X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=IntelFrameworkModulePkg%2FInclude%2FLibrary%2FOemHookStatusCodeLib.h;h=8b09e7843553ebba2b6ddf6e43ad9ea51c8a17db;hp=b26189c941de4b445f848589b6ce388c97a347fe;hb=d0bd68b21fcbb3caef0bc1581c3dbe3d77a0898f;hpb=8a7d75b0625cffee0c67b85afe56763f93d86481 diff --git a/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h b/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h index b26189c941..8b09e78435 100644 --- a/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h +++ b/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h @@ -1,8 +1,8 @@ - /** @file - OEM hook status code library functions with no library constructor/destructor + OEM hook status code library. Platform can implement an instance to + initialize the OEM devices to report status code information. - Copyright (c) 2006, Intel Corporation + Copyright (c) 2006 - 2009, 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 @@ -11,8 +11,6 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - Module Name: OemHookStatusCodeLib.h - **/ #ifndef __OEM_HOOK_STATUSCODE_LIB__ @@ -35,14 +33,13 @@ OemHookStatusCodeInitialize ( /** Report status code to OEM device. - @param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below. + @param CodeType Indicates the type of status code being reported. @param 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. + 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. - Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. - Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification. + Specific values are discussed in the Intel Platform Innovation Framework for EFI Status Code Specification. @param Instance The enumeration of a hardware or software entity within the system. A system may contain multiple entities that match a class/subclass pairing. @@ -70,4 +67,5 @@ OemHookStatusCodeReport ( IN EFI_STATUS_CODE_DATA *Data OPTIONAL ); -#endif +#endif // __OEM_HOOK_STATUSCODE_LIB__ +