1 /* 2 * Copyright (c) 2002 CITEL Technologies Ltd. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 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. 16 * 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 27 * SUCH DAMAGE. 28 * 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 32 * source code. 33 */ 34 35 #ifndef __LWIP_IGMP_H__ 36 #define __LWIP_IGMP_H__ 37 38 #include "lwip/opt.h" 39 #include "lwip/ip_addr.h" 40 #include "lwip/netif.h" 41 #include "lwip/pbuf.h" 42 43 #if LWIP_IGMP /* don't build if not configured for use in lwipopts.h */ 44 45 #ifdef __cplusplus 46 extern "C" { 47 #endif 48 49 50 /* IGMP timer */ 51 #define IGMP_TMR_INTERVAL 100 /* Milliseconds */ 52 #define IGMP_V1_DELAYING_MEMBER_TMR (1000/IGMP_TMR_INTERVAL) 53 #define IGMP_JOIN_DELAYING_MEMBER_TMR (500 /IGMP_TMR_INTERVAL) 54 55 /* MAC Filter Actions, these are passed to a netif's 56 * igmp_mac_filter callback function. */ 57 #define IGMP_DEL_MAC_FILTER 0 58 #define IGMP_ADD_MAC_FILTER 1 59 60 61 /** 62 * igmp group structure - there is 63 * a list of groups for each interface 64 * these should really be linked from the interface, but 65 * if we keep them separate we will not affect the lwip original code 66 * too much 67 * 68 * There will be a group for the all systems group address but this 69 * will not run the state machine as it is used to kick off reports 70 * from all the other groups 71 */ 72 struct igmp_group { 73 /** next link */ 74 struct igmp_group *next; 75 /** interface on which the group is active */ 76 struct netif *netif; 77 /** multicast address */ 78 ip_addr_t group_address; 79 /** signifies we were the last person to report */ 80 u8_t last_reporter_flag; 81 /** current state of the group */ 82 u8_t group_state; 83 /** timer for reporting, negative is OFF */ 84 u16_t timer; 85 /** counter of simultaneous uses */ 86 u8_t use; 87 }; 88 89 /* Prototypes */ 90 void igmp_init(void); 91 err_t igmp_start(struct netif *netif); 92 err_t igmp_stop(struct netif *netif); 93 void igmp_report_groups(struct netif *netif); 94 struct igmp_group *igmp_lookfor_group(struct netif *ifp, ip_addr_t *addr); 95 void igmp_input(struct pbuf *p, struct netif *inp, ip_addr_t *dest); 96 err_t igmp_joingroup(ip_addr_t *ifaddr, ip_addr_t *groupaddr); 97 err_t igmp_leavegroup(ip_addr_t *ifaddr, ip_addr_t *groupaddr); 98 void igmp_tmr(void); 99 100 #ifdef __cplusplus 101 } 102 #endif 103 104 #endif /* LWIP_IGMP */ 105 106 #endif /* __LWIP_IGMP_H__ */ 107
