1b1b4d261SWilliam A. Kennington IIIdescription: > 2763d424eSChris Cain Implement to specify the power consumption cap and bounds 3b1b4d261SWilliam A. Kennington III 4b1b4d261SWilliam A. Kennington IIIproperties: 5b1b4d261SWilliam A. Kennington III - name: PowerCap 6b1b4d261SWilliam A. Kennington III type: uint32 7b1b4d261SWilliam A. Kennington III description: > 8763d424eSChris Cain Power cap value. This is the user specified power cap. When enabled 9763d424eSChris Cain the power usage of the system will be limited to keep the power at or 10763d424eSChris Cain below this cap. This value is in Watts. 11b1b4d261SWilliam A. Kennington III 12b1b4d261SWilliam A. Kennington III - name: PowerCapEnable 13b1b4d261SWilliam A. Kennington III type: boolean 14b1b4d261SWilliam A. Kennington III description: > 15a1347418SPatrick Williams Power cap enable. Set to true to enable the PowerCap, false to 16a1347418SPatrick Williams disable it. 17ed708de3SGaurav Gandhi 18edc177f9SChris Cain #TODO: These following bounds are currently owned by Settings but need to be 19edc177f9SChris Cain # written by OCC.Control service so must be writable for now. 20ed708de3SGaurav Gandhi - name: MinPowerCapValue 21ed708de3SGaurav Gandhi type: uint32 22edc177f9SChris Cain #flags: 23edc177f9SChris Cain # - readonly 24ed708de3SGaurav Gandhi default: 0 25763d424eSChris Cain description: The Minimum supported PowerCap setting. 26ed708de3SGaurav Gandhi 27ed708de3SGaurav Gandhi - name: MaxPowerCapValue 28ed708de3SGaurav Gandhi type: uint32 29edc177f9SChris Cain #flags: 30edc177f9SChris Cain # - readonly 31ed708de3SGaurav Gandhi default: maxint 32763d424eSChris Cain description: The Maximum supported PowerCap setting. 33763d424eSChris Cain 34763d424eSChris Cain - name: MinSoftPowerCapValue 35763d424eSChris Cain type: uint32 36edc177f9SChris Cain #flags: 37edc177f9SChris Cain # - readonly 38763d424eSChris Cain default: 0 39763d424eSChris Cain description: > 40a1347418SPatrick Williams Minimum supported soft user PowerCap setting. The min soft user 41a1347418SPatrick Williams PowerCap value is normally less than or equal to the MinPowerCapValue. 42a1347418SPatrick Williams When the PowerCap is set to any value between MinSoftPowerCapValue and 43a1347418SPatrick Williams MinPowerCapValue an attempt will be made to maintain the cap but it 44*921791c7SManojkiran Eda will not be guaranteed. 450b2cbd32SThang Tran 460b2cbd32SThang Tran - name: ExceptionAction 470b2cbd32SThang Tran type: enum[self.ExceptionActions] 480b2cbd32SThang Tran default: NoAction 490b2cbd32SThang Tran description: > 500b2cbd32SThang Tran Exception Actions, taken if the Power Limit is exceeded and cannot be 510b2cbd32SThang Tran controlled within the Correction time limit. 520b2cbd32SThang Tran 530b2cbd32SThang Tran - name: CorrectionTime 540b2cbd32SThang Tran type: uint64 550b2cbd32SThang Tran default: 0 560b2cbd32SThang Tran description: > 570b2cbd32SThang Tran Correction Time Limit in microseconds. Maximum time taken to limit the 580b2cbd32SThang Tran power after the platform power has reached the power limit before the 590b2cbd32SThang Tran Exception Action will be taken. The Exception Action shall be taken if 600b2cbd32SThang Tran the system power usage constantly exceeds the specified power limit 610b2cbd32SThang Tran for more than the Correction Time Limit interval. The Correction Time 620b2cbd32SThang Tran Limit timeout automatically restarts if the system power meets or 630b2cbd32SThang Tran drops below the Power Limit. 640b2cbd32SThang Tran 650b2cbd32SThang Tran - name: SamplingPeriod 660b2cbd32SThang Tran type: uint64 670b2cbd32SThang Tran default: 1000000 680b2cbd32SThang Tran description: > 690b2cbd32SThang Tran Management application Statistics Sampling period in microseconds. 700b2cbd32SThang Tran 710b2cbd32SThang Tranenumerations: 720b2cbd32SThang Tran - name: ExceptionActions 730b2cbd32SThang Tran description: > 740b2cbd32SThang Tran Exception actions, taken if the Power Limit is exceeded and cannot be 750b2cbd32SThang Tran controlled within the Correction Time Limit. 760b2cbd32SThang Tran values: 770b2cbd32SThang Tran - name: NoAction 780b2cbd32SThang Tran description: > 790b2cbd32SThang Tran No action is called. 800b2cbd32SThang Tran 810b2cbd32SThang Tran - name: HardPowerOff 820b2cbd32SThang Tran description: > 830b2cbd32SThang Tran Hard Power Off system and log event. 840b2cbd32SThang Tran 850b2cbd32SThang Tran - name: LogEventOnly 86*921791c7SManojkiran Eda description: > 870b2cbd32SThang Tran Log Event Only. 880b2cbd32SThang Tran 890b2cbd32SThang Tran - name: Oem 90*921791c7SManojkiran Eda description: > 910b2cbd32SThang Tran OEM defined action. 92