OemHookStatusCodeLib.h File Reference

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	OemHookStatusCodeInitialize (VOID)
EFI_STATUS EFIAPI	OemHookStatusCodeReport (IN EFI_STATUS_CODE_TYPE CodeType, IN EFI_STATUS_CODE_VALUE Value, IN UINT32 Instance, IN EFI_GUID *CallerId OPTIONAL, IN EFI_STATUS_CODE_DATA *Data OPTIONAL)

Detailed Description

OEM hook status code library. Platform can implement an instance to initialize the OEM devices to report status code information.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file OemHookStatusCodeLib.h.

Function Documentation

OemHookStatusCodeInitialize()

EFI_STATUS EFIAPI OemHookStatusCodeInitialize

(

VOID

)

Initialize OEM status code device.

Returns

Status of initialization of OEM status code device.

Initialize OEM status code device .

Return values

EFI_SUCCESS

Always return EFI_SUCCESS.

Definition at line 17 of file OemHookStatusCodeLibNull.c.

OemHookStatusCodeReport()

EFI_STATUS EFIAPI OemHookStatusCodeReport	(	IN EFI_STATUS_CODE_TYPE	CodeType,
		IN EFI_STATUS_CODE_VALUE	Value,
		IN UINT32	Instance,
		IN EFI_GUID *CallerId	OPTIONAL,
		IN EFI_STATUS_CODE_DATA *Data	OPTIONAL
	)

Report status code to OEM device.

Parameters

CodeType	Indicates the type of status code being reported.
Value	Describes the current status of a hardware or software entity. This includes both an operation and classification information about the class and subclass. For progress codes, the operation is the current activity. For error codes, it is the exception. For debug codes, it is not defined at this time. Specific values are discussed in the Intel Platform Innovation Framework for EFI Status Code Specification.
Instance	The enumeration of a hardware or software entity within the system. A system may contain multiple entities that match a class/subclass pairing. The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, not meaningful, or not relevant. 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. Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0 Specification.
Data	This optional parameter may be used to pass additional data.

Returns

The function always returns EFI_SUCCESS.

Report status code to OEM device.

Parameters

CodeType	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. For progress codes, the operation is the current activity. For error codes, it is the exception. For debug codes, it is not defined at this time.
Instance	The enumeration of a hardware or software entity within the system. A system may contain multiple entities that match a class/subclass pairing. The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, not meaningful, or not relevant. 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

Always return EFI_SUCCESS.

Definition at line 45 of file OemHookStatusCodeLibNull.c.