[edk2platforms][PATCH v1 0/1] IntelSiliconPkg: Add IntelDieInfoProtocol

[edk2platforms][PATCH v1 0/1] IntelSiliconPkg: Add IntelDieInfoProtocol

[maciej.czajkowski]

This commit will add a protocol/PPI definition which will provide a generic and 
unified way to get information about dies installed in the system(PCH, SoC, CPU).
It will be implemented per generation in silicon packages.

Cc: Ray Ni <ray.ni@intel.com>
Cc: Rangasai V Chaganty <rangasai.v.chaganty@intel.com>

Maciej Czajkowski (1):
  IntelSiliconPkg: Add IntelDieInfoProtocol

 Silicon/Intel/IntelSiliconPkg/Include/Protocol/IntelDieInfoProtocol.h | 109 ++++++++++++++++++++
 Silicon/Intel/IntelSiliconPkg/IntelSiliconPkg.dec                     |   2 +
 2 files changed, 111 insertions(+)
 create mode 100644 Silicon/Intel/IntelSiliconPkg/Include/Protocol/IntelDieInfoProtocol.h

-- 
2.27.0.windows.1

---------------------------------------------------------------------
Intel Technology Poland sp. z o.o.
ul. Slowackiego 173 | 80-298 Gdansk | Sad Rejonowy Gdansk Polnoc | VII Wydzial Gospodarczy Krajowego Rejestru Sadowego - KRS 101882 | NIP 957-07-52-316 | Kapital zakladowy 200.000 PLN.
Ta wiadomosc wraz z zalacznikami jest przeznaczona dla okreslonego adresata i moze zawierac informacje poufne. W razie przypadkowego otrzymania tej wiadomosci, prosimy o powiadomienie nadawcy oraz trwale jej usuniecie; jakiekolwiek przegladanie lub rozpowszechnianie jest zabronione.
This e-mail and any attachments may contain confidential material for the sole use of the intended recipient(s). If you are not the intended recipient, please contact the sender and delete all copies; any review or distribution by others is strictly prohibited.

[edk2platforms][PATCH v1 1/1] IntelSiliconPkg: Add IntelDieInfoProtocol

[Maciej Czajkowski]

Added IntelDieInfoProtocol header into IntelSiliconPkg tree.
The purpose is to have generic and unified interface for getting
information about dies installed in the system.
It will be implemented by silicon code.

Change-Id: I219f238a6245eb81dbaebe6b826304baf3f78dc2
Cc: Ray Ni <ray.ni@intel.com>
Cc: Rangasai V Chaganty <rangasai.v.chaganty@intel.com>
Signed-off-by: Maciej Czajkowski <maciej.czajkowski@intel.com>
---
 Silicon/Intel/IntelSiliconPkg/Include/Protocol/IntelDieInfoProtocol.h | 109 ++++++++++++++++++++
 Silicon/Intel/IntelSiliconPkg/IntelSiliconPkg.dec                     |   2 +
 2 files changed, 111 insertions(+)

diff --git a/Silicon/Intel/IntelSiliconPkg/Include/Protocol/IntelDieInfoProtocol.h b/Silicon/Intel/IntelSiliconPkg/Include/Protocol/IntelDieInfoProtocol.h
new file mode 100644
index 000000000000..6182947e82fc
--- /dev/null
+++ b/Silicon/Intel/IntelSiliconPkg/Include/Protocol/IntelDieInfoProtocol.h
@@ -0,0 +1,109 @@
+/** @file
+  IntelDieInfoProtocol definition
+
+  Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>
+  SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+#ifndef _DIE_INFO_PROTOCOL_H_
+#define _DIE_INFO_PROTOCOL_H_
+
+typedef struct _INTEL_DIE_INFO_PROTOCOL  INTEL_DIE_INFO_PROTOCOL;
+typedef INTEL_DIE_INFO_PROTOCOL  INTEL_DIE_INFO_PPI;
+
+extern EFI_GUID gIntelDieInfoProtocolGuid;
+extern EFI_GUID gIntelDieInfoPpiGuid;
+
+#define INTEL_DIE_INFO_PPI_GUID \
+{ 0xAED8A0A1, 0xFDE6, 0x4CF2, { 0xA3, 0x85, 0x08, 0xF1, 0x25, 0xF2, 0x40, 0x37 }}
+
+#define INTEL_DIE_INFO_PROTOCOL_GUID \
+{ 0xAED8A0A1, 0xFDE6, 0x4CF2, { 0xA3, 0x85, 0x08, 0xF1, 0x25, 0xF2, 0x40, 0x37 }}
+
+#define DIE_INFO_PROTOCOL_REVISION 1
+#define DIE_INFO_PROTOCOL_SIGNATURE  SIGNATURE_32 ('I', 'D', 'I', 'P')
+
+#define DIE_INFO_PCH_GUID \
+{ 0x62CB6D68, 0x4771, 0x4569, { 0x81, 0xFA, 0x1E, 0x99, 0x6E, 0xA9, 0x91, 0xC5 }}
+
+#define DIE_INFO_SOC_GUID \
+{ 0x63287105, 0x578E, 0x4799, { 0xBE, 0x55, 0x5D, 0xDA, 0xCA, 0x03, 0x74, 0xD0 }}
+
+#define DIE_INFO_IO_GUID \
+{ 0x23DA4C74, 0x54A0, 0x4E01, { 0x83, 0xB1, 0x8C, 0xA7, 0x43, 0x43, 0x1F, 0xF0 }}
+
+#define DIE_INFO_CPU_GUID \
+{ 0x6E5AF2E3, 0x5D84, 0x48F2, { 0x84, 0x28, 0x99, 0xE4, 0x93, 0x4F, 0x51, 0xE4 }}
+
+#define DIE_INFO_GFX_GUID \
+{ 0x1D3D2599, 0x7A1C, 0x4B1E, { 0x8C, 0xC5, 0x0F, 0x88, 0x27, 0xA0, 0x2E, 0xEC }}
+
+/**
+  Returns pointer to constant string representing die name.
+  Name is specific to die type.
+
+  @param[in] This  Pointer to the DieInfoProtocol context structure
+  @retval Pointer to the const string
+**/
+typedef
+CONST CHAR8*
+(EFIAPI *INTEL_DIE_INFO_GET_DIE_NAME_STR) (
+  IN INTEL_DIE_INFO_PROTOCOL  *This
+  );
+
+/**
+  Returns pointer to constant string representing stepping of the die.
+
+  @param[in] This  Pointer to the DieInfoProtocol context structure
+  @retval Pointer to the const string
+**/
+typedef
+CONST CHAR8*
+(EFIAPI *INTEL_DIE_INFO_GET_STEPPING_STR) (
+  IN INTEL_DIE_INFO_PROTOCOL  *This
+  );
+
+/**
+  Returns pointer to constant string representing SKU of the die.
+
+  @param[in] This  Pointer to the DieInfoProtocol context structure
+  @retval Pointer to the const string
+**/
+typedef
+CONST CHAR8*
+(EFIAPI *INTEL_DIE_INFO_GET_SKU_STR) (
+  IN INTEL_DIE_INFO_PROTOCOL  *This
+  );
+
+/**
+  Protocol/PPI definition.
+
+  <b>Revision 1</b>:
+   - Initial version.
+**/
+struct _INTEL_DIE_INFO_PROTOCOL {
+  UINT32                           Signature; ///< Protocol signature
+  UINT32                           Revision; ///< Current protocol revision
+  /**
+    Type of the die that particular instance is reffering to. See DIE_INFO_*_GUID
+  **/
+  EFI_GUID                         Type;
+  /**
+    Index of the die in the system.
+  **/
+  UINT32                           DieIndex;
+  /**
+    Generation and die specific ID number.
+  **/
+  UINT64                           DieId;
+  /**
+    Generation and die specific stepping ID.
+  **/
+  UINT32                           SteppingId;
+
+  INTEL_DIE_INFO_GET_DIE_NAME_STR  GetNameStr;
+  INTEL_DIE_INFO_GET_STEPPING_STR  GetSteppingStr;
+  INTEL_DIE_INFO_GET_SKU_STR       GetSkuStr;
+};
+
+#endif // _DIE_INFO_PROTOCOL_H_
diff --git a/Silicon/Intel/IntelSiliconPkg/IntelSiliconPkg.dec b/Silicon/Intel/IntelSiliconPkg/IntelSiliconPkg.dec
index 2461ab8e06e7..7af784d77abc 100644
--- a/Silicon/Intel/IntelSiliconPkg/IntelSiliconPkg.dec
+++ b/Silicon/Intel/IntelSiliconPkg/IntelSiliconPkg.dec
@@ -73,9 +73,11 @@ [Guids]
 [Ppis]
   gEdkiiVTdInfoPpiGuid = { 0x8a59fcb3, 0xf191, 0x400c, { 0x97, 0x67, 0x67, 0xaf, 0x2b, 0x25, 0x68, 0x4a } }
   gEdkiiVTdNullRootEntryTableGuid = { 0x3de0593f, 0x6e3e, 0x4542, { 0xa1, 0xcb, 0xcb, 0xb2, 0xdb, 0xeb, 0xd8, 0xff } }
+  gIntelDieInfoPpiGuid = { 0xAED8A0A1, 0xFDE6, 0x4CF2, { 0xA3, 0x85, 0x08, 0xF1, 0x25, 0xF2, 0x40, 0x37 }}
 
 [Protocols]
   gEdkiiPlatformVTdPolicyProtocolGuid = { 0x3d17e448, 0x466, 0x4e20, { 0x99, 0x9f, 0xb2, 0xe1, 0x34, 0x88, 0xee, 0x22 }}
+  gIntelDieInfoProtocolGuid = { 0xAED8A0A1, 0xFDE6, 0x4CF2, { 0xA3, 0x85, 0x08, 0xF1, 0x25, 0xF2, 0x40, 0x37 }}
 
   ## Protocol for device security policy.
   # Include/Protocol/PlatformDeviceSecurityPolicy.h
-- 
2.27.0.windows.1

---------------------------------------------------------------------
Intel Technology Poland sp. z o.o.
ul. Slowackiego 173 | 80-298 Gdansk | Sad Rejonowy Gdansk Polnoc | VII Wydzial Gospodarczy Krajowego Rejestru Sadowego - KRS 101882 | NIP 957-07-52-316 | Kapital zakladowy 200.000 PLN.
Ta wiadomosc wraz z zalacznikami jest przeznaczona dla okreslonego adresata i moze zawierac informacje poufne. W razie przypadkowego otrzymania tej wiadomosci, prosimy o powiadomienie nadawcy oraz trwale jej usuniecie; jakiekolwiek przegladanie lub rozpowszechnianie jest zabronione.
This e-mail and any attachments may contain confidential material for the sole use of the intended recipient(s). If you are not the intended recipient, please contact the sender and delete all copies; any review or distribution by others is strictly prohibited.

Re: [edk2platforms][PATCH v1 1/1] IntelSiliconPkg: Add IntelDieInfoProtocol

[Ni, Ray]

+#define DIE_INFO_CPU_GUID \

+{ 0x6E5AF2E3, 0x5D84, 0x48F2, { 0x84, 0x28, 0x99, 0xE4, 0x93, 0x4F, 0x51, 0xE4 }}

1. What's the difference between SOC and CPU?


+  UINT32                           DieIndex;

2. What the purpose of "DieIndex"?


+  INTEL_DIE_INFO_GET_DIE_NAME_STR  GetNameStr;

+  INTEL_DIE_INFO_GET_STEPPING_STR  GetSteppingStr;

+  INTEL_DIE_INFO_GET_SKU_STR       GetSkuStr;

3. Have you considered to use data fields such as "CONST CHAR8 * DieName, Stepping, Sku" instead of the methods?

Re: [edk2platforms][PATCH v1 1/1] IntelSiliconPkg: Add IntelDieInfoProtocol

[Chaganty, Rangasai V]

Maciej, 
Please add description of the interface in the comment block in line 103, specifically covering the purpose of the interface, the producer and consumer of this interface. 
DieId's description says "Generation and die specific ID number". Can you add some details on how a producer of this interface would know the values to be assigned here? Does this contain any sort of encoding of generation and Die specific ID in a single UINT64 ?
Same question for Stepping ID.

Any reason the die specific GUIDs are not declared in the .dec file?

Thanks,
Sai

-----Original Message-----
From: Czajkowski, Maciej <maciej.czajkowski@intel.com> 
Sent: Thursday, October 07, 2021 8:24 AM
To: devel@edk2.groups.io
Cc: Ni, Ray <ray.ni@intel.com>; Chaganty, Rangasai V <rangasai.v.chaganty@intel.com>
Subject: [edk2platforms][PATCH v1 1/1] IntelSiliconPkg: Add IntelDieInfoProtocol

Added IntelDieInfoProtocol header into IntelSiliconPkg tree.
The purpose is to have generic and unified interface for getting information about dies installed in the system.
It will be implemented by silicon code.

Change-Id: I219f238a6245eb81dbaebe6b826304baf3f78dc2
Cc: Ray Ni <ray.ni@intel.com>
Cc: Rangasai V Chaganty <rangasai.v.chaganty@intel.com>
Signed-off-by: Maciej Czajkowski <maciej.czajkowski@intel.com>
---
 Silicon/Intel/IntelSiliconPkg/Include/Protocol/IntelDieInfoProtocol.h | 109 ++++++++++++++++++++
 Silicon/Intel/IntelSiliconPkg/IntelSiliconPkg.dec                     |   2 +
 2 files changed, 111 insertions(+)

diff --git a/Silicon/Intel/IntelSiliconPkg/Include/Protocol/IntelDieInfoProtocol.h b/Silicon/Intel/IntelSiliconPkg/Include/Protocol/IntelDieInfoProtocol.h
new file mode 100644
index 000000000000..6182947e82fc
--- /dev/null
+++ b/Silicon/Intel/IntelSiliconPkg/Include/Protocol/IntelDieInfoProtoco
+++ l.h
@@ -0,0 +1,109 @@
+/** @file+  IntelDieInfoProtocol definition++  Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>+  SPDX-License-Identifier: BSD-2-Clause-Patent++**/+#ifndef _DIE_INFO_PROTOCOL_H_+#define _DIE_INFO_PROTOCOL_H_++typedef struct _INTEL_DIE_INFO_PROTOCOL  INTEL_DIE_INFO_PROTOCOL;+typedef INTEL_DIE_INFO_PROTOCOL  INTEL_DIE_INFO_PPI;++extern EFI_GUID gIntelDieInfoProtocolGuid;+extern EFI_GUID gIntelDieInfoPpiGuid;++#define INTEL_DIE_INFO_PPI_GUID \+{ 0xAED8A0A1, 0xFDE6, 0x4CF2, { 0xA3, 0x85, 0x08, 0xF1, 0x25, 0xF2, 0x40, 0x37 }}++#define INTEL_DIE_INFO_PROTOCOL_GUID \+{ 0xAED8A0A1, 0xFDE6, 0x4CF2, { 0xA3, 0x85, 0x08, 0xF1, 0x25, 0xF2, 0x40, 0x37 }}++#define DIE_INFO_PROTOCOL_REVISION 1+#define DIE_INFO_PROTOCOL_SIGNATURE  SIGNATURE_32 ('I', 'D', 'I', 'P')++#define DIE_INFO_PCH_GUID \+{ 0x62CB6D68, 0x4771, 0x4569, { 0x81, 0xFA, 0x1E, 0x99, 0x6E, 0xA9, 0x91, 0xC5 }}++#define DIE_INFO_SOC_GUID \+{ 0x63287105, 0x578E, 0x4799, { 0xBE, 0x55, 0x5D, 0xDA, 0xCA, 0x03, 0x74, 0xD0 }}++#define DIE_INFO_IO_GUID \+{ 0x23DA4C74, 0x54A0, 0x4E01, { 0x83, 0xB1, 0x8C, 0xA7, 0x43, 0x43, 0x1F, 0xF0 }}++#define DIE_INFO_CPU_GUID \+{ 0x6E5AF2E3, 0x5D84, 0x48F2, { 0x84, 0x28, 0x99, 0xE4, 0x93, 0x4F, 0x51, 0xE4 }}++#define DIE_INFO_GFX_GUID \+{ 0x1D3D2599, 0x7A1C, 0x4B1E, { 0x8C, 0xC5, 0x0F, 0x88, 0x27, 0xA0, 0x2E, 0xEC }}++/**+  Returns pointer to constant string representing die name.+  Name is specific to die type.++  @param[in] This  Pointer to the DieInfoProtocol context structure+  @retval Pointer to the const string+**/+typedef+CONST CHAR8*+(EFIAPI *INTEL_DIE_INFO_GET_DIE_NAME_STR) (+  IN INTEL_DIE_INFO_PROTOCOL  *This+  );++/**+  Returns pointer to constant string representing stepping of the die.++  @param[in] This  Pointer to the DieInfoProtocol context structure+  @retval Pointer to the const string+**/+typedef+CONST CHAR8*+(EFIAPI *INTEL_DIE_INFO_GET_STEPPING_STR) (+  IN INTEL_DIE_INFO_PROTOCOL  *This+  );++/**+  Returns pointer to constant string representing SKU of the die.++  @param[in] This  Pointer to the DieInfoProtocol context structure+  @retval Pointer to the const string+**/+typedef+CONST CHAR8*+(EFIAPI *INTEL_DIE_INFO_GET_SKU_STR) (+  IN INTEL_DIE_INFO_PROTOCOL  *This+  );++/**+  Protocol/PPI definition.++  <b>Revision 1</b>:+   - Initial version.+**/+struct _INTEL_DIE_INFO_PROTOCOL {+  UINT32                           Signature; ///< Protocol signature+  UINT32                           Revision; ///< Current protocol revision+  /**+    Type of the die that particular instance is reffering to. See DIE_INFO_*_GUID+  **/+  EFI_GUID                         Type;+  /**+    Index of the die in the system.+  **/+  UINT32                           DieIndex;+  /**+    Generation and die specific ID number.+  **/+  UINT64                           DieId;+  /**+    Generation and die specific stepping ID.+  **/+  UINT32                           SteppingId;++  INTEL_DIE_INFO_GET_DIE_NAME_STR  GetNameStr;+  INTEL_DIE_INFO_GET_STEPPING_STR  GetSteppingStr;+  INTEL_DIE_INFO_GET_SKU_STR       GetSkuStr;+};++#endif // _DIE_INFO_PROTOCOL_H_diff --git a/Silicon/Intel/IntelSiliconPkg/IntelSiliconPkg.dec b/Silicon/Intel/IntelSiliconPkg/IntelSiliconPkg.dec
index 2461ab8e06e7..7af784d77abc 100644
--- a/Silicon/Intel/IntelSiliconPkg/IntelSiliconPkg.dec
+++ b/Silicon/Intel/IntelSiliconPkg/IntelSiliconPkg.dec
@@ -73,9 +73,11 @@ [Guids]
 [Ppis]   gEdkiiVTdInfoPpiGuid = { 0x8a59fcb3, 0xf191, 0x400c, { 0x97, 0x67, 0x67, 0xaf, 0x2b, 0x25, 0x68, 0x4a } }   gEdkiiVTdNullRootEntryTableGuid = { 0x3de0593f, 0x6e3e, 0x4542, { 0xa1, 0xcb, 0xcb, 0xb2, 0xdb, 0xeb, 0xd8, 0xff } }+  gIntelDieInfoPpiGuid = { 0xAED8A0A1, 0xFDE6, 0x4CF2, { 0xA3, 0x85, 0x08, 0xF1, 0x25, 0xF2, 0x40, 0x37 }}  [Protocols]   gEdkiiPlatformVTdPolicyProtocolGuid = { 0x3d17e448, 0x466, 0x4e20, { 0x99, 0x9f, 0xb2, 0xe1, 0x34, 0x88, 0xee, 0x22 }}+  gIntelDieInfoProtocolGuid = { 0xAED8A0A1, 0xFDE6, 0x4CF2, { 0xA3, 0x85, 0x08, 0xF1, 0x25, 0xF2, 0x40, 0x37 }}    ## Protocol for device security policy.   # Include/Protocol/PlatformDeviceSecurityPolicy.h-- 
2.27.0.windows.1

Re: [edk2-devel] [edk2platforms][PATCH v1 1/1] IntelSiliconPkg: Add IntelDieInfoProtocol

[Maciej Czajkowski]

[-- Attachment #1: Type: text/plain, Size: 589 bytes --]

What's the difference between SOC and CPU?
SOC die differs from typical CPU die in Intel's chiplet design.

What the purpose of "DieIndex"?
We want to have an indication to which exactly die given protocol instance is referring to (in example in multi socket/multi PCH designs).

Have you considered to use data fields such as "CONST CHAR8 * DieName, Stepping, Sku" instead of the methods?
Yes, but there might be a configuration where chipset id is going to be changed during the boot. By using methods, we ensure that returned value is correct in every call.

Regards,
Maciej

[-- Attachment #2: Type: text/html, Size: 1055 bytes --]

Re: [edk2-devel] [edk2platforms][PATCH v1 1/1] IntelSiliconPkg: Add IntelDieInfoProtocol

[Maciej Czajkowski]

[-- Attachment #1: Type: text/plain, Size: 634 bytes --]

Can you add some details on how a producer of this interface would know the values to be assigned here? Does this contain any sort of encoding of generation and Die specific ID in a single UINT64?
Yes, in order to have a generic field regardless of the die type and per-generation changes it will be packed into a single UINT64. Protocol will be installed by silicon code, and consumer will need to be aware of the encoding and decode it. Same applies for stepping id.

Any reason the die specific GUIDs are not declared in the .dec file?
I can't see any problems with that, they will be added in v2 changes.

Regards,
Maciej

[-- Attachment #2: Type: text/html, Size: 725 bytes --]