EdkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.h

   1
   2 /** @file
   3   Heade file of status code PEIM
   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.h
  15
  16 **/
  17
  18 #ifndef __PEI_STATUS_CODE_H__
  19 #define __PEI_STATUS_CODE_H__
  20
  21
  22 /**
  23   Convert status code value and extended data to readable ASCII string, send string to serial I/O device.
  24
  25   @param  CodeType      Indicates the type of status code being reported.  Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.
  26
  27   @param  Value         Describes the current status of a hardware or software entity.
  28                         This included information about the class and subclass that is used to classify the entity
  29                         as well as an operation.  For progress codes, the operation is the current activity.
  30                         For error codes, it is the exception.  For debug codes, it is not defined at this time.
  31                         Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.
  32                         Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.
  33
  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 information is unavailable,
  37                         not meaningful, or not relevant.  Valid instance numbers start with 1.
  38
  39
  40   @param  CallerId      This optional parameter may be used to identify the caller.
  41                         This parameter allows the status code driver to apply different rules to different callers.
  42                         Type EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification.
  43
  44
  45   @param  Data          This optional parameter may be used to pass additional data
  46
  47   @return               The function always return EFI_SUCCESS.
  48
  49 **/
  50 EFI_STATUS
  51 SerialStatusCodeReportWorker (
  52   IN EFI_STATUS_CODE_TYPE     CodeType,
  53   IN EFI_STATUS_CODE_VALUE    Value,
  54   IN UINT32                   Instance,
  55   IN EFI_GUID                 *CallerId,
  56   IN EFI_STATUS_CODE_DATA     *Data OPTIONAL
  57   );
  58
  59
  60 /**
  61   Initialize memory status code.
  62   Create one GUID'ed HOB with PCD defined size. If create required size
  63   GUID'ed HOB failed, then ASSERT().
  64
  65   @return           The function always return EFI_SUCCESS
  66
  67 **/
  68 EFI_STATUS
  69 MemoryStatusCodeInitializeWorker (
  70   VOID
  71   );
  72
  73 /**
  74   Report status code into GUID'ed HOB.
  75
  76   @param  CodeType      Indicates the type of status code being reported.  Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.
  77
  78   @param  Value         Describes the current status of a hardware or software entity.
  79                         This included information about the class and subclass that is used to classify the entity
  80                         as well as an operation.  For progress codes, the operation is the current activity.
  81                         For error codes, it is the exception.  For debug codes, it is not defined at this time.
  82                         Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.
  83                         Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.
  84
  85   @param  Instance      The enumeration of a hardware or software entity within the system.
  86                         A system may contain multiple entities that match a class/subclass pairing.
  87                         The instance differentiates between them.  An instance of 0 indicates that instance information is unavailable,
  88                         not meaningful, or not relevant.  Valid instance numbers start with 1.
  89
  90   @return               The function always return EFI_SUCCESS.
  91
  92 **/
  93 EFI_STATUS
  94 MemoryStatusCodeReportWorker (
  95   IN EFI_STATUS_CODE_TYPE     CodeType,
  96   IN EFI_STATUS_CODE_VALUE    Value,
  97   IN UINT32                   Instance
  98   );
  99
 100 #endif