[mirror_edk2.git] / MdeModulePkg / Library / ExtendedIfrSupportLib / Form.c

/** @file\r
  Common Library Routines to assist handle HII elements.\r
\r
Copyright (c) 2007 - 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
#include "LibraryInternal.h"\r
\r
extern EFI_HII_DATABASE_PROTOCOL *gIfrLibHiiDatabase;\r
\r
/**\r
  Get the specified package from a package list based on an index.\r
  The Buffer on output is updated to point to a package header in\r
  the HiiPackageList. This is an internal function.\r
\r
  @param HiiPackageList  The Package List Header.\r
  @param PackageIndex    The index of the package to get.\r
  @param BufferLen       The length of the package.\r
  @param Buffer          The starting address of package.\r
\r
  @retval EFI_SUCCESS   This function completes successfully.\r
  @retval EFI_NOT_FOUND The package is not found.\r
\r
**/\r
EFI_STATUS\r
GetPackageDataFromPackageList (\r
  IN  EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList,\r
  IN  UINT32                      PackageIndex,\r
  OUT UINT32                      *BufferLen,\r
  OUT EFI_HII_PACKAGE_HEADER      **Buffer\r
  )\r
{\r
  UINT32                        Index;\r
  EFI_HII_PACKAGE_HEADER        *Package;\r
  UINT32                        Offset;\r
  UINT32                        PackageListLength;\r
  EFI_HII_PACKAGE_HEADER        PackageHeader;\r
\r
  PackageHeader.Length = 0;\r
  PackageHeader.Type   = 0;\r
\r
  ASSERT (HiiPackageList != NULL);\r
\r
  if ((BufferLen == NULL) || (Buffer == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Package = NULL;\r
  Index   = 0;\r
  Offset  = sizeof (EFI_HII_PACKAGE_LIST_HEADER);\r
  PackageListLength = ReadUnaligned32 (&HiiPackageList->PackageLength);\r
  while (Offset < PackageListLength) {\r
    Package = (EFI_HII_PACKAGE_HEADER *) (((UINT8 *) HiiPackageList) + Offset);\r
    CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r
    if (Index == PackageIndex) {\r
      break;\r
    }\r
    Offset += PackageHeader.Length;\r
    Index++;\r
  }\r
  if (Offset >= PackageListLength) {\r
    //\r
    // no package found in this Package List\r
    //\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  *BufferLen = PackageHeader.Length;\r
  *Buffer    = Package;\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This is the internal worker function to update the data in\r
  a form specified by FormSetGuid, FormId and Label.\r
\r
  @param FormSetGuid     The optional Formset GUID.\r
  @param FormId          The Form ID.\r
  @param Package         The package header.\r
  @param PackageLength   The package length.\r
  @param Label           The label for the update.\r
  @param Insert          True if inserting opcode to the form.\r
  @param Data            The data payload.\r
  @param TempBuffer      The resultant package.\r
  @param TempBufferSize  The length of the resultant package.\r
\r
  @retval EFI_OUT_OF_RESOURCES  If there is not enough memory to complete the operation.\r
  @retval EFI_INVALID_PARAMETER If TempBuffer or TempBufferSize is NULL.\r
  @retval EFI_SUCCESS    The function completes successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UpdateFormPackageData (\r
  IN  EFI_GUID               *FormSetGuid, OPTIONAL\r
  IN  EFI_FORM_ID            FormId,\r
  IN  EFI_HII_PACKAGE_HEADER *Package,\r
  IN  UINT32                 PackageLength,\r
  IN  UINT16                 Label,\r
  IN  BOOLEAN                Insert,\r
  IN  EFI_HII_UPDATE_DATA    *Data,\r
  OUT UINT8                  **TempBuffer,\r
  OUT UINT32                 *TempBufferSize\r
  )\r
{\r
  UINTN                     AddSize;\r
  UINT8                     *BufferPos;\r
  EFI_HII_PACKAGE_HEADER    PackageHeader;\r
  UINTN                     Offset;\r
  EFI_IFR_OP_HEADER         *IfrOpHdr;\r
  BOOLEAN                   GetFormSet;\r
  BOOLEAN                   GetForm;\r
  UINT8                     ExtendOpCode;\r
  UINT16                    LabelNumber;\r
  BOOLEAN                   Updated;\r
  EFI_IFR_OP_HEADER         *AddOpCode;\r
\r
  if ((TempBuffer == NULL) || (TempBufferSize == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  *TempBufferSize = PackageLength;\r
  if (Data != NULL) {\r
    *TempBufferSize += Data->Offset;\r
  }\r
  *TempBuffer = AllocateZeroPool (*TempBufferSize);\r
  if (*TempBuffer == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  CopyMem (*TempBuffer, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r
  *TempBufferSize = sizeof (EFI_HII_PACKAGE_HEADER);\r
  BufferPos = *TempBuffer + sizeof (EFI_HII_PACKAGE_HEADER);\r
\r
  CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r
  IfrOpHdr   = (EFI_IFR_OP_HEADER *)((UINT8 *) Package + sizeof (EFI_HII_PACKAGE_HEADER));\r
  Offset     = sizeof (EFI_HII_PACKAGE_HEADER);\r
  GetFormSet = (BOOLEAN) ((FormSetGuid == NULL) ? TRUE : FALSE);\r
  GetForm    = FALSE;\r
  Updated    = FALSE;\r
\r
  while (Offset < PackageHeader.Length) {\r
    CopyMem (BufferPos, IfrOpHdr, IfrOpHdr->Length);\r
    BufferPos += IfrOpHdr->Length;\r
    *TempBufferSize += IfrOpHdr->Length;\r
\r
    switch (IfrOpHdr->OpCode) {\r
    case EFI_IFR_FORM_SET_OP :\r
      if (FormSetGuid != NULL) {\r
        if (CompareGuid((GUID *)(VOID *)&((EFI_IFR_FORM_SET *) IfrOpHdr)->Guid, FormSetGuid)) {\r
          GetFormSet = TRUE;\r
        }\r
      }\r
      break;\r
\r
    case EFI_IFR_FORM_OP:\r
      if (CompareMem (&((EFI_IFR_FORM *) IfrOpHdr)->FormId, &FormId, sizeof (EFI_FORM_ID)) == 0) {\r
        GetForm = TRUE;\r
      }\r
      break;\r
\r
    case EFI_IFR_GUID_OP :\r
      if (!GetFormSet || !GetForm || Updated) {\r
        //\r
        // Go to the next Op-Code\r
        //\r
        Offset   += IfrOpHdr->Length;\r
        IfrOpHdr = (EFI_IFR_OP_HEADER *) ((CHAR8 *) (IfrOpHdr) + IfrOpHdr->Length);\r
        continue;\r
      }\r
\r
      ExtendOpCode = ((EFI_IFR_GUID_LABEL *) IfrOpHdr)->ExtendOpCode;\r
      LabelNumber = ReadUnaligned16 ((UINT16 *)(VOID *)&((EFI_IFR_GUID_LABEL *)IfrOpHdr)->Number);\r
      if ((ExtendOpCode != EFI_IFR_EXTEND_OP_LABEL) || (LabelNumber != Label) \r
          || !CompareGuid ((EFI_GUID *)(UINTN)(&((EFI_IFR_GUID_LABEL *)IfrOpHdr)->Guid), &gEfiIfrTianoGuid)) {\r
        //\r
        // Go to the next Op-Code\r
        //\r
        Offset   += IfrOpHdr->Length;\r
        IfrOpHdr = (EFI_IFR_OP_HEADER *) ((CHAR8 *) (IfrOpHdr) + IfrOpHdr->Length);\r
        continue;\r
      }\r
\r
      if (Insert && (Data != NULL)) {\r
        //\r
        // insert the DataCount amount of opcodes to TempBuffer if Data is NULL remove\r
        // DataCount amount of opcodes unless runing into a label.\r
        //\r
        AddOpCode = (EFI_IFR_OP_HEADER *)Data->Data;\r
        AddSize   = 0;\r
        while (AddSize < Data->Offset) {\r
          CopyMem (BufferPos, AddOpCode, AddOpCode->Length);\r
          BufferPos += AddOpCode->Length;\r
          *TempBufferSize += AddOpCode->Length;\r
\r
          AddSize += AddOpCode->Length;\r
          AddOpCode = (EFI_IFR_OP_HEADER *) ((CHAR8 *) (AddOpCode) + AddOpCode->Length);\r
        }\r
      } else {\r
        //\r
        // Search the next Label.\r
        //\r
        while (TRUE) {\r
          Offset   += IfrOpHdr->Length;\r
          //\r
          // Search the next label and Fail if not label found.\r
          //\r
          if (Offset >= PackageHeader.Length) {\r
            goto Fail;\r
          }\r
          IfrOpHdr = (EFI_IFR_OP_HEADER *) ((CHAR8 *) (IfrOpHdr) + IfrOpHdr->Length);\r
          if (IfrOpHdr->OpCode == EFI_IFR_GUID_OP) {\r
            ExtendOpCode = ((EFI_IFR_GUID_LABEL *) IfrOpHdr)->ExtendOpCode;\r
            if ((ExtendOpCode == EFI_IFR_EXTEND_OP_LABEL) && CompareGuid ((EFI_GUID *)(UINTN)(&((EFI_IFR_GUID_LABEL *)IfrOpHdr)->Guid), &gEfiIfrTianoGuid)) {\r
              break;\r
            }\r
          }\r
        }\r
\r
        if (Data != NULL) {\r
          AddOpCode = (EFI_IFR_OP_HEADER *)Data->Data;\r
          AddSize   = 0;\r
          while (AddSize < Data->Offset) {\r
            CopyMem (BufferPos, AddOpCode, AddOpCode->Length);\r
            BufferPos += AddOpCode->Length;\r
            *TempBufferSize += AddOpCode->Length;\r
\r
            AddSize   += AddOpCode->Length;\r
            AddOpCode = (EFI_IFR_OP_HEADER *) ((CHAR8 *) (AddOpCode) + AddOpCode->Length);\r
          }\r
        }\r
\r
        //\r
        // copy the next label\r
        //\r
        CopyMem (BufferPos, IfrOpHdr, IfrOpHdr->Length);\r
        BufferPos += IfrOpHdr->Length;\r
        *TempBufferSize += IfrOpHdr->Length;\r
      }\r
\r
      Updated = TRUE;\r
      break;\r
    default :\r
      break;\r
    }\r
\r
    //\r
    // Go to the next Op-Code\r
    //\r
    Offset   += IfrOpHdr->Length;\r
    IfrOpHdr = (EFI_IFR_OP_HEADER *) ((CHAR8 *) (IfrOpHdr) + IfrOpHdr->Length);\r
  }\r
\r
  //\r
  // Update the package length.\r
  //\r
  PackageHeader.Length = *TempBufferSize;\r
  CopyMem (*TempBuffer, &PackageHeader, sizeof (EFI_HII_PACKAGE_HEADER));\r
\r
Fail:\r
  if (!Updated) {\r
    FreePool (*TempBuffer);\r
    *TempBufferSize = 0;\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  return EFI_SUCCESS;\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
  ASSERT (UpdateData != NULL);\r
\r
  UpdateData->BufferSize = BufferSize;\r
  UpdateData->Offset = 0;\r
  UpdateData->Data = AllocatePool (BufferSize);\r
\r
  return (UpdateData->Data != NULL) ? EFI_SUCCESS : EFI_OUT_OF_RESOURCES;\r
}\r
\r
/**\r
\r
  This function free the resource of update data.\r
\r
  @param UpdateData      The adding data;\r
\r
**/\r
VOID\r
IfrLibFreeUpdateData (\r
  IN EFI_HII_UPDATE_DATA       *UpdateData\r
  )\r
{\r
  ASSERT (UpdateData != NULL);\r
  \r
  FreePool (UpdateData->Data);\r
  UpdateData->Data = NULL;\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
\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
  EFI_STATUS                   Status;\r
  EFI_HII_DATABASE_PROTOCOL    *HiiDatabase;\r
  EFI_HII_PACKAGE_LIST_HEADER  *HiiPackageList;\r
  UINT32                       Index;\r
  EFI_HII_PACKAGE_LIST_HEADER  *UpdateBuffer;\r
  UINTN                        BufferSize;\r
  UINT8                        *UpdateBufferPos;\r
  EFI_HII_PACKAGE_HEADER       PackageHeader;\r
  EFI_HII_PACKAGE_HEADER       *Package;\r
  UINT32                       PackageLength;\r
  EFI_HII_PACKAGE_HEADER       *TempBuffer;\r
  UINT32                       TempBufferSize;\r
  BOOLEAN                      Updated;\r
\r
  if (Data == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  HiiDatabase = gIfrLibHiiDatabase;\r
\r
  //\r
  // Get the orginal package list\r
  //\r
  BufferSize = 0;\r
  HiiPackageList   = NULL;\r
  Status = HiiDatabase->ExportPackageLists (HiiDatabase, Handle, &BufferSize, HiiPackageList);\r
  //\r
  // Handle is a invalid handle. Check if Handle is corrupted.\r
  //\r
  ASSERT (Status != EFI_NOT_FOUND);\r
  //\r
  // The return status should always be EFI_BUFFER_TOO_SMALL as input buffer's size is 0.\r
  //\r
  ASSERT (Status == EFI_BUFFER_TOO_SMALL);\r
  HiiPackageList = AllocatePool (BufferSize);\r
  ASSERT (HiiPackageList != NULL);\r
\r
  Status = HiiDatabase->ExportPackageLists (HiiDatabase, Handle, &BufferSize, HiiPackageList);\r
  if (EFI_ERROR (Status)) {\r
    FreePool (HiiPackageList);\r
    return Status;\r
  }\r
\r
  //\r
  // Calculate and allocate space for retrieval of IFR data\r
  //\r
  BufferSize += Data->Offset;\r
  UpdateBuffer = AllocateZeroPool (BufferSize);\r
  if (UpdateBuffer == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  UpdateBufferPos = (UINT8 *) UpdateBuffer;\r
\r
  //\r
  // copy the package list header\r
  //\r
  CopyMem (UpdateBufferPos, HiiPackageList, sizeof (EFI_HII_PACKAGE_LIST_HEADER));\r
  UpdateBufferPos += sizeof (EFI_HII_PACKAGE_LIST_HEADER);\r
\r
  Updated = FALSE;\r
  for (Index = 0; ; Index++) {\r
    Status = GetPackageDataFromPackageList (HiiPackageList, Index, &PackageLength, &Package);\r
    if (Status == EFI_SUCCESS) {\r
      CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r
      if ((PackageHeader.Type == EFI_HII_PACKAGE_FORMS) && !Updated) {\r
        Status = UpdateFormPackageData (FormSetGuid, FormId, Package, PackageLength, Label, Insert, Data, (UINT8 **)&TempBuffer, &TempBufferSize);\r
        if (!EFI_ERROR(Status)) {\r
          if (FormSetGuid == NULL) {\r
            Updated = TRUE;\r
          }\r
          CopyMem (UpdateBufferPos, TempBuffer, TempBufferSize);\r
          UpdateBufferPos += TempBufferSize;\r
          FreePool (TempBuffer);\r
          continue;\r
        }\r
      }\r
\r
      CopyMem (UpdateBufferPos, Package, PackageLength);\r
      UpdateBufferPos += PackageLength;\r
    } else if (Status == EFI_NOT_FOUND) {\r
      break;\r
    } else {\r
      FreePool (HiiPackageList);\r
      return Status;\r
    }\r
  }\r
\r
  //\r
  // Update package list length\r
  //\r
  BufferSize = UpdateBufferPos - (UINT8 *) UpdateBuffer;\r
  WriteUnaligned32 (&UpdateBuffer->PackageLength, (UINT32)BufferSize);\r
\r
  FreePool (HiiPackageList);\r
\r
  return HiiDatabase->UpdatePackageList (HiiDatabase, Handle, UpdateBuffer);\r
}\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
  This ConfigBody strings is generated by UEFI VfrCompiler for the default\r
  values in a Form Set. The name of the ConfigBody strings is VfrMyIfrNVDataDefault0000\r
  constructed following this rule: \r
   "Vfr" + varstore.name + "Default" + defaultstore.attributes.\r
  Check the generated C file in Output for details.\r
\r
  @param  Buffer                 The start address of buffer.\r
  @param  BufferSize             The size of buffer.\r
  @param  Number                 The number of the strings.\r
  @param  ...                    Variable argument list for default value in <AltResp> format \r
                                 generated by the tool.\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
  VA_LIST                         Args;\r
  UINTN                           Index;\r
  UINT32                          TotalLen;\r
  UINT8                           *BufCfgArray;\r
  UINT8                           *BufferPos;\r
  UINT16                          Offset;\r
  UINT16                          Width;\r
  UINT8                           *Value;\r
\r
  if ((Buffer == NULL) || (BufferSize == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Offset = 0;\r
  Width  = 0;\r
  Value  = NULL;\r
\r
  VA_START (Args, Number);\r
  for (Index = 0; Index < Number; Index++) {\r
    BufCfgArray = (UINT8 *) VA_ARG (Args, VOID *);\r
    TotalLen = ReadUnaligned32 ((UINT32 *)BufCfgArray);\r
    BufferPos = BufCfgArray + sizeof (UINT32);\r
\r
    while ((UINT32)(BufferPos - BufCfgArray) < TotalLen) {\r
      Offset = ReadUnaligned16 ((UINT16 *)BufferPos);\r
      BufferPos += sizeof (UINT16);\r
      Width = ReadUnaligned16 ((UINT16 *)BufferPos);\r
      BufferPos += sizeof (UINT16);\r
      Value = BufferPos;\r
      BufferPos += Width;\r
\r
      if ((UINTN)(Offset + Width) > *BufferSize) {\r
        return EFI_BUFFER_TOO_SMALL;\r
      }\r
\r
      CopyMem ((UINT8 *)Buffer + Offset, Value, Width);\r
    }\r
  }\r
  VA_END (Args);\r
\r
  *BufferSize = (UINTN)Offset;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
Commit	Line	Data
8dbae30d	1	/** @file\r
	2	Common Library Routines to assist handle HII elements.\r
	3	\r
	4	Copyright (c) 2007 - 2008, Intel Corporation. <BR>\r
	5	All rights reserved. This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
	13	**/\r
	14	\r
	15	#include "LibraryInternal.h"\r
	16	\r
13492369	17	extern EFI_HII_DATABASE_PROTOCOL *gIfrLibHiiDatabase;\r
13492369	18	\r
6ca46b63	19	/**\r
	20	Get the specified package from a package list based on an index.\r
	21	The Buffer on output is updated to point to a package header in\r
	22	the HiiPackageList. This is an internal function.\r
	23	\r
	24	@param HiiPackageList The Package List Header.\r
	25	@param PackageIndex The index of the package to get.\r
	26	@param BufferLen The length of the package.\r
	27	@param Buffer The starting address of package.\r
	28	\r
	29	@retval EFI_SUCCESS This function completes successfully.\r
	30	@retval EFI_NOT_FOUND The package is not found.\r
	31	\r
	32	**/\r
8dbae30d	33	EFI_STATUS\r
	34	GetPackageDataFromPackageList (\r
	35	IN EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList,\r
	36	IN UINT32 PackageIndex,\r
	37	OUT UINT32 *BufferLen,\r
	38	OUT EFI_HII_PACKAGE_HEADER **Buffer\r
	39	)\r
	40	{\r
	41	UINT32 Index;\r
	42	EFI_HII_PACKAGE_HEADER *Package;\r
	43	UINT32 Offset;\r
	44	UINT32 PackageListLength;\r
6ca46b63	45	EFI_HII_PACKAGE_HEADER PackageHeader;\r
	46	\r
	47	PackageHeader.Length = 0;\r
	48	PackageHeader.Type = 0;\r
8dbae30d	49	\r
53dff899	50	ASSERT (HiiPackageList != NULL);\r
8dbae30d	51	\r
	52	if ((BufferLen == NULL) \|\| (Buffer == NULL)) {\r
	53	return EFI_INVALID_PARAMETER;\r
	54	}\r
	55	\r
	56	Package = NULL;\r
	57	Index = 0;\r
	58	Offset = sizeof (EFI_HII_PACKAGE_LIST_HEADER);\r
3a306c10	59	PackageListLength = ReadUnaligned32 (&HiiPackageList->PackageLength);\r
8dbae30d	60	while (Offset < PackageListLength) {\r
	61	Package = (EFI_HII_PACKAGE_HEADER ) (((UINT8 ) HiiPackageList) + Offset);\r
	62	CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r
	63	if (Index == PackageIndex) {\r
	64	break;\r
	65	}\r
	66	Offset += PackageHeader.Length;\r
	67	Index++;\r
	68	}\r
	69	if (Offset >= PackageListLength) {\r
	70	//\r
	71	// no package found in this Package List\r
	72	//\r
	73	return EFI_NOT_FOUND;\r
	74	}\r
	75	\r
	76	*BufferLen = PackageHeader.Length;\r
	77	*Buffer = Package;\r
	78	return EFI_SUCCESS;\r
	79	}\r
	80	\r
6ca46b63	81	/**\r
6ca46b63	82	This is the internal worker function to update the data in\r
5df74ff8	83	a form specified by FormSetGuid, FormId and Label.\r
6ca46b63	84	\r
6ca46b63	85	@param FormSetGuid The optional Formset GUID.\r
53dff899	86	@param FormId The Form ID.\r
6ca46b63	87	@param Package The package header.\r
	88	@param PackageLength The package length.\r
	89	@param Label The label for the update.\r
	90	@param Insert True if inserting opcode to the form.\r
	91	@param Data The data payload.\r
	92	@param TempBuffer The resultant package.\r
	93	@param TempBufferSize The length of the resultant package.\r
	94	\r
	95	@retval EFI_OUT_OF_RESOURCES If there is not enough memory to complete the operation.\r
	96	@retval EFI_INVALID_PARAMETER If TempBuffer or TempBufferSize is NULL.\r
	97	@retval EFI_SUCCESS The function completes successfully.\r
	98	\r
	99	**/\r
8dbae30d	100	EFI_STATUS\r
	101	EFIAPI\r
	102	UpdateFormPackageData (\r
6ca46b63	103	IN EFI_GUID *FormSetGuid, OPTIONAL\r
8dbae30d	104	IN EFI_FORM_ID FormId,\r
	105	IN EFI_HII_PACKAGE_HEADER *Package,\r
	106	IN UINT32 PackageLength,\r
	107	IN UINT16 Label,\r
	108	IN BOOLEAN Insert,\r
	109	IN EFI_HII_UPDATE_DATA *Data,\r
	110	OUT UINT8 **TempBuffer,\r
	111	OUT UINT32 *TempBufferSize\r
	112	)\r
	113	{\r
	114	UINTN AddSize;\r
	115	UINT8 *BufferPos;\r
	116	EFI_HII_PACKAGE_HEADER PackageHeader;\r
	117	UINTN Offset;\r
	118	EFI_IFR_OP_HEADER *IfrOpHdr;\r
	119	BOOLEAN GetFormSet;\r
	120	BOOLEAN GetForm;\r
	121	UINT8 ExtendOpCode;\r
	122	UINT16 LabelNumber;\r
	123	BOOLEAN Updated;\r
	124	EFI_IFR_OP_HEADER *AddOpCode;\r
	125	\r
	126	if ((TempBuffer == NULL) \|\| (TempBufferSize == NULL)) {\r
	127	return EFI_INVALID_PARAMETER;\r
	128	}\r
	129	\r
	130	*TempBufferSize = PackageLength;\r
	131	if (Data != NULL) {\r
	132	*TempBufferSize += Data->Offset;\r
	133	}\r
	134	TempBuffer = AllocateZeroPool (TempBufferSize);\r
	135	if (*TempBuffer == NULL) {\r
	136	return EFI_OUT_OF_RESOURCES;\r
	137	}\r
	138	\r
	139	CopyMem (*TempBuffer, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r
	140	*TempBufferSize = sizeof (EFI_HII_PACKAGE_HEADER);\r
	141	BufferPos = *TempBuffer + sizeof (EFI_HII_PACKAGE_HEADER);\r
	142	\r
	143	CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r
	144	IfrOpHdr = (EFI_IFR_OP_HEADER )((UINT8 ) Package + sizeof (EFI_HII_PACKAGE_HEADER));\r
	145	Offset = sizeof (EFI_HII_PACKAGE_HEADER);\r
	146	GetFormSet = (BOOLEAN) ((FormSetGuid == NULL) ? TRUE : FALSE);\r
	147	GetForm = FALSE;\r
	148	Updated = FALSE;\r
	149	\r
	150	while (Offset < PackageHeader.Length) {\r
	151	CopyMem (BufferPos, IfrOpHdr, IfrOpHdr->Length);\r
	152	BufferPos += IfrOpHdr->Length;\r
	153	*TempBufferSize += IfrOpHdr->Length;\r
	154	\r
	155	switch (IfrOpHdr->OpCode) {\r
	156	case EFI_IFR_FORM_SET_OP :\r
	157	if (FormSetGuid != NULL) {\r
54656366	158	if (CompareGuid((GUID )(VOID )&((EFI_IFR_FORM_SET *) IfrOpHdr)->Guid, FormSetGuid)) {\r
8dbae30d	159	GetFormSet = TRUE;\r
	160	}\r
	161	}\r
	162	break;\r
	163	\r
	164	case EFI_IFR_FORM_OP:\r
	165	if (CompareMem (&((EFI_IFR_FORM *) IfrOpHdr)->FormId, &FormId, sizeof (EFI_FORM_ID)) == 0) {\r
	166	GetForm = TRUE;\r
	167	}\r
	168	break;\r
	169	\r
	170	case EFI_IFR_GUID_OP :\r
	171	if (!GetFormSet \|\| !GetForm \|\| Updated) {\r
	172	//\r
	173	// Go to the next Op-Code\r
	174	//\r
	175	Offset += IfrOpHdr->Length;\r
	176	IfrOpHdr = (EFI_IFR_OP_HEADER ) ((CHAR8 ) (IfrOpHdr) + IfrOpHdr->Length);\r
	177	continue;\r
	178	}\r
	179	\r
	180	ExtendOpCode = ((EFI_IFR_GUID_LABEL *) IfrOpHdr)->ExtendOpCode;\r
54656366	181	LabelNumber = ReadUnaligned16 ((UINT16 )(VOID )&((EFI_IFR_GUID_LABEL *)IfrOpHdr)->Number);\r
3597bcbe	182	if ((ExtendOpCode != EFI_IFR_EXTEND_OP_LABEL) \|\| (LabelNumber != Label) \r
5c526736	183	\|\| !CompareGuid ((EFI_GUID )(UINTN)(&((EFI_IFR_GUID_LABEL )IfrOpHdr)->Guid), &gEfiIfrTianoGuid)) {\r
8dbae30d	184	//\r
	185	// Go to the next Op-Code\r
	186	//\r
	187	Offset += IfrOpHdr->Length;\r
	188	IfrOpHdr = (EFI_IFR_OP_HEADER ) ((CHAR8 ) (IfrOpHdr) + IfrOpHdr->Length);\r
	189	continue;\r
	190	}\r
	191	\r
	192	if (Insert && (Data != NULL)) {\r
	193	//\r
	194	// insert the DataCount amount of opcodes to TempBuffer if Data is NULL remove\r
	195	// DataCount amount of opcodes unless runing into a label.\r
	196	//\r
	197	AddOpCode = (EFI_IFR_OP_HEADER *)Data->Data;\r
	198	AddSize = 0;\r
	199	while (AddSize < Data->Offset) {\r
	200	CopyMem (BufferPos, AddOpCode, AddOpCode->Length);\r
	201	BufferPos += AddOpCode->Length;\r
	202	*TempBufferSize += AddOpCode->Length;\r
	203	\r
	204	AddSize += AddOpCode->Length;\r
	205	AddOpCode = (EFI_IFR_OP_HEADER ) ((CHAR8 ) (AddOpCode) + AddOpCode->Length);\r
	206	}\r
	207	} else {\r
	208	//\r
	209	// Search the next Label.\r
	210	//\r
	211	while (TRUE) {\r
	212	Offset += IfrOpHdr->Length;\r
	213	//\r
	214	// Search the next label and Fail if not label found.\r
	215	//\r
	216	if (Offset >= PackageHeader.Length) {\r
	217	goto Fail;\r
	218	}\r
	219	IfrOpHdr = (EFI_IFR_OP_HEADER ) ((CHAR8 ) (IfrOpHdr) + IfrOpHdr->Length);\r
	220	if (IfrOpHdr->OpCode == EFI_IFR_GUID_OP) {\r
	221	ExtendOpCode = ((EFI_IFR_GUID_LABEL *) IfrOpHdr)->ExtendOpCode;\r
5c526736	222	if ((ExtendOpCode == EFI_IFR_EXTEND_OP_LABEL) && CompareGuid ((EFI_GUID )(UINTN)(&((EFI_IFR_GUID_LABEL )IfrOpHdr)->Guid), &gEfiIfrTianoGuid)) {\r
8dbae30d	223	break;\r
	224	}\r
	225	}\r
	226	}\r
	227	\r
	228	if (Data != NULL) {\r
	229	AddOpCode = (EFI_IFR_OP_HEADER *)Data->Data;\r
	230	AddSize = 0;\r
	231	while (AddSize < Data->Offset) {\r
	232	CopyMem (BufferPos, AddOpCode, AddOpCode->Length);\r
	233	BufferPos += AddOpCode->Length;\r
	234	*TempBufferSize += AddOpCode->Length;\r
	235	\r
	236	AddSize += AddOpCode->Length;\r
	237	AddOpCode = (EFI_IFR_OP_HEADER ) ((CHAR8 ) (AddOpCode) + AddOpCode->Length);\r
	238	}\r
	239	}\r
	240	\r
	241	//\r
	242	// copy the next label\r
	243	//\r
	244	CopyMem (BufferPos, IfrOpHdr, IfrOpHdr->Length);\r
	245	BufferPos += IfrOpHdr->Length;\r
	246	*TempBufferSize += IfrOpHdr->Length;\r
	247	}\r
	248	\r
	249	Updated = TRUE;\r
	250	break;\r
	251	default :\r
	252	break;\r
	253	}\r
	254	\r
	255	//\r
	256	// Go to the next Op-Code\r
	257	//\r
	258	Offset += IfrOpHdr->Length;\r
	259	IfrOpHdr = (EFI_IFR_OP_HEADER ) ((CHAR8 ) (IfrOpHdr) + IfrOpHdr->Length);\r
	260	}\r
	261	\r
	262	//\r
	263	// Update the package length.\r
	264	//\r
	265	PackageHeader.Length = *TempBufferSize;\r
	266	CopyMem (*TempBuffer, &PackageHeader, sizeof (EFI_HII_PACKAGE_HEADER));\r
	267	\r
	268	Fail:\r
	269	if (!Updated) {\r
cfb9b643	270	FreePool (*TempBuffer);\r
8dbae30d	271	*TempBufferSize = 0;\r
	272	return EFI_NOT_FOUND;\r
	273	}\r
	274	\r
	275	return EFI_SUCCESS;\r
	276	}\r
	277	\r
8d00a0f1	278	/**\r
	279	This function initialize the data structure for dynamic opcode.\r
	280	\r
	281	@param UpdateData The adding data;\r
	282	@param BufferSize Length of the buffer to fill dynamic opcodes.\r
	283	\r
	284	@retval EFI_SUCCESS Update data is initialized.\r
	285	@retval EFI_INVALID_PARAMETER UpdateData is NULL.\r
	286	@retval EFI_OUT_OF_RESOURCES No enough memory to allocate.\r
	287	\r
	288	**/\r
	289	EFI_STATUS\r
	290	IfrLibInitUpdateData (\r
	291	IN OUT EFI_HII_UPDATE_DATA *UpdateData,\r
	292	IN UINT32 BufferSize\r
	293	)\r
	294	{\r
	295	ASSERT (UpdateData != NULL);\r
	296	\r
	297	UpdateData->BufferSize = BufferSize;\r
	298	UpdateData->Offset = 0;\r
	299	UpdateData->Data = AllocatePool (BufferSize);\r
	300	\r
	301	return (UpdateData->Data != NULL) ? EFI_SUCCESS : EFI_OUT_OF_RESOURCES;\r
	302	}\r
	303	\r
	304	/**\r
	305	\r
	306	This function free the resource of update data.\r
	307	\r
	308	@param UpdateData The adding data;\r
	309	\r
8d00a0f1	310	**/\r
f875a4f1	311	VOID\r
8d00a0f1	312	IfrLibFreeUpdateData (\r
	313	IN EFI_HII_UPDATE_DATA *UpdateData\r
	314	)\r
	315	{\r
f875a4f1	316	ASSERT (UpdateData != NULL);\r
	317	\r
	318	FreePool (UpdateData->Data);\r
8d00a0f1	319	UpdateData->Data = NULL;\r
8d00a0f1	320	\r
8d00a0f1	321	}\r
8dbae30d	322	\r
	323	/**\r
	324	This function allows the caller to update a form that has\r
	325	previously been registered with the EFI HII database.\r
	326	\r
	327	@param Handle Hii Handle\r
	328	@param FormSetGuid The formset should be updated.\r
	329	@param FormId The form should be updated.\r
	330	@param Label Update information starting immediately after this\r
	331	label in the IFR\r
	332	@param Insert If TRUE and Data is not NULL, insert data after\r
	333	Label. If FALSE, replace opcodes between two\r
	334	labels with Data\r
	335	@param Data The adding data; If NULL, remove opcodes between\r
	336	two Label.\r
	337	\r
	338	@retval EFI_SUCCESS Update success.\r
	339	@retval Other Update fail.\r
	340	\r
	341	**/\r
	342	EFI_STATUS\r
	343	EFIAPI\r
	344	IfrLibUpdateForm (\r
	345	IN EFI_HII_HANDLE Handle,\r
	346	IN EFI_GUID *FormSetGuid, OPTIONAL\r
	347	IN EFI_FORM_ID FormId,\r
	348	IN UINT16 Label,\r
	349	IN BOOLEAN Insert,\r
	350	IN EFI_HII_UPDATE_DATA *Data\r
	351	)\r
	352	{\r
	353	EFI_STATUS Status;\r
	354	EFI_HII_DATABASE_PROTOCOL *HiiDatabase;\r
	355	EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList;\r
	356	UINT32 Index;\r
	357	EFI_HII_PACKAGE_LIST_HEADER *UpdateBuffer;\r
	358	UINTN BufferSize;\r
	359	UINT8 *UpdateBufferPos;\r
	360	EFI_HII_PACKAGE_HEADER PackageHeader;\r
	361	EFI_HII_PACKAGE_HEADER *Package;\r
	362	UINT32 PackageLength;\r
	363	EFI_HII_PACKAGE_HEADER *TempBuffer;\r
	364	UINT32 TempBufferSize;\r
	365	BOOLEAN Updated;\r
	366	\r
	367	if (Data == NULL) {\r
	368	return EFI_INVALID_PARAMETER;\r
	369	}\r
	370	\r
	371	HiiDatabase = gIfrLibHiiDatabase;\r
	372	\r
	373	//\r
	374	// Get the orginal package list\r
	375	//\r
	376	BufferSize = 0;\r
	377	HiiPackageList = NULL;\r
	378	Status = HiiDatabase->ExportPackageLists (HiiDatabase, Handle, &BufferSize, HiiPackageList);\r
fa7b3168	379	//\r
	380	// Handle is a invalid handle. Check if Handle is corrupted.\r
	381	//\r
	382	ASSERT (Status != EFI_NOT_FOUND);\r
	383	//\r
	384	// The return status should always be EFI_BUFFER_TOO_SMALL as input buffer's size is 0.\r
	385	//\r
	386	ASSERT (Status == EFI_BUFFER_TOO_SMALL);\r
	387	HiiPackageList = AllocatePool (BufferSize);\r
	388	ASSERT (HiiPackageList != NULL);\r
	389	\r
	390	Status = HiiDatabase->ExportPackageLists (HiiDatabase, Handle, &BufferSize, HiiPackageList);\r
	391	if (EFI_ERROR (Status)) {\r
	392	FreePool (HiiPackageList);\r
	393	return Status;\r
8dbae30d	394	}\r
	395	\r
	396	//\r
	397	// Calculate and allocate space for retrieval of IFR data\r
	398	//\r
	399	BufferSize += Data->Offset;\r
	400	UpdateBuffer = AllocateZeroPool (BufferSize);\r
	401	if (UpdateBuffer == NULL) {\r
	402	return EFI_OUT_OF_RESOURCES;\r
	403	}\r
	404	\r
	405	UpdateBufferPos = (UINT8 *) UpdateBuffer;\r
	406	\r
	407	//\r
	408	// copy the package list header\r
	409	//\r
	410	CopyMem (UpdateBufferPos, HiiPackageList, sizeof (EFI_HII_PACKAGE_LIST_HEADER));\r
	411	UpdateBufferPos += sizeof (EFI_HII_PACKAGE_LIST_HEADER);\r
	412	\r
	413	Updated = FALSE;\r
	414	for (Index = 0; ; Index++) {\r
	415	Status = GetPackageDataFromPackageList (HiiPackageList, Index, &PackageLength, &Package);\r
	416	if (Status == EFI_SUCCESS) {\r
	417	CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r
8d00a0f1	418	if ((PackageHeader.Type == EFI_HII_PACKAGE_FORMS) && !Updated) {\r
8dbae30d	419	Status = UpdateFormPackageData (FormSetGuid, FormId, Package, PackageLength, Label, Insert, Data, (UINT8 **)&TempBuffer, &TempBufferSize);\r
	420	if (!EFI_ERROR(Status)) {\r
	421	if (FormSetGuid == NULL) {\r
	422	Updated = TRUE;\r
	423	}\r
	424	CopyMem (UpdateBufferPos, TempBuffer, TempBufferSize);\r
	425	UpdateBufferPos += TempBufferSize;\r
cfb9b643	426	FreePool (TempBuffer);\r
8dbae30d	427	continue;\r
	428	}\r
	429	}\r
	430	\r
	431	CopyMem (UpdateBufferPos, Package, PackageLength);\r
	432	UpdateBufferPos += PackageLength;\r
	433	} else if (Status == EFI_NOT_FOUND) {\r
	434	break;\r
	435	} else {\r
cfb9b643	436	FreePool (HiiPackageList);\r
8dbae30d	437	return Status;\r
	438	}\r
	439	}\r
	440	\r
	441	//\r
	442	// Update package list length\r
	443	//\r
	444	BufferSize = UpdateBufferPos - (UINT8 *) UpdateBuffer;\r
3a306c10	445	WriteUnaligned32 (&UpdateBuffer->PackageLength, (UINT32)BufferSize);\r
8dbae30d	446	\r
cfb9b643	447	FreePool (HiiPackageList);\r
8dbae30d	448	\r
	449	return HiiDatabase->UpdatePackageList (HiiDatabase, Handle, UpdateBuffer);\r
	450	}\r
	451	\r
	452	\r
	453	/**\r
53dff899	454	Configure the buffer accrording to ConfigBody strings in the format of\r
	455	<Length:4 bytes>, <Offset: 2 bytes>, <Width:2 bytes>, <Data:n bytes>.\r
	456	This ConfigBody strings is generated by UEFI VfrCompiler for the default\r
	457	values in a Form Set. The name of the ConfigBody strings is VfrMyIfrNVDataDefault0000\r
	458	constructed following this rule: \r
	459	"Vfr" + varstore.name + "Default" + defaultstore.attributes.\r
	460	Check the generated C file in Output for details.\r
8dbae30d	461	\r
6ca46b63	462	@param Buffer The start address of buffer.\r
	463	@param BufferSize The size of buffer.\r
	464	@param Number The number of the strings.\r
	465	@param ... Variable argument list for default value in <AltResp> format \r
	466	generated by the tool.\r
8dbae30d	467	\r
	468	@retval EFI_BUFFER_TOO_SMALL the BufferSize is too small to operate.\r
	469	@retval EFI_INVALID_PARAMETER Buffer is NULL or BufferSize is 0.\r
	470	@retval EFI_SUCCESS Operation successful.\r
	471	\r
	472	**/\r
	473	EFI_STATUS\r
	474	EFIAPI\r
	475	IfrLibExtractDefault(\r
	476	IN VOID *Buffer,\r
	477	IN UINTN *BufferSize,\r
	478	UINTN Number,\r
	479	...\r
	480	)\r
	481	{\r
	482	VA_LIST Args;\r
	483	UINTN Index;\r
	484	UINT32 TotalLen;\r
	485	UINT8 *BufCfgArray;\r
	486	UINT8 *BufferPos;\r
	487	UINT16 Offset;\r
	488	UINT16 Width;\r
	489	UINT8 *Value;\r
	490	\r
	491	if ((Buffer == NULL) \|\| (BufferSize == NULL)) {\r
	492	return EFI_INVALID_PARAMETER;\r
	493	}\r
	494	\r
	495	Offset = 0;\r
	496	Width = 0;\r
	497	Value = NULL;\r
	498	\r
	499	VA_START (Args, Number);\r
	500	for (Index = 0; Index < Number; Index++) {\r
	501	BufCfgArray = (UINT8 ) VA_ARG (Args, VOID );\r
3a306c10	502	TotalLen = ReadUnaligned32 ((UINT32 *)BufCfgArray);\r
8dbae30d	503	BufferPos = BufCfgArray + sizeof (UINT32);\r
	504	\r
	505	while ((UINT32)(BufferPos - BufCfgArray) < TotalLen) {\r
3a306c10	506	Offset = ReadUnaligned16 ((UINT16 *)BufferPos);\r
8dbae30d	507	BufferPos += sizeof (UINT16);\r
3a306c10	508	Width = ReadUnaligned16 ((UINT16 *)BufferPos);\r
8dbae30d	509	BufferPos += sizeof (UINT16);\r
	510	Value = BufferPos;\r
	511	BufferPos += Width;\r
	512	\r
	513	if ((UINTN)(Offset + Width) > *BufferSize) {\r
	514	return EFI_BUFFER_TOO_SMALL;\r
	515	}\r
	516	\r
	517	CopyMem ((UINT8 *)Buffer + Offset, Value, Width);\r
	518	}\r
	519	}\r
	520	VA_END (Args);\r
	521	\r
	522	*BufferSize = (UINTN)Offset;\r
	523	\r
	524	return EFI_SUCCESS;\r
	525	}\r
	526	\r
	527	\r