[edk2-staging][PATCH v2 0/3] Add TPM subclass definition

[edk2-staging][PATCH v2 0/3] Add TPM subclass definition

[Kun Qin]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3966

This patch series is a follow up of previous submission:
https://edk2.groups.io/g/devel/message/91075

v2 patch changes include feedback for v1 series:
a. Removed PCD replacement related code change;

>From PI Specification v1.7 Errata A, EFI_PERIPHERAL_DOCKING is defined as
0xD0000 (as well as included in PiStatusCode.h).

However, subclass employed as PCD for TPM peripheral in SecurityPkg is
also defined as 0xD0000. The TPM subclass code was used in TcgPei.c when
reporting error codes.

The collision of subclass definition could cause the parsing of reported
errors being ambiguous.

This patch series add EFI_PERIPHERAL_TPM as a spec-defined value and
removed potential usages in the SecurityPkg.

Patch v2 branch: https://github.com/kuqin12/edk2/tree/BZ3966-add_tpm_subclass_v2

Cc: Andrew Fish <afish@apple.com>
Cc: Leif Lindholm <leif@nuviainc.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: Jiewen Yao <jiewen.yao@intel.com>
Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Qi Zhang <qi1.zhang@intel.com>
Cc: Rahul Kumar <rahul1.kumar@intel.com>

Kun Qin (3):
  EDK2 Code First: PI Specification: New peripheral subclass for TPM
  MdePkg: MmCommunication: Add TPM subclass definition to MdePkg
  SecurityPkg: SubClassTpm: Updated default value

 CodeFirst/BZ3966-SpecChange.md   | 59 ++++++++++++++++++++
 MdePkg/Include/Pi/PiStatusCode.h |  1 +
 SecurityPkg/SecurityPkg.dec      |  6 +-
 SecurityPkg/SecurityPkg.uni      |  2 +-
 4 files changed, 64 insertions(+), 4 deletions(-)
 create mode 100644 CodeFirst/BZ3966-SpecChange.md

-- 
2.37.0.windows.1

[edk2-staging][PATCH v2 1/3] EDK2 Code First: PI Specification: New peripheral subclass for TPM

[Kun Qin]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3966

This change includes specification update markdown file that describes
the proposed PI Specification v1.7 Errata A in detail and potential
impact to the existing codebase.

Cc: Andrew Fish <afish@apple.com>
Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Zhiguang Liu <zhiguang.liu@intel.com>

Signed-off-by: Kun Qin <kuqin12@gmail.com>
---

Notes:
    v2:
    - Removed PCD replacement changes [Michael Kinney]

 CodeFirst/BZ3966-SpecChange.md | 59 ++++++++++++++++++++
 1 file changed, 59 insertions(+)

diff --git a/CodeFirst/BZ3966-SpecChange.md b/CodeFirst/BZ3966-SpecChange.md
new file mode 100644
index 000000000000..bfece823021d
--- /dev/null
+++ b/CodeFirst/BZ3966-SpecChange.md
@@ -0,0 +1,59 @@
+# Title: Introduction of `EFI_PERIPHERAL_TPM` Peripheral Subclass Definition
+
+## Status: Draft
+
+## Document: UEFI Platform Initialization Specification Version 1.7 Errata A
+
+## License
+
+SPDX-License-Identifier: CC-BY-4.0
+
+## Submitter: [TianoCore Community](https://www.tianocore.org)
+
+## Summary of the change
+
+Add `EFI_PERIPHERAL_TPM` into Peripheral Subclass definition.
+
+## Benefits of the change
+
+Current status code covered various [peripheral subclass definitions](https://github.com/tianocore/edk2/blob/master/MdePkg/Include/Pi/PiStatusCode.h).
+
+As Trusted Platform Module (TPM) becomes more available on the modern systems, status reports from such peripheral are playing more important roles in anaylzing the secruity state and healthiness of a system. However, peripheral subclass definitions do not cover TPM as of today.
+
+Standardizing the TPM peripheral subclass definition could facilitate the parsing of peripheral reported errors and avoid potential definition collisions from implementation based subclass usages.
+
+The request of this change intends to expand definitions of `EFI_PERIPHERAL_**` under Periperhal Subclass definitions to cover the TPM subclass.
+
+## Impact of the change
+
+Occupy a new macro definitions of subclass under `Defined Subclasses: User-Accessible Peripheral Class`.
+
+## Detailed description of the change [normative updates]
+
+### Specification Changes
+
+1. In PI Specification v1.7 Errata A: Vol. 3, Table 3-30: Defined Subclasses: User-Accessible Peripheral Class, add one new rows below `EFI_PERIPHERAL_DOCKING` definition and adjust the rest of reserved definitions accordingly:
+
+    | Subclass | Code Name | Description |
+    | --- | --- | --- |
+    | Trusted Platform Module | EFI_PERIPHERAL_TPM | The peripheral referred to is a Trusted Platform Module |
+    | 0x0F–0x7F | Reserved for future use by this specification |  |
+
+1. In PI Specification v1.7 Errata A: Vol. 3, Table 3-84: Defined Subclasses: User-Accessible Peripheral Class, add one new rows below `EFI_PERIPHERAL_DOCKING` definition and adjust the rest of reserved definitions accordingly:
+
+    | Subclass | Code Name |
+    | --- | --- |
+    | Trusted Platform Module | EFI_PERIPHERAL_TPM |
+    | 0x0F–0x7F | Reserved for future use by this specification. |
+
+1. In PI Specification v1.7 Errata A: Vol. 3, Section 6.7.2.1 Subclass Definitions: Prototype, add one new definitions below `EFI_PERIPHERAL_DOCKING` definition:
+
+    ```c
+    #define EFI_PERIPHERAL_TPM \
+      (EFI_PERIPHERAL | 0x000E0000)
+    ```
+
+### Code Changes
+
+1. Add macro definitions in `MdePkg/Include/Pi/PiStatusCode.h` to match new specification.
+1. Updated the default value of `gEfiSecurityPkgTokenSpaceGuid.PcdStatusCodeSubClassTpmDevice` to `(EFI_PERIPHERAL | 0x000E0000)` for consistency and backwards compatibility outside of SecurityPkg.
-- 
2.37.0.windows.1

[edk2-staging][PATCH v2 2/3] MdePkg: MmCommunication: Add TPM subclass definition to MdePkg

[Kun Qin]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3966

This change introduces a new peripheral subclass definition.

The new subclass definition will cover system reboot events under the
status reports from Trusted Platform Modules (TPMs).

These definition could provide helpful datapoints to OEMs to analyze
system security state and healthiness, as well as avoid definition
collision with other existing peripheral subclass definitions.

Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Zhiguang Liu <zhiguang.liu@intel.com>

Signed-off-by: Kun Qin <kuqin12@gmail.com>
---

Notes:
    v2:
    - No change

 MdePkg/Include/Pi/PiStatusCode.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/MdePkg/Include/Pi/PiStatusCode.h b/MdePkg/Include/Pi/PiStatusCode.h
index ef2aea7364bc..d65b65654053 100644
--- a/MdePkg/Include/Pi/PiStatusCode.h
+++ b/MdePkg/Include/Pi/PiStatusCode.h
@@ -363,6 +363,7 @@ typedef struct {
 #define EFI_PERIPHERAL_LCD_DEVICE       (EFI_PERIPHERAL | 0x000B0000)
 #define EFI_PERIPHERAL_NETWORK          (EFI_PERIPHERAL | 0x000C0000)
 #define EFI_PERIPHERAL_DOCKING          (EFI_PERIPHERAL | 0x000D0000)
+#define BZ3966_EFI_PERIPHERAL_TPM              (EFI_PERIPHERAL | 0x000E0000)
 ///@}
 
 ///
-- 
2.37.0.windows.1

[edk2-staging][PATCH v2 3/3] SecurityPkg: SubClassTpm: Updated default value

[Kun Qin]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3966

This change updated the default value of TPM device subclass PCD to
`0x010E0000` in order to match the definition of EFI_PERIPHERAL_TPM
from PI specification.

Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Qi Zhang <qi1.zhang@intel.com>
Cc: Rahul Kumar <rahul1.kumar@intel.com>

Signed-off-by: Kun Qin <kuqin12@gmail.com>
---

Notes:
    v2:
    - No change

 SecurityPkg/SecurityPkg.dec | 6 +++---
 SecurityPkg/SecurityPkg.uni | 2 +-
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/SecurityPkg/SecurityPkg.dec b/SecurityPkg/SecurityPkg.dec
index 7ecf9565d98c..49fc030e2da3 100644
--- a/SecurityPkg/SecurityPkg.dec
+++ b/SecurityPkg/SecurityPkg.dec
@@ -315,10 +315,10 @@ [PcdsFixedAtBuild, PcdsPatchableInModule]
   gEfiSecurityPkgTokenSpaceGuid.PcdTpmPlatformClass|0|UINT8|0x00000006
 
   ## Progress Code for TPM device subclass definitions.<BR><BR>
-  #  EFI_PERIPHERAL_TPM  = (EFI_PERIPHERAL | 0x000D0000) = 0x010D0000<BR>
+  #  EFI_PERIPHERAL_TPM  = (EFI_PERIPHERAL | 0x000E0000) = 0x010E0000<BR>
   # @Prompt Status Code for TPM device definitions
-  # @ValidList  0x80000003 | 0x010D0000
-  gEfiSecurityPkgTokenSpaceGuid.PcdStatusCodeSubClassTpmDevice|0x010D0000|UINT32|0x00000007
+  # @ValidList  0x80000003 | 0x010E0000
+  gEfiSecurityPkgTokenSpaceGuid.PcdStatusCodeSubClassTpmDevice|0x010E0000|UINT32|0x00000007
 
   ## Defines the IO port used to trigger a software System Management Interrupt (SMI).<BR><BR>
   #  Used as the SMI Command IO port by security functionality that triggers a software SMI such
diff --git a/SecurityPkg/SecurityPkg.uni b/SecurityPkg/SecurityPkg.uni
index 68587304d779..6c28b8021333 100644
--- a/SecurityPkg/SecurityPkg.uni
+++ b/SecurityPkg/SecurityPkg.uni
@@ -169,7 +169,7 @@
 #string STR_gEfiSecurityPkgTokenSpaceGuid_PcdStatusCodeSubClassTpmDevice_PROMPT  #language en-US "Status Code for TPM device definitions"
 
 #string STR_gEfiSecurityPkgTokenSpaceGuid_PcdStatusCodeSubClassTpmDevice_HELP  #language en-US "Progress Code for TPM device subclass definitions.<BR><BR>\n"
-                                                                                               "EFI_PERIPHERAL_TPM  = (EFI_PERIPHERAL | 0x000D0000) = 0x010D0000<BR>"
+                                                                                               "EFI_PERIPHERAL_TPM  = (EFI_PERIPHERAL | 0x000E0000) = 0x010E0000<BR>"
 
 #string STR_gEfiSecurityPkgTokenSpaceGuid_PcdRsa2048Sha256PublicKeyBuffer_PROMPT  #language en-US "One or more SHA 256 Hashes of RSA 2048 bit public keys used to verify Recovery and Capsule Update images"
 
-- 
2.37.0.windows.1

Re: [edk2-devel] [edk2-staging][PATCH v2 0/3] Add TPM subclass definition

[Michael D Kinney]

Series Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>


> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Kun Qin
> Sent: Wednesday, July 13, 2022 7:28 PM
> To: devel@edk2.groups.io
> Cc: Andrew Fish <afish@apple.com>; Leif Lindholm <leif@nuviainc.com>; Kinney, Michael D <michael.d.kinney@intel.com>; Gao,
> Liming <gaoliming@byosoft.com.cn>; Liu, Zhiguang <zhiguang.liu@intel.com>; Yao, Jiewen <jiewen.yao@intel.com>; Wang, Jian J
> <jian.j.wang@intel.com>; Zhang, Qi1 <qi1.zhang@intel.com>; Kumar, Rahul1 <rahul1.kumar@intel.com>
> Subject: [edk2-devel] [edk2-staging][PATCH v2 0/3] Add TPM subclass definition
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3966
> 
> This patch series is a follow up of previous submission:
> https://edk2.groups.io/g/devel/message/91075
> 
> v2 patch changes include feedback for v1 series:
> a. Removed PCD replacement related code change;
> 
> From PI Specification v1.7 Errata A, EFI_PERIPHERAL_DOCKING is defined as
> 0xD0000 (as well as included in PiStatusCode.h).
> 
> However, subclass employed as PCD for TPM peripheral in SecurityPkg is
> also defined as 0xD0000. The TPM subclass code was used in TcgPei.c when
> reporting error codes.
> 
> The collision of subclass definition could cause the parsing of reported
> errors being ambiguous.
> 
> This patch series add EFI_PERIPHERAL_TPM as a spec-defined value and
> removed potential usages in the SecurityPkg.
> 
> Patch v2 branch: https://github.com/kuqin12/edk2/tree/BZ3966-add_tpm_subclass_v2
> 
> Cc: Andrew Fish <afish@apple.com>
> Cc: Leif Lindholm <leif@nuviainc.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: Jiewen Yao <jiewen.yao@intel.com>
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Qi Zhang <qi1.zhang@intel.com>
> Cc: Rahul Kumar <rahul1.kumar@intel.com>
> 
> Kun Qin (3):
>   EDK2 Code First: PI Specification: New peripheral subclass for TPM
>   MdePkg: MmCommunication: Add TPM subclass definition to MdePkg
>   SecurityPkg: SubClassTpm: Updated default value
> 
>  CodeFirst/BZ3966-SpecChange.md   | 59 ++++++++++++++++++++
>  MdePkg/Include/Pi/PiStatusCode.h |  1 +
>  SecurityPkg/SecurityPkg.dec      |  6 +-
>  SecurityPkg/SecurityPkg.uni      |  2 +-
>  4 files changed, 64 insertions(+), 4 deletions(-)
>  create mode 100644 CodeFirst/BZ3966-SpecChange.md
> 
> --
> 2.37.0.windows.1
> 
> 
> 
> 
> 

Re: [edk2-devel] [edk2-staging][PATCH v2 0/3] Add TPM subclass definition

[Yao, Jiewen]

Reviewed by Jiewen Yao <Jiewen.yao@intel.com>

> -----Original Message-----
> From: Kinney, Michael D <michael.d.kinney@intel.com>
> Sent: Saturday, July 16, 2022 12:28 AM
> To: devel@edk2.groups.io; kuqin12@gmail.com; Kinney, Michael D
> <michael.d.kinney@intel.com>
> Cc: Andrew Fish <afish@apple.com>; Leif Lindholm <leif@nuviainc.com>; Gao,
> Liming <gaoliming@byosoft.com.cn>; Liu, Zhiguang <zhiguang.liu@intel.com>;
> Yao, Jiewen <jiewen.yao@intel.com>; Wang, Jian J <jian.j.wang@intel.com>;
> Zhang, Qi1 <qi1.zhang@intel.com>; Kumar, Rahul1 <rahul1.kumar@intel.com>
> Subject: RE: [edk2-devel] [edk2-staging][PATCH v2 0/3] Add TPM subclass
> definition
> 
> Series Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
> 
> 
> > -----Original Message-----
> > From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Kun Qin
> > Sent: Wednesday, July 13, 2022 7:28 PM
> > To: devel@edk2.groups.io
> > Cc: Andrew Fish <afish@apple.com>; Leif Lindholm <leif@nuviainc.com>;
> Kinney, Michael D <michael.d.kinney@intel.com>; Gao,
> > Liming <gaoliming@byosoft.com.cn>; Liu, Zhiguang <zhiguang.liu@intel.com>;
> Yao, Jiewen <jiewen.yao@intel.com>; Wang, Jian J
> > <jian.j.wang@intel.com>; Zhang, Qi1 <qi1.zhang@intel.com>; Kumar, Rahul1
> <rahul1.kumar@intel.com>
> > Subject: [edk2-devel] [edk2-staging][PATCH v2 0/3] Add TPM subclass
> definition
> >
> > REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3966
> >
> > This patch series is a follow up of previous submission:
> > https://edk2.groups.io/g/devel/message/91075
> >
> > v2 patch changes include feedback for v1 series:
> > a. Removed PCD replacement related code change;
> >
> > From PI Specification v1.7 Errata A, EFI_PERIPHERAL_DOCKING is defined as
> > 0xD0000 (as well as included in PiStatusCode.h).
> >
> > However, subclass employed as PCD for TPM peripheral in SecurityPkg is
> > also defined as 0xD0000. The TPM subclass code was used in TcgPei.c when
> > reporting error codes.
> >
> > The collision of subclass definition could cause the parsing of reported
> > errors being ambiguous.
> >
> > This patch series add EFI_PERIPHERAL_TPM as a spec-defined value and
> > removed potential usages in the SecurityPkg.
> >
> > Patch v2 branch: https://github.com/kuqin12/edk2/tree/BZ3966-
> add_tpm_subclass_v2
> >
> > Cc: Andrew Fish <afish@apple.com>
> > Cc: Leif Lindholm <leif@nuviainc.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: Jiewen Yao <jiewen.yao@intel.com>
> > Cc: Jian J Wang <jian.j.wang@intel.com>
> > Cc: Qi Zhang <qi1.zhang@intel.com>
> > Cc: Rahul Kumar <rahul1.kumar@intel.com>
> >
> > Kun Qin (3):
> >   EDK2 Code First: PI Specification: New peripheral subclass for TPM
> >   MdePkg: MmCommunication: Add TPM subclass definition to MdePkg
> >   SecurityPkg: SubClassTpm: Updated default value
> >
> >  CodeFirst/BZ3966-SpecChange.md   | 59 ++++++++++++++++++++
> >  MdePkg/Include/Pi/PiStatusCode.h |  1 +
> >  SecurityPkg/SecurityPkg.dec      |  6 +-
> >  SecurityPkg/SecurityPkg.uni      |  2 +-
> >  4 files changed, 64 insertions(+), 4 deletions(-)
> >  create mode 100644 CodeFirst/BZ3966-SpecChange.md
> >
> > --
> > 2.37.0.windows.1
> >
> >
> >
> > 
> >