EdkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.c

   1
   2 /** @file
   3   Generic PeiStatusCode Module.
   4
   5   Copyright (c) 2006, Intel Corporation
   6   All rights reserved. This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  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   Module Name:  PeiStatusCode.c
  15
  16 **/
  17
  18 #include "PeiStatusCode.h"
  19
  20 /**
  21   Report status code to all supported device.
  22
  23
  24   @param  PeiServices
  25
  26   @param  Type          Indicates the type of status code being reported.
  27                         The type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.
  28   @param  Value         Describes the current status of a hardware or software entity.
  29                         This includes information about the class and subclass that is used to classify the entity
  30                         as well as an operation.  For progress codes, the operation is the current activity.
  31                         For error codes, it is the exception.  For debug codes, it is not defined at this time.
  32                         Type EFI_STATUS_CODE_VALUE is defined in ¡°Related Definitions¡± below.
  33                         Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.
  34   @param  Instance      The enumeration of a hardware or software entity within the system.
  35                         A system may contain multiple entities that match a class/subclass pairing.
  36                         The instance differentiates between them.  An instance of 0 indicates that instance
  37                         information is unavailable, not meaningful, or not relevant.  Valid instance numbers start with 1.
  38   @param  CallerId      This optional parameter may be used to identify the caller.
  39                         This parameter allows the status code driver to apply different rules to different callers.
  40   @param  Data          This optional parameter may be used to pass additional data.
  41                         Type EFI_STATUS_CODE_DATA is defined in "Related Definitions" below.
  42                         The contents of this data type may have additional GUID-specific data.  The standard GUIDs and
  43                         their associated data structures are defined in the Intel? Platform Innovation Framework for EFI Status Codes Specification.
  44 **/
  45 EFI_STATUS
  46 EFIAPI
  47 ReportDispatcher (
  48   IN EFI_PEI_SERVICES         **PeiServices,
  49   IN EFI_STATUS_CODE_TYPE     Type,
  50   IN EFI_STATUS_CODE_VALUE    Value,
  51   IN UINT32                   Instance,
  52   IN EFI_GUID                 *CallerId OPTIONAL,
  53   IN EFI_STATUS_CODE_DATA     *Data OPTIONAL
  54   );
  55
  56 STATIC
  57 EFI_PEI_PROGRESS_CODE_PPI     mStatusCodePpi           = {
  58   ReportDispatcher
  59   };
  60
  61 STATIC
  62 EFI_PEI_PPI_DESCRIPTOR        mStatusCodePpiDescriptor = {
  63   EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,
  64   &gEfiPeiStatusCodePpiGuid,
  65   &mStatusCodePpi
  66   };
  67
  68 /**
  69   Report status code to all supported device.
  70
  71
  72   @param  PeiServices
  73
  74   @param  CodeType      Indicates the type of status code being reported.
  75                         The type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.
  76   @param  Value         Describes the current status of a hardware or software entity.
  77                         This includes information about the class and subclass that is used to classify the entity
  78                         as well as an operation.  For progress codes, the operation is the current activity.
  79                         For error codes, it is the exception.  For debug codes, it is not defined at this time.
  80                         Type EFI_STATUS_CODE_VALUE is defined in ¡°Related Definitions¡± below.
  81                         Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.
  82   @param  Instance      The enumeration of a hardware or software entity within the system.
  83                         A system may contain multiple entities that match a class/subclass pairing.
  84                         The instance differentiates between them.  An instance of 0 indicates that instance
  85                         information is unavailable, not meaningful, or not relevant.  Valid instance numbers start with 1.
  86   @param  CallerId      This optional parameter may be used to identify the caller.
  87                         This parameter allows the status code driver to apply different rules to different callers.
  88   @param  Data          This optional parameter may be used to pass additional data.
  89                         Type EFI_STATUS_CODE_DATA is defined in "Related Definitions" below.
  90                         The contents of this data type may have additional GUID-specific data.  The standard GUIDs and
  91                         their associated data structures are defined in the Intel? Platform Innovation Framework for EFI Status Codes Specification.
  92 **/
  93 EFI_STATUS
  94 EFIAPI
  95 ReportDispatcher (
  96   IN EFI_PEI_SERVICES         **PeiServices,
  97   IN EFI_STATUS_CODE_TYPE     CodeType,
  98   IN EFI_STATUS_CODE_VALUE    Value,
  99   IN UINT32                   Instance,
 100   IN EFI_GUID                 *CallerId OPTIONAL,
 101   IN EFI_STATUS_CODE_DATA     *Data OPTIONAL
 102   )
 103 {
 104   if (FeaturePcdGet (PcdStatusCodeUseSerial)) {
 105     SerialStatusCodeReportWorker (
 106       CodeType,
 107       Value,
 108       Instance,
 109       CallerId,
 110       Data
 111       );
 112   }
 113   if (FeaturePcdGet (PcdStatusCodeUseMemory)) {
 114     MemoryStatusCodeReportWorker (
 115       CodeType,
 116       Value,
 117       Instance
 118       );
 119   }
 120   if (FeaturePcdGet (PcdStatusCodeUseOEM)) {
 121     OemHookStatusCodeReport (
 122       CodeType,
 123       Value,
 124       Instance,
 125       CallerId,
 126       Data
 127       );
 128   }
 129
 130   return EFI_SUCCESS;
 131 }
 132
 133 /**
 134   Initialize PEI status codes and publish the status code
 135   PPI.
 136
 137   @param   FfsHeader       FV this PEIM was loaded from.
 138   @param   PeiServices     General purpose services available to every PEIM.
 139
 140   @return                  The function always returns success.
 141
 142 **/
 143 EFI_STATUS
 144 PeiStatusCodeDriverEntry (
 145   IN EFI_FFS_FILE_HEADER       *FfsHeader,
 146   IN EFI_PEI_SERVICES          **PeiServices
 147   )
 148 {
 149   EFI_STATUS                  Status;
 150
 151   //
 152   // Dispatch initialization request to sub-statuscode-devices.
 153   // If enable UseSerial, then initialize serial port.
 154   // if enable UseMemory, then initialize memory status code worker.
 155   // if enable UseOEM, then initialize Oem status code.
 156   //
 157   if (FeaturePcdGet (PcdStatusCodeUseSerial)) {
 158     Status = SerialPortInitialize();
 159     ASSERT_EFI_ERROR (Status);
 160   }
 161   if (FeaturePcdGet (PcdStatusCodeUseMemory)) {
 162     Status = MemoryStatusCodeInitializeWorker ();
 163     ASSERT_EFI_ERROR  (Status);
 164   }
 165   if (FeaturePcdGet (PcdStatusCodeUseOEM)) {
 166     Status = OemHookStatusCodeInitialize ();
 167     ASSERT_EFI_ERROR  (Status);
 168   }
 169
 170   //
 171   // Install PeiStatusCodePpi.
 172   // PeiServices use this Ppi to output status code.
 173   // use library
 174   Status = PeiServicesInstallPpi (&mStatusCodePpiDescriptor);
 175   ASSERT_EFI_ERROR (Status);
 176
 177   return EFI_SUCCESS;
 178 }
 179