[PATCH v1 0/3] Adding Statuc Code Definitions from PI Spec v1.8

[PATCH v1 0/3] Adding Statuc Code Definitions from PI Spec v1.8

[Kun Qin]

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

This is an official patch series to add status codes into PiStatusCode,
continued from 2 previously sent code-first patch series:
https://edk2.groups.io/g/devel/message/91330
https://edk2.groups.io/g/devel/message/92093

Now the macro definitions have landed in PI spec v1.8, this patch is
to add them in Tianocore.

Patch v1 branch: https://github.com/kuqin12/edk2/tree/pi_v1p8_v1

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>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Zhiguang Liu <zhiguang.liu@intel.com>

Kun Qin (3):
  MdePkg: PiStatusCode: Add new Host Software class Error Code to MdePkg
  MdePkg: PiStatusCode: Add TPM subclass definition to MdePkg
  SecurityPkg: SubClassTpm: Updated default value

 MdePkg/Include/Pi/PiStatusCode.h | 42 ++++++++++----------
 SecurityPkg/SecurityPkg.dec      |  6 +--
 SecurityPkg/SecurityPkg.uni      |  2 +-
 3 files changed, 26 insertions(+), 24 deletions(-)

-- 
2.40.1.windows.1

[PATCH v1 1/3] MdePkg: PiStatusCode: Add new Host Software class Error Code to MdePkg

[Kun Qin]

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

This change introduces a new error code definitions under Host Software
class according to PI specification v1.8.

The new error code definition will cover system reboot events under the
conditions of inconsistent memory map from one boot to another.

These error codes could provide helpful datapoints to OEMs to investigate
and prevent system failures in general.

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>
---
 MdePkg/Include/Pi/PiStatusCode.h | 41 ++++++++++----------
 1 file changed, 21 insertions(+), 20 deletions(-)

diff --git a/MdePkg/Include/Pi/PiStatusCode.h b/MdePkg/Include/Pi/PiStatusCode.h
index ef2aea7364bc..3222a082c550 100644
--- a/MdePkg/Include/Pi/PiStatusCode.h
+++ b/MdePkg/Include/Pi/PiStatusCode.h
@@ -965,26 +965,27 @@ typedef struct {
 /// These are shared by all subclasses.
 ///
 ///@{
-#define EFI_SW_EC_NON_SPECIFIC            0x00000000
-#define EFI_SW_EC_LOAD_ERROR              0x00000001
-#define EFI_SW_EC_INVALID_PARAMETER       0x00000002
-#define EFI_SW_EC_UNSUPPORTED             0x00000003
-#define EFI_SW_EC_INVALID_BUFFER          0x00000004
-#define EFI_SW_EC_OUT_OF_RESOURCES        0x00000005
-#define EFI_SW_EC_ABORTED                 0x00000006
-#define EFI_SW_EC_ILLEGAL_SOFTWARE_STATE  0x00000007
-#define EFI_SW_EC_ILLEGAL_HARDWARE_STATE  0x00000008
-#define EFI_SW_EC_START_ERROR             0x00000009
-#define EFI_SW_EC_BAD_DATE_TIME           0x0000000A
-#define EFI_SW_EC_CFG_INVALID             0x0000000B
-#define EFI_SW_EC_CFG_CLR_REQUEST         0x0000000C
-#define EFI_SW_EC_CFG_DEFAULT             0x0000000D
-#define EFI_SW_EC_PWD_INVALID             0x0000000E
-#define EFI_SW_EC_PWD_CLR_REQUEST         0x0000000F
-#define EFI_SW_EC_PWD_CLEARED             0x00000010
-#define EFI_SW_EC_EVENT_LOG_FULL          0x00000011
-#define EFI_SW_EC_WRITE_PROTECTED         0x00000012
-#define EFI_SW_EC_FV_CORRUPTED            0x00000013
+#define EFI_SW_EC_NON_SPECIFIC             0x00000000
+#define EFI_SW_EC_LOAD_ERROR               0x00000001
+#define EFI_SW_EC_INVALID_PARAMETER        0x00000002
+#define EFI_SW_EC_UNSUPPORTED              0x00000003
+#define EFI_SW_EC_INVALID_BUFFER           0x00000004
+#define EFI_SW_EC_OUT_OF_RESOURCES         0x00000005
+#define EFI_SW_EC_ABORTED                  0x00000006
+#define EFI_SW_EC_ILLEGAL_SOFTWARE_STATE   0x00000007
+#define EFI_SW_EC_ILLEGAL_HARDWARE_STATE   0x00000008
+#define EFI_SW_EC_START_ERROR              0x00000009
+#define EFI_SW_EC_BAD_DATE_TIME            0x0000000A
+#define EFI_SW_EC_CFG_INVALID              0x0000000B
+#define EFI_SW_EC_CFG_CLR_REQUEST          0x0000000C
+#define EFI_SW_EC_CFG_DEFAULT              0x0000000D
+#define EFI_SW_EC_PWD_INVALID              0x0000000E
+#define EFI_SW_EC_PWD_CLR_REQUEST          0x0000000F
+#define EFI_SW_EC_PWD_CLEARED              0x00000010
+#define EFI_SW_EC_EVENT_LOG_FULL           0x00000011
+#define EFI_SW_EC_WRITE_PROTECTED          0x00000012
+#define EFI_SW_EC_FV_CORRUPTED             0x00000013
+#define EFI_SW_EC_INCONSISTENT_MEMORY_MAP  0x00000014
 ///@}
 
 //
-- 
2.40.1.windows.1

[PATCH v1 2/3] MdePkg: PiStatusCode: 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 from PI
specification v1.8.

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>
---
 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 3222a082c550..6675431611cb 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 EFI_PERIPHERAL_TPM              (EFI_PERIPHERAL | 0x000E0000)
 ///@}
 
 ///
-- 
2.40.1.windows.1

[PATCH v1 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 v1.8.

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>
---
 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 0a8042d63fe1..53aa7ec43557 100644
--- a/SecurityPkg/SecurityPkg.dec
+++ b/SecurityPkg/SecurityPkg.dec
@@ -308,10 +308,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.40.1.windows.1

Re: [edk2-devel] [PATCH v1 3/3] SecurityPkg: SubClassTpm: Updated default value

[Yao, Jiewen]

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

> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Kun Qin
> Sent: Friday, June 2, 2023 2:30 AM
> To: devel@edk2.groups.io
> Cc: Yao, Jiewen <jiewen.yao@intel.com>; Wang, Jian J <jian.j.wang@intel.com>;
> Zhang, Qi1 <qi1.zhang@intel.com>; Kumar, Rahul R <rahul.r.kumar@intel.com>
> Subject: [edk2-devel] [PATCH v1 3/3] SecurityPkg: SubClassTpm: Updated
> default value
> 
> 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 v1.8.
> 
> 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>
> ---
>  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 0a8042d63fe1..53aa7ec43557 100644
> --- a/SecurityPkg/SecurityPkg.dec
> +++ b/SecurityPkg/SecurityPkg.dec
> @@ -308,10 +308,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|0x010D000
> 0|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_PROM
> PT  #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_PRO
> MPT  #language en-US "One or more SHA 256 Hashes of RSA 2048 bit public keys
> used to verify Recovery and Capsule Update images"
> 
> 
> 
> --
> 2.40.1.windows.1
> 
> 
> 
> -=-=-=-=-=-=
> Groups.io Links: You receive all messages sent to this group.
> View/Reply Online (#105602): https://edk2.groups.io/g/devel/message/105602
> Mute This Topic: https://groups.io/mt/99271148/1772286
> Group Owner: devel+owner@edk2.groups.io
> Unsubscribe: https://edk2.groups.io/g/devel/unsub [jiewen.yao@intel.com]
> -=-=-=-=-=-=
> 

回复: [PATCH v1 0/3] Adding Statuc Code Definitions from PI Spec v1.8

[gaoliming]

Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>

> -----邮件原件-----
> 发件人: Kun Qin <kuqin12@gmail.com>
> 发送时间: 2023年6月2日 2:30
> 收件人: devel@edk2.groups.io
> 抄送: Jiewen Yao <jiewen.yao@intel.com>; Jian J Wang
> <jian.j.wang@intel.com>; Qi Zhang <qi1.zhang@intel.com>; Rahul Kumar
> <rahul1.kumar@intel.com>; Michael D Kinney <michael.d.kinney@intel.com>;
> Liming Gao <gaoliming@byosoft.com.cn>; Zhiguang Liu
> <zhiguang.liu@intel.com>
> 主题: [PATCH v1 0/3] Adding Statuc Code Definitions from PI Spec v1.8
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3794
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3966
> 
> This is an official patch series to add status codes into PiStatusCode,
> continued from 2 previously sent code-first patch series:
> https://edk2.groups.io/g/devel/message/91330
> https://edk2.groups.io/g/devel/message/92093
> 
> Now the macro definitions have landed in PI spec v1.8, this patch is
> to add them in Tianocore.
> 
> Patch v1 branch: https://github.com/kuqin12/edk2/tree/pi_v1p8_v1
> 
> 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>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Zhiguang Liu <zhiguang.liu@intel.com>
> 
> Kun Qin (3):
>   MdePkg: PiStatusCode: Add new Host Software class Error Code to MdePkg
>   MdePkg: PiStatusCode: Add TPM subclass definition to MdePkg
>   SecurityPkg: SubClassTpm: Updated default value
> 
>  MdePkg/Include/Pi/PiStatusCode.h | 42 ++++++++++----------
>  SecurityPkg/SecurityPkg.dec      |  6 +--
>  SecurityPkg/SecurityPkg.uni      |  2 +-
>  3 files changed, 26 insertions(+), 24 deletions(-)
> 
> --
> 2.40.1.windows.1

Re: [edk2-devel] 回复: [PATCH v1 0/3] Adding Statuc Code Definitions from PI Spec v1.8

[Kun Qin]

Hi Liming/Jiewen,

Do you mind helping merging this patch series? It has collected necessary
reviewed-by tags already:
https://edk2.groups.io/g/devel/message/105602
https://edk2.groups.io/g/devel/message/105609

Please let me know if it is preferable for me to add the garner and send 
a v2.

Thanks,
Kun

On 6/1/2023 6:18 PM, gaoliming via groups.io wrote:
> Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
>
>> -----邮件原件-----
>> 发件人: Kun Qin <kuqin12@gmail.com>
>> 发送时间: 2023年6月2日 2:30
>> 收件人: devel@edk2.groups.io
>> 抄送: Jiewen Yao <jiewen.yao@intel.com>; Jian J Wang
>> <jian.j.wang@intel.com>; Qi Zhang <qi1.zhang@intel.com>; Rahul Kumar
>> <rahul1.kumar@intel.com>; Michael D Kinney <michael.d.kinney@intel.com>;
>> Liming Gao <gaoliming@byosoft.com.cn>; Zhiguang Liu
>> <zhiguang.liu@intel.com>
>> 主题: [PATCH v1 0/3] Adding Statuc Code Definitions from PI Spec v1.8
>>
>> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3794
>> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3966
>>
>> This is an official patch series to add status codes into PiStatusCode,
>> continued from 2 previously sent code-first patch series:
>> https://edk2.groups.io/g/devel/message/91330
>> https://edk2.groups.io/g/devel/message/92093
>>
>> Now the macro definitions have landed in PI spec v1.8, this patch is
>> to add them in Tianocore.
>>
>> Patch v1 branch: https://github.com/kuqin12/edk2/tree/pi_v1p8_v1
>>
>> 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>
>> Cc: Michael D Kinney <michael.d.kinney@intel.com>
>> Cc: Liming Gao <gaoliming@byosoft.com.cn>
>> Cc: Zhiguang Liu <zhiguang.liu@intel.com>
>>
>> Kun Qin (3):
>>    MdePkg: PiStatusCode: Add new Host Software class Error Code to MdePkg
>>    MdePkg: PiStatusCode: Add TPM subclass definition to MdePkg
>>    SecurityPkg: SubClassTpm: Updated default value
>>
>>   MdePkg/Include/Pi/PiStatusCode.h | 42 ++++++++++----------
>>   SecurityPkg/SecurityPkg.dec      |  6 +--
>>   SecurityPkg/SecurityPkg.uni      |  2 +-
>>   3 files changed, 26 insertions(+), 24 deletions(-)
>>
>> --
>> 2.40.1.windows.1
>
>
>
>
> 
>
>