* Re: [PATCH v3] MdePkg/Include: Add IPMI KCS definitions
2023-03-23 13:57 [PATCH v3] MdePkg/Include: Add IPMI KCS definitions Chang, Abner
@ 2023-03-23 17:36 ` Isaac Oram
2023-03-23 17:39 ` [edk2-devel] " Tinh Nguyen
2023-03-23 22:12 ` Michael D Kinney
2 siblings, 0 replies; 4+ messages in thread
From: Isaac Oram @ 2023-03-23 17:36 UTC (permalink / raw)
To: abner.chang@amd.com, devel@edk2.groups.io
Cc: Kinney, Michael D, Gao, Liming, Liu, Zhiguang, Nickle Wang,
Igor Kulchytskyy, Abdul Lateef Attar
Acked-by: Isaac Oram <isaac.w.oram@intel.com>
-----Original Message-----
From: abner.chang@amd.com <abner.chang@amd.com>
Sent: Thursday, March 23, 2023 6:58 AM
To: devel@edk2.groups.io
Cc: Kinney, Michael D <michael.d.kinney@intel.com>; Gao, Liming <gaoliming@byosoft.com.cn>; Liu, Zhiguang <zhiguang.liu@intel.com>; Nickle Wang <nicklew@nvidia.com>; Igor Kulchytskyy <igork@ami.com>; Oram, Isaac W <isaac.w.oram@intel.com>; Abdul Lateef Attar <AbdulLateef.Attar@amd.com>
Subject: [PATCH v3] MdePkg/Include: Add IPMI KCS definitions
From: Abner Chang <abner.chang@amd.com>
BZ #4354
This change adds definitions for IPMI KCS.
Spec ref:
https://www.intel.com/content/www/us/en/products/docs/servers/ipmi/ipmi-second-gen-interface-spec-v2-rev1-1.html
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>
Acked-by: Isaac Oram <isaac.w.oram@intel.com>
---
MdePkg/MdePkg.dec | 6 ++
MdePkg/Include/IndustryStandard/IpmiKcs.h | 76 +++++++++++++++++++++++
2 files changed, 82 insertions(+)
create mode 100644 MdePkg/Include/IndustryStandard/IpmiKcs.h
diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec index 2d643bede1d..5cf04bc0cb6 100644
--- a/MdePkg/MdePkg.dec
+++ b/MdePkg/MdePkg.dec
@@ -9,6 +9,7 @@
# (C) Copyright 2016 - 2021 Hewlett Packard Enterprise Development LP<BR> # Copyright (c) 2022, Loongson Technology Corporation Limited. All rights reserved.<BR> # Copyright (c) 2021 - 2022, Arm Limited. All rights reserved.<BR>
+# Copyright (C) 2023 Advanced Micro Devices, Inc. All rights
+reserved.<BR>
#
# SPDX-License-Identifier: BSD-2-Clause-Patent # @@ -2342,6 +2343,11 @@
# @Prompt Memory Address of GuidedExtractHandler Table.
gEfiMdePkgTokenSpaceGuid.PcdGuidedExtractHandlerTableAddress|0x1000000|UINT64|0x30001015
+ ## This value is the IPMI KCS Interface I/O base address used to transmit IPMI commands.
+ # The value of 0xca2 is the default I/O base address defined in IPMI specification.
+ # @Prompt IPMI KCS Interface I/O Base Address
+
+ gEfiMdePkgTokenSpaceGuid.PcdIpmiKcsIoBaseAddress|0xca2|UINT16|0x000000
+ 31
+
[PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
## This value is used to set the base address of PCI express hierarchy.
# @Prompt PCI Express Base Address.
diff --git a/MdePkg/Include/IndustryStandard/IpmiKcs.h b/MdePkg/Include/IndustryStandard/IpmiKcs.h
new file mode 100644
index 00000000000..c3baf80bd76
--- /dev/null
+++ b/MdePkg/Include/IndustryStandard/IpmiKcs.h
@@ -0,0 +1,76 @@
+/** @file
+ IPMI KCS Register Definitions
+
+ Copyright (C) 2023 Advanced Micro Devices, Inc. All rights
+ reserved.<BR>
+ SPDX-License-Identifier: BSD-2-Clause-Patent
+
+ @par Revision Reference:
+ IPMI Specification
+ Version 2.0, Rev. 1.1
+
+https://www.intel.com/content/www/us/en/products/docs/servers/ipmi/ipmi
+-second-gen-interface-spec-v2-rev1-1.html
+**/
+
+#ifndef IPMI_KCS_H_
+#define IPMI_KCS_H_
+
+#define IPMI_KCS_STATUS_REGISTER_OFFSET 1
+#define IPMI_KCS_COMMAND_REGISTER_OFFSET 1
+#define IPMI_KCS_DATA_OUT_REGISTER_OFFSET 0
+#define IPMI_KCS_DATA_IN_REGISTER_OFFSET 0
+
+///
+/// IPMI KCS Interface Status Bits
+///
+#define IPMI_KCS_OBF BIT0
+#define IPMI_KCS_IBF BIT1
+#define IPMI_KCS_SMS_ATN BIT2
+#define IPMI_KCS_COMMAND_DATA BIT3
+#define IPMI_KCS_OEM1 BIT4
+#define IPMI_KCS_OEM2 BIT5
+#define IPMI_KCS_S0 BIT6
+#define IPMI_KCS_S1 BIT7
+
+///
+/// IPMI KCS Interface Control Codes
+///
+#define IPMI_KCS_CONTROL_CODE_GET_STATUS_ABORT 0x60
+#define IPMI_KCS_CONTROL_CODE_WRITE_START 0x61
+#define IPMI_KCS_CONTROL_CODE_WRITE_END 0x62
+#define IPMI_KCS_CONTROL_CODE_READ 0x68
+
+///
+/// Status Codes
+///
+#define IPMI_KCS_STATUS_NO_ERROR 0x00
+#define IPMI_KCS_STATUS_ABORT 0x01
+#define IPMI_KCS_STATUS_ILLEGAL 0x02
+#define IPMI_KCS_STATUS_LENGTH_ERROR 0x06
+#define IPMI_KCS_STATUS_UNSPECIFIED 0xFF
+
+///
+/// KCS Interface State Bit
+///
+typedef enum {
+ IPMI_KCS_IDLE_STATE = 0,
+ IPMI_KCS_READ_STATE,
+ IPMI_KCS_WRITE_STATE,
+ IPMI_KCS_ERROR_STATE
+} IPMI_KCS_STATE;
+
+///
+/// IPMI KCS Interface Request Format
+///
+typedef struct {
+ UINT8 NetFunc;
+ UINT8 Command;
+ UINT8 Data[0];
+} IPMI_KCS_RESQUEST_HEADER;
+
+///
+/// IPMI KCS Interface Response Format
+///
+typedef struct {
+ UINT8 NetFunc;
+ UINT8 Command;
+} IPMI_KCS_RESPONSE_HEADER;
+#endif
--
2.37.1.windows.1
^ permalink raw reply related [flat|nested] 4+ messages in thread* Re: [edk2-devel] [PATCH v3] MdePkg/Include: Add IPMI KCS definitions
2023-03-23 13:57 [PATCH v3] MdePkg/Include: Add IPMI KCS definitions Chang, Abner
2023-03-23 17:36 ` Isaac Oram
@ 2023-03-23 17:39 ` Tinh Nguyen
2023-03-23 22:12 ` Michael D Kinney
2 siblings, 0 replies; 4+ messages in thread
From: Tinh Nguyen @ 2023-03-23 17:39 UTC (permalink / raw)
To: devel, abner.chang
Cc: Michael D Kinney, Liming Gao, Zhiguang Liu, Nickle Wang,
Igor Kulchytskyy, Isaac Oram, Abdul Lateef Attar
Hi Abner,
On 3/23/2023 8:57 PM, Chang, Abner via groups.io wrote:
> From: Abner Chang <abner.chang@amd.com>
>
> BZ #4354
> This change adds definitions for IPMI KCS.
>
> Spec ref:
> https://www.intel.com/content/www/us/en/products/docs/servers/ipmi/ipmi-second-gen-interface-spec-v2-rev1-1.html
>
> 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>
> Acked-by: Isaac Oram <isaac.w.oram@intel.com>
> ---
> MdePkg/MdePkg.dec | 6 ++
> MdePkg/Include/IndustryStandard/IpmiKcs.h | 76 +++++++++++++++++++++++
> 2 files changed, 82 insertions(+)
> create mode 100644 MdePkg/Include/IndustryStandard/IpmiKcs.h
>
> diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
> index 2d643bede1d..5cf04bc0cb6 100644
> --- a/MdePkg/MdePkg.dec
> +++ b/MdePkg/MdePkg.dec
> @@ -9,6 +9,7 @@
> # (C) Copyright 2016 - 2021 Hewlett Packard Enterprise Development LP<BR>
> # Copyright (c) 2022, Loongson Technology Corporation Limited. All rights reserved.<BR>
> # Copyright (c) 2021 - 2022, Arm Limited. All rights reserved.<BR>
> +# Copyright (C) 2023 Advanced Micro Devices, Inc. All rights reserved.<BR>
> #
> # SPDX-License-Identifier: BSD-2-Clause-Patent
> #
> @@ -2342,6 +2343,11 @@
> # @Prompt Memory Address of GuidedExtractHandler Table.
> gEfiMdePkgTokenSpaceGuid.PcdGuidedExtractHandlerTableAddress|0x1000000|UINT64|0x30001015
>
> + ## This value is the IPMI KCS Interface I/O base address used to transmit IPMI commands.
> + # The value of 0xca2 is the default I/O base address defined in IPMI specification.
> + # @Prompt IPMI KCS Interface I/O Base Address
> + gEfiMdePkgTokenSpaceGuid.PcdIpmiKcsIoBaseAddress|0xca2|UINT16|0x00000031
> +
> [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
> ## This value is used to set the base address of PCI express hierarchy.
> # @Prompt PCI Express Base Address.
> diff --git a/MdePkg/Include/IndustryStandard/IpmiKcs.h b/MdePkg/Include/IndustryStandard/IpmiKcs.h
> new file mode 100644
> index 00000000000..c3baf80bd76
> --- /dev/null
> +++ b/MdePkg/Include/IndustryStandard/IpmiKcs.h
> @@ -0,0 +1,76 @@
> +/** @file
> + IPMI KCS Register Definitions
> +
> + Copyright (C) 2023 Advanced Micro Devices, Inc. All rights reserved.<BR>
> + SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> + @par Revision Reference:
> + IPMI Specification
> + Version 2.0, Rev. 1.1
> + https://www.intel.com/content/www/us/en/products/docs/servers/ipmi/ipmi-second-gen-interface-spec-v2-rev1-1.html
> +**/
> +
> +#ifndef IPMI_KCS_H_
> +#define IPMI_KCS_H_
> +
> +#define IPMI_KCS_STATUS_REGISTER_OFFSET 1
> +#define IPMI_KCS_COMMAND_REGISTER_OFFSET 1
> +#define IPMI_KCS_DATA_OUT_REGISTER_OFFSET 0
> +#define IPMI_KCS_DATA_IN_REGISTER_OFFSET 0
> +
> +///
> +/// IPMI KCS Interface Status Bits
> +///
> +#define IPMI_KCS_OBF BIT0
> +#define IPMI_KCS_IBF BIT1
> +#define IPMI_KCS_SMS_ATN BIT2
> +#define IPMI_KCS_COMMAND_DATA BIT3
> +#define IPMI_KCS_OEM1 BIT4
> +#define IPMI_KCS_OEM2 BIT5
> +#define IPMI_KCS_S0 BIT6
> +#define IPMI_KCS_S1 BIT7
> +
> +///
> +/// IPMI KCS Interface Control Codes
> +///
> +#define IPMI_KCS_CONTROL_CODE_GET_STATUS_ABORT 0x60
> +#define IPMI_KCS_CONTROL_CODE_WRITE_START 0x61
> +#define IPMI_KCS_CONTROL_CODE_WRITE_END 0x62
> +#define IPMI_KCS_CONTROL_CODE_READ 0x68
> +
> +///
> +/// Status Codes
> +///
> +#define IPMI_KCS_STATUS_NO_ERROR 0x00
> +#define IPMI_KCS_STATUS_ABORT 0x01
> +#define IPMI_KCS_STATUS_ILLEGAL 0x02
> +#define IPMI_KCS_STATUS_LENGTH_ERROR 0x06
> +#define IPMI_KCS_STATUS_UNSPECIFIED 0xFF
> +
> +///
> +/// KCS Interface State Bit
> +///
> +typedef enum {
> + IPMI_KCS_IDLE_STATE = 0,
> + IPMI_KCS_READ_STATE,
> + IPMI_KCS_WRITE_STATE,
> + IPMI_KCS_ERROR_STATE
> +} IPMI_KCS_STATE;
> +
> +///
> +/// IPMI KCS Interface Request Format
> +///
> +typedef struct {
> + UINT8 NetFunc;
That definition is fine, but I'm curious why you don't use bit field to
separate NetFun and Lun
> + UINT8 Command;
> + UINT8 Data[0];
> +} IPMI_KCS_RESQUEST_HEADER;
It should be REQUEST?
> +
> +///
> +/// IPMI KCS Interface Response Format
> +///
> +typedef struct {
> + UINT8 NetFunc;
> + UINT8 Command;
> +} IPMI_KCS_RESPONSE_HEADER;
> +#endif
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [PATCH v3] MdePkg/Include: Add IPMI KCS definitions
2023-03-23 13:57 [PATCH v3] MdePkg/Include: Add IPMI KCS definitions Chang, Abner
2023-03-23 17:36 ` Isaac Oram
2023-03-23 17:39 ` [edk2-devel] " Tinh Nguyen
@ 2023-03-23 22:12 ` Michael D Kinney
2 siblings, 0 replies; 4+ messages in thread
From: Michael D Kinney @ 2023-03-23 22:12 UTC (permalink / raw)
To: abner.chang@amd.com, devel@edk2.groups.io
Cc: Gao, Liming, Liu, Zhiguang, Nickle Wang, Igor Kulchytskyy,
Oram, Isaac W, Abdul Lateef Attar, Kinney, Michael D
> -----Original Message-----
> From: abner.chang@amd.com <abner.chang@amd.com>
> Sent: Thursday, March 23, 2023 6:58 AM
> To: devel@edk2.groups.io
> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; Gao, Liming <gaoliming@byosoft.com.cn>; Liu, Zhiguang <zhiguang.liu@intel.com>;
> Nickle Wang <nicklew@nvidia.com>; Igor Kulchytskyy <igork@ami.com>; Oram, Isaac W <isaac.w.oram@intel.com>; Abdul Lateef Attar
> <AbdulLateef.Attar@amd.com>
> Subject: [PATCH v3] MdePkg/Include: Add IPMI KCS definitions
>
> From: Abner Chang <abner.chang@amd.com>
>
> BZ #4354
> This change adds definitions for IPMI KCS.
>
> Spec ref:
> https://www.intel.com/content/www/us/en/products/docs/servers/ipmi/ipmi-second-gen-interface-spec-v2-rev1-1.html
>
> 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>
> Acked-by: Isaac Oram <isaac.w.oram@intel.com>
> ---
> MdePkg/MdePkg.dec | 6 ++
> MdePkg/Include/IndustryStandard/IpmiKcs.h | 76 +++++++++++++++++++++++
> 2 files changed, 82 insertions(+)
> create mode 100644 MdePkg/Include/IndustryStandard/IpmiKcs.h
>
> diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
> index 2d643bede1d..5cf04bc0cb6 100644
> --- a/MdePkg/MdePkg.dec
> +++ b/MdePkg/MdePkg.dec
> @@ -9,6 +9,7 @@
> # (C) Copyright 2016 - 2021 Hewlett Packard Enterprise Development LP<BR>
> # Copyright (c) 2022, Loongson Technology Corporation Limited. All rights reserved.<BR>
> # Copyright (c) 2021 - 2022, Arm Limited. All rights reserved.<BR>
> +# Copyright (C) 2023 Advanced Micro Devices, Inc. All rights reserved.<BR>
> #
> # SPDX-License-Identifier: BSD-2-Clause-Patent
> #
> @@ -2342,6 +2343,11 @@
> # @Prompt Memory Address of GuidedExtractHandler Table.
> gEfiMdePkgTokenSpaceGuid.PcdGuidedExtractHandlerTableAddress|0x1000000|UINT64|0x30001015
>
> + ## This value is the IPMI KCS Interface I/O base address used to transmit IPMI commands.
> + # The value of 0xca2 is the default I/O base address defined in IPMI specification.
> + # @Prompt IPMI KCS Interface I/O Base Address
> + gEfiMdePkgTokenSpaceGuid.PcdIpmiKcsIoBaseAddress|0xca2|UINT16|0x00000031
> +
> [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
> ## This value is used to set the base address of PCI express hierarchy.
> # @Prompt PCI Express Base Address.
> diff --git a/MdePkg/Include/IndustryStandard/IpmiKcs.h b/MdePkg/Include/IndustryStandard/IpmiKcs.h
> new file mode 100644
> index 00000000000..c3baf80bd76
> --- /dev/null
> +++ b/MdePkg/Include/IndustryStandard/IpmiKcs.h
> @@ -0,0 +1,76 @@
> +/** @file
> + IPMI KCS Register Definitions
> +
> + Copyright (C) 2023 Advanced Micro Devices, Inc. All rights reserved.<BR>
> + SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> + @par Revision Reference:
> + IPMI Specification
> + Version 2.0, Rev. 1.1
> + https://www.intel.com/content/www/us/en/products/docs/servers/ipmi/ipmi-second-gen-interface-spec-v2-rev1-1.html
> +**/
> +
> +#ifndef IPMI_KCS_H_
> +#define IPMI_KCS_H_
> +
> +#define IPMI_KCS_STATUS_REGISTER_OFFSET 1
> +#define IPMI_KCS_COMMAND_REGISTER_OFFSET 1
> +#define IPMI_KCS_DATA_OUT_REGISTER_OFFSET 0
> +#define IPMI_KCS_DATA_IN_REGISTER_OFFSET 0
> +
> +///
> +/// IPMI KCS Interface Status Bits
> +///
> +#define IPMI_KCS_OBF BIT0
> +#define IPMI_KCS_IBF BIT1
> +#define IPMI_KCS_SMS_ATN BIT2
> +#define IPMI_KCS_COMMAND_DATA BIT3
> +#define IPMI_KCS_OEM1 BIT4
> +#define IPMI_KCS_OEM2 BIT5
> +#define IPMI_KCS_S0 BIT6
> +#define IPMI_KCS_S1 BIT7
> +
> +///
> +/// IPMI KCS Interface Control Codes
> +///
> +#define IPMI_KCS_CONTROL_CODE_GET_STATUS_ABORT 0x60
> +#define IPMI_KCS_CONTROL_CODE_WRITE_START 0x61
> +#define IPMI_KCS_CONTROL_CODE_WRITE_END 0x62
> +#define IPMI_KCS_CONTROL_CODE_READ 0x68
> +
> +///
> +/// Status Codes
> +///
> +#define IPMI_KCS_STATUS_NO_ERROR 0x00
> +#define IPMI_KCS_STATUS_ABORT 0x01
> +#define IPMI_KCS_STATUS_ILLEGAL 0x02
> +#define IPMI_KCS_STATUS_LENGTH_ERROR 0x06
> +#define IPMI_KCS_STATUS_UNSPECIFIED 0xFF
> +
> +///
> +/// KCS Interface State Bit
> +///
> +typedef enum {
> + IPMI_KCS_IDLE_STATE = 0,
> + IPMI_KCS_READ_STATE,
> + IPMI_KCS_WRITE_STATE,
> + IPMI_KCS_ERROR_STATE
> +} IPMI_KCS_STATE;
> +
> +///
> +/// IPMI KCS Interface Request Format
> +///
> +typedef struct {
> + UINT8 NetFunc;
> + UINT8 Command;
> + UINT8 Data[0];
I think flexible array members are supposed to use [] and not [0].
> +} IPMI_KCS_RESQUEST_HEADER;
> +
> +///
> +/// IPMI KCS Interface Response Format
> +///
> +typedef struct {
> + UINT8 NetFunc;
> + UINT8 Command;
> +} IPMI_KCS_RESPONSE_HEADER;
> +#endif
> --
> 2.37.1.windows.1
^ permalink raw reply [flat|nested] 4+ messages in thread