/** @file\r
- Instance of Print Library based on gEfiPrint2ProtocolGuid.\r
+ Instance of Print Library based on gEfiPrint2SProtocolGuid.\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
+ provided in the Print2S 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
} \\r
} while (FALSE)\r
\r
-EFI_PRINT2_PROTOCOL *mPrint2Protocol = NULL;\r
+EFI_PRINT2S_PROTOCOL *mPrint2SProtocol = NULL;\r
\r
/**\r
- The constructor function caches the pointer to Print2 protocol.\r
+ The constructor function caches the pointer to Print2S protocol.\r
\r
- The constructor function locates Print2 protocol from protocol database.\r
+ The constructor function locates Print2S 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
EFI_STATUS Status;\r
\r
Status = SystemTable->BootServices->LocateProtocol (\r
- &gEfiPrint2ProtocolGuid,\r
+ &gEfiPrint2SProtocolGuid,\r
NULL,\r
- (VOID**) &mPrint2Protocol\r
+ (VOID**) &mPrint2SProtocol\r
);\r
ASSERT_EFI_ERROR (Status);\r
- ASSERT (mPrint2Protocol != NULL);\r
+ ASSERT (mPrint2SProtocol != NULL);\r
\r
return Status;\r
}\r
{\r
ASSERT_UNICODE_BUFFER (StartOfBuffer);\r
ASSERT_UNICODE_BUFFER (FormatString);\r
- return mPrint2Protocol->UnicodeBSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ return mPrint2SProtocol->UnicodeBSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
}\r
\r
/**\r
)\r
{\r
ASSERT_UNICODE_BUFFER (StartOfBuffer);\r
- return mPrint2Protocol->UnicodeBSPrintAsciiFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ return mPrint2SProtocol->UnicodeBSPrintAsciiFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
}\r
\r
/**\r
IN UINTN Width\r
)\r
{\r
- return mPrint2Protocol->UnicodeValueToString (Buffer, Flags, Value, Width);\r
+ RETURN_STATUS Status;\r
+ UINTN BufferSize;\r
+\r
+ if (Width == 0) {\r
+ BufferSize = (MAXIMUM_VALUE_CHARACTERS + 1) * sizeof (CHAR16);\r
+ } else {\r
+ BufferSize = (Width + 1) * sizeof (CHAR16);\r
+ }\r
+\r
+ Status = mPrint2SProtocol->UnicodeValueToStringS (Buffer, BufferSize, Flags, Value, Width);\r
+ if (RETURN_ERROR (Status)) {\r
+ return 0;\r
+ }\r
+\r
+ return StrnLenS (Buffer, BufferSize / sizeof (CHAR16));\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
+ return mPrint2SProtocol->UnicodeValueToStringS (Buffer, BufferSize, Flags, Value, Width);\r
}\r
\r
/**\r
IN BASE_LIST Marker\r
)\r
{\r
- return mPrint2Protocol->AsciiBSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ return mPrint2SProtocol->AsciiBSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
}\r
\r
/**\r
)\r
{\r
ASSERT_UNICODE_BUFFER (FormatString);\r
- return mPrint2Protocol->AsciiBSPrintUnicodeFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ return mPrint2SProtocol->AsciiBSPrintUnicodeFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
}\r
\r
/**\r
IN UINTN Width\r
)\r
{\r
- return mPrint2Protocol->AsciiValueToString (Buffer, Flags, Value, Width);\r
+ RETURN_STATUS Status;\r
+ UINTN BufferSize;\r
+\r
+ if (Width == 0) {\r
+ BufferSize = (MAXIMUM_VALUE_CHARACTERS + 1) * sizeof (CHAR8);\r
+ } else {\r
+ BufferSize = (Width + 1) * sizeof (CHAR8);\r
+ }\r
+\r
+ Status = mPrint2SProtocol->AsciiValueToStringS (Buffer, BufferSize, Flags, Value, Width);\r
+ if (RETURN_ERROR (Status)) {\r
+ return 0;\r
+ }\r
+\r
+ return AsciiStrnLenS (Buffer, BufferSize / sizeof (CHAR8));\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
+ return mPrint2SProtocol->AsciiValueToStringS (Buffer, BufferSize, Flags, Value, Width);\r
}\r
\r
#define PREFIX_SIGN BIT1\r
projects / mirror_edk2.git / blobdiff