diff mbox series

[V6,10/15] core/pldm: Decode the GetFRURecordTableMetadata request

Message ID 20230829092409.75899-11-clombard@linux.ibm.com
State Accepted
Headers show
Series Complete PLDM responder and enable PLDM support | expand

Commit Message

Christophe Lombard Aug. 29, 2023, 9:24 a.m. UTC
The GetFRURecordTableMetadata command is used to get the FRU Record
Table metadata information that includes the FRU Record major version,
the FRU Record minor version, the size of the largest FRU Record data,
total length of the FRU Record Table, total number of FRU Record Data
structures, and the integrity checksum on the FRU Record Table data.

Add an "IBM, skiboot" FRU Record product requested by the BMC.

Signed-off-by: Christophe Lombard <clombard@linux.ibm.com>
---
 core/pldm/pldm-fru-requests.c | 58 +++++++++++++++++++++
 core/pldm/pldm-responder.c    | 96 +++++++++++++++++++++++++++++++++++
 core/pldm/pldm.h              |  3 ++
 3 files changed, 157 insertions(+)
diff mbox series

Patch

diff --git a/core/pldm/pldm-fru-requests.c b/core/pldm/pldm-fru-requests.c
index ab517e90f..fa4764b17 100644
--- a/core/pldm/pldm-fru-requests.c
+++ b/core/pldm/pldm-fru-requests.c
@@ -14,6 +14,9 @@ 
 static void *fru_record_table;
 static size_t fru_record_length;
 
+static void *local_fru_record_table;
+static size_t local_fru_table_length;
+
 static bool fru_ready;
 static char *bmc_version;
 
@@ -211,6 +214,61 @@  out:
 	return rc;
 }
 
+#define RECORD_SET_ID 100
+
+void pldm_fru_set_local_table(uint32_t *table_length,
+			      uint16_t *total_record_set_identifiers,
+			      uint16_t *total_table_records)
+{
+	struct pldm_fru_record_data_format *record;
+	struct pldm_fru_record_tlv *fru_tlv;
+	size_t fru_table_size, record_size;
+	char fru_product[] = "IBM, skiboot";
+
+	if (local_fru_record_table) {
+		*table_length = local_fru_table_length;
+		*total_record_set_identifiers =  1;
+		*total_table_records = 1;
+		return;
+	}
+
+	/* allocate fru table */
+	fru_table_size = sizeof(struct pldm_fru_record_data_format) +
+			 sizeof(struct pldm_fru_record_tlv) +
+			 strlen(fru_product);
+	local_fru_record_table = zalloc(fru_table_size);
+	if (!local_fru_record_table) {
+		prlog(PR_ERR, "%s: failed to allocate fru record table\n",
+			      __func__);
+		return;
+	}
+
+	/* fill fru record data */
+	record = (struct pldm_fru_record_data_format *)local_fru_record_table;
+	record->record_set_id = htole16(RECORD_SET_ID);
+	record->record_type = PLDM_FRU_RECORD_TYPE_GENERAL;
+	record->num_fru_fields = 1;
+	record->encoding_type = PLDM_FRU_ENCODING_ASCII;
+
+	/* to start, set the size as the start of the TLV structs */
+	record_size = offsetof(struct pldm_fru_record_data_format, tlvs);
+
+	/* TLVs data */
+	fru_tlv = (struct pldm_fru_record_tlv *)(local_fru_record_table + record_size);
+	fru_tlv->type = PLDM_FRU_FIELD_TYPE_OTHER;
+	fru_tlv->length = strlen(fru_product);
+	memcpy(fru_tlv->value, fru_product, fru_tlv->length);
+
+	/* increment record_size by total size of this TLV */
+	record_size += (offsetof(struct pldm_fru_record_tlv, value) + fru_tlv->length);
+
+	*table_length = record_size;
+	*total_record_set_identifiers =  1;
+	*total_table_records = 1;
+
+	local_fru_table_length = *table_length;
+}
+
 int pldm_fru_init(void)
 {
 	int rc;
diff --git a/core/pldm/pldm-responder.c b/core/pldm/pldm-responder.c
index 3eba2e9be..3ab813f36 100644
--- a/core/pldm/pldm-responder.c
+++ b/core/pldm/pldm-responder.c
@@ -10,6 +10,7 @@ 
 #include <stdio.h>
 #include <string.h>
 #include <debug_descriptor.h>
+#include <libpldm/fru.h>
 #include <libpldm/platform.h>
 #include <libpldm/platform_oem_ibm.h>
 #include <libpldm/state_set.h>
@@ -946,6 +947,97 @@  static struct pldm_cmd pldm_platform_get_pdr = {
 	.handler = platform_get_pdr_handle,
 };
 
+/*
+ * PLDM Fru commands support
+ */
+static struct pldm_type pldm_fru_type = {
+	.name = "fru",
+	.pldm_type_id = PLDM_FRU,
+};
+
+/* currently we support version 1.0 of fru table */
+#define SUPPORTED_FRU_VERSION_MAJOR 1
+#define SUPPORTED_FRU_VERSION_MINOR 0
+
+/* Used by the metadata request handler for the value of
+ * FRUTableMaximumSize
+ * 0 means SetFRURecordTable command is not supported (see DSP 0257
+ * v1.0.0 Table 9)
+ */
+#define FRU_TABLE_MAX_SIZE_UNSUPPORTED 0
+
+/*
+ * GetFRURecordTableMetadata (0X01)
+ * The GetFRURecordTableMetadata command is used to get the FRU Record
+ * Table metadata information that includes the FRU Record major
+ * version, the FRU Record minor version, the size of the largest FRU
+ * Record data, total length of the FRU Record Table, total number of
+ * FRU Record Data structures, and the integrity checksum on the FRU
+ * Record Table data.
+ */
+static int fru_get_record_table_metadata_handler(const struct pldm_rx_data *rx)
+{
+	size_t data_size = PLDM_MSG_SIZE(struct pldm_get_fru_record_table_metadata_resp);
+	uint16_t total_record_set_identifiers, total_table_records;
+	uint32_t fru_table_length;
+	struct pldm_tx_data *tx;
+	int rc;
+
+	/*
+	 * GetFRURecordTableMetadata requests
+	 * don't have any payload, so no need to decode them
+	 */
+
+	/* add specific fru record */
+	pldm_fru_set_local_table(&fru_table_length,
+				 &total_record_set_identifiers,
+				 &total_table_records);
+
+	/* create a PLDM response message for GetFRURecordTableMetadata */
+	tx = zalloc(sizeof(struct pldm_tx_data) + data_size);
+	if (!tx)
+		return OPAL_NO_MEM;
+	tx->data_size = data_size;
+	tx->tag_owner = true;
+	tx->msg_tag = rx->msg_tag;
+
+	rc = encode_get_fru_record_table_metadata_resp(
+				rx->hdrinf.instance,
+				PLDM_SUCCESS,
+				SUPPORTED_FRU_VERSION_MAJOR,
+				SUPPORTED_FRU_VERSION_MINOR,
+				FRU_TABLE_MAX_SIZE_UNSUPPORTED,
+				fru_table_length,
+				total_record_set_identifiers,
+				total_table_records,
+				0, // checksum, not calculated
+				(struct pldm_msg *)tx->data);
+	if (rc != PLDM_SUCCESS) {
+		prlog(PR_ERR, "Encode GetFRURecordTableMetadata Error, rc: %d\n", rc);
+		cc_resp(rx, rx->hdrinf.pldm_type,
+			rx->hdrinf.command, PLDM_ERROR);
+		free(tx);
+		return OPAL_PARAMETER;
+	}
+
+	/* send PLDM message over MCTP */
+	rc = pldm_mctp_message_tx(tx);
+	if (rc) {
+		prlog(PR_ERR, "Failed to send GetFRURecordTableMetadata response, rc = %d\n", rc);
+		free(tx);
+		return OPAL_HARDWARE;
+	}
+
+	free(tx);
+	return OPAL_SUCCESS;
+}
+
+static struct pldm_cmd pldm_fru_get_record_table_metadata = {
+	.name = "PLDM_GET_FRU_RECORD_TABLE_METADATA",
+	.pldm_cmd_id = PLDM_GET_FRU_RECORD_TABLE_METADATA,
+	.handler = fru_get_record_table_metadata_handler,
+};
+
 int pldm_responder_handle_request(struct pldm_rx_data *rx)
 {
 	const struct pldm_type *type;
@@ -994,5 +1086,9 @@  int pldm_responder_init(void)
 	add_cmd(&pldm_platform_type, &pldm_platform_set_state_effecter_states);
 	add_cmd(&pldm_platform_type, &pldm_platform_get_pdr);
 
+	/* Register fru commands we'll respond to - DSP0257 */
+	add_type(&pldm_fru_type);
+	add_cmd(&pldm_fru_type, &pldm_fru_get_record_table_metadata);
+
 	return OPAL_SUCCESS;
 }
diff --git a/core/pldm/pldm.h b/core/pldm/pldm.h
index df38ce5fb..bc8782466 100644
--- a/core/pldm/pldm.h
+++ b/core/pldm/pldm.h
@@ -80,6 +80,9 @@  int pldm_file_io_write_file(uint32_t file_handle, uint32_t pos,
 int pldm_file_io_init(void);
 
 int pldm_fru_get_bmc_version(void *bv, int len);
+void pldm_fru_set_local_table(uint32_t *table_length,
+			      uint16_t *total_record_set_identifiers,
+			      uint16_t *total_table_records);
 int pldm_fru_init(void);
 
 int pldm_bios_find_lid_by_attr_name(const char *name, char **lid);