Update all files to follow doxygen style file header.

[mirror_edk2.git] / MdeModulePkg / Library / ExtendedIfrSupportLib / Common.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
\r
//\r
// Hii relative protocols\r
//\r
\r
EFI_HII_DATABASE_PROTOCOL *gIfrLibHiiDatabase;\r
EFI_HII_STRING_PROTOCOL   *gIfrLibHiiString;\r
\r
EFI_STATUS\r
EFIAPI\r
ExtendedIfrSupportLibConstructor (\r
  IN EFI_HANDLE           ImageHandle,\r
  IN EFI_SYSTEM_TABLE     *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  Status = gBS->LocateProtocol (&gEfiHiiDatabaseProtocolGuid, NULL, (VOID **) &gIfrLibHiiDatabase);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = gBS->LocateProtocol (&gEfiHiiStringProtocolGuid, NULL, (VOID **) &gIfrLibHiiString);\r
  ASSERT_EFI_ERROR (Status);\r
  \r
  return EFI_SUCCESS;\r
}\r
\r
\r
\r
STATIC EFI_GUID mIfrVendorGuid = EFI_IFR_TIANO_GUID;\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
Routine Description:\r
  Extract formset class for given HII handle.\r
\r
Arguments:\r
  HiiHandle       - Hii handle\r
  Class           - Class of the formset\r
  FormSetTitle    - Formset title string\r
  FormSetHelp     - Formset help string\r
\r
Returns:\r
  EFI_SUCCESS     - Successfully extract Class for specified Hii handle.\r
\r
--*/\r
{\r
  EFI_STATUS                   Status;\r
  UINTN                        BufferSize;\r
  EFI_HII_PACKAGE_LIST_HEADER  *HiiPackageList;\r
  UINT8                        *Package;\r
  UINT8                        *OpCodeData;\r
  UINT32                       Offset;\r
  UINT32                       Offset2;\r
  UINT32                       PackageListLength;\r
  EFI_HII_PACKAGE_HEADER       PackageHeader;\r
\r
  ASSERT (Handle != NULL);\r
  ASSERT (Class != NULL);  \r
  ASSERT (FormSetTitle != NULL);\r
  ASSERT (FormSetHelp != NULL);\r
\r
  *Class = EFI_NON_DEVICE_CLASS;\r
  *FormSetTitle = 0;\r
  *FormSetHelp = 0;\r
\r
  //\r
  // Get HII PackageList\r
  //\r
  BufferSize = 0;\r
  HiiPackageList = NULL;\r
  Status = gIfrLibHiiDatabase->ExportPackageLists (gIfrLibHiiDatabase, Handle, &BufferSize, HiiPackageList);\r
  ASSERT (Status != EFI_NOT_FOUND);\r
  \r
  if (Status == EFI_BUFFER_TOO_SMALL) {\r
    HiiPackageList = AllocatePool (BufferSize);\r
    ASSERT (HiiPackageList != NULL);\r
\r
    Status = gIfrLibHiiDatabase->ExportPackageLists (gIfrLibHiiDatabase, Handle, &BufferSize, HiiPackageList);\r
  }\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Get Form package from this HII package List\r
  //\r
  Offset = sizeof (EFI_HII_PACKAGE_LIST_HEADER);\r
  Offset2 = 0;\r
  CopyMem (&PackageListLength, &HiiPackageList->PackageLength, sizeof (UINT32));\r
\r
  while (Offset < PackageListLength) {\r
    Package = ((UINT8 *) HiiPackageList) + Offset;\r
    CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r
\r
    if (PackageHeader.Type == EFI_HII_PACKAGE_FORM) {\r
      //\r
      // Search Class Opcode in this Form Package\r
      //\r
      Offset2 = sizeof (EFI_HII_PACKAGE_HEADER);\r
      while (Offset2 < PackageHeader.Length) {\r
        OpCodeData = Package + Offset2;\r
\r
        if (((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode == EFI_IFR_FORM_SET_OP) {\r
          //\r
          // Find FormSet OpCode\r
          //\r
          CopyMem (FormSetTitle, &((EFI_IFR_FORM_SET *) OpCodeData)->FormSetTitle, sizeof (EFI_STRING_ID));\r
          CopyMem (FormSetHelp, &((EFI_IFR_FORM_SET *) OpCodeData)->Help, sizeof (EFI_STRING_ID));\r
        }\r
\r
        if ((((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode == EFI_IFR_GUID_OP) &&\r
             CompareGuid (&mIfrVendorGuid, (EFI_GUID *)(OpCodeData + sizeof (EFI_IFR_OP_HEADER))) &&\r
            (((EFI_IFR_GUID_CLASS *) OpCodeData)->ExtendOpCode == EFI_IFR_EXTEND_OP_CLASS)\r
           ) {\r
          //\r
          // Find GUIDed Class OpCode\r
          //\r
          CopyMem (Class, &((EFI_IFR_GUID_CLASS *) OpCodeData)->Class, sizeof (UINT16));\r
\r
          //\r
          // Till now, we ought to have found the formset Opcode\r
          //\r
          break;\r
        }\r
\r
        Offset2 += ((EFI_IFR_OP_HEADER *) OpCodeData)->Length;\r
      }\r
\r
      if (Offset2 < PackageHeader.Length) {\r
        //\r
        // Target formset found\r
        //\r
        break;\r
      }\r
    }\r
\r
    Offset += PackageHeader.Length;\r
  }\r
\r
  gBS->FreePool (HiiPackageList);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r