Split UnixOemHookStatusCodeLib to PEI/DXE instances

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@2380 6f19259b-4bc3-4df7-8a09-765794883524

4 files changed, 321 insertions, 58 deletions

diff --git a/EdkUnixPkg/Library/UnixOemHookStatusCodeLib/UnixOemHookStatusCodeLib.msa b/EdkUnixPkg/Library/DxeUnixOemHookStatusCodeLib/DxeUnixOemHookStatusCodeLib.msa
index 859390274a..7e9aeebd85 100644
--- a/EdkUnixPkg/Library/UnixOemHookStatusCodeLib/UnixOemHookStatusCodeLib.msa
+++ b/EdkUnixPkg/Library/DxeUnixOemHookStatusCodeLib/DxeUnixOemHookStatusCodeLib.msa
@@ -1,44 +1,36 @@
 <?xml version="1.0" encoding="UTF-8"?>

 <ModuleSurfaceArea xmlns="http://www.TianoCore.org/2006/Edk2.0">

   <MsaHeader>

-    <ModuleName>UnixOemHookStatusCodeLib</ModuleName>

-    <ModuleType>PEIM</ModuleType>

-    <GuidValue>f3c32014-8985-11db-bae7-0040d02b1835</GuidValue>

+    <ModuleName>DxeUnixOemHookStatusCodeLib</ModuleName>

+    <ModuleType>DXE_DRIVER</ModuleType>

+    <GuidValue>0BB6F68A-2FC5-4394-9375-2B43F1C34B59</GuidValue>

     <Version>1.0</Version>

     <Abstract>Memory Status Code Library for UEFI drivers</Abstract>

     <Description>Lib to provide memory journal status code reporting Routines</Description>

-    <Copyright>Copyright (c) 2006, Intel Corporation.</Copyright>

-    <License>

-      All rights reserved.

+    <Copyright>Copyright (c) 2007, Intel Corporation.</Copyright>

+    <License>All rights reserved.

       This software and associated documentation (if any) is furnished

       under a license and may only be used or copied in accordance

       with the terms of the license. Except as permitted by such

       license, no part of this software or documentation may be

       reproduced, stored in a retrieval system, or transmitted in any

       form or by any means without the express written consent of

-      Intel Corporation.

-    </License>

+      Intel Corporation.</License>

     <Specification>FRAMEWORK_BUILD_PACKAGING_SPECIFICATION   0x00000052</Specification>

   </MsaHeader>

   <ModuleDefinitions>

     <SupportedArchitectures>IA32</SupportedArchitectures>

     <BinaryModule>false</BinaryModule>

-    <OutputFileBasename>UnixOemHookStatusCodeLib</OutputFileBasename>

+    <OutputFileBasename>DxeUnixOemHookStatusCodeLib</OutputFileBasename>

   </ModuleDefinitions>

   <LibraryClassDefinitions>

-    <LibraryClass Usage="ALWAYS_PRODUCED">

+    <LibraryClass Usage="ALWAYS_PRODUCED" SupModuleList="DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER">

       <Keyword>OemHookStatusCodeLib</Keyword>

     </LibraryClass>

     <LibraryClass Usage="ALWAYS_CONSUMED">

-      <Keyword>BaseLib</Keyword>

-    </LibraryClass>

-    <LibraryClass Usage="ALWAYS_CONSUMED">

       <Keyword>DebugLib</Keyword>

     </LibraryClass>

     <LibraryClass Usage="ALWAYS_CONSUMED">

-      <Keyword>PcdLib</Keyword>

-    </LibraryClass>

-    <LibraryClass Usage="ALWAYS_CONSUMED">

       <Keyword>HobLib</Keyword>

     </LibraryClass>

     <LibraryClass Usage="ALWAYS_CONSUMED">

@@ -50,12 +42,6 @@
     <LibraryClass Usage="ALWAYS_CONSUMED">

       <Keyword>ReportStatusCodeLib</Keyword>

     </LibraryClass>

-    <LibraryClass Usage="ALWAYS_CONSUMED">

-      <Keyword>PeiServicesLib</Keyword>

-    </LibraryClass>

-    <LibraryClass Usage="ALWAYS_CONSUMED">

-      <Keyword>UnixLib</Keyword>

-    </LibraryClass>

   </LibraryClassDefinitions>

   <SourceFiles>

     <Filename>UnixOemHookStatusCodeLib.c</Filename>

@@ -70,20 +56,13 @@
       <ProtocolCName>gEfiUnixThunkProtocolGuid</ProtocolCName>

     </Protocol>

   </Protocols>

-  <PPIs>

-    <Ppi Usage="ALWAYS_CONSUMED">

-      <PpiCName>gPeiUnixThunkPpiGuid</PpiCName>

-    </Ppi>

-  </PPIs>

+  <Guids>

+    <GuidCNames Usage="ALWAYS_CONSUMED">

+      <GuidCName>gEfiStatusCodeSpecificDataGuid</GuidCName>

+    </GuidCNames>

+  </Guids>

   <Externs>

     <Specification>EFI_SPECIFICATION_VERSION 0x00020000</Specification>

     <Specification>EDK_RELEASE_VERSION 0x00020000</Specification>

   </Externs>

-  <PcdCoded xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

-    <PcdEntry PcdItemType="FEATURE_FLAG">

-      <C_Name>PcdUnixStatusCodeLibUseForPei</C_Name>

-      <TokenSpaceGuidCName>gEfiEdkUnixPkgTokenSpaceGuid</TokenSpaceGuidCName>

-      <HelpText>Select which type of driver the library links against.</HelpText>

-    </PcdEntry>

-  </PcdCoded>

 </ModuleSurfaceArea>
diff --git a/EdkUnixPkg/Library/DxeUnixOemHookStatusCodeLib/UnixOemHookStatusCodeLib.c b/EdkUnixPkg/Library/DxeUnixOemHookStatusCodeLib/UnixOemHookStatusCodeLib.c
new file mode 100644
index 0000000000..0cfad2601f
--- /dev/null
+++ b/EdkUnixPkg/Library/DxeUnixOemHookStatusCodeLib/UnixOemHookStatusCodeLib.c
@@ -0,0 +1,227 @@
+/** @file

+  OEM hook status code library functions with no library constructor/destructor

+

+  Copyright (c) 2006, Intel Corporation

+  All rights reserved. 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.

+

+  Module Name:  UnixOemHookStatusCodeLib.c

+

+**/

+

+//

+// Cache of UnixThunk protocol 

+//

+STATIC

+EFI_UNIX_THUNK_PROTOCOL   *mUnix;

+

+//

+// Cache of standard output handle . 

+//

+STATIC

+int                      mStdOut;

+

+/**

+

+  Initialize OEM status code device .

+

+  @return    Always return EFI_SUCCESS.

+

+**/

+EFI_STATUS

+EFIAPI

+OemHookStatusCodeInitialize (

+  VOID

+  )

+{

+  EFI_HOB_GUID_TYPE        *GuidHob;

+

+  //

+  // Retrieve UnixThunkProtocol from GUID'ed HOB

+  //

+  GuidHob = GetFirstGuidHob (&gEfiUnixThunkProtocolGuid);

+  ASSERT (GuidHob != NULL);

+  mUnix = (EFI_UNIX_THUNK_PROTOCOL *)(*(UINTN *)(GET_GUID_HOB_DATA (GuidHob)));

+  ASSERT (mUnix != NULL);

+

+  //

+  // Cache standard output handle.

+  //

+  mStdOut = 1;
+

+  return EFI_SUCCESS;

+}

+

+/**

+  Report status code to OEM device.

+ 

+  @param  CodeType      Indicates the type of status code being reported.  Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.

+ 

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

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

+                        as well as an operation.  For progress codes, the operation is the current activity. 

+                        For error codes, it is the exception.  For debug codes, it is not defined at this time. 

+                        Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.  

+                        Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.

+ 

+  @param  Instance      The enumeration of a hardware or software entity within the system.  

+                        A system may contain multiple entities that match a class/subclass pairing. 

+                        The instance differentiates between them.  An instance of 0 indicates that instance information is unavailable, 

+                        not meaningful, or not relevant.  Valid instance numbers start with 1.

+

+

+  @param  CallerId      This optional parameter may be used to identify the caller. 

+                        This parameter allows the status code driver to apply different rules to different callers. 

+                        Type EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification.

+

+

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

+ 

+  @return               The function always return EFI_SUCCESS.

+

+**/

+EFI_STATUS

+EFIAPI

+OemHookStatusCodeReport (

+  IN EFI_STATUS_CODE_TYPE     CodeType,

+  IN EFI_STATUS_CODE_VALUE    Value,

+  IN UINT32                   Instance,

+  IN EFI_GUID                 *CallerId, OPTIONAL

+  IN EFI_STATUS_CODE_DATA     *Data      OPTIONAL

+  )

+{

+  CHAR8           *Filename;

+  CHAR8           *Description;

+  CHAR8           *Format;

+  CHAR8           Buffer[EFI_STATUS_CODE_DATA_MAX_SIZE];

+  UINT32          ErrorLevel;

+  UINT32          LineNumber;

+  UINTN           CharCount;

+  VA_LIST         Marker;

+  EFI_DEBUG_INFO  *DebugInfo;

+

+  Buffer[0] = '\0';

+

+  if (Data != NULL &&

+      ReportStatusCodeExtractAssertInfo (CodeType, Value, Data, &Filename, &Description, &LineNumber)) {

+    //

+    // Print ASSERT() information into output buffer.

+    //

+    CharCount = AsciiSPrint (

+                  Buffer,

+                  EFI_STATUS_CODE_DATA_MAX_SIZE,

+                  "\n\rASSERT!: %a (%d): %a\n\r",

+                  Filename,

+                  LineNumber,

+                  Description

+                  );

+

+    //

+    // Callout to standard output.

+    //

+    mUnix->Write (

+              mStdOut,

+              Buffer,

+              CharCount

+	      );
+

+    return EFI_SUCCESS;

+

+  } else if (Data != NULL &&

+             ReportStatusCodeExtractDebugInfo (Data, &ErrorLevel, &Marker, &Format)) {

+    //

+    // Print DEBUG() information into output buffer.

+    //

+    CharCount = AsciiVSPrint (

+                  Buffer, 

+                  EFI_STATUS_CODE_DATA_MAX_SIZE, 

+                  Format, 

+                  Marker

+                  );

+  } else if (Data != NULL && 

+             CompareGuid (&Data->Type, &gEfiStatusCodeSpecificDataGuid) &&

+             (CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_DEBUG_CODE) {

+    //

+    // Print specific data into output buffer.

+    //

+    DebugInfo = (EFI_DEBUG_INFO *) (Data + 1);

+    Marker    = (VA_LIST) (DebugInfo + 1);

+    Format    = (CHAR8 *) (((UINT64 *) Marker) + 12);

+

+    CharCount = AsciiVSPrint (Buffer, EFI_STATUS_CODE_DATA_MAX_SIZE, Format, Marker);

+  } else if ((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) {

+    //

+    // Print ERROR information into output buffer.

+    //

+    CharCount = AsciiSPrint (

+                  Buffer, 

+                  EFI_STATUS_CODE_DATA_MAX_SIZE, 

+                  "ERROR: C%x:V%x I%x", 

+                  CodeType, 

+                  Value, 

+                  Instance

+                  );

+

+    //

+    // Make sure we don't try to print values that weren't intended to be printed, especially NULL GUID pointers.

+    //

+    

+    if (CallerId != NULL) {

+      CharCount += AsciiSPrint (

+                     &Buffer[CharCount - 1],

+                     (EFI_STATUS_CODE_DATA_MAX_SIZE - (sizeof (Buffer[0]) * CharCount)),

+                     " %g",

+                     CallerId

+                     );

+    }

+

+    if (Data != NULL) {

+      CharCount += AsciiSPrint (

+                     &Buffer[CharCount - 1],

+                     (EFI_STATUS_CODE_DATA_MAX_SIZE - (sizeof (Buffer[0]) * CharCount)),

+                     " %x",

+                     Data

+                     );

+    }

+

+    CharCount += AsciiSPrint (

+                   &Buffer[CharCount - 1],

+                   (EFI_STATUS_CODE_DATA_MAX_SIZE - (sizeof (Buffer[0]) * CharCount)),

+                   "\n\r"

+                   );

+  } else if ((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) {

+    CharCount = AsciiSPrint (

+                  Buffer, 

+                  EFI_STATUS_CODE_DATA_MAX_SIZE, 

+                  "PROGRESS CODE: V%x I%x\n\r", 

+                  Value, 

+                  Instance

+                  );

+  } else {

+    CharCount = AsciiSPrint (

+                  Buffer, 

+                  EFI_STATUS_CODE_DATA_MAX_SIZE, 

+                  "Undefined: C%x:V%x I%x\n\r", 

+                  CodeType, 

+                  Value, 

+                  Instance

+                  );

+  }

+

+  //

+  // Callout to standard output.

+  //

+  mUnix->Write (

+            mStdOut,

+            Buffer,

+            CharCount

+            );

+

+  return EFI_SUCCESS;

+}

+

diff --git a/EdkUnixPkg/Library/PeiUnixOemHookStatusCodeLib/PeiUnixOemHookStatusCodeLib.msa b/EdkUnixPkg/Library/PeiUnixOemHookStatusCodeLib/PeiUnixOemHookStatusCodeLib.msa
new file mode 100644
index 0000000000..f80a105736
--- /dev/null
+++ b/EdkUnixPkg/Library/PeiUnixOemHookStatusCodeLib/PeiUnixOemHookStatusCodeLib.msa
@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="UTF-8"?>

+<ModuleSurfaceArea xmlns="http://www.TianoCore.org/2006/Edk2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

+  <MsaHeader>

+    <ModuleName>PeiUnixOemHookStatusCodeLib</ModuleName>

+    <ModuleType>PEIM</ModuleType>

+    <GuidValue>23E378C1-B199-49ad-9F14-DAF5D3C7EC28</GuidValue>

+    <Version>1.0</Version>

+    <Abstract>Memory Status Code Library for UEFI drivers</Abstract>

+    <Description>Lib to provide memory journal status code reporting Routines</Description>

+    <Copyright>Copyright (c) 2007, Intel Corporation.</Copyright>

+    <License>All rights reserved.

+      This software and associated documentation (if any) is furnished

+      under a license and may only be used or copied in accordance

+      with the terms of the license. Except as permitted by such

+      license, no part of this software or documentation may be

+      reproduced, stored in a retrieval system, or transmitted in any

+      form or by any means without the express written consent of

+      Intel Corporation.</License>

+    <Specification>FRAMEWORK_BUILD_PACKAGING_SPECIFICATION   0x00000052</Specification>

+  </MsaHeader>

+  <ModuleDefinitions>

+    <SupportedArchitectures>IA32</SupportedArchitectures>

+    <BinaryModule>false</BinaryModule>

+    <OutputFileBasename>PeiUnixOemHookStatusCodeLib</OutputFileBasename>

+  </ModuleDefinitions>

+  <LibraryClassDefinitions>

+    <LibraryClass Usage="ALWAYS_PRODUCED" SupModuleList="PEIM">

+      <Keyword>OemHookStatusCodeLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>DebugLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>PrintLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>BaseMemoryLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>ReportStatusCodeLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>PeiServicesLib</Keyword>

+    </LibraryClass>

+  </LibraryClassDefinitions>

+  <SourceFiles>

+    <Filename>UnixOemHookStatusCodeLib.c</Filename>

+  </SourceFiles>

+  <PackageDependencies>

+    <Package PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec"/>

+    <Package PackageGuid="68169ab0-d41b-4009-9060-292c253ac43d"/>

+    <Package PackageGuid="f2805c44-8985-11db-9e98-0040d02b1835"/>

+  </PackageDependencies>

+  <PPIs>

+    <Ppi Usage="ALWAYS_CONSUMED">

+      <PpiCName>gPeiUnixThunkPpiGuid</PpiCName>

+    </Ppi>

+  </PPIs>

+  <Guids>

+    <GuidCNames Usage="ALWAYS_CONSUMED">

+      <GuidCName>gEfiStatusCodeSpecificDataGuid</GuidCName>

+    </GuidCNames>

+  </Guids>

+  <Externs>

+    <Specification>EFI_SPECIFICATION_VERSION 0x00020000</Specification>

+    <Specification>EDK_RELEASE_VERSION 0x00020000</Specification>

+  </Externs>

+</ModuleSurfaceArea>
diff --git a/EdkUnixPkg/Library/UnixOemHookStatusCodeLib/UnixOemHookStatusCodeLib.c b/EdkUnixPkg/Library/PeiUnixOemHookStatusCodeLib/UnixOemHookStatusCodeLib.c
index 34f5e0dc51..a7dada2fe8 100644
--- a/EdkUnixPkg/Library/UnixOemHookStatusCodeLib/UnixOemHookStatusCodeLib.c
+++ b/EdkUnixPkg/Library/PeiUnixOemHookStatusCodeLib/UnixOemHookStatusCodeLib.c
@@ -42,32 +42,21 @@ OemHookStatusCodeInitialize (
   PEI_UNIX_THUNK_PPI  *UnixThunkPpi;

   EFI_STATUS        Status;

 

-  if (FeaturePcdGet (PcdUnixStatusCodeLibUseForPei)) {

-    //

-    // Locate NtThunkPpi for retrieving standard output handle

-    //

-    Status = PeiServicesLocatePpi (

-               &gPeiUnixThunkPpiGuid,

-               0,

-               NULL,

-               (VOID **) &UnixThunkPpi

-               );

-

-    ASSERT_EFI_ERROR (Status);

-

-    mUnix  = (EFI_UNIX_THUNK_PROTOCOL *) UnixThunkPpi->UnixThunk ();

-  } else {

-    EFI_HOB_GUID_TYPE        *GuidHob;

+  

+  //

+  // Locate Unix ThunkPpi for retrieving standard output handle

+  //

+  Status = PeiServicesLocatePpi (

+              &gPeiUnixThunkPpiGuid,

+              0,

+              NULL,

+              (VOID **) &UnixThunkPpi

+              );

 

-    //

-    // Retrieve UnixThunkProtocol from GUID'ed HOB

-    //

-    GuidHob = GetFirstGuidHob (&gEfiUnixThunkProtocolGuid);

-    ASSERT (GuidHob != NULL);

-    mUnix = (EFI_UNIX_THUNK_PROTOCOL *)(*(UINTN *)(GET_GUID_HOB_DATA (GuidHob)));

-    ASSERT (mUnix != NULL);

-  }

+  ASSERT_EFI_ERROR (Status);

 

+  mUnix  = (EFI_UNIX_THUNK_PROTOCOL *) UnixThunkPpi->UnixThunk ();

+  

   //

   // Cache standard output handle.

   //