878ddf1f |
1 | /*++\r |
2 | \r |
3 | Copyright (c) 2006, Intel Corporation \r |
4 | All rights reserved. This program and the accompanying materials \r |
5 | are licensed and made available under the terms and conditions of the BSD License \r |
6 | which accompanies this distribution. The full text of the license may be found at \r |
7 | http://opensource.org/licenses/bsd-license.php \r |
8 | \r |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r |
11 | \r |
12 | Module Name:\r |
13 | \r |
14 | HiiDatabase.h\r |
15 | \r |
16 | Abstract:\r |
17 | \r |
18 | This file contains global defines and prototype definitions \r |
19 | for the HII database.\r |
20 | \r |
21 | --*/\r |
22 | \r |
23 | #ifndef _HIIDATABASE_H\r |
24 | #define _HIIDATABASE_H\r |
25 | \r |
26 | //\r |
27 | // HII Database Global data\r |
28 | //\r |
29 | #define EFI_HII_DATA_SIGNATURE EFI_SIGNATURE_32 ('H', 'i', 'i', 'P')\r |
30 | \r |
31 | #define MAX_GLYPH_COUNT 65535\r |
32 | #define NARROW_GLYPH_ARRAY_SIZE 19\r |
33 | #define WIDE_GLYPH_ARRAY_SIZE 38\r |
34 | \r |
35 | #define SETUP_MAP_NAME L"Setup"\r |
36 | #define HII_VARIABLE_SUFFIX_USER_DATA L"UserSavedData"\r |
37 | #define HII_VARIABLE_SUFFIX_DEFAULT_OVERRIDE L"DefaultOverride"\r |
38 | #define HII_VARIABLE_SUFFIX_MANUFACTURING_OVERRIDE L"ManufacturingOverride"\r |
39 | \r |
40 | typedef struct _EFI_HII_HANDLE_DATABASE {\r |
41 | VOID *Buffer; // Actual buffer pointer\r |
42 | EFI_HII_HANDLE Handle; // Monotonically increasing value to signify the value returned to caller\r |
43 | UINT32 NumberOfTokens; // The initial number of tokens when first registered\r |
44 | struct _EFI_HII_HANDLE_DATABASE *NextHandleDatabase;\r |
45 | } EFI_HII_HANDLE_DATABASE;\r |
46 | \r |
47 | typedef struct {\r |
48 | EFI_NARROW_GLYPH NarrowGlyphs[MAX_GLYPH_COUNT];\r |
49 | EFI_WIDE_GLYPH WideGlyphs[MAX_GLYPH_COUNT];\r |
50 | EFI_KEY_DESCRIPTOR SystemKeyboardLayout[106];\r |
51 | EFI_KEY_DESCRIPTOR OverrideKeyboardLayout[106];\r |
52 | BOOLEAN SystemKeyboardUpdate; // Has the SystemKeyboard been updated?\r |
53 | } EFI_HII_GLOBAL_DATA;\r |
54 | \r |
55 | typedef struct {\r |
56 | UINTN Signature;\r |
57 | \r |
58 | EFI_HII_GLOBAL_DATA *GlobalData;\r |
59 | EFI_HII_HANDLE_DATABASE *DatabaseHead; // Head of the Null-terminated singly-linked list of handles.\r |
60 | EFI_HII_PROTOCOL Hii;\r |
61 | } EFI_HII_DATA;\r |
62 | \r |
63 | typedef struct {\r |
64 | EFI_HII_HANDLE Handle;\r |
65 | EFI_GUID Guid;\r |
66 | EFI_HII_HANDLE_PACK HandlePack;\r |
67 | UINTN IfrSize;\r |
68 | UINTN StringSize;\r |
69 | EFI_HII_IFR_PACK *IfrData; // All the IFR data stored here\r |
70 | EFI_HII_STRING_PACK *StringData; // All the String data stored at &IfrData + IfrSize (StringData is just a label - never referenced)\r |
71 | } EFI_HII_PACKAGE_INSTANCE;\r |
72 | \r |
73 | typedef struct {\r |
74 | EFI_HII_PACK_HEADER Header;\r |
75 | EFI_IFR_FORM_SET FormSet;\r |
76 | EFI_IFR_END_FORM_SET EndFormSet;\r |
77 | } EFI_FORM_SET_STUB;\r |
78 | \r |
79 | #define EFI_HII_DATA_FROM_THIS(a) CR (a, EFI_HII_DATA, Hii, EFI_HII_DATA_SIGNATURE)\r |
80 | \r |
81 | #define NARROW_WIDTH 8\r |
82 | #define WIDE_WIDTH 16\r |
83 | \r |
84 | extern UINT8 mUnknownGlyph[38];\r |
85 | \r |
86 | //\r |
87 | // Prototypes\r |
88 | //\r |
89 | EFI_STATUS\r |
90 | GetPackSize (\r |
91 | IN VOID *Pack,\r |
92 | OUT UINTN *PackSize,\r |
93 | OUT UINT32 *NumberOfTokens\r |
94 | )\r |
95 | ;\r |
96 | \r |
97 | EFI_STATUS\r |
98 | ValidatePack (\r |
99 | IN EFI_HII_PROTOCOL *This,\r |
100 | IN EFI_HII_PACKAGE_INSTANCE *PackageInstance,\r |
101 | OUT EFI_HII_PACKAGE_INSTANCE **StringPackageInstance,\r |
102 | OUT UINT32 *TotalStringCount\r |
103 | )\r |
104 | ;\r |
105 | \r |
106 | //\r |
107 | // Public Interface Prototypes\r |
108 | //\r |
109 | EFI_STATUS\r |
110 | EFIAPI\r |
111 | InitializeHiiDatabase (\r |
112 | IN EFI_HANDLE ImageHandle,\r |
113 | IN EFI_SYSTEM_TABLE *SystemTable\r |
114 | )\r |
115 | ;\r |
116 | \r |
117 | EFI_STATUS\r |
118 | EFIAPI\r |
119 | HiiNewPack (\r |
120 | IN EFI_HII_PROTOCOL *This,\r |
121 | IN EFI_HII_PACKAGES *PackageList,\r |
122 | OUT EFI_HII_HANDLE *Handle\r |
123 | )\r |
124 | ;\r |
125 | \r |
126 | EFI_STATUS\r |
127 | EFIAPI\r |
128 | HiiRemovePack (\r |
129 | IN EFI_HII_PROTOCOL *This,\r |
130 | IN EFI_HII_HANDLE Handle\r |
131 | )\r |
132 | ;\r |
133 | \r |
134 | EFI_STATUS\r |
135 | EFIAPI\r |
136 | HiiFindHandles (\r |
137 | IN EFI_HII_PROTOCOL *This,\r |
138 | IN OUT UINT16 *HandleBufferLength,\r |
139 | OUT EFI_HII_HANDLE *Handle\r |
140 | )\r |
141 | ;\r |
142 | \r |
143 | EFI_STATUS\r |
144 | EFIAPI\r |
145 | HiiExportDatabase (\r |
146 | IN EFI_HII_PROTOCOL *This,\r |
147 | IN EFI_HII_HANDLE Handle,\r |
148 | IN OUT UINTN *BufferSize,\r |
149 | OUT VOID *Buffer\r |
150 | )\r |
151 | ;\r |
152 | \r |
153 | EFI_STATUS\r |
154 | EFIAPI\r |
155 | HiiGetGlyph (\r |
156 | IN EFI_HII_PROTOCOL *This,\r |
157 | IN CHAR16 *Source,\r |
158 | IN OUT UINT16 *Index,\r |
159 | OUT UINT8 **GlyphBuffer,\r |
160 | OUT UINT16 *BitWidth,\r |
161 | IN OUT UINT32 *InternalStatus\r |
162 | )\r |
163 | ;\r |
164 | \r |
165 | EFI_STATUS\r |
166 | EFIAPI\r |
167 | HiiGlyphToBlt (\r |
168 | IN EFI_HII_PROTOCOL *This,\r |
169 | IN UINT8 *GlyphBuffer,\r |
170 | IN EFI_UGA_PIXEL Foreground,\r |
171 | IN EFI_UGA_PIXEL Background,\r |
172 | IN UINTN Count,\r |
173 | IN UINTN Width,\r |
174 | IN UINTN Height,\r |
175 | IN OUT EFI_UGA_PIXEL *BltBuffer\r |
176 | )\r |
177 | ;\r |
178 | \r |
179 | EFI_STATUS\r |
180 | EFIAPI\r |
181 | HiiNewString (\r |
182 | IN EFI_HII_PROTOCOL *This,\r |
183 | IN CHAR16 *Language,\r |
184 | IN EFI_HII_HANDLE Handle,\r |
185 | IN OUT STRING_REF *Reference,\r |
186 | IN CHAR16 *NewString\r |
187 | )\r |
188 | ;\r |
189 | \r |
190 | EFI_STATUS\r |
191 | EFIAPI\r |
192 | HiiGetString (\r |
193 | IN EFI_HII_PROTOCOL *This,\r |
194 | IN EFI_HII_HANDLE Handle,\r |
195 | IN STRING_REF Token,\r |
196 | IN BOOLEAN Raw,\r |
197 | IN CHAR16 *LanguageString,\r |
198 | IN OUT UINTN *BufferLength,\r |
199 | OUT EFI_STRING StringBuffer\r |
200 | )\r |
201 | ;\r |
202 | \r |
203 | EFI_STATUS\r |
204 | EFIAPI\r |
205 | HiiResetStrings (\r |
206 | IN EFI_HII_PROTOCOL *This,\r |
207 | IN EFI_HII_HANDLE Handle\r |
208 | )\r |
209 | ;\r |
210 | \r |
211 | EFI_STATUS\r |
212 | EFIAPI\r |
213 | HiiTestString (\r |
214 | IN EFI_HII_PROTOCOL *This,\r |
215 | IN CHAR16 *StringToTest,\r |
216 | IN OUT UINT32 *FirstMissing,\r |
217 | OUT UINT32 *GlyphBufferSize\r |
218 | )\r |
219 | ;\r |
220 | \r |
221 | EFI_STATUS\r |
222 | EFIAPI\r |
223 | HiiGetPrimaryLanguages (\r |
224 | IN EFI_HII_PROTOCOL *This,\r |
225 | IN EFI_HII_HANDLE Handle,\r |
226 | OUT EFI_STRING *LanguageString\r |
227 | )\r |
228 | ;\r |
229 | \r |
230 | EFI_STATUS\r |
231 | EFIAPI\r |
232 | HiiGetSecondaryLanguages (\r |
233 | IN EFI_HII_PROTOCOL *This,\r |
234 | IN EFI_HII_HANDLE Handle,\r |
235 | IN CHAR16 *PrimaryLanguage,\r |
236 | OUT EFI_STRING *LanguageString\r |
237 | )\r |
238 | ;\r |
239 | \r |
240 | EFI_STATUS\r |
241 | EFIAPI\r |
242 | HiiGetLine (\r |
243 | IN EFI_HII_PROTOCOL *This,\r |
244 | IN EFI_HII_HANDLE Handle,\r |
245 | IN STRING_REF Token,\r |
246 | IN OUT UINT16 *Index,\r |
247 | IN UINT16 LineWidth,\r |
248 | IN CHAR16 *LanguageString,\r |
249 | IN OUT UINT16 *BufferLength,\r |
250 | OUT EFI_STRING StringBuffer\r |
251 | )\r |
252 | ;\r |
253 | \r |
254 | EFI_STATUS\r |
255 | EFIAPI\r |
256 | HiiGetForms (\r |
257 | IN EFI_HII_PROTOCOL *This,\r |
258 | IN EFI_HII_HANDLE Handle,\r |
259 | IN EFI_FORM_ID FormId,\r |
260 | IN OUT UINTN *BufferLength,\r |
261 | OUT UINT8 *Buffer\r |
262 | )\r |
263 | ;\r |
264 | \r |
265 | EFI_STATUS\r |
266 | EFIAPI\r |
267 | HiiGetDefaultImage (\r |
268 | IN EFI_HII_PROTOCOL *This,\r |
269 | IN EFI_HII_HANDLE Handle,\r |
270 | IN UINTN DefaultMask,\r |
271 | OUT EFI_HII_VARIABLE_PACK_LIST **VariablePackList\r |
272 | )\r |
273 | ;\r |
274 | \r |
275 | EFI_STATUS\r |
276 | EFIAPI\r |
277 | HiiUpdateForm (\r |
278 | IN EFI_HII_PROTOCOL *This,\r |
279 | IN EFI_HII_HANDLE Handle,\r |
280 | IN EFI_FORM_LABEL Label,\r |
281 | IN BOOLEAN AddData,\r |
282 | IN EFI_HII_UPDATE_DATA *Data\r |
283 | )\r |
284 | ;\r |
285 | \r |
286 | EFI_STATUS\r |
287 | EFIAPI\r |
288 | HiiGetKeyboardLayout (\r |
289 | IN EFI_HII_PROTOCOL *This,\r |
290 | OUT UINT16 *DescriptorCount,\r |
291 | OUT EFI_KEY_DESCRIPTOR *Descriptor\r |
292 | )\r |
293 | ;\r |
294 | \r |
295 | EFI_STATUS\r |
296 | HiiCompareLanguage (\r |
297 | IN CHAR16 *LanguageStringLocation,\r |
298 | IN CHAR16 *Language\r |
299 | )\r |
300 | ;\r |
301 | \r |
302 | #endif\r |