Skip to content

Commit 50c17e0

Browse files
authored
Update references of /var/platform to /var/firmwareupdate to match implementation (#1000)
1 parent 63a29ad commit 50c17e0

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

doc/fwutil/fwutil.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,7 @@ New component api is introduced to support the component firmware auto-update as
576576
"""
577577
raise NotImplementedError
578578
```
579-
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.
579+
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.
580580

581581
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.
582582
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.
@@ -602,7 +602,7 @@ In this example, BIOS firmware got updated, CPLD firmware got installed but powe
602602
*powercycle can be triggered by cold reboot script in this case.
603603

604604
```bash
605-
admin@sonic:~/fwutil$ cat /var/platform/fw_au_status
605+
admin@sonic:~/fwutil$ cat /var/firmwareupdate/fw_au_status
606606
{
607607
"MSN2700/BIOS":
608608
{
@@ -634,7 +634,7 @@ And the components available for the update are BIOS, and SSD.
634634
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.
635635

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

671-
Here is the /var/platform directory structure while fwutil handles the `fwutil update all fw` and `fwutil show update status` command.
671+
Here is the /var/firmwareupdate directory structure while fwutil handles the `fwutil update all fw` and `fwutil show update status` command.
672672
```
673-
/var/platform/
673+
/var/firmwareupdate/
674674
|--- fw_au_status
675675
|--- <boot_type>_fw_au_task*
676676
```

0 commit comments

Comments
 (0)