xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Condition/HostFirmware.interface.yaml (revision a1347418307d31a94bd21f22897aa508df938dcf)
1b1b4d261SWilliam A. Kennington IIIdescription: >
2*a1347418SPatrick Williams    Implement to provide information on the condition of the host firmware. The
3*a1347418SPatrick Williams    expectation is the implementer of this interface utilize their host protocol
4*a1347418SPatrick Williams    (IPMI, PLDM, ...) to check the state of the host firmware running on the
5*a1347418SPatrick Williams    system.
6b1b4d261SWilliam A. Kennington III
7b1b4d261SWilliam A. Kennington IIIproperties:
8b1b4d261SWilliam A. Kennington III    - name: CurrentFirmwareCondition
9b1b4d261SWilliam A. Kennington III      type: enum[self.FirmwareCondition]
108da396caSPatrick Williams      default: "Unknown"
11b1b4d261SWilliam A. Kennington III      description: >
12b1b4d261SWilliam A. Kennington III          The current condition of the host
13b1b4d261SWilliam A. Kennington III
14b1b4d261SWilliam A. Kennington IIIenumerations:
15b1b4d261SWilliam A. Kennington III    - name: FirmwareCondition
16b1b4d261SWilliam A. Kennington III      description: >
17b1b4d261SWilliam A. Kennington III          The current condition of the host firmware
18b1b4d261SWilliam A. Kennington III      values:
198da396caSPatrick Williams          - name: "Unknown"
20b1b4d261SWilliam A. Kennington III            description: >
21b1b4d261SWilliam A. Kennington III                The condition of the host firmware is unknown
228da396caSPatrick Williams          - name: "Off"
23b1b4d261SWilliam A. Kennington III            description: >
24b1b4d261SWilliam A. Kennington III                Host firmware is not responsive to communication
258da396caSPatrick Williams          - name: "Running"
26b1b4d261SWilliam A. Kennington III            description: >
27b1b4d261SWilliam A. Kennington III                Host firmware is running and responsive to communication
28