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

NetworkPkg/Dhcp6Dxe/Dhcp6Driver.c
NetworkPkg/Dhcp6Dxe/Dhcp6Driver.h
NetworkPkg/Dhcp6Dxe/Dhcp6Impl.c
NetworkPkg/Dhcp6Dxe/Dhcp6Io.c
NetworkPkg/Dhcp6Dxe/Dhcp6Utility.c
NetworkPkg/Dhcp6Dxe/Dhcp6Utility.h

index 2ffdba73a563f6e409f73de9c0139a84e1fdb5a6..f0b236835f869c621a96811f289fd7d9e5cec2df 100644 (file)
@@ -1,6 +1,6 @@
 /** @file\r
   Driver Binding functions and Service Binding functions\r
-  implementationfor for Dhcp6 Driver.\r
+  implementation for Dhcp6 Driver.\r
 \r
   Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
 \r
@@ -300,7 +300,7 @@ Dhcp6CreateInstance (
 \r
   //\r
   // There is a timer for each Dhcp6 instance, which is used to track the\r
-  // lease time of Ia and the retransmisson time of all sent packets.\r
+  // lease time of Ia and the retransmission time of all sent packets.\r
   //\r
   Status = gBS->CreateEvent (\r
                   EVT_NOTIFY_SIGNAL | EVT_TIMER,\r
@@ -445,7 +445,7 @@ Dhcp6DriverBindingStart (
   DHCP6_SERVICE                   *Service;\r
 \r
   //\r
-  // Check the Dhcp6 serivce whether already started.\r
+  // Check the Dhcp6 service whether already started.\r
   //\r
   Status = gBS->OpenProtocol (\r
                   ControllerHandle,\r
@@ -551,7 +551,7 @@ Dhcp6DriverBindingStop (
   Service = DHCP6_SERVICE_FROM_THIS (ServiceBinding);\r
   if (!IsListEmpty (&Service->Child)) {\r
     //\r
-    // Destroy all the children instances before destory the service.\r
+    // Destroy all the children instances before destroy the service.\r
     //\r
     List = &Service->Child;\r
     Status = NetDestroyLinkList (\r
@@ -603,7 +603,7 @@ ON_EXIT:
                               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 other                 The child handle was not created.\r
 \r
@@ -715,7 +715,7 @@ ON_ERROR:
   @param[in]  This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL 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 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 a609eddf247412319a2c1acbdab8d0d79be70bc2..1b8744b9b8d26b674d144f30f2916a3fffc59cec 100644 (file)
@@ -108,7 +108,7 @@ Dhcp6DriverBindingStop (
                       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
@@ -132,7 +132,7 @@ Dhcp6ServiceBindingCreateChild (
   @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 44c340ed0c6ad8dfcb57539585354e18f08963da..bb4c1d12a987c13697db6a2d4bb5bcb79b9e17a8 100644 (file)
@@ -96,7 +96,7 @@ EfiDhcp6Start (
   OldTpl           = gBS->RaiseTPL (TPL_CALLBACK);\r
 \r
   //\r
-  // Check Media Satus.\r
+  // Check Media Status.\r
   //\r
   MediaStatus = EFI_SUCCESS;\r
   NetLibDetectMediaWaitTimeout (Service->Controller, DHCP_CHECK_MEDIA_WAITING_TIME, &MediaStatus);\r
@@ -220,7 +220,7 @@ EfiDhcp6Stop (
   }\r
 \r
   //\r
-  // Poll udp out of the net tpl if synchoronus call.\r
+  // Poll udp out of the net tpl if synchronous call.\r
   //\r
   if (Instance->Config->IaInfoEvent == NULL) {\r
     ASSERT (Udp6 != NULL);\r
@@ -694,7 +694,7 @@ EfiDhcp6InfoRequest (
   }\r
 \r
   //\r
-  // Poll udp out of the net tpl if synchoronus call.\r
+  // Poll udp out of the net tpl if synchronous call.\r
   //\r
   if (TimeoutEvent == NULL) {\r
 \r
@@ -823,7 +823,7 @@ EfiDhcp6RenewRebind (
   gBS->RestoreTPL (OldTpl);\r
 \r
   //\r
-  // Poll udp out of the net tpl if synchoronus call.\r
+  // Poll udp out of the net tpl if synchronous call.\r
   //\r
   if (Instance->Config->IaInfoEvent == NULL) {\r
 \r
@@ -958,7 +958,7 @@ EfiDhcp6Decline (
   gBS->RestoreTPL (OldTpl);\r
 \r
   //\r
-  // Poll udp out of the net tpl if synchoronus call.\r
+  // Poll udp out of the net tpl if synchronous call.\r
   //\r
   if (Instance->Config->IaInfoEvent == NULL) {\r
 \r
@@ -1099,7 +1099,7 @@ EfiDhcp6Release (
   gBS->RestoreTPL (OldTpl);\r
 \r
   //\r
-  // Poll udp out of the net tpl if synchoronus call.\r
+  // Poll udp out of the net tpl if synchronous call.\r
   //\r
   if (Instance->Config->IaInfoEvent == NULL) {\r
     while (Instance->UdpSts == EFI_ALREADY_STARTED) {\r
index 613b42149cc18da3191428e12f6866796bbf47a6..c20876d5a5d32fa550e7b3981033a55faf7a9706 100644 (file)
@@ -58,7 +58,7 @@ Dhcp6EnqueueRetry (
   TxCb->Elapsed  = Elapsed;\r
 \r
   //\r
-  // Calculate the retransmission according to the the message type.\r
+  // Calculate the retransmission according to the message type.\r
   //\r
   switch (Packet->Dhcp6.Header.MessageType) {\r
   case Dhcp6MsgSolicit:\r
@@ -549,13 +549,13 @@ Dhcp6UpdateIaInfo (
 \r
   ASSERT (Instance->Config != NULL);\r
   //\r
-  // If the reply was received in reponse to a solicit with rapid commit option,\r
+  // If the reply was received in response to a solicit with rapid commit option,\r
   // request, renew or rebind message, the client updates the information it has\r
   // recorded about IAs from the IA options contained in the reply message:\r
   //   1. record the T1 and T2 times\r
   //   2. add any new addresses in the IA\r
   //   3. discard any addresses from the IA, that have a valid lifetime of 0\r
-  //   4. update lifetimes for any addresses that alread recorded\r
+  //   4. update lifetimes for any addresses that already recorded\r
   //   5. leave unchanged any information about addresses\r
   //\r
   // See details in the section-18.1.8 of rfc-3315.\r
@@ -942,7 +942,7 @@ Dhcp6SendSolicitMsg   (
   }\r
 \r
   //\r
-  // Create the Dhcp6 packet and initialize commone fields.\r
+  // Create the Dhcp6 packet and initialize common fields.\r
   //\r
   Packet = AllocateZeroPool (DHCP6_BASE_PACKET_SIZE + UserLen);\r
   if (Packet == NULL) {\r
@@ -1124,7 +1124,7 @@ Dhcp6SendRequestMsg (
   }\r
 \r
   //\r
-  // Create the Dhcp6 packet and initialize commone fields.\r
+  // Create the Dhcp6 packet and initialize common fields.\r
   //\r
   Packet = AllocateZeroPool (DHCP6_BASE_PACKET_SIZE + UserLen);\r
   if (Packet == NULL) {\r
@@ -1282,7 +1282,7 @@ Dhcp6SendDeclineMsg (
   ServerId = (EFI_DHCP6_DUID *) (Option + 2);\r
 \r
   //\r
-  // Create the Dhcp6 packet and initialize commone fields.\r
+  // Create the Dhcp6 packet and initialize common fields.\r
   //\r
   Packet = AllocateZeroPool (DHCP6_BASE_PACKET_SIZE);\r
   if (Packet == NULL) {\r
@@ -1416,7 +1416,7 @@ Dhcp6SendReleaseMsg (
   ServerId = (EFI_DHCP6_DUID *) (Option + 2);\r
 \r
   //\r
-  // Create the Dhcp6 packet and initialize commone fields.\r
+  // Create the Dhcp6 packet and initialize common fields.\r
   //\r
   Packet = AllocateZeroPool (DHCP6_BASE_PACKET_SIZE);\r
   if (Packet == NULL) {\r
@@ -1547,7 +1547,7 @@ Dhcp6SendRenewRebindMsg (
   }\r
 \r
   //\r
-  // Create the Dhcp6 packet and initialize commone fields.\r
+  // Create the Dhcp6 packet and initialize common fields.\r
   //\r
   Packet = AllocateZeroPool (DHCP6_BASE_PACKET_SIZE + UserLen);\r
   if (Packet == NULL) {\r
@@ -1830,7 +1830,7 @@ Dhcp6SendInfoRequestMsg (
   }\r
 \r
   //\r
-  // Create the Dhcp6 packet and initialize commone fields.\r
+  // Create the Dhcp6 packet and initialize common fields.\r
   //\r
   Packet = AllocateZeroPool (DHCP6_BASE_PACKET_SIZE + UserLen);\r
   if (Packet == NULL) {\r
@@ -2150,7 +2150,7 @@ Dhcp6HandleReplyMsg (
     Instance->UdpSts = EFI_SUCCESS;\r
 \r
     //\r
-    // For async, signal the Ia event to inform Ia infomation update.\r
+    // For async, signal the Ia event to inform Ia information update.\r
     //\r
     if (Instance->Config->IaInfoEvent != NULL) {\r
       gBS->SignalEvent (Instance->Config->IaInfoEvent);\r
@@ -2213,14 +2213,14 @@ Dhcp6HandleReplyMsg (
 \r
       //\r
       // Maybe this is a new round DHCP process due to some reason, such as NotOnLink\r
-      // ReplyMsg for ConfirmMsg should triger new round to acquire new address. In that\r
+      // ReplyMsg for ConfirmMsg should trigger new round to acquire new address. In that\r
       // case, clear old address.ValidLifetime and append to new address. Therefore, DHCP\r
       // consumers can be notified to flush old address.\r
       //\r
       Dhcp6AppendCacheIa (Instance);\r
 \r
       //\r
-      // For async, signal the Ia event to inform Ia infomation update.\r
+      // For async, signal the Ia event to inform Ia information update.\r
       //\r
       if (Instance->Config->IaInfoEvent != NULL) {\r
         gBS->SignalEvent (Instance->Config->IaInfoEvent);\r
@@ -2431,7 +2431,7 @@ Dhcp6HandleAdvertiseMsg (
 \r
   //\r
   // If the client does receives a valid reply message that includes a rapid\r
-  // commit option since a solicit with rapid commit optioin sent before, select\r
+  // commit option since a solicit with rapid commit option sent before, select\r
   // this reply message. Or else, process the advertise messages as normal.\r
   // See details in the section-17.1.4 of rfc-3315.\r
   //\r
index a8a938211572d49048557487e470317ea4391668..d249a1cca7a11cb0a932b4b618bc624f432c2214 100644 (file)
@@ -312,7 +312,7 @@ Dhcp6CleanupModeData (
 \r
   @param[in]  Base          The base value of the time.\r
   @param[in]  IsFirstRt     If TRUE, it is the first time to calculate expire time.\r
-  @param[in]  NeedSigned    If TRUE, the the signed factor is needed.\r
+  @param[in]  NeedSigned    If TRUE, the signed factor is needed.\r
 \r
   @return     Expire        The calculated result for the new expire time.\r
 \r
@@ -506,7 +506,7 @@ Dhcp6DepriveAddress (
     //\r
     // If release all Ia addresses, just copy the configured Ia and then set\r
     // its address count as zero.\r
-    // We may decline/release part of addresses at the begining. So it's a\r
+    // We may decline/release part of addresses at the beginning. So it's a\r
     // forwarding step to update address infor for decline/release, while the\r
     // other infor such as Ia state will be updated when receiving reply.\r
     //\r
@@ -995,7 +995,7 @@ Dhcp6SeekIaOption (
 \r
 /**\r
   Check whether the incoming IPv6 address in IaAddr is one of the maintained\r
-  addresses in the IA control blcok.\r
+  addresses in the IA control block.\r
 \r
   @param[in]  IaAddr            The pointer to the IA Address to be checked.\r
   @param[in]  CurrentIa         The pointer to the IA in IA control block.\r
@@ -1023,9 +1023,9 @@ Dhcp6AddrIsInCurrentIa (
 }\r
 \r
 /**\r
-  Parse the address option and update the address infomation.\r
+  Parse the address option and update the address information.\r
 \r
-  @param[in]      CurrentIa     The pointer to the Ia Address in control blcok.\r
+  @param[in]      CurrentIa     The pointer to the Ia Address in control block.\r
   @param[in]      IaInnerOpt    The pointer to the buffer.\r
   @param[in]      IaInnerLen    The length to parse.\r
   @param[out]     AddrNum       The number of addresses.\r
@@ -1107,7 +1107,7 @@ Dhcp6ParseAddrOption (
 \r
 \r
 /**\r
-  Create a control blcok for the Ia according to the corresponding options.\r
+  Create a control block for the Ia according to the corresponding options.\r
 \r
   @param[in]  Instance              The pointer to DHCP6 Instance.\r
   @param[in]  IaInnerOpt            The pointer to the inner options in the Ia option.\r
@@ -1229,7 +1229,7 @@ Dhcp6CacheIa (
 }\r
 \r
 /**\r
-  Append CacheIa to the currrent IA. Meanwhile, clear CacheIa.ValidLifetime to 0.\r
+  Append CacheIa to the current IA. Meanwhile, clear CacheIa.ValidLifetime to 0.\r
 \r
   @param[in]  Instance            The pointer to DHCP6 instance.\r
 \r
@@ -1285,7 +1285,7 @@ Dhcp6AppendCacheIa (
 }\r
 \r
 /**\r
-  Calculate the Dhcp6 get mapping timeout by adding additinal delay to the IP6 DAD transmits count.\r
+  Calculate the Dhcp6 get mapping timeout by adding additional delay to the IP6 DAD transmits count.\r
 \r
   @param[in]   Ip6Cfg              The pointer to Ip6 config protocol.\r
   @param[out]  TimeOut             The time out value in 100ns units.\r
index 6a302adf29449b46a2b154df0d75677f64711650..2f18eb3609572992cb37851fe371653be5afc891 100644 (file)
@@ -71,7 +71,7 @@ Dhcp6CleanupModeData (
 \r
   @param[in]  Base          The base value of the time.\r
   @param[in]  IsFirstRt     If TRUE, it is the first time to calculate expire time.\r
-  @param[in]  NeedSigned    If TRUE, the the signed factor is needed.\r
+  @param[in]  NeedSigned    If TRUE, the signed factor is needed.\r
 \r
   @return     Expire        The calculated result for the new expire time.\r
 \r
@@ -165,7 +165,7 @@ Dhcp6OnTransmitted (
 \r
   @param[in, out] Buf           The pointer to buffer.\r
   @param[in]      OptType       The option type.\r
-  @param[in]      OptLen        The lenght of option content.s\r
+  @param[in]      OptLen        The length of option content.s\r
   @param[in]      Data          The pointer to the option content.\r
 \r
   @return         Buf           The position to append the next option.\r
@@ -270,7 +270,7 @@ Dhcp6SeekIaOption (
 /**\r
   Parse the address option and update the address info.\r
 \r
-  @param[in]      CurrentIa     The pointer to the Ia Address in control blcok.\r
+  @param[in]      CurrentIa     The pointer to the Ia Address in control block.\r
   @param[in]      IaInnerOpt    The pointer to the buffer.\r
   @param[in]      IaInnerLen    The length to parse.\r
   @param[out]     AddrNum       The number of addresses.\r
@@ -287,7 +287,7 @@ Dhcp6ParseAddrOption (
   );\r
 \r
 /**\r
-  Create a control blcok for the Ia according to the corresponding options.\r
+  Create a control block for the Ia according to the corresponding options.\r
 \r
   @param[in]  Instance              The pointer to DHCP6 Instance.\r
   @param[in]  IaInnerOpt            The pointer to the inner options in the Ia option.\r
@@ -327,7 +327,7 @@ Dhcp6CacheIa (
 \r
 \r
 /**\r
-  Append CacheIa to the currrent IA. Meanwhile, clear CacheIa.ValidLifetime to 0.\r
+  Append CacheIa to the current IA. Meanwhile, clear CacheIa.ValidLifetime to 0.\r
 \r
   @param[in]  Instance            The pointer to DHCP6 instance.\r
 \r
@@ -338,7 +338,7 @@ Dhcp6AppendCacheIa (
   );\r
 \r
 /**\r
-  Calculate the Dhcp6 get mapping timeout by adding additinal delay to the IP6 DAD transmits count.\r
+  Calculate the Dhcp6 get mapping timeout by adding additional delay to the IP6 DAD transmits count.\r
 \r
   @param[in]   Ip6Cfg              The pointer to Ip6 config protocol.\r
   @param[out]  TimeOut             The time out value in 100ns units.\r