]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - MdePkg/Include/Protocol/HiiDatabase.h
Formalize comments for Protocols and PPIs.
[mirror_edk2.git] / MdePkg / Include / Protocol / HiiDatabase.h
... / ...
CommitLineData
1/** @file\r
2 The file provides Database manager for HII-related data\r
3 structures.\r
4 \r
5 Copyright (c) 2006 - 2008, 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**/\r
15\r
16#ifndef __HII_DATABASE_H__\r
17#define __HII_DATABASE_H__\r
18\r
19#define EFI_HII_DATABASE_PROTOCOL_GUID \\r
20 { 0xef9fc172, 0xa1b2, 0x4693, { 0xb3, 0x27, 0x6d, 0x32, 0xfc, 0x41, 0x60, 0x42 } }\r
21\r
22\r
23typedef struct _EFI_HII_DATABASE_PROTOCOL EFI_HII_DATABASE_PROTOCOL;\r
24\r
25\r
26///\r
27/// EFI_HII_DATABASE_NOTIFY_TYPE\r
28/// \r
29typedef UINTN EFI_HII_DATABASE_NOTIFY_TYPE;\r
30\r
31#define EFI_HII_DATABASE_NOTIFY_NEW_PACK 0x00000001\r
32#define EFI_HII_DATABASE_NOTIFY_REMOVE_PACK 0x00000002\r
33#define EFI_HII_DATABASE_NOTIFY_EXPORT_PACK 0x00000004\r
34#define EFI_HII_DATABASE_NOTIFY_ADD_PACK 0x00000008\r
35/**\r
36 \r
37 Functions which are registered to receive notification of\r
38 database events have this prototype. The actual event is encoded\r
39 in NotifyType. The following table describes how PackageType,\r
40 PackageGuid, Handle, and Package are used for each of the\r
41 notification types.\r
42\r
43 @param PackageType Package type of the notification.\r
44\r
45 @param PackageGuid If PackageType is\r
46 EFI_HII_PACKAGE_TYPE_GUID, then this is\r
47 the pointer to the GUID from the Guid\r
48 field of EFI_HII_PACKAGE_GUID_HEADER.\r
49 Otherwise, it must be NULL.\r
50\r
51 @param Package Points to the package referred to by the notification. \r
52 \r
53 @param Handle The handle of the package\r
54 list which contains the specified package.\r
55\r
56 @param NotifyType The type of change concerning the\r
57 database. See\r
58 EFI_HII_DATABASE_NOTIFY_TYPE.\r
59\r
60**/\r
61typedef\r
62EFI_STATUS\r
63(EFIAPI *EFI_HII_DATABASE_NOTIFY)(\r
64 IN UINT8 PackageType,\r
65 IN CONST EFI_GUID *PackageGuid,\r
66 IN CONST EFI_HII_PACKAGE_HEADER *Package,\r
67 IN EFI_HII_HANDLE Handle,\r
68 IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType\r
69);\r
70\r
71/**\r
72\r
73 This function adds the packages in the package list to the\r
74 database and returns a handle. If there is a\r
75 EFI_DEVICE_PATH_PROTOCOL associated with the DriverHandle, then\r
76 this function will create a package of type\r
77 EFI_PACKAGE_TYPE_DEVICE_PATH and add it to the package list. For\r
78 each package in the package list, registered functions with the\r
79 notification type NEW_PACK and having the same package type will\r
80 be called. For each call to NewPackageList(), there should be a\r
81 corresponding call to\r
82 EFI_HII_DATABASE_PROTOCOL.RemovePackageList().\r
83\r
84 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
85\r
86 @param PackageList A pointer to an EFI_HII_PACKAGE_LIST_HEADER structure.\r
87\r
88 @param DriverHandle Associate the package list with this EFI handle.\r
89 \r
90 @param Handle A pointer to the EFI_HII_HANDLE instance.\r
91\r
92 @retval EFI_SUCCESS The package list associated with the\r
93 Handle was added to the HII database.\r
94\r
95 @retval EFI_OUT_OF_RESOURCES Unable to allocate necessary\r
96 resources for the new database\r
97 contents.\r
98\r
99 @retval EFI_INVALID_PARAMETER PackageList is NULL or Handle is NULL.\r
100\r
101**/\r
102typedef\r
103EFI_STATUS\r
104(EFIAPI *EFI_HII_DATABASE_NEW_PACK)(\r
105 IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
106 IN CONST EFI_HII_PACKAGE_LIST_HEADER *PackageList,\r
107 IN EFI_HANDLE DriverHandle,\r
108 OUT EFI_HII_HANDLE *Handle\r
109);\r
110\r
111\r
112/**\r
113\r
114 This function removes the package list that is associated with a\r
115 handle Handle from the HII database. Before removing the\r
116 package, any registered functions with the notification type\r
117 REMOVE_PACK and the same package type will be called. For each\r
118 call to EFI_HII_DATABASE_PROTOCOL.NewPackageList(), there should\r
119 be a corresponding call to RemovePackageList.\r
120\r
121 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
122 \r
123 @param Handle The handle that was registered to the data\r
124 that is requested for removal.\r
125 \r
126 @retval EFI_SUCCESS The data associated with the Handle was\r
127 removed from the HII database.\r
128 @retval EFI_NOT_FOUND The specified Handle is not in database.\r
129\r
130**/\r
131typedef\r
132EFI_STATUS\r
133(EFIAPI *EFI_HII_DATABASE_REMOVE_PACK)(\r
134 IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
135 IN EFI_HII_HANDLE Handle\r
136);\r
137\r
138\r
139/**\r
140 \r
141 This function updates the existing package list (which has the\r
142 specified Handle) in the HII databases, using the new package\r
143 list specified by PackageList. The update process has the\r
144 following steps: Collect all the package types in the package\r
145 list specified by PackageList. A package type consists of the\r
146 Type field of EFI_HII_PACKAGE_HEADER and, if the Type is\r
147 EFI_HII_PACKAGE_TYPE_GUID, the Guid field, as defined in\r
148 EFI_HII_PACKAGE_GUID_HEADER. Iterate through the packages within\r
149 the existing package list in the HII database specified by\r
150 Handle. If a package??s type matches one of the types collected\r
151 in step 1, then perform the following steps:\r
152 - Call any functions registered with the notification type\r
153 REMOVE_PACK.\r
154 - Remove the package from the package list and the HII\r
155 database.\r
156 Add all of the packages within the new package list specified\r
157 by PackageList, using the following steps:\r
158 - Add the package to the package list and the HII database.\r
159 - Call any functions registered with the notification type\r
160 ADD_PACK.\r
161\r
162 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
163 \r
164 @param Handle The handle that was registered to the data\r
165 that is requested for removal.\r
166 \r
167 @param PackageList A pointer to an EFI_HII_PACKAGE_LIST\r
168 package.\r
169 \r
170 @retval EFI_SUCCESS The HII database was successfully updated.\r
171 \r
172 @retval EFI_OUT_OF_RESOURCES Unable to allocate enough memory\r
173 for the updated database.\r
174 \r
175 @retval EFI_INVALID_PARAMETER PackageList was NULL.\r
176 @retval EFI_NOT_FOUND The specified Handle is not in database.\r
177\r
178**/\r
179typedef\r
180EFI_STATUS\r
181(EFIAPI *EFI_HII_DATABASE_UPDATE_PACK)(\r
182 IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
183 IN EFI_HII_HANDLE Handle,\r
184 IN CONST EFI_HII_PACKAGE_LIST_HEADER *PackageList\r
185);\r
186\r
187\r
188/**\r
189 \r
190 This function returns a list of the package handles of the \r
191 specified type that are currently active in the database. The \r
192 pseudo-type EFI_HII_PACKAGE_TYPE_ALL will cause all package \r
193 handles to be listed.\r
194 \r
195 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
196 \r
197 @param PackageType Specifies the package type of the packages\r
198 to list or EFI_HII_PACKAGE_TYPE_ALL for\r
199 all packages to be listed.\r
200 \r
201 @param PackageGuid If PackageType is\r
202 EFI_HII_PACKAGE_TYPE_GUID, then this is\r
203 the pointer to the GUID which must match\r
204 the Guid field of\r
205 EFI_HII_PACKAGE_GUID_HEADER. Otherwise, it\r
206 must be NULL.\r
207 \r
208 @param HandleBufferLength On input, a pointer to the length\r
209 of the handle buffer. On output,\r
210 the length of the handle buffer\r
211 that is required for the handles found.\r
212\r
213 @param Handle An array of EFI_HII_HANDLE instances returned.\r
214\r
215 @retval EFI_SUCCESS The matching handles are outputed successfully.\r
216 HandleBufferLength is updated with the actual length.\r
217 @retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter\r
218 indicates that Handle is too\r
219 small to support the number of\r
220 handles. HandleBufferLength is\r
221 updated with a value that will\r
222 enable the data to fit.\r
223 @retval EFI_NOT_FOUND No matching handle could not be found in database.\r
224 @retval EFI_INVALID_PARAMETER Handle or HandleBufferLength was NULL.\r
225 @retval EFI_INVALID_PARAMETER PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but\r
226 PackageGuid is not NULL, PackageType is a EFI_HII_\r
227 PACKAGE_TYPE_GUID but PackageGuid is NULL.\r
228**/\r
229typedef\r
230EFI_STATUS\r
231(EFIAPI *EFI_HII_DATABASE_LIST_PACKS)(\r
232 IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
233 IN UINT8 PackageType,\r
234 IN CONST EFI_GUID *PackageGuid,\r
235 IN OUT UINTN *HandleBufferLength,\r
236 OUT EFI_HII_HANDLE *Handle\r
237);\r
238\r
239/**\r
240\r
241 This function will export one or all package lists in the\r
242 database to a buffer. For each package list exported, this\r
243 function will call functions registered with EXPORT_PACK and\r
244 then copy the package list to the buffer. The registered\r
245 functions may call EFI_HII_DATABASE_PROTOCOL.UpdatePackageList()\r
246 to modify the package list before it is copied to the buffer. If\r
247 the specified BufferSize is too small, then the status\r
248 EFI_OUT_OF_RESOURCES will be returned and the actual package\r
249 size will be returned in BufferSize.\r
250\r
251 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
252\r
253\r
254 @param Handle An EFI_HII_HANDLE that corresponds to the\r
255 desired package list in the HII database to\r
256 export or NULL to indicate all package lists\r
257 should be exported. \r
258\r
259 @param BufferSize On input, a pointer to the length of the\r
260 buffer. On output, the length of the\r
261 buffer that is required for the exported\r
262 data.\r
263\r
264 @param Buffer A pointer to a buffer that will contain the\r
265 results of the export function.\r
266 \r
267 \r
268 @retval EFI_SUCCESS Package exported.\r
269 \r
270 @retval EFI_OUT_OF_RESOURCES BufferSize is too small to hold the package.\r
271\r
272**/\r
273typedef\r
274EFI_STATUS\r
275(EFIAPI *EFI_HII_DATABASE_EXPORT_PACKS)(\r
276 IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
277 IN EFI_HII_HANDLE Handle,\r
278 IN OUT UINTN *BufferSize,\r
279 OUT EFI_HII_PACKAGE_LIST_HEADER *Buffer\r
280);\r
281\r
282\r
283/**\r
284 \r
285 \r
286 This function registers a function which will be called when\r
287 specified actions related to packages of the specified type\r
288 occur in the HII database. By registering a function, other\r
289 HII-related drivers are notified when specific package types\r
290 are added, removed or updated in the HII database. Each driver\r
291 or application which registers a notification should use\r
292 EFI_HII_DATABASE_PROTOCOL.UnregisterPackageNotify() before\r
293 exiting.\r
294 \r
295 \r
296 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
297\r
298 @param PackageType The package type. See\r
299 EFI_HII_PACKAGE_TYPE_x in EFI_HII_PACKAGE_HEADER. \r
300\r
301 @param PackageGuid If PackageType is\r
302 EFI_HII_PACKAGE_TYPE_GUID, then this is\r
303 the pointer to the GUID which must match\r
304 the Guid field of\r
305 EFI_HII_PACKAGE_GUID_HEADER. Otherwise, it\r
306 must be NULL.\r
307\r
308 @param PackageNotifyFn Points to the function to be called\r
309 when the event specified by\r
310 NotificationType occurs. See\r
311 EFI_HII_DATABASE_NOTIFY.\r
312\r
313 @param NotifyType Describes the types of notification which\r
314 this function will be receiving. See\r
315 EFI_HII_DATABASE_NOTIFY_TYPE for more a\r
316 list of types.\r
317\r
318 @param NotifyHandle Points to the unique handle assigned to\r
319 the registered notification. Can be used\r
320 in EFI_HII_DATABASE_PROTOCOL.UnregisterPack\r
321 to stop notifications.\r
322\r
323\r
324 @retval EFI_SUCCESS Notification registered successfully.\r
325\r
326 @retval EFI_OUT_OF_RESOURCES Unable to allocate necessary\r
327 data structures.\r
328\r
329 @retval EFI_INVALID_PARAMETER PackageGuid is not NULL when\r
330 PackageType is not\r
331 EFI_HII_PACKAGE_TYPE_GUID.\r
332\r
333**/\r
334typedef\r
335EFI_STATUS\r
336(EFIAPI *EFI_HII_DATABASE_REGISTER_NOTIFY)(\r
337 IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
338 IN UINT8 PackageType,\r
339 IN CONST EFI_GUID *PackageGuid,\r
340 IN EFI_HII_DATABASE_NOTIFY PackageNotifyFn,\r
341 IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType,\r
342 OUT EFI_HANDLE *NotifyHandle\r
343);\r
344\r
345\r
346/**\r
347 \r
348 Removes the specified HII database package-related notification.\r
349 \r
350 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
351\r
352 @param NotificationHandle The handle of the notification\r
353 function being unregistered.\r
354 \r
355 @retval EFI_SUCCESS Unregister the notification Successsfully\r
356 \r
357 @retval EFI_NOT_FOUND The incoming notification handle does not exist \r
358 in current hii database.\r
359 \r
360**/\r
361typedef\r
362EFI_STATUS\r
363(EFIAPI *EFI_HII_DATABASE_UNREGISTER_NOTIFY)(\r
364 IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
365 IN EFI_HANDLE NotificationHandle\r
366);\r
367\r
368\r
369/**\r
370 \r
371 This routine retrieves an array of GUID values for each keyboard\r
372 layout that was previously registered in the system.\r
373\r
374 @param This A pointer to the EFI_HII_PROTOCOL instance.\r
375\r
376 @param KeyGuidBufferLength On input, a pointer to the length\r
377 of the keyboard GUID buffer. On\r
378 output, the length of the handle\r
379 buffer that is required for the\r
380 handles found. \r
381 \r
382 @param KeyGuidBuffer An array of keyboard layout GUID\r
383 instances returned.\r
384\r
385 @retval EFI_SUCCESS KeyGuidBuffer was updated successfully.\r
386 \r
387 @retval EFI_BUFFER_TOO_SMALL The KeyGuidBufferLength\r
388 parameter indicates that\r
389 KeyGuidBuffer is too small to\r
390 support the number of GUIDs.\r
391 KeyGuidBufferLength is updated\r
392 with a value that will enable\r
393 the data to fit.\r
394\r
395**/\r
396typedef\r
397EFI_STATUS\r
398(EFIAPI *EFI_HII_FIND_KEYBOARD_LAYOUTS)(\r
399 IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
400 IN OUT UINT16 *KeyGuidBufferLength,\r
401 OUT EFI_GUID *KeyGuidBuffer\r
402);\r
403\r
404\r
405/**\r
406 \r
407 This routine retrieves the requested keyboard layout. The layout\r
408 is a physical description of the keys on a keyboard and the\r
409 character(s) that are associated with a particular set of key\r
410 strokes.\r
411\r
412 @param This A pointer to the EFI_HII_PROTOCOL instance.\r
413 \r
414 @param KeyGuid A pointer to the unique ID associated with a\r
415 given keyboard layout. If KeyGuid is NULL then\r
416 the current layout will be retrieved.\r
417\r
418 @param KeyboardLayoutLength On input, a pointer to the length of the\r
419 KeyboardLayout buffer. On output, the length of\r
420 the data placed into KeyboardLayout.\r
421 \r
422 @param KeyboardLayout A pointer to a buffer containing the\r
423 retrieved keyboard layout.\r
424 \r
425 @retval EFI_SUCCESS The keyboard layout was retrieved\r
426 successfully.\r
427 \r
428 @retval EFI_NOT_FOUND The requested keyboard layout was not found.\r
429\r
430**/\r
431typedef\r
432EFI_STATUS\r
433(EFIAPI *EFI_HII_GET_KEYBOARD_LAYOUT)(\r
434 IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
435 IN CONST EFI_GUID *KeyGuid,\r
436 IN OUT UINT16 *KeyboardLayoutLength,\r
437 OUT EFI_HII_KEYBOARD_LAYOUT *KeyboardLayout\r
438);\r
439\r
440/**\r
441 \r
442 This routine sets the default keyboard layout to the one\r
443 referenced by KeyGuid. When this routine is called, an event\r
444 will be signaled of the EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID\r
445 group type. This is so that agents which are sensitive to the\r
446 current keyboard layout being changed can be notified of this\r
447 change.\r
448\r
449 @param This A pointer to the EFI_HII_PROTOCOL instance.\r
450\r
451 @param KeyGuid A pointer to the unique ID associated with a\r
452 given keyboard layout.\r
453\r
454 @retval EFI_SUCCESS The current keyboard layout was successfully set.\r
455\r
456 @retval EFI_NOT_FOUND The referenced keyboard layout was not\r
457 found, so action was taken.\r
458\r
459**/\r
460typedef\r
461EFI_STATUS\r
462(EFIAPI *EFI_HII_SET_KEYBOARD_LAYOUT)(\r
463 IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
464 IN CONST EFI_GUID *KeyGuid\r
465);\r
466\r
467/**\r
468 \r
469 Return the EFI handle associated with a package list.\r
470 \r
471 @param This A pointer to the EFI_HII_PROTOCOL instance.\r
472 \r
473 @param PackageListHandle An EFI_HII_HANDLE that corresponds\r
474 to the desired package list in the\r
475 HIIdatabase.\r
476 \r
477 @param DriverHandle On return, contains the EFI_HANDLE which\r
478 was registered with the package list in\r
479 NewPackageList().\r
480 \r
481 @retval EFI_SUCCESS The DriverHandle was returned successfully.\r
482 \r
483 @retval EFI_INVALID_PARAMETER The PackageListHandle was not valid.\r
484\r
485**/\r
486typedef\r
487EFI_STATUS\r
488(EFIAPI *EFI_HII_DATABASE_GET_PACK_HANDLE)(\r
489 IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
490 IN EFI_HII_HANDLE PackageListHandle,\r
491 OUT EFI_HANDLE *DriverHandle\r
492);\r
493\r
494///\r
495/// Database manager for HII-related data structures.\r
496///\r
497struct _EFI_HII_DATABASE_PROTOCOL {\r
498 EFI_HII_DATABASE_NEW_PACK NewPackageList;\r
499 EFI_HII_DATABASE_REMOVE_PACK RemovePackageList;\r
500 EFI_HII_DATABASE_UPDATE_PACK UpdatePackageList;\r
501 EFI_HII_DATABASE_LIST_PACKS ListPackageLists;\r
502 EFI_HII_DATABASE_EXPORT_PACKS ExportPackageLists;\r
503 EFI_HII_DATABASE_REGISTER_NOTIFY RegisterPackageNotify;\r
504 EFI_HII_DATABASE_UNREGISTER_NOTIFY UnregisterPackageNotify;\r
505 EFI_HII_FIND_KEYBOARD_LAYOUTS FindKeyboardLayouts;\r
506 EFI_HII_GET_KEYBOARD_LAYOUT GetKeyboardLayout;\r
507 EFI_HII_SET_KEYBOARD_LAYOUT SetKeyboardLayout;\r
508 EFI_HII_DATABASE_GET_PACK_HANDLE GetPackageListHandle;\r
509};\r
510\r
511extern EFI_GUID gEfiHiiDatabaseProtocolGuid;\r
512\r
513#endif\r
514\r
515\r