architecture/code-update/code-update.md

5 - Static, non-UBI layout
6 - UBI layout - enabled via `obmc-ubi-fs` distro feature
14 1. Get a BMC image tar: After building OpenBMC, you will end up with a set of
16    - The UBI layout image is
17      `obmc-phosphor-image-<platform>-<timestamp>.ubi.mtd.tar`
18    - The static layout image is
19      `obmc-phosphor-image-<platform>-<timestamp>.static.mtd.tar`
21    The BMC tar image contains 5 files: u-boot, kernel, ro, and rw partitions and
30    version=2.7.0-dev
32    HashType=RSA-SHA256
37    - Method 1: Via Redfish Upload:
38      <https://github.com/openbmc/docs/blob/master/REDFISH-cheatsheet.md#firmware-update>.
40    - Method 2: Via scp: Copy the generated BMC image to the `/tmp/images/`
42    - Method 3: Via REST Upload:
43      <https://github.com/openbmc/docs/blob/master/rest-api.md#uploading-images>
44    - Method 4: Via TFTP: Perform a POST request to call the `DownloadViaTFTP`
50    value of 8 hexadecimal numbers, generated by SHA-512 hashing the version
53    - Method 1: From the BMC command line, note the most recent directory name
57    # ls -l /tmp/images/
59      drwx------    2 root     root            80 Aug 22 07:54 2a1022fe
60      drwx------    2 root     root            80 Aug 22 07:53 488449a2
63    - Method 2: This method _only_ works if there are no `Ready` images at the
65      has its Activation property set to Ready, in this example it'd be
69      $ curl -b cjar -k https://${bmc}/xyz/openbmc_project/software/enumerate
76    - Method 3: Calculate the version id beforehand from the image with:
79 … xfO <BMC tar image> MANIFEST | sed -ne '/version=/ {s/version=//;p}' | head -n1 | tr -d '\n' | sh…
82 4. To initiate the update, set the `RequestedActivation` property of the desired
86    - Method 1: From the BMC command line:
89      busctl set-property xyz.openbmc_project.Software.BMC.Updater \
96    - Method 2: Using the REST API:
99      curl -b cjar -k -H "Content-Type: application/json" -X PUT \
100        -d '{"data":
108    - Method 1: From Redfish: A task is returned from the Redfish upload. The
112     curl -k https://${bmc}/redfish/v1/TaskService/Tasks/0
115    - Method 2: From the BMC command line:
118      busctl get-property xyz.openbmc_project.Software.BMC.Updater  \
123    - Method 3: Using the REST API:
126      curl -b cjar -k https://${bmc}/xyz/openbmc_project/software/<id>/attr/Progress
130    is set to "Active" via one of the following methods:
131    - Method 1: From Redfish: Check the task returned from the Redfish upload.
134      curl -k https://${bmc}/redfish/v1/TaskService/Tasks/0
137    - Method 2: From the BMC command line:
140      busctl get-property xyz.openbmc_project.Software.BMC.Updater \
145    - Method 3: Using the REST API:
148      curl -b cjar -k https://${bmc}/xyz/openbmc_project/software/<id>
152    - Method 1: From Redfish: If ApplyTime was set to "Immediate", the BMC will
154      <https://github.com/openbmc/docs/blob/master/REDFISH-cheatsheet.md#firmware-applytime>.
156      <https://github.com/openbmc/docs/blob/master/REDFISH-cheatsheet.md#bmc-reboot>.
158    - Method 2: From the BMC command line:
164    - Method 3: Using the REST API:
167      curl -c cjar -b cjar -k -H "Content-Type: application/json" -X PUT \
168          -d '{"data": "xyz.openbmc_project.State.BMC.Transition.Reboot"}' \
178 curl -c cjar -b cjar -k -H "Content-Type: application/json" -X GET  \
202    curl -c cjar -b cjar -k -H "Content-Type: application/json" -X GET \
222    curl -c cjar -b cjar -k -H "Content-Type: application/json" -X GET \
260    curl -c cjar -b cjar -k -H "Content-Type: application/json" -X GET \
276    curl -c cjar -b cjar -k -H "Content-Type: application/json" -X GET  \
297 - version - The version of the image
298 - purpose - The image's purpose (e.g.
302 …[Version interface](https://github.com/openbmc/phosphor-dbus-interfaces/blob/6f69ae5b33ee224358cb4…
304 - MachineName - The name of machine (platform) for which this image is built
306   in os-release file of running image. Image will not be upgraded if this check
313 - extended_version - A more detailed version, which could include versions of
321 curl -c cjar -b cjar -k -H "Content-Type: application/json" \
322     -X POST https://${bmc}/xyz/openbmc_project/software/<$id>/action/delete \
323     -d "{\"data\": [] }"
326 Note: The image must be non-functional ("non-running").
328 To delete all non-functional images, whether BMC or host images:
331 curl -c cjar -b cjar -k -H "Content-Type: application/json" \
332     -X POST https://${bmc}/xyz/openbmc_project/software/action/deleteAll \
333     -d "{\"data\": [] }"
343 intended to be a one-way operation which means that once enabled, there is no
349 curl -b cjar -k -H 'Content-Type: application/json' -X PUT -d '{"data":1}'  \
354 Although field mode is meant to be a one-way operation, it can be disabled by a
360 systemctl unmask usr-local.mount
366 <https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Control/F…
375 curl -b cjar -k -H 'Content-Type: application/json' -X POST -d '{"data":[]}' \
382 image on the system, clear the shared preserve host volume, pnor-prsv, and clear
386 <https://github.com/openbmc/phosphor-dbus-interfaces/blob/02b39246d45ea029a1652a49cc20eab7723dd63b/…
392 When a BMC image is activated, each `image-<name>` is written to the BMC chip's
395 - image-u-boot
396 - image-kernel
397 - image-rofs
398 - image-rwfs
402 When a BMC image is activated (i.e. when "RequestedActivation" is set to
406 images to be stored. By default, only the BMC chip is used. To use both, set
407 "BMC_RO_MTD" to "alt-bmc+bmc".
412 <https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Software>
413 and <https://github.com/openbmc/phosphor-bmc-code-mgmt>