StatusCode.h File Reference

Go to the source code of this file.

Classes
struct	_EFI_STATUS_CODE_PROTOCOL

Macros
#define	EFI_STATUS_CODE_RUNTIME_PROTOCOL_GUID   { 0xd2b2b828, 0x826, 0x48a7, { 0xb3, 0xdf, 0x98, 0x3c, 0x0, 0x60, 0x24, 0xf0 } }

Typedefs
typedef EFI_STATUS(EFIAPI *	EFI_REPORT_STATUS_CODE) (IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, IN UINT32 Instance, IN EFI_GUID *CallerId OPTIONAL, IN EFI_STATUS_CODE_DATA *Data OPTIONAL)
typedef struct _EFI_STATUS_CODE_PROTOCOL	EFI_STATUS_CODE_PROTOCOL

Variables
EFI_GUID	gEfiStatusCodeRuntimeProtocolGuid

Detailed Description

Status code Runtime Protocol as defined in PI Specification 1.4a VOLUME 2 DXE

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Macro Definition Documentation

EFI_STATUS_CODE_RUNTIME_PROTOCOL_GUID

#define EFI_STATUS_CODE_RUNTIME_PROTOCOL_GUID   { 0xd2b2b828, 0x826, 0x48a7, { 0xb3, 0xdf, 0x98, 0x3c, 0x0, 0x60, 0x24, 0xf0 } }

Typedef Documentation

EFI_REPORT_STATUS_CODE

typedef EFI_STATUS(EFIAPI * EFI_REPORT_STATUS_CODE) (IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, IN UINT32 Instance, IN EFI_GUID *CallerId OPTIONAL, IN EFI_STATUS_CODE_DATA *Data OPTIONAL)

Provides an interface that a software module can call to report a status code.

Parameters

Type	Indicates the type of status code being reported.
Value	Describes the current status of a hardware or software entity. This included information about the class and subclass that is used to classify the entity as well as an operation.
Instance	The enumeration of a hardware or software entity within the system. Valid instance numbers start with 1.
CallerId	This optional parameter may be used to identify the caller. This parameter allows the status code driver to apply different rules to different callers.
Data	This optional parameter may be used to pass additional data.

Return values

EFI_SUCCESS	The function completed successfully
EFI_DEVICE_ERROR	The function should not be completed due to a device error.

EFI_STATUS_CODE_PROTOCOL

typedef struct _EFI_STATUS_CODE_PROTOCOL EFI_STATUS_CODE_PROTOCOL

Provides the service required to report a status code to the platform firmware. This protocol must be produced by a runtime DXE driver.

Variable Documentation

gEfiStatusCodeRuntimeProtocolGuid

EFI_GUID gEfiStatusCodeRuntimeProtocolGuid

extern