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>

diff --git a/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h b/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
index b2042841d28e7c0d1d949a05e2142f8122ed4ca1..b37e032db09bedac4e968ce3454af9fc0953ed99 100644 (file)
--- a/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
+++ b/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
@@ -1,7 +1,7 @@
 /** @file\r
   Debug Communication Library definitions.\r
 \r
 /** @file\r
   Debug Communication Library definitions.\r
 \r

-  Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r

   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r


@@ -88,7 +88,7 @@ DebugPortInitialize (
   @param  Handle           Debug port handle.\r
   @param  Buffer           Pointer to the data buffer to store the data read from the debug device.\r
   @param  NumberOfBytes    Number of bytes which will be read.\r
   @param  Handle           Debug port handle.\r
   @param  Buffer           Pointer to the data buffer to store the data read from the debug device.\r
   @param  NumberOfBytes    Number of bytes which will be read.\r

-  @param  Timeout          Timeout value for reading from debug device. It unit is Microsecond.\r
+  @param  Timeout          Timeout value for reading from debug device. Its unit is Microsecond.\r

 \r
   @retval 0                Read data failed, no data is to be read.\r
   @retval >0               Actual number of bytes read from debug device.\r
 \r
   @retval 0                Read data failed, no data is to be read.\r
   @retval >0               Actual number of bytes read from debug device.\r


@@ -118,7 +118,7 @@ DebugPortReadBuffer (
 \r
   @retval 0                NumberOfBytes is 0.\r
   @retval >0               The number of bytes written to the debug device.\r
 \r
   @retval 0                NumberOfBytes is 0.\r
   @retval >0               The number of bytes written to the debug device.\r

-                           If this value is less than NumberOfBytes, then the read operation failed.\r
+                           If this value is less than NumberOfBytes, then the write operation failed.\r

 \r
 **/\r
 UINTN\r
 \r
 **/\r
 UINTN\r


@@ -139,7 +139,7 @@ DebugPortWriteBuffer (
   @param  Handle           Debug port handle.\r
 \r
   @retval TRUE             Data is waiting to be read from the debug device.\r
   @param  Handle           Debug port handle.\r
 \r
   @retval TRUE             Data is waiting to be read from the debug device.\r

-  @retval FALSE            There is no data waiting to be read from the serial device.\r
+  @retval FALSE            There is no data waiting to be read from the debug device.\r

 \r
 **/\r
 BOOLEAN\r
 \r
 **/\r
 BOOLEAN\r

diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c
index 04e25e3ec2cf8bb753a667436f8415a6bcdf2421..49bad6b5864d445a6398eb3b59047738ec5e151f 100644 (file)
--- a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c
+++ b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c
@@ -1,7 +1,7 @@
 /** @file\r
   Debug Port Library implementation based on usb3 debug port.\r
 \r
 /** @file\r
   Debug Port Library implementation based on usb3 debug port.\r
 \r

-  Copyright (c) 2014 - 2015, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.<BR>\r

   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r


@@ -756,7 +756,7 @@ Enable:
   @param  Handle           Debug port handle.\r
   @param  Buffer           Pointer to the data buffer to store the data read from the debug device.\r
   @param  NumberOfBytes    Number of bytes which will be read.\r
   @param  Handle           Debug port handle.\r
   @param  Buffer           Pointer to the data buffer to store the data read from the debug device.\r
   @param  NumberOfBytes    Number of bytes which will be read.\r

-  @param  Timeout          Timeout value for reading from debug device. It unit is Microsecond.\r
+  @param  Timeout          Timeout value for reading from debug device. Its unit is Microsecond.\r

 \r
   @retval 0                Read data failed, no data is to be read.\r
   @retval >0               Actual number of bytes read from debug device.\r
 \r
   @retval 0                Read data failed, no data is to be read.\r
   @retval >0               Actual number of bytes read from debug device.\r


@@ -836,7 +836,7 @@ DebugPortReadBuffer (
 \r
   @retval 0                NumberOfBytes is 0.\r
   @retval >0               The number of bytes written to the debug device.\r
 \r
   @retval 0                NumberOfBytes is 0.\r
   @retval >0               The number of bytes written to the debug device.\r

-                           If this value is less than NumberOfBytes, then the read operation failed.\r
+                           If this value is less than NumberOfBytes, then the write operation failed.\r

 \r
 **/\r
 UINTN\r
 \r
 **/\r
 UINTN\r


@@ -919,7 +919,7 @@ DebugPortWriteBuffer (
   @param  Handle           Debug port handle.\r
 \r
   @retval TRUE             Data is waiting to be read from the debug device.\r
   @param  Handle           Debug port handle.\r
 \r
   @retval TRUE             Data is waiting to be read from the debug device.\r

-  @retval FALSE            There is no data waiting to be read from the serial device.\r
+  @retval FALSE            There is no data waiting to be read from the debug device.\r

 \r
 **/\r
 BOOLEAN\r
 \r
 **/\r
 BOOLEAN\r

diff --git a/SourceLevelDebugPkg/SourceLevelDebugPkg.dec b/SourceLevelDebugPkg/SourceLevelDebugPkg.dec
index c9a47f625526dcc7e685e0dd651e4e2b8cc3c94e..b89e9c6ad601f2367d9975f434169c8c1aa990f8 100644 (file)
--- a/SourceLevelDebugPkg/SourceLevelDebugPkg.dec
+++ b/SourceLevelDebugPkg/SourceLevelDebugPkg.dec
@@ -6,7 +6,7 @@
 # and host, PeCoffExtraActionLib instance to report symbol path information,\r
 # etc.\r
 #\r
 # and host, PeCoffExtraActionLib instance to report symbol path information,\r
 # etc.\r
 #\r

-# Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r

 # This program and the accompanying materials are licensed and made available under \r
 # the terms and conditions of the BSD License that accompanies this distribution.  \r
 # The full text of the license may be found at\r
 # This program and the accompanying materials are licensed and made available under \r
 # the terms and conditions of the BSD License that accompanies this distribution.  \r
 # The full text of the license may be found at\r


@@ -92,7 +92,7 @@
 \r
   ## The memory BAR of xhci host controller, in which usb debug feature is enabled.\r
   ## Note that the memory BAR address is only used before Pci bus resource allocation.\r
 \r
   ## The memory BAR of xhci host controller, in which usb debug feature is enabled.\r
   ## Note that the memory BAR address is only used before Pci bus resource allocation.\r

-  # @Prompt Configure ehci host controller memory BAR.\r
+  # @Prompt Configure xhci host controller memory BAR.\r

   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbXhciMemorySpaceBase|0xD0000000|UINT64|0x00000007\r
   \r
   ## The pci address of xhci host controller, in which usb debug feature is enabled.\r
   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbXhciMemorySpaceBase|0xD0000000|UINT64|0x00000007\r
   \r
   ## The pci address of xhci host controller, in which usb debug feature is enabled.\r

diff --git a/SourceLevelDebugPkg/SourceLevelDebugPkg.uni b/SourceLevelDebugPkg/SourceLevelDebugPkg.uni
index 781b717e4e24e79f6b2cc4d72aaff1cb7a7a396d..8a201652274b086163fb9b4d0a19019ae2714573 100644 (file)
--- a/SourceLevelDebugPkg/SourceLevelDebugPkg.uni
+++ b/SourceLevelDebugPkg/SourceLevelDebugPkg.uni
@@ -8,7 +8,7 @@
 // and host, PeCoffExtraActionLib instance to report symbol path information,\r
 // etc.\r
 //\r
 // and host, PeCoffExtraActionLib instance to report symbol path information,\r
 // etc.\r
 //\r

-// Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>\r
+// Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r

 //\r
 // This program and the accompanying materials are licensed and made available under\r
 // the terms and conditions of the BSD License that accompanies this distribution.\r
 //\r
 // This program and the accompanying materials are licensed and made available under\r
 // the terms and conditions of the BSD License that accompanies this distribution.\r


@@ -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"\r
                                                                                                      "Its value is not suggested to be changed in platform DSC file."\r
 \r
 #string STR_gEfiSourceLevelDebugPkgTokenSpaceGuid_PcdDebugPortHandleBufferSize_HELP  #language en-US "The data buffer size used by debug port in debug communication library instances.\n"\r
                                                                                                      "Its value is not suggested to be changed in platform DSC file."\r
 \r

-#string STR_gEfiSourceLevelDebugPkgTokenSpaceGuid_PcdUsbXhciMemorySpaceBase_PROMPT  #language en-US "Configure ehci host controller memory BAR."\r
+#string STR_gEfiSourceLevelDebugPkgTokenSpaceGuid_PcdUsbXhciMemorySpaceBase_PROMPT  #language en-US "Configure xhci host controller memory BAR."\r

 \r
 #string STR_gEfiSourceLevelDebugPkgTokenSpaceGuid_PcdUsbXhciMemorySpaceBase_HELP  #language en-US "The memory BAR of xhci host controller, in which usb debug feature is enabled.\n"\r
                                                                                                   "Note that the memory BAR address is only used before Pci bus resource allocation."\r
 \r
 #string STR_gEfiSourceLevelDebugPkgTokenSpaceGuid_PcdUsbXhciMemorySpaceBase_HELP  #language en-US "The memory BAR of xhci host controller, in which usb debug feature is enabled.\n"\r
                                                                                                   "Note that the memory BAR address is only used before Pci bus resource allocation."\r