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