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