Add encode/decode for EventMessageBufferSize
Added encode API for EventMessageBufferSize command(0x0D) which
is defined in DSP02408 Version 1.2.1 sec:16.9.
Signed-off-by: Dung Cao <dung@os.amperecomputing.com>
Change-Id: Id3f00706b3d3a1871aa6491cc0ffe2ee42597258
diff --git a/include/libpldm/platform.h b/include/libpldm/platform.h
index 8ef0f76..f0eea51 100644
--- a/include/libpldm/platform.h
+++ b/include/libpldm/platform.h
@@ -26,6 +26,11 @@
#define PLDM_GET_PDR_REQ_BYTES 13
#define PLDM_SET_EVENT_RECEIVER_RESP_BYTES 1
+
+/* Platform event supported request */
+#define PLDM_EVENT_MESSAGE_BUFFER_SIZE_REQ_BYTES 2
+#define PLDM_EVENT_MESSAGE_BUFFER_SIZE_RESP_BYTES 3
+
/* Minimum response length */
#define PLDM_GET_PDR_MIN_RESP_BYTES 12
#define PLDM_GET_NUMERIC_EFFECTER_VALUE_MIN_RESP_BYTES 5
@@ -115,6 +120,8 @@
enum pldm_platform_commands {
PLDM_SET_EVENT_RECEIVER = 0x04,
+ PLDM_PLATFORM_EVENT_MESSAGE = 0x0A,
+ PLDM_EVENT_MESSAGE_BUFFER_SIZE = 0xD,
PLDM_GET_SENSOR_READING = 0x11,
PLDM_GET_STATE_SENSOR_READINGS = 0x21,
PLDM_SET_NUMERIC_EFFECTER_VALUE = 0x31,
@@ -122,7 +129,6 @@
PLDM_SET_STATE_EFFECTER_STATES = 0x39,
PLDM_GET_PDR_REPOSITORY_INFO = 0x50,
PLDM_GET_PDR = 0x51,
- PLDM_PLATFORM_EVENT_MESSAGE = 0x0A
};
/** @brief PLDM PDR types
@@ -747,6 +753,23 @@
uint16_t heartbeat_timer;
} __attribute__((packed));
+/** @struct pldm_event_message_buffer_size_req
+ *
+ * Structure representing EventMessageBufferSizes command request data
+ */
+struct pldm_event_message_buffer_size_req {
+ uint16_t event_receiver_max_buffer_size;
+} __attribute__((packed));
+
+/** @struct pldm_event_message_buffer_size_resp
+ *
+ * Structure representing EventMessageBufferSizes command response data
+ */
+struct pldm_event_message_buffer_size_resp {
+ uint8_t completion_code;
+ uint16_t terminus_max_buffer_size;
+} __attribute__((packed));
+
/** @struct pldm_set_numeric_effecter_value_req
*
* structure representing SetNumericEffecterValue request packet
@@ -1418,6 +1441,29 @@
uint8_t *completion_code,
uint8_t *platform_event_status);
+/** @brief Decode EventMessageBufferSize response data
+ * @param[in] msg - Request message
+ * @param[in] payload_length - Length of Response message payload
+ * @param[out] completion_code - PLDM completion code
+ * @return pldm_completion_codes
+ */
+int decode_event_message_buffer_size_resp(const struct pldm_msg *msg,
+ size_t payload_length,
+ uint8_t *completion_code,
+ uint16_t *terminus_max_buffer_size);
+
+/** @brief Encode EventMessageBufferSize request data
+ * @param[in] instance_id - Message's instance id
+ * @param[in] event_receiver_max_buffer_size - Max buffer size
+ * @param[out] msg - Request message
+ * @return pldm_completion_codes
+ * @note Caller is responsible for memory alloc and dealloc of param
+ * 'msg.payload'
+ */
+int encode_event_message_buffer_size_req(
+ uint8_t instance_id, uint16_t event_receiver_max_buffer_size,
+ struct pldm_msg *msg);
+
/** @brief Decode sensorEventData response data
*
* @param[in] event_data - event data from the response message
diff --git a/src/platform.c b/src/platform.c
index 8b83747..a781f3c 100644
--- a/src/platform.c
+++ b/src/platform.c
@@ -922,6 +922,55 @@
return PLDM_SUCCESS;
}
+int encode_event_message_buffer_size_req(
+ uint8_t instance_id, uint16_t event_receiver_max_buffer_size,
+ struct pldm_msg *msg)
+{
+ struct pldm_header_info header = {0};
+ header.msg_type = PLDM_REQUEST;
+ header.instance = instance_id;
+ header.pldm_type = PLDM_PLATFORM;
+ header.command = PLDM_EVENT_MESSAGE_BUFFER_SIZE;
+
+ uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
+ if (rc != PLDM_SUCCESS) {
+ return rc;
+ }
+
+ struct pldm_event_message_buffer_size_req *request =
+ (struct pldm_event_message_buffer_size_req *)msg->payload;
+ request->event_receiver_max_buffer_size =
+ event_receiver_max_buffer_size;
+
+ return PLDM_SUCCESS;
+}
+
+int decode_event_message_buffer_size_resp(const struct pldm_msg *msg,
+ size_t payload_length,
+ uint8_t *completion_code,
+ uint16_t *terminus_max_buffer_size)
+{
+ if (msg == NULL || completion_code == NULL ||
+ terminus_max_buffer_size == NULL) {
+ return PLDM_ERROR_INVALID_DATA;
+ }
+
+ *completion_code = msg->payload[0];
+ if (PLDM_SUCCESS != *completion_code) {
+ return PLDM_SUCCESS;
+ }
+ if (payload_length != PLDM_EVENT_MESSAGE_BUFFER_SIZE_RESP_BYTES) {
+ return PLDM_ERROR_INVALID_LENGTH;
+ }
+
+ struct pldm_event_message_buffer_size_resp *response =
+ (struct pldm_event_message_buffer_size_resp *)msg->payload;
+
+ *terminus_max_buffer_size = response->terminus_max_buffer_size;
+
+ return PLDM_SUCCESS;
+}
+
int decode_sensor_event_data(const uint8_t *event_data,
size_t event_data_length, uint16_t *sensor_id,
uint8_t *sensor_event_class_type,
diff --git a/tests/libpldm_platform_test.cpp b/tests/libpldm_platform_test.cpp
index c785e3f..9c5e3b0 100644
--- a/tests/libpldm_platform_test.cpp
+++ b/tests/libpldm_platform_test.cpp
@@ -832,6 +832,74 @@
EXPECT_EQ(rc, PLDM_ERROR_INVALID_LENGTH);
}
+TEST(EventMessageBufferSize, testGoodEventMessageBufferSizeRequest)
+{
+ uint8_t eventBufferSize = 32;
+
+ std::array<uint8_t, hdrSize + PLDM_EVENT_MESSAGE_BUFFER_SIZE_REQ_BYTES>
+ requestMsg{};
+ auto request = reinterpret_cast<pldm_msg*>(requestMsg.data());
+
+ auto rc = encode_event_message_buffer_size_req(0, eventBufferSize, request);
+
+ EXPECT_EQ(rc, PLDM_SUCCESS);
+}
+
+TEST(EventMessageBufferSize, testGoodEventMessageBufferSizeResponse)
+{
+ uint8_t completionCode = PLDM_SUCCESS;
+ uint16_t terminusMaxBufferSize = 256;
+
+ std::array<uint8_t, hdrSize + PLDM_EVENT_MESSAGE_BUFFER_SIZE_RESP_BYTES>
+ responseMsg{};
+
+ uint8_t retCompletionCode;
+ uint16_t retMaxBufferSize = 0;
+
+ auto response = reinterpret_cast<pldm_msg*>(responseMsg.data());
+ struct pldm_event_message_buffer_size_resp* resp =
+ reinterpret_cast<struct pldm_event_message_buffer_size_resp*>(
+ response->payload);
+
+ resp->completion_code = completionCode;
+ resp->terminus_max_buffer_size = terminusMaxBufferSize;
+
+ auto rc = decode_event_message_buffer_size_resp(
+ response, responseMsg.size() - hdrSize, &retCompletionCode,
+ &retMaxBufferSize);
+
+ EXPECT_EQ(rc, PLDM_SUCCESS);
+ EXPECT_EQ(retCompletionCode, completionCode);
+ EXPECT_EQ(terminusMaxBufferSize, retMaxBufferSize);
+}
+
+TEST(EventMessageBufferSize, testBadEventMessageBufferSizeResponse)
+{
+ uint8_t completionCode = PLDM_SUCCESS;
+ uint16_t terminusMaxBufferSize = 256;
+
+ std::array<uint8_t, hdrSize + PLDM_EVENT_MESSAGE_BUFFER_SIZE_RESP_BYTES>
+ responseMsg{};
+
+ uint8_t retCompletionCode;
+ uint16_t retMaxBufferSize = 0;
+
+ auto response = reinterpret_cast<pldm_msg*>(responseMsg.data());
+ struct pldm_event_message_buffer_size_resp* resp =
+ reinterpret_cast<struct pldm_event_message_buffer_size_resp*>(
+ response->payload);
+ resp->completion_code = completionCode;
+ resp->terminus_max_buffer_size = terminusMaxBufferSize;
+
+ auto rc =
+ decode_event_message_buffer_size_resp(response, 0, nullptr, nullptr);
+ EXPECT_EQ(rc, PLDM_ERROR_INVALID_DATA);
+
+ rc = decode_event_message_buffer_size_resp(
+ response, responseMsg.size(), &retCompletionCode, &retMaxBufferSize);
+ EXPECT_EQ(rc, PLDM_ERROR_INVALID_LENGTH);
+}
+
TEST(PlatformEventMessage, testGoodStateSensorDecodeRequest)
{
std::array<uint8_t,