Gunnar Mills | ec1b41c | 2017-05-02 12:20:36 -0500 | [diff] [blame] | 1 | #pragma once |
| 2 | |
Gunnar Mills | ec1b41c | 2017-05-02 12:20:36 -0500 | [diff] [blame] | 3 | #include "activation.hpp" |
Lei YU | 56aaf45 | 2018-06-21 16:09:44 +0800 | [diff] [blame] | 4 | #include "item_updater_helper.hpp" |
Saqib Khan | 705f1bf | 2017-06-09 23:58:38 -0500 | [diff] [blame] | 5 | #include "version.hpp" |
Gunnar Mills | b0ce996 | 2018-09-07 13:39:10 -0500 | [diff] [blame] | 6 | #include "xyz/openbmc_project/Collection/DeleteAll/server.hpp" |
| 7 | |
| 8 | #include <sdbusplus/server.hpp> |
John Wang | 85c356f | 2019-09-11 16:20:13 +0800 | [diff] [blame] | 9 | #include <xyz/openbmc_project/Association/Definitions/server.hpp> |
Michael Tritz | 37a5904 | 2017-07-12 13:44:53 -0500 | [diff] [blame] | 10 | #include <xyz/openbmc_project/Common/FactoryReset/server.hpp> |
Michael Tritz | 0129d92 | 2017-08-10 19:33:46 -0500 | [diff] [blame] | 11 | #include <xyz/openbmc_project/Control/FieldMode/server.hpp> |
Gunnar Mills | ec1b41c | 2017-05-02 12:20:36 -0500 | [diff] [blame] | 12 | |
Adriana Kobylak | 58aa750 | 2020-06-08 11:12:11 -0500 | [diff] [blame] | 13 | #include <string> |
Bright Cheng | 8e9ccfe | 2019-11-18 16:18:44 +0800 | [diff] [blame] | 14 | #include <vector> |
Adriana Kobylak | 58aa750 | 2020-06-08 11:12:11 -0500 | [diff] [blame] | 15 | |
Gunnar Mills | ec1b41c | 2017-05-02 12:20:36 -0500 | [diff] [blame] | 16 | namespace phosphor |
| 17 | { |
| 18 | namespace software |
| 19 | { |
| 20 | namespace updater |
| 21 | { |
| 22 | |
Michael Tritz | 37a5904 | 2017-07-12 13:44:53 -0500 | [diff] [blame] | 23 | using ItemUpdaterInherit = sdbusplus::server::object::object< |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 24 | sdbusplus::xyz::openbmc_project::Common::server::FactoryReset, |
| 25 | sdbusplus::xyz::openbmc_project::Control::server::FieldMode, |
John Wang | 85c356f | 2019-09-11 16:20:13 +0800 | [diff] [blame] | 26 | sdbusplus::xyz::openbmc_project::Association::server::Definitions, |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 27 | sdbusplus::xyz::openbmc_project::Collection::server::DeleteAll>; |
Michael Tritz | 37a5904 | 2017-07-12 13:44:53 -0500 | [diff] [blame] | 28 | |
Patrick Williams | e75d10f | 2017-05-30 16:56:32 -0500 | [diff] [blame] | 29 | namespace MatchRules = sdbusplus::bus::match::rules; |
Gunnar Mills | 4844291 | 2017-10-06 13:34:07 -0500 | [diff] [blame] | 30 | using VersionClass = phosphor::software::manager::Version; |
Gunnar Mills | ded875d | 2017-08-28 16:44:52 -0500 | [diff] [blame] | 31 | using AssociationList = |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 32 | std::vector<std::tuple<std::string, std::string, std::string>>; |
Gunnar Mills | ded875d | 2017-08-28 16:44:52 -0500 | [diff] [blame] | 33 | |
Gunnar Mills | ec1b41c | 2017-05-02 12:20:36 -0500 | [diff] [blame] | 34 | /** @class ItemUpdater |
| 35 | * @brief Manages the activation of the BMC version items. |
| 36 | */ |
Michael Tritz | 37a5904 | 2017-07-12 13:44:53 -0500 | [diff] [blame] | 37 | class ItemUpdater : public ItemUpdaterInherit |
Gunnar Mills | ec1b41c | 2017-05-02 12:20:36 -0500 | [diff] [blame] | 38 | { |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 39 | public: |
| 40 | /* |
| 41 | * @brief Types of Activation status for image validation. |
| 42 | */ |
| 43 | enum class ActivationStatus |
| 44 | { |
| 45 | ready, |
| 46 | invalid, |
| 47 | active |
| 48 | }; |
Saqib Khan | 35e83f3 | 2017-05-22 11:37:32 -0500 | [diff] [blame] | 49 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 50 | /** @brief Constructs ItemUpdater |
| 51 | * |
| 52 | * @param[in] bus - The D-Bus bus object |
| 53 | */ |
| 54 | ItemUpdater(sdbusplus::bus::bus& bus, const std::string& path) : |
Lei YU | 56aaf45 | 2018-06-21 16:09:44 +0800 | [diff] [blame] | 55 | ItemUpdaterInherit(bus, path.c_str(), false), bus(bus), helper(bus), |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 56 | versionMatch(bus, |
| 57 | MatchRules::interfacesAdded() + |
| 58 | MatchRules::path("/xyz/openbmc_project/software"), |
| 59 | std::bind(std::mem_fn(&ItemUpdater::createActivation), |
| 60 | this, std::placeholders::_1)) |
| 61 | { |
Lei YU | 531fbc2 | 2021-12-10 20:03:18 +0800 | [diff] [blame] | 62 | getRunningSlot(); |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 63 | setBMCInventoryPath(); |
| 64 | processBMCImage(); |
| 65 | restoreFieldModeStatus(); |
Lei YU | 6e9fb1d | 2021-02-19 18:01:40 +0800 | [diff] [blame] | 66 | #ifdef HOST_BIOS_UPGRADE |
| 67 | createBIOSObject(); |
| 68 | #endif |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 69 | emit_object_added(); |
| 70 | }; |
Gunnar Mills | ec1b41c | 2017-05-02 12:20:36 -0500 | [diff] [blame] | 71 | |
Adriana Kobylak | bbcb7be | 2018-07-17 15:47:34 -0500 | [diff] [blame] | 72 | /** @brief Save priority value to persistent storage (flash and optionally |
| 73 | * a U-Boot environment variable) |
| 74 | * |
| 75 | * @param[in] versionId - The Id of the version |
| 76 | * @param[in] value - The priority value |
| 77 | * @return None |
| 78 | */ |
| 79 | void savePriority(const std::string& versionId, uint8_t value); |
| 80 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 81 | /** @brief Sets the given priority free by incrementing |
| 82 | * any existing priority with the same value by 1 |
| 83 | * |
| 84 | * @param[in] value - The priority that needs to be set free. |
| 85 | * @param[in] versionId - The Id of the version for which we |
| 86 | * are trying to free up the priority. |
| 87 | * @return None |
| 88 | */ |
| 89 | void freePriority(uint8_t value, const std::string& versionId); |
Saqib Khan | 4c1aec0 | 2017-07-06 11:46:13 -0500 | [diff] [blame] | 90 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 91 | /** |
| 92 | * @brief Create and populate the active BMC Version. |
| 93 | */ |
| 94 | void processBMCImage(); |
Saqib Khan | ba23988 | 2017-05-26 08:41:54 -0500 | [diff] [blame] | 95 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 96 | /** |
| 97 | * @brief Erase specified entry D-Bus object |
| 98 | * if Action property is not set to Active |
| 99 | * |
| 100 | * @param[in] entryId - unique identifier of the entry |
| 101 | */ |
| 102 | void erase(std::string entryId); |
Leonel Gonzalez | 3526ef7 | 2017-07-07 14:38:25 -0500 | [diff] [blame] | 103 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 104 | /** |
| 105 | * @brief Deletes all versions except for the current one |
| 106 | */ |
| 107 | void deleteAll(); |
Gunnar Mills | ded875d | 2017-08-28 16:44:52 -0500 | [diff] [blame] | 108 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 109 | /** @brief Creates an active association to the |
| 110 | * newly active software image |
| 111 | * |
| 112 | * @param[in] path - The path to create the association to. |
| 113 | */ |
| 114 | void createActiveAssociation(const std::string& path); |
Gunnar Mills | ded875d | 2017-08-28 16:44:52 -0500 | [diff] [blame] | 115 | |
Adriana Kobylak | 991af7e | 2018-12-10 13:08:38 -0600 | [diff] [blame] | 116 | /** @brief Removes the associations from the provided software image path |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 117 | * |
Adriana Kobylak | 991af7e | 2018-12-10 13:08:38 -0600 | [diff] [blame] | 118 | * @param[in] path - The path to remove the associations from. |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 119 | */ |
Adriana Kobylak | 991af7e | 2018-12-10 13:08:38 -0600 | [diff] [blame] | 120 | void removeAssociations(const std::string& path); |
Gunnar Mills | ded875d | 2017-08-28 16:44:52 -0500 | [diff] [blame] | 121 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 122 | /** @brief Determine if the given priority is the lowest |
| 123 | * |
| 124 | * @param[in] value - The priority that needs to be checked. |
| 125 | * |
| 126 | * @return boolean corresponding to whether the given |
| 127 | * priority is lowest. |
| 128 | */ |
| 129 | bool isLowestPriority(uint8_t value); |
Saqib Khan | b9da663 | 2017-09-13 09:48:37 -0500 | [diff] [blame] | 130 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 131 | /** |
| 132 | * @brief Updates the U-Boot variables to point to the requested |
| 133 | * versionId, so that the systems boots from this version on |
| 134 | * the next reboot. |
| 135 | * |
| 136 | * @param[in] versionId - The version to point the system to boot from. |
| 137 | */ |
| 138 | void updateUbootEnvVars(const std::string& versionId); |
Adriana Kobylak | b77551c | 2017-10-27 12:46:23 -0500 | [diff] [blame] | 139 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 140 | /** |
| 141 | * @brief Updates the uboot variables to point to BMC version with lowest |
| 142 | * priority, so that the system boots from this version on the |
| 143 | * next boot. |
| 144 | */ |
| 145 | void resetUbootEnvVars(); |
Saqib Khan | 49446ae | 2017-10-02 10:54:20 -0500 | [diff] [blame] | 146 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 147 | /** @brief Brings the total number of active BMC versions to |
| 148 | * ACTIVE_BMC_MAX_ALLOWED -1. This function is intended to be |
| 149 | * run before activating a new BMC version. If this function |
| 150 | * needs to delete any BMC version(s) it will delete the |
| 151 | * version(s) with the highest priority, skipping the |
| 152 | * functional BMC version. |
Adriana Kobylak | a696359 | 2018-09-07 14:13:29 -0500 | [diff] [blame] | 153 | * |
| 154 | * @param[in] caller - The Activation object that called this function. |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 155 | */ |
Lei YU | 0cd6d84 | 2021-12-27 11:56:02 +0800 | [diff] [blame] | 156 | void freeSpace(const Activation& caller); |
Adriana Kobylak | 204e1e7 | 2018-01-24 16:00:05 -0600 | [diff] [blame] | 157 | |
AppaRao Puli | 1bb6dcb | 2020-03-27 20:51:57 +0530 | [diff] [blame] | 158 | /** @brief Creates a updateable association to the |
| 159 | * "running" BMC software image |
| 160 | * |
| 161 | * @param[in] path - The path to create the association. |
| 162 | */ |
| 163 | void createUpdateableAssociation(const std::string& path); |
| 164 | |
Adriana Kobylak | ec4eec3 | 2019-11-13 14:28:35 -0600 | [diff] [blame] | 165 | /** @brief Persistent map of Version D-Bus objects and their |
| 166 | * version id */ |
| 167 | std::map<std::string, std::unique_ptr<VersionClass>> versions; |
| 168 | |
Bright Cheng | 8e9ccfe | 2019-11-18 16:18:44 +0800 | [diff] [blame] | 169 | /** @brief Vector of needed BMC images in the tarball*/ |
| 170 | std::vector<std::string> imageUpdateList; |
| 171 | |
Lei YU | 531fbc2 | 2021-12-10 20:03:18 +0800 | [diff] [blame] | 172 | /** @breif The slot of running BMC image */ |
| 173 | uint32_t runningImageSlot = 0; |
| 174 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 175 | private: |
| 176 | /** @brief Callback function for Software.Version match. |
| 177 | * @details Creates an Activation D-Bus object. |
| 178 | * |
| 179 | * @param[in] msg - Data associated with subscribed signal |
| 180 | */ |
| 181 | void createActivation(sdbusplus::message::message& msg); |
Gunnar Mills | ec1b41c | 2017-05-02 12:20:36 -0500 | [diff] [blame] | 182 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 183 | /** |
| 184 | * @brief Validates the presence of SquashFS image in the image dir. |
| 185 | * |
| 186 | * @param[in] filePath - The path to the image dir. |
| 187 | * @param[out] result - ActivationStatus Enum. |
| 188 | * ready if validation was successful. |
| 189 | * invalid if validation fail. |
| 190 | * active if image is the current version. |
| 191 | * |
| 192 | */ |
| 193 | ActivationStatus validateSquashFSImage(const std::string& filePath); |
Saqib Khan | 35e83f3 | 2017-05-22 11:37:32 -0500 | [diff] [blame] | 194 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 195 | /** @brief BMC factory reset - marks the read-write partition for |
| 196 | * recreation upon reboot. */ |
| 197 | void reset() override; |
Michael Tritz | 37a5904 | 2017-07-12 13:44:53 -0500 | [diff] [blame] | 198 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 199 | /** |
| 200 | * @brief Enables field mode, if value=true. |
| 201 | * |
| 202 | * @param[in] value - If true, enables field mode. |
| 203 | * @param[out] result - Returns the current state of field mode. |
| 204 | * |
| 205 | */ |
| 206 | bool fieldModeEnabled(bool value) override; |
Michael Tritz | 0129d92 | 2017-08-10 19:33:46 -0500 | [diff] [blame] | 207 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 208 | /** @brief Sets the BMC inventory item path under |
| 209 | * /xyz/openbmc_project/inventory/system/chassis/. */ |
| 210 | void setBMCInventoryPath(); |
Gunnar Mills | b60add1 | 2017-08-24 16:41:42 -0500 | [diff] [blame] | 211 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 212 | /** @brief The path to the BMC inventory item. */ |
| 213 | std::string bmcInventoryPath; |
Gunnar Mills | b60add1 | 2017-08-24 16:41:42 -0500 | [diff] [blame] | 214 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 215 | /** @brief Restores field mode status on reboot. */ |
| 216 | void restoreFieldModeStatus(); |
Michael Tritz | 0129d92 | 2017-08-10 19:33:46 -0500 | [diff] [blame] | 217 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 218 | /** @brief Creates a functional association to the |
| 219 | * "running" BMC software image |
| 220 | * |
| 221 | * @param[in] path - The path to create the association to. |
| 222 | */ |
| 223 | void createFunctionalAssociation(const std::string& path); |
Gunnar Mills | 88e8a32 | 2017-09-13 11:09:28 -0500 | [diff] [blame] | 224 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 225 | /** @brief Persistent sdbusplus D-Bus bus connection. */ |
| 226 | sdbusplus::bus::bus& bus; |
Gunnar Mills | ec1b41c | 2017-05-02 12:20:36 -0500 | [diff] [blame] | 227 | |
Lei YU | 56aaf45 | 2018-06-21 16:09:44 +0800 | [diff] [blame] | 228 | /** @brief The helper of image updater. */ |
| 229 | Helper helper; |
| 230 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 231 | /** @brief Persistent map of Activation D-Bus objects and their |
| 232 | * version id */ |
| 233 | std::map<std::string, std::unique_ptr<Activation>> activations; |
Gunnar Mills | ec1b41c | 2017-05-02 12:20:36 -0500 | [diff] [blame] | 234 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 235 | /** @brief sdbusplus signal match for Software.Version */ |
| 236 | sdbusplus::bus::match_t versionMatch; |
Gunnar Mills | ec1b41c | 2017-05-02 12:20:36 -0500 | [diff] [blame] | 237 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 238 | /** @brief This entry's associations */ |
| 239 | AssociationList assocs = {}; |
Gunnar Mills | ded875d | 2017-08-28 16:44:52 -0500 | [diff] [blame] | 240 | |
Adriana Kobylak | 2285fe0 | 2018-02-27 15:36:59 -0600 | [diff] [blame] | 241 | /** @brief Clears read only partition for |
| 242 | * given Activation D-Bus object. |
| 243 | * |
| 244 | * @param[in] versionId - The version id. |
| 245 | */ |
| 246 | void removeReadOnlyPartition(std::string versionId); |
Eddie James | eaa1ee0 | 2018-03-01 10:09:10 -0600 | [diff] [blame] | 247 | |
| 248 | /** @brief Copies U-Boot from the currently booted BMC chip to the |
| 249 | * alternate chip. |
| 250 | */ |
| 251 | void mirrorUbootToAlt(); |
Bright Cheng | 8e9ccfe | 2019-11-18 16:18:44 +0800 | [diff] [blame] | 252 | |
| 253 | /** @brief Check the required image files |
| 254 | * |
| 255 | * @param[in] filePath - BMC tarball file path |
| 256 | * @param[in] imageList - Image filenames included in the BMC tarball |
| 257 | * @param[out] result - Boolean |
| 258 | * true if all image files are found in BMC tarball |
| 259 | * false if one of image files is missing |
| 260 | */ |
| 261 | bool checkImage(const std::string& filePath, |
| 262 | const std::vector<std::string>& imageList); |
Lei YU | 6e9fb1d | 2021-02-19 18:01:40 +0800 | [diff] [blame] | 263 | |
| 264 | #ifdef HOST_BIOS_UPGRADE |
| 265 | /** @brief Create the BIOS object without knowing the version. |
| 266 | * |
| 267 | * The object is created only to provide the DBus access so that an |
| 268 | * external service could set the correct BIOS version. |
| 269 | * On BIOS code update, the version is updated accordingly. |
| 270 | */ |
| 271 | void createBIOSObject(); |
| 272 | |
| 273 | /** @brief Persistent Activation D-Bus object for BIOS */ |
| 274 | std::unique_ptr<Activation> biosActivation; |
| 275 | |
Lei YU | 16aa28a | 2021-05-07 10:17:30 +0800 | [diff] [blame] | 276 | public: |
Lei YU | 6e9fb1d | 2021-02-19 18:01:40 +0800 | [diff] [blame] | 277 | /** @brief Persistent Version D-Bus object for BIOS */ |
| 278 | std::unique_ptr<VersionClass> biosVersion; |
| 279 | #endif |
Lei YU | 531fbc2 | 2021-12-10 20:03:18 +0800 | [diff] [blame] | 280 | |
| 281 | /** @brief Get the slot number of running image */ |
| 282 | void getRunningSlot(); |
Gunnar Mills | ec1b41c | 2017-05-02 12:20:36 -0500 | [diff] [blame] | 283 | }; |
| 284 | |
Gunnar Mills | ec1b41c | 2017-05-02 12:20:36 -0500 | [diff] [blame] | 285 | } // namespace updater |
| 286 | } // namespace software |
| 287 | } // namespace phosphor |