]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Library/PrintLib.h
MdePkg/BasePrintLib: Add safe print functions [A|U]ValueToStringS
[mirror_edk2.git] / MdePkg / Include / Library / PrintLib.h
index 3eb84f311b51aa31cd315ad3020faaa7009ed211..8c11dab696353021863e9b5a26c0818ba1359bef 100644 (file)
 /** @file\r
-       Library that provides print services\r
+  Provides services to print a formatted string to a buffer. All combinations of\r
+  Unicode and ASCII strings are supported.\r
 \r
-       Copyright (c) 2006, 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
+Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+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
+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
-       Module Name:    PrintLib.h\r
+  The Print Library functions provide a simple means to produce formatted output \r
+  strings.  Many of the output functions use a format string to describe how to \r
+  format the output of variable arguments.  The format string consists of normal \r
+  text and argument descriptors.  There are no restrictions for how the normal \r
+  text and argument descriptors can be mixed.  The following end of line(EOL) \r
+  translations must be performed on the contents of the format string:\r
+  \r
+     - '\\r' is translated to '\\r'\r
+     - '\\r\\n' is translated to '\\r\\n'\r
+     - '\\n' is translated to '\\r\\n' \r
+     - '\\n\\r' is translated to '\\r\\n'\r
+  \r
+  This does not follow the ANSI C standard for sprint().  The format of argument \r
+  descriptors is described below.  The ANSI C standard for sprint() has been \r
+  followed for some of the format types, and has not been followed for others.  \r
+  The exceptions are noted below.\r
+\r
+    %[flags][width][.precision]type\r
+\r
+  [flags]:\r
+    - -       \r
+      - The field is left justified.  If not flag is not specified, then the \r
+        field is right justified.\r
+    - space   \r
+      - Prefix a space character to a number.  Only valid for types X, x, and d.\r
+    - + \r
+      - Prefix a plus character to a number.  Only valid for types X, x, and d.  \r
+        If both space and + are specified, then space is ignored.\r
+    - 0\r
+      - Pad with 0 characters to the left of a number.  Only valid for types \r
+        X, x, and d.\r
+    - ,\r
+      - Place a comma every 3rd digit of the number.  Only valid for type d.\r
+        If 0 is also specified, then 0 is ignored.\r
+    - L, l\r
+      - The number being printed is size UINT64.  Only valid for types X, x, and d.\r
+        If this flag is not specified, then the number being printed is size int.\r
+    - NOTE: All invalid flags are ignored.\r
+\r
+  [width]:\r
+\r
+    - *\r
+      - The width of the field is specified by a UINTN argument in the \r
+        argument list.\r
+    - number\r
+      - The number specified as a decimal value represents the width of \r
+        the field.\r
+    - NOTE: If [width] is not specified, then a field width of 0 is assumed.\r
+\r
+  [.precision]:\r
+\r
+    - *\r
+      - The precision of the field is specified by a UINTN argument in the \r
+        argument list.\r
+    - number\r
+      - The number specified as a decimal value represents the precision of \r
+        the field.\r
+    - NOTE: If [.precision] is not specified, then a precision of 0 is assumed.\r
+\r
+  type:\r
+\r
+    - %\r
+      - Print a %%.\r
+    - c\r
+      - The argument is a Unicode character.  ASCII characters can be printed \r
+        using this type too by making sure bits 8..15 of the argument are set to 0.\r
+    - x\r
+      - The argument is an unsigned hexadecimal number.  The characters used are 0..9 and \r
+        A..F.  If the flag 'L' is not specified, then the argument is assumed \r
+        to be size int.  This does not follow ANSI C.\r
+    - X\r
+      - The argument is an unsigned hexadecimal number and the number is padded with \r
+        zeros.  This is equivalent to a format string of "0x". If the flag \r
+        'L' is not specified, then the argument is assumed to be size int.  \r
+        This does not follow ANSI C.\r
+    - d\r
+      - The argument is a signed decimal number.  If the flag 'L' is not specified, \r
+        then the argument is assumed to be size int.  \r
+    - u\r
+      - The argument is a unsigned decimal number.  If the flag 'L' is not specified, \r
+        then the argument is assumed to be size int.\r
+    - p\r
+      - The argument is a pointer that is a (VOID *), and it is printed as an \r
+        unsigned hexadecimal number  The characters used are 0..9 and A..F.\r
+    - a\r
+      - The argument is a pointer to an ASCII string.  \r
+        This does not follow ANSI C.\r
+    - S, s\r
+      - The argument is a pointer to a Unicode string.  \r
+        This does not follow ANSI C.\r
+    - g\r
+      - The argument is a pointer to a GUID structure.  The GUID is printed \r
+        in the format XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.  \r
+        This does not follow ANSI C.\r
+    - t\r
+      - The argument is a pointer to an EFI_TIME structure.  The time and \r
+        date are printed in the format "mm/dd/yyyy hh:mm" where mm is the \r
+        month zero padded, dd is the day zero padded, yyyy is the year zero \r
+        padded, hh is the hour zero padded, and mm is minutes zero padded.  \r
+        This does not follow ANSI C. \r
+    - r\r
+      - The argument is a RETURN_STATUS value.  This value is converted to \r
+        a string following the table below.  This does not follow ANSI C. \r
+      - RETURN_SUCCESS               \r
+        - "Success"\r
+      - RETURN_LOAD_ERROR            \r
+        - "Load Error"\r
+      - RETURN_INVALID_PARAMETER     \r
+        - "Invalid Parameter"\r
+      - RETURN_UNSUPPORTED           \r
+        - "Unsupported"\r
+      - RETURN_BAD_BUFFER_SIZE       \r
+        - "Bad Buffer Size"\r
+      - RETURN_BUFFER_TOO_SMALL      \r
+        - "Buffer Too Small"\r
+      - RETURN_NOT_READY             \r
+        - "Not Ready"\r
+      - RETURN_DEVICE_ERROR          \r
+        - "Device Error"\r
+      - RETURN_WRITE_PROTECTED       \r
+        - "Write Protected"\r
+      - RETURN_OUT_OF_RESOURCES      \r
+        - "Out of Resources"\r
+      - RETURN_VOLUME_CORRUPTED      \r
+        - "Volume Corrupt"\r
+      - RETURN_VOLUME_FULL           \r
+        - "Volume Full"\r
+      - RETURN_NO_MEDIA              \r
+        - "No Media"\r
+      - RETURN_MEDIA_CHANGED         \r
+        - "Media changed"\r
+      - RETURN_NOT_FOUND             \r
+        - "Not Found"\r
+      - RETURN_ACCESS_DENIED         \r
+        - "Access Denied"\r
+      - RETURN_NO_RESPONSE           \r
+        - "No Response"\r
+      - RETURN_NO_MAPPING            \r
+        - "No mapping"\r
+      - RETURN_TIMEOUT               \r
+        - "Time out"\r
+      - RETURN_NOT_STARTED           \r
+        - "Not started"\r
+      - RETURN_ALREADY_STARTED       \r
+        - "Already started"\r
+      - RETURN_ABORTED               \r
+        - "Aborted"\r
+      - RETURN_ICMP_ERROR            \r
+        - "ICMP Error"\r
+      - RETURN_TFTP_ERROR            \r
+        - "TFTP Error"\r
+      - RETURN_PROTOCOL_ERROR        \r
+        - "Protocol Error"\r
+      - RETURN_WARN_UNKNOWN_GLYPH    \r
+        - "Warning Unknown Glyph"\r
+      - RETURN_WARN_DELETE_FAILURE   \r
+        - "Warning Delete Failure"\r
+      - RETURN_WARN_WRITE_FAILURE    \r
+        - "Warning Write Failure"\r
+      - RETURN_WARN_BUFFER_TOO_SMALL \r
+        - "Warning Buffer Too Small"\r
 \r
 **/\r
 \r
 #ifndef __PRINT_LIB_H__\r
 #define __PRINT_LIB_H__\r
 \r
-//\r
-// Print primitives\r
-//\r
+///\r
+/// Define the maximum number of characters that are required to\r
+/// encode with a NULL terminator a decimal, hexadecimal, GUID,   \r
+/// or TIME value.\r
+///  \r
+///  Maximum Length Decimal String     = 28\r
+///    "-9,223,372,036,854,775,808"\r
+///  Maximum Length Hexadecimal String = 17\r
+///    "FFFFFFFFFFFFFFFF"\r
+///  Maximum Length GUID               = 37\r
+///    "00000000-0000-0000-0000-000000000000"\r
+///  Maximum Length TIME               = 18\r
+///    "12/12/2006  12:12"\r
+///\r
+#define MAXIMUM_VALUE_CHARACTERS  38\r
+\r
+///\r
+/// Flags bitmask values use in UnicodeValueToString() and \r
+/// AsciiValueToString()\r
+///\r
 #define LEFT_JUSTIFY      0x01\r
 #define COMMA_TYPE        0x08\r
 #define PREFIX_ZERO       0x20\r
+#define RADIX_HEX         0x80\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
+  This function is similar as vsnprintf_s defined in C11.\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
+\r
+  If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+  If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
+  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+  (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+  buffer is unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+  If BufferSize is 0 or 1, then the output buffer is unmodified and 0 is returned.\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    A 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
@@ -33,6 +252,93 @@ UnicodeVSPrint (
   IN  VA_LIST       Marker\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 BASE_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
+\r
+  If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+  If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+  (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+  buffer is unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+  If BufferSize is 0 or 1, then the output buffer is unmodified and 0 is returned.\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    A Null-terminated Unicode format string.\r
+  @param  Marker          BASE_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
+UnicodeBSPrint (\r
+  OUT CHAR16        *StartOfBuffer,\r
+  IN  UINTN         BufferSize,\r
+  IN  CONST CHAR16  *FormatString,\r
+  IN  BASE_LIST     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
+  This function is similar as snprintf_s defined in C11.\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
+\r
+  If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+  If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+  (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+  buffer is unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+  If BufferSize is 0 or 1, then the output buffer is unmodified and 0 is returned.\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    A 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
@@ -42,6 +348,45 @@ UnicodeSPrint (
   ...\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
+  This function is similar as vsnprintf_s defined in C11.\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
+\r
+  If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+  (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+  buffer is unmodified and 0 is returned.\r
+  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+  PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+  If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\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    A Null-terminated ASCII 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
@@ -51,7 +396,92 @@ UnicodeVSPrintAsciiFormat (
   IN  VA_LIST      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 BASE_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
+\r
+  If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+  (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+  buffer is unmodified and 0 is returned.\r
+  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+  PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+  If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\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    A Null-terminated ASCII format string.\r
+  @param  Marker          BASE_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
+UnicodeBSPrintAsciiFormat (\r
+  OUT CHAR16       *StartOfBuffer,\r
+  IN  UINTN        BufferSize,\r
+  IN  CONST CHAR8  *FormatString,\r
+  IN  BASE_LIST    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
+  This function is similar as snprintf_s defined in C11.\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
+\r
+  If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+  (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+  buffer is unmodified and 0 is returned.\r
+  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+  PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+  If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\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    A Null-terminated ASCII 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
@@ -61,6 +491,154 @@ UnicodeSPrintAsciiFormat (
   ...\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 RADIX_HEX is set in Flags, then the output buffer will be \r
+  formatted in hexadecimal format.\r
+  If Value is < 0 and RADIX_HEX 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 RADIX_HEX 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 RADIX_HEX are set in Flags, then ASSERT().\r
+  If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
+\r
+  @param  Buffer  The 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
+/**\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\r
+  spaces is ever performed. If Width is 0 then a width of\r
+  MAXIMUM_VALUE_CHARACTERS is assumed. If the conversion contains more than\r
+  Width characters, then only the first Width characters are placed in Buffer.\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\r
+  commas are inserted every 3rd digit starting from the right.\r
+  If RADIX_HEX is set in Flags, then the output buffer will be formatted in\r
+  hexadecimal format.\r
+  If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in\r
+  Buffer is a '-'.\r
+  If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, then\r
+  Buffer is padded with '0' characters so the combination of the optional '-'\r
+  sign character, '0' characters, digit characters for Value, and the\r
+  Null-terminator add up to Width characters.\r
+\r
+  If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
+  If an error would be returned, then the function will also ASSERT().\r
+\r
+  @param  Buffer      The pointer to the output buffer for the produced\r
+                      Null-terminated Unicode string.\r
+  @param  BufferSize  The size of Buffer in bytes, including the\r
+                      Null-terminator.\r
+  @param  Flags       The bitmask of flags that specify left justification,\r
+                      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\r
+                      Buffer, not including the Null-terminator.\r
+\r
+  @retval RETURN_SUCCESS           The decimal value is converted.\r
+  @retval RETURN_BUFFER_TOO_SMALL  If BufferSize cannot hold the converted\r
+                                   value.\r
+  @retval RETURN_INVALID_PARAMETER If Buffer is NULL.\r
+                                   If PcdMaximumUnicodeStringLength is not\r
+                                   zero, and BufferSize is greater than\r
+                                   (PcdMaximumUnicodeStringLength *\r
+                                   sizeof (CHAR16) + 1).\r
+                                   If unsupported bits are set in Flags.\r
+                                   If both COMMA_TYPE and RADIX_HEX are set in\r
+                                   Flags.\r
+                                   If Width >= MAXIMUM_VALUE_CHARACTERS.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+UnicodeValueToStringS (\r
+  IN OUT CHAR16  *Buffer,\r
+  IN UINTN       BufferSize,\r
+  IN UINTN       Flags,\r
+  IN INT64       Value,\r
+  IN UINTN       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
+  This function is similar as vsnprintf_s defined in C11.\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
+\r
+  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+  (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+  is unmodified and 0 is returned.\r
+  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+  PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+  If BufferSize is 0, then no output buffer is produced and 0 is returned.\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    A Null-terminated ASCII 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
@@ -70,6 +648,88 @@ AsciiVSPrint (
   IN  VA_LIST       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 BASE_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
+\r
+  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+  (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+  is unmodified and 0 is returned.\r
+  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+  PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+  If BufferSize is 0, then no output buffer is produced and 0 is returned.\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    A Null-terminated ASCII format string.\r
+  @param  Marker          BASE_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
+AsciiBSPrint (\r
+  OUT CHAR8         *StartOfBuffer,\r
+  IN  UINTN         BufferSize,\r
+  IN  CONST CHAR8   *FormatString,\r
+  IN  BASE_LIST     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
+  This function is similar as snprintf_s defined in C11.\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
+\r
+  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+  (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+  is unmodified and 0 is returned.\r
+  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
+  PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+  If BufferSize is 0, then no output buffer is produced and 0 is returned.\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    A Null-terminated ASCII 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
@@ -79,6 +739,45 @@ AsciiSPrint (
   ...\r
   );\r
 \r
+/**\r
+  Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
+  Unicode format string and a VA_LIST argument list.\r
+\r
+  This function is similar as vsnprintf_s defined in C11.\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
+\r
+  If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+  (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+  is unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+  If BufferSize is 0, then no output buffer is produced and 0 is returned.\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    A 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
@@ -88,6 +787,92 @@ AsciiVSPrintUnicodeFormat (
   IN  VA_LIST       Marker\r
   );\r
 \r
+/**\r
+  Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
+  Unicode format string and a BASE_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
+\r
+  If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+  (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+  is unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+  If BufferSize is 0, then no output buffer is produced and 0 is returned.\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    A Null-terminated Unicode format string.\r
+  @param  Marker          BASE_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
+AsciiBSPrintUnicodeFormat (\r
+  OUT CHAR8         *StartOfBuffer,\r
+  IN  UINTN         BufferSize,\r
+  IN  CONST CHAR16  *FormatString,\r
+  IN  BASE_LIST     Marker\r
+  );\r
+\r
+/**\r
+  Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
+  Unicode format string and  variable argument list.\r
+\r
+  This function is similar as snprintf_s defined in C11.\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
+\r
+  If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+  (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+  is unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+  If BufferSize is 0, then no output buffer is produced and 0 is returned.\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    A 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
@@ -97,22 +882,159 @@ AsciiSPrintUnicodeFormat (
   ...\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 RADIX_HEX is set in Flags, then the output buffer will be \r
+  formatted in hexadecimal format.\r
+  If Value is < 0 and RADIX_HEX 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 RADIX_HEX are set in Flags, then ASSERT().\r
+  If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
+\r
+  @param  Buffer  A 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
-UnicodeValueToString (\r
-  IN OUT CHAR16  *Buffer,\r
+AsciiValueToString (\r
+  OUT CHAR8      *Buffer,\r
+  IN  UINTN      Flags,\r
+  IN  INT64      Value,\r
+  IN  UINTN      Width\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\r
+  string specified by Buffer containing at most Width characters. No padding of\r
+  spaces is ever performed. If Width is 0 then a width of\r
+  MAXIMUM_VALUE_CHARACTERS is assumed. If the conversion contains more than\r
+  Width characters, then only the first Width characters are placed in Buffer.\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\r
+  commas are inserted every 3rd digit starting from the right.\r
+  If RADIX_HEX is set in Flags, then the output buffer will be formatted in\r
+  hexadecimal format.\r
+  If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in\r
+  Buffer is a '-'.\r
+  If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, then\r
+  Buffer is padded with '0' characters so the combination of the optional '-'\r
+  sign character, '0' characters, digit characters for Value, and the\r
+  Null-terminator add up to Width characters.\r
+\r
+  If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
+  If an error would be returned, then the function will also ASSERT().\r
+\r
+  @param  Buffer      The pointer to the output buffer for the produced\r
+                      Null-terminated Ascii string.\r
+  @param  BufferSize  The size of Buffer in bytes, including the\r
+                      Null-terminator.\r
+  @param  Flags       The bitmask of flags that specify left justification,\r
+                      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\r
+                      Buffer, not including the Null-terminator.\r
+\r
+  @retval RETURN_SUCCESS           The decimal value is converted.\r
+  @retval RETURN_BUFFER_TOO_SMALL  If BufferSize cannot hold the converted\r
+                                   value.\r
+  @retval RETURN_INVALID_PARAMETER If Buffer is NULL.\r
+                                   If PcdMaximumAsciiStringLength is not\r
+                                   zero, and BufferSize is greater than\r
+                                   PcdMaximumAsciiStringLength.\r
+                                   If unsupported bits are set in Flags.\r
+                                   If both COMMA_TYPE and RADIX_HEX are set in\r
+                                   Flags.\r
+                                   If Width >= MAXIMUM_VALUE_CHARACTERS.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+AsciiValueToStringS (\r
+  IN OUT CHAR8   *Buffer,\r
+  IN UINTN       BufferSize,\r
   IN UINTN       Flags,\r
   IN INT64       Value,\r
   IN UINTN       Width\r
   );\r
 \r
+/**\r
+  Returns the number of characters that would be produced by if the formatted \r
+  output were produced not including the Null-terminator.\r
+\r
+  If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+  If FormatString is NULL, then ASSERT() and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more\r
+  than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+  Null-terminator, then ASSERT() and 0 is returned.\r
+\r
+  @param[in]  FormatString    A Null-terminated Unicode format string.\r
+  @param[in]  Marker          VA_LIST marker for the variable argument list.\r
+\r
+  @return The number of characters that would be produced, not including the \r
+          Null-terminator.\r
+**/\r
+UINTN\r
+EFIAPI\r
+SPrintLength (\r
+  IN  CONST CHAR16   *FormatString,\r
+  IN  VA_LIST       Marker\r
+  );\r
+\r
+/**\r
+  Returns the number of characters that would be produced by if the formatted \r
+  output were produced not including the Null-terminator.\r
+\r
+  If FormatString is NULL, then ASSERT() and 0 is returned.\r
+  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more\r
+  than PcdMaximumAsciiStringLength Ascii characters not including the\r
+  Null-terminator, then ASSERT() and 0 is returned.\r
+\r
+  @param[in]  FormatString    A Null-terminated ASCII format string.\r
+  @param[in]  Marker          VA_LIST marker for the variable argument list.\r
+\r
+  @return The number of characters that would be produced, not including the \r
+          Null-terminator.\r
+**/\r
 UINTN\r
 EFIAPI\r
-AsciiValueToString (\r
-  IN OUT CHAR8  *Buffer,\r
-  IN UINTN      Flags,\r
-  IN INT64      Value,\r
-  IN UINTN      Width\r
+SPrintLengthAsciiFormat (\r
+  IN  CONST CHAR8   *FormatString,\r
+  IN  VA_LIST       Marker\r
   );\r
 \r
 #endif\r