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