projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| d1f95000 | 1 | /** @file\r |
| 4ca9b6c4 | 2 | Status code Runtime Protocol as defined in PI Specification VOLUME 2 DXE\r |
| d1f95000 | 3 | \r |
| 7f1eba7b | 4 | The StatusCode () service is added to the EFI system table and the \r |
| d1f95000 | 5 | EFI_STATUS_CODE_ARCH_PROTOCOL_GUID protocol is registered with a NULL \r |
| 6 | pointer.\r | |
| 7 | \r | |
| 630b4187 | 8 | No CRC of the EFI system table is required, since that is done in the DXE core.\r |
| d1f95000 | 9 | \r |
| 10 | This code abstracts Status Code reporting.\r | |
| 11 | \r | |
| 9df063a0 HT |
12 | Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r |
| 13 | This program and the accompanying materials \r | |
| d1f95000 | 14 | are licensed and made available under the terms and conditions of the BSD License \r |
| 15 | which accompanies this distribution. The full text of the license may be found at \r | |
| 16 | http://opensource.org/licenses/bsd-license.php \r | |
| 17 | \r | |
| 18 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
| 19 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
| 20 | \r | |
| d1f95000 | 21 | **/\r |
| 22 | \r | |
| 23 | #ifndef __STATUS_CODE_RUNTIME_PROTOCOL_H__\r | |
| 24 | #define __STATUS_CODE_RUNTIME_PROTOCOL_H__\r | |
| 25 | \r | |
| 26 | #define EFI_STATUS_CODE_RUNTIME_PROTOCOL_GUID \\r | |
| 27 | { 0xd2b2b828, 0x826, 0x48a7, { 0xb3, 0xdf, 0x98, 0x3c, 0x0, 0x60, 0x24, 0xf0 } }\r | |
| 28 | \r | |
| 29 | /**\r | |
| 30 | Provides an interface that a software module can call to report a status code.\r | |
| 31 | \r | |
| 32 | @param Type Indicates the type of status code being reported.\r | |
| 33 | @param Value Describes the current status of a hardware or software entity.\r | |
| 34 | This included information about the class and subclass that is used to\r | |
| 35 | classify the entity as well as an operation.\r | |
| 36 | @param Instance The enumeration of a hardware or software entity within\r | |
| 37 | the system. Valid instance numbers start with 1.\r | |
| 38 | @param CallerId This optional parameter may be used to identify the caller.\r | |
| 39 | This parameter allows the status code driver to apply different rules to\r | |
| 40 | different callers.\r | |
| 41 | @param Data This optional parameter may be used to pass additional data.\r | |
| 42 | \r | |
| 43 | @retval EFI_SUCCESS The function completed successfully\r | |
| 44 | @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.\r | |
| 45 | \r | |
| 46 | **/\r | |
| 47 | typedef\r | |
| ec0ccdda | 48 | EFI_STATUS\r |
| 8b13229b | 49 | (EFIAPI *EFI_REPORT_STATUS_CODE)(\r |
| d1f95000 | 50 | IN EFI_STATUS_CODE_TYPE Type,\r |
| 51 | IN EFI_STATUS_CODE_VALUE Value,\r | |
| 52 | IN UINT32 Instance,\r | |
| 53 | IN EFI_GUID *CallerId OPTIONAL,\r | |
| 54 | IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r | |
| 55 | );\r | |
| 56 | \r | |
| 44717a39 | 57 | ///\r |
| 58 | /// Provides the service required to report a status code to the platform firmware.\r | |
| 59 | /// This protocol must be produced by a runtime DXE driver and may be consumed \r | |
| 60 | /// only by the DXE Foundation.\r | |
| 61 | ///\r | |
| d1f95000 | 62 | typedef struct _EFI_STATUS_CODE_PROTOCOL {\r |
| 63 | EFI_REPORT_STATUS_CODE ReportStatusCode;\r | |
| 64 | } EFI_STATUS_CODE_PROTOCOL;\r | |
| 65 | \r | |
| 66 | extern EFI_GUID gEfiStatusCodeRuntimeProtocolGuid;\r | |
| 67 | \r | |
| 68 | #endif\r |