SourceLevelDebugPkg DebugUsb3: Fix some typos

Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Hao Wu <hao.a.wu@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Hao Wu <hao.a.wu@intel.com>
This commit is contained in:
Star Zeng 2018-02-04 17:33:10 +08:00
parent a2acb04ca6
commit f4043414da
4 changed files with 12 additions and 12 deletions

View File

@ -1,7 +1,7 @@
/** @file /** @file
Debug Communication Library definitions. Debug Communication Library definitions.
Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR> Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials 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
@ -88,7 +88,7 @@ DebugPortInitialize (
@param Handle Debug port handle. @param Handle Debug port handle.
@param Buffer Pointer to the data buffer to store the data read from the debug device. @param Buffer Pointer to the data buffer to store the data read from the debug device.
@param NumberOfBytes Number of bytes which will be read. @param NumberOfBytes Number of bytes which will be read.
@param Timeout Timeout value for reading from debug device. It unit is Microsecond. @param Timeout Timeout value for reading from debug device. Its unit is Microsecond.
@retval 0 Read data failed, no data is to be read. @retval 0 Read data failed, no data is to be read.
@retval >0 Actual number of bytes read from debug device. @retval >0 Actual number of bytes read from debug device.
@ -118,7 +118,7 @@ DebugPortReadBuffer (
@retval 0 NumberOfBytes is 0. @retval 0 NumberOfBytes is 0.
@retval >0 The number of bytes written to the debug device. @retval >0 The number of bytes written to the debug device.
If this value is less than NumberOfBytes, then the read operation failed. If this value is less than NumberOfBytes, then the write operation failed.
**/ **/
UINTN UINTN
@ -139,7 +139,7 @@ DebugPortWriteBuffer (
@param Handle Debug port handle. @param Handle Debug port handle.
@retval TRUE Data is waiting to be read from the debug device. @retval TRUE Data is waiting to be read from the debug device.
@retval FALSE There is no data waiting to be read from the serial device. @retval FALSE There is no data waiting to be read from the debug device.
**/ **/
BOOLEAN BOOLEAN

View File

@ -1,7 +1,7 @@
/** @file /** @file
Debug Port Library implementation based on usb3 debug port. Debug Port Library implementation based on usb3 debug port.
Copyright (c) 2014 - 2015, Intel Corporation. All rights reserved.<BR> Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials 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
@ -756,7 +756,7 @@ Enable:
@param Handle Debug port handle. @param Handle Debug port handle.
@param Buffer Pointer to the data buffer to store the data read from the debug device. @param Buffer Pointer to the data buffer to store the data read from the debug device.
@param NumberOfBytes Number of bytes which will be read. @param NumberOfBytes Number of bytes which will be read.
@param Timeout Timeout value for reading from debug device. It unit is Microsecond. @param Timeout Timeout value for reading from debug device. Its unit is Microsecond.
@retval 0 Read data failed, no data is to be read. @retval 0 Read data failed, no data is to be read.
@retval >0 Actual number of bytes read from debug device. @retval >0 Actual number of bytes read from debug device.
@ -836,7 +836,7 @@ DebugPortReadBuffer (
@retval 0 NumberOfBytes is 0. @retval 0 NumberOfBytes is 0.
@retval >0 The number of bytes written to the debug device. @retval >0 The number of bytes written to the debug device.
If this value is less than NumberOfBytes, then the read operation failed. If this value is less than NumberOfBytes, then the write operation failed.
**/ **/
UINTN UINTN
@ -919,7 +919,7 @@ DebugPortWriteBuffer (
@param Handle Debug port handle. @param Handle Debug port handle.
@retval TRUE Data is waiting to be read from the debug device. @retval TRUE Data is waiting to be read from the debug device.
@retval FALSE There is no data waiting to be read from the serial device. @retval FALSE There is no data waiting to be read from the debug device.
**/ **/
BOOLEAN BOOLEAN

View File

@ -6,7 +6,7 @@
# and host, PeCoffExtraActionLib instance to report symbol path information, # and host, PeCoffExtraActionLib instance to report symbol path information,
# etc. # etc.
# #
# Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR> # Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials are licensed and made available under # This program and the accompanying materials are licensed and made available under
# the terms and conditions of the BSD License that accompanies this distribution. # the terms and conditions of the BSD License that accompanies this distribution.
# The full text of the license may be found at # The full text of the license may be found at
@ -92,7 +92,7 @@
## The memory BAR of xhci host controller, in which usb debug feature is enabled. ## The memory BAR of xhci host controller, in which usb debug feature is enabled.
## Note that the memory BAR address is only used before Pci bus resource allocation. ## Note that the memory BAR address is only used before Pci bus resource allocation.
# @Prompt Configure ehci host controller memory BAR. # @Prompt Configure xhci host controller memory BAR.
gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbXhciMemorySpaceBase|0xD0000000|UINT64|0x00000007 gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbXhciMemorySpaceBase|0xD0000000|UINT64|0x00000007
## The pci address of xhci host controller, in which usb debug feature is enabled. ## The pci address of xhci host controller, in which usb debug feature is enabled.

View File

@ -8,7 +8,7 @@
// and host, PeCoffExtraActionLib instance to report symbol path information, // and host, PeCoffExtraActionLib instance to report symbol path information,
// etc. // etc.
// //
// Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR> // Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
// //
// This program and the accompanying materials are licensed and made available under // This program and the accompanying materials are licensed and made available under
// the terms and conditions of the BSD License that accompanies this distribution. // the terms and conditions of the BSD License that accompanies this distribution.
@ -70,7 +70,7 @@
#string STR_gEfiSourceLevelDebugPkgTokenSpaceGuid_PcdDebugPortHandleBufferSize_HELP #language en-US "The data buffer size used by debug port in debug communication library instances.\n" #string STR_gEfiSourceLevelDebugPkgTokenSpaceGuid_PcdDebugPortHandleBufferSize_HELP #language en-US "The data buffer size used by debug port in debug communication library instances.\n"
"Its value is not suggested to be changed in platform DSC file." "Its value is not suggested to be changed in platform DSC file."
#string STR_gEfiSourceLevelDebugPkgTokenSpaceGuid_PcdUsbXhciMemorySpaceBase_PROMPT #language en-US "Configure ehci host controller memory BAR." #string STR_gEfiSourceLevelDebugPkgTokenSpaceGuid_PcdUsbXhciMemorySpaceBase_PROMPT #language en-US "Configure xhci host controller memory BAR."
#string STR_gEfiSourceLevelDebugPkgTokenSpaceGuid_PcdUsbXhciMemorySpaceBase_HELP #language en-US "The memory BAR of xhci host controller, in which usb debug feature is enabled.\n" #string STR_gEfiSourceLevelDebugPkgTokenSpaceGuid_PcdUsbXhciMemorySpaceBase_HELP #language en-US "The memory BAR of xhci host controller, in which usb debug feature is enabled.\n"
"Note that the memory BAR address is only used before Pci bus resource allocation." "Note that the memory BAR address is only used before Pci bus resource allocation."