]> git.proxmox.com Git - mirror_edk2.git/commitdiff
MdeModulePkg/UsbBus: Fix various typos
authorAntoine Coeur <coeur@gmx.fr>
Fri, 7 Feb 2020 01:07:34 +0000 (02:07 +0100)
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Mon, 10 Feb 2020 22:30:07 +0000 (22:30 +0000)
Fix various typos in comments and documentation.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao A Wu <hao.a.wu@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Signed-off-by: Antoine Coeur <coeur@gmx.fr>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Acked-by: Liming Gao <liming.gao@intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <20200207010831.9046-22-philmd@redhat.com>

12 files changed:
MdeModulePkg/Bus/Usb/UsbBusDxe/UsbBus.c
MdeModulePkg/Bus/Usb/UsbBusDxe/UsbBus.h
MdeModulePkg/Bus/Usb/UsbBusDxe/UsbEnumer.c
MdeModulePkg/Bus/Usb/UsbBusDxe/UsbHub.c
MdeModulePkg/Bus/Usb/UsbBusDxe/UsbHub.h
MdeModulePkg/Bus/Usb/UsbBusDxe/UsbUtility.c
MdeModulePkg/Bus/Usb/UsbBusDxe/UsbUtility.h
MdeModulePkg/Bus/Usb/UsbBusPei/HubPeim.h
MdeModulePkg/Bus/Usb/UsbBusPei/PeiUsbLib.c
MdeModulePkg/Bus/Usb/UsbBusPei/PeiUsbLib.h
MdeModulePkg/Bus/Usb/UsbBusPei/UsbIoPeim.c
MdeModulePkg/Bus/Usb/UsbBusPei/UsbPeim.h

index d4002c48d74e1a7908e68cf0da000c422cb5e57a..4b4915c019ad4e6cf6aca9bb94d36b0a78ad9f43 100644 (file)
@@ -96,10 +96,10 @@ UsbIoControlTransfer (
              UsbStatus\r
              );\r
   //\r
-  // If the request completed sucessfully and the Direction of the request is\r
+  // If the request completed successfully and the Direction of the request is\r
   // EfiUsbDataIn or EfiUsbDataOut, then make sure the actual number of bytes\r
-  // transfered is the same as the number of bytes requested.  If a different\r
-  // number of bytes were transfered, then return EFI_DEVICE_ERROR.\r
+  // transferred is the same as the number of bytes requested.  If a different\r
+  // number of bytes were transferred, then return EFI_DEVICE_ERROR.\r
   //\r
   if (!EFI_ERROR (Status)) {\r
     if (Direction != EfiUsbNoData && DataLength != RequestedDataLength) {\r
@@ -389,7 +389,7 @@ ON_EXIT:
                                  the request.\r
   @param  PollInterval           The interval to poll the transfer result, (in ms).\r
   @param  DataLength             The length of perodic data transfer.\r
-  @param  Callback               The function to call periodicaly when transfer is\r
+  @param  Callback               The function to call periodically when transfer is\r
                                  ready.\r
   @param  Context                The context to the callback.\r
 \r
@@ -490,7 +490,7 @@ UsbIoIsochronousTransfer (
   @param  DeviceEndpoint         The device endpoint.\r
   @param  Data                   The data to transfer.\r
   @param  DataLength             The length of perodic data transfer.\r
-  @param  IsochronousCallBack    The function to call periodicaly when transfer is\r
+  @param  IsochronousCallBack    The function to call periodically when transfer is\r
                                  ready.\r
   @param  Context                The context to the callback.\r
 \r
@@ -1355,7 +1355,7 @@ UsbBusControllerDriverStart (
       if (IsDevicePathEnd (RemainingDevicePath)) {\r
         //\r
         // If RemainingDevicePath is the End of Device Path Node,\r
-        // skip enumerate any device and return EFI_SUCESSS\r
+        // skip enumerate any device and return EFI_SUCCESS\r
         //\r
         return EFI_SUCCESS;\r
       }\r
index 3fdbc94d95ebb202c558fb5840ecd314b563f6dc..c84a24df2413628ac90f6cf11e1c2625b8a185a2 100644 (file)
@@ -159,7 +159,7 @@ typedef struct _EFI_USB_BUS_PROTOCOL {
 \r
 //\r
 // Stands for the real USB device. Each device may\r
-// has several seperately working interfaces.\r
+// has several separately working interfaces.\r
 //\r
 struct _USB_DEVICE {\r
   USB_BUS                   *Bus;\r
@@ -265,8 +265,8 @@ struct _USB_BUS {
   // USB Bus driver need to control the recursive connect policy of the bus, only those wanted\r
   // usb child device will be recursively connected.\r
   //\r
-  // WantedUsbIoDPList tracks the Usb child devices which user want to recursivly fully connecte,\r
-  // every wanted child device is stored in a item of the WantedUsbIoDPList, whose structrure is\r
+  // WantedUsbIoDPList tracks the Usb child devices which user want to recursively fully connecte,\r
+  // every wanted child device is stored in a item of the WantedUsbIoDPList, whose structure is\r
   // DEVICE_PATH_LIST_ITEM\r
   //\r
   LIST_ENTRY                WantedUsbIoDPList;\r
@@ -337,7 +337,7 @@ UsbBusAddWantedUsbIoDP (
   Check whether a usb child device is the wanted device in a bus.\r
 \r
   @param  Bus     The Usb bus's private data pointer.\r
-  @param  UsbIf   The usb child device inferface.\r
+  @param  UsbIf   The usb child device interface.\r
 \r
   @retval True    If a usb child device is the wanted device in a bus.\r
   @retval False   If a usb child device is *NOT* the wanted device in a bus.\r
@@ -351,7 +351,7 @@ UsbBusIsWantedUsbIO (
   );\r
 \r
 /**\r
-  Recursively connnect every wanted usb child device to ensure they all fully connected.\r
+  Recursively connect every wanted usb child device to ensure they all fully connected.\r
   Check all the child Usb IO handles in this bus, recursively connecte if it is wanted usb child device.\r
 \r
   @param  UsbBusId                  Point to EFI_USB_BUS_PROTOCOL interface.\r
@@ -461,7 +461,7 @@ UsbIoSyncInterruptTransfer (
                                  the request.\r
   @param  PollInterval           The interval to poll the transfer result, (in ms).\r
   @param  DataLength             The length of perodic data transfer.\r
-  @param  Callback               The function to call periodicaly when transfer is\r
+  @param  Callback               The function to call periodically when transfer is\r
                                  ready.\r
   @param  Context                The context to the callback.\r
 \r
@@ -512,7 +512,7 @@ UsbIoIsochronousTransfer (
   @param  DeviceEndpoint         The device endpoint.\r
   @param  Data                   The data to transfer.\r
   @param  DataLength             The length of perodic data transfer.\r
-  @param  IsochronousCallBack    The function to call periodicaly when transfer is\r
+  @param  IsochronousCallBack    The function to call periodically when transfer is\r
                                  ready.\r
   @param  Context                The context to the callback.\r
 \r
index cc0de52de411b66e5f0b0641bbe5257e3d65ec9b..d3e0cfa626c394132f3d25d037f68521e1248956 100644 (file)
@@ -757,7 +757,7 @@ UsbEnumerateNewDev (
 \r
   //\r
   // After port is reset, hub establishes a signal path between\r
-  // the device and host (DEFALUT state). Device's registers are\r
+  // the device and host (DEFAULT state). Device's registers are\r
   // reset, use default address 0 (host enumerates one device at\r
   // a time) , and ready to respond to control transfer at EP 0.\r
   //\r
index c7c27a54819f9609f68625f5d5c8939a0e9df7a1..c5bd112511a46c09c365ce88e5fac167f8f36fb0 100644 (file)
@@ -545,7 +545,7 @@ UsbOnHubInterrupt (
   // OK, actually something is changed, save the change map\r
   // then signal the HUB to do enumeration. This is a good\r
   // practise since UsbOnHubInterrupt is called in the context\r
-  // of host contrller's AsyncInterrupt monitor.\r
+  // of host controller's AsyncInterrupt monitor.\r
   //\r
   HubIf->ChangeMap = AllocateZeroPool (DataLength);\r
 \r
@@ -630,7 +630,7 @@ UsbHubInit (
 \r
   //\r
   // OK, set IsHub to TRUE. Now usb bus can handle this device\r
-  // as a working HUB. If failed eariler, bus driver will not\r
+  // as a working HUB. If failed earlier, bus driver will not\r
   // recognize it as a hub. Other parts of the bus should be able\r
   // to work.\r
   //\r
index 0f4db2f34dc9423628f18281375b575f8371ef49..6043b5b2cd486577c5f50b616e26206bfe61b155 100644 (file)
@@ -97,7 +97,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 \r
 #pragma pack(1)\r
 //\r
-// Hub descriptor, the last two fields are of variable lenght.\r
+// Hub descriptor, the last two fields are of variable length.\r
 //\r
 typedef struct {\r
   UINT8           Length;\r
index 8559992d27430335f6c23551be3457254d65a0aa..7529e03e853c1115078c968adc2c1103975fa9d8 100644 (file)
@@ -784,7 +784,7 @@ MatchUsbClass (
   // If connect class policy, determine whether to create device handle by the five fields\r
   // in class device path node.\r
   //\r
-  // In addtion, hub interface is always matched for this policy.\r
+  // In addition, hub interface is always matched for this policy.\r
   //\r
   if ((ActIfDesc->InterfaceClass == USB_HUB_CLASS_CODE) &&\r
       (ActIfDesc->InterfaceSubClass == USB_HUB_SUBCLASS_CODE)) {\r
@@ -1018,7 +1018,7 @@ UsbBusAddWantedUsbIoDP (
   } else {\r
     //\r
     // If RemainingDevicePath is the End of Device Path Node,\r
-    // skip enumerate any device and return EFI_SUCESSS\r
+    // skip enumerate any device and return EFI_SUCCESS\r
     //\r
     return EFI_SUCCESS;\r
   }\r
@@ -1034,7 +1034,7 @@ UsbBusAddWantedUsbIoDP (
   Check whether a usb child device is the wanted device in a bus.\r
 \r
   @param  Bus     The Usb bus's private data pointer.\r
-  @param  UsbIf   The usb child device inferface.\r
+  @param  UsbIf   The usb child device interface.\r
 \r
   @retval True    If a usb child device is the wanted device in a bus.\r
   @retval False   If a usb child device is *NOT* the wanted device in a bus.\r
@@ -1136,7 +1136,7 @@ UsbBusIsWantedUsbIO (
 }\r
 \r
 /**\r
-  Recursively connnect every wanted usb child device to ensure they all fully connected.\r
+  Recursively connect every wanted usb child device to ensure they all fully connected.\r
   Check all the child Usb IO handles in this bus, recursively connecte if it is wanted usb child device.\r
 \r
   @param  UsbBusId                  Point to EFI_USB_BUS_PROTOCOL interface.\r
index 9c52520c87f767969c09d84ff52313f66aff82fd..1d2b8a6174c73151efa7a0dbe80e58c0403c46aa 100644 (file)
@@ -101,7 +101,7 @@ UsbHcClearRootHubPortFeature (
   @param  UsbResult        The result of transfer.\r
 \r
   @retval EFI_SUCCESS      The control transfer finished without error.\r
-  @retval Others           The control transfer failed, reason returned in UsbReslt.\r
+  @retval Others           The control transfer failed, reason returned in UsbResult.\r
 \r
 **/\r
 EFI_STATUS\r
index a78a1652ff4a016014ee6a021837b4bc9822c4c5..2a6d911a067e64a337a653407148441d3fbdc893 100644 (file)
@@ -78,7 +78,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 #define MAXBYTES  8\r
 #pragma pack(1)\r
 //\r
-// Hub descriptor, the last two fields are of variable lenght.\r
+// Hub descriptor, the last two fields are of variable length.\r
 //\r
 typedef struct {\r
   UINT8 Length;\r
index 2cc1fc6aa77e70177895cfcab07260ba847807ab..1385b0ab59af97970ec9fb390ddf58bb8b194de6 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-Common Libarary for PEI USB\r
+Common Library for PEI USB\r
 \r
 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved. <BR>\r
 \r
index cf9400987a38272307974d9e83d4bb9ac946c43d..48b8e594b283c4898ee637cf52431eda158d6888 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-Common Libarary for PEI USB\r
+Common Library for PEI USB\r
 \r
 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved. <BR>\r
 \r
index 653bbf52f00515717092add5a5525ea6954a16cf..fc04f834a549c3637cea9d824659d7613a63fb65 100644 (file)
@@ -131,7 +131,7 @@ PeiUsbControlTransfer (
   @param  DeviceEndpoint        Endpoint number and its direction in bit 7.\r
   @param  Data                  A pointer to the buffer of data to transmit\r
                                 from or receive into.\r
-  @param  DataLength            The lenght of the data buffer.\r
+  @param  DataLength            The length of the data buffer.\r
   @param  Timeout               Indicates the maximum time, in millisecond, which the\r
                                 transfer is allowed to complete. If Timeout is 0, then\r
                                 the caller must wait for the function to be completed\r
index caba53266daca02cc6b9980081e022810e09b5f7..b55b97d8707f6fbddfd8cb94a17014440945f689 100644 (file)
@@ -154,7 +154,7 @@ PeiUsbControlTransfer (
   @param  DeviceEndpoint        Endpoint number and its direction in bit 7.\r
   @param  Data                  A pointer to the buffer of data to transmit\r
                                 from or receive into.\r
-  @param  DataLength            The lenght of the data buffer.\r
+  @param  DataLength            The length of the data buffer.\r
   @param  Timeout               Indicates the maximum time, in millisecond, which the\r
                                 transfer is allowed to complete. If Timeout is 0, then\r
                                 the caller must wait for the function to be completed\r