NetworkPkg/MnpDxe: Fix various typos

Fix various typos in documentation, comments and debug strings.

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-44-philmd@redhat.com>
[lersek@redhat.com: replace EFI_D_xxx w/ DEBUG_xxx to shut up PatchCheck]

diff --git a/NetworkPkg/MnpDxe/MnpConfig.c b/NetworkPkg/MnpDxe/MnpConfig.c
index 5906ad546fb2a8b6c1266292abde92810ab2b2b4..3a51210060d6aeab167c4b2f9631294c1ab96d1b 100644 (file)
--- a/NetworkPkg/MnpDxe/MnpConfig.c
+++ b/NetworkPkg/MnpDxe/MnpConfig.c
@@ -707,7 +707,7 @@ MnpCreateServiceData (
   //\r
   MnpServiceData = AllocateZeroPool (sizeof (MNP_SERVICE_DATA));\r
   if (MnpServiceData == NULL) {\r
-    DEBUG ((EFI_D_ERROR, "MnpCreateServiceData: Faild to allocate memory for the new Mnp Service Data.\n"));\r
+    DEBUG ((DEBUG_ERROR, "MnpCreateServiceData: Failed to allocate memory for the new Mnp Service Data.\n"));\r
 \r
     return NULL;\r
   }\r
@@ -742,7 +742,7 @@ MnpCreateServiceData (
                          &MnpServiceData->DevicePath\r
                          );\r
     if (MnpServiceHandle == NULL) {\r
-      DEBUG ((EFI_D_ERROR, "MnpCreateServiceData: Faild to create child handle.\n"));\r
+      DEBUG ((DEBUG_ERROR, "MnpCreateServiceData: Failed to create child handle.\n"));\r
 \r
       return NULL;\r
     }\r
@@ -1325,7 +1325,7 @@ MnpStop (
 \r
   if (MnpDeviceData->ConfiguredChildrenNumber > 0) {\r
     //\r
-    // If there are other configured chilren, return and keep the timers and\r
+    // If there are other configured children, return and keep the timers and\r
     // simple network unchanged.\r
     //\r
     return EFI_SUCCESS;\r
@@ -1402,7 +1402,7 @@ MnpFlushRcvdDataQueue (
 \r
   @param[in, out]  Instance     Pointer to the mnp instance context data.\r
   @param[in]       ConfigData   Pointer to the configuration data used to configure\r
-                                the isntance.\r
+                                the instance.\r
 \r
   @retval EFI_SUCCESS           The Instance is configured.\r
   @retval EFI_UNSUPPORTED       EnableReceiveTimestamps is on and the\r
@@ -1605,7 +1605,7 @@ MnpConfigReceiveFilters (
       EnableFilterBits |= EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST;\r
 \r
       //\r
-      // Allocate pool for the mulicast addresses.\r
+      // Allocate pool for the multicast addresses.\r
       //\r
       MCastFilterCnt  = MnpDeviceData->GroupAddressCount;\r
       MCastFilter     = AllocatePool (sizeof (EFI_MAC_ADDRESS) * MCastFilterCnt);\r
@@ -1696,7 +1696,7 @@ MnpConfigReceiveFilters (
 \r
   @param[in, out]  Instance        Pointer to the mnp instance context data.\r
   @param[in, out]  CtrlBlk         Pointer to the group address control block.\r
-  @param[in, out]  GroupAddress    Pointer to the group adress.\r
+  @param[in, out]  GroupAddress    Pointer to the group address.\r
   @param[in]       MacAddress      Pointer to the mac address.\r
   @param[in]       HwAddressSize   The hardware address size.\r
 \r
@@ -1851,7 +1851,7 @@ MnpGroupOp (
 \r
   if (JoinFlag) {\r
     //\r
-    // A new gropu address is to be added.\r
+    // A new group address is to be added.\r
     //\r
     GroupAddress  = NULL;\r
     AddressExist  = FALSE;\r

diff --git a/NetworkPkg/MnpDxe/MnpDriver.c b/NetworkPkg/MnpDxe/MnpDriver.c
index e99e7c5a6166a8ecab6cde2d1ae5717ff478820e..dfcdec5d31a7434250d09d5dc134d7aa78265941 100644 (file)
--- a/NetworkPkg/MnpDxe/MnpDriver.c
+++ b/NetworkPkg/MnpDxe/MnpDriver.c
@@ -110,7 +110,7 @@ MnpDriverBindingSupported (
   }\r
 \r
   //\r
-  // Close the openned SNP protocol.\r
+  // Close the opened SNP protocol.\r
   //\r
   gBS->CloseProtocol (\r
          ControllerHandle,\r
@@ -419,7 +419,7 @@ MnpDriverBindingStop (
                                      it is not NULL, then the I/O services are added\r
                                      to the existing child 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\r
                                      create the child.\r
@@ -450,7 +450,7 @@ MnpServiceBindingCreateChild (
   //\r
   Instance = AllocateZeroPool (sizeof (MNP_INSTANCE_DATA));\r
   if (Instance == NULL) {\r
-    DEBUG ((EFI_D_ERROR, "MnpServiceBindingCreateChild: Faild to allocate memory for the new instance.\n"));\r
+    DEBUG ((DEBUG_ERROR, "MnpServiceBindingCreateChild: Failed to allocate memory for the new instance.\n"));\r
 \r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
@@ -535,7 +535,7 @@ ErrorExit:
                                  instance.\r
   @param[in]  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\r
                                  is being removed.\r
   @retval EFI_INVALID_PARAMETER  ChildHandle is NULL.\r
@@ -660,7 +660,7 @@ MnpServiceBindingDestroyChild (
   @param[in]  ImageHandle  The image handle of the driver.\r
   @param[in]  SystemTable  The system table.\r
 \r
-  @retval EFI_SUCCES       The driver binding and component name protocols are\r
+  @retval EFI_SUCCESS      The driver binding and component name protocols are\r
                            successfully installed.\r
   @retval Others           Other errors as indicated.\r
 \r

diff --git a/NetworkPkg/MnpDxe/MnpDriver.h b/NetworkPkg/MnpDxe/MnpDriver.h
index 150d21e9ec16b1c7f8bf8d792a140a62bebed853..4837cd0534b239228da8fb7c20c6be3f2a6edb9a 100644 (file)
--- a/NetworkPkg/MnpDxe/MnpDriver.h
+++ b/NetworkPkg/MnpDxe/MnpDriver.h
@@ -1,5 +1,5 @@
 /** @file\r
-  Declaration of strctures and functions for MnpDxe driver.\r
+  Declaration of structures and functions for MnpDxe driver.\r
 \r
 Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.<BR>\r
 SPDX-License-Identifier: BSD-2-Clause-Patent\r
@@ -223,7 +223,7 @@ MnpDriverBindingStop (
                                      it is not NULL, then the I/O services are added\r
                                      to the existing child 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\r
                                      create the child.\r
@@ -248,7 +248,7 @@ MnpServiceBindingCreateChild (
                                  instance.\r
   @param[in]  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\r
                                  is being removed.\r
   @retval EFI_INVALID_PARAMETER  ChildHandle is NULL.\r

diff --git a/NetworkPkg/MnpDxe/MnpDxe.inf b/NetworkPkg/MnpDxe/MnpDxe.inf
index 7280060dded14f640c4cf1f2ad9a9be5c5ff0b3f..608e52aa51d8fa492ef453f33fc2566da56297a0 100644 (file)
--- a/NetworkPkg/MnpDxe/MnpDxe.inf
+++ b/NetworkPkg/MnpDxe/MnpDxe.inf
@@ -1,5 +1,5 @@
 ## @file\r
-#  This module produces EFI MNP Protocol, EFI MNP Servie Binding Protocol and EFI VLAN Protocol.\r
+#  This module produces EFI MNP Protocol, EFI MNP Service Binding Protocol and EFI VLAN Protocol.\r
 #\r
 #  This module produces EFI Managed Network Protocol upon EFI Simple Network Protocol,\r
 #  to provide raw asynchronous network I/O services. It also produces EFI VLAN Protocol\r

diff --git a/NetworkPkg/MnpDxe/MnpDxe.uni b/NetworkPkg/MnpDxe/MnpDxe.uni
index 04be3cd7fe5a5fe6627b26eee527dbaef8767495..481e791499fef744dfcf22ef7b63b36721feceaa 100644 (file)
--- a/NetworkPkg/MnpDxe/MnpDxe.uni
+++ b/NetworkPkg/MnpDxe/MnpDxe.uni
@@ -1,5 +1,5 @@
 // /** @file\r
-// This module produces EFI MNP Protocol, EFI MNP Servie Binding Protocol and EFI VLAN Protocol.\r
+// This module produces EFI MNP Protocol, EFI MNP Service Binding Protocol and EFI VLAN Protocol.\r
 //\r
 // This module produces EFI Managed Network Protocol upon EFI Simple Network Protocol,\r
 // to provide raw asynchronous network I/O services. It also produces EFI VLAN Protocol\r
@@ -12,7 +12,7 @@
 // **/\r
 \r
 \r
-#string STR_MODULE_ABSTRACT             #language en-US "Produces EFI MNP Protocol, EFI MNP Servie Binding Protocol and EFI VLAN Protocol"\r
+#string STR_MODULE_ABSTRACT             #language en-US "Produces EFI MNP Protocol, EFI MNP Service Binding Protocol and EFI VLAN Protocol"\r
 \r
 #string STR_MODULE_DESCRIPTION          #language en-US "This module produces EFI Managed Network Protocol upon EFI Simple Network Protocol to provide raw asynchronous network I/O services. It also produces EFI VLAN Protocol to provide manageability interface for VLAN configuration."\r
 \r

diff --git a/NetworkPkg/MnpDxe/MnpImpl.h b/NetworkPkg/MnpDxe/MnpImpl.h
index 7d542403465993eb7b15d3ff307ea75ef6ef4e35..e91408c6c9bd673ed8f85a251f30b7b946f5498b 100644 (file)
--- a/NetworkPkg/MnpDxe/MnpImpl.h
+++ b/NetworkPkg/MnpDxe/MnpImpl.h
@@ -284,7 +284,7 @@ MnpFlushRcvdDataQueue (
 \r
   @param[in, out]  Instance     Pointer to the mnp instance context data.\r
   @param[in]       ConfigData   Pointer to the configuration data used to configure\r
-                                the isntance.\r
+                                the instance.\r
 \r
   @retval EFI_SUCCESS           The Instance is configured.\r
   @retval EFI_UNSUPPORTED       EnableReceiveTimestamps is on and the\r
@@ -361,12 +361,12 @@ MnpBuildTxPacket (
 /**\r
   Synchronously send out the packet.\r
 \r
-  This functon places the packet buffer to SNP driver's tansmit queue. The packet\r
-  can be considered successfully sent out once SNP acccetp the packet, while the\r
+  This function places the packet buffer to SNP driver's tansmit queue. The packet\r
+  can be considered successfully sent out once SNP accept the packet, while the\r
   packet buffer recycle is deferred for better performance.\r
 \r
   @param[in]       MnpServiceData      Pointer to the mnp service context data.\r
-  @param[in]       Packet              Pointer to the pakcet buffer.\r
+  @param[in]       Packet              Pointer to the packet buffer.\r
   @param[in]       Length              The length of the packet.\r
   @param[in, out]  Token               Pointer to the token the packet generated from.\r
 \r
@@ -404,7 +404,7 @@ MnpInstanceDeliverPacket (
   packet.\r
 \r
   @param[in]  Event               The event this notify function registered to.\r
-  @param[in]  Context             Pointer to the context data registerd to the Event.\r
+  @param[in]  Context             Pointer to the context data registered to the Event.\r
 \r
 **/\r
 VOID\r
@@ -480,8 +480,8 @@ MnpAllocTxBuf (
 \r
   @param[in, out]  MnpDeviceData     Pointer to the mnp device context data.\r
 \r
-  @retval EFI_SUCCESS             Successed to recyclethe transmitted buffer address.\r
-  @retval Others                  Failed to recyclethe transmitted buffer address.\r
+  @retval EFI_SUCCESS             Successed to recycle the transmitted buffer address.\r
+  @retval Others                  Failed to recycle the transmitted buffer address.\r
 \r
 **/\r
 EFI_STATUS\r

diff --git a/NetworkPkg/MnpDxe/MnpIo.c b/NetworkPkg/MnpDxe/MnpIo.c
index 56405d62b5e05b1b1f9f6b743576b32301f539ec..ae4a18fd81ac03b59414ed82e38edf5edb435e64 100644 (file)
--- a/NetworkPkg/MnpDxe/MnpIo.c
+++ b/NetworkPkg/MnpDxe/MnpIo.c
@@ -190,12 +190,12 @@ MnpBuildTxPacket (
 /**\r
   Synchronously send out the packet.\r
 \r
-  This functon places the packet buffer to SNP driver's tansmit queue. The packet\r
-  can be considered successfully sent out once SNP acccetp the packet, while the\r
+  This function places the packet buffer to SNP driver's tansmit queue. The packet\r
+  can be considered successfully sent out once SNP accept the packet, while the\r
   packet buffer recycle is deferred for better performance.\r
 \r
   @param[in]       MnpServiceData      Pointer to the mnp service context data.\r
-  @param[in]       Packet              Pointer to the pakcet buffer.\r
+  @param[in]       Packet              Pointer to the packet buffer.\r
   @param[in]       Length              The length of the packet.\r
   @param[in, out]  Token               Pointer to the token the packet generated from.\r
 \r
@@ -422,7 +422,7 @@ MnpDeliverPacket (
   packet.\r
 \r
   @param[in]  Event               The event this notify function registered to.\r
-  @param[in]  Context             Pointer to the context data registerd to the Event.\r
+  @param[in]  Context             Pointer to the context data registered to the Event.\r
 \r
 **/\r
 VOID\r

diff --git a/NetworkPkg/MnpDxe/MnpMain.c b/NetworkPkg/MnpDxe/MnpMain.c
index d96178a1d9943a3b835c030a38be35a6d4b21094..ff7e89de103ebbc2e50aad7182dd0dbf27b512d2 100644 (file)
--- a/NetworkPkg/MnpDxe/MnpMain.c
+++ b/NetworkPkg/MnpDxe/MnpMain.c
@@ -376,8 +376,8 @@ MnpGroups (
   if ((!Instance->ConfigData.EnableMulticastReceive) ||\r
     ((MacAddress != NULL) && !NET_MAC_IS_MULTICAST (MacAddress, &SnpMode->BroadcastAddress, SnpMode->HwAddressSize))) {\r
     //\r
-    // The instance isn't configured to do mulitcast receive. OR\r
-    // the passed in MacAddress is not a mutlticast mac address.\r
+    // The instance isn't configured to do multicast receive. OR\r
+    // the passed in MacAddress is not a multicast mac address.\r
     //\r
     Status = EFI_INVALID_PARAMETER;\r
     goto ON_EXIT;\r
@@ -713,7 +713,7 @@ MnpCancel (
   }\r
 \r
   //\r
-  // Dispatch the DPC queued by the NotifyFunction of the cancled token's events.\r
+  // Dispatch the DPC queued by the NotifyFunction of the canceled token's events.\r
   //\r
   DispatchDpc ();\r
 \r