From ff82167537c1acb0d0918fc6d168654986fdef42 Mon Sep 17 00:00:00 2001 From: Antoine Coeur Date: Fri, 7 Feb 2020 02:08:04 +0100 Subject: [PATCH] NetworkPkg/Udp6Dxe: Fix various typos Fix various typos in comments and documentation. Cc: Jiaxin Wu Cc: Siyuan Fu Cc: Maciej Rabeda Signed-off-by: Antoine Coeur Reviewed-by: Philippe Mathieu-Daude Reviewed-by: Maciej Rabeda Signed-off-by: Philippe Mathieu-Daude Message-Id: <20200207010831.9046-52-philmd@redhat.com> --- NetworkPkg/Udp6Dxe/Udp6Driver.c | 8 ++++---- NetworkPkg/Udp6Dxe/Udp6Driver.h | 6 +++--- NetworkPkg/Udp6Dxe/Udp6Impl.c | 18 +++++++++--------- NetworkPkg/Udp6Dxe/Udp6Impl.h | 12 ++++++------ NetworkPkg/Udp6Dxe/Udp6Main.c | 12 ++++++------ 5 files changed, 28 insertions(+), 28 deletions(-) diff --git a/NetworkPkg/Udp6Dxe/Udp6Driver.c b/NetworkPkg/Udp6Dxe/Udp6Driver.c index 5334fd1734..6021bb3699 100644 --- a/NetworkPkg/Udp6Dxe/Udp6Driver.c +++ b/NetworkPkg/Udp6Dxe/Udp6Driver.c @@ -117,7 +117,7 @@ Udp6DriverBindingSupported ( @param[in] RemainingDevicePath Optional parameter use to pick a specific child device to start. - @retval EFI_SUCCES This driver is added to ControllerHandle. + @retval EFI_SUCCESS This driver is added to ControllerHandle. @retval EFI_OUT_OF_RESOURCES The required system resource can't be allocated. @retval other This driver does not support this device. @@ -223,7 +223,7 @@ Udp6DestroyChildEntryInHandleBuffer ( of children is zero stop the entire bus driver. @param[in] ChildHandleBuffer List of Child Handles to Stop. It is optional. - @retval EFI_SUCCES This driver is removed ControllerHandle. + @retval EFI_SUCCESS This driver is removed ControllerHandle. @retval EFI_DEVICE_ERROR Can't find the NicHandle from the ControllerHandle and specified GUID. @retval other This driver was not removed from this device. @@ -310,7 +310,7 @@ Udp6DriverBindingStop ( 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 This is NULL or ChildHandle is NULL. @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create the child. @@ -443,7 +443,7 @@ ON_ERROR: @param[in] This Protocol instance pointer. @param[in] ChildHandle Handle of the child to destroy. - @retval EFI_SUCCES The I/O services were removed from the child + @retval EFI_SUCCESS The I/O services were removed from the child handle. @retval EFI_UNSUPPORTED The child handle does not support the I/O services that are being removed. diff --git a/NetworkPkg/Udp6Dxe/Udp6Driver.h b/NetworkPkg/Udp6Dxe/Udp6Driver.h index a08623979e..577cebd5b1 100644 --- a/NetworkPkg/Udp6Dxe/Udp6Driver.h +++ b/NetworkPkg/Udp6Dxe/Udp6Driver.h @@ -78,7 +78,7 @@ Udp6DriverBindingSupported ( @param[in] RemainingDevicePath Optional parameter use to pick a specific child device to start. - @retval EFI_SUCCES This driver is added to ControllerHandle. + @retval EFI_SUCCESS This driver is added to ControllerHandle. @retval EFI_OUT_OF_RESOURCES The required system resource can't be allocated. @retval other This driver does not support this device. @@ -132,7 +132,7 @@ Udp6DriverBindingStop ( 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 This is NULL or ChildHandle is NULL. @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create the child. @@ -155,7 +155,7 @@ Udp6ServiceBindingCreateChild ( @param[in] This Protocol instance pointer. @param[in] ChildHandle Handle of the child to destroy. - @retval EFI_SUCCES The I/O services were removed from the child + @retval EFI_SUCCESS The I/O services were removed from the child handle. @retval EFI_UNSUPPORTED The child handle does not support the I/O services that are being removed. diff --git a/NetworkPkg/Udp6Dxe/Udp6Impl.c b/NetworkPkg/Udp6Dxe/Udp6Impl.c index aefcd3396c..ba939fdbfc 100644 --- a/NetworkPkg/Udp6Dxe/Udp6Impl.c +++ b/NetworkPkg/Udp6Dxe/Udp6Impl.c @@ -96,7 +96,7 @@ Udp6DgramRcvd ( ); /** - This function cancle the token specified by Arg in the Map. + This function cancel the token specified by Arg in the Map. @param[in] Map Pointer to the NET_MAP. @param[in] Item Pointer to the NET_MAP_ITEM. @@ -458,7 +458,7 @@ Udp6CheckTimeout ( /** - This function intializes the new created udp instance. + This function initializes the new created udp instance. @param[in] Udp6Service Pointer to the UDP6_SERVICE_DATA. @param[in, out] Instance Pointer to the un-initialized UDP6_INSTANCE_DATA. @@ -575,7 +575,7 @@ Udp6FindInstanceByPort ( /** This function tries to bind the udp instance according to the configured port - allocation stragety. + allocation strategy. @param[in] InstanceList Pointer to the head of the list linking the udp instances. @@ -832,7 +832,7 @@ Udp6ValidateTxToken ( if ((UdpSessionData->DestinationPort == 0) && (ConfigData->RemotePort == 0)) { // - // Ambiguous; no avalaible DestinationPort for this token. + // Ambiguous; no available DestinationPort for this token. // return EFI_INVALID_PARAMETER; } @@ -841,7 +841,7 @@ Udp6ValidateTxToken ( NetIp6IsUnspecifiedAddr (&ConfigData->RemoteAddress) ) { // - // The DestinationAddress is not specificed. + // The DestinationAddress is not specified. // return EFI_INVALID_PARAMETER; } @@ -915,7 +915,7 @@ Udp6TokenExist ( pseudo HeadSum to reduce some overhead. @param[in] Packet Pointer to the NET_BUF contains the udp datagram. - @param[in] HeadSum Checksum of the pseudo header, execpt the length + @param[in] HeadSum Checksum of the pseudo header, except the length field. @return The 16-bit checksum of this udp datagram. @@ -1123,7 +1123,7 @@ Udp6LeaveGroup ( /** - This function cancle the token specified by Arg in the Map. + This function cancel the token specified by Arg in the Map. @param[in] Map Pointer to the NET_MAP. @param[in] Item Pointer to the NET_MAP_ITEM. @@ -1276,7 +1276,7 @@ Udp6InstanceCancelToken ( from the received udp datagram. @retval TRUE The udp datagram matches the receiving requirements of the Instance. - @retval FALSE The udp datagram does not matche the receiving requirements of the Instance. + @retval FALSE The udp datagram does not match the receiving requirements of the Instance. **/ BOOLEAN @@ -1814,7 +1814,7 @@ Udp6SendPortUnreach ( ); // - // Set the checksum as zero, and IP6 driver will calcuate it with pseudo header. + // Set the checksum as zero, and IP6 driver will calculate it with pseudo header. // IcmpErrHdr->Head.Checksum = 0; diff --git a/NetworkPkg/Udp6Dxe/Udp6Impl.h b/NetworkPkg/Udp6Dxe/Udp6Impl.h index 5ccbcebfdf..55a4b8a909 100644 --- a/NetworkPkg/Udp6Dxe/Udp6Impl.h +++ b/NetworkPkg/Udp6Dxe/Udp6Impl.h @@ -151,7 +151,7 @@ Udp6CleanInstance ( ); /** - This function intializes the new created udp instance. + This function initializes the new created udp instance. @param[in] Udp6Service Pointer to the UDP6_SERVICE_DATA. @param[in, out] Instance Pointer to the un-initialized UDP6_INSTANCE_DATA. @@ -221,7 +221,7 @@ Udp6GetModeData ( @retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully. - @retval EFI_NO_MAPPING When the UdpConifgData.UseAnyStationAddress is set + @retval EFI_NO_MAPPING When the UdpConfigData.UseAnyStationAddress is set to true and there is no address available for IP6 driver to binding source address to this instance. @@ -281,12 +281,12 @@ Udp6Configure ( .FragmentBuffer fields is NULL. One or more of the Token.Packet.TxData.UdpSessionData. - DestinationAddres are not valid unicast IPv6 + DestinationAddress are not valid unicast IPv6 addresses, if the UdpSessionData is not NULL. Token.Packet.TxData.UdpSessionData. - DestinationAddres is NULL + DestinationAddress is NULL Token.Packet.TxData.UdpSessionData. - DestinatioPort is zero. + DestinationPort is zero. Token.Packet.TxData.UdpSessionData is NULL and this instance's UdpConfigData.RemoteAddress is unspecified. @@ -430,7 +430,7 @@ Udp6Groups ( /** This function tries to bind the udp instance according to the configured port - allocation stragety. + allocation strategy. @param[in] InstanceList Pointer to the head of the list linking the udp instances. diff --git a/NetworkPkg/Udp6Dxe/Udp6Main.c b/NetworkPkg/Udp6Dxe/Udp6Main.c index 0829b7b2a6..a33eb3c8cf 100644 --- a/NetworkPkg/Udp6Dxe/Udp6Main.c +++ b/NetworkPkg/Udp6Dxe/Udp6Main.c @@ -104,7 +104,7 @@ Udp6GetModeData ( @retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully. - @retval EFI_NO_MAPPING When the UdpConifgData.UseAnyStationAddress is set + @retval EFI_NO_MAPPING When the UdpConfigData.UseAnyStationAddress is set to true and there is no address available for the IP6 driver to bind a source address to this instance. @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE: @@ -368,7 +368,7 @@ Udp6Groups ( // Keep a local copy of the configured multicast IPs because IpIo receives // datagrams from the 0 station address IP instance and then UDP delivers to // the matched instance. This copy of multicast IPs is used to avoid receive - // the mutlicast datagrams destinated to multicast IPs the other instances configured. + // the multicast datagrams destinated to multicast IPs the other instances configured. // if (JoinFlag) { @@ -423,13 +423,13 @@ ON_EXIT: One or more of the Token.Packet.TxData.FragmentTable[].FragmentBuffer fields is NULL. One or more of the - Token.Packet.TxData.UdpSessionData.DestinationAddres + Token.Packet.TxData.UdpSessionData.DestinationAddress are not valid unicast IPv6 addresses if the UdpSessionData is not NULL. Token.Packet.TxData.UdpSessionData. DestinationAddress is NULL Token.Packet.TxData.UdpSessionData. - DestinatioPort + DestinationPort is zero. Token.Packet.TxData.UdpSessionData is NULL and this instance's UdpConfigData.RemoteAddress is unspecified. @@ -586,7 +586,7 @@ Udp6Transmit ( } } else { // - // Set the checksum is zero if the ConfigData->StationAddress is unspcified + // Set the checksum is zero if the ConfigData->StationAddress is unspecified // and the Ipv6 will fill the correct value of this checksum. // Udp6Header->Checksum = 0; @@ -807,7 +807,7 @@ Udp6Cancel ( OldTpl = gBS->RaiseTPL (TPL_CALLBACK); // - // Cancle the tokens specified by Token for this instance. + // Cancel the tokens specified by Token for this instance. // Status = Udp6InstanceCancelToken (Instance, Token); -- 2.39.2