architecture/code-update/code-update.md

3 Two BMC Code layouts are available:
12 The following are the steps to update the BMC.
14 1. Get a BMC image tar: After building OpenBMC, you will end up with a set of
21    The BMC tar image contains 5 files: u-boot, kernel, ro, and rw partitions and
29    purpose=xyz.openbmc_project.Software.Version.VersionPurpose.BMC
36 2. Transfer the generated BMC image to the BMC via one of the following methods:
40    - Method 2: Via scp: Copy the generated BMC image to the `/tmp/images/`
41      directory on the BMC.
53    - Method 1: From the BMC command line, note the most recent directory name
69      $ curl -b cjar -k https://${bmc}/xyz/openbmc_project/software/enumerate
79 …tar xfO <BMC tar image> MANIFEST | sed -ne '/version=/ {s/version=//;p}' | head -n1 | tr -d '\n' |…
84    previous step, this will write the contents of the image to the BMC chip via
86    - Method 1: From the BMC command line:
89      busctl set-property xyz.openbmc_project.Software.BMC.Updater \
102        https://${bmc}/xyz/openbmc_project/software/<id>/attr/RequestedActivation
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  \
126      curl -b cjar -k https://${bmc}/xyz/openbmc_project/software/<id>/attr/Progress
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 \
148      curl -b cjar -k https://${bmc}/xyz/openbmc_project/software/<id>
151 7. Reboot the BMC for the image to take effect.
152    - Method 1: From Redfish: If ApplyTime was set to "Immediate", the BMC will
155      To reboot the BMC manually see:
156      <https://github.com/openbmc/docs/blob/master/REDFISH-cheatsheet.md#bmc-reboot>.
158    - Method 2: From the BMC command line:
168          -d '{"data": "xyz.openbmc_project.State.BMC.Transition.Reboot"}' \
169          https://${bmc}/xyz/openbmc_project/state/bmc0/attr/RequestedBMCTransition
179     https://${bmc}/xyz/openbmc_project/software/
193 1. A "functional" association to the "running" BMC and host images
195    There is only one functional association per BMC and one functional
196    association per host. The functional/running BMC image is the BMC image with
197    the lowest priority when rebooting the BMC. The functional image does not
198    update until the BMC is rebooted. The functional host image behaves the same
203        https://${bmc}/xyz/openbmc_project/software/functional
216 2. An "active" association to the active BMC and host images
218    Note: Several BMC images might be active, this is true for the host images as
223        https://${bmc}/xyz/openbmc_project/software/active
240    BMC OOB interfaces like Redfish/IPMI. All updateable firmware components must
261       https://${bmc}/xyz/openbmc_project/software/493a00ad/inventory
265          "/xyz/openbmc_project/inventory/system/chassis/motherboard/boxelder/bmc"
277        https://${bmc}/xyz/openbmc_project/inventory/system/chassis/activation
292 via TFTP, or copied to the BMC.
299   xyz.openbmc_project.Software.Version.VersionPurpose.BMC or
322     -X POST https://${bmc}/xyz/openbmc_project/software/<$id>/action/delete \
328 To delete all non-functional images, whether BMC or host images:
332     -X POST https://${bmc}/xyz/openbmc_project/software/action/deleteAll \
341 interface disables patching of the BMC by not mounting `/usr/local`, which in
350     https://${bmc}/xyz/openbmc_project/software/attr/FieldModeEnabled
355 user with admin privileges by running the following commands on the BMC:
370 Software factory reset resets the BMC and host firmware to its factory state by
372 command and then reboot the BMC:
376     https://${bmc}/xyz/openbmc_project/software/action/Reset
380 The factory reset on the BMC side will clear `/var`, `/home`, and `/etc`. On the
392 When a BMC image is activated, each `image-<name>` is written to the BMC chip's
402 When a BMC image is activated (i.e. when "RequestedActivation" is set to
403 "Active"), UBI volumes are created on the BMC chip for the image. The alternate
404 BMC chip can also be used to store images. This is determined by "BMC_RO_MTD".
405 Using both the alternate BMC chip and the BMC chip allows for multiple BMC
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".
413 and <https://github.com/openbmc/phosphor-bmc-code-mgmt>