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-52-philmd@redhat.com>
@param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
device to start.\r
\r
@param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
device to start.\r
\r
- @retval EFI_SUCCES This driver is added to ControllerHandle.\r
+ @retval EFI_SUCCESS This driver is added to ControllerHandle.\r
@retval EFI_OUT_OF_RESOURCES The required system resource can't be allocated.\r
@retval other This driver does not support this device.\r
\r
@retval EFI_OUT_OF_RESOURCES The required system resource can't be allocated.\r
@retval other This driver does not support this device.\r
\r
of children is zero stop the entire bus driver.\r
@param[in] ChildHandleBuffer List of Child Handles to Stop. It is optional.\r
\r
of children is zero stop the entire bus driver.\r
@param[in] ChildHandleBuffer List of Child Handles to Stop. It is optional.\r
\r
- @retval EFI_SUCCES This driver is removed ControllerHandle.\r
+ @retval EFI_SUCCESS This driver is removed ControllerHandle.\r
@retval EFI_DEVICE_ERROR Can't find the NicHandle from the ControllerHandle and specified GUID.\r
@retval other This driver was not removed from this device.\r
\r
@retval EFI_DEVICE_ERROR Can't find the NicHandle from the ControllerHandle and specified GUID.\r
@retval other This driver was not removed from this device.\r
\r
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
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 This is NULL or ChildHandle is NULL.\r
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to create\r
the child.\r
@retval EFI_INVALID_PARAMETER This is NULL or ChildHandle is NULL.\r
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to create\r
the child.\r
@param[in] This Protocol instance pointer.\r
@param[in] ChildHandle Handle of the child to destroy.\r
\r
@param[in] This Protocol instance pointer.\r
@param[in] ChildHandle Handle of the child to destroy.\r
\r
- @retval EFI_SUCCES The I/O services were removed from the child\r
+ @retval EFI_SUCCESS The I/O services were removed from the child\r
handle.\r
@retval EFI_UNSUPPORTED The child handle does not support the I/O services\r
that are being removed.\r
handle.\r
@retval EFI_UNSUPPORTED The child handle does not support the I/O services\r
that are being removed.\r
@param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
device to start.\r
\r
@param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
device to start.\r
\r
- @retval EFI_SUCCES This driver is added to ControllerHandle.\r
+ @retval EFI_SUCCESS This driver is added to ControllerHandle.\r
@retval EFI_OUT_OF_RESOURCES The required system resource can't be allocated.\r
@retval other This driver does not support this device.\r
\r
@retval EFI_OUT_OF_RESOURCES The required system resource can't be allocated.\r
@retval other This driver does not support this device.\r
\r
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
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 This is NULL or ChildHandle is NULL.\r
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to create\r
the child.\r
@retval EFI_INVALID_PARAMETER This is NULL or ChildHandle is NULL.\r
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to create\r
the child.\r
@param[in] This Protocol instance pointer.\r
@param[in] ChildHandle Handle of the child to destroy.\r
\r
@param[in] This Protocol instance pointer.\r
@param[in] ChildHandle Handle of the child to destroy.\r
\r
- @retval EFI_SUCCES The I/O services were removed from the child\r
+ @retval EFI_SUCCESS The I/O services were removed from the child\r
handle.\r
@retval EFI_UNSUPPORTED The child handle does not support the I/O services\r
that are being removed.\r
handle.\r
@retval EFI_UNSUPPORTED The child handle does not support the I/O services\r
that are being removed.\r
- This function cancle the token specified by Arg in the Map.\r
+ This function cancel the token specified by Arg in the Map.\r
\r
@param[in] Map Pointer to the NET_MAP.\r
@param[in] Item Pointer to the NET_MAP_ITEM.\r
\r
@param[in] Map Pointer to the NET_MAP.\r
@param[in] Item Pointer to the NET_MAP_ITEM.\r
- This function intializes the new created udp instance.\r
+ This function initializes the new created udp instance.\r
\r
@param[in] Udp6Service Pointer to the UDP6_SERVICE_DATA.\r
@param[in, out] Instance Pointer to the un-initialized UDP6_INSTANCE_DATA.\r
\r
@param[in] Udp6Service Pointer to the UDP6_SERVICE_DATA.\r
@param[in, out] Instance Pointer to the un-initialized UDP6_INSTANCE_DATA.\r
\r
/**\r
This function tries to bind the udp instance according to the configured port\r
\r
/**\r
This function tries to bind the udp instance according to the configured port\r
\r
@param[in] InstanceList Pointer to the head of the list linking the udp\r
instances.\r
\r
@param[in] InstanceList Pointer to the head of the list linking the udp\r
instances.\r
\r
if ((UdpSessionData->DestinationPort == 0) && (ConfigData->RemotePort == 0)) {\r
//\r
\r
if ((UdpSessionData->DestinationPort == 0) && (ConfigData->RemotePort == 0)) {\r
//\r
- // Ambiguous; no avalaible DestinationPort for this token.\r
+ // Ambiguous; no available DestinationPort for this token.\r
//\r
return EFI_INVALID_PARAMETER;\r
}\r
//\r
return EFI_INVALID_PARAMETER;\r
}\r
NetIp6IsUnspecifiedAddr (&ConfigData->RemoteAddress)\r
) {\r
//\r
NetIp6IsUnspecifiedAddr (&ConfigData->RemoteAddress)\r
) {\r
//\r
- // The DestinationAddress is not specificed.\r
+ // The DestinationAddress is not specified.\r
//\r
return EFI_INVALID_PARAMETER;\r
}\r
//\r
return EFI_INVALID_PARAMETER;\r
}\r
pseudo HeadSum to reduce some overhead.\r
\r
@param[in] Packet Pointer to the NET_BUF contains the udp datagram.\r
pseudo HeadSum to reduce some overhead.\r
\r
@param[in] Packet Pointer to the NET_BUF contains the udp datagram.\r
- @param[in] HeadSum Checksum of the pseudo header, execpt the length\r
+ @param[in] HeadSum Checksum of the pseudo header, except the length\r
field.\r
\r
@return The 16-bit checksum of this udp datagram.\r
field.\r
\r
@return The 16-bit checksum of this udp datagram.\r
- This function cancle the token specified by Arg in the Map.\r
+ This function cancel the token specified by Arg in the Map.\r
\r
@param[in] Map Pointer to the NET_MAP.\r
@param[in] Item Pointer to the NET_MAP_ITEM.\r
\r
@param[in] Map Pointer to the NET_MAP.\r
@param[in] Item Pointer to the NET_MAP_ITEM.\r
from the received udp datagram.\r
\r
@retval TRUE The udp datagram matches the receiving requirements of the Instance.\r
from the received udp datagram.\r
\r
@retval TRUE The udp datagram matches the receiving requirements of the Instance.\r
- @retval FALSE The udp datagram does not matche the receiving requirements of the Instance.\r
+ @retval FALSE The udp datagram does not match the receiving requirements of the Instance.\r
- // Set the checksum as zero, and IP6 driver will calcuate it with pseudo header.\r
+ // Set the checksum as zero, and IP6 driver will calculate it with pseudo header.\r
//\r
IcmpErrHdr->Head.Checksum = 0;\r
\r
//\r
IcmpErrHdr->Head.Checksum = 0;\r
\r
- This function intializes the new created udp instance.\r
+ This function initializes the new created udp instance.\r
\r
@param[in] Udp6Service Pointer to the UDP6_SERVICE_DATA.\r
@param[in, out] Instance Pointer to the un-initialized UDP6_INSTANCE_DATA.\r
\r
@param[in] Udp6Service Pointer to the UDP6_SERVICE_DATA.\r
@param[in, out] Instance Pointer to the un-initialized UDP6_INSTANCE_DATA.\r
\r
@retval EFI_SUCCESS The configuration settings were set, changed, or\r
reset successfully.\r
\r
@retval EFI_SUCCESS The configuration settings were set, changed, or\r
reset successfully.\r
- @retval EFI_NO_MAPPING When the UdpConifgData.UseAnyStationAddress is set\r
+ @retval EFI_NO_MAPPING When the UdpConfigData.UseAnyStationAddress is set\r
to true and there is no address available for IP6\r
driver to binding source address to this\r
instance.\r
to true and there is no address available for IP6\r
driver to binding source address to this\r
instance.\r
.FragmentBuffer fields is NULL.\r
One or more of the\r
Token.Packet.TxData.UdpSessionData.\r
.FragmentBuffer fields is NULL.\r
One or more of the\r
Token.Packet.TxData.UdpSessionData.\r
- DestinationAddres are not valid unicast IPv6\r
+ DestinationAddress are not valid unicast IPv6\r
addresses, if the UdpSessionData is not NULL.\r
Token.Packet.TxData.UdpSessionData.\r
addresses, if the UdpSessionData is not NULL.\r
Token.Packet.TxData.UdpSessionData.\r
- DestinationAddres is NULL\r
+ DestinationAddress is NULL\r
Token.Packet.TxData.UdpSessionData.\r
Token.Packet.TxData.UdpSessionData.\r
- DestinatioPort is zero.\r
+ DestinationPort is zero.\r
Token.Packet.TxData.UdpSessionData is\r
NULL and this instance's\r
UdpConfigData.RemoteAddress is unspecified.\r
Token.Packet.TxData.UdpSessionData is\r
NULL and this instance's\r
UdpConfigData.RemoteAddress is unspecified.\r
\r
/**\r
This function tries to bind the udp instance according to the configured port\r
\r
/**\r
This function tries to bind the udp instance according to the configured port\r
\r
@param[in] InstanceList Pointer to the head of the list linking the udp\r
instances.\r
\r
@param[in] InstanceList Pointer to the head of the list linking the udp\r
instances.\r
\r
@retval EFI_SUCCESS The configuration settings were set, changed, or\r
reset successfully.\r
\r
@retval EFI_SUCCESS The configuration settings were set, changed, or\r
reset successfully.\r
- @retval EFI_NO_MAPPING When the UdpConifgData.UseAnyStationAddress is set\r
+ @retval EFI_NO_MAPPING When the UdpConfigData.UseAnyStationAddress is set\r
to true and there is no address available for the IP6\r
driver to bind a source address to this instance.\r
@retval EFI_INVALID_PARAMETER One or more following conditions are TRUE:\r
to true and there is no address available for the IP6\r
driver to bind a source address to this instance.\r
@retval EFI_INVALID_PARAMETER One or more following conditions are TRUE:\r
// Keep a local copy of the configured multicast IPs because IpIo receives\r
// datagrams from the 0 station address IP instance and then UDP delivers to\r
// the matched instance. This copy of multicast IPs is used to avoid receive\r
// Keep a local copy of the configured multicast IPs because IpIo receives\r
// datagrams from the 0 station address IP instance and then UDP delivers to\r
// the matched instance. This copy of multicast IPs is used to avoid receive\r
- // the mutlicast datagrams destinated to multicast IPs the other instances configured.\r
+ // the multicast datagrams destinated to multicast IPs the other instances configured.\r
//\r
if (JoinFlag) {\r
\r
//\r
if (JoinFlag) {\r
\r
One or more of the\r
Token.Packet.TxData.FragmentTable[].FragmentBuffer\r
fields is NULL. One or more of the\r
One or more of the\r
Token.Packet.TxData.FragmentTable[].FragmentBuffer\r
fields is NULL. One or more of the\r
- Token.Packet.TxData.UdpSessionData.DestinationAddres\r
+ Token.Packet.TxData.UdpSessionData.DestinationAddress\r
are not valid unicast IPv6\r
addresses if the UdpSessionData is not NULL.\r
Token.Packet.TxData.UdpSessionData.\r
DestinationAddress is NULL\r
Token.Packet.TxData.UdpSessionData.\r
are not valid unicast IPv6\r
addresses if the UdpSessionData is not NULL.\r
Token.Packet.TxData.UdpSessionData.\r
DestinationAddress is NULL\r
Token.Packet.TxData.UdpSessionData.\r
is zero.\r
Token.Packet.TxData.UdpSessionData is NULL and this\r
instance's UdpConfigData.RemoteAddress is unspecified.\r
is zero.\r
Token.Packet.TxData.UdpSessionData is NULL and this\r
instance's UdpConfigData.RemoteAddress is unspecified.\r
- // Set the checksum is zero if the ConfigData->StationAddress is unspcified\r
+ // Set the checksum is zero if the ConfigData->StationAddress is unspecified\r
// and the Ipv6 will fill the correct value of this checksum.\r
//\r
Udp6Header->Checksum = 0;\r
// and the Ipv6 will fill the correct value of this checksum.\r
//\r
Udp6Header->Checksum = 0;\r
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
//\r
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
//\r
- // Cancle the tokens specified by Token for this instance.\r
+ // Cancel the tokens specified by Token for this instance.\r
//\r
Status = Udp6InstanceCancelToken (Instance, Token);\r
\r
//\r
Status = Udp6InstanceCancelToken (Instance, Token);\r
\r