blob: 0f679ac34487ed1fe1df94ba34e50351bd79704c [file] [log] [blame]
Deepak Kodihalli4b271e12017-05-13 09:57:52 -05001description: >
Chris Cain763d4242022-02-10 08:27:05 -06002 Implement to specify the power consumption cap and bounds
Deepak Kodihalli4b271e12017-05-13 09:57:52 -05003
4properties:
5 - name: PowerCap
6 type: uint32
7 description: >
Chris Cain763d4242022-02-10 08:27:05 -06008 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.
Andrew Geissler31289a62017-06-29 15:41:10 -050011
12 - name: PowerCapEnable
13 type: boolean
14 description: >
15 Power cap enable. Set to true to enable the PowerCap, false
16 to disable it.
Gaurav Gandhied708de2021-08-24 21:34:59 +000017
18 - name: MinPowerCapValue
19 type: uint32
Chris Cain763d4242022-02-10 08:27:05 -060020 flags:
21 - readonly
Gaurav Gandhied708de2021-08-24 21:34:59 +000022 default: 0
Chris Cain763d4242022-02-10 08:27:05 -060023 description: The Minimum supported PowerCap setting.
Gaurav Gandhied708de2021-08-24 21:34:59 +000024
25 - name: MaxPowerCapValue
26 type: uint32
Chris Cain763d4242022-02-10 08:27:05 -060027 flags:
28 - readonly
Gaurav Gandhied708de2021-08-24 21:34:59 +000029 default: maxint
Chris Cain763d4242022-02-10 08:27:05 -060030 description: The Maximum supported PowerCap setting.
31
32 - name: MinSoftPowerCapValue
33 type: uint32
34 flags:
35 - readonly
36 default: 0
37 description: >
38 Minimum supported soft user PowerCap setting.
39 The min soft user PowerCap value is normally less than or equal to
40 the MinPowerCapValue. When the PowerCap is set to any value between
41 MinSoftPowerCapValue and MinPowerCapValue an attempt will be made to
42 maintain the cap but it will not be guaranted.
43