* [PATCH] SourceLevelDebugPkg DebugUsb3: Fix some typos
@ 2018-02-06 12:21 Star Zeng
2018-02-06 12:55 ` Wu, Hao A
0 siblings, 1 reply; 2+ messages in thread
From: Star Zeng @ 2018-02-06 12:21 UTC (permalink / raw)
To: edk2-devel; +Cc: Star Zeng, Ruiyu Ni, Hao Wu
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>
---
SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h | 8 ++++----
.../DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c | 8 ++++----
SourceLevelDebugPkg/SourceLevelDebugPkg.dec | 4 ++--
SourceLevelDebugPkg/SourceLevelDebugPkg.uni | 4 ++--
4 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h b/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
index b2042841d28e..b37e032db09b 100644
--- a/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
+++ b/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
@@ -1,7 +1,7 @@
/** @file
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
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
@@ -88,7 +88,7 @@ DebugPortInitialize (
@param Handle Debug port handle.
@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 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 Actual number of bytes read from debug device.
@@ -118,7 +118,7 @@ DebugPortReadBuffer (
@retval 0 NumberOfBytes is 0.
@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
@@ -139,7 +139,7 @@ DebugPortWriteBuffer (
@param Handle Debug port handle.
@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
diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c
index 04e25e3ec2cf..49bad6b5864d 100644
--- a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c
+++ b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c
@@ -1,7 +1,7 @@
/** @file
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
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
@@ -756,7 +756,7 @@ Enable:
@param Handle Debug port handle.
@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 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 Actual number of bytes read from debug device.
@@ -836,7 +836,7 @@ DebugPortReadBuffer (
@retval 0 NumberOfBytes is 0.
@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
@@ -919,7 +919,7 @@ DebugPortWriteBuffer (
@param Handle Debug port handle.
@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
diff --git a/SourceLevelDebugPkg/SourceLevelDebugPkg.dec b/SourceLevelDebugPkg/SourceLevelDebugPkg.dec
index c9a47f625526..b89e9c6ad601 100644
--- a/SourceLevelDebugPkg/SourceLevelDebugPkg.dec
+++ b/SourceLevelDebugPkg/SourceLevelDebugPkg.dec
@@ -6,7 +6,7 @@
# and host, PeCoffExtraActionLib instance to report symbol path information,
# 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
# the terms and conditions of the BSD License that accompanies this distribution.
# The full text of the license may be found at
@@ -92,7 +92,7 @@ [PcdsFixedAtBuild, PcdsPatchableInModule]
## 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.
- # @Prompt Configure ehci host controller memory BAR.
+ # @Prompt Configure xhci host controller memory BAR.
gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbXhciMemorySpaceBase|0xD0000000|UINT64|0x00000007
## The pci address of xhci host controller, in which usb debug feature is enabled.
diff --git a/SourceLevelDebugPkg/SourceLevelDebugPkg.uni b/SourceLevelDebugPkg/SourceLevelDebugPkg.uni
index 781b717e4e24..8a201652274b 100644
--- a/SourceLevelDebugPkg/SourceLevelDebugPkg.uni
+++ b/SourceLevelDebugPkg/SourceLevelDebugPkg.uni
@@ -8,7 +8,7 @@
// and host, PeCoffExtraActionLib instance to report symbol path information,
// 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
// 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"
"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"
"Note that the memory BAR address is only used before Pci bus resource allocation."
--
2.7.0.windows.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] SourceLevelDebugPkg DebugUsb3: Fix some typos
2018-02-06 12:21 [PATCH] SourceLevelDebugPkg DebugUsb3: Fix some typos Star Zeng
@ 2018-02-06 12:55 ` Wu, Hao A
0 siblings, 0 replies; 2+ messages in thread
From: Wu, Hao A @ 2018-02-06 12:55 UTC (permalink / raw)
To: Zeng, Star, edk2-devel@lists.01.org; +Cc: Ni, Ruiyu
Reviewed-by: Hao Wu <hao.a.wu@intel.com>
Best Regards,
Hao Wu
> -----Original Message-----
> From: Zeng, Star
> Sent: Tuesday, February 06, 2018 8:22 PM
> To: edk2-devel@lists.01.org
> Cc: Zeng, Star; Ni, Ruiyu; Wu, Hao A
> Subject: [PATCH] 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>
> ---
> SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h | 8 ++++-
> ---
> .../DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c | 8
> ++++----
> SourceLevelDebugPkg/SourceLevelDebugPkg.dec | 4 ++--
> SourceLevelDebugPkg/SourceLevelDebugPkg.uni | 4 ++--
> 4 files changed, 12 insertions(+), 12 deletions(-)
>
> diff --git a/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
> b/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
> index b2042841d28e..b37e032db09b 100644
> --- a/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
> +++ b/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
> @@ -1,7 +1,7 @@
> /** @file
> 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
> 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
> @@ -88,7 +88,7 @@ DebugPortInitialize (
> @param Handle Debug port handle.
> @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 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 Actual number of bytes read from debug device.
> @@ -118,7 +118,7 @@ DebugPortReadBuffer (
>
> @retval 0 NumberOfBytes is 0.
> @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
> @@ -139,7 +139,7 @@ DebugPortWriteBuffer (
> @param Handle Debug port handle.
>
> @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
> diff --git
> a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommuni
> cationLibUsb3Common.c
> b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommuni
> cationLibUsb3Common.c
> index 04e25e3ec2cf..49bad6b5864d 100644
> ---
> a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommuni
> cationLibUsb3Common.c
> +++
> b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommuni
> cationLibUsb3Common.c
> @@ -1,7 +1,7 @@
> /** @file
> 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
> 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
> @@ -756,7 +756,7 @@ Enable:
> @param Handle Debug port handle.
> @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 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 Actual number of bytes read from debug device.
> @@ -836,7 +836,7 @@ DebugPortReadBuffer (
>
> @retval 0 NumberOfBytes is 0.
> @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
> @@ -919,7 +919,7 @@ DebugPortWriteBuffer (
> @param Handle Debug port handle.
>
> @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
> diff --git a/SourceLevelDebugPkg/SourceLevelDebugPkg.dec
> b/SourceLevelDebugPkg/SourceLevelDebugPkg.dec
> index c9a47f625526..b89e9c6ad601 100644
> --- a/SourceLevelDebugPkg/SourceLevelDebugPkg.dec
> +++ b/SourceLevelDebugPkg/SourceLevelDebugPkg.dec
> @@ -6,7 +6,7 @@
> # and host, PeCoffExtraActionLib instance to report symbol path information,
> # 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
> # the terms and conditions of the BSD License that accompanies this
> distribution.
> # The full text of the license may be found at
> @@ -92,7 +92,7 @@ [PcdsFixedAtBuild, PcdsPatchableInModule]
>
> ## 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.
> - # @Prompt Configure ehci host controller memory BAR.
> + # @Prompt Configure xhci host controller memory BAR.
>
> gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbXhciMemorySpaceBase|0xD0
> 000000|UINT64|0x00000007
>
> ## The pci address of xhci host controller, in which usb debug feature is
> enabled.
> diff --git a/SourceLevelDebugPkg/SourceLevelDebugPkg.uni
> b/SourceLevelDebugPkg/SourceLevelDebugPkg.uni
> index 781b717e4e24..8a201652274b 100644
> --- a/SourceLevelDebugPkg/SourceLevelDebugPkg.uni
> +++ b/SourceLevelDebugPkg/SourceLevelDebugPkg.uni
> @@ -8,7 +8,7 @@
> // and host, PeCoffExtraActionLib instance to report symbol path information,
> // 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
> // 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"
> "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"
> "Note that the
> memory BAR address is only used before Pci bus resource allocation."
> --
> 2.7.0.windows.1
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2018-02-06 12:50 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-02-06 12:21 [PATCH] SourceLevelDebugPkg DebugUsb3: Fix some typos Star Zeng
2018-02-06 12:55 ` Wu, Hao A
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox