MdePkg/Include/Library/HiiLib.h

   1 /** @file
   2   Public include file for the HII Library
   3
   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
   9
  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.
  12
  13 **/
  14
  15 #ifndef __HII_LIB_H__
  16 #define __HII_LIB_H__
  17
  18 //
  19 // Limited buffer size recommended by RFC4646 (4.3.  Length Considerations)
  20 // (42 characters plus a NULL terminator)
  21 //
  22 #define RFC_3066_ENTRY_SIZE             (42 + 1)
  23
  24 #define ISO_639_2_ENTRY_SIZE            3
  25
  26 /**
  27   Assemble EFI_HII_PACKAGE_LIST according to the passed in packages.
  28
  29   If GuidId is NULL, then ASSERT.
  30   If not enough resource to complete the operation, then ASSERT.
  31
  32   @param  NumberOfPackages       Number of packages.
  33   @param  GuidId                          Package GUID.
  34   @param  ...                                Variable argument list for packages to be assembled.
  35
  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.
  38
  39 **/
  40 EFI_HII_PACKAGE_LIST_HEADER *
  41 EFIAPI
  42 HiiLibPreparePackageList (
  43   IN UINTN                    NumberOfPackages,
  44   IN CONST EFI_GUID                 *GuidId,
  45   ...
  46   )
  47 ;
  48
  49 /**
  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.
  54
  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.
  57
  58   If HiiHandle is NULL, then ASSERT.
  59
  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
  66                               be set to NULL.
  67   @param  ...                 The variable argument list describing all HII Package.
  68
  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.
  71
  72 **/
  73 EFI_STATUS
  74 EFIAPI
  75 HiiLibAddPackages (
  76   IN       UINTN               NumberOfPackages,
  77   IN CONST EFI_GUID            *GuidId,
  78   IN       EFI_HANDLE          DriverHandle, OPTIONAL
  79   OUT      EFI_HII_HANDLE      *HiiHandle,
  80   ...
  81   )
  82 ;
  83
  84 /**
  85   Removes a package list from the default HII database.
  86
  87   If HiiHandle is NULL, then ASSERT.
  88   If HiiHandle is not a valid EFI_HII_HANDLE in the default HII database, then ASSERT.
  89
  90   @param  HiiHandle                The handle that was previously registered to the data base that is requested for removal.
  91                                              List later.
  92
  93   @return  VOID
  94
  95 **/
  96 VOID
  97 EFIAPI
  98 HiiLibRemovePackages (
  99   IN      EFI_HII_HANDLE      HiiHandle
 100   )
 101 ;
 102
 103 /**
 104   This function adds the string into String Package of each language
 105   supported by the package list.
 106
 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.
 110
 111   @param  PackageList            Handle of the package list where this string will
 112                                             be added.
 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.
 116
 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.
 119
 120 **/
 121 EFI_STATUS
 122 EFIAPI
 123 HiiLibNewString (
 124   IN  EFI_HII_HANDLE                  PackageList,
 125   OUT EFI_STRING_ID                   *StringId,
 126   IN  CONST EFI_STRING                String
 127   )
 128 ;
 129
 130 /**
 131   This function update the specified string in String Package of each language
 132   supported by the package list.
 133
 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.
 137
 138   @param  PackageList            Handle of the package list where this string will
 139                                             be added.
 140   @param  StringId               Ths String Id to be updated.
 141   @param  String                 Points to the new null-terminated string.
 142
 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.
 145
 146 **/
 147 EFI_STATUS
 148 EFIAPI
 149 HiiLibSetString (
 150   IN  EFI_HII_HANDLE                  PackageList,
 151   IN  EFI_STRING_ID                   StringId,
 152   IN  CONST EFI_STRING                String
 153   )
 154 ;
 155
 156 /**
 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.
 159
 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.
 164
 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
 168                                       PackageList.
 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.
 173
 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
 177                                  to hold the string.
 178   @retval EFI_INVALID_PARAMETER  The String or StringSize was NULL.
 179
 180 **/
 181
 182 EFI_STATUS
 183 EFIAPI
 184 HiiLibGetString (
 185   IN  EFI_HII_HANDLE                  PackageList,
 186   IN  EFI_STRING_ID                   StringId,
 187   OUT EFI_STRING                      String,
 188   IN  OUT UINTN                       *StringSize
 189   )
 190 ;
 191
 192 /**
 193   Get string specified by StringId form the HiiHandle. The caller
 194   is responsible to free the *String.
 195
 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.
 199
 200   @param  HiiHandle              The HII handle of package list.
 201   @param  StringId               The String ID.
 202   @param  String                 The output string.
 203
 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.
 208
 209 **/
 210 EFI_STATUS
 211 EFIAPI
 212 HiiLibGetStringFromHandle (
 213   IN  EFI_HII_HANDLE                  HiiHandle,
 214   IN  EFI_STRING_ID                   StringId,
 215   OUT EFI_STRING                      *String
 216   )
 217 ;
 218
 219 /**
 220   Get the string given the StringId and String package Producer's Guid. The caller
 221   is responsible to free the *String.
 222
 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.
 226
 227   @param  ProducerGuid           The Guid of String package list.
 228   @param  StringId               The String ID.
 229   @param  String                 The output string.
 230
 231   @retval EFI_SUCCESS            Operation is successful.
 232   @retval EFI_OUT_OF_RESOURCES   There is not enought memory in the system.
 233
 234 **/
 235 EFI_STATUS
 236 EFIAPI
 237 HiiLibGetStringFromToken (
 238   IN  EFI_GUID                        *ProducerGuid,
 239   IN  EFI_STRING_ID                   StringId,
 240   OUT EFI_STRING                      *String
 241   )
 242 ;
 243
 244 /**
 245   Determines the handles that are currently active in the database.
 246   It's the caller's responsibility to free handle buffer.
 247
 248   If HandleBufferLength is NULL, then ASSERT.
 249   If HiiHandleBuffer is NULL, then ASSERT.
 250
 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.
 255
 256   @retval EFI_SUCCESS            Get an array of Hii Handles successfully.
 257
 258 **/
 259 EFI_STATUS
 260 EFIAPI
 261 HiiLibGetHiiHandles (
 262   IN OUT UINTN                     *HandleBufferLength,
 263   OUT    EFI_HII_HANDLE            **HiiHandleBuffer
 264   )
 265 ;
 266
 267 /**
 268   Extract Hii package list GUID for given HII handle.
 269
 270   If HiiHandle could not be found in the default HII database, then ASSERT.
 271   If Guid is NULL, then ASSERT.
 272
 273   @param  Handle              Hii handle
 274   @param  Guid                Package list GUID
 275
 276   @retval EFI_SUCCESS            Successfully extract GUID from Hii database.
 277
 278 **/
 279 EFI_STATUS
 280 EFIAPI
 281 HiiLibExtractGuidFromHiiHandle (
 282   IN      EFI_HII_HANDLE      Handle,
 283   OUT     EFI_GUID            *Guid
 284   )
 285 ;
 286
 287 /**
 288   Find HII Handle in the default HII database associated with given Device Path.
 289
 290   If DevicePath is NULL, then ASSERT.
 291
 292   @param  DevicePath             Device Path associated with the HII package list
 293                                  handle.
 294
 295   @retval Handle                 HII package list Handle associated with the Device
 296                                         Path.
 297   @retval NULL                   Hii Package list handle is not found.
 298
 299 **/
 300 EFI_HII_HANDLE
 301 EFIAPI
 302 HiiLibDevicePathToHiiHandle (
 303   IN EFI_DEVICE_PATH_PROTOCOL   *DevicePath
 304   )
 305 ;
 306
 307
 308 /**
 309   Determine what is the current language setting. The space reserved for Lang
 310   must be at least RFC_3066_ENTRY_SIZE bytes;
 311
 312   If Lang is NULL, then ASSERT.
 313
 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
 317                                          is returned.
 318
 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.
 321
 322 **/
 323 EFI_STATUS
 324 EFIAPI
 325 HiiLibGetCurrentLanguage (
 326   OUT     CHAR8               *Lang
 327   )
 328 ;
 329
 330 /**
 331   Get next language from language code list (with separator ';').
 332
 333   If LangCode is NULL, then ASSERT.
 334   If Lang is NULL, then ASSERT.
 335
 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.
 340
 341 **/
 342 VOID
 343 EFIAPI
 344 HiiLibGetNextLanguage (
 345   IN OUT CHAR8      **LangCode,
 346   OUT CHAR8         *Lang
 347   )
 348 ;
 349
 350 /**
 351   This function returns the list of supported languages, in the format specified
 352   in UEFI specification Appendix M.
 353
 354   If HiiHandle is not a valid Handle in the default HII database, then ASSERT.
 355
 356   @param  HiiHandle              The HII package list handle.
 357
 358   @retval   !NULL  The supported languages.
 359   @retval   NULL    If Supported Languages can not be retrived.
 360
 361 **/
 362 CHAR8 *
 363 EFIAPI
 364 HiiLibGetSupportedLanguages (
 365   IN EFI_HII_HANDLE           HiiHandle
 366   )
 367 ;
 368
 369 /**
 370   This function returns the list of supported 2nd languages, in the format specified
 371   in UEFI specification Appendix M.
 372
 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.
 375
 376   @param  HiiHandle              The HII package list handle.
 377   @param  FirstLanguage          Pointer to language name buffer.
 378
 379   @return The supported languages.
 380
 381 **/
 382 CHAR8 *
 383 EFIAPI
 384 HiiLibGetSupportedSecondaryLanguages (
 385   IN EFI_HII_HANDLE           HiiHandle,
 386   IN CONST CHAR8              *FirstLanguage
 387   )
 388 ;
 389
 390
 391 /**
 392   This function returns the number of supported languages on HiiHandle.
 393
 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.
 396
 397   @param  HiiHandle              The HII package list handle.
 398
 399   @return The  number of supported languages.
 400
 401 **/
 402 UINT16
 403 EFIAPI
 404 HiiLibGetSupportedLanguageNumber (
 405   IN EFI_HII_HANDLE           HiiHandle
 406   )
 407 ;
 408
 409 /**
 410   Convert language code from RFC3066 to ISO639-2.
 411
 412   If LanguageRfc3066 is NULL, then ASSERT.
 413   If LanguageIso639 is NULL, then ASSERT.
 414
 415   @param  LanguageRfc3066        RFC3066 language code.
 416   @param  LanguageIso639         ISO639-2 language code.
 417
 418   @retval EFI_SUCCESS            Language code converted.
 419   @retval EFI_NOT_FOUND          Language code not found.
 420
 421 **/
 422 EFI_STATUS
 423 EFIAPI
 424 ConvertRfc3066LanguageToIso639Language (
 425   CHAR8   *LanguageRfc3066,
 426   CHAR8   *LanguageIso639
 427   )
 428 ;
 429
 430 /**
 431   Convert language code list from RFC3066 to ISO639-2, e.g. "en-US;fr-FR" will
 432   be converted to "engfra".
 433
 434   If SupportedLanguages is NULL, then ASSERT.
 435
 436   @param  SupportedLanguages     The RFC3066 language list.
 437
 438   @return The ISO639-2 language list.
 439
 440 **/
 441 CHAR8 *
 442 EFIAPI
 443 Rfc3066ToIso639 (
 444   CHAR8  *SupportedLanguages
 445   )
 446 ;
 447
 448 #endif