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   @retval EFI_SUCCESS            Resource in UpdateData is released.
  67   @retval EFI_INVALID_PARAMETER  UpdateData is NULL.
  68
  69 **/
  70 EFI_STATUS
  71 IfrLibFreeUpdateData (
  72   IN EFI_HII_UPDATE_DATA       *UpdateData
  73   )
  74 ;
  75
  76 /**
  77   This function allows the caller to update a form that has
  78   previously been registered with the EFI HII database.
  79   The update make use of a extended opcode EFI_IFR_EXTEND_OP_LABEL
  80   specific to Intel's implementation to complete the operation.
  81
  82
  83   @param  Handle                 Hii Handle
  84   @param  FormSetGuid            The formset should be updated.
  85   @param  FormId                 The form should be updated.
  86   @param  Label                  Update information starting immediately after this
  87                                  label in the IFR
  88   @param  Insert                 If TRUE and Data is not NULL, insert data after
  89                                  Label. If FALSE, replace opcodes between two
  90                                  labels with Data.
  91   @param  Data                   The adding data; If NULL, remove opcodes between
  92                                  two Label.
  93
  94   @retval EFI_SUCCESS            Update success.
  95   @retval Other                  Update fail.
  96
  97 **/
  98 EFI_STATUS
  99 EFIAPI
 100 IfrLibUpdateForm (
 101   IN EFI_HII_HANDLE            Handle,
 102   IN EFI_GUID                  *FormSetGuid, OPTIONAL
 103   IN EFI_FORM_ID               FormId,
 104   IN UINT16                    Label,
 105   IN BOOLEAN                   Insert,
 106   IN EFI_HII_UPDATE_DATA       *Data
 107   );
 108
 109 /**
 110   Extract formset class for given HII handle.
 111
 112   If Handle is not a valid EFI_HII_HANDLE in the default HII database, then
 113   ASSERT.
 114
 115   If Class is NULL, then ASSERT.
 116   IfFormSetTitle is NULL, then ASSERT.
 117   If FormSetHelp is NULL, then ASSERT.
 118
 119   @param  HiiHandle              Hii handle
 120   @param  Class                    On output, Class of the formset
 121   @param  FormSetTitle          On output,  Formset title string
 122   @param  FormSetHelp          On output,   Formset help string
 123
 124   @retval EFI_SUCCESS            Successfully extract Class for specified Hii
 125                                  handle.
 126
 127 **/
 128 EFI_STATUS
 129 EFIAPI
 130 IfrLibExtractClassFromHiiHandle (
 131   IN      EFI_HII_HANDLE      Handle,
 132   OUT     UINT16              *Class,
 133   OUT     EFI_STRING_ID       *FormSetTitle,
 134   OUT     EFI_STRING_ID       *FormSetHelp
 135   );
 136
 137 /**
 138   Configure the buffer accrording to ConfigBody strings in the format of
 139   <Length:4 bytes>, <Offset: 2 bytes>, <Width:2 bytes>, <Data:n bytes>.
 140
 141   @param  Buffer                 the start address of buffer.
 142   @param  BufferSize             the size of buffer.
 143   @param  Number                 the number of the ConfigBody strings.
 144   @param  ...                    the ConfigBody strings
 145
 146   @retval EFI_BUFFER_TOO_SMALL   the BufferSize is too small to operate.
 147   @retval EFI_INVALID_PARAMETER  Buffer is NULL or BufferSize is 0.
 148   @retval EFI_SUCCESS            Operation successful.
 149
 150 **/
 151 EFI_STATUS
 152 EFIAPI
 153 IfrLibExtractDefault(
 154   IN VOID                         *Buffer,
 155   IN UINTN                        *BufferSize,
 156   UINTN                           Number,
 157   ...
 158   );
 159
 160 #endif
 161