2 * Copyright (c) 2002 CITEL Technologies Ltd.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of CITEL Technologies Ltd nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY CITEL TECHNOLOGIES AND CONTRIBUTORS ``AS IS''
18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL CITEL TECHNOLOGIES OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * This file is a contribution to the lwIP TCP/IP stack.
30 * The Swedish Institute of Computer Science and Adam Dunkels
31 * are specifically granted permission to redistribute this
35 #ifndef __LWIP_IGMP_H__
36 #define __LWIP_IGMP_H__
39 #include "lwip/ip_addr.h"
40 #include "lwip/netif.h"
41 #include "lwip/pbuf.h"
43 #if LWIP_IGMP /* don't build if not configured for use in lwipopts.h */
52 #define IP_PROTO_IGMP 2
55 #define ROUTER_ALERT 0x9404
56 #define ROUTER_ALERTLEN 4
59 * IGMP message types, including version number.
61 #define IGMP_MEMB_QUERY 0x11 /* Membership query */
62 #define IGMP_V1_MEMB_REPORT 0x12 /* Ver. 1 membership report */
63 #define IGMP_V2_MEMB_REPORT 0x16 /* Ver. 2 membership report */
64 #define IGMP_LEAVE_GROUP 0x17 /* Leave-group message */
67 #define IGMP_TMR_INTERVAL 100 /* Milliseconds */
68 #define IGMP_V1_DELAYING_MEMBER_TMR (1000/IGMP_TMR_INTERVAL)
69 #define IGMP_JOIN_DELAYING_MEMBER_TMR (500 /IGMP_TMR_INTERVAL)
71 /* MAC Filter Actions */
72 #define IGMP_DEL_MAC_FILTER 0
73 #define IGMP_ADD_MAC_FILTER 1
75 /* Group membership states */
76 #define IGMP_GROUP_NON_MEMBER 0
77 #define IGMP_GROUP_DELAYING_MEMBER 1
78 #define IGMP_GROUP_IDLE_MEMBER 2
83 #ifdef PACK_STRUCT_USE_INCLUDES
84 # include "arch/bpstruct.h"
87 #if (defined(__MWERKS__) || defined(__CWCC__))
88 #pragma options align= packed
91 PACK_STRUCT_FIELD(u8_t igmp_msgtype
);
92 PACK_STRUCT_FIELD(u8_t igmp_maxresp
);
93 PACK_STRUCT_FIELD(u16_t igmp_checksum
);
94 PACK_STRUCT_FIELD(struct ip_addr igmp_group_address
);
97 #ifdef PACK_STRUCT_USE_INCLUDES
98 # include "arch/epstruct.h"
102 * now a group structure - there is
103 * a list of groups for each interface
104 * these should really be linked from the interface, but
105 * if we keep them separate we will not affect the lwip original code
108 * There will be a group for the all systems group address but this
109 * will not run the state machine as it is used to kick off reports
110 * from all the other groups
114 struct igmp_group
*next
;
115 struct netif
*interface
;
116 struct ip_addr group_address
;
117 u8_t last_reporter_flag
; /* signifies we were the last person to report */
120 u8_t use
; /* counter of simultaneous uses */
125 void igmp_init(void);
127 err_t
igmp_start( struct netif
*netif
);
129 err_t
igmp_stop( struct netif
*netif
);
131 void igmp_report_groups( struct netif
*netif
);
133 struct igmp_group
*igmp_lookfor_group( struct netif
*ifp
, struct ip_addr
*addr
);
135 struct igmp_group
*igmp_lookup_group( struct netif
*ifp
, struct ip_addr
*addr
);
137 err_t
igmp_remove_group( struct igmp_group
*group
);
139 void igmp_input( struct pbuf
*p
, struct netif
*inp
, struct ip_addr
*dest
);
141 err_t
igmp_joingroup( struct ip_addr
*ifaddr
, struct ip_addr
*groupaddr
);
143 err_t
igmp_leavegroup( struct ip_addr
*ifaddr
, struct ip_addr
*groupaddr
);
147 void igmp_timeout( struct igmp_group
*group
);
149 void igmp_start_timer( struct igmp_group
*group
, u8_t max_time
);
151 void igmp_stop_timer( struct igmp_group
*group
);
153 void igmp_delaying_member( struct igmp_group
*group
, u8_t maxresp
);
155 err_t
igmp_ip_output_if( struct pbuf
*p
, struct ip_addr
*src
, struct ip_addr
*dest
, u8_t ttl
, u8_t proto
, struct netif
*netif
);
157 void igmp_send( struct igmp_group
*group
, u8_t type
);
163 #endif /* LWIP_IGMP */
165 #endif /* __LWIP_IGMP_H__ */