PLDM: Implement encode response & decode request API for SetFRURecordTable
This commit implements the responder flow for SetFRURecordTable
PLDM SPEC: DSP0257_1.0.0 Table 11
Tested: Unit tests passed
Signed-off-by: Sridevi Ramesh <sridevra@in.ibm.com>
Change-Id: Ic9cd7e0f37148fcb6fe5a7aea4c6719562a55b0d
diff --git a/libpldm/fru.c b/libpldm/fru.c
index b726139..7633e50 100644
--- a/libpldm/fru.c
+++ b/libpldm/fru.c
@@ -467,3 +467,64 @@
return PLDM_SUCCESS;
}
+
+int decode_set_fru_record_table_req(const struct pldm_msg *msg,
+ size_t payload_length,
+ uint32_t *data_transfer_handle,
+ uint8_t *transfer_flag,
+ struct variable_field *fru_table_data)
+
+{
+ if (msg == NULL || data_transfer_handle == NULL ||
+ transfer_flag == NULL || fru_table_data == NULL) {
+ return PLDM_ERROR_INVALID_DATA;
+ }
+
+ if (payload_length <= PLDM_SET_FRU_RECORD_TABLE_MIN_REQ_BYTES) {
+ return PLDM_ERROR_INVALID_LENGTH;
+ }
+
+ struct pldm_set_fru_record_table_req *req =
+ (struct pldm_set_fru_record_table_req *)msg->payload;
+
+ *data_transfer_handle = le32toh(req->data_transfer_handle);
+ *transfer_flag = req->transfer_flag;
+ fru_table_data->length =
+ payload_length - PLDM_SET_FRU_RECORD_TABLE_MIN_REQ_BYTES;
+ fru_table_data->ptr = req->fru_record_table_data;
+
+ return PLDM_SUCCESS;
+}
+
+int encode_set_fru_record_table_resp(uint8_t instance_id,
+ uint8_t completion_code,
+ uint32_t next_data_transfer_handle,
+ size_t payload_length,
+ struct pldm_msg *msg)
+{
+ if (msg == NULL) {
+ return PLDM_ERROR_INVALID_DATA;
+ }
+ if (payload_length != PLDM_SET_FRU_RECORD_TABLE_RESP_BYTES) {
+ return PLDM_ERROR_INVALID_LENGTH;
+ }
+
+ struct pldm_header_info header = {0};
+ header.instance = instance_id;
+ header.msg_type = PLDM_RESPONSE;
+ header.pldm_type = PLDM_FRU;
+ header.command = PLDM_SET_FRU_RECORD_TABLE;
+
+ uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
+ if (PLDM_SUCCESS != rc) {
+ return rc;
+ }
+
+ struct pldm_set_fru_record_table_resp *response =
+ (struct pldm_set_fru_record_table_resp *)msg->payload;
+ response->completion_code = completion_code;
+ response->next_data_transfer_handle =
+ htole32(next_data_transfer_handle);
+
+ return PLDM_SUCCESS;
+}
diff --git a/libpldm/fru.h b/libpldm/fru.h
index 3739937..456c051 100644
--- a/libpldm/fru.h
+++ b/libpldm/fru.h
@@ -17,10 +17,15 @@
#define PLDM_GET_FRU_RECORD_TABLE_REQ_BYTES 5
#define PLDM_GET_FRU_RECORD_TABLE_MIN_RESP_BYTES 6
#define PLDM_GET_FRU_RECORD_BY_OPTION_MIN_RESP_BYTES 6
+#define PLDM_SET_FRU_RECORD_TABLE_MIN_REQ_BYTES 5
+#define PLDM_SET_FRU_RECORD_TABLE_RESP_BYTES 5
#define FRU_TABLE_CHECKSUM_SIZE 4
enum pldm_fru_completion_codes {
+ PLDM_FRU_INVALID_DATA_TRANSFER_HANDLE = 0x80,
+ PLDM_FRU_INVALID_TRANSFER_FLAG = 0x82,
+ PLDM_FRU_DATA_INVALID_DATA_INTEGRITY_CHECK = 0x84,
PLDM_FRU_DATA_STRUCTURE_TABLE_UNAVAILABLE = 0x85,
};
@@ -126,6 +131,17 @@
uint8_t fru_structure_data[1];
} __attribute__((packed));
+struct pldm_set_fru_record_table_req {
+ uint32_t data_transfer_handle;
+ uint8_t transfer_flag;
+ uint8_t fru_record_table_data[1];
+} __attribute__((packed));
+
+struct pldm_set_fru_record_table_resp {
+ uint8_t completion_code;
+ uint32_t next_data_transfer_handle;
+} __attribute__((packed));
+
/** @struct pldm_fru_record_tlv
*
* Structure representing each FRU field entry (type, length, value)
@@ -423,6 +439,41 @@
void get_fru_record_by_option(const uint8_t *table, size_t table_size,
uint8_t *record_table, size_t *record_size,
uint16_t rsi, uint8_t rt, uint8_t ft);
+/* SetFruRecordTable */
+
+/** @brief Decode SetFruRecordTable request data
+ *
+ * @param[in] msg - PLDM request message payload
+ * @param[in] payload_length - Length of request payload
+ * @param[out] data_transfer_handle - A handle used to identify a FRU Record
+ * table data transfer
+ * @param[out] transfer_flag - Flag to indicate what part of the transfer
+ * this request represents
+ * @param[out] fru_table_data - Struct variable_field, contains data specific
+ * to the fru record table and the length of table
+ * data
+ * @return pldm_completion_codes
+ */
+int decode_set_fru_record_table_req(const struct pldm_msg *msg,
+ size_t payload_length,
+ uint32_t *data_transfer_handle,
+ uint8_t *transfer_flag,
+ struct variable_field *fru_table_data);
+
+/** @brief Create a PLDM response message for SetFruRecordTable
+ *
+ * @param[in] instance_id - Message's instance id
+ * @param[in] completion_code - PLDM completion code
+ * @param[in] next_transfer_handle - handle to identify the next portion of the
+ * transfer
+ * @param[in] payload_length - Length of payload message
+ * @param[out] msg - Argument to capture the Message
+ */
+int encode_set_fru_record_table_resp(uint8_t instance_id,
+ uint8_t completion_code,
+ uint32_t next_data_transfer_handle,
+ size_t payload_length,
+ struct pldm_msg *msg);
#ifdef __cplusplus
}
diff --git a/libpldm/tests/libpldm_fru_test.cpp b/libpldm/tests/libpldm_fru_test.cpp
index 8a3850c..0419826 100644
--- a/libpldm/tests/libpldm_fru_test.cpp
+++ b/libpldm/tests/libpldm_fru_test.cpp
@@ -772,3 +772,116 @@
EXPECT_EQ(rc, PLDM_ERROR_INVALID_LENGTH);
}
+
+TEST(SetFRURecordTable, testGoodEncodeResponse)
+{
+ uint8_t instanceId = 2;
+ uint8_t completionCode = PLDM_SUCCESS;
+ uint32_t nextDataTransferHandle = 32;
+
+ std::array<uint8_t,
+ sizeof(pldm_msg_hdr) + PLDM_SET_FRU_RECORD_TABLE_RESP_BYTES>
+ responseMsg{};
+ struct pldm_msg* response =
+ reinterpret_cast<struct pldm_msg*>(responseMsg.data());
+ auto rc = encode_set_fru_record_table_resp(
+ instanceId, completionCode, nextDataTransferHandle,
+ responseMsg.size() - sizeof(pldm_msg_hdr), response);
+ EXPECT_EQ(rc, PLDM_SUCCESS);
+
+ struct pldm_set_fru_record_table_resp* resp =
+ reinterpret_cast<struct pldm_set_fru_record_table_resp*>(
+ response->payload);
+ EXPECT_EQ(completionCode, resp->completion_code);
+ EXPECT_EQ(htole32(nextDataTransferHandle), resp->next_data_transfer_handle);
+}
+
+TEST(SetFRURecordTable, testBadEncodeResponse)
+{
+ uint8_t instanceId = 0;
+ uint8_t completionCode = PLDM_SUCCESS;
+ uint32_t nextDataTransferHandle = 1;
+
+ std::array<uint8_t,
+ sizeof(pldm_msg_hdr) + PLDM_SET_FRU_RECORD_TABLE_RESP_BYTES>
+ responseMsg{};
+ struct pldm_msg* response =
+ reinterpret_cast<struct pldm_msg*>(responseMsg.data());
+
+ auto rc = encode_set_fru_record_table_resp(
+ instanceId, completionCode, nextDataTransferHandle,
+ responseMsg.size() - sizeof(pldm_msg_hdr), NULL);
+ EXPECT_EQ(rc, PLDM_ERROR_INVALID_DATA);
+
+ rc = encode_set_fru_record_table_resp(
+ instanceId, completionCode, nextDataTransferHandle,
+ responseMsg.size() - sizeof(pldm_msg_hdr) - 1, response);
+ EXPECT_EQ(rc, PLDM_ERROR_INVALID_LENGTH);
+}
+
+TEST(SetFRURecordTable, testGoodDecodeRequest)
+{
+ uint32_t transferHandle = 1;
+ uint8_t transferFlag = PLDM_GET_FIRSTPART;
+ uint32_t tableData = 44;
+
+ std::array<uint8_t, sizeof(pldm_msg_hdr) +
+ PLDM_SET_FRU_RECORD_TABLE_MIN_REQ_BYTES +
+ sizeof(tableData)>
+ requestMsg{};
+ auto request = reinterpret_cast<struct pldm_msg*>(requestMsg.data());
+ struct pldm_set_fru_record_table_req* req =
+ reinterpret_cast<struct pldm_set_fru_record_table_req*>(
+ request->payload);
+ req->data_transfer_handle = htole32(transferHandle);
+ req->transfer_flag = transferFlag;
+ memcpy(req->fru_record_table_data, &tableData, sizeof(tableData));
+
+ uint32_t retTransferHandle;
+ uint8_t retTransferFlag;
+ struct variable_field table;
+
+ auto rc = decode_set_fru_record_table_req(
+ request, requestMsg.size() - sizeof(pldm_msg_hdr), &retTransferHandle,
+ &retTransferFlag, &table);
+
+ EXPECT_EQ(rc, PLDM_SUCCESS);
+ EXPECT_EQ(retTransferHandle, transferHandle);
+ EXPECT_EQ(retTransferFlag, transferFlag);
+ EXPECT_EQ(table.length, sizeof(tableData));
+ EXPECT_EQ(0, memcmp(table.ptr, &tableData, sizeof(tableData)));
+}
+
+TEST(SetFRURecordTable, testBadDecodeRequest)
+{
+ uint32_t transferHandle = 1;
+ uint8_t transferFlag = PLDM_GET_FIRSTPART;
+ uint32_t tableData = 44;
+
+ std::array<uint8_t, sizeof(pldm_msg_hdr) +
+ PLDM_SET_FRU_RECORD_TABLE_MIN_REQ_BYTES +
+ sizeof(tableData)>
+ requestMsg{};
+ auto request = reinterpret_cast<struct pldm_msg*>(requestMsg.data());
+ struct pldm_set_fru_record_table_req* req =
+ reinterpret_cast<struct pldm_set_fru_record_table_req*>(
+ request->payload);
+ req->data_transfer_handle = htole32(transferHandle);
+ req->transfer_flag = transferFlag;
+ memcpy(req->fru_record_table_data, &tableData, sizeof(tableData));
+
+ uint32_t retTransferHandle;
+ uint8_t retTransferFlag;
+
+ auto rc = decode_set_fru_record_table_req(
+ request, requestMsg.size() - sizeof(pldm_msg_hdr), &retTransferHandle,
+ &retTransferFlag, NULL);
+ EXPECT_EQ(rc, PLDM_ERROR_INVALID_DATA);
+
+ struct variable_field table;
+ rc = decode_set_fru_record_table_req(
+ request,
+ requestMsg.size() - sizeof(pldm_msg_hdr) - sizeof(tableData) - 1,
+ &retTransferHandle, &retTransferFlag, &table);
+ EXPECT_EQ(rc, PLDM_ERROR_INVALID_LENGTH);
+}