openbmc/openpower-occ-control/powermode.hpp

34 constexpr auto PMODE_PATH = "/xyz/openbmc_project/control/host0/power_mode";
35 constexpr auto PMODE_INTERFACE = "xyz.openbmc_project.Control.Power.Mode";
36 constexpr auto POWER_MODE_PROP = "PowerMode";
37 constexpr auto POWER_SAFE_MODE_PROP = "SafeMode";
39 constexpr auto PIPS_PATH = "/xyz/openbmc_project/control/host0/power_ips";
40 constexpr auto PIPS_INTERFACE =
42 constexpr auto IPS_ACTIVE_PROP = "Active";
43 constexpr auto IPS_ENABLED_PROP = "Enabled";
44 constexpr auto IPS_ENTER_UTIL = "EnterUtilizationPercent";
45 constexpr auto IPS_ENTER_TIME = "EnterDwellTime";
46 constexpr auto IPS_EXIT_UTIL = "ExitUtilizationPercent";
47 constexpr auto IPS_EXIT_TIME = "ExitDwellTime";
49 const auto PMODE_DEFAULT_INTERFACE =
59  * @param[in] i_modeString - power mode string
111      *  @param[in] newMode - desired System Power Mode
112      *  @param[in] oemModeData - data required by some OEM Power Modes
124      *  @param[in] modeLock - desired System Power Mode Lock
133      *  @param[in] enabled - Idle Power Save status (true = enabled)
134      *  @param[in] enterUtil - IPS Enter Utilization (%)
135      *  @param[in] enterTime - IPS Enter Time (seconds)
136      *  @param[in] exitUtil - IPS Exit Utilization (%)
137      *  @param[in] exitTime - IPS Exit Time (seconds)
154      *  @param[out] mode - current system power mode
155      *  @param[out] oemModeData - frequency data for some OEM mode
171      *  @param[out] enabled - Idle Power Save status (true = enabled)
172      *  @param[out] enterUtil - IPS Enter Utilization (%)
173      *  @param[out] enterTime - IPS Enter Time (seconds)
174      *  @param[out] exitUtil - IPS Exit Utilization (%)
175      *  @param[out] exitTime - IPS Exit Time (seconds)
227     static constexpr auto powerModeFilename = "powerModeData";
253      * @param[in] managerRef - manager object reference
254      * @param[in] modePath - Power Mode dbus path
255      * @param[in] ipsPath - Idle Power Saver dbus path
280      * @param[in] newMode     - desired system power mode
281      * @param[in] oemModeData - data required by some OEM Power Modes
299      * @param[in]  occPath - hwmon path for master OCC
306      * @param[in]  isActive - true when master OCC is active
315      *  @param[in] poll - Indicates whether or not the IPS state file should
318     void addIpsWatch(bool poll = true);
328      *  @param[in] value - Intended value
330      *  @return          - the value or Updated value of the property
336      *  @param[in] mode  - potential mode
338      *  @return          - true if the mode is valid
355     /** @brief Pass-through occ path on the bus */
406     /** @brief register for the callback from the POLL IPS changed event */
411      * @param[out] currentMode - current system power mode
412      * @param[out] oemModeData - frequency data for some OEM mode
420      * @param[in]  newMode - desired power mode
430      * @param[in]  msg - Data associated with IPS change signal
437      *  @param[out] enabled - Idle Power Save status (true = enabled)
438      *  @param[out] enterUtil - IPS Enter Utilization (%)
439      *  @param[out] enterTime - IPS Enter Time (seconds)
440      *  @param[out] exitUtil - IPS Exit Utilization (%)
441      *  @param[out] exitTime - IPS Exit Time (seconds)
450      *  @param[in] enabled - Idle Power Save status (true = enabled)
451      *  @param[in] enterUtil - IPS Enter Utilization (%)
452      *  @param[in] enterTime - IPS Enter Time (seconds)
453      *  @param[in] exitUtil - IPS Exit Utilization (%)
454      *  @param[in] exitTime - IPS Exit Time (seconds)
470      * @param[out] defaultMode - default system power mode
478      *  @param[out] enabled - Idle Power Save status (true = enabled)
479      *  @param[out] enterUtil - IPS Enter Utilization (%)
480      *  @param[out] enterTime - IPS Enter Time (seconds)
481      *  @param[out] exitUtil - IPS Exit Utilization (%)
482      *  @param[out] exitTime - IPS Exit Time (seconds)
497     /** @brief Read the supported power modes from entity-manager and update
510     /** @brief callback for the POLL IPS changed event
512      *  @param[in] es       - Populated event source
513      *  @param[in] fd       - Associated File descriptor
514      *  @param[in] revents  - Type of event
515      *  @param[in] userData - User data that was passed during registration
534     int fd = -1;