blob: ddeacd44f880877f7a4c05a9136ee424f83e2896 [file] [log] [blame]
SunnySrivastava198426ff1c82020-02-26 05:48:39 -06001description: >
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 -05008 - name: path
9 type: path
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 -060024 errors:
Patrick Williams8da396c2022-03-14 14:21:02 -050025 - 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 -060029
30 - name: GetFRUsByUnexpandedLocationCode
31 description: >
32 A method to get list of FRU D-BUS object paths for a given
33 unexpanded location code.
34 parameters:
Patrick Williams8da396c2022-03-14 14:21:02 -050035 - name: locationCode
36 type: string
37 description: >
38 An un-expanded Location code.
39 - name: nodeNumber
40 type: uint16
41 description: >
42 Denotes the node in case of a multi-node configuration,
43 ignored on a single node system.
SunnySrivastava198426ff1c82020-02-26 05:48:39 -060044 returns:
Patrick Williams8da396c2022-03-14 14:21:02 -050045 - name: inventoryList
46 type: array[path]
47 description: >
48 List of all the FRUs D-Bus object paths for the given location
49 code.
SunnySrivastava198426ff1c82020-02-26 05:48:39 -060050 errors:
Patrick Williams8da396c2022-03-14 14:21:02 -050051 - xyz.openbmc_project.Common.Error.InvalidArgument
52 - com.ibm.VPD.Error.LocationNotFound
53 - com.ibm.VPD.Error.NodeNotFound
SunnySrivastava198426ff1c82020-02-26 05:48:39 -060054
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 -050060 - name: locationCode
61 type: string
62 description: >
63 Location code in expanded format.
SunnySrivastava198426ff1c82020-02-26 05:48:39 -060064 returns:
Patrick Williams8da396c2022-03-14 14:21:02 -050065 - name: inventoryList
66 type: array[path]
67 description: >
68 List of all the FRUs D-Bus object path for the given location
69 code.
SunnySrivastava198426ff1c82020-02-26 05:48:39 -060070 errors:
Patrick Williams8da396c2022-03-14 14:21:02 -050071 - xyz.openbmc_project.Common.Error.InvalidArgument
72 - com.ibm.VPD.Error.LocationNotFound
73 - com.ibm.VPD.Error.NodeNotFound
SunnySrivastava198426ff1c82020-02-26 05:48:39 -060074
75 - name: GetExpandedLocationCode
76 description: >
77 An api to get expanded location code corresponding to a given
78 un-expanded location code.
79 Expanded location codes gives the location of the FRU in the system.
80 parameters:
Patrick Williams8da396c2022-03-14 14:21:02 -050081 - name: locationCode
82 type: string
83 description: >
84 Location code in un-expanded format.
85 - name: nodeNumber
86 type: uint16
87 description: >
88 Denotes the node in case of multi-node configuration.
89 Ignored in case of single node configuration.
SunnySrivastava198426ff1c82020-02-26 05:48:39 -060090 returns:
Patrick Williams8da396c2022-03-14 14:21:02 -050091 - name: locationCode
92 type: string
93 description: >
94 Location code in expanded format.
SunnySrivastava198426ff1c82020-02-26 05:48:39 -060095 errors:
Patrick Williams8da396c2022-03-14 14:21:02 -050096 - xyz.openbmc_project.Common.Error.InvalidArgument
97 - com.ibm.VPD.Error.LocationNotFound
98 - com.ibm.VPD.Error.NodeNotFound
SunnySrivastava19849c3dab32020-09-07 03:47:05 -050099
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 -0500105 - xyz.openbmc_project.Common.Error.InvalidArgument