Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-dbus-interfaces / 4f6fbeab36c23cce3816f0f6de4c92b9b87774b7 / . / yaml / com / ibm / VPD / Manager.interface.yaml
blob: 8d1409dd1dea03970429b4b0e5baf508b7574dfa [file] [log] [blame]
SunnySrivastava198426ff1c82020-02-26 05:48:39 -0600[diff] [blame]1description: >
2 Implement to manage VPD data in system.
3methods:
4 - name: WriteKeyword
5 description: >
6 A method to update the keyword value for a given VPD record.
7 parameters:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]8 - name: path
Patrick Williamsb78a0702022-10-24 12:32:56 -0500[diff] [blame]9 type: object_path
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]10 description: >
11 Path to the D-Bus object that represents the FRU.
12 - name: record
13 type: string
14 description: >
15 Record whose keyword value needs to be modified.
16 - name: keyword
17 type: string
18 description: >
19 Keyword whose value needs to be updated.
20 - name: value
21 type: array[byte]
22 description: >
23 Value to be updated for the keyword.
SunnySrivastava198426ff1c82020-02-26 05:48:39 -0600[diff] [blame]24 errors:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]25 - xyz.openbmc_project.Common.Error.InvalidArgument
26 - com.ibm.VPD.Error.PathNotFound
27 - com.ibm.VPD.Error.RecordNotFound
28 - com.ibm.VPD.Error.KeywordNotFound
SunnySrivastava198426ff1c82020-02-26 05:48:39 -0600[diff] [blame]29
30 - name: GetFRUsByUnexpandedLocationCode
31 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -0600[diff] [blame]32 A method to get list of FRU D-BUS object paths for a given unexpanded
33 location code.
SunnySrivastava198426ff1c82020-02-26 05:48:39 -0600[diff] [blame]34 parameters:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]35 - name: locationCode
36 type: string
37 description: >
38 An un-expanded Location code.
39 - name: nodeNumber
40 type: uint16
41 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -0600[diff] [blame]42 Denotes the node in case of a multi-node configuration, ignored
43 on a single node system.
SunnySrivastava198426ff1c82020-02-26 05:48:39 -0600[diff] [blame]44 returns:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]45 - name: inventoryList
Patrick Williamsb78a0702022-10-24 12:32:56 -0500[diff] [blame]46 type: array[object_path]
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]47 description: >
48 List of all the FRUs D-Bus object paths for the given location
49 code.
SunnySrivastava198426ff1c82020-02-26 05:48:39 -0600[diff] [blame]50 errors:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]51 - xyz.openbmc_project.Common.Error.InvalidArgument
52 - com.ibm.VPD.Error.LocationNotFound
53 - com.ibm.VPD.Error.NodeNotFound
SunnySrivastava198426ff1c82020-02-26 05:48:39 -0600[diff] [blame]54
55 - name: GetFRUsByExpandedLocationCode
56 description: >
57 A method to get list of FRU D-BUS object paths for a given expanded
58 location code.
59 parameters:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]60 - name: locationCode
61 type: string
62 description: >
63 Location code in expanded format.
SunnySrivastava198426ff1c82020-02-26 05:48:39 -0600[diff] [blame]64 returns:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]65 - name: inventoryList
Patrick Williamsb78a0702022-10-24 12:32:56 -0500[diff] [blame]66 type: array[object_path]
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]67 description: >
68 List of all the FRUs D-Bus object path for the given location
69 code.
SunnySrivastava198426ff1c82020-02-26 05:48:39 -0600[diff] [blame]70 errors:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]71 - xyz.openbmc_project.Common.Error.InvalidArgument
72 - com.ibm.VPD.Error.LocationNotFound
73 - com.ibm.VPD.Error.NodeNotFound
SunnySrivastava198426ff1c82020-02-26 05:48:39 -0600[diff] [blame]74
75 - name: GetExpandedLocationCode
76 description: >
77 An api to get expanded location code corresponding to a given
Patrick Williamsa1347412022-12-06 10:56:22 -0600[diff] [blame]78 un-expanded location code. Expanded location codes gives the location
79 of the FRU in the system.
SunnySrivastava198426ff1c82020-02-26 05:48:39 -0600[diff] [blame]80 parameters:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]81 - name: locationCode
82 type: string
83 description: >
84 Location code in un-expanded format.
85 - name: nodeNumber
86 type: uint16
87 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -0600[diff] [blame]88 Denotes the node in case of multi-node configuration. Ignored in
89 case of single node configuration.
SunnySrivastava198426ff1c82020-02-26 05:48:39 -0600[diff] [blame]90 returns:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]91 - name: locationCode
92 type: string
93 description: >
94 Location code in expanded format.
SunnySrivastava198426ff1c82020-02-26 05:48:39 -0600[diff] [blame]95 errors:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]96 - xyz.openbmc_project.Common.Error.InvalidArgument
97 - com.ibm.VPD.Error.LocationNotFound
98 - com.ibm.VPD.Error.NodeNotFound
SunnySrivastava19849c3dab32020-09-07 03:47:05 -0500[diff] [blame]99
100 - name: PerformVPDRecollection
101 description: >
102 An api to check for FRUs replaced and if required, perform
103 recollection of VPD data for them.
104 errors:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]105 - xyz.openbmc_project.Common.Error.InvalidArgument