blob: ee4d5ac817f4ea7857f0b36d3ab816a22fcad738 [file] [log] [blame]
Patrick Williams3350f3e2016-11-23 07:27:01 -06001description: >
Andrew Geissler4e41bf72020-01-06 13:40:23 -06002 Simple definition of a Software or Firmware version. Note that this
3 interface may be implemented by D-Bus objects that do not necessarily
4 contain a software level. For example an OpenBMC log may implement this
5 interface to store the software level of the BMC or Host for debug purposes.
6 If looking for real software versions associated with a device then ensure
7 this interface is under the /xyz/openbmc_project/software object path.
Patrick Williams3350f3e2016-11-23 07:27:01 -06008properties:
9 - name: Version
10 type: string
11 description: >
Patrick Williams8da396c2022-03-14 14:21:02 -050012 The version identifier.
Patrick Williams3350f3e2016-11-23 07:27:01 -060013 - name: Purpose
14 type: enum[self.VersionPurpose]
15 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -060016 The purpose of the version. As in, what can it be used for or applied
17 to?
Patrick Williamsf05e2052021-12-01 10:25:03 -060018
Patrick Williamsa1347412022-12-06 10:56:22 -060019 This property is deprecated in favor of Compatible strings and
20 inventory associations. The enumeration should not be expanded
21 further.
Patrick Williams3350f3e2016-11-23 07:27:01 -060022enumerations:
23 - name: VersionPurpose
24 description: >
Patrick Williams8da396c2022-03-14 14:21:02 -050025 An enumeration of possible purposes of the version.
Patrick Williams3350f3e2016-11-23 07:27:01 -060026 values:
Patrick Williams8da396c2022-03-14 14:21:02 -050027 - name: Unknown
28 description: >
29 The version is of unknown purpose.
30 - name: Other
31 description: >
32 The version is of some other purpose.
33 - name: System
34 description: >
35 The version is an aggregate for the system as a whole.
36 - name: BMC
37 description: >
38 The version is a version for the BMC.
39 - name: Host
40 description: >
41 The version is a version for a managed host.
42 - name: PSU
43 description: >
44 The version is a version for a PSU.