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