xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Smbios/MDR_V2.interface.yaml (revision 921791c73008a3edfc6507afb5bc15e48963d295) 
1b1b4d261SWilliam A. Kennington IIIdescription: >
2b1b4d261SWilliam A. Kennington III    SMBIOS MDR V2 service
3b1b4d261SWilliam A. Kennington IIImethods:
4b1b4d261SWilliam A. Kennington III    - name: GetDirectoryInformation
5b1b4d261SWilliam A. Kennington III      description: >
6b1b4d261SWilliam A. Kennington III          Get the directory with directory index.
7b1b4d261SWilliam A. Kennington III      parameters:
8b1b4d261SWilliam A. Kennington III          - name: dirIndex
9b1b4d261SWilliam A. Kennington III            type: byte
10b1b4d261SWilliam A. Kennington III            description: >
11b1b4d261SWilliam A. Kennington III                Directory index of SMBIOS.
12b1b4d261SWilliam A. Kennington III      returns:
13b1b4d261SWilliam A. Kennington III          - name: dir
14b1b4d261SWilliam A. Kennington III            type: array[byte]
15b1b4d261SWilliam A. Kennington III            description: >
16b1b4d261SWilliam A. Kennington III                Directory of agent.
17b1b4d261SWilliam A. Kennington III      errors:
18b1b4d261SWilliam A. Kennington III          - self.Error.InvalidParameter
19b1b4d261SWilliam A. Kennington III
20b1b4d261SWilliam A. Kennington III    - name: GetDataInformation
21b1b4d261SWilliam A. Kennington III      description: >
22b1b4d261SWilliam A. Kennington III          Get the data info with id index and data set ID.
23b1b4d261SWilliam A. Kennington III      parameters:
24b1b4d261SWilliam A. Kennington III          - name: idIndex
25b1b4d261SWilliam A. Kennington III            type: byte
26b1b4d261SWilliam A. Kennington III            description: >
27b1b4d261SWilliam A. Kennington III                Index of SMBIOS directory.
28b1b4d261SWilliam A. Kennington III      returns:
29b1b4d261SWilliam A. Kennington III          - name: dataInfo
30b1b4d261SWilliam A. Kennington III            type: array[byte]
31b1b4d261SWilliam A. Kennington III            description: >
32b1b4d261SWilliam A. Kennington III                Data information of SMBIOS.
33b1b4d261SWilliam A. Kennington III      errors:
34b1b4d261SWilliam A. Kennington III          - self.Error.InvalidParameter
35b1b4d261SWilliam A. Kennington III
36b1b4d261SWilliam A. Kennington III    - name: SendDirectoryInformation
37b1b4d261SWilliam A. Kennington III      description: >
38b1b4d261SWilliam A. Kennington III          Send directory information to SMBIOS directory.
39b1b4d261SWilliam A. Kennington III      parameters:
40b1b4d261SWilliam A. Kennington III          - name: dirVersion
41b1b4d261SWilliam A. Kennington III            type: byte
42b1b4d261SWilliam A. Kennington III            description: >
43b1b4d261SWilliam A. Kennington III                A counter which increments each time directory updated.
44b1b4d261SWilliam A. Kennington III          - name: dirIndex
45b1b4d261SWilliam A. Kennington III            type: byte
46b1b4d261SWilliam A. Kennington III            description: >
47b1b4d261SWilliam A. Kennington III                Directory index of SMBIOS.
48b1b4d261SWilliam A. Kennington III          - name: returnedEntries
49b1b4d261SWilliam A. Kennington III            type: byte
50b1b4d261SWilliam A. Kennington III            description: >
51b1b4d261SWilliam A. Kennington III                Indicates number of directory entries.
52b1b4d261SWilliam A. Kennington III          - name: remainingEntries
53b1b4d261SWilliam A. Kennington III            type: byte
54b1b4d261SWilliam A. Kennington III            description: >
55b1b4d261SWilliam A. Kennington III                Remaining entries which are higher than index in this transfer.
56b1b4d261SWilliam A. Kennington III          - name: dirEntry
57b1b4d261SWilliam A. Kennington III            type: array[byte]
58b1b4d261SWilliam A. Kennington III            description: >
59b1b4d261SWilliam A. Kennington III                Data set ID of SMBIOS table.
60b1b4d261SWilliam A. Kennington III      returns:
61b1b4d261SWilliam A. Kennington III          - name: status
62b1b4d261SWilliam A. Kennington III            type: boolean
63b1b4d261SWilliam A. Kennington III            description: >
64*921791c7SManojkiran Eda                Need to continue directory transmission or not.
65b1b4d261SWilliam A. Kennington III      errors:
66b1b4d261SWilliam A. Kennington III          - self.Error.InvalidParameter
67b1b4d261SWilliam A. Kennington III
68b1b4d261SWilliam A. Kennington III    - name: GetDataOffer
69b1b4d261SWilliam A. Kennington III      description: >
70b1b4d261SWilliam A. Kennington III          Get data set ID.
71b1b4d261SWilliam A. Kennington III      returns:
72b1b4d261SWilliam A. Kennington III          - name: offer
73b1b4d261SWilliam A. Kennington III            type: array[byte]
74b1b4d261SWilliam A. Kennington III            description: >
75b1b4d261SWilliam A. Kennington III                Data set ID.
76b1b4d261SWilliam A. Kennington III      errors:
77b1b4d261SWilliam A. Kennington III          - self.Error.UpdateInProgress
78b1b4d261SWilliam A. Kennington III
79b1b4d261SWilliam A. Kennington III    - name: SendDataInformation
80b1b4d261SWilliam A. Kennington III      description: >
81b1b4d261SWilliam A. Kennington III          Send data information with directory index.
82b1b4d261SWilliam A. Kennington III      parameters:
83b1b4d261SWilliam A. Kennington III          - name: idIndex
84b1b4d261SWilliam A. Kennington III            type: byte
85b1b4d261SWilliam A. Kennington III            description: >
86b1b4d261SWilliam A. Kennington III                Index of SMBIOS directory.
87b1b4d261SWilliam A. Kennington III          - name: flag
88b1b4d261SWilliam A. Kennington III            type: byte
89b1b4d261SWilliam A. Kennington III            description: >
90b1b4d261SWilliam A. Kennington III                Valid flag to set dir entry status.
91b1b4d261SWilliam A. Kennington III          - name: dataLen
92b1b4d261SWilliam A. Kennington III            type: uint32
93b1b4d261SWilliam A. Kennington III            description: >
94b1b4d261SWilliam A. Kennington III                The length of the data in bytes.
95b1b4d261SWilliam A. Kennington III          - name: dataVer
96b1b4d261SWilliam A. Kennington III            type: uint32
97b1b4d261SWilliam A. Kennington III            description: >
98b1b4d261SWilliam A. Kennington III                The version number of this data.
99b1b4d261SWilliam A. Kennington III          - name: timeStamp
100b1b4d261SWilliam A. Kennington III            type: uint32
101b1b4d261SWilliam A. Kennington III            description: >
102*921791c7SManojkiran Eda                Timestamp determined by the agent.
103b1b4d261SWilliam A. Kennington III      returns:
104b1b4d261SWilliam A. Kennington III          - name: status
105b1b4d261SWilliam A. Kennington III            type: boolean
106b1b4d261SWilliam A. Kennington III            description: >
107b1b4d261SWilliam A. Kennington III                Whether data changes.
108b1b4d261SWilliam A. Kennington III      errors:
109b1b4d261SWilliam A. Kennington III          - self.Error.InvalidParameter
110b1b4d261SWilliam A. Kennington III
111b1b4d261SWilliam A. Kennington III    - name: FindIdIndex
112b1b4d261SWilliam A. Kennington III      description: >
113b1b4d261SWilliam A. Kennington III          Find id index by data info.
114b1b4d261SWilliam A. Kennington III      parameters:
115b1b4d261SWilliam A. Kennington III          - name: dataInfo
116b1b4d261SWilliam A. Kennington III            type: array[byte]
117b1b4d261SWilliam A. Kennington III            description: >
118b1b4d261SWilliam A. Kennington III                Data info of data entry.
119b1b4d261SWilliam A. Kennington III      returns:
120b1b4d261SWilliam A. Kennington III          - name: idIndex
121b1b4d261SWilliam A. Kennington III            type: int32
122b1b4d261SWilliam A. Kennington III            description: >
123b1b4d261SWilliam A. Kennington III                Id index of data entry.
124b1b4d261SWilliam A. Kennington III      errors:
125b1b4d261SWilliam A. Kennington III          - self.Error.InvalidId
126b1b4d261SWilliam A. Kennington III
127b1b4d261SWilliam A. Kennington III    - name: AgentSynchronizeData
128b1b4d261SWilliam A. Kennington III      description: >
129b1b4d261SWilliam A. Kennington III          Synchronize SMBIOS data from file.
130b1b4d261SWilliam A. Kennington III      returns:
131b1b4d261SWilliam A. Kennington III          - name: status
132b1b4d261SWilliam A. Kennington III            type: boolean
133b1b4d261SWilliam A. Kennington III            description: >
134b1b4d261SWilliam A. Kennington III                Whether synchronization succeed or not.
135b1b4d261SWilliam A. Kennington III
136b1b4d261SWilliam A. Kennington III    - name: SynchronizeDirectoryCommonData
137b1b4d261SWilliam A. Kennington III      description: >
138b1b4d261SWilliam A. Kennington III          Synchronize directory common data.
139b1b4d261SWilliam A. Kennington III      parameters:
140b1b4d261SWilliam A. Kennington III          - name: idIndex
141b1b4d261SWilliam A. Kennington III            type: byte
142b1b4d261SWilliam A. Kennington III            description: >
143b1b4d261SWilliam A. Kennington III                Index of SMBIOS directory.
144b1b4d261SWilliam A. Kennington III          - name: size
145b1b4d261SWilliam A. Kennington III            type: uint32
146b1b4d261SWilliam A. Kennington III            description: >
147b1b4d261SWilliam A. Kennington III                Size of data that BIOS prepare to transfer.
148b1b4d261SWilliam A. Kennington III      returns:
149b1b4d261SWilliam A. Kennington III          - name: commonData
150b1b4d261SWilliam A. Kennington III            type: array[uint32]
151b1b4d261SWilliam A. Kennington III            description: >
152b1b4d261SWilliam A. Kennington III                Directory common data includes data size, version and timestamp.
153b1b4d261SWilliam A. Kennington III
154b1b4d261SWilliam A. Kennington IIIproperties:
155b1b4d261SWilliam A. Kennington III    - name: DirectoryEntries
156b1b4d261SWilliam A. Kennington III      type: byte
157b1b4d261SWilliam A. Kennington III      description: >
158b1b4d261SWilliam A. Kennington III          Numbers of directory entries.
159