Add NewHii and UefiHiiServices library instances.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8049 6f19259b-4bc3-4df7-8a09-765794883524
2009-04-09 15:12:01 +00:00
parent 253a25e8cc
commit ef7df998f7
4 changed files with 3181 additions and 0 deletions
--- a/MdeModulePkg/Library/UefiHiiServicesLib/UefiHiiServicesLib.c
+++ b/MdeModulePkg/Library/UefiHiiServicesLib/UefiHiiServicesLib.c
@@ -0,0 +1,108 @@
+/** @file
+  This library retrieves pointers to the UEFI HII Protocol instances in the 
+  library's constructor.  All of the UEFI HII related protocols are optional, 
+  so the consumers of this library class must verify that the global variable 
+  pointers are not NULL before use.   
+
+  Copyright (c) 2006 - 2009, Intel Corporation<BR>
+  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 <Library/UefiHiiServicesLib.h>
+#include <Library/UefiBootServicesTableLib.h>
+#include <Library/DebugLib.h>
+
+#include <Protocol/HiiFont.h>
+#include <Protocol/HiiString.h>
+#include <Protocol/HiiImage.h>
+#include <Protocol/HiiDatabase.h>
+#include <Protocol/HiiConfigRouting.h>
+
+///
+/// Pointer to the UEFI HII Font Protocol
+///
+EFI_HII_FONT_PROTOCOL  *gHiiFont = NULL;
+
+///
+/// Pointer to the UEFI HII String Protocol
+///
+EFI_HII_STRING_PROTOCOL  *gHiiString = NULL;
+
+///
+/// Pointer to the UEFI HII Image Protocol
+///
+EFI_HII_IMAGE_PROTOCOL  *gHiiImage = NULL;
+
+///
+/// Pointer to the UEFI HII Database Protocol
+///
+EFI_HII_DATABASE_PROTOCOL  *gHiiDatabase = NULL;
+
+///
+/// Pointer to the UEFI HII Config Rounting Protocol
+///
+EFI_HII_CONFIG_ROUTING_PROTOCOL  *gHiiConfigRouting = NULL;
+
+/**
+  The constructor function retrieves pointers to the UEFI HII protocol instances
+    
+  The constructor function retrieves pointers to the four UEFI HII protocols from the 
+  handle database.  These include the UEFI HII Font Protocol, the UEFI HII String 
+  Protocol, the UEFI HII Image Protocol, the UEFI HII Database Protocol, and the 
+  UEFI HII Config Routing Protocol.  This function always return EFI_SUCCESS.
+  All of these protocols are optional if the platform does not support configuration
+  and the UEFI HII Image Protocol and the UEFI HII Font Protocol are optional if 
+  the platform does not support a graphical console.  As a result, the consumers
+  of this library much check the protocol pointers againt NULL before using them,
+  or use dependency expressions to guarantee that some of them are present before
+  assuming they are not NULL.
+
+  @param  ImageHandle   The firmware allocated handle for the EFI image.
+  @param  SystemTable   A pointer to the EFI System Table.
+
+  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.
+
+**/
+EFI_STATUS
+EFIAPI
+UefiHiiServicesLibConstructor (
+  IN EFI_HANDLE        ImageHandle,
+  IN EFI_SYSTEM_TABLE  *SystemTable
+  )
+{
+  //
+  // Retrieve the pointer to the UEFI HII Font Protocol 
+  //
+  gBS->LocateProtocol (&gEfiHiiFontProtocolGuid, NULL, (VOID **) &gHiiFont);
+
+  //
+  // Retrieve the pointer to the UEFI HII String Protocol 
+  //
+  gBS->LocateProtocol (&gEfiHiiStringProtocolGuid, NULL, (VOID **) &gHiiString);
+
+  //
+  // Retrieve the pointer to the UEFI HII Image Protocol 
+  //
+  gBS->LocateProtocol (&gEfiHiiImageProtocolGuid, NULL, (VOID **) &gHiiImage);
+
+  //
+  // Retrieve the pointer to the UEFI HII Database Protocol 
+  //
+  gBS->LocateProtocol (&gEfiHiiDatabaseProtocolGuid, NULL, (VOID **) &gHiiDatabase);
+
+  //
+  // Retrieve the pointer to the UEFI HII Config Routing Protocol 
+  //
+  gBS->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid, NULL, (VOID **) &gHiiConfigRouting);
+
+  return EFI_SUCCESS;
+}