public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Chang, Abner" <abner.chang@amd.com>
To: <devel@edk2.groups.io>
Cc: Michael D Kinney <michael.d.kinney@intel.com>,
	Liming Gao <gaoliming@byosoft.com.cn>,
	Zhiguang Liu <zhiguang.liu@intel.com>,
	"Nickle Wang" <nicklew@nvidia.com>,
	Igor Kulchytskyy <igork@ami.com>,
	Isaac Oram <isaac.w.oram@intel.com>,
	Abdul Lateef Attar <AbdulLateef.Attar@amd.com>
Subject: [PATCH] MdePkg/Include: Add DMTF PLDM Base definitions
Date: Sun, 2 Apr 2023 09:51:55 +0800	[thread overview]
Message-ID: <20230402015155.147-1-abner.chang@amd.com> (raw)

From: Abner Chang <abner.chang@amd.com>

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 <abner.chang@amd.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Zhiguang Liu <zhiguang.liu@intel.com>
Cc: Nickle Wang <nicklew@nvidia.com>
Cc: Igor Kulchytskyy <igork@ami.com>
Cc: Isaac Oram <isaac.w.oram@intel.com>
Cc: Abdul Lateef Attar <AbdulLateef.Attar@amd.com>
---
 MdePkg/Include/IndustryStandard/Pldm.h | 81 ++++++++++++++++++++++++++
 1 file changed, 81 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 00000000000..82d65b71874
--- /dev/null
+++ b/MdePkg/Include/IndustryStandard/Pldm.h
@@ -0,0 +1,81 @@
+/**
+  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_
-- 
2.37.1.windows.1


             reply	other threads:[~2023-04-02  1:52 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-02  1:51 Chang, Abner [this message]
2023-04-18 17:49 ` [edk2-devel] [PATCH] MdePkg/Include: Add DMTF PLDM Base definitions Michael D Kinney
2023-04-19  2:13   ` Chang, Abner
2023-04-19 15:05     ` Michael D Kinney
2023-04-20  3:24       ` Chang, Abner
2023-04-21  1:43         ` Michael D Kinney

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230402015155.147-1-abner.chang@amd.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox