]> git.proxmox.com Git - mirror_edk2.git/commitdiff
NetworkPkg/Ip4Dxe: Fix various typos
authorAntoine Coeur <coeur@gmx.fr>
Fri, 7 Feb 2020 01:07:52 +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: 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-40-philmd@redhat.com>

21 files changed:
NetworkPkg/Ip4Dxe/Ip4Common.c
NetworkPkg/Ip4Dxe/Ip4Common.h
NetworkPkg/Ip4Dxe/Ip4Config2Impl.c
NetworkPkg/Ip4Dxe/Ip4Config2Impl.h
NetworkPkg/Ip4Dxe/Ip4Config2Nv.c
NetworkPkg/Ip4Dxe/Ip4Driver.c
NetworkPkg/Ip4Dxe/Ip4Driver.h
NetworkPkg/Ip4Dxe/Ip4Icmp.h
NetworkPkg/Ip4Dxe/Ip4If.c
NetworkPkg/Ip4Dxe/Ip4If.h
NetworkPkg/Ip4Dxe/Ip4Igmp.c
NetworkPkg/Ip4Dxe/Ip4Igmp.h
NetworkPkg/Ip4Dxe/Ip4Impl.c
NetworkPkg/Ip4Dxe/Ip4Impl.h
NetworkPkg/Ip4Dxe/Ip4Input.c
NetworkPkg/Ip4Dxe/Ip4Input.h
NetworkPkg/Ip4Dxe/Ip4Option.c
NetworkPkg/Ip4Dxe/Ip4Output.c
NetworkPkg/Ip4Dxe/Ip4Output.h
NetworkPkg/Ip4Dxe/Ip4Route.c
NetworkPkg/Ip4Dxe/Ip4Route.h

index c756a2dbf7e41514dc1cc81018a5304188f07da0..f4269b8ea49520b58b5f5ad69cd58713cf47dee9 100644 (file)
@@ -9,7 +9,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 \r
 \r
 /**\r
-  Return the cast type (Unicast/Boradcast) specific to an\r
+  Return the cast type (Unicast/Broadcast) specific to an\r
   interface. All the addresses are host byte ordered.\r
 \r
   @param[in]  IpAddr                The IP address to classify in host byte order\r
@@ -17,7 +17,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 \r
   @return The cast type of this IP address specific to the interface.\r
   @retval IP4_LOCAL_HOST        The IpAddr equals to the interface's address\r
-  @retval IP4_SUBNET_BROADCAST  The IpAddr is a directed subnet boradcast to  the\r
+  @retval IP4_SUBNET_BROADCAST  The IpAddr is a directed subnet broadcast to  the\r
                                 interface\r
   @retval IP4_NET_BROADCAST     The IpAddr is a network broadcast to the interface\r
   @retval 0                     Otherwise.\r
@@ -182,7 +182,7 @@ Ip4FindNet (
   Find an interface of the service with the same Ip/Netmask pair.\r
 \r
   @param[in]  IpSb                  Ip4 service binding instance\r
-  @param[in]  Ip                    The Ip adress to find (host byte order)\r
+  @param[in]  Ip                    The Ip address to find (host byte order)\r
   @param[in]  Netmask               The network to find (host byte order)\r
 \r
   @return The IP4_INTERFACE point if found, otherwise NULL\r
@@ -266,10 +266,10 @@ Ip4NtohHead (
 /**\r
   Validate that Ip/Netmask pair is OK to be used as station\r
   address. Only continuous netmasks are supported. and check\r
-  that StationAddress is a unicast address on the newtwork.\r
+  that StationAddress is a unicast address on the network.\r
 \r
   @param[in]  Ip                 The IP address to validate.\r
-  @param[in]  Netmask            The netmaks of the IP.\r
+  @param[in]  Netmask            The netmask of the IP.\r
 \r
   @retval TRUE                   The Ip/Netmask pair is valid.\r
   @retval FALSE                  The Ip/Netmask pair is invalid.\r
index 8fbfd548721902d67f24b6217add1b2006583c21..a84602d45ac0632fa1574574127d28d7e348e23d 100644 (file)
@@ -23,7 +23,7 @@ typedef struct _IP4_SERVICE    IP4_SERVICE;
 #define IP4_LINK_PROMISC      0x00000004\r
 \r
 //\r
-// IP4 address cast type classfication. Keep it true that any\r
+// IP4 address cast type classification. Keep it true that any\r
 // type bigger than or equal to LOCAL_BROADCAST is broadcast.\r
 //\r
 #define IP4_PROMISCUOUS       1\r
@@ -63,13 +63,13 @@ typedef struct _IP4_SERVICE    IP4_SERVICE;
 #define IP4_IS_BROADCAST(CastType) ((CastType) >= IP4_LOCAL_BROADCAST)\r
 \r
 ///\r
-/// Conver the Microsecond to second. IP transmit/receive time is\r
+/// Convert the Microsecond to second. IP transmit/receive time is\r
 /// in the unit of microsecond. IP ticks once per second.\r
 ///\r
 #define IP4_US_TO_SEC(Us) (((Us) + 999999) / 1000000)\r
 \r
 /**\r
-  Return the cast type (Unicast/Boradcast) specific to an\r
+  Return the cast type (Unicast/Broadcast) specific to an\r
   interface. All the addresses are host byte ordered.\r
 \r
   @param[in]  IpAddr                The IP address to classify in host byte order\r
@@ -77,7 +77,7 @@ typedef struct _IP4_SERVICE    IP4_SERVICE;
 \r
   @return The cast type of this IP address specific to the interface.\r
   @retval IP4_LOCAL_HOST        The IpAddr equals to the interface's address\r
-  @retval IP4_SUBNET_BROADCAST  The IpAddr is a directed subnet boradcast to  the\r
+  @retval IP4_SUBNET_BROADCAST  The IpAddr is a directed subnet broadcast to  the\r
                                 interface\r
   @retval IP4_NET_BROADCAST     The IpAddr is a network broadcast to the interface\r
   @retval 0                     Otherwise.\r
@@ -146,7 +146,7 @@ Ip4FindNet (
   Find an interface of the service with the same Ip/Netmask pair.\r
 \r
   @param[in]  IpSb                  Ip4 service binding instance\r
-  @param[in]  Ip                    The Ip adress to find (host byte order)\r
+  @param[in]  Ip                    The Ip address to find (host byte order)\r
   @param[in]  Netmask               The network to find (host byte order)\r
 \r
   @return The IP4_INTERFACE point if found, otherwise NULL\r
@@ -199,10 +199,10 @@ Ip4NtohHead (
 /**\r
   Validate that Ip/Netmask pair is OK to be used as station\r
   address. Only continuous netmasks are supported. and check\r
-  that StationAddress is a unicast address on the newtwork.\r
+  that StationAddress is a unicast address on the network.\r
 \r
   @param[in]  Ip                 The IP address to validate.\r
-  @param[in]  Netmask            The netmaks of the IP.\r
+  @param[in]  Netmask            The netmask of the IP.\r
 \r
   @retval TRUE                   The Ip/Netmask pair is valid.\r
   @retval FALSE                  The Ip/Netmask pair is invalid.\r
index 9dca48ddd6458044b089ed6b492ee29b8a365a0d..9cfad5916d1037cc8451cf65f8fd8023a78eede0 100644 (file)
@@ -174,7 +174,7 @@ Ip4Config2SignalEvent (
 /**\r
   Read the configuration data from variable storage according to the VarName and\r
   gEfiIp4Config2ProtocolGuid. It checks the integrity of variable data. If the\r
-  data is corrupted, it clears the variable data to ZERO. Othewise, it outputs the\r
+  data is corrupted, it clears the variable data to ZERO. Otherwise, it outputs the\r
   configuration data to IP4_CONFIG2_INSTANCE.\r
 \r
   @param[in]      VarName       The pointer to the variable name\r
@@ -377,7 +377,7 @@ Ip4Config2WriteConfigData (
   @param[out]  Table       The built IP4 route table.\r
 \r
   @retval EFI_SUCCESS           The route table is successfully build\r
-  @retval EFI_NOT_FOUND         Failed to allocate the memory for the rotue table.\r
+  @retval EFI_NOT_FOUND         Failed to allocate the memory for the route table.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -912,7 +912,7 @@ Ip4StartAutoConfig (
 \r
   //\r
   // A host must not invoke DHCP configuration if it is already\r
-  // participating in the DHCP configuraiton process.\r
+  // participating in the DHCP configuration process.\r
   //\r
   if (Instance->Dhcp4Handle != NULL) {\r
     return EFI_SUCCESS;\r
@@ -1234,7 +1234,7 @@ Ip4Config2SetPolicy (
                                 under the current policy.\r
   @retval EFI_INVALID_PARAMETER One or more fields in Data is invalid.\r
   @retval EFI_OUT_OF_RESOURCES  Fail to allocate resource to complete the operation.\r
-  @retval EFI_NOT_READY         An asynchrous process is invoked to set the specified\r
+  @retval EFI_NOT_READY         An asynchronous process is invoked to set the specified\r
                                 configuration data, and the process is not finished.\r
   @retval EFI_ABORTED           The manual addresses to be set equal current\r
                                 configuration.\r
@@ -1721,7 +1721,7 @@ EfiIp4Config2SetData (
     }\r
   } else {\r
     //\r
-    // Another asynchornous process is on the way.\r
+    // Another asynchronous process is on the way.\r
     //\r
     Status = EFI_ACCESS_DENIED;\r
   }\r
index 1716dde399ab59ce0aecbeeb455b4be861bef081..0e4639e77c7898482c161c86e45dcd1267a3034d 100644 (file)
@@ -205,7 +205,7 @@ typedef struct {
 /**\r
   Read the configuration data from variable storage according to the VarName and\r
   gEfiIp4Config2ProtocolGuid. It checks the integrity of variable data. If the\r
-  data is corrupted, it clears the variable data to ZERO. Othewise, it outputs the\r
+  data is corrupted, it clears the variable data to ZERO. Otherwise, it outputs the\r
   configuration data to IP4_CONFIG2_INSTANCE.\r
 \r
   @param[in]      VarName       The pointer to the variable name\r
index a4d2996a60e64b6bfefdb01c0f1f3c0d561478a4..63014ca3190755e2390a0a198486001d38783089 100644 (file)
@@ -988,7 +988,7 @@ Failure:
   @param[out] Progress       A pointer to a string filled in with the\r
                              offset of the most recent '&' before the\r
                              first failing name / value pair (or the\r
-                             beginn ing of the string if the failure\r
+                             beginning of the string if the failure\r
                              is in the first name / value pair) or\r
                              the terminating NULL if all was\r
                              successful.\r
@@ -1098,7 +1098,7 @@ Ip4FormRouteConfig (
                                  variable and its data.\r
   @retval EFI_DEVICE_ERROR       The variable could not be saved.\r
   @retval EFI_UNSUPPORTED        The specified Action is not supported by the\r
-                                 callback.Currently not implemented.\r
+                                 callback. Currently not implemented.\r
   @retval EFI_INVALID_PARAMETERS Passing in wrong parameter.\r
   @retval Others                 Other errors as indicated.\r
 \r
index 62be8b681a18b9d22a5a4de65564a88c3e4e6e9f..7fed659ca101d90708674030b422e9529d4ec214 100644 (file)
@@ -581,7 +581,7 @@ Ip4DriverBindingStart (
   Ip4Cfg2  = &IpSb->Ip4Config2Instance.Ip4Config2;\r
 \r
   //\r
-  // Install the Ip4ServiceBinding Protocol onto ControlerHandle\r
+  // Install the Ip4ServiceBinding Protocol onto ControllerHandle\r
   //\r
   Status = gBS->InstallMultipleProtocolInterfaces (\r
                   &ControllerHandle,\r
@@ -829,7 +829,7 @@ ON_ERROR:
                       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 ChildHandle is NULL.\r
   @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to create\r
                                 the child\r
@@ -933,7 +933,7 @@ ON_ERROR:
   @param  This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
   @param  ChildHandle Handle of the child to destroy\r
 \r
-  @retval EFI_SUCCES            The protocol was removed from ChildHandle.\r
+  @retval EFI_SUCCESS           The protocol was removed from ChildHandle.\r
   @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.\r
   @retval EFI_INVALID_PARAMETER Child handle is NULL.\r
   @retval EFI_ACCESS_DENIED     The protocol could not be removed from the ChildHandle\r
@@ -1020,14 +1020,14 @@ Ip4ServiceBindingDestroyChild (
   // Uninstall the IP4 protocol first. Many thing happens during\r
   // this:\r
   // 1. The consumer of the IP4 protocol will be stopped if it\r
-  // opens the protocol BY_DRIVER. For eaxmple, if MNP driver is\r
+  // opens the protocol BY_DRIVER. For example, if MNP driver is\r
   // stopped, IP driver's stop function will be called, and uninstall\r
   // EFI_IP4_PROTOCOL will trigger the UDP's stop function. This\r
   // makes it possible to create the network stack bottom up, and\r
   // stop it top down.\r
   // 2. the upper layer will recycle the received packet. The recycle\r
   // event's TPL is higher than this function. The recycle events\r
-  // will be called back before preceeding. If any packets not recycled,\r
+  // will be called back before preceding. If any packets not recycled,\r
   // that means there is a resource leak.\r
   //\r
   gBS->RestoreTPL (OldTpl);\r
index be374715703cb81799b3f4f5af6ecd200fc5cfde..d94bdf3bdec17837603222eedc68f58562628ff8 100644 (file)
@@ -47,7 +47,7 @@ Ip4DriverEntryPoint (
   );\r
 \r
 //\r
-// Function prototypes for the Drivr Binding Protocol\r
+// Function prototypes for the Driver Binding Protocol\r
 //\r
 /**\r
   Test to see if this driver supports ControllerHandle. This service\r
@@ -143,7 +143,7 @@ Ip4DriverBindingStop (
                       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 ChildHandle is NULL.\r
   @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to create\r
                                 the child\r
@@ -167,7 +167,7 @@ Ip4ServiceBindingCreateChild (
   @param  This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
   @param  ChildHandle Handle of the child to destroy\r
 \r
-  @retval EFI_SUCCES            The protocol was removed from ChildHandle.\r
+  @retval EFI_SUCCESS           The protocol was removed from ChildHandle.\r
   @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.\r
   @retval EFI_INVALID_PARAMETER Child handle is NULL.\r
   @retval EFI_ACCESS_DENIED     The protocol could not be removed from the ChildHandle\r
index a52200176f5ad5b002046742932dba5d1cdfb4d2..a23952dbdded029d6c259fd8146364bcdaddaf8f 100644 (file)
@@ -10,7 +10,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 #define __EFI_IP4_ICMP_H__\r
 \r
   //\r
-  // ICMP type definations\r
+  // ICMP type definitions\r
   //\r
 #define ICMP_ECHO_REPLY            0\r
 #define ICMP_DEST_UNREACHABLE      3\r
@@ -27,7 +27,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 #define ICMP_DEFAULT_CODE          0\r
 \r
   //\r
-  // ICMP code definations for ICMP_DEST_UNREACHABLE\r
+  // ICMP code definitions for ICMP_DEST_UNREACHABLE\r
   //\r
 #define ICMP_NET_UNREACHABLE       0\r
 #define ICMP_HOST_UNREACHABLE      1\r
@@ -44,13 +44,13 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 #define ICMP_HOST_UNREACHABLE_TOS  12\r
 \r
   //\r
-  // ICMP code definations for ICMP_TIME_EXCEEDED\r
+  // ICMP code definitions for ICMP_TIME_EXCEEDED\r
   //\r
 #define ICMP_TIMEOUT_IN_TRANSIT    0\r
 #define ICMP_TIMEOUT_REASSEMBLE    1  // Host may generate\r
 \r
   //\r
-  // ICMP code definations for ICMP_TIME_EXCEEDED\r
+  // ICMP code definitions for ICMP_TIME_EXCEEDED\r
   //\r
 #define ICMP_NET_REDIRECT          0\r
 #define ICMP_HOST_REDIRECT         1\r
index 348f2e076aedaea63ea3c3680140545c144a093b..edb0b197ca3edbf452281596931d0184670edec8 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  Implement IP4 pesudo interface.\r
+  Implement IP4 pseudo interface.\r
 \r
 Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>\r
 SPDX-License-Identifier: BSD-2-Clause-Patent\r
@@ -9,13 +9,13 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 #include "Ip4Impl.h"\r
 \r
 //\r
-// Mac address with all zero, used to determine whethter the ARP\r
+// Mac address with all zero, used to determine whether the ARP\r
 // resolve succeeded. Failed ARP requests zero the MAC address buffer.\r
 //\r
 EFI_MAC_ADDRESS  mZeroMacAddress;\r
 \r
 /**\r
-  Callback funtion when frame transmission is finished. It will\r
+  Callback function when frame transmission is finished. It will\r
   call the frame owner's callback function to tell it the result.\r
 \r
   @param[in]  Context            Context which is point to the token.\r
@@ -567,7 +567,7 @@ Ip4SetAddress (
   //\r
   // Set the ip/netmask, then compute the subnet broadcast\r
   // and network broadcast for easy access. When computing\r
-  // nework broadcast, the subnet mask is most like longer\r
+  // network broadcast, the subnet mask is most like longer\r
   // than the default netmask (not subneted) as defined in\r
   // RFC793. If that isn't the case, we are aggregating the\r
   // networks, use the subnet's mask instead.\r
@@ -983,7 +983,7 @@ Ip4OnArpResolved (
 \r
 \r
 /**\r
-  Callback funtion when frame transmission is finished. It will\r
+  Callback function when frame transmission is finished. It will\r
   call the frame owner's callback function to tell it the result.\r
 \r
   @param[in]  Context            Context which is point to the token.\r
@@ -1255,7 +1255,7 @@ Ip4OnFrameReceivedDpc (
   }\r
 \r
   //\r
-  // Wrap the frame in a net buffer then deliever it to IP input.\r
+  // Wrap the frame in a net buffer then deliver it to IP input.\r
   // IP will reassemble the packet, and deliver it to upper layer\r
   //\r
   Netfrag.Len  = MnpRxData->DataLength;\r
@@ -1311,7 +1311,7 @@ Ip4OnFrameReceived (
 \r
   @retval EFI_ALREADY_STARTED   There is already a pending receive request.\r
   @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource to receive.\r
-  @retval EFI_SUCCESS           The recieve request has been started.\r
+  @retval EFI_SUCCESS           The receive request has been started.\r
   @retval other                 Other error occurs.\r
 \r
 **/\r
index d73bb5285f9780e45a236ccb1c93d5a3835963cc..ec951d30434e2bf1175be48d3a8ec92dc1ccf8a0 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  Definition for IP4 pesudo interface structure.\r
+  Definition for IP4 pseudo interface structure.\r
 \r
 Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>\r
 SPDX-License-Identifier: BSD-2-Clause-Patent\r
@@ -325,7 +325,7 @@ Ip4CancelReceive (
 \r
   @retval EFI_ALREADY_STARTED   There is already a pending receive request.\r
   @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource to receive.\r
-  @retval EFI_SUCCESS           The recieve request has been started.\r
+  @retval EFI_SUCCESS           The receive request has been started.\r
   @retval other                 Other error occurs.\r
 \r
 **/\r
index e69b2fe7fc0868c0d4600a63c48755d30995af0a..f69ba762fe4dedf03afc8c72e7fdd6a1031b390a 100644 (file)
@@ -149,7 +149,7 @@ Ip4FindMac (
 \r
   @param[in]  IpSb               The IP4 service instance that requests the\r
                                  transmission.\r
-  @param[in]  Dst                The destinaton to send to.\r
+  @param[in]  Dst                The destination to send to.\r
   @param[in]  Type               The IGMP message type, such as IGMP v1 membership\r
                                  report.\r
   @param[in]  Group              The group address in the IGMP message head.\r
@@ -273,7 +273,7 @@ Ip4JoinGroup (
 \r
   //\r
   // If the IP service already is a member in the group, just\r
-  // increase the refernce count and return.\r
+  // increase the reference count and return.\r
   //\r
   Group     = Ip4FindGroup (IgmpCtrl, Address);\r
 \r
@@ -587,7 +587,7 @@ Ip4CombineGroups (
   @param  Count             The number of group addresses in the Groups.\r
   @param  Addr              The IP4 multicast address to remove.\r
 \r
-  @return The nubmer of group addresses in the Groups after remove.\r
+  @return The number of group addresses in the Groups after remove.\r
           It is Count if the Addr isn't in the Groups.\r
 \r
 **/\r
index 49c13ba3a7a0f80a78af3d7a295d9d2769e96567..56631bd4afb359a57f45072044f06f9f27f73638 100644 (file)
@@ -170,7 +170,7 @@ Ip4CombineGroups (
   @param  Count             The number of group addresses in the Groups.\r
   @param  Addr              The IP4 multicast address to remove.\r
 \r
-  @return The nubmer of group addresses in the Groups after remove.\r
+  @return The number of group addresses in the Groups after remove.\r
           It is Count if the Addr isn't in the Groups.\r
 \r
 **/\r
index ec6f0370772b003ec1b79b230655571034f0b747..5935d405dd59af9110b11c775447ded7ed27033c 100644 (file)
@@ -198,7 +198,7 @@ EfiIp4Routes (
   @retval  EFI_NOT_STARTED       This instance has not been started.\r
   @retval  EFI_NO_MAPPING        When using the default address, configuration (DHCP, BOOTP,\r
                                  RARP, etc.) is not finished yet.\r
-  @retval  EFI_INVALID_PARAMETER One or more pameters are invalid.\r
+  @retval  EFI_INVALID_PARAMETER One or more parameters are invalid.\r
   @retval  EFI_ACCESS_DENIED     The transmit completion token with the same Token.Event\r
                                  was already in the transmit queue.\r
   @retval  EFI_NOT_READY         The completion token could not be queued because the transmit\r
@@ -525,7 +525,7 @@ Ip4ServiceConfigMnp (
 \r
 \r
 /**\r
-  Intiialize the IP4_PROTOCOL structure to the unconfigured states.\r
+  Initialize the IP4_PROTOCOL structure to the unconfigured states.\r
 \r
   @param  IpSb                   The IP4 service instance.\r
   @param  IpInstance             The IP4 child instance.\r
@@ -985,7 +985,7 @@ ON_EXIT:
 \r
   @retval EFI_ALREADY_STARTED    Want to join the group, but already a member of it.\r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate some resources.\r
-  @retval EFI_DEVICE_ERROR       Failed to set the group configuraton.\r
+  @retval EFI_DEVICE_ERROR       Failed to set the group configuration.\r
   @retval EFI_SUCCESS            Successfully updated the group setting.\r
   @retval EFI_NOT_FOUND          Try to leave the group which it isn't a member.\r
 \r
@@ -1043,7 +1043,7 @@ Ip4Groups (
   //\r
   // Leave the group. Leave all the groups if GroupAddress is NULL.\r
   // Must iterate from the end to the beginning because the GroupCount\r
-  // is decreamented each time an address is removed..\r
+  // is decremented each time an address is removed..\r
   //\r
   for (Index = IpInstance->GroupCount; Index > 0 ; Index--) {\r
     ASSERT (IpInstance->Groups != NULL);\r
@@ -1283,7 +1283,7 @@ ON_EXIT:
   @param[in]  Map                    The container of either user's transmit or receive\r
                                      token.\r
   @param[in]  Item                   Current item to check against.\r
-  @param[in]  Context                The Token to check againist.\r
+  @param[in]  Context                The Token to check against.\r
 \r
   @retval EFI_ACCESS_DENIED      The token or event has already been enqueued in IP.\r
   @retval EFI_SUCCESS            The current item isn't the same token/event as the\r
@@ -1557,7 +1557,7 @@ Ip4OnPacketSent (
   @retval  EFI_NOT_STARTED       This instance has not been started.\r
   @retval  EFI_NO_MAPPING        When using the default address, configuration (DHCP, BOOTP,\r
                                  RARP, etc.) is not finished yet.\r
-  @retval  EFI_INVALID_PARAMETER One or more pameters are invalid.\r
+  @retval  EFI_INVALID_PARAMETER One or more parameters are invalid.\r
   @retval  EFI_ACCESS_DENIED     The transmit completion token with the same Token.Event\r
                                  was already in the transmit queue.\r
   @retval  EFI_NOT_READY         The completion token could not be queued because the transmit\r
@@ -1619,7 +1619,7 @@ EfiIp4Transmit (
   }\r
 \r
   //\r
-  // make sure that token is properly formated\r
+  // make sure that token is properly formatted\r
   //\r
   Status = Ip4TxTokenValid (Token, IpIf, Config->RawData);\r
 \r
index a322a85981a57ec10d7c6b6c57889201fefe4aa4..e8ff33d38adc0c523056f7a06f68177d7fbf6949 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  Ip4 internal functions and type defintions.\r
+  Ip4 internal functions and type definitions.\r
 \r
 Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>\r
 (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
@@ -134,7 +134,7 @@ struct _IP4_PROTOCOL {
   LIST_ENTRY                Link;       // Link to all the IP protocol from the service\r
 \r
   //\r
-  // User's transmit/receive tokens, and received/deliverd packets\r
+  // User's transmit/receive tokens, and received/delivered packets\r
   //\r
   NET_MAP                   RxTokens;\r
   NET_MAP                   TxTokens;   // map between (User's Token, IP4_TXTOKE_WRAP)\r
@@ -260,7 +260,7 @@ Ip4ServiceConfigMnp (
   );\r
 \r
 /**\r
-  Intiialize the IP4_PROTOCOL structure to the unconfigured states.\r
+  Initialize the IP4_PROTOCOL structure to the unconfigured states.\r
 \r
   @param  IpSb                   The IP4 service instance.\r
   @param  IpInstance             The IP4 child instance.\r
@@ -315,7 +315,7 @@ Ip4Cancel (
 \r
   @retval EFI_ALREADY_STARTED    Want to join the group, but already a member of it\r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate some resources.\r
-  @retval EFI_DEVICE_ERROR       Failed to set the group configuraton\r
+  @retval EFI_DEVICE_ERROR       Failed to set the group configuration\r
   @retval EFI_SUCCESS            Successfully updated the group setting.\r
   @retval EFI_NOT_FOUND          Try to leave the group which it isn't a member.\r
 \r
index 24c5846588031b0e0a43f7d13708973e98a63632..fec242c71f4f7225db02df090eafa680c951cdaa 100644 (file)
@@ -387,7 +387,7 @@ Ip4Reassemble (
     RemoveEntryList (&Assemble->Link);\r
 \r
     //\r
-    // If the packet is properly formated, the last fragment's End\r
+    // If the packet is properly formatted, the last fragment's End\r
     // equals to the packet's total length. Otherwise, the packet\r
     // is a fake, drop it now.\r
     //\r
@@ -468,7 +468,7 @@ Ip4IpSecFree (
   actions: bypass the packet, discard the packet, or protect the packet.\r
 \r
   @param[in]       IpSb          The IP4 service instance.\r
-  @param[in, out]  Head          The The caller supplied IP4 header.\r
+  @param[in, out]  Head          The caller supplied IP4 header.\r
   @param[in, out]  Netbuf        The IP4 packet to be processed by IPsec.\r
   @param[in, out]  Options       The caller supplied options.\r
   @param[in, out]  OptionsLen    The length of the option.\r
@@ -480,7 +480,7 @@ Ip4IpSecFree (
   @retval EFI_SUCCESS            The packet was bypassed and all buffers remain the same.\r
   @retval EFI_SUCCESS            The packet was protected.\r
   @retval EFI_ACCESS_DENIED      The packet was discarded.\r
-  @retval EFI_OUT_OF_RESOURCES   There is no suffcient resource to complete the operation.\r
+  @retval EFI_OUT_OF_RESOURCES   There is no sufficient resource to complete the operation.\r
   @retval EFI_BUFFER_TOO_SMALL   The number of non-empty block is bigger than the\r
                                  number of input data blocks when build a fragment table.\r
 \r
@@ -625,7 +625,7 @@ Ip4IpSecProcessPacket (
     }\r
 \r
     //\r
-    // Free orginal Netbuf.\r
+    // Free original Netbuf.\r
     //\r
     NetIpSecNetbufFree (*Netbuf);\r
     *Netbuf = TxWrap->Packet;\r
@@ -689,8 +689,8 @@ ON_EXIT:
   @param[in]       Flag            The link layer flag for the packet received, such\r
                                    as multicast.\r
 \r
-  @retval     EFI_SEUCCESS               The recieved packet is in well form.\r
-  @retval     EFI_INVAILD_PARAMETER      The recieved packet is malformed.\r
+  @retval     EFI_SUCCESS                The received packet is in well form.\r
+  @retval     EFI_INVALID_PARAMETER      The received packet is malformed.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -891,8 +891,8 @@ Ip4AccpetFrame (
   ZeroMem (&ZeroHead, sizeof (IP4_HEAD));\r
   if (0 == CompareMem (Head, &ZeroHead, sizeof (IP4_HEAD))) {\r
   // Packet may have been changed. Head, HeadLen, TotalLen, and\r
-  // info must be reloaded bofore use. The ownership of the packet\r
-  // is transfered to the packet process logic.\r
+  // info must be reloaded before use. The ownership of the packet\r
+  // is transferred to the packet process logic.\r
   //\r
     Head = (IP4_HEAD *) NetbufGetByte (Packet, 0, NULL);\r
     ASSERT (Head != NULL);\r
@@ -973,7 +973,7 @@ Ip4InstanceFrameAcceptable (
   Config = &IpInstance->ConfigData;\r
 \r
   //\r
-  // Dirty trick for the Tiano UEFI network stack implmentation. If\r
+  // Dirty trick for the Tiano UEFI network stack implementation. If\r
   // ReceiveTimeout == -1, the receive of the packet for this instance\r
   // is disabled. The UEFI spec don't have such capability. We add\r
   // this to improve the performance because IP will make a copy of\r
@@ -1086,7 +1086,7 @@ Ip4InstanceEnquePacket (
   }\r
 \r
   //\r
-  // Enque a shared copy of the packet.\r
+  // Enqueue a shared copy of the packet.\r
   //\r
   Clone = NetbufClone (Packet);\r
 \r
@@ -1365,7 +1365,7 @@ Ip4InterfaceEnquePacket (
   //\r
   // First, check that the packet is acceptable to this interface\r
   // and find the local cast type for the interface. A packet sent\r
-  // to say 192.168.1.1 should NOT be delliever to 10.0.0.1 unless\r
+  // to say 192.168.1.1 should NOT be deliver to 10.0.0.1 unless\r
   // promiscuous receiving.\r
   //\r
   LocalType = 0;\r
@@ -1381,7 +1381,7 @@ Ip4InterfaceEnquePacket (
 \r
   } else {\r
     //\r
-    // Check the destination againist local IP. If the station\r
+    // Check the destination against local IP. If the station\r
     // address is 0.0.0.0, it means receiving all the IP destined\r
     // to local non-zero IP. Otherwise, it is necessary to compare\r
     // the destination to the interface's IP address.\r
@@ -1463,7 +1463,7 @@ Ip4InterfaceDeliverPacket (
 \r
 /**\r
   Demultiple the packet. the packet delivery is processed in two\r
-  passes. The first pass will enque a shared copy of the packet\r
+  passes. The first pass will enqueue a shared copy of the packet\r
   to each IP4 child that accepts the packet. The second pass will\r
   deliver a non-shared copy of the packet to each IP4 child that\r
   has pending receive requests. Data is copied if more than one\r
@@ -1495,7 +1495,7 @@ Ip4Demultiplex (
   INTN                      Enqueued;\r
 \r
   //\r
-  // Two pass delivery: first, enque a shared copy of the packet\r
+  // Two pass delivery: first, enqueue a shared copy of the packet\r
   // to each instance that accept the packet.\r
   //\r
   Enqueued = 0;\r
index f4d45d1613d0d95fb3c1d1141df7466d70ddac25..9bd86e15c9cfe66e0c133bf46f007b0057bde09c 100644 (file)
@@ -128,7 +128,7 @@ Ip4AccpetFrame (
 \r
 /**\r
   Demultiple the packet. the packet delivery is processed in two\r
-  passes. The first pass will enque a shared copy of the packet\r
+  passes. The first pass will enqueue a shared copy of the packet\r
   to each IP4 child that accepts the packet. The second pass will\r
   deliver a non-shared copy of the packet to each IP4 child that\r
   has pending receive requests. Data is copied if more than one\r
@@ -215,7 +215,7 @@ Ip4PacketTimerTicking (
   actions: bypass the packet, discard the packet, or protect the packet.\r
 \r
   @param[in]       IpSb          The IP4 service instance.\r
-  @param[in, out]  Head          The The caller supplied IP4 header.\r
+  @param[in, out]  Head          The caller supplied IP4 header.\r
   @param[in, out]  Netbuf        The IP4 packet to be processed by IPsec.\r
   @param[in, out]  Options       The caller supplied options.\r
   @param[in, out]  OptionsLen    The length of the option.\r
@@ -227,7 +227,7 @@ Ip4PacketTimerTicking (
   @retval EFI_SUCCESS            The packet was bypassed and all buffers remain the same.\r
   @retval EFI_SUCCESS            The packet was protected.\r
   @retval EFI_ACCESS_DENIED      The packet was discarded.\r
-  @retval EFI_OUT_OF_RESOURCES   There is no suffcient resource to complete the operation.\r
+  @retval EFI_OUT_OF_RESOURCES   There is no sufficient resource to complete the operation.\r
   @retval EFI_BUFFER_TOO_SMALL   The number of non-empty block is bigger than the\r
                                  number of input data blocks when build a fragment table.\r
 \r
index b3c598c64a38c7887e1ea68922f7fae288955962..0f6e444ce8be44a1a9a1eab2f78232a04a63af1c 100644 (file)
@@ -181,7 +181,7 @@ Ip4CopyOption (
 \r
   //\r
   // Head length is in the unit of 4 bytes. Now, Len is the\r
-  // acutal option length to appear in the IP header.\r
+  // actual option length to appear in the IP header.\r
   //\r
   Len = ((Next + 3) &~0x03);\r
 \r
index 5eb3814089cbe0f90a1ededd97997d9637aff7b1..c161b72542be08d3162dbac2fb468d8702c4486c 100644 (file)
@@ -21,10 +21,10 @@ UINT16  mIp4Id;
                            Fragment, Ttl, Protocol, Src and Dst. All the fields\r
                            are in host byte order. This function will fill in\r
                            the Ver, HeadLen, and checksum.\r
-  @param  Option           The orginal IP4 option to copy from\r
+  @param  Option           The original IP4 option to copy from\r
   @param  OptLen           The length of the IP4 option\r
 \r
-  @retval EFI_BAD_BUFFER_SIZE  There is no enought room in the head space of\r
+  @retval EFI_BAD_BUFFER_SIZE  There is no enough room in the head space of\r
                                Packet.\r
   @retval EFI_SUCCESS          The IP4 header is successfully added to the packet.\r
 \r
@@ -300,7 +300,7 @@ Ip4Output (
 \r
   } else if (GateWay == IP4_ALLZERO_ADDRESS) {\r
     //\r
-    // Route the packet unless overrided, that is, GateWay isn't zero.\r
+    // Route the packet unless overridden, that is, GateWay isn't zero.\r
     //\r
     if (IpInstance == NULL) {\r
       CacheEntry = Ip4Route (IpSb->DefaultRouteTable, Head->Dst, Head->Src, IpIf->SubnetMask, TRUE);\r
@@ -331,7 +331,7 @@ Ip4Output (
 \r
   if (Packet->TotalSize + HeadLen > Mtu) {\r
     //\r
-    // Fragmentation is diabled for RawData mode.\r
+    // Fragmentation is disabled for RawData mode.\r
     //\r
     if (RawData) {\r
       return EFI_BAD_BUFFER_SIZE;\r
@@ -399,7 +399,7 @@ Ip4Output (
   }\r
 \r
   //\r
-  // Send the first fragment, it is either the orginal packet, or the\r
+  // Send the first fragment, it is either the original packet, or the\r
   // first fragment of a fragmented packet. It seems that there is a subtle\r
   // bug here: what if the caller free the packet in Callback and IpIf (or\r
   // MNP child used by that interface) still holds the fragments and try\r
@@ -420,7 +420,7 @@ Ip4Output (
   //    is bound with the Packet. It will only be freed when all\r
   //    the references to Packet have been released. Upon then, the\r
   //    Packet's OnFree callback will release the IP4_TXTOKEN_WRAP,\r
-  //    and singal the user's recycle event. So, also no problem for\r
+  //    and signal the user's recycle event. So, also no problem for\r
   //    upper layer's packets.\r
   //\r
   Ip4PrependHead (Packet, Head, Option, OptLen);\r
index ae54f8b485caf04b5d2e008b0304a7410e9561fb..bb6fa641b090121004d1d9d11b26a3244fb0a0d7 100644 (file)
@@ -99,10 +99,10 @@ Ip4CancelPacket (
                            Fragment, Ttl, Protocol, Src and Dst. All the fields\r
                            are in host byte order. This function will fill in\r
                            the Ver, HeadLen, and checksum.\r
-  @param  Option           The orginal IP4 option to copy from\r
+  @param  Option           The original IP4 option to copy from\r
   @param  OptLen           The length of the IP4 option\r
 \r
-  @retval EFI_BAD_BUFFER_SIZE  There is no enought room in the head space of\r
+  @retval EFI_BAD_BUFFER_SIZE  There is no enough room in the head space of\r
                                Packet.\r
   @retval EFI_SUCCESS          The IP4 header is successfully added to the packet.\r
 \r
index 124c0730ad8740cfce5fc92f405412f0f441823f..386011934b192324e9448b05e15316a4a2274057 100644 (file)
@@ -9,14 +9,14 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 \r
 \r
 /**\r
-  Allocate a route entry then initialize it with the Dest/Netmaks\r
+  Allocate a route entry then initialize it with the Dest/Netmask\r
   and Gateway.\r
 \r
   @param[in]  Dest                  The destination network\r
   @param[in]  Netmask               The destination network mask\r
   @param[in]  GateWay               The nexthop address\r
 \r
-  @return NULL if failed to allocate memeory, otherwise the newly created\r
+  @return NULL if failed to allocate memory, otherwise the newly created\r
           route entry.\r
 \r
 **/\r
@@ -129,7 +129,7 @@ Ip4FreeRouteCacheEntry (
 /**\r
   Initialize an empty route cache table.\r
 \r
-  @param[in, out]  RtCache               The rotue cache table to initialize.\r
+  @param[in, out]  RtCache               The route cache table to initialize.\r
 \r
 **/\r
 VOID\r
@@ -359,7 +359,7 @@ Ip4AddRoute (
 \r
   @retval EFI_SUCCESS           The route entry is successfully removed\r
   @retval EFI_NOT_FOUND         There is no route entry in the table with that\r
-                                properity.\r
+                                property.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -396,7 +396,7 @@ Ip4DelRoute (
 \r
 /**\r
   Find a route cache with the dst and src. This is used by ICMP\r
-  redirect messasge process. All kinds of redirect is treated as\r
+  redirect message process. All kinds of redirect is treated as\r
   host redirect according to RFC1122. So, only route cache entries\r
   are modified according to the ICMP redirect message.\r
 \r
@@ -444,7 +444,7 @@ Ip4FindRouteCache (
   2. The local route entries have precedence over the default route entry.\r
 \r
   @param[in]  RtTable               The route table to search from\r
-  @param[in]  Dst                   The destionation address to search\r
+  @param[in]  Dst                   The destination address to search\r
 \r
   @return NULL if no route matches the Dst, otherwise the point to the\r
           most specific route to the Dst.\r
@@ -605,7 +605,7 @@ Ip4Route (
   @param[in]  IpInstance        The IP4 child that requests the route table.\r
 \r
   @retval EFI_SUCCESS           The route table is successfully build\r
-  @retval EFI_OUT_OF_RESOURCES  Failed to allocate the memory for the rotue table.\r
+  @retval EFI_OUT_OF_RESOURCES  Failed to allocate the memory for the route table.\r
 \r
 **/\r
 EFI_STATUS\r
index 4b0b5282ab5a470491190e157007c8ddc385da14..b4d91667e9597f65afd2b6b8f9c0b06917fa3621 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  EFI IP4 route table and route cache table defintions.\r
+  EFI IP4 route table and route cache table definitions.\r
 \r
 Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>\r
 SPDX-License-Identifier: BSD-2-Clause-Patent\r
@@ -56,8 +56,8 @@ typedef struct {
 ///\r
 /// The route cache table is organized as a hash table. Each\r
 /// IP4 route table has a embedded route cache. For now the\r
-/// route cache and route table are binded togehter. But keep\r
-/// the route cache a seperated structure in case we want to\r
+/// route cache and route table are binded together. But keep\r
+/// the route cache a separated structure in case we want to\r
 /// detach them later.\r
 ///\r
 typedef struct {\r
@@ -138,7 +138,7 @@ Ip4AddRoute (
 \r
   @retval EFI_SUCCESS           The route entry is successfully removed\r
   @retval EFI_NOT_FOUND         There is no route entry in the table with that\r
-                                properity.\r
+                                property.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -151,7 +151,7 @@ Ip4DelRoute (
 \r
 /**\r
   Find a route cache with the dst and src. This is used by ICMP\r
-  redirect messasge process. All kinds of redirect is treated as\r
+  redirect message process. All kinds of redirect is treated as\r
   host redirect according to RFC1122. So, only route cache entries\r
   are modified according to the ICMP redirect message.\r
 \r
@@ -215,7 +215,7 @@ Ip4Route (
   @param[in]  IpInstance        The IP4 child that requests the route table.\r
 \r
   @retval EFI_SUCCESS           The route table is successfully build\r
-  @retval EFI_OUT_OF_RESOURCES  Failed to allocate the memory for the rotue table.\r
+  @retval EFI_OUT_OF_RESOURCES  Failed to allocate the memory for the route table.\r
 \r
 **/\r
 EFI_STATUS\r