architecture/code-update/code-update-deprecated.md

5 - The REST APIs described below are deprecated. Please follow
6   [code-update.md](code-update.md) for the new APIs to do code update.
7 - The rest part of this document is still valid.
10 [host-code-update.md](host-code-update.md)
13 `tmp/deploy/images/<platform>/`. The `image-*` symlinks correspond to components
16 - `image-bmc` → `obmc-phosphor-image-<platform>-<timestamp>.static.mtd`
20 - `image-kernel` → `fitImage-obmc-phosphor-initramfs-<platform>.bin`
25 - `image-rofs` → `obmc-phosphor-image-<platform>.squashfs-xz`
27   The read-only OpenBMC filesystem
29 - `image-rwfs` → `rwfs.jffs2`
31   The read-write filesystem for persistent changes to the OpenBMC filesystem
33 - `image-u-boot` → `u-boot.bin`
40 - `<platform>-<timestamp>.all.tar`
42   The complete BMC flash content: A single file (`image-bmc`) wrapped in a tar
45 - `<platform>-<timestamp>.tar`
48   for each of the u-boot, kernel, ro and rw partitions.
52 The BMC normally runs with the read-write and read-only file systems mounted,
53 which means these images may be read (and written, for the read-write
59 filesystem, and the images copied into the `/run/initramfs` directory will be
61 `halt` commands -- they will write the flash before stopping.
75 U-Boot redundant environments):
77     fw_setenv openbmconce copy-files-to-ram copy-base-filesystem-to-ram
78     fw_setenv openbmconce copy-files-to-ram copy-base-filesystem-to-ram
81 Copy one or more of these `image-*` files to the directory:
83     /run/initramfs/
85 (preserving the filename), then run the `update` script to apply the images:
87     /run/initramfs/update
98     /run/initramfs/update --help
117     curl -b cjar -k -H "Content-Type: application/json" -X POST \
118         -d '{"data":  []}' \
119         https://${bmc}/org/openbmc/control/flash/bmc/action/prepareForUpdate
121 This will setup the u-boot environment and reboot the BMC. If no other images
126 There are a few settings available to control the update process:
128 - `preserve_network_settings`: Preserve network settings, only needed if
130 - `restore_application_defaults`: update (clear) the read-write file system
131 - `update_kernel_and_apps`: update kernel and initramfs. If the partitioned
134 - `clear_persistent_files`: ignore the persistent file list when resetting
136 - `auto_apply`: Attempt to write the images by invoking the `Apply` method after
140 `/control/flash/bmc/attr/<setting>`. For example:
142     curl -b cjar -k -H "Content-Type: application/json" -X PUT \
143         -d '{"data": 1}' \
144         https://${bmc}/org/openbmc/control/flash/bmc/attr/preserve_network_settings
150     curl -b cjar -k -H "Content-Type: application/json" -X POST \
151         -d '{"data": ["<TFTP server IP address>", "<filename>"]}' \
152         https://${bmc}/org/openbmc/control/flash/bmc/action/updateViaTftp
161     curl -b cjar -k https://${bmc}/org/openbmc/control/flash/bmc
166     curl -b cjar -k -H "Content-Type: application/json" -X POST \
167         -d '{"data": []}' \
168         https://${bmc}/org/openbmc/control/flash/bmc/action/GetUpdateProgress
172 - During downloading the tarball, the progress status is `Downloading`
173 - After the tarball is downloaded and verified, the progress status becomes
181     curl -b cjar -k -H "Content-Type: application/json" -X POST \
182         -d '{"data": []}' \
183         https://${bmc}/org/openbmc/control/flash/bmc/action/Apply
188 - During flashing the image, the status becomes `Writing images to flash`
189 - After it's flashed and verified, the status becomes
195 BMC control object:
197     curl -b cjar -k -H "Content-Type: application/json" -X POST \
198         -d '{"data": []}' \
199         https://${bmc}/org/openbmc/control/bmc0/action/warmReset