| Deepak Kodihalli | 4b271e1 | 2017-05-13 09:57:52 -0500 | [diff] [blame] | 1 | description: > |
| Chris Cain | 763d424 | 2022-02-10 08:27:05 -0600 | [diff] [blame] | 2 | Implement to specify the power consumption cap and bounds |
| Deepak Kodihalli | 4b271e1 | 2017-05-13 09:57:52 -0500 | [diff] [blame] | 3 | |
| 4 | properties: |
| 5 | - name: PowerCap |
| 6 | type: uint32 |
| 7 | description: > |
| Chris Cain | 763d424 | 2022-02-10 08:27:05 -0600 | [diff] [blame] | 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. |
| Andrew Geissler | 31289a6 | 2017-06-29 15:41:10 -0500 | [diff] [blame] | 11 | |
| 12 | - name: PowerCapEnable |
| 13 | type: boolean |
| 14 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 15 | Power cap enable. Set to true to enable the PowerCap, false to |
| 16 | disable it. |
| Gaurav Gandhi | ed708de | 2021-08-24 21:34:59 +0000 | [diff] [blame] | 17 | |
| Chris Cain | edc177f | 2022-04-07 13:26:24 -0500 | [diff] [blame] | 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. |
| Gaurav Gandhi | ed708de | 2021-08-24 21:34:59 +0000 | [diff] [blame] | 20 | - name: MinPowerCapValue |
| 21 | type: uint32 |
| Chris Cain | edc177f | 2022-04-07 13:26:24 -0500 | [diff] [blame] | 22 | #flags: |
| 23 | # - readonly |
| Gaurav Gandhi | ed708de | 2021-08-24 21:34:59 +0000 | [diff] [blame] | 24 | default: 0 |
| Chris Cain | 763d424 | 2022-02-10 08:27:05 -0600 | [diff] [blame] | 25 | description: The Minimum supported PowerCap setting. |
| Gaurav Gandhi | ed708de | 2021-08-24 21:34:59 +0000 | [diff] [blame] | 26 | |
| 27 | - name: MaxPowerCapValue |
| 28 | type: uint32 |
| Chris Cain | edc177f | 2022-04-07 13:26:24 -0500 | [diff] [blame] | 29 | #flags: |
| 30 | # - readonly |
| Gaurav Gandhi | ed708de | 2021-08-24 21:34:59 +0000 | [diff] [blame] | 31 | default: maxint |
| Chris Cain | 763d424 | 2022-02-10 08:27:05 -0600 | [diff] [blame] | 32 | description: The Maximum supported PowerCap setting. |
| 33 | |
| 34 | - name: MinSoftPowerCapValue |
| 35 | type: uint32 |
| Chris Cain | edc177f | 2022-04-07 13:26:24 -0500 | [diff] [blame] | 36 | #flags: |
| 37 | # - readonly |
| Chris Cain | 763d424 | 2022-02-10 08:27:05 -0600 | [diff] [blame] | 38 | default: 0 |
| 39 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 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. |
| Thang Tran | 0b2cbd3 | 2023-01-31 15:43:07 +0700 | [diff] [blame^] | 45 | |
| 46 | - name: ExceptionAction |
| 47 | type: enum[self.ExceptionActions] |
| 48 | default: NoAction |
| 49 | description: > |
| 50 | Exception Actions, taken if the Power Limit is exceeded and cannot be |
| 51 | controlled within the Correction time limit. |
| 52 | |
| 53 | - name: CorrectionTime |
| 54 | type: uint64 |
| 55 | default: 0 |
| 56 | description: > |
| 57 | Correction Time Limit in microseconds. Maximum time taken to limit the |
| 58 | power after the platform power has reached the power limit before the |
| 59 | Exception Action will be taken. The Exception Action shall be taken if |
| 60 | the system power usage constantly exceeds the specified power limit |
| 61 | for more than the Correction Time Limit interval. The Correction Time |
| 62 | Limit timeout automatically restarts if the system power meets or |
| 63 | drops below the Power Limit. |
| 64 | |
| 65 | - name: SamplingPeriod |
| 66 | type: uint64 |
| 67 | default: 1000000 |
| 68 | description: > |
| 69 | Management application Statistics Sampling period in microseconds. |
| 70 | |
| 71 | enumerations: |
| 72 | - name: ExceptionActions |
| 73 | description: > |
| 74 | Exception actions, taken if the Power Limit is exceeded and cannot be |
| 75 | controlled within the Correction Time Limit. |
| 76 | values: |
| 77 | - name: NoAction |
| 78 | description: > |
| 79 | No action is called. |
| 80 | |
| 81 | - name: HardPowerOff |
| 82 | description: > |
| 83 | Hard Power Off system and log event. |
| 84 | |
| 85 | - name: LogEventOnly |
| 86 | decription: > |
| 87 | Log Event Only. |
| 88 | |
| 89 | - name: Oem |
| 90 | decription: > |
| 91 | OEM defined action. |