MdeModulePkg/Universal/ReportStatusCodeRouter/RuntimeDxe/ReportStatusCodeRouterRuntimeDxe.h

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