Implement response encode/request decode for ReadFileIntoMemory
The ReadFileIntoMemory command is an OEM command to support large
size transfer from BMC to Host via DMA mechanism.
Change-Id: I416a1af8a4d1ea91a7dffbbb98ae58eeccf6d0ea
Signed-off-by: Tom Joseph <tomjoseph@in.ibm.com>
diff --git a/libpldm/Makefile.am b/libpldm/Makefile.am
index 59da344..d837608 100644
--- a/libpldm/Makefile.am
+++ b/libpldm/Makefile.am
@@ -1,7 +1,11 @@
+nobase_include_HEADERS = \
+ file_io.h
+
libpldmoem_LTLIBRARIES = libpldmoem.la
libpldmoemdir = ${libdir}
libpldmoem_la_SOURCES = \
- base.c
+ base.c \
+ file_io.c
libpldmoem_la_LDFLAGS = \
-version-info 1:0:0 -shared
diff --git a/libpldm/file_io.c b/libpldm/file_io.c
new file mode 100644
index 0000000..426033a
--- /dev/null
+++ b/libpldm/file_io.c
@@ -0,0 +1,53 @@
+#include "file_io.h"
+#include <endian.h>
+#include <string.h>
+
+int decode_read_file_memory_req(const uint8_t *msg, size_t payload_length,
+ uint32_t *file_handle, uint32_t *offset,
+ uint32_t *length, uint64_t *address)
+{
+ if (msg == NULL || file_handle == NULL || offset == NULL ||
+ length == NULL || address == NULL) {
+ return PLDM_ERROR_INVALID_DATA;
+ }
+
+ if (payload_length != PLDM_READ_FILE_MEM_REQ_BYTES) {
+ return PLDM_ERROR_INVALID_LENGTH;
+ }
+
+ *file_handle = le32toh(*((uint32_t *)msg));
+ *offset = le32toh(*((uint32_t *)(msg + sizeof(*file_handle))));
+ *length = le32toh(
+ *((uint32_t *)(msg + sizeof(*file_handle) + sizeof(*offset))));
+ *address = le64toh(*((uint64_t *)(msg + sizeof(*file_handle) +
+ sizeof(*offset) + sizeof(*length))));
+
+ return PLDM_SUCCESS;
+}
+
+int encode_read_file_memory_resp(uint8_t instance_id, uint8_t completion_code,
+ uint32_t length, struct pldm_msg *msg)
+{
+ struct pldm_header_info header = {0};
+ int rc = PLDM_SUCCESS;
+
+ uint8_t *payload = msg->payload;
+ *payload = completion_code;
+
+ header.msg_type = PLDM_RESPONSE;
+ header.instance = instance_id;
+ header.pldm_type = PLDM_IBM_OEM_TYPE;
+ header.command = PLDM_READ_FILE_INTO_MEMORY;
+
+ if ((rc = pack_pldm_header(&header, &(msg->hdr))) > PLDM_SUCCESS) {
+ return rc;
+ }
+
+ if (msg->payload[0] == PLDM_SUCCESS) {
+ uint8_t *dst = msg->payload + sizeof(completion_code);
+ length = htole32(length);
+ memcpy(dst, &length, sizeof(length));
+ }
+
+ return PLDM_SUCCESS;
+}
diff --git a/libpldm/file_io.h b/libpldm/file_io.h
new file mode 100644
index 0000000..c273608
--- /dev/null
+++ b/libpldm/file_io.h
@@ -0,0 +1,64 @@
+#ifndef FILEIO_H
+#define FILEIO_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <stddef.h>
+#include <stdint.h>
+
+#include "base.h"
+
+#define PLDM_IBM_OEM_TYPE 0x3F
+
+/** @brief PLDM Commands in IBM OEM type
+ */
+enum pldm_fileio_commands { PLDM_READ_FILE_INTO_MEMORY = 0x6 };
+
+/** @brief PLDM Command specific codes
+ */
+enum pldm_fileio_completion_codes {
+ PLDM_INVALID_FILE_HANDLE = 0x80,
+ PLDM_DATA_OUT_OF_RANGE = 0x81,
+ PLDM_INVALID_READ_LENGTH = 0x82
+};
+
+#define PLDM_READ_FILE_MEM_REQ_BYTES 20
+#define PLDM_READ_FILE_MEM_RESP_BYTES 5
+
+/* ReadFileIntoMemory */
+
+/** @brief Decode ReadFileIntoMemory commands request data
+ *
+ * @param[in] msg - Pointer to PLDM request message payload
+ * @param[in] payload_length - Length of request payload
+ * @param[out] file_handle - A handle to the file
+ * @param[out] offset - Offset to the file at which the read should begin
+ * @param[out] length - Number of bytes to be read
+ * @param[out] address - Memory address where the file content has to be
+ * written to
+ * @return pldm_completion_codes
+ */
+int decode_read_file_memory_req(const uint8_t *msg, size_t payload_length,
+ uint32_t *file_handle, uint32_t *offset,
+ uint32_t *length, uint64_t *address);
+
+/** @brief Create a PLDM response for ReadFileIntoMemory
+ *
+ * @param[in] instance_id - Message's instance id
+ * @param[in] completion_code - PLDM completion code
+ * @param[in] length - Number of bytes read. This could be less than what the
+ requester asked for.
+ * @param[in,out] msg - Message will be written to this
+ * @return pldm_completion_codes
+ * @note Caller is responsible for memory alloc and dealloc of param 'msg'
+ */
+int encode_read_file_memory_resp(uint8_t instance_id, uint8_t completion_code,
+ uint32_t length, struct pldm_msg *msg);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* FILEIO_H */