MdeModulePkg/Include/Library/ExtendedIfrSupportLib.h

   1 /** @file
   2   Library header file defines APIs that is related to IFR operations but
   3   specific to EDK II implementation.
   4
   5 Copyright (c) 2006 - 2008, Intel Corporation. <BR>
   6 All rights reserved. This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __EXTENDED_IFR_SUPPORT_LIB_H__
  17 #define __EXTENDED_IFR_SUPPORT_LIB_H__
  18
  19 /**
  20   Create GUIDed opcode for banner. Banner opcode
  21   EFI_IFR_EXTEND_OP_BANNER is extended opcode specific
  22   to Intel's implementation.
  23
  24   @param  Title                  String ID for title
  25   @param  LineNumber             Line number for this banner
  26   @param  Alignment              Alignment for this banner, left, center or right
  27   @param  Data                   Destination for the created opcode binary
  28
  29   @retval EFI_SUCCESS            Opcode create success
  30   @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
  31
  32 **/
  33 EFI_STATUS
  34 EFIAPI
  35 CreateBannerOpCode (
  36   IN      EFI_STRING_ID       Title,
  37   IN      UINT16              LineNumber,
  38   IN      UINT8               Alignment,
  39   IN OUT  EFI_HII_UPDATE_DATA *Data
  40   );
  41
  42 /**
  43   This function initialize the data structure for dynamic opcode.
  44
  45   @param UpdateData     The adding data;
  46   @param BufferSize     Length of the buffer to fill dynamic opcodes.
  47
  48   @retval EFI_SUCCESS           Update data is initialized.
  49   @retval EFI_INVALID_PARAMETER UpdateData is NULL.
  50   @retval EFI_OUT_OF_RESOURCES  No enough memory to allocate.
  51
  52 **/
  53 EFI_STATUS
  54 IfrLibInitUpdateData (
  55   IN OUT EFI_HII_UPDATE_DATA   *UpdateData,
  56   IN UINT32                    BufferSize
  57   )
  58 ;
  59
  60 /**
  61
  62   This function free the resource of update data.
  63
  64   @param UpdateData      The adding data;
  65
  66 **/
  67 VOID
  68 IfrLibFreeUpdateData (
  69   IN EFI_HII_UPDATE_DATA       *UpdateData
  70   )
  71 ;
  72
  73 /**
  74   This function allows the caller to update a form that has
  75   previously been registered with the EFI HII database.
  76   The update make use of a extended opcode EFI_IFR_EXTEND_OP_LABEL
  77   specific to Intel's implementation to complete the operation.
  78
  79
  80   @param  Handle                 Hii Handle
  81   @param  FormSetGuid            The formset should be updated.
  82   @param  FormId                 The form should be updated.
  83   @param  Label                  Update information starting immediately after this
  84                                  label in the IFR
  85   @param  Insert                 If TRUE and Data is not NULL, insert data after
  86                                  Label. If FALSE, replace opcodes between two
  87                                  labels with Data.
  88   @param  Data                   The adding data; If NULL, remove opcodes between
  89                                  two Label.
  90
  91   @retval EFI_SUCCESS            Update success.
  92   @retval Other                  Update fail.
  93
  94 **/
  95 EFI_STATUS
  96 EFIAPI
  97 IfrLibUpdateForm (
  98   IN EFI_HII_HANDLE            Handle,
  99   IN EFI_GUID                  *FormSetGuid, OPTIONAL
 100   IN EFI_FORM_ID               FormId,
 101   IN UINT16                    Label,
 102   IN BOOLEAN                   Insert,
 103   IN EFI_HII_UPDATE_DATA       *Data
 104   );
 105
 106 /**
 107   Extract formset class for given HII handle.
 108
 109   If Handle is not a valid EFI_HII_HANDLE in the default HII database, then
 110   ASSERT.
 111
 112   If Class is NULL, then ASSERT.
 113   IfFormSetTitle is NULL, then ASSERT.
 114   If FormSetHelp is NULL, then ASSERT.
 115
 116   @param  HiiHandle              Hii handle
 117   @param  Class                  On output, Class of the formset
 118   @param  FormSetTitle           On output,  Formset title string
 119   @param  FormSetHelp            On output,   Formset help string
 120
 121   @retval EFI_SUCCESS            Successfully extract Class for specified Hii
 122                                  handle.
 123
 124 **/
 125 EFI_STATUS
 126 EFIAPI
 127 IfrLibExtractClassFromHiiHandle (
 128   IN      EFI_HII_HANDLE      Handle,
 129   OUT     UINT16              *Class,
 130   OUT     EFI_STRING_ID       *FormSetTitle,
 131   OUT     EFI_STRING_ID       *FormSetHelp
 132   );
 133
 134 /**
 135   Configure the buffer accrording to ConfigBody strings in the format of
 136   <Length:4 bytes>, <Offset: 2 bytes>, <Width:2 bytes>, <Data:n bytes>.
 137   This ConfigBody strings is generated by UEFI VfrCompiler for the default
 138   values in a Form Set. The name of the ConfigBody strings is VfrMyIfrNVDataDefault0000
 139   constructed following this rule:
 140    "Vfr" + varstore.name + "Default" + defaultstore.attributes.
 141   Check the generated C file in Output for details.
 142
 143   @param  Buffer                 the start address of buffer.
 144   @param  BufferSize             the size of buffer.
 145   @param  Number                 the number of the ConfigBody strings.
 146   @param  ...                    the ConfigBody strings
 147
 148   @retval EFI_BUFFER_TOO_SMALL   the BufferSize is too small to operate.
 149   @retval EFI_INVALID_PARAMETER  Buffer is NULL or BufferSize is 0.
 150   @retval EFI_SUCCESS            Operation successful.
 151
 152 **/
 153 EFI_STATUS
 154 EFIAPI
 155 IfrLibExtractDefault(
 156   IN VOID                         *Buffer,
 157   IN UINTN                        *BufferSize,
 158   UINTN                           Number,
 159   ...
 160   );
 161
 162 #endif
 163