phosphor-power/phosphor-power-supply/psu_manager.hpp

7 #include <phosphor-logging/log.hpp>
22 using namespace phosphor::power::psu;
25 namespace phosphor::power::manager  namespace
33 // Validation timeout. Allow 30s to detect if new EM interfaces show up in D-Bus
54  * This class will create an object used to manage and monitor a list of power
68      * Constructor to read configuration from D-Bus.
70      * @param[in] bus - D-Bus bus object
71      * @param[in] e - event object
76      * Get PSU properties from D-Bus, use that to build a power supply
79      * @param[in] properties - A map of property names and values
85      * Get PSU configuration from D-Bus
91      *        D-Bus object provided by Entity Manager.
107         return timer->get_event().loop();  in run()
120             psu->onOffConfig(data);  in onOffConfig()
127      * with a clean state. Presence changes and power state changes will want
135             psu->clearFaults();  in clearFaults()
140      * Get the status of Power on.
149      * The D-Bus object
154      * The timer that runs to periodically check the power supplies.
161      * The timer that performs power supply validation as the entity manager
162      * interfaces show up in d-bus.
169      * Let power control/sequencer application know of PSU error(s).
171      * @param[in] psuErrorString - string for power supply error
178      * @param[in] faultName - 'name' message for the BMC error log entry
179      * @param[in,out] additionalData - The AdditionalData property for the error
185      * Analyze the status of each of the power supplies.
192      * @brief Analyze the set of the power supplies for a brownout failure. Log
197     /** @brief True if the power is on. */
200     /** @brief True if power control is in the window between chassis pgood loss
201      * and power off. */
207     /** @brief Used as part of subscribing to power on state changes*/
210     /** @brief Used to subscribe to D-Bus power on state changes */
213     /** @brief Used to subscribe to D-Bus power supply presence changes */
220      * @brief Callback for power state property changes
224      * @param[in] msg - Data associated with the power state signal
231      * Process change of the Present property for power supply.
233      * @param[in]  msg - Data associated with the Present change signal
238      * @brief Callback for entity-manager interface added
243      * @param[in] msg - Data associated with the interfaces added signal
251      * power supply D-Bus inventory objects.
260             psu->updateInventory();  in updateInventory()
267      * @param[in] properties - A map of property names and values
272      * @brief Update inventory for missing required power supplies
277      * @brief Perform power supply configuration validation.
278      * @details Validates if the existing power supply properties are a
286      * multiple times due to interfaces added signal. Set to true during power
287      * off to trigger the validation on power on.
296      * @param[out] additionalData - Contains debug information on why the check
313      * @param[in] psu - Power supply to check
321      * @param[out] model - The model name. Empty if there is a mismatch.
322      * @param[out] additionalData - If there is a mismatch, it contains debug
330      * @brief Set the power-config-full-load GPIO depending on the EM full load
342      * @brief The vector for power supplies.
347      * @brief The libgpiod object for setting the power supply config
361      * /xyz/openbmc_project/power/power_supplies root D-Bus path.
370      * /xyz/openbmc_project/sensors root D-Bus path.
375      * @brief GPIO to toggle to 'sync' power supply input history.
380      * @brief Toggles the GPIO to sync power supply input history readings
382      * This GPIO is connected to all supplies.  This will clear the
383      * previous readings out of the supplies and restart them both at the
384      * same time zero and at record ID 0.  The supplies will return 0
394      * @brief Tells each PSU to set its power supply input
395      *        voltage rating D-Bus property.
401             psu->setInputVoltageRating();  in setInputVoltageRating()
406      * @brief Build the device driver name for the power supply.
408      * @param[in] i2cbus - i2c bus
409      * @param[in] i2caddr - i2c bus address
420      * @brief The device driver name for all power supplies.
425 } // namespace phosphor::power::manager