blob: a59bb66d02e18b2b3e35250158d4c3b1505e682b [file] [log] [blame]
Lakshminarayana R. Kammath27693a42019-06-24 00:51:47 -05001#pragma once
2
Dung Cao3d03f3f2023-09-07 06:51:33 +00003#include "common/instance_id.hpp"
Deepak Kodihallid130e1a2020-06-17 05:55:32 -05004#include "common/utils.hpp"
Lakshminarayana R. Kammath27693a42019-06-24 00:51:47 -05005
6#include <err.h>
George Liuc453e162022-12-21 17:16:23 +08007#include <libpldm/base.h>
8#include <libpldm/bios.h>
9#include <libpldm/fru.h>
10#include <libpldm/platform.h>
Lakshminarayana R. Kammath27693a42019-06-24 00:51:47 -050011#include <sys/socket.h>
12#include <sys/un.h>
13#include <unistd.h>
14
John Wang58a0e062019-11-08 15:38:15 +080015#include <CLI/CLI.hpp>
Sridevi Rameshca4a8152020-08-11 09:26:19 -050016#include <nlohmann/json.hpp>
George Liu6492f522020-06-16 10:34:05 +080017
Lakshminarayana R. Kammath27693a42019-06-24 00:51:47 -050018#include <cstring>
19#include <iomanip>
20#include <iostream>
John Wang58a0e062019-11-08 15:38:15 +080021#include <utility>
Lakshminarayana R. Kammath27693a42019-06-24 00:51:47 -050022
John Wang58a0e062019-11-08 15:38:15 +080023namespace pldmtool
24{
25
26namespace helper
27{
28
John Wang58a0e062019-11-08 15:38:15 +080029constexpr uint8_t PLDM_ENTITY_ID = 8;
Sridevi Rameshca4a8152020-08-11 09:26:19 -050030using ordered_json = nlohmann::ordered_json;
Lakshminarayana R. Kammath27693a42019-06-24 00:51:47 -050031
Sridevi Rameshc91822b2020-02-27 09:26:41 -060032/** @brief print the input message if pldmverbose is enabled
33 *
34 * @param[in] pldmVerbose - verbosity flag - true/false
35 * @param[in] msg - message to print
36 * @param[in] data - data to print
37 *
38 * @return - None
39 */
40
41template <class T>
42void Logger(bool pldmverbose, const char* msg, const T& data)
43{
44 if (pldmverbose)
45 {
46 std::stringstream s;
47 s << data;
48 std::cout << msg << s.str() << std::endl;
49 }
50}
Sridevi Rameshca4a8152020-08-11 09:26:19 -050051
52/** @brief Display in JSON format.
53 *
54 * @param[in] data - data to print in json
55 *
56 * @return - None
57 */
58static inline void DisplayInJson(const ordered_json& data)
59{
60 std::cout << data.dump(4) << std::endl;
61}
62
Manojkiran Eda2576aec2024-06-17 12:05:17 +053063/** @brief MCTP socket read/receive
Lakshminarayana R. Kammath27693a42019-06-24 00:51:47 -050064 *
65 * @param[in] requestMsg - Request message to compare against loopback
Manojkiran Eda2576aec2024-06-17 12:05:17 +053066 * message received from mctp socket
67 * @param[out] responseMsg - Response buffer received from mctp socket
Sridevi Rameshc91822b2020-02-27 09:26:41 -060068 * @param[in] pldmVerbose - verbosity flag - true/false
Lakshminarayana R. Kammath27693a42019-06-24 00:51:47 -050069 *
70 * @return - 0 on success.
71 * -1 or -errno on failure.
72 */
73int mctpSockSendRecv(const std::vector<uint8_t>& requestMsg,
Sridevi Rameshc91822b2020-02-27 09:26:41 -060074 std::vector<uint8_t>& responseMsg, bool pldmVerbose);
Lakshminarayana R. Kammath27693a42019-06-24 00:51:47 -050075
John Wang58a0e062019-11-08 15:38:15 +080076class CommandInterface
77{
78 public:
79 explicit CommandInterface(const char* type, const char* name,
80 CLI::App* app) :
81 pldmType(type),
Deepak Kodihallid6638b72020-07-02 08:36:14 -050082 commandName(name), mctp_eid(PLDM_ENTITY_ID), pldmVerbose(false),
83 instanceId(0)
John Wang58a0e062019-11-08 15:38:15 +080084 {
Pavithra Barithayaf5ad6c72019-12-06 15:10:52 +080085 app->add_option("-m,--mctp_eid", mctp_eid, "MCTP endpoint ID");
Sridevi Rameshc91822b2020-02-27 09:26:41 -060086 app->add_flag("-v, --verbose", pldmVerbose);
Thu Nguyen94270892023-10-25 17:11:44 +070087 app->add_option("-n, --retry-count", numRetries,
88 "Number of retry when PLDM request message is failed");
John Wang58a0e062019-11-08 15:38:15 +080089 app->callback([&]() { exec(); });
90 }
Sridevi Rameshc91822b2020-02-27 09:26:41 -060091
John Wang58a0e062019-11-08 15:38:15 +080092 virtual ~CommandInterface() = default;
93
94 virtual std::pair<int, std::vector<uint8_t>> createRequestMsg() = 0;
95
96 virtual void parseResponseMsg(struct pldm_msg* responsePtr,
97 size_t payloadLength) = 0;
98
John Wangb754eee2020-02-15 16:10:25 +080099 virtual void exec();
100
101 int pldmSendRecv(std::vector<uint8_t>& requestMsg,
102 std::vector<uint8_t>& responseMsg);
John Wang58a0e062019-11-08 15:38:15 +0800103
Chinmay Shripad Hegde526461a2023-01-11 13:04:02 +0530104 /**
105 * @brief get MCTP endpoint ID
106 *
107 * @return uint8_t - MCTP endpoint ID
108 */
109 inline uint8_t getMCTPEID()
110 {
111 return mctp_eid;
112 }
113
Pavithra Barithayaa340eed2023-02-14 03:32:47 -0600114 /**
115 * @brief get PLDM type
116 *
117 * @return pldm type
118 */
119 inline std::string getPLDMType()
120 {
121 return pldmType;
122 }
123
124 /**
125 * @brief get command name
126 *
127 * @return the command name
128 */
129 inline std::string getCommandName()
130 {
131 return commandName;
132 }
133
John Wang58a0e062019-11-08 15:38:15 +0800134 private:
135 const std::string pldmType;
136 const std::string commandName;
Pavithra Barithayaf5ad6c72019-12-06 15:10:52 +0800137 uint8_t mctp_eid;
Sridevi Rameshc91822b2020-02-27 09:26:41 -0600138 bool pldmVerbose;
Pavithra Barithayaac3c45a2020-03-05 02:28:26 -0600139
140 protected:
141 uint8_t instanceId;
Dung Cao3d03f3f2023-09-07 06:51:33 +0000142 pldm::InstanceIdDb instanceIdDb;
Thu Nguyen94270892023-10-25 17:11:44 +0700143 uint8_t numRetries = 0;
John Wang58a0e062019-11-08 15:38:15 +0800144};
145
146} // namespace helper
147} // namespace pldmtool