MdeModulePkg/Universal/StatusCodeHandler/Smm/StatusCodeHandlerSmm.h

   1 /** @file
   2   Internal include file for Status Code Handler Driver.
   3
   4   Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
   5   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 **/
  14
  15 #ifndef __STATUS_CODE_HANDLER_SMM_H__
  16 #define __STATUS_CODE_HANDLER_SMM_H__
  17
  18 #include <Protocol/SmmReportStatusCodeHandler.h>
  19
  20 #include <Guid/MemoryStatusCodeRecord.h>
  21 #include <Guid/StatusCodeDataTypeId.h>
  22 #include <Guid/StatusCodeDataTypeDebug.h>
  23
  24 #include <Library/SynchronizationLib.h>
  25 #include <Library/DebugLib.h>
  26 #include <Library/ReportStatusCodeLib.h>
  27 #include <Library/PrintLib.h>
  28 #include <Library/PcdLib.h>
  29 #include <Library/UefiDriverEntryPoint.h>
  30 #include <Library/SmmServicesTableLib.h>
  31 #include <Library/SerialPortLib.h>
  32 #include <Library/MemoryAllocationLib.h>
  33 #include <Library/BaseMemoryLib.h>
  34
  35 //
  36 // Runtime memory status code worker definition
  37 //
  38 typedef struct {
  39   UINT32   RecordIndex;
  40   UINT32   NumberOfRecords;
  41   UINT32   MaxRecordsNumber;
  42 } RUNTIME_MEMORY_STATUSCODE_HEADER;
  43
  44 extern RUNTIME_MEMORY_STATUSCODE_HEADER  *mSmmMemoryStatusCodeTable;
  45
  46 /**
  47   Locates Serial I/O Protocol as initialization for serial status code worker.
  48
  49   @retval EFI_SUCCESS  Serial I/O Protocol is successfully located.
  50
  51 **/
  52 EFI_STATUS
  53 EfiSerialStatusCodeInitializeWorker (
  54   VOID
  55   );
  56
  57
  58 /**
  59   Convert status code value and extended data to readable ASCII string, send string to serial I/O device.
  60
  61   @param  CodeType         Indicates the type of status code being reported.
  62   @param  Value            Describes the current status of a hardware or software entity.
  63                            This included information about the class and subclass that is used to
  64                            classify the entity as well as an operation.
  65   @param  Instance         The enumeration of a hardware or software entity within
  66                            the system. Valid instance numbers start with 1.
  67   @param  CallerId         This optional parameter may be used to identify the caller.
  68                            This parameter allows the status code driver to apply different rules to
  69                            different callers.
  70   @param  Data             This optional parameter may be used to pass additional data.
  71
  72   @retval EFI_SUCCESS      Status code reported to serial I/O successfully.
  73   @retval EFI_DEVICE_ERROR EFI serial device cannot work after ExitBootService() is called.
  74   @retval EFI_DEVICE_ERROR EFI serial device cannot work with TPL higher than TPL_CALLBACK.
  75
  76 **/
  77 EFI_STATUS
  78 EFIAPI
  79 SerialStatusCodeReportWorker (
  80   IN EFI_STATUS_CODE_TYPE     CodeType,
  81   IN EFI_STATUS_CODE_VALUE    Value,
  82   IN UINT32                   Instance,
  83   IN EFI_GUID                 *CallerId,
  84   IN EFI_STATUS_CODE_DATA     *Data OPTIONAL
  85   );
  86
  87 /**
  88   Initialize runtime memory status code table as initialization for runtime memory status code worker
  89
  90   @retval EFI_SUCCESS  Runtime memory status code table successfully initialized.
  91
  92 **/
  93 EFI_STATUS
  94 MemoryStatusCodeInitializeWorker (
  95   VOID
  96   );
  97
  98 /**
  99   Report status code into runtime memory. If the runtime pool is full, roll back to the
 100   first record and overwrite it.
 101
 102   @param  CodeType                Indicates the type of status code being reported.
 103   @param  Value                   Describes the current status of a hardware or software entity.
 104                                   This included information about the class and subclass that is used to
 105                                   classify the entity as well as an operation.
 106   @param  Instance                The enumeration of a hardware or software entity within
 107                                   the system. Valid instance numbers start with 1.
 108   @param  CallerId                This optional parameter may be used to identify the caller.
 109                                   This parameter allows the status code driver to apply different rules to
 110                                   different callers.
 111   @param  Data                    This optional parameter may be used to pass additional data.
 112
 113   @retval EFI_SUCCESS             Status code successfully recorded in runtime memory status code table.
 114
 115 **/
 116 EFI_STATUS
 117 EFIAPI
 118 MemoryStatusCodeReportWorker (
 119   IN EFI_STATUS_CODE_TYPE               CodeType,
 120   IN EFI_STATUS_CODE_VALUE              Value,
 121   IN UINT32                             Instance,
 122   IN EFI_GUID                           *CallerId,
 123   IN EFI_STATUS_CODE_DATA               *Data OPTIONAL
 124   );
 125
 126 #endif