MdeModulePkg/Universal/ReportStatusCodeRouter/RuntimeDxe/ReportStatusCodeRouterRuntimeDxe.h

   1 /** @file
   2   Internal include file for Report Status Code Router 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 __REPORT_STATUS_CODE_ROUTER_RUNTIME_DXE_H__
  16 #define __REPORT_STATUS_CODE_ROUTER_RUNTIME_DXE_H__
  17
  18
  19 #include <Protocol/ReportStatusCodeHandler.h>
  20 #include <Protocol/StatusCode.h>
  21
  22 #include <Guid/EventGroup.h>
  23
  24 #include <Library/BaseLib.h>
  25 #include <Library/SynchronizationLib.h>
  26 #include <Library/DebugLib.h>
  27 #include <Library/PcdLib.h>
  28 #include <Library/HobLib.h>
  29 #include <Library/UefiDriverEntryPoint.h>
  30 #include <Library/UefiBootServicesTableLib.h>
  31 #include <Library/MemoryAllocationLib.h>
  32 #include <Library/UefiRuntimeLib.h>
  33
  34 #define RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE  SIGNATURE_32 ('r', 'h', 'c', 'e')
  35
  36 typedef struct {
  37   UINTN                     Signature;
  38   EFI_RSC_HANDLER_CALLBACK  RscHandlerCallback;
  39   EFI_TPL                   Tpl;
  40   LIST_ENTRY                Node;
  41 } RSC_HANDLER_CALLBACK_ENTRY;
  42
  43 typedef struct {
  44   EFI_RSC_HANDLER_CALLBACK RscHandlerCallback;
  45   EFI_STATUS_CODE_TYPE     Type;
  46   EFI_STATUS_CODE_VALUE    Value;
  47   UINT32                   Instance;
  48   EFI_GUID                 *CallerId;
  49   EFI_STATUS_CODE_DATA     *Data;
  50 } RSC_EVENT_CONTEXT;
  51
  52 /**
  53   Register the callback function for ReportStatusCode() notification.
  54
  55   When this function is called the function pointer is added to an internal list and any future calls to
  56   ReportStatusCode() will be forwarded to the Callback function. During the bootservices,
  57   this is the callback for which this service can be invoked. The report status code router
  58   will create an event such that the callback function is only invoked at the TPL for which it was
  59   registered. The entity that registers for the callback should also register for an event upon
  60   generation of exit boot services and invoke the unregister service.
  61   If the handler does not have a TPL dependency, it should register for a callback at TPL high. The
  62   router infrastructure will support making callbacks at runtime, but the caller for runtime invocation
  63   must meet the following criteria:
  64   1. must be a runtime driver type so that its memory is not reclaimed
  65   2. not unregister at exit boot services so that the router will still have its callback address
  66   3. the caller must be self-contained (eg. Not call out into any boot-service interfaces) and be
  67   runtime safe, in general.
  68
  69   @param[in] Callback   A pointer to a function of type EFI_RSC_HANDLER_CALLBACK that is called when
  70                         a call to ReportStatusCode() occurs.
  71   @param[in] Tpl        TPL at which callback can be safely invoked.
  72
  73   @retval  EFI_SUCCESS              Function was successfully registered.
  74   @retval  EFI_INVALID_PARAMETER    The callback function was NULL.
  75   @retval  EFI_OUT_OF_RESOURCES     The internal buffer ran out of space. No more functions can be
  76                                     registered.
  77   @retval  EFI_ALREADY_STARTED      The function was already registered. It can't be registered again.
  78
  79 **/
  80 EFI_STATUS
  81 EFIAPI
  82 Register (
  83   IN EFI_RSC_HANDLER_CALLBACK   Callback,
  84   IN EFI_TPL                    Tpl
  85   );
  86
  87 /**
  88   Remove a previously registered callback function from the notification list.
  89
  90   A callback function must be unregistered before it is deallocated. It is important that any registered
  91   callbacks that are not runtime complaint be unregistered when ExitBootServices() is called.
  92
  93   @param[in]  Callback  A pointer to a function of type EFI_RSC_HANDLER_CALLBACK that is to be
  94                         unregistered.
  95
  96   @retval EFI_SUCCESS           The function was successfully unregistered.
  97   @retval EFI_INVALID_PARAMETER The callback function was NULL.
  98   @retval EFI_NOT_FOUND         The callback function was not found to be unregistered.
  99
 100 **/
 101 EFI_STATUS
 102 EFIAPI
 103 Unregister (
 104   IN EFI_RSC_HANDLER_CALLBACK Callback
 105   );
 106
 107 /**
 108   Provides an interface that a software module can call to report a status code.
 109
 110   @param  Type             Indicates the type of status code being reported.
 111   @param  Value            Describes the current status of a hardware or software entity.
 112                            This included information about the class and subclass that is used to
 113                            classify the entity as well as an operation.
 114   @param  Instance         The enumeration of a hardware or software entity within
 115                            the system. Valid instance numbers start with 1.
 116   @param  CallerId         This optional parameter may be used to identify the caller.
 117                            This parameter allows the status code driver to apply different rules to
 118                            different callers.
 119   @param  Data             This optional parameter may be used to pass additional data.
 120
 121   @retval EFI_SUCCESS           The function completed successfully
 122   @retval EFI_DEVICE_ERROR      The function should not be completed due to a device error.
 123
 124 **/
 125 EFI_STATUS
 126 EFIAPI
 127 ReportDispatcher (
 128   IN EFI_STATUS_CODE_TYPE     Type,
 129   IN EFI_STATUS_CODE_VALUE    Value,
 130   IN UINT32                   Instance,
 131   IN EFI_GUID                 *CallerId  OPTIONAL,
 132   IN EFI_STATUS_CODE_DATA     *Data      OPTIONAL
 133   );
 134
 135 #endif
 136
 137