2 Module produce UC2 on top of UC.
4 UEFI 2.1 specification supersedes Inte's EFI Specification 1.10.
5 EFI_UNICODE_COLLATION_PROTOCOL defined in Inte's EFI Specification 1.10 is replaced by
6 EFI_UNICODE_COLLATION_PROTOCOL in UEFI 2.1.
7 This module produces UC2 on top of UC. This module is used on platform when both of
8 these two conditions are true:
9 1) EFI 1.10 module producing UC present
10 2) And the rest of modules on the platform consume UC2
12 Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
13 This program and the accompanying materials
14 are licensed and made available under the terms and conditions of the BSD License
15 which accompanies this distribution. The full text of the license may be found at
16 http://opensource.org/licenses/bsd-license.php
18 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
19 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
25 #include <Protocol/UnicodeCollation.h>
26 #include <Library/BaseLib.h>
27 #include <Library/DebugLib.h>
28 #include <Library/UefiBootServicesTableLib.h>
29 #include <Library/UefiDriverEntryPoint.h>
30 #include <Library/UefiLib.h>
31 #include <Library/MemoryAllocationLib.h>
32 #include <Library/HiiLib.h>
33 #include <Library/BaseMemoryLib.h>
34 #include <Library/LanguageLib.h>
37 Performs a case-insensitive comparison of two Null-terminated Unicode
40 @param This Protocol instance pointer.
41 @param Str1 A pointer to a Null-terminated Unicode string.
42 @param Str2 A pointer to a Null-terminated Unicode string.
44 @retval 0 Str1 is equivalent to Str2
45 @retval > 0 Str1 is lexically greater than Str2
46 @retval < 0 Str1 is lexically less than Str2
52 IN EFI_UNICODE_COLLATION_PROTOCOL
*This
,
58 Converts all the Unicode characters in a Null-terminated Unicode string to
59 lower case Unicode characters.
61 @param This Protocol instance pointer.
62 @param Str A pointer to a Null-terminated Unicode string.
68 IN EFI_UNICODE_COLLATION_PROTOCOL
*This
,
73 Converts all the Unicode characters in a Null-terminated Unicode string to upper
74 case Unicode characters.
76 @param This Protocol instance pointer.
77 @param Str A pointer to a Null-terminated Unicode string.
83 IN EFI_UNICODE_COLLATION_PROTOCOL
*This
,
88 Performs a case-insensitive comparison of a Null-terminated Unicode
89 pattern string and a Null-terminated Unicode string.
91 @param This Protocol instance pointer.
92 @param String A pointer to a Null-terminated Unicode string.
93 @param Pattern A pointer to a Null-terminated Unicode pattern string.
95 @retval TRUE Pattern was found in String.
96 @retval FALSE Pattern was not found in String.
102 IN EFI_UNICODE_COLLATION_PROTOCOL
*This
,
108 Converts an 8.3 FAT file name in an OEM character set to a Null-terminated
111 @param This Protocol instance pointer.
112 @param FatSize The size of the string Fat in bytes.
113 @param Fat A pointer to a Null-terminated string that contains an 8.3 file
114 name using an OEM character set.
115 @param String A pointer to a Null-terminated Unicode string. The string must
116 be preallocated to hold FatSize Unicode characters.
122 IN EFI_UNICODE_COLLATION_PROTOCOL
*This
,
129 Converts a Null-terminated Unicode string to legal characters in a FAT
130 filename using an OEM character set.
132 @param This Protocol instance pointer.
133 @param String A pointer to a Null-terminated Unicode string. The string must
134 be preallocated to hold FatSize Unicode characters.
135 @param FatSize The size of the string Fat in bytes.
136 @param Fat A pointer to a Null-terminated string that contains an 8.3 file
137 name using an OEM character set.
139 @retval TRUE Fat is a Long File Name
140 @retval FALSE Fat is an 8.3 file name
146 IN EFI_UNICODE_COLLATION_PROTOCOL
*This
,
152 #define UC2_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('_', 'U', 'C', '2')
156 EFI_UNICODE_COLLATION_PROTOCOL Uc2
;
157 EFI_UNICODE_COLLATION_PROTOCOL
*Uc
;
160 #define UC2_PRIVATE_DATA_FROM_THIS(a) CR (a, UC2_PRIVATE_DATA, Uc2, UC2_PRIVATE_DATA_SIGNATURE)
163 // Firmware Volume Protocol template
165 EFI_EVENT mUc2Registration
;
167 UC2_PRIVATE_DATA gUC2PrivateDataTemplate
= {
168 UC2_PRIVATE_DATA_SIGNATURE
,
185 This notification function is invoked when an instance of the
186 EFI_UNICODE_COLLATION_PROTOCOL is produced. It installs another instance of the
187 EFI_UNICODE_COLLATION_PROTOCOL2 on the same handle.
189 @param Event The event that occured
190 @param Context Context of event. Not used in this nofication function.
195 UcNotificationEvent (
203 UC2_PRIVATE_DATA
*Private
;
204 EFI_UNICODE_COLLATION_PROTOCOL
*Uc2
;
207 BufferSize
= sizeof (Handle
);
208 Status
= gBS
->LocateHandle (
210 &gEfiUnicodeCollationProtocolGuid
,
215 if (EFI_ERROR (Status
)) {
217 // Exit Path of While Loop....
223 // Skip this handle if the Firmware Volume Protocol is already installed
225 Status
= gBS
->HandleProtocol (
227 &gEfiUnicodeCollation2ProtocolGuid
,
230 if (!EFI_ERROR (Status
)) {
235 // Allocate private data structure
237 Private
= AllocateCopyPool (sizeof (UC2_PRIVATE_DATA
), &gUC2PrivateDataTemplate
);
238 if (Private
== NULL
) {
243 // Retrieve the UC Protocol
245 Status
= gBS
->HandleProtocol (
247 &gEfiUnicodeCollationProtocolGuid
,
248 (VOID
**)&Private
->Uc
250 ASSERT_EFI_ERROR (Status
);
253 // Fill in rest of private data structure
255 Private
->Uc2
.SupportedLanguages
= ConvertLanguagesIso639ToRfc4646 (Private
->Uc
->SupportedLanguages
);
256 if (Private
->Uc2
.SupportedLanguages
!= NULL
) {
259 // Install UC2 Protocol onto same handle
261 Status
= gBS
->InstallMultipleProtocolInterfaces (
263 &gEfiUnicodeCollation2ProtocolGuid
,
267 ASSERT_EFI_ERROR (Status
);
274 The user Entry Point for DXE driver. The user code starts with this function
275 as the real entry point for the image goes into a library that calls this
278 @param[in] ImageHandle The firmware allocated handle for the EFI image.
279 @param[in] SystemTable A pointer to the EFI System Table.
281 @retval EFI_SUCCESS The entry point is executed successfully.
282 @retval other Some error occurs when executing this entry point.
288 IN EFI_HANDLE ImageHandle
,
289 IN EFI_SYSTEM_TABLE
*SystemTable
292 EfiCreateProtocolNotifyEvent (
293 &gEfiUnicodeCollationProtocolGuid
,
304 Performs a case-insensitive comparison of two Null-terminated Unicode
307 @param This Protocol instance pointer.
308 @param Str1 A pointer to a Null-terminated Unicode string.
309 @param Str2 A pointer to a Null-terminated Unicode string.
311 @retval 0 Str1 is equivalent to Str2
312 @retval > 0 Str1 is lexically greater than Str2
313 @retval < 0 Str1 is lexically less than Str2
319 IN EFI_UNICODE_COLLATION_PROTOCOL
*This
,
324 UC2_PRIVATE_DATA
*Private
;
326 Private
= UC2_PRIVATE_DATA_FROM_THIS (This
);
328 return Private
->Uc
->StriColl (Private
->Uc
, Str1
, Str2
);
333 Converts all the Unicode characters in a Null-terminated Unicode string to
334 lower case Unicode characters.
336 @param This Protocol instance pointer.
337 @param Str A pointer to a Null-terminated Unicode string.
343 IN EFI_UNICODE_COLLATION_PROTOCOL
*This
,
347 UC2_PRIVATE_DATA
*Private
;
349 Private
= UC2_PRIVATE_DATA_FROM_THIS (This
);
351 Private
->Uc
->StrLwr (Private
->Uc
, Str
);
356 Converts all the Unicode characters in a Null-terminated Unicode string to upper
357 case Unicode characters.
359 @param This Protocol instance pointer.
360 @param Str A pointer to a Null-terminated Unicode string.
366 IN EFI_UNICODE_COLLATION_PROTOCOL
*This
,
370 UC2_PRIVATE_DATA
*Private
;
372 Private
= UC2_PRIVATE_DATA_FROM_THIS (This
);
374 Private
->Uc
->StrUpr (Private
->Uc
, Str
);
378 Performs a case-insensitive comparison of a Null-terminated Unicode
379 pattern string and a Null-terminated Unicode string.
381 @param This Protocol instance pointer.
382 @param String A pointer to a Null-terminated Unicode string.
383 @param Pattern A pointer to a Null-terminated Unicode pattern string.
385 @retval TRUE Pattern was found in String.
386 @retval FALSE Pattern was not found in String.
392 IN EFI_UNICODE_COLLATION_PROTOCOL
*This
,
397 UC2_PRIVATE_DATA
*Private
;
399 Private
= UC2_PRIVATE_DATA_FROM_THIS (This
);
401 return Private
->Uc
->MetaiMatch (Private
->Uc
, String
, Pattern
);
406 Converts an 8.3 FAT file name in an OEM character set to a Null-terminated
409 @param This Protocol instance pointer.
410 @param FatSize The size of the string Fat in bytes.
411 @param Fat A pointer to a Null-terminated string that contains an 8.3 file
412 name using an OEM character set.
413 @param String A pointer to a Null-terminated Unicode string. The string must
414 be preallocated to hold FatSize Unicode characters.
420 IN EFI_UNICODE_COLLATION_PROTOCOL
*This
,
426 UC2_PRIVATE_DATA
*Private
;
428 Private
= UC2_PRIVATE_DATA_FROM_THIS (This
);
430 Private
->Uc
->FatToStr (Private
->Uc
, FatSize
, Fat
, String
);
435 Converts a Null-terminated Unicode string to legal characters in a FAT
436 filename using an OEM character set.
438 @param This Protocol instance pointer.
439 @param String A pointer to a Null-terminated Unicode string. The string must
440 be preallocated to hold FatSize Unicode characters.
441 @param FatSize The size of the string Fat in bytes.
442 @param Fat A pointer to a Null-terminated string that contains an 8.3 file
443 name using an OEM character set.
445 @retval TRUE Fat is a Long File Name
446 @retval FALSE Fat is an 8.3 file name
452 IN EFI_UNICODE_COLLATION_PROTOCOL
*This
,
458 UC2_PRIVATE_DATA
*Private
;
460 Private
= UC2_PRIVATE_DATA_FROM_THIS (This
);
462 return Private
->Uc
->StrToFat (Private
->Uc
, String
, FatSize
, Fat
);