--- /dev/null
+#/** @file\r
+# Library instance that implements Print Library class based on protocol\r
+# gEfiPrint2ProtocolGuid.\r
+#\r
+# Copyright (c) 2009, Intel Corporation.\r
+#\r
+# All rights reserved. This program and the accompanying materials\r
+# are licensed and made available under the terms and conditions of the BSD License\r
+# which accompanies this distribution. The full text of the license may be found at\r
+# http://opensource.org/licenses/bsd-license.php\r
+# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+#\r
+#\r
+#**/\r
+\r
+[Defines]\r
+ INF_VERSION = 0x00010005\r
+ BASE_NAME = DxePrintLibPrint2Protocol\r
+ FILE_GUID = 55D460DB-8FEA-415a-B95D-70145AE0675C\r
+ MODULE_TYPE = DXE_DRIVER\r
+ VERSION_STRING = 1.0\r
+ LIBRARY_CLASS = PrintLib|DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER\r
+\r
+ CONSTRUCTOR = PrintLibConstructor\r
+\r
+#\r
+# The following information is for reference only and not required by the build tools.\r
+#\r
+# VALID_ARCHITECTURES = IA32 X64 IPF EBC\r
+#\r
+\r
+[Sources.common]\r
+ PrintLib.c\r
+\r
+\r
+[Packages]\r
+ MdePkg/MdePkg.dec\r
+ MdeModulePkg/MdeModulePkg.dec\r
+\r
+\r
+[LibraryClasses]\r
+ UefiBootServicesTableLib\r
+ DebugLib\r
+\r
+[Protocols]\r
+ gEfiPrint2ProtocolGuid ## CONSUMES\r
+\r
+[Depex]\r
+ gEfiPrint2ProtocolGuid\r
--- /dev/null
+/** @file\r
+ Instance of Print Library based on gEfiPrint2ProtocolGuid.\r
+\r
+ Implement the print library instance by wrap the interface \r
+ provided in the Print2 protocol. This protocol is defined as the internal\r
+ protocol related to this implementation, not in the public spec. So, this \r
+ library instance is only for this code base.\r
+\r
+Copyright (c) 2009, Intel Corporation\r
+All rights reserved. This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution. The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#include <Uefi.h>\r
+#include <Protocol/Print2.h>\r
+#include <Library/UefiBootServicesTableLib.h>\r
+#include <Library/DebugLib.h>\r
+\r
+EFI_PRINT2_PROTOCOL *mPrint2Protocol = NULL;\r
+\r
+/**\r
+ The constructor function caches the pointer to Print2 protocol.\r
+ \r
+ The constructor function locates Print2 protocol from protocol database.\r
+ It will ASSERT() if that operation fails and it will always return EFI_SUCCESS. \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 constructor always returns EFI_SUCCESS.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PrintLibConstructor (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+\r
+ Status = gBS->LocateProtocol (\r
+ &gEfiPrint2ProtocolGuid,\r
+ NULL,\r
+ (VOID**) &mPrint2Protocol\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+ ASSERT (mPrint2Protocol != NULL);\r
+\r
+ return Status;\r
+}\r
+\r
+\r
+/**\r
+ Produces a Null-terminated Unicode string in an output buffer based on \r
+ a Null-terminated Unicode format string and a VA_LIST argument list\r
+ \r
+ Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
+ and BufferSize. \r
+ The Unicode string is produced by parsing the format string specified by FormatString. \r
+ Arguments are pulled from the variable argument list specified by Marker based on the \r
+ contents of the format string. \r
+ The number of Unicode characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+ If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
+ If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
+ If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
+ PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ ASSERT().\r
+ If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
+ contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ Null-terminator, then ASSERT().\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ Unicode string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString Null-terminated Unicode format string.\r
+ @param Marker VA_LIST marker for the variable argument list.\r
+ \r
+ @return The number of Unicode characters in the produced output buffer not including the\r
+ Null-terminator.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+UnicodeVSPrint (\r
+ OUT CHAR16 *StartOfBuffer,\r
+ IN UINTN BufferSize,\r
+ IN CONST CHAR16 *FormatString,\r
+ IN VA_LIST Marker\r
+ )\r
+{\r
+ return mPrint2Protocol->UnicodeVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
+}\r
+\r
+/**\r
+ Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated \r
+ Unicode format string and variable argument list.\r
+ \r
+ Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The Unicode string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list based on the contents of the format string.\r
+ The number of Unicode characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+ If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
+ If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
+ If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
+ PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ ASSERT().\r
+ If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
+ contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ Null-terminator, then ASSERT().\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ Unicode string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString Null-terminated Unicode format string.\r
+ @param ... Variable argument list whose contents are accessed based on the \r
+ format string specified by FormatString.\r
+\r
+ @return The number of Unicode characters in the produced output buffer not including the\r
+ Null-terminator.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+UnicodeSPrint (\r
+ OUT CHAR16 *StartOfBuffer,\r
+ IN UINTN BufferSize,\r
+ IN CONST CHAR16 *FormatString,\r
+ ...\r
+ )\r
+{\r
+ VA_LIST Marker;\r
+\r
+ VA_START (Marker, FormatString);\r
+ return UnicodeVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
+}\r
+\r
+/**\r
+ Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
+ ASCII format string and a VA_LIST argument list\r
+ \r
+ Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The Unicode string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list specified by Marker based on the \r
+ contents of the format string.\r
+ The number of Unicode characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+ If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
+ If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
+ If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
+ ASSERT().\r
+ If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
+ contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ Null-terminator, then ASSERT().\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ Unicode string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString Null-terminated Unicode format string.\r
+ @param Marker VA_LIST marker for the variable argument list.\r
+ \r
+ @return The number of Unicode characters in the produced output buffer not including the\r
+ Null-terminator.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+UnicodeVSPrintAsciiFormat (\r
+ OUT CHAR16 *StartOfBuffer,\r
+ IN UINTN BufferSize,\r
+ IN CONST CHAR8 *FormatString,\r
+ IN VA_LIST Marker\r
+ )\r
+{\r
+ return mPrint2Protocol->UnicodeSPrintAsciiFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
+}\r
+\r
+/**\r
+ Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated \r
+ ASCII format string and variable argument list.\r
+ \r
+ Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The Unicode string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list based on the contents of the \r
+ format string.\r
+ The number of Unicode characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+ If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
+ If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
+ If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
+ ASSERT().\r
+ If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
+ contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ Null-terminator, then ASSERT().\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ Unicode string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString Null-terminated Unicode format string.\r
+ @param ... Variable argument list whose contents are accessed based on the \r
+ format string specified by FormatString.\r
+ \r
+ @return The number of Unicode characters in the produced output buffer not including the\r
+ Null-terminator.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+UnicodeSPrintAsciiFormat (\r
+ OUT CHAR16 *StartOfBuffer,\r
+ IN UINTN BufferSize,\r
+ IN CONST CHAR8 *FormatString,\r
+ ...\r
+ )\r
+{\r
+ VA_LIST Marker;\r
+\r
+ VA_START (Marker, FormatString);\r
+ return UnicodeVSPrintAsciiFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
+}\r
+\r
+/**\r
+ Converts a decimal value to a Null-terminated Unicode string.\r
+ \r
+ Converts the decimal number specified by Value to a Null-terminated Unicode \r
+ string specified by Buffer containing at most Width characters. No padding of spaces \r
+ is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
+ The number of Unicode characters in Buffer is returned not including the Null-terminator.\r
+ If the conversion contains more than Width characters, then only the first\r
+ Width characters are returned, and the total number of characters \r
+ required to perform the conversion is returned.\r
+ Additional conversion parameters are specified in Flags. \r
+ \r
+ The Flags bit LEFT_JUSTIFY is always ignored.\r
+ All conversions are left justified in Buffer.\r
+ If Width is 0, PREFIX_ZERO is ignored in Flags.\r
+ If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas\r
+ are inserted every 3rd digit starting from the right.\r
+ If HEX_RADIX is set in Flags, then the output buffer will be \r
+ formatted in hexadecimal format.\r
+ If Value is < 0 and HEX_RADIX is not set in Flags, then the fist character in Buffer is a '-'.\r
+ If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, \r
+ then Buffer is padded with '0' characters so the combination of the optional '-' \r
+ sign character, '0' characters, digit characters for Value, and the Null-terminator\r
+ add up to Width characters.\r
+ If both COMMA_TYPE and HEX_RADIX are set in Flags, then ASSERT().\r
+ If Buffer is NULL, then ASSERT().\r
+ If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
+ If unsupported bits are set in Flags, then ASSERT().\r
+ If both COMMA_TYPE and HEX_RADIX are set in Flags, then ASSERT().\r
+ If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
+\r
+ @param Buffer Pointer to the output buffer for the produced Null-terminated\r
+ Unicode string.\r
+ @param Flags The bitmask of flags that specify left justification, zero pad, and commas.\r
+ @param Value The 64-bit signed value to convert to a string.\r
+ @param Width The maximum number of Unicode characters to place in Buffer, not including\r
+ the Null-terminator.\r
+ \r
+ @return The number of Unicode characters in Buffer not including the Null-terminator.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+UnicodeValueToString (\r
+ IN OUT CHAR16 *Buffer,\r
+ IN UINTN Flags,\r
+ IN INT64 Value,\r
+ IN UINTN Width\r
+ )\r
+{\r
+ return mPrint2Protocol->UnicodeValueToString (Buffer, Flags, Value, Width);\r
+}\r
+\r
+/**\r
+ Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
+ ASCII format string and a VA_LIST argument list.\r
+ \r
+ Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The ASCII string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list specified by Marker based on \r
+ the contents of the format string.\r
+ The number of ASCII characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
+ If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
+ ASSERT().\r
+ If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
+ contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
+ Null-terminator, then ASSERT().\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ ASCII string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString Null-terminated Unicode format string.\r
+ @param Marker VA_LIST marker for the variable argument list.\r
+ \r
+ @return The number of ASCII characters in the produced output buffer not including the\r
+ Null-terminator.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+AsciiVSPrint (\r
+ OUT CHAR8 *StartOfBuffer,\r
+ IN UINTN BufferSize,\r
+ IN CONST CHAR8 *FormatString,\r
+ IN VA_LIST Marker\r
+ )\r
+{\r
+ return mPrint2Protocol->AsciiVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
+}\r
+\r
+/**\r
+ Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
+ ASCII format string and variable argument list.\r
+ \r
+ Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The ASCII string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list based on the contents of the \r
+ format string.\r
+ The number of ASCII characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
+ If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
+ ASSERT().\r
+ If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
+ contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
+ Null-terminator, then ASSERT().\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ ASCII string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString Null-terminated Unicode format string.\r
+ @param ... Variable argument list whose contents are accessed based on the \r
+ format string specified by FormatString.\r
+\r
+ @return The number of ASCII characters in the produced output buffer not including the\r
+ Null-terminator.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+AsciiSPrint (\r
+ OUT CHAR8 *StartOfBuffer,\r
+ IN UINTN BufferSize,\r
+ IN CONST CHAR8 *FormatString,\r
+ ...\r
+ )\r
+{\r
+ VA_LIST Marker;\r
+\r
+ VA_START (Marker, FormatString);\r
+ return AsciiVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
+}\r
+\r
+/**\r
+ Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
+ ASCII format string and a VA_LIST argument list.\r
+ \r
+ Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The ASCII string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list specified by Marker based on \r
+ the contents of the format string.\r
+ The number of ASCII characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
+ If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ ASSERT().\r
+ If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
+ contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
+ Null-terminator, then ASSERT().\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ ASCII string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString Null-terminated Unicode format string.\r
+ @param Marker VA_LIST marker for the variable argument list.\r
+ \r
+ @return The number of ASCII characters in the produced output buffer not including the\r
+ Null-terminator.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+AsciiVSPrintUnicodeFormat (\r
+ OUT CHAR8 *StartOfBuffer,\r
+ IN UINTN BufferSize,\r
+ IN CONST CHAR16 *FormatString,\r
+ IN VA_LIST Marker\r
+ )\r
+{\r
+ return mPrint2Protocol->AsciiVSPrintUnicodeFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
+}\r
+\r
+/**\r
+ Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
+ ASCII format string and variable argument list.\r
+ \r
+ Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
+ and BufferSize.\r
+ The ASCII string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list based on the contents of the \r
+ format string.\r
+ The number of ASCII characters in the produced output buffer is returned not including\r
+ the Null-terminator.\r
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
+ If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+ PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ ASSERT().\r
+ If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
+ contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
+ Null-terminator, then ASSERT().\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ ASCII string.\r
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+ @param FormatString Null-terminated Unicode format string.\r
+ @param ... Variable argument list whose contents are accessed based on the \r
+ format string specified by FormatString.\r
+\r
+ @return The number of ASCII characters in the produced output buffer not including the\r
+ Null-terminator.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+AsciiSPrintUnicodeFormat (\r
+ OUT CHAR8 *StartOfBuffer,\r
+ IN UINTN BufferSize,\r
+ IN CONST CHAR16 *FormatString,\r
+ ...\r
+ )\r
+{\r
+ VA_LIST Marker;\r
+\r
+ VA_START (Marker, FormatString);\r
+ return AsciiVSPrintUnicodeFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
+}\r
+\r
+\r
+/**\r
+ Converts a decimal value to a Null-terminated ASCII string.\r
+ \r
+ Converts the decimal number specified by Value to a Null-terminated ASCII string \r
+ specified by Buffer containing at most Width characters. No padding of spaces \r
+ is ever performed.\r
+ If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
+ The number of ASCII characters in Buffer is returned not including the Null-terminator.\r
+ If the conversion contains more than Width characters, then only the first Width\r
+ characters are returned, and the total number of characters required to perform\r
+ the conversion is returned.\r
+ Additional conversion parameters are specified in Flags. \r
+ The Flags bit LEFT_JUSTIFY is always ignored.\r
+ All conversions are left justified in Buffer.\r
+ If Width is 0, PREFIX_ZERO is ignored in Flags.\r
+ If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas\r
+ are inserted every 3rd digit starting from the right.\r
+ If HEX_RADIX is set in Flags, then the output buffer will be \r
+ formatted in hexadecimal format.\r
+ If Value is < 0 and HEX_RADIX is not set in Flags, then the fist character in Buffer is a '-'.\r
+ If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, \r
+ then Buffer is padded with '0' characters so the combination of the optional '-' \r
+ sign character, '0' characters, digit characters for Value, and the Null-terminator\r
+ add up to Width characters.\r
+ \r
+ If Buffer is NULL, then ASSERT().\r
+ If unsupported bits are set in Flags, then ASSERT().\r
+ If both COMMA_TYPE and HEX_RADIX are set in Flags, then ASSERT().\r
+ If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
+\r
+ @param Buffer Pointer to the output buffer for the produced Null-terminated\r
+ ASCII string.\r
+ @param Flags The bitmask of flags that specify left justification, zero pad, and commas.\r
+ @param Value The 64-bit signed value to convert to a string.\r
+ @param Width The maximum number of ASCII characters to place in Buffer, not including\r
+ the Null-terminator.\r
+ \r
+ @return The number of ASCII characters in Buffer not including the Null-terminator.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+AsciiValueToString (\r
+ OUT CHAR8 *Buffer,\r
+ IN UINTN Flags,\r
+ IN INT64 Value,\r
+ IN UINTN Width\r
+ )\r
+{\r
+ return mPrint2Protocol->AsciiValueToString (Buffer, Flags, Value, Width);\r
+}\r
+++ /dev/null
-#/** @file\r
-# Instance of Print Library based on EFI_PRINT2_PROTOCOL.\r
-#\r
-# Copyright (c) 2006 - 2008, Intel Corporation.\r
-#\r
-# All rights reserved. This program and the accompanying materials\r
-# are licensed and made available under the terms and conditions of the BSD License\r
-# which accompanies this distribution. The full text of the license may be found at\r
-# http://opensource.org/licenses/bsd-license.php\r
-# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-#\r
-#\r
-#**/\r
-\r
-[Defines]\r
- INF_VERSION = 0x00010005\r
- BASE_NAME = EdkDxePrintLib\r
- FILE_GUID = 50bcb105-6634-441d-b403-659110a03ad2\r
- MODULE_TYPE = DXE_DRIVER\r
- VERSION_STRING = 1.0\r
- LIBRARY_CLASS = PrintLib|DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER\r
-\r
-#\r
-# The following information is for reference only and not required by the build tools.\r
-#\r
-# VALID_ARCHITECTURES = IA32 X64 IPF EBC\r
-#\r
-\r
-[Sources.common]\r
- PrintLib.c\r
-\r
-\r
-[Packages]\r
- MdePkg/MdePkg.dec\r
- MdeModulePkg/MdeModulePkg.dec\r
-\r
-\r
-[LibraryClasses]\r
- UefiBootServicesTableLib\r
-\r
-\r
-[Protocols]\r
- gEfiPrint2ProtocolGuid ## CONSUMES\r
-\r
+++ /dev/null
-/** @file\r
- Instance of Print Library based on EFI_PRINT2_PROTOCOL.\r
-\r
- Implement the print library instance by wrap the interface \r
- provided in the Print protocol. This protocol is defined as the internal\r
- protocol related to this implementation, not in the public spec. So, this \r
- library instance is only for this code base.\r
-\r
-Copyright (c) 2006 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
-**/\r
-\r
-#include <Uefi.h>\r
-\r
-#include <Protocol/Print2.h>\r
-\r
-#include <Library/PrintLib.h>\r
-#include <Library/UefiBootServicesTableLib.h>\r
-\r
-EFI_PRINT2_PROTOCOL *gPrintProtocol = NULL;\r
-\r
-/**\r
- Internal function to locate the EFI_PRINT2_PROTOCOL.\r
-\r
- @retval EFI_SUCCESS EFI_PRINT2_PROTOCOL is successfuly located.\r
- @retval EFI_NOT_FOUND EFI_PRINT2_PROTOCOL cannot be found.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-InternalLocatePrintProtocol (\r
- VOID\r
- )\r
-{\r
- EFI_STATUS Status;\r
-\r
- if (gPrintProtocol == NULL) {\r
- Status = gBS->LocateProtocol (\r
- &gEfiPrint2ProtocolGuid,\r
- NULL,\r
- (VOID **)&gPrintProtocol\r
- );\r
- if (EFI_ERROR (Status)) {\r
- gPrintProtocol = NULL;\r
- return Status;\r
- }\r
- }\r
- \r
- return EFI_SUCCESS;\r
-}\r
-\r
-/**\r
- Produces a Null-terminated Unicode string in an output buffer based on \r
- a Null-terminated Unicode format string and a VA_LIST argument list\r
- \r
- Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
- and BufferSize. \r
- The Unicode string is produced by parsing the format string specified by FormatString. \r
- Arguments are pulled from the variable argument list specified by Marker based on the \r
- contents of the format string. \r
- The number of Unicode characters in the produced output buffer is returned not including\r
- the Null-terminator.\r
- If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
-\r
- If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
- If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
- If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
- If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
- PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
- contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
- Null-terminator, then ASSERT().\r
-\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
- Unicode string.\r
- @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
- @param Marker VA_LIST marker for the variable argument list.\r
- \r
- @return The number of Unicode characters in the produced output buffer not including the\r
- Null-terminator.\r
-\r
-**/\r
-UINTN\r
-EFIAPI\r
-UnicodeVSPrint (\r
- OUT CHAR16 *StartOfBuffer,\r
- IN UINTN BufferSize,\r
- IN CONST CHAR16 *FormatString,\r
- IN VA_LIST Marker\r
- )\r
-{\r
- if (InternalLocatePrintProtocol() != EFI_SUCCESS) {\r
- return 0;\r
- }\r
-\r
- return gPrintProtocol->VSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
-}\r
-\r
-/**\r
- Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated \r
- Unicode format string and variable argument list.\r
- \r
- Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
- and BufferSize.\r
- The Unicode string is produced by parsing the format string specified by FormatString.\r
- Arguments are pulled from the variable argument list based on the contents of the format string.\r
- The number of Unicode characters in the produced output buffer is returned not including\r
- the Null-terminator.\r
- If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
-\r
- If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
- If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
- If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
- If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
- PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
- contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
- Null-terminator, then ASSERT().\r
-\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
- Unicode string.\r
- @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
- @param ... Variable argument list whose contents are accessed based on the \r
- format string specified by FormatString.\r
-\r
- @return The number of Unicode characters in the produced output buffer not including the\r
- Null-terminator.\r
-\r
-**/\r
-UINTN\r
-EFIAPI\r
-UnicodeSPrint (\r
- OUT CHAR16 *StartOfBuffer,\r
- IN UINTN BufferSize,\r
- IN CONST CHAR16 *FormatString,\r
- ...\r
- )\r
-{\r
- VA_LIST Marker;\r
-\r
- VA_START (Marker, FormatString);\r
- return UnicodeVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
-}\r
-\r
-/**\r
- Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
- ASCII format string and a VA_LIST argument list\r
- \r
- Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
- and BufferSize.\r
- The Unicode string is produced by parsing the format string specified by FormatString.\r
- Arguments are pulled from the variable argument list specified by Marker based on the \r
- contents of the format string.\r
- The number of Unicode characters in the produced output buffer is returned not including\r
- the Null-terminator.\r
- If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
-\r
- If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
- If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
- If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
- contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
- Null-terminator, then ASSERT().\r
-\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
- Unicode string.\r
- @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
- @param Marker VA_LIST marker for the variable argument list.\r
- \r
- @return The number of Unicode characters in the produced output buffer not including the\r
- Null-terminator.\r
-\r
-**/\r
-UINTN\r
-EFIAPI\r
-UnicodeVSPrintAsciiFormat (\r
- OUT CHAR16 *StartOfBuffer,\r
- IN UINTN BufferSize,\r
- IN CONST CHAR8 *FormatString,\r
- IN VA_LIST Marker\r
- )\r
-{\r
- if (InternalLocatePrintProtocol() != EFI_SUCCESS) {\r
- return 0;\r
- }\r
-\r
- return gPrintProtocol->UniVSPrintAscii (StartOfBuffer, BufferSize, FormatString, Marker);\r
-}\r
-\r
-/**\r
- Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated \r
- ASCII format string and variable argument list.\r
- \r
- Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
- and BufferSize.\r
- The Unicode string is produced by parsing the format string specified by FormatString.\r
- Arguments are pulled from the variable argument list based on the contents of the \r
- format string.\r
- The number of Unicode characters in the produced output buffer is returned not including\r
- the Null-terminator.\r
- If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
-\r
- If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
- If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
- If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
- contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
- Null-terminator, then ASSERT().\r
-\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
- Unicode string.\r
- @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
- @param ... Variable argument list whose contents are accessed based on the \r
- format string specified by FormatString.\r
- \r
- @return The number of Unicode characters in the produced output buffer not including the\r
- Null-terminator.\r
-\r
-**/\r
-UINTN\r
-EFIAPI\r
-UnicodeSPrintAsciiFormat (\r
- OUT CHAR16 *StartOfBuffer,\r
- IN UINTN BufferSize,\r
- IN CONST CHAR8 *FormatString,\r
- ...\r
- )\r
-{\r
- VA_LIST Marker;\r
-\r
- VA_START (Marker, FormatString);\r
- return UnicodeVSPrintAsciiFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
-}\r
-\r
-/**\r
- Converts a decimal value to a Null-terminated Unicode string.\r
- \r
- Converts the decimal number specified by Value to a Null-terminated Unicode \r
- string specified by Buffer containing at most Width characters. No padding of spaces \r
- is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
- The number of Unicode characters in Buffer is returned not including the Null-terminator.\r
- If the conversion contains more than Width characters, then only the first\r
- Width characters are returned, and the total number of characters \r
- required to perform the conversion is returned.\r
- Additional conversion parameters are specified in Flags. \r
- \r
- The Flags bit LEFT_JUSTIFY is always ignored.\r
- All conversions are left justified in Buffer.\r
- If Width is 0, PREFIX_ZERO is ignored in Flags.\r
- If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas\r
- are inserted every 3rd digit starting from the right.\r
- If HEX_RADIX is set in Flags, then the output buffer will be \r
- formatted in hexadecimal format.\r
- If Value is < 0 and HEX_RADIX is not set in Flags, then the fist character in Buffer is a '-'.\r
- If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, \r
- then Buffer is padded with '0' characters so the combination of the optional '-' \r
- sign character, '0' characters, digit characters for Value, and the Null-terminator\r
- add up to Width characters.\r
- If both COMMA_TYPE and HEX_RADIX are set in Flags, then ASSERT().\r
- If Buffer is NULL, then ASSERT().\r
- If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
- If unsupported bits are set in Flags, then ASSERT().\r
- If both COMMA_TYPE and HEX_RADIX are set in Flags, then ASSERT().\r
- If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
-\r
- @param Buffer Pointer to the output buffer for the produced Null-terminated\r
- Unicode string.\r
- @param Flags The bitmask of flags that specify left justification, zero pad, and commas.\r
- @param Value The 64-bit signed value to convert to a string.\r
- @param Width The maximum number of Unicode characters to place in Buffer, not including\r
- the Null-terminator.\r
- \r
- @return The number of Unicode characters in Buffer not including the Null-terminator.\r
-\r
-**/\r
-UINTN\r
-EFIAPI\r
-UnicodeValueToString (\r
- IN OUT CHAR16 *Buffer,\r
- IN UINTN Flags,\r
- IN INT64 Value,\r
- IN UINTN Width\r
- )\r
-{\r
- if (InternalLocatePrintProtocol() != EFI_SUCCESS) {\r
- return 0;\r
- }\r
-\r
- return gPrintProtocol->UniValueToString (Buffer, Flags, Value, Width);\r
-}\r
-\r
-/**\r
- Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
- ASCII format string and a VA_LIST argument list.\r
- \r
- Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
- and BufferSize.\r
- The ASCII string is produced by parsing the format string specified by FormatString.\r
- Arguments are pulled from the variable argument list specified by Marker based on \r
- the contents of the format string.\r
- The number of ASCII characters in the produced output buffer is returned not including\r
- the Null-terminator.\r
- If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
-\r
- If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
- If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
- contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
- Null-terminator, then ASSERT().\r
-\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
- ASCII string.\r
- @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
- @param Marker VA_LIST marker for the variable argument list.\r
- \r
- @return The number of ASCII characters in the produced output buffer not including the\r
- Null-terminator.\r
-\r
-**/\r
-UINTN\r
-EFIAPI\r
-AsciiVSPrint (\r
- OUT CHAR8 *StartOfBuffer,\r
- IN UINTN BufferSize,\r
- IN CONST CHAR8 *FormatString,\r
- IN VA_LIST Marker\r
- )\r
-{\r
- if (InternalLocatePrintProtocol() != EFI_SUCCESS) {\r
- return 0;\r
- }\r
-\r
- return gPrintProtocol->AsciiVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
-}\r
-\r
-/**\r
- Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
- ASCII format string and variable argument list.\r
- \r
- Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
- and BufferSize.\r
- The ASCII string is produced by parsing the format string specified by FormatString.\r
- Arguments are pulled from the variable argument list based on the contents of the \r
- format string.\r
- The number of ASCII characters in the produced output buffer is returned not including\r
- the Null-terminator.\r
- If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
-\r
- If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
- If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
- contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
- Null-terminator, then ASSERT().\r
-\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
- ASCII string.\r
- @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
- @param ... Variable argument list whose contents are accessed based on the \r
- format string specified by FormatString.\r
-\r
- @return The number of ASCII characters in the produced output buffer not including the\r
- Null-terminator.\r
-\r
-**/\r
-UINTN\r
-EFIAPI\r
-AsciiSPrint (\r
- OUT CHAR8 *StartOfBuffer,\r
- IN UINTN BufferSize,\r
- IN CONST CHAR8 *FormatString,\r
- ...\r
- )\r
-{\r
- VA_LIST Marker;\r
-\r
- VA_START (Marker, FormatString);\r
- return AsciiVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
-}\r
-\r
-/**\r
- Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
- ASCII format string and a VA_LIST argument list.\r
- \r
- Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
- and BufferSize.\r
- The ASCII string is produced by parsing the format string specified by FormatString.\r
- Arguments are pulled from the variable argument list specified by Marker based on \r
- the contents of the format string.\r
- The number of ASCII characters in the produced output buffer is returned not including\r
- the Null-terminator.\r
- If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
-\r
- If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
- If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
- If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
- PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
- contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
- Null-terminator, then ASSERT().\r
-\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
- ASCII string.\r
- @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
- @param Marker VA_LIST marker for the variable argument list.\r
- \r
- @return The number of ASCII characters in the produced output buffer not including the\r
- Null-terminator.\r
-\r
-**/\r
-UINTN\r
-EFIAPI\r
-AsciiVSPrintUnicodeFormat (\r
- OUT CHAR8 *StartOfBuffer,\r
- IN UINTN BufferSize,\r
- IN CONST CHAR16 *FormatString,\r
- IN VA_LIST Marker\r
- )\r
-{\r
- if (InternalLocatePrintProtocol() != EFI_SUCCESS) {\r
- return 0;\r
- }\r
-\r
- return gPrintProtocol->AsciiVSPrintUni (StartOfBuffer, BufferSize, FormatString, Marker);\r
-}\r
-\r
-/**\r
- Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
- ASCII format string and variable argument list.\r
- \r
- Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
- and BufferSize.\r
- The ASCII string is produced by parsing the format string specified by FormatString.\r
- Arguments are pulled from the variable argument list based on the contents of the \r
- format string.\r
- The number of ASCII characters in the produced output buffer is returned not including\r
- the Null-terminator.\r
- If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
-\r
- If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
- If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
- If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
- PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
- contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
- Null-terminator, then ASSERT().\r
-\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
- ASCII string.\r
- @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
- @param ... Variable argument list whose contents are accessed based on the \r
- format string specified by FormatString.\r
-\r
- @return The number of ASCII characters in the produced output buffer not including the\r
- Null-terminator.\r
-\r
-**/\r
-UINTN\r
-EFIAPI\r
-AsciiSPrintUnicodeFormat (\r
- OUT CHAR8 *StartOfBuffer,\r
- IN UINTN BufferSize,\r
- IN CONST CHAR16 *FormatString,\r
- ...\r
- )\r
-{\r
- VA_LIST Marker;\r
-\r
- VA_START (Marker, FormatString);\r
- return AsciiVSPrintUnicodeFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
-}\r
-\r
-\r
-/**\r
- Converts a decimal value to a Null-terminated ASCII string.\r
- \r
- Converts the decimal number specified by Value to a Null-terminated ASCII string \r
- specified by Buffer containing at most Width characters. No padding of spaces \r
- is ever performed.\r
- If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
- The number of ASCII characters in Buffer is returned not including the Null-terminator.\r
- If the conversion contains more than Width characters, then only the first Width\r
- characters are returned, and the total number of characters required to perform\r
- the conversion is returned.\r
- Additional conversion parameters are specified in Flags. \r
- The Flags bit LEFT_JUSTIFY is always ignored.\r
- All conversions are left justified in Buffer.\r
- If Width is 0, PREFIX_ZERO is ignored in Flags.\r
- If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas\r
- are inserted every 3rd digit starting from the right.\r
- If HEX_RADIX is set in Flags, then the output buffer will be \r
- formatted in hexadecimal format.\r
- If Value is < 0 and HEX_RADIX is not set in Flags, then the fist character in Buffer is a '-'.\r
- If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, \r
- then Buffer is padded with '0' characters so the combination of the optional '-' \r
- sign character, '0' characters, digit characters for Value, and the Null-terminator\r
- add up to Width characters.\r
- \r
- If Buffer is NULL, then ASSERT().\r
- If unsupported bits are set in Flags, then ASSERT().\r
- If both COMMA_TYPE and HEX_RADIX are set in Flags, then ASSERT().\r
- If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
-\r
- @param Buffer Pointer to the output buffer for the produced Null-terminated\r
- ASCII string.\r
- @param Flags The bitmask of flags that specify left justification, zero pad, and commas.\r
- @param Value The 64-bit signed value to convert to a string.\r
- @param Width The maximum number of ASCII characters to place in Buffer, not including\r
- the Null-terminator.\r
- \r
- @return The number of ASCII characters in Buffer not including the Null-terminator.\r
-\r
-**/\r
-UINTN\r
-EFIAPI\r
-AsciiValueToString (\r
- OUT CHAR8 *Buffer,\r
- IN UINTN Flags,\r
- IN INT64 Value,\r
- IN UINTN Width\r
- )\r
-{\r
- if (InternalLocatePrintProtocol() != EFI_SUCCESS) {\r
- return 0;\r
- }\r
-\r
- return gPrintProtocol->AsciiValueToString (Buffer, Flags, Value, Width);\r
-}\r
projects / mirror_edk2.git / commitdiff