1description: >
2  Implement the Soft Power Off function.
3  On receiving the SMS_ATTN from BMC, Host will respond with a
4  GetMessageFlags command and the BMC will respond with a static
5  data indicating that Event Message Buffer is full. Host then sends
6  'ReadEvent' command and BMC responds with an architected packet
7  mentioning that the type is SOFT_OFF. Host then goes ahead and starts
8  to quiesce. Once that is done, Host will send a hard
9  power off command to BMC and then BMC will issue a hard power off.
10
11properties:
12    - name: ResponseReceived
13      type: enum[self.HostResponse]
14      default: NotApplicable
15      description: >
16        When the response is received for 'SMS_ATN', this is set to
17        'SoftOffReceived' and is set to 'HostShutdown' when Host
18        sends a Power Off request.
19
20enumerations:
21    - name: HostResponse
22      description: >
23        Possible response types from Host for a Soft Power Off function.
24      values:
25        - name: NotApplicable
26          description: >
27            Default initial value.
28        - name: SoftOffReceived
29          description: >
30            Host has received the SMS_ATN from BMC indicating that
31            Host needs to do a Soft Power Off.
32        - name: HostShutdown
33          description: >
34            Host has sufficiently quiesced and acknowledged the shutdown
35            request such that the hardware shutdown sequence can safely
36            be performed.
37