xref: /minix3/minix/lib/liblwip/dist/src/include/lwip/igmp.h (revision 5d5fbe79c1b60734f34c69330aec5496644e8651)
1*5d5fbe79SDavid van Moolenbroek /**
2*5d5fbe79SDavid van Moolenbroek  * @file
3*5d5fbe79SDavid van Moolenbroek  * IGMP API
4*5d5fbe79SDavid van Moolenbroek  */
5*5d5fbe79SDavid van Moolenbroek 
6*5d5fbe79SDavid van Moolenbroek /*
7*5d5fbe79SDavid van Moolenbroek  * Copyright (c) 2002 CITEL Technologies Ltd.
8*5d5fbe79SDavid van Moolenbroek  * All rights reserved.
9*5d5fbe79SDavid van Moolenbroek  *
10*5d5fbe79SDavid van Moolenbroek  * Redistribution and use in source and binary forms, with or without
11*5d5fbe79SDavid van Moolenbroek  * modification, are permitted provided that the following conditions
12*5d5fbe79SDavid van Moolenbroek  * are met:
13*5d5fbe79SDavid van Moolenbroek  * 1. Redistributions of source code must retain the above copyright
14*5d5fbe79SDavid van Moolenbroek  *    notice, this list of conditions and the following disclaimer.
15*5d5fbe79SDavid van Moolenbroek  * 2. Redistributions in binary form must reproduce the above copyright
16*5d5fbe79SDavid van Moolenbroek  *    notice, this list of conditions and the following disclaimer in the
17*5d5fbe79SDavid van Moolenbroek  *    documentation and/or other materials provided with the distribution.
18*5d5fbe79SDavid van Moolenbroek  * 3. Neither the name of CITEL Technologies Ltd nor the names of its contributors
19*5d5fbe79SDavid van Moolenbroek  *    may be used to endorse or promote products derived from this software
20*5d5fbe79SDavid van Moolenbroek  *    without specific prior written permission.
21*5d5fbe79SDavid van Moolenbroek  *
22*5d5fbe79SDavid van Moolenbroek  * THIS SOFTWARE IS PROVIDED BY CITEL TECHNOLOGIES AND CONTRIBUTORS ``AS IS''
23*5d5fbe79SDavid van Moolenbroek  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24*5d5fbe79SDavid van Moolenbroek  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25*5d5fbe79SDavid van Moolenbroek  * ARE DISCLAIMED.  IN NO EVENT SHALL CITEL TECHNOLOGIES OR CONTRIBUTORS BE LIABLE
26*5d5fbe79SDavid van Moolenbroek  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27*5d5fbe79SDavid van Moolenbroek  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28*5d5fbe79SDavid van Moolenbroek  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29*5d5fbe79SDavid van Moolenbroek  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30*5d5fbe79SDavid van Moolenbroek  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31*5d5fbe79SDavid van Moolenbroek  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32*5d5fbe79SDavid van Moolenbroek  * SUCH DAMAGE.
33*5d5fbe79SDavid van Moolenbroek  *
34*5d5fbe79SDavid van Moolenbroek  * This file is a contribution to the lwIP TCP/IP stack.
35*5d5fbe79SDavid van Moolenbroek  * The Swedish Institute of Computer Science and Adam Dunkels
36*5d5fbe79SDavid van Moolenbroek  * are specifically granted permission to redistribute this
37*5d5fbe79SDavid van Moolenbroek  * source code.
38*5d5fbe79SDavid van Moolenbroek */
39*5d5fbe79SDavid van Moolenbroek 
40*5d5fbe79SDavid van Moolenbroek #ifndef LWIP_HDR_IGMP_H
41*5d5fbe79SDavid van Moolenbroek #define LWIP_HDR_IGMP_H
42*5d5fbe79SDavid van Moolenbroek 
43*5d5fbe79SDavid van Moolenbroek #include "lwip/opt.h"
44*5d5fbe79SDavid van Moolenbroek #include "lwip/ip_addr.h"
45*5d5fbe79SDavid van Moolenbroek #include "lwip/netif.h"
46*5d5fbe79SDavid van Moolenbroek #include "lwip/pbuf.h"
47*5d5fbe79SDavid van Moolenbroek 
48*5d5fbe79SDavid van Moolenbroek #if LWIP_IPV4 && LWIP_IGMP /* don't build if not configured for use in lwipopts.h */
49*5d5fbe79SDavid van Moolenbroek 
50*5d5fbe79SDavid van Moolenbroek #ifdef __cplusplus
51*5d5fbe79SDavid van Moolenbroek extern "C" {
52*5d5fbe79SDavid van Moolenbroek #endif
53*5d5fbe79SDavid van Moolenbroek 
54*5d5fbe79SDavid van Moolenbroek /* IGMP timer */
55*5d5fbe79SDavid van Moolenbroek #define IGMP_TMR_INTERVAL              100 /* Milliseconds */
56*5d5fbe79SDavid van Moolenbroek #define IGMP_V1_DELAYING_MEMBER_TMR   (1000/IGMP_TMR_INTERVAL)
57*5d5fbe79SDavid van Moolenbroek #define IGMP_JOIN_DELAYING_MEMBER_TMR (500 /IGMP_TMR_INTERVAL)
58*5d5fbe79SDavid van Moolenbroek 
59*5d5fbe79SDavid van Moolenbroek /* Compatibility defines (don't use for new code) */
60*5d5fbe79SDavid van Moolenbroek #define IGMP_DEL_MAC_FILTER            NETIF_DEL_MAC_FILTER
61*5d5fbe79SDavid van Moolenbroek #define IGMP_ADD_MAC_FILTER            NETIF_ADD_MAC_FILTER
62*5d5fbe79SDavid van Moolenbroek 
63*5d5fbe79SDavid van Moolenbroek /**
64*5d5fbe79SDavid van Moolenbroek  * igmp group structure - there is
65*5d5fbe79SDavid van Moolenbroek  * a list of groups for each interface
66*5d5fbe79SDavid van Moolenbroek  * these should really be linked from the interface, but
67*5d5fbe79SDavid van Moolenbroek  * if we keep them separate we will not affect the lwip original code
68*5d5fbe79SDavid van Moolenbroek  * too much
69*5d5fbe79SDavid van Moolenbroek  *
70*5d5fbe79SDavid van Moolenbroek  * There will be a group for the all systems group address but this
71*5d5fbe79SDavid van Moolenbroek  * will not run the state machine as it is used to kick off reports
72*5d5fbe79SDavid van Moolenbroek  * from all the other groups
73*5d5fbe79SDavid van Moolenbroek  */
74*5d5fbe79SDavid van Moolenbroek struct igmp_group {
75*5d5fbe79SDavid van Moolenbroek   /** next link */
76*5d5fbe79SDavid van Moolenbroek   struct igmp_group *next;
77*5d5fbe79SDavid van Moolenbroek   /** multicast address */
78*5d5fbe79SDavid van Moolenbroek   ip4_addr_t         group_address;
79*5d5fbe79SDavid van Moolenbroek   /** signifies we were the last person to report */
80*5d5fbe79SDavid van Moolenbroek   u8_t               last_reporter_flag;
81*5d5fbe79SDavid van Moolenbroek   /** current state of the group */
82*5d5fbe79SDavid van Moolenbroek   u8_t               group_state;
83*5d5fbe79SDavid van Moolenbroek   /** timer for reporting, negative is OFF */
84*5d5fbe79SDavid van Moolenbroek   u16_t              timer;
85*5d5fbe79SDavid van Moolenbroek   /** counter of simultaneous uses */
86*5d5fbe79SDavid van Moolenbroek   u8_t               use;
87*5d5fbe79SDavid van Moolenbroek };
88*5d5fbe79SDavid van Moolenbroek 
89*5d5fbe79SDavid van Moolenbroek /*  Prototypes */
90*5d5fbe79SDavid van Moolenbroek void   igmp_init(void);
91*5d5fbe79SDavid van Moolenbroek err_t  igmp_start(struct netif *netif);
92*5d5fbe79SDavid van Moolenbroek err_t  igmp_stop(struct netif *netif);
93*5d5fbe79SDavid van Moolenbroek void   igmp_report_groups(struct netif *netif);
94*5d5fbe79SDavid van Moolenbroek struct igmp_group *igmp_lookfor_group(struct netif *ifp, const ip4_addr_t *addr);
95*5d5fbe79SDavid van Moolenbroek void   igmp_input(struct pbuf *p, struct netif *inp, const ip4_addr_t *dest);
96*5d5fbe79SDavid van Moolenbroek err_t  igmp_joingroup(const ip4_addr_t *ifaddr, const ip4_addr_t *groupaddr);
97*5d5fbe79SDavid van Moolenbroek err_t  igmp_joingroup_netif(struct netif *netif, const ip4_addr_t *groupaddr);
98*5d5fbe79SDavid van Moolenbroek err_t  igmp_leavegroup(const ip4_addr_t *ifaddr, const ip4_addr_t *groupaddr);
99*5d5fbe79SDavid van Moolenbroek err_t  igmp_leavegroup_netif(struct netif *netif, const ip4_addr_t *groupaddr);
100*5d5fbe79SDavid van Moolenbroek void   igmp_tmr(void);
101*5d5fbe79SDavid van Moolenbroek 
102*5d5fbe79SDavid van Moolenbroek /** @ingroup igmp
103*5d5fbe79SDavid van Moolenbroek  * Get list head of IGMP groups for netif.
104*5d5fbe79SDavid van Moolenbroek  * Note: The allsystems group IP is contained in the list as first entry.
105*5d5fbe79SDavid van Moolenbroek  * @see @ref netif_set_igmp_mac_filter()
106*5d5fbe79SDavid van Moolenbroek  */
107*5d5fbe79SDavid van Moolenbroek #define netif_igmp_data(netif) ((struct igmp_group *)netif_get_client_data(netif, LWIP_NETIF_CLIENT_DATA_INDEX_IGMP))
108*5d5fbe79SDavid van Moolenbroek 
109*5d5fbe79SDavid van Moolenbroek #ifdef __cplusplus
110*5d5fbe79SDavid van Moolenbroek }
111*5d5fbe79SDavid van Moolenbroek #endif
112*5d5fbe79SDavid van Moolenbroek 
113*5d5fbe79SDavid van Moolenbroek #endif /* LWIP_IPV4 && LWIP_IGMP */
114*5d5fbe79SDavid van Moolenbroek 
115*5d5fbe79SDavid van Moolenbroek #endif /* LWIP_HDR_IGMP_H */
116