xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/State/Drive.interface.yaml (revision a1347418307d31a94bd21f22897aa508df938dcf)
1b1b4d261SWilliam A. Kennington IIIdescription: >
2b1b4d261SWilliam A. Kennington III    Implement to provide drive state management.
3b1b4d261SWilliam A. Kennington III
4b1b4d261SWilliam A. Kennington IIIproperties:
5b1b4d261SWilliam A. Kennington III    - name: Rebuilding
6b1b4d261SWilliam A. Kennington III      type: boolean
7b1b4d261SWilliam A. Kennington III      default: false
8b1b4d261SWilliam A. Kennington III      description: >
9b1b4d261SWilliam A. Kennington III          Describes if the drive is currently rebuilding.
1018554386SWilly Tu    - name: RequestedDriveTransition
1118554386SWilly Tu      type: enum[self.Transition]
1218554386SWilly Tu      default: "NotSupported"
1318554386SWilly Tu      description: >
1418554386SWilly Tu          The desired Drive transition
1518554386SWilly Tu    - name: CurrentDriveState
1618554386SWilly Tu      type: enum[self.DriveState]
1718554386SWilly Tu      default: "Unknown"
1818554386SWilly Tu      description: >
1918554386SWilly Tu          The current state of the Drive and is a read-only property.
2018554386SWilly Tu      flags:
2118554386SWilly Tu          - readonly
2218554386SWilly Tu    - name: LastRebootTime
2318554386SWilly Tu      type: uint64
2418554386SWilly Tu      default: maxint
2518554386SWilly Tu      description: >
26*a1347418SPatrick Williams          Time when the Drive last rebooted represented in EpochTime. The time
27*a1347418SPatrick Williams          reference should be based on the BMC's time. If not supported, it will
28*a1347418SPatrick Williams          be represented as maxint.
2918554386SWilly Tu      flags:
3018554386SWilly Tu          - readonly
3118554386SWilly Tu
3218554386SWilly Tuenumerations:
3318554386SWilly Tu    - name: Transition
3418554386SWilly Tu      description: >
3518554386SWilly Tu          The desired transition for the Drive
3618554386SWilly Tu      values:
3718554386SWilly Tu          - name: "Reboot"
3818554386SWilly Tu            description: >
3918554386SWilly Tu                The Drive should be rebooted.
4018554386SWilly Tu          - name: "HardReboot"
4118554386SWilly Tu            description: >
4218554386SWilly Tu                The Drive should be non-gracefully rebooted.
4318554386SWilly Tu          - name: "Powercycle"
4418554386SWilly Tu            description: >
4518554386SWilly Tu                The Drive should be powercycled.
4618554386SWilly Tu          - name: "None"
4718554386SWilly Tu            description: >
4818554386SWilly Tu                No transition is in progress.
4918554386SWilly Tu          - name: "NotSupported"
5018554386SWilly Tu            description: >
5118554386SWilly Tu                Transition request is not supported.
5218554386SWilly Tu
5318554386SWilly Tu    - name: DriveState
5418554386SWilly Tu      description: >
5518554386SWilly Tu          The current state of the Drive
5618554386SWilly Tu      values:
5718554386SWilly Tu          - name: "Unknown"
5818554386SWilly Tu            description: >
5918554386SWilly Tu                The Drive State is unknown.
6018554386SWilly Tu          - name: "Ready"
6118554386SWilly Tu            description: >
6218554386SWilly Tu                Ready implies all services started and are running successfully
6318554386SWilly Tu          - name: "NotReady"
6418554386SWilly Tu            description: >
6518554386SWilly Tu                Not ready implies not all services have started or are not
6618554386SWilly Tu                running successfully
6718554386SWilly Tu          - name: "Offline"
6818554386SWilly Tu            description: >
6918554386SWilly Tu                The Drive is ready, but waiting for external action to enable it
7018554386SWilly Tu          - name: "Debug"
7118554386SWilly Tu            description: >
7218554386SWilly Tu                The Drive is ready and in debug mode. The functionalities might
7318554386SWilly Tu                be limited
7418554386SWilly Tu          - name: "UpdateInProgress"
7518554386SWilly Tu            description: >
7618554386SWilly Tu                UpdateInProgress implies the Drive is in firmware update mode.
7718554386SWilly Tu                Current DriveState will be set to "UpdateInProgress" while
7818554386SWilly Tu                starting firmware download and reset to "Ready", once activation
7918554386SWilly Tu                is done or error occurs during update process.
80