tools/power-utils/updater.hpp

8  *     http://www.apache.org/licenses/LICENSE-2.0
33 constexpr auto FW_UPDATE_FAILED_MSG =
35 constexpr auto PSU_FW_FILE_ISSUE_MSG =
37 constexpr auto FW_UPDATE_SUCCESS_MSG =
40 constexpr auto ERROR_SEVERITY = "xyz.openbmc_project.Logging.Entry.Level.Error";
41 constexpr auto INFORMATIONAL_SEVERITY =
47  * @param[in] bus - The sdbusplus DBus bus connection
48  * @param[in] psuInventoryPath - The inventory path of the PSU
49  * @param[in] imageDir - The directory containing the PSU image
61  * @param[in] bus - The sdbusplus DBus bus connection
62  * @param[in] psuInventoryPath - The inventory path of the PSU
63  * @param[in] imageDir - The directory containing the PSU image
84      * @param psuInventoryPath - The PSU inventory path
85      * @param devPath - The PSU device path
86      * @param imageDir - The update image directory
96      * @param doBind - indicate if it's going to bind or unbind the driver
102      * @param present - The present state to set
114      * @return 0 if success, otherwise non-zero
118     /** @brief Create I2C device
120      * Creates the I2C device based on the device name.
121      * e.g. It opens busId 3, address 0x68 for "3-0068"
150     /** @brief I2C interface accessor */
151     i2c::I2CInterface* getI2C()  in getI2C()
153         return i2c.get();  in getI2C()
165      * @param[in] additionalData Additional key-value pairs containing details
173      * @brief Retrieves additional data related to I2C communication.
175      * This method collects and returns I2C bus information, including the
179      * @return A map containing I2C-related key-value pairs.
184      * @brief Call out an I2C-related Predictive Error Log.
186      * This method creates a serviceable event log related to I2C failures.
187      * It collects additional data about the I2C communication and logs the
190      * @param[in] extraAdditionalData Additional key-value pairs specific to
201      * @brief Call out a PSU-related Predictive Error Log.
206      * @param[in] extraAdditionalData Additional key-value pairs specific to
207      *                                the PSU-related error.
213      * @brief Call out a software-related Predictive Error Log.
216      * software-related errors. It merges any additional error-specific data
219      * @param[in] extraAdditionalData Additional key-value pairs specific to
220      *                                the software-related error.
287      * Usually it is a device in i2c subsystem, e.g.
288      *   /sys/bus/i2c/devices/3-0068
294      * Usually it is a i2c device name, e.g.
295      *   3-0068
305      *   /sys/bus/i2c/drivers/ibm-cffps
309     /** @brief The i2c device interface */
310     std::unique_ptr<i2c::I2CInterface> i2c;  member in updater::Updater
328  * @param[in] model - PSU model number
329  * @param[in] psuInventoryPath - PSU inventory path
330  * @param[in] devPath - Device path
331  * @param[in] imageDir - Image directory
342  * @param[in] directory - Path to FS directory
349  * @brief Calculate CRC-8 for a data vector
351  * @param[in] data - Firmware data block
360  * @param[in] milliseconds - Time in milliseconds
365  * @brief Convert a big-endian value to little-endian
367  * @param[in] bigEndianValue - Uint 32 bit value
376  * @param[in] fileName - Firmware file name
385  * @param[in] fileName - Firmware file name
394  * @param[in] inputFile - Input file stream
395  * @param[in] numberOfBytesToRead - Number of bytes to read from firmware file.