libpldm: encode GetFruRecordTable request api
This commit implements encode request api for
Get FRU record table which is defined in
PLDM FRU Data Specification DSP0257_1.0.0.
Signed-off-by: PriyangaRamasamy <priyanga24@in.ibm.com>
Change-Id: I8b276f4796175e0a44da9e719a3a1949d29ece86
libpldm: decode GetFruRecordTable response api
This commit implements decode response api for
GetFruRecordTable which is defined in
PLDM FRU Data Specification DSP0257_1.0.0.
Change-Id: I97642b25142f523c349b4ccc19c9a002eb9d6e0d
Signed-off-by: PriyangaRamasamy <priyanga24@in.ibm.com>
diff --git a/libpldm/fru.c b/libpldm/fru.c
index f28231b..13d14e8 100644
--- a/libpldm/fru.c
+++ b/libpldm/fru.c
@@ -192,3 +192,67 @@
return PLDM_SUCCESS;
}
+
+int encode_get_fru_record_table_req(uint8_t instance_id,
+ uint32_t data_transfer_handle,
+ uint8_t transfer_operation_flag,
+ struct pldm_msg *msg, size_t payload_length)
+
+{
+ struct pldm_header_info header = {0};
+ int rc = PLDM_ERROR_INVALID_DATA;
+
+ header.msg_type = PLDM_REQUEST;
+ header.instance = instance_id;
+ header.pldm_type = PLDM_FRU;
+ header.command = PLDM_GET_FRU_RECORD_TABLE;
+
+ if (msg == NULL) {
+ return rc;
+ }
+ if (payload_length != sizeof(struct pldm_get_fru_record_table_req)) {
+ return PLDM_ERROR_INVALID_LENGTH;
+ }
+ if ((rc = pack_pldm_header(&header, &(msg->hdr))) > PLDM_SUCCESS) {
+ return rc;
+ }
+
+ struct pldm_get_fru_record_table_req *req =
+ (struct pldm_get_fru_record_table_req *)msg->payload;
+ req->data_transfer_handle = htole32(data_transfer_handle);
+ req->transfer_operation_flag = transfer_operation_flag;
+
+ return PLDM_SUCCESS;
+}
+
+int decode_get_fru_record_table_resp(
+ const struct pldm_msg *msg, size_t payload_length, uint8_t *completion_code,
+ uint32_t *next_data_transfer_handle, uint8_t *transfer_flag,
+ uint8_t *fru_record_table_data, size_t *fru_record_table_length)
+{
+ if (msg == NULL || completion_code == NULL ||
+ next_data_transfer_handle == NULL || transfer_flag == NULL ||
+ fru_record_table_data == NULL || fru_record_table_length == NULL) {
+ return PLDM_ERROR_INVALID_DATA;
+ }
+
+ *completion_code = msg->payload[0];
+ if (PLDM_SUCCESS != *completion_code) {
+ return PLDM_SUCCESS;
+ }
+ if (payload_length <= PLDM_GET_FRU_RECORD_TABLE_MIN_RESP_BYTES) {
+ return PLDM_ERROR_INVALID_LENGTH;
+ }
+
+ struct pldm_get_fru_record_table_resp *resp =
+ (struct pldm_get_fru_record_table_resp *)msg->payload;
+
+ *next_data_transfer_handle = le32toh(resp->next_data_transfer_handle);
+ *transfer_flag = resp->transfer_flag;
+ memcpy(fru_record_table_data, resp->fru_record_table_data,
+ payload_length - PLDM_GET_FRU_RECORD_TABLE_MIN_RESP_BYTES);
+ *fru_record_table_length =
+ payload_length - PLDM_GET_FRU_RECORD_TABLE_MIN_RESP_BYTES;
+
+ return PLDM_SUCCESS;
+}
diff --git a/libpldm/fru.h b/libpldm/fru.h
index 6a14956..6addf27 100644
--- a/libpldm/fru.h
+++ b/libpldm/fru.h
@@ -20,6 +20,8 @@
enum pldm_fru_commands {
PLDM_GET_FRU_RECORD_TABLE_METADATA = 0X01,
PLDM_GET_FRU_RECORD_TABLE = 0X02,
+ PLDM_SET_FRU_RECORD_TABLE = 0X03,
+ PLDM_GET_FRU_RECORD_BY_OPTION = 0X04
};
/** @brief FRU record types
@@ -228,6 +230,49 @@
uint32_t next_data_transfer_handle,
uint8_t transfer_flag,
struct pldm_msg *msg);
+/* Requester */
+
+/* GetFruRecordTable */
+
+/** @brief Create a PLDM request message for GetFruRecordTable
+ *
+ * @param[in] instance_id - Message's instance id
+ * @param[in] data_transfer_handle - A handle, used to identify a FRU Record
+ * Table data transfer
+ * @param[in] transfer_operation_flag - A flag that indicates whether this is
+ * the start of the transfer
+ * @param[in,out] msg - Message will be written to this
+ * @param[in] payload_length - Length of request message payload
+ * @return pldm_completion_codes
+ * @note Caller is responsible for memory alloc and dealloc of param
+ * 'msg.payload'
+ */
+
+int encode_get_fru_record_table_req(uint8_t instance_id,
+ uint32_t data_transfer_handle,
+ uint8_t transfer_operation_flag,
+ struct pldm_msg *msg,
+ size_t payload_length);
+
+/** @brief Decode GetFruRecordTable response data
+ *
+ * @param[in] msg - Response message
+ * @param[in] payload_length - Length of response message payload
+ * @param[out] completion_code - Pointer to response msg's PLDM completion code
+ * @param[out] next_data_transfer_handle - A handle used to identify the next
+ * portion of the transfer
+ * @param[out] transfer_flag - The transfer flag that indicates what part of
+ * the transfer this response represents
+ * @param[out] fru_record_table_data - This data is a portion of the overall
+ * FRU Record Table
+ * @param[out] fru_record_table_length - Length of the FRU record table data
+ * @return pldm_completion_codes
+ */
+
+int decode_get_fru_record_table_resp(
+ const struct pldm_msg *msg, size_t payload_length, uint8_t *completion_code,
+ uint32_t *next_data_transfer_handle, uint8_t *transfer_flag,
+ uint8_t *fru_record_table_data, size_t *fru_record_table_length);
/** @brief Encode the FRU record in the FRU table
*
diff --git a/libpldm/tests/libpldm_fru_test.cpp b/libpldm/tests/libpldm_fru_test.cpp
index 9e598c7..350d1b9 100644
--- a/libpldm/tests/libpldm_fru_test.cpp
+++ b/libpldm/tests/libpldm_fru_test.cpp
@@ -392,3 +392,120 @@
ASSERT_EQ(rc, PLDM_ERROR_INVALID_DATA);
}
+
+TEST(GetFruRecordTable, testGoodEncodeRequest)
+
+{
+ std::array<uint8_t,
+ sizeof(pldm_msg_hdr) + PLDM_GET_FRU_RECORD_TABLE_REQ_BYTES>
+ requestMsg{};
+
+ auto requestPtr = reinterpret_cast<pldm_msg*>(requestMsg.data());
+ auto request =
+ reinterpret_cast<pldm_get_fru_record_table_req*>(requestPtr->payload);
+
+ // Random value for data transfer handle and transfer operation flag
+ uint32_t data_transfer_handle = 32;
+ uint8_t transfer_operation_flag = PLDM_GET_FIRSTPART;
+
+ // Invoke encode get FRU record table request api
+ auto rc = encode_get_fru_record_table_req(
+ 0, data_transfer_handle, transfer_operation_flag, requestPtr,
+ requestMsg.size() - sizeof(pldm_msg_hdr));
+
+ ASSERT_EQ(rc, PLDM_SUCCESS);
+ ASSERT_EQ(requestPtr->hdr.request, PLDM_REQUEST);
+ ASSERT_EQ(requestPtr->hdr.instance_id, 0);
+ ASSERT_EQ(requestPtr->hdr.type, PLDM_FRU);
+ ASSERT_EQ(requestPtr->hdr.command, PLDM_GET_FRU_RECORD_TABLE);
+ ASSERT_EQ(le32toh(data_transfer_handle), request->data_transfer_handle);
+ ASSERT_EQ(transfer_operation_flag, request->transfer_operation_flag);
+}
+
+TEST(GetFruRecordTable, testBadEncodeRequest)
+
+{
+ uint32_t data_transfer_handle = 0x0;
+ uint8_t transfer_operation_flag = PLDM_GET_FIRSTPART;
+
+ std::array<uint8_t,
+ sizeof(pldm_msg_hdr) + PLDM_GET_FRU_RECORD_TABLE_REQ_BYTES>
+ requestMsg{};
+ auto rc = encode_get_fru_record_table_req(
+ 0, data_transfer_handle, transfer_operation_flag, NULL,
+ requestMsg.size() - sizeof(pldm_msg_hdr));
+
+ ASSERT_EQ(rc, PLDM_ERROR_INVALID_DATA);
+}
+
+TEST(GetFruRecordTable, testGoodDecodeResponse)
+{
+ uint8_t completion_code = PLDM_SUCCESS;
+ uint32_t next_data_transfer_handle = 0x16;
+ uint8_t transfer_flag = PLDM_START_AND_END;
+ std::vector<uint8_t> fru_record_table_data = {1, 2, 3, 4, 5, 6, 7, 8, 9};
+
+ std::vector<uint8_t> responseMsg(sizeof(pldm_msg_hdr) +
+ PLDM_GET_FRU_RECORD_TABLE_MIN_RESP_BYTES +
+ fru_record_table_data.size());
+
+ auto responsePtr = reinterpret_cast<pldm_msg*>(responseMsg.data());
+ size_t payload_length = responseMsg.size() - sizeof(pldm_msg_hdr);
+ auto response =
+ reinterpret_cast<pldm_get_fru_record_table_resp*>(responsePtr->payload);
+
+ response->completion_code = completion_code;
+ response->next_data_transfer_handle = htole32(next_data_transfer_handle);
+ response->transfer_flag = transfer_flag;
+ memcpy(response->fru_record_table_data, fru_record_table_data.data(),
+ fru_record_table_data.size());
+
+ uint8_t ret_completion_code = 0;
+ uint32_t ret_next_data_transfer_handle = 0;
+ uint8_t ret_transfer_flag = 0;
+ std::vector<uint8_t> ret_fru_record_table_data(9, 0);
+ size_t ret_fru_record_table_length = 0;
+
+ // Invoke decode get FRU record table response api
+ auto rc = decode_get_fru_record_table_resp(
+ responsePtr, payload_length, &ret_completion_code,
+ &ret_next_data_transfer_handle, &ret_transfer_flag,
+ ret_fru_record_table_data.data(), &ret_fru_record_table_length);
+ ASSERT_EQ(rc, PLDM_SUCCESS);
+ ASSERT_EQ(completion_code, ret_completion_code);
+ ASSERT_EQ(next_data_transfer_handle, ret_next_data_transfer_handle);
+ ASSERT_EQ(transfer_flag, ret_transfer_flag);
+ ASSERT_EQ(0, memcmp(fru_record_table_data.data(),
+ ret_fru_record_table_data.data(),
+ ret_fru_record_table_length));
+ ASSERT_EQ(fru_record_table_data.size(), ret_fru_record_table_length);
+}
+
+TEST(GetFruRecordTable, testBadDecodeResponse)
+{
+ uint8_t completion_code = 0;
+ uint32_t next_data_transfer_handle = 0;
+ uint8_t transfer_flag = PLDM_START_AND_END;
+ std::vector<uint8_t> fru_record_table_data(9, 0);
+ size_t fru_record_table_length = 0;
+
+ std::vector<uint8_t> responseMsg(sizeof(pldm_msg_hdr) +
+ PLDM_GET_FRU_RECORD_TABLE_MIN_RESP_BYTES +
+ fru_record_table_data.size());
+
+ auto responsePtr = reinterpret_cast<pldm_msg*>(responseMsg.data());
+
+ // Payload message is missing
+ auto rc = decode_get_fru_record_table_resp(
+ NULL, 0, &completion_code, &next_data_transfer_handle, &transfer_flag,
+ fru_record_table_data.data(), &fru_record_table_length);
+
+ ASSERT_EQ(rc, PLDM_ERROR_INVALID_DATA);
+
+ // Payload length is invalid
+ rc = decode_get_fru_record_table_resp(
+ responsePtr, 0, &completion_code, &next_data_transfer_handle,
+ &transfer_flag, fru_record_table_data.data(), &fru_record_table_length);
+
+ ASSERT_EQ(rc, PLDM_ERROR_INVALID_LENGTH);
+}