#define __PPRINT_H__\r
\r
#define EFI_PRINT_PROTOCOL_GUID \\r
- { 0x5bcc3dbc, 0x8c57, 0x450a, { 0xbb, 0xc, 0xa1, 0xc0, 0xbd, 0xde, 0x48, 0xc } }\r
+ { 0xdf2d868e, 0x32fc, 0x4cf0, {0x8e, 0x6b, 0xff, 0xd9, 0x5d, 0x13, 0x43, 0xd0} }\r
\r
//\r
// Forward reference for pure ANSI compatability\r
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 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
-typedef\r
-UINTN\r
-(EFIAPI *UNI_VSPRINT_ASCII)(\r
- OUT CHAR16 *StartOfBuffer,\r
- IN UINTN BufferSize,\r
- IN CONST CHAR8 *FormatString,\r
- IN VA_LIST 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
-typedef\r
-UINTN\r
-(EFIAPI *VALUE_TO_UNISTRING)(\r
- IN OUT CHAR16 *Buffer,\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
- 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
-typedef\r
-UINTN\r
-(EFIAPI *ASCII_VSPRINT)(\r
- OUT CHAR8 *StartOfBuffer,\r
- IN UINTN BufferSize,\r
- IN CONST CHAR8 *FormatString,\r
- 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 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
-typedef\r
-UINTN\r
-(EFIAPI *ASCII_VSPRINT_UNI)(\r
- OUT CHAR8 *StartOfBuffer,\r
- IN UINTN BufferSize,\r
- IN CONST CHAR16 *FormatString,\r
- IN VA_LIST Marker\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
-typedef\r
-UINTN\r
-(EFIAPI *VALUE_TO_ASCIISTRING)(\r
- IN OUT CHAR8 *Buffer,\r
- IN UINTN Flags,\r
- IN INT64 Value,\r
- IN UINTN Width\r
- );\r
\r
struct _EFI_PRINT_PROTOCOL {\r
UNI_VSPRINT VSPrint;\r
- UNI_VSPRINT_ASCII UniVSPrintAscii;\r
- VALUE_TO_UNISTRING UniValueToString; \r
- ASCII_VSPRINT AsciiVSPrint; \r
- ASCII_VSPRINT_UNI AsciiVSPrintUni;\r
- VALUE_TO_ASCIISTRING AsciiValueToString;\r
};\r
\r
extern EFI_GUID gEfiPrintProtocolGuid;\r