Fix some typo.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8008 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
gikidy 2009-04-02 05:34:26 +00:00
parent f98c4b825e
commit 28d3e14ffb
15 changed files with 111 additions and 110 deletions

View File

@ -19,11 +19,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Initialize the serial device hardware. Initialize the serial device hardware.
If no initialization is required, then return RETURN_SUCCESS. If no initialization is required, then return RETURN_SUCCESS.
If the serial device was successfuly initialized, then return RETURN_SUCCESS. If the serial device was successfully initialized, then return RETURN_SUCCESS.
If the serial device could not be initialized, then return RETURN_DEVICE_ERROR. If the serial device could not be initialized, then return RETURN_DEVICE_ERROR.
@retval RETURN_SUCCESS The serial device was initialized. @retval RETURN_SUCCESS The serial device was initialized.
@retval RETURN_DEVICE_ERROR The serail device could not be initialized. @retval RETURN_DEVICE_ERROR The serial device could not be initialized.
**/ **/
RETURN_STATUS RETURN_STATUS
@ -70,7 +70,7 @@ SerialPortWrite (
@param NumberOfBytes Number of bytes which will be read. @param NumberOfBytes Number of bytes which will be read.
@retval 0 Read data failed, No data is to be read. @retval 0 Read data failed, No data is to be read.
@retval >0 Aactual number of bytes read from serial device. @retval >0 Actual number of bytes read from serial device.
**/ **/
UINTN UINTN
@ -83,7 +83,7 @@ SerialPortRead (
/** /**
Polls a serial device to see if there is any data waiting to be read. Polls a serial device to see if there is any data waiting to be read.
Polls aserial device to see if there is any data waiting to be read. Polls a serial device to see if there is any data waiting to be read.
If there is data waiting to be read from the serial device, then TRUE is returned. If there is data waiting to be read from the serial device, then TRUE is returned.
If there is no data waiting to be read from the serial device, then FALSE is returned. If there is no data waiting to be read from the serial device, then FALSE is returned.

View File

@ -22,7 +22,7 @@ extern CONST UINT32 _gUefiDriverRevision;
/** /**
Enrty point to UEFI Application. Entry point to UEFI Application.
This function is the entry point for a UEFI Application. This function must call This function is the entry point for a UEFI Application. This function must call
ProcessLibraryConstructorList(), ProcessModuleEntryPointList(), and ProcessLibraryDestructorList(). ProcessLibraryConstructorList(), ProcessModuleEntryPointList(), and ProcessLibraryDestructorList().

View File

@ -74,9 +74,9 @@ UefiDecompressGetInfo (
Extracts decompressed data to its original form. Extracts decompressed data to its original form.
This function is designed so that the decompression algorithm can be implemented This function is designed so that the decompression algorithm can be implemented
without using any memory services. As a result, this function is not allowed to without using any memory services. As a result, this function is not allowed to
call any memory allocation services in its implementation. It is the caller's r call any memory allocation services in its implementation. It is the caller's
esponsibility to allocate and free the Destination and Scratch buffers. responsibility to allocate and free the Destination and Scratch buffers.
If the compressed source data specified by Source is sucessfully decompressed If the compressed source data specified by Source is successfully decompressed
into Destination, then RETURN_SUCCESS is returned. If the compressed source data into Destination, then RETURN_SUCCESS is returned. If the compressed source data
specified by Source is not in a valid compressed data format, specified by Source is not in a valid compressed data format,
then RETURN_INVALID_PARAMETER is returned. then RETURN_INVALID_PARAMETER is returned.

View File

@ -62,7 +62,7 @@ typedef struct {
Macro that returns the number of 100 ns units for a specified number of microseconds. Macro that returns the number of 100 ns units for a specified number of microseconds.
Useful for managing EFI timer events. Useful for managing EFI timer events.
@param Microseconds Number of microseonds. @param Microseconds Number of microseconds.
@return The number of 100 ns units equivalent to the number of microseconds specified @return The number of 100 ns units equivalent to the number of microseconds specified
by Microseconds. by Microseconds.
@ -71,7 +71,7 @@ typedef struct {
#define EFI_TIMER_PERIOD_MICROSECONDS(Microseconds) MultU64x32((UINT64)(Microseconds), 10) #define EFI_TIMER_PERIOD_MICROSECONDS(Microseconds) MultU64x32((UINT64)(Microseconds), 10)
/** /**
Macro that returns the number of 100 ns units for a specified number of milliseoconds. Macro that returns the number of 100 ns units for a specified number of milliseconds.
Useful for managing EFI timer events. Useful for managing EFI timer events.
@param Milliseconds Number of milliseconds. @param Milliseconds Number of milliseconds.
@ -83,7 +83,7 @@ typedef struct {
#define EFI_TIMER_PERIOD_MILLISECONDS(Milliseconds) MultU64x32((UINT64)(Milliseconds), 10000) #define EFI_TIMER_PERIOD_MILLISECONDS(Milliseconds) MultU64x32((UINT64)(Milliseconds), 10000)
/** /**
Macro that returns the number of 100 ns units for a specified number of seoconds. Macro that returns the number of 100 ns units for a specified number of seconds.
Useful for managing EFI timer events. Useful for managing EFI timer events.
@param Seconds Number of seconds. @param Seconds Number of seconds.
@ -378,9 +378,9 @@ EfiReleaseLock (
function. function.
@retval EFI_SUCCESS ControllerHandle is managed by the driver @retval EFI_SUCCESS ControllerHandle is managed by the driver
specifed by DriverBindingHandle. specified by DriverBindingHandle.
@retval EFI_UNSUPPORTED ControllerHandle is not managed by the driver @retval EFI_UNSUPPORTED ControllerHandle is not managed by the driver
specifed by DriverBindingHandle. specified by DriverBindingHandle.
**/ **/
EFI_STATUS EFI_STATUS
@ -436,7 +436,7 @@ EfiTestChildHandle (
@retval EFI_SUCCESS The Unicode string that matches the language @retval EFI_SUCCESS The Unicode string that matches the language
specified by Language was found specified by Language was found
in the table of Unicoide strings UnicodeStringTable, in the table of Unicode strings UnicodeStringTable,
and it was returned in UnicodeString. and it was returned in UnicodeString.
@retval EFI_INVALID_PARAMETER Language is NULL. @retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER UnicodeString is NULL. @retval EFI_INVALID_PARAMETER UnicodeString is NULL.
@ -468,7 +468,7 @@ LookupUnicodeString (
RFC 4646 language code for the Unicode string to look up and RFC 4646 language code for the Unicode string to look up and
return. If Iso639Language is TRUE, then this ASCII string is return. If Iso639Language is TRUE, then this ASCII string is
not assumed to be Null-terminated, and only the first three not assumed to be Null-terminated, and only the first three
chacters are used. If Iso639Language is FALSE, then this ASCII characters are used. If Iso639Language is FALSE, then this ASCII
string must be Null-terminated. string must be Null-terminated.
@param SupportedLanguages A pointer to a Null-terminated ASCII string that contains a @param SupportedLanguages A pointer to a Null-terminated ASCII string that contains a
set of ISO 639-2 or RFC 4646 language codes that the Unicode set of ISO 639-2 or RFC 4646 language codes that the Unicode
@ -1064,7 +1064,7 @@ AsciiErrorPrint (
@param X X coordinate to print the string. @param X X coordinate to print the string.
@param Y Y coordinate to print the string. @param Y Y coordinate to print the string.
@param ForeGround The forground color of the string being printed. This is @param ForeGround The foreground color of the string being printed. This is
an optional parameter that may be NULL. If it is NULL, an optional parameter that may be NULL. If it is NULL,
then the foreground color of the current ConOut device then the foreground color of the current ConOut device
in the EFI_SYSTEM_TABLE is used. in the EFI_SYSTEM_TABLE is used.
@ -1112,7 +1112,7 @@ PrintXY (
@param X X coordinate to print the string. @param X X coordinate to print the string.
@param Y Y coordinate to print the string. @param Y Y coordinate to print the string.
@param ForeGround The forground color of the string being printed. This is @param ForeGround The foreground color of the string being printed. This is
an optional parameter that may be NULL. If it is NULL, an optional parameter that may be NULL. If it is NULL,
then the foreground color of the current ConOut device then the foreground color of the current ConOut device
in the EFI_SYSTEM_TABLE is used. in the EFI_SYSTEM_TABLE is used.
@ -1262,7 +1262,7 @@ EfiLibInstallDriverBindingComponentName2 (
@param ImageHandle The image handle of the driver. @param ImageHandle The image handle of the driver.
@param SystemTable The EFI System Table that was passed to the driver's entry point. @param SystemTable The EFI System Table that was passed to the driver's entry point.
@param DriverBinding A Driver Binding Protocol instance that this driver is producing. @param DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installe onto. If this @param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this
parameter is NULL, then a new handle is created. parameter is NULL, then a new handle is created.
@param ComponentName A Component Name Protocol instance that this driver is producing. @param ComponentName A Component Name Protocol instance that this driver is producing.
@param ComponentName2 A Component Name 2 Protocol instance that this driver is producing. @param ComponentName2 A Component Name 2 Protocol instance that this driver is producing.

View File

@ -180,7 +180,7 @@ EfiSetWakeupTime (
@param VendorGuid Unify identifier for vendor. @param VendorGuid Unify identifier for vendor.
@param Attributes Point to memory location to return the attributes of variable. If the point @param Attributes Point to memory location to return the attributes of variable. If the point
is NULL, the parameter would be ignored. is NULL, the parameter would be ignored.
@param DataSize As input, point to the maxinum size of return Data-Buffer. @param DataSize As input, point to the maximum size of return Data-Buffer.
As output, point to the actual size of the returned Data-Buffer. As output, point to the actual size of the returned Data-Buffer.
@param Data Point to return Data-Buffer. @param Data Point to return Data-Buffer.
@ -214,8 +214,8 @@ EfiGetVariable (
variable name data. When the entire variable list has been returned, the error EFI_NOT_FOUND variable name data. When the entire variable list has been returned, the error EFI_NOT_FOUND
is returned. is returned.
@param VariableNameSize As input, point to maxinum size of variable name. @param VariableNameSize As input, point to maximum size of variable name.
As output, point to actual size of varaible name. As output, point to actual size of variable name.
@param VariableName As input, supplies the last VariableName that was returned by @param VariableName As input, supplies the last VariableName that was returned by
GetNextVariableName(). GetNextVariableName().
As output, returns the name of variable. The name As output, returns the name of variable. The name
@ -317,7 +317,7 @@ EfiGetNextHighMonotonicCount (
Calling this interface with ResetType of EfiResetShutdown causes the system to enter a power state equivalent to the Calling this interface with ResetType of EfiResetShutdown causes the system to enter a power state equivalent to the
ACPI G2/S5 or G3 states. If the system does not support this reset type, then when the system is rebooted, it should ACPI G2/S5 or G3 states. If the system does not support this reset type, then when the system is rebooted, it should
exhibit the EfiResetCold attributes. exhibit the EfiResetCold attributes.
The platform may optionally log the parmeters from any non-normal reset that occurs. The platform may optionally log the parameters from any non-normal reset that occurs.
The ResetSystem() function does not return. The ResetSystem() function does not return.
@param ResetType The type of reset to perform. @param ResetType The type of reset to perform.

View File

@ -230,7 +230,7 @@ UsbSetReportRequest (
@retval EFI_SUCCESS The request executed successfully. @retval EFI_SUCCESS The request executed successfully.
@retval EFI_OUT_OF_RESOURCES The request could not be completed because the @retval EFI_OUT_OF_RESOURCES The request could not be completed because the
buffer specifed by ReportLength and Report is not buffer specified by ReportLength and Report is not
large enough to hold the result of the request. large enough to hold the result of the request.
@retval EFI_TIMEOUT A timeout occurred executing the request. @retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error. @retval EFI_DEVICE_ERROR The request failed due to a device error.
@ -266,7 +266,7 @@ UsbGetReportRequest (
@retval EFI_SUCCESS The request executed successfully. @retval EFI_SUCCESS The request executed successfully.
@retval EFI_OUT_OF_RESOURCES The request could not be completed because the @retval EFI_OUT_OF_RESOURCES The request could not be completed because the
buffer specifed by DescriptorLength and Descriptor buffer specified by DescriptorLength and Descriptor
is not large enough to hold the result of the request. is not large enough to hold the result of the request.
@retval EFI_TIMEOUT A timeout occurred executing the request. @retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error. The transfer @retval EFI_DEVICE_ERROR The request failed due to a device error. The transfer

View File

@ -22,11 +22,11 @@
Initialize the serial device hardware. Initialize the serial device hardware.
If no initialization is required, then return RETURN_SUCCESS. If no initialization is required, then return RETURN_SUCCESS.
If the serial device was successfuly initialized, then return RETURN_SUCCESS. If the serial device was successfully initialized, then return RETURN_SUCCESS.
If the serial device could not be initialized, then return RETURN_DEVICE_ERROR. If the serial device could not be initialized, then return RETURN_DEVICE_ERROR.
@retval RETURN_SUCCESS The serial device was initialized. @retval RETURN_SUCCESS The serial device was initialized.
@retval RETURN_DEVICE_ERROR The serail device could not be initialized. @retval RETURN_DEVICE_ERROR The serial device could not be initialized.
**/ **/
RETURN_STATUS RETURN_STATUS
@ -95,7 +95,7 @@ SerialPortRead (
/** /**
Polls a serial device to see if there is any data waiting to be read. Polls a serial device to see if there is any data waiting to be read.
Polls aserial device to see if there is any data waiting to be read. Polls a serial device to see if there is any data waiting to be read.
If there is data waiting to be read from the serial device, then TRUE is returned. If there is data waiting to be read from the serial device, then TRUE is returned.
If there is no data waiting to be read from the serial device, then FALSE is returned. If there is no data waiting to be read from the serial device, then FALSE is returned.

View File

@ -707,9 +707,9 @@ UefiDecompressGetInfo (
Extracts decompressed data to its original form. Extracts decompressed data to its original form.
This function is designed so that the decompression algorithm can be implemented This function is designed so that the decompression algorithm can be implemented
without using any memory services. As a result, this function is not allowed to without using any memory services. As a result, this function is not allowed to
call any memory allocation services in its implementation. It is the caller's r call any memory allocation services in its implementation. It is the caller's
esponsibility to allocate and free the Destination and Scratch buffers. responsibility to allocate and free the Destination and Scratch buffers.
If the compressed source data specified by Source is sucessfully decompressed If the compressed source data specified by Source is successfully decompressed
into Destination, then RETURN_SUCCESS is returned. If the compressed source data into Destination, then RETURN_SUCCESS is returned. If the compressed source data
specified by Source is not in a valid compressed data format, specified by Source is not in a valid compressed data format,
then RETURN_INVALID_PARAMETER is returned. then RETURN_INVALID_PARAMETER is returned.

View File

@ -18,7 +18,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/** /**
Enrty point to UEFI Application. Entry point to UEFI Application.
This function is the entry point for a UEFI Application. This function must call This function is the entry point for a UEFI Application. This function must call
ProcessLibraryConstructorList(), ProcessModuleEntryPointList(), and ProcessLibraryDestructorList(). ProcessLibraryConstructorList(), ProcessModuleEntryPointList(), and ProcessLibraryDestructorList().

View File

@ -306,7 +306,7 @@ EfiLibInstallDriverBindingComponentName2 (
@param ImageHandle The image handle of the driver. @param ImageHandle The image handle of the driver.
@param SystemTable The EFI System Table that was passed to the driver's entry point. @param SystemTable The EFI System Table that was passed to the driver's entry point.
@param DriverBinding A Driver Binding Protocol instance that this driver is producing. @param DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installe onto. If this @param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this
parameter is NULL, then a new handle is created. parameter is NULL, then a new handle is created.
@param ComponentName A Component Name Protocol instance that this driver is producing. @param ComponentName A Component Name Protocol instance that this driver is producing.
@param ComponentName2 A Component Name 2 Protocol instance that this driver is producing. @param ComponentName2 A Component Name 2 Protocol instance that this driver is producing.

View File

@ -456,9 +456,9 @@ EfiReleaseLock (
function. function.
@retval EFI_SUCCESS ControllerHandle is managed by the driver @retval EFI_SUCCESS ControllerHandle is managed by the driver
specifed by DriverBindingHandle. specified by DriverBindingHandle.
@retval EFI_UNSUPPORTED ControllerHandle is not managed by the driver @retval EFI_UNSUPPORTED ControllerHandle is not managed by the driver
specifed by DriverBindingHandle. specified by DriverBindingHandle.
**/ **/
EFI_STATUS EFI_STATUS
@ -581,7 +581,7 @@ EfiTestChildHandle (
@retval EFI_SUCCESS The Unicode string that matches the language @retval EFI_SUCCESS The Unicode string that matches the language
specified by Language was found specified by Language was found
in the table of Unicoide strings UnicodeStringTable, in the table of Unicode strings UnicodeStringTable,
and it was returned in UnicodeString. and it was returned in UnicodeString.
@retval EFI_INVALID_PARAMETER Language is NULL. @retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER UnicodeString is NULL. @retval EFI_INVALID_PARAMETER UnicodeString is NULL.
@ -661,7 +661,7 @@ LookupUnicodeString (
RFC 4646 language code for the Unicode string to look up and RFC 4646 language code for the Unicode string to look up and
return. If Iso639Language is TRUE, then this ASCII string is return. If Iso639Language is TRUE, then this ASCII string is
not assumed to be Null-terminated, and only the first three not assumed to be Null-terminated, and only the first three
chacters are used. If Iso639Language is FALSE, then this ASCII characters are used. If Iso639Language is FALSE, then this ASCII
string must be Null-terminated. string must be Null-terminated.
@param SupportedLanguages A pointer to a Null-terminated ASCII string that contains a @param SupportedLanguages A pointer to a Null-terminated ASCII string that contains a
set of ISO 639-2 or RFC 4646 language codes that the Unicode set of ISO 639-2 or RFC 4646 language codes that the Unicode
@ -1191,19 +1191,20 @@ FreeUnicodeStringTable (
} }
/** /**
Returns a pointer to an allocated buffer that contains the contents of a Returns a pointer to an allocated buffer that contains the contents of a
variable retrieved through the UEFI Runtime Service GetVariable(). The variable retrieved through the UEFI Runtime Service GetVariable(). The
returned buffer is allocated using AllocatePool(). The caller is responsible returned buffer is allocated using AllocatePool(). The caller is responsible
for freeing tis buffer with FreePool(). for freeing this buffer with FreePool().
If Name is NULL, then ASSERT(). If Name is NULL, then ASSERT().
If Guid is NULL, then ASSERT(). If Guid is NULL, then ASSERT().
@param[in] Name Pointer to a Null-terminated Unicode string. @param[in] Name Pointer to a Null-terminated Unicode string.
@param[in] Guid Pointer to an EFI_GUID structure @param[in] Guid Pointer to an EFI_GUID structure
@retval NULL The variable could not be retrieved. @retval NULL The variable could not be retrieved.
@retval Other A pointer to allocated buffer containing the variable contents @retval NULL There are not enough resources available for the variable contents.
@retval Other A pointer to allocated buffer containing the variable contents.
**/ **/
VOID * VOID *

View File

@ -85,22 +85,22 @@ InternalPrint (
return Return; return Return;
} }
/** /**
Prints a formatted Unicode string to the console output device specified by Prints a formatted Unicode string to the console output device specified by
ConOut defined in the EFI_SYSTEM_TABLE. ConOut defined in the EFI_SYSTEM_TABLE.
This function prints a formatted Unicode string to the console output device This function prints a formatted Unicode string to the console output device
specified by ConOut in EFI_SYSTEM_TABLE and returns the number of Unicode specified by ConOut in EFI_SYSTEM_TABLE and returns the number of Unicode
characters that printed to ConOut. If the length of the formatted Unicode characters that printed to ConOut. If the length of the formatted Unicode
string is greater than PcdUefiLibMaxPrintBufferSize, then only the first string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
PcdUefiLibMaxPrintBufferSize characters are sent to ConOut. PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.
If Format is NULL, then ASSERT(). If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT(). If Format is not aligned on a 16-bit boundary, then ASSERT().
@param Format Null-terminated Unicode format string. @param Format Null-terminated Unicode format string.
@param ... Variable argument list whose contents are accessed based @param ... Variable argument list whose contents are accessed based
on the format string specified by Format. on the format string specified by Format.
@return Number of Unicode characters printed to ConOut. @return Number of Unicode characters printed to ConOut.
**/ **/
@ -123,22 +123,22 @@ Print (
return Return; return Return;
} }
/** /**
Prints a formatted Unicode string to the console output device specified by Prints a formatted Unicode string to the console output device specified by
StdErr defined in the EFI_SYSTEM_TABLE. StdErr defined in the EFI_SYSTEM_TABLE.
This function prints a formatted Unicode string to the console output device This function prints a formatted Unicode string to the console output device
specified by StdErr in EFI_SYSTEM_TABLE and returns the number of Unicode specified by StdErr in EFI_SYSTEM_TABLE and returns the number of Unicode
characters that printed to StdErr. If the length of the formatted Unicode characters that printed to StdErr. If the length of the formatted Unicode
string is greater than PcdUefiLibMaxPrintBufferSize, then only the first string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
PcdUefiLibMaxPrintBufferSize characters are sent to StdErr. PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.
If Format is NULL, then ASSERT(). If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT(). If Format is not aligned on a 16-bit boundary, then ASSERT().
@param Format Null-terminated Unicode format string. @param Format Null-terminated Unicode format string.
@param ... Variable argument list whose contents are accessed based @param ... Variable argument list whose contents are accessed based
on the format string specified by Format. on the format string specified by Format.
@return Number of Unicode characters printed to StdErr. @return Number of Unicode characters printed to StdErr.
**/ **/
@ -213,21 +213,21 @@ AsciiInternalPrint (
return Return; return Return;
} }
/** /**
Prints a formatted ASCII string to the console output device specified by Prints a formatted ASCII string to the console output device specified by
ConOut defined in the EFI_SYSTEM_TABLE. ConOut defined in the EFI_SYSTEM_TABLE.
This function prints a formatted ASCII string to the console output device This function prints a formatted ASCII string to the console output device
specified by ConOut in EFI_SYSTEM_TABLE and returns the number of ASCII specified by ConOut in EFI_SYSTEM_TABLE and returns the number of ASCII
characters that printed to ConOut. If the length of the formatted ASCII characters that printed to ConOut. If the length of the formatted ASCII
string is greater than PcdUefiLibMaxPrintBufferSize, then only the first string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
PcdUefiLibMaxPrintBufferSize characters are sent to ConOut. PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.
If Format is NULL, then ASSERT(). If Format is NULL, then ASSERT().
@param Format Null-terminated ASCII format string. @param Format Null-terminated ASCII format string.
@param ... Variable argument list whose contents are accessed based @param ... Variable argument list whose contents are accessed based
on the format string specified by Format. on the format string specified by Format.
@return Number of ASCII characters printed to ConOut. @return Number of ASCII characters printed to ConOut.
**/ **/
@ -251,21 +251,21 @@ AsciiPrint (
return Return; return Return;
} }
/** /**
Prints a formatted ASCII string to the console output device specified by Prints a formatted ASCII string to the console output device specified by
StdErr defined in the EFI_SYSTEM_TABLE. StdErr defined in the EFI_SYSTEM_TABLE.
This function prints a formatted ASCII string to the console output device This function prints a formatted ASCII string to the console output device
specified by StdErr in EFI_SYSTEM_TABLE and returns the number of ASCII specified by StdErr in EFI_SYSTEM_TABLE and returns the number of ASCII
characters that printed to StdErr. If the length of the formatted ASCII characters that printed to StdErr. If the length of the formatted ASCII
string is greater than PcdUefiLibMaxPrintBufferSize, then only the first string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
PcdUefiLibMaxPrintBufferSize characters are sent to StdErr. PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.
If Format is NULL, then ASSERT(). If Format is NULL, then ASSERT().
@param Format Null-terminated ASCII format string. @param Format Null-terminated ASCII format string.
@param ... Variable argument list whose contents are accessed based @param ... Variable argument list whose contents are accessed based
on the format string specified by Format. on the format string specified by Format.
@return Number of ASCII characters printed to ConErr. @return Number of ASCII characters printed to ConErr.
**/ **/
@ -530,39 +530,39 @@ Error:
} }
/** /**
Prints a formatted Unicode string to a graphics console device specified by Prints a formatted Unicode string to a graphics console device specified by
ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates. ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates.
This function prints a formatted Unicode string to the graphics console device This function prints a formatted Unicode string to the graphics console device
specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of
Unicode characters printed. If the length of the formatted Unicode string is Unicode characters printed. If the length of the formatted Unicode string is
greater than PcdUefiLibMaxPrintBufferSize, then only the first greater than PcdUefiLibMaxPrintBufferSize, then only the first
PcdUefiLibMaxPrintBufferSize characters are printed. The EFI_HII_FONT_PROTOCOL PcdUefiLibMaxPrintBufferSize characters are printed. The EFI_HII_FONT_PROTOCOL
is used to convert the string to a bitmap using the glyphs registered with the is used to convert the string to a bitmap using the glyphs registered with the
HII database. No wrapping is performed, so any portions of the string the fall HII database. No wrapping is performed, so any portions of the string the fall
outside the active display region will not be displayed. outside the active display region will not be displayed.
If a graphics console device is not associated with the ConsoleOutputHandle If a graphics console device is not associated with the ConsoleOutputHandle
defined in the EFI_SYSTEM_TABLE then no string is printed, and 0 is returned. defined in the EFI_SYSTEM_TABLE then no string is printed, and 0 is returned.
If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no
string is printed, and 0 is returned. string is printed, and 0 is returned.
If Format is NULL, then ASSERT(). If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT(). If Format is not aligned on a 16-bit boundary, then ASSERT().
@param X X coordinate to print the string. @param X X coordinate to print the string.
@param Y Y coordinate to print the string. @param Y Y coordinate to print the string.
@param ForeGround The forground color of the string being printed. This is @param ForeGround The foreground color of the string being printed. This is
an optional parameter that may be NULL. If it is NULL, an optional parameter that may be NULL. If it is NULL,
then the foreground color of the current ConOut device then the foreground color of the current ConOut device
in the EFI_SYSTEM_TABLE is used. in the EFI_SYSTEM_TABLE is used.
@param BackGround The background color of the string being printed. This is @param BackGround The background color of the string being printed. This is
an optional parameter that may be NULL. If it is NULL, an optional parameter that may be NULL. If it is NULL,
then the background color of the current ConOut device then the background color of the current ConOut device
in the EFI_SYSTEM_TABLE is used. in the EFI_SYSTEM_TABLE is used.
@param Format Null-terminated Unicode format string. See Print Library @param Format Null-terminated Unicode format string. See Print Library
for the supported format string syntax. for the supported format string syntax.
@param ... Variable argument list whose contents are accessed based on @param ... Variable argument list whose contents are accessed based on
the format string specified by Format. the format string specified by Format.
@return The number of Unicode characters printed. @return The number of Unicode characters printed.
@ -604,38 +604,38 @@ PrintXY (
} }
/** /**
Prints a formatted ASCII string to a graphics console device specified by Prints a formatted ASCII string to a graphics console device specified by
ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates. ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates.
This function prints a formatted ASCII string to the graphics console device This function prints a formatted ASCII string to the graphics console device
specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of
ASCII characters printed. If the length of the formatted ASCII string is ASCII characters printed. If the length of the formatted ASCII string is
greater than PcdUefiLibMaxPrintBufferSize, then only the first greater than PcdUefiLibMaxPrintBufferSize, then only the first
PcdUefiLibMaxPrintBufferSize characters are printed. The EFI_HII_FONT_PROTOCOL PcdUefiLibMaxPrintBufferSize characters are printed. The EFI_HII_FONT_PROTOCOL
is used to convert the string to a bitmap using the glyphs registered with the is used to convert the string to a bitmap using the glyphs registered with the
HII database. No wrapping is performed, so any portions of the string the fall HII database. No wrapping is performed, so any portions of the string the fall
outside the active display region will not be displayed. outside the active display region will not be displayed.
If a graphics console device is not associated with the ConsoleOutputHandle If a graphics console device is not associated with the ConsoleOutputHandle
defined in the EFI_SYSTEM_TABLE then no string is printed, and 0 is returned. defined in the EFI_SYSTEM_TABLE then no string is printed, and 0 is returned.
If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no
string is printed, and 0 is returned. string is printed, and 0 is returned.
If Format is NULL, then ASSERT(). If Format is NULL, then ASSERT().
@param X X coordinate to print the string. @param X X coordinate to print the string.
@param Y Y coordinate to print the string. @param Y Y coordinate to print the string.
@param ForeGround The forground color of the string being printed. This is @param ForeGround The foreground color of the string being printed. This is
an optional parameter that may be NULL. If it is NULL, an optional parameter that may be NULL. If it is NULL,
then the foreground color of the current ConOut device then the foreground color of the current ConOut device
in the EFI_SYSTEM_TABLE is used. in the EFI_SYSTEM_TABLE is used.
@param BackGround The background color of the string being printed. This is @param BackGround The background color of the string being printed. This is
an optional parameter that may be NULL. If it is NULL, an optional parameter that may be NULL. If it is NULL,
then the background color of the current ConOut device then the background color of the current ConOut device
in the EFI_SYSTEM_TABLE is used. in the EFI_SYSTEM_TABLE is used.
@param Format Null-terminated ASCII format string. See Print Library @param Format Null-terminated ASCII format string. See Print Library
for the supported format string syntax. for the supported format string syntax.
@param ... Variable argument list whose contents are accessed based on @param ... Variable argument list whose contents are accessed based on
the format string specified by Format. the format string specified by Format.
@return The number of ASCII characters printed. @return The number of ASCII characters printed.

View File

@ -33,7 +33,7 @@
Calling this interface with ResetType of EfiResetShutdown causes the system to enter a power state equivalent to the Calling this interface with ResetType of EfiResetShutdown causes the system to enter a power state equivalent to the
ACPI G2/S5 or G3 states. If the system does not support this reset type, then when the system is rebooted, it should ACPI G2/S5 or G3 states. If the system does not support this reset type, then when the system is rebooted, it should
exhibit the EfiResetCold attributes. exhibit the EfiResetCold attributes.
The platform may optionally log the parmeters from any non-normal reset that occurs. The platform may optionally log the parameters from any non-normal reset that occurs.
The ResetSystem() function does not return. The ResetSystem() function does not return.
@param ResetType The type of reset to perform. @param ResetType The type of reset to perform.
@ -208,7 +208,7 @@ EfiSetWakeupTime (
@param VendorGuid Unify identifier for vendor. @param VendorGuid Unify identifier for vendor.
@param Attributes Point to memory location to return the attributes of variable. If the point @param Attributes Point to memory location to return the attributes of variable. If the point
is NULL, the parameter would be ignored. is NULL, the parameter would be ignored.
@param DataSize As input, point to the maxinum size of return Data-Buffer. @param DataSize As input, point to the maximum size of return Data-Buffer.
As output, point to the actual size of the returned Data-Buffer. As output, point to the actual size of the returned Data-Buffer.
@param Data Point to return Data-Buffer. @param Data Point to return Data-Buffer.
@ -246,8 +246,8 @@ EfiGetVariable (
variable name data. When the entire variable list has been returned, the error EFI_NOT_FOUND variable name data. When the entire variable list has been returned, the error EFI_NOT_FOUND
is returned. is returned.
@param VariableNameSize As input, point to maxinum size of variable name. @param VariableNameSize As input, point to maximum size of variable name.
As output, point to actual size of varaible name. As output, point to actual size of variable name.
@param VariableName As input, supplies the last VariableName that was returned by @param VariableName As input, supplies the last VariableName that was returned by
GetNextVariableName(). GetNextVariableName().
As output, returns the name of variable. The name As output, returns the name of variable. The name

View File

@ -163,8 +163,8 @@ UsbGetReportDescriptor (
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbGetProtocolRequest ( UsbGetProtocolRequest (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT8 Interface, IN UINT8 Interface,
OUT UINT8 *Protocol OUT UINT8 *Protocol
) )
{ {
@ -441,7 +441,7 @@ UsbSetReportRequest (
@retval EFI_SUCCESS The request executed successfully. @retval EFI_SUCCESS The request executed successfully.
@retval EFI_OUT_OF_RESOURCES The request could not be completed because the @retval EFI_OUT_OF_RESOURCES The request could not be completed because the
buffer specifed by ReportLength and Report is not buffer specified by ReportLength and Report is not
large enough to hold the result of the request. large enough to hold the result of the request.
@retval EFI_TIMEOUT A timeout occurred executing the request. @retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error. @retval EFI_DEVICE_ERROR The request failed due to a device error.

View File

@ -37,7 +37,7 @@
@retval EFI_SUCCESS The request executed successfully. @retval EFI_SUCCESS The request executed successfully.
@retval EFI_OUT_OF_RESOURCES The request could not be completed because the @retval EFI_OUT_OF_RESOURCES The request could not be completed because the
buffer specifed by DescriptorLength and Descriptor buffer specified by DescriptorLength and Descriptor
is not large enough to hold the result of the request. is not large enough to hold the result of the request.
@retval EFI_TIMEOUT A timeout occurred executing the request. @retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error. The transfer @retval EFI_DEVICE_ERROR The request failed due to a device error. The transfer