commit 1855438658857b355cfed500a54141fd28aaccda
author Willy Tu <wltu@google.com> Wed May 12 16:15:43 2021 -0700
committer Patrick Williams <patrick@stwcx.xyz> Wed Jul 28 02:35:19 2021 +0000
tree 54dde7deb2f395b550be74e3daef0c80d092e60e
parent c43d228a079f021ea2ac12923d2ac0fc6c1e38e5

State: Drive: Update the State interface for Drive

The State interface will have the state of the Drive and transition
states.

Added RequestedDriveTransition, DriveState, and LastRebootTime
based off xyz.openbmc_project.State.BMC.

The RequestedDriveTransition allow actions like reset and powercycles.
For systems that does not support it, it is defaulted to `NotSupported`.

The current DriveState provides different available state the drive can
be in. The `UpdateInProgress` in DriveState can be used to replace
the current `Rebuilding`.

Required:
https://gerrit.openbmc-project.xyz/c/openbmc/sdbusplus/+/45142
for sdbusplus maxint uint64 support.

Change-Id: I5350de29554a0a0a41307f1f009d942135471abe
Signed-off-by: Willy Tu <wltu@google.com>

yaml/xyz/openbmc_project/State/Drive.interface.yaml

diff --git a/yaml/xyz/openbmc_project/State/Drive.interface.yaml b/yaml/xyz/openbmc_project/State/Drive.interface.yaml
index 3ad2793..b0500e8 100644
--- a/yaml/xyz/openbmc_project/State/Drive.interface.yaml
+++ b/yaml/xyz/openbmc_project/State/Drive.interface.yaml
@@ -7,3 +7,73 @@
       default: false
       description: >
           Describes if the drive is currently rebuilding.
+    - name: RequestedDriveTransition
+      type: enum[self.Transition]
+      default: "NotSupported"
+      description: >
+          The desired Drive transition
+    - name: CurrentDriveState
+      type: enum[self.DriveState]
+      default: "Unknown"
+      description: >
+          The current state of the Drive and is a read-only property.
+      flags:
+          - readonly
+    - name: LastRebootTime
+      type: uint64
+      default: maxint
+      description: >
+          Time when the Drive last rebooted represented in EpochTime.
+          The time reference should be based on the BMC's time.
+          If not supported, it will be represented as maxint.
+      flags:
+          - readonly
+
+enumerations:
+    - name: Transition
+      description: >
+          The desired transition for the Drive
+      values:
+          - name: "Reboot"
+            description: >
+                The Drive should be rebooted.
+          - name: "HardReboot"
+            description: >
+                The Drive should be non-gracefully rebooted.
+          - name: "Powercycle"
+            description: >
+                The Drive should be powercycled.
+          - name: "None"
+            description: >
+                No transition is in progress.
+          - name: "NotSupported"
+            description: >
+                Transition request is not supported.
+
+    - name: DriveState
+      description: >
+          The current state of the Drive
+      values:
+          - name: "Unknown"
+            description: >
+                The Drive State is unknown.
+          - name: "Ready"
+            description: >
+                Ready implies all services started and are running successfully
+          - name: "NotReady"
+            description: >
+                Not ready implies not all services have started or are not
+                running successfully
+          - name: "Offline"
+            description: >
+                The Drive is ready, but waiting for external action to enable it
+          - name: "Debug"
+            description: >
+                The Drive is ready and in debug mode. The functionalities might
+                be limited
+          - name: "UpdateInProgress"
+            description: >
+                UpdateInProgress implies the Drive is in firmware update mode.
+                Current DriveState will be set to "UpdateInProgress" while
+                starting firmware download and reset to "Ready", once activation
+                is done or error occurs during update process.