diff options
Diffstat (limited to 'usr/src/man/man1m/fwflash.1m')
| -rw-r--r-- | usr/src/man/man1m/fwflash.1m | 90 |
1 files changed, 48 insertions, 42 deletions
diff --git a/usr/src/man/man1m/fwflash.1m b/usr/src/man/man1m/fwflash.1m index 3eac6f8689..d81d7f7dae 100644 --- a/usr/src/man/man1m/fwflash.1m +++ b/usr/src/man/man1m/fwflash.1m @@ -1,13 +1,13 @@ '\" te .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright 2020 Oxide Computer Company .\" 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] -.TH FWFLASH 1M "Nov 4, 2008" +.TH FWFLASH 1M "June 9, 2020" .SH NAME fwflash \- firmware query and update utility .SH SYNOPSIS -.LP .nf \fB/usr/sbin/fwflash\fR [\fB-l\fR [\fB-c\fR \fIdevice_class\fR | \fBALL\fR ]] | [\fB-v\fR] | [\fB-h\fR] @@ -20,8 +20,6 @@ fwflash \- firmware query and update utility .fi .SH DESCRIPTION -.sp -.LP The \fBfwflash\fR 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 @@ -38,8 +36,6 @@ 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. .SH OPTIONS -.sp -.LP The following options are supported: .sp .ne 2 @@ -50,7 +46,7 @@ The following options are supported: .RS 4n An optional parameter, valid only when used with the \fB-l\fR option. This option causes the command to list only devices of a specific class type. -Currently supported classes are \fBIB\fR, \fBses\fR, \fBsesgen\fR, or +Currently supported classes are \fBIB\fR, \fBses\fR, \fBsd\fR, \fBufm\fR, or \fBALL\fR. If \fB-c\fR is not specified for the \fB-l\fRoption, the class defaults to \fBALL\fR. .RE @@ -116,6 +112,12 @@ two of them can be set with the same value. .sp For SCSI Enclosure Services (\fBses\fR or \fBsgen\fR) devices, an identifying target-port worldwide name is displayed, if available. +.sp +For \fBufm\fR(7D) based devices, identifying information such as PCI +identifiers and supported capabilities such as the ability to read +firmware images or slot information is reported. For each firmware image +on the device, each slot is displayed along with information about the +slot's version and attributes. .RE .sp @@ -129,8 +131,7 @@ Specify the path to a file to create when reading the firmware from the device. The \fB-f\fR and \fB-r\fR options are mutually exclusive. .sp Not all flashable devices support reading firmware images back from the device. -At present, only InfiniBand (IB) devices are supported for this operation. A -message will be displayed if the selected device does not support this +A message will be displayed if the selected device does not support this operation. .RE @@ -158,7 +159,6 @@ that allows you to forcibly flash an incompatible firmware image onto a device. .RE .SH EXAMPLES -.LP \fBExample 1 \fREntering Command Without Arguments .sp .LP @@ -170,7 +170,6 @@ arguments. .nf example# \fBfwflash\fR Usage: -Usage: fwflash [-l [-c device_class | ALL]] | [-v] | [-h] fwflash [-f file1,file2,file3,... | -r file] [-y] -d device_path @@ -232,8 +231,8 @@ Device[1], /devices/pci@0,0/pci8086,3597@4/pci15b3,6278@0:devctl .sp .LP -Alternatively, for a SAS Expander presented as a SCSI Enclosure Services device -, we might see output such as this: +Alternatively, for a SAS Expander presented as a SCSI Enclosure Services device, +we might see output such as this: .sp .in +2 @@ -250,6 +249,37 @@ Device[0] /devices/pci@0/pci@0/pci@2/scsi@0/ses@3,0:ses .in -2 .sp +.sp +.LP +Finally, for devices that support the system's upgradeable firmware +module APIs (see \fBufm\fR(7D)), one might see output like: + +.sp +.in +2 +.nf +example# \fBfwflash -l\fR +List of available devices: +Device[0] /devices/pci@0,0/pci1022,1483@3,2/pci8086,390d@0 +Class [ufm] + Vendor: Intel Corporation + Device: SSD 660P Series + Capabilities: Report + Image 0: Firmware + Slot 0 (-|w|a): 002C + Slot 1 (-|w|-): 002C + + +Device[1] /devices/pci@3d,0/pci1022,1483@3,1/pci1849,1521@0 +Class [ufm] + Vendor: Intel Corporation + Device: I350 Gigabit Network Connection + Capabilities: Report, Read Image + Image 0: NVM + Slot 0 (r|w|a): 1.69 +.fi +.in -2 +.sp + .LP \fBExample 3 \fRFlash Upgrading an IB HCA Device .sp @@ -304,11 +334,11 @@ the \fB-y\fR option so that read occurs without prompting. .sp .in +2 .nf -example# \fBfwflash -y -r /firmware.bin \e +example# \fBfwflash -y -r ./firmware.bin \e -d /devices/pci@1d,700000/pci@1/pci15b3,5a44@0:devctl\fR About to read firmware on: /devices/pci@1d,700000/pci@1/pci15b3,5a44@0:devctl -to filename: /firmware.bin +to filename: ./firmware.bin Reading . . . Done. @@ -339,12 +369,9 @@ fwflash: No flashable devices in this system .LP Each plugin found in \fB/usr/lib/fwflash/identify\fR 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 \fBNOTES\fR section below. +devices can be flashed. .SH RETURN VALUES -.sp -.LP The \fBfwflash\fR command returns the following values: .sp .ne 2 @@ -367,8 +394,6 @@ Failure .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -383,9 +408,8 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBhermon\fR(7D), \fBses\fR(7D), \fBtavor\fR(7D) +\fBattributes\fR(5), \fBhermon\fR(7D), \fBses\fR(7D), \fBtavor\fR(7D), +\fBufm\fR(7D) .sp .LP The InfiniBand Trade Association website, http://www.infinibandta.org @@ -401,21 +425,3 @@ The SCSI Storage Interfaces committee website, http://www.t10.org .sp .LP \fISerial Attached SCSI-2, SAS2\fR -.SH NOTES -.sp -.LP -The \fBfwflash\fR command supports: -.RS +4 -.TP -.ie t \(bu -.el o -InfiniBand Host Channel Adapters (IB HCAs) containing either the AMD or the -Intel parallel flash parts. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -SCSI Enclosure Services devices such as SAS Expanders, attached with -\fBses\fR(7D) drivers. -.RE |