]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/Ppi/StatusCode.h
Formalize comments for Protocols and PPIs.
[mirror_edk2.git] / MdePkg / Include / Ppi / StatusCode.h
CommitLineData
5879b875 1/** @file\r
2 This file declares Status Code PPI.\r
d7132512 3 This ppi provides service that allows PEIMs to report status codes.\r
5879b875 4\r
d7132512 5 Copyright (c) 2006 - 2008, Intel Corporation \r
5879b875 6 All rights reserved. This program and the accompanying materials \r
7 are licensed and made available under the terms and conditions of the BSD License \r
8 which accompanies this distribution. The full text of the license may be found at \r
9 http://opensource.org/licenses/bsd-license.php \r
10\r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
13\r
5879b875 14 @par Revision Reference:\r
15 This PPI is defined in PI.\r
16 Version 1.00.\r
17\r
18**/\r
19\r
20#ifndef __STATUS_CODE_PPI_H__\r
21#define __STATUS_CODE_PPI_H__\r
22\r
d7132512
LG
23#include <Pi/PiPeiCis.h>\r
24\r
5879b875 25#define EFI_PEI_REPORT_PROGRESS_CODE_PPI_GUID \\r
26 { 0x229832d3, 0x7a30, 0x4b36, {0xb8, 0x27, 0xf4, 0xc, 0xb7, 0xd4, 0x54, 0x36 } }\r
27\r
13c38031 28//\r
29// EFI_PEI_PROGRESS_CODE_PPI.ReportStatusCode() is equivalent to the\r
30// PEI Service ReportStatusCode().\r
31// It is defined in PiPeiCis.h. \r
32//\r
33\r
34///\r
35/// This PPI provides the sevice to report status code.\r
36/// There can be only one instance of this service in the system.\r
37///\r
5879b875 38typedef struct {\r
39 EFI_PEI_REPORT_STATUS_CODE ReportStatusCode;\r
40} EFI_PEI_PROGRESS_CODE_PPI;\r
41\r
42extern EFI_GUID gEfiPeiStatusCodePpiGuid;\r
43\r
44#endif\r