1#!/usr/bin/env python3
2
3r"""
4Contains PLDM-related constants.
5"""
6
7PLDM_SUPPORTED_TYPES = ['base', 'platform', 'bios', 'fru', 'oem-ibm']
8
9# 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': '63', 'STRING': 'oem-ibm'}
15PLDM_SUPPORTED_TYPES = ['0(base)', '2(platform)', '3(bios)', '4(fru)', '63(oem-ibm)']
16
17VERSION_BASE = {'VALUE': ['f1', 'f0', 'f0', '00'], 'STRING': '1.0.0'}
18VERSION_PLATFORM = {'VALUE': ['f1', 'f2', 'f0', '00'], 'STRING': '1.2.0'}
19VERSION_BIOS = {'VALUE': ['f1', 'f1', 'f1', '00'], 'STRING': '1.0.0'}
20VERSION_FRU = {'VALUE': ['f1', 'f0', 'f0', '00'], 'STRING': '1.0.0'}
21VERSION_OEM = {'VALUE': ['f1', 'f0', 'f0', '00'], 'STRING': '1.0.0'}
22
23
24PLDM_BASE_CMDS = ['2(GetTID)', '3(GetPLDMVersion)', '4(GetPLDMTypes)', '5(GetPLDMCommands)']
25PLDM_PLATFORM_CMDS = ['57(SetStateEffecterStates)', '81(GetPDR)']
26PLDM_BIOS_CMDS = ['1(GetBIOSTable)', '7(SetBIOSAttributeCurrentValue)',
27                  '8(GetBIOSAttributeCurrentValueByHandle)', '12(GetDateTime)',
28                  '13(SetDateTime)']
29PLDM_FRU_CMDS = ['1(GetFRURecordTableMetadata)', '2(GetFRURecordTable)', '4(GetFRURecordByOption)']
30PLDM_OEM_CMDS = ['1(GetFileTable)', '4(ReadFile)', '5(WriteFile)', '6(ReadFileInToMemory)',
31                 '7(WriteFileFromMemory)', '8(ReadFileByTypeIntoMemory)',
32                 '9(WriteFileByTypeFromMemory)', '10(NewFileAvailable)',
33                 '11(ReadFileByType)', '12(WriteFileByType)', '13(FileAck)',
34                 '240(GetAlertStatus)']
35
36# PLDM command format.
37
38'''
39e.g. : GetPLDMVersion usage
40
41pldmtool base GetPLDMVersion -t <pldm_type>
42
43pldm supported types
44
45base->0,platform->2,bios->3,fru->4
46
47'''
48CMD_GETPLDMVERSION = 'base GetPLDMVersion -t %s'
49
50'''
51e.g. : PLDM raw command usage
52
53pldmtool raw -d 0x80 0x00 0x03 0x00 0x00 0x00 0x00 0x01 0x00
54
55pldm raw -d 0x<header> 0x<pldm_type> 0x<pldm_cmd_type> 0x<payload_data>
56'''
57
58CMD_PLDMTOOL_RAW = 'raw -d 0x80' + '0x%s' + ' ' + '0x%s'
59
60
61# PLDM command payload data.
62
63PAYLOAD_GetPLDMVersion = \
64    ' 0x00 0x00 0x00 0x00 0x%s 0x%s'    # %(TransferOperationFlag, PLDMType)
65
66
67'''
68e.g. : SetDateTime usage
69
70pldmtool bios SetDateTime -d <YYYYMMDDHHMMSS>
71
72'''
73CMD_SETDATETIME = 'bios SetDateTime -d %s'
74
75
76CMD_GETPDR = 'platform GetPDR -d %s'
77
78'''
79e.g. : SetStateEffecterStates usage
80
81pldmtool platform GetPDR -i <effter_handle> -c <count> -d <effecterID, effecterState>
82
83pldmtool platform SetStateEffecterStates -i 1 -c 1 -d 1 1
84'''
85
86CMD_SETSTATEEFFECTERSTATES = 'platform SetStateEffecterStates -i %s -c %s -d %s'
87
88# GetPDR parsed response message for record handle.
89# Dictionary value array holds the expected output for record handle 1, 2.
90#
91# Note :
92#      Record handle - 0 is default &  has same behaviour as record handle 1
93#      Only record handle 0, 1, 2 are supported as of now.
94
95RESPONSE_DICT_GETPDR_SETSTATEEFFECTER = {
96    'PDRHeaderVersion': [1],
97    'PDRType': ['State Effecter PDR'],
98    'recordChangeNumber': [0],
99    'effecterID': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
100    'entityType': ['Virtual Machine Manager', 'System chassis (main enclosure)',
101                   'System Firmware', 'Processor Module', '32801(OEM)',
102                   'Management Controller', '24577(OEM)'],
103    'entityInstanceNumber': [0, 1, 2, 3, 4],
104    'containerID': [0, 1],
105    'effecterSemanticID': [0],
106    'effecterInit': ['noInit'],
107    'effecterDescriptionPDR': [False],
108    'compositeEffecterCount': [1]}
109
110RESPONSE_DICT_GETPDR_FRURECORDSETIDENTIFIER = {
111    'PDRHeaderVersion': [1],
112    'PDRType': ['FRU Record Set PDR'],
113    'recordChangeNumber': [0],
114    'dataLength': [10],
115    'entityType': ['System Board', 'Chassis front panel board (control panel)',
116                   'Management Controller', 'OEM', 'Power converter',
117                   'System (logical)', 'System chassis (main enclosure)',
118                   'Chassis front panel board (control panel)',
119                   'Processor Module', 'Memory Module', 'Power Supply',
120                   '24576(OEM)', '60(OEM)', 'Processor', '142(OEM)'],
121    'containerID': [0, 1, 2, 3]}
122
123RESPONSE_DICT_GETPDR_PDRENTITYASSOCIATION = {
124    'PDRHeaderVersion': [1],
125    'PDRType': ['Entity Association PDR'],
126    'recordChangeNumber': [0],
127    'containerID': [1, 2, 3],
128    'associationtype': ['Physical'],
129    'containerentityType': ['System Board', 'System (logical)',
130                            'System chassis (main enclosure)']}
131
132RESPONSE_DICT_GETPDR_STATESENSORPDR = {
133    'entityType': ['Communication Channel', 'Connector', 'Processor Module',
134                   '32774(OEM)', '57346(OEM)', '57347(OEM)', '32801(OEM)',
135                   '91(OEM)', '5(OEM)', '24577(OEM)'],
136    'sensorInit': ['noInit'],
137    'sensorAuxiliaryNamesPDR': [False]}
138
139RESPONSE_DICT_GETPDR_TERMINUSLOCATORPDR = {
140    'PDRHeaderVersion': [1],
141    'PDRType': ['Terminus Locator PDR'],
142    'recordChangeNumber': [0],
143    'validity': ['valid'],
144    'TID': [0, 1, 208],
145    'containerID': [0, 1],
146    'terminusLocatorType': ['MCTP_EID'],
147    'terminusLocatorValueSize': [1]}
148
149RESPONSE_DICT_GETPDR_NUMERICEFFECTERPDR = {
150    'PDRHeaderVersion': [1],
151    'PDRType': ['Numeric Effecter PDR'],
152    'recordChangeNumber': [0],
153    'entityInstanceNumber': [0, 1],
154    'containerID': [0],
155    'effecterSemanticID': [0],
156    'effecterInit': [0],
157    'effecterAuxiliaryNames': [False],
158    'baseUnit': [0, 72, 21],
159    'unitModifier': [0],
160    'baseOEMUnitHandle': [0],
161    'auxUnit': [0],
162    'auxUnitModifier': [0],
163    'auxrateUnit': [0],
164    'auxOEMUnitHandle': [0],
165    'resolution': [1, 0],
166    'offset': [0],
167    'accuracy': [0],
168    'plusTolerance': [0],
169    'minusTolerance': [0],
170    'stateTransitionInterval': [0],
171    'TransitionInterval': [0],
172    'minSettable': [0],
173    'rangeFieldSupport': [0],
174    'nominalValue': [0],
175    'normalMax': [0],
176    'normalMin': [0],
177    'ratedMax': [0],
178    'ratedMin': [0]}
179
180PLDM_PDR_TYPES = {
181    'PLDM_STATE_EFFECTER_PDR': 'State Effecter PDR',
182    'PLDM_PDR_FRU_RECORD_SET': 'FRU Record Set PDR',
183    'PLDM_PDR_ENTITY_ASSOCIATION': 'Entity Association PDR',
184    'PLDM_STATE_SENSOR_PDR': 'State Sensor PDR',
185    'PLDM_NUMERIC_EFFECTER_PDR': 'Numeric Effecter PDR',
186    'PLDM_TERMINUS_LOCATOR_PDR': 'Terminus Locator PDR',
187    'PLDM_COMPACT_NUMERIC_SENSOR_PDR': '21'}
188
189RESPONSE_LIST_GETBIOSTABLE_ATTRVALTABLE = [
190    'BIOSString', 'BIOSInteger', 'BIOSEnumeration']
191