openbmc/phosphor-ipmi-flash/README.md

7 [OpenBMC docs](https://github.com/openbmc/docs/blob/master/designs/firmware-update-via-blobs.md).
9 ## Building and using the host-tool
11 This repo contains a host-tool implementation for talking to the corresponding
14 ### Building the host-tool
16 The host-tool depends on ipmi-blob-tool and pciutils.
21 [xorg-macros source](https://gitlab.freedesktop.org/xorg/util/macros).
26 ./autogen.sh --prefix=/usr
41 #### Building ipmi-blob-tool
44 [ipmi-blob-tool source](https://github.com/openbmc/ipmi-blob-tool).
62 meson setup -Dexamples=false -Dtests=disabled builddir
63 ninja -C builddir
64 ninja -C builddir install
67 #### Building burn_my_bmc (the host-tool)
70 [phosphor-ipmi-flash source](https://github.com/openbmc/phosphor-ipmi-flash).
76 ./configure --disable-build-bmc-blob-handler
84 …configure --enable-oe-sdk --host "$(uname -m)" --disable-build-bmc-blob-handler AR=x86_64-openbmc-…
89 The host-tool has parameters that let the caller specify every required detail.
94 …----------- | ------------------------------------------------------------------------ | ---------…
96 …ipci`, `ipminet`, `ipmipci-skip-bridge-disable` | The data transport mechanism, typically `ipmilpc…
105 If you're using a net data transfer mechanism, you'll also need two additional
108 defaults to 623, the same port as IPMI LAN+.
113 file over IPMI packets, which is a very slow process. A 32-MiB image can take ~3
114 hours to send via this method. This can be done in <1 minutes via the PCI or net
117 This is implemented as a phosphor blob handler.
124 Basically the IPMI OEM handler receives the image in one fashion or another and
132 will check for files named "`image-*`" and flash them appropriately for each
133 name to section. The IPMI command creates a file `/run/initramfs/bmc-image` and
147 To use `phosphor-ipmi-flash` a platform must provide a configuration. A platform
157 | ------------------------ | ------------------------------------------------------- |
158 | `--enable-static-layout` | Enable treating the update as a static layout update.   |
159 | `--enable-tarball-ubi`   | Enable treating the update as a tarball for UBI update. |
160 | `--enable-host-bios`     | Enable receiving the update for a host bios update.     |
163 transfer the data. By default, the data-in-IPMI mechanism is enabled.
166 via the LPC memory region, the PCI-to-AHB memory region, or sending over a
169 platform's device-tree may have the region locked to a specific driver
170 (lpc-aspeed-ctrl), preventing the region from other use.
176 | ---------------- | ------- | --------------------------------------------------------------------…
177 | `MAPPED_ADDRESS` | 0       | The address used for mapping P2A or LPC into the BMC's memory-space.…
179 There are two kinds of PCI device-id for NPCM7xx and NPCM8xx respectively. For
180 NPCM7xx the device-id is using 0x0750 and NPCM8xx is using 0x0850. Use this
182 platforms and make in-band firmware update work well.
185 | ----------------- | ------- | ------------------------------------- |
186 | `NUVOTON_PCI_DID` | 0x0750  | The device-id for Nuvoton PCI bridge. |
193 | --------------------- | ---------------------- |
194 | `--enable-aspeed-p2a` | Use with ASPEED parts. |
201 | ---------------------- | ----------------------- |
202 | `--enable-aspeed-lpc`  | Use with ASPEED parts.  |
203 | `--enable-nuvoton-lpc` | Use with Nuvoton parts. |
207 NOTE: This mechanism is only intended to be used in-band and not exposed
211 | --------------------- | --------------------------- |
212 | `--enable-net-bridge` | Enable net transport bridge |
217 | ------------------------- | ------------------------------------------------ |
218 | `--enable-cleanup-delete` | Provide a simple blob id that deletes artifacts. |
224 | ------------------------ | -------------------------------------- |
225 | `--enable-reboot-update` | Enable use of reboot update mechanism. |
228 option can be enabled. Note that `--enable-update-status` option and the above
229 `--enable-reboot-update` option cannot be enabled at the same time.
232 | ------------------------ | --------------------------------- |
233 | `--enable-update-status` | Enable use of update status file. |
239 | -------------- | ------------------------------ |
240 | `--enable-ppc` | Enable PPC host memory access. |
248 | ----------------------------- | ----------------------------------------- | ---------------------…
249 | `STATIC_HANDLER_STAGED_NAME`  | `/run/initramfs/bmc-image`                | The filename where to…
250 | `TARBALL_STAGED_NAME`         | `/tmp/image-update.tar`                   | The filename where to…
252 | `PREPARATION_DBUS_SERVICE`    | `phosphor-ipmi-flash-bmc-prepare.target`  | The systemd target st…
254 | `VERIFY_DBUS_SERVICE`         | `phosphor-ipmi-flash-bmc-verify.target`   | The systemd target st…
255 | `UPDATE_DBUS_SERVICE`         | `phosphor-ipmi-flash-bmc-update.target`   | The systemd target st…
257 | `BIOS_STAGED_NAME`            | `/tmp/bios-image`                         | The file to use for s…
259 | `PREPARATION_BIOS_TARGET`     | `phosphor-ipmi-flash-bios-prepare.target` | The systemd target wh…
260 | `VERIFY_BIOS_TARGET`          | `phosphor-ipmi-flash-bios-verify.target`  | The systemd target st…
261 | `UPDATE_BIOS_TARGET`          | `phosphor-ipmi-flash-bios-update.target`  | The systemd target st…
272 describes how a host-side tool is expected to talk to it (triggering different