openbmc/openpower-occ-control/powercap.hpp

9 #include <xyz/openbmc_project/Control/Power/CapLimits/server.hpp>
29 namespace Base = sdbusplus::xyz::openbmc_project::Control::Power::server;
56     /** @brief Loads any saved power cap data */
62     /** @brief Save Power Mode data to persistent file
64      *  @param[in] softMin - soft minimum power cap in Watts
65      *  @param[in] hardMin - hard minimum power cap in Watts
66      *  @param[in] max     - maximum power cap in Watts
78     /** @brief Return the power cap limits
80      *  @param[out] softMin - soft minimum power cap in Watts
81      *  @param[out] hardMin - hard minimum power cap in Watts
82      *  @param[out] max     - maximum power cap in Watts
92     /** @brief Return true if the power cap limits are available */
98     /** @brief Saves the Power Mode data in the filesystem. */
101     /** @brief Trace the Power Mode and IPS parameters. */
105     /** @brief Power Mode data filename to store persistent data */
108     /** @brief Power Mode data object to be persisted */
111     /** @brief Loads the persisted power cap data from the filesystem. */
116  *  @brief Monitors for changes to the power cap and notifies occ
118  *  The customer power cap is provided to the OCC by host TMGT when the occ
120  *  the power cap to the OCC if the cap is changed while the occ is active.
128      * This object will monitor for changes to the power cap setting and
129      * power cap enable properties.  If a change is detected, and the occ
132      * @param[in] occStatus - The occ status object
143                 sdbusRule::argN(0, "xyz.openbmc_project.Control.Power.Cap") +  in PowerCap()
148         //  Read the current limits from persistent data  in PowerCap()
151         // Update limits on dbus  in PowerCap()
154         this->emit_object_added();  in PowerCap()
158      * power)
160      * @param[in]  pcap        - Current user power cap setting (input/AC power)
161      * @param[in]  pcapEnabled - Current power cap enable setting
167     /** @brief Read the power cap bounds from sysfs and update DBus */
171     /** @brief Persisted power cap limits */
178      * @param[in]  msg       - Data associated with pcap change signal
183     /** @brief Get the power cap property
185      * @return Power cap, 0 on failure to indicate no pcap
189     /** @brief Get the power cap enable property
191      * @return Whether power cap enabled, will return false on error
195     /** @brief Write the output/DC power cap to the occ hwmon entry
197      * @param[in]  pcapValue - Power cap value to write to OCC
201     /** @brief Read the user power cap from sysfs
203      * @return User power cap value in Watts or 0 if disabled
208      * @brief Returns the filename to use for the user power cap
213      * @param[in] expr - Regular expression of file to find
228     /** @brief Update the power cap bounds on DBus
230      * @param[in]  softMin - soft minimum power cap in Watts
231      * @param[in]  hardMin - hard minimum power cap in Watts
232      * @param[in]  pcapMax - maximum power cap in Watts