Add yaml definition file for Soft Power Off function

Change-Id: I63c18de7704db826efdbb8a44218720f63b3c4c2
Signed-off-by: Vishwanatha Subbanna <vishwa@linux.vnet.ibm.com>

1 files changed, 36 insertions, 0 deletions

diff --git a/xyz/openbmc_project/Ipmi/Internal/SoftPowerOff.interface.yaml b/xyz/openbmc_project/Ipmi/Internal/SoftPowerOff.interface.yaml
new file mode 100644
index 0000000..2bae9a7
--- /dev/null
+++ b/xyz/openbmc_project/Ipmi/Internal/SoftPowerOff.interface.yaml
@@ -0,0 +1,36 @@
+description: >
+  Implement the Soft Power Off function.
+  On receiving the SMS_ATTN from BMC, Host will respond with a
+  GetMessageFlags command and the BMC will respond with a static
+  data indicating that Event Message Buffer is full. Host then sends
+  'ReadEvent' command and BMC responds with an architected packet
+  mentioning that the type is SOFT_OFF. Host then goes ahead and starts
+  to quiesce. Once that is done, Host will send a hard
+  power off command to BMC and then BMC will issue a hard power off.
+
+properties:
+    - name: ResponseReceived
+      type: enum[self.HostResponse]
+      default: NotApplicable
+      description: >
+        When the response is received for 'SMS_ATN', this is set to
+        'SoftOffReceived' and is set to 'HostShutdown' when Host
+        sends a Power Off request.
+
+enumerations:
+    - name: HostResponse
+      description: >
+        Possible response types from Host for a Soft Power Off function.
+      values:
+        - name: NotApplicable
+          description: >
+            Default initial value.
+        - name: SoftOffReceived
+          description: >
+            Host has received the SMS_ATN from BMC indicating that
+            Host needs to do a Soft Power Off.
+        - name: HostShutdown
+          description: >
+            Host has sufficiently quiesced and acknowledged the shutdown
+            request such that the hardware shutdown sequence can safely
+            be performed.