xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Control/Power/Cap.interface.yaml (revision a1347418307d31a94bd21f22897aa508df938dcf)
1description: >
2    Implement to specify the power consumption cap and bounds
3
4properties:
5    - name: PowerCap
6      type: uint32
7      description: >
8          Power cap value. This is the user specified power cap.  When enabled
9          the power usage of the system will be limited to keep the power at or
10          below this cap.  This value is in Watts.
11
12    - name: PowerCapEnable
13      type: boolean
14      description: >
15          Power cap enable.  Set to true to enable the PowerCap, false to
16          disable it.
17
18    #TODO: These following bounds are currently owned by Settings but need to be
19    #      written by OCC.Control service so must be writable for now.
20    - name: MinPowerCapValue
21      type: uint32
22      #flags:
23      #    - readonly
24      default: 0
25      description: The Minimum supported PowerCap setting.
26
27    - name: MaxPowerCapValue
28      type: uint32
29      #flags:
30      #    - readonly
31      default: maxint
32      description: The Maximum supported PowerCap setting.
33
34    - name: MinSoftPowerCapValue
35      type: uint32
36      #flags:
37      #    - readonly
38      default: 0
39      description: >
40          Minimum supported soft user PowerCap setting. The min soft user
41          PowerCap value is normally less than or equal to the MinPowerCapValue.
42          When the PowerCap is set to any value between MinSoftPowerCapValue and
43          MinPowerCapValue an attempt will be made to maintain the cap but it
44          will not be guaranted.
45