Skip to content

Commit

Permalink
Update references of /var/platform to /var/firmwareupdate to match im…
Browse files Browse the repository at this point in the history
…plementation (sonic-net#1000)
  • Loading branch information
alexrallen authored and Itamar Talmon committed Oct 2, 2022
1 parent c32e485 commit 468230f
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions doc/fwutil/fwutil.md
Original file line number Diff line number Diff line change
Expand Up @@ -576,7 +576,7 @@ New component api is introduced to support the component firmware auto-update as
"""
raise NotImplementedError
```
The return_code of auto_update_firmware() which indicates the firmware auto-update status, will be logged in "fw_au_status" under "/var/platform/" directory by fwutil and the status file will be used for the `fwutil show update status` command.
The return_code of auto_update_firmware() which indicates the firmware auto-update status, will be logged in "fw_au_status" under "/var/firmwareupdate/" directory by fwutil and the status file will be used for the `fwutil show update status` command.

In case that a firmware update needs any additional step to complete the firmware update but the installation time is longer than the boot time requirement, auto-update platform api is expected to install the firmware and perform the complete action during the reboot via `platform_fw_au_reboot_handle` or `platform_reboot` plugin.
For example, some cpld update needs a power cycle to complete the firmware update and some cpld update needs a register triggered power-cycle to give some refresh time for the new firmware to be effective on the system.
Expand All @@ -602,7 +602,7 @@ In this example, BIOS firmware got updated, CPLD firmware got installed but powe
*powercycle can be triggered by cold reboot script in this case.

```bash
admin@sonic:~/fwutil$ cat /var/platform/fw_au_status
admin@sonic:~/fwutil$ cat /var/firmwareupdate/fw_au_status
{
"MSN2700/BIOS":
{
Expand Down Expand Up @@ -634,7 +634,7 @@ And the components available for the update are BIOS, and SSD.
In this example, BIOS firmware got updated, CPLD firmware update was skipped since the update completion can not be done for warm, and SSD firmware update is scheduled during warm boot.

```bash
admin@sonic:~/fwutil$ cat /var/platform/fw_au_status
admin@sonic:~/fwutil$ cat /var/firmwareupdate/fw_au_status
{
"MSN2700/BIOS":
{
Expand Down Expand Up @@ -668,9 +668,9 @@ Automatic FW installation requires default platform_components.json to be create
_sonic-buildimage/device/<platform_name>/<onie_platform>/platform_components.json_
Recommended image path is "/lib/firmware/<vendor>".

Here is the /var/platform directory structure while fwutil handles the `fwutil update all fw` and `fwutil show update status` command.
Here is the /var/firmwareupdate directory structure while fwutil handles the `fwutil update all fw` and `fwutil show update status` command.
```
/var/platform/
/var/firmwareupdate/
|--- fw_au_status
|--- <boot_type>_fw_au_task*
```
Expand Down

0 comments on commit 468230f

Please sign in to comment.