1 /**
2  * @file
3  * IGMP protocol definitions
4  */
5 
6 /*
7  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without modification,
11  * are permitted provided that the following conditions are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright notice,
14  *    this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright notice,
16  *    this list of conditions and the following disclaimer in the documentation
17  *    and/or other materials provided with the distribution.
18  * 3. The name of the author may not be used to endorse or promote products
19  *    derived from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
22  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
24  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
26  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
29  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
30  * OF SUCH DAMAGE.
31  *
32  * This file is part of the lwIP TCP/IP stack.
33  *
34  * Author: Adam Dunkels <adam@sics.se>
35  *
36  */
37 #ifndef LWIP_HDR_PROT_IGMP_H
38 #define LWIP_HDR_PROT_IGMP_H
39 
40 #include "lwip/arch.h"
41 #include "lwip/ip4_addr.h"
42 
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46 
47 /*
48  * IGMP constants
49  */
50 #define IGMP_TTL                       1
51 #define IGMP_MINLEN                    8
52 #define ROUTER_ALERT                   0x9404U
53 #define ROUTER_ALERTLEN                4
54 
55 /*
56  * IGMP message types, including version number.
57  */
58 #define IGMP_MEMB_QUERY                0x11 /* Membership query         */
59 #define IGMP_V1_MEMB_REPORT            0x12 /* Ver. 1 membership report */
60 #define IGMP_V2_MEMB_REPORT            0x16 /* Ver. 2 membership report */
61 #define IGMP_LEAVE_GROUP               0x17 /* Leave-group message      */
62 
63 /* Group  membership states */
64 #define IGMP_GROUP_NON_MEMBER          0
65 #define IGMP_GROUP_DELAYING_MEMBER     1
66 #define IGMP_GROUP_IDLE_MEMBER         2
67 
68 /**
69  * IGMP packet format.
70  */
71 #ifdef PACK_STRUCT_USE_INCLUDES
72 #  include "arch/bpstruct.h"
73 #endif
74 PACK_STRUCT_BEGIN
75 struct igmp_msg {
76   PACK_STRUCT_FLD_8(u8_t         igmp_msgtype);
77   PACK_STRUCT_FLD_8(u8_t         igmp_maxresp);
78   PACK_STRUCT_FIELD(u16_t        igmp_checksum);
79   PACK_STRUCT_FLD_S(ip4_addr_p_t igmp_group_address);
80 } PACK_STRUCT_STRUCT;
81 PACK_STRUCT_END
82 #ifdef PACK_STRUCT_USE_INCLUDES
83 #  include "arch/epstruct.h"
84 #endif
85 
86 #ifdef __cplusplus
87 }
88 #endif
89 
90 #endif /* LWIP_HDR_PROT_IGMP_H */
91