[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / UcOnUc2Thunk / UcOnUc2Thunk.c

/** @file\r
Module produce UC on top of UC2.\r
\r
UEFI 2.1 specification supersedes Inte's EFI Specification 1.10.\r
UNICODE_COLLATION_PROTOCOL defined in Inte's EFI Specification 1.10 is replaced by\r
EFI_UNICODE_COLLATION_PROTOCOL in UEFI 2.1.\r
This module produces UC on top of UC2. This module is used on platform when both of\r
these two conditions are true:\r
1) EFI 1.10 module consuming UC present\r
2) And the rest of modules on the platform produce UC2\r
\r
Copyright (c) 2006 - 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
Module Name:\r
\r
**/\r
\r
#include <PiDxe.h>\r
#include <Protocol/UnicodeCollation.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/LanguageLib.h>\r
\r
/**\r
  Performs a case-insensitive comparison of two Null-terminated Unicode \r
  strings.\r
\r
  @param  This Protocol instance pointer.\r
  @param  Str1 A pointer to a Null-terminated Unicode string.\r
  @param  Str2 A pointer to a Null-terminated Unicode string.\r
\r
  @retval 0   Str1 is equivalent to Str2\r
  @retval > 0 Str1 is lexically greater than Str2\r
  @retval < 0 Str1 is lexically less than Str2\r
\r
**/\r
INTN\r
EFIAPI\r
StriColl (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL   *This,\r
  IN CHAR16                           *Str1,\r
  IN CHAR16                           *Str2\r
  );\r
\r
/**\r
  Converts all the Unicode characters in a Null-terminated Unicode string to \r
  lower case Unicode characters.\r
\r
  @param  This   Protocol instance pointer.\r
  @param  Str    A pointer to a Null-terminated Unicode string.\r
\r
**/\r
VOID\r
EFIAPI\r
StrLwr (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL   *This,\r
  IN OUT CHAR16                       *Str\r
  );\r
\r
/**\r
  Converts all the Unicode characters in a Null-terminated Unicode string to upper\r
  case Unicode characters.\r
\r
  @param  This   Protocol instance pointer.\r
  @param  Str    A pointer to a Null-terminated Unicode string.\r
\r
**/\r
VOID\r
EFIAPI\r
StrUpr (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL   *This,\r
  IN OUT CHAR16                       *Str\r
  );\r
\r
/**\r
  Performs a case-insensitive comparison of a Null-terminated Unicode \r
  pattern string and a Null-terminated Unicode string.\r
\r
  @param  This    Protocol instance pointer.\r
  @param  String  A pointer to a Null-terminated Unicode string.\r
  @param  Pattern A pointer to a Null-terminated Unicode pattern string.\r
\r
  @retval TRUE    Pattern was found in String.\r
  @retval FALSE   Pattern was not found in String.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
MetaiMatch (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL   *This,\r
  IN CHAR16                           *String,\r
  IN CHAR16                           *Pattern\r
  );\r
\r
/**\r
  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated \r
  Unicode string.\r
\r
  @param  This    Protocol instance pointer.\r
  @param  FatSize The size of the string Fat in bytes.\r
  @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
                  name using an OEM character set.\r
  @param  String  A pointer to a Null-terminated Unicode string. The string must\r
                  be preallocated to hold FatSize Unicode characters.\r
\r
**/\r
VOID\r
EFIAPI\r
FatToStr (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL   *This,\r
  IN UINTN                            FatSize,\r
  IN CHAR8                            *Fat,\r
  OUT CHAR16                          *String\r
  );\r
\r
/**\r
  Converts a Null-terminated Unicode string to legal characters in a FAT \r
  filename using an OEM character set. \r
\r
  @param  This    Protocol instance pointer.\r
  @param  String  A pointer to a Null-terminated Unicode string. The string must\r
                  be preallocated to hold FatSize Unicode characters.\r
  @param  FatSize The size of the string Fat in bytes.\r
  @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
                  name using an OEM character set.\r
\r
  @retval TRUE    Fat is a Long File Name\r
  @retval FALSE   Fat is an 8.3 file name\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
StrToFat (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL   *This,\r
  IN CHAR16                           *String,\r
  IN UINTN                            FatSize,\r
  OUT CHAR8                           *Fat\r
  );\r
\r
#define UC_PRIVATE_DATA_SIGNATURE  SIGNATURE_32 ('_', 'U', 'C', '_')\r
\r
typedef struct {\r
  UINT32                          Signature;\r
  EFI_UNICODE_COLLATION_PROTOCOL  UC;\r
  EFI_UNICODE_COLLATION_PROTOCOL *UC2;\r
} UC_PRIVATE_DATA;\r
\r
#define UC_PRIVATE_DATA_FROM_THIS(a) CR (a, UC_PRIVATE_DATA, UC, UC_PRIVATE_DATA_SIGNATURE)\r
\r
//\r
// Firmware Volume Protocol template\r
//\r
EFI_EVENT  mUcRegistration;\r
\r
UC_PRIVATE_DATA gUCPrivateDataTemplate = {\r
  UC_PRIVATE_DATA_SIGNATURE,\r
  {\r
    StriColl,\r
    MetaiMatch,\r
    StrLwr,\r
    StrUpr,\r
    FatToStr,\r
    StrToFat,\r
    NULL\r
  },\r
  NULL\r
};\r
\r
//\r
// Module globals\r
//\r
\r
VOID\r
EFIAPI\r
Uc2NotificationEvent (\r
  IN  EFI_EVENT       Event,\r
  IN  VOID            *Context\r
  )\r
{\r
  EFI_STATUS                     Status;\r
  UINTN                          BufferSize;\r
  EFI_HANDLE                     Handle;\r
  UC_PRIVATE_DATA               *Private;\r
  EFI_UNICODE_COLLATION_PROTOCOL *Uc2;\r
\r
  while (TRUE) {\r
    BufferSize = sizeof (Handle);\r
    Status = gBS->LocateHandle (\r
                    ByRegisterNotify,\r
                    &gEfiUnicodeCollation2ProtocolGuid,\r
                    mUcRegistration,\r
                    &BufferSize,\r
                    &Handle\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      //\r
      // Exit Path of While Loop....\r
      //\r
      break;\r
    }\r
\r
    //\r
    // Skip this handle if the Firmware Volume Protocol is already installed\r
    //\r
    Status = gBS->HandleProtocol (\r
                    Handle,\r
                    &gEfiUnicodeCollationProtocolGuid,\r
                    (VOID **)&Uc2\r
                    );\r
    if (!EFI_ERROR (Status)) {\r
      continue;\r
    }\r
\r
    //\r
    // Allocate private data structure\r
    //\r
    Private = AllocateCopyPool (sizeof (UC_PRIVATE_DATA), &gUCPrivateDataTemplate);\r
    if (Private == NULL) {\r
      continue;\r
    }\r
\r
    //\r
    // Retrieve the UC Protocol\r
    //\r
    Status = gBS->HandleProtocol (\r
                    Handle,\r
                    &gEfiUnicodeCollation2ProtocolGuid,\r
                    (VOID **)&Private->UC2\r
                    );\r
    ASSERT_EFI_ERROR (Status);\r
\r
    //\r
    // Fill in rest of private data structure\r
    //\r
    Private->UC.SupportedLanguages = ConvertLanguagesRfc4646ToIso639 (Private->UC2->SupportedLanguages);\r
\r
    if (Private->UC.SupportedLanguages != NULL) {\r
\r
      //\r
      // Install Firmware Volume Protocol onto same handle\r
      //\r
      Status = gBS->InstallMultipleProtocolInterfaces (\r
                      &Handle,\r
                      &gEfiUnicodeCollationProtocolGuid,\r
                      &Private->UC,\r
                      NULL\r
                      );\r
      ASSERT_EFI_ERROR (Status);\r
    }\r
  }\r
}\r
\r
\r
/**\r
  The user Entry Point for DXE driver. The user code starts with this function\r
  as the real entry point for the image goes into a library that calls this \r
  function.\r
\r
  @param[in] ImageHandle    The firmware allocated handle for the EFI image.  \r
  @param[in] SystemTable    A pointer to the EFI System Table.\r
  \r
  @retval EFI_SUCCESS       The entry point is executed successfully.\r
  @retval other             Some error occurs when executing this entry point.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializeUC (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EfiCreateProtocolNotifyEvent (\r
    &gEfiUnicodeCollation2ProtocolGuid,\r
    TPL_CALLBACK,\r
    Uc2NotificationEvent,\r
    NULL,\r
    &mUcRegistration\r
    );\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Performs a case-insensitive comparison of two Null-terminated Unicode \r
  strings.\r
\r
  @param  This Protocol instance pointer.\r
  @param  Str1 A pointer to a Null-terminated Unicode string.\r
  @param  Str2 A pointer to a Null-terminated Unicode string.\r
\r
  @retval 0   Str1 is equivalent to Str2\r
  @retval > 0 Str1 is lexically greater than Str2\r
  @retval < 0 Str1 is lexically less than Str2\r
\r
**/\r
INTN\r
EFIAPI\r
StriColl (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL   *This,\r
  IN CHAR16                           *Str1,\r
  IN CHAR16                           *Str2\r
  )\r
{\r
  UC_PRIVATE_DATA *Private;\r
  \r
  Private = UC_PRIVATE_DATA_FROM_THIS (This);\r
  \r
  return Private->UC2->StriColl (Private->UC2, Str1, Str2);\r
}\r
\r
\r
/**\r
  Converts all the Unicode characters in a Null-terminated Unicode string to \r
  lower case Unicode characters.\r
\r
  @param  This   Protocol instance pointer.\r
  @param  Str    A pointer to a Null-terminated Unicode string.\r
\r
**/\r
VOID\r
EFIAPI\r
StrLwr (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL   *This,\r
  IN OUT CHAR16                       *Str\r
  )\r
{\r
  UC_PRIVATE_DATA *Private;\r
  \r
  Private = UC_PRIVATE_DATA_FROM_THIS (This);\r
  \r
  Private->UC2->StrLwr (Private->UC2, Str);\r
}\r
\r
\r
/**\r
  Converts all the Unicode characters in a Null-terminated Unicode string to upper\r
  case Unicode characters.\r
\r
  @param  This   Protocol instance pointer.\r
  @param  Str    A pointer to a Null-terminated Unicode string.\r
\r
**/\r
VOID\r
EFIAPI\r
StrUpr (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL   *This,\r
  IN OUT CHAR16                       *Str\r
  )\r
{\r
  UC_PRIVATE_DATA *Private;\r
  \r
  Private = UC_PRIVATE_DATA_FROM_THIS (This);\r
  \r
  Private->UC2->StrUpr (Private->UC2, Str);\r
}\r
\r
/**\r
  Performs a case-insensitive comparison of a Null-terminated Unicode \r
  pattern string and a Null-terminated Unicode string.\r
\r
  @param  This    Protocol instance pointer.\r
  @param  String  A pointer to a Null-terminated Unicode string.\r
  @param  Pattern A pointer to a Null-terminated Unicode pattern string.\r
\r
  @retval TRUE    Pattern was found in String.\r
  @retval FALSE   Pattern was not found in String.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
MetaiMatch (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL   *This,\r
  IN CHAR16                           *String,\r
  IN CHAR16                           *Pattern\r
  )\r
{\r
  UC_PRIVATE_DATA *Private;\r
  \r
  Private = UC_PRIVATE_DATA_FROM_THIS (This);\r
  \r
  return Private->UC2->MetaiMatch (Private->UC2, String, Pattern);\r
}\r
\r
\r
/**\r
  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated \r
  Unicode string.\r
\r
  @param  This    Protocol instance pointer.\r
  @param  FatSize The size of the string Fat in bytes.\r
  @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
                  name using an OEM character set.\r
  @param  String  A pointer to a Null-terminated Unicode string. The string must\r
                  be preallocated to hold FatSize Unicode characters.\r
\r
**/\r
VOID\r
EFIAPI\r
FatToStr (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL   *This,\r
  IN UINTN                            FatSize,\r
  IN CHAR8                            *Fat,\r
  OUT CHAR16                          *String\r
  )\r
{\r
  UC_PRIVATE_DATA *Private;\r
  \r
  Private = UC_PRIVATE_DATA_FROM_THIS (This);\r
  \r
  Private->UC2->FatToStr (Private->UC2, FatSize, Fat, String);\r
}\r
\r
\r
/**\r
  Converts a Null-terminated Unicode string to legal characters in a FAT \r
  filename using an OEM character set. \r
\r
  @param  This    Protocol instance pointer.\r
  @param  String  A pointer to a Null-terminated Unicode string. The string must\r
                  be preallocated to hold FatSize Unicode characters.\r
  @param  FatSize The size of the string Fat in bytes.\r
  @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
                  name using an OEM character set.\r
\r
  @retval TRUE    Fat is a Long File Name\r
  @retval FALSE   Fat is an 8.3 file name\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
StrToFat (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL   *This,\r
  IN CHAR16                           *String,\r
  IN UINTN                            FatSize,\r
  OUT CHAR8                           *Fat\r
  )\r
{\r
  UC_PRIVATE_DATA *Private;\r
  \r
  Private = UC_PRIVATE_DATA_FROM_THIS (This);\r
  \r
  return Private->UC2->StrToFat (Private->UC2, String, FatSize, Fat);\r
}\r
\r
Commit	Line	Data
a432c703	1	/** @file\r
	2	Module produce UC on top of UC2.\r
	3	\r
	4	UEFI 2.1 specification supersedes Inte's EFI Specification 1.10.\r
	5	UNICODE_COLLATION_PROTOCOL defined in Inte's EFI Specification 1.10 is replaced by\r
	6	EFI_UNICODE_COLLATION_PROTOCOL in UEFI 2.1.\r
	7	This module produces UC on top of UC2. This module is used on platform when both of\r
	8	these two conditions are true:\r
	9	1) EFI 1.10 module consuming UC present\r
	10	2) And the rest of modules on the platform produce UC2\r
	11	\r
	12	Copyright (c) 2006 - 2008 Intel Corporation. <BR>\r
	13	All rights reserved. This program and the accompanying materials\r
	14	are licensed and made available under the terms and conditions of the BSD License\r
	15	which accompanies this distribution. The full text of the license may be found at\r
	16	http://opensource.org/licenses/bsd-license.php\r
	17	\r
	18	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	19	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	20	Module Name:\r
	21	\r
	22	**/\r
	23	\r
	24	#include <PiDxe.h>\r
	25	#include <Protocol/UnicodeCollation.h>\r
	26	#include <Library/BaseLib.h>\r
	27	#include <Library/DebugLib.h>\r
	28	#include <Library/UefiBootServicesTableLib.h>\r
	29	#include <Library/UefiDriverEntryPoint.h>\r
	30	#include <Library/UefiLib.h>\r
	31	#include <Library/MemoryAllocationLib.h>\r
	32	#include <Library/HiiLib.h>\r
ad5a96ab	33	#include <Library/BaseMemoryLib.h>\r
7c9d25ae	34	#include <Library/LanguageLib.h>\r
a432c703	35	\r
	36	/**\r
	37	Performs a case-insensitive comparison of two Null-terminated Unicode \r
	38	strings.\r
	39	\r
	40	@param This Protocol instance pointer.\r
	41	@param Str1 A pointer to a Null-terminated Unicode string.\r
	42	@param Str2 A pointer to a Null-terminated Unicode string.\r
	43	\r
	44	@retval 0 Str1 is equivalent to Str2\r
	45	@retval > 0 Str1 is lexically greater than Str2\r
	46	@retval < 0 Str1 is lexically less than Str2\r
	47	\r
	48	**/\r
	49	INTN\r
	50	EFIAPI\r
	51	StriColl (\r
	52	IN EFI_UNICODE_COLLATION_PROTOCOL *This,\r
	53	IN CHAR16 *Str1,\r
	54	IN CHAR16 *Str2\r
e00e1d46	55	);\r
a432c703	56	\r
	57	/**\r
	58	Converts all the Unicode characters in a Null-terminated Unicode string to \r
	59	lower case Unicode characters.\r
	60	\r
	61	@param This Protocol instance pointer.\r
	62	@param Str A pointer to a Null-terminated Unicode string.\r
	63	\r
	64	**/\r
	65	VOID\r
	66	EFIAPI\r
	67	StrLwr (\r
	68	IN EFI_UNICODE_COLLATION_PROTOCOL *This,\r
	69	IN OUT CHAR16 *Str\r
e00e1d46	70	);\r
a432c703	71	\r
	72	/**\r
	73	Converts all the Unicode characters in a Null-terminated Unicode string to upper\r
	74	case Unicode characters.\r
	75	\r
	76	@param This Protocol instance pointer.\r
	77	@param Str A pointer to a Null-terminated Unicode string.\r
	78	\r
	79	**/\r
	80	VOID\r
	81	EFIAPI\r
	82	StrUpr (\r
	83	IN EFI_UNICODE_COLLATION_PROTOCOL *This,\r
	84	IN OUT CHAR16 *Str\r
e00e1d46	85	);\r
a432c703	86	\r
	87	/**\r
	88	Performs a case-insensitive comparison of a Null-terminated Unicode \r
	89	pattern string and a Null-terminated Unicode string.\r
	90	\r
	91	@param This Protocol instance pointer.\r
	92	@param String A pointer to a Null-terminated Unicode string.\r
	93	@param Pattern A pointer to a Null-terminated Unicode pattern string.\r
	94	\r
	95	@retval TRUE Pattern was found in String.\r
	96	@retval FALSE Pattern was not found in String.\r
	97	\r
	98	**/\r
	99	BOOLEAN\r
	100	EFIAPI\r
	101	MetaiMatch (\r
	102	IN EFI_UNICODE_COLLATION_PROTOCOL *This,\r
	103	IN CHAR16 *String,\r
	104	IN CHAR16 *Pattern\r
e00e1d46	105	);\r
a432c703	106	\r
	107	/**\r
	108	Converts an 8.3 FAT file name in an OEM character set to a Null-terminated \r
	109	Unicode string.\r
	110	\r
	111	@param This Protocol instance pointer.\r
	112	@param FatSize The size of the string Fat in bytes.\r
	113	@param Fat A pointer to a Null-terminated string that contains an 8.3 file\r
	114	name using an OEM character set.\r
	115	@param String A pointer to a Null-terminated Unicode string. The string must\r
	116	be preallocated to hold FatSize Unicode characters.\r
	117	\r
	118	**/\r
	119	VOID\r
	120	EFIAPI\r
	121	FatToStr (\r
	122	IN EFI_UNICODE_COLLATION_PROTOCOL *This,\r
	123	IN UINTN FatSize,\r
	124	IN CHAR8 *Fat,\r
	125	OUT CHAR16 *String\r
e00e1d46	126	);\r
a432c703	127	\r
	128	/**\r
	129	Converts a Null-terminated Unicode string to legal characters in a FAT \r
	130	filename using an OEM character set. \r
	131	\r
	132	@param This Protocol instance pointer.\r
	133	@param String A pointer to a Null-terminated Unicode string. The string must\r
	134	be preallocated to hold FatSize Unicode characters.\r
	135	@param FatSize The size of the string Fat in bytes.\r
	136	@param Fat A pointer to a Null-terminated string that contains an 8.3 file\r
	137	name using an OEM character set.\r
	138	\r
	139	@retval TRUE Fat is a Long File Name\r
	140	@retval FALSE Fat is an 8.3 file name\r
	141	\r
	142	**/\r
	143	BOOLEAN\r
	144	EFIAPI\r
	145	StrToFat (\r
	146	IN EFI_UNICODE_COLLATION_PROTOCOL *This,\r
	147	IN CHAR16 *String,\r
	148	IN UINTN FatSize,\r
	149	OUT CHAR8 *Fat\r
e00e1d46	150	);\r
a432c703	151	\r
a3a83173	152	#define UC_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('_', 'U', 'C', '_')\r
a432c703	153	\r
	154	typedef struct {\r
	155	UINT32 Signature;\r
	156	EFI_UNICODE_COLLATION_PROTOCOL UC;\r
	157	EFI_UNICODE_COLLATION_PROTOCOL *UC2;\r
	158	} UC_PRIVATE_DATA;\r
	159	\r
	160	#define UC_PRIVATE_DATA_FROM_THIS(a) CR (a, UC_PRIVATE_DATA, UC, UC_PRIVATE_DATA_SIGNATURE)\r
	161	\r
	162	//\r
	163	// Firmware Volume Protocol template\r
	164	//\r
	165	EFI_EVENT mUcRegistration;\r
	166	\r
	167	UC_PRIVATE_DATA gUCPrivateDataTemplate = {\r
	168	UC_PRIVATE_DATA_SIGNATURE,\r
	169	{\r
	170	StriColl,\r
	171	MetaiMatch,\r
	172	StrLwr,\r
	173	StrUpr,\r
	174	FatToStr,\r
	175	StrToFat,\r
	176	NULL\r
	177	},\r
	178	NULL\r
	179	};\r
	180	\r
	181	//\r
	182	// Module globals\r
	183	//\r
	184	\r
	185	VOID\r
	186	EFIAPI\r
	187	Uc2NotificationEvent (\r
	188	IN EFI_EVENT Event,\r
	189	IN VOID *Context\r
	190	)\r
	191	{\r
	192	EFI_STATUS Status;\r
	193	UINTN BufferSize;\r
	194	EFI_HANDLE Handle;\r
	195	UC_PRIVATE_DATA *Private;\r
	196	EFI_UNICODE_COLLATION_PROTOCOL *Uc2;\r
	197	\r
	198	while (TRUE) {\r
	199	BufferSize = sizeof (Handle);\r
	200	Status = gBS->LocateHandle (\r
	201	ByRegisterNotify,\r
	202	&gEfiUnicodeCollation2ProtocolGuid,\r
	203	mUcRegistration,\r
	204	&BufferSize,\r
	205	&Handle\r
	206	);\r
	207	if (EFI_ERROR (Status)) {\r
	208	//\r
	209	// Exit Path of While Loop....\r
	210	//\r
	211	break;\r
	212	}\r
	213	\r
	214	//\r
	215	// Skip this handle if the Firmware Volume Protocol is already installed\r
	216	//\r
217	Status = gBS->HandleProtocol (\r
218	Handle,\r
219	&gEfiUnicodeCollationProtocolGuid,\r
220	(VOID **)&Uc2\r
221	);\r
222	if (!EFI_ERROR (Status)) {\r
223	continue;\r
224	}\r
225	\r
226	//\r
227	// Allocate private data structure\r
228	//\r
229	Private = AllocateCopyPool (sizeof (UC_PRIVATE_DATA), &gUCPrivateDataTemplate);\r
230	if (Private == NULL) {\r
231	continue;\r
232	}\r
233	\r
234	//\r
235	// Retrieve the UC Protocol\r
236	//\r
237	Status = gBS->HandleProtocol (\r
238	Handle,\r
239	&gEfiUnicodeCollation2ProtocolGuid,\r
240	(VOID **)&Private->UC2\r
241	);\r
242	ASSERT_EFI_ERROR (Status);\r
243	\r
244	//\r
245	// Fill in rest of private data structure\r
246	//\r
7c9d25ae	247	Private->UC.SupportedLanguages = ConvertLanguagesRfc4646ToIso639 (Private->UC2->SupportedLanguages);\r
a432c703	248	\r
7c9d25ae	249	if (Private->UC.SupportedLanguages != NULL) {\r
a432c703	250	\r
	251	//\r
	252	// Install Firmware Volume Protocol onto same handle\r
	253	//\r
	254	Status = gBS->InstallMultipleProtocolInterfaces (\r
	255	&Handle,\r
	256	&gEfiUnicodeCollationProtocolGuid,\r
	257	&Private->UC,\r
	258	NULL\r
	259	);\r
	260	ASSERT_EFI_ERROR (Status);\r
	261	}\r
	262	}\r
	263	}\r
	264	\r
	265	\r
	266	/**\r
	267	The user Entry Point for DXE driver. The user code starts with this function\r
	268	as the real entry point for the image goes into a library that calls this \r
	269	function.\r
	270	\r
	271	@param[in] ImageHandle The firmware allocated handle for the EFI image. \r
	272	@param[in] SystemTable A pointer to the EFI System Table.\r
	273	\r
	274	@retval EFI_SUCCESS The entry point is executed successfully.\r
	275	@retval other Some error occurs when executing this entry point.\r
	276	\r
	277	**/\r
	278	EFI_STATUS\r
	279	EFIAPI\r
	280	InitializeUC (\r
	281	IN EFI_HANDLE ImageHandle,\r
	282	IN EFI_SYSTEM_TABLE *SystemTable\r
	283	)\r
	284	{\r
	285	EfiCreateProtocolNotifyEvent (\r
185be2e0	286	&gEfiUnicodeCollation2ProtocolGuid,\r
a432c703	287	TPL_CALLBACK,\r
	288	Uc2NotificationEvent,\r
	289	NULL,\r
	290	&mUcRegistration\r
	291	);\r
	292	return EFI_SUCCESS;\r
	293	}\r
	294	\r
	295	\r
	296	/**\r
	297	Performs a case-insensitive comparison of two Null-terminated Unicode \r
	298	strings.\r
	299	\r
	300	@param This Protocol instance pointer.\r
	301	@param Str1 A pointer to a Null-terminated Unicode string.\r
	302	@param Str2 A pointer to a Null-terminated Unicode string.\r
	303	\r
	304	@retval 0 Str1 is equivalent to Str2\r
	305	@retval > 0 Str1 is lexically greater than Str2\r
	306	@retval < 0 Str1 is lexically less than Str2\r
	307	\r
	308	**/\r
	309	INTN\r
	310	EFIAPI\r
	311	StriColl (\r
	312	IN EFI_UNICODE_COLLATION_PROTOCOL *This,\r
	313	IN CHAR16 *Str1,\r
	314	IN CHAR16 *Str2\r
	315	)\r
	316	{\r
	317	UC_PRIVATE_DATA *Private;\r
	318	\r
	319	Private = UC_PRIVATE_DATA_FROM_THIS (This);\r
	320	\r
	321	return Private->UC2->StriColl (Private->UC2, Str1, Str2);\r
	322	}\r
	323	\r
	324	\r
	325	/**\r
	326	Converts all the Unicode characters in a Null-terminated Unicode string to \r
	327	lower case Unicode characters.\r
	328	\r
	329	@param This Protocol instance pointer.\r
	330	@param Str A pointer to a Null-terminated Unicode string.\r
	331	\r
	332	**/\r
	333	VOID\r
	334	EFIAPI\r
	335	StrLwr (\r
	336	IN EFI_UNICODE_COLLATION_PROTOCOL *This,\r
	337	IN OUT CHAR16 *Str\r
	338	)\r
	339	{\r
	340	UC_PRIVATE_DATA *Private;\r
	341	\r
	342	Private = UC_PRIVATE_DATA_FROM_THIS (This);\r
	343	\r
	344	Private->UC2->StrLwr (Private->UC2, Str);\r
	345	}\r
	346	\r
	347	\r
	348	/**\r
	349	Converts all the Unicode characters in a Null-terminated Unicode string to upper\r
	350	case Unicode characters.\r
351	\r
352	@param This Protocol instance pointer.\r
353	@param Str A pointer to a Null-terminated Unicode string.\r
354	\r
355	**/\r
356	VOID\r
357	EFIAPI\r
358	StrUpr (\r
359	IN EFI_UNICODE_COLLATION_PROTOCOL *This,\r
360	IN OUT CHAR16 *Str\r
361	)\r
362	{\r
363	UC_PRIVATE_DATA *Private;\r
364	\r
365	Private = UC_PRIVATE_DATA_FROM_THIS (This);\r
366	\r
367	Private->UC2->StrUpr (Private->UC2, Str);\r
368	}\r
369	\r
370	/**\r
371	Performs a case-insensitive comparison of a Null-terminated Unicode \r
372	pattern string and a Null-terminated Unicode string.\r
373	\r
374	@param This Protocol instance pointer.\r
375	@param String A pointer to a Null-terminated Unicode string.\r
376	@param Pattern A pointer to a Null-terminated Unicode pattern string.\r
377	\r
378	@retval TRUE Pattern was found in String.\r
379	@retval FALSE Pattern was not found in String.\r
380	\r
381	**/\r
382	BOOLEAN\r
383	EFIAPI\r
384	MetaiMatch (\r
385	IN EFI_UNICODE_COLLATION_PROTOCOL *This,\r
386	IN CHAR16 *String,\r
387	IN CHAR16 *Pattern\r
388	)\r
389	{\r
390	UC_PRIVATE_DATA *Private;\r
391	\r
392	Private = UC_PRIVATE_DATA_FROM_THIS (This);\r
393	\r
394	return Private->UC2->MetaiMatch (Private->UC2, String, Pattern);\r
395	}\r
396	\r
397	\r
398	/**\r
399	Converts an 8.3 FAT file name in an OEM character set to a Null-terminated \r
400	Unicode string.\r
401	\r
402	@param This Protocol instance pointer.\r
403	@param FatSize The size of the string Fat in bytes.\r
404	@param Fat A pointer to a Null-terminated string that contains an 8.3 file\r
405	name using an OEM character set.\r
406	@param String A pointer to a Null-terminated Unicode string. The string must\r
407	be preallocated to hold FatSize Unicode characters.\r
408	\r
409	**/\r
410	VOID\r
411	EFIAPI\r
412	FatToStr (\r
413	IN EFI_UNICODE_COLLATION_PROTOCOL *This,\r
414	IN UINTN FatSize,\r
415	IN CHAR8 *Fat,\r
416	OUT CHAR16 *String\r
417	)\r
418	{\r
419	UC_PRIVATE_DATA *Private;\r
420	\r
421	Private = UC_PRIVATE_DATA_FROM_THIS (This);\r
422	\r
423	Private->UC2->FatToStr (Private->UC2, FatSize, Fat, String);\r
424	}\r
425	\r
426	\r
427	/**\r
428	Converts a Null-terminated Unicode string to legal characters in a FAT \r
429	filename using an OEM character set. \r
430	\r
431	@param This Protocol instance pointer.\r
432	@param String A pointer to a Null-terminated Unicode string. The string must\r
433	be preallocated to hold FatSize Unicode characters.\r
434	@param FatSize The size of the string Fat in bytes.\r
435	@param Fat A pointer to a Null-terminated string that contains an 8.3 file\r
436	name using an OEM character set.\r
437	\r
438	@retval TRUE Fat is a Long File Name\r
439	@retval FALSE Fat is an 8.3 file name\r
440	\r
441	**/\r
442	BOOLEAN\r
443	EFIAPI\r
444	StrToFat (\r
445	IN EFI_UNICODE_COLLATION_PROTOCOL *This,\r
446	IN CHAR16 *String,\r
447	IN UINTN FatSize,\r
448	OUT CHAR8 *Fat\r
449	)\r
450	{\r
451	UC_PRIVATE_DATA *Private;\r
452	\r
453	Private = UC_PRIVATE_DATA_FROM_THIS (This);\r
454	\r
455	return Private->UC2->StrToFat (Private->UC2, String, FatSize, Fat);\r
456	}\r
457	\r