179 lines
6.3 KiB
C
179 lines
6.3 KiB
C
/****************************************************************************
|
|
* include/nuttx/net/igmp.h
|
|
* The definitions in this header file are intended only for internal use
|
|
* by the NuttX network stack.
|
|
*
|
|
* Copyright (C) 2010, 2012, 2014, 2019 Gregory Nutt. All rights reserved.
|
|
* Author: Gregory Nutt <gnutt@nuttx.org>
|
|
*
|
|
* The NuttX implementation of IGMP was inspired by the IGMP add-on for the
|
|
* lwIP TCP/IP stack by Steve Reynolds:
|
|
*
|
|
* Copyright (c) 2002 CITEL Technologies Ltd.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
* 3. Neither the name NuttX nor the names of its contributors may be
|
|
* used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
|
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
|
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __INCLUDE_NUTTX_NET_IGMP_H
|
|
#define __INCLUDE_NUTTX_NET_IGMP_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
|
|
#include <nuttx/net/netconfig.h>
|
|
#include <nuttx/net/netdev.h>
|
|
#include <nuttx/net/ip.h>
|
|
|
|
#ifdef CONFIG_NET_IGMP
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/* IGMP packet types */
|
|
|
|
#define IGMP_MEMBERSHIP_QUERY 0x11 /* Membership Query */
|
|
#define IGMPv1_MEMBERSHIP_REPORT 0x12 /* IGMP Ver. 1 Membership Report */
|
|
#define IGMPv2_MEMBERSHIP_REPORT 0x16 /* IGMP Ver. 2 Membership Report */
|
|
#define IGMPv3_MEMBERSHIP_REPORT 0x22 /* IGMP Ver. 3 Membership Report */
|
|
#define IGMP_LEAVE_GROUP 0x17 /* Leave Group */
|
|
|
|
/* Size of IGMP header in bytes */
|
|
|
|
#define IGMP_HDRLEN 8
|
|
|
|
/* Time-to-Live must be one */
|
|
|
|
#define IGMP_TTL 1
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
/* Convenience [re-]definition of the IPv4 header with the router alert */
|
|
|
|
struct igmp_iphdr_s
|
|
{
|
|
/* IPv4 IP header */
|
|
|
|
uint8_t vhl; /* 8-bit Version (4) and header length (6 with Router Alert) */
|
|
uint8_t tos; /* 8-bit Type of service (e.g., 6=TCP) */
|
|
uint8_t len[2]; /* 16-bit Total length */
|
|
uint8_t ipid[2]; /* 16-bit Identification */
|
|
uint8_t ipoffset[2]; /* 16-bit IP flags + fragment offset */
|
|
uint8_t ttl; /* 8-bit Time to Live */
|
|
uint8_t proto; /* 8-bit Protocol */
|
|
uint16_t ipchksum; /* 16-bit Header checksum */
|
|
uint16_t srcipaddr[2]; /* 32-bit Source IP address */
|
|
uint16_t destipaddr[2]; /* 32-bit Destination IP address */
|
|
|
|
/* Router Alert IP header option */
|
|
|
|
uint16_t ra[2]; /* RFC 2113 */
|
|
};
|
|
|
|
/* IGMPv2 packet structure as defined by RFC 2236.
|
|
*
|
|
* The Max Response Time (maxresp) specifies the time limit for the
|
|
* corresponding report. The field has a resolution of 100 milliseconds, the
|
|
* value is taken directly. This field is meaningful only in Membership Query
|
|
* (0x11); in other messages it is set to 0 and ignored by the receiver.
|
|
*/
|
|
|
|
struct igmp_hdr_s
|
|
{
|
|
/* IGMPv2 header:
|
|
*
|
|
* 0 1 2 3
|
|
* 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
|
|
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
|
* | Type | Max Resp Time | Checksum |
|
|
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
|
* | Group Address |
|
|
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
|
*/
|
|
|
|
uint8_t type; /* 8-bit IGMP packet type */
|
|
uint8_t maxresp; /* 8-bit Max response time */
|
|
uint16_t chksum; /* 16-bit Checksum */
|
|
uint16_t grpaddr[2]; /* 32-bit Group address */
|
|
};
|
|
|
|
#ifdef CONFIG_NET_STATISTICS
|
|
struct igmp_stats_s
|
|
{
|
|
net_stats_t length_errors;
|
|
net_stats_t chksum_errors;
|
|
net_stats_t v1_received;
|
|
net_stats_t joins;
|
|
net_stats_t leaves;
|
|
net_stats_t leave_sched;
|
|
net_stats_t report_sched;
|
|
net_stats_t poll_send;
|
|
net_stats_t ucast_query;
|
|
net_stats_t query_received;
|
|
net_stats_t report_received;
|
|
};
|
|
|
|
# define IGMP_STATINCR(p) ((p)++)
|
|
#else
|
|
# define IGMP_STATINCR(p)
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
#undef EXTERN
|
|
#if defined(__cplusplus)
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
#undef EXTERN
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* CONFIG_NET_IGMP */
|
|
#endif /* __INCLUDE_NUTTX_NET_IGMP_H */
|