EdkCompatibilityPkg/Compatibility/FrameworkHiiOnUefiHiiThunk/HiiDatabase.h

   1 /**@file
   2
   3   This file contains global defines and prototype definitions
   4   for the Framework HII to Uefi HII Thunk Module.
   5
   6 Copyright (c) 2006 - 2008, Intel Corporation
   7 All rights reserved. This program and the accompanying materials
   8 are licensed and made available under the terms and conditions of the BSD License
   9 which accompanies this distribution.  The full text of the license may be found at
  10 http://opensource.org/licenses/bsd-license.php
  11
  12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 #ifndef _HIIDATABASE_H
  18 #define _HIIDATABASE_H
  19
  20
  21 #include <FrameworkDxe.h>
  22
  23 #include <Guid/GlobalVariable.h>
  24 #include <Protocol/FrameworkFormCallback.h>
  25 #include <Protocol/FrameworkHii.h>
  26 #include <Protocol/FrameworkFormBrowser.h>
  27
  28 //
  29 // UEFI HII Protocols
  30 //
  31 #include <Protocol/HiiFont.h>
  32 #include <Protocol/HiiImage.h>
  33 #include <Protocol/HiiString.h>
  34 #include <Protocol/HiiDatabase.h>
  35 #include <Protocol/HiiConfigRouting.h>
  36 #include <Protocol/HiiConfigAccess.h>
  37 #include <Protocol/UgaDraw.h>
  38
  39
  40 #include <Library/BaseLib.h>
  41 #include <Library/DebugLib.h>
  42 #include <Library/UefiDriverEntryPoint.h>
  43 #include <Library/MemoryAllocationLib.h>
  44 #include <Library/BaseMemoryLib.h>
  45 #include <Library/UefiBootServicesTableLib.h>
  46 #include <Library/UefiRuntimeServicesTableLib.h>
  47 #include <Library/HiiLib.h>
  48 #include <Library/ExtendedHiiLib.h>
  49 #include <Library/UefiLib.h>
  50
  51 #include <Library/IfrSupportLib.h>
  52 #include <Library/ExtendedIfrSupportLib.h>
  53 #include <Library/PcdLib.h>
  54
  55 #include <Guid/MdeModuleHii.h>
  56
  57 #include "UefiIfrParser.h"
  58
  59
  60 //
  61 // VARSTORE ID of 0 for Buffer Storage Type Storage is defined as invalid in UEFI 2.1 HII. VARSTORE ID
  62 // 0 is the default VarStore ID for storage without explicit declaration in Framework HII 0.92. EDK II UEFI VFR compiler
  63 // in compatible mode will assign 0x0001 as UEFI VARSTORE ID to this default storage id in Framework VFR without
  64 // VARSTORE declaration.
  65 //
  66 // In addition, the Name of Default VarStore is assumed to be L"Setup" for those storage without explicit VARSTORE declaration in the formset
  67 // by Framework HII. EDK II UEFI VFR compiler in compatible mode hard-coded L"Setup" as VARSTORE name.
  68 //
  69 #define FRAMEWORK_RESERVED_VARSTORE_ID 0x0001
  70 #define FRAMEWORK_RESERVED_VARSTORE_NAME L"Setup"
  71
  72 ///
  73 /// The size of a 3 character ISO639 language code.
  74 ///
  75 #define ISO_639_2_ENTRY_SIZE            3
  76
  77
  78
  79 #pragma pack (1)
  80 typedef struct {
  81   EFI_HII_PACK_HEADER     FrameworkPackageHeader;
  82   EFI_HII_PACKAGE_HEADER  PackageHeader;
  83 } TIANO_AUTOGEN_PACKAGES_HEADER;
  84 #pragma pack ()
  85
  86 #define HII_THUNK_PRIVATE_DATA_FROM_THIS(Record)  CR(Record, HII_THUNK_PRIVATE_DATA, Hii, HII_THUNK_PRIVATE_DATA_SIGNATURE)
  87 #define HII_THUNK_PRIVATE_DATA_SIGNATURE            SIGNATURE_32 ('H', 'i', 'I', 'T')
  88 typedef struct {
  89   UINTN                    Signature;
  90   EFI_HANDLE               Handle;
  91   EFI_HII_PROTOCOL         Hii;
  92
  93   //
  94   // The head of link list for all HII_THUNK_CONTEXT.
  95   //
  96   LIST_ENTRY               ThunkContextListHead;
  97
  98   EFI_HANDLE               RemovePackNotifyHandle;
  99   EFI_HANDLE               AddPackNotifyHandle;
 100 } HII_THUNK_PRIVATE_DATA;
 101
 102
 103
 104
 105
 106 #define QUESTION_ID_MAP_ENTRY_FROM_LINK(Record) CR(Record, QUESTION_ID_MAP_ENTRY, Link, QUESTION_ID_MAP_ENTRY_SIGNATURE)
 107 #define QUESTION_ID_MAP_ENTRY_SIGNATURE            SIGNATURE_32 ('Q', 'I', 'M', 'E')
 108 typedef struct {
 109   UINT32            Signature;
 110   LIST_ENTRY        Link;
 111   UINT16            FwQId;
 112   EFI_QUESTION_ID   UefiQid;
 113 } QUESTION_ID_MAP_ENTRY;
 114
 115
 116
 117 #define QUESTION_ID_MAP_FROM_LINK(Record) CR(Record, QUESTION_ID_MAP, Link, QUESTION_ID_MAP_SIGNATURE)
 118 #define QUESTION_ID_MAP_SIGNATURE            SIGNATURE_32 ('Q', 'I', 'M', 'P')
 119 typedef struct {
 120   UINT32            Signature;
 121   LIST_ENTRY        Link;
 122   UINT16            VarStoreId;
 123   UINTN             VarSize;
 124   LIST_ENTRY        MapEntryListHead;
 125 } QUESTION_ID_MAP;
 126
 127
 128
 129 #define HII_THUNK_CONTEXT_FROM_LINK(Record) CR(Record, HII_THUNK_CONTEXT, Link, HII_THUNK_CONTEXT_SIGNATURE)
 130 #define HII_THUNK_CONTEXT_SIGNATURE            SIGNATURE_32 ('H', 'T', 'H', 'M')
 131 typedef struct {
 132   LIST_ENTRY                Link;
 133   UINT32                    Signature;
 134   FRAMEWORK_EFI_HII_HANDLE  FwHiiHandle;
 135   EFI_HII_HANDLE            UefiHiiHandle;
 136   EFI_HANDLE                UefiHiiDriverHandle;
 137
 138   UINTN                     IfrPackageCount;
 139   UINTN                     StringPackageCount;
 140
 141   BOOLEAN                   ByFrameworkHiiNewPack;
 142
 143   //
 144   // HII Thunk will use TagGuid to associate the String Package and Form Package togehter.
 145   // See description for TagGuid. This field is to record if either one of the following condition
 146   // is TRUE:
 147   // 1) if ((SharingStringPack == TRUE) && (StringPackageCount != 0 && IfrPackageCount == 0)), then this Package List only
 148   ///   has String Packages and provides Strings to other IFR package.
 149   // 2) if ((SharingStringPack == TRUE) && (StringPackageCount == 0 && IfrPackageCount != 1)), then this Form Package
 150   //    copied String Packages from other Package List.
 151   // 3) if ((SharingStringPack == FALSE)), this Package does not provide String Package or copy String Packages from other
 152   //    Package List.
 153   //
 154   //
 155   // When a Hii->NewString() is called for this FwHiiHandle and SharingStringPack is TRUE, then all Package List that sharing
 156   // the same TagGuid will update or create String in there respective String Packages. If SharingStringPack is FALSE, then
 157   // only the String from String Packages in this Package List will be updated or created.
 158   //
 159   BOOLEAN                   SharingStringPack;
 160
 161   //
 162   // The HII 0.92 version of HII data implementation in EDK 1.03 and 1.04 make an the following assumption
 163   // in both HII Database implementation and all modules that registering packages:
 164   // If a Package List has only IFR package and no String Package, the IFR package will reference
 165   // String in another Package List registered with the HII database with the same EFI_HII_PACKAGES.GuidId.
 166   // TagGuid is the used to record this GuidId.
 167   EFI_GUID                   TagGuid;
 168
 169   UINT8                      *NvMapOverride;
 170
 171   FORM_BROWSER_FORMSET       *FormSet;
 172
 173 } HII_THUNK_CONTEXT;
 174
 175
 176
 177 #define BUFFER_STORAGE_ENTRY_SIGNATURE              SIGNATURE_32 ('H', 'T', 's', 'k')
 178 #define BUFFER_STORAGE_ENTRY_FROM_LINK(Record) CR(Record, BUFFER_STORAGE_ENTRY, Link, BUFFER_STORAGE_ENTRY_SIGNATURE)
 179 typedef struct {
 180   LIST_ENTRY Link;
 181   UINT32     Signature;
 182   EFI_GUID   Guid;
 183   CHAR16     *Name;
 184   UINTN      Size;
 185   UINT16     VarStoreId;
 186 } BUFFER_STORAGE_ENTRY;
 187
 188
 189
 190 #define CONFIG_ACCESS_PRIVATE_SIGNATURE            SIGNATURE_32 ('H', 'T', 'c', 'a')
 191 #define CONFIG_ACCESS_PRIVATE_FROM_PROTOCOL(Record) CR(Record, CONFIG_ACCESS_PRIVATE, ConfigAccessProtocol, CONFIG_ACCESS_PRIVATE_SIGNATURE)
 192 typedef struct {
 193   UINT32                         Signature;
 194   EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccessProtocol;
 195   //
 196   // Framework's callback
 197   //
 198   EFI_FORM_CALLBACK_PROTOCOL     *FormCallbackProtocol;
 199
 200   HII_THUNK_CONTEXT              *ThunkContext;
 201 } CONFIG_ACCESS_PRIVATE;
 202
 203
 204
 205 #define EFI_FORMBROWSER_THUNK_PRIVATE_DATA_SIGNATURE            SIGNATURE_32 ('F', 'B', 'T', 'd')
 206 #define EFI_FORMBROWSER_THUNK_PRIVATE_DATA_FROM_THIS(Record)   CR(Record, EFI_FORMBROWSER_THUNK_PRIVATE_DATA, FormBrowser, EFI_FORMBROWSER_THUNK_PRIVATE_DATA_SIGNATURE)
 207 typedef struct {
 208   UINTN                     Signature;
 209   EFI_HANDLE                Handle;
 210   HII_THUNK_PRIVATE_DATA    *ThunkPrivate;
 211   EFI_FORM_BROWSER_PROTOCOL FormBrowser;
 212 } EFI_FORMBROWSER_THUNK_PRIVATE_DATA;
 213
 214
 215 //
 216 // Extern Variables
 217 //
 218 extern CONST EFI_HII_DATABASE_PROTOCOL            *mHiiDatabase;
 219 extern CONST EFI_HII_IMAGE_PROTOCOL               *mHiiImageProtocol;
 220 extern CONST EFI_HII_STRING_PROTOCOL              *mHiiStringProtocol;
 221 extern CONST EFI_HII_FONT_PROTOCOL                *mHiiFontProtocol;
 222 extern CONST EFI_HII_CONFIG_ROUTING_PROTOCOL      *mHiiConfigRoutingProtocol;
 223 extern CONST EFI_FORM_BROWSER2_PROTOCOL           *mFormBrowser2Protocol;
 224
 225 extern HII_THUNK_PRIVATE_DATA                     *mHiiThunkPrivateData;
 226
 227 extern BOOLEAN                                    mInFrameworkUpdatePakcage;
 228
 229
 230 EFI_STATUS
 231 EFIAPI
 232 HiiNewPack (
 233   IN  EFI_HII_PROTOCOL              *This,
 234   IN  EFI_HII_PACKAGES              *PackageList,
 235   OUT FRAMEWORK_EFI_HII_HANDLE      *Handle
 236   );
 237
 238 EFI_STATUS
 239 EFIAPI
 240 HiiRemovePack (
 241   IN EFI_HII_PROTOCOL               *This,
 242   IN FRAMEWORK_EFI_HII_HANDLE       Handle
 243   );
 244
 245 EFI_STATUS
 246 EFIAPI
 247 HiiFindHandles (
 248   IN     EFI_HII_PROTOCOL           *This,
 249   IN OUT UINT16                     *HandleBufferLength,
 250   OUT    FRAMEWORK_EFI_HII_HANDLE   *Handle
 251   );
 252
 253 EFI_STATUS
 254 EFIAPI
 255 HiiExportDatabase (
 256   IN     EFI_HII_PROTOCOL           *This,
 257   IN     FRAMEWORK_EFI_HII_HANDLE   Handle,
 258   IN OUT UINTN                      *BufferSize,
 259   OUT    VOID                       *Buffer
 260   );
 261
 262 EFI_STATUS
 263 EFIAPI
 264 HiiGetGlyph (
 265   IN     EFI_HII_PROTOCOL           *This,
 266   IN     CHAR16                     *Source,
 267   IN OUT UINT16                     *Index,
 268   OUT    UINT8                      **GlyphBuffer,
 269   OUT    UINT16                     *BitWidth,
 270   IN OUT UINT32                     *InternalStatus
 271   );
 272
 273 EFI_STATUS
 274 EFIAPI
 275 HiiGlyphToBlt (
 276   IN     EFI_HII_PROTOCOL              *This,
 277   IN     UINT8                         *GlyphBuffer,
 278   IN     EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground,
 279   IN     EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background,
 280   IN     UINTN                         Count,
 281   IN     UINTN                         Width,
 282   IN     UINTN                         Height,
 283   IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer
 284   );
 285
 286 EFI_STATUS
 287 EFIAPI
 288 HiiNewString (
 289   IN     EFI_HII_PROTOCOL        *This,
 290   IN     CHAR16                  *Language,
 291   IN     FRAMEWORK_EFI_HII_HANDLE Handle,
 292   IN OUT STRING_REF              *Reference,
 293   IN     CHAR16                  *NewString
 294   );
 295
 296 EFI_STATUS
 297 EFIAPI
 298 HiiGetString (
 299   IN     EFI_HII_PROTOCOL           *This,
 300   IN     FRAMEWORK_EFI_HII_HANDLE   Handle,
 301   IN     STRING_REF                 Token,
 302   IN     BOOLEAN                    Raw,
 303   IN     CHAR16                     *LanguageString,
 304   IN OUT UINTN                      *BufferLength,
 305   OUT    EFI_STRING                 StringBuffer
 306   );
 307
 308 EFI_STATUS
 309 EFIAPI
 310 HiiResetStrings (
 311   IN     EFI_HII_PROTOCOL           *This,
 312   IN     FRAMEWORK_EFI_HII_HANDLE   Handle
 313   );
 314
 315 EFI_STATUS
 316 EFIAPI
 317 HiiTestString (
 318   IN     EFI_HII_PROTOCOL           *This,
 319   IN     CHAR16                     *StringToTest,
 320   IN OUT UINT32                     *FirstMissing,
 321   OUT    UINT32                     *GlyphBufferSize
 322   );
 323
 324 EFI_STATUS
 325 EFIAPI
 326 HiiGetPrimaryLanguages (
 327   IN  EFI_HII_PROTOCOL              *This,
 328   IN  FRAMEWORK_EFI_HII_HANDLE      Handle,
 329   OUT EFI_STRING                    *LanguageString
 330   );
 331
 332 EFI_STATUS
 333 EFIAPI
 334 HiiGetSecondaryLanguages (
 335   IN  EFI_HII_PROTOCOL                *This,
 336   IN  FRAMEWORK_EFI_HII_HANDLE        Handle,
 337   IN  CHAR16                          *PrimaryLanguage,
 338   OUT EFI_STRING                      *LanguageString
 339   );
 340
 341 EFI_STATUS
 342 EFIAPI
 343 HiiGetLine (
 344   IN     EFI_HII_PROTOCOL               *This,
 345   IN     FRAMEWORK_EFI_HII_HANDLE       Handle,
 346   IN     STRING_REF                     Token,
 347   IN OUT UINT16                         *Index,
 348   IN     UINT16                         LineWidth,
 349   IN     CHAR16                         *LanguageString,
 350   IN OUT UINT16                         *BufferLength,
 351   OUT    EFI_STRING                     StringBuffer
 352   );
 353
 354 EFI_STATUS
 355 EFIAPI
 356 HiiGetForms (
 357   IN     EFI_HII_PROTOCOL               *This,
 358   IN     FRAMEWORK_EFI_HII_HANDLE       Handle,
 359   IN     EFI_FORM_ID                    FormId,
 360   IN OUT UINTN                          *BufferLength,
 361   OUT    UINT8                          *Buffer
 362   );
 363
 364 EFI_STATUS
 365 EFIAPI
 366 HiiGetDefaultImage (
 367   IN     EFI_HII_PROTOCOL               *This,
 368   IN     FRAMEWORK_EFI_HII_HANDLE       Handle,
 369   IN     UINTN                          DefaultMask,
 370   OUT    EFI_HII_VARIABLE_PACK_LIST     **VariablePackList
 371   );
 372
 373 EFI_STATUS
 374 EFIAPI
 375 HiiUpdateForm (
 376   IN EFI_HII_PROTOCOL                   *This,
 377   IN FRAMEWORK_EFI_HII_HANDLE           Handle,
 378   IN EFI_FORM_LABEL                     Label,
 379   IN BOOLEAN                            AddData,
 380   IN FRAMEWORK_EFI_HII_UPDATE_DATA      *Data
 381   );
 382
 383 EFI_STATUS
 384 EFIAPI
 385 HiiGetKeyboardLayout (
 386   IN     EFI_HII_PROTOCOL               *This,
 387   OUT    UINT16                         *DescriptorCount,
 388   OUT    FRAMEWORK_EFI_KEY_DESCRIPTOR   *Descriptor
 389   );
 390
 391 EFI_STATUS
 392 EFIAPI
 393 ThunkSendForm (
 394   IN  EFI_FORM_BROWSER_PROTOCOL       *This,
 395   IN  BOOLEAN                         UseDatabase,
 396   IN  FRAMEWORK_EFI_HII_HANDLE        *Handle,
 397   IN  UINTN                           HandleCount,
 398   IN  FRAMEWORK_EFI_IFR_PACKET        *Packet, OPTIONAL
 399   IN  EFI_HANDLE                      CallbackHandle, OPTIONAL
 400   IN  UINT8                           *NvMapOverride, OPTIONAL
 401   IN  FRAMEWORK_EFI_SCREEN_DESCRIPTOR *ScreenDimensions, OPTIONAL
 402   OUT BOOLEAN                         *ResetRequired OPTIONAL
 403   );
 404
 405 EFI_STATUS
 406 EFIAPI
 407 ThunkCreatePopUp (
 408   IN  UINTN                           NumberOfLines,
 409   IN  BOOLEAN                         HotKey,
 410   IN  UINTN                           MaximumStringSize,
 411   OUT CHAR16                          *StringBuffer,
 412   OUT EFI_INPUT_KEY                   *KeyValue,
 413   IN  CHAR16                          *String,
 414   ...
 415   );
 416
 417 EFI_STATUS
 418 EFIAPI
 419 RemovePackNotify (
 420   IN UINT8                              PackageType,
 421   IN CONST EFI_GUID                     *PackageGuid,
 422   IN CONST EFI_HII_PACKAGE_HEADER       *Package,
 423   IN EFI_HII_HANDLE                     Handle,
 424   IN EFI_HII_DATABASE_NOTIFY_TYPE       NotifyType
 425   );
 426
 427 EFI_STATUS
 428 EFIAPI
 429 NewOrAddPackNotify (
 430   IN UINT8                              PackageType,
 431   IN CONST EFI_GUID                     *PackageGuid,
 432   IN CONST EFI_HII_PACKAGE_HEADER       *Package,
 433   IN EFI_HII_HANDLE                     Handle,
 434   IN EFI_HII_DATABASE_NOTIFY_TYPE       NotifyType
 435   );
 436
 437 /**
 438   Create a EFI_HII_UPDATE_DATA structure used to call IfrLibUpdateForm.
 439
 440   @param ThunkContext   The HII Thunk Context.
 441   @param FwUpdateData   The Framework Update Data.
 442   @param UefiUpdateData The UEFI Update Data.
 443
 444   @retval EFI_SUCCESS       The UEFI Update Data is created successfully.
 445   @retval EFI_UNSUPPORTED   There is unsupported opcode in FwUpdateData.
 446   @retval EFI_OUT_OF_RESOURCES There is not enough resource.
 447 **/
 448 EFI_STATUS
 449 FwUpdateDataToUefiUpdateData (
 450   IN       HII_THUNK_CONTEXT                *ThunkContext,
 451   IN CONST FRAMEWORK_EFI_HII_UPDATE_DATA    *FwUpdateData,
 452   OUT      EFI_HII_UPDATE_DATA              **UefiUpdateData
 453   )
 454 ;
 455
 456 /**
 457
 458   Initialize string packages in HII database.
 459
 460 **/
 461 VOID
 462 InitSetBrowserStrings (
 463   VOID
 464   )
 465 ;
 466
 467 #include "Utility.h"
 468 #include "ConfigAccess.h"
 469
 470 #endif