MdeModulePkg/Include/Library/OemHookStatusCodeLib.h

   1 /** @file
   2   OEM hook status code library. Platform can implement an instance to
   3   initialize the OEM devices to report status code information.
   4
   5 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
   6 SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef __OEM_HOOK_STATUSCODE_LIB__
  11 #define __OEM_HOOK_STATUSCODE_LIB__
  12
  13 /**
  14
  15   Initialize OEM status code device.
  16
  17
  18   @return    Status of initialization of OEM status code device.
  19
  20 **/
  21 EFI_STATUS
  22 EFIAPI
  23 OemHookStatusCodeInitialize (
  24   VOID
  25   );
  26
  27 /**
  28   Report status code to OEM device.
  29
  30   @param  CodeType      Indicates the type of status code being reported.
  31
  32   @param  Value         Describes the current status of a hardware or software entity.
  33                         This includes both an operation and classification information
  34                         about the class and subclass.
  35                         For progress codes, the operation is the current activity.
  36                         For error codes, it is the exception.  For debug codes,
  37                         it is not defined at this time.
  38                         Specific values are discussed in the Intel Platform Innovation
  39                         Framework for EFI Status Code Specification.
  40
  41   @param  Instance      The enumeration of a hardware or software entity within the system.
  42                         A system may contain multiple entities that match a class/subclass
  43                         pairing.
  44                         The instance differentiates between them.  An instance of 0
  45                         indicates that instance information is unavailable,
  46                         not meaningful, or not relevant.  Valid instance numbers
  47                         start with 1.
  48
  49
  50   @param  CallerId      This optional parameter may be used to identify the caller.
  51                         This parameter allows the status code driver to apply
  52                         different rules to different callers.
  53                         Type EFI_GUID is defined in InstallProtocolInterface()
  54                         in the UEFI 2.0 Specification.
  55
  56
  57   @param  Data          This optional parameter may be used to pass additional data.
  58
  59   @return               The function always returns EFI_SUCCESS.
  60
  61 **/
  62 EFI_STATUS
  63 EFIAPI
  64 OemHookStatusCodeReport (
  65   IN EFI_STATUS_CODE_TYPE   CodeType,
  66   IN EFI_STATUS_CODE_VALUE  Value,
  67   IN UINT32                 Instance,
  68   IN EFI_GUID               *CallerId  OPTIONAL,
  69   IN EFI_STATUS_CODE_DATA   *Data      OPTIONAL
  70   );
  71
  72 #endif // __OEM_HOOK_STATUSCODE_LIB__