NetworkPkg/Udp6Dxe: Fix various typos
authorAntoine Coeur <coeur@gmx.fr>
Fri, 7 Feb 2020 01:08:04 +0000 (02:08 +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: Jiaxin Wu <jiaxin.wu@intel.com>
Cc: Siyuan Fu <siyuan.fu@intel.com>
Cc: Maciej Rabeda <maciej.rabeda@intel.com>
Signed-off-by: Antoine Coeur <coeur@gmx.fr>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Reviewed-by: Maciej Rabeda <maciej.rabeda@intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <20200207010831.9046-52-philmd@redhat.com>

NetworkPkg/Udp6Dxe/Udp6Driver.c
NetworkPkg/Udp6Dxe/Udp6Driver.h
NetworkPkg/Udp6Dxe/Udp6Impl.c
NetworkPkg/Udp6Dxe/Udp6Impl.h
NetworkPkg/Udp6Dxe/Udp6Main.c

index 5334fd1..6021bb3 100644 (file)
@@ -117,7 +117,7 @@ Udp6DriverBindingSupported (
   @param[in]  RemainingDevicePath    Optional parameter use to pick a specific child\r
                                      device to start.\r
 \r
-  @retval EFI_SUCCES             This driver is added to ControllerHandle.\r
+  @retval EFI_SUCCESS            This driver is added to ControllerHandle.\r
   @retval EFI_OUT_OF_RESOURCES   The required system resource can't be allocated.\r
   @retval other                  This driver does not support this device.\r
 \r
@@ -223,7 +223,7 @@ Udp6DestroyChildEntryInHandleBuffer (
                                      of children is zero stop the entire bus driver.\r
   @param[in]  ChildHandleBuffer      List of Child Handles to Stop. It is optional.\r
 \r
-  @retval EFI_SUCCES             This driver is removed ControllerHandle.\r
+  @retval EFI_SUCCESS            This driver is removed ControllerHandle.\r
   @retval EFI_DEVICE_ERROR       Can't find the NicHandle from the ControllerHandle and specified GUID.\r
   @retval other                  This driver was not removed from this device.\r
 \r
@@ -310,7 +310,7 @@ Udp6DriverBindingStop (
                                then a new handle is created. If it is a pointer to an existing UEFI handle,\r
                                then the protocol is added to the existing UEFI handle.\r
 \r
-  @retval EFI_SUCCES            The protocol was added to ChildHandle.\r
+  @retval EFI_SUCCESS           The protocol was added to ChildHandle.\r
   @retval EFI_INVALID_PARAMETER This is NULL or ChildHandle is NULL.\r
   @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to create\r
                                 the child.\r
@@ -443,7 +443,7 @@ ON_ERROR:
   @param[in]  This               Protocol instance pointer.\r
   @param[in]  ChildHandle        Handle of the child to destroy.\r
 \r
-  @retval EFI_SUCCES             The I/O services were removed from the child\r
+  @retval EFI_SUCCESS            The I/O services were removed from the child\r
                                  handle.\r
   @retval EFI_UNSUPPORTED        The child handle does not support the I/O services\r
                                  that are being removed.\r
index a086239..577cebd 100644 (file)
@@ -78,7 +78,7 @@ Udp6DriverBindingSupported (
   @param[in]  RemainingDevicePath    Optional parameter use to pick a specific child\r
                                      device to start.\r
 \r
-  @retval EFI_SUCCES             This driver is added to ControllerHandle.\r
+  @retval EFI_SUCCESS            This driver is added to ControllerHandle.\r
   @retval EFI_OUT_OF_RESOURCES   The required system resource can't be allocated.\r
   @retval other                  This driver does not support this device.\r
 \r
@@ -132,7 +132,7 @@ Udp6DriverBindingStop (
                                then a new handle is created. If it is a pointer to an existing UEFI handle,\r
                                then the protocol is added to the existing UEFI handle.\r
 \r
-  @retval EFI_SUCCES            The protocol was added to ChildHandle.\r
+  @retval EFI_SUCCESS           The protocol was added to ChildHandle.\r
   @retval EFI_INVALID_PARAMETER This is NULL or ChildHandle is NULL.\r
   @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to create\r
                                 the child.\r
@@ -155,7 +155,7 @@ Udp6ServiceBindingCreateChild (
   @param[in]  This               Protocol instance pointer.\r
   @param[in]  ChildHandle        Handle of the child to destroy.\r
 \r
-  @retval EFI_SUCCES             The I/O services were removed from the child\r
+  @retval EFI_SUCCESS            The I/O services were removed from the child\r
                                  handle.\r
   @retval EFI_UNSUPPORTED        The child handle does not support the I/O services\r
                                  that are being removed.\r
index aefcd33..ba939fd 100644 (file)
@@ -96,7 +96,7 @@ Udp6DgramRcvd (
   );\r
 \r
 /**\r
-  This function cancle the token specified by Arg in the Map.\r
+  This function cancel the token specified by Arg in the Map.\r
 \r
   @param[in]  Map             Pointer to the NET_MAP.\r
   @param[in]  Item            Pointer to the NET_MAP_ITEM.\r
@@ -458,7 +458,7 @@ Udp6CheckTimeout (
 \r
 \r
 /**\r
-  This function intializes the new created udp instance.\r
+  This function initializes the new created udp instance.\r
 \r
   @param[in]       Udp6Service      Pointer to the UDP6_SERVICE_DATA.\r
   @param[in, out]  Instance         Pointer to the un-initialized UDP6_INSTANCE_DATA.\r
@@ -575,7 +575,7 @@ Udp6FindInstanceByPort (
 \r
 /**\r
   This function tries to bind the udp instance according to the configured port\r
-  allocation stragety.\r
+  allocation strategy.\r
 \r
   @param[in]  InstanceList       Pointer to the head of the list linking the udp\r
                                  instances.\r
@@ -832,7 +832,7 @@ Udp6ValidateTxToken (
 \r
     if ((UdpSessionData->DestinationPort == 0) && (ConfigData->RemotePort == 0)) {\r
       //\r
-      // Ambiguous; no avalaible DestinationPort for this token.\r
+      // Ambiguous; no available DestinationPort for this token.\r
       //\r
       return EFI_INVALID_PARAMETER;\r
     }\r
@@ -841,7 +841,7 @@ Udp6ValidateTxToken (
         NetIp6IsUnspecifiedAddr (&ConfigData->RemoteAddress)\r
         ) {\r
       //\r
-      // The DestinationAddress is not specificed.\r
+      // The DestinationAddress is not specified.\r
       //\r
       return EFI_INVALID_PARAMETER;\r
     }\r
@@ -915,7 +915,7 @@ Udp6TokenExist (
   pseudo HeadSum to reduce some overhead.\r
 \r
   @param[in]  Packet           Pointer to the NET_BUF contains the udp datagram.\r
-  @param[in]  HeadSum          Checksum of the pseudo header, execpt the length\r
+  @param[in]  HeadSum          Checksum of the pseudo header, except the length\r
                                field.\r
 \r
   @return The 16-bit checksum of this udp datagram.\r
@@ -1123,7 +1123,7 @@ Udp6LeaveGroup (
 \r
 \r
 /**\r
-  This function cancle the token specified by Arg in the Map.\r
+  This function cancel the token specified by Arg in the Map.\r
 \r
   @param[in]  Map             Pointer to the NET_MAP.\r
   @param[in]  Item            Pointer to the NET_MAP_ITEM.\r
@@ -1276,7 +1276,7 @@ Udp6InstanceCancelToken (
                                  from the received udp datagram.\r
 \r
   @retval TRUE     The udp datagram matches the receiving requirements of the Instance.\r
-  @retval FALSE    The udp datagram does not matche the receiving requirements of the Instance.\r
+  @retval FALSE    The udp datagram does not match the receiving requirements of the Instance.\r
 \r
 **/\r
 BOOLEAN\r
@@ -1814,7 +1814,7 @@ Udp6SendPortUnreach (
     );\r
 \r
   //\r
-  // Set the checksum as zero, and IP6 driver will calcuate it with pseudo header.\r
+  // Set the checksum as zero, and IP6 driver will calculate it with pseudo header.\r
   //\r
   IcmpErrHdr->Head.Checksum = 0;\r
 \r
index 5ccbceb..55a4b8a 100644 (file)
@@ -151,7 +151,7 @@ Udp6CleanInstance (
   );\r
 \r
 /**\r
-  This function intializes the new created udp instance.\r
+  This function initializes the new created udp instance.\r
 \r
   @param[in]      Udp6Service      Pointer to the UDP6_SERVICE_DATA.\r
   @param[in, out]  Instance         Pointer to the un-initialized UDP6_INSTANCE_DATA.\r
@@ -221,7 +221,7 @@ Udp6GetModeData (
 \r
   @retval EFI_SUCCESS            The configuration settings were set, changed, or\r
                                  reset successfully.\r
-  @retval EFI_NO_MAPPING         When the UdpConifgData.UseAnyStationAddress is set\r
+  @retval EFI_NO_MAPPING         When the UdpConfigData.UseAnyStationAddress is set\r
                                  to true  and there is no address available for IP6\r
                                  driver to binding  source address to this\r
                                  instance.\r
@@ -281,12 +281,12 @@ Udp6Configure (
                                  .FragmentBuffer fields is NULL.\r
                                  One or more of the\r
                                  Token.Packet.TxData.UdpSessionData.\r
-                                 DestinationAddres are not valid unicast IPv6\r
+                                 DestinationAddress are not valid unicast IPv6\r
                                  addresses, if the  UdpSessionData is not NULL.\r
                                  Token.Packet.TxData.UdpSessionData.\r
-                                 DestinationAddres is NULL\r
+                                 DestinationAddress is NULL\r
                                  Token.Packet.TxData.UdpSessionData.\r
-                                 DestinatioPort is zero.\r
+                                 DestinationPort is zero.\r
                                  Token.Packet.TxData.UdpSessionData is\r
                                  NULL and this  instance's\r
                                  UdpConfigData.RemoteAddress is unspecified.\r
@@ -430,7 +430,7 @@ Udp6Groups (
 \r
 /**\r
   This function tries to bind the udp instance according to the configured port\r
-  allocation stragety.\r
+  allocation strategy.\r
 \r
   @param[in]  InstanceList       Pointer to the head of the list linking the udp\r
                                  instances.\r
index 0829b7b..a33eb3c 100644 (file)
@@ -104,7 +104,7 @@ Udp6GetModeData (
 \r
   @retval EFI_SUCCESS            The configuration settings were set, changed, or\r
                                  reset successfully.\r
-  @retval EFI_NO_MAPPING         When the UdpConifgData.UseAnyStationAddress is set\r
+  @retval EFI_NO_MAPPING         When the UdpConfigData.UseAnyStationAddress is set\r
                                  to true and there is no address available for the IP6\r
                                  driver to bind a source address to this instance.\r
   @retval EFI_INVALID_PARAMETER  One or more following conditions are TRUE:\r
@@ -368,7 +368,7 @@ Udp6Groups (
   // Keep a local copy of the configured multicast IPs because IpIo receives\r
   // datagrams from the 0 station address IP instance and then UDP delivers to\r
   // the matched instance. This copy of multicast IPs is used to avoid receive\r
-  // the mutlicast datagrams destinated to multicast IPs the other instances configured.\r
+  // the multicast datagrams destinated to multicast IPs the other instances configured.\r
   //\r
   if (JoinFlag) {\r
 \r
@@ -423,13 +423,13 @@ ON_EXIT:
                                  One or more of the\r
                                  Token.Packet.TxData.FragmentTable[].FragmentBuffer\r
                                  fields is NULL. One or more of the\r
-                                 Token.Packet.TxData.UdpSessionData.DestinationAddres\r
+                                 Token.Packet.TxData.UdpSessionData.DestinationAddress\r
                                  are not valid unicast IPv6\r
                                  addresses if the  UdpSessionData is not NULL.\r
                                  Token.Packet.TxData.UdpSessionData.\r
                                  DestinationAddress is NULL\r
                                  Token.Packet.TxData.UdpSessionData.\r
-                                 DestinatioPort\r
+                                 DestinationPort\r
                                  is zero.\r
                                  Token.Packet.TxData.UdpSessionData is NULL and this\r
                                  instance's UdpConfigData.RemoteAddress  is unspecified.\r
@@ -586,7 +586,7 @@ Udp6Transmit (
       }\r
     } else {\r
       //\r
-      // Set the checksum is zero if the ConfigData->StationAddress is unspcified\r
+      // Set the checksum is zero if the ConfigData->StationAddress is unspecified\r
       // and the Ipv6 will fill the correct value of this checksum.\r
       //\r
       Udp6Header->Checksum = 0;\r
@@ -807,7 +807,7 @@ Udp6Cancel (
   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
 \r
   //\r
-  // Cancle the tokens specified by Token for this instance.\r
+  // Cancel the tokens specified by Token for this instance.\r
   //\r
   Status = Udp6InstanceCancelToken (Instance, Token);\r
 \r