add function header

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@350 6f19259b-4bc3-4df7-8a09-765794883524

3 files changed, 458 insertions, 21 deletions

diff --git a/MdePkg/Library/BasePrintLib/PrintLib.c b/MdePkg/Library/BasePrintLib/PrintLib.c
index bbd0820..f2c7ee5 100644
--- a/MdePkg/Library/BasePrintLib/PrintLib.c
+++ b/MdePkg/Library/BasePrintLib/PrintLib.c
@@ -56,20 +56,21 @@ static CONST STATUS_LOOKUP_TABLE_ENTRY  StatusString[] = {
 

 

 /**

+  Worker function that produces a Null-terminated string in an output buffer 

+  based on a Null-terminated format string and a VA_LIST argument list.

+

   VSPrint function to process format and place the results in Buffer. Since a 

   VA_LIST is used this rountine allows the nesting of Vararg routines. Thus 

   this is the main print working routine

 

-  @param  StartOfBuffer Unicode buffer to print the results of the parsing of Format into.

-  

-  @param  BufferSize Maximum number of characters to put into buffer. Zero means

-  no limit.

-  

-  @param  Flags Intial flags value.  Can only have FORMAT_UNICODE and OUTPUT_UNICODE set

-  

-  @param  FormatString Unicode format string see file header for more details.

-  

-  @param  Marker Vararg list consumed by processing Format.

+  @param  Buffer      Character buffer to print the results of the parsing

+                      of Format into.

+  @param  BufferSize  Maximum number of characters to put into buffer.

+                      Zero means no limit.

+  @param  Flags       Intial flags value.

+                      Can only have FORMAT_UNICODE and OUTPUT_UNICODE set

+  @param  Format      Null-terminated format string.

+  @param  Marker      Vararg list consumed by processing Format.

 

   @return Number of characters printed.

 

@@ -515,6 +516,25 @@ BasePrintLibVSPrint (
   return ((Buffer - OriginalBuffer) / BytesPerOutputCharacter);

 }

 

+/**

+  Worker function that produces a Null-terminated string in an output buffer 

+  based on a Null-terminated format string and variable argument list.

+

+  VSPrint function to process format and place the results in Buffer. Since a 

+  VA_LIST is used this rountine allows the nesting of Vararg routines. Thus 

+  this is the main print working routine

+

+  @param  Buffer        Character buffer to print the results of the parsing

+                        of Format into.

+  @param  BufferSize    Maximum number of characters to put into buffer.

+                        Zero means no limit.

+  @param  Flags         Intial flags value.

+                        Can only have FORMAT_UNICODE and OUTPUT_UNICODE set

+  @param  FormatString  Null-terminated format string.

+

+  @return Number of characters printed.

+

+**/

 UINTN

 BasePrintLibSPrint (

   OUT CHAR8        *StartOfBuffer,

@@ -530,6 +550,34 @@ BasePrintLibSPrint (
   return BasePrintLibVSPrint (StartOfBuffer, BufferSize, Flags, FormatString, Marker);

 }

 

+/**

+  Produces a Null-terminated Unicode string in an output buffer based on 

+  a Null-terminated Unicode format string and a VA_LIST argument list

+  

+  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer

+  and BufferSize.  

+  The Unicode string is produced by parsing the format string specified by FormatString.  

+  Arguments are pulled from the variable argument list specified by Marker based on the 

+  contents of the format string.  

+  The length of the produced output buffer is returned.

+  If BufferSize is 0, then no output buffer is produced and 0 is returned.

+

+  If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().

+  If BufferSize is not 0 and FormatString is NULL, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than 

+  PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string

+  contains more than PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().

+

+  @param  StartOfBuffer   APointer to the output buffer for the produced Null-terminated 

+                          Unicode string.

+  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

+  @param  FormatString    Null-terminated Unicode format string.

+  @param  Marker          VA_LIST marker for the variable argument list.

+  

+  @return return Length of the produced output buffer.

+

+**/

 UINTN

 EFIAPI

 UnicodeVSPrint (

@@ -542,6 +590,32 @@ UnicodeVSPrint (
   return BasePrintLibVSPrint ((CHAR8 *)StartOfBuffer, BufferSize >> 1, FORMAT_UNICODE | OUTPUT_UNICODE, (CHAR8 *)FormatString, Marker);

 }

 

+/**

+  Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated 

+  Unicode format string and variable argument list.

+  

+  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer

+  and BufferSize.

+  The Unicode string is produced by parsing the format string specified by FormatString.

+  Arguments are pulled from the variable argument list based on the contents of the format string.

+  The length of the produced output buffer is returned.  

+  If BufferSize is 0, then no output buffer is produced and 0 is returned.

+

+  If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().

+  If BufferSize is not 0 and FormatString is NULL, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than 

+  PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string

+  contains more than PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().

+

+  @param  StartOfBuffer   APointer to the output buffer for the produced Null-terminated 

+                          Unicode string.

+  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

+  @param  FormatString    Null-terminated Unicode format string.

+  

+  @return Length of the produced output buffer.

+

+**/

 UINTN

 EFIAPI

 UnicodeSPrint (

@@ -557,6 +631,34 @@ UnicodeSPrint (
   return UnicodeVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);

 }

 

+/**

+  Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated

+  ASCII format string and a VA_LIST argument list

+  

+  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer

+  and BufferSize.

+  The Unicode string is produced by parsing the format string specified by FormatString.

+  Arguments are pulled from the variable argument list specified by Marker based on the 

+  contents of the format string.

+  The length of the produced output buffer is returned.

+  If BufferSize is 0, then no output buffer is produced and 0 is returned.

+

+  If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().

+  If BufferSize is not 0 and FormatString is NULL, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than 

+  PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string

+  contains more than PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().

+

+  @param  StartOfBuffer   APointer to the output buffer for the produced Null-terminated 

+                          Unicode string.

+  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

+  @param  FormatString    Null-terminated Unicode format string.

+  @param  Marker          VA_LIST marker for the variable argument list.

+  

+  @return Length of the produced output buffer.

+

+**/

 UINTN

 EFIAPI

 UnicodeVSPrintAsciiFormat (

@@ -569,6 +671,33 @@ UnicodeVSPrintAsciiFormat (
   return BasePrintLibVSPrint ((CHAR8 *)StartOfBuffer, BufferSize >> 1, OUTPUT_UNICODE,FormatString, Marker);

 }

 

+/**

+  Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated 

+  ASCII format string and  variable argument list.

+  

+  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer

+  and BufferSize.

+  The Unicode string is produced by parsing the format string specified by FormatString.

+  Arguments are pulled from the variable argument list based on the contents of the 

+  format string.

+  The length of the produced output buffer is returned.

+  If BufferSize is 0, then no output buffer is produced and 0 is returned.

+

+  If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().

+  If BufferSize is not 0 and FormatString is NULL, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than 

+  PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string

+  contains more than PcdMaximumUnicodeStringLength Unicode characters, then ASSERT().

+

+  @param  StartOfBuffer   APointer to the output buffer for the produced Null-terminated 

+                          Unicode string.

+  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

+  @param  FormatString    Null-terminated Unicode format string.

+  

+  @return Length of the produced output buffer.

+

+**/

 UINTN

 EFIAPI

 UnicodeSPrintAsciiFormat (

@@ -584,6 +713,34 @@ UnicodeSPrintAsciiFormat (
   return UnicodeVSPrintAsciiFormat (StartOfBuffer, BufferSize >> 1, FormatString, Marker);

 }

 

+/**

+  Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated

+  ASCII format string and a VA_LIST argument list.

+  

+  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer

+  and BufferSize.

+  The ASCII string is produced by parsing the format string specified by FormatString.

+  Arguments are pulled from the variable argument list specified by Marker based on 

+  the contents of the format string.

+  The length of the produced output buffer is returned.

+  If BufferSize is 0, then no output buffer is produced and 0 is returned.

+

+  If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().

+  If BufferSize is not 0 and FormatString is NULL, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than 

+  PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string

+  contains more than PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().

+

+  @param  StartOfBuffer   APointer to the output buffer for the produced Null-terminated 

+                          ASCII string.

+  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

+  @param  FormatString    Null-terminated Unicode format string.

+  @param  Marker          VA_LIST marker for the variable argument list.

+  

+  @return Length of the produced output buffer.

+

+**/

 UINTN

 EFIAPI

 AsciiVSPrint (

@@ -596,6 +753,33 @@ AsciiVSPrint (
   return BasePrintLibVSPrint (StartOfBuffer, BufferSize, 0, FormatString, Marker);

 }

 

+/**

+  Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated

+  ASCII format string and  variable argument list.

+  

+  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer

+  and BufferSize.

+  The ASCII string is produced by parsing the format string specified by FormatString.

+  Arguments are pulled from the variable argument list based on the contents of the 

+  format string.

+  The length of the produced output buffer is returned.

+  If BufferSize is 0, then no output buffer is produced and 0 is returned.

+

+  If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().

+  If BufferSize is not 0 and FormatString is NULL, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than 

+  PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string

+  contains more than PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().

+

+  @param  StartOfBuffer   APointer to the output buffer for the produced Null-terminated 

+                          ASCII string.

+  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

+  @param  FormatString    Null-terminated Unicode format string.

+  

+  @return Length of the produced output buffer.

+

+**/

 UINTN

 EFIAPI

 AsciiSPrint (

@@ -611,6 +795,34 @@ AsciiSPrint (
   return AsciiVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);

 }

 

+/**

+  Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated

+  ASCII format string and a VA_LIST argument list.

+  

+  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer

+  and BufferSize.

+  The ASCII string is produced by parsing the format string specified by FormatString.

+  Arguments are pulled from the variable argument list specified by Marker based on 

+  the contents of the format string.

+  The length of the produced output buffer is returned.

+  If BufferSize is 0, then no output buffer is produced and 0 is returned.

+

+  If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().

+  If BufferSize is not 0 and FormatString is NULL, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than 

+  PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string

+  contains more than PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().

+

+  @param  StartOfBuffer   APointer to the output buffer for the produced Null-terminated 

+                          ASCII string.

+  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

+  @param  FormatString    Null-terminated Unicode format string.

+  @param  Marker          VA_LIST marker for the variable argument list.

+  

+  @return Length of the produced output buffer.

+

+**/

 UINTN

 EFIAPI

 AsciiVSPrintUnicodeFormat (

@@ -623,6 +835,33 @@ AsciiVSPrintUnicodeFormat (
   return BasePrintLibVSPrint (StartOfBuffer, BufferSize, FORMAT_UNICODE, (CHAR8 *)FormatString, Marker);

 }

 

+/**

+  Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated

+  ASCII format string and  variable argument list.

+  

+  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer

+  and BufferSize.

+  The ASCII string is produced by parsing the format string specified by FormatString.

+  Arguments are pulled from the variable argument list based on the contents of the 

+  format string.

+  The length of the produced output buffer is returned.

+  If BufferSize is 0, then no output buffer is produced and 0 is returned.

+

+  If BufferSize is not 0 and StartOfBuffer is NULL, then ASSERT().

+  If BufferSize is not 0 and FormatString is NULL, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than 

+  PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().

+  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string

+  contains more than PcdMaximumUnicodeStringLength ASCII characters, then ASSERT().

+

+  @param  StartOfBuffer   APointer to the output buffer for the produced Null-terminated 

+                          ASCII string.

+  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

+  @param  FormatString    Null-terminated Unicode format string.

+  

+  @return Length of the produced output buffer.

+

+**/

 UINTN

 EFIAPI

 AsciiSPrintUnicodeFormat (

@@ -638,6 +877,41 @@ AsciiSPrintUnicodeFormat (
   return AsciiVSPrintUnicodeFormat (StartOfBuffer, BufferSize, FormatString, Marker);

 }

 

+/**

+  Converts a decimal value to a Null-terminated Unicode string.

+  

+  Converts the decimal number specified by Value to a Null-terminated Unicode 

+  string specified by Buffer containing at most Width characters.

+  If Width is 0 then a width of  MAXIMUM_VALUE_CHARACTERS is assumed.

+  The total number of characters placed in Buffer is returned.

+  If the conversion contains more than Width characters, then only the first

+  Width characters are returned, and the total number of characters 

+  required to perform the conversion is returned.

+  Additional conversion parameters are specified in Flags.  

+  The Flags bit LEFT_JUSTIFY is always ignored.

+  All conversions are left justified in Buffer.

+  If Width is 0, PREFIX_ZERO is ignored in Flags.

+  If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas

+  are inserted every 3rd digit starting from the right.

+  If Value is < 0, then the fist character in Buffer is a '-'.

+  If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, 

+  then Buffer is padded with '0' characters so the combination of the optional '-' 

+  sign character, '0' characters, digit characters for Value, and the Null-terminator

+  add up to Width characters.

+

+  If Buffer is NULL, then ASSERT().

+  If unsupported bits are set in Flags, then ASSERT().

+  If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()

+

+  @param  Buffer  Pointer to the output buffer for the produced Null-terminated

+                  Unicode string.

+  @param  Flags   The bitmask of flags that specify left justification, zero pad, and commas.

+  @param  Value   The 64-bit signed value to convert to a string.

+  @param  Width	  The maximum number of Unicode characters to place in Buffer.

+  

+  @return Total number of characters required to perform the conversion.

+

+**/

 UINTN

 EFIAPI

 UnicodeValueToString (

@@ -650,6 +924,41 @@ UnicodeValueToString (
   return BasePrintLibConvertValueToString ((CHAR8 *)Buffer, Flags, Value, Width, 2);

 }

 

+/**

+  Converts a decimal value to a Null-terminated ASCII string.

+  

+  Converts the decimal number specified by Value to a Null-terminated ASCII string 

+  specified by Buffer containing at most Width characters.

+  If Width is 0 then a width of  MAXIMUM_VALUE_CHARACTERS is assumed.

+  The total number of characters placed in Buffer is returned.

+  If the conversion contains more than Width characters, then only the first Width

+  characters are returned, and the total number of characters required to perform

+  the conversion is returned.

+  Additional conversion parameters are specified in Flags.  

+  The Flags bit LEFT_JUSTIFY is always ignored.

+  All conversions are left justified in Buffer.

+  If Width is 0, PREFIX_ZERO is ignored in Flags.

+  If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas 

+  are inserted every 3rd digit starting from the right.

+  If Value is < 0, then the fist character in Buffer is a '-'.

+  If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, then Buffer

+  is padded with '0' characters so the combination of the optional '-'

+  sign character, '0' characters, digit characters for Value, and the 

+  Null-terminator add up to Width characters.

+

+  If Buffer is NULL, then ASSERT().

+  If unsupported bits are set in Flags, then ASSERT().

+  If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()

+

+  @param  Buffer  Pointer to the output buffer for the produced Null-terminated

+                  ASCII string.

+  @param  Flags   The bitmask of flags that specify left justification, zero pad, and commas.

+  @param  Value   The 64-bit signed value to convert to a string.

+  @param  Width	  The maximum number of ASCII characters to place in Buffer.

+  

+  @return Total number of characters required to perform the conversion.

+

+**/

 UINTN

 EFIAPI

 AsciiValueToString (

diff --git a/MdePkg/Library/BasePrintLib/PrintLibInternal.c b/MdePkg/Library/BasePrintLib/PrintLibInternal.c
index 56d3575..89d18b0 100644
--- a/MdePkg/Library/BasePrintLib/PrintLibInternal.c
+++ b/MdePkg/Library/BasePrintLib/PrintLibInternal.c
@@ -18,6 +18,20 @@
 

 static CONST CHAR8 mHexStr[] = {'0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'};

 

+

+/**

+  Internal function that places the character into the Buffer.

+

+  Internal function that places ASCII or Unicode character into the Buffer.

+

+  @param  Buffer      Buffer to place the Unicode or ASCII string.

+  @param  Length      Count of character to be placed into Buffer.

+  @param  Character   Character to be placed into Buffer.

+  @param  Increment   Character increment in Buffer.

+

+  @return Number of characters printed.

+

+**/

 CHAR8 *

 BasePrintLibFillBuffer (

   CHAR8   *Buffer,

@@ -37,15 +51,13 @@ BasePrintLibFillBuffer (
 }

 

 /**

-  Print worker function that prints a Value as a decimal number in Buffer.

+  Internal function that convert a decimal number to a string in Buffer.

 

-  @param  Buffer Location to place the Unicode or ASCII string of Value.

-  

-  @param  Value Value to convert to a Decimal or Hexidecimal string in Buffer.

-  

-  @param  Flags Flags to use in printing string, see file header for details.

-  

-  @param  Precision Minimum number of digits to return in the ASCII string

+  Print worker function that convert a decimal number to a string in Buffer.

+

+  @param  Buffer    Location to place the Unicode or ASCII string of Value.

+  @param  Value     Value to convert to a Decimal or Hexidecimal string in Buffer.

+  @param  Radix     Radix of the value

 

   @return Number of characters printed.

 

@@ -74,6 +86,43 @@ BasePrintLibValueToString (
   return Digits;

 }

 

+/**

+  Internal function that converts a decimal value to a Null-terminated string.

+  

+  Converts the decimal number specified by Value to a Null-terminated  

+  string specified by Buffer containing at most Width characters.

+  If Width is 0 then a width of  MAXIMUM_VALUE_CHARACTERS is assumed.

+  The total number of characters placed in Buffer is returned.

+  If the conversion contains more than Width characters, then only the first

+  Width characters are returned, and the total number of characters 

+  required to perform the conversion is returned.

+  Additional conversion parameters are specified in Flags.  

+  The Flags bit LEFT_JUSTIFY is always ignored.

+  All conversions are left justified in Buffer.

+  If Width is 0, PREFIX_ZERO is ignored in Flags.

+  If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas

+  are inserted every 3rd digit starting from the right.

+  If Value is < 0, then the fist character in Buffer is a '-'.

+  If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, 

+  then Buffer is padded with '0' characters so the combination of the optional '-' 

+  sign character, '0' characters, digit characters for Value, and the Null-terminator

+  add up to Width characters.

+

+  If Buffer is NULL, then ASSERT().

+  If unsupported bits are set in Flags, then ASSERT().

+  If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()

+

+  @param  Buffer    Pointer to the output buffer for the produced Null-terminated

+                    string.

+  @param  Flags     The bitmask of flags that specify left justification, zero pad,

+                    and commas.

+  @param  Value     The 64-bit signed value to convert to a string.

+  @param  Width	    The maximum number of characters to place in Buffer.

+  @param  Increment Character increment in Buffer.

+  

+  @return Total number of characters required to perform the conversion.

+

+**/

 UINTN

 BasePrintLibConvertValueToString (

   IN OUT CHAR8   *Buffer,

diff --git a/MdePkg/Library/BasePrintLib/PrintLibInternal.h b/MdePkg/Library/BasePrintLib/PrintLibInternal.h
index c7fecfd..0f7bebf 100644
--- a/MdePkg/Library/BasePrintLib/PrintLibInternal.h
+++ b/MdePkg/Library/BasePrintLib/PrintLibInternal.h
@@ -14,8 +14,6 @@
 

 **/

 

-

-

 //

 // Print primitives

 //

@@ -44,7 +42,7 @@
 #define MAXIMUM_VALUE_CHARACTERS  38

 

 //

-//

+// Record date and time information

 //

 typedef struct {

   UINT16  Year;

@@ -60,6 +58,25 @@ typedef struct {
   UINT8   Pad2;

 } TIME;

 

+/**

+  Worker function that produces a Null-terminated string in an output buffer 

+  based on a Null-terminated format string and variable argument list.

+

+  VSPrint function to process format and place the results in Buffer. Since a 

+  VA_LIST is used this rountine allows the nesting of Vararg routines. Thus 

+  this is the main print working routine

+

+  @param  Buffer        Character buffer to print the results of the parsing

+                        of Format into.

+  @param  BufferSize    Maximum number of characters to put into buffer.

+                        Zero means no limit.

+  @param  Flags         Intial flags value.

+                        Can only have FORMAT_UNICODE and OUTPUT_UNICODE set

+  @param  FormatString  Null-terminated format string.

+

+  @return Number of characters printed.

+

+**/

 UINTN

 BasePrintLibSPrint (

   OUT CHAR8        *Buffer,

@@ -69,6 +86,19 @@ BasePrintLibSPrint (
   ...

   );

 

+/**

+  Internal function that places the character into the Buffer.

+

+  Internal function that places ASCII or Unicode character into the Buffer.

+

+  @param  Buffer      Buffer to place the Unicode or ASCII string.

+  @param  Length      Count of character to be placed into Buffer.

+  @param  Character   Character to be placed into Buffer.

+  @param  Increment   Character increment in Buffer.

+

+  @return Number of characters printed.

+

+**/

 CHAR8 *

 BasePrintLibFillBuffer (

   CHAR8   *Buffer,

@@ -77,6 +107,18 @@ BasePrintLibFillBuffer (
   INTN    Increment

   );

 

+/**

+  Internal function that convert a decimal number to a string in Buffer.

+

+  Print worker function that convert a decimal number to a string in Buffer.

+

+  @param  Buffer    Location to place the Unicode or ASCII string of Value.

+  @param  Value     Value to convert to a Decimal or Hexidecimal string in Buffer.

+  @param  Radix     Radix of the value

+

+  @return Number of characters printed.

+

+**/

 UINTN

 EFIAPI

 BasePrintLibValueToString (

@@ -85,6 +127,43 @@ BasePrintLibValueToString (
   IN UINTN      Radix

   );

 

+/**

+  Internal function that converts a decimal value to a Null-terminated string.

+  

+  Converts the decimal number specified by Value to a Null-terminated  

+  string specified by Buffer containing at most Width characters.

+  If Width is 0 then a width of  MAXIMUM_VALUE_CHARACTERS is assumed.

+  The total number of characters placed in Buffer is returned.

+  If the conversion contains more than Width characters, then only the first

+  Width characters are returned, and the total number of characters 

+  required to perform the conversion is returned.

+  Additional conversion parameters are specified in Flags.  

+  The Flags bit LEFT_JUSTIFY is always ignored.

+  All conversions are left justified in Buffer.

+  If Width is 0, PREFIX_ZERO is ignored in Flags.

+  If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas

+  are inserted every 3rd digit starting from the right.

+  If Value is < 0, then the fist character in Buffer is a '-'.

+  If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, 

+  then Buffer is padded with '0' characters so the combination of the optional '-' 

+  sign character, '0' characters, digit characters for Value, and the Null-terminator

+  add up to Width characters.

+

+  If Buffer is NULL, then ASSERT().

+  If unsupported bits are set in Flags, then ASSERT().

+  If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()

+

+  @param  Buffer    Pointer to the output buffer for the produced Null-terminated

+                    string.

+  @param  Flags     The bitmask of flags that specify left justification, zero pad,

+                    and commas.

+  @param  Value     The 64-bit signed value to convert to a string.

+  @param  Width	    The maximum number of characters to place in Buffer.

+  @param  Increment Character increment in Buffer.

+  

+  @return Total number of characters required to perform the conversion.

+

+**/

 UINTN

 BasePrintLibConvertValueToString (

   IN OUT CHAR8   *Buffer,