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 This program and the accompanying materials are licensed and made available under
   7 the terms and conditions of the BSD License that accompanies this distribution.
   8 The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php.
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __OEM_HOOK_STATUSCODE_LIB__
  17 #define __OEM_HOOK_STATUSCODE_LIB__
  18
  19 /**
  20
  21   Initialize OEM status code device.
  22
  23
  24   @return    Status of initialization of OEM status code device.
  25
  26 **/
  27 EFI_STATUS
  28 EFIAPI
  29 OemHookStatusCodeInitialize (
  30   VOID
  31   );
  32
  33 /**
  34   Report status code to OEM device.
  35
  36   @param  CodeType      Indicates the type of status code being reported.
  37
  38   @param  Value         Describes the current status of a hardware or software entity.
  39                         This includes both an operation and classification information
  40                         about the class and subclass.
  41                         For progress codes, the operation is the current activity.
  42                         For error codes, it is the exception.  For debug codes,
  43                         it is not defined at this time.
  44                         Specific values are discussed in the Intel Platform Innovation
  45                         Framework for EFI Status Code Specification.
  46
  47   @param  Instance      The enumeration of a hardware or software entity within the system.
  48                         A system may contain multiple entities that match a class/subclass
  49                         pairing.
  50                         The instance differentiates between them.  An instance of 0
  51                         indicates that instance information is unavailable,
  52                         not meaningful, or not relevant.  Valid instance numbers
  53                         start with 1.
  54
  55
  56   @param  CallerId      This optional parameter may be used to identify the caller.
  57                         This parameter allows the status code driver to apply
  58                         different rules to different callers.
  59                         Type EFI_GUID is defined in InstallProtocolInterface()
  60                         in the UEFI 2.0 Specification.
  61
  62
  63   @param  Data          This optional parameter may be used to pass additional data.
  64
  65   @return               The function always returns EFI_SUCCESS.
  66
  67 **/
  68 EFI_STATUS
  69 EFIAPI
  70 OemHookStatusCodeReport (
  71   IN EFI_STATUS_CODE_TYPE     CodeType,
  72   IN EFI_STATUS_CODE_VALUE    Value,
  73   IN UINT32                   Instance,
  74   IN EFI_GUID                 *CallerId, OPTIONAL
  75   IN EFI_STATUS_CODE_DATA     *Data      OPTIONAL
  76   );
  77
  78 #endif // __OEM_HOOK_STATUSCODE_LIB__
  79