From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id E0BED82223 for ; Tue, 21 Feb 2017 03:36:09 -0800 (PST) Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 21 Feb 2017 03:36:09 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.35,189,1484035200"; d="scan'208";a="68323622" Received: from shwdeopenpsi014.ccr.corp.intel.com ([10.239.9.13]) by fmsmga006.fm.intel.com with ESMTP; 21 Feb 2017 03:36:08 -0800 From: Hao Wu To: edk2-devel@lists.01.org Cc: Hao Wu , Jiewen Yao , Liming Gao , Michael Kinney Date: Tue, 21 Feb 2017 19:35:32 +0800 Message-Id: <1487676934-12984-6-git-send-email-hao.a.wu@intel.com> X-Mailer: git-send-email 1.9.5.msysgit.0 In-Reply-To: <1487676934-12984-1-git-send-email-hao.a.wu@intel.com> References: <1487676934-12984-1-git-send-email-hao.a.wu@intel.com> Subject: [PATCH 5/7] MdeModulePkg/PrintDxe: Handle the deprecation of [A|U]ValueToString X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 21 Feb 2017 11:36:10 -0000 To handle the deprecation of PrintLib APIs UnicodeValueToString and AsciiValueToString by subsequent commits, the commit refines the logic for the implemetation of the UnicodeValueToString and AsciiValueToString services in EFI_PRINT2_PROTOCOL. When the macro DISABLE_NEW_DEPRECATED_INTERFACES is defined (indicating the deprecation of the PrintLib APIs), the above two services will ASSERT and will return zero to reflect not being supported. Cc: Jiewen Yao Cc: Liming Gao Cc: Michael Kinney Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Hao Wu --- MdeModulePkg/Universal/PrintDxe/Print.c | 92 +++++++++++++++++++- 1 file changed, 90 insertions(+), 2 deletions(-) diff --git a/MdeModulePkg/Universal/PrintDxe/Print.c b/MdeModulePkg/Universal/PrintDxe/Print.c index 85bc724..8029836 100644 --- a/MdeModulePkg/Universal/PrintDxe/Print.c +++ b/MdeModulePkg/Universal/PrintDxe/Print.c @@ -20,6 +20,94 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include #include +/** + Implementaion of the UnicodeValueToString service in EFI_PRINT2_PROTOCOL. + + If the macro DISABLE_NEW_DEPRECATED_INTERFACES is defined, then ASSERT(). + + @param Buffer The pointer to the output buffer for the produced + Null-terminated Unicode string. + @param Flags The bitmask of flags that specify left justification, zero + pad, and commas. + @param Value The 64-bit signed value to convert to a string. + @param Width The maximum number of Unicode characters to place in Buffer, + not including the Null-terminator. + + @return If the macro DISABLE_NEW_DEPRECATED_INTERFACES is defined, return 0. + Otherwise, return the number of Unicode characters in Buffer not + including the Null-terminator. + +**/ +UINTN +EFIAPI +PrintDxeUnicodeValueToString ( + IN OUT CHAR16 *Buffer, + IN UINTN Flags, + IN INT64 Value, + IN UINTN Width + ) +{ +#ifdef DISABLE_NEW_DEPRECATED_INTERFACES + // + // If the macro DISABLE_NEW_DEPRECATED_INTERFACES is defined, then the + // PrintLib API UnicodeValueToString is already deprecated. + // In this case, ASSERT will be triggered and zero will be returned for the + // implementation of the UnicodeValueToString service in EFI_PRINT2_PROTOCOL + // to indicate that the service is no longer supported. + // + DEBUG ((DEBUG_ERROR, "PrintDxe: The UnicodeValueToString service in EFI_PRINT2_PROTOCOL is no longer supported for security reason.\n")); + DEBUG ((DEBUG_ERROR, "PrintDxe: Please consider using the UnicodeValueToStringS service in EFI_PRINT2S_PROTOCOL.\n")); + ASSERT (FALSE); + return 0; +#else + return UnicodeValueToString (Buffer, Flags, Value, Width); +#endif +} + +/** + Implementaion of the AsciiValueToString service in EFI_PRINT2_PROTOCOL. + + If the macro DISABLE_NEW_DEPRECATED_INTERFACES is defined, then ASSERT(). + + @param Buffer A pointer to the output buffer for the produced + Null-terminated ASCII string. + @param Flags The bitmask of flags that specify left justification, zero + pad, and commas. + @param Value The 64-bit signed value to convert to a string. + @param Width The maximum number of ASCII characters to place in Buffer, + not including the Null-terminator. + + @return If the macro DISABLE_NEW_DEPRECATED_INTERFACES is defined, return 0. + Otherwise, return the number of ASCII characters in Buffer not + including the Null-terminator. + +**/ +UINTN +EFIAPI +PrintDxeAsciiValueToString ( + OUT CHAR8 *Buffer, + IN UINTN Flags, + IN INT64 Value, + IN UINTN Width + ) +{ +#ifdef DISABLE_NEW_DEPRECATED_INTERFACES + // + // If the macro DISABLE_NEW_DEPRECATED_INTERFACES is defined, then the + // PrintLib API AsciiValueToString is already deprecated. + // In this case, ASSERT will be triggered and zero will be returned for the + // implementation of the AsciiValueToString service in EFI_PRINT2_PROTOCOL + // to indicate that the service is no longer supported. + // + DEBUG ((DEBUG_ERROR, "PrintDxe: The AsciiValueToString service in EFI_PRINT2_PROTOCOL is no longer supported for security reason.\n")); + DEBUG ((DEBUG_ERROR, "PrintDxe: Please consider using the AsciiValueToStringS service in EFI_PRINT2S_PROTOCOL.\n")); + ASSERT (FALSE); + return 0; +#else + return AsciiValueToString (Buffer, Flags, Value, Width); +#endif +} + EFI_HANDLE mPrintThunkHandle = NULL; CONST EFI_PRINT2_PROTOCOL mPrint2Protocol = { @@ -27,12 +115,12 @@ CONST EFI_PRINT2_PROTOCOL mPrint2Protocol = { UnicodeSPrint, UnicodeBSPrintAsciiFormat, UnicodeSPrintAsciiFormat, - UnicodeValueToString, + PrintDxeUnicodeValueToString, AsciiBSPrint, AsciiSPrint, AsciiBSPrintUnicodeFormat, AsciiSPrintUnicodeFormat, - AsciiValueToString + PrintDxeAsciiValueToString }; CONST EFI_PRINT2S_PROTOCOL mPrint2SProtocol = { -- 1.9.5.msysgit.0