xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Software/Version.interface.yaml (revision 6db06f5b8024f6a7cd9b69930c2a02402b501ec9)
1b1b4d261SWilliam A. Kennington IIIdescription: >
2b1b4d261SWilliam A. Kennington III    Simple definition of a Software or Firmware version. Note that this
3b1b4d261SWilliam A. Kennington III    interface may be implemented by D-Bus objects that do not necessarily
4b1b4d261SWilliam A. Kennington III    contain a software level. For example an OpenBMC log may implement this
5b1b4d261SWilliam A. Kennington III    interface to store the software level of the BMC or Host for debug purposes.
6b1b4d261SWilliam A. Kennington III    If looking for real software versions associated with a device then ensure
7b1b4d261SWilliam A. Kennington III    this interface is under the /xyz/openbmc_project/software object path.
8b1b4d261SWilliam A. Kennington IIIproperties:
9b1b4d261SWilliam A. Kennington III    - name: Version
10b1b4d261SWilliam A. Kennington III      type: string
11b1b4d261SWilliam A. Kennington III      description: >
12b1b4d261SWilliam A. Kennington III          The version identifier.
13b1b4d261SWilliam A. Kennington III    - name: Purpose
14b1b4d261SWilliam A. Kennington III      type: enum[self.VersionPurpose]
15b1b4d261SWilliam A. Kennington III      description: >
16a1347418SPatrick Williams          The purpose of the version.  As in, what can it be used for or applied
17a1347418SPatrick Williams          to?
18f05e2050SPatrick Williams
19a1347418SPatrick Williams          This property is deprecated in favor of Compatible strings and
20a1347418SPatrick Williams          inventory associations.  The enumeration should not be expanded
21a1347418SPatrick Williams          further.
22b1b4d261SWilliam A. Kennington IIIenumerations:
23b1b4d261SWilliam A. Kennington III    - name: VersionPurpose
24b1b4d261SWilliam A. Kennington III      description: >
25b1b4d261SWilliam A. Kennington III          An enumeration of possible purposes of the version.
26b1b4d261SWilliam A. Kennington III      values:
27b1b4d261SWilliam A. Kennington III          - name: Unknown
28b1b4d261SWilliam A. Kennington III            description: >
29b1b4d261SWilliam A. Kennington III                The version is of unknown purpose.
30b1b4d261SWilliam A. Kennington III          - name: Other
31b1b4d261SWilliam A. Kennington III            description: >
32b1b4d261SWilliam A. Kennington III                The version is of some other purpose.
33b1b4d261SWilliam A. Kennington III          - name: System
34b1b4d261SWilliam A. Kennington III            description: >
35b1b4d261SWilliam A. Kennington III                The version is an aggregate for the system as a whole.
36b1b4d261SWilliam A. Kennington III          - name: BMC
37b1b4d261SWilliam A. Kennington III            description: >
38b1b4d261SWilliam A. Kennington III                The version is a version for the BMC.
39b1b4d261SWilliam A. Kennington III          - name: Host
40b1b4d261SWilliam A. Kennington III            description: >
41b1b4d261SWilliam A. Kennington III                The version is a version for a managed host.
42b1b4d261SWilliam A. Kennington III          - name: PSU
43b1b4d261SWilliam A. Kennington III            description: >
44b1b4d261SWilliam A. Kennington III                The version is a version for a PSU.
454206b1acSJagpal Singh Gill
464206b1acSJagpal Singh Gillassociations:
474206b1acSJagpal Singh Gill    - name: running
484206b1acSJagpal Singh Gill      description: >
494206b1acSJagpal Singh Gill          This indicates the current running version for the associated
504206b1acSJagpal Singh Gill          inventory item.
514206b1acSJagpal Singh Gill      reverse_names:
524206b1acSJagpal Singh Gill          - ran_on
534206b1acSJagpal Singh Gill      required_endpoint_interfaces:
544206b1acSJagpal Singh Gill          - xyz.openbmc_project.Inventory.Item
554206b1acSJagpal Singh Gill    - name: activating
564206b1acSJagpal Singh Gill      description: >
574206b1acSJagpal Singh Gill          This indicates the current activated version for the associated
584206b1acSJagpal Singh Gill          inventory item. There can be more than one active version associated
594206b1acSJagpal Singh Gill          with the same inventory item. In such a case, RedundancyPriority
604206b1acSJagpal Singh Gill          interface will help to decide the correct priority order for the
614206b1acSJagpal Singh Gill          active version transition to running.
624206b1acSJagpal Singh Gill      reverse_names:
634206b1acSJagpal Singh Gill          - activated_on
644206b1acSJagpal Singh Gill      required_endpoint_interfaces:
654206b1acSJagpal Singh Gill          - xyz.openbmc_project.Inventory.Item
66*6db06f5bSPatrick Williams
67*6db06f5bSPatrick Williamspaths:
68*6db06f5bSPatrick Williams    - namespace: /xyz/openbmc_project/software
69