UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / MdeModulePkg / Universal / Disk / UnicodeCollation / EnglishDxe / UnicodeCollationEng.c

/** @file\r
  Driver to implement English version of Unicode Collation Protocol.\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "UnicodeCollationEng.h"\r
\r
CHAR8  mEngUpperMap[MAP_TABLE_SIZE];\r
CHAR8  mEngLowerMap[MAP_TABLE_SIZE];\r
CHAR8  mEngInfoMap[MAP_TABLE_SIZE];\r
\r
CHAR8  mOtherChars[] = {\r
  '0',\r
  '1',\r
  '2',\r
  '3',\r
  '4',\r
  '5',\r
  '6',\r
  '7',\r
  '8',\r
  '9',\r
  '\\',\r
  '.',\r
  '_',\r
  '^',\r
  '$',\r
  '~',\r
  '!',\r
  '#',\r
  '%',\r
  '&',\r
  '-',\r
  '{',\r
  '}',\r
  '(',\r
  ')',\r
  '@',\r
  '`',\r
  '\'',\r
  '\0'\r
};\r
\r
EFI_HANDLE  mHandle = NULL;\r
\r
//\r
// EFI Unicode Collation Protocol supporting ISO 639-2 language code\r
//\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_COLLATION_PROTOCOL  UnicodeEng = {\r
  EngStriColl,\r
  EngMetaiMatch,\r
  EngStrLwr,\r
  EngStrUpr,\r
  EngFatToStr,\r
  EngStrToFat,\r
  "eng"\r
};\r
\r
//\r
// EFI Unicode Collation2 Protocol supporting RFC 4646 language code\r
//\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_COLLATION_PROTOCOL  Unicode2Eng = {\r
  EngStriColl,\r
  EngMetaiMatch,\r
  EngStrLwr,\r
  EngStrUpr,\r
  EngFatToStr,\r
  EngStrToFat,\r
  "en"\r
};\r
\r
/**\r
  The user Entry Point for English module.\r
\r
  This function initializes unicode character mapping and then installs Unicode\r
  Collation & Unicode Collation 2 Protocols based on the feature flags.\r
\r
  @param  ImageHandle    The firmware allocated handle for the EFI image.\r
  @param  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
InitializeUnicodeCollationEng (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       Index;\r
  UINTN       Index2;\r
\r
  //\r
  // Initialize mapping tables for the supported languages\r
  //\r
  for (Index = 0; Index < MAP_TABLE_SIZE; Index++) {\r
    mEngUpperMap[Index] = (CHAR8)Index;\r
    mEngLowerMap[Index] = (CHAR8)Index;\r
    mEngInfoMap[Index]  = 0;\r
\r
    if (((Index >= 'a') && (Index <= 'z')) || ((Index >= 0xe0) && (Index <= 0xf6)) || ((Index >= 0xf8) && (Index <= 0xfe))) {\r
      Index2               = Index - 0x20;\r
      mEngUpperMap[Index]  = (CHAR8)Index2;\r
      mEngLowerMap[Index2] = (CHAR8)Index;\r
\r
      mEngInfoMap[Index]  |= CHAR_FAT_VALID;\r
      mEngInfoMap[Index2] |= CHAR_FAT_VALID;\r
    }\r
  }\r
\r
  for (Index = 0; mOtherChars[Index] != 0; Index++) {\r
    Index2               = mOtherChars[Index];\r
    mEngInfoMap[Index2] |= CHAR_FAT_VALID;\r
  }\r
\r
  if (FeaturePcdGet (PcdUnicodeCollation2Support)) {\r
    if (FeaturePcdGet (PcdUnicodeCollationSupport)) {\r
      Status = gBS->InstallMultipleProtocolInterfaces (\r
                      &mHandle,\r
                      &gEfiUnicodeCollationProtocolGuid,\r
                      &UnicodeEng,\r
                      &gEfiUnicodeCollation2ProtocolGuid,\r
                      &Unicode2Eng,\r
                      NULL\r
                      );\r
      ASSERT_EFI_ERROR (Status);\r
    } else {\r
      Status = gBS->InstallMultipleProtocolInterfaces (\r
                      &mHandle,\r
                      &gEfiUnicodeCollation2ProtocolGuid,\r
                      &Unicode2Eng,\r
                      NULL\r
                      );\r
      ASSERT_EFI_ERROR (Status);\r
    }\r
  } else {\r
    if (FeaturePcdGet (PcdUnicodeCollationSupport)) {\r
      Status = gBS->InstallMultipleProtocolInterfaces (\r
                      &mHandle,\r
                      &gEfiUnicodeCollationProtocolGuid,\r
                      &UnicodeEng,\r
                      NULL\r
                      );\r
      ASSERT_EFI_ERROR (Status);\r
    } else {\r
      //\r
      // This module must support to produce at least one of Unicode Collation Protocol\r
      // and Unicode Collation 2 Protocol.\r
      //\r
      ASSERT (FALSE);\r
      Status = EFI_UNSUPPORTED;\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Performs a case-insensitive comparison of two Null-terminated strings.\r
\r
  @param  This Protocol instance pointer.\r
  @param  Str1 A pointer to a Null-terminated string.\r
  @param  Str2 A pointer to a Null-terminated 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
EngStriColl (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL  *This,\r
  IN CHAR16                          *Str1,\r
  IN CHAR16                          *Str2\r
  )\r
{\r
  while (*Str1 != 0) {\r
    if (TO_UPPER (*Str1) != TO_UPPER (*Str2)) {\r
      break;\r
    }\r
\r
    Str1 += 1;\r
    Str2 += 1;\r
  }\r
\r
  return TO_UPPER (*Str1) - TO_UPPER (*Str2);\r
}\r
\r
/**\r
  Converts all the characters in a Null-terminated string to\r
  lower case characters.\r
\r
  @param  This   Protocol instance pointer.\r
  @param  Str    A pointer to a Null-terminated string.\r
\r
**/\r
VOID\r
EFIAPI\r
EngStrLwr (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL  *This,\r
  IN OUT CHAR16                      *Str\r
  )\r
{\r
  while (*Str != 0) {\r
    *Str = TO_LOWER (*Str);\r
    Str += 1;\r
  }\r
}\r
\r
/**\r
  Converts all the characters in a Null-terminated string to upper\r
  case characters.\r
\r
  @param  This   Protocol instance pointer.\r
  @param  Str    A pointer to a Null-terminated string.\r
\r
**/\r
VOID\r
EFIAPI\r
EngStrUpr (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL  *This,\r
  IN OUT CHAR16                      *Str\r
  )\r
{\r
  while (*Str != 0) {\r
    *Str = TO_UPPER (*Str);\r
    Str += 1;\r
  }\r
}\r
\r
/**\r
  Performs a case-insensitive comparison of a Null-terminated\r
  pattern string and a Null-terminated string.\r
\r
  @param  This    Protocol instance pointer.\r
  @param  String  A pointer to a Null-terminated string.\r
  @param  Pattern A pointer to a Null-terminated 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
EngMetaiMatch (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL  *This,\r
  IN CHAR16                          *String,\r
  IN CHAR16                          *Pattern\r
  )\r
{\r
  CHAR16  CharC;\r
  CHAR16  CharP;\r
  CHAR16  Index3;\r
\r
  for ( ; ;) {\r
    CharP    = *Pattern;\r
    Pattern += 1;\r
\r
    switch (CharP) {\r
      case 0:\r
        //\r
        // End of pattern.  If end of string, TRUE match\r
        //\r
        if (*String != 0) {\r
          return FALSE;\r
        } else {\r
          return TRUE;\r
        }\r
\r
      case '*':\r
        //\r
        // Match zero or more chars\r
        //\r
        while (*String != 0) {\r
          if (EngMetaiMatch (This, String, Pattern)) {\r
            return TRUE;\r
          }\r
\r
          String += 1;\r
        }\r
\r
        return EngMetaiMatch (This, String, Pattern);\r
\r
      case '?':\r
        //\r
        // Match any one char\r
        //\r
        if (*String == 0) {\r
          return FALSE;\r
        }\r
\r
        String += 1;\r
        break;\r
\r
      case '[':\r
        //\r
        // Match char set\r
        //\r
        CharC = *String;\r
        if (CharC == 0) {\r
          //\r
          // syntax problem\r
          //\r
          return FALSE;\r
        }\r
\r
        Index3 = 0;\r
        CharP  = *Pattern++;\r
        while (CharP != 0) {\r
          if (CharP == ']') {\r
            return FALSE;\r
          }\r
\r
          if (CharP == '-') {\r
            //\r
            // if range of chars, get high range\r
            //\r
            CharP = *Pattern;\r
            if ((CharP == 0) || (CharP == ']')) {\r
              //\r
              // syntax problem\r
              //\r
              return FALSE;\r
            }\r
\r
            if ((TO_UPPER (CharC) >= TO_UPPER (Index3)) && (TO_UPPER (CharC) <= TO_UPPER (CharP))) {\r
              //\r
              // if in range, it's a match\r
              //\r
              break;\r
            }\r
          }\r
\r
          Index3 = CharP;\r
          if (TO_UPPER (CharC) == TO_UPPER (CharP)) {\r
            //\r
            // if char matches\r
            //\r
            break;\r
          }\r
\r
          CharP = *Pattern++;\r
        }\r
\r
        //\r
        // skip to end of match char set\r
        //\r
        while ((CharP != 0) && (CharP != ']')) {\r
          CharP    = *Pattern;\r
          Pattern += 1;\r
        }\r
\r
        String += 1;\r
        break;\r
\r
      default:\r
        CharC = *String;\r
        if (TO_UPPER (CharC) != TO_UPPER (CharP)) {\r
          return FALSE;\r
        }\r
\r
        String += 1;\r
        break;\r
    }\r
  }\r
}\r
\r
/**\r
  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated 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 8-bit OEM character set.\r
  @param  String  A pointer to a Null-terminated string. The string must\r
                  be preallocated to hold FatSize characters.\r
\r
**/\r
VOID\r
EFIAPI\r
EngFatToStr (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL  *This,\r
  IN UINTN                           FatSize,\r
  IN CHAR8                           *Fat,\r
  OUT CHAR16                         *String\r
  )\r
{\r
  //\r
  // No DBCS issues, just expand and add null terminate to end of string\r
  //\r
  while ((*Fat != 0) && (FatSize != 0)) {\r
    *String  = *Fat;\r
    String  += 1;\r
    Fat     += 1;\r
    FatSize -= 1;\r
  }\r
\r
  *String = 0;\r
}\r
\r
/**\r
  Converts a Null-terminated 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 string. The string must\r
                  be preallocated to hold FatSize 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
EngStrToFat (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL  *This,\r
  IN CHAR16                          *String,\r
  IN UINTN                           FatSize,\r
  OUT CHAR8                          *Fat\r
  )\r
{\r
  BOOLEAN  SpecialCharExist;\r
\r
  SpecialCharExist = FALSE;\r
  while ((*String != 0) && (FatSize != 0)) {\r
    //\r
    // Skip '.' or ' ' when making a fat name\r
    //\r
    if ((*String != '.') && (*String != ' ')) {\r
      //\r
      // If this is a valid fat char, move it.\r
      // Otherwise, move a '_' and flag the fact that the name needs a long file name.\r
      //\r
      if ((*String < MAP_TABLE_SIZE) && ((mEngInfoMap[*String] & CHAR_FAT_VALID) != 0)) {\r
        *Fat = mEngUpperMap[*String];\r
      } else {\r
        *Fat             = '_';\r
        SpecialCharExist = TRUE;\r
      }\r
\r
      Fat     += 1;\r
      FatSize -= 1;\r
    }\r
\r
    String += 1;\r
  }\r
\r
  //\r
  // Do not terminate that fat string\r
  //\r
  return SpecialCharExist;\r
}\r