Sync in bug fix from EDK I:

[mirror_edk2.git] / MdeModulePkg / Include / Library / ExtendedIfrSupportLib.h

/** @file\r
  Library header file defines APIs that is related to IFR operations but \r
  specific to EDK II implementation.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __EXTENDED_IFR_SUPPORT_LIB_H__\r
#define __EXTENDED_IFR_SUPPORT_LIB_H__\r
\r
/**\r
  Create GUIDed opcode for banner. Banner opcode\r
  EFI_IFR_EXTEND_OP_BANNER is extended opcode specific\r
  to Intel's implementation.\r
\r
  @param  Title                  String ID for title\r
  @param  LineNumber             Line number for this banner\r
  @param  Alignment              Alignment for this banner, left, center or right\r
  @param  Data                   Destination for the created opcode binary\r
\r
  @retval EFI_SUCCESS            Opcode create success\r
  @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CreateBannerOpCode (\r
  IN      EFI_STRING_ID       Title,\r
  IN      UINT16              LineNumber,\r
  IN      UINT8               Alignment,\r
  IN OUT  EFI_HII_UPDATE_DATA *Data\r
  );\r
\r
/**\r
  This function initialize the data structure for dynamic opcode.\r
\r
  @param UpdateData     The adding data;\r
  @param BufferSize     Length of the buffer to fill dynamic opcodes.\r
\r
  @retval EFI_SUCCESS           Update data is initialized.\r
  @retval EFI_INVALID_PARAMETER UpdateData is NULL.\r
  @retval EFI_OUT_OF_RESOURCES  No enough memory to allocate.\r
\r
**/\r
EFI_STATUS\r
IfrLibInitUpdateData (\r
  IN OUT EFI_HII_UPDATE_DATA   *UpdateData,\r
  IN UINT32                    BufferSize\r
  )\r
;\r
\r
/**\r
\r
  This function free the resource of update data.\r
\r
  @param UpdateData      The adding data;\r
\r
  @retval EFI_SUCCESS            Resource in UpdateData is released.\r
  @retval EFI_INVALID_PARAMETER  UpdateData is NULL.\r
\r
**/\r
EFI_STATUS\r
IfrLibFreeUpdateData (\r
  IN EFI_HII_UPDATE_DATA       *UpdateData\r
  )\r
;\r
\r
/**\r
  This function allows the caller to update a form that has\r
  previously been registered with the EFI HII database.\r
  The update make use of a extended opcode EFI_IFR_EXTEND_OP_LABEL\r
  specific to Intel's implementation to complete the operation.\r
  \r
\r
  @param  Handle                 Hii Handle\r
  @param  FormSetGuid            The formset should be updated.\r
  @param  FormId                 The form should be updated.\r
  @param  Label                  Update information starting immediately after this\r
                                 label in the IFR\r
  @param  Insert                 If TRUE and Data is not NULL, insert data after\r
                                 Label. If FALSE, replace opcodes between two\r
                                 labels with Data.\r
  @param  Data                   The adding data; If NULL, remove opcodes between\r
                                 two Label.\r
\r
  @retval EFI_SUCCESS            Update success.\r
  @retval Other                  Update fail.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IfrLibUpdateForm (\r
  IN EFI_HII_HANDLE            Handle,\r
  IN EFI_GUID                  *FormSetGuid, OPTIONAL\r
  IN EFI_FORM_ID               FormId,\r
  IN UINT16                    Label,\r
  IN BOOLEAN                   Insert,\r
  IN EFI_HII_UPDATE_DATA       *Data\r
  );\r
\r
/**\r
  Extract formset class for given HII handle.\r
\r
  If Handle is not a valid EFI_HII_HANDLE in the default HII database, then\r
  ASSERT.\r
\r
  If Class is NULL, then ASSERT.\r
  IfFormSetTitle is NULL, then ASSERT.\r
  If FormSetHelp is NULL, then ASSERT.\r
\r
  @param  HiiHandle              Hii handle\r
  @param  Class                    On output, Class of the formset\r
  @param  FormSetTitle          On output,  Formset title string\r
  @param  FormSetHelp          On output,   Formset help string\r
\r
  @retval EFI_SUCCESS            Successfully extract Class for specified Hii\r
                                 handle.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IfrLibExtractClassFromHiiHandle (\r
  IN      EFI_HII_HANDLE      Handle,\r
  OUT     UINT16              *Class,\r
  OUT     EFI_STRING_ID       *FormSetTitle,\r
  OUT     EFI_STRING_ID       *FormSetHelp\r
  );\r
\r
/**\r
  Configure the buffer accrording to ConfigBody strings in the format of\r
  <Length:4 bytes>, <Offset: 2 bytes>, <Width:2 bytes>, <Data:n bytes>.\r
\r
  @param  Buffer                 the start address of buffer.\r
  @param  BufferSize             the size of buffer.\r
  @param  Number                 the number of the ConfigBody strings.\r
  @param  ...                    the ConfigBody strings\r
\r
  @retval EFI_BUFFER_TOO_SMALL   the BufferSize is too small to operate.\r
  @retval EFI_INVALID_PARAMETER  Buffer is NULL or BufferSize is 0.\r
  @retval EFI_SUCCESS            Operation successful.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IfrLibExtractDefault(\r
  IN VOID                         *Buffer,\r
  IN UINTN                        *BufferSize,\r
  UINTN                           Number,\r
  ...\r
  );\r
\r
#endif\r
\r