MdePkg/Include/Ppi/StatusCode.h

   1 /** @file
   2   This file declares Status Code PPI.
   3   This ppi provides service that allows PEIMs to report status codes.
   4
   5   Copyright (c) 2006 - 2008, 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   @par Revision Reference:
  15   This PPI is defined in PI.
  16   Version 1.00.
  17
  18 **/
  19
  20 #ifndef __STATUS_CODE_PPI_H__
  21 #define __STATUS_CODE_PPI_H__
  22
  23 #include <Pi/PiPeiCis.h>
  24
  25 #define EFI_PEI_REPORT_PROGRESS_CODE_PPI_GUID \
  26   { 0x229832d3, 0x7a30, 0x4b36, {0xb8, 0x27, 0xf4, 0xc, 0xb7, 0xd4, 0x54, 0x36 } }
  27
  28 //
  29 // EFI_PEI_PROGRESS_CODE_PPI.ReportStatusCode() is equivalent to the
  30 // PEI Service ReportStatusCode().
  31 // It is defined in PiPeiCis.h.
  32 //
  33
  34 ///
  35 /// This PPI provides the sevice to report status code.
  36 /// There can be only one instance of this service in the system.
  37 ///
  38 typedef struct {
  39   ///
  40   /// Service that allows PEIMs to report status codes.
  41   /// This function is defined in PiPeicis.h.
  42   ///
  43   EFI_PEI_REPORT_STATUS_CODE  ReportStatusCode;
  44 } EFI_PEI_PROGRESS_CODE_PPI;
  45
  46 extern EFI_GUID gEfiPeiStatusCodePpiGuid;
  47
  48 #endif