fwflash(1m) - osol9

1fwflash(1M)             System Administration Commands             fwflash(1M)
2
3
4

NAME

6       fwflash - firmware query and update utility
7

SYNOPSIS

9       /usr/sbin/fwflash  [-l [-c device_class | ALL ]]
10            | [-v] | [-h]
11
12
13       fwflash  [-f file1,file2,file3,... | -r file]
14            [-y] [-d device_path]
15
16

DESCRIPTION

18       The  fwflash  command writes a binary image file to supported flashable
19       devices attached to a Solaris host. It also  provides  the  ability  to
20       read  firmware  to  a file if supported by the device. Because changing
21       the firmware in a device can have significant impact on  the  stability
22       of  a  system, only users with the privilege All are allowed to execute
23       this command. Users authorized  to  run  fwflash  can  be  granted  the
24       "Firmware Flash Update" Rights Profile.
25
26
27       The  first  form  of  the  command,  above,  provides information about
28       devices. It lists all devices currently available on  the  system  that
29       are  supported by fwflash for firmware upgrade. You can filter the list
30       operation, to display only specified classes  of  devices.  The  second
31       form  of  the  command  provides  the  operations  to read or write the
32       firmware images to specific devices.
33

OPTIONS

35       The following options are supported:
36
37       -c device_class
38
39           An optional parameter, valid only when used  with  the  -l  option.
40           This  option  causes the command to list only devices of a specific
41           class type. Currently supported classes are  IB,  ses,  sesgen,  or
42           ALL. If -c is not specified for the -loption, the class defaults to
43           ALL.
44
45
46       -d dev_path
47
48           The dev_path is absolute path name of  the  device  that  the  user
49           wants to modify with the -for -r operation. If the device cannot be
50           found, the command fails. If  the  -d  option  is  specified,  then
51           either -f or -r must also be specified.
52
53
54       -f file1,file2,file3,...
55
56           Specify  the  path  to  one or more binary firmware image files you
57           want to write to the device. fwflash will verify that each file  is
58           a  valid firmware image for the specified device. If it is not, the
59           command fails with an appropriate error message.
60
61           If multiple firmware image files are specified, each image is veri‐
62           fied  and  flashed  to the device in the order given on the command
63           line. If any of the specified files cannot be successfully flashed,
64           then an appropriate message is displayed.
65
66           After  a  new  firmware  image  is flashed to a device, a reboot is
67           required to correctly activate the new firmware.
68
69
70       -h
71
72           Display the command line usage message for fwflash.
73
74
75       -l
76
77           List the devices on a system available  for  firmware  upgrade  and
78           display information specific to each device or device class.
79
80           For InfiniBand (IB) devices, the list operation  displays the guids
81           (Globally Unique Identifier) currently set for the HCA, as well  as
82           the  current  firmware  revision installed. There are four separate
83           guids on the HCA; two of them can be set with the same value.
84
85           For SCSI Enclosure Services (ses or sgen) devices,  an  identifying
86           target-port worldwide name is displayed, if available.
87
88
89       -r file
90
91           Specify the path to a file to create when reading the firmware from
92           the device. The -f and -r options are mutually exclusive.
93
94           Not all flashable devices support reading firmware images back from
95           the device.  At present, only InfiniBand (IB) devices are supported
96           for this operation. A message will be  displayed  if  the  selected
97           device does not support this operation.
98
99
100       -v
101
102           Display fwflash version information and exit.
103
104
105       -y
106
107           Valid only when a flash read (-r) or write (-f) operation is speci‐
108           fied. This option causes fwflash not  to  prompt  for  confirmation
109           during  operation and operate non-interactively. Note that there is
110           no option  that  allows  you  to  forcibly  flash  an  incompatible
111           firmware image onto a device.
112
113

EXAMPLES

115       Example 1 Entering Command Without Arguments
116
117
118       The following command shows fwflash when the command is entered without
119       arguments.
120
121
122         example# fwflash
123         Usage:
124         Usage:
125               fwflash [-l [-c device_class | ALL]] | [-v] | [-h]
126               fwflash [-f file1,file2,file3,... | -r file] [-y] -d device_path
127
128               -l              list flashable devices in this system
129               -c device_class limit search to a specific class
130                               eg IB for InfiniBand, ses for SCSI Enclosures
131               -v              print version number of fwflash utility
132               -h              print this usage message
133
134               -f file1,file2,file3,...
135                               firmware image file list to flash
136               -r file         file to dump device firmware to
137               -y              answer Yes/Y/y to prompts
138               -d device_path  pathname of device to be flashed
139
140               If -d device_path is specified, then one of -f <files>
141               or -r <file> must also be specified
142
143               If multiple firmware images are required to be flashed
144               they must be listed together, separated by commas. The
145               images will be flashed in the order specified.
146
147
148
149       Example 2 Listing Devices Available to Flash
150
151
152       The following command lists the devices available to be flashed.
153
154
155         example# fwflash -l
156         List of available devices:
157         Device[0],  /devices/pci@0,0/pci8086,3595@2/pci8086,32a@0,2/\
158                     pci15b3,5a46@c/pci15b3,5a44@0:devctl
159             Class [IB]
160                 GUID: System Image - 0002c901081e33b3
161                       Node         - 0000000000003446
162                       Port 1       - 0002c901081e33b1
163                       Port 2       - 0002c901081e33b2
164                 Firmware revision: 3.3.0002
165                 No hardware information available for this device
166
167         Device[1],  /devices/pci@0,0/pci8086,3597@4/pci15b3,6278@0:devctl
168             Class [IB]
169                 GUID: System Image - 0002c9010a99e3b3
170                       Node         - 0002c9010a99e3b0
171                       Port 1       - 0002c9010a99e3b1
172                       Port 2       - 0002c9010a99e3b2
173                 Firmware revision: 4.8.00c8
174                 Product           : MTLP25208-CF256T (Lion cub)
175                 PSID              : MT_00B0000001
176
177
178
179
180       Alternatively, for a SAS Expander presented as a  SCSI  Enclosure  Ser‐
181       vices device , we might see output such as this:
182
183
184         example# fwflash -l
185         List of available devices:
186         Device[0] /devices/pci@0/pci@0/pci@2/scsi@0/ses@3,0:ses
187           Class [sgen]
188                 Target port WWN  : 500605b00002453d
189                 Vendor           : SUN
190                 Product          : 16Disk Backplane
191                 Firmware revision: 5021
192
193
194
195       Example 3 Flash Upgrading an IB HCA Device
196
197
198       The following command flash upgrades an IB HCA device.
199
200
201         example# fwflash -f ./version.3.2.0000 \
202            -d /devices/pci@0,0/pci8086,3597@4/pci15b3,6278@0:devctl
203         About to update firmware on:
204           /devices/pci@0,0/pci8086,3597@4/pci15b3,6278@0:devctl
205         Continue (Y/N): Y
206
207         Updating . . . . . . . . . . . .
208         Done.  New image will be active after the system is rebooted.
209
210
211
212
213       Note that you are prompted before the upgrading proceeds and that it is
214       mandatory that you reboot your host to activate the new firmware image.
215
216
217
218       The following command adds the -y option to the command.
219
220
221         example# fwflash -y -f ./version.3.2.0000 \
222            -d /devices/pci@0,0/pci8086,3597@4/pci15b3,6278@0:devctl
223         About to update firmware on:
224           /devices/pci@0,0/pci8086,3597@4/pci15b3,6278@0:devctl
225
226         Updating . . . . . . . . . . . .
227         Done.  New image will be active after the system is rebooted.
228
229
230
231       Example 4 Reading Device Firmware to File
232
233
234       The command shown below reads the device firmware to a file.  The  com‐
235       mand uses the -y option so that read occurs without prompting.
236
237
238         example# fwflash -y -r /firmware.bin \
239            -d /devices/pci@1d,700000/pci@1/pci15b3,5a44@0:devctl
240         About to read firmware on:
241                  /devices/pci@1d,700000/pci@1/pci15b3,5a44@0:devctl
242         to filename: /firmware.bin
243
244         Reading . . .
245         Done.
246
247
248
249       Example 5 When No Flashable Devices Are Found
250
251
252       The  command output shown below informs the user that there are no sup‐
253       ported flashable devices found in the system:
254
255
256         example# fwflash -l
257         fwflash: No flashable devices attached with the ses driver in this system
258         fwflash: No flashable devices attached with the sgen driver in this system
259         fwflash: No flashable devices attached with the tavor driver in this system
260         fwflash: No flashable devices in this system
261
262
263
264
265       Each plugin found in /usr/lib/fwflash/identify is loaded in  turn,  and
266       walks  the  system  device  tree,  determining  whether  any currently-
267       attached devices can be flashed. For the list of device types and driv‐
268       ers that are currently supported, please see the NOTES section below.
269
270

RETURN VALUES

272       The fwflash command returns the following values:
273
274       0
275
276           Success
277
278
279       1
280
281           Failure
282
283

ATTRIBUTES

285       See attributes(5) for descriptions of the following attributes:
286
287
288
289
290       ┌─────────────────────────────┬─────────────────────────────┐
291       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
292       ├─────────────────────────────┼─────────────────────────────┤
293       │Availability                 │SUNWfwflash                  │
294       ├─────────────────────────────┼─────────────────────────────┤
295       │Interface Stability          │Committed                    │
296       └─────────────────────────────┴─────────────────────────────┘
297

NOTES

317       The fwflash command supports:
318
319           o      InfiniBand Host Channel Adapters (IB HCAs) containing either
320                  the AMD or the Intel parallel flash parts.
321
322           o      SCSI Enclosure  Services  devices  such  as  SAS  Expanders,
323                  attached with  ses(7D) drivers.
324
325
326
327SunOS 5.11                        4 Nov 2008                       fwflash(1M)