Skip to content

Commit

Permalink
[fwutil]: Update command reference doc: per component FW update. (#1708)
Browse files Browse the repository at this point in the history 
Signed-off-by: Nazarii Hnydyn <nazariig@nvidia.com>
What I did
Updated command reference to match fwutil v.2.0.0.0
How I did it
Updated command reference
  • Loading branch information
@nazariig
nazariig authored Jul 26, 2021
1 parent b83d2bf commit 4422911
Showing 1 changed file with 133 additions and 57 deletions.
190 changes: 133 additions & 57 deletions doc/Command-Reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5889,22 +5889,86 @@ Go Back To [Beginning of the document](#) or [Beginning of this section](#pfc-wa
### Platform Component Firmware show commands
**show platform firmware**
**show platform firmware status**
This command displays platform components firmware status information.
- Usage:
```bash
show platform firmware
show platform firmware status
```

- Example:
```bash
admin@sonic:~$ show platform firmware
admin@sonic:~$ sudo show platform firmware status
Chassis Module Component Version Description
--------- -------- ----------- ----------------------- ---------------------------------------
Chassis1 N/A BIOS 0ACLH004_02.02.007_9600 BIOS - Basic Input/Output System
CPLD 5.3.3.1 CPLD - includes all CPLDs in the switch
--------- -------- ----------- ----------------------- ----------------------------------------
MSN3800 N/A ONIE 2020.11-5.2.0022-9600 ONIE - Open Network Install Environment
SSD 0202-000 SSD - Solid-State Drive
BIOS 0ACLH004_02.02.008_9600 BIOS - Basic Input/Output System
CPLD1 CPLD000120_REV0900 CPLD - Complex Programmable Logic Device
CPLD2 CPLD000165_REV0500 CPLD - Complex Programmable Logic Device
CPLD3 CPLD000166_REV0300 CPLD - Complex Programmable Logic Device
CPLD4 CPLD000167_REV0100 CPLD - Complex Programmable Logic Device
```

**show platform firmware updates**

This command displays platform components firmware updates information.

- Usage:
```bash
show platform firmware updates [-i|--image]
```

- Options:
- _-i|--image_: show updates using current/next SONiC image

Valid values:
- current
- next

Default:
- current

- Example:
```bash
admin@sonic:~$ sudo show platform firmware updates
Chassis Module Component Firmware Version (Current/Available) Status
--------- -------- ----------- ------------------------------------------ ------------------------------------------------- ------------------
MSN3800 N/A ONIE /usr/local/lib/firmware/mellanox/onie.bin 2020.11-5.2.0022-9600 / 2020.11-5.2.0024-9600 update is required
SSD /usr/local/lib/firmware/mellanox/ssd.bin 0202-000 / 0204-000 update is required
BIOS /usr/local/lib/firmware/mellanox/bios.bin 0ACLH004_02.02.008_9600 / 0ACLH004_02.02.010_9600 update is required
CPLD1 /usr/local/lib/firmware/mellanox/cpld.mpfa CPLD000120_REV0900 / CPLD000120_REV0900 up-to-date
CPLD2 /usr/local/lib/firmware/mellanox/cpld.mpfa CPLD000165_REV0500 / CPLD000165_REV0500 up-to-date
CPLD3 /usr/local/lib/firmware/mellanox/cpld.mpfa CPLD000166_REV0300 / CPLD000166_REV0300 up-to-date
CPLD4 /usr/local/lib/firmware/mellanox/cpld.mpfa CPLD000167_REV0100 / CPLD000167_REV0100 up-to-date
```

- Note:
- current/next values for _-i|--image_ are taken from `sonic-installer list`
```bash
admin@sonic:~$ sudo sonic-installer list
Current: SONiC-OS-202012.0-fb89c28c9
Next: SONiC-OS-201911.0-2bec3004e
Available:
SONiC-OS-202012.0-fb89c28c9
SONiC-OS-201911.0-2bec3004e
```

**show platform firmware version**

This command displays platform components firmware utility version.

- Usage:
```bash
show platform firmware version
```

- Example:
```bash
admin@sonic:~$ show platform firmware version
fwutil version 2.0.0.0
```

### Platform Component Firmware config commands
Expand All @@ -5920,30 +5984,35 @@ config platform firmware install chassis component <component_name> fw <fw_path>
config platform firmware install module <module_name> component <component_name> fw <fw_path> [-y|--yes]
```

- Options:
- _-y|--yes_: automatic yes to prompts. Assume "yes" as answer to all prompts and run non-interactively

- Example:
```bash
admin@sonic:~$ sudo config platform firmware install chassis component BIOS fw /etc/mlnx/fw/sn3800/chassis1/bios.bin
admin@sonic:~$ sudo config platform firmware install chassis component BIOS fw /usr/local/lib/firmware/mellanox/sn3800/chassis1/bios.bin
Warning: Immediate cold reboot is required to complete BIOS firmware update.
New firmware will be installed, continue? [y/N]: y
Installing firmware:
/etc/mlnx/fw/sn3800/chassis1/bios.bin
/usr/local/lib/firmware/mellanox/sn3800/chassis1/bios.bin
admin@sonic:~$ sudo config platform firmware install module Module1 component BIOS fw http://mellanox.com/fw/sn3800/module1/bios.bin
admin@sonic:~$ sudo config platform firmware install module Module1 component BIOS fw https://www.mellanox.com/fw/sn3800/module1/bios.bin
Warning: Immediate cold reboot is required to complete BIOS firmware update.
New firmware will be installed, continue? [y/N]: y
Downloading firmware:
[##################################################] 100%
Installing firmware:
/tmp/bios.bin
```
Supported options:
1. -y|--yes - automatic yes to prompts. Assume "yes" as answer to all prompts and run non-interactively
- Note:
- <fw_path> can be absolute path or URL
**config platform firmware update**
This command is used for automatic FW update of all available platform components.
This command is used to update a platform component firmware from current/next SONiC image.
Both modular and non modular chassis platforms are supported.
Automatic FW update requires `platform_components.json` to be created and placed at:
FW update requires `platform_components.json` to be created and placed at:
sonic-buildimage/device/<platform_name>/<onie_platform>/platform_components.json
Example:
Expand All @@ -5954,19 +6023,16 @@ Example:
"Chassis1": {
"component": {
"BIOS": {
"firmware": "/etc/<platform_name>/fw/<onie_platform>/chassis1/bios.bin",
"version": "0ACLH003_02.02.010",
"info": "Cold reboot is required"
"firmware": "/usr/local/lib/firmware/<platform_name>/<onie_platform>/chassis1/bios.bin",
"version": "<bios_version>"
},
"CPLD": {
"firmware": "/etc/<platform_name>/fw/<onie_platform>/chassis1/cpld.bin",
"version": "10",
"info": "Power cycle is required"
"firmware": "/usr/local/lib/firmware/<platform_name>/<onie_platform>/chassis1/cpld.bin",
"version": "<cpld_version>"
},
"FPGA": {
"firmware": "/etc/<platform_name>/fw/<onie_platform>/chassis1/fpga.bin",
"version": "5",
"info": "Power cycle is required"
"firmware": "/usr/local/lib/firmware/<platform_name>/<onie_platform>/chassis1/fpga.bin",
"version": "<fpga_version>"
}
}
}
Expand All @@ -5981,19 +6047,16 @@ Example:
"Chassis1": {
"component": {
"BIOS": {
"firmware": "/etc/<platform_name>/fw/<onie_platform>/chassis1/bios.bin",
"version": "0ACLH003_02.02.010",
"info": "Cold reboot is required"
"firmware": "/usr/local/lib/firmware/<platform_name>/<onie_platform>/chassis1/bios.bin",
"version": "<bios_version>"
},
"CPLD": {
"firmware": "/etc/<platform_name>/fw/<onie_platform>/chassis1/cpld.bin",
"version": "10",
"info": "Power cycle is required"
"firmware": "/usr/local/lib/firmware/<platform_name>/<onie_platform>/chassis1/cpld.bin",
"version": "<cpld_version>"
},
"FPGA": {
"firmware": "/etc/<platform_name>/fw/<onie_platform>/chassis1/fpga.bin",
"version": "5",
"info": "Power cycle is required"
"firmware": "/usr/local/lib/firmware/<platform_name>/<onie_platform>/chassis1/fpga.bin",
"version": "<fpga_version>"
}
}
}
Expand All @@ -6002,51 +6065,64 @@ Example:
"Module1": {
"component": {
"CPLD": {
"firmware": "/etc/<platform_name>/fw/<onie_platform>/module1/cpld.bin",
"version": "10",
"info": "Power cycle is required"
"firmware": "/usr/local/lib/firmware/<platform_name>/<onie_platform>/module1/cpld.bin",
"version": "<cpld_version>"
},
"FPGA": {
"firmware": "/etc/<platform_name>/fw/<onie_platform>/module1/fpga.bin",
"version": "5",
"info": "Power cycle is required"
"firmware": "/usr/local/lib/firmware/<platform_name>/<onie_platform>/module1/fpga.bin",
"version": "<fpga_version>"
}
}
}
}
}
```
Note: FW update will be skipped if component definition is not provided (e.g., 'BIOS': { })
- Usage:
```bash
config platform firmware update [-y|--yes] [-f|--force] [-i|--image=current|next]
config platform firmware update chassis component <component_name> fw [-y|--yes] [-f|--force] [-i|--image]
config platform firmware update module <module_name> component <component_name> fw [-y|--yes] [-f|--force] [-i|--image]
```
- Options:
- _-y|--yes_: automatic yes to prompts. Assume "yes" as answer to all prompts and run non-interactively
- _-f|--force_: update FW regardless the current version
- _-i|--image_: update FW using current/next SONiC image
Valid values:
- current
- next
Default:
- current
- Example:
```bash
admin@sonic:~$ sudo config platform firmware update
Chassis Module Component Firmware Version Status Info
--------- -------- ----------- ------------------------------------- ------------------------------------------------- ------------------ -----------------------
Chassis1 N/A BIOS /etc/mlnx/fw/sn3800/chassis1/bios.bin 0ACLH004_02.02.007_9600 / 0ACLH004_02.02.007_9600 up-to-date Cold reboot is required
CPLD /etc/mlnx/fw/sn3800/chassis1/cpld.bin 5.3.3.1 / 5.3.3.2 update is required Power cycle is required
admin@sonic:~$ sudo config platform firmware update chassis component BIOS fw
Warning: Immediate cold reboot is required to complete BIOS firmware update.
New firmware will be installed, continue? [y/N]: y
Updating firmware:
/usr/local/lib/firmware/mellanox/x86_64-mlnx_msn3800-r0/chassis1/bios.bin
Summary:
Chassis Module Component Status
--------- -------- ----------- ----------
Chassis1 N/A BIOS up-to-date
CPLD success
admin@sonic:~$ sudo config platform firmware update module Module1 component BIOS fw
Warning: Immediate cold reboot is required to complete BIOS firmware update.
New firmware will be installed, continue? [y/N]: y
Updating firmware:
/usr/local/lib/firmware/mellanox/x86_64-mlnx_msn3800-r0/module1/bios.bin
```
Supported options:
1. -y|--yes - automatic yes to prompts. Assume "yes" as answer to all prompts and run non-interactively
2. -f|--force - install FW regardless the current version
3. -i|--image - update FW using current/next SONiC image
Note: the default option is --image=current (current/next values are taken from `sonic-installer list`)
- Note:
- FW update will be disabled if component definition is not provided (e.g., 'BIOS': { })
- FW version will be read from image if `version` field is not provided
- current/next values for _-i|--image_ are taken from `sonic-installer list`
```bash
admin@sonic:~$ sudo sonic-installer list
Current: SONiC-OS-202012.0-fb89c28c9
Next: SONiC-OS-201911.0-2bec3004e
Available:
SONiC-OS-202012.0-fb89c28c9
SONiC-OS-201911.0-2bec3004e
```
### Platform Component Firmware vendor specific behaviour
Expand Down

0 comments on commit 4422911

Please sign in to comment.