From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga17.intel.com (mga17.intel.com [192.55.52.151]) by mx.groups.io with SMTP id smtpd.web09.3020.1607324723647978115 for ; Sun, 06 Dec 2020 23:05:23 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@intel.onmicrosoft.com header.s=selector2-intel-onmicrosoft-com header.b=ohHfLHDZ; spf=pass (domain: intel.com, ip: 192.55.52.151, mailfrom: hao.a.wu@intel.com) IronPort-SDR: RAZBPr1hEIkPd/bwTrW5B8a3aPUnOj5RoZDRGzrncLC7r9paWQszAIkKrciN7LmKge49Y3we7Q OhgaLATmyTEg== X-IronPort-AV: E=McAfee;i="6000,8403,9827"; a="153471091" X-IronPort-AV: E=Sophos;i="5.78,399,1599548400"; d="scan'208";a="153471091" Received: from fmsmga004.fm.intel.com ([10.253.24.48]) by fmsmga107.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 06 Dec 2020 23:05:22 -0800 IronPort-SDR: 4rICwVgoOW0XMkCry/jyjnxPBEm4F+KVonoj5MmflGipyTMcT1fY7r0kdYb1TWORv59RV/JJiy hymRGRWZi+vQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.78,399,1599548400"; d="scan'208";a="367070905" Received: from fmsmsx606.amr.corp.intel.com ([10.18.126.86]) by fmsmga004.fm.intel.com with ESMTP; 06 Dec 2020 23:05:22 -0800 Received: from fmsmsx604.amr.corp.intel.com (10.18.126.84) by fmsmsx606.amr.corp.intel.com (10.18.126.86) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.1713.5; Sun, 6 Dec 2020 23:05:22 -0800 Received: from fmsedg602.ED.cps.intel.com (10.1.192.136) by fmsmsx604.amr.corp.intel.com (10.18.126.84) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.1713.5 via Frontend Transport; Sun, 6 Dec 2020 23:05:22 -0800 Received: from NAM12-MW2-obe.outbound.protection.outlook.com (104.47.66.43) by edgegateway.intel.com (192.55.55.71) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.1713.5; Sun, 6 Dec 2020 23:05:21 -0800 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=SD25Mt6AubXt2ZZDvH5RoXcGJfKwC4n4LXC5bAai1RIgMJ4t1zipdY/XsE1RKYjPPCZQczc5uRePe4Fk8ptPcQ8u2MnDL42PnJmlTSFHMopDAQa4z0lXCwyDq0gyjR4aII/eKASxoBG1B9oqZoNtNHwUBPqE57B0HUPiRwy8g7+RlcELBHJLjfrBh5CDVYfY1Zl/6Uwl/vm4f54/FK81ktANWxL8EAymCSv4NjGMIMSbqwOztHh8LVARz93Rf5Z7a+U6LNdJyQvKnvTT+37VjJ1LZ3piaFDezy2gnI4a0+26phgkTJdlZ1QIUTCV/BeFdsjOofSgbfUsK0kjlgp0dQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=W67pdl1BnWF2SPAyCFMnTxLioIPMPUczp26xeF0dmxg=; b=ZT1tL5gWnYNGuG5CI7XtzPsQe9JSAQuDLp/VBYhtMVoitMkM35aS2E6hRhPPwrXujrYo5dzPuDRI1DypHtZj/L5XYNxaGbODECnBqA+DvWUSuDHvmm+1EqPTTeP/riQTmICJF6MkbxjjiMNuFEOONeNWMDB9Ixdrael7Xl0WvQlhmLnFfsVBAzdRWBm7hfksyQktxbbCqGDd4gnHEc6Jb73cOTsb56OX0szpIzJpiZ+6M6jwNPlI2gy9os1ePVaCSME65BRFc9NHNIPv6hUXsSfMuOWibPEDHq+E6afAs6KZPFv3/BWThk9njJx61SqKG2rfup9K/iuhYE9t0qcrTg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=intel.com; dmarc=pass action=none header.from=intel.com; dkim=pass header.d=intel.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=intel.onmicrosoft.com; s=selector2-intel-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=W67pdl1BnWF2SPAyCFMnTxLioIPMPUczp26xeF0dmxg=; b=ohHfLHDZRhx23phhXST6lqbEzSXTMjSGrocucQ+vC9KISXGiU7z+qbORJl13vEGrhAE/j2H2MmyLXp/repwMZANNBcUhEh65artNkNjZgP51jkQ97eE0+H0GnDqcLgARKgwIpRvOmhEconfNa9bXm2YdNRPPFb/ZmDh/7SyeiCk= Received: from BN8PR11MB3666.namprd11.prod.outlook.com (2603:10b6:408:8c::19) by BN6PR11MB4036.namprd11.prod.outlook.com (2603:10b6:405:82::15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3632.21; Mon, 7 Dec 2020 07:05:20 +0000 Received: from BN8PR11MB3666.namprd11.prod.outlook.com ([fe80::4cda:993f:ffc1:f169]) by BN8PR11MB3666.namprd11.prod.outlook.com ([fe80::4cda:993f:ffc1:f169%6]) with mapi id 15.20.3632.022; Mon, 7 Dec 2020 07:05:20 +0000 From: "Wu, Hao A" To: "devel@edk2.groups.io" , "abner.chang@hpe.com" CC: "Wang, Jian J" , Liming Gao , Leif Lindholm , Nickle Wang , Peter O'Hanley Subject: Re: [edk2-devel] [PATCH v4 1/6] MdeModulePkg/Ucs2Utf8lib: UCS2 to UFT8 manipulation library Thread-Topic: [edk2-devel] [PATCH v4 1/6] MdeModulePkg/Ucs2Utf8lib: UCS2 to UFT8 manipulation library Thread-Index: AQHWzGGbnIp5k2YdTEmEUKndALmf7qnrMygg Date: Mon, 7 Dec 2020 07:05:20 +0000 Message-ID: References: <20201207053655.29101-1-abner.chang@hpe.com> <20201207053655.29101-2-abner.chang@hpe.com> In-Reply-To: <20201207053655.29101-2-abner.chang@hpe.com> Accept-Language: en-US, zh-CN X-MS-Has-Attach: X-MS-TNEF-Correlator: dlp-product: dlpe-windows dlp-reaction: no-action dlp-version: 11.5.1.3 authentication-results: edk2.groups.io; dkim=none (message not signed) header.d=none;edk2.groups.io; dmarc=none action=none header.from=intel.com; x-originating-ip: [192.198.147.218] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: ee1b4d2f-f5d8-4335-0076-08d89a7e75c2 x-ms-traffictypediagnostic: BN6PR11MB4036: x-ms-exchange-transport-forked: True x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:2201; x-ms-exchange-senderadcheck: 1 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: AePT5PSg5OdUzYxtjbsK7v/LnXJ1wJZehMktl8D2dVfeYX8dEscOnm1Xd/w8inhoBybQ7M1dPR/Qe1BkLLW9ui3ApdPBpXqlTSNTMxc52pluj1jgME7xy0Y7io9cP8jLEPjf/gpSUVlNn3Iqj7/WoSfTyapZaARWWKzL3MnAUFl7is0zI54RJEqXED9rkJtUhasMG+Dwo9niiW4a6rglv3L2pxMkiEa7FPBFBbaD+TFMx/P59qtDX/ROxqEkV2VjLaEkB/QnrM84E6hJK9LgRwk4nd2Mq79bvlu6/SXP+AI3Z1V3bM/9fyuSyzMBAZPr7P5YyRLuMa6rJtU8Y2YLq3HQ1UdP6gF/9MWKKOHXc7UQFFhC0Ngpz/UswcJHEuzkTStyM1uPVdp9UJuNYl1nEg== x-forefront-antispam-report: CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:BN8PR11MB3666.namprd11.prod.outlook.com;PTR:;CAT:NONE;SFS:(4636009)(136003)(366004)(396003)(346002)(39860400002)(376002)(8936002)(966005)(83380400001)(53546011)(64756008)(66476007)(9686003)(4326008)(66556008)(76116006)(55016002)(66446008)(19627235002)(8676002)(66946007)(316002)(71200400001)(30864003)(33656002)(110136005)(52536014)(2906002)(478600001)(5660300002)(7696005)(86362001)(6506007)(26005)(186003)(54906003)(579004);DIR:OUT;SFP:1102; x-ms-exchange-antispam-messagedata: =?us-ascii?Q?IrIbilyAjkkKjtdYKj1HoMmd9ZHDNyzIuPqieqwBKp0LVwb28uqbFHjrYcCt?= =?us-ascii?Q?BqbNgvr843h+VKD/VO0MluA2YBnuu/quvWGDQswTrrcqpaWPg56+fna96rxT?= =?us-ascii?Q?0jyh3SsLRz5X5Zf1VSHAUJBtuwhOdPI/z23nqdDvNes7FSowuXMBC6sG/Lho?= =?us-ascii?Q?lM9dPZzUt81zcPI5t6RCUHzgK9zVOlnIDmRZy2V15TF1lYHKrc/YMi43NYY1?= =?us-ascii?Q?ghk875MSzUIp2tFtp039KV62ylZ1SSeuLRb7T6eWPH0naMjpQ+yLNiVtclHb?= =?us-ascii?Q?x4tn5mPKP9FThn5WG25qa0hqTroWOQjJ8I/3TXZbFGIg3JoHyOppFKvbqGlK?= =?us-ascii?Q?21Yq3AohDb666kN4S5K7e9Q5DlHQvSW3wPQBLgn5svYbKFDPepPGm8inG4Ck?= =?us-ascii?Q?4+jdMoPa4WsWWo2iw9dZvOCUIzHcC4s12z660E3loszmMPR35qM0xOHv/Nxb?= =?us-ascii?Q?kCp0x5nfiQvkFe7JsmbHiwStFoE5rN+5sQYqHhyQ8MkIRGGaluKbP+aKmOmh?= =?us-ascii?Q?8MXZM1nha34xO5+3SCmN52/L+JuzLxHscPi3txXMt4J4NMF4jfQACw34yv+h?= =?us-ascii?Q?sdzZcR2acNK6BfJqnyQsUQqDbAK/LHsAvJrdmUm1HJCgv8ykwxIbEceu1clW?= =?us-ascii?Q?VThhFhDep+tIBuVYUVynbFd2U9a+K0mdeGLqceENQZAbgjCViThFXHbvREPq?= =?us-ascii?Q?r1XW3w0cftUcr24aUWCwBSArvlkLJStyYBE30Fonz0hhrGU4hxNxaIeHv5qb?= =?us-ascii?Q?AU3NHgJ5hthGftwzXA5HceGC7Bc+OBo+cwSlM9MNMww4rvuZg26TSIMxfiPZ?= =?us-ascii?Q?lglJTtytP2OrwqfO+cpS9OYBkVx4VnMeWgcHoh/wZAQS9a3BfjUfPiIkf2Lo?= =?us-ascii?Q?Q4YygCK9J07pjAsPRIPWnP92vOdI54LSNCDg2RfwJ7iM37ypbmij1ApkWs4A?= =?us-ascii?Q?Ra1Dw0a8cuVzL3NPng8e6NBF/Rx7ZurXsi4dheOTbMwZ8wiHLCQlXJ8Cflku?= =?us-ascii?Q?6Utj?= MIME-Version: 1.0 X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: BN8PR11MB3666.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: ee1b4d2f-f5d8-4335-0076-08d89a7e75c2 X-MS-Exchange-CrossTenant-originalarrivaltime: 07 Dec 2020 07:05:20.3451 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 46c98d88-e344-4ed4-8496-4ed7712e255d X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: l29l6VC+qS1UZ0R5tHZYHwXo357nzWK02WTWcNFns37EXrMkbIRsZhBxHgwr0u4TVFvycxghxIaBFUE6BICdVw== X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN6PR11MB4036 Return-Path: hao.a.wu@intel.com X-OriginatorOrg: intel.com Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable > -----Original Message----- > From: devel@edk2.groups.io On Behalf Of Abner > Chang > Sent: Monday, December 7, 2020 1:37 PM > To: devel@edk2.groups.io > Cc: Wang, Jian J ; Wu, Hao A = ; > Liming Gao ; Leif Lindholm > ; Nickle Wang ; Peter O'Hanley > > Subject: [edk2-devel] [PATCH v4 1/6] MdeModulePkg/Ucs2Utf8lib: UCS2 to > UFT8 manipulation library >=20 > This library provides UCS2 to UFT8 or vise versa functions to manipulate > UCS2/UTF8 strings. This library is currently used by edk2 port of open s= ource > jansson library. Really sorry for missing the previous discussion between you and Leif. For me, the Ucs2Utf8lib case is kind of similar with the jansson library c= ase for the Redfish feature. If the current consumer is only the jansson library under the RedfishPkg, = I would suggest to put the Ucs2Utf8lib under RedfishPkg first. We can move this library to a more generic place if there are more consume= rs. Best Regards, Hao Wu >=20 > Signed-off-by: Abner Chang >=20 > Cc: Jian J Wang > Cc: Hao A Wu > Cc: Liming Gao > Cc: Leif Lindholm > Cc: Nickle Wang > Cc: Peter O'Hanley > --- > .../Include/Library/BaseUcs2Utf8Lib.h | 69 +++ > .../Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.c | 417 ++++++++++++++++++ > .../BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf | 30 ++ > MdeModulePkg/MdeModulePkg.dec | 5 + > MdeModulePkg/MdeModulePkg.dsc | 2 + > 5 files changed, 523 insertions(+) > create mode 100644 MdeModulePkg/Include/Library/BaseUcs2Utf8Lib.h > create mode 100644 > MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.c > create mode 100644 > MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf >=20 > diff --git a/MdeModulePkg/Include/Library/BaseUcs2Utf8Lib.h > b/MdeModulePkg/Include/Library/BaseUcs2Utf8Lib.h > new file mode 100644 > index 0000000000..51ae924929 > --- /dev/null > +++ b/MdeModulePkg/Include/Library/BaseUcs2Utf8Lib.h > @@ -0,0 +1,69 @@ > +/** @file > + UCS2 to UTF8 manipulation library header file. > + > + Copyright (c) 2019, Intel Corporation. All rights reserved.
> + (C) Copyright 2020 Hewlett Packard Enterprise Development LP
> + > + SPDX-License-Identifier: BSD-2-Clause-Patent > + > +**/ > + > +#ifndef BASE_UCS2UTF8_LIB_H_ > +#define BASE_UCS2UTF8_LIB_H_ > + > +#include > +#include > +#include > +#include > +#include > +#include > +#include > + > +/// > +/// L"\u0000" > +/// > +#define UNICODE_FORMAT_LEN 6 > +#define UNICODE_FORMAT_CHAR_LEN 2 > +#define UNICODE_FORMAT_CHAR_SIZE 3 > + > +#define UTF8_BUFFER_FOR_UCS2_MAX_SIZE 3 > + > +/** > + Convert a UCS2 string to a UTF8 encoded string. > + > + @param[in] Ucs2Str The provided UCS2 string. > + @param[out] Utf8StrAddr The converted UTF8 string addres= s. Caller > + is responsible for Free this str= ing. > + > + @retval EFI_INVALID_PARAMETER One or more parameters are inval= id. > + @retval EFI_OUT_OF_RESOURCES System runs out of resources. > + @retval EFI_SUCCESS The UTF8 encoded string has been > converted. > + > +**/ > +EFI_STATUS > +UCS2StrToUTF8 ( > + IN CHAR16 *Ucs2Str, > + OUT CHAR8 **Utf8StrAddr > + ); > + > +/** > + Convert a UTF8 encoded string to a UCS2 string. > + > + @param[in] Utf8Str The provided UTF8 encoded string= . > + @param[out] Ucs2StrAddr The converted UCS2 string addres= s. > Caller > + is responsible for Free this str= ing. > + > + @retval EFI_INVALID_PARAMETER The UTF8 encoded string is not v= alid > to > + convert to UCS2 string. > + One or more parameters are inval= id. > + @retval EFI_OUT_OF_RESOURCES System runs out of resources. > + @retval EFI_SUCCESS The UCS2 string has been convert= ed. > + > +**/ > +EFI_STATUS > +UTF8StrToUCS2 ( > + IN CHAR8 *Utf8Str, > + OUT CHAR16 **Ucs2StrAddr > + ); > + > +#endif > diff --git a/MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.c > b/MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.c > new file mode 100644 > index 0000000000..6cff109a5c > --- /dev/null > +++ b/MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.c > @@ -0,0 +1,417 @@ > +/** @file > + UCS2 to UTF8 manipulation library. > + > + Copyright (c) 2018 - 2019, Intel Corporation. All rights > + reserved.
> + (C) Copyright 2020 Hewlett Packard Enterprise Development LP
> + > + SPDX-License-Identifier: BSD-2-Clause-Patent > + > +**/ > + > +#include > + > +/** > + Since each UCS2 character can be represented by 1-3 UTF8 encoded > +characters, > + this function is used to retrieve the UTF8 encoding size for a UCS2 > character. > + > + @param[in] Utf8Buffer The buffer for UTF8 encoded data. > + > + @retval Return the size of UTF8 encoding string or 0 if it is no= t for > + UCS2 format. > + > +**/ > +UINT8 > +GetUTF8SizeForUCS2 ( > + IN CHAR8 *Utf8Buffer > + ) > +{ > + CHAR8 TempChar; > + UINT8 Utf8Size; > + > + ASSERT (Utf8Buffer !=3D NULL); > + > + TempChar =3D *Utf8Buffer; > + if ((TempChar & 0xF0) =3D=3D 0xF0) { > + > + // > + // This format is not for UCS2. > + // > + return 0; > + } > + > + Utf8Size =3D 1; > + if ((TempChar & 0x80) =3D=3D 0x80) { > + if ((TempChar & 0xC0) =3D=3D 0xC0) { > + > + Utf8Size ++; > + if ((TempChar & 0xE0) =3D=3D 0xE0) { > + > + Utf8Size ++; > + } > + } > + } > + > + return Utf8Size; > +} > + > +/** > + Since each UCS2 character can be represented by the format: \uXXXX, > +this function > + is used to retrieve the UCS2 character from a Unicode format. > + Call MUST make sure there are at least 6 Bytes in the input UTF8 buff= er. > + > + @param[in] Utf8Buffer The buffer for UTF8 encoded data= . > + @param[out] Ucs2Char The converted UCS2 character. > + > + @retval EFI_INVALID_PARAMETER Non-Ascii characters found in th= e > hexadecimal > + digits string, and can't be conv= erted to a UCS2 > + character. > + @retval EFI_SUCCESS The UCS2 character has been retr= ieved. > + > +**/ > +EFI_STATUS > +GetUCS2CharByFormat ( > + IN CHAR8 *Utf8Buffer, > + OUT CHAR16 *Ucs2Char > + ) > +{ > + UINT8 Num1; > + UINT8 Num2; > + UINT8 Index; > + CHAR8 Ucs2CharFormat[UNICODE_FORMAT_CHAR_SIZE]; /// two > Hexadecimal digits Ascii string, like "3F" > + > + for (Index =3D 0; Index < 4; Index ++) { > + if ((*(Utf8Buffer + 2 + Index) & 0x80) !=3D 0x00) { > + return EFI_INVALID_PARAMETER; > + } > + } > + > + ZeroMem (Ucs2CharFormat, UNICODE_FORMAT_CHAR_SIZE); > + > + // > + // Get the First Number, Offset is 2 > + // > + CopyMem (Ucs2CharFormat, Utf8Buffer + 2, > UNICODE_FORMAT_CHAR_LEN); > + Num1 =3D (UINT8) AsciiStrHexToUintn (Ucs2CharFormat); > + > + // > + // Get the Second Number, Offset is 4 // CopyMem (Ucs2CharFormat, > + Utf8Buffer + 4, UNICODE_FORMAT_CHAR_LEN); > + Num2 =3D (UINT8) AsciiStrHexToUintn (Ucs2CharFormat); > + > + // > + // Ucs2Char is Little-Endian > + // > + *((CHAR8 *) Ucs2Char) =3D Num2; > + *(((CHAR8 *) Ucs2Char) + 1) =3D Num1; > + > + return EFI_SUCCESS; > +} > + > +/** > + Convert a UCS2 character to UTF8 encoding string. > + > + @param[in] Ucs2Char The provided UCS2 character. > + @param[out] Utf8Buffer The converted UTF8 encoded data. > + > + @retval Return the size of UTF8 encoding data for this UCS2 char= acter. > + > +**/ > +UINT8 > +UCS2CharToUTF8 ( > + IN CHAR16 Ucs2Char, > + OUT CHAR8 *Utf8Buffer > + ) > +{ > + UINT16 Ucs2Number; > + > + ASSERT (Utf8Buffer !=3D NULL); > + > + Ucs2Number =3D (UINT16) Ucs2Char; > + if (Ucs2Number <=3D 0x007F) { > + > + // > + // UTF8 format: 0xxxxxxx > + // > + *Utf8Buffer =3D Ucs2Char & 0x7F; > + return 1; > + > + } else if (Ucs2Number >=3D 0x0080 && Ucs2Number <=3D 0x07FF) { > + > + // > + // UTF8 format: 110xxxxx 10xxxxxx > + // > + *(Utf8Buffer + 1) =3D (Ucs2Char & 0x3F) | 0x80; > + *Utf8Buffer =3D ((Ucs2Char >> 6) & 0x1F) | 0xC0; > + return 2; > + > + } else { /// Ucs2Number >=3D 0x0800 && Ucs2Number <=3D 0xFFFF > + > + // > + // UTF8 format: 1110xxxx 10xxxxxx 10xxxxxx > + // > + *(Utf8Buffer + 2) =3D (Ucs2Char & 0x3F) | 0x80; > + *(Utf8Buffer + 1) =3D ((Ucs2Char >> 6) & 0x3F) | 0x80; > + *Utf8Buffer =3D ((Ucs2Char >> 12) & 0x0F) | 0xE0; > + return 3; > + } > +} > + > +/** > + Convert a UTF8 encoded data to a UCS2 character. > + > + @param[in] Utf8Buffer The provided UTF8 encoded data. > + @param[out] Ucs2Char The converted UCS2 character. > + > + @retval EFI_INVALID_PARAMETER The UTF8 encoded string is not v= alid > or > + not for UCS2 character. > + @retval EFI_SUCCESS The converted UCS2 character. > + > +**/ > +EFI_STATUS > +UTF8ToUCS2Char ( > + IN CHAR8 *Utf8Buffer, > + OUT CHAR16 *Ucs2Char > + ) > +{ > + UINT8 Utf8Size; > + CHAR8 *Ucs2Buffer; > + CHAR8 TempChar1; > + CHAR8 TempChar2; > + CHAR8 TempChar3; > + > + ASSERT (Utf8Buffer !=3D NULL && Ucs2Char !=3D NULL); ZeroMem (Ucs2Ch= ar, > + sizeof (CHAR16)); Ucs2Buffer =3D (CHAR8 *) Ucs2Char; > + > + Utf8Size =3D GetUTF8SizeForUCS2 (Utf8Buffer); switch (Utf8Size) { > + > + case 1: > + > + // > + // UTF8 format: 0xxxxxxx > + // > + TempChar1 =3D *Utf8Buffer; > + if ((TempChar1 & 0x80) !=3D 0x00) { > + return EFI_INVALID_PARAMETER; > + } > + > + *Ucs2Buffer =3D TempChar1; > + *(Ucs2Buffer + 1) =3D 0; > + break; > + > + case 2: > + > + // > + // UTF8 format: 110xxxxx 10xxxxxx > + // > + TempChar1 =3D *Utf8Buffer; > + if ((TempChar1 & 0xE0) !=3D 0xC0) { > + return EFI_INVALID_PARAMETER; > + } > + > + TempChar2 =3D *(Utf8Buffer + 1); > + if ((TempChar2 & 0xC0) !=3D 0x80) { > + return EFI_INVALID_PARAMETER; > + } > + > + *Ucs2Buffer =3D (TempChar1 << 6) + (TempChar2 & 0x3F); > + *(Ucs2Buffer + 1) =3D (TempChar1 >> 2) & 0x07; > + break; > + > + case 3: > + > + // > + // UTF8 format: 1110xxxx 10xxxxxx 10xxxxxx > + // > + TempChar1 =3D *Utf8Buffer; > + if ((TempChar1 & 0xF0) !=3D 0xE0) { > + return EFI_INVALID_PARAMETER; > + } > + > + TempChar2 =3D *(Utf8Buffer + 1); > + if ((TempChar2 & 0xC0) !=3D 0x80) { > + return EFI_INVALID_PARAMETER; > + } > + > + TempChar3 =3D *(Utf8Buffer + 2); > + if ((TempChar3 & 0xC0) !=3D 0x80) { > + return EFI_INVALID_PARAMETER; > + } > + > + *Ucs2Buffer =3D (TempChar2 << 6) + (TempChar3 & 0x3F); > + *(Ucs2Buffer + 1) =3D (TempChar1 << 4) + ((TempChar2 >> 2) & 0x0F= ); > + > + break; > + > + default: > + > + return EFI_INVALID_PARAMETER; > + } > + > + return EFI_SUCCESS; > +} > + > +/** > + Convert a UCS2 string to a UTF8 encoded string. > + > + @param[in] Ucs2Str The provided UCS2 string. > + @param[out] Utf8StrAddr The converted UTF8 string addres= s. Caller > + is responsible for Free this str= ing. > + > + @retval EFI_INVALID_PARAMETER One or more parameters are inval= id. > + @retval EFI_OUT_OF_RESOURCES System runs out of resources. > + @retval EFI_SUCCESS The UTF8 encoded string has been > converted. > + > +**/ > +EFI_STATUS > +UCS2StrToUTF8 ( > + IN CHAR16 *Ucs2Str, > + OUT CHAR8 **Utf8StrAddr > + ) > +{ > + UINTN Ucs2StrIndex; > + UINTN Ucs2StrLength; > + CHAR8 *Utf8Str; > + UINTN Utf8StrLength; > + UINTN Utf8StrIndex; > + CHAR8 Utf8Buffer[UTF8_BUFFER_FOR_UCS2_MAX_SIZE]; > + UINT8 Utf8BufferSize; > + > + if (Ucs2Str =3D=3D NULL || Utf8StrAddr =3D=3D NULL) { > + return EFI_INVALID_PARAMETER; > + } > + > + Ucs2StrLength =3D StrLen (Ucs2Str); > + Utf8StrLength =3D 0; > + > + for (Ucs2StrIndex =3D 0; Ucs2StrIndex < Ucs2StrLength; Ucs2StrIndex += +) > + { > + > + ZeroMem (Utf8Buffer, sizeof (Utf8Buffer)); > + Utf8BufferSize =3D UCS2CharToUTF8 (Ucs2Str[Ucs2StrIndex], Utf8Buffe= r); > + Utf8StrLength +=3D Utf8BufferSize; > + } > + > + Utf8Str =3D AllocateZeroPool (Utf8StrLength + 1); if (Utf8Str =3D=3D= NULL) > + { > + return EFI_OUT_OF_RESOURCES; > + } > + > + Utf8StrIndex =3D 0; > + for (Ucs2StrIndex =3D 0; Ucs2StrIndex < Ucs2StrLength; Ucs2StrIndex += +) > + { > + > + ZeroMem (Utf8Buffer, sizeof (Utf8Buffer)); > + Utf8BufferSize =3D UCS2CharToUTF8 (Ucs2Str[Ucs2StrIndex], > + Utf8Buffer); > + > + CopyMem (Utf8Str + Utf8StrIndex, Utf8Buffer, Utf8BufferSize); > + Utf8StrIndex +=3D Utf8BufferSize; > + } > + > + Utf8Str[Utf8StrIndex] =3D '\0'; > + *Utf8StrAddr =3D Utf8Str; > + > + return EFI_SUCCESS; > +} > + > +/** > + Convert a UTF8 encoded string to a UCS2 string. > + > + @param[in] Utf8Str The provided UTF8 encoded string= . > + @param[out] Ucs2StrAddr The converted UCS2 string addres= s. > Caller > + is responsible for Free this str= ing. > + > + @retval EFI_INVALID_PARAMETER The UTF8 encoded string is not v= alid > to > + convert to UCS2 string. > + One or more parameters are inval= id. > + @retval EFI_OUT_OF_RESOURCES System runs out of resources. > + @retval EFI_SUCCESS The UCS2 string has been convert= ed. > + > +**/ > +EFI_STATUS > +UTF8StrToUCS2 ( > + IN CHAR8 *Utf8Str, > + OUT CHAR16 **Ucs2StrAddr > + ) > +{ > + EFI_STATUS Status; > + UINTN Utf8StrIndex; > + UINTN Utf8StrLength; > + UINTN Ucs2StrIndex; > + UINT8 Utf8BufferSize; > + CHAR16 *Ucs2StrTemp; > + > + if (Utf8Str =3D=3D NULL || Ucs2StrAddr =3D=3D NULL) { > + return EFI_INVALID_PARAMETER; > + } > + > + // > + // It is not an Ascii string, calculate string length. > + // > + Utf8StrLength =3D 0; > + while (*(Utf8Str + Utf8StrLength) !=3D '\0') { > + Utf8StrLength ++; > + } > + > + // > + // UCS2 string shall not be longer than the UTF8 string. > + // > + Ucs2StrTemp =3D AllocateZeroPool ((Utf8StrLength + 1) * sizeof > + (CHAR16)); if (Ucs2StrTemp =3D=3D NULL) { > + return EFI_OUT_OF_RESOURCES; > + } > + > + Utf8StrIndex =3D 0; > + Ucs2StrIndex =3D 0; > + while (Utf8Str[Utf8StrIndex] !=3D '\0') { > + > + if (CompareMem (Utf8Str + Utf8StrIndex, "\\u", 2) =3D=3D 0 && > + Utf8StrLength - Utf8StrIndex >=3D UNICODE_FORMAT_LEN) { > + > + Status =3D GetUCS2CharByFormat (Utf8Str + Utf8StrIndex, Ucs2StrTe= mp + > Ucs2StrIndex); > + if (!EFI_ERROR (Status)) { > + > + Utf8StrIndex +=3D UNICODE_FORMAT_LEN; > + Ucs2StrIndex ++; > + } else { > + > + StrCpyS (Ucs2StrTemp + Ucs2StrIndex, 3, L"\\u"); > + > + Ucs2StrIndex +=3D 2; > + Utf8StrIndex +=3D 2; > + } > + } else { > + > + Utf8BufferSize =3D GetUTF8SizeForUCS2 (Utf8Str + Utf8StrIndex); > + if (Utf8BufferSize =3D=3D 0 || Utf8StrLength - Utf8StrIndex < > + Utf8BufferSize) { > + > + FreePool (Ucs2StrTemp); > + return EFI_INVALID_PARAMETER; > + } > + > + Status =3D UTF8ToUCS2Char (Utf8Str + Utf8StrIndex, Ucs2StrTemp + > Ucs2StrIndex); > + if (EFI_ERROR (Status)) { > + > + FreePool (Ucs2StrTemp); > + return EFI_INVALID_PARAMETER; > + } > + > + Ucs2StrIndex ++; > + Utf8StrIndex +=3D Utf8BufferSize; > + } > + } > + > + *Ucs2StrAddr =3D AllocateZeroPool ((Ucs2StrIndex + 1) * sizeof > + (CHAR16)); if (*Ucs2StrAddr =3D=3D NULL) { > + > + FreePool (Ucs2StrTemp); > + return EFI_OUT_OF_RESOURCES; > + } > + > + StrCpyS (*Ucs2StrAddr, Ucs2StrIndex + 1, Ucs2StrTemp); > + *(*Ucs2StrAddr + Ucs2StrIndex) =3D L'\0'; FreePool (Ucs2StrTemp); > + > + return EFI_SUCCESS; > +} > + > diff --git a/MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf > b/MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf > new file mode 100644 > index 0000000000..93efb1fb88 > --- /dev/null > +++ b/MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf > @@ -0,0 +1,30 @@ > +## @file > +# UCS2 to UTF8 manipulation library. > +# > +# Copyright (c) 2019, Intel Corporation. All rights reserved.
# (C) > +Copyright 2020 Hewlett Packard Enterprise Development LP
# > +# SPDX-License-Identifier: BSD-2-Clause-Patent > +# > +## > + > +[Defines] > + INF_VERSION =3D 0x0001001b > + BASE_NAME =3D BaseUcs2Utf8Lib > + FILE_GUID =3D 536646C3-46D0-4B12-ABC4-CDE1A33B52= 56 > + MODULE_TYPE =3D BASE > + VERSION_STRING =3D 1.0 > + LIBRARY_CLASS =3D Ucs2Utf8Lib > + > +# > +# VALID_ARCHITECTURES =3D IA32 X64 ARM AARCH64 RISCV64 > +# > + > +[Sources.common] > + BaseUcs2Utf8Lib.c > + > +[Packages] > + MdePkg/MdePkg.dec > + MdeModulePkg/MdeModulePkg.dec > + > + > diff --git a/MdeModulePkg/MdeModulePkg.dec > b/MdeModulePkg/MdeModulePkg.dec index 9b52b34494..1cd8c6392d > 100644 > --- a/MdeModulePkg/MdeModulePkg.dec > +++ b/MdeModulePkg/MdeModulePkg.dec > @@ -154,6 +154,11 @@ > # > VariablePolicyHelperLib|Include/Library/VariablePolicyHelperLib.h >=20 > + ## @libraryclass This library provides UCS2 to UTF8 manipulation > + # functions. > + # > + Ucs2Utf8Lib|Include/Library/BaseUcs2Utf8Lib.h > + > [Guids] > ## MdeModule package token space guid > # Include/Guid/MdeModulePkgTokenSpace.h > diff --git a/MdeModulePkg/MdeModulePkg.dsc > b/MdeModulePkg/MdeModulePkg.dsc index 90165ca443..85e2daeeea > 100644 > --- a/MdeModulePkg/MdeModulePkg.dsc > +++ b/MdeModulePkg/MdeModulePkg.dsc > @@ -43,6 +43,7 @@ > PeCoffLib|MdePkg/Library/BasePeCoffLib/BasePeCoffLib.inf >=20 > PeCoffGetEntryPointLib|MdePkg/Library/BasePeCoffGetEntryPointLib/Base > PeCoffGetEntryPointLib.inf > SortLib|MdeModulePkg/Library/BaseSortLib/BaseSortLib.inf > + > Ucs2Utf8Lib|MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf > # > # UEFI & PI > # > @@ -212,6 +213,7 @@ > MdeModulePkg/Application/MemoryProfileInfo/MemoryProfileInfo.inf >=20 > MdeModulePkg/Library/UefiSortLib/UefiSortLib.inf > + MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf > MdeModulePkg/Logo/Logo.inf > MdeModulePkg/Logo/LogoDxe.inf > MdeModulePkg/Library/BaseSortLib/BaseSortLib.inf > -- > 2.17.1 >=20 >=20 >=20 >=20 >=20