blob: ef2a1a5e887774339f510bd53dc475f8a75d4b73 [file] [log] [blame]
Lakshminarayana R. Kammath27693a42019-06-24 00:51:47 -05001#include "pldm_base_cmd.hpp"
2
George Liu6492f522020-06-16 10:34:05 +08003#include "pldm_cmd_helper.hpp"
4
George Liuc453e162022-12-21 17:16:23 +08005#include <libpldm/utils.h>
6
Sridevi Ramesh45e52542020-04-03 07:54:18 -05007#ifdef OEM_IBM
George Liuc453e162022-12-21 17:16:23 +08008#include <libpldm/file_io.h>
9#include <libpldm/host.h>
Sridevi Ramesh45e52542020-04-03 07:54:18 -050010#endif
11
Sridevi Rameshca4a8152020-08-11 09:26:19 -050012#include <string>
13
John Wang58a0e062019-11-08 15:38:15 +080014namespace pldmtool
Lakshminarayana R. Kammath27693a42019-06-24 00:51:47 -050015{
Lakshminarayana R. Kammath27693a42019-06-24 00:51:47 -050016
John Wang58a0e062019-11-08 15:38:15 +080017namespace base
Lakshminarayana R. Kammath27693a42019-06-24 00:51:47 -050018{
Lakshminarayana R. Kammath58229b22019-08-09 06:30:04 -050019
John Wang58a0e062019-11-08 15:38:15 +080020namespace
Lakshminarayana R. Kammath58229b22019-08-09 06:30:04 -050021{
John Wang58a0e062019-11-08 15:38:15 +080022
23using namespace pldmtool::helper;
24
25std::vector<std::unique_ptr<CommandInterface>> commands;
26const std::map<const char*, pldm_supported_types> pldmTypes{
Sridevi Ramesh45e52542020-04-03 07:54:18 -050027 {"base", PLDM_BASE}, {"platform", PLDM_PLATFORM},
28 {"bios", PLDM_BIOS}, {"fru", PLDM_FRU},
29#ifdef OEM_IBM
30 {"oem-ibm", PLDM_OEM},
31#endif
John Wang58a0e062019-11-08 15:38:15 +080032};
33
Sridevi Ramesh66294d32020-02-21 03:52:07 -060034const std::map<const char*, pldm_supported_commands> pldmBaseCmds{
35 {"GetTID", PLDM_GET_TID},
36 {"GetPLDMVersion", PLDM_GET_PLDM_VERSION},
37 {"GetPLDMTypes", PLDM_GET_PLDM_TYPES},
38 {"GetPLDMCommands", PLDM_GET_PLDM_COMMANDS}};
39
40const std::map<const char*, pldm_bios_commands> pldmBiosCmds{
41 {"GetBIOSTable", PLDM_GET_BIOS_TABLE},
Sridevi Ramesh8fb11c92021-06-08 08:45:01 -050042 {"SetBIOSTable", PLDM_SET_BIOS_TABLE},
Sridevi Ramesh66294d32020-02-21 03:52:07 -060043 {"SetBIOSAttributeCurrentValue", PLDM_SET_BIOS_ATTRIBUTE_CURRENT_VALUE},
44 {"GetBIOSAttributeCurrentValueByHandle",
45 PLDM_GET_BIOS_ATTRIBUTE_CURRENT_VALUE_BY_HANDLE},
46 {"GetDateTime", PLDM_GET_DATE_TIME},
47 {"SetDateTime", PLDM_SET_DATE_TIME}};
48
49const std::map<const char*, pldm_platform_commands> pldmPlatformCmds{
50 {"SetNumericEffecterValue", PLDM_SET_NUMERIC_EFFECTER_VALUE},
51 {"SetStateEffecterStates", PLDM_SET_STATE_EFFECTER_STATES},
Sridevi Ramesh8fb11c92021-06-08 08:45:01 -050052 {"GetPDR", PLDM_GET_PDR},
53 {"GetNumericEffecterValue", PLDM_GET_NUMERIC_EFFECTER_VALUE},
54 {"SetEventReceiver", PLDM_SET_EVENT_RECEIVER},
55 {"GetSensorReading", PLDM_GET_SENSOR_READING},
56 {"GetStateSensorReadings", PLDM_GET_STATE_SENSOR_READINGS},
57 {"PlatformEventMessage", PLDM_PLATFORM_EVENT_MESSAGE}};
Sridevi Ramesh66294d32020-02-21 03:52:07 -060058
59const std::map<const char*, pldm_fru_commands> pldmFruCmds{
60 {"GetFRURecordTableMetadata", PLDM_GET_FRU_RECORD_TABLE_METADATA},
John Wang5bdde3a2020-06-16 15:02:33 +080061 {"GetFRURecordTable", PLDM_GET_FRU_RECORD_TABLE},
62 {"GetFRURecordByOption", PLDM_GET_FRU_RECORD_BY_OPTION}};
Sridevi Ramesh66294d32020-02-21 03:52:07 -060063
Sridevi Ramesh45e52542020-04-03 07:54:18 -050064#ifdef OEM_IBM
65const std::map<const char*, pldm_host_commands> pldmIBMHostCmds{
66 {"GetAlertStatus", PLDM_HOST_GET_ALERT_STATUS}};
67
68const std::map<const char*, pldm_fileio_commands> pldmIBMFileIOCmds{
69 {"GetFileTable", PLDM_GET_FILE_TABLE},
70 {"ReadFile", PLDM_READ_FILE},
71 {"WriteFile", PLDM_WRITE_FILE},
72 {"ReadFileInToMemory", PLDM_READ_FILE_INTO_MEMORY},
73 {"WriteFileFromMemory", PLDM_WRITE_FILE_FROM_MEMORY},
74 {"ReadFileByTypeIntoMemory", PLDM_READ_FILE_BY_TYPE_INTO_MEMORY},
75 {"WriteFileByTypeFromMemory", PLDM_WRITE_FILE_BY_TYPE_FROM_MEMORY},
76 {"NewFileAvailable", PLDM_NEW_FILE_AVAILABLE},
77 {"ReadFileByType", PLDM_READ_FILE_BY_TYPE},
78 {"WriteFileByType", PLDM_WRITE_FILE_BY_TYPE},
79 {"FileAck", PLDM_FILE_ACK}};
80#endif
81
John Wang58a0e062019-11-08 15:38:15 +080082} // namespace
83
84class GetPLDMTypes : public CommandInterface
85{
86 public:
87 ~GetPLDMTypes() = default;
88 GetPLDMTypes() = delete;
89 GetPLDMTypes(const GetPLDMTypes&) = delete;
90 GetPLDMTypes(GetPLDMTypes&&) = default;
91 GetPLDMTypes& operator=(const GetPLDMTypes&) = delete;
92 GetPLDMTypes& operator=(GetPLDMTypes&&) = default;
93
94 using CommandInterface::CommandInterface;
95
96 std::pair<int, std::vector<uint8_t>> createRequestMsg() override
Lakshminarayana R. Kammath58229b22019-08-09 06:30:04 -050097 {
John Wang58a0e062019-11-08 15:38:15 +080098 std::vector<uint8_t> requestMsg(sizeof(pldm_msg_hdr));
99 auto request = reinterpret_cast<pldm_msg*>(requestMsg.data());
Pavithra Barithayaac3c45a2020-03-05 02:28:26 -0600100 auto rc = encode_get_types_req(instanceId, request);
John Wang58a0e062019-11-08 15:38:15 +0800101 return {rc, requestMsg};
Lakshminarayana R. Kammath58229b22019-08-09 06:30:04 -0500102 }
103
John Wang58a0e062019-11-08 15:38:15 +0800104 void parseResponseMsg(pldm_msg* responsePtr, size_t payloadLength) override
Lakshminarayana R. Kammath58229b22019-08-09 06:30:04 -0500105 {
John Wang58a0e062019-11-08 15:38:15 +0800106 uint8_t cc = 0;
107 std::vector<bitfield8_t> types(8);
108 auto rc = decode_get_types_resp(responsePtr, payloadLength, &cc,
109 types.data());
110 if (rc != PLDM_SUCCESS || cc != PLDM_SUCCESS)
111 {
112 std::cerr << "Response Message Error: "
Sampa Misraaa8ae722019-12-12 03:20:40 -0600113 << "rc=" << rc << ",cc=" << (int)cc << "\n";
Lakshminarayana R. Kammath58229b22019-08-09 06:30:04 -0500114 return;
John Wang58a0e062019-11-08 15:38:15 +0800115 }
116
117 printPldmTypes(types);
Lakshminarayana R. Kammath58229b22019-08-09 06:30:04 -0500118 }
119
John Wang58a0e062019-11-08 15:38:15 +0800120 private:
121 void printPldmTypes(std::vector<bitfield8_t>& types)
Lakshminarayana R. Kammath58229b22019-08-09 06:30:04 -0500122 {
Sridevi Rameshca4a8152020-08-11 09:26:19 -0500123 ordered_json data;
124 ordered_json jarray;
John Wang58a0e062019-11-08 15:38:15 +0800125 for (int i = 0; i < PLDM_MAX_TYPES; i++)
126 {
127 bitfield8_t b = types[i / 8];
128 if (b.byte & (1 << i % 8))
129 {
Patrick Williams6da4f912023-05-10 07:50:53 -0500130 auto it = std::find_if(pldmTypes.begin(), pldmTypes.end(),
131 [i](const auto& typePair) {
132 return typePair.second == i;
133 });
John Wang58a0e062019-11-08 15:38:15 +0800134 if (it != pldmTypes.end())
135 {
Sridevi Rameshca4a8152020-08-11 09:26:19 -0500136 jarray["PLDM Type"] = it->first;
137 jarray["PLDM Type Code"] = i;
138 data.emplace_back(jarray);
John Wang58a0e062019-11-08 15:38:15 +0800139 }
140 }
141 }
Sridevi Rameshca4a8152020-08-11 09:26:19 -0500142 pldmtool::helper::DisplayInJson(data);
Lakshminarayana R. Kammath58229b22019-08-09 06:30:04 -0500143 }
John Wang58a0e062019-11-08 15:38:15 +0800144};
145
146class GetPLDMVersion : public CommandInterface
147{
148 public:
149 ~GetPLDMVersion() = default;
150 GetPLDMVersion() = delete;
151 GetPLDMVersion(const GetPLDMVersion&) = delete;
152 GetPLDMVersion(GetPLDMVersion&&) = default;
153 GetPLDMVersion& operator=(const GetPLDMVersion&) = delete;
154 GetPLDMVersion& operator=(GetPLDMVersion&&) = default;
155
156 explicit GetPLDMVersion(const char* type, const char* name, CLI::App* app) :
157 CommandInterface(type, name, app)
Lakshminarayana R. Kammath58229b22019-08-09 06:30:04 -0500158 {
John Wang58a0e062019-11-08 15:38:15 +0800159 app->add_option("-t,--type", pldmType, "pldm supported type")
160 ->required()
161 ->transform(CLI::CheckedTransformer(pldmTypes, CLI::ignore_case));
Lakshminarayana R. Kammath58229b22019-08-09 06:30:04 -0500162 }
John Wang58a0e062019-11-08 15:38:15 +0800163 std::pair<int, std::vector<uint8_t>> createRequestMsg() override
164 {
165 std::vector<uint8_t> requestMsg(sizeof(pldm_msg_hdr) +
166 PLDM_GET_VERSION_REQ_BYTES);
167 auto request = reinterpret_cast<pldm_msg*>(requestMsg.data());
168
Pavithra Barithayaac3c45a2020-03-05 02:28:26 -0600169 auto rc = encode_get_version_req(instanceId, 0, PLDM_GET_FIRSTPART,
170 pldmType, request);
John Wang58a0e062019-11-08 15:38:15 +0800171 return {rc, requestMsg};
172 }
173
174 void parseResponseMsg(pldm_msg* responsePtr, size_t payloadLength) override
175 {
176 uint8_t cc = 0, transferFlag = 0;
177 uint32_t transferHandle = 0;
178 ver32_t version;
Patrick Williams6da4f912023-05-10 07:50:53 -0500179 auto rc = decode_get_version_resp(responsePtr, payloadLength, &cc,
180 &transferHandle, &transferFlag,
181 &version);
John Wang58a0e062019-11-08 15:38:15 +0800182 if (rc != PLDM_SUCCESS || cc != PLDM_SUCCESS)
183 {
184 std::cerr << "Response Message Error: "
Sampa Misraaa8ae722019-12-12 03:20:40 -0600185 << "rc=" << rc << ",cc=" << (int)cc << "\n";
John Wang58a0e062019-11-08 15:38:15 +0800186 return;
187 }
188 char buffer[16] = {0};
189 ver2str(&version, buffer, sizeof(buffer));
Sridevi Rameshca4a8152020-08-11 09:26:19 -0500190 ordered_json data;
Patrick Williams6da4f912023-05-10 07:50:53 -0500191 auto it = std::find_if(pldmTypes.begin(), pldmTypes.end(),
192 [&](const auto& typePair) {
193 return typePair.second == pldmType;
194 });
John Wang58a0e062019-11-08 15:38:15 +0800195
196 if (it != pldmTypes.end())
197 {
Sridevi Rameshca4a8152020-08-11 09:26:19 -0500198 data["Response"] = buffer;
John Wang58a0e062019-11-08 15:38:15 +0800199 }
Sridevi Rameshca4a8152020-08-11 09:26:19 -0500200 pldmtool::helper::DisplayInJson(data);
John Wang58a0e062019-11-08 15:38:15 +0800201 }
202
203 private:
204 pldm_supported_types pldmType;
205};
206
Sridevi Rameshadd56f02020-01-20 23:44:22 -0600207class GetTID : public CommandInterface
208{
209 public:
210 ~GetTID() = default;
211 GetTID() = delete;
212 GetTID(const GetTID&) = delete;
213 GetTID(GetTID&&) = default;
214 GetTID& operator=(const GetTID&) = delete;
215 GetTID& operator=(GetTID&&) = default;
216
217 using CommandInterface::CommandInterface;
218
219 std::pair<int, std::vector<uint8_t>> createRequestMsg() override
220 {
221 std::vector<uint8_t> requestMsg(sizeof(pldm_msg_hdr));
222 auto request = reinterpret_cast<pldm_msg*>(requestMsg.data());
Pavithra Barithayaac3c45a2020-03-05 02:28:26 -0600223 auto rc = encode_get_tid_req(instanceId, request);
Sridevi Rameshadd56f02020-01-20 23:44:22 -0600224 return {rc, requestMsg};
225 }
226
227 void parseResponseMsg(pldm_msg* responsePtr, size_t payloadLength) override
228 {
229 uint8_t cc = 0;
230 uint8_t tid = 0;
231 std::vector<bitfield8_t> types(8);
232 auto rc = decode_get_tid_resp(responsePtr, payloadLength, &cc, &tid);
233 if (rc != PLDM_SUCCESS || cc != PLDM_SUCCESS)
234 {
235 std::cerr << "Response Message Error: "
236 << "rc=" << rc << ",cc=" << (int)cc << "\n";
237 return;
238 }
Sridevi Rameshca4a8152020-08-11 09:26:19 -0500239 ordered_json data;
240 data["Response"] = static_cast<uint32_t>(tid);
241 pldmtool::helper::DisplayInJson(data);
Sridevi Rameshadd56f02020-01-20 23:44:22 -0600242 }
243};
244
Sridevi Ramesh66294d32020-02-21 03:52:07 -0600245class GetPLDMCommands : public CommandInterface
246{
247 public:
248 ~GetPLDMCommands() = default;
249 GetPLDMCommands() = delete;
250 GetPLDMCommands(const GetPLDMCommands&) = delete;
251 GetPLDMCommands(GetPLDMCommands&&) = default;
252 GetPLDMCommands& operator=(const GetPLDMCommands&) = delete;
253 GetPLDMCommands& operator=(GetPLDMCommands&&) = default;
254
255 explicit GetPLDMCommands(const char* type, const char* name,
256 CLI::App* app) :
257 CommandInterface(type, name, app)
258 {
259 app->add_option("-t,--type", pldmType, "pldm supported type")
260 ->required()
261 ->transform(CLI::CheckedTransformer(pldmTypes, CLI::ignore_case));
262 }
263
264 std::pair<int, std::vector<uint8_t>> createRequestMsg() override
265 {
266 std::vector<uint8_t> requestMsg(sizeof(pldm_msg_hdr) +
267 PLDM_GET_COMMANDS_REQ_BYTES);
268 auto request = reinterpret_cast<pldm_msg*>(requestMsg.data());
269 ver32_t version{0xFF, 0xFF, 0xFF, 0xFF};
Patrick Williams6da4f912023-05-10 07:50:53 -0500270 auto rc = encode_get_commands_req(instanceId, pldmType, version,
271 request);
Sridevi Ramesh66294d32020-02-21 03:52:07 -0600272 return {rc, requestMsg};
273 }
274
275 void parseResponseMsg(pldm_msg* responsePtr, size_t payloadLength) override
276 {
277 uint8_t cc = 0;
278 std::vector<bitfield8_t> cmdTypes(32);
279 auto rc = decode_get_commands_resp(responsePtr, payloadLength, &cc,
280 cmdTypes.data());
281 if (rc != PLDM_SUCCESS || cc != PLDM_SUCCESS)
282 {
283 std::cerr << "Response Message Error: "
284 << "rc=" << rc << ",cc=" << (int)cc << "\n";
285 return;
286 }
287 printPldmCommands(cmdTypes, pldmType);
288 }
289
290 private:
291 pldm_supported_types pldmType;
292
293 template <typename CommandMap>
Sridevi Rameshca4a8152020-08-11 09:26:19 -0500294 void printCommand(CommandMap& commandMap, int i, ordered_json& jarray)
Sridevi Ramesh66294d32020-02-21 03:52:07 -0600295 {
Patrick Williams6da4f912023-05-10 07:50:53 -0500296 auto it = std::find_if(commandMap.begin(), commandMap.end(),
297 [i](const auto& typePair) {
298 return typePair.second == i;
299 });
Sridevi Ramesh66294d32020-02-21 03:52:07 -0600300 if (it != commandMap.end())
301 {
Sridevi Rameshca4a8152020-08-11 09:26:19 -0500302 jarray["PLDM Command Code"] = i;
303 jarray["PLDM Command"] = it->first;
Sridevi Ramesh66294d32020-02-21 03:52:07 -0600304 }
305 }
306
307 void printPldmCommands(std::vector<bitfield8_t>& cmdTypes,
308 pldm_supported_types pldmType)
309 {
Sridevi Rameshca4a8152020-08-11 09:26:19 -0500310 ordered_json output;
Sridevi Ramesh66294d32020-02-21 03:52:07 -0600311 for (int i = 0; i < PLDM_MAX_CMDS_PER_TYPE; i++)
312 {
Sridevi Rameshca4a8152020-08-11 09:26:19 -0500313 ordered_json cmdinfo;
Sridevi Ramesh66294d32020-02-21 03:52:07 -0600314 bitfield8_t b = cmdTypes[i / 8];
315 if (b.byte & (1 << i % 8))
316 {
Sridevi Ramesh66294d32020-02-21 03:52:07 -0600317 switch (pldmType)
318 {
319 case PLDM_BASE:
Sridevi Rameshca4a8152020-08-11 09:26:19 -0500320 printCommand(pldmBaseCmds, i, cmdinfo);
Sridevi Ramesh66294d32020-02-21 03:52:07 -0600321 break;
322 case PLDM_PLATFORM:
Sridevi Rameshca4a8152020-08-11 09:26:19 -0500323 printCommand(pldmPlatformCmds, i, cmdinfo);
Sridevi Ramesh66294d32020-02-21 03:52:07 -0600324 break;
325 case PLDM_BIOS:
Sridevi Rameshca4a8152020-08-11 09:26:19 -0500326 printCommand(pldmBiosCmds, i, cmdinfo);
Sridevi Ramesh66294d32020-02-21 03:52:07 -0600327 break;
328 case PLDM_FRU:
Sridevi Rameshca4a8152020-08-11 09:26:19 -0500329 printCommand(pldmFruCmds, i, cmdinfo);
Sridevi Ramesh66294d32020-02-21 03:52:07 -0600330 break;
Sridevi Ramesh45e52542020-04-03 07:54:18 -0500331 case PLDM_OEM:
Pavithra Barithaya6f4e9042020-04-20 23:33:46 -0500332#ifdef OEM_IBM
Sridevi Rameshca4a8152020-08-11 09:26:19 -0500333 printCommand(pldmIBMHostCmds, i, cmdinfo);
334 printCommand(pldmIBMFileIOCmds, i, cmdinfo);
Pavithra Barithaya6f4e9042020-04-20 23:33:46 -0500335#endif
Sridevi Ramesh45e52542020-04-03 07:54:18 -0500336 break;
Sridevi Ramesh66294d32020-02-21 03:52:07 -0600337 default:
338 break;
339 }
Sridevi Rameshca4a8152020-08-11 09:26:19 -0500340 output.emplace_back(cmdinfo);
Sridevi Ramesh66294d32020-02-21 03:52:07 -0600341 }
342 }
Sridevi Rameshca4a8152020-08-11 09:26:19 -0500343 pldmtool::helper::DisplayInJson(output);
Sridevi Ramesh66294d32020-02-21 03:52:07 -0600344 }
345};
346
John Wang58a0e062019-11-08 15:38:15 +0800347void registerCommand(CLI::App& app)
348{
349 auto base = app.add_subcommand("base", "base type command");
350 base->require_subcommand(1);
Sridevi Rameshadd56f02020-01-20 23:44:22 -0600351
Patrick Williams6da4f912023-05-10 07:50:53 -0500352 auto getPLDMTypes = base->add_subcommand("GetPLDMTypes",
353 "get pldm supported types");
John Wang58a0e062019-11-08 15:38:15 +0800354 commands.push_back(
355 std::make_unique<GetPLDMTypes>("base", "GetPLDMTypes", getPLDMTypes));
356
Patrick Williams6da4f912023-05-10 07:50:53 -0500357 auto getPLDMVersion = base->add_subcommand("GetPLDMVersion",
358 "get version of a certain type");
John Wang58a0e062019-11-08 15:38:15 +0800359 commands.push_back(std::make_unique<GetPLDMVersion>(
360 "base", "GetPLDMVersion", getPLDMVersion));
Sridevi Rameshadd56f02020-01-20 23:44:22 -0600361
362 auto getPLDMTID = base->add_subcommand("GetTID", "get Terminus ID (TID)");
363 commands.push_back(std::make_unique<GetTID>("base", "GetTID", getPLDMTID));
Sridevi Ramesh66294d32020-02-21 03:52:07 -0600364
365 auto getPLDMCommands = base->add_subcommand(
366 "GetPLDMCommands", "get supported commands of pldm type");
367 commands.push_back(std::make_unique<GetPLDMCommands>(
368 "base", "GetPLDMCommands", getPLDMCommands));
Lakshminarayana R. Kammath58229b22019-08-09 06:30:04 -0500369}
John Wang58a0e062019-11-08 15:38:15 +0800370
371} // namespace base
372} // namespace pldmtool