MdeModulePkg/MemoryStatusCode: Expose the DXE memory status code table.

Let data of DXE memory status code can be used by other modules.
1. Save the address of DXE memory status code table to DxeConfigurationTable.
2. Save the address of SMM memory status code table to SmmConfigurationTable.
3. Move RUNTIME_MEMORY_STATUSCODE_HEADER to its public header file.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Cinnamon Shia <cinnamon.shia@hpe.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

6 files changed, 48 insertions, 44 deletions

diff --git a/MdeModulePkg/Universal/StatusCodeHandler/RuntimeDxe/MemoryStatusCodeWorker.c b/MdeModulePkg/Universal/StatusCodeHandler/RuntimeDxe/MemoryStatusCodeWorker.c
index 8680497693..a306d7517f 100644
--- a/MdeModulePkg/Universal/StatusCodeHandler/RuntimeDxe/MemoryStatusCodeWorker.c
+++ b/MdeModulePkg/Universal/StatusCodeHandler/RuntimeDxe/MemoryStatusCodeWorker.c
@@ -2,13 +2,14 @@
   Runtime memory status code worker.

 

   Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>

-  This program and the accompanying materials                          

-  are licensed and made available under the terms and conditions of the BSD License         

-  which accompanies this distribution.  The full text of the license may be found at        

-  http://opensource.org/licenses/bsd-license.php                                            

-                                                                                            

-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+  (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>

+  This program and the accompanying materials

+  are licensed and made available under the terms and conditions of the BSD License

+  which accompanies this distribution.  The full text of the license may be found at

+  http://opensource.org/licenses/bsd-license.php

+

+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

 **/

 

@@ -18,8 +19,9 @@ RUNTIME_MEMORY_STATUSCODE_HEADER  *mRtMemoryStatusCodeTable;
 

 /**

   Initialize runtime memory status code table as initialization for runtime memory status code worker

- 

+

   @retval EFI_SUCCESS  Runtime memory status code table successfully initialized.

+  @retval others       Errors from gBS->InstallConfigurationTable().

 

 **/

 EFI_STATUS

@@ -27,6 +29,8 @@ RtMemoryStatusCodeInitializeWorker (
   VOID

   )

 {

+  EFI_STATUS                        Status;

+

   //

   // Allocate runtime memory status code pool.

   //

@@ -40,15 +44,16 @@ RtMemoryStatusCodeInitializeWorker (
   mRtMemoryStatusCodeTable->NumberOfRecords  = 0;

   mRtMemoryStatusCodeTable->MaxRecordsNumber = 

     (PcdGet16 (PcdStatusCodeMemorySize) * 1024) / sizeof (MEMORY_STATUSCODE_RECORD);

+  Status = gBS->InstallConfigurationTable (&gMemoryStatusCodeRecordGuid, mRtMemoryStatusCodeTable);

 

-  return EFI_SUCCESS;

+  return Status;

 }

 

 

 /**

   Report status code into runtime memory. If the runtime pool is full, roll back to the 

   first record and overwrite it.

- 

+

   @param  CodeType                Indicates the type of status code being reported.

   @param  Value                   Describes the current status of a hardware or software entity.

                                   This included information about the class and subclass that is used to

@@ -59,7 +64,7 @@ RtMemoryStatusCodeInitializeWorker (
                                   This parameter allows the status code driver to apply different rules to

                                   different callers.

   @param  Data                    This optional parameter may be used to pass additional data.

- 

+

   @retval EFI_SUCCESS             Status code successfully recorded in runtime memory status code table.

 

 **/

diff --git a/MdeModulePkg/Universal/StatusCodeHandler/RuntimeDxe/StatusCodeHandlerRuntimeDxe.h b/MdeModulePkg/Universal/StatusCodeHandler/RuntimeDxe/StatusCodeHandlerRuntimeDxe.h
index 2bf341202e..a3185f5b52 100644
--- a/MdeModulePkg/Universal/StatusCodeHandler/RuntimeDxe/StatusCodeHandlerRuntimeDxe.h
+++ b/MdeModulePkg/Universal/StatusCodeHandler/RuntimeDxe/StatusCodeHandlerRuntimeDxe.h
@@ -2,6 +2,7 @@
   Internal include file for Status Code Handler Driver.

 

   Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>

+  (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>

   This program and the accompanying materials

   are licensed and made available under the terms and conditions of the BSD License

   which accompanies this distribution.  The full text of the license may be found at

@@ -40,15 +41,6 @@
 //

 #define MAX_DEBUG_MESSAGE_LENGTH 0x100

 

-//

-// Runtime memory status code worker definition

-//

-typedef struct {

-  UINT32   RecordIndex;

-  UINT32   NumberOfRecords;

-  UINT32   MaxRecordsNumber;

-} RUNTIME_MEMORY_STATUSCODE_HEADER;

-

 extern RUNTIME_MEMORY_STATUSCODE_HEADER  *mRtMemoryStatusCodeTable;

 

 /**

@@ -65,7 +57,7 @@ EfiSerialStatusCodeInitializeWorker (
 

 /**

   Convert status code value and extended data to readable ASCII string, send string to serial I/O device.

- 

+

   @param  CodeType         Indicates the type of status code being reported.

   @param  Value            Describes the current status of a hardware or software entity.

                            This included information about the class and subclass that is used to

@@ -96,6 +88,7 @@ SerialStatusCodeReportWorker (
   Initialize runtime memory status code table as initialization for runtime memory status code worker

  

   @retval EFI_SUCCESS  Runtime memory status code table successfully initialized.

+  @retval others       Errors from gBS->InstallConfigurationTable().

 

 **/

 EFI_STATUS

@@ -106,7 +99,7 @@ RtMemoryStatusCodeInitializeWorker (
 /**

   Report status code into runtime memory. If the runtime pool is full, roll back to the 

   first record and overwrite it.

- 

+

   @param  CodeType                Indicates the type of status code being reported.

   @param  Value                   Describes the current status of a hardware or software entity.

                                   This included information about the class and subclass that is used to

@@ -117,7 +110,7 @@ RtMemoryStatusCodeInitializeWorker (
                                   This parameter allows the status code driver to apply different rules to

                                   different callers.

   @param  Data                    This optional parameter may be used to pass additional data.

- 

+

   @retval EFI_SUCCESS             Status code successfully recorded in runtime memory status code table.

 

 **/

diff --git a/MdeModulePkg/Universal/StatusCodeHandler/RuntimeDxe/StatusCodeHandlerRuntimeDxe.inf b/MdeModulePkg/Universal/StatusCodeHandler/RuntimeDxe/StatusCodeHandlerRuntimeDxe.inf
index ba22ca48cf..637804f5de 100644
--- a/MdeModulePkg/Universal/StatusCodeHandler/RuntimeDxe/StatusCodeHandlerRuntimeDxe.inf
+++ b/MdeModulePkg/Universal/StatusCodeHandler/RuntimeDxe/StatusCodeHandlerRuntimeDxe.inf
@@ -2,6 +2,7 @@
 #  Status Code Handler Driver which produces general handlers and hook them onto the DXE status code router.

 #

 #  Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>

+#  (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>

 #

 #  This program and the accompanying materials

 #  are licensed and made available under the terms and conditions of the BSD License

@@ -52,7 +53,9 @@
   BaseMemoryLib

   

 [Guids]

-  gMemoryStatusCodeRecordGuid                   ## SOMETIMES_CONSUMES   ## HOB

+  ## SOMETIMES_CONSUMES   ## HOB

+  ## SOMETIMES_PRODUCES   ## SystemTable

+  gMemoryStatusCodeRecordGuid

   gEfiStatusCodeDataTypeStringGuid              ## SOMETIMES_CONSUMES   ## UNDEFINED

   gEfiEventVirtualAddressChangeGuid             ## CONSUMES ## Event

   gEfiEventExitBootServicesGuid                 ## CONSUMES ## Event

diff --git a/MdeModulePkg/Universal/StatusCodeHandler/Smm/MemoryStatusCodeWorker.c b/MdeModulePkg/Universal/StatusCodeHandler/Smm/MemoryStatusCodeWorker.c
index 78d908b16e..6baf2dd0f2 100644
--- a/MdeModulePkg/Universal/StatusCodeHandler/Smm/MemoryStatusCodeWorker.c
+++ b/MdeModulePkg/Universal/StatusCodeHandler/Smm/MemoryStatusCodeWorker.c
@@ -2,11 +2,12 @@
   Runtime memory status code worker.

 

   Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

+  (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>

   This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License         

   which accompanies this distribution.  The full text of the license may be found at        

   http://opensource.org/licenses/bsd-license.php                                            

-                                                                                            

+

   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

 

@@ -18,15 +19,17 @@ RUNTIME_MEMORY_STATUSCODE_HEADER  *mSmmMemoryStatusCodeTable;
 

 /**

   Initialize SMM memory status code table as initialization for memory status code worker

- 

-  @retval EFI_SUCCESS  SMM memory status code table successfully initialized.

 

+  @retval EFI_SUCCESS  SMM memory status code table successfully initialized.

+  @retval others       Errors from gSmst->SmmInstallConfigurationTable().

 **/

 EFI_STATUS

 MemoryStatusCodeInitializeWorker (

   VOID

   )

 {

+  EFI_STATUS                        Status;

+

   //

   // Allocate SMM memory status code pool.

   //

@@ -34,14 +37,20 @@ MemoryStatusCodeInitializeWorker (
   ASSERT (mSmmMemoryStatusCodeTable != NULL);

 

   mSmmMemoryStatusCodeTable->MaxRecordsNumber = (PcdGet16 (PcdStatusCodeMemorySize) * 1024) / sizeof (MEMORY_STATUSCODE_RECORD);

-  return EFI_SUCCESS;

+  Status = gSmst->SmmInstallConfigurationTable (

+                    gSmst,

+                    &gMemoryStatusCodeRecordGuid,

+                    &mSmmMemoryStatusCodeTable,

+                    sizeof (mSmmMemoryStatusCodeTable)

+                    );

+  return Status;

 }

 

 

 /**

   Report status code into runtime memory. If the runtime pool is full, roll back to the 

   first record and overwrite it.

- 

+

   @param  CodeType                Indicates the type of status code being reported.

   @param  Value                   Describes the current status of a hardware or software entity.

                                   This included information about the class and subclass that is used to

@@ -52,7 +61,7 @@ MemoryStatusCodeInitializeWorker (
                                   This parameter allows the status code driver to apply different rules to

                                   different callers.

   @param  Data                    This optional parameter may be used to pass additional data.

- 

+

   @retval EFI_SUCCESS             Status code successfully recorded in runtime memory status code table.

 

 **/

diff --git a/MdeModulePkg/Universal/StatusCodeHandler/Smm/StatusCodeHandlerSmm.h b/MdeModulePkg/Universal/StatusCodeHandler/Smm/StatusCodeHandlerSmm.h
index ee85a69c5a..1a374c2ead 100644
--- a/MdeModulePkg/Universal/StatusCodeHandler/Smm/StatusCodeHandlerSmm.h
+++ b/MdeModulePkg/Universal/StatusCodeHandler/Smm/StatusCodeHandlerSmm.h
@@ -2,6 +2,7 @@
   Internal include file for Status Code Handler Driver.

 

   Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>

+  (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>

   This program and the accompanying materials

   are licensed and made available under the terms and conditions of the BSD License

   which accompanies this distribution.  The full text of the license may be found at

@@ -37,20 +38,11 @@
 //

 #define MAX_DEBUG_MESSAGE_LENGTH 0x100

 

-//

-// Runtime memory status code worker definition

-//

-typedef struct {

-  UINT32   RecordIndex;

-  UINT32   NumberOfRecords;

-  UINT32   MaxRecordsNumber;

-} RUNTIME_MEMORY_STATUSCODE_HEADER;

-

 extern RUNTIME_MEMORY_STATUSCODE_HEADER  *mSmmMemoryStatusCodeTable;

 

 /**

   Locates Serial I/O Protocol as initialization for serial status code worker.

- 

+

   @retval EFI_SUCCESS  Serial I/O Protocol is successfully located.

 

 **/

@@ -62,7 +54,7 @@ EfiSerialStatusCodeInitializeWorker (
 

 /**

   Convert status code value and extended data to readable ASCII string, send string to serial I/O device.

- 

+

   @param  CodeType         Indicates the type of status code being reported.

   @param  Value            Describes the current status of a hardware or software entity.

                            This included information about the class and subclass that is used to

@@ -103,7 +95,7 @@ MemoryStatusCodeInitializeWorker (
 /**

   Report status code into runtime memory. If the runtime pool is full, roll back to the 

   first record and overwrite it.

- 

+

   @param  CodeType                Indicates the type of status code being reported.

   @param  Value                   Describes the current status of a hardware or software entity.

                                   This included information about the class and subclass that is used to

@@ -114,7 +106,7 @@ MemoryStatusCodeInitializeWorker (
                                   This parameter allows the status code driver to apply different rules to

                                   different callers.

   @param  Data                    This optional parameter may be used to pass additional data.

- 

+

   @retval EFI_SUCCESS             Status code successfully recorded in runtime memory status code table.

 

 **/

diff --git a/MdeModulePkg/Universal/StatusCodeHandler/Smm/StatusCodeHandlerSmm.inf b/MdeModulePkg/Universal/StatusCodeHandler/Smm/StatusCodeHandlerSmm.inf
index 1e66fbf83f..7b5073546e 100644
--- a/MdeModulePkg/Universal/StatusCodeHandler/Smm/StatusCodeHandlerSmm.inf
+++ b/MdeModulePkg/Universal/StatusCodeHandler/Smm/StatusCodeHandlerSmm.inf
@@ -2,6 +2,7 @@
 #  Status Code Handler Driver which produces general handlers and hook them onto the SMM status code router.

 #

 #  Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>

+#  (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>

 #

 #  This program and the accompanying materials

 #  are licensed and made available under the terms and conditions of the BSD License

@@ -49,9 +50,10 @@
   DebugLib

   MemoryAllocationLib

   BaseMemoryLib

-  

+

 [Guids]

   gEfiStatusCodeDataTypeStringGuid              ## SOMETIMES_CONSUMES   ## UNDEFINED

+  gMemoryStatusCodeRecordGuid                   ## SOMETIMES_PRODUCES   ## UNDEFINED # SmmSystemTable

 

 [Protocols]

   gEfiSmmRscHandlerProtocolGuid                 ## CONSUMES