From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail.byosoft.com.cn (mail.byosoft.com.cn [58.240.74.242]) by mx.groups.io with SMTP id smtpd.web12.6282.1611625835451992522 for ; Mon, 25 Jan 2021 17:50:37 -0800 Authentication-Results: mx.groups.io; dkim=missing; spf=none, err=permanent DNS error (domain: byosoft.com.cn, ip: 58.240.74.242, mailfrom: gaoliming@byosoft.com.cn) Received: from DESKTOPS6D0PVI ([58.246.60.130]) (envelope-sender ) by 192.168.6.13 with ESMTP for ; Tue, 26 Jan 2021 09:50:30 +0800 X-WM-Sender: gaoliming@byosoft.com.cn X-WM-AuthFlag: YES X-WM-AuthUser: gaoliming@byosoft.com.cn From: "gaoliming" To: , Cc: "'Dandan Bi'" , "'Eric Dong'" , "'Nickle Wang'" , "'Michael D Kinney'" References: <20210122031525.30972-1-abner.chang@hpe.com> In-Reply-To: <20210122031525.30972-1-abner.chang@hpe.com> Subject: =?UTF-8?B?5Zue5aSNOiBbZWRrMi1kZXZlbF0gW1BBVENIXSBNZGVNb2R1bGVQa2cvTGlicmFyeTogQWRkIEhpaUdldFN0cmluZ0V4IHRvIFVlZmlIaWlMaWIgZm9yIEVESzIgUmVkZmlzaA==?= Date: Tue, 26 Jan 2021 09:50:31 +0800 Message-ID: <010101d6f385$a15c29a0$e4147ce0$@byosoft.com.cn> MIME-Version: 1.0 X-Mailer: Microsoft Outlook 16.0 Thread-Index: AQHT4eaQhHYErCem54zJIDUydZmqNao/RQBQ Content-Type: text/plain; charset="gb2312" Content-Transfer-Encoding: quoted-printable Content-Language: zh-cn Abner: I agree this request is reasonable. New API name HiiGetStringEx is OK to me. I have some comments on the detail of this API.=20 1. Please describe the behavior in function header when TryBestLanguage is FASLE. 2. When TryBestLanguage is FALSE, the input Language can't be NULL. If Language is NULL, the function should return the invalid parameter.=20 Thanks Liming > -----=D3=CA=BC=FE=D4=AD=BC=FE----- > =B7=A2=BC=FE=C8=CB: bounce+27952+70661+4905953+8761045@groups.io > =B4=FA=B1=ED Abner Chang > =B7=A2=CB=CD=CA=B1=BC=E4: 2021=C4=EA1=D4=C222=C8=D5 11:15 > =CA=D5=BC=FE=C8=CB: devel@edk2.groups.io > =B3=AD=CB=CD: Dandan Bi ; Eric Dong ; > Nickle Wang > =D6=F7=CC=E2: [edk2-devel] [PATCH] MdeModulePkg/Library: Add HiiGetStrin= gEx to > UefiHiiLib for EDK2 Redfish >=20 > Add HiiGetStringEx and leveraged by HiiGetString function to support > getting string with the best language in optionally. This avoids the > string in x-uefi language is misled to the language defined by > "PlatformLang" or the "Supported Languages". This change is introduced > to support x-uefi keyword language for configuring BIOS setting. >=20 > Signed-off-by: Jiaxin Wu > Signed-off-by: Siyuan Fu > Signed-off-by: Fan Wang > Signed-off-by: Abner Chang > Cc: Dandan Bi > Cc: Eric Dong > Cc: Nickle Wang > --- > MdeModulePkg/Include/Library/HiiLib.h | 41 +++++++++++- > MdeModulePkg/Library/UefiHiiLib/HiiString.c | 73 ++++++++++++++++----- > 2 files changed, 96 insertions(+), 18 deletions(-) >=20 > diff --git a/MdeModulePkg/Include/Library/HiiLib.h > b/MdeModulePkg/Include/Library/HiiLib.h > index c475cb74a1..66c654dcd3 100644 > --- a/MdeModulePkg/Include/Library/HiiLib.h > +++ b/MdeModulePkg/Include/Library/HiiLib.h > @@ -1,7 +1,7 @@ > /** @file > Public include file for the HII Library >=20 > -Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
> +Copyright (c) 2007 - 2021, Intel Corporation. All rights reserved.
> SPDX-License-Identifier: BSD-2-Clause-Patent >=20 > **/ > @@ -152,8 +152,43 @@ HiiGetString ( > IN EFI_HII_HANDLE HiiHandle, > IN EFI_STRING_ID StringId, > IN CONST CHAR8 *Language OPTIONAL > - ) > -; > + ); > + > +/** > + Retrieves a string from a string package in a specific language. If the > language > + is not specified, then a string from a string package in the current platform > + language is retrieved. If the string can not be retrieved using the > specified > + language or the current platform language, then the string is retriev= ed > from > + the string package in the first language the string package supports. The > + returned string is allocated using AllocatePool(). The caller is responsible > + for freeing the allocated buffer using FreePool(). > + > + If HiiHandle is NULL, then ASSERT(). > + If StringId is 0, then ASSET. > + > + @param[in] HiiHandle A handle that was previously > registered in the HII Database. > + @param[in] StringId The identifier of the string to retriev= ed > from the string > + package associated with HiiHandle. > + @param[in] Language The language of the string to retrieve. > If this parameter > + is NULL, then the current platform > language is used. The > + format of Language must follow the > language format assumed > + the HII Database. > + @param[in] TryBestLanguage If TRUE, try to get the best matching > language from all > + supported languages. > + > + > + @retval NULL The string specified by StringId is not present in the > string package. > + @retval Other The string was returned. > + > +**/ > +EFI_STRING > +EFIAPI > +HiiGetStringEx ( > + IN EFI_HII_HANDLE HiiHandle, > + IN EFI_STRING_ID StringId, > + IN CONST CHAR8 *Language OPTIONAL, > + IN BOOLEAN TryBestLanguage > + ); >=20 > /** > Retrieves a string from a string package named by GUID, in the specified > language. > diff --git a/MdeModulePkg/Library/UefiHiiLib/HiiString.c > b/MdeModulePkg/Library/UefiHiiLib/HiiString.c > index 95229f8a8c..f3c52ace56 100644 > --- a/MdeModulePkg/Library/UefiHiiLib/HiiString.c > +++ b/MdeModulePkg/Library/UefiHiiLib/HiiString.c > @@ -1,7 +1,7 @@ > /** @file > HII Library implementation that uses DXE protocols and services. >=20 > - Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved. > + Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved. > SPDX-License-Identifier: BSD-2-Clause-Patent >=20 > **/ > @@ -220,6 +220,44 @@ HiiGetString ( > IN EFI_STRING_ID StringId, > IN CONST CHAR8 *Language OPTIONAL > ) > +{ > + return HiiGetStringEx (HiiHandle, StringId, Language, TRUE); > +} > + > +/** > + Retrieves a string from a string package in a specific language. If the > language > + is not specified, then a string from a string package in the current platform > + language is retrieved. If the string can not be retrieved using the > specified > + language or the current platform language, then the string is retriev= ed > from > + the string package in the first language the string package supports. The > + returned string is allocated using AllocatePool(). The caller is responsible > + for freeing the allocated buffer using FreePool(). > + > + If HiiHandle is NULL, then ASSERT(). > + If StringId is 0, then ASSET. > + > + @param[in] HiiHandle A handle that was previously > registered in the HII Database. > + @param[in] StringId The identifier of the string to retriev= ed > from the string > + package associated with HiiHandle. > + @param[in] Language The language of the string to retrieve. > If this parameter > + is NULL, then the current platform > language is used. The > + format of Language must follow the > language format assumed > + the HII Database. > + @param[in] TryBestLanguage If TRUE, try to get the best matching > language from all > + supported languages. > + > + @retval NULL The string specified by StringId is not present in the > string package. > + @retval Other The string was returned. > + > +**/ > +EFI_STRING > +EFIAPI > +HiiGetStringEx ( > + IN EFI_HII_HANDLE HiiHandle, > + IN EFI_STRING_ID StringId, > + IN CONST CHAR8 *Language OPTIONAL, > + IN BOOLEAN TryBestLanguage > + ) > { > EFI_STATUS Status; > UINTN StringSize; > @@ -261,21 +299,26 @@ HiiGetString ( > Language =3D ""; > } >=20 > - // > - // Get the best matching language from SupportedLanguages > - // > - BestLanguage =3D GetBestLanguage ( > - SupportedLanguages, > - FALSE, > // RFC 4646 mode > - Language, > // Highest priority > - PlatformLanguage !=3D NULL ? PlatformLanguage : "", > // Next highest priority > - SupportedLanguages, > // Lowest priority > - NULL > - ); > - if (BestLanguage =3D=3D NULL) { > - goto Error; > + if (TryBestLanguage) { > + // > + // Get the best matching language from SupportedLanguages > + // > + BestLanguage =3D GetBestLanguage ( > + SupportedLanguages, > + FALSE, > // RFC 4646 mode > + Language, > // Highest priority > + PlatformLanguage !=3D NULL ? PlatformLanguage : > "", // Next highest priority > + SupportedLanguages, > // Lowest priority > + NULL > + ); > + if (BestLanguage =3D=3D NULL) { > + goto Error; > + } > + } else { > + BestLanguage =3D (CHAR8 *) Language; > } >=20 > + > // > // Retrieve the size of the string in the string package for the > BestLanguage > // > @@ -337,7 +380,7 @@ Error: > if (PlatformLanguage !=3D NULL) { > FreePool (PlatformLanguage); > } > - if (BestLanguage !=3D NULL) { > + if (TryBestLanguage && BestLanguage !=3D NULL) { > FreePool (BestLanguage); > } >=20 > -- > 2.17.1 >=20 >=20 >=20 >=20 >=20