[mirror_edk2.git] / IntelFrameworkPkg / Library / FrameworkHiiLib / HiiLib.c

/** @file\r
  HII Library implementation that uses DXE protocols and services.\r
\r
  Copyright (c) 2006, 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
\r
#include <FrameworkDxe.h>\r
\r
#include <Protocol/FrameworkHii.h>\r
\r
#include <Library/FrameworkHiiLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
\r
EFI_HII_PROTOCOL *mHii = NULL;\r
\r
/**\r
  Library constustor function for HiiLib library instance locate the\r
  gEfiHiiProtocolGuid firstly, the other interface in this library\r
  instance will dependent on the protocol of gEfiHiiProtocolGuid.\r
  So the depex of gEfiHiiProtocolGuid is required for this library \r
  instance.\r
  If protocol of gEfiHiiProtocolGuid is not installed, then ASSERT().\r
  \r
  @param ImageHandle  The image handle of driver module who use this library \r
                      instance.\r
  @param SystemTable  Pointer to the EFI System Table.\r
  @retval EFI_SUCCESS library constuctor always success.\r
**/\r
EFI_STATUS\r
EFIAPI\r
FrameworkHiiLibConstructor (\r
  IN EFI_HANDLE           ImageHandle,\r
  IN EFI_SYSTEM_TABLE     *SystemTable\r
  )\r
{\r
  EFI_STATUS Status;\r
  \r
  Status = gBS->LocateProtocol (\r
      &gEfiHiiProtocolGuid,\r
      NULL,\r
      (VOID **) &mHii\r
    );\r
  ASSERT_EFI_ERROR (Status);\r
  ASSERT (mHii != NULL);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This function is internal function that prepare and create\r
  HII packages with given number and package's guid.\r
  It is invoked by HiiAddPackages() and PreparePackages() interface.\r
  If the parameter of package's number is 0, then ASSERT().\r
  \r
  @param NumberOfPackages  Given number of package item in a HII package list.\r
  @param Guid              Given GUID of a HII package list.\r
  @param Marker            Package's content list.\r
  \r
  @return pointer to new created HII package list.\r
**/\r
EFI_HII_PACKAGES *\r
InternalPreparePackages (\r
  IN UINTN           NumberOfPackages,\r
  IN CONST EFI_GUID  *Guid OPTIONAL,\r
  VA_LIST            Marker\r
  )\r
{\r
  EFI_HII_PACKAGES  *HiiPackages;\r
  VOID              **Package;\r
  UINTN             Index;\r
\r
  ASSERT (NumberOfPackages > 0);\r
\r
  HiiPackages                   = AllocateZeroPool (sizeof (EFI_HII_PACKAGES) + NumberOfPackages * sizeof (VOID *));\r
  ASSERT (HiiPackages != NULL);\r
\r
  HiiPackages->GuidId           = (EFI_GUID *) Guid;\r
  HiiPackages->NumberOfPackages = NumberOfPackages;\r
  Package                       = (VOID **) (((UINT8 *) HiiPackages) + sizeof (EFI_HII_PACKAGES));\r
\r
  for (Index = 0; Index < NumberOfPackages; Index++) {\r
    *Package = VA_ARG (Marker, VOID *);\r
    Package++;\r
  }\r
\r
  return HiiPackages;\r
\r
}\r
\r
/**\r
  This function allocates pool for an EFI_HII_PACKAGES structure\r
  with enough space for the variable argument list of package pointers.\r
  The allocated structure is initialized using NumberOfPackages, Guid,\r
  and the variable length argument list of package pointers.\r
\r
  @param  NumberOfPackages The number of HII packages to prepare.\r
  @param  Guid Package GUID.\r
\r
  @return The allocated and initialized packages.\r
\r
**/\r
EFI_HII_PACKAGES *\r
EFIAPI\r
PreparePackages (\r
  IN UINTN           NumberOfPackages,\r
  IN CONST EFI_GUID  *Guid OPTIONAL,\r
  ...\r
  )\r
{\r
  VA_LIST           Args;\r
\r
  VA_START (Args, Guid);\r
\r
  return InternalPreparePackages (NumberOfPackages, Guid, Args);\r
}\r
\r
\r
/**\r
  This function allocates pool for an EFI_HII_PACKAGE_LIST structure\r
  with additional space that is big enough to host all packages described by the variable \r
  argument list of package pointers.  The allocated structure is initialized using NumberOfPackages, \r
  GuidId,  and the variable length argument list of package pointers.\r
\r
  Then, EFI_HII_PACKAGE_LIST will be register to the default System HII Database. The\r
  Handle to the newly registered Package List is returned throught HiiHandle.\r
\r
  @param  NumberOfPackages         The number of HII packages to register.\r
  @param  GuidId                   Package List GUID ID.\r
  @param  DriverHandle             The pointer of driver handle\r
  @param  HiiHandle                The ID used to retrieve the Package List later.\r
  @param  ...                      The variable argument list describing all HII Package.\r
\r
  @return\r
  The allocated and initialized packages.\r
\r
**/\r
\r
EFI_STATUS\r
EFIAPI\r
HiiLibAddPackages (\r
  IN       UINTN               NumberOfPackages,\r
  IN CONST EFI_GUID            *GuidId,\r
  IN       EFI_HANDLE          DriverHandle, OPTIONAL\r
  OUT      EFI_HII_HANDLE      *HiiHandle, OPTIONAL\r
  ...\r
  )\r
{\r
  VA_LIST                   Args;\r
  EFI_HII_PACKAGES          *FrameworkHiiPacages;\r
  FRAMEWORK_EFI_HII_HANDLE  FrameworkHiiHandle;\r
  EFI_STATUS                Status;\r
\r
\r
  VA_START (Args, HiiHandle);\r
  FrameworkHiiPacages = InternalPreparePackages (NumberOfPackages, GuidId, Args);\r
\r
  Status      = mHii->NewPack (mHii, FrameworkHiiPacages, &FrameworkHiiHandle);\r
  if (HiiHandle != NULL) {\r
    if (EFI_ERROR (Status)) {\r
      *HiiHandle = NULL;\r
    } else {\r
      *HiiHandle = (EFI_HII_HANDLE) (UINTN) FrameworkHiiHandle;\r
    }\r
  }\r
\r
  FreePool (FrameworkHiiPacages);\r
  \r
  return Status;\r
}\r
\r
/**\r
  Removes a package list from the default HII database.\r
\r
  If HiiHandle is NULL, then ASSERT.\r
  If HiiHandle is not a valid EFI_HII_HANDLE in the default HII database, then ASSERT.\r
\r
  @param  HiiHandle                The handle that was previously registered to the data base that is requested for removal.\r
                                             List later.\r
\r
  @return  VOID\r
\r
**/\r
VOID\r
EFIAPI\r
HiiLibRemovePackages (\r
  IN      EFI_HII_HANDLE      HiiHandle\r
  )\r
{\r
  EFI_STATUS Status;\r
  \r
  Status = mHii->RemovePack (mHii, (FRAMEWORK_EFI_HII_HANDLE) (UINTN) HiiHandle);\r
  ASSERT_EFI_ERROR (Status);\r
}\r
\r
\r
/**\r
  This function adds the string into String Package of each language.\r
\r
  @param  PackageList            Handle of the package list where this string will\r
                                 be added.\r
  @param  StringId               On return, contains the new strings id, which is\r
                                 unique within PackageList.\r
  @param  String                 Points to the new null-terminated string.\r
\r
  @retval EFI_SUCCESS            The new string was added successfully.\r
  @retval EFI_NOT_FOUND          The specified PackageList could not be found in\r
                                 database.\r
  @retval EFI_OUT_OF_RESOURCES   Could not add the string due to lack of resources.\r
  @retval EFI_INVALID_PARAMETER  String is NULL or StringId is NULL is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiLibNewString (\r
  IN  EFI_HII_HANDLE                  PackageList,\r
  OUT EFI_STRING_ID                   *StringId,\r
  IN  CONST EFI_STRING                String\r
  )\r
{\r
  FRAMEWORK_EFI_HII_HANDLE  FrameworkHiiHandle;\r
  EFI_STATUS                Status;\r
\r
  FrameworkHiiHandle = (FRAMEWORK_EFI_HII_HANDLE) (UINTN) PackageList;\r
  Status = mHii->NewString (\r
            mHii,\r
            NULL,\r
            FrameworkHiiHandle,\r
            StringId,\r
            String\r
          );\r
\r
  return Status;\r
}\r
\r
/**\r
  Get the string given the StringId and String package Producer's Guid. The caller\r
  is responsible to free the *String.\r
\r
  If PackageList with the matching ProducerGuid is not found, then ASSERT.\r
  If PackageList with the matching ProducerGuid is found but no String is\r
  specified by StringId is found, then ASSERT.\r
\r
  @param  ProducerGuid           The Guid of String package list.\r
  @param  StringId               The String ID.\r
  @param  String                 The output string.\r
\r
  @retval EFI_SUCCESS            Operation is successful.\r
  @retval EFI_OUT_OF_RESOURCES   There is not enought memory in the system.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiLibGetStringFromToken (\r
  IN  EFI_GUID                        *ProducerGuid,\r
  IN  EFI_STRING_ID                   StringId,\r
  OUT EFI_STRING                      *String\r
  )\r
{\r
  return EFI_SUCCESS;  \r
}\r
\r
/**\r
  Get string specified by StringId form the HiiHandle. The caller\r
  is responsible to free the *String.\r
\r
  If String is NULL, then ASSERT.\r
  If HiiHandle could not be found in the default HII database, then ASSERT.\r
  If StringId is not found in PackageList, then ASSERT.\r
\r
  @param  PackageList            The HII handle of package list.\r
  @param  StringId               The String ID.\r
  @param  String                 The output string.\r
\r
  @retval EFI_NOT_FOUND          String is not found.\r
  @retval EFI_SUCCESS            Operation is successful.\r
  @retval EFI_OUT_OF_RESOURCES   There is not enought memory in the system.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiLibGetStringFromHandle (\r
  IN  EFI_HII_HANDLE                  PackageList,\r
  IN  EFI_STRING_ID                   StringId,\r
  OUT EFI_STRING                      *String\r
  )\r
{\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Create the driver handle for HII driver. The protocol and \r
  Package list of this driver wili be installed into this \r
  driver handle. \r
  The implement set DriverHandle to NULL simpliy to let \r
  handle manager create a default new handle.\r
  \r
  @param[out] DriverHandle the pointer of driver handle\r
  @return always successful.\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiLibCreateHiiDriverHandle (\r
  OUT EFI_HANDLE               *DriverHandle\r
  )\r
{\r
  //\r
  // Driver\r
  // This implementation does nothing as DriverHandle concept only\r
  // applies to UEFI HII specification.\r
  //\r
  \r
  *DriverHandle = NULL;\r
  \r
  return EFI_SUCCESS;\r
}\r
\r
Commit	Line	Data
0a869bf8	1	/** @file\r
	2	HII Library implementation that uses DXE protocols and services.\r
	3	\r
	4	Copyright (c) 2006, Intel Corporation<BR>\r
53f93f7e	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
0a869bf8	9	\r
53f93f7e	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
53f93f7e	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
0a869bf8	12	\r
0a869bf8	13	**/\r
0a869bf8	14	\r
ed7748fe	15	\r
564995cd	16	#include <FrameworkDxe.h>\r
ed7748fe	17	\r
dc7b4a5c	18	#include <Protocol/FrameworkHii.h>\r
dc7b4a5c	19	\r
8e5b17b2	20	#include <Library/FrameworkHiiLib.h>\r
53f93f7e	21	#include <Library/DebugLib.h>\r
53f93f7e	22	#include <Library/MemoryAllocationLib.h>\r
dc7b4a5c	23	#include <Library/UefiBootServicesTableLib.h>\r
bb557845	24	\r
dc7b4a5c	25	EFI_HII_PROTOCOL *mHii = NULL;\r
dc7b4a5c	26	\r
bb557845	27	/**\r
	28	Library constustor function for HiiLib library instance locate the\r
	29	gEfiHiiProtocolGuid firstly, the other interface in this library\r
	30	instance will dependent on the protocol of gEfiHiiProtocolGuid.\r
	31	So the depex of gEfiHiiProtocolGuid is required for this library \r
	32	instance.\r
	33	If protocol of gEfiHiiProtocolGuid is not installed, then ASSERT().\r
	34	\r
	35	@param ImageHandle The image handle of driver module who use this library \r
	36	instance.\r
	37	@param SystemTable Pointer to the EFI System Table.\r
	38	@retval EFI_SUCCESS library constuctor always success.\r
	39	**/\r
dc7b4a5c	40	EFI_STATUS\r
	41	EFIAPI\r
	42	FrameworkHiiLibConstructor (\r
	43	IN EFI_HANDLE ImageHandle,\r
	44	IN EFI_SYSTEM_TABLE *SystemTable\r
	45	)\r
	46	{\r
	47	EFI_STATUS Status;\r
	48	\r
	49	Status = gBS->LocateProtocol (\r
	50	&gEfiHiiProtocolGuid,\r
	51	NULL,\r
	52	(VOID **) &mHii\r
	53	);\r
	54	ASSERT_EFI_ERROR (Status);\r
	55	ASSERT (mHii != NULL);\r
	56	\r
	57	return EFI_SUCCESS;\r
	58	}\r
	59	\r
bb557845	60	/**\r
	61	This function is internal function that prepare and create\r
	62	HII packages with given number and package's guid.\r
	63	It is invoked by HiiAddPackages() and PreparePackages() interface.\r
	64	If the parameter of package's number is 0, then ASSERT().\r
	65	\r
	66	@param NumberOfPackages Given number of package item in a HII package list.\r
	67	@param Guid Given GUID of a HII package list.\r
	68	@param Marker Package's content list.\r
	69	\r
	70	@return pointer to new created HII package list.\r
	71	**/\r
dc7b4a5c	72	EFI_HII_PACKAGES *\r
	73	InternalPreparePackages (\r
	74	IN UINTN NumberOfPackages,\r
	75	IN CONST EFI_GUID *Guid OPTIONAL,\r
	76	VA_LIST Marker\r
	77	)\r
	78	{\r
	79	EFI_HII_PACKAGES *HiiPackages;\r
	80	VOID **Package;\r
	81	UINTN Index;\r
	82	\r
	83	ASSERT (NumberOfPackages > 0);\r
	84	\r
	85	HiiPackages = AllocateZeroPool (sizeof (EFI_HII_PACKAGES) + NumberOfPackages * sizeof (VOID *));\r
	86	ASSERT (HiiPackages != NULL);\r
	87	\r
	88	HiiPackages->GuidId = (EFI_GUID *) Guid;\r
	89	HiiPackages->NumberOfPackages = NumberOfPackages;\r
	90	Package = (VOID *) (((UINT8 ) HiiPackages) + sizeof (EFI_HII_PACKAGES));\r
	91	\r
	92	for (Index = 0; Index < NumberOfPackages; Index++) {\r
	93	Package = VA_ARG (Marker, VOID );\r
	94	Package++;\r
	95	}\r
	96	\r
	97	return HiiPackages;\r
	98	\r
	99	}\r
	100	\r
0a869bf8	101	/**\r
	102	This function allocates pool for an EFI_HII_PACKAGES structure\r
	103	with enough space for the variable argument list of package pointers.\r
53f93f7e	104	The allocated structure is initialized using NumberOfPackages, Guid,\r
0a869bf8	105	and the variable length argument list of package pointers.\r
	106	\r
	107	@param NumberOfPackages The number of HII packages to prepare.\r
	108	@param Guid Package GUID.\r
	109	\r
	110	@return The allocated and initialized packages.\r
	111	\r
	112	**/\r
	113	EFI_HII_PACKAGES *\r
	114	EFIAPI\r
	115	PreparePackages (\r
	116	IN UINTN NumberOfPackages,\r
	117	IN CONST EFI_GUID *Guid OPTIONAL,\r
	118	...\r
	119	)\r
	120	{\r
	121	VA_LIST Args;\r
0a869bf8	122	\r
dc7b4a5c	123	VA_START (Args, Guid);\r
0a869bf8	124	\r
dc7b4a5c	125	return InternalPreparePackages (NumberOfPackages, Guid, Args);\r
dc7b4a5c	126	}\r
0a869bf8	127	\r
0a869bf8	128	\r
dc7b4a5c	129	/**\r
	130	This function allocates pool for an EFI_HII_PACKAGE_LIST structure\r
	131	with additional space that is big enough to host all packages described by the variable \r
	132	argument list of package pointers. The allocated structure is initialized using NumberOfPackages, \r
	133	GuidId, and the variable length argument list of package pointers.\r
0a869bf8	134	\r
dc7b4a5c	135	Then, EFI_HII_PACKAGE_LIST will be register to the default System HII Database. The\r
	136	Handle to the newly registered Package List is returned throught HiiHandle.\r
	137	\r
7459094d	138	@param NumberOfPackages The number of HII packages to register.\r
	139	@param GuidId Package List GUID ID.\r
	140	@param DriverHandle The pointer of driver handle\r
dc7b4a5c	141	@param HiiHandle The ID used to retrieve the Package List later.\r
7459094d	142	@param ... The variable argument list describing all HII Package.\r
dc7b4a5c	143	\r
	144	@return\r
	145	The allocated and initialized packages.\r
	146	\r
	147	**/\r
	148	\r
	149	EFI_STATUS\r
	150	EFIAPI\r
568f78ab	151	HiiLibAddPackages (\r
dc7b4a5c	152	IN UINTN NumberOfPackages,\r
	153	IN CONST EFI_GUID *GuidId,\r
	154	IN EFI_HANDLE DriverHandle, OPTIONAL\r
	155	OUT EFI_HII_HANDLE *HiiHandle, OPTIONAL\r
	156	...\r
	157	)\r
	158	{\r
	159	VA_LIST Args;\r
	160	EFI_HII_PACKAGES *FrameworkHiiPacages;\r
	161	FRAMEWORK_EFI_HII_HANDLE FrameworkHiiHandle;\r
	162	EFI_STATUS Status;\r
	163	\r
	164	\r
	165	VA_START (Args, HiiHandle);\r
	166	FrameworkHiiPacages = InternalPreparePackages (NumberOfPackages, GuidId, Args);\r
	167	\r
	168	Status = mHii->NewPack (mHii, FrameworkHiiPacages, &FrameworkHiiHandle);\r
	169	if (HiiHandle != NULL) {\r
	170	if (EFI_ERROR (Status)) {\r
	171	*HiiHandle = NULL;\r
	172	} else {\r
	173	*HiiHandle = (EFI_HII_HANDLE) (UINTN) FrameworkHiiHandle;\r
	174	}\r
0a869bf8	175	}\r
0a869bf8	176	\r
dc7b4a5c	177	FreePool (FrameworkHiiPacages);\r
	178	\r
	179	return Status;\r
	180	}\r
0a869bf8	181	\r
bb557845	182	/**\r
	183	Removes a package list from the default HII database.\r
	184	\r
	185	If HiiHandle is NULL, then ASSERT.\r
	186	If HiiHandle is not a valid EFI_HII_HANDLE in the default HII database, then ASSERT.\r
	187	\r
	188	@param HiiHandle The handle that was previously registered to the data base that is requested for removal.\r
	189	List later.\r
	190	\r
	191	@return VOID\r
	192	\r
	193	**/\r
568f78ab	194	VOID\r
dc7b4a5c	195	EFIAPI\r
568f78ab	196	HiiLibRemovePackages (\r
dc7b4a5c	197	IN EFI_HII_HANDLE HiiHandle\r
	198	)\r
	199	{\r
568f78ab	200	EFI_STATUS Status;\r
	201	\r
	202	Status = mHii->RemovePack (mHii, (FRAMEWORK_EFI_HII_HANDLE) (UINTN) HiiHandle);\r
	203	ASSERT_EFI_ERROR (Status);\r
dc7b4a5c	204	}\r
	205	\r
	206	\r
	207	/**\r
	208	This function adds the string into String Package of each language.\r
	209	\r
	210	@param PackageList Handle of the package list where this string will\r
	211	be added.\r
	212	@param StringId On return, contains the new strings id, which is\r
	213	unique within PackageList.\r
	214	@param String Points to the new null-terminated string.\r
	215	\r
	216	@retval EFI_SUCCESS The new string was added successfully.\r
	217	@retval EFI_NOT_FOUND The specified PackageList could not be found in\r
	218	database.\r
	219	@retval EFI_OUT_OF_RESOURCES Could not add the string due to lack of resources.\r
	220	@retval EFI_INVALID_PARAMETER String is NULL or StringId is NULL is NULL.\r
	221	\r
	222	**/\r
	223	EFI_STATUS\r
	224	EFIAPI\r
568f78ab	225	HiiLibNewString (\r
dc7b4a5c	226	IN EFI_HII_HANDLE PackageList,\r
	227	OUT EFI_STRING_ID *StringId,\r
	228	IN CONST EFI_STRING String\r
	229	)\r
	230	{\r
	231	FRAMEWORK_EFI_HII_HANDLE FrameworkHiiHandle;\r
	232	EFI_STATUS Status;\r
	233	\r
	234	FrameworkHiiHandle = (FRAMEWORK_EFI_HII_HANDLE) (UINTN) PackageList;\r
	235	Status = mHii->NewString (\r
	236	mHii,\r
	237	NULL,\r
	238	FrameworkHiiHandle,\r
	239	StringId,\r
	240	String\r
	241	);\r
	242	\r
	243	return Status;\r
	244	}\r
	245	\r
bb557845	246	/**\r
	247	Get the string given the StringId and String package Producer's Guid. The caller\r
	248	is responsible to free the *String.\r
dc7b4a5c	249	\r
bb557845	250	If PackageList with the matching ProducerGuid is not found, then ASSERT.\r
	251	If PackageList with the matching ProducerGuid is found but no String is\r
	252	specified by StringId is found, then ASSERT.\r
dc7b4a5c	253	\r
bb557845	254	@param ProducerGuid The Guid of String package list.\r
	255	@param StringId The String ID.\r
	256	@param String The output string.\r
dc7b4a5c	257	\r
bb557845	258	@retval EFI_SUCCESS Operation is successful.\r
bb557845	259	@retval EFI_OUT_OF_RESOURCES There is not enought memory in the system.\r
dc7b4a5c	260	\r
bb557845	261	**/\r
dc7b4a5c	262	EFI_STATUS\r
dc7b4a5c	263	EFIAPI\r
568f78ab	264	HiiLibGetStringFromToken (\r
dc7b4a5c	265	IN EFI_GUID *ProducerGuid,\r
	266	IN EFI_STRING_ID StringId,\r
	267	OUT EFI_STRING *String\r
	268	)\r
	269	{\r
	270	return EFI_SUCCESS; \r
	271	}\r
	272	\r
bb557845	273	/**\r
	274	Get string specified by StringId form the HiiHandle. The caller\r
	275	is responsible to free the *String.\r
	276	\r
	277	If String is NULL, then ASSERT.\r
	278	If HiiHandle could not be found in the default HII database, then ASSERT.\r
	279	If StringId is not found in PackageList, then ASSERT.\r
	280	\r
7459094d	281	@param PackageList The HII handle of package list.\r
bb557845	282	@param StringId The String ID.\r
	283	@param String The output string.\r
	284	\r
	285	@retval EFI_NOT_FOUND String is not found.\r
	286	@retval EFI_SUCCESS Operation is successful.\r
	287	@retval EFI_OUT_OF_RESOURCES There is not enought memory in the system.\r
bb557845	288	\r
bb557845	289	**/\r
dc7b4a5c	290	EFI_STATUS\r
	291	EFIAPI\r
	292	HiiLibGetStringFromHandle (\r
	293	IN EFI_HII_HANDLE PackageList,\r
	294	IN EFI_STRING_ID StringId,\r
	295	OUT EFI_STRING *String\r
	296	)\r
	297	{\r
	298	return EFI_SUCCESS;\r
	299	}\r
	300	\r
bb557845	301	/**\r
	302	Create the driver handle for HII driver. The protocol and \r
	303	Package list of this driver wili be installed into this \r
	304	driver handle. \r
	305	The implement set DriverHandle to NULL simpliy to let \r
	306	handle manager create a default new handle.\r
	307	\r
	308	@param[out] DriverHandle the pointer of driver handle\r
	309	@return always successful.\r
	310	**/\r
dc7b4a5c	311	EFI_STATUS\r
	312	EFIAPI\r
	313	HiiLibCreateHiiDriverHandle (\r
	314	OUT EFI_HANDLE *DriverHandle\r
	315	)\r
	316	{\r
	317	//\r
	318	// Driver\r
	319	// This implementation does nothing as DriverHandle concept only\r
	320	// applies to UEFI HII specification.\r
	321	//\r
	322	\r
	323	*DriverHandle = NULL;\r
	324	\r
	325	return EFI_SUCCESS;\r
	326	}\r
	327	\r