| Andrew Geissler | d345966 | 2017-03-16 14:15:31 -0500 | [diff] [blame] | 1 | description: > |
| 2 | Implement to provide host interface support |
| 3 | |
| 4 | methods: |
| 5 | - name: Execute |
| 6 | description: > |
| 7 | Execute the requested command by the caller. This command will be |
| 8 | processed in first in first out order. See the Command enum |
| 9 | description below for details on all supported commands. |
| 10 | parameters: |
| 11 | - name: command |
| 12 | type: enum[self.Command] |
| 13 | description: Requested command to execute against the host |
| 14 | errors: |
| 15 | - self.Error.CommandNotSupported |
| 16 | |
| 17 | signals: |
| 18 | - name: CommandComplete |
| 19 | description: > |
| 20 | Signal indicating that a Command has completed |
| 21 | properties: |
| 22 | - name: command |
| 23 | type: enum[self.Command] |
| 24 | description: Executed command |
| 25 | - name: result |
| 26 | type: enum[self.Result] |
| 27 | description: Result of the command execution |
| 28 | |
| 29 | enumerations: |
| 30 | - name: Command |
| 31 | description: > |
| 32 | The command to execute against the host |
| 33 | values: |
| 34 | - name: SoftOff |
| 35 | description: > |
| 36 | Host firmware should do a clean shutdown and request a chassis power |
| 37 | off to the BMC when complete. This command will return once the |
| 38 | command has been sent to the host. |
| 39 | - name: Heartbeat |
| 40 | description: > |
| Andrew Geissler | ec9fc42 | 2021-04-19 16:29:13 -0500 | [diff] [blame] | 41 | Note: This is in the process of being deprecated in favor of the |
| 42 | new xyz.openbmc_project.Condition.HostFirmware interface. |
| Andrew Geissler | d345966 | 2017-03-16 14:15:31 -0500 | [diff] [blame] | 43 | Used to determine if the host is running and functional. This |
| 44 | command will return once the command has been sent to the host. |
| 45 | The response to the attention and the reading of the command |
| 46 | provides the needed functional information. |
| 47 | |
| 48 | - name: Result |
| 49 | description: > |
| 50 | The result of the command execution |
| 51 | values: |
| 52 | - name: Success |
| 53 | description: Command execution was a success |
| 54 | - name: Failure |
| 55 | description: Command execution was a failure |