18da396caSPatrick Williamsdescription: Implement to provide the chassis power management 2b1b4d261SWilliam A. Kennington III 3b1b4d261SWilliam A. Kennington IIIproperties: 4b1b4d261SWilliam A. Kennington III - name: RequestedPowerTransition 5b1b4d261SWilliam A. Kennington III type: enum[self.Transition] 68da396caSPatrick Williams default: "Off" 7b1b4d261SWilliam A. Kennington III description: > 8a1347418SPatrick Williams The desired power transition to start on this chassis. This will be 9a1347418SPatrick Williams preserved across AC power cycles of the BMC. 10abb61a0fSAndrew Geissler errors: 11abb61a0fSAndrew Geissler - xyz.openbmc_project.State.Chassis.Error.BMCNotReady 12*57db6a13SThang Tran - xyz.openbmc_project.Common.Error.Unavailable 13b1b4d261SWilliam A. Kennington III 14b1b4d261SWilliam A. Kennington III - name: CurrentPowerState 15b1b4d261SWilliam A. Kennington III type: enum[self.PowerState] 16b1b4d261SWilliam A. Kennington III description: > 17a1347418SPatrick Williams A read-only property describing the current chassis power state. A 18a1347418SPatrick Williams user can determine if a chassis is in transition by comparing the 19a1347418SPatrick Williams CurrentPowerState and RequestedPowerTransition properties. 20b1b4d261SWilliam A. Kennington III 219c913327SAndrew Geissler - name: CurrentPowerStatus 229c913327SAndrew Geissler type: enum[self.PowerStatus] 239c913327SAndrew Geissler description: > 24a1347418SPatrick Williams A read-only property describing the current chassis power status. This 25a1347418SPatrick Williams property aggregates all available information about the status of the 26a1347418SPatrick Williams power coming into the chassis. Note that this is different then the 27a1347418SPatrick Williams CurrentPowerState in that it provides status of the power coming into 28a1347418SPatrick Williams the chassis, not the actual state of the chassis power. 299c913327SAndrew Geissler 30b1b4d261SWilliam A. Kennington III - name: LastStateChangeTime 31b1b4d261SWilliam A. Kennington III type: uint64 32b1b4d261SWilliam A. Kennington III description: > 33a1347418SPatrick Williams The last time at which the chassis power changed state, as tracked by 34a1347418SPatrick Williams the CurrentPowerState property, in epoch time, in milliseconds. This 35a1347418SPatrick Williams can be used to tell when the chassis was last powered on or off. 36b1b4d261SWilliam A. Kennington III 37b1b4d261SWilliam A. Kennington IIIenumerations: 38b1b4d261SWilliam A. Kennington III - name: Transition 39b1b4d261SWilliam A. Kennington III description: > 40b1b4d261SWilliam A. Kennington III The desired power transition for the chassis 41b1b4d261SWilliam A. Kennington III values: 428da396caSPatrick Williams - name: "Off" 43b1b4d261SWilliam A. Kennington III description: > 44b1b4d261SWilliam A. Kennington III Chassis power should be off 458da396caSPatrick Williams - name: "On" 46b1b4d261SWilliam A. Kennington III description: > 47b1b4d261SWilliam A. Kennington III Chassis power should be on 488da396caSPatrick Williams - name: "PowerCycle" 49b1b4d261SWilliam A. Kennington III description: > 50b1b4d261SWilliam A. Kennington III Chassis power should be cycled from off to on. There will be a 5 51b1b4d261SWilliam A. Kennington III second delay between the off and the on. 52b1b4d261SWilliam A. Kennington III 53b1b4d261SWilliam A. Kennington III - name: PowerState 54b1b4d261SWilliam A. Kennington III description: > 55b1b4d261SWilliam A. Kennington III The current state of the chassis power 56b1b4d261SWilliam A. Kennington III values: 578da396caSPatrick Williams - name: "Off" 58b1b4d261SWilliam A. Kennington III description: > 59b1b4d261SWilliam A. Kennington III Chassis power is off 608da396caSPatrick Williams - name: "TransitioningToOff" 61b1b4d261SWilliam A. Kennington III description: > 62b1b4d261SWilliam A. Kennington III Firmware is transitioning the chassis to an Off state 638da396caSPatrick Williams - name: "On" 64b1b4d261SWilliam A. Kennington III description: > 65b1b4d261SWilliam A. Kennington III Chassis power is on 668da396caSPatrick Williams - name: "TransitioningToOn" 67b1b4d261SWilliam A. Kennington III description: > 68b1b4d261SWilliam A. Kennington III Firmware is transitioning the chassis to an On state 699c913327SAndrew Geissler 709c913327SAndrew Geissler - name: PowerStatus 719c913327SAndrew Geissler description: > 729c913327SAndrew Geissler The current status of the chassis power 739c913327SAndrew Geissler values: 748da396caSPatrick Williams - name: "Undefined" 759c913327SAndrew Geissler description: > 769c913327SAndrew Geissler Chassis power status is unknown 778da396caSPatrick Williams - name: "BrownOut" 789c913327SAndrew Geissler description: > 799c913327SAndrew Geissler Chassis power status is in a brownout condition. 808da396caSPatrick Williams - name: "UninterruptiblePowerSupply" 819c913327SAndrew Geissler description: > 829c913327SAndrew Geissler Chassis power is being provided via an uninterruptible power 83a1347418SPatrick Williams supply. Note that some systems may choose to continue to use 84a1347418SPatrick Williams this status, even once power has returned to the system, to 85a1347418SPatrick Williams indicate the uninterruptible power supply is charging or is 86a1347418SPatrick Williams below a certain threshold of charged. This provides system 87a1347418SPatrick Williams owners the flexibility on whether their system requires a 88a1347418SPatrick Williams certain level of charged uninterruptible power supply to be in a 89a1347418SPatrick Williams 'Good' state or not. 908da396caSPatrick Williams - name: "Good" 919c913327SAndrew Geissler description: > 929c913327SAndrew Geissler Chassis power status is in a good condition 93855b46f3SPatrick Williams 94855b46f3SPatrick Williamspaths: 95855b46f3SPatrick Williams - namespace: /xyz/openbmc_project/state 96855b46f3SPatrick Williams segments: 97855b46f3SPatrick Williams - name: Chassis 98855b46f3SPatrick Williams value: chassis 99