1description: >
2    Customer requested system power mode.
3
4properties:
5    - name: PowerMode
6      type: enum[self.PowerMode]
7      default: Static
8      description: >
9          This property shall contain the computer system power mode setting.
10          This defines the processor speed based on the priority of power
11          consumption and performance.
12      errors:
13          - xyz.openbmc_project.Common.Error.InvalidArgument
14          - xyz.openbmc_project.Common.Error.NotAllowed
15
16    - name: SafeMode
17      type: boolean
18      flags:
19          - readonly
20      default: false
21      description: >
22          This property shall indicate whether the System is in Safe Mode. When
23          this is true, the system power mode is not being used in the system.
24
25    - name: AllowedPowerModes
26      type: set[enum[self.PowerMode]]
27      flags:
28          - const
29      description: >
30          A const property describing all the allowed power modes. Some systems
31          may not support all modes, so this property can be filled in with only
32          the supported modes. If empty, then any of the PowerMode values can be
33          set.
34
35enumerations:
36    - name: PowerMode
37      description: >
38          Possible Power Mode settings
39      values:
40          - name: BalancedPerformance
41            description: >
42                The system performs at the highest speeds while utilization is
43                high and performs at reduced speeds when the utilization is low.
44          - name: EfficiencyFavorPerformance
45            description: >
46                The system performs at reduced speeds at all utilizations to
47                save power while attempting to maintain performance. This mode
48                differs from EfficiencyFavorPower in that more performance is
49                retained but less power is saved.
50          - name: EfficiencyFavorPower
51            description: >
52                The system performs at reduced speeds at all utilizations to
53                save power at the cost of performance. This mode differs from
54                PowerSaving in that more performance is retained and less power
55                is saved. This mode differs from EfficiencyFavorPerformance in
56                that less performance is retained but more power is saved.
57          - name: MaximumPerformance
58            description: >
59                This value shall indicate the system performs at the highest
60                speeds possible. This mode should be used when performance is
61                the top priority.
62          - name: OEM
63            description: >
64                This value shall indicate the system performs at an OEM-defined
65                power mode.
66          - name: PowerSaving
67            description: >
68                This value shall indicate the system performs at reduced speeds
69                to save power. This mode should be used when power saving is the
70                top priority.
71          - name: Static
72            description: >
73                This value shall indicate the system performs at a static base
74                speed.
75