projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 07c6a47e ED |
1 | /** @file\r |
| 2 | EFI MM Status Code Protocol as defined in the PI 1.5 specification.\r | |
| 3 | \r | |
| 4 | This protocol provides the basic status code services while in MM.\r | |
| 5 | \r | |
| 6 | Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r | |
| 9344f092 | 7 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
| 07c6a47e ED |
8 | \r |
| 9 | **/\r | |
| 10 | \r | |
| 11 | #ifndef _MM_STATUS_CODE_H__\r | |
| 12 | #define _MM_STATUS_CODE_H__\r | |
| 13 | \r | |
| 14 | \r | |
| 15 | #define EFI_MM_STATUS_CODE_PROTOCOL_GUID \\r | |
| 16 | { \\r | |
| 17 | 0x6afd2b77, 0x98c1, 0x4acd, {0xa6, 0xf9, 0x8a, 0x94, 0x39, 0xde, 0xf, 0xb1} \\r | |
| 18 | }\r | |
| 19 | \r | |
| 20 | typedef struct _EFI_MM_STATUS_CODE_PROTOCOL EFI_MM_STATUS_CODE_PROTOCOL;\r | |
| 21 | \r | |
| 22 | /**\r | |
| 23 | Service to emit the status code in MM.\r | |
| 24 | \r | |
| 25 | The EFI_MM_STATUS_CODE_PROTOCOL.ReportStatusCode() function enables a driver\r | |
| 26 | to emit a status code while in MM. The reason that there is a separate protocol definition from the\r | |
| 27 | DXE variant of this service is that the publisher of this protocol will provide a service that is\r | |
| 28 | capability of coexisting with a foreground operational environment, such as an operating system\r | |
| 29 | after the termination of boot services.\r | |
| 30 | \r | |
| 31 | @param[in] This Points to this instance of the EFI_MM_STATUS_CODE_PROTOCOL.\r | |
| 32 | @param[in] CodeType DIndicates the type of status code being reported.\r | |
| 33 | @param[in] Value Describes the current status of a hardware or software entity.\r | |
| 34 | @param[in] Instance The enumeration of a hardware or software entity within the system.\r | |
| 35 | @param[in] CallerId This optional parameter may be used to identify the caller.\r | |
| 36 | @param[in] Data This optional parameter may be used to pass additional data.\r | |
| 37 | \r | |
| 38 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 39 | @retval EFI_INVALID_PARAMETER The function should not be completed due to a device error.\r | |
| 40 | **/\r | |
| 41 | typedef\r | |
| 42 | EFI_STATUS\r | |
| 43 | (EFIAPI *EFI_MM_REPORT_STATUS_CODE)(\r | |
| 44 | IN CONST EFI_MM_STATUS_CODE_PROTOCOL *This,\r | |
| 45 | IN EFI_STATUS_CODE_TYPE CodeType,\r | |
| 46 | IN EFI_STATUS_CODE_VALUE Value,\r | |
| 47 | IN UINT32 Instance,\r | |
| 48 | IN CONST EFI_GUID *CallerId,\r | |
| 49 | IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r | |
| 50 | );\r | |
| 51 | \r | |
| 52 | struct _EFI_MM_STATUS_CODE_PROTOCOL {\r | |
| 53 | EFI_MM_REPORT_STATUS_CODE ReportStatusCode;\r | |
| 54 | };\r | |
| 55 | \r | |
| 56 | extern EFI_GUID gEfiMmStatusCodeProtocolGuid;\r | |
| 57 | \r | |
| 58 | #endif\r | |
| 59 | \r |