requester: Add PollForPlatformEventMessage APIs
Added encode/decode APIs for PollForPlatformEventMessage command(0x0B)
which is defined in DSP0248 Version 1.2.1 sec:16.7.
Signed-off-by: Thu Nguyen <thu@os.amperecomputing.com>
Signed-off-by: Dung Cao <dung@os.amperecomputing.com>
Change-Id: I0a707256d0ff6133d48a384dc252bce736b802f7
diff --git a/tests/libpldm_platform_test.cpp b/tests/libpldm_platform_test.cpp
index e7f4253..7746b59 100644
--- a/tests/libpldm_platform_test.cpp
+++ b/tests/libpldm_platform_test.cpp
@@ -8,6 +8,7 @@
#include "libpldm/base.h"
#include "libpldm/entity.h"
#include "libpldm/platform.h"
+#include "msgbuf.h"
#include "pldm_types.h"
#include <gtest/gtest.h>
@@ -1181,6 +1182,257 @@
EXPECT_EQ(rc, PLDM_ERROR_INVALID_LENGTH);
}
+TEST(PollForPlatformEventMessage, testGoodEncodeRequest)
+{
+ uint8_t formatVersion = 0x01;
+ uint8_t transferOperationFlag = 0x1;
+ uint32_t dataTransferHandle = 0xffffffff;
+ uint16_t eventIdToAcknowledge = 0x0;
+
+ std::array<uint8_t,
+ hdrSize + PLDM_POLL_FOR_PLATFORM_EVENT_MESSAGE_REQ_BYTES>
+ requestMsg{};
+ auto request = reinterpret_cast<pldm_msg*>(requestMsg.data());
+
+ auto rc = encode_poll_for_platform_event_message_req(
+ 0, formatVersion, transferOperationFlag, dataTransferHandle,
+ eventIdToAcknowledge, request,
+ PLDM_POLL_FOR_PLATFORM_EVENT_MESSAGE_REQ_BYTES);
+ EXPECT_EQ(rc, PLDM_SUCCESS);
+
+ struct pldm_msgbuf _buf;
+ struct pldm_msgbuf* buf = &_buf;
+ rc = pldm_msgbuf_init(buf, PLDM_POLL_FOR_PLATFORM_EVENT_MESSAGE_REQ_BYTES,
+ request->payload,
+ PLDM_POLL_FOR_PLATFORM_EVENT_MESSAGE_REQ_BYTES);
+ EXPECT_EQ(rc, PLDM_SUCCESS);
+
+ uint8_t retFormatVersion;
+ uint8_t retTransferOperationFlag;
+ uint32_t retDataTransferHandle;
+ uint16_t retEventIdToAcknowledge;
+
+ pldm_msgbuf_extract_uint8(buf, &retFormatVersion);
+ pldm_msgbuf_extract_uint8(buf, &retTransferOperationFlag);
+ pldm_msgbuf_extract_uint32(buf, &retDataTransferHandle);
+ pldm_msgbuf_extract_uint16(buf, &retEventIdToAcknowledge);
+
+ EXPECT_EQ(retFormatVersion, formatVersion);
+ EXPECT_EQ(retTransferOperationFlag, transferOperationFlag);
+ EXPECT_EQ(retDataTransferHandle, dataTransferHandle);
+ EXPECT_EQ(retEventIdToAcknowledge, eventIdToAcknowledge);
+ EXPECT_EQ(pldm_msgbuf_destroy(buf), PLDM_SUCCESS);
+}
+
+TEST(PollForPlatformEventMessage, testBadEncodeRequest)
+{
+ uint8_t formatVersion = 0x01;
+ uint8_t transferOperationFlag = 0x1;
+ uint32_t dataTransferHandle = 0xffffffff;
+ uint16_t eventIdToAcknowledge = 0x0;
+
+ std::array<uint8_t,
+ hdrSize + PLDM_POLL_FOR_PLATFORM_EVENT_MESSAGE_REQ_BYTES>
+ requestMsg{};
+ auto request = reinterpret_cast<pldm_msg*>(requestMsg.data());
+
+ auto rc = encode_poll_for_platform_event_message_req(
+ 0, formatVersion, transferOperationFlag, dataTransferHandle,
+ eventIdToAcknowledge, nullptr,
+ PLDM_POLL_FOR_PLATFORM_EVENT_MESSAGE_REQ_BYTES);
+
+ EXPECT_EQ(rc, PLDM_ERROR_INVALID_DATA);
+
+ encode_poll_for_platform_event_message_req(
+ 0, formatVersion, transferOperationFlag, dataTransferHandle,
+ eventIdToAcknowledge, request, hdrSize);
+}
+
+TEST(PollForPlatformEventMessage, testGoodDecodeRespond)
+{
+ uint8_t completionCode = PLDM_SUCCESS;
+ uint8_t tId = 0x9;
+ uint16_t eventId = 159;
+ uint32_t nextDataTransferHandle = 0x11223344;
+ uint8_t transferFlag = PLDM_START_AND_END;
+ uint8_t eventClass = 0x5;
+ uint8_t eventData[5] = {0x55, 0x44, 0x33, 0x22, 0x11};
+ constexpr uint32_t eventDataSize = 0x00000005;
+ uint32_t eventDataIntegrityChecksum = 0x66778899;
+
+ std::vector<uint8_t> responseMsg{
+ 0x1,
+ 0x0,
+ 0x0,
+ PLDM_SUCCESS,
+ 0x9, // tid
+ 159,
+ 0x0, // event id
+ 0x44,
+ 0x33,
+ 0x22,
+ 0x11, // next_data_transfer_handle
+ PLDM_START_AND_END, // transfer_flag
+ 0x05, // event class
+ 0x05,
+ 0x00,
+ 0x00,
+ 0x00, // event_data_size
+ 0x55,
+ 0x44,
+ 0x33,
+ 0x22,
+ 0x11, // event_data[5]
+ 0x99,
+ 0x88,
+ 0x77,
+ 0x66 // event_data_integrity_checksum
+ };
+ const uint32_t respMsgLen = 23;
+
+ auto response = reinterpret_cast<pldm_msg*>(responseMsg.data());
+
+ uint8_t retCompletionCode;
+ uint8_t retTid = 0;
+ uint16_t retEventId = 0;
+ uint32_t retNextDataTransferHandle = 0;
+ uint8_t retTransferFlag = 0;
+ uint8_t retEventClass = 0;
+ uint32_t retEventDataSize = 0;
+ uint8_t* retEventData = nullptr;
+ uint32_t retEventDataIntegrityChecksum = 0;
+
+ auto rc = decode_poll_for_platform_event_message_resp(
+ response, respMsgLen, &retCompletionCode, &retTid, &retEventId,
+ &retNextDataTransferHandle, &retTransferFlag, &retEventClass,
+ &retEventDataSize, (void**)&retEventData,
+ &retEventDataIntegrityChecksum);
+
+ EXPECT_EQ(rc, PLDM_SUCCESS);
+ EXPECT_EQ(retCompletionCode, completionCode);
+ EXPECT_EQ(retTid, tId);
+ EXPECT_EQ(retEventId, eventId);
+ EXPECT_EQ(retNextDataTransferHandle, nextDataTransferHandle);
+ EXPECT_EQ(retTransferFlag, transferFlag);
+ EXPECT_EQ(retEventClass, eventClass);
+ EXPECT_EQ(retEventDataSize, eventDataSize);
+ EXPECT_EQ(retEventDataIntegrityChecksum, eventDataIntegrityChecksum);
+ EXPECT_EQ(0, memcmp(eventData, retEventData, eventDataSize));
+}
+
+TEST(PollForPlatformEventMessage, testGoodDecodeAckOnlyRespond)
+{
+ uint8_t completionCode = PLDM_SUCCESS;
+ uint8_t tId = 0x9;
+ uint16_t eventId = 0xffff;
+
+ std::vector<uint8_t> responseMsg{
+ 0x1, 0x0, 0x0, PLDM_SUCCESS,
+ 0x9, // tid
+ 0xff,
+ 0xff // event id
+ };
+ const uint32_t respMsgLen = 4;
+
+ auto response = reinterpret_cast<pldm_msg*>(responseMsg.data());
+
+ uint8_t retCompletionCode;
+ uint8_t retTid = 0;
+ uint16_t retEventId = 0;
+ uint32_t retNextDataTransferHandle = 0;
+ uint8_t retTransferFlag = 0;
+ uint8_t retEventClass = 0;
+ uint32_t retEventDataSize = 0;
+ uint8_t* retEventData = nullptr;
+ uint32_t retEventDataIntegrityChecksum = 0;
+
+ auto rc = decode_poll_for_platform_event_message_resp(
+ response, respMsgLen, &retCompletionCode, &retTid, &retEventId,
+ &retNextDataTransferHandle, &retTransferFlag, &retEventClass,
+ &retEventDataSize, (void**)&retEventData,
+ &retEventDataIntegrityChecksum);
+
+ EXPECT_EQ(rc, PLDM_SUCCESS);
+ EXPECT_EQ(retCompletionCode, completionCode);
+ EXPECT_EQ(retTid, tId);
+ EXPECT_EQ(retEventId, eventId);
+
+ eventId = 0x0000;
+ responseMsg[5] = 0x00;
+ responseMsg[6] = 0x00;
+ response = reinterpret_cast<pldm_msg*>(responseMsg.data());
+
+ rc = decode_poll_for_platform_event_message_resp(
+ response, respMsgLen, &retCompletionCode, &retTid, &retEventId,
+ &retNextDataTransferHandle, &retTransferFlag, &retEventClass,
+ &retEventDataSize, (void**)&retEventData,
+ &retEventDataIntegrityChecksum);
+
+ EXPECT_EQ(rc, PLDM_SUCCESS);
+ EXPECT_EQ(retCompletionCode, completionCode);
+ EXPECT_EQ(retTid, tId);
+ EXPECT_EQ(retEventId, eventId);
+}
+
+TEST(PollForPlatformEventMessage, testBadDecodeRespond)
+{
+ std::vector<uint8_t> responseMsg{
+ 0x1,
+ 0x0,
+ 0x0,
+ PLDM_SUCCESS,
+ 0x9, // tid
+ 159,
+ 0x0, // event id
+ 0x44,
+ 0x33,
+ 0x22,
+ 0x11, // next_data_transfer_handle
+ PLDM_START_AND_END, // transfer_flag
+ 0x05, // event class
+ 0x05,
+ 0x00,
+ 0x00,
+ 0x00, // event_data_size
+ 0x55,
+ 0x44,
+ 0x33,
+ 0x22,
+ 0x11, // event_data[5]
+ 0x99,
+ 0x88,
+ 0x77,
+ 0x66 // event_data_integrity_checksum
+ };
+ // const uint32_t respMsgLen = 23;
+
+ auto response = reinterpret_cast<pldm_msg*>(responseMsg.data());
+
+ auto rc = decode_poll_for_platform_event_message_resp(
+ nullptr, 0, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr,
+ nullptr, nullptr, nullptr);
+
+ EXPECT_EQ(rc, PLDM_ERROR_INVALID_DATA);
+
+ uint8_t retCompletionCode;
+ uint8_t retTid = 0;
+ uint16_t retEventId = 0;
+ uint32_t retNextDataTransferHandle = 0;
+ uint8_t retTransferFlag = 0;
+ uint8_t retEventClass = 0;
+ uint32_t retEventDataSize = 0;
+ uint8_t* retEventData = nullptr;
+ uint32_t retEventDataIntegrityChecksum = 0;
+
+ rc = decode_poll_for_platform_event_message_resp(
+ response, PLDM_POLL_FOR_PLATFORM_EVENT_MESSAGE_MIN_RESP_BYTES - 1,
+ &retCompletionCode, &retTid, &retEventId, &retNextDataTransferHandle,
+ &retTransferFlag, &retEventClass, &retEventDataSize,
+ (void**)&retEventData, &retEventDataIntegrityChecksum);
+
+ EXPECT_EQ(rc, PLDM_ERROR_INVALID_LENGTH);
+}
+
TEST(PlatformEventMessage, testGoodStateSensorDecodeRequest)
{
std::array<uint8_t,