tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Retire Print protocol in MdeModulePkg and update Print2 protocol to provide full set of API in PrintLib classes 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7564 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
qhuang8 2009-02-23 02:58:46 +00:00
parent 72aff63a93
commit e996a8c98a
2 changed files with 192 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
MdeModulePkg/Include/Protocol/Print.h
View File

@ -1,78 +0,0 @@
/** @file
The lite print protocol defines only one print function to
print the format unicode string.
Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef __PPRINT_H__
#define __PPRINT_H__
#define EFI_PRINT_PROTOCOL_GUID \
{ 0xdf2d868e, 0x32fc, 0x4cf0, {0x8e, 0x6b, 0xff, 0xd9, 0x5d, 0x13, 0x43, 0xd0} }
//
// Forward reference for pure ANSI compatability
//
typedef struct _EFI_PRINT_PROTOCOL EFI_PRINT_PROTOCOL;
/**
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 number of Unicode characters in the produced output buffer is returned not including
the Null-terminator.
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.
If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().
If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().
If BufferSize > 1 and FormatString is NULL, then ASSERT().
If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then
ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
contains more than PcdMaximumUnicodeStringLength Unicode characters not including the
Null-terminator, then ASSERT().
@param StartOfBuffer A pointer 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 The number of Unicode characters in the produced output buffer not including the
Null-terminator.
**/
typedef
UINTN
(EFIAPI *UNI_VSPRINT)(
OUT CHAR16 *StartOfBuffer,
IN UINTN BufferSize,
IN CONST CHAR16 *FormatString,
IN VA_LIST Marker
);
struct _EFI_PRINT_PROTOCOL {
UNI_VSPRINT VSPrint;
};
extern EFI_GUID gEfiPrintProtocolGuid;
#endif

209
MdeModulePkg/Include/Protocol/Print2.h
View File

@ -3,7 +3,7 @@
This print protocol defines six basic print functions to This print protocol defines six basic print functions to
print the format unicode and ascii string. print the format unicode and ascii string.
Copyright (c) 2006 - 2008, Intel Corporation Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -61,13 +61,56 @@ typedef struct _EFI_PRINT2_PROTOCOL EFI_PRINT2_PROTOCOL;
**/ **/
typedef typedef
UINTN UINTN
(EFIAPI *UNI_VSPRINT2)( (EFIAPI *UNICODE_VS_PRINT) (
OUT CHAR16 *StartOfBuffer, OUT CHAR16 *StartOfBuffer,
IN UINTN BufferSize, IN UINTN BufferSize,
IN CONST CHAR16 *FormatString, IN CONST CHAR16 *FormatString,
IN VA_LIST Marker IN VA_LIST 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 number of Unicode characters in the produced output buffer is returned not including
the Null-terminator.
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.
If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().
If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().
If BufferSize > 1 and FormatString is NULL, then ASSERT().
If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then
ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
contains more than PcdMaximumUnicodeStringLength Unicode characters not including the
Null-terminator, then ASSERT().
@param StartOfBuffer A pointer 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 ... Variable argument list whose contents are accessed based on the
format string specified by FormatString.
@return The number of Unicode characters in the produced output buffer not including the
Null-terminator.
**/
typedef
UINTN
(EFIAPI *UNICODE_S_PRINT) (
OUT CHAR16 *StartOfBuffer,
IN UINTN BufferSize,
IN CONST CHAR16 *FormatString,
...
);
/** /**
Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated
ASCII format string and a VA_LIST argument list ASCII format string and a VA_LIST argument list
@ -103,13 +146,56 @@ UINTN
**/ **/
typedef typedef
UINTN UINTN
(EFIAPI *UNI_VSPRINT_ASCII)( (EFIAPI *UNICODE_VS_PRINT_ASCII_FORMAT) (
OUT CHAR16 *StartOfBuffer, OUT CHAR16 *StartOfBuffer,
IN UINTN BufferSize, IN UINTN BufferSize,
IN CONST CHAR8 *FormatString, IN CONST CHAR8 *FormatString,
IN VA_LIST Marker IN VA_LIST 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 number of Unicode characters in the produced output buffer is returned not including
the Null-terminator.
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.
If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().
If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().
If BufferSize > 1 and FormatString is NULL, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then
ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
contains more than PcdMaximumUnicodeStringLength Unicode characters not including the
Null-terminator, then ASSERT().
@param StartOfBuffer A pointer 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 ASCII format string.
@param ... Variable argument list whose contents are accessed based on the
format string specified by FormatString.
@return The number of Unicode characters in the produced output buffer not including the
Null-terminator.
**/
typedef
UINTN
(EFIAPI *UNICODE_S_PRINT_ASCII_FORMAT) (
OUT CHAR16 *StartOfBuffer,
IN UINTN BufferSize,
IN CONST CHAR8 *FormatString,
...
);
/** /**
Converts a decimal value to a Null-terminated Unicode string. Converts a decimal value to a Null-terminated Unicode string.
@ -153,7 +239,7 @@ UINTN
**/ **/
typedef typedef
UINTN UINTN
(EFIAPI *VALUE_TO_UNISTRING)( (EFIAPI *UNICODE_VALUE_TO_STRING) (
IN OUT CHAR16 *Buffer, IN OUT CHAR16 *Buffer,
IN UINTN Flags, IN UINTN Flags,
IN INT64 Value, IN INT64 Value,
@ -194,13 +280,55 @@ UINTN
**/ **/
typedef typedef
UINTN UINTN
(EFIAPI *ASCII_VSPRINT)( (EFIAPI *ASCII_VS_PRINT) (
OUT CHAR8 *StartOfBuffer, OUT CHAR8 *StartOfBuffer,
IN UINTN BufferSize, IN UINTN BufferSize,
IN CONST CHAR8 *FormatString, IN CONST CHAR8 *FormatString,
IN VA_LIST Marker IN VA_LIST 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 number of ASCII characters in the produced output buffer is returned not including
the Null-terminator.
If BufferSize is 0, then no output buffer is produced and 0 is returned.
If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().
If BufferSize > 0 and FormatString is NULL, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then
ASSERT().
If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string
contains more than PcdMaximumAsciiStringLength ASCII characters not including the
Null-terminator, then ASSERT().
@param StartOfBuffer A pointer 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 ASCII format string.
@param ... Variable argument list whose contents are accessed based on the
format string specified by FormatString.
@return The number of ASCII characters in the produced output buffer not including the
Null-terminator.
**/
typedef
UINTN
(EFIAPI *ASCII_S_PRINT) (
OUT CHAR8 *StartOfBuffer,
IN UINTN BufferSize,
IN CONST CHAR8 *FormatString,
...
);
/** /**
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
Unicode format string and a VA_LIST argument list. Unicode format string and a VA_LIST argument list.
@ -236,13 +364,56 @@ UINTN
**/ **/
typedef typedef
UINTN UINTN
(EFIAPI *ASCII_VSPRINT_UNI)( (EFIAPI *ASCII_VS_PRINT_UNICODE_FORMAT) (
OUT CHAR8 *StartOfBuffer, OUT CHAR8 *StartOfBuffer,
IN UINTN BufferSize, IN UINTN BufferSize,
IN CONST CHAR16 *FormatString, IN CONST CHAR16 *FormatString,
IN VA_LIST Marker IN VA_LIST Marker
); );
/**
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
Unicode 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 number of ASCII characters in the produced output buffer is returned not including
the Null-terminator.
If BufferSize is 0, then no output buffer is produced and 0 is returned.
If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().
If BufferSize > 0 and FormatString is NULL, then ASSERT().
If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then
ASSERT().
If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string
contains more than PcdMaximumAsciiStringLength ASCII characters not including the
Null-terminator, then ASSERT().
@param StartOfBuffer A pointer 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 ... Variable argument list whose contents are accessed based on the
format string specified by FormatString.
@return The number of ASCII characters in the produced output buffer not including the
Null-terminator.
**/
typedef
UINTN
(EFIAPI *ASCII_S_PRINT_UNICODE_FORMAT) (
OUT CHAR8 *StartOfBuffer,
IN UINTN BufferSize,
IN CONST CHAR16 *FormatString,
...
);
/** /**
Converts a decimal value to a Null-terminated ASCII string. Converts a decimal value to a Null-terminated ASCII string.
@ -285,20 +456,24 @@ UINTN
**/ **/
typedef typedef
UINTN UINTN
(EFIAPI *VALUE_TO_ASCIISTRING)( (EFIAPI *ASCII_VALUE_TO_STRING) (
IN OUT CHAR8 *Buffer, OUT CHAR8 *Buffer,
IN UINTN Flags, IN UINTN Flags,
IN INT64 Value, IN INT64 Value,
IN UINTN Width IN UINTN Width
); );
struct _EFI_PRINT2_PROTOCOL { struct _EFI_PRINT2_PROTOCOL {
UNI_VSPRINT2 VSPrint; UNICODE_VS_PRINT UnicodeVSPrint;
UNI_VSPRINT_ASCII UniVSPrintAscii; UNICODE_S_PRINT UnicodeSPrint;
VALUE_TO_UNISTRING UniValueToString; UNICODE_VS_PRINT_ASCII_FORMAT UnicodeVSPrintAsciiFormat;
ASCII_VSPRINT AsciiVSPrint; UNICODE_S_PRINT_ASCII_FORMAT UnicodeSPrintAsciiFormat;
ASCII_VSPRINT_UNI AsciiVSPrintUni; UNICODE_VALUE_TO_STRING UnicodeValueToString;
VALUE_TO_ASCIISTRING AsciiValueToString; ASCII_VS_PRINT AsciiVSPrint;
ASCII_S_PRINT AsciiSPrint;
ASCII_VS_PRINT_UNICODE_FORMAT AsciiVSPrintUnicodeFormat;
ASCII_S_PRINT_UNICODE_FORMAT AsciiSPrintUnicodeFormat;
ASCII_VALUE_TO_STRING AsciiValueToString;
}; };
extern EFI_GUID gEfiPrint2ProtocolGuid; extern EFI_GUID gEfiPrint2ProtocolGuid;