NetworkPkg/UefiPxeBcDxe: Fix various typos
authorAntoine Coeur <coeur@gmx.fr>
Fri, 7 Feb 2020 01:08:05 +0000 (02:08 +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-53-philmd@redhat.com>

NetworkPkg/UefiPxeBcDxe/PxeBcBoot.c
NetworkPkg/UefiPxeBcDxe/PxeBcDhcp4.c
NetworkPkg/UefiPxeBcDxe/PxeBcDhcp4.h
NetworkPkg/UefiPxeBcDxe/PxeBcDhcp6.c
NetworkPkg/UefiPxeBcDxe/PxeBcDhcp6.h
NetworkPkg/UefiPxeBcDxe/PxeBcDriver.c
NetworkPkg/UefiPxeBcDxe/PxeBcImpl.c
NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.c
NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h
NetworkPkg/UefiPxeBcDxe/PxeBcSupport.c
NetworkPkg/UefiPxeBcDxe/PxeBcSupport.h

index a982d3a..10bbb06 100644 (file)
@@ -257,7 +257,7 @@ ON_EXIT:
 \r
   @retval EFI_ABORTED     User cancel operation.\r
   @retval EFI_SUCCESS     Select the boot menu success.\r
-  @retval EFI_NOT_READY   Read the input key from the keybroad has not finish.\r
+  @retval EFI_NOT_READY   Read the input key from the keyboard has not finish.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -970,7 +970,7 @@ PxeBcDiscoverBootFile (
   @param[in, out] Private           Pointer to PxeBc private data.\r
   @param[out]     NewMakeCallback   If TRUE, it is a new callback.\r
                                     Otherwise, it is not new callback.\r
-  @retval EFI_SUCCESS          PxeBaseCodeCallbackProtocol installed succesfully.\r
+  @retval EFI_SUCCESS          PxeBaseCodeCallbackProtocol installed successfully.\r
   @retval Others               Failed to install PxeBaseCodeCallbackProtocol.\r
 \r
 **/\r
index bb5e53b..fb63cf6 100644 (file)
@@ -78,7 +78,7 @@ PxeBcParseDhcp4Options (
 \r
 \r
 /**\r
-  Parse the PXE vender options and extract the information from them.\r
+  Parse the PXE vendor options and extract the information from them.\r
 \r
   @param[in]  Dhcp4Option        Pointer to vendor options in buffer.\r
   @param[in]  VendorOption       Pointer to structure to store information in vendor options.\r
@@ -312,7 +312,7 @@ PxeBcBuildDhcp4Options (
 \r
   if (EFI_ERROR (NetLibGetSystemGuid ((EFI_GUID *) OptEnt.Uuid->Guid))) {\r
     //\r
-    // Zero the Guid to indicate NOT programable if failed to get system Guid.\r
+    // Zero the Guid to indicate NOT programmable if failed to get system Guid.\r
     //\r
     DEBUG ((EFI_D_WARN, "PXE: Failed to read system GUID from the smbios table!\n"));\r
     ZeroMem (OptEnt.Uuid->Guid, sizeof (EFI_GUID));\r
@@ -1125,7 +1125,7 @@ PxeBcHandleDhcp4Offer (
       }\r
     } else {\r
       //\r
-      //  Othewise, the bootfile name must be included in DhcpOnly offer.\r
+      //  Otherwise, the bootfile name must be included in DhcpOnly offer.\r
       //\r
       if (Options[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] == NULL) {\r
         Status = EFI_NOT_FOUND;\r
@@ -1275,7 +1275,7 @@ PxeBcDhcp4CallBack (
       //\r
       if (EFI_ERROR (NetLibGetSystemGuid ((EFI_GUID *) Packet->Dhcp4.Header.ClientHwAddr))) {\r
         //\r
-        // Zero the Guid to indicate NOT programable if failed to get system Guid.\r
+        // Zero the Guid to indicate NOT programmable if failed to get system Guid.\r
         //\r
         DEBUG ((EFI_D_WARN, "PXE: Failed to read system GUID from the smbios table!\n"));\r
         ZeroMem (Packet->Dhcp4.Header.ClientHwAddr, sizeof (EFI_GUID));\r
@@ -1464,7 +1464,7 @@ PxeBcDhcp4Discover (
   if (Mode->SendGUID) {\r
     if (EFI_ERROR (NetLibGetSystemGuid ((EFI_GUID *) Token.Packet->Dhcp4.Header.ClientHwAddr))) {\r
       //\r
-      // Zero the Guid to indicate NOT programable if failed to get system Guid.\r
+      // Zero the Guid to indicate NOT programmable if failed to get system Guid.\r
       //\r
       DEBUG ((EFI_D_WARN, "PXE: Failed to read system GUID from the smbios table!\n"));\r
       ZeroMem (Token.Packet->Dhcp4.Header.ClientHwAddr, sizeof (EFI_GUID));\r
index 69b0502..879da18 100644 (file)
@@ -60,7 +60,7 @@
 \r
 //\r
 // Dhcp4 and Dhcp6 share this definition, and corresponding\r
-// relatioinship is as follows:\r
+// relationship is as follows:\r
 //\r
 //   Dhcp4Discover <> Dhcp6Solicit\r
 //   Dhcp4Offer    <> Dhcp6Advertise\r
index 1164fbb..8d71143 100644 (file)
@@ -25,7 +25,7 @@ EFI_IPv6_ADDRESS   mAllDhcpRelayAndServersAddress = {{0xFF, 2, 0, 0, 0, 0, 0, 0,
   @param[in]  OptTag        The required option tag.\r
 \r
   @retval     NULL          Failed to parse the required option.\r
-  @retval     Others        The postion of the required option in buffer.\r
+  @retval     Others        The position of the required option in buffer.\r
 \r
 **/\r
 EFI_DHCP6_PACKET_OPTION *\r
@@ -370,7 +370,7 @@ Exit:
 \r
   @retval EFI_ABORTED     User cancel operation.\r
   @retval EFI_SUCCESS     Selected the boot menu successfully.\r
-  @retval EFI_NOT_READY   Read the input key from the keybroad has not finish.\r
+  @retval EFI_NOT_READY   Read the input key from the keyboard has not finish.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -674,7 +674,7 @@ PxeBcParseDhcp6Packet (
 \r
   //\r
   // The offer with assigned client address is NOT a proxy offer.\r
-  // An ia_na option, embeded with valid ia_addr option and a status_code of success.\r
+  // An ia_na option, embedded with valid ia_addr option and a status_code of success.\r
   //\r
   Option = Options[PXEBC_DHCP6_IDX_IA_NA];\r
   if (Option != NULL) {\r
@@ -1431,7 +1431,7 @@ PxeBcHandleDhcp6Offer (
       }\r
     } else {\r
       //\r
-      //  Othewise, the bootfilename must be included in DhcpOnly offer.\r
+      //  Otherwise, the bootfilename must be included in DhcpOnly offer.\r
       //\r
       ASSERT (Cache6->OptList[PXEBC_DHCP6_IDX_BOOT_FILE_URL] != NULL);\r
     }\r
@@ -1480,7 +1480,7 @@ PxeBcUnregisterIp6Address (
 \r
   @retval     EFI_SUCCESS         Found a valid gateway address successfully.\r
   @retval     EFI_TIMEOUT         The operation is time out.\r
-  @retval     Other               Unexpect error happened.\r
+  @retval     Other               Unexpected error happened.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1594,7 +1594,7 @@ ON_EXIT:
   @param[in]  Private             The pointer to PXEBC_PRIVATE_DATA.\r
   @param[in]  Address             The pointer to the ready address.\r
 \r
-  @retval     EFI_SUCCESS         Registered the address succesfully.\r
+  @retval     EFI_SUCCESS         Registered the address successfully.\r
   @retval     Others              Failed to register the address.\r
 \r
 **/\r
@@ -1774,8 +1774,8 @@ ON_EXIT:
 \r
   @param[in]  Private             The pointer to PXEBC_PRIVATE_DATA.\r
 \r
-  @retval     EFI_SUCCESS         Switch the IP policy succesfully.\r
-  @retval     Others              Unexpect error happened.\r
+  @retval     EFI_SUCCESS         Switch the IP policy successfully.\r
+  @retval     Others              Unexpected error happened.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1915,7 +1915,7 @@ PxeBcDhcp6CallBack (
   Callback  = Private->PxeBcCallback;\r
 \r
   //\r
-  // Callback to user when any traffic ocurred if has.\r
+  // Callback to user when any traffic occurred if has.\r
   //\r
   if (Dhcp6Event != Dhcp6SelectAdvertise && Callback != NULL) {\r
     Received = (BOOLEAN) (Dhcp6Event == Dhcp6RcvdAdvertise || Dhcp6Event == Dhcp6RcvdReply);\r
index ca40fdc..ae4be77 100644 (file)
@@ -123,7 +123,7 @@ typedef struct {
 \r
   @retval EFI_ABORTED     User canceled the operation.\r
   @retval EFI_SUCCESS     Selected the boot menu successfully.\r
-  @retval EFI_NOT_READY   Read the input key from the keybroad has not finish.\r
+  @retval EFI_NOT_READY   Read the input key from the keyboard has not finish.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -174,7 +174,7 @@ PxeBcParseDhcp6Packet (
   @param[in]  Private             The pointer to the PxeBc private data.\r
   @param[in]  Address             The pointer to the ready address.\r
 \r
-  @retval     EFI_SUCCESS         Registered the address succesfully.\r
+  @retval     EFI_SUCCESS         Registered the address successfully.\r
   @retval     Others              Failed to register the address.\r
 \r
 **/\r
@@ -226,8 +226,8 @@ PxeBcDhcp6Discover (
 \r
   @param[in]  Private             The pointer to PXEBC_PRIVATE_DATA.\r
 \r
-  @retval     EFI_SUCCESS         Switch the IP policy succesfully.\r
-  @retval     Others              Unexpect error happened.\r
+  @retval     EFI_SUCCESS         Switch the IP policy successfully.\r
+  @retval     Others              Unexpected error happened.\r
 \r
 **/\r
 EFI_STATUS\r
index b35edb6..0e2675b 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  Driver Binding functions implementationfor for UefiPxeBc Driver.\r
+  Driver Binding functions implementation for UefiPxeBc Driver.\r
 \r
   (C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>\r
   Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.<BR>\r
@@ -1184,7 +1184,7 @@ PxeBcCreateIp6Children (
   }\r
 \r
   //\r
-  // Set IPv6 avaiable flag and set default configure data for\r
+  // Set IPv6 available flag and set default configure data for\r
   // Udp6Read and Ip6 instance.\r
   //\r
   Status = PxeBcCheckIpv6Support (ControllerHandle, Private, &Private->Mode.Ipv6Available);\r
index 639415b..5d18207 100644 (file)
@@ -204,7 +204,7 @@ EfiPxeBcStart (
     //the active state, If the DHCP4 D.O.R.A started by IP4 auto\r
     //configuration and has not been completed, the Dhcp4 state machine\r
     //will not be in the right state for the PXE to start a new round D.O.R.A.\r
-    //so we need to switch it's policy to static.\r
+    //so we need to switch its policy to static.\r
     //\r
     Status = PxeBcSetIp4Policy (Private);\r
     if (EFI_ERROR (Status)) {\r
@@ -631,7 +631,7 @@ EfiPxeBcDiscover (
       }\r
       if (Index != Info->IpCnt) {\r
         //\r
-        // It's invalid if the first server doesn't accecpt any response\r
+        // It's invalid if the first server doesn't accept any response\r
         // but any of the other servers does accept any response.\r
         //\r
         Status = EFI_INVALID_PARAMETER;\r
@@ -1410,7 +1410,7 @@ EfiPxeBcUdpRead (
 \r
   if (IsMatched) {\r
     //\r
-    // Copy the rececived packet to user if matched by filter.\r
+    // Copy the received packet to user if matched by filter.\r
     //\r
     if (Mode->UsingIpv6) {\r
       Udp6Rx = Udp6Token.Packet.RxData;\r
@@ -1685,7 +1685,7 @@ EfiPxeBcSetIpFilter (
         for (Index = 0; Index < NewFilter->IpCnt; ++Index) {\r
           if (IP4_IS_MULTICAST (EFI_NTOHL (NewFilter->IpList[Index].v4))) {\r
             //\r
-            // Join the mutilcast group.\r
+            // Join the multicast group.\r
             //\r
             Status = Private->Udp4Read->Groups (Private->Udp4Read, TRUE, &NewFilter->IpList[Index].v4);\r
             if (EFI_ERROR (Status)) {\r
@@ -1723,7 +1723,7 @@ EfiPxeBcSetIpFilter (
         for (Index = 0; Index < NewFilter->IpCnt; ++Index) {\r
           if (IP6_IS_MULTICAST (&NewFilter->IpList[Index].v6)) {\r
             //\r
-            // Join the mutilcast group.\r
+            // Join the multicast group.\r
             //\r
             Status = Private->Udp6Read->Groups (Private->Udp6Read, TRUE, &NewFilter->IpList[Index].v6);\r
             if (EFI_ERROR (Status)) {\r
index 6a390c2..addcafc 100644 (file)
@@ -106,8 +106,8 @@ PxeBcMtftp6CheckPacket (
   @param[in]      WindowSize     Pointer to required window size.\r
   @param[in, out] BufferSize     Pointer to buffer size.\r
 \r
-  @retval EFI_SUCCESS        Sucessfully obtained the size of file.\r
-  @retval EFI_NOT_FOUND      Parse the tftp ptions failed.\r
+  @retval EFI_SUCCESS        Successfully obtained the size of file.\r
+  @retval EFI_NOT_FOUND      Parse the tftp options failed.\r
   @retval EFI_DEVICE_ERROR   The network device encountered an error during this operation.\r
   @retval Others             Has not obtained the size of the file.\r
 \r
@@ -512,7 +512,7 @@ PxeBcMtftp6ReadDirectory (
   @param[in]  PacketLen      Length of EFI_MTFTP4_PACKET.\r
   @param[in]  Packet         Pointer to EFI_MTFTP4_PACKET to be checked.\r
 \r
-  @retval EFI_SUCCESS    The current operation succeeeded.\r
+  @retval EFI_SUCCESS    The current operation succeeded.\r
   @retval EFI_ABORTED    Abort the current transfer process.\r
 \r
 **/\r
@@ -896,7 +896,7 @@ PxeBcMtftp4WriteFile (
   @param[in, out]  BufferSize     Pointer to buffer size.\r
   @param[in]       DontUseBuffer  Indicates whether to use a receive buffer.\r
 \r
-  @retval EFI_SUCCES         Successfully obtained the data from the file included in the directory.\r
+  @retval EFI_SUCCESS        Successfully obtained the data from the file included in the directory.\r
   @retval EFI_DEVICE_ERROR   The network device encountered an error during this operation.\r
   @retval Others             Operation failed.\r
 \r
@@ -1037,7 +1037,7 @@ PxeBcTftpGetFileSize (
   @param[in, out] BufferSize     Pointer to buffer size.\r
   @param[in]      DontUseBuffer  Indicates whether to use a receive buffer.\r
 \r
-  @retval EFI_SUCCESS        Sucessfully read the data from the special file.\r
+  @retval EFI_SUCCESS        Successfully read the data from the special file.\r
   @retval EFI_DEVICE_ERROR   The network device encountered an error during this operation.\r
   @retval Others             Read data from file failed.\r
 \r
@@ -1143,7 +1143,7 @@ PxeBcTftpWriteFile (
   @param[in, out]  BufferSize     Pointer to buffer size.\r
   @param[in]       DontUseBuffer  Indicatse whether to use a receive buffer.\r
 \r
-  @retval EFI_SUCCES         Successfully obtained the data from the file included in the directory.\r
+  @retval EFI_SUCCESS        Successfully obtained the data from the file included in the directory.\r
   @retval EFI_DEVICE_ERROR   The network device encountered an error during this operation.\r
   @retval Others             Operation failed.\r
 \r
index 9a011e0..7356c0a 100644 (file)
@@ -33,7 +33,7 @@
   @param[in, out] BufferSize     Pointer to buffer size.\r
 \r
   @retval EFI_SUCCESS        Successfully obtained the size of file.\r
-  @retval EFI_NOT_FOUND      Parse the tftp ptions failed.\r
+  @retval EFI_NOT_FOUND      Parse the tftp options failed.\r
   @retval EFI_DEVICE_ERROR   The network device encountered an error during this operation.\r
   @retval Others             Did not obtain the size of the file.\r
 \r
@@ -119,7 +119,7 @@ PxeBcTftpWriteFile (
   @param[in, out]  BufferSize     Pointer to buffer size.\r
   @param[in]       DontUseBuffer  Indicates whether with a receive buffer.\r
 \r
-  @retval EFI_SUCCES         Successfully obtained the data from the file included in directory.\r
+  @retval EFI_SUCCESS        Successfully obtained the data from the file included in directory.\r
   @retval EFI_DEVICE_ERROR   The network device encountered an error during this operation.\r
   @retval Others             Operation failed.\r
 \r
index ae8eb48..8eb1558 100644 (file)
@@ -11,7 +11,7 @@
 \r
 \r
 /**\r
-  Flush the previous configration using the new station Ip address.\r
+  Flush the previous configuration using the new station Ip address.\r
 \r
   @param[in]   Private        The pointer to the PxeBc private data.\r
   @param[in]   StationIp      The pointer to the station Ip address.\r
@@ -136,7 +136,7 @@ PxeBcCommonNotify (
 \r
   @param  Mode           The pointer to EFI_PXE_BASE_CODE_MODE.\r
   @param  Ip4Addr        The Ip4 address for resolution.\r
-  @param  MacAddress     The resoluted MAC address if the resolution is successful.\r
+  @param  MacAddress     The resolved MAC address if the resolution is successful.\r
                          The value is undefined if the resolution fails.\r
 \r
   @retval TRUE           Found an matched entry.\r
@@ -1176,7 +1176,7 @@ PxeBcUdp4Read (
          Token->Status == EFI_NOT_READY &&\r
          EFI_ERROR (gBS->CheckEvent (TimeoutEvent))) {\r
     //\r
-    // Poll the token utill reply/ICMPv6 error message received or timeout.\r
+    // Poll the token until reply/ICMPv6 error message received or timeout.\r
     //\r
     Udp4->Poll (Udp4);\r
     if (Token->Status == EFI_ICMP_ERROR ||\r
@@ -1280,7 +1280,7 @@ PxeBcUdp6Read (
          Token->Status == EFI_NOT_READY &&\r
          EFI_ERROR (gBS->CheckEvent (TimeoutEvent))) {\r
     //\r
-    // Poll the token utill reply/ICMPv6 error message received or timeout.\r
+    // Poll the token until reply/ICMPv6 error message received or timeout.\r
     //\r
     Udp6->Poll (Udp6);\r
     if (Token->Status == EFI_ICMP_ERROR ||\r
index 9264cd9..3125721 100644 (file)
@@ -21,7 +21,7 @@
 \r
 \r
 /**\r
-  Flush the previous configration using the new station Ip address.\r
+  Flush the previous configuration using the new station Ip address.\r
 \r
   @param[in]   Private        Pointer to PxeBc private data.\r
   @param[in]   StationIp      Pointer to the station Ip address.\r
@@ -59,7 +59,7 @@ PxeBcCommonNotify (
 \r
   @param  Mode           Pointer to EFI_PXE_BASE_CODE_MODE.\r
   @param  Ip4Addr        The Ip4 address for resolution.\r
-  @param  MacAddress     The resoluted MAC address if the resolution is successful.\r
+  @param  MacAddress     The resolved MAC address if the resolution is successful.\r
                          The value is undefined if resolution fails.\r
 \r
   @retval TRUE           Found a matched entry.\r
@@ -156,7 +156,7 @@ PxeBcConfigUdp4Write (
   @param[in]       StationIp            Pointer to the station address.\r
   @param[in, out]  SrcPort              Pointer to the source port.\r
 \r
-  @retval          EFI_SUCCESS          Successfuly configured this instance.\r
+  @retval          EFI_SUCCESS          Successfully configured this instance.\r
   @retval          Others               Failed to configure this instance.\r
 \r
 **/\r
@@ -234,7 +234,7 @@ PxeBcUdp6Write (
   @param[in]  Session             Pointer to the current UDPv4 session.\r
   @param[in]  OpFlags             Operation flag for UdpRead/UdpWrite.\r
 \r
-  @retval     TRUE                Succesfully passed the Ip filter.\r
+  @retval     TRUE                Successfully passed the Ip filter.\r
   @retval     FALSE               Failed to pass the Ip filter.\r
 \r
 **/\r
@@ -254,7 +254,7 @@ PxeBcCheckByIpFilter (
   @param[in, out]  DestIp         Pointer to the dest Ip address.\r
   @param[in]       OpFlags        Operation flag for UdpRead/UdpWrite.\r
 \r
-  @retval     TRUE                Succesfully passed the IPv4 filter.\r
+  @retval     TRUE                Successfully passed the IPv4 filter.\r
   @retval     FALSE               Failed to pass the IPv4 filter.\r
 \r
 **/\r
@@ -275,7 +275,7 @@ PxeBcCheckByDestIp (
   @param[in, out]  DestPort       Pointer to the destination port.\r
   @param[in]       OpFlags        Operation flag for UdpRead/UdpWrite.\r
 \r
-  @retval     TRUE                Succesfully passed the IPv4 filter.\r
+  @retval     TRUE                Successfully passed the IPv4 filter.\r
   @retval     FALSE               Failed to pass the IPv4 filter.\r
 \r
 **/\r
@@ -296,7 +296,7 @@ PxeBcCheckByDestPort (
   @param[in, out]  SrcIp          Pointer to the source Ip address.\r
   @param[in]       OpFlags        Operation flag for UdpRead/UdpWrite.\r
 \r
-  @retval     TRUE                Succesfully passed the IPv4 filter.\r
+  @retval     TRUE                Successfully passed the IPv4 filter.\r
   @retval     FALSE               Failed to pass the IPv4 filter.\r
 \r
 **/\r
@@ -317,7 +317,7 @@ PxeBcFilterBySrcIp (
   @param[in, out]  SrcPort        Pointer to the source port.\r
   @param[in]       OpFlags        Operation flag for UdpRead/UdpWrite.\r
 \r
-  @retval     TRUE                Succesfully passed the IPv4 filter.\r
+  @retval     TRUE                Successfully passed the IPv4 filter.\r
   @retval     FALSE               Failed to pass the IPv4 filter.\r
 \r
 **/\r