NetworkPkg/Dhcp6Dxe: Fix various typos

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-33-philmd@redhat.com>

NetworkPkg/Dhcp6Dxe/Dhcp6Driver.c

@@ -1,6 +1,6 @@
 /** @file
   Driver Binding functions and Service Binding functions
-  implementationfor for Dhcp6 Driver.
+  implementation for Dhcp6 Driver.
 
   Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
 
@@ -300,7 +300,7 @@ Dhcp6CreateInstance (
 
   //
   // There is a timer for each Dhcp6 instance, which is used to track the
-  // lease time of Ia and the retransmisson time of all sent packets.
+  // lease time of Ia and the retransmission time of all sent packets.
   //
   Status = gBS->CreateEvent (
                   EVT_NOTIFY_SIGNAL | EVT_TIMER,
@@ -445,7 +445,7 @@ Dhcp6DriverBindingStart (
   DHCP6_SERVICE                   *Service;
 
   //
-  // Check the Dhcp6 serivce whether already started.
+  // Check the Dhcp6 service whether already started.
   //
   Status = gBS->OpenProtocol (
                   ControllerHandle,
@@ -551,7 +551,7 @@ Dhcp6DriverBindingStop (
   Service = DHCP6_SERVICE_FROM_THIS (ServiceBinding);
   if (!IsListEmpty (&Service->Child)) {
     //
-    // Destroy all the children instances before destory the service.
+    // Destroy all the children instances before destroy the service.
     //
     List = &Service->Child;
     Status = NetDestroyLinkList (
@@ -603,7 +603,7 @@ ON_EXIT:
                               then a new handle is created. If it is a pointer to an existing
                               UEFI handle, then the protocol is added to the existing UEFI handle.
 
-  @retval EFI_SUCCES            The protocol was added to ChildHandle.
+  @retval EFI_SUCCESS           The protocol was added to ChildHandle.
   @retval EFI_INVALID_PARAMETER ChildHandle is NULL.
   @retval other                 The child handle was not created.
 
@@ -715,7 +715,7 @@ ON_ERROR:
   @param[in]  This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
   @param[in]  ChildHandle Handle of the child to destroy
 
-  @retval EFI_SUCCES            The protocol was removed from ChildHandle.
+  @retval EFI_SUCCESS           The protocol was removed from ChildHandle.
   @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.
   @retval EFI_INVALID_PARAMETER Child handle is NULL.
   @retval EFI_ACCESS_DENIED     The protocol could not be removed from the ChildHandle

NetworkPkg/Dhcp6Dxe/Dhcp6Driver.h

@@ -108,7 +108,7 @@ Dhcp6DriverBindingStop (
                       then a new handle is created. If it is a pointer to an existing UEFI handle,
                       then the protocol is added to the existing UEFI handle.
 
-  @retval EFI_SUCCES            The protocol was added to ChildHandle.
+  @retval EFI_SUCCESS           The protocol was added to ChildHandle.
   @retval EFI_INVALID_PARAMETER ChildHandle is NULL.
   @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to create
                                 the child.
@@ -132,7 +132,7 @@ Dhcp6ServiceBindingCreateChild (
   @param  This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
   @param  ChildHandle Handle of the child to destroy.
 
-  @retval EFI_SUCCES            The protocol was removed from ChildHandle.
+  @retval EFI_SUCCESS           The protocol was removed from ChildHandle.
   @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.
   @retval EFI_INVALID_PARAMETER Child handle is NULL.
   @retval EFI_ACCESS_DENIED     The protocol could not be removed from the ChildHandle

NetworkPkg/Dhcp6Dxe/Dhcp6Impl.c

@@ -96,7 +96,7 @@ EfiDhcp6Start (
   OldTpl           = gBS->RaiseTPL (TPL_CALLBACK);
 
   //
-  // Check Media Satus.
+  // Check Media Status.
   //
   MediaStatus = EFI_SUCCESS;
   NetLibDetectMediaWaitTimeout (Service->Controller, DHCP_CHECK_MEDIA_WAITING_TIME, &MediaStatus);
@@ -220,7 +220,7 @@ EfiDhcp6Stop (
   }
 
   //
-  // Poll udp out of the net tpl if synchoronus call.
+  // Poll udp out of the net tpl if synchronous call.
   //
   if (Instance->Config->IaInfoEvent == NULL) {
     ASSERT (Udp6 != NULL);
@@ -694,7 +694,7 @@ EfiDhcp6InfoRequest (
   }
 
   //
-  // Poll udp out of the net tpl if synchoronus call.
+  // Poll udp out of the net tpl if synchronous call.
   //
   if (TimeoutEvent == NULL) {
 
@@ -823,7 +823,7 @@ EfiDhcp6RenewRebind (
   gBS->RestoreTPL (OldTpl);
 
   //
-  // Poll udp out of the net tpl if synchoronus call.
+  // Poll udp out of the net tpl if synchronous call.
   //
   if (Instance->Config->IaInfoEvent == NULL) {
 
@@ -958,7 +958,7 @@ EfiDhcp6Decline (
   gBS->RestoreTPL (OldTpl);
 
   //
-  // Poll udp out of the net tpl if synchoronus call.
+  // Poll udp out of the net tpl if synchronous call.
   //
   if (Instance->Config->IaInfoEvent == NULL) {
 
@@ -1099,7 +1099,7 @@ EfiDhcp6Release (
   gBS->RestoreTPL (OldTpl);
 
   //
-  // Poll udp out of the net tpl if synchoronus call.
+  // Poll udp out of the net tpl if synchronous call.
   //
   if (Instance->Config->IaInfoEvent == NULL) {
     while (Instance->UdpSts == EFI_ALREADY_STARTED) {

NetworkPkg/Dhcp6Dxe/Dhcp6Io.c

@@ -58,7 +58,7 @@ Dhcp6EnqueueRetry (
   TxCb->Elapsed  = Elapsed;
 
   //
-  // Calculate the retransmission according to the the message type.
+  // Calculate the retransmission according to the message type.
   //
   switch (Packet->Dhcp6.Header.MessageType) {
   case Dhcp6MsgSolicit:
@@ -549,13 +549,13 @@ Dhcp6UpdateIaInfo (
 
   ASSERT (Instance->Config != NULL);
   //
-  // If the reply was received in reponse to a solicit with rapid commit option,
+  // If the reply was received in response to a solicit with rapid commit option,
   // request, renew or rebind message, the client updates the information it has
   // recorded about IAs from the IA options contained in the reply message:
   //   1. record the T1 and T2 times
   //   2. add any new addresses in the IA
   //   3. discard any addresses from the IA, that have a valid lifetime of 0
-  //   4. update lifetimes for any addresses that alread recorded
+  //   4. update lifetimes for any addresses that already recorded
   //   5. leave unchanged any information about addresses
   //
   // See details in the section-18.1.8 of rfc-3315.
@@ -942,7 +942,7 @@ Dhcp6SendSolicitMsg   (
   }
 
   //
-  // Create the Dhcp6 packet and initialize commone fields.
+  // Create the Dhcp6 packet and initialize common fields.
   //
   Packet = AllocateZeroPool (DHCP6_BASE_PACKET_SIZE + UserLen);
   if (Packet == NULL) {
@@ -1124,7 +1124,7 @@ Dhcp6SendRequestMsg (
   }
 
   //
-  // Create the Dhcp6 packet and initialize commone fields.
+  // Create the Dhcp6 packet and initialize common fields.
   //
   Packet = AllocateZeroPool (DHCP6_BASE_PACKET_SIZE + UserLen);
   if (Packet == NULL) {
@@ -1282,7 +1282,7 @@ Dhcp6SendDeclineMsg (
   ServerId = (EFI_DHCP6_DUID *) (Option + 2);
 
   //
-  // Create the Dhcp6 packet and initialize commone fields.
+  // Create the Dhcp6 packet and initialize common fields.
   //
   Packet = AllocateZeroPool (DHCP6_BASE_PACKET_SIZE);
   if (Packet == NULL) {
@@ -1416,7 +1416,7 @@ Dhcp6SendReleaseMsg (
   ServerId = (EFI_DHCP6_DUID *) (Option + 2);
 
   //
-  // Create the Dhcp6 packet and initialize commone fields.
+  // Create the Dhcp6 packet and initialize common fields.
   //
   Packet = AllocateZeroPool (DHCP6_BASE_PACKET_SIZE);
   if (Packet == NULL) {
@@ -1547,7 +1547,7 @@ Dhcp6SendRenewRebindMsg (
   }
 
   //
-  // Create the Dhcp6 packet and initialize commone fields.
+  // Create the Dhcp6 packet and initialize common fields.
   //
   Packet = AllocateZeroPool (DHCP6_BASE_PACKET_SIZE + UserLen);
   if (Packet == NULL) {
@@ -1830,7 +1830,7 @@ Dhcp6SendInfoRequestMsg (
   }
 
   //
-  // Create the Dhcp6 packet and initialize commone fields.
+  // Create the Dhcp6 packet and initialize common fields.
   //
   Packet = AllocateZeroPool (DHCP6_BASE_PACKET_SIZE + UserLen);
   if (Packet == NULL) {
@@ -2150,7 +2150,7 @@ Dhcp6HandleReplyMsg (
     Instance->UdpSts = EFI_SUCCESS;
 
     //
-    // For async, signal the Ia event to inform Ia infomation update.
+    // For async, signal the Ia event to inform Ia information update.
     //
     if (Instance->Config->IaInfoEvent != NULL) {
       gBS->SignalEvent (Instance->Config->IaInfoEvent);
@@ -2213,14 +2213,14 @@ Dhcp6HandleReplyMsg (
 
       //
       // Maybe this is a new round DHCP process due to some reason, such as NotOnLink
-      // ReplyMsg for ConfirmMsg should triger new round to acquire new address. In that
+      // ReplyMsg for ConfirmMsg should trigger new round to acquire new address. In that
       // case, clear old address.ValidLifetime and append to new address. Therefore, DHCP
       // consumers can be notified to flush old address.
       //
       Dhcp6AppendCacheIa (Instance);
 
       //
-      // For async, signal the Ia event to inform Ia infomation update.
+      // For async, signal the Ia event to inform Ia information update.
       //
       if (Instance->Config->IaInfoEvent != NULL) {
         gBS->SignalEvent (Instance->Config->IaInfoEvent);
@@ -2431,7 +2431,7 @@ Dhcp6HandleAdvertiseMsg (
 
   //
   // If the client does receives a valid reply message that includes a rapid
-  // commit option since a solicit with rapid commit optioin sent before, select
+  // commit option since a solicit with rapid commit option sent before, select
   // this reply message. Or else, process the advertise messages as normal.
   // See details in the section-17.1.4 of rfc-3315.
   //

NetworkPkg/Dhcp6Dxe/Dhcp6Utility.c

@@ -312,7 +312,7 @@ Dhcp6CleanupModeData (
 
   @param[in]  Base          The base value of the time.
   @param[in]  IsFirstRt     If TRUE, it is the first time to calculate expire time.
-  @param[in]  NeedSigned    If TRUE, the the signed factor is needed.
+  @param[in]  NeedSigned    If TRUE, the signed factor is needed.
 
   @return     Expire        The calculated result for the new expire time.
 
@@ -506,7 +506,7 @@ Dhcp6DepriveAddress (
     //
     // If release all Ia addresses, just copy the configured Ia and then set
     // its address count as zero.
-    // We may decline/release part of addresses at the begining. So it's a
+    // We may decline/release part of addresses at the beginning. So it's a
     // forwarding step to update address infor for decline/release, while the
     // other infor such as Ia state will be updated when receiving reply.
     //
@@ -995,7 +995,7 @@ Dhcp6SeekIaOption (
 
 /**
   Check whether the incoming IPv6 address in IaAddr is one of the maintained
-  addresses in the IA control blcok.
+  addresses in the IA control block.
 
   @param[in]  IaAddr            The pointer to the IA Address to be checked.
   @param[in]  CurrentIa         The pointer to the IA in IA control block.
@@ -1023,9 +1023,9 @@ Dhcp6AddrIsInCurrentIa (
 }
 
 /**
-  Parse the address option and update the address infomation.
+  Parse the address option and update the address information.
 
-  @param[in]      CurrentIa     The pointer to the Ia Address in control blcok.
+  @param[in]      CurrentIa     The pointer to the Ia Address in control block.
   @param[in]      IaInnerOpt    The pointer to the buffer.
   @param[in]      IaInnerLen    The length to parse.
   @param[out]     AddrNum       The number of addresses.
@@ -1107,7 +1107,7 @@ Dhcp6ParseAddrOption (
 
 
 /**
-  Create a control blcok for the Ia according to the corresponding options.
+  Create a control block for the Ia according to the corresponding options.
 
   @param[in]  Instance              The pointer to DHCP6 Instance.
   @param[in]  IaInnerOpt            The pointer to the inner options in the Ia option.
@@ -1229,7 +1229,7 @@ Dhcp6CacheIa (
 }
 
 /**
-  Append CacheIa to the currrent IA. Meanwhile, clear CacheIa.ValidLifetime to 0.
+  Append CacheIa to the current IA. Meanwhile, clear CacheIa.ValidLifetime to 0.
 
   @param[in]  Instance            The pointer to DHCP6 instance.
 
@@ -1285,7 +1285,7 @@ Dhcp6AppendCacheIa (
 }
 
 /**
-  Calculate the Dhcp6 get mapping timeout by adding additinal delay to the IP6 DAD transmits count.
+  Calculate the Dhcp6 get mapping timeout by adding additional delay to the IP6 DAD transmits count.
 
   @param[in]   Ip6Cfg              The pointer to Ip6 config protocol.
   @param[out]  TimeOut             The time out value in 100ns units.

NetworkPkg/Dhcp6Dxe/Dhcp6Utility.h

@@ -71,7 +71,7 @@ Dhcp6CleanupModeData (
 
   @param[in]  Base          The base value of the time.
   @param[in]  IsFirstRt     If TRUE, it is the first time to calculate expire time.
-  @param[in]  NeedSigned    If TRUE, the the signed factor is needed.
+  @param[in]  NeedSigned    If TRUE, the signed factor is needed.
 
   @return     Expire        The calculated result for the new expire time.
 
@@ -165,7 +165,7 @@ Dhcp6OnTransmitted (
 
   @param[in, out] Buf           The pointer to buffer.
   @param[in]      OptType       The option type.
-  @param[in]      OptLen        The lenght of option content.s
+  @param[in]      OptLen        The length of option content.s
   @param[in]      Data          The pointer to the option content.
 
   @return         Buf           The position to append the next option.
@@ -270,7 +270,7 @@ Dhcp6SeekIaOption (
 /**
   Parse the address option and update the address info.
 
-  @param[in]      CurrentIa     The pointer to the Ia Address in control blcok.
+  @param[in]      CurrentIa     The pointer to the Ia Address in control block.
   @param[in]      IaInnerOpt    The pointer to the buffer.
   @param[in]      IaInnerLen    The length to parse.
   @param[out]     AddrNum       The number of addresses.
@@ -287,7 +287,7 @@ Dhcp6ParseAddrOption (
   );
 
 /**
-  Create a control blcok for the Ia according to the corresponding options.
+  Create a control block for the Ia according to the corresponding options.
 
   @param[in]  Instance              The pointer to DHCP6 Instance.
   @param[in]  IaInnerOpt            The pointer to the inner options in the Ia option.
@@ -327,7 +327,7 @@ Dhcp6CacheIa (
 
 
 /**
-  Append CacheIa to the currrent IA. Meanwhile, clear CacheIa.ValidLifetime to 0.
+  Append CacheIa to the current IA. Meanwhile, clear CacheIa.ValidLifetime to 0.
 
   @param[in]  Instance            The pointer to DHCP6 instance.
 
@@ -338,7 +338,7 @@ Dhcp6AppendCacheIa (
   );
 
 /**
-  Calculate the Dhcp6 get mapping timeout by adding additinal delay to the IP6 DAD transmits count.
+  Calculate the Dhcp6 get mapping timeout by adding additional delay to the IP6 DAD transmits count.
 
   @param[in]   Ip6Cfg              The pointer to Ip6 config protocol.
   @param[out]  TimeOut             The time out value in 100ns units.