xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Control/Power/Mode.interface.yaml (revision e2c9bc74f2b8c0e78c305894289f8938d75ee108)
1b1b4d261SWilliam A. Kennington IIIdescription: >
2b1b4d261SWilliam A. Kennington III    Customer requested system power mode.
3b1b4d261SWilliam A. Kennington III
4b1b4d261SWilliam A. Kennington IIIproperties:
5b1b4d261SWilliam A. Kennington III    - name: PowerMode
6b1b4d261SWilliam A. Kennington III      type: enum[self.PowerMode]
7fdcdfbefSChris Cain      default: Static
8b1b4d261SWilliam A. Kennington III      description: >
9b1b4d261SWilliam A. Kennington III          This property shall contain the computer system power mode setting.
10b1b4d261SWilliam A. Kennington III          This defines the processor speed based on the priority of power
11b1b4d261SWilliam A. Kennington III          consumption and performance.
12*e2c9bc74SChris Cain      errors:
13*e2c9bc74SChris Cain          - xyz.openbmc_project.Common.Error.InvalidArgument
14*e2c9bc74SChris Cain          - xyz.openbmc_project.Common.Error.NotAllowed
15fdcdfbefSChris Cain
16c6cf37a7SSheldon Bailey    - name: SafeMode
17c6cf37a7SSheldon Bailey      type: boolean
18c6cf37a7SSheldon Bailey      flags:
19c6cf37a7SSheldon Bailey          - readonly
20c6cf37a7SSheldon Bailey      default: false
21c6cf37a7SSheldon Bailey      description: >
22a1347418SPatrick Williams          This property shall indicate whether the System is in Safe Mode. When
23a1347418SPatrick Williams          this is true, the system power mode is not being used in the system.
24b1b4d261SWilliam A. Kennington III
25fdcdfbefSChris Cain    - name: AllowedPowerModes
26fdcdfbefSChris Cain      type: set[enum[self.PowerMode]]
27fdcdfbefSChris Cain      flags:
28fdcdfbefSChris Cain          - const
29fdcdfbefSChris Cain      description: >
30fdcdfbefSChris Cain          A const property describing all the allowed power modes. Some systems
31fdcdfbefSChris Cain          may not support all modes, so this property can be filled in with only
32fdcdfbefSChris Cain          the supported modes. If empty, then any of the PowerMode values can be
33fdcdfbefSChris Cain          set.
34fdcdfbefSChris Cain
35b1b4d261SWilliam A. Kennington IIIenumerations:
36b1b4d261SWilliam A. Kennington III    - name: PowerMode
37b1b4d261SWilliam A. Kennington III      description: >
38b1b4d261SWilliam A. Kennington III          Possible Power Mode settings
39b1b4d261SWilliam A. Kennington III      values:
403e4c27aeSChris Cain          - name: BalancedPerformance
41921791c7SManojkiran Eda            description: >
423e4c27aeSChris Cain                The system performs at the highest speeds while utilization is
433e4c27aeSChris Cain                high and performs at reduced speeds when the utilization is low.
443e4c27aeSChris Cain          - name: EfficiencyFavorPerformance
45921791c7SManojkiran Eda            description: >
463e4c27aeSChris Cain                The system performs at reduced speeds at all utilizations to
473e4c27aeSChris Cain                save power while attempting to maintain performance. This mode
483e4c27aeSChris Cain                differs from EfficiencyFavorPower in that more performance is
493e4c27aeSChris Cain                retained but less power is saved.
503e4c27aeSChris Cain          - name: EfficiencyFavorPower
51921791c7SManojkiran Eda            description: >
523e4c27aeSChris Cain                The system performs at reduced speeds at all utilizations to
533e4c27aeSChris Cain                save power at the cost of performance. This mode differs from
543e4c27aeSChris Cain                PowerSaving in that more performance is retained and less power
553e4c27aeSChris Cain                is saved. This mode differs from EfficiencyFavorPerformance in
563e4c27aeSChris Cain                that less performance is retained but more power is saved.
57b1b4d261SWilliam A. Kennington III          - name: MaximumPerformance
58921791c7SManojkiran Eda            description: >
59b1b4d261SWilliam A. Kennington III                This value shall indicate the system performs at the highest
60b1b4d261SWilliam A. Kennington III                speeds possible. This mode should be used when performance is
61b1b4d261SWilliam A. Kennington III                the top priority.
62b1b4d261SWilliam A. Kennington III          - name: OEM
63b1b4d261SWilliam A. Kennington III            description: >
64b1b4d261SWilliam A. Kennington III                This value shall indicate the system performs at an OEM-defined
65b1b4d261SWilliam A. Kennington III                power mode.
663e4c27aeSChris Cain          - name: PowerSaving
673e4c27aeSChris Cain            description: >
683e4c27aeSChris Cain                This value shall indicate the system performs at reduced speeds
693e4c27aeSChris Cain                to save power. This mode should be used when power saving is the
703e4c27aeSChris Cain                top priority.
713e4c27aeSChris Cain          - name: Static
723e4c27aeSChris Cain            description: >
733e4c27aeSChris Cain                This value shall indicate the system performs at a static base
743e4c27aeSChris Cain                speed.
75