MdeModulePkg/Universal/StatusCodeHandler/Smm/StatusCodeHandlerSmm.h

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