MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Universal / StatusCodeHandler / Smm / StatusCodeHandlerSmm.h

/** @file\r
  Internal include file for Status Code Handler Driver.\r
\r
  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
  (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __STATUS_CODE_HANDLER_SMM_H__\r
#define __STATUS_CODE_HANDLER_SMM_H__\r
\r
#include <Protocol/SmmReportStatusCodeHandler.h>\r
\r
#include <Guid/MemoryStatusCodeRecord.h>\r
#include <Guid/StatusCodeDataTypeId.h>\r
#include <Guid/StatusCodeDataTypeDebug.h>\r
\r
#include <Library/SynchronizationLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/SmmServicesTableLib.h>\r
#include <Library/SerialPortLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/BaseMemoryLib.h>\r
\r
//\r
// Define the maximum message length\r
//\r
#define MAX_DEBUG_MESSAGE_LENGTH 0x100\r
\r
extern RUNTIME_MEMORY_STATUSCODE_HEADER  *mSmmMemoryStatusCodeTable;\r
\r
/**\r
  Locates Serial I/O Protocol as initialization for serial status code worker.\r
\r
  @retval EFI_SUCCESS  Serial I/O Protocol is successfully located.\r
\r
**/\r
EFI_STATUS\r
EfiSerialStatusCodeInitializeWorker (\r
  VOID\r
  );\r
\r
\r
/**\r
  Convert status code value and extended data to readable ASCII string, send string to serial I/O device.\r
\r
  @param  CodeType         Indicates the type of status code being reported.\r
  @param  Value            Describes the current status of a hardware or software entity.\r
                           This included information about the class and subclass that is used to\r
                           classify the entity as well as an operation.\r
  @param  Instance         The enumeration of a hardware or software entity within\r
                           the system. Valid instance numbers start with 1.\r
  @param  CallerId         This optional parameter may be used to identify the caller.\r
                           This parameter allows the status code driver to apply different rules to\r
                           different callers.\r
  @param  Data             This optional parameter may be used to pass additional data.\r
\r
  @retval EFI_SUCCESS      Status code reported to serial I/O successfully.\r
  @retval EFI_DEVICE_ERROR EFI serial device cannot work after ExitBootService() is called.\r
  @retval EFI_DEVICE_ERROR EFI serial device cannot work with TPL higher than TPL_CALLBACK.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SerialStatusCodeReportWorker (\r
  IN EFI_STATUS_CODE_TYPE     CodeType,\r
  IN EFI_STATUS_CODE_VALUE    Value,\r
  IN UINT32                   Instance,\r
  IN EFI_GUID                 *CallerId,\r
  IN EFI_STATUS_CODE_DATA     *Data OPTIONAL\r
  );\r
\r
/**\r
  Initialize runtime memory status code table as initialization for runtime memory status code worker\r
\r
  @retval EFI_SUCCESS  Runtime memory status code table successfully initialized.\r
\r
**/\r
EFI_STATUS\r
MemoryStatusCodeInitializeWorker (\r
  VOID\r
  );\r
\r
/**\r
  Report status code into runtime memory. If the runtime pool is full, roll back to the\r
  first record and overwrite it.\r
\r
  @param  CodeType                Indicates the type of status code being reported.\r
  @param  Value                   Describes the current status of a hardware or software entity.\r
                                  This included information about the class and subclass that is used to\r
                                  classify the entity as well as an operation.\r
  @param  Instance                The enumeration of a hardware or software entity within\r
                                  the system. Valid instance numbers start with 1.\r
  @param  CallerId                This optional parameter may be used to identify the caller.\r
                                  This parameter allows the status code driver to apply different rules to\r
                                  different callers.\r
  @param  Data                    This optional parameter may be used to pass additional data.\r
\r
  @retval EFI_SUCCESS             Status code successfully recorded in runtime memory status code table.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
MemoryStatusCodeReportWorker (\r
  IN EFI_STATUS_CODE_TYPE               CodeType,\r
  IN EFI_STATUS_CODE_VALUE              Value,\r
  IN UINT32                             Instance,\r
  IN EFI_GUID                           *CallerId,\r
  IN EFI_STATUS_CODE_DATA               *Data OPTIONAL\r
  );\r
\r
#endif\r