te
Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
fwflash - firmware query and update utility

/usr/sbin/fwflash [-l [-c device_class | ALL ]]
 | [-v] | [-h]

fwflash [-f file1,file2,file3,... | -r file]
 [-y] [-d device_path]

The fwflash command writes a binary image file to supported flashable devices attached to a Solaris host. It also provides the ability to read firmware to a file if supported by the device. Because changing the firmware in a device can have significant impact on the stability of a system, only users with the privilege All are allowed to execute this command. Users authorized to run fwflash can be granted the "Firmware Flash Update" Rights Profile.

The first form of the command, above, provides information about devices. It lists all devices currently available on the system that are supported by fwflash for firmware upgrade. You can filter the list operation, to display only specified classes of devices. The second form of the command provides the operations to read or write the firmware images to specific devices.

The following options are supported: -c device_class

-d dev_path -f file1,file2,file3,... -h -l -r file -v -y

Example 1 Entering Command Without Arguments

The following command shows fwflash when the command is entered without arguments.

example# fwflash
Usage:
Usage:
 fwflash [-l [-c device_class | ALL]] | [-v] | [-h]
 fwflash [-f file1,file2,file3,... | -r file] [-y] -d device_path

 -l list flashable devices in this system
 -c device_class limit search to a specific class
 eg IB for InfiniBand, ses for SCSI Enclosures
 -v print version number of fwflash utility
 -h print this usage message

 -f file1,file2,file3,...
 firmware image file list to flash
 -r file file to dump device firmware to
 -y answer Yes/Y/y to prompts
 -d device_path pathname of device to be flashed

 If -d device_path is specified, then one of -f <files>
 or -r <file> must also be specified

 If multiple firmware images are required to be flashed
 they must be listed together, separated by commas. The
 images will be flashed in the order specified.

Example 2 Listing Devices Available to Flash

The following command lists the devices available to be flashed.

example# fwflash -l
List of available devices:
Device[0], /devices/pci@0,0/pci8086,3595@2/pci8086,32a@0,2/\e
 pci15b3,5a46@c/pci15b3,5a44@0:devctl
 Class [IB]
 GUID: System Image - 0002c901081e33b3
 Node - 0000000000003446
 Port 1 - 0002c901081e33b1
 Port 2 - 0002c901081e33b2
 Firmware revision: 3.3.0002
 No hardware information available for this device

Device[1], /devices/pci@0,0/pci8086,3597@4/pci15b3,6278@0:devctl
 Class [IB]
 GUID: System Image - 0002c9010a99e3b3
 Node - 0002c9010a99e3b0
 Port 1 - 0002c9010a99e3b1
 Port 2 - 0002c9010a99e3b2
 Firmware revision: 4.8.00c8
 Product : MTLP25208-CF256T (Lion cub)
 PSID : MT_00B0000001

Alternatively, for a SAS Expander presented as a SCSI Enclosure Services device , we might see output such as this:

example# fwflash -l
List of available devices:
Device[0] /devices/pci@0/pci@0/pci@2/scsi@0/ses@3,0:ses
 Class [sgen]
 Target port WWN : 500605b00002453d
 Vendor : SUN
 Product : 16Disk Backplane
 Firmware revision: 5021

Example 3 Flash Upgrading an IB HCA Device

The following command flash upgrades an IB HCA device.

example# fwflash -f ./version.3.2.0000 \e
 -d /devices/pci@0,0/pci8086,3597@4/pci15b3,6278@0:devctl
About to update firmware on:
 /devices/pci@0,0/pci8086,3597@4/pci15b3,6278@0:devctl
Continue (Y/N): Y

Updating . . . . . . . . . . . .
Done. New image will be active after the system is rebooted.

Note that you are prompted before the upgrading proceeds and that it is mandatory that you reboot your host to activate the new firmware image.

The following command adds the -y option to the command.

example# fwflash -y -f ./version.3.2.0000 \e
 -d /devices/pci@0,0/pci8086,3597@4/pci15b3,6278@0:devctl
About to update firmware on:
 /devices/pci@0,0/pci8086,3597@4/pci15b3,6278@0:devctl

Updating . . . . . . . . . . . .
Done. New image will be active after the system is rebooted.

Example 4 Reading Device Firmware to File

The command shown below reads the device firmware to a file. The command uses the -y option so that read occurs without prompting.

example# fwflash -y -r /firmware.bin \e
 -d /devices/pci@1d,700000/pci@1/pci15b3,5a44@0:devctl
About to read firmware on:
 /devices/pci@1d,700000/pci@1/pci15b3,5a44@0:devctl
to filename: /firmware.bin

Reading . . .
Done.

Example 5 When No Flashable Devices Are Found

The command output shown below informs the user that there are no supported flashable devices found in the system:

example# fwflash -l
fwflash: No flashable devices attached with the ses driver in this system
fwflash: No flashable devices attached with the sgen driver in this system
fwflash: No flashable devices attached with the tavor driver in this system
fwflash: No flashable devices in this system

Each plugin found in /usr/lib/fwflash/identify is loaded in turn, and walks the system device tree, determining whether any currently-attached devices can be flashed. For the list of device types and drivers that are currently supported, please see the NOTES section below.

The fwflash command returns the following values: 0

1

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE

Interface Stability Committed

attributes(5), hermon(7D), ses(7D), tavor(7D)

The InfiniBand Trade Association website, http://www.infinibandta.org

The SCSI Storage Interfaces committee website, http://www.t10.org

SCSI Primary Commands-4, SPC4

SCSI Enclosure Services-2, SES2

Serial Attached SCSI-2, SAS2

The fwflash command supports: