3 Copyright (c) 2005 - 2006, Intel Corporation.<BR>
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14 #ifndef __EFI_IP4_IGMP_H__
15 #define __EFI_IP4_IGMP_H__
27 /// The status of multicast group. It isn't necessary to maintain
28 /// explicit state of host state diagram. A group with non-zero
29 /// DelayTime is in "delaying member" state. otherwise, it is in
30 /// "idle member" state.
42 /// The IGMP status. Each IP4 service instance has a IGMP_SERVICE_DATA
43 /// attached. The Igmpv1QuerySeen remember whether the server on this
44 /// connected network is v1 or v2.
55 IGMP_MEMBERSHIP_QUERY
= 0x11,
56 IGMP_V1_MEMBERSHIP_REPORT
= 0x12,
57 IGMP_V2_MEMBERSHIP_REPORT
= 0x16,
58 IGMP_LEAVE_GROUP
= 0x17,
60 IGMP_V1ROUTER_PRESENT
= 400,
61 IGMP_UNSOLICIATED_REPORT
= 10
65 Init the IGMP control data of the IP4 service instance, configure
66 MNP to receive ALL SYSTEM multicast.
68 @param[in, out] IpSb The IP4 service whose IGMP is to be initialized.
70 @retval EFI_SUCCESS IGMP of the IpSb is successfully initialized.
71 @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to initialize IGMP.
72 @retval Others Failed to initialize the IGMP of IpSb.
77 IN OUT IP4_SERVICE
*IpSb
81 Join the multicast group on behalf of this IP4 child
83 @param[in] IpInstance The IP4 child that wants to join the group
84 @param[in] Address The group to join
86 @retval EFI_SUCCESS Successfully join the multicast group
87 @retval EFI_OUT_OF_RESOURCES Failed to allocate resources
88 @retval Others Failed to join the multicast group.
93 IN IP4_PROTOCOL
*IpInstance
,
98 Leave the IP4 multicast group on behalf of IpInstance.
100 @param[in] IpInstance The IP4 child that wants to leave the group
102 @param[in] Address The group address to leave
104 @retval EFI_NOT_FOUND The IP4 service instance isn't in the group
105 @retval EFI_SUCCESS Successfully leave the multicast group.
106 @retval Others Failed to leave the multicast group.
111 IN IP4_PROTOCOL
*IpInstance
,
116 Handle the received IGMP message for the IP4 service instance.
118 @param[in] IpSb The IP4 service instance that received the message
119 @param[in] Head The IP4 header of the received message
120 @param[in] Packet The IGMP message, without IP4 header
122 @retval EFI_INVALID_PARAMETER The IGMP message is malformated.
123 @retval EFI_SUCCESS The IGMP message is successfully processed.
128 IN IP4_SERVICE
*IpSb
,
134 The periodical timer function for IGMP. It does the following
136 1. Decrease the Igmpv1QuerySeen to make it possible to refresh
137 the IGMP server type.
138 2. Decrease the report timer for each IGMP group in "delaying
141 @param[in] IpSb The IP4 service instance that is ticking
150 Add a group address to the array of group addresses.
151 The caller should make sure that no duplicated address
152 existed in the array. Although the function doesn't
153 assume the byte order of the both Source and Addr, the
154 network byte order is used by the caller.
156 @param[in] Source The array of group addresses to add to
157 @param[in] Count The number of group addresses in the Source
158 @param[in] Addr The IP4 multicast address to add
160 @return NULL if failed to allocate memory for the new groups,
161 otherwise the new combined group addresses.
172 Remove a group address from the array of group addresses.
173 Although the function doesn't assume the byte order of the
174 both Groups and Addr, the network byte order is used by
177 @param Groups The array of group addresses to remove from
178 @param Count The number of group addresses in the Groups
179 @param Addr The IP4 multicast address to remove
181 @return The nubmer of group addresses in the Groups after remove.
182 It is Count if the Addr isn't in the Groups.
187 IN OUT IP4_ADDR
*Groups
,
193 Find the IGMP_GROUP structure which contains the status of multicast
194 group Address in this IGMP control block
196 @param[in] IgmpCtrl The IGMP control block to search from
197 @param[in] Address The multicast address to search
199 @return NULL if the multicast address isn't in the IGMP control block. Otherwise
200 the point to the IGMP_GROUP which contains the status of multicast group
206 IN IGMP_SERVICE_DATA
*IgmpCtrl
,