blob: 9cda77a0094557feaf83371289250067e4bc0f0b [file] [log] [blame]
Sridevi Ramesh70e14182019-08-27 04:04:27 -05001#!/usr/bin/python
2
3r"""
4Contains PLDM-related constants.
5"""
6
Sridevi Ramesh1495bc42020-02-04 03:13:33 -06007PLDM_SUPPORTED_TYPES = ['base', 'platform', 'bios']
Rahul Maheshwari4d488572019-12-10 23:53:05 -06008
Sridevi Rameshc4e1cba2019-12-03 00:12:27 -06009# PLDM types.
10PLDM_TYPE_BASE = {'VALUE': '00', 'STRING': 'base'}
11PLDM_TYPE_PLATFORM = {'VALUE': '02', 'STRING': 'platform'}
12PLDM_TYPE_BIOS = {'VALUE': '03', 'STRING': 'bios'}
13PLDM_TYPE_FRU = {'VALUE': '04', 'STRING': 'fru'}
14PLDM_TYPE_OEM = {'VALUE': '3F', 'STRING': 'oem'}
Sridevi Ramesh70e14182019-08-27 04:04:27 -050015
Sridevi Rameshc4e1cba2019-12-03 00:12:27 -060016VERSION_BASE = {'VALUE': ['f1', 'f0', 'f0', '00'], 'STRING': '1.0.0'}
Sridevi Rameshec753aa2020-02-17 22:55:13 -060017VERSION_PLATFORM = {'VALUE': ['f1', 'f2', 'f0', '00'], 'STRING': '1.2.0'}
Sridevi Rameshc4e1cba2019-12-03 00:12:27 -060018VERSION_BIOS = {'VALUE': ['f1', 'f1', 'f1', '00'], 'STRING': '1.0.0'}
19VERSION_FRU = {'VALUE': ['f1', 'f0', 'f0', '00'], 'STRING': '1.0.0'}
Sridevi Ramesh70e14182019-08-27 04:04:27 -050020
Sridevi Rameshc4e1cba2019-12-03 00:12:27 -060021# PLDM base related variables.
Sridevi Ramesh70e14182019-08-27 04:04:27 -050022PLDM_BASE_CMD = {
Sridevi Rameshc4e1cba2019-12-03 00:12:27 -060023 'GET_TID': '02',
24 'GET_PLDM_VERSION': '03',
25 'GET_PLDM_TYPES': '04',
26 'GET_PLDM_COMMANDS': '05'}
Sridevi Ramesh70e14182019-08-27 04:04:27 -050027
Sridevi Rameshc4e1cba2019-12-03 00:12:27 -060028# Response lengths are inclusive of completion code.
29GET_TID_RESP_BYTES = 2
30GET_PLDM_VERSION_RESP_BYTES = 10
31GET_PLDM_TYPES_RESP_BYTES = 9
32GET_PLDM_COMMANDS_RESP_BYTES = 33
Sridevi Ramesh70e14182019-08-27 04:04:27 -050033
Sridevi Rameshc4e1cba2019-12-03 00:12:27 -060034# PLDM bios related variables.
Sridevi Ramesh70e14182019-08-27 04:04:27 -050035PLDM_BIOS_CMD = {
36 'GET_BIOS_TABLE': '01',
37 'SET_BIOS_ATTRIBUTE_CURRENT_VALUE': '07',
38 'GET_BIOS_ATTRIBUTE_CURRENT_VALUE_BY_HANDLE': '08',
39 'GET_DATE_TIME': '0c'}
40
Sridevi Rameshc4e1cba2019-12-03 00:12:27 -060041PLDM_BIOS_TABLE_TYPES = {
42 'STRING_TABLE': '00',
43 'ATTRIBUTE_TABLE': '01',
44 'ATTRIBUTE_VAL_TABLE': '02'}
45
46TRANSFER_OPERATION_FLAG = {
47 'GETNEXTPART': '00',
48 'GETFIRSTPART': '01'}
49
50TRANSFER_RESP_FLAG = {
51 'PLDM_START': '01',
52 'PLDM_MIDDLE': '02',
53 'PLDM_END': '04',
54 'PLDM_START_AND_END': '05'}
55
56# PLDM platform related variables.
Sridevi Ramesh70e14182019-08-27 04:04:27 -050057PLDM_PLATFORM_CMD = {
58 'SET_STATE_EFFECTER_STATES': '39',
59 'GET_PDR': '51'}
60
61PLDM_PDR_TYPES = {
62 'STATE_EFFECTER_PDR': '11'}
63
64# PLDM OEM related variables.
65PLDM_FILEIO_CMD = {
66 'GET_FILE_TABLE': '1',
67 'READ_FILE': '4',
68 'WRITE_FILE': '5',
69 'READ_FILE_INTO_MEMORY': '6',
70 'WRITE_FILE_FROM_MEMORY': '7'}
71
72PLDM_FILEIO_COMPLETION_CODES = {
73 'INVALID_FILE_HANDLE': '80',
74 'DATA_OUT_OF_RANGE': '81',
75 'INVALID_READ_LENGTH': '82',
76 'INVALID_WRITE_LENGTH': '83',
77 'FILE_TABLE_UNAVAILABLE': '84',
78 'INVALID_FILE_TABLE_TYPE': '85'}
Sridevi Rameshc4e1cba2019-12-03 00:12:27 -060079
80# PLDM FRU related variables.
81PLDM_FRU_CMD = {
82 'PLDM_GET_FRU_RECORD_TABLE_METADATA': '01',
83 'PLDM_GET_FRU_RECORD_TABLE': '02'}
84
85# PLDM command format.
86
Sridevi Rameshc4e1cba2019-12-03 00:12:27 -060087'''
88e.g. : GetPLDMVersion usage
89
90pldmtool base GetPLDMVersion -t <pldm_type>
91
92pldm supported types
93
94base->0,platform->2,bios->3,fru->4
95
96'''
Rahul Maheshwari4d488572019-12-10 23:53:05 -060097CMD_GETPLDMVERSION = 'base GetPLDMVersion -t %s'
Sridevi Rameshc4e1cba2019-12-03 00:12:27 -060098
99'''
100e.g. : PLDM raw command usage
101
102pldmtool raw -d 0x80 0x00 0x03 0x00 0x00 0x00 0x00 0x01 0x00
103
104pldm raw -d 0x<header> 0x<pldm_type> 0x<pldm_cmd_type> 0x<payload_data>
105'''
106
Rahul Maheshwari4d488572019-12-10 23:53:05 -0600107CMD_PLDMTOOL_RAW = 'raw -d 0x80' + '0x%s' + ' ' + '0x%s'
Sridevi Rameshc4e1cba2019-12-03 00:12:27 -0600108
109
110# PLDM command payload data.
111
112PAYLOAD_GetPLDMVersion = \
113 ' 0x00 0x00 0x00 0x00 0x%s 0x%s' # %(TransferOperationFlag, PLDMType)
Rahul Maheshwari4d488572019-12-10 23:53:05 -0600114
115
Sridevi Ramesh1495bc42020-02-04 03:13:33 -0600116'''
117e.g. : SetDateTime usage
118
119pldmtool bios SetDateTime -d <YYYYMMDDHHMMSS>
120
121'''
122CMD_SETDATETIME = 'bios SetDateTime -d %s'
Sridevi Rameshfe52e402020-02-05 00:15:24 -0600123
124
125CMD_GETPDR = 'platform GetPDR -d %s'
126
127'''
128e.g. : SetStateEffecterStates usage
129
130pldmtool platform GetPDR -d <effecterID, requestSet, effecterState>
131
132pldmtool platform SetStateEffecterStates -d 1 1 1
133
134'''
135
136CMD_SETSTATEEFFECTERSTATES = 'platform SetStateEffecterStates -d %s'
137
138# GetPDR parsed response message for record handle.
139# Dictionary value array holds the expected output for record handle 1, 2.
140# e.g. : 'nextrecordhandle': ['0', '2']
141#
142# Note :
143# Record handle - 0 is default & has same behaviour as record handle 1
144# Only record handle 0, 1, 2 are supported as of now.
145
146RESPONSE_DICT_GETPDR = {
147 'nextrecordhandle': ['0', '2'],
148 'responsecount': ['29', '30'],
149 'recordhandle': ['1', '2'],
150 'pdrheaderversion': ['1'],
151 'pdrtype': ['11'],
152 'recordchangenumber': ['0'],
153 'datalength': ['19', '20'],
154 'pldmterminushandle': ['0'],
155 'effecterid': ['1', '2'],
156 'entitytype': ['33', '45'],
157 'entityinstancenumber': ['0'],
158 'containerid': ['0'],
159 'effectersemanticid': ['0'],
160 'effecterinit': ['0'],
161 'effecterdescriptionpdr': ['false'],
162 'compositeeffectercount': ['1'],
163 'statesetid': ['196', '260'],
164 'possiblestatessize': ['1', '2'],
165 'possiblestates': ['6', '0']}
166
Sridevi Rameshfe52e402020-02-05 00:15:24 -0600167RESPONSE_DICT_GETBIOSTABLE_STRTABLE = {
168 'biosstringhandle': ['BIOSString'],
169 '0': ['Allowed'],
170 '1': ['Disabled'],
171 '2': ['Enabled'],
172 '3': ['Not Allowed'],
173 '4': ['Perm'],
174 '5': ['Temp'],
175 '6': ['pvm-fw-boot-side'],
176 '7': ['pvm-inband-code-update'],
177 '8': ['pvm-os-boot-side'],
178 '9': ['pvm-pcie-error-inject'],
179 '10': ['pvm-surveillance'],
180 '11': ['pvm-system-name'],
181 '12': ['vmi-if-count']}