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 /**
  44   This function allows the caller to update a form that has
  45   previously been registered with the EFI HII database.
  46   The update make use of a extended opcode EFI_IFR_EXTEND_OP_LABEL
  47   specific to Intel's implementation to complete the operation.
  48
  49
  50   @param  Handle                 Hii Handle
  51   @param  FormSetGuid            The formset should be updated.
  52   @param  FormId                 The form should be updated.
  53   @param  Label                  Update information starting immediately after this
  54                                  label in the IFR
  55   @param  Insert                 If TRUE and Data is not NULL, insert data after
  56                                  Label. If FALSE, replace opcodes between two
  57                                  labels with Data.
  58   @param  Data                   The adding data; If NULL, remove opcodes between
  59                                  two Label.
  60
  61   @retval EFI_SUCCESS            Update success.
  62   @retval Other                  Update fail.
  63
  64 **/
  65 EFI_STATUS
  66 EFIAPI
  67 IfrLibUpdateForm (
  68   IN EFI_HII_HANDLE            Handle,
  69   IN EFI_GUID                  *FormSetGuid, OPTIONAL
  70   IN EFI_FORM_ID               FormId,
  71   IN UINT16                    Label,
  72   IN BOOLEAN                   Insert,
  73   IN EFI_HII_UPDATE_DATA       *Data
  74   )
  75 ;
  76
  77 /**
  78   Extract formset class for given HII handle.
  79
  80   If Handle is not a valid EFI_HII_HANDLE in the default HII database, then
  81   ASSERT.
  82
  83   If Class is NULL, then ASSERT.
  84   IfFormSetTitle is NULL, then ASSERT.
  85   If FormSetHelp is NULL, then ASSERT.
  86
  87   @param  HiiHandle              Hii handle
  88   @param  Class                    On output, Class of the formset
  89   @param  FormSetTitle          On output,  Formset title string
  90   @param  FormSetHelp          On output,   Formset help string
  91
  92   @retval EFI_SUCCESS            Successfully extract Class for specified Hii
  93                                  handle.
  94
  95 **/
  96 EFI_STATUS
  97 EFIAPI
  98 IfrLibExtractClassFromHiiHandle (
  99   IN      EFI_HII_HANDLE      Handle,
 100   OUT     UINT16              *Class,
 101   OUT     EFI_STRING_ID       *FormSetTitle,
 102   OUT     EFI_STRING_ID       *FormSetHelp
 103   )
 104 ;
 105
 106 /**
 107   Configure the buffer accrording to ConfigBody strings in the format of
 108   <Length:4 bytes>, <Offset: 2 bytes>, <Width:2 bytes>, <Data:n bytes>.
 109
 110   @param  Buffer                 the start address of buffer.
 111   @param  BufferSize             the size of buffer.
 112   @param  Number                 the number of the ConfigBody strings.
 113   @param  ...                    the ConfigBody strings
 114
 115   @retval EFI_BUFFER_TOO_SMALL   the BufferSize is too small to operate.
 116   @retval EFI_INVALID_PARAMETER  Buffer is NULL or BufferSize is 0.
 117   @retval EFI_SUCCESS            Operation successful.
 118
 119 **/
 120 EFI_STATUS
 121 EFIAPI
 122 IfrLibExtractDefault(
 123   IN VOID                         *Buffer,
 124   IN UINTN                        *BufferSize,
 125   UINTN                           Number,
 126   ...
 127   )
 128 ;
 129
 130 #endif
 131