2 Public include file for the HII Library
4 Copyright (c) 2007 - 2008, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 // Limited buffer size recommended by RFC4646 (4.3. Length Considerations)
20 // (42 characters plus a NULL terminator)
22 #define RFC_3066_ENTRY_SIZE (42 + 1)
24 #define ISO_639_2_ENTRY_SIZE 3
27 Assemble EFI_HII_PACKAGE_LIST according to the passed in packages.
29 If GuidId is NULL, then ASSERT.
30 If not enough resource to complete the operation, then ASSERT.
32 @param NumberOfPackages Number of packages.
33 @param GuidId Package GUID.
34 @param ... Variable argument list for packages to be assembled.
36 @return EFI_HII_PACKAGE_LIST_HEADER Pointer of EFI_HII_PACKAGE_LIST_HEADER. The function will ASSERT if system has
37 not enough resource to complete the operation.
40 EFI_HII_PACKAGE_LIST_HEADER
*
42 HiiLibPreparePackageList (
43 IN UINTN NumberOfPackages
,
44 IN CONST EFI_GUID
*GuidId
,
50 This function allocates pool for an EFI_HII_PACKAGE_LIST structure
51 with additional space that is big enough to host all packages described by the variable
52 argument list of package pointers. The allocated structure is initialized using NumberOfPackages,
53 GuidId, and the variable length argument list of package pointers.
55 Then, EFI_HII_PACKAGE_LIST will be register to the default System HII Database. The
56 Handle to the newly registered Package List is returned throught HiiHandle.
58 If HiiHandle is NULL, then ASSERT.
60 @param NumberOfPackages The number of HII packages to register.
61 @param GuidId Package List GUID ID.
62 @param DriverHandle Optional. If not NULL, the DriverHandle on which an instance of DEVICE_PATH_PROTOCOL is installed.
63 This DriverHandle uniquely defines the device that the added packages are associated with.
64 @param HiiHandle On output, the HiiHandle is update with the handle which can be used to retrieve the Package
65 List later. If the functions failed to add the package to the default HII database, this value will
67 @param ... The variable argument list describing all HII Package.
69 @return EFI_SUCCESS If the packages are successfully added to the default HII database.
70 @return EFI_OUT_OF_RESOURCE Not enough resource to complete the operation.
76 IN UINTN NumberOfPackages
,
77 IN CONST EFI_GUID
*GuidId
,
78 IN EFI_HANDLE DriverHandle
, OPTIONAL
79 OUT EFI_HII_HANDLE
*HiiHandle
,
85 Removes a package list from the default HII database.
87 If HiiHandle is NULL, then ASSERT.
88 If HiiHandle is not a valid EFI_HII_HANDLE in the default HII database, then ASSERT.
90 @param HiiHandle The handle that was previously registered to the data base that is requested for removal.
98 HiiLibRemovePackages (
99 IN EFI_HII_HANDLE HiiHandle
104 This function adds the string into String Package of each language
105 supported by the package list.
107 If String is NULL, then ASSERT.
108 If StringId is NULL, the ASSERT.
109 If PackageList could not be found in the default HII database, then ASSERT.
111 @param PackageList Handle of the package list where this string will
113 @param StringId On return, contains the new strings id, which is
114 unique within PackageList.
115 @param String Points to the new null-terminated string.
117 @retval EFI_SUCCESS The new string was added successfully.
118 @retval EFI_OUT_OF_RESOURCES Could not add the string due to lack of resources.
124 IN EFI_HII_HANDLE PackageList
,
125 OUT EFI_STRING_ID
*StringId
,
126 IN CONST EFI_STRING String
131 This function update the specified string in String Package of each language
132 supported by the package list.
134 If String is NULL, then ASSERT.
135 If PackageList could not be found in the default HII database, then ASSERT.
136 If StringId is not found in PackageList, then ASSERT.
138 @param PackageList Handle of the package list where this string will
140 @param StringId Ths String Id to be updated.
141 @param String Points to the new null-terminated string.
143 @retval EFI_SUCCESS The new string was added successfully.
144 @retval EFI_OUT_OF_RESOURCES Could not add the string due to lack of resources.
150 IN EFI_HII_HANDLE PackageList
,
151 IN EFI_STRING_ID StringId
,
152 IN CONST EFI_STRING String
157 This function try to retrieve string from String package of current language.
158 If fails, it try to retrieve string from String package of first language it support.
160 If String is NULL, then ASSERT.
161 If StringSize is NULL, then ASSERT.
162 If PackageList could not be found in the default HII database, then ASSERT.
163 If StringId is not found in PackageList, then ASSERT.
165 @param PackageList The package list in the HII database to search for
166 the specified string.
167 @param StringId The string's id, which is unique within
169 @param String Points to the new null-terminated string.
170 @param StringSize On entry, points to the size of the buffer pointed
171 to by String, in bytes. On return, points to the
172 length of the string, in bytes.
174 @retval EFI_SUCCESS The string was returned successfully.
175 @retval EFI_NOT_FOUND The string specified by StringId is not available.
176 @retval EFI_BUFFER_TOO_SMALL The buffer specified by StringLength is too small
178 @retval EFI_INVALID_PARAMETER The String or StringSize was NULL.
185 IN EFI_HII_HANDLE PackageList
,
186 IN EFI_STRING_ID StringId
,
187 OUT EFI_STRING String
,
188 IN OUT UINTN
*StringSize
193 Get string specified by StringId form the HiiHandle. The caller
194 is responsible to free the *String.
196 If String is NULL, then ASSERT.
197 If HiiHandle could not be found in the default HII database, then ASSERT.
198 If StringId is not found in PackageList, then ASSERT.
200 @param HiiHandle The HII handle of package list.
201 @param StringId The String ID.
202 @param String The output string.
204 @retval EFI_NOT_FOUND String is not found.
205 @retval EFI_SUCCESS Operation is successful.
206 @retval EFI_OUT_OF_RESOURCES There is not enought memory in the system.
207 @retval EFI_INVALID_PARAMETER The String is NULL.
212 HiiLibGetStringFromHandle (
213 IN EFI_HII_HANDLE HiiHandle
,
214 IN EFI_STRING_ID StringId
,
215 OUT EFI_STRING
*String
220 Get the string given the StringId and String package Producer's Guid. The caller
221 is responsible to free the *String.
223 If PackageList with the matching ProducerGuid is not found, then ASSERT.
224 If PackageList with the matching ProducerGuid is found but no String is
225 specified by StringId is found, then ASSERT.
227 @param ProducerGuid The Guid of String package list.
228 @param StringId The String ID.
229 @param String The output string.
231 @retval EFI_SUCCESS Operation is successful.
232 @retval EFI_OUT_OF_RESOURCES There is not enought memory in the system.
237 HiiLibGetStringFromToken (
238 IN EFI_GUID
*ProducerGuid
,
239 IN EFI_STRING_ID StringId
,
240 OUT EFI_STRING
*String
245 Determines the handles that are currently active in the database.
246 It's the caller's responsibility to free handle buffer.
248 If HandleBufferLength is NULL, then ASSERT.
249 If HiiHandleBuffer is NULL, then ASSERT.
251 @param HandleBufferLength On input, a pointer to the length of the handle
252 buffer. On output, the length of the handle buffer
253 that is required for the handles found.
254 @param HiiHandleBuffer Pointer to an array of Hii Handles returned.
256 @retval EFI_SUCCESS Get an array of Hii Handles successfully.
261 HiiLibGetHiiHandles (
262 IN OUT UINTN
*HandleBufferLength
,
263 OUT EFI_HII_HANDLE
**HiiHandleBuffer
268 Extract Hii package list GUID for given HII handle.
270 If HiiHandle could not be found in the default HII database, then ASSERT.
271 If Guid is NULL, then ASSERT.
273 @param Handle Hii handle
274 @param Guid Package list GUID
276 @retval EFI_SUCCESS Successfully extract GUID from Hii database.
281 HiiLibExtractGuidFromHiiHandle (
282 IN EFI_HII_HANDLE Handle
,
288 Find HII Handle in the default HII database associated with given Device Path.
290 If DevicePath is NULL, then ASSERT.
292 @param DevicePath Device Path associated with the HII package list
295 @retval Handle HII package list Handle associated with the Device
297 @retval NULL Hii Package list handle is not found.
302 HiiLibDevicePathToHiiHandle (
303 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
309 Determine what is the current language setting. The space reserved for Lang
310 must be at least RFC_3066_ENTRY_SIZE bytes;
312 If Lang is NULL, then ASSERT.
314 @param Lang Pointer of system language. Lang will always be filled with
315 a valid RFC 3066 language string. If "PlatformLang" is not
316 set in the system, the default language specifed by PcdUefiVariableDefaultPlatformLang
319 @return EFI_SUCCESS If the EFI Variable with "PlatformLang" is set and return in Lang.
320 @return EFI_NOT_FOUND If the EFI Variable with "PlatformLang" is not set, but a valid default language is return in Lang.
325 HiiLibGetCurrentLanguage (
331 Get next language from language code list (with separator ';').
333 If LangCode is NULL, then ASSERT.
334 If Lang is NULL, then ASSERT.
336 @param LangCode On input: point to first language in the list. On
337 output: point to next language in the list, or
338 NULL if no more language in the list.
339 @param Lang The first language in the list.
344 HiiLibGetNextLanguage (
345 IN OUT CHAR8
**LangCode
,
351 This function returns the list of supported languages, in the format specified
352 in UEFI specification Appendix M.
354 If HiiHandle is not a valid Handle in the default HII database, then ASSERT.
356 @param HiiHandle The HII package list handle.
358 @retval !NULL The supported languages.
359 @retval NULL If Supported Languages can not be retrived.
364 HiiLibGetSupportedLanguages (
365 IN EFI_HII_HANDLE HiiHandle
370 This function returns the list of supported 2nd languages, in the format specified
371 in UEFI specification Appendix M.
373 If HiiHandle is not a valid Handle in the default HII database, then ASSERT.
374 If not enough resource to complete the operation, then ASSERT.
376 @param HiiHandle The HII package list handle.
377 @param FirstLanguage Pointer to language name buffer.
379 @return The supported languages.
384 HiiLibGetSupportedSecondaryLanguages (
385 IN EFI_HII_HANDLE HiiHandle
,
386 IN CONST CHAR8
*FirstLanguage
392 This function returns the number of supported languages on HiiHandle.
394 If HiiHandle is not a valid Handle in the default HII database, then ASSERT.
395 If not enough resource to complete the operation, then ASSERT.
397 @param HiiHandle The HII package list handle.
399 @return The number of supported languages.
404 HiiLibGetSupportedLanguageNumber (
405 IN EFI_HII_HANDLE HiiHandle
410 Convert language code from RFC3066 to ISO639-2.
412 LanguageRfc3066 contain a single RFC 3066 code such as
415 The LanguageRfc3066 must be a buffer large enough
416 for ISO_639_2_ENTRY_SIZE characters.
418 If LanguageRfc3066 is NULL, then ASSERT.
419 If LanguageIso639 is NULL, then ASSERT.
421 @param LanguageRfc3066 RFC3066 language code.
422 @param LanguageIso639 ISO639-2 language code.
424 @retval EFI_SUCCESS Language code converted.
425 @retval EFI_NOT_FOUND Language code not found.
430 ConvertRfc3066LanguageToIso639Language (
431 IN CHAR8
*LanguageRfc3066
,
432 OUT CHAR8
*LanguageIso639
437 Convert language code from ISO639-2 to RFC3066.
439 LanguageIso639 contain a single ISO639-2 code such as
442 The LanguageRfc3066 must be a buffer large enough
443 for RFC_3066_ENTRY_SIZE characters.
445 If LanguageIso639 is NULL, then ASSERT.
446 If LanguageRfc3066 is NULL, then ASSERT.
448 @param LanguageIso639 ISO639-2 language code.
449 @param LanguageRfc3066 RFC3066 language code.
451 @retval EFI_SUCCESS Language code converted.
452 @retval EFI_NOT_FOUND Language code not found.
457 ConvertIso639LanguageToRfc3066Language (
458 IN CONST CHAR8
*LanguageIso639
,
459 OUT CHAR8
*LanguageRfc3066
464 Convert language code list from RFC3066 to ISO639-2, e.g. "en-US;fr-FR" will
465 be converted to "engfra".
467 If SupportedLanguages is NULL, then ASSERT.
469 @param SupportedLanguages The RFC3066 language list.
471 @return The ISO639-2 language list.
477 CHAR8
*SupportedLanguages