UnixPkg/Library/DxeUnixOemHookStatusCodeLib/UnixOemHookStatusCodeLib.c

   1 /** @file
   2   OEM hook status code library functions with no library constructor/destructor
   3
   4   Copyright (c) 2006, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13   Module Name:  UnixOemHookStatusCodeLib.c
  14
  15 **/
  16 #include "PiDxe.h"
  17 #include <Guid/StatusCodeDataTypeId.h>
  18 #include "UnixDxe.h"
  19 #include <Library/OemHookStatusCodeLib.h>
  20 #include <Library/DebugLib.h>
  21 #include <Library/HobLib.h>
  22 #include <Library/PrintLib.h>
  23 #include <Library/BaseMemoryLib.h>
  24 #include <Library/ReportStatusCodeLib.h>
  25 #include <FrameworkModuleBase.h>
  26 #include <DebugInfo.h>
  27
  28 //
  29 // Cache of UnixThunk protocol
  30 //
  31 EFI_UNIX_THUNK_PROTOCOL   *mUnix;
  32
  33 //
  34 // Cache of standard output handle .
  35 //
  36 int                      mStdOut;
  37
  38 /**
  39
  40   Initialize OEM status code device .
  41
  42   @return    Always return EFI_SUCCESS.
  43
  44 **/
  45 EFI_STATUS
  46 EFIAPI
  47 OemHookStatusCodeInitialize (
  48   VOID
  49   )
  50 {
  51   EFI_HOB_GUID_TYPE        *GuidHob;
  52
  53   //
  54   // Retrieve UnixThunkProtocol from GUID'ed HOB
  55   //
  56   GuidHob = GetFirstGuidHob (&gEfiUnixThunkProtocolGuid);
  57   ASSERT (GuidHob != NULL);
  58   mUnix = (EFI_UNIX_THUNK_PROTOCOL *)(*(UINTN *)(GET_GUID_HOB_DATA (GuidHob)));
  59   ASSERT (mUnix != NULL);
  60
  61   //
  62   // Cache standard output handle.
  63   //
  64   mStdOut = 1;
  65
  66   return EFI_SUCCESS;
  67 }
  68
  69 /**
  70   Report status code to OEM device.
  71
  72   @param  CodeType      Indicates the type of status code being reported.  Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.
  73
  74   @param  Value         Describes the current status of a hardware or software entity.
  75                         This included information about the class and subclass that is used to classify the entity
  76                         as well as an operation.  For progress codes, the operation is the current activity.
  77                         For error codes, it is the exception.  For debug codes, it is not defined at this time.
  78                         Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.
  79                         Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.
  80
  81   @param  Instance      The enumeration of a hardware or software entity within the system.
  82                         A system may contain multiple entities that match a class/subclass pairing.
  83                         The instance differentiates between them.  An instance of 0 indicates that instance information is unavailable,
  84                         not meaningful, or not relevant.  Valid instance numbers start with 1.
  85
  86
  87   @param  CallerId      This optional parameter may be used to identify the caller.
  88                         This parameter allows the status code driver to apply different rules to different callers.
  89                         Type EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification.
  90
  91
  92   @param  Data          This optional parameter may be used to pass additional data
  93
  94   @return               The function always return EFI_SUCCESS.
  95
  96 **/
  97 EFI_STATUS
  98 EFIAPI
  99 OemHookStatusCodeReport (
 100   IN EFI_STATUS_CODE_TYPE     CodeType,
 101   IN EFI_STATUS_CODE_VALUE    Value,
 102   IN UINT32                   Instance,
 103   IN EFI_GUID                 *CallerId, OPTIONAL
 104   IN EFI_STATUS_CODE_DATA     *Data      OPTIONAL
 105   )
 106 {
 107   CHAR8           *Filename;
 108   CHAR8           *Description;
 109   CHAR8           *Format;
 110   CHAR8           Buffer[EFI_STATUS_CODE_DATA_MAX_SIZE];
 111   UINT32          ErrorLevel;
 112   UINT32          LineNumber;
 113   UINTN           CharCount;
 114   BASE_LIST       Marker;
 115   EFI_DEBUG_INFO  *DebugInfo;
 116
 117   Buffer[0] = '\0';
 118
 119   if (Data != NULL &&
 120       ReportStatusCodeExtractAssertInfo (CodeType, Value, Data, &Filename, &Description, &LineNumber)) {
 121     //
 122     // Print ASSERT() information into output buffer.
 123     //
 124     CharCount = AsciiSPrint (
 125                   Buffer,
 126                   EFI_STATUS_CODE_DATA_MAX_SIZE,
 127                   "\n\rASSERT!: %a (%d): %a\n\r",
 128                   Filename,
 129                   LineNumber,
 130                   Description
 131                   );
 132
 133     //
 134     // Callout to standard output.
 135     //
 136     mUnix->Write (
 137               mStdOut,
 138               Buffer,
 139               CharCount
 140               );
 141
 142     return EFI_SUCCESS;
 143
 144   } else if (Data != NULL &&
 145              ReportStatusCodeExtractDebugInfo (Data, &ErrorLevel, &Marker, &Format)) {
 146     //
 147     // Print DEBUG() information into output buffer.
 148     //
 149     CharCount = AsciiBSPrint (
 150                   Buffer,
 151                   EFI_STATUS_CODE_DATA_MAX_SIZE,
 152                   Format,
 153                   Marker
 154                   );
 155   } else if (Data != NULL &&
 156              CompareGuid (&Data->Type, &gEfiStatusCodeSpecificDataGuid) &&
 157              (CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_DEBUG_CODE) {
 158     //
 159     // Print specific data into output buffer.
 160     //
 161     DebugInfo = (EFI_DEBUG_INFO *) (Data + 1);
 162     Marker    = (BASE_LIST) (DebugInfo + 1);
 163     Format    = (CHAR8 *) (((UINT64 *) Marker) + 12);
 164
 165     CharCount = AsciiBSPrint (Buffer, EFI_STATUS_CODE_DATA_MAX_SIZE, Format, Marker);
 166   } else if ((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) {
 167     //
 168     // Print ERROR information into output buffer.
 169     //
 170     CharCount = AsciiSPrint (
 171                   Buffer,
 172                   EFI_STATUS_CODE_DATA_MAX_SIZE,
 173                   "ERROR: C%x:V%x I%x",
 174                   CodeType,
 175                   Value,
 176                   Instance
 177                   );
 178
 179     //
 180     // Make sure we don't try to print values that weren't intended to be printed, especially NULL GUID pointers.
 181     //
 182
 183     if (CallerId != NULL) {
 184       CharCount += AsciiSPrint (
 185                      &Buffer[CharCount - 1],
 186                      (EFI_STATUS_CODE_DATA_MAX_SIZE - (sizeof (Buffer[0]) * CharCount)),
 187                      " %g",
 188                      CallerId
 189                      );
 190     }
 191
 192     if (Data != NULL) {
 193       CharCount += AsciiSPrint (
 194                      &Buffer[CharCount - 1],
 195                      (EFI_STATUS_CODE_DATA_MAX_SIZE - (sizeof (Buffer[0]) * CharCount)),
 196                      " %x",
 197                      Data
 198                      );
 199     }
 200
 201     CharCount += AsciiSPrint (
 202                    &Buffer[CharCount - 1],
 203                    (EFI_STATUS_CODE_DATA_MAX_SIZE - (sizeof (Buffer[0]) * CharCount)),
 204                    "\n\r"
 205                    );
 206   } else if ((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) {
 207     CharCount = AsciiSPrint (
 208                   Buffer,
 209                   EFI_STATUS_CODE_DATA_MAX_SIZE,
 210                   "PROGRESS CODE: V%x I%x\n\r",
 211                   Value,
 212                   Instance
 213                   );
 214   } else {
 215     CharCount = AsciiSPrint (
 216                   Buffer,
 217                   EFI_STATUS_CODE_DATA_MAX_SIZE,
 218                   "Undefined: C%x:V%x I%x\n\r",
 219                   CodeType,
 220                   Value,
 221                   Instance
 222                   );
 223   }
 224
 225   //
 226   // Callout to standard output.
 227   //
 228   mUnix->Write (
 229             mStdOut,
 230             Buffer,
 231             CharCount
 232             );
 233
 234   return EFI_SUCCESS;
 235 }
 236