1 // SPDX-License-Identifier: GPL-2.0+
3 * EFI Unicode collation protocol
5 * Copyright (c) 2018 Heinrich Schuchardt <xypron.glpk@gmx.de>
12 #include <efi_loader.h>
14 /* Characters that may not be used in FAT 8.3 file names */
15 static const char illegal[] = "+,<=>:;\"/\\|?*[]\x7f";
18 * EDK2 assumes codepage 1250 when creating FAT 8.3 file names.
19 * Linux defaults to codepage 437 for FAT 8.3 file names.
21 #if CONFIG_FAT_DEFAULT_CODEPAGE == 1250
22 /* Unicode code points for code page 1250 characters 0x80 - 0xff */
23 static const u16 codepage[] = CP1250;
25 /* Unicode code points for code page 437 characters 0x80 - 0xff */
26 static const u16 codepage[] = CP437;
29 /* GUID of the EFI_UNICODE_COLLATION_PROTOCOL2 */
30 const efi_guid_t efi_guid_unicode_collation_protocol2 =
31 EFI_UNICODE_COLLATION_PROTOCOL2_GUID;
34 * efi_stri_coll() - compare utf-16 strings case-insenitively
36 * @this: unicode collation protocol instance
40 * This function implements the StriColl() service of the
41 * EFI_UNICODE_COLLATION_PROTOCOL.
43 * See the Unified Extensible Firmware Interface (UEFI) specification for
46 * Return: 0: s1 == s2, > 0: s1 > s2, < 0: s1 < s2
48 static efi_intn_t EFIAPI efi_stri_coll(
49 struct efi_unicode_collation_protocol *this, u16 *s1, u16 *s2)
54 EFI_ENTRY("%p, %ls, %ls", this, s1, s2);
55 for (; *s1 | *s2; ++s1, ++s2) {
56 c1 = utf_to_upper(*s1);
57 c2 = utf_to_upper(*s2);
67 EFI_EXIT(EFI_SUCCESS);
72 * next_lower() - get next codepoint converted to lower case
74 * @string: pointer to u16 string, on return advanced by one codepoint
75 * Return: first codepoint of string converted to lower case
77 static s32 next_lower(const u16 **string)
79 return utf_to_lower(utf16_get(string));
83 * metai_match() - compare utf-16 string with a pattern string case-insenitively
85 * @string: string to compare
86 * @pattern: pattern string
88 * The pattern string may use these:
89 * - * matches >= 0 characters
90 * - ? matches 1 character
91 * - [<char1><char2>...<charN>] match any character in the set
92 * - [<char1>-<char2>] matches any character in the range
94 * This function is called my efi_metai_match().
96 * For '*' pattern searches this function calls itself recursively.
97 * Performance-wise this is suboptimal, especially for multiple '*' wildcards.
98 * But it results in simple code.
100 * Return: true if the string is matched.
102 static bool metai_match(const u16 *string, const u16 *pattern)
106 for (; *string && *pattern;) {
107 const u16 *string_old = string;
109 s = next_lower(&string);
110 p = next_lower(&pattern);
114 /* Match 0 or more characters */
115 for (;; s = next_lower(&string)) {
116 if (metai_match(string_old, pattern))
123 /* Match any one character */
126 /* Match any character in the set */
127 p = next_lower(&pattern);
132 p = next_lower(&pattern);
135 p = next_lower(&pattern);
136 if (s < first || s > p)
138 p = next_lower(&pattern);
147 for (; p && p != ']';
148 p = next_lower(&pattern)) {
152 if (!hit || p != ']')
157 /* Match one character */
162 if (!*pattern && !*string)
168 * efi_metai_match() - compare utf-16 string with a pattern string
171 * @this: unicode collation protocol instance
172 * @s: string to compare
175 * The pattern string may use these:
176 * - * matches >= 0 characters
177 * - ? matches 1 character
178 * - [<char1><char2>...<charN>] match any character in the set
179 * - [<char1>-<char2>] matches any character in the range
181 * This function implements the MetaMatch() service of the
182 * EFI_UNICODE_COLLATION_PROTOCOL.
184 * Return: true if the string is matched.
186 static bool EFIAPI efi_metai_match(struct efi_unicode_collation_protocol *this,
187 const u16 *string, const u16 *pattern)
191 EFI_ENTRY("%p, %ls, %ls", this, string, pattern);
192 ret = metai_match(string, pattern);
193 EFI_EXIT(EFI_SUCCESS);
198 * efi_str_lwr() - convert to lower case
200 * @this: unicode collation protocol instance
201 * @string: string to convert
204 * The conversion is done in place. As long as upper and lower letters use the
205 * same number of words this does not pose a problem.
207 * This function implements the StrLwr() service of the
208 * EFI_UNICODE_COLLATION_PROTOCOL.
210 static void EFIAPI efi_str_lwr(struct efi_unicode_collation_protocol *this,
213 EFI_ENTRY("%p, %ls", this, string);
214 for (; *string; ++string)
215 *string = utf_to_lower(*string);
216 EFI_EXIT(EFI_SUCCESS);
220 * efi_str_upr() - convert to upper case
222 * @this: unicode collation protocol instance
223 * @string: string to convert
226 * The conversion is done in place. As long as upper and lower letters use the
227 * same number of words this does not pose a problem.
229 * This function implements the StrUpr() service of the
230 * EFI_UNICODE_COLLATION_PROTOCOL.
232 static void EFIAPI efi_str_upr(struct efi_unicode_collation_protocol *this,
235 EFI_ENTRY("%p, %ls", this, string);
236 for (; *string; ++string)
237 *string = utf_to_upper(*string);
238 EFI_EXIT(EFI_SUCCESS);
242 * efi_fat_to_str() - convert an 8.3 file name from an OEM codepage to Unicode
244 * @this: unicode collation protocol instance
245 * @fat_size: size of the string to convert
246 * @fat: string to convert
247 * @string: converted string
249 * This function implements the FatToStr() service of the
250 * EFI_UNICODE_COLLATION_PROTOCOL.
252 static void EFIAPI efi_fat_to_str(struct efi_unicode_collation_protocol *this,
253 efi_uintn_t fat_size, char *fat, u16 *string)
258 EFI_ENTRY("%p, %zu, %s, %p", this, fat_size, fat, string);
259 for (i = 0; i < fat_size; ++i) {
260 c = (unsigned char)fat[i];
262 c = codepage[i - 0x80];
268 EFI_EXIT(EFI_SUCCESS);
272 * efi_fat_to_str() - convert a utf-16 string to legal characters for a FAT
273 * file name in an OEM code page
275 * @this: unicode collation protocol instance
276 * @string: Unicode string to convert
277 * @fat_size: size of the target buffer
278 * @fat: converted string
280 * This function implements the StrToFat() service of the
281 * EFI_UNICODE_COLLATION_PROTOCOL.
283 * Return: true if an illegal character was substituted by '_'.
285 static bool EFIAPI efi_str_to_fat(struct efi_unicode_collation_protocol *this,
286 const u16 *string, efi_uintn_t fat_size,
293 EFI_ENTRY("%p, %ls, %zu, %p", this, string, fat_size, fat);
294 for (i = 0; i < fat_size;) {
295 c = utf16_get(&string);
297 /* Ignore period and space */
308 /* Look for codepage translation */
309 for (j = 0; j < 0x80; ++j) {
310 if (c == codepage[j]) {
319 } else if (c && (c < 0x20 || strchr(illegal, c))) {
329 EFI_EXIT(EFI_SUCCESS);
333 const struct efi_unicode_collation_protocol efi_unicode_collation_protocol2 = {
334 .stri_coll = efi_stri_coll,
335 .metai_match = efi_metai_match,
336 .str_lwr = efi_str_lwr,
337 .str_upr = efi_str_upr,
338 .fat_to_str = efi_fat_to_str,
339 .str_to_fat = efi_str_to_fat,
340 .supported_languages = "en",
344 * In EFI 1.10 a version of the Unicode collation protocol using ISO 639-2
345 * language codes existed. This protocol is not part of the UEFI specification
346 * any longer. Unfortunately it is required to run the UEFI Self Certification
347 * Test (SCT) II, version 2.6, 2017. So we implement it here for the sole
348 * purpose of running the SCT. It can be removed when a compliant SCT is
351 #if CONFIG_IS_ENABLED(EFI_UNICODE_COLLATION_PROTOCOL)
353 /* GUID of the EFI_UNICODE_COLLATION_PROTOCOL */
354 const efi_guid_t efi_guid_unicode_collation_protocol =
355 EFI_UNICODE_COLLATION_PROTOCOL_GUID;
357 const struct efi_unicode_collation_protocol efi_unicode_collation_protocol = {
358 .stri_coll = efi_stri_coll,
359 .metai_match = efi_metai_match,
360 .str_lwr = efi_str_lwr,
361 .str_upr = efi_str_upr,
362 .fat_to_str = efi_fat_to_str,
363 .str_to_fat = efi_str_to_fat,
364 /* ISO 639-2 language code */
365 .supported_languages = "eng",