]>
Commit | Line | Data |
---|---|---|
a9102619 | 1 | \r |
2 | /** @file\r | |
3 | OEM hook status code library functions with no library constructor/destructor\r | |
4 | \r | |
5 | Copyright (c) 2006, Intel Corporation\r | |
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 | |
14 | Module Name: OemHookStatusCodeLib.h\r | |
15 | \r | |
16 | **/\r | |
17 | \r | |
18 | #ifndef __OEM_HOOK_STATUSCODE_LIB__\r | |
19 | #define __OEM_HOOK_STATUSCODE_LIB__\r | |
20 | \r | |
21 | /**\r | |
22 | \r | |
23 | Initialize OEM status code device .\r | |
24 | \r | |
25 | \r | |
26 | @return Status of initialization of OEM status code device.\r | |
27 | \r | |
28 | **/\r | |
29 | EFI_STATUS\r | |
30 | EFIAPI\r | |
31 | OemHookStatusCodeInitialize (\r | |
32 | VOID\r | |
33 | );\r | |
34 | \r | |
35 | /**\r | |
36 | Report status code to OEM device.\r | |
37 | \r | |
38 | @param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r | |
39 | \r | |
40 | @param Value Describes the current status of a hardware or software entity. \r | |
41 | This included information about the class and subclass that is used to classify the entity \r | |
42 | as well as an operation. For progress codes, the operation is the current activity. \r | |
43 | For error codes, it is the exception. For debug codes, it is not defined at this time. \r | |
44 | Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. \r | |
45 | Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r | |
46 | \r | |
47 | @param Instance The enumeration of a hardware or software entity within the system. \r | |
48 | A system may contain multiple entities that match a class/subclass pairing. \r | |
49 | The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, \r | |
50 | not meaningful, or not relevant. Valid instance numbers start with 1.\r | |
51 | \r | |
52 | \r | |
53 | @param CallerId This optional parameter may be used to identify the caller. \r | |
54 | This parameter allows the status code driver to apply different rules to different callers. \r | |
55 | Type EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification.\r | |
56 | \r | |
57 | \r | |
58 | @param Data This optional parameter may be used to pass additional data\r | |
59 | \r | |
60 | @return The function always return EFI_SUCCESS.\r | |
61 | \r | |
62 | **/\r | |
63 | EFI_STATUS\r | |
64 | EFIAPI\r | |
65 | OemHookStatusCodeReport (\r | |
66 | IN EFI_STATUS_CODE_TYPE CodeType,\r | |
67 | IN EFI_STATUS_CODE_VALUE Value,\r | |
68 | IN UINT32 Instance,\r | |
69 | IN EFI_GUID *CallerId, OPTIONAL\r | |
70 | IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r | |
71 | );\r | |
72 | \r | |
73 | #endif\r |