1b1b4d261SWilliam A. Kennington IIIdescription: >
2b1b4d261SWilliam A. Kennington III    Implementation of BMC state management.  When rebooting we are in
3b1b4d261SWilliam A. Kennington III    transition.  When Ready all services required are running
4a1347418SPatrick Williams    successfully.  When we are Not Ready this implies not all services have
5a1347418SPatrick Williams    started that are required to be.
6b1b4d261SWilliam A. Kennington III
7b1b4d261SWilliam A. Kennington IIIproperties:
8b1b4d261SWilliam A. Kennington III    - name: RequestedBMCTransition
9b1b4d261SWilliam A. Kennington III      type: enum[self.Transition]
108da396caSPatrick Williams      default: "None"
11b1b4d261SWilliam A. Kennington III      description: >
12b1b4d261SWilliam A. Kennington III          The desired BMC transition
13b1b4d261SWilliam A. Kennington III
14b1b4d261SWilliam A. Kennington III    - name: CurrentBMCState
15b1b4d261SWilliam A. Kennington III      type: enum[self.BMCState]
16b1b4d261SWilliam A. Kennington III      description: >
17b1b4d261SWilliam A. Kennington III          The current state of the BMC and is a read-only property.
18b1b4d261SWilliam A. Kennington III
19b1b4d261SWilliam A. Kennington III    - name: LastRebootTime
20b1b4d261SWilliam A. Kennington III      type: uint64
21b1b4d261SWilliam A. Kennington III      description: >
22a1347418SPatrick Williams          The last time at which the BMC came out of a reboot as determined by
23a1347418SPatrick Williams          its uptime, in epoch time, in milliseconds.
24b1b4d261SWilliam A. Kennington III
252a4da80eSTim Lee    - name: LastRebootCause
262a4da80eSTim Lee      type: enum[self.RebootCause]
278da396caSPatrick Williams      default: "Unknown"
282a4da80eSTim Lee      description: >
292a4da80eSTim Lee          The last BMC reboot cause
302a4da80eSTim Lee
31b1b4d261SWilliam A. Kennington IIIenumerations:
32b1b4d261SWilliam A. Kennington III    - name: Transition
33b1b4d261SWilliam A. Kennington III      description: >
34b1b4d261SWilliam A. Kennington III          The desired transition for the BMC firmware
35b1b4d261SWilliam A. Kennington III      values:
368da396caSPatrick Williams          - name: "Reboot"
37b1b4d261SWilliam A. Kennington III            description: >
38b1b4d261SWilliam A. Kennington III                BMC system should be rebooted
398da396caSPatrick Williams          - name: "HardReboot"
40b1b4d261SWilliam A. Kennington III            description: >
41b1b4d261SWilliam A. Kennington III                BMC system should be non-gracefully rebooted.
428da396caSPatrick Williams          - name: "None"
43b1b4d261SWilliam A. Kennington III            description: >
44b1b4d261SWilliam A. Kennington III                No transition is in progress
45b1b4d261SWilliam A. Kennington III
46b1b4d261SWilliam A. Kennington III    - name: BMCState
47b1b4d261SWilliam A. Kennington III      description: >
48b1b4d261SWilliam A. Kennington III          The current state of the BMC firmware
49b1b4d261SWilliam A. Kennington III      values:
508da396caSPatrick Williams          - name: "Ready"
51b1b4d261SWilliam A. Kennington III            description: >
52b1b4d261SWilliam A. Kennington III                Ready implies all services started and are running successfully
538da396caSPatrick Williams          - name: "NotReady"
54b1b4d261SWilliam A. Kennington III            description: >
55a1347418SPatrick Williams                Not ready implies not all services have started or are not
56a1347418SPatrick Williams                running successfully
578da396caSPatrick Williams          - name: "UpdateInProgress"
58b1b4d261SWilliam A. Kennington III            description: >
59a1347418SPatrick Williams                UpdateInProgress implies BMC is in firmware update mode.
60a1347418SPatrick Williams                CurrentBMCState will be set to "UpdateInProgress" while starting
61a1347418SPatrick Williams                image download and reset to Ready, once activation is done or
62a1347418SPatrick Williams                error case during update process.
638da396caSPatrick Williams          - name: "Quiesced"
64a9c704e7SAndrew Geissler            description: >
65a9c704e7SAndrew Geissler                BMC firmware is quiesced. The BMC firmware is enabled but either
66a1347418SPatrick Williams                unresponsive or only processing a restricted set of commands.
67a1347418SPatrick Williams                This state may be the result of a service within the BMC going
68a1347418SPatrick Williams                into a failed state.
692a4da80eSTim Lee
702a4da80eSTim Lee    - name: RebootCause
712a4da80eSTim Lee      description: >
722a4da80eSTim Lee          The recorded reboot cause of the BMC
732a4da80eSTim Lee      values:
748da396caSPatrick Williams          - name: "POR"
752a4da80eSTim Lee            description: >
762a4da80eSTim Lee                Last reboot is caused by Power-On-Reset
778da396caSPatrick Williams          - name: "PinholeReset"
78615e4f93SAndrew Geissler            description: >
79615e4f93SAndrew Geissler                Last reboot is caused by pinhole reset
808da396caSPatrick Williams          - name: "Watchdog"
812a4da80eSTim Lee            description: >
822a4da80eSTim Lee                Last reboot is caused by Watchdog
838da396caSPatrick Williams          - name: "Unknown"
842a4da80eSTim Lee            description: >
852a4da80eSTim Lee                Last reboot is caused by Unknown
86*855b46f3SPatrick Williams
87*855b46f3SPatrick Williamspaths:
88*855b46f3SPatrick Williams    - namespace: /xyz/openbmc_project/state
89*855b46f3SPatrick Williams      segments:
90*855b46f3SPatrick Williams          - name: BMC
91*855b46f3SPatrick Williams            description: >
92*855b46f3SPatrick Williams                The object representing _this_ BMC is always at bmc0.
93*855b46f3SPatrick Williams            value: bmc0
94