/** @file\r
This file implements the RFC2236: IGMP v2.\r
\r
-Copyright (c) 2005 - 2009, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2005 - 2015, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
Find the IGMP_GROUP structure which contains the status of multicast\r
group Address in this IGMP control block\r
\r
- @param[in] IgmpCtrl The IGMP control block to search from\r
- @param[in] Address The multicast address to search\r
+ @param[in] IgmpCtrl The IGMP control block to search from.\r
+ @param[in] Address The multicast address to search.\r
\r
@return NULL if the multicast address isn't in the IGMP control block. Otherwise\r
the point to the IGMP_GROUP which contains the status of multicast group\r
same MAC address. Several IP4 multicast address may be mapped to\r
the same MAC address.\r
\r
- @param[in] IgmpCtrl The IGMP control block to search in\r
- @param[in] Mac The MAC address to search\r
+ @param[in] IgmpCtrl The IGMP control block to search in.\r
+ @param[in] Mac The MAC address to search.\r
\r
@return The number of the IP4 multicast group that mapped to the same\r
multicast group Mac.\r
Send an IGMP protocol message to the Dst, such as IGMP v1 membership report.\r
\r
@param[in] IpSb The IP4 service instance that requests the\r
- transmission\r
- @param[in] Dst The destinaton to send to\r
+ transmission.\r
+ @param[in] Dst The destinaton to send to.\r
@param[in] Type The IGMP message type, such as IGMP v1 membership\r
- report\r
+ report.\r
@param[in] Group The group address in the IGMP message head.\r
\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate memory to build the message\r
- @retval EFI_SUCCESS The IGMP message is successfully send\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate memory to build the message.\r
+ @retval EFI_SUCCESS The IGMP message is successfully send.\r
@retval Others Failed to send the IGMP message.\r
\r
**/\r
\r
@param[in] IpSb The IP4 service instance that requests the\r
transmission.\r
- @param[in] Group The group address to report\r
+ @param[in] Group The group address to report.\r
\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate memory to build the message\r
- @retval EFI_SUCCESS The IGMP report message is successfully send\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate memory to build the message.\r
+ @retval EFI_SUCCESS The IGMP report message is successfully send.\r
@retval Others Failed to send the report.\r
\r
**/\r
/**\r
Join the multicast group on behalf of this IP4 child\r
\r
- @param[in] IpInstance The IP4 child that wants to join the group\r
- @param[in] Address The group to join\r
+ @param[in] IpInstance The IP4 child that wants to join the group.\r
+ @param[in] Address The group to join.\r
\r
- @retval EFI_SUCCESS Successfully join the multicast group\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate resources\r
+ @retval EFI_SUCCESS Successfully join the multicast group.\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.\r
@retval Others Failed to join the multicast group.\r
\r
**/\r
Leave the IP4 multicast group on behalf of IpInstance.\r
\r
@param[in] IpInstance The IP4 child that wants to leave the group\r
- address\r
- @param[in] Address The group address to leave\r
+ address.\r
+ @param[in] Address The group address to leave.\r
\r
- @retval EFI_NOT_FOUND The IP4 service instance isn't in the group\r
+ @retval EFI_NOT_FOUND The IP4 service instance isn't in the group.\r
@retval EFI_SUCCESS Successfully leave the multicast group.\r
@retval Others Failed to leave the multicast group.\r
\r
/**\r
Handle the received IGMP message for the IP4 service instance.\r
\r
- @param[in] IpSb The IP4 service instance that received the message\r
- @param[in] Head The IP4 header of the received message\r
- @param[in] Packet The IGMP message, without IP4 header\r
+ @param[in] IpSb The IP4 service instance that received the message.\r
+ @param[in] Head The IP4 header of the received message.\r
+ @param[in] Packet The IGMP message, without IP4 header.\r
\r
@retval EFI_INVALID_PARAMETER The IGMP message is malformated.\r
@retval EFI_SUCCESS The IGMP message is successfully processed.\r
2. Decrease the report timer for each IGMP group in "delaying\r
member" state.\r
\r
- @param[in] IpSb The IP4 service instance that is ticking\r
+ @param[in] IpSb The IP4 service instance that is ticking.\r
\r
**/\r
VOID\r
assume the byte order of the both Source and Addr, the\r
network byte order is used by the caller.\r
\r
- @param[in] Source The array of group addresses to add to\r
- @param[in] Count The number of group addresses in the Source\r
- @param[in] Addr The IP4 multicast address to add\r
+ @param[in] Source The array of group addresses to add to.\r
+ @param[in] Count The number of group addresses in the Source.\r
+ @param[in] Addr The IP4 multicast address to add.\r
\r
@return NULL if failed to allocate memory for the new groups,\r
otherwise the new combined group addresses.\r
both Groups and Addr, the network byte order is used by\r
the caller.\r
\r
- @param Groups The array of group addresses to remove from\r
- @param Count The number of group addresses in the Groups\r
- @param Addr The IP4 multicast address to remove\r
+ @param Groups The array of group addresses to remove from.\r
+ @param Count The number of group addresses in the Groups.\r
+ @param Addr The IP4 multicast address to remove.\r
\r
@return The nubmer of group addresses in the Groups after remove.\r
It is Count if the Addr isn't in the Groups.\r
projects / mirror_edk2.git / blobdiff