NetworkPkg/ArpDxe: 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@linux.intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <20200207010831.9046-31-philmd@redhat.com>
[lersek@redhat.com: replace EFI_D_xxx w/ DEBUG_xxx to shut up PatchCheck]

diff --git a/NetworkPkg/ArpDxe/ArpDriver.c b/NetworkPkg/ArpDxe/ArpDriver.c
index 632d691d75886b5d4f2c24262059d1d93bc93cc4..2b8da5a2bacd538cd59e4a2db06bcf70bc6b203e 100644 (file)
--- a/NetworkPkg/ArpDxe/ArpDriver.c
+++ b/NetworkPkg/ArpDxe/ArpDriver.c
@@ -195,7 +195,7 @@ ArpCleanService (
 \r
   if (ArpService->PeriodicTimer != NULL) {\r
     //\r
-    // Cancle and close the PeriodicTimer.\r
+    // Cancel and close the PeriodicTimer.\r
     //\r
     gBS->SetTimer (ArpService->PeriodicTimer, TimerCancel, 0);\r
     gBS->CloseEvent (ArpService->PeriodicTimer);\r
@@ -203,7 +203,7 @@ ArpCleanService (
 \r
   if (ArpService->RxToken.Event != NULL) {\r
     //\r
-    // Cancle the RxToken and close the event in the RxToken.\r
+    // Cancel the RxToken and close the event in the RxToken.\r
     //\r
     ArpService->Mnp->Cancel (ArpService->Mnp, NULL);\r
     gBS->CloseEvent (ArpService->RxToken.Event);\r
@@ -288,7 +288,7 @@ ArpDestroyChildEntryInHandleBuffer (
   @retval EFI_ACCESS_DENIED        The device specified by ControllerHandle and\r
                                    RemainingDevicePath is already being managed by\r
                                    a different driver or an application that\r
-                                   requires exclusive acces. Currently not implemented.\r
+                                   requires exclusive access. Currently not implemented.\r
   @retval EFI_UNSUPPORTED          The device specified by ControllerHandle and\r
                                    RemainingDevicePath is not supported by the\r
                                    driver specified by This.\r
@@ -363,7 +363,7 @@ ArpDriverBindingSupported (
                                    Currently not implemented.\r
   @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of\r
                                    resources.\r
-  @retval Others                   The driver failded to start the device.\r
+  @retval Others                   The driver failed to start the device.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -547,7 +547,7 @@ ArpDriverBindingStop (
                       then a new handle is created. If it is a pointer to an existing\r
                       UEFI handle, 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
@@ -598,7 +598,7 @@ ArpServiceBindingCreateChild (
                   NULL\r
                   );\r
   if (EFI_ERROR (Status)) {\r
-    DEBUG ((EFI_D_ERROR, "ArpSBCreateChild: faild to install ARP protocol, %r.\n", Status));\r
+    DEBUG ((DEBUG_ERROR, "ArpSBCreateChild: failed to install ARP protocol, %r.\n", Status));\r
 \r
     FreePool (Instance);\r
     return Status;\r
@@ -672,7 +672,7 @@ 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\r
                                 being removed.\r
   @retval EFI_INVALID_PARAMETER Child handle is NULL.\r

diff --git a/NetworkPkg/ArpDxe/ArpDriver.h b/NetworkPkg/ArpDxe/ArpDriver.h
index 0b5b06ee37d576fb27811688ec98c895dfa9c229..7dbc1c187820a7f0da49702b4eae8434e5ead966 100644 (file)
--- a/NetworkPkg/ArpDxe/ArpDriver.h
+++ b/NetworkPkg/ArpDxe/ArpDriver.h
@@ -30,7 +30,7 @@ extern EFI_COMPONENT_NAME_PROTOCOL    gArpComponentName;
 extern EFI_COMPONENT_NAME2_PROTOCOL   gArpComponentName2;\r
 \r
 //\r
-// Function prototypes for the Drivr Binding Protocol\r
+// Function prototypes for the Driver Binding Protocol\r
 //\r
 /**\r
   Tests to see if this driver supports a given controller.\r
@@ -55,7 +55,7 @@ extern EFI_COMPONENT_NAME2_PROTOCOL   gArpComponentName2;
   @retval EFI_ACCESS_DENIED        The device specified by ControllerHandle and\r
                                    RemainingDevicePath is already being managed by\r
                                    a different driver or an application that\r
-                                   requires exclusive acces. Currently not implemented.\r
+                                   requires exclusive access. Currently not implemented.\r
   @retval EFI_UNSUPPORTED          The device specified by ControllerHandle and\r
                                    RemainingDevicePath is not supported by the\r
                                    driver specified by This.\r
@@ -97,7 +97,7 @@ ArpDriverBindingSupported (
                                    Currently not implemented.\r
   @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of\r
                                    resources.\r
-  @retval Others                   The driver failded to start the device.\r
+  @retval Others                   The driver failed to start the device.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -159,7 +159,7 @@ ArpDriverBindingStop (
                       then a new handle is created. If it is a pointer to an existing\r
                       UEFI handle, 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
@@ -183,7 +183,7 @@ ArpServiceBindingCreateChild (
   @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\r
                                 being removed.\r
   @retval EFI_INVALID_PARAMETER Child handle is NULL.\r

diff --git a/NetworkPkg/ArpDxe/ArpImpl.c b/NetworkPkg/ArpDxe/ArpImpl.c
index 0e9ef103eff9c31d1f34fb5a1feae5bd97021bed..9cdb33f2bd66f1455a0d88ac88a59fe443013fe0 100644 (file)
--- a/NetworkPkg/ArpDxe/ArpImpl.c
+++ b/NetworkPkg/ArpDxe/ArpImpl.c
@@ -55,7 +55,7 @@ ArpInitInstance (
 /**\r
   Process the Arp packets received from Mnp, the procedure conforms to RFC826.\r
 \r
-  @param[in]  Context            Pointer to the context data registerd to the\r
+  @param[in]  Context            Pointer to the context data registered to the\r
                                  Event.\r
 \r
   @return None.\r
@@ -316,7 +316,7 @@ RESTART_RECEIVE:
   Queue ArpOnFrameRcvdDpc as a DPC at TPL_CALLBACK.\r
 \r
   @param[in]  Event                  The Event this notify function registered to.\r
-  @param[in]  Context                Pointer to the context data registerd to the\r
+  @param[in]  Context                Pointer to the context data registered to the\r
                                      Event.\r
 \r
   @return None.\r
@@ -338,7 +338,7 @@ ArpOnFrameRcvd (
 /**\r
   Process the already sent arp packets.\r
 \r
-  @param[in]  Context                Pointer to the context data registerd to the\r
+  @param[in]  Context                Pointer to the context data registered to the\r
                                      Event.\r
 \r
   @return None.\r
@@ -377,7 +377,7 @@ ArpOnFrameSentDpc (
   Request ArpOnFrameSentDpc as a DPC at TPL_CALLBACK.\r
 \r
   @param[in]  Event                  The Event this notify function registered to.\r
-  @param[in]  Context                Pointer to the context data registerd to the\r
+  @param[in]  Context                Pointer to the context data registered to the\r
                                      Event.\r
 \r
   @return None.\r
@@ -401,7 +401,7 @@ ArpOnFrameSent (
   Process the arp cache olding and drive the retrying arp requests.\r
 \r
   @param[in]  Event                  The Event this notify function registered to.\r
-  @param[in]  Context                Pointer to the context data registerd to the\r
+  @param[in]  Context                Pointer to the context data registered to the\r
                                      Event.\r
 \r
   @return None.\r
@@ -1008,7 +1008,7 @@ ArpConfigureInstance (
 \r
 \r
 /**\r
-  Send out an arp frame using the CachEntry and the ArpOpCode.\r
+  Send out an arp frame using the CacheEntry and the ArpOpCode.\r
 \r
   @param[in]  Instance               Pointer to the instance context data.\r
   @param[in]  CacheEntry             Pointer to the configuration data used to\r
@@ -1344,7 +1344,7 @@ ArpDeleteCacheEntry (
             );\r
 \r
   //\r
-  // Delete the cache entries inthe ResolvedCacheTable.\r
+  // Delete the cache entries in the ResolvedCacheTable.\r
   //\r
   Count += ArpDeleteCacheEntryInTable (\r
              &ArpService->ResolvedCacheTable,\r
@@ -1466,7 +1466,7 @@ ArpFindCacheEntry (
   ArpService = Instance->ArpService;\r
 \r
   //\r
-  // Init the FounEntries used to hold the found cache entries.\r
+  // Init the FoundEntries used to hold the found cache entries.\r
   //\r
   NetMapInit (&FoundEntries);\r
 \r

diff --git a/NetworkPkg/ArpDxe/ArpImpl.h b/NetworkPkg/ArpDxe/ArpImpl.h
index 47eedc1cb6f7dcc6f8885755b2171077119c6cb7..506f3e6ef61ebda73ff9fb1371eac9401954c03f 100644 (file)
--- a/NetworkPkg/ArpDxe/ArpImpl.h
+++ b/NetworkPkg/ArpDxe/ArpImpl.h
@@ -436,7 +436,7 @@ ArpRequest (
 \r
   If the request is in the internal ARP request queue, the request is aborted\r
   immediately and its ResolvedEvent is signaled. Only an asynchronous address\r
-  request needs to be canceled. If TargeSwAddress and ResolveEvent are both\r
+  request needs to be canceled. If TargetSwAddress and ResolvedEvent are both\r
   NULL, all the pending asynchronous requests that have been issued by This\r
   instance will be cancelled and their corresponding events will be signaled.\r
 \r
@@ -599,7 +599,7 @@ ArpDeleteCacheEntry (
   );\r
 \r
 /**\r
-  Send out an arp frame using the CachEntry and the ArpOpCode.\r
+  Send out an arp frame using the CacheEntry and the ArpOpCode.\r
 \r
   @param[in]  Instance               Pointer to the instance context data.\r
   @param[in]  CacheEntry             Pointer to the configuration data used to\r
@@ -636,7 +636,7 @@ ArpInitInstance (
 /**\r
   Process the Arp packets received from Mnp, the procedure conforms to RFC826.\r
 \r
-  @param[in]  Context            Pointer to the context data registerd to the\r
+  @param[in]  Context            Pointer to the context data registered to the\r
                                  Event.\r
 \r
   @return None.\r
@@ -652,7 +652,7 @@ ArpOnFrameRcvdDpc (
   Queue ArpOnFrameRcvdDpc as a DPC at TPL_CALLBACK.\r
 \r
   @param[in]  Event                  The Event this notify function registered to.\r
-  @param[in]  Context                Pointer to the context data registerd to the\r
+  @param[in]  Context                Pointer to the context data registered to the\r
                                      Event.\r
 \r
   @return None.\r
@@ -668,7 +668,7 @@ ArpOnFrameRcvd (
 /**\r
   Process the already sent arp packets.\r
 \r
-  @param[in]  Context                Pointer to the context data registerd to the\r
+  @param[in]  Context                Pointer to the context data registered to the\r
                                      Event.\r
 \r
   @return None.\r
@@ -684,7 +684,7 @@ ArpOnFrameSentDpc (
   Request ArpOnFrameSentDpc as a DPC at TPL_CALLBACK.\r
 \r
   @param[in]  Event                  The Event this notify function registered to.\r
-  @param[in]  Context                Pointer to the context data registerd to the\r
+  @param[in]  Context                Pointer to the context data registered to the\r
                                      Event.\r
 \r
   @return None.\r
@@ -701,7 +701,7 @@ ArpOnFrameSent (
   Process the arp cache olding and drive the retrying arp requests.\r
 \r
   @param[in]  Event                  The Event this notify function registered to.\r
-  @param[in]  Context                Pointer to the context data registerd to the\r
+  @param[in]  Context                Pointer to the context data registered to the\r
                                      Event.\r
 \r
   @return None.\r

diff --git a/NetworkPkg/ArpDxe/ArpMain.c b/NetworkPkg/ArpDxe/ArpMain.c
index f06121fed452cf0b4bcb0763123a1d4a4cb6b290..6e8690a93689940ea40c04559fbf5686e2396864 100644 (file)
--- a/NetworkPkg/ArpDxe/ArpMain.c
+++ b/NetworkPkg/ArpDxe/ArpMain.c
@@ -175,7 +175,7 @@ ArpAdd (
   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
 \r
   //\r
-  // See whether the entry to add exists. Check the DeinedCacheTable first.\r
+  // See whether the entry to add exists. Check the DeniedCacheTable first.\r
   //\r
   CacheEntry = ArpFindDeniedCacheEntry (\r
                  ArpService,\r
@@ -198,7 +198,7 @@ ArpAdd (
 \r
   if ((CacheEntry != NULL) && !Overwrite) {\r
     //\r
-    // The entry to add exists, if not Overwirte, deny this add request.\r
+    // The entry to add exists, if not Overwrite, deny this add request.\r
     //\r
     Status = EFI_ACCESS_DENIED;\r
     goto UNLOCK_EXIT;\r
@@ -542,7 +542,7 @@ ArpRequest (
   ProtocolAddress.AddressPtr = TargetSwAddress;\r
 \r
   //\r
-  // Initialize the TargetHwAddrss to a zero address.\r
+  // Initialize the TargetHwAddress to a zero address.\r
   //\r
   ZeroMem (TargetHwAddress, SnpMode->HwAddressSize);\r
 \r
@@ -675,7 +675,7 @@ SIGNAL_USER:
 \r
   If the request is in the internal ARP request queue, the request is aborted\r
   immediately and its ResolvedEvent is signaled. Only an asynchronous address\r
-  request needs to be canceled. If TargeSwAddress and ResolveEvent are both\r
+  request needs to be canceled. If TargetSwAddress and ResolvedEvent are both\r
   NULL, all the pending asynchronous requests that have been issued by This\r
   instance will be cancelled and their corresponding events will be signaled.\r
 \r
@@ -729,7 +729,7 @@ ArpCancel (
 \r
   //\r
   // Dispatch the DPCs queued by the NotifyFunction of the events signaled\r
-  // by ArpCancleRequest.\r
+  // by ArpCancelRequest.\r
   //\r
   DispatchDpc ();\r
 \r