Decode APIs now accept const struct pldm_msg *msg
All the decode_xxx APIs were changed to accept the complete pldm_msg
instead of working with just a specific member (payload) making it
consistent with the encode_xxx APIs.
Following changes were made through out the code,
- decode_xxx now requires to send the const struct pldm_msg *msg
instead of a const uint8_t *msg.
- Within the decode_xxx function the payload is extracted and used
accordingly.
- All the calls made to decode_xxx APIs have been modified to now
pass the pointer to pldm_msg_hdr (struct pldm_msg *msg).
- The test code was modified to now pass the appropriate data
to all the encode_xxx APIs.
Change-Id: I16a3f6e554ea2c9fa44d55dc8f21f65022bd983a
Signed-off-by: Zahed Hossain <zahzahed@in.ibm.com>
diff --git a/libpldm/base.c b/libpldm/base.c
index 1c1809e..36df1b0 100644
--- a/libpldm/base.c
+++ b/libpldm/base.c
@@ -126,7 +126,7 @@
return PLDM_SUCCESS;
}
-int decode_get_commands_req(const uint8_t *msg, size_t payload_length,
+int decode_get_commands_req(const struct pldm_msg *msg, size_t payload_length,
uint8_t *type, ver32_t *version)
{
if (msg == NULL || type == NULL || version == NULL) {
@@ -138,7 +138,7 @@
}
struct pldm_get_commands_req *request =
- (struct pldm_get_commands_req *)msg;
+ (struct pldm_get_commands_req *)msg->payload;
*type = request->type;
*version = request->version;
return PLDM_SUCCESS;
@@ -172,7 +172,7 @@
return PLDM_SUCCESS;
}
-int decode_get_types_resp(const uint8_t *msg, size_t payload_length,
+int decode_get_types_resp(const struct pldm_msg *msg, size_t payload_length,
uint8_t *completion_code, bitfield8_t *types)
{
if (msg == NULL || types == NULL || completion_code == NULL) {
@@ -184,7 +184,7 @@
}
struct pldm_get_types_resp *response =
- (struct pldm_get_types_resp *)msg;
+ (struct pldm_get_types_resp *)msg->payload;
*completion_code = response->completion_code;
if (PLDM_SUCCESS != *completion_code) {
return PLDM_SUCCESS;
@@ -195,7 +195,7 @@
return PLDM_SUCCESS;
}
-int decode_get_commands_resp(const uint8_t *msg, size_t payload_length,
+int decode_get_commands_resp(const struct pldm_msg *msg, size_t payload_length,
uint8_t *completion_code, bitfield8_t *commands)
{
if (msg == NULL || commands == NULL || completion_code == NULL) {
@@ -207,7 +207,7 @@
}
struct pldm_get_commands_resp *response =
- (struct pldm_get_commands_resp *)msg;
+ (struct pldm_get_commands_resp *)msg->payload;
*completion_code = response->completion_code;
if (PLDM_SUCCESS != *completion_code) {
return PLDM_SUCCESS;
@@ -278,7 +278,7 @@
return PLDM_SUCCESS;
}
-int decode_get_version_req(const uint8_t *msg, size_t payload_length,
+int decode_get_version_req(const struct pldm_msg *msg, size_t payload_length,
uint32_t *transfer_handle, uint8_t *transfer_opflag,
uint8_t *type)
{
@@ -288,14 +288,14 @@
}
struct pldm_get_version_req *request =
- (struct pldm_get_version_req *)msg;
+ (struct pldm_get_version_req *)msg->payload;
*transfer_handle = le32toh(request->transfer_handle);
*transfer_opflag = request->transfer_opflag;
*type = request->type;
return PLDM_SUCCESS;
}
-int decode_get_version_resp(const uint8_t *msg, size_t payload_length,
+int decode_get_version_resp(const struct pldm_msg *msg, size_t payload_length,
uint8_t *completion_code,
uint32_t *next_transfer_handle,
uint8_t *transfer_flag, ver32_t *version)
@@ -310,7 +310,7 @@
}
struct pldm_get_version_resp *response =
- (struct pldm_get_version_resp *)msg;
+ (struct pldm_get_version_resp *)msg->payload;
*completion_code = response->completion_code;
if (PLDM_SUCCESS != *completion_code) {
return PLDM_SUCCESS;
diff --git a/libpldm/base.h b/libpldm/base.h
index 6a044ad..f15ca7e 100644
--- a/libpldm/base.h
+++ b/libpldm/base.h
@@ -221,14 +221,14 @@
/** @brief Decode a GetPLDMTypes response message
*
- * @param[in] msg - Response message payload
+ * @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] types - pointer to array bitfield8_t[8] containing supported
* types (MAX_TYPES/8) = 8), as per DSP0240
* @return pldm_completion_codes
*/
-int decode_get_types_resp(const uint8_t *msg, size_t payload_length,
+int decode_get_types_resp(const struct pldm_msg *msg, size_t payload_length,
uint8_t *completion_code, bitfield8_t *types);
/* GetPLDMCommands */
@@ -248,14 +248,14 @@
/** @brief Decode a GetPLDMCommands response message
*
- * @param[in] msg - Response message payload
+ * @param[in] msg - Response message
* @param[in] payload_length - Length of reponse message payload
* @param[out] completion_code - Pointer to response msg's PLDM completion code
* @param[in] commands - pointer to array bitfield8_t[32] containing supported
* commands (PLDM_MAX_CMDS_PER_TYPE/8) = 32), as per DSP0240
* @return pldm_completion_codes
*/
-int decode_get_commands_resp(const uint8_t *msg, size_t payload_length,
+int decode_get_commands_resp(const struct pldm_msg *msg, size_t payload_length,
uint8_t *completion_code, bitfield8_t *commands);
/* GetPLDMVersion */
@@ -280,14 +280,14 @@
/** @brief Decode a GetPLDMVersion response message
*
- * @param[in] msg - Response message payload
+ * @param[in] msg - Response message
* @param[in] payload_length - Length of reponse message payload
* @param[out] completion_code - Pointer to response msg's PLDM completion code
* @param[out] next_transfer_handle - the next handle for the next part of data
* @param[out] transfer_flag - flag to indicate the part of data
* @return pldm_completion_codes
*/
-int decode_get_version_resp(const uint8_t *msg, size_t payload_length,
+int decode_get_version_resp(const struct pldm_msg *msg, size_t payload_length,
uint8_t *completion_code,
uint32_t *next_transfer_handle,
uint8_t *transfer_flag, ver32_t *version);
@@ -320,7 +320,7 @@
* @param[out] version - Version for PLDM Type
* @return pldm_completion_codes
*/
-int decode_get_commands_req(const uint8_t *msg, size_t payload_length,
+int decode_get_commands_req(const struct pldm_msg *msg, size_t payload_length,
uint8_t *type, ver32_t *version);
/** @brief Create a PLDM response message for GetPLDMCommands
@@ -367,7 +367,7 @@
* @param[out] type - PLDM type for which version is requested
* @return pldm_completion_codes
*/
-int decode_get_version_req(const uint8_t *msg, size_t payload_length,
+int decode_get_version_req(const struct pldm_msg *msg, size_t payload_length,
uint32_t *transfer_handle, uint8_t *transfer_opflag,
uint8_t *type);
diff --git a/libpldm/bios.c b/libpldm/bios.c
index 358fb38..9664318 100644
--- a/libpldm/bios.c
+++ b/libpldm/bios.c
@@ -55,7 +55,7 @@
return PLDM_SUCCESS;
}
-int decode_get_date_time_resp(const uint8_t *msg, size_t payload_length,
+int decode_get_date_time_resp(const struct pldm_msg *msg, size_t payload_length,
uint8_t *completion_code, uint8_t *seconds,
uint8_t *minutes, uint8_t *hours, uint8_t *day,
uint8_t *month, uint16_t *year)
@@ -71,7 +71,7 @@
}
struct pldm_get_date_time_resp *response =
- (struct pldm_get_date_time_resp *)msg;
+ (struct pldm_get_date_time_resp *)msg->payload;
*completion_code = response->completion_code;
if (PLDM_SUCCESS != *completion_code) {
diff --git a/libpldm/bios.h b/libpldm/bios.h
index cd35651..6f9e42b 100644
--- a/libpldm/bios.h
+++ b/libpldm/bios.h
@@ -47,7 +47,7 @@
/** @brief Decode a GetDateTime response message
*
- * @param[in] msg - Response message payload
+ * @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] seconds - Seconds in BCD format
@@ -58,7 +58,7 @@
* @param[out] year - year in BCD format
* @return pldm_completion_codes
*/
-int decode_get_date_time_resp(const uint8_t *msg, size_t payload_length,
+int decode_get_date_time_resp(const struct pldm_msg *msg, size_t payload_length,
uint8_t *completion_code, uint8_t *seconds,
uint8_t *minutes, uint8_t *hours, uint8_t *day,
uint8_t *month, uint16_t *year);
diff --git a/libpldm/platform.c b/libpldm/platform.c
index d0929d9..f9c8351 100644
--- a/libpldm/platform.c
+++ b/libpldm/platform.c
@@ -55,7 +55,7 @@
return PLDM_SUCCESS;
}
-int decode_set_state_effecter_states_resp(const uint8_t *msg,
+int decode_set_state_effecter_states_resp(const struct pldm_msg *msg,
size_t payload_length,
uint8_t *completion_code)
{
@@ -67,12 +67,12 @@
return PLDM_ERROR_INVALID_LENGTH;
}
- *completion_code = msg[0];
+ *completion_code = msg->payload[0];
return PLDM_SUCCESS;
}
-int decode_set_state_effecter_states_req(const uint8_t *msg,
+int decode_set_state_effecter_states_req(const struct pldm_msg *msg,
size_t payload_length,
uint16_t *effecter_id,
uint8_t *comp_effecter_count,
@@ -88,7 +88,7 @@
}
struct pldm_set_state_effecter_states_req *request =
- (struct pldm_set_state_effecter_states_req *)msg;
+ (struct pldm_set_state_effecter_states_req *)msg->payload;
*effecter_id = le16toh(request->effecter_id);
*comp_effecter_count = request->comp_effecter_count;
diff --git a/libpldm/platform.h b/libpldm/platform.h
index 7d25eb3..d29dc8a 100644
--- a/libpldm/platform.h
+++ b/libpldm/platform.h
@@ -117,7 +117,7 @@
/** @brief Decode SetStateEffecterStates request data
*
- * @param[in] msg - Request message payload
+ * @param[in] msg - Request message
* @param[in] payload_length - Length of request message payload
* @param[out] effecter_id - used to identify and access the effecter
* @param[out] comp_effecter_count - number of individual sets of effecter
@@ -133,7 +133,7 @@
* @return pldm_completion_codes
*/
-int decode_set_state_effecter_states_req(const uint8_t *msg,
+int decode_set_state_effecter_states_req(const struct pldm_msg *msg,
size_t payload_length,
uint16_t *effecter_id,
uint8_t *comp_effecter_count,
@@ -166,12 +166,12 @@
struct pldm_msg *msg);
/** @brief Decode SetStateEffecterStates response data
- * @param[in] msg - Request message payload
+ * @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_set_state_effecter_states_resp(const uint8_t *msg,
+int decode_set_state_effecter_states_resp(const struct pldm_msg *msg,
size_t payload_length,
uint8_t *completion_code);
#ifdef __cplusplus