blob: 2bf829d2680325db9542e1c8408e02a5385d031a [file] [log] [blame]
Tom Josepha65c0412020-07-03 21:14:44 +05301#include "libpldm/entity.h"
2#include "libpldm/state_set.h"
3
4#include "common/types.hpp"
George Liud6649362019-11-27 19:06:51 +08005#include "pldm_cmd_helper.hpp"
6
Brad Bishop02d71142021-10-14 19:00:17 -04007#include <cstddef>
8#include <map>
9
Sridevi Rameshdcdcd3b2021-06-15 04:06:49 -050010#ifdef OEM_IBM
11#include "oem/ibm/oem_ibm_state_set.hpp"
12#endif
13
Brad Bishop5079ac42021-08-19 18:35:06 -040014using namespace pldm::utils;
15
George Liud6649362019-11-27 19:06:51 +080016namespace pldmtool
17{
18
19namespace platform
20{
21
22namespace
23{
24
25using namespace pldmtool::helper;
Sridevi Rameshf31b5042021-01-22 05:42:07 -060026
27static const std::map<uint8_t, std::string> sensorPresState{
28 {PLDM_SENSOR_UNKNOWN, "Sensor Unknown"},
29 {PLDM_SENSOR_NORMAL, "Sensor Normal"},
30 {PLDM_SENSOR_WARNING, "Sensor Warning"},
31 {PLDM_SENSOR_CRITICAL, "Sensor Critical"},
32 {PLDM_SENSOR_FATAL, "Sensor Fatal"},
33 {PLDM_SENSOR_LOWERWARNING, "Sensor Lower Warning"},
34 {PLDM_SENSOR_LOWERCRITICAL, "Sensor Lower Critical"},
35 {PLDM_SENSOR_LOWERFATAL, "Sensor Lower Fatal"},
36 {PLDM_SENSOR_UPPERWARNING, "Sensor Upper Warning"},
37 {PLDM_SENSOR_UPPERCRITICAL, "Sensor Upper Critical"},
38 {PLDM_SENSOR_UPPERFATAL, "Sensor Upper Fatal"}};
39
40static const std::map<uint8_t, std::string> sensorOpState{
41 {PLDM_SENSOR_ENABLED, "Sensor Enabled"},
42 {PLDM_SENSOR_DISABLED, "Sensor Disabled"},
43 {PLDM_SENSOR_UNAVAILABLE, "Sensor Unavailable"},
44 {PLDM_SENSOR_STATUSUNKOWN, "Sensor Status Unknown"},
45 {PLDM_SENSOR_FAILED, "Sensor Failed"},
46 {PLDM_SENSOR_INITIALIZING, "Sensor Sensor Intializing"},
47 {PLDM_SENSOR_SHUTTINGDOWN, "Sensor Shutting down"},
48 {PLDM_SENSOR_INTEST, "Sensor Intest"}};
49
George Liud6649362019-11-27 19:06:51 +080050std::vector<std::unique_ptr<CommandInterface>> commands;
51
52} // namespace
53
Sridevi Ramesh27c512a2020-08-12 03:29:42 -050054using ordered_json = nlohmann::ordered_json;
55
George Liud6649362019-11-27 19:06:51 +080056class GetPDR : public CommandInterface
57{
58 public:
59 ~GetPDR() = default;
60 GetPDR() = delete;
61 GetPDR(const GetPDR&) = delete;
62 GetPDR(GetPDR&&) = default;
63 GetPDR& operator=(const GetPDR&) = delete;
64 GetPDR& operator=(GetPDR&&) = default;
65
66 using CommandInterface::CommandInterface;
67
George Liud6649362019-11-27 19:06:51 +080068 explicit GetPDR(const char* type, const char* name, CLI::App* app) :
69 CommandInterface(type, name, app)
70 {
Shantappa Teekappanavar3ddbe432021-06-29 15:46:06 -050071 auto pdrOptionGroup = app->add_option_group(
72 "Required Option",
73 "Retrieve individual PDR, all PDRs, or PDRs of a requested type");
74 pdrOptionGroup->add_option(
75 "-d,--data", recordHandle,
76 "retrieve individual PDRs from a PDR Repository\n"
77 "eg: The recordHandle value for the PDR to be retrieved and 0 "
78 "means get first PDR in the repository.");
79 pdrRecType = "";
80 pdrOptionGroup->add_option("-t, --type", pdrRecType,
81 "retrieve all PDRs of the requested type\n"
82 "supported types:\n"
83 "[terminusLocator, stateSensor, "
84 "numericEffecter, stateEffecter, "
85 "EntityAssociation, fruRecord, ... ]");
86 allPDRs = false;
87 pdrOptionGroup->add_flag("-a, --all", allPDRs,
88 "retrieve all PDRs from a PDR repository");
89 pdrOptionGroup->require_option(1);
90 }
91
92 void exec() override
93 {
94 if (allPDRs || !pdrRecType.empty())
95 {
96 if (!pdrRecType.empty())
97 {
98 std::transform(pdrRecType.begin(), pdrRecType.end(),
99 pdrRecType.begin(), tolower);
100 }
101
Brad Bishop16eff862021-10-14 19:44:32 -0400102 // start the array
103 std::cout << "[\n";
104
Shantappa Teekappanavar3ddbe432021-06-29 15:46:06 -0500105 // Retrieve all PDR records starting from the first
106 recordHandle = 0;
107 uint32_t prevRecordHandle = 0;
Brad Bishop02d71142021-10-14 19:00:17 -0400108 std::map<uint32_t, uint32_t> recordsSeen;
Shantappa Teekappanavar3ddbe432021-06-29 15:46:06 -0500109 do
110 {
111 CommandInterface::exec();
112 // recordHandle is updated to nextRecord when
113 // CommandInterface::exec() is successful.
114 // In case of any error, return.
115 if (recordHandle == prevRecordHandle)
116 {
117 return;
118 }
Brad Bishop02d71142021-10-14 19:00:17 -0400119
120 // check for circular references.
121 auto result =
122 recordsSeen.emplace(recordHandle, prevRecordHandle);
123 if (!result.second)
124 {
125 std::cerr
126 << "Record handle " << recordHandle
127 << " has multiple references: " << result.first->second
128 << ", " << prevRecordHandle << "\n";
129 return;
130 }
Shantappa Teekappanavar3ddbe432021-06-29 15:46:06 -0500131 prevRecordHandle = recordHandle;
Brad Bishop16eff862021-10-14 19:44:32 -0400132
133 if (recordHandle != 0)
134 {
135 // close the array
136 std::cout << ",";
137 }
Shantappa Teekappanavar3ddbe432021-06-29 15:46:06 -0500138 } while (recordHandle != 0);
Brad Bishop16eff862021-10-14 19:44:32 -0400139
140 // close the array
141 std::cout << "]\n";
Shantappa Teekappanavar3ddbe432021-06-29 15:46:06 -0500142 }
143 else
144 {
145 CommandInterface::exec();
146 }
George Liud6649362019-11-27 19:06:51 +0800147 }
148
149 std::pair<int, std::vector<uint8_t>> createRequestMsg() override
150 {
151 std::vector<uint8_t> requestMsg(sizeof(pldm_msg_hdr) +
152 PLDM_GET_PDR_REQ_BYTES);
153 auto request = reinterpret_cast<pldm_msg*>(requestMsg.data());
154
Deepak Kodihallia59cdc62020-07-14 05:11:33 -0500155 auto rc =
156 encode_get_pdr_req(instanceId, recordHandle, 0, PLDM_GET_FIRSTPART,
157 UINT16_MAX, 0, request, PLDM_GET_PDR_REQ_BYTES);
George Liud6649362019-11-27 19:06:51 +0800158 return {rc, requestMsg};
159 }
160
161 void parseResponseMsg(pldm_msg* responsePtr, size_t payloadLength) override
162 {
163 uint8_t completionCode = 0;
Deepak Kodihallia59cdc62020-07-14 05:11:33 -0500164 uint8_t recordData[UINT16_MAX] = {0};
George Liud6649362019-11-27 19:06:51 +0800165 uint32_t nextRecordHndl = 0;
166 uint32_t nextDataTransferHndl = 0;
167 uint8_t transferFlag = 0;
168 uint16_t respCnt = 0;
169 uint8_t transferCRC = 0;
170
171 auto rc = decode_get_pdr_resp(
172 responsePtr, payloadLength, &completionCode, &nextRecordHndl,
173 &nextDataTransferHndl, &transferFlag, &respCnt, recordData,
174 sizeof(recordData), &transferCRC);
175
176 if (rc != PLDM_SUCCESS || completionCode != PLDM_SUCCESS)
177 {
178 std::cerr << "Response Message Error: "
179 << "rc=" << rc << ",cc=" << (int)completionCode
180 << std::endl;
181 return;
182 }
183
George Liu62d12ec2020-02-05 16:27:08 +0800184 printPDRMsg(nextRecordHndl, respCnt, recordData);
Shantappa Teekappanavar3ddbe432021-06-29 15:46:06 -0500185 recordHandle = nextRecordHndl;
George Liud6649362019-11-27 19:06:51 +0800186 }
187
188 private:
Tom Josepha65c0412020-07-03 21:14:44 +0530189 const std::map<pldm::pdr::EntityType, std::string> entityType = {
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530190 {PLDM_ENTITY_UNSPECIFIED, "Unspecified"},
191 {PLDM_ENTITY_OTHER, "Other"},
192 {PLDM_ENTITY_NETWORK, "Network"},
193 {PLDM_ENTITY_GROUP, "Group"},
194 {PLDM_ENTITY_REMOTE_MGMT_COMM_DEVICE,
195 "Remote Management Communication Device"},
196 {PLDM_ENTITY_EXTERNAL_ENVIRONMENT, "External Environment"},
197 {PLDM_ENTITY_COMM_CHANNEL, " Communication Channel"},
198 {PLDM_ENTITY_TERMINUS, "PLDM Terminus"},
199 {PLDM_ENTITY_PLATFORM_EVENT_LOG, " Platform Event Log"},
200 {PLDM_ENTITY_KEYPAD, "keypad"},
201 {PLDM_ENTITY_SWITCH, "Switch"},
202 {PLDM_ENTITY_PUSHBUTTON, "Pushbutton"},
203 {PLDM_ENTITY_DISPLAY, "Display"},
204 {PLDM_ENTITY_INDICATOR, "Indicator"},
205 {PLDM_ENTITY_SYS_MGMT_SW, "System Management Software"},
Tom Josepha65c0412020-07-03 21:14:44 +0530206 {PLDM_ENTITY_SYS_FIRMWARE, "System Firmware"},
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530207 {PLDM_ENTITY_OPERATING_SYS, "Operating System"},
Tom Josepha65c0412020-07-03 21:14:44 +0530208 {PLDM_ENTITY_VIRTUAL_MACHINE_MANAGER, "Virtual Machine Manager"},
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530209 {PLDM_ENTITY_OS_LOADER, "OS Loader"},
210 {PLDM_ENTITY_DEVICE_DRIVER, "Device Driver"},
211 {PLDM_ENTITY_MGMT_CONTROLLER_FW, "Management Controller Firmware"},
Tom Josepha65c0412020-07-03 21:14:44 +0530212 {PLDM_ENTITY_SYSTEM_CHASSIS, "System chassis (main enclosure)"},
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530213 {PLDM_ENTITY_SUB_CHASSIS, "Sub-chassis"},
214 {PLDM_ENTITY_DISK_DRIVE_BAY, "Disk Drive Bay"},
215 {PLDM_ENTITY_PERIPHERAL_BAY, "Peripheral Bay"},
216 {PLDM_ENTITY_DEVICE_BAY, "Device bay"},
217 {PLDM_ENTITY_DOOR, "Door"},
218 {PLDM_ENTITY_ACCESS_PANEL, "Access Panel"},
219 {PLDM_ENTITY_COVER, "Cover"},
220 {PLDM_ENTITY_BOARD, "Board"},
221 {PLDM_ENTITY_CARD, "Card"},
222 {PLDM_ENTITY_MODULE, "Module"},
223 {PLDM_ENTITY_SYS_MGMT_MODULE, "System management module"},
Tom Josepha65c0412020-07-03 21:14:44 +0530224 {PLDM_ENTITY_SYS_BOARD, "System Board"},
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530225 {PLDM_ENTITY_MEMORY_BOARD, "Memory Board"},
Tom Josepha65c0412020-07-03 21:14:44 +0530226 {PLDM_ENTITY_MEMORY_MODULE, "Memory Module"},
227 {PLDM_ENTITY_PROC_MODULE, "Processor Module"},
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530228 {PLDM_ENTITY_ADD_IN_CARD, "Add-in Card"},
Tom Josepha65c0412020-07-03 21:14:44 +0530229 {PLDM_ENTITY_CHASSIS_FRONT_PANEL_BOARD,
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530230 "Chassis front panel board(control panel)"},
231 {PLDM_ENTITY_BACK_PANEL_BOARD, "Back panel board"},
232 {PLDM_ENTITY_POWER_MGMT, "Power management board"},
233 {PLDM_ENTITY_POWER_SYS_BOARD, "Power system board"},
234 {PLDM_ENTITY_DRIVE_BACKPLANE, "Drive backplane"},
235 {PLDM_ENTITY_SYS_INTERNAL_EXPANSION_BOARD,
236 "System internal expansion board"},
237 {PLDM_ENTITY_OTHER_SYS_BOARD, "Other system board"},
238 {PLDM_ENTITY_CHASSIS_BACK_PANEL_BOARD, "Chassis back panel board"},
239 {PLDM_ENTITY_PROCESSING_BLADE, "Processing blade"},
240 {PLDM_ENTITY_CONNECTIVITY_SWITCH, "Connectivity switch"},
241 {PLDM_ENTITY_PROC_MEMORY_MODULE, "Processor/Memory Module"},
242 {PLDM_ENTITY_IO_MODULE, "I/O Module"},
243 {PLDM_ENTITY_PROC_IO_MODULE, "Processor I/O Module"},
244 {PLDM_ENTITY_COOLING_DEVICE, "Cooling device"},
245 {PLDM_ENTITY_COOLING_SUBSYSTEM, "Cooling subsystem"},
246 {PLDM_ENTITY_COOLING_UNIT, "Cooling Unit"},
Jayashankar Padath79175b42021-05-20 22:54:34 -0500247 {PLDM_ENTITY_FAN, "Fan"},
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530248 {PLDM_ENTITY_PELTIER_COOLING_DEVICE, "Peltier Cooling Device"},
249 {PLDM_ENTITY_LIQUID_COOLING_DEVICE, "Liquid Cooling Device"},
250 {PLDM_ENTITY_LIQUID_COOLING_SUBSYSTEM, "Liquid Colling Subsystem"},
251 {PLDM_ENTITY_OTHER_STORAGE_DEVICE, "Other Storage Device"},
252 {PLDM_ENTITY_FLOPPY_DRIVE, "Floppy Drive"},
253 {PLDM_ENTITY_FIXED_DISK_HARD_DRIVE, "Hard Drive"},
254 {PLDM_ENTITY_CD_DRIVE, "CD Drive"},
255 {PLDM_ENTITY_CD_DVD_DRIVE, "CD/DVD Drive"},
256 {PLDM_ENTITY_OTHER_SILICON_STORAGE_DEVICE,
257 "Other Silicon Storage Device"},
Jayashankar Padath79175b42021-05-20 22:54:34 -0500258 {PLDM_ENTITY_SOLID_STATE_SRIVE, "Solid State Drive"},
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530259 {PLDM_ENTITY_POWER_SUPPLY, "Power supply"},
260 {PLDM_ENTITY_BATTERY, "Battery"},
261 {PLDM_ENTITY_SUPER_CAPACITOR, "Super Capacitor"},
262 {PLDM_ENTITY_POWER_CONVERTER, "Power Converter"},
263 {PLDM_ENTITY_DC_DC_CONVERTER, "DC-DC Converter"},
264 {PLDM_ENTITY_AC_MAINS_POWER_SUPPLY, "AC mains power supply"},
265 {PLDM_ENTITY_DC_MAINS_POWER_SUPPLY, "DC mains power supply"},
266 {PLDM_ENTITY_PROC, "Processor"},
267 {PLDM_ENTITY_CHIPSET_COMPONENT, "Chipset Component"},
268 {PLDM_ENTITY_MGMT_CONTROLLER, "Management Controller"},
269 {PLDM_ENTITY_PERIPHERAL_CONTROLLER, "Peripheral Controller"},
270 {PLDM_ENTITY_SEEPROM, "SEEPROM"},
271 {PLDM_ENTITY_NVRAM_CHIP, "NVRAM Chip"},
272 {PLDM_ENTITY_FLASH_MEMORY_CHIP, "FLASH Memory chip"},
273 {PLDM_ENTITY_MEMORY_CHIP, "Memory Chip"},
274 {PLDM_ENTITY_MEMORY_CONTROLLER, "Memory Controller"},
275 {PLDM_ENTITY_NETWORK_CONTROLLER, "Network Controller"},
276 {PLDM_ENTITY_IO_CONTROLLER, "I/O Controller"},
277 {PLDM_ENTITY_SOUTH_BRIDGE, "South Bridge"},
Jayashankar Padath79175b42021-05-20 22:54:34 -0500278 {PLDM_ENTITY_REAL_TIME_CLOCK, "Real Time Clock (RTC)"},
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530279 {PLDM_ENTITY_FPGA_CPLD_DEVICE, "FPGA/CPLD Configurable Logic Device"},
280 {PLDM_ENTITY_OTHER_BUS, "Other Bus"},
281 {PLDM_ENTITY_SYS_BUS, "System Bus"},
282 {PLDM_ENTITY_I2C_BUS, "I2C Bus"},
283 {PLDM_ENTITY_SMBUS_BUS, "SMBus Bus"},
284 {PLDM_ENTITY_SPI_BUS, "SPI Bus"},
285 {PLDM_ENTITY_PCI_BUS, "PCI Bus"},
286 {PLDM_ENTITY_PCI_EXPRESS_BUS, "PCI Express Bus"},
287 {PLDM_ENTITY_PECI_BUS, "PECI Bus"},
288 {PLDM_ENTITY_LPC_BUS, "LPC Bus"},
289 {PLDM_ENTITY_USB_BUS, "USB Bus"},
290 {PLDM_ENTITY_FIREWIRE_BUS, "FireWire Bus"},
291 {PLDM_ENTITY_SCSI_BUS, "SCSI Bus"},
292 {PLDM_ENTITY_SATA_SAS_BUS, "SATA/SAS Bus"},
293 {PLDM_ENTITY_PROC_FRONT_SIDE_BUS, "Processor/Front-side Bus"},
294 {PLDM_ENTITY_INTER_PROC_BUS, "Inter-processor Bus"},
295 {PLDM_ENTITY_CONNECTOR, "Connector"},
Jayashankar Padath79175b42021-05-20 22:54:34 -0500296 {PLDM_ENTITY_SLOT, "Slot"},
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530297 {PLDM_ENTITY_CABLE, "Cable(electrical or optical)"},
298 {PLDM_ENTITY_INTERCONNECT, "Interconnect"},
299 {PLDM_ENTITY_PLUG, "Plug"},
300 {PLDM_ENTITY_SOCKET, "Socket"},
Sridevi Rameshdcdcd3b2021-06-15 04:06:49 -0500301 {PLDM_ENTITY_SYSTEM_LOGICAL, "System (Logical)"},
302 };
Deepak Kodihalli5544ccd2020-03-15 23:36:16 -0500303
Tom Josepha65c0412020-07-03 21:14:44 +0530304 const std::map<uint16_t, std::string> stateSet = {
305 {PLDM_STATE_SET_HEALTH_STATE, "Health State"},
306 {PLDM_STATE_SET_AVAILABILITY, "Availability"},
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530307 {PLDM_STATE_SET_PREDICTIVE_CONDITION, "Predictive Condition"},
308 {PLDM_STATE_SET_REDUNDANCY_STATUS, "Redundancy Status"},
309 {PLDM_STATE_SET_HEALTH_REDUNDANCY_TREND, "Health/Redundancy Trend"},
310 {PLDM_STATE_SET_GROUP_RESOURCE_LEVEL, "Group Resource Level"},
311 {PLDM_STATE_SET_REDUNDANCY_ENTITY_ROLE, "Redundancy Entity Role"},
Tom Josepha65c0412020-07-03 21:14:44 +0530312 {PLDM_STATE_SET_OPERATIONAL_STATUS, "Operational Status"},
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530313 {PLDM_STATE_SET_OPERATIONAL_STRESS_STATUS, "Operational Stress Status"},
314 {PLDM_STATE_SET_OPERATIONAL_FAULT_STATUS, "Operational Fault Status"},
Tom Josepha65c0412020-07-03 21:14:44 +0530315 {PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS,
316 "Operational Running Status"},
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530317 {PLDM_STATE_SET_OPERATIONAL_CONNECTION_STATUS,
318 "Operational Connection Status"},
Tom Josepha65c0412020-07-03 21:14:44 +0530319 {PLDM_STATE_SET_PRESENCE, "Presence"},
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530320 {PLDM_STATE_SET_PERFORMANCE, "Performance"},
Tom Josepha65c0412020-07-03 21:14:44 +0530321 {PLDM_STATE_SET_CONFIGURATION_STATE, "Configuration State"},
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530322 {PLDM_STATE_SET_CHANGED_CONFIGURATION, "Changed Configuration"},
323 {PLDM_STATE_SET_IDENTIFY_STATE, "Identify State"},
324 {PLDM_STATE_SET_VERSION, "Version"},
325 {PLDM_STATE_SET_ALARM_STATE, "Alarm State"},
326 {PLDM_STATE_SET_DEVICE_INITIALIZATION, "Device Initialization"},
327 {PLDM_STATE_SET_THERMAL_TRIP, "Thermal Trip"},
328 {PLDM_STATE_SET_HEARTBEAT, "Heartbeat"},
Tom Josepha65c0412020-07-03 21:14:44 +0530329 {PLDM_STATE_SET_LINK_STATE, "Link State"},
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530330 {PLDM_STATE_SET_SMOKE_STATE, "Smoke State"},
331 {PLDM_STATE_SET_HUMIDITY_STATE, "Humidity State"},
332 {PLDM_STATE_SET_DOOR_STATE, "Door State"},
333 {PLDM_STATE_SET_SWITCH_STATE, "Switch State"},
334 {PLDM_STATE_SET_LOCK_STATE, "Lock State"},
335 {PLDM_STATE_SET_PHYSICAL_SECURITY, "Physical Security"},
336 {PLDM_STATE_SET_DOCK_AUTHORIZATION, "Dock Authorization"},
337 {PLDM_STATE_SET_HW_SECURITY, "Hardware Security"},
338 {PLDM_STATE_SET_PHYSICAL_COMM_CONNECTION,
339 "Physical Communication Connection"},
340 {PLDM_STATE_SET_COMM_LEASH_STATUS, "Communication Leash Status"},
341 {PLDM_STATE_SET_FOREIGN_NW_DETECTION_STATUS,
342 "Foreign Network Detection Status"},
343 {PLDM_STATE_SET_PASSWORD_PROTECTED_ACCESS_SECURITY,
344 "Password-Protected Access Security"},
345 {PLDM_STATE_SET_SECURITY_ACCESS_PRIVILEGE_LEVEL,
346 "Security Access –PrivilegeLevel"},
347 {PLDM_STATE_SET_SESSION_AUDIT, "PLDM Session Audit"},
Tom Josepha65c0412020-07-03 21:14:44 +0530348 {PLDM_STATE_SET_SW_TERMINATION_STATUS, "Software Termination Status"},
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530349 {PLDM_STATE_SET_STORAGE_MEDIA_ACTIVITY, "Storage Media Activity"},
Tom Josepha65c0412020-07-03 21:14:44 +0530350 {PLDM_STATE_SET_BOOT_RESTART_CAUSE, "Boot/Restart Cause"},
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530351 {PLDM_STATE_SET_BOOT_RESTART_REQUEST, "Boot/Restart Request"},
352 {PLDM_STATE_SET_ENTITY_BOOT_STATUS, "Entity Boot Status"},
353 {PLDM_STATE_SET_BOOT_ERROR_STATUS, "Boot ErrorStatus"},
Tom Josepha65c0412020-07-03 21:14:44 +0530354 {PLDM_STATE_SET_BOOT_PROGRESS, "Boot Progress"},
Manojkiran Edaafbdb6d2021-05-27 17:19:51 +0530355 {PLDM_STATE_SET_SYS_FIRMWARE_HANG, "System Firmware Hang"},
356 {PLDM_STATE_SET_POST_ERRORS, "POST Errors"},
357 {PLDM_STATE_SET_LOG_FILL_STATUS, "Log Fill Status"},
358 {PLDM_STATE_SET_LOG_FILTER_STATUS, "Log Filter Status"},
359 {PLDM_STATE_SET_LOG_TIMESTAMP_CHANGE, "Log Timestamp Change"},
360 {PLDM_STATE_SET_INTERRUPT_REQUESTED, "Interrupt Requested"},
361 {PLDM_STATE_SET_INTERRUPT_RECEIVED, "Interrupt Received"},
362 {PLDM_STATE_SET_DIAGNOSTIC_INTERRUPT_REQUESTED,
363 "Diagnostic Interrupt Requested"},
364 {PLDM_STATE_SET_DIAGNOSTIC_INTERRUPT_RECEIVED,
365 "Diagnostic Interrupt Received"},
366 {PLDM_STATE_SET_IO_CHANNEL_CHECK_NMI_REQUESTED,
367 "I/O Channel Check NMI Requested"},
368 {PLDM_STATE_SET_IO_CHANNEL_CHECK_NMI_RECEIVED,
369 "I/O Channel Check NMI Received"},
370 {PLDM_STATE_SET_FATAL_NMI_REQUESTED, "Fatal NMI Requested"},
371 {PLDM_STATE_SET_FATAL_NMI_RECEIVED, "Fatal NMI Received"},
372 {PLDM_STATE_SET_SOFTWARE_NMI_REQUESTED, "Software NMI Requested"},
373 {PLDM_STATE_SET_SOFTWARE_NMI_RECEIVED, "Software NMI Received"},
374 {PLDM_STATE_SET_SMI_REQUESTED, "SMI Requested"},
375 {PLDM_STATE_SET_SMI_RECEIVED, "SMI Received"},
376 {PLDM_STATE_SET_PCI_PERR_REQUESTED, "PCI PERR Requested"},
377 {PLDM_STATE_SET_PCI_PERR_RECEIVED, "PCI PERR Received"},
378 {PLDM_STATE_SET_PCI_SERR_REQUESTED, "PCI SERR Requested "},
379 {PLDM_STATE_SET_PCI_SERR_RECEIVED, "PCI SERR Received"},
380 {PLDM_STATE_SET_BUS_ERROR_STATUS, "Bus Error Status"},
381 {PLDM_STATE_SET_WATCHDOG_STATUS, "Watchdog Status"},
382 {PLDM_STATE_SET_POWER_SUPPLY_STATE, "Power Supply State"},
383 {PLDM_STATE_SET_DEVICE_POWER_STATE, "Device Power State"},
384 {PLDM_STATE_SET_ACPI_POWER_STATE, "ACPI Power State"},
385 {PLDM_STATE_SET_BACKUP_POWER_SOURCE, "Backup Power Source"},
386 {PLDM_STATE_SET_SYSTEM_POWER_STATE, "System Power State "},
387 {PLDM_STATE_SET_BATTERY_ACTIVITY, "Battery Activity"},
388 {PLDM_STATE_SET_BATTERY_STATE, "Battery State"},
389 {PLDM_STATE_SET_PROC_POWER_STATE, "Processor Power State"},
390 {PLDM_STATE_SET_POWER_PERFORMANCE_STATE, "Power-Performance State"},
391 {PLDM_STATE_SET_PROC_ERROR_STATUS, "Processor Error Status"},
392 {PLDM_STATE_SET_BIST_FAILURE_STATUS, "BIST FailureStatus"},
393 {PLDM_STATE_SET_IBIST_FAILURE_STATUS, "IBIST FailureStatus"},
394 {PLDM_STATE_SET_PROC_HANG_IN_POST, "Processor Hang in POST"},
395 {PLDM_STATE_SET_PROC_STARTUP_FAILURE, "Processor Startup Failure"},
396 {PLDM_STATE_SET_UNCORRECTABLE_CPU_ERROR, "Uncorrectable CPU Error"},
397 {PLDM_STATE_SET_MACHINE_CHECK_ERROR, "Machine Check Error"},
398 {PLDM_STATE_SET_CORRECTED_MACHINE_CHECK, "Corrected Machine Check"},
399 {PLDM_STATE_SET_CACHE_STATUS, "Cache Status"},
400 {PLDM_STATE_SET_MEMORY_ERROR_STATUS, "Memory Error Status"},
401 {PLDM_STATE_SET_REDUNDANT_MEMORY_ACTIVITY_STATUS,
402 "Redundant Memory Activity Status"},
403 {PLDM_STATE_SET_ERROR_DETECTION_STATUS, "Error Detection Status"},
404 {PLDM_STATE_SET_STUCK_BIT_STATUS, "Stuck Bit Status"},
405 {PLDM_STATE_SET_SCRUB_STATUS, "Scrub Status"},
406 {PLDM_STATE_SET_SLOT_OCCUPANCY, "Slot Occupancy"},
Sridevi Rameshdcdcd3b2021-06-15 04:06:49 -0500407 {PLDM_STATE_SET_SLOT_STATE, "Slot State"},
408 };
Tom Josepha65c0412020-07-03 21:14:44 +0530409
410 const std::array<std::string_view, 4> sensorInit = {
411 "noInit", "useInitPDR", "enableSensor", "disableSensor"};
412
Tom Joseph97a7a762020-07-06 10:37:18 +0530413 const std::array<std::string_view, 4> effecterInit = {
414 "noInit", "useInitPDR", "enableEffecter", "disableEffecter"};
415
Sridevi Ramesha1bfb782020-07-14 02:51:23 -0500416 const std::map<uint8_t, std::string> pdrType = {
417 {PLDM_TERMINUS_LOCATOR_PDR, "Terminus Locator PDR"},
418 {PLDM_NUMERIC_SENSOR_PDR, "Numeric Sensor PDR"},
419 {PLDM_NUMERIC_SENSOR_INITIALIZATION_PDR,
420 "Numeric Sensor Initialization PDR"},
421 {PLDM_STATE_SENSOR_PDR, "State Sensor PDR"},
422 {PLDM_STATE_SENSOR_INITIALIZATION_PDR,
423 "State Sensor Initialization PDR"},
424 {PLDM_SENSOR_AUXILIARY_NAMES_PDR, "Sensor Auxiliary Names PDR"},
425 {PLDM_OEM_UNIT_PDR, "OEM Unit PDR"},
426 {PLDM_OEM_STATE_SET_PDR, "OEM State Set PDR"},
427 {PLDM_NUMERIC_EFFECTER_PDR, "Numeric Effecter PDR"},
428 {PLDM_NUMERIC_EFFECTER_INITIALIZATION_PDR,
429 "Numeric Effecter Initialization PDR"},
430 {PLDM_STATE_EFFECTER_PDR, "State Effecter PDR"},
431 {PLDM_STATE_EFFECTER_INITIALIZATION_PDR,
432 "State Effecter Initialization PDR"},
433 {PLDM_EFFECTER_AUXILIARY_NAMES_PDR, "Effecter Auxiliary Names PDR"},
434 {PLDM_EFFECTER_OEM_SEMANTIC_PDR, "Effecter OEM Semantic PDR"},
435 {PLDM_PDR_ENTITY_ASSOCIATION, "Entity Association PDR"},
436 {PLDM_ENTITY_AUXILIARY_NAMES_PDR, "Entity Auxiliary Names PDR"},
437 {PLDM_OEM_ENTITY_ID_PDR, "OEM Entity ID PDR"},
438 {PLDM_INTERRUPT_ASSOCIATION_PDR, "Interrupt Association PDR"},
439 {PLDM_EVENT_LOG_PDR, "PLDM Event Log PDR"},
440 {PLDM_PDR_FRU_RECORD_SET, "FRU Record Set PDR"},
441 {PLDM_OEM_DEVICE_PDR, "OEM Device PDR"},
442 {PLDM_OEM_PDR, "OEM PDR"},
443 };
444
Sridevi Rameshdcdcd3b2021-06-15 04:06:49 -0500445 static inline const std::map<uint8_t, std::string> setThermalTrip{
446 {PLDM_STATE_SET_THERMAL_TRIP_STATUS_NORMAL, "Normal"},
447 {PLDM_STATE_SET_THERMAL_TRIP_STATUS_THERMAL_TRIP, "Thermal Trip"}};
448
449 static inline const std::map<uint8_t, std::string> setIdentifyState{
450 {PLDM_STATE_SET_IDENTIFY_STATE_UNASSERTED, "Identify State Unasserted"},
451 {PLDM_STATE_SET_IDENTIFY_STATE_ASSERTED, "Identify State Asserted"}};
452
453 static inline const std::map<uint8_t, std::string> setBootProgressState{
454 {PLDM_STATE_SET_BOOT_PROG_STATE_NOT_ACTIVE, "Boot Not Active"},
455 {PLDM_STATE_SET_BOOT_PROG_STATE_COMPLETED, "Boot Completed"},
456 {PLDM_STATE_SET_BOOT_PROG_STATE_MEM_INITIALIZATION,
457 "Memory Initialization"},
458 {PLDM_STATE_SET_BOOT_PROG_STATE_SEC_PROC_INITIALIZATION,
459 "Secondary Processor(s) Initialization"},
460 {PLDM_STATE_SET_BOOT_PROG_STATE_PCI_RESORUCE_CONFIG,
461 "PCI Resource Configuration"},
462 {PLDM_STATE_SET_BOOT_PROG_STATE_STARTING_OP_SYS,
463 "Starting Operating System"},
464 {PLDM_STATE_SET_BOOT_PROG_STATE_BASE_BOARD_INITIALIZATION,
465 "Baseboard Initialization"},
466 {PLDM_STATE_SET_BOOT_PROG_STATE_PRIMARY_PROC_INITIALIZATION,
467 "Primary Processor Initialization"}};
468
469 static inline const std::map<uint8_t, std::string> setOpFaultStatus{
470 {PLDM_STATE_SET_OPERATIONAL_FAULT_STATUS_NORMAL, "Normal"},
471 {PLDM_STATE_SET_OPERATIONAL_FAULT_STATUS_STRESSED, "Stressed"}};
472
473 static inline const std::map<uint8_t, std::string> setSysPowerState{
474 {PLDM_STATE_SET_SYS_POWER_STATE_OFF_SOFT_GRACEFUL,
475 "Off-Soft Graceful"}};
476
477 static inline const std::map<uint8_t, std::string> setSWTerminationStatus{
478 {PLDM_SW_TERM_GRACEFUL_RESTART_REQUESTED,
479 "Graceful Restart Requested"}};
480
481 static inline const std::map<uint8_t, std::string> setAvailability{
482 {PLDM_STATE_SET_AVAILABILITY_REBOOTING, "Rebooting"}};
483
484 static inline const std::map<uint8_t, std::string> setHealthState{
485 {PLDM_STATE_SET_HEALTH_STATE_NORMAL, "Normal"},
Manojkiran Eda5de3de52022-01-03 12:12:53 +0530486 {PLDM_STATE_SET_HEALTH_STATE_NON_CRITICAL, "Non-Critical"},
487 {PLDM_STATE_SET_HEALTH_STATE_CRITICAL, "Critical"},
488 {PLDM_STATE_SET_HEALTH_STATE_FATAL, "Fatal"},
489 {PLDM_STATE_SET_HEALTH_STATE_UPPER_NON_CRITICAL, "Upper Non-Critical"},
490 {PLDM_STATE_SET_HEALTH_STATE_LOWER_NON_CRITICAL, "Lower Non-Critical"},
Sridevi Rameshdcdcd3b2021-06-15 04:06:49 -0500491 {PLDM_STATE_SET_HEALTH_STATE_UPPER_CRITICAL, "Upper Critical"},
Manojkiran Eda5de3de52022-01-03 12:12:53 +0530492 {PLDM_STATE_SET_HEALTH_STATE_LOWER_CRITICAL, "Lower Critical"},
493 {PLDM_STATE_SET_HEALTH_STATE_UPPER_FATAL, "Upper Fatal"},
494 {PLDM_STATE_SET_HEALTH_STATE_LOWER_FATAL, "Lower Fatal"}};
495
496 static inline const std::map<uint8_t, std::string>
497 setOperationalRunningState{
498 {PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_STARTING, "Starting"},
499 {PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_STOPPING, "Stopping"},
500 {PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_STOPPED, "Stopped"},
501 {PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_IN_SERVICE,
502 "In Service"},
503 {PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_ABORTED, "Aborted"},
504 {PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_DORMANT, "Dormant"}};
Sridevi Rameshdcdcd3b2021-06-15 04:06:49 -0500505
506 static inline const std::map<uint16_t, const std::map<uint8_t, std::string>>
507 populatePStateMaps{
508 {PLDM_STATE_SET_THERMAL_TRIP, setThermalTrip},
509 {PLDM_STATE_SET_IDENTIFY_STATE, setIdentifyState},
510 {PLDM_STATE_SET_BOOT_PROGRESS, setBootProgressState},
511 {PLDM_STATE_SET_OPERATIONAL_FAULT_STATUS, setOpFaultStatus},
512 {PLDM_STATE_SET_SYSTEM_POWER_STATE, setSysPowerState},
513 {PLDM_STATE_SET_SW_TERMINATION_STATUS, setSWTerminationStatus},
514 {PLDM_STATE_SET_AVAILABILITY, setAvailability},
515 {PLDM_STATE_SET_HEALTH_STATE, setHealthState},
Manojkiran Eda5de3de52022-01-03 12:12:53 +0530516 {PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS,
517 setOperationalRunningState},
Sridevi Rameshdcdcd3b2021-06-15 04:06:49 -0500518 };
519
Shantappa Teekappanavar3ddbe432021-06-29 15:46:06 -0500520 const std::map<std::string, uint8_t> strToPdrType = {
521 {"terminuslocator", PLDM_TERMINUS_LOCATOR_PDR},
522 {"statesensor", PLDM_STATE_SENSOR_PDR},
523 {"numericeffecter", PLDM_NUMERIC_EFFECTER_PDR},
524 {"stateeffecter", PLDM_STATE_EFFECTER_PDR},
525 {"entityassociation", PLDM_PDR_ENTITY_ASSOCIATION},
526 {"frurecord", PLDM_PDR_FRU_RECORD_SET},
527 // Add other types
528 };
529
Manojkiran Eda0c5d1ec2021-05-29 11:21:25 +0530530 bool isLogicalBitSet(const uint16_t entity_type)
531 {
532 return entity_type & 0x8000;
533 }
534
535 uint16_t getEntityTypeForLogicalEntity(const uint16_t logical_entity_type)
536 {
537 return logical_entity_type & 0x7FFF;
538 }
539
Tom Josepha65c0412020-07-03 21:14:44 +0530540 std::string getEntityName(pldm::pdr::EntityType type)
Deepak Kodihalli5544ccd2020-03-15 23:36:16 -0500541 {
Manojkiran Eda0c5d1ec2021-05-29 11:21:25 +0530542 uint16_t entityNumber = type;
543 std::string entityName = "[Physical] ";
544
545 if (isLogicalBitSet(type))
546 {
547 entityName = "[Logical] ";
548 entityNumber = getEntityTypeForLogicalEntity(type);
549 }
550
Deepak Kodihalli5544ccd2020-03-15 23:36:16 -0500551 try
552 {
Manojkiran Eda0c5d1ec2021-05-29 11:21:25 +0530553 return entityName + entityType.at(entityNumber);
Deepak Kodihalli5544ccd2020-03-15 23:36:16 -0500554 }
555 catch (const std::out_of_range& e)
556 {
Sridevi Rameshdcdcd3b2021-06-15 04:06:49 -0500557 auto OemString =
558 std::to_string(static_cast<unsigned>(entityNumber));
Manojkiran Eda0c5d1ec2021-05-29 11:21:25 +0530559 if (type >= PLDM_OEM_ENTITY_TYPE_START &&
560 type <= PLDM_OEM_ENTITY_TYPE_END)
561 {
Sridevi Rameshdcdcd3b2021-06-15 04:06:49 -0500562#ifdef OEM_IBM
563 if (OemIBMEntityType.contains(entityNumber))
564 {
565 return entityName + OemIBMEntityType.at(entityNumber) +
566 "(OEM)";
567 }
568#endif
569 return entityName + OemString + "(OEM)";
Manojkiran Eda0c5d1ec2021-05-29 11:21:25 +0530570 }
Sridevi Rameshdcdcd3b2021-06-15 04:06:49 -0500571 return OemString;
Deepak Kodihalli5544ccd2020-03-15 23:36:16 -0500572 }
573 }
574
Tom Josepha65c0412020-07-03 21:14:44 +0530575 std::string getStateSetName(uint16_t id)
576 {
Sridevi Ramesha1bfb782020-07-14 02:51:23 -0500577 auto typeString = std::to_string(id);
Tom Josepha65c0412020-07-03 21:14:44 +0530578 try
579 {
Sridevi Ramesha1bfb782020-07-14 02:51:23 -0500580 return stateSet.at(id) + "(" + typeString + ")";
Tom Josepha65c0412020-07-03 21:14:44 +0530581 }
582 catch (const std::out_of_range& e)
583 {
Sridevi Ramesha1bfb782020-07-14 02:51:23 -0500584 return typeString;
585 }
586 }
587
Sridevi Rameshdcdcd3b2021-06-15 04:06:49 -0500588 std::vector<std::string>
589 getStateSetPossibleStateNames(uint16_t stateId,
590 const std::vector<uint8_t>& value)
591 {
592 std::vector<std::string> data{};
593 std::map<uint8_t, std::string> stateNameMaps;
594
595 for (auto& s : value)
596 {
597 std::map<uint8_t, std::string> stateNameMaps;
598 auto pstr = std::to_string(s);
599
600#ifdef OEM_IBM
601 if (stateId >= PLDM_OEM_STATE_SET_START &&
602 stateId <= PLDM_OEM_STATE_SET_END)
603 {
604 if (populateOemIBMStateMaps.contains(stateId))
605 {
606 const std::map<uint8_t, std::string> stateNames =
607 populateOemIBMStateMaps.at(stateId);
608 stateNameMaps.insert(stateNames.begin(), stateNames.end());
609 }
610 }
611#endif
612 if (populatePStateMaps.contains(stateId))
613 {
614 const std::map<uint8_t, std::string> stateNames =
615 populatePStateMaps.at(stateId);
616 stateNameMaps.insert(stateNames.begin(), stateNames.end());
617 }
618 if (stateNameMaps.contains(s))
619 {
620 data.push_back(stateNameMaps.at(s) + "(" + pstr + ")");
621 }
622 else
623 {
624 data.push_back(pstr);
625 }
626 }
627 return data;
628 }
629
Sridevi Ramesha1bfb782020-07-14 02:51:23 -0500630 std::string getPDRType(uint8_t type)
631 {
632 auto typeString = std::to_string(type);
633 try
634 {
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500635 return pdrType.at(type);
Sridevi Ramesha1bfb782020-07-14 02:51:23 -0500636 }
637 catch (const std::out_of_range& e)
638 {
639 return typeString;
Tom Josepha65c0412020-07-03 21:14:44 +0530640 }
641 }
642
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500643 void printCommonPDRHeader(const pldm_pdr_hdr* hdr, ordered_json& output)
Tom Joseph952abfa2020-07-03 12:25:15 +0530644 {
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500645 output["recordHandle"] = hdr->record_handle;
646 output["PDRHeaderVersion"] = unsigned(hdr->version);
647 output["PDRType"] = getPDRType(hdr->type);
648 output["recordChangeNumber"] = hdr->record_change_num;
649 output["dataLength"] = hdr->length;
Tom Joseph952abfa2020-07-03 12:25:15 +0530650 }
651
Sridevi Rameshdcdcd3b2021-06-15 04:06:49 -0500652 std::vector<uint8_t> printPossibleStates(uint8_t possibleStatesSize,
653 const bitfield8_t* states)
Tom Josepha65c0412020-07-03 21:14:44 +0530654 {
655 uint8_t possibleStatesPos{};
Sridevi Rameshdcdcd3b2021-06-15 04:06:49 -0500656 std::vector<uint8_t> data{};
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500657 auto printStates = [&possibleStatesPos, &data](const bitfield8_t& val) {
658 std::stringstream pstates;
Tom Josepha65c0412020-07-03 21:14:44 +0530659 for (int i = 0; i < CHAR_BIT; i++)
660 {
661 if (val.byte & (1 << i))
662 {
Sridevi Rameshdcdcd3b2021-06-15 04:06:49 -0500663 pstates << (possibleStatesPos * CHAR_BIT + i);
664 data.push_back(
665 static_cast<uint8_t>(std::stoi(pstates.str())));
Sridevi Ramesh148ccab2020-11-23 08:23:09 -0600666 pstates.str("");
Tom Josepha65c0412020-07-03 21:14:44 +0530667 }
668 }
669 possibleStatesPos++;
670 };
671 std::for_each(states, states + possibleStatesSize, printStates);
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500672 return data;
Tom Josepha65c0412020-07-03 21:14:44 +0530673 }
674
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500675 void printStateSensorPDR(const uint8_t* data, ordered_json& output)
Tom Josepha65c0412020-07-03 21:14:44 +0530676 {
677 auto pdr = reinterpret_cast<const pldm_state_sensor_pdr*>(data);
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500678 output["PLDMTerminusHandle"] = pdr->terminus_handle;
679 output["sensorID"] = pdr->sensor_id;
680 output["entityType"] = getEntityName(pdr->entity_type);
681 output["entityInstanceNumber"] = pdr->entity_instance;
682 output["containerID"] = pdr->container_id;
683 output["sensorInit"] = sensorInit[pdr->sensor_init];
684 output["sensorAuxiliaryNamesPDR"] =
685 (pdr->sensor_auxiliary_names_pdr ? true : false);
686 output["compositeSensorCount"] = unsigned(pdr->composite_sensor_count);
Tom Josepha65c0412020-07-03 21:14:44 +0530687
688 auto statesPtr = pdr->possible_states;
Sridevi Ramesh148ccab2020-11-23 08:23:09 -0600689 auto compCount = pdr->composite_sensor_count;
Tom Josepha65c0412020-07-03 21:14:44 +0530690
Sridevi Ramesh148ccab2020-11-23 08:23:09 -0600691 while (compCount--)
Tom Josepha65c0412020-07-03 21:14:44 +0530692 {
693 auto state = reinterpret_cast<const state_sensor_possible_states*>(
694 statesPtr);
Sridevi Ramesh148ccab2020-11-23 08:23:09 -0600695 output.emplace(("stateSetID[" + std::to_string(compCount) + "]"),
696 getStateSetName(state->state_set_id));
697 output.emplace(
698 ("possibleStatesSize[" + std::to_string(compCount) + "]"),
699 state->possible_states_size);
700 output.emplace(
701 ("possibleStates[" + std::to_string(compCount) + "]"),
Sridevi Rameshdcdcd3b2021-06-15 04:06:49 -0500702 getStateSetPossibleStateNames(
703 state->state_set_id,
704 printPossibleStates(state->possible_states_size,
705 state->states)));
Tom Josepha65c0412020-07-03 21:14:44 +0530706
Sridevi Ramesh148ccab2020-11-23 08:23:09 -0600707 if (compCount)
Tom Josepha65c0412020-07-03 21:14:44 +0530708 {
709 statesPtr += sizeof(state_sensor_possible_states) +
710 state->possible_states_size - 1;
711 }
712 }
713 }
714
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500715 void printPDRFruRecordSet(uint8_t* data, ordered_json& output)
Deepak Kodihalli5544ccd2020-03-15 23:36:16 -0500716 {
George Liu62d12ec2020-02-05 16:27:08 +0800717 if (data == NULL)
Deepak Kodihalli5544ccd2020-03-15 23:36:16 -0500718 {
719 return;
720 }
721
722 data += sizeof(pldm_pdr_hdr);
723 pldm_pdr_fru_record_set* pdr =
724 reinterpret_cast<pldm_pdr_fru_record_set*>(data);
Manojkiran Edabcf91ac2021-03-14 13:50:48 +0530725 if (!pdr)
726 {
727 std::cerr << "Failed to get the FRU record set PDR" << std::endl;
728 return;
729 }
Deepak Kodihalli5544ccd2020-03-15 23:36:16 -0500730
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500731 output["PLDMTerminusHandle"] = unsigned(pdr->terminus_handle);
732 output["FRURecordSetIdentifier"] = unsigned(pdr->fru_rsi);
733 output["entityType"] = getEntityName(pdr->entity_type);
734 output["entityInstanceNumber"] = unsigned(pdr->entity_instance_num);
735 output["containerID"] = unsigned(pdr->container_id);
Deepak Kodihalli5544ccd2020-03-15 23:36:16 -0500736 }
737
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500738 void printPDREntityAssociation(uint8_t* data, ordered_json& output)
Deepak Kodihalli5544ccd2020-03-15 23:36:16 -0500739 {
740 const std::map<uint8_t, const char*> assocationType = {
741 {PLDM_ENTITY_ASSOCIAION_PHYSICAL, "Physical"},
742 {PLDM_ENTITY_ASSOCIAION_LOGICAL, "Logical"},
743 };
744
George Liu62d12ec2020-02-05 16:27:08 +0800745 if (data == NULL)
Deepak Kodihalli5544ccd2020-03-15 23:36:16 -0500746 {
747 return;
748 }
749
750 data += sizeof(pldm_pdr_hdr);
751 pldm_pdr_entity_association* pdr =
752 reinterpret_cast<pldm_pdr_entity_association*>(data);
Manojkiran Edabcf91ac2021-03-14 13:50:48 +0530753 if (!pdr)
754 {
755 std::cerr << "Failed to get the PDR eneity association"
756 << std::endl;
757 return;
758 }
Deepak Kodihalli5544ccd2020-03-15 23:36:16 -0500759
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500760 output["containerID"] = int(pdr->container_id);
George Liubd5e2ea2021-04-22 20:33:06 +0800761 if (assocationType.contains(pdr->association_type))
762 {
763 output["associationType"] =
764 assocationType.at(pdr->association_type);
765 }
766 else
767 {
768 std::cout << "Get associationType failed.\n";
769 }
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500770 output["containerEntityType"] =
771 getEntityName(pdr->container.entity_type);
772 output["containerEntityInstanceNumber"] =
773 int(pdr->container.entity_instance_num);
774 output["containerEntityContainerID"] =
775 int(pdr->container.entity_container_id);
776 output["containedEntityCount"] =
777 static_cast<unsigned>(pdr->num_children);
Deepak Kodihalli5544ccd2020-03-15 23:36:16 -0500778
779 auto child = reinterpret_cast<pldm_entity*>(&pdr->children[0]);
780 for (int i = 0; i < pdr->num_children; ++i)
781 {
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500782 output.emplace("containedEntityType[" + std::to_string(i + 1) + "]",
783 getEntityName(child->entity_type));
784 output.emplace("containedEntityInstanceNumber[" +
785 std::to_string(i + 1) + "]",
786 unsigned(child->entity_instance_num));
787 output.emplace("containedEntityContainerID[" +
788 std::to_string(i + 1) + "]",
789 unsigned(child->entity_container_id));
790
Deepak Kodihalli5544ccd2020-03-15 23:36:16 -0500791 ++child;
792 }
793 }
794
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500795 void printNumericEffecterPDR(uint8_t* data, ordered_json& output)
George Liu62d12ec2020-02-05 16:27:08 +0800796 {
797 struct pldm_numeric_effecter_value_pdr* pdr =
798 (struct pldm_numeric_effecter_value_pdr*)data;
Manojkiran Edabcf91ac2021-03-14 13:50:48 +0530799 if (!pdr)
800 {
801 std::cerr << "Failed to get numeric effecter PDR" << std::endl;
802 return;
803 }
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500804
805 output["PLDMTerminusHandle"] = int(pdr->terminus_handle);
806 output["effecterID"] = int(pdr->effecter_id);
807 output["entityType"] = int(pdr->entity_type);
808 output["entityInstanceNumber"] = int(pdr->entity_instance);
809 output["containerID"] = int(pdr->container_id);
810 output["effecterSemanticID"] = int(pdr->effecter_semantic_id);
811 output["effecterInit"] = unsigned(pdr->effecter_init);
812 output["effecterAuxiliaryNames"] =
813 (unsigned(pdr->effecter_auxiliary_names) ? true : false);
814 output["baseUnit"] = unsigned(pdr->base_unit);
815 output["unitModifier"] = unsigned(pdr->unit_modifier);
816 output["rateUnit"] = unsigned(pdr->rate_unit);
817 output["baseOEMUnitHandle"] = unsigned(pdr->base_oem_unit_handle);
818 output["auxUnit"] = unsigned(pdr->aux_unit);
819 output["auxUnitModifier"] = unsigned(pdr->aux_unit_modifier);
820 output["auxrateUnit"] = unsigned(pdr->aux_rate_unit);
821 output["auxOEMUnitHandle"] = unsigned(pdr->aux_oem_unit_handle);
822 output["isLinear"] = (unsigned(pdr->is_linear) ? true : false);
823 output["effecterDataSize"] = unsigned(pdr->effecter_data_size);
824 output["resolution"] = unsigned(pdr->resolution);
825 output["offset"] = unsigned(pdr->offset);
826 output["accuracy"] = unsigned(pdr->accuracy);
827 output["plusTolerance"] = unsigned(pdr->plus_tolerance);
828 output["minusTolerance"] = unsigned(pdr->minus_tolerance);
829 output["stateTransitionInterval"] =
830 unsigned(pdr->state_transition_interval);
831 output["TransitionInterval"] = unsigned(pdr->transition_interval);
832
George Liu62d12ec2020-02-05 16:27:08 +0800833 switch (pdr->effecter_data_size)
834 {
835 case PLDM_EFFECTER_DATA_SIZE_UINT8:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500836 output["maxSettable"] = unsigned(pdr->max_set_table.value_u8);
837 output["minSettable"] = unsigned(pdr->min_set_table.value_u8);
George Liu62d12ec2020-02-05 16:27:08 +0800838 break;
839 case PLDM_EFFECTER_DATA_SIZE_SINT8:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500840 output["maxSettable"] = unsigned(pdr->max_set_table.value_s8);
841 output["minSettable"] = unsigned(pdr->min_set_table.value_s8);
George Liu62d12ec2020-02-05 16:27:08 +0800842 break;
843 case PLDM_EFFECTER_DATA_SIZE_UINT16:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500844 output["maxSettable"] = unsigned(pdr->max_set_table.value_u16);
845 output["minSettable"] = unsigned(pdr->min_set_table.value_u16);
George Liu62d12ec2020-02-05 16:27:08 +0800846 break;
847 case PLDM_EFFECTER_DATA_SIZE_SINT16:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500848 output["maxSettable"] = unsigned(pdr->max_set_table.value_s16);
849 output["minSettable"] = unsigned(pdr->min_set_table.value_s16);
George Liu62d12ec2020-02-05 16:27:08 +0800850 break;
851 case PLDM_EFFECTER_DATA_SIZE_UINT32:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500852 output["maxSettable"] = unsigned(pdr->max_set_table.value_u32);
853 output["minSettable"] = unsigned(pdr->min_set_table.value_u32);
George Liu62d12ec2020-02-05 16:27:08 +0800854 break;
855 case PLDM_EFFECTER_DATA_SIZE_SINT32:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500856 output["maxSettable"] = unsigned(pdr->max_set_table.value_s32);
857 output["minSettable"] = unsigned(pdr->min_set_table.value_s32);
George Liu62d12ec2020-02-05 16:27:08 +0800858 break;
859 default:
860 break;
861 }
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500862
863 output["rangeFieldFormat"] = unsigned(pdr->range_field_format);
864 output["rangeFieldSupport"] = unsigned(pdr->range_field_support.byte);
865
George Liu62d12ec2020-02-05 16:27:08 +0800866 switch (pdr->range_field_format)
867 {
868 case PLDM_RANGE_FIELD_FORMAT_UINT8:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500869 output["nominalValue"] = unsigned(pdr->nominal_value.value_u8);
870 output["normalMax"] = unsigned(pdr->normal_max.value_u8);
871 output["normalMin"] = unsigned(pdr->normal_min.value_u8);
872 output["ratedMax"] = unsigned(pdr->rated_max.value_u8);
873 output["ratedMin"] = unsigned(pdr->rated_min.value_u8);
George Liu62d12ec2020-02-05 16:27:08 +0800874 break;
875 case PLDM_RANGE_FIELD_FORMAT_SINT8:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500876 output["nominalValue"] = unsigned(pdr->nominal_value.value_s8);
877 output["normalMax"] = unsigned(pdr->normal_max.value_s8);
878 output["normalMin"] = unsigned(pdr->normal_min.value_s8);
879 output["ratedMax"] = unsigned(pdr->rated_max.value_s8);
880 output["ratedMin"] = unsigned(pdr->rated_min.value_s8);
George Liu62d12ec2020-02-05 16:27:08 +0800881 break;
882 case PLDM_RANGE_FIELD_FORMAT_UINT16:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500883 output["nominalValue"] = unsigned(pdr->nominal_value.value_u16);
884 output["normalMax"] = unsigned(pdr->normal_max.value_u16);
885 output["normalMin"] = unsigned(pdr->normal_min.value_u16);
886 output["ratedMax"] = unsigned(pdr->rated_max.value_u16);
887 output["ratedMin"] = unsigned(pdr->rated_min.value_u16);
George Liu62d12ec2020-02-05 16:27:08 +0800888 break;
889 case PLDM_RANGE_FIELD_FORMAT_SINT16:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500890 output["nominalValue"] = unsigned(pdr->nominal_value.value_s16);
891 output["normalMax"] = unsigned(pdr->normal_max.value_s16);
892 output["normalMin"] = unsigned(pdr->normal_min.value_s16);
893 output["ratedMax"] = unsigned(pdr->rated_max.value_s16);
894 output["ratedMin"] = unsigned(pdr->rated_min.value_s16);
George Liu62d12ec2020-02-05 16:27:08 +0800895 break;
896 case PLDM_RANGE_FIELD_FORMAT_UINT32:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500897 output["nominalValue"] = unsigned(pdr->nominal_value.value_u32);
898 output["normalMax"] = unsigned(pdr->normal_max.value_u32);
899 output["normalMin"] = unsigned(pdr->normal_min.value_u32);
900 output["ratedMax"] = unsigned(pdr->rated_max.value_u32);
901 output["ratedMin"] = unsigned(pdr->rated_min.value_u32);
George Liu62d12ec2020-02-05 16:27:08 +0800902 break;
903 case PLDM_RANGE_FIELD_FORMAT_SINT32:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500904 output["nominalValue"] = unsigned(pdr->nominal_value.value_s32);
905 output["normalMax"] = unsigned(pdr->normal_max.value_s32);
906 output["normalMin"] = unsigned(pdr->normal_min.value_s32);
907 output["ratedMax"] = unsigned(pdr->rated_max.value_s32);
908 output["ratedMin"] = unsigned(pdr->rated_min.value_s32);
George Liu62d12ec2020-02-05 16:27:08 +0800909 break;
910 case PLDM_RANGE_FIELD_FORMAT_REAL32:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500911 output["nominalValue"] = unsigned(pdr->nominal_value.value_f32);
912 output["normalMax"] = unsigned(pdr->normal_max.value_f32);
913 output["normalMin"] = unsigned(pdr->normal_min.value_f32);
914 output["ratedMax"] = unsigned(pdr->rated_max.value_f32);
915 output["ratedMin"] = unsigned(pdr->rated_min.value_f32);
George Liu62d12ec2020-02-05 16:27:08 +0800916 break;
917 default:
918 break;
919 }
920 }
921
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500922 void printStateEffecterPDR(const uint8_t* data, ordered_json& output)
George Liu62d12ec2020-02-05 16:27:08 +0800923 {
Tom Joseph97a7a762020-07-06 10:37:18 +0530924 auto pdr = reinterpret_cast<const pldm_state_effecter_pdr*>(data);
George Liu62d12ec2020-02-05 16:27:08 +0800925
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500926 output["PLDMTerminusHandle"] = pdr->terminus_handle;
927 output["effecterID"] = pdr->effecter_id;
928 output["entityType"] = getEntityName(pdr->entity_type);
929 output["entityInstanceNumber"] = pdr->entity_instance;
930 output["containerID"] = pdr->container_id;
931 output["effecterSemanticID"] = pdr->effecter_semantic_id;
932 output["effecterInit"] = effecterInit[pdr->effecter_init];
933 output["effecterDescriptionPDR"] =
934 (pdr->has_description_pdr ? true : false);
935 output["compositeEffecterCount"] =
936 unsigned(pdr->composite_effecter_count);
George Liud6649362019-11-27 19:06:51 +0800937
Tom Joseph97a7a762020-07-06 10:37:18 +0530938 auto statesPtr = pdr->possible_states;
Sridevi Ramesh148ccab2020-11-23 08:23:09 -0600939 auto compEffCount = pdr->composite_effecter_count;
Tom Joseph97a7a762020-07-06 10:37:18 +0530940
Sridevi Ramesh148ccab2020-11-23 08:23:09 -0600941 while (compEffCount--)
George Liud6649362019-11-27 19:06:51 +0800942 {
Tom Joseph97a7a762020-07-06 10:37:18 +0530943 auto state =
944 reinterpret_cast<const state_effecter_possible_states*>(
945 statesPtr);
Sridevi Ramesh148ccab2020-11-23 08:23:09 -0600946 output.emplace(("stateSetID[" + std::to_string(compEffCount) + "]"),
947 getStateSetName(state->state_set_id));
948 output.emplace(
949 ("possibleStatesSize[" + std::to_string(compEffCount) + "]"),
950 state->possible_states_size);
951 output.emplace(
952 ("possibleStates[" + std::to_string(compEffCount) + "]"),
Sridevi Rameshdcdcd3b2021-06-15 04:06:49 -0500953 getStateSetPossibleStateNames(
954 state->state_set_id,
955 printPossibleStates(state->possible_states_size,
956 state->states)));
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500957
Sridevi Ramesh148ccab2020-11-23 08:23:09 -0600958 if (compEffCount)
Tom Joseph97a7a762020-07-06 10:37:18 +0530959 {
960 statesPtr += sizeof(state_effecter_possible_states) +
961 state->possible_states_size - 1;
962 }
George Liud6649362019-11-27 19:06:51 +0800963 }
964 }
965
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500966 void printTerminusLocatorPDR(const uint8_t* data, ordered_json& output)
Sampa Misra12afe112020-05-25 11:40:44 -0500967 {
968 const std::array<std::string_view, 4> terminusLocatorType = {
969 "UID", "MCTP_EID", "SMBusRelative", "systemSoftware"};
970
971 auto pdr = reinterpret_cast<const pldm_terminus_locator_pdr*>(data);
972
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500973 output["PLDMTerminusHandle"] = pdr->terminus_handle;
974 output["validity"] = (pdr->validity ? "valid" : "notValid");
975 output["TID"] = unsigned(pdr->tid);
976 output["containerID"] = pdr->container_id;
977 output["terminusLocatorType"] =
978 terminusLocatorType[pdr->terminus_locator_type];
979 output["terminusLocatorValueSize"] =
980 unsigned(pdr->terminus_locator_value_size);
Sampa Misra12afe112020-05-25 11:40:44 -0500981
982 if (pdr->terminus_locator_type == PLDM_TERMINUS_LOCATOR_TYPE_MCTP_EID)
983 {
984 auto locatorValue =
985 reinterpret_cast<const pldm_terminus_locator_type_mctp_eid*>(
986 pdr->terminus_locator_value);
Sridevi Ramesh27c512a2020-08-12 03:29:42 -0500987 output["EID"] = unsigned(locatorValue->eid);
Sampa Misra12afe112020-05-25 11:40:44 -0500988 }
989 }
990
Shantappa Teekappanavar3ddbe432021-06-29 15:46:06 -0500991 void printPDRMsg(uint32_t& nextRecordHndl, const uint16_t respCnt,
George Liu62d12ec2020-02-05 16:27:08 +0800992 uint8_t* data)
George Liud6649362019-11-27 19:06:51 +0800993 {
George Liu62d12ec2020-02-05 16:27:08 +0800994 if (data == NULL)
George Liud6649362019-11-27 19:06:51 +0800995 {
Manojkiran Edabcf91ac2021-03-14 13:50:48 +0530996 std::cerr << "Failed to get PDR message" << std::endl;
George Liud6649362019-11-27 19:06:51 +0800997 return;
998 }
999
Sridevi Ramesh27c512a2020-08-12 03:29:42 -05001000 ordered_json output;
1001 output["nextRecordHandle"] = nextRecordHndl;
1002 output["responseCount"] = respCnt;
George Liud6649362019-11-27 19:06:51 +08001003
1004 struct pldm_pdr_hdr* pdr = (struct pldm_pdr_hdr*)data;
Manojkiran Edabcf91ac2021-03-14 13:50:48 +05301005 if (!pdr)
1006 {
1007 return;
1008 }
Shantappa Teekappanavar3ddbe432021-06-29 15:46:06 -05001009
1010 if (!pdrRecType.empty())
1011 {
1012 // Need to return if the requested PDR type
1013 // is not supported
1014 if (!strToPdrType.contains(pdrRecType))
1015 {
1016 std::cerr << "PDR type '" << pdrRecType
1017 << "' is not supported or invalid\n";
1018 // PDR type not supported, setting next record handle to 0
1019 // to avoid looping through all PDR records
1020 nextRecordHndl = 0;
1021 return;
1022 }
1023
1024 // Do not print PDR record if the current record
1025 // PDR type does not match with requested type
1026 if (pdr->type != strToPdrType.at(pdrRecType))
1027 {
1028 return;
1029 }
1030 }
1031
Sridevi Ramesh27c512a2020-08-12 03:29:42 -05001032 printCommonPDRHeader(pdr, output);
1033
George Liud6649362019-11-27 19:06:51 +08001034 switch (pdr->type)
1035 {
Sampa Misra12afe112020-05-25 11:40:44 -05001036 case PLDM_TERMINUS_LOCATOR_PDR:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -05001037 printTerminusLocatorPDR(data, output);
Sampa Misra12afe112020-05-25 11:40:44 -05001038 break;
Tom Josepha65c0412020-07-03 21:14:44 +05301039 case PLDM_STATE_SENSOR_PDR:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -05001040 printStateSensorPDR(data, output);
Tom Josepha65c0412020-07-03 21:14:44 +05301041 break;
George Liu62d12ec2020-02-05 16:27:08 +08001042 case PLDM_NUMERIC_EFFECTER_PDR:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -05001043 printNumericEffecterPDR(data, output);
George Liu62d12ec2020-02-05 16:27:08 +08001044 break;
George Liud6649362019-11-27 19:06:51 +08001045 case PLDM_STATE_EFFECTER_PDR:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -05001046 printStateEffecterPDR(data, output);
George Liud6649362019-11-27 19:06:51 +08001047 break;
Deepak Kodihalli5544ccd2020-03-15 23:36:16 -05001048 case PLDM_PDR_ENTITY_ASSOCIATION:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -05001049 printPDREntityAssociation(data, output);
Deepak Kodihalli5544ccd2020-03-15 23:36:16 -05001050 break;
1051 case PLDM_PDR_FRU_RECORD_SET:
Sridevi Ramesh27c512a2020-08-12 03:29:42 -05001052 printPDRFruRecordSet(data, output);
Deepak Kodihalli5544ccd2020-03-15 23:36:16 -05001053 break;
George Liud6649362019-11-27 19:06:51 +08001054 default:
1055 break;
1056 }
Sridevi Ramesh27c512a2020-08-12 03:29:42 -05001057 pldmtool::helper::DisplayInJson(output);
George Liud6649362019-11-27 19:06:51 +08001058 }
1059
1060 private:
1061 uint32_t recordHandle;
Shantappa Teekappanavar3ddbe432021-06-29 15:46:06 -05001062 bool allPDRs;
1063 std::string pdrRecType;
George Liud6649362019-11-27 19:06:51 +08001064};
1065
1066class SetStateEffecter : public CommandInterface
1067{
1068 public:
1069 ~SetStateEffecter() = default;
1070 SetStateEffecter() = delete;
1071 SetStateEffecter(const SetStateEffecter&) = delete;
1072 SetStateEffecter(SetStateEffecter&&) = default;
1073 SetStateEffecter& operator=(const SetStateEffecter&) = delete;
1074 SetStateEffecter& operator=(SetStateEffecter&&) = default;
1075
George Liuba4c1fb2020-02-05 14:13:30 +08001076 // compositeEffecterCount(value: 0x01 to 0x08) * stateField(2)
1077 static constexpr auto maxEffecterDataSize = 16;
1078
1079 // compositeEffecterCount(value: 0x01 to 0x08)
1080 static constexpr auto minEffecterCount = 1;
1081 static constexpr auto maxEffecterCount = 8;
George Liud6649362019-11-27 19:06:51 +08001082 explicit SetStateEffecter(const char* type, const char* name,
1083 CLI::App* app) :
1084 CommandInterface(type, name, app)
1085 {
1086 app->add_option(
George Liuba4c1fb2020-02-05 14:13:30 +08001087 "-i, --id", effecterId,
1088 "A handle that is used to identify and access the effecter")
1089 ->required();
1090 app->add_option("-c, --count", effecterCount,
1091 "The number of individual sets of effecter information")
1092 ->required();
1093 app->add_option(
George Liud6649362019-11-27 19:06:51 +08001094 "-d,--data", effecterData,
George Liuba4c1fb2020-02-05 14:13:30 +08001095 "Set effecter state data\n"
1096 "eg: requestSet0 effecterState0 noChange1 dummyState1 ...")
1097 ->required();
George Liud6649362019-11-27 19:06:51 +08001098 }
1099
1100 std::pair<int, std::vector<uint8_t>> createRequestMsg() override
1101 {
1102 std::vector<uint8_t> requestMsg(
1103 sizeof(pldm_msg_hdr) + PLDM_SET_STATE_EFFECTER_STATES_REQ_BYTES);
1104 auto request = reinterpret_cast<pldm_msg*>(requestMsg.data());
1105
George Liuba4c1fb2020-02-05 14:13:30 +08001106 if (effecterCount > maxEffecterCount ||
1107 effecterCount < minEffecterCount)
George Liud6649362019-11-27 19:06:51 +08001108 {
George Liuba4c1fb2020-02-05 14:13:30 +08001109 std::cerr << "Request Message Error: effecterCount size "
1110 << effecterCount << "is invalid\n";
George Liud6649362019-11-27 19:06:51 +08001111 auto rc = PLDM_ERROR_INVALID_DATA;
1112 return {rc, requestMsg};
1113 }
1114
George Liuba4c1fb2020-02-05 14:13:30 +08001115 if (effecterData.size() > maxEffecterDataSize)
George Liud6649362019-11-27 19:06:51 +08001116 {
George Liuba4c1fb2020-02-05 14:13:30 +08001117 std::cerr << "Request Message Error: effecterData size "
1118 << effecterData.size() << "is invalid\n";
1119 auto rc = PLDM_ERROR_INVALID_DATA;
1120 return {rc, requestMsg};
1121 }
1122
1123 auto stateField = parseEffecterData(effecterData, effecterCount);
1124 if (!stateField)
1125 {
1126 std::cerr << "Failed to parse effecter data, effecterCount size "
1127 << effecterCount << "\n";
George Liud6649362019-11-27 19:06:51 +08001128 auto rc = PLDM_ERROR_INVALID_DATA;
1129 return {rc, requestMsg};
1130 }
1131
1132 auto rc = encode_set_state_effecter_states_req(
Pavithra Barithayaac3c45a2020-03-05 02:28:26 -06001133 instanceId, effecterId, effecterCount, stateField->data(), request);
George Liud6649362019-11-27 19:06:51 +08001134 return {rc, requestMsg};
1135 }
1136
1137 void parseResponseMsg(pldm_msg* responsePtr, size_t payloadLength) override
1138 {
1139 uint8_t completionCode = 0;
1140 auto rc = decode_set_state_effecter_states_resp(
1141 responsePtr, payloadLength, &completionCode);
1142
1143 if (rc != PLDM_SUCCESS || completionCode != PLDM_SUCCESS)
1144 {
1145 std::cerr << "Response Message Error: "
George Liuba4c1fb2020-02-05 14:13:30 +08001146 << "rc=" << rc << ",cc=" << (int)completionCode << "\n";
George Liud6649362019-11-27 19:06:51 +08001147 return;
1148 }
1149
Sridevi Ramesh27c512a2020-08-12 03:29:42 -05001150 ordered_json data;
1151 data["Response"] = "SUCCESS";
1152 pldmtool::helper::DisplayInJson(data);
George Liud6649362019-11-27 19:06:51 +08001153 }
1154
1155 private:
George Liuba4c1fb2020-02-05 14:13:30 +08001156 uint16_t effecterId;
1157 uint8_t effecterCount;
George Liud6649362019-11-27 19:06:51 +08001158 std::vector<uint8_t> effecterData;
1159};
1160
George Liucc9c20d2020-02-05 10:24:11 +08001161class SetNumericEffecterValue : public CommandInterface
1162{
1163 public:
1164 ~SetNumericEffecterValue() = default;
1165 SetNumericEffecterValue() = delete;
1166 SetNumericEffecterValue(const SetNumericEffecterValue&) = delete;
1167 SetNumericEffecterValue(SetNumericEffecterValue&&) = default;
1168 SetNumericEffecterValue& operator=(const SetNumericEffecterValue&) = delete;
1169 SetNumericEffecterValue& operator=(SetNumericEffecterValue&&) = default;
1170
1171 explicit SetNumericEffecterValue(const char* type, const char* name,
1172 CLI::App* app) :
1173 CommandInterface(type, name, app)
1174 {
1175 app->add_option(
1176 "-i, --id", effecterId,
1177 "A handle that is used to identify and access the effecter")
1178 ->required();
1179 app->add_option("-s, --size", effecterDataSize,
1180 "The bit width and format of the setting value for the "
1181 "effecter. enum value: {uint8, sint8, uint16, sint16, "
1182 "uint32, sint32}\n")
1183 ->required();
1184 app->add_option("-d,--data", maxEffecterValue,
1185 "The setting value of numeric effecter being "
1186 "requested\n")
1187 ->required();
1188 }
1189
1190 std::pair<int, std::vector<uint8_t>> createRequestMsg() override
1191 {
1192 std::vector<uint8_t> requestMsg(
1193 sizeof(pldm_msg_hdr) +
1194 PLDM_SET_NUMERIC_EFFECTER_VALUE_MIN_REQ_BYTES + 3);
1195
1196 uint8_t* effecterValue = (uint8_t*)&maxEffecterValue;
1197
1198 auto request = reinterpret_cast<pldm_msg*>(requestMsg.data());
1199 size_t payload_length = PLDM_SET_NUMERIC_EFFECTER_VALUE_MIN_REQ_BYTES;
1200
1201 if (effecterDataSize == PLDM_EFFECTER_DATA_SIZE_UINT16 ||
1202 effecterDataSize == PLDM_EFFECTER_DATA_SIZE_SINT16)
1203 {
1204 payload_length = PLDM_SET_NUMERIC_EFFECTER_VALUE_MIN_REQ_BYTES + 1;
1205 }
1206 if (effecterDataSize == PLDM_EFFECTER_DATA_SIZE_UINT32 ||
1207 effecterDataSize == PLDM_EFFECTER_DATA_SIZE_SINT32)
1208 {
1209 payload_length = PLDM_SET_NUMERIC_EFFECTER_VALUE_MIN_REQ_BYTES + 3;
1210 }
1211 auto rc = encode_set_numeric_effecter_value_req(
1212 0, effecterId, effecterDataSize, effecterValue, request,
1213 payload_length);
1214
1215 return {rc, requestMsg};
1216 }
1217
1218 void parseResponseMsg(pldm_msg* responsePtr, size_t payloadLength) override
1219 {
1220 uint8_t completionCode = 0;
1221 auto rc = decode_set_numeric_effecter_value_resp(
1222 responsePtr, payloadLength, &completionCode);
1223
1224 if (rc != PLDM_SUCCESS || completionCode != PLDM_SUCCESS)
1225 {
1226 std::cerr << "Response Message Error: "
1227 << "rc=" << rc << ",cc=" << (int)completionCode
1228 << std::endl;
1229 return;
1230 }
1231
Sridevi Ramesh27c512a2020-08-12 03:29:42 -05001232 ordered_json data;
1233 data["Response"] = "SUCCESS";
1234 pldmtool::helper::DisplayInJson(data);
George Liucc9c20d2020-02-05 10:24:11 +08001235 }
1236
1237 private:
1238 uint16_t effecterId;
1239 uint8_t effecterDataSize;
1240 uint64_t maxEffecterValue;
1241};
1242
Sridevi Rameshf31b5042021-01-22 05:42:07 -06001243class GetStateSensorReadings : public CommandInterface
1244{
1245 public:
1246 ~GetStateSensorReadings() = default;
1247 GetStateSensorReadings() = delete;
1248 GetStateSensorReadings(const GetStateSensorReadings&) = delete;
1249 GetStateSensorReadings(GetStateSensorReadings&&) = default;
1250 GetStateSensorReadings& operator=(const GetStateSensorReadings&) = delete;
1251 GetStateSensorReadings& operator=(GetStateSensorReadings&&) = default;
1252
1253 explicit GetStateSensorReadings(const char* type, const char* name,
1254 CLI::App* app) :
1255 CommandInterface(type, name, app)
1256 {
1257 app->add_option(
1258 "-i, --sensor_id", sensorId,
1259 "Sensor ID that is used to identify and access the sensor")
1260 ->required();
1261 app->add_option("-r, --rearm", sensorRearm,
1262 "Each bit location in this field corresponds to a "
1263 "particular sensor")
1264 ->required();
1265 }
1266
1267 std::pair<int, std::vector<uint8_t>> createRequestMsg() override
1268 {
1269 std::vector<uint8_t> requestMsg(
1270 sizeof(pldm_msg_hdr) + PLDM_GET_STATE_SENSOR_READINGS_REQ_BYTES);
1271 auto request = reinterpret_cast<pldm_msg*>(requestMsg.data());
1272
1273 uint8_t reserved = 0;
1274 bitfield8_t bf;
1275 bf.byte = sensorRearm;
1276 auto rc = encode_get_state_sensor_readings_req(instanceId, sensorId, bf,
1277 reserved, request);
1278
1279 return {rc, requestMsg};
1280 }
1281
1282 void parseResponseMsg(pldm_msg* responsePtr, size_t payloadLength) override
1283 {
1284 uint8_t completionCode = 0;
1285 uint8_t compSensorCount = 0;
1286 std::array<get_sensor_state_field, 8> stateField{};
1287 auto rc = decode_get_state_sensor_readings_resp(
1288 responsePtr, payloadLength, &completionCode, &compSensorCount,
1289 stateField.data());
1290
1291 if (rc != PLDM_SUCCESS || completionCode != PLDM_SUCCESS)
1292 {
1293 std::cerr << "Response Message Error: "
1294 << "rc=" << rc << ",cc=" << (int)completionCode
1295 << std::endl;
1296 return;
1297 }
1298 ordered_json output;
1299 output["compositeSensorCount"] = (int)compSensorCount;
1300
1301 for (size_t i = 0; i < compSensorCount; i++)
1302 {
George Liubd5e2ea2021-04-22 20:33:06 +08001303 if (sensorOpState.contains(stateField[i].sensor_op_state))
1304 {
1305 output.emplace(("sensorOpState[" + std::to_string(i) + "]"),
1306 sensorOpState.at(stateField[i].sensor_op_state));
1307 }
Sridevi Rameshf31b5042021-01-22 05:42:07 -06001308
George Liubd5e2ea2021-04-22 20:33:06 +08001309 if (sensorPresState.contains(stateField[i].present_state))
1310 {
1311 output.emplace(("presentState[" + std::to_string(i) + "]"),
1312 sensorPresState.at(stateField[i].present_state));
1313 }
1314
1315 if (sensorPresState.contains(stateField[i].previous_state))
1316 {
1317 output.emplace(
1318 ("previousState[" + std::to_string(i) + "]"),
1319 sensorPresState.at(stateField[i].previous_state));
1320 }
1321
1322 if (sensorPresState.contains(stateField[i].event_state))
1323 {
1324 output.emplace(("eventState[" + std::to_string(i) + "]"),
1325 sensorPresState.at(stateField[i].event_state));
1326 }
Sridevi Rameshf31b5042021-01-22 05:42:07 -06001327 }
1328
1329 pldmtool::helper::DisplayInJson(output);
1330 }
1331
1332 private:
1333 uint16_t sensorId;
1334 uint8_t sensorRearm;
1335};
1336
George Liud6649362019-11-27 19:06:51 +08001337void registerCommand(CLI::App& app)
1338{
1339 auto platform = app.add_subcommand("platform", "platform type command");
1340 platform->require_subcommand(1);
1341
1342 auto getPDR =
1343 platform->add_subcommand("GetPDR", "get platform descriptor records");
1344 commands.push_back(std::make_unique<GetPDR>("platform", "getPDR", getPDR));
1345
1346 auto setStateEffecterStates = platform->add_subcommand(
1347 "SetStateEffecterStates", "set effecter states");
1348 commands.push_back(std::make_unique<SetStateEffecter>(
1349 "platform", "setStateEffecterStates", setStateEffecterStates));
George Liucc9c20d2020-02-05 10:24:11 +08001350
1351 auto setNumericEffecterValue = platform->add_subcommand(
1352 "SetNumericEffecterValue", "set the value for a PLDM Numeric Effecter");
1353 commands.push_back(std::make_unique<SetNumericEffecterValue>(
1354 "platform", "setNumericEffecterValue", setNumericEffecterValue));
Sridevi Rameshf31b5042021-01-22 05:42:07 -06001355
1356 auto getStateSensorReadings = platform->add_subcommand(
1357 "GetStateSensorReadings", "get the state sensor readings");
1358 commands.push_back(std::make_unique<GetStateSensorReadings>(
1359 "platform", "getStateSensorReadings", getStateSensorReadings));
George Liud6649362019-11-27 19:06:51 +08001360}
1361
1362} // namespace platform
1363} // namespace pldmtool