Split Nt32OemHookStatusCodeLib to PEI/DXE instances

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

2 files changed, 299 insertions, 0 deletions

diff --git a/EdkNt32Pkg/Library/DxeNt32OemHookStatusCodeLib/DxeNt32OemHookStatusCodeLib.msa b/EdkNt32Pkg/Library/DxeNt32OemHookStatusCodeLib/DxeNt32OemHookStatusCodeLib.msa
new file mode 100644
index 0000000000..463c607375
--- /dev/null
+++ b/EdkNt32Pkg/Library/DxeNt32OemHookStatusCodeLib/DxeNt32OemHookStatusCodeLib.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>DxeNt32OemHookStatusCodeLib</ModuleName>

+    <ModuleType>DXE_DRIVER</ModuleType>

+    <GuidValue>EF172A23-C7C5-47b7-B24E-D10DFE15540F</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>DxeNt32OemHookStatusCodeLib</OutputFileBasename>

+  </ModuleDefinitions>

+  <LibraryClassDefinitions>

+    <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>DebugLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>HobLib</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>

+  </LibraryClassDefinitions>

+  <SourceFiles>

+    <Filename>Nt32OemHookStatusCodeLib.c</Filename>

+  </SourceFiles>

+  <PackageDependencies>

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

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

+    <Package PackageGuid="0fb2aa2d-10d5-40a5-a9dc-060c12a4a3f3"/>

+  </PackageDependencies>

+  <Protocols>

+    <Protocol Usage="ALWAYS_CONSUMED">

+      <ProtocolCName>gEfiWinNtThunkProtocolGuid</ProtocolCName>

+    </Protocol>

+  </Protocols>

+  <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>
\ No newline at end of file
diff --git a/EdkNt32Pkg/Library/DxeNt32OemHookStatusCodeLib/Nt32OemHookStatusCodeLib.c b/EdkNt32Pkg/Library/DxeNt32OemHookStatusCodeLib/Nt32OemHookStatusCodeLib.c
new file mode 100644
index 0000000000..942d7eaed6
--- /dev/null
+++ b/EdkNt32Pkg/Library/DxeNt32OemHookStatusCodeLib/Nt32OemHookStatusCodeLib.c
@@ -0,0 +1,231 @@
+/** @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:  Nt32OemHookStatusCodeLib.c

+

+**/

+

+//

+// Cache of WinNtThunk protocol 

+//

+STATIC

+EFI_WIN_NT_THUNK_PROTOCOL   *mWinNt;

+

+//

+// Cache of standard output handle . 

+//

+STATIC

+HANDLE                      mStdOut;

+

+/**

+

+  Initialize OEM status code device .

+

+  @return    Always return EFI_SUCCESS.

+

+**/

+EFI_STATUS

+EFIAPI

+OemHookStatusCodeInitialize (

+  VOID

+  )

+{

+  EFI_HOB_GUID_TYPE   *GuidHob;

+

+  //

+  // Retrieve WinNtThunkProtocol from GUID'ed HOB

+  //

+  GuidHob = GetFirstGuidHob (&gEfiWinNtThunkProtocolGuid);

+  ASSERT (GuidHob != NULL);

+  mWinNt = (EFI_WIN_NT_THUNK_PROTOCOL *)(*(UINTN *)(GET_GUID_HOB_DATA (GuidHob)));

+  ASSERT (mWinNt != NULL);

+

+  //

+  // Cache standard output handle.

+  //

+  mStdOut = mWinNt->GetStdHandle (STD_OUTPUT_HANDLE);

+

+  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.

+    //

+    mWinNt->WriteFile (

+              mStdOut,

+              Buffer,

+              CharCount,

+              &CharCount,

+              NULL

+              );

+

+    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.

+  //

+  mWinNt->WriteFile (

+            mStdOut,

+            Buffer,

+            CharCount,

+            &CharCount,

+            NULL

+            );

+

+  return EFI_SUCCESS;

+}

+