Add in supports for platform Setup module which is programmed using Framework HII interface.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5175 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 331 insertions, 4 deletions

diff --git a/EdkCompatibilityPkg/Compatibility/FrameworkHiiToUefiHiiThunk/HiiDatabase.c b/EdkCompatibilityPkg/Compatibility/FrameworkHiiToUefiHiiThunk/HiiDatabase.c
index 09c571dfaa..53863d8114 100644
--- a/EdkCompatibilityPkg/Compatibility/FrameworkHiiToUefiHiiThunk/HiiDatabase.c
+++ b/EdkCompatibilityPkg/Compatibility/FrameworkHiiToUefiHiiThunk/HiiDatabase.c
@@ -15,8 +15,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 #include "HiiDatabase.h"

 

+EFI_HII_THUNK_PRIVATE_DATA *mHiiThunkPrivateData;

 

-EFI_HII_THUNK_PRIVATE_DATA HiiThunkPrivateDataTempate = {

+EFI_HII_THUNK_PRIVATE_DATA mHiiThunkPrivateDataTempate = {

   {//Signature

     EFI_HII_THUNK_DRIVER_DATA_SIGNATURE 

   },

@@ -47,10 +48,16 @@ EFI_HII_THUNK_PRIVATE_DATA HiiThunkPrivateDataTempate = {
   },

   { //StaticHiiHandle

     //The FRAMEWORK_EFI_HII_HANDLE starts from 1 

-    // and increase upwords untill reach 2^(sizeof (FRAMEWORK_EFI_HII_HANDLE)) - 1. 

+    // and increase upwords untill reach the value of StaticPureUefiHiiHandle. 

     // The code will assert to prevent overflow.

     (FRAMEWORK_EFI_HII_HANDLE) 1 

   },

+  { //StaticPureUefiHiiHandle

+    //The Static FRAMEWORK_EFI_HII_HANDLE starts from 0xFFFF 

+    // and decrease downwords untill reach the value of StaticHiiHandle. 

+    // The code will assert to prevent overflow.

+    (FRAMEWORK_EFI_HII_HANDLE) 0xFFFF 

+  },

   {

     NULL, NULL                  //HiiHandleLinkList

   },

@@ -62,6 +69,255 @@ CONST EFI_HII_IMAGE_PROTOCOL               *mHiiImageProtocol;
 CONST EFI_HII_STRING_PROTOCOL              *mHiiStringProtocol;

 CONST EFI_HII_CONFIG_ROUTING_PROTOCOL      *mHiiConfigRoutingProtocol;

 

+EFI_STATUS

+RegisterUefiHiiHandle (

+  EFI_HII_THUNK_PRIVATE_DATA *Private,

+  EFI_HII_HANDLE             UefiHiiHandle

+ )

+{

+  EFI_STATUS     Status;

+  EFI_GUID       PackageGuid;

+  HII_TRHUNK_HANDLE_MAPPING_DATABASE_ENTRY *HandleMappingEntry;

+

+  HandleMappingEntry = AllocateZeroPool (sizeof (*HandleMappingEntry));

+  HandleMappingEntry->Signature = HII_TRHUNK_HANDLE_MAPPING_DATABASE_ENTRY_SIGNATURE;

+

+  Status = AssignPureUefiHiiHandle (Private, &HandleMappingEntry->FrameworkHiiHandle);

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+  

+  HandleMappingEntry->UefiHiiHandle = UefiHiiHandle;

+  Status = HiiLibExtractGuidFromHiiHandle (UefiHiiHandle, &PackageGuid);

+  ASSERT_EFI_ERROR (Status);

+  

+  CopyGuid(&HandleMappingEntry->TagGuid, &PackageGuid);

+  

+  InsertTailList (&Private->HiiThunkHandleMappingDBListHead, &HandleMappingEntry->List);

+

+  return EFI_SUCCESS;

+}

+

+

+EFI_STATUS

+UnRegisterUefiHiiHandle (

+  EFI_HII_THUNK_PRIVATE_DATA *Private,

+  EFI_HII_HANDLE UefiHiiHandle

+ )

+{

+  HII_TRHUNK_HANDLE_MAPPING_DATABASE_ENTRY     *MapEntry;

+

+  MapEntry = UefiHiiHandleToMapDatabaseEntry (Private, UefiHiiHandle);

+  ASSERT (MapEntry != NULL);

+  

+  RemoveEntryList (&MapEntry->List);

+

+  FreePool (MapEntry);

+    

+  return EFI_SUCCESS;

+}

+

+EFI_STATUS

+EFIAPI

+AddPackNotify (

+  IN UINT8                              PackageType,

+  IN CONST EFI_GUID                     *PackageGuid,

+  IN CONST EFI_HII_PACKAGE_HEADER       *Package,

+  IN EFI_HII_HANDLE                     Handle,

+  IN EFI_HII_DATABASE_NOTIFY_TYPE       NotifyType

+  )

+{

+  EFI_STATUS   Status;

+  EFI_HII_THUNK_PRIVATE_DATA *Private;

+

+  ASSERT (PackageType == EFI_HII_PACKAGE_STRINGS);

+  ASSERT (NotifyType == EFI_HII_DATABASE_NOTIFY_ADD_PACK);

+

+  Status  = EFI_SUCCESS;

+  Private = mHiiThunkPrivateData;

+

+  //

+  // We only create a MapEntry if the Uefi Hii Handle is only already registered

+  // by the HII Thunk Layer.

+  //

+  if (UefiHiiHandleToMapDatabaseEntry (Private, Handle) == NULL) {

+    Status = RegisterUefiHiiHandle (Private, Handle);

+  } 

+

+  return Status;  

+}

+EFI_STATUS

+EFIAPI

+NewPackNotify (

+  IN UINT8                              PackageType,

+  IN CONST EFI_GUID                     *PackageGuid,

+  IN CONST EFI_HII_PACKAGE_HEADER       *Package,

+  IN EFI_HII_HANDLE                     Handle,

+  IN EFI_HII_DATABASE_NOTIFY_TYPE       NotifyType

+  )

+{

+  EFI_STATUS   Status;

+  EFI_HII_THUNK_PRIVATE_DATA *Private;

+

+  ASSERT (PackageType == EFI_HII_PACKAGE_STRINGS);

+  ASSERT (NotifyType == EFI_HII_DATABASE_NOTIFY_NEW_PACK);

+

+  if (mInFrameworkHiiNewPack) {

+    return EFI_SUCCESS;

+  }

+

+  Status  = EFI_SUCCESS;

+  Private = mHiiThunkPrivateData;

+

+  //

+  // We only

+  //

+  if (UefiHiiHandleToMapDatabaseEntry (Private, Handle) == NULL) {

+    Status = RegisterUefiHiiHandle (Private, Handle);

+  } 

+

+  return Status;

+}

+

+BOOLEAN

+IsLastStringPack (

+  IN CONST EFI_HII_PACKAGE_HEADER       *Package,

+  IN EFI_HII_HANDLE                     Handle

+  )

+{

+  EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList;

+  UINTN                        BufferSize;

+  EFI_STATUS                   Status;

+  EFI_HII_PACKAGE_HEADER       *PackageHdrPtr;

+  EFI_HII_PACKAGE_HEADER       PackageHeader;

+  BOOLEAN                      Match;

+

+  Match = FALSE;

+  HiiPackageList = NULL;

+  BufferSize = 0;

+  Status = mHiiDatabase->ExportPackageLists (mHiiDatabase, Handle, &BufferSize, HiiPackageList);

+  ASSERT (Status != EFI_NOT_FOUND);

+  

+  if (Status == EFI_BUFFER_TOO_SMALL) {

+    HiiPackageList = AllocateZeroPool (BufferSize);

+    ASSERT (HiiPackageList != NULL);

+

+    Status = mHiiDatabase->ExportPackageLists (mHiiDatabase, Handle, &BufferSize, HiiPackageList);

+  }

+

+  

+  PackageHdrPtr = (EFI_HII_PACKAGE_HEADER *) ((UINT8 *) HiiPackageList + sizeof (EFI_HII_PACKAGE_LIST_HEADER));

+  CopyMem (&PackageHeader, PackageHdrPtr, sizeof (EFI_HII_PACKAGE_HEADER));

+

+  Status = EFI_SUCCESS;

+

+  while (PackageHeader.Type != EFI_HII_PACKAGE_END) {

+    switch (PackageHeader.Type) {

+      case EFI_HII_PACKAGE_STRINGS:

+        if (CompareMem (Package, PackageHdrPtr, Package->Length) != 0) {

+          FreePool (HiiPackageList);

+          return FALSE;

+        }

+      break;      

+      default:

+        break;

+    }

+    //

+    // goto header of next package

+    //

+    PackageHdrPtr = (EFI_HII_PACKAGE_HEADER *) ((UINT8 *) PackageHdrPtr + PackageHeader.Length);

+    CopyMem (&PackageHeader, PackageHdrPtr, sizeof (EFI_HII_PACKAGE_HEADER));

+  }

+

+  FreePool (HiiPackageList);

+  return TRUE;

+}

+

+EFI_STATUS

+EFIAPI

+RemovePackNotify (

+  IN UINT8                              PackageType,

+  IN CONST EFI_GUID                     *PackageGuid,

+  IN CONST EFI_HII_PACKAGE_HEADER       *Package,

+  IN EFI_HII_HANDLE                     Handle,

+  IN EFI_HII_DATABASE_NOTIFY_TYPE       NotifyType

+  )

+{

+  EFI_STATUS   Status;

+  EFI_HII_THUNK_PRIVATE_DATA *Private;

+  HII_TRHUNK_HANDLE_MAPPING_DATABASE_ENTRY * MapEntry;

+

+  Status = EFI_SUCCESS;

+

+  ASSERT (PackageType == EFI_HII_PACKAGE_STRINGS);

+  ASSERT (NotifyType == EFI_HII_DATABASE_NOTIFY_REMOVE_PACK);

+

+  Private = mHiiThunkPrivateData;

+

+  MapEntry = UefiHiiHandleToMapDatabaseEntry (Private, Handle);

+

+  if (MapEntry->FrameworkHiiHandle > Private->StaticHiiHandle) {

+    //

+    // This is a PackageList registered using UEFI HII Protocol Instance.

+    // The MapEntry->TagGuid for this type of PackageList is a auto generated GUID

+    // to link StringPack with IfrPack.

+    // RemovePackNotify is only used to remove PackageList when it is removed by

+    // calling mHiiDatabase->RemovePackageList interface.

+    if (IsLastStringPack (Package, Handle)) {

+      Status = UnRegisterUefiHiiHandle (Private, Handle);

+    }

+  }

+

+  return Status;

+}

+

+EFI_STATUS

+EFIAPI

+MapUefiHiiHandles (

+  EFI_HII_THUNK_PRIVATE_DATA *Private

+  )

+{

+  UINTN          HandleBufferLength;

+  EFI_HII_HANDLE *HandleBuffer;

+  EFI_STATUS     Status;

+  UINTN          Index;

+  HII_TRHUNK_HANDLE_MAPPING_DATABASE_ENTRY * MapEntry;

+

+  HandleBufferLength = 0;

+  HandleBuffer       = NULL;

+  Status = mHiiDatabase->ListPackageLists (

+                            mHiiDatabase,

+                            EFI_HII_PACKAGE_TYPE_ALL,

+                            NULL,

+                            &HandleBufferLength,

+                            HandleBuffer

+                            );

+  if (EFI_ERROR (Status) && (Status != EFI_BUFFER_TOO_SMALL)) {

+    return Status;

+  }

+

+  HandleBuffer = AllocateZeroPool (HandleBufferLength);

+  Status = mHiiDatabase->ListPackageLists (

+                            mHiiDatabase,

+                            EFI_HII_PACKAGE_TYPE_ALL,

+                            NULL,

+                            &HandleBufferLength,

+                            HandleBuffer

+                            );

+

+  for (Index = 0; Index < HandleBufferLength / sizeof (EFI_HII_HANDLE); Index++) {

+    MapEntry = UefiHiiHandleToMapDatabaseEntry (Private, HandleBuffer[Index]);

+    //

+    // Only register those UEFI HII Handles that are registered using the UEFI HII database interface.

+    //

+    if (MapEntry == NULL) {

+      Status = RegisterUefiHiiHandle (Private, HandleBuffer[Index]);

+      ASSERT_EFI_ERROR (Status);

+    }

+  }

+

+  return EFI_SUCCESS;                  

+}

 

 EFI_STATUS

 EFIAPI

@@ -89,10 +345,12 @@ Returns:
 

   ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiHiiProtocolGuid);

 

-  HiiData = AllocateCopyPool (sizeof (EFI_HII_THUNK_PRIVATE_DATA), &HiiThunkPrivateDataTempate);

+  HiiData = AllocateCopyPool (sizeof (EFI_HII_THUNK_PRIVATE_DATA), &mHiiThunkPrivateDataTempate);

   ASSERT (HiiData != NULL);

   InitializeListHead (&HiiData->HiiThunkHandleMappingDBListHead);

 

+  mHiiThunkPrivateData = HiiData;

+

   Status = gBS->LocateProtocol (

                   &gEfiHiiDatabaseProtocolGuid,

                   NULL,

@@ -140,6 +398,39 @@ Returns:
                   );

   ASSERT_EFI_ERROR (Status);

 

+  Status = MapUefiHiiHandles (HiiData);

+  ASSERT_EFI_ERROR (Status);

+

+  Status = mHiiDatabase->RegisterPackageNotify (

+                           mHiiDatabase,

+                           EFI_HII_PACKAGE_STRINGS,

+                           NULL,

+                           NewPackNotify,

+                           EFI_HII_DATABASE_NOTIFY_NEW_PACK,

+                           &HiiData->NewPackNotifyHandle

+                           );

+  ASSERT_EFI_ERROR (Status);

+

+  Status = mHiiDatabase->RegisterPackageNotify (

+                           mHiiDatabase,

+                           EFI_HII_PACKAGE_STRINGS,

+                           NULL,

+                           AddPackNotify,

+                           EFI_HII_DATABASE_NOTIFY_ADD_PACK,

+                           &HiiData->AddPackNotifyHandle

+                           );

+  ASSERT_EFI_ERROR (Status);

+

+  Status = mHiiDatabase->RegisterPackageNotify (

+                           mHiiDatabase,

+                           EFI_HII_PACKAGE_STRINGS,

+                           NULL,

+                           RemovePackNotify,

+                           EFI_HII_DATABASE_NOTIFY_REMOVE_PACK,

+                           &HiiData->RemovePackNotifyHandle

+                           );

+  ASSERT_EFI_ERROR (Status);

+

   return Status;

 }

 

@@ -161,7 +452,43 @@ Returns:
 

 --*/

 {

-  ASSERT (FALSE);

+  UINT16                                     Count;

+  LIST_ENTRY                                *ListEntry;

+  HII_TRHUNK_HANDLE_MAPPING_DATABASE_ENTRY *HandleMapEntry;

+  EFI_HII_THUNK_PRIVATE_DATA               *Private;

+

+  if (HandleBufferLength == NULL) {

+    return EFI_INVALID_PARAMETER;

+  }

+

+  Private = EFI_HII_THUNK_PRIVATE_DATA_FROM_THIS(This);  

+

+  Count = 0;

+  for (ListEntry = Private->HiiThunkHandleMappingDBListHead.ForwardLink;

+       ListEntry != &Private->HiiThunkHandleMappingDBListHead;

+       ListEntry = ListEntry->ForwardLink

+       ) {

+    Count++;

+  }

+

+  if (Count > *HandleBufferLength) {

+    *HandleBufferLength = (Count * sizeof (FRAMEWORK_EFI_HII_HANDLE));

+    return EFI_BUFFER_TOO_SMALL;

+  }

+

+  Count = 0;

+  for (ListEntry = Private->HiiThunkHandleMappingDBListHead.ForwardLink;

+       ListEntry != &Private->HiiThunkHandleMappingDBListHead;

+       ListEntry = ListEntry->ForwardLink

+       ) {

+    HandleMapEntry = HII_TRHUNK_HANDLE_MAPPING_DATABASE_ENTRY_FROM_LISTENTRY (ListEntry);

+

+    Handle[Count] = HandleMapEntry->FrameworkHiiHandle;

+  

+    Count++;

+  }  

+

+  *HandleBufferLength = (Count * sizeof (FRAMEWORK_EFI_HII_HANDLE));

   return EFI_SUCCESS;

 }