From 45f5341f6de16edc7aed082e15e6afd48a664ee1 Mon Sep 17 00:00:00 2001 From: Abner Chang Date: Sun, 2 Apr 2023 09:35:29 +0800 Subject: MdePkg/Include: Add DMTF PLDM Base definitions BZ #4396 This change adds definitions for DMTF PLDM base specification. Spec ref: https://www.dmtf.org/sites/default/files/standards/documents/DSP0240_1.1.0.pdf Signed-off-by: Abner Chang Cc: Michael D Kinney Cc: Liming Gao Cc: Zhiguang Liu Cc: Nickle Wang Cc: Igor Kulchytskyy Cc: Isaac Oram Cc: Abdul Lateef Attar Reviewed-by: Michael D Kinney --- MdePkg/Include/IndustryStandard/Pldm.h | 82 ++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 MdePkg/Include/IndustryStandard/Pldm.h diff --git a/MdePkg/Include/IndustryStandard/Pldm.h b/MdePkg/Include/IndustryStandard/Pldm.h new file mode 100644 index 0000000000..c821f081f8 --- /dev/null +++ b/MdePkg/Include/IndustryStandard/Pldm.h @@ -0,0 +1,82 @@ +/** @file + + The definitions of DMTF Platform Level Data Model (PLDM) + Base Specification. + + Copyright (C) 2023 Advanced Micro Devices, Inc. All rights reserved. + SPDX-License-Identifier: BSD-2-Clause-Patent + + @par Revision Reference: + DMTF Platform Level Data Model (PLDM) Base Specification + Version 1.1.0 + https://www.dmtf.org/sites/default/files/standards/documents/DSP0240_1.1.0.pdf + +**/ + +#ifndef PLDM_H_ +#define PLDM_H_ + +#pragma pack(1) + +#define PLDM_MESSAGE_HEADER_VERSION 0 + +/// +/// General definitions from Platform Level Data Model (PLDM) Base +/// Specification (DMTF DSP0240) +/// +typedef struct { + UINT8 InstanceId : 5; ///< Request instance ID. + UINT8 Reserved : 1; ///< Reserved bit. + UINT8 DatagramBit : 1; ///< used to indicate whether the Instance ID field is + ///< being used for tracking and matching requests and + ///< responses, or just being used for asynchronous + ///< notifications. + UINT8 RequestBit : 1; ///< Request bit. + UINT8 PldmType : 6; ///< PLDM message type. + UINT8 HeaderVersion : 2; ///< Header version. + UINT8 PldmTypeCommandCode; ///< The command code of PLDM message type. +} PLDM_MESSAGE_HEADER; + +typedef PLDM_MESSAGE_HEADER PLDM_REQUEST_HEADER; + +#define PLDM_MESSAGE_HEADER_IS_REQUEST 1 +#define PLDM_MESSAGE_HEADER_IS_DATAGRAM 1 +#define PLDM_MESSAGE_HEADER_INSTANCE_ID_MASK 0x1f + +typedef struct { + PLDM_MESSAGE_HEADER PldmHeader; + UINT8 PldmCompletionCode; ///< PLDM completion of response message. +} PLDM_RESPONSE_HEADER; + +#pragma pack() + +#define PLDM_HEADER_VERSION 0x00 + +#define PLDM_COMPLETION_CODE_SUCCESS 0x00 +#define PLDM_COMPLETION_CODE_ERROR 0x01 +#define PLDM_COMPLETION_CODE_ERROR_INVALID_DATA 0x02 +#define PLDM_COMPLETION_CODE_ERROR_INVALID_LENGTH 0x03 +#define PLDM_COMPLETION_CODE_ERROR_NOT_READY 0x04 +#define PLDM_COMPLETION_CODE_ERROR_UNSUPPORTED_PLDM_CMD 0x05 +#define PLDM_COMPLETION_CODE_ERROR_INVALID_PLDM_TYPE 0x20 +#define PLDM_COMPLETION_CODE_SPECIFIC_START 0x80 +#define PLDM_COMPLETION_CODE_SPECIFIC_END 0xff + +/// +/// Type Code definitions from Platform Level Data Model (PLDM) IDs +/// and Codes Specification (DMTF DSP0245) +/// https://www.dmtf.org/sites/default/files/standards/documents/DSP0245_1.3.0.pdf +/// +#define PLDM_TYPE_MESSAGE_CONTROL_AND_DISCOVERY 0x00 +#define PLDM_TYPE_SMBIOS 0x01 +#define PLDM_TYPE_PLATFORM_MONITORING_AND_CONTROL 0x02 +#define PLDM_TYPE_BIOS_CONTROL_AND_CONFIGURATION 0x03 + +#define PLDM_TRANSFER_FLAG_START 0x01 +#define PLDM_TRANSFER_FLAG_MIDDLE 0x02 +#define PLDM_TRANSFER_FLAG_END 0x04 +#define PLDM_TRANSFER_FLAG_START_AND_END 0x05 + +#define PLDM_TRANSFER_OPERATION_FLAG_GET_NEXT_PART 0x00 +#define PLDM_TRANSFER_OPERATION_FLAG_GET_FIRST_PART 0x01 +#endif // PLDM_H_ -- cgit v1.2.3