]>
Commit | Line | Data |
---|---|---|
878ddf1f | 1 | /** @file\r |
2 | Public include file for the HOB Library\r | |
3 | \r | |
4 | Copyright (c) 2006, Intel Corporation \r | |
5 | All rights reserved. This program and the accompanying materials \r | |
6 | are licensed and made available under the terms and conditions of the BSD License \r | |
7 | which accompanies this distribution. The full text of the license may be found at \r | |
8 | http://opensource.org/licenses/bsd-license.php \r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
12 | \r | |
13 | Module Name: HobLib.h\r | |
14 | \r | |
15 | **/\r | |
16 | \r | |
17 | #ifndef __HOB_LIB_H__\r | |
18 | #define __HOB_LIB_H__\r | |
19 | \r | |
20 | /**\r | |
21 | Returns the pointer to the HOB list.\r | |
22 | \r | |
23 | @return The pointer to the HOB list.\r | |
24 | \r | |
25 | **/\r | |
26 | VOID *\r | |
27 | EFIAPI\r | |
28 | GetHobList (\r | |
29 | VOID\r | |
30 | )\r | |
31 | ;\r | |
32 | \r | |
33 | /**\r | |
34 | This function searches the first instance of a HOB type from the starting HOB pointer. \r | |
35 | If there does not exist such HOB type from the starting HOB pointer, it will return NULL. \r | |
36 | \r | |
37 | @param Type The HOB type to return.\r | |
38 | @param HobStart The starting HOB pointer to search from.\r | |
39 | \r | |
40 | @return The next instance of a HOB type from the starting HOB.\r | |
41 | \r | |
42 | **/\r | |
43 | VOID *\r | |
44 | EFIAPI\r | |
45 | GetNextHob (\r | |
46 | IN UINT16 Type,\r | |
47 | IN CONST VOID *HobStart\r | |
48 | )\r | |
49 | ;\r | |
50 | \r | |
51 | /**\r | |
52 | This function searches the first instance of a HOB type among the whole HOB list. \r | |
53 | If there does not exist such HOB type in the HOB list, it will return NULL. \r | |
54 | \r | |
55 | @param Type The HOB type to return.\r | |
56 | \r | |
57 | @return The next instance of a HOB type from the starting HOB.\r | |
58 | \r | |
59 | **/\r | |
60 | VOID *\r | |
61 | EFIAPI\r | |
62 | GetFirstHob (\r | |
63 | IN UINT16 Type\r | |
64 | )\r | |
65 | ;\r | |
66 | \r | |
67 | /**\r | |
68 | This function searches the first instance of a HOB from the starting HOB pointer. \r | |
69 | Such HOB should satisfy two conditions: \r | |
70 | its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid. \r | |
71 | If there does not exist such HOB from the starting HOB pointer, it will return NULL. \r | |
72 | \r | |
73 | @param Guid The GUID to match with in the HOB list.\r | |
74 | @param HobStart A pointer to a Guid.\r | |
75 | \r | |
76 | @return The next instance of the matched GUID HOB from the starting HOB.\r | |
77 | \r | |
78 | **/\r | |
79 | VOID *\r | |
80 | EFIAPI\r | |
81 | GetNextGuidHob (\r | |
82 | IN CONST EFI_GUID *Guid,\r | |
83 | IN CONST VOID *HobStart\r | |
84 | )\r | |
85 | ;\r | |
86 | \r | |
87 | /**\r | |
88 | This function searches the first instance of a HOB among the whole HOB list. \r | |
89 | Such HOB should satisfy two conditions:\r | |
90 | its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.\r | |
91 | If there does not exist such HOB from the starting HOB pointer, it will return NULL.\r | |
92 | \r | |
93 | @param Guid The GUID to match with in the HOB list.\r | |
94 | \r | |
95 | @return The first instance of the matched GUID HOB among the whole HOB list.\r | |
96 | \r | |
97 | **/\r | |
98 | VOID *\r | |
99 | EFIAPI\r | |
100 | GetFirstGuidHob (\r | |
101 | IN CONST EFI_GUID *Guid\r | |
102 | )\r | |
103 | ;\r | |
104 | \r | |
105 | /**\r | |
106 | This function builds a HOB for a loaded PE32 module.\r | |
107 | \r | |
108 | @param ModuleName The GUID File Name of the module.\r | |
109 | @param MemoryAllocationModule The 64 bit physical address of the module.\r | |
110 | @param ModuleLength The length of the module in bytes.\r | |
111 |