Definitions common to IGMP host, router and snooping switch. More...

#include "core/net.h"

Macros
#define	IGMP_TICK_INTERVAL 200

#define	IGMP_ROBUSTNESS_VARIABLE 2

#define	IGMP_QUERY_INTERVAL 125000

#define	IGMP_QUERY_RESPONSE_INTERVAL 10000

#define	IGMP_GROUP_MEMBERSHIP_INTERVAL

#define	IGMP_OTHER_QUERIER_PRESENT_INTERVAL

#define	IGMP_STARTUP_QUERY_INTERVAL (IGMP_QUERY_INTERVAL / 4)

#define	IGMP_STARTUP_QUERY_COUNT IGMP_ROBUSTNESS_VARIABLE

#define	IGMP_LAST_MEMBER_QUERY_INTERVAL 1000

#define	IGMP_LAST_MEMBER_QUERY_COUNT IGMP_ROBUSTNESS_VARIABLE

#define	IGMP_LAST_MEMBER_QUERY_TIME

#define	IGMP_UNSOLICITED_REPORT_INTERVAL 10000

#define	IGMP_OLDER_VERSION_QUERIER_PRESENT_TIMEOUT 400000

#define	IGMP_V1_MAX_RESPONSE_TIME 10000

#define	IGMP_V3_UNSOLICITED_REPORT_INTERVAL 1000

#define	IGMP_MAX_MSG_SIZE 1024

#define	IGMP_TTL 1

#define	IGMP_ALL_SYSTEMS_ADDR IPV4_ADDR(224, 0, 0, 1)

#define	IGMP_ALL_ROUTERS_ADDR IPV4_ADDR(224, 0, 0, 2)

#define	IGMP_V3_ALL_ROUTERS_ADDR IPV4_ADDR(224, 0, 0, 22)

Enumerations
enum	IgmpVersion { IGMP_VERSION_1 = 1, IGMP_VERSION_2 = 2, IGMP_VERSION_3 = 3 }
	IGMP versions. More...

enum	IgmpType { IGMP_TYPE_MEMBERSHIP_QUERY = 0x11, IGMP_TYPE_MEMBERSHIP_REPORT_V1 = 0x12, IGMP_TYPE_MEMBERSHIP_REPORT_V2 = 0x16, IGMP_TYPE_LEAVE_GROUP = 0x17, IGMP_TYPE_MEMBERSHIP_REPORT_V3 = 0x22 }
	IGMP message types. More...

enum	IgmpGroupRecordType { IGMP_GROUP_RECORD_TYPE_IS_IN = 1, IGMP_GROUP_RECORD_TYPE_IS_EX = 2, IGMP_GROUP_RECORD_TYPE_TO_IN = 3, IGMP_GROUP_RECORD_TYPE_TO_EX = 4, IGMP_GROUP_RECORD_TYPE_ALLOW = 5, IGMP_GROUP_RECORD_TYPE_BLOCK = 6 }
	IGMPv3 group record types. More...

Functions
error_t	igmpInit (NetInterface *interface)
	IGMP initialization. More...

void	igmpTick (NetInterface *interface)
	IGMP timer handler. More...

void	igmpLinkChangeEvent (NetInterface *interface)
	Callback function for link change event. More...

error_t	igmpSendMessage (NetInterface interface, Ipv4Addr destAddr, NetBuffer buffer, size_t offset)
	Send IGMP message. More...

void	igmpProcessMessage (NetInterface interface, const Ipv4PseudoHeader pseudoHeader, const NetBuffer buffer, size_t offset, const NetRxAncillary ancillary)
	Process incoming IGMP message. More...

systime_t	igmpGetRandomDelay (systime_t maxDelay)
	Generate a random delay. More...

uint32_t	igmpDecodeFloatingPointValue (uint8_t code)
	Decode a floating-point value. More...

Variables
typedef	__packed_struct
	IGMP message. More...

uint8_t	maxRespTime

uint16_t	checksum

Ipv4Addr	groupAddr

	IgmpMessage

uint8_t	maxRespCode

uint8_t	qrv

uint8_t	s

uint8_t	flags

uint8_t	qqic

uint16_t	numOfSources

Ipv4Addr	srcAddr []

	IgmpMembershipQueryV3

uint8_t	reserved

uint16_t	numOfGroupRecords

uint8_t	groupRecords []

	IgmpMembershipReportV3

uint8_t	auxDataLen

Ipv4Addr	multicastAddr

	IgmpGroupRecord

systime_t	igmpTickCounter

Detailed Description

Definitions common to IGMP host, router and snooping switch.

License

SPDX-License-Identifier: GPL-2.0-or-later

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author: Oryx Embedded SARL (www.oryx-embedded.com)

Version: 2.5.4

Definition in file igmp_common.h.

Macro Definition Documentation

◆ IGMP_ALL_ROUTERS_ADDR

#define IGMP_ALL_ROUTERS_ADDR IPV4_ADDR(224, 0, 0, 2)

Definition at line 146 of file igmp_common.h.

◆ IGMP_ALL_SYSTEMS_ADDR

#define IGMP_ALL_SYSTEMS_ADDR IPV4_ADDR(224, 0, 0, 1)

Definition at line 144 of file igmp_common.h.

◆ IGMP_GROUP_MEMBERSHIP_INTERVAL

#define IGMP_GROUP_MEMBERSHIP_INTERVAL

Value:

((IGMP_ROBUSTNESS_VARIABLE * \

IGMP_QUERY_INTERVAL) + IGMP_QUERY_RESPONSE_INTERVAL)

Definition at line 66 of file igmp_common.h.

◆ IGMP_LAST_MEMBER_QUERY_COUNT

#define IGMP_LAST_MEMBER_QUERY_COUNT IGMP_ROBUSTNESS_VARIABLE

Definition at line 96 of file igmp_common.h.

◆ IGMP_LAST_MEMBER_QUERY_INTERVAL

#define IGMP_LAST_MEMBER_QUERY_INTERVAL 1000

Definition at line 89 of file igmp_common.h.

◆ IGMP_LAST_MEMBER_QUERY_TIME

#define IGMP_LAST_MEMBER_QUERY_TIME

Value:

(IGMP_LAST_MEMBER_QUERY_COUNT * \

IGMP_LAST_MEMBER_QUERY_INTERVAL)

Definition at line 102 of file igmp_common.h.

◆ IGMP_MAX_MSG_SIZE

#define IGMP_MAX_MSG_SIZE 1024

Definition at line 135 of file igmp_common.h.

◆ IGMP_OLDER_VERSION_QUERIER_PRESENT_TIMEOUT

#define IGMP_OLDER_VERSION_QUERIER_PRESENT_TIMEOUT 400000

Definition at line 114 of file igmp_common.h.

◆ IGMP_OTHER_QUERIER_PRESENT_INTERVAL

#define IGMP_OTHER_QUERIER_PRESENT_INTERVAL

Value:

((IGMP_ROBUSTNESS_VARIABLE * \

IGMP_QUERY_INTERVAL) + (IGMP_QUERY_RESPONSE_INTERVAL / 2))

Definition at line 70 of file igmp_common.h.

◆ IGMP_QUERY_INTERVAL

#define IGMP_QUERY_INTERVAL 125000

Definition at line 53 of file igmp_common.h.

◆ IGMP_QUERY_RESPONSE_INTERVAL

#define IGMP_QUERY_RESPONSE_INTERVAL 10000

Definition at line 60 of file igmp_common.h.

◆ IGMP_ROBUSTNESS_VARIABLE

#define IGMP_ROBUSTNESS_VARIABLE 2

Definition at line 46 of file igmp_common.h.

◆ IGMP_STARTUP_QUERY_COUNT

#define IGMP_STARTUP_QUERY_COUNT IGMP_ROBUSTNESS_VARIABLE

Definition at line 82 of file igmp_common.h.

◆ IGMP_STARTUP_QUERY_INTERVAL

#define IGMP_STARTUP_QUERY_INTERVAL (IGMP_QUERY_INTERVAL / 4)

Definition at line 75 of file igmp_common.h.

◆ IGMP_TICK_INTERVAL

#define IGMP_TICK_INTERVAL 200

Definition at line 39 of file igmp_common.h.

◆ IGMP_TTL

#define IGMP_TTL 1

Definition at line 141 of file igmp_common.h.

◆ IGMP_UNSOLICITED_REPORT_INTERVAL

#define IGMP_UNSOLICITED_REPORT_INTERVAL 10000

Definition at line 107 of file igmp_common.h.

◆ IGMP_V1_MAX_RESPONSE_TIME

#define IGMP_V1_MAX_RESPONSE_TIME 10000

Definition at line 121 of file igmp_common.h.

◆ IGMP_V3_ALL_ROUTERS_ADDR

#define IGMP_V3_ALL_ROUTERS_ADDR IPV4_ADDR(224, 0, 0, 22)

Definition at line 148 of file igmp_common.h.

◆ IGMP_V3_UNSOLICITED_REPORT_INTERVAL

#define IGMP_V3_UNSOLICITED_REPORT_INTERVAL 1000

Definition at line 128 of file igmp_common.h.

Enumeration Type Documentation

◆ IgmpGroupRecordType

enum IgmpGroupRecordType

IGMPv3 group record types.

Enumerator
IGMP_GROUP_RECORD_TYPE_IS_IN
IGMP_GROUP_RECORD_TYPE_IS_EX
IGMP_GROUP_RECORD_TYPE_TO_IN
IGMP_GROUP_RECORD_TYPE_TO_EX
IGMP_GROUP_RECORD_TYPE_ALLOW
IGMP_GROUP_RECORD_TYPE_BLOCK

Definition at line 186 of file igmp_common.h.

◆ IgmpType

enum IgmpType

IGMP message types.

Enumerator
IGMP_TYPE_MEMBERSHIP_QUERY
IGMP_TYPE_MEMBERSHIP_REPORT_V1
IGMP_TYPE_MEMBERSHIP_REPORT_V2
IGMP_TYPE_LEAVE_GROUP
IGMP_TYPE_MEMBERSHIP_REPORT_V3

Definition at line 172 of file igmp_common.h.

◆ IgmpVersion

enum IgmpVersion

IGMP versions.

Enumerator
IGMP_VERSION_1
IGMP_VERSION_2
IGMP_VERSION_3

Definition at line 160 of file igmp_common.h.

Function Documentation

◆ igmpDecodeFloatingPointValue()

uint32_t igmpDecodeFloatingPointValue ( uint8_t code )

Decode a floating-point value.

Parameters

[in] code Floating-point representation

Returns: Decoded value

Definition at line 399 of file igmp_common.c.

◆ igmpGetRandomDelay()

systime_t igmpGetRandomDelay ( systime_t maxDelay )

Generate a random delay.

Parameters

[in] maxDelay maximum delay

Returns: Random amount of time

Definition at line 374 of file igmp_common.c.

◆ igmpInit()

error_t igmpInit ( NetInterface * interface )

IGMP initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 73 of file igmp_common.c.

◆ igmpLinkChangeEvent()

void igmpLinkChangeEvent ( NetInterface * interface )

Callback function for link change event.

Parameters

[in] interface Underlying network interface

Definition at line 140 of file igmp_common.c.

◆ igmpProcessMessage()

void igmpProcessMessage	(	NetInterface *	interface,
		const Ipv4PseudoHeader *	pseudoHeader,
		const NetBuffer *	buffer,
		size_t	offset,
		const NetRxAncillary *	ancillary
	)

Process incoming IGMP message.

Parameters

[in]	interface	Underlying network interface
[in]	pseudoHeader	IPv4 pseudo header
[in]	buffer	Multi-part buffer containing the incoming IGMP message
[in]	offset	Offset to the first byte of the IGMP message
[in]	ancillary	Additional options passed to the stack along with the packet

Definition at line 293 of file igmp_common.c.

◆ igmpSendMessage()

error_t igmpSendMessage	(	NetInterface *	interface,
		Ipv4Addr	destAddr,
		NetBuffer *	buffer,
		size_t	offset
	)

Send IGMP message.

Parameters

[in]	interface	Underlying network interface
[in]	destAddr	Destination IP address
[in]	buffer	Multi-part buffer containing the payload
[in]	offset	Offset to the first byte of the payload

Returns: Error code

Definition at line 158 of file igmp_common.c.

◆ igmpTick()

void igmpTick ( NetInterface * interface )

IGMP timer handler.

This routine must be periodically called by the TCP/IP stack to handle IGMP related timers

Parameters

[in] interface Underlying network interface

Definition at line 108 of file igmp_common.c.

Variable Documentation

◆ __packed_struct

typedef __packed_struct

Initial value:

{

uint8_t type

IGMP message.

IGMPv3 group record.

IGMPv3 Membership Report message.

IGMPv3 Membership Query message.

Definition at line 209 of file igmp_common.h.

◆ auxDataLen

uint8_t auxDataLen

Definition at line 265 of file igmp_common.h.

◆ checksum

uint16_t checksum

Definition at line 213 of file igmp_common.h.

◆ flags

uint16_t flags

Definition at line 235 of file igmp_common.h.

◆ groupAddr

Ipv4Addr groupAddr

Definition at line 214 of file igmp_common.h.

◆ groupRecords

uint8_t groupRecords[]

Definition at line 254 of file igmp_common.h.

◆ IgmpGroupRecord

IgmpGroupRecord

Definition at line 269 of file igmp_common.h.

◆ IgmpMembershipQueryV3

IgmpMembershipQueryV3

Definition at line 240 of file igmp_common.h.

◆ IgmpMembershipReportV3

IgmpMembershipReportV3

Definition at line 255 of file igmp_common.h.

◆ IgmpMessage

IgmpMessage

Definition at line 215 of file igmp_common.h.

◆ igmpTickCounter

systime_t igmpTickCounter

extern

Definition at line 64 of file igmp_common.c.

◆ maxRespCode

uint8_t maxRespCode

Definition at line 225 of file igmp_common.h.

◆ maxRespTime

uint8_t maxRespTime

Definition at line 212 of file igmp_common.h.

◆ multicastAddr

Ipv6Addr multicastAddr

Definition at line 267 of file igmp_common.h.

◆ numOfGroupRecords

uint16_t numOfGroupRecords

Definition at line 253 of file igmp_common.h.

◆ numOfSources

uint16_t numOfSources

Definition at line 238 of file igmp_common.h.

◆ qqic

uint8_t qqic

Definition at line 237 of file igmp_common.h.

◆ qrv

uint8_t qrv

Definition at line 233 of file igmp_common.h.

◆ reserved

uint8_t reserved

Definition at line 250 of file igmp_common.h.

◆ s

uint8_t s

Definition at line 234 of file igmp_common.h.

◆ srcAddr

Ipv4Addr srcAddr[]

Definition at line 239 of file igmp_common.h.

Macros

Enumerations

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ IGMP_ALL_ROUTERS_ADDR

◆ IGMP_ALL_SYSTEMS_ADDR

◆ IGMP_GROUP_MEMBERSHIP_INTERVAL

◆ IGMP_LAST_MEMBER_QUERY_COUNT

◆ IGMP_LAST_MEMBER_QUERY_INTERVAL

◆ IGMP_LAST_MEMBER_QUERY_TIME

◆ IGMP_MAX_MSG_SIZE

◆ IGMP_OLDER_VERSION_QUERIER_PRESENT_TIMEOUT

◆ IGMP_OTHER_QUERIER_PRESENT_INTERVAL

◆ IGMP_QUERY_INTERVAL

◆ IGMP_QUERY_RESPONSE_INTERVAL

◆ IGMP_ROBUSTNESS_VARIABLE

◆ IGMP_STARTUP_QUERY_COUNT

◆ IGMP_STARTUP_QUERY_INTERVAL

◆ IGMP_TICK_INTERVAL

◆ IGMP_TTL

◆ IGMP_UNSOLICITED_REPORT_INTERVAL

◆ IGMP_V1_MAX_RESPONSE_TIME

◆ IGMP_V3_ALL_ROUTERS_ADDR

◆ IGMP_V3_UNSOLICITED_REPORT_INTERVAL

Enumeration Type Documentation

◆ IgmpGroupRecordType

◆ IgmpType

◆ IgmpVersion

Function Documentation

◆ igmpDecodeFloatingPointValue()

◆ igmpGetRandomDelay()

◆ igmpInit()

◆ igmpLinkChangeEvent()

◆ igmpProcessMessage()

◆ igmpSendMessage()

◆ igmpTick()

Variable Documentation

◆ __packed_struct

◆ auxDataLen

◆ checksum

◆ flags

◆ groupAddr

◆ groupRecords

◆ IgmpGroupRecord

◆ IgmpMembershipQueryV3

◆ IgmpMembershipReportV3

◆ IgmpMessage

◆ igmpTickCounter

◆ maxRespCode

◆ maxRespTime

◆ multicastAddr

◆ numOfGroupRecords

◆ numOfSources

◆ qqic

◆ qrv

◆ reserved

◆ s

◆ srcAddr