[Skiboot] [PATCH V6 10/21] core/pldm: PLDM for Platform Monitoring and Control Specification
Abhishek SIngh Tomar
abhishek at linux.ibm.com
Fri Sep 30 01:14:09 AEST 2022
On Tue, Sep 13, 2022 at 12:26:54PM +0200, Christophe Lombard wrote:
> This specification defines the functions and data structures used for
> discovering, describing, initializing, and accessing sensors and effecters
> within the management controllers and management devices of a platform
> management subsystem using PLDM messaging.
>
> A PDR (Platform Descriptor Record) is a set of data that is used to
> provide semantic information about sensors, effecters, monitored or
> controller entities, and functions and services within a PLDM
> implementation.
> PDRs are mostly used to support PLDM monitoring and control and platform
> events.
>
> The PDRs for a PLDM subsystem are collected into a single, central PDR
> Repository. A central repository provides a single place from which PDR
> information can be retrieved.
>
> The GetPDR command is used to retrieve individual PDRs from a PDR
> Repository. The record is identified by the PDR recordHandle value that is
> passed in the request.
>
> The patch dump all the PDRs within a PDR Repository.
>
> Signed-off-by: Christophe Lombard <clombard at linux.vnet.ibm.com>
Rviewed-by: Abhishek Singh Tomar <abhishek at linux.ibm.com>
> ---
> core/pldm/Makefile.inc | 3 +
> core/pldm/pldm-base-requests.c | 67 ++++++++
> core/pldm/pldm-mctp.c | 16 ++
> core/pldm/pldm-platform-requests.c | 254 +++++++++++++++++++++++++++++
> core/pldm/pldm.h | 10 ++
> 5 files changed, 350 insertions(+)
> create mode 100644 core/pldm/pldm-base-requests.c
> create mode 100644 core/pldm/pldm-platform-requests.c
>
> diff --git a/core/pldm/Makefile.inc b/core/pldm/Makefile.inc
> index a9b3b7e6..04c4c51b 100644
> --- a/core/pldm/Makefile.inc
> +++ b/core/pldm/Makefile.inc
> @@ -7,7 +7,10 @@ SUBDIRS += $(PLDM_DIR)
> CPPFLAGS += -I$(SRC)/pldm/libpldm/
> CPPFLAGS += -I$(SRC)/pldm/ibm/libpldm/
>
> +CFLAGS_$(PLDM_DIR)/pldm-platform-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 = $(PLDM_DIR)/built-in.a
> $(PLDM): $(PLDM_OBJS:%=$(PLDM_DIR)/%)
> diff --git a/core/pldm/pldm-base-requests.c b/core/pldm/pldm-base-requests.c
> new file mode 100644
> index 00000000..454bfb1b
> --- /dev/null
> +++ b/core/pldm/pldm-base-requests.c
> @@ -0,0 +1,67 @@
> +// SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
> +// Copyright 2022 IBM Corp.
> +
> +#define pr_fmt(fmt) "PLDM: " fmt
> +
> +#include <cpu.h>
> +#include <opal.h>
> +#include <stdio.h>
> +#include <string.h>
> +#include <inttypes.h>
> +#include <pldm/libpldm/base.h>
> +#include "pldm.h"
> +
> +static uint8_t bmc_tid = -1;
> +
> +uint8_t pldm_base_get_bmc_tid(void)
> +{
> + return bmc_tid;
> +}
> +
> +/*
> + * Create a PLDM request message for GetTID.
> + */
> +int pldm_base_get_tid_req(void)
> +{
> + char request_msg[PKT_SIZE(0)]; /* the command doesn't have a message payload */
> + size_t response_len, payload_len;
> + void *response_msg;
> + int rc;
> +
> + struct pldm_get_tid_resp response;
> +
> + /* Encode the get tid request */
> + rc = encode_get_tid_req(DEFAULT_INSTANCE_ID,
> + (struct pldm_msg *)request_msg);
> + if (rc != PLDM_SUCCESS) {
> + prlog(PR_ERR, "Encode GetTID 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: GetTID, rc: %d\n", rc);
> + return rc;
> + }
> +
> + /* Decode the message */
> + payload_len = response_len - sizeof(struct pldm_msg_hdr);
> +
> + rc = decode_get_tid_resp(response_msg, payload_len,
> + &response.completion_code,
> + &response.tid);
> + if ((rc != PLDM_SUCCESS) || (response.completion_code != PLDM_SUCCESS)) {
> + prlog(PR_ERR, "Decode GetTID Error, rc: %d, cc: %d\n",
> + rc, response.completion_code);
> + free(response_msg);
> + return OPAL_PARAMETER;
> + }
> +
> + prlog(PR_INFO, "BMC's TID is %d\n", response.tid);
> + bmc_tid = response.tid;
> + free(response_msg);
> +
> + return OPAL_SUCCESS;
> +}
> diff --git a/core/pldm/pldm-mctp.c b/core/pldm/pldm-mctp.c
> index c7d7bb3b..a351a340 100644
> --- a/core/pldm/pldm-mctp.c
> +++ b/core/pldm/pldm-mctp.c
> @@ -113,6 +113,8 @@ int pldm_mctp_init(uint8_t mode)
> {
> int rc;
>
> + prlog(PR_NOTICE, "%s - Getting PLDM data\n", __func__);
> +
> /* MCTP Binding */
> rc = ast_mctp_init(mode, message_rx);
> if (rc) {
> @@ -130,6 +132,18 @@ int pldm_mctp_init(uint8_t mode)
> /* Requester implementation */
> pldm_requester_init();
>
> + /* Get BMC tid */
> + rc = pldm_base_get_tid_req();
> + if (rc) {
> + prlog(PR_ERR, "Failed to retrieve BMC Tid\n");
> + goto out;
> + }
> +
> + /* Get PDRs data */
> + rc = pldm_platform_init();
> + if (rc)
> + prlog(PR_ERR, "Failed to retrieve Data Records\n");
> +
> out:
> prlog(PR_NOTICE, "%s - done, rc: %d\n", __func__, rc);
> return rc;
> @@ -137,5 +151,7 @@ out:
>
> void pldm_mctp_exit(void)
> {
> + pldm_platform_exit();
> +
> ast_mctp_exit();
> }
> diff --git a/core/pldm/pldm-platform-requests.c b/core/pldm/pldm-platform-requests.c
> new file mode 100644
> index 00000000..965820c8
> --- /dev/null
> +++ b/core/pldm/pldm-platform-requests.c
> @@ -0,0 +1,254 @@
> +// SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
> +// Copyright 2022 IBM Corp.
> +
> +#define pr_fmt(fmt) "PLDM: " fmt
> +
> +#include <cpu.h>
> +#include <opal.h>
> +#include <stdio.h>
> +#include <string.h>
> +#include <timebase.h>
> +#include <inttypes.h>
> +#include <pldm/libpldm/entity.h>
> +#include <pldm/libpldm/state_set.h>
> +#include <pldm/libpldm/platform.h>
> +#include "pldm.h"
> +
> +#define NO_MORE_PDR_HANDLES 0
> +
> +static pldm_pdr *pdrs_repo;
> +static bool pdr_ready;
> +
> +struct pldm_pdrs {
> + uint32_t record_hndl;
> + bool done;
> + int rc;
> +};
> +
> +static void pdr_init_complete(bool success)
> +{
> + /* Read not successful, error out and free the buffer */
> + if (!success) {
> + pdr_ready = false;
> +
> + pldm_pdr_destroy(pdrs_repo);
> + return;
> + }
> +
> + /* Mark ready */
> + pdr_ready = true;
> +}
> +
> +struct get_pdr_response {
> + uint8_t completion_code;
> + uint32_t next_record_hndl;
> + uint32_t next_data_transfer_hndl;
> + uint8_t transfer_flag;
> + uint16_t resp_cnt;
> + uint8_t *record_data;
> + size_t record_data_length;
> + uint8_t transfer_crc;
> +};
> +
> +static int encode_and_queue_get_pdr_req(struct pldm_pdrs *pdrs);
> +
> +static void get_pdr_req_complete(struct pldm_rx_data *rx,
> + void *data)
> +{
> + struct pldm_pdrs *pdrs = (struct pldm_pdrs *)data;
> + uint32_t record_hndl = pdrs->record_hndl;
> + size_t payload_len;
> + int rc, i;
> +
> + struct get_pdr_response response;
> +
> + prlog(PR_DEBUG, "%s - record_hndl: %d\n", __func__, record_hndl);
> +
> + /* Decode the message twice; the first time, the payload buffer
> + * will be null so that the decoder will simply tell us how big
> + * the buffer should be. Then we create a suitable payload
> + * buffer and call the decoder again, this time with the real
> + * buffer so that it can fill it with data from the message.
> + *
> + * transfer_crc is not used in case of PLDM_START_AND_END.
> + */
> + payload_len = rx->msg_len - sizeof(struct pldm_msg_hdr);
> + response.record_data_length = 0;
> + response.record_data = NULL;
> +
> + for (i = 0; i < 2; i++) {
> + rc = decode_get_pdr_resp(
> + rx->msg, payload_len,
> + &response.completion_code,
> + &response.next_record_hndl,
> + &response.next_data_transfer_hndl,
> + &response.transfer_flag,
> + &response.resp_cnt,
> + response.record_data,
> + response.record_data_length,
> + &response.transfer_crc);
> +
> + if (rc != PLDM_SUCCESS || response.completion_code != PLDM_SUCCESS) {
> + /* Message decoding failed */
> + prlog(PR_ERR, "Decode GetPDRResp Error (rc: %d, cc: %d)\n",
> + rc, response.completion_code);
> +
> + /* BMC is not ready, try again */
> + if (response.completion_code == PLDM_ERROR_NOT_READY) {
> + time_wait_ms(500);
> + encode_and_queue_get_pdr_req(pdrs);
> + return;
> + }
> +
> + pdrs->rc = OPAL_PARAMETER;
> + pdrs->done = true;
> + return;
> + }
> +
> + if (response.record_data == NULL) {
> + response.record_data_length = response.resp_cnt;
> + response.record_data = zalloc(response.resp_cnt);
> + }
> + }
> +
> + /* we do not support multipart transfer */
> + if (response.transfer_flag != PLDM_START_AND_END)
> + prlog(PR_ERR, "Transfert GetPDRResp not complete, transfer_flag: %d\n",
> + response.transfer_flag);
> +
> + prlog(PR_DEBUG, "%s - record_hndl: %d, next_record_hndl: %d, resp_cnt: %d\n",
> + __func__, record_hndl,
> + response.next_record_hndl,
> + response.resp_cnt);
> +
> + /* Add a PDR record to a PDR repository */
> + pldm_pdr_add(pdrs_repo,
> + response.record_data,
> + response.resp_cnt,
> + record_hndl,
> + false);
> +
> + free(response.record_data);
> +
> + if (response.next_record_hndl != NO_MORE_PDR_HANDLES) {
> + pdrs->record_hndl = response.next_record_hndl;
> + encode_and_queue_get_pdr_req(pdrs);
> + } else {
> + pdr_init_complete(true);
> + pdrs->done = true;
> + pdrs->rc = OPAL_SUCCESS;
> + prlog(PR_DEBUG, "%s - done\n", __func__);
> + }
> +}
> +
> +/*
> + * Send/receive a PLDM GetPDR stateEffecter request message
> + * Get platform descriptor records.
> + *
> + * pldmtool platform GetPDR -t stateEffecter
> + * ...
> + * {
> + * "nextRecordHandle": 138,
> + * "responseCount": 30,
> + * "recordHandle": 137,
> + * "PDRHeaderVersion": 1,
> + * "PDRType": "State Effecter PDR",
> + * "recordChangeNumber": 0,
> + * "dataLength": 20,
> + * "PLDMTerminusHandle": 1,
> + * "effecterID": 43,
> + * "entityType": "[Physical] System chassis (main enclosure)",
> + * ...
> + * "Off-Soft Graceful(9)"
> + * }
> + * ...
> + */
> +static int encode_and_queue_get_pdr_req(struct pldm_pdrs *pdrs)
> +{
> + char request_msg[PKT_SIZE(struct pldm_get_pdr_req)];
> + uint32_t record_hndl = pdrs->record_hndl;
> + int rc;
> +
> + struct pldm_get_pdr_req pdr_req = {
> + .record_handle = record_hndl, /* record change number (0 for first request) */
> + .data_transfer_handle = 0, /* (0 if transfer op is FIRSTPART) */
> + .transfer_op_flag = PLDM_GET_FIRSTPART, /* transfer op flag */
> + .request_count = SHRT_MAX, /* Don't limit the size of the PDR */
> + .record_change_number = 0 /* record change number (0 for first request) */
> + };
> +
> + prlog(PR_DEBUG, "%s - record_hndl: %d\n", __func__, record_hndl);
> +
> + /* Encode the get_PDR request */
> + rc = encode_get_pdr_req(DEFAULT_INSTANCE_ID,
> + pdr_req.record_handle,
> + pdr_req.data_transfer_handle,
> + pdr_req.transfer_op_flag,
> + pdr_req.request_count,
> + pdr_req.record_change_number,
> + (struct pldm_msg *)request_msg,
> + PLDM_GET_PDR_REQ_BYTES);
> + if (rc != PLDM_SUCCESS) {
> + prlog(PR_ERR, "Encode GetPDRReq Error, rc: %d\n", rc);
> + pdrs->done = true;
> + pdrs->rc = OPAL_PARAMETER;
> + return OPAL_PARAMETER;
> + }
> +
> + /* Queue the first getpdr request */
> + rc = pldm_requester_queue(request_msg, sizeof(request_msg),
> + get_pdr_req_complete, pdrs);
> + if (rc) {
> + prlog(PR_ERR, "Communication Error, req: GetPDRReq, rc: %d\n", rc);
> + pdrs->done = true;
> + pdrs->rc = OPAL_PARAMETER;
> + }
> +
> + return rc;
> +}
> +
> +static int pdrs_init(void)
> +{
> + struct pldm_pdrs pdrs;
> + int rc;
> +
> + /* make a new PDR repository */
> + pdrs_repo = pldm_pdr_init();
> +
> + /* collect all PDrs into a PDR Repository */
> + pdrs.record_hndl = 0;
> + rc = encode_and_queue_get_pdr_req(&pdrs);
> + if (rc)
> + return rc;
> +
> + /* wait for the end of pdrs received */
> + do {
> + time_wait_ms(5);
> + } while (!pdrs.done);
> +
> + return pdrs.rc;
> +}
> +
> +int pldm_platform_init(void)
> +{
> + int rc;
> +
> + /* retrieve all PDRs */
> + rc = pdrs_init();
> + if (rc) {
> + pdr_init_complete(false);
> + prlog(PR_ERR, "%s - done, rc: %d\n", __func__, rc);
> + return rc;
> + }
> +
> + pdr_init_complete(true);
> + prlog(PR_DEBUG, "%s - done\n", __func__);
> +
> + return OPAL_SUCCESS;
> +}
> +
> +void pldm_platform_exit(void)
> +{
> + if (pdr_ready)
> + pldm_pdr_destroy(pdrs_repo);
> +}
> diff --git a/core/pldm/pldm.h b/core/pldm/pldm.h
> index fa7a80de..d035655f 100644
> --- a/core/pldm/pldm.h
> +++ b/core/pldm/pldm.h
> @@ -6,6 +6,7 @@
> #define __COREPLDM_H__
>
> #include <pldm/libpldm/base.h>
> +#include <pldm/libpldm/utils.h>
> #include <pldm.h>
>
> /* Common support */
> @@ -28,6 +29,9 @@ void printbuf(const char *name, const char *msg, int len);
>
> #define PKT_SIZE(x) (sizeof(struct pldm_msg_hdr) + sizeof(x))
>
> +/* For all of the encode functions just pass in a default ID (0x00) */
> +#define DEFAULT_INSTANCE_ID 0
> +
> struct pldm_rx_data {
> struct pldm_header_info hdrinf; /* parsed message header */
>
> @@ -43,6 +47,12 @@ int pldm_responder_handle_request(struct pldm_rx_data *rx);
> int pldm_responder_init(void);
>
> /* Requester support */
> +uint8_t pldm_base_get_bmc_tid(void);
> +int pldm_base_get_tid_req(void);
> +
> +int pldm_platform_init(void);
> +void pldm_platform_exit(void);
> +
> int pldm_requester_handle_response(struct pldm_rx_data *rx);
> int pldm_requester_queue(void *request_msg, size_t request_len,
> void (*complete)(struct pldm_rx_data *rx, void *data),
> --
> 2.37.3
>
> _______________________________________________
> Skiboot mailing list
> Skiboot at lists.ozlabs.org
> https://lists.ozlabs.org/listinfo/skiboot
More information about the Skiboot
mailing list