[V6,18/21] core/pldm: PLDM for File-IO operations

The ibm/libpldm library implements IBM OEM commands support for PLDM and
specially encode and decode APIs for in-band readFile and writeFile
commands.

The GetFileTable request message is used to retrieve the file table which
contains the list of lid files available and their attributes.

Reviewed-by: Abhishek Singh Tomar <abhishek at linux.ibm.com>
Signed-off-by: Christophe Lombard <clombard@linux.vnet.ibm.com>
---
 core/pldm/Makefile.inc            |   1 +
 core/pldm/pldm-file-io-requests.c | 142 ++++++++++++++++++++++++++++++
 core/pldm/pldm-mctp.c             |   9 +-
 core/pldm/pldm.h                  |   2 +
 4 files changed, 153 insertions(+), 1 deletion(-)
 create mode 100644 core/pldm/pldm-file-io-requests.c

On Tue, Sep 13, 2022 at 12:27:02PM +0200, Christophe Lombard wrote:
> The ibm/libpldm library implements IBM OEM commands support for PLDM and
> specially encode and decode APIs for in-band readFile and writeFile
> commands.
> 
> The GetFileTable request message is used to retrieve the file table which
> contains the list of lid files available and their attributes.
> 
Reviewed-by: Abhishek Singh Tomar <abhishek@linux.ibm.com>
> Signed-off-by: Christophe Lombard <clombard@linux.vnet.ibm.com>
> ---
>  core/pldm/Makefile.inc            |   1 +
>  core/pldm/pldm-file-io-requests.c | 142 ++++++++++++++++++++++++++++++
>  core/pldm/pldm-mctp.c             |   9 +-
>  core/pldm/pldm.h                  |   2 +
>  4 files changed, 153 insertions(+), 1 deletion(-)
>  create mode 100644 core/pldm/pldm-file-io-requests.c
> 
> diff --git a/core/pldm/Makefile.inc b/core/pldm/Makefile.inc
> index 4d08e371..4e6833eb 100644
> --- a/core/pldm/Makefile.inc
> +++ b/core/pldm/Makefile.inc
> @@ -13,6 +13,7 @@ CFLAGS_$(PLDM_DIR)/pldm-bios-requests.o = -Wno-strict-prototypes
>  PLDM_OBJS = pldm-mctp.o pldm-responder.o pldm-requester.o
>  PLDM_OBJS += pldm-base-requests.o pldm-platform-requests.o
>  PLDM_OBJS += pldm-bios-requests.o pldm-fru-requests.o
> +PLDM_OBJS += pldm-file-io-requests.o
> 
>  PLDM = $(PLDM_DIR)/built-in.a
>  $(PLDM): $(PLDM_OBJS:%=$(PLDM_DIR)/%)
> diff --git a/core/pldm/pldm-file-io-requests.c b/core/pldm/pldm-file-io-requests.c
> new file mode 100644
> index 00000000..5eb260d6
> --- /dev/null
> +++ b/core/pldm/pldm-file-io-requests.c
> @@ -0,0 +1,142 @@
> +// SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
> +// Copyright 2022 IBM Corp.
> +
> +#define pr_fmt(fmt) "PLDM: " fmt
> +
> +#include <opal.h>
> +#include <stdio.h>
> +#include <string.h>
> +#include <inttypes.h>
> +#include <pldm/ibm/libpldm/file_io.h>
> +#include "pldm.h"
> +
> +/* list of lid files available */
> +static void *file_attr_table;
> +static size_t file_attr_length;
> +
> +static bool file_io_ready;
> +
> +static void file_io_init_complete(bool success)
> +{
> +	/* Read not successful, error out and free the buffer */
> +	if (!success) {
> +		file_io_ready = false;
> +
> +		if (file_attr_table != NULL) {
> +			free(file_attr_table);
> +			file_attr_length = 0;
> +		}
> +		return;
> +	}
> +
> +	/* Mark ready */
> +	file_io_ready = true;
> +}
> +
> +/*
> + * Send/receive a PLDM GetFileTable request message.
> + * The file table contains the list of files available and
> + * their attributes.
> + *
> + * Ex:
> + * {
> + *   "FileHandle": "11",
> + *   "FileNameLength": 12,
> + *   "FileName": "81e0066b.lid",
> + *   "FileSize": 589824,
> + *   "FileTraits": 6
> + * },
> + */
> +static int get_file_table_req(void)
> +{
> +	char request_msg[PKT_SIZE(struct pldm_get_file_table_req)];
> +	size_t response_len, payload_len;
> +	uint8_t file_table_data_start_offset;
> +	uint8_t transfer_flag, completion_code;
> +	uint32_t next_transfer_handle;
> +	void *response_msg;
> +	int rc;
> +
> +	struct pldm_get_file_table_req file_table_req = {
> +		.transfer_handle = 0, /* (0 if operation op is FIRSTPART) */
> +		.operation_flag = PLDM_GET_FIRSTPART,
> +		.table_type = PLDM_FILE_ATTRIBUTE_TABLE,
> +	};
> +
> +	prlog(PR_DEBUG, "%s - GetFileReq\n", __func__);
> +
> +	/* Encode the file table request */
> +	rc = encode_get_file_table_req(
> +			DEFAULT_INSTANCE_ID,
> +			file_table_req.transfer_handle,
> +			file_table_req.operation_flag,
> +			file_table_req.table_type,
> +			(struct pldm_msg *)request_msg);
> +	if (rc != PLDM_SUCCESS) {
> +		prlog(PR_ERR, "Encode GetFileReq Error, rc: %d\n", rc);
> +		return OPAL_PARAMETER;
> +	}
> +
> +	/* Send and get the response message bytes */
> +	rc = pldm_requester_queue_and_wait(request_msg, sizeof(request_msg),
> +					   &response_msg, &response_len);
> +	if (rc) {
> +		prlog(PR_ERR, "Communication Error, req: GetFileReq, rc: %d\n", rc);
> +		return rc;
> +	}
> +
> +	/* Decode the message */
> +	payload_len = response_len - sizeof(struct pldm_msg_hdr);
> +	rc = decode_get_file_table_resp(
> +				response_msg,
> +				payload_len,
> +				&completion_code,
> +				&next_transfer_handle,
> +				&transfer_flag,
> +				&file_table_data_start_offset,
> +				&file_attr_length);
> +	if (rc != PLDM_SUCCESS || completion_code != PLDM_SUCCESS) {
> +		prlog(PR_ERR, "Decode GetFileResp Error, rc: %d, cc: %d\n",
> +			      rc, completion_code);
> +		free(response_msg);
> +		return OPAL_PARAMETER;
> +	}
> +
> +	/* we do not support multipart transfer */
> +	if ((next_transfer_handle != PLDM_GET_NEXTPART) ||
> +	    (transfer_flag != PLDM_START_AND_END)) {
> +		prlog(PR_ERR, "Transfert GetFileResp not complete, "
> +			      "transfer_hndl: %d, transfer_flag: %d\n",
> +			      next_transfer_handle,
> +			      transfer_flag);
> +	}
> +
> +	file_attr_table = zalloc(file_attr_length);
> +	memcpy(file_attr_table,
> +	       ((struct pldm_msg *)response_msg)->payload +
> +	       file_table_data_start_offset,
> +	       file_attr_length);
> +
> +	free(response_msg);
> +
> +	return OPAL_SUCCESS;
> +}
> +
> +int pldm_file_io_init(void)
> +{
> +	int rc;
> +
> +	/* PLDM GetFileTable request */
> +	rc = get_file_table_req();
> +	if (rc)
> +		goto err;
> +
> +	file_io_init_complete(true);
> +	prlog(PR_DEBUG, "%s - done\n", __func__);
> +
> +	return OPAL_SUCCESS;
> +
> +err:
> +	file_io_init_complete(false);
> +	return rc;
> +}
> diff --git a/core/pldm/pldm-mctp.c b/core/pldm/pldm-mctp.c
> index 542edc27..1d1d1b37 100644
> --- a/core/pldm/pldm-mctp.c
> +++ b/core/pldm/pldm-mctp.c
> @@ -155,8 +155,15 @@ int pldm_mctp_init(uint8_t mode)
> 
>  	/* Get Fru data */
>  	rc = pldm_fru_init();
> -	if (rc)
> +	if (rc) {
>  		prlog(PR_ERR, "Failed to retrieve Fru data\n");
> +		goto out;
> +	}
> +
> +	/* Get FILE IO data */
> +	rc = pldm_file_io_init();
> +	if (rc)
> +		prlog(PR_ERR, "Failed to retrieve File io data\n");
> 
>  out:
>  	prlog(PR_NOTICE, "%s - done, rc: %d\n", __func__, rc);
> diff --git a/core/pldm/pldm.h b/core/pldm/pldm.h
> index 5ee53cb9..49435fdd 100644
> --- a/core/pldm/pldm.h
> +++ b/core/pldm/pldm.h
> @@ -47,6 +47,8 @@ int pldm_responder_handle_request(struct pldm_rx_data *rx);
>  int pldm_responder_init(void);
> 
>  /* Requester support */
> +int pldm_file_io_init(void);
> +
>  int pldm_fru_get_bmc_version(void *bv);
>  int pldm_fru_init(void);
> 
> -- 
> 2.37.3
> 
> _______________________________________________
> Skiboot mailing list
> Skiboot@lists.ozlabs.org
> https://lists.ozlabs.org/listinfo/skiboot