openbmc_project/Software/README.md

13    installed onto that item. A specific example of this would be a process that
16 A simple system design would be to include a single _ImageManager_ and two
22 to allow additional images to be added to the BMC, such as Object.Add() for REST
24 also be provided to facilitate removing images which are no longer needed.
25 Images maintained in the file system would be presented as a corresponding
27 `xyz.openbmc_project.Common.FilePath` interface would be provided to specify the
51 interface will be at the exact same path as the _ImageManager_'s
53 appropriate when the software image can be applied to exactly one device in the
72 each `Software.Version`. This allows the same software version to be contained
75 A reasonable algorithm might be:
81 can be challenging. For the BMC, two different images may both be the same size
84 properly. It is therefore important to be able to specify more details than
93 identifiers that can be used to map to common software implementations, in a
101 strings identifying the system element this image can be applied to.
104 strings shall be of the following format:
113   `BoardBar`. Typically these would be code names for the hardware element such
125 If an image contains sub-sections which can be applied to multiple system
132 `xyz.openbmc_project.Software.Activation` has a property Activation that can be
136    version and it is therefore not ready for activation. This might be used on
141    detected via CRC or security verification failure. An event may be recorded
143 3. _Ready_ - Indicating that the `Software.Version` can be activated.
147    on systems with redundant storage devices a version might be _Active_ but not
150    has failed. An event may be recorded with additional details.
151 7. _Staged_ - The `Software.Version` is in staged flash region. This will be
160 RequestedApplyTime that indicates when the newly applied software image will be
163 values and the value can be supplied through HttpPushUriApplyTime object:
165 1. _Immediate_ - Indicating that the `Software.Version` needs to be activated
167 2. _OnReset_ - Indicating that the `Software.Version` needs to be activated on
175 `xyz.openbmc_project.Software.ActivationBlocksTransition` may be added to any
180 BMC reboot. This could be facilitated with systemd service specifiers.
184 All version identifiers are implementation specific strings. No format should be
188 identifiers. The `xyz.openbmc_project.Software.ExtendedVersion` interface can be
211 Prior to `Activation`, it can be useful to indicate a desired
212 `RedundancyPriority`. This can be done by setting the `Priority` on the
214 not honor this field or be unable to comply with the request, in which case the
231 In some designs there may be multiple _ItemUpdater_ instances which are handling
241 settings of the given software. The `Software.Settings` should be added to along
262 List `/xyz/openbmc_project/software/`. This list can be filtered to just active