Committing changes to the comments, after review with engineers.
[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Library / OemHookStatusCodeLib.h
CommitLineData
a9102619 1/** @file\r
920d2c23
LG
2 OEM hook status code library. Platform can implement an instance to \r
3 initialize the OEM devices to report status code information.\r
a9102619 4\r
920d2c23 5 Copyright (c) 2006 - 2009, Intel Corporation\r
a9102619 6 All rights reserved. This program and the accompanying materials\r
7 are licensed and made available under the terms and conditions of the BSD License\r
8 which accompanies this distribution. The full text of the license may be found at\r
9 http://opensource.org/licenses/bsd-license.php\r
10\r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
a9102619 14**/\r
15\r
16#ifndef __OEM_HOOK_STATUSCODE_LIB__\r
17#define __OEM_HOOK_STATUSCODE_LIB__\r
18\r
19/**\r
20\r
21 Initialize OEM status code device .\r
22\r
23\r
24 @return Status of initialization of OEM status code device.\r
25 \r
26**/\r
27EFI_STATUS\r
28EFIAPI\r
29OemHookStatusCodeInitialize (\r
30 VOID\r
31 );\r
32\r
33/**\r
34 Report status code to OEM device.\r
35 \r
d0bd68b2 36 @param CodeType Indicates the type of status code being reported. \r
a9102619 37 \r
38 @param Value Describes the current status of a hardware or software entity. \r
727fed5a 39 This includes both an operation and classification information about the class and subclass.\r
40 For progress codes, the operation is the current activity. \r
a9102619 41 For error codes, it is the exception. For debug codes, it is not defined at this time. \r
d0bd68b2 42 Specific values are discussed in the Intel Platform Innovation Framework for EFI Status Code Specification.\r
a9102619 43 \r
44 @param Instance The enumeration of a hardware or software entity within the system. \r
45 A system may contain multiple entities that match a class/subclass pairing. \r
46 The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, \r
47 not meaningful, or not relevant. Valid instance numbers start with 1.\r
48\r
49\r
50 @param CallerId This optional parameter may be used to identify the caller. \r
51 This parameter allows the status code driver to apply different rules to different callers. \r
8a7d75b0 52 Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0 Specification.\r
a9102619 53\r
54\r
55 @param Data This optional parameter may be used to pass additional data\r
56 \r
57 @return The function always return EFI_SUCCESS.\r
58\r
59**/\r
60EFI_STATUS\r
61EFIAPI\r
62OemHookStatusCodeReport (\r
63 IN EFI_STATUS_CODE_TYPE CodeType,\r
64 IN EFI_STATUS_CODE_VALUE Value,\r
65 IN UINT32 Instance,\r
66 IN EFI_GUID *CallerId, OPTIONAL\r
67 IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r
68 );\r
69\r
ed7752ec 70#endif // __OEM_HOOK_STATUSCODE_LIB__\r
71\r