Add an example HII driver to show how to generate HII resource section

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

4 files changed, 255 insertions, 0 deletions

diff --git a/MdeModulePkg/Universal/HiiResourcesSampleDxe/HiiResourcesSample.c b/MdeModulePkg/Universal/HiiResourcesSampleDxe/HiiResourcesSample.c
new file mode 100644
index 0000000..c3c5725
--- /dev/null
+++ b/MdeModulePkg/Universal/HiiResourcesSampleDxe/HiiResourcesSample.c
@@ -0,0 +1,156 @@
+/** @file

+This is an example of how a driver retrieve HII data using HII Package List

+Protocol, and how to publish the HII data.

+

+Copyright (c) 2009, Intel Corporation

+All rights reserved. This program and the accompanying materials

+are licensed and made available under the terms and conditions of the BSD License

+which accompanies this distribution.  The full text of the license may be found at

+http://opensource.org/licenses/bsd-license.php

+

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+**/

+

+#include <Uefi.h>

+#include <Protocol/HiiPackageList.h>

+#include <Library/DevicePathLib.h>

+#include <Library/UefiDriverEntryPoint.h>

+#include <Library/UefiBootServicesTableLib.h>

+#include <Library/UefiHiiServicesLib.h>

+#include <Library/HiiLib.h>

+

+#pragma pack(1)

+///

+/// HII specific Vendor Device Path definition.

+///

+typedef struct {

+  VENDOR_DEVICE_PATH             VendorDevicePath;

+  EFI_DEVICE_PATH_PROTOCOL       End;

+} HII_VENDOR_DEVICE_PATH;

+#pragma pack()

+

+

+EFI_HII_HANDLE  mHiiHandle = NULL;

+EFI_HANDLE      mDriverHandle = NULL;

+

+HII_VENDOR_DEVICE_PATH  mHiiVendorDevicePath = {

+  {

+    {

+      HARDWARE_DEVICE_PATH,

+      HW_VENDOR_DP,

+      {

+        (UINT8) (sizeof (VENDOR_DEVICE_PATH)),

+        (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)

+      }

+    },

+    //

+    // {D49D2EB0-44D5-4621-9FD6-1A92C9109B99}

+    //

+    { 0xD49D2EB0, 0x44D5, 0x4621, { 0x9F, 0xD6, 0x1A, 0x92, 0xC9, 0x10, 0x9B, 0x99 } }

+  },

+  {

+    END_DEVICE_PATH_TYPE,

+    END_ENTIRE_DEVICE_PATH_SUBTYPE,

+    { 

+      (UINT8) (END_DEVICE_PATH_LENGTH),

+      (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)

+    }

+  }

+};

+

+/**

+  Main entry for this driver.

+  

+  @param[in] ImageHandle     Image handle this driver.

+  @param[in] SystemTable     Pointer to SystemTable.

+

+  @retval EFI_SUCESS     This function always complete successfully.

+

+**/

+EFI_STATUS

+EFIAPI

+HiiResourcesSampleInit (

+  IN EFI_HANDLE                   ImageHandle,

+  IN EFI_SYSTEM_TABLE             *SystemTable

+  )

+{

+  EFI_STATUS                      Status;

+  EFI_HII_PACKAGE_LIST_HEADER     *PackageList;

+

+  //

+  // Retrieve HII package list from ImageHandle

+  //

+  Status = gBS->OpenProtocol (

+                  ImageHandle,

+                  &gEfiHiiPackageListProtocolGuid,

+                  (VOID **) &PackageList,

+                  ImageHandle,

+                  NULL,

+                  EFI_OPEN_PROTOCOL_GET_PROTOCOL

+                  );

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  //

+  // Publish sample Fromset

+  //

+  Status = gBS->InstallProtocolInterface (

+                  &mDriverHandle,

+                  &gEfiDevicePathProtocolGuid,

+                  EFI_NATIVE_INTERFACE,

+                  &mHiiVendorDevicePath

+                  );

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  //

+  // Publish HII package list to HII Database. Here we use ImageHandle as

+  // the "Driver Handle" for HiiDatabase->NewPackageList(), since there will

+  // be EFI_LOADED_IMAGE_DEVICE_PATH_PROTOCOL installed on the ImageHandle.

+  //

+  Status = gHiiDatabase->NewPackageList (

+                          gHiiDatabase,

+                          PackageList,

+                          mDriverHandle,

+                          &mHiiHandle

+                          );

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  return EFI_SUCCESS;

+}

+

+/**

+  Unloads the application and its installed protocol.

+

+  @param[in]  ImageHandle       Handle that identifies the image to be unloaded.

+

+  @retval EFI_SUCCESS           The image has been unloaded.

+**/

+EFI_STATUS

+EFIAPI

+HiiResourcesSampleUnload (

+  IN EFI_HANDLE  ImageHandle

+  )

+{

+  if (mDriverHandle != NULL) {

+    gBS->UninstallProtocolInterface (

+            mDriverHandle,

+            &gEfiDevicePathProtocolGuid,

+            &mHiiVendorDevicePath

+           );

+    mDriverHandle = NULL;

+  }

+

+  if (mHiiHandle != NULL) {

+    HiiRemovePackages (mHiiHandle);

+    mHiiHandle = NULL;

+  }

+

+  return EFI_SUCCESS;

+}

diff --git a/MdeModulePkg/Universal/HiiResourcesSampleDxe/HiiResourcesSampleDxe.inf b/MdeModulePkg/Universal/HiiResourcesSampleDxe/HiiResourcesSampleDxe.inf
new file mode 100644
index 0000000..82e2412
--- /dev/null
+++ b/MdeModulePkg/Universal/HiiResourcesSampleDxe/HiiResourcesSampleDxe.inf
@@ -0,0 +1,53 @@
+#/** @file

+# This is an example of how a driver retrieve HII data using HII Package List

+# Protocol, and how to publish the HII data.

+#

+#  Copyright (c) 2009, Intel Corporation. All rights reserved.

+#

+#  All rights reserved. This program and the accompanying materials

+#  are licensed and made available under the terms and conditions of the BSD License

+#  which accompanies this distribution. The full text of the license may be found at

+#  http://opensource.org/licenses/bsd-license.php

+#  

+#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+#

+#

+#**/

+

+[Defines]

+  INF_VERSION                    = 0x00010005

+  BASE_NAME                      = HiiResourcesSample

+  FILE_GUID                      = D49D2EB0-44D5-4621-9FD6-1A92C9109B99

+  MODULE_TYPE                    = UEFI_DRIVER

+  VERSION_STRING                 = 1.0

+  ENTRY_POINT                    = HiiResourcesSampleInit

+  UNLOAD_IMAGE                   = HiiResourcesSampleUnload

+#

+#  This flag specifies whether HII resource section is generated into PE image.

+#

+  UEFI_HII_RESOURCE_SECTION      = TRUE

+

+#

+# The following information is for reference only and not required by the build tools.

+#

+#  VALID_ARCHITECTURES           = IA32 X64 IPF EBC

+#

+

+[Sources]

+  HiiResourcesSample.c

+  SampleStrings.uni

+  Sample.vfr

+

+[Packages]

+  MdePkg/MdePkg.dec

+  MdeModulePkg/MdeModulePkg.dec

+

+[LibraryClasses]

+  UefiBootServicesTableLib

+  UefiDriverEntryPoint

+  UefiHiiServicesLib

+  HiiLib

+

+[Protocols]

+  gEfiHiiPackageListProtocolGuid    ## CONSUMES

diff --git a/MdeModulePkg/Universal/HiiResourcesSampleDxe/Sample.vfr b/MdeModulePkg/Universal/HiiResourcesSampleDxe/Sample.vfr
new file mode 100644
index 0000000..ad0ecad
--- /dev/null
+++ b/MdeModulePkg/Universal/HiiResourcesSampleDxe/Sample.vfr
@@ -0,0 +1,46 @@
+// *++

+//

+// Copyright (c) 2009, Intel Corporation

+// All rights reserved. This program and the accompanying materials

+// are licensed and made available under the terms and conditions of the BSD License

+// which accompanies this distribution.  The full text of the license may be found at

+// http://opensource.org/licenses/bsd-license.php

+//

+// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+//

+// Module Name:

+//

+//   Sample.vfr

+//

+// Abstract:

+//

+//   Sample Form.

+//

+// Revision History:

+//

+// --*/

+

+#define SAMPLE_GUID    { 0x4f4ef7f0, 0xaa29, 0x4ce9, 0xba, 0x41, 0x64, 0x3e, 0x1, 0x23, 0xa9, 0x9f }

+

+

+formset

+  guid     = SAMPLE_GUID,

+  title    = STRING_TOKEN(STR_SAMPLE_FORM_SET_TITLE),

+  help     = STRING_TOKEN(STR_SAMPLE_FORM_SET_HELP),

+

+  form formid = 1,

+       title  = STRING_TOKEN(STR_SAMPLE_FORM1_TITLE);

+

+  	text

+      help   = STRING_TOKEN(STR_SAMPLE_VERSION_HELP),

+      text   = STRING_TOKEN(STR_SAMPLE_VERSION_TEXT),

+	    text   = STRING_TOKEN(STR_SAMPLE_EMPTY);

+

+    subtitle text = STRING_TOKEN(STR_SAMPLE_EMPTY);

+

+    subtitle text = STRING_TOKEN(STR_SAMPLE_ESC);

+

+  endform;

+

+endformset;

diff --git a/MdeModulePkg/Universal/HiiResourcesSampleDxe/SampleStrings.uni b/MdeModulePkg/Universal/HiiResourcesSampleDxe/SampleStrings.uni
new file mode 100644
index 0000000..5b3f1d9
--- /dev/null
+++ b/MdeModulePkg/Universal/HiiResourcesSampleDxe/SampleStrings.uni