Definitions common to IGMP host, router and snooping switch. More...
#include "core/net.h"
Go to the source code of this file.
Macros | |
#define | IGMP_TICK_INTERVAL 1000 |
#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_V1_ROUTER_PRESENT_TIMEOUT 400000 |
#define | IGMP_V1_MAX_RESPONSE_TIME 10000 |
#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) |
Typedefs | |
struct { | |
char_t type | |
uint32_t dataStart | |
uint32_t dataLength | |
uint8_t nameLength | |
char_t name [] | |
uint8_t tokenLen: 4 | |
uint8_t type: 2 | |
uint8_t version: 2 | |
uint8_t code | |
uint16_t mid | |
uint8_t token [] | |
union { | |
uint8_t b [6] | |
uint16_t w [3] | |
} | |
uint16_t srcPort | |
uint16_t destPort | |
uint32_t seqNum | |
uint32_t ackNum | |
uint8_t reserved1: 4 | |
uint8_t dataOffset: 4 | |
uint8_t flags: 6 | |
uint8_t reserved2: 2 | |
uint16_t window | |
uint16_t checksum | |
uint16_t urgentPointer | |
uint8_t options [] | |
uint16_t length | |
uint8_t data [] | |
uint8_t op | |
uint8_t htype | |
uint8_t hlen | |
uint8_t hops | |
uint32_t xid | |
uint16_t secs | |
uint16_t flags | |
Ipv4Addr ciaddr | |
Ipv4Addr yiaddr | |
Ipv4Addr siaddr | |
Ipv4Addr giaddr | |
MacAddr chaddr | |
uint8_t unused [10] | |
uint8_t sname [64] | |
uint8_t file [128] | |
uint32_t magicCookie | |
uint16_t type | |
uint16_t hardwareType | |
uint32_t time | |
MacAddr linkLayerAddr | |
uint16_t id | |
uint8_t rd: 1 | |
uint8_t tc: 1 | |
uint8_t aa: 1 | |
uint8_t opcode: 4 | |
uint8_t qr: 1 | |
uint8_t rcode: 4 | |
uint8_t z: 3 | |
uint8_t ra: 1 | |
uint16_t qdcount | |
uint16_t ancount | |
uint16_t nscount | |
uint16_t arcount | |
uint8_t questions [] | |
uint16_t controlWord | |
uint16_t byteCount | |
uint8_t bLength | |
uint8_t bDescriptorType | |
uint16_t bcdUsb | |
uint8_t bDeviceClass | |
uint8_t bDeviceSubClass | |
uint8_t bDeviceProtocol | |
uint8_t bMaxPacketSize0 | |
uint16_t idVendor | |
uint16_t idProduct | |
uint16_t bcdDevice | |
uint8_t iManufacturer | |
uint8_t iProduct | |
uint8_t iSerialNumber | |
uint8_t bNumConfigurations | |
uint8_t maxRespTime | |
Ipv4Addr groupAddr | |
uint16_t hrd | |
uint16_t pro | |
uint8_t hln | |
uint8_t pln | |
uint16_t op | |
MacAddr sha | |
Ipv4Addr spa | |
MacAddr tha | |
Ipv4Addr tpa | |
uint8_t length | |
uint8_t value [] | |
uint16_t first | |
uint16_t last | |
uint16_t next | |
union { | |
uint8_t b [16] | |
uint16_t w [8] | |
uint32_t dw [4] | |
} | |
uint16_t maxRespDelay | |
uint16_t reserved | |
Ipv6Addr multicastAddr | |
uint32_t reserved | |
uint16_t pvid | |
uint8_t autoNegSupportStatus | |
uint16_t pmdAutoNegAdvCap | |
uint16_t operationalMauType | |
uint16_t capabilities | |
uint8_t deviceType | |
uint8_t lengthH: 1 | |
uint8_t lengthL | |
uint8_t t: 1 | |
uint8_t c: 1 | |
union { | |
int32_t integer | |
uint8_t octetString [1] | |
uint8_t oid [1] | |
uint8_t ipAddr [4] | |
uint32_t counter32 | |
uint32_t gauge32 | |
uint32_t unsigned32 | |
uint32_t timeTicks | |
uint64_t counter64 | |
} | |
uint16_t transactionId | |
uint16_t protocolId | |
uint8_t unitId | |
uint8_t pdu [] | |
uint8_t retain: 1 | |
uint8_t qos: 2 | |
uint8_t dup: 1 | |
union { | |
uint8_t all | |
struct { | |
uint8_t topicIdType: 2 | |
uint8_t cleanSession: 1 | |
uint8_t will: 1 | |
uint8_t retain: 1 | |
uint8_t qos: 2 | |
uint8_t dup: 1 | |
} | |
} | |
uint8_t b: 1 | |
uint8_t identifier | |
uint8_t valueSize | |
Ipv4Addr srcIpAddr | |
Ipv4Addr destIpAddr | |
Eui64 interfaceId | |
uint16_t mru | |
uint8_t peerIdLength | |
uint8_t peerId [] | |
uint32_t seconds | |
uint32_t fraction | |
uint16_t opcode | |
char_t filename [] | |
uint8_t reserved: 3 | |
uint8_t fin: 1 | |
uint8_t payloadLen: 7 | |
uint8_t mask: 1 | |
uint8_t extPayloadLen [] | |
uint32_t length | |
uint8_t payload [] | |
uint8_t protocolVersionId | |
uint8_t bpduType | |
StpBridgeId rootId | |
uint32_t rootPathCost | |
StpBridgeId bridgeId | |
uint16_t portId | |
uint16_t messageAge | |
uint16_t maxAge | |
uint16_t helloTime | |
uint16_t forwardDelay | |
uint8_t version1Length | |
uint16_t priority | |
MacAddr addr | |
} | IgmpMessage |
General IGMP message format. More... | |
Enumerations | |
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 type. 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, const IgmpMessage *message, size_t length) |
Send IGMP message. More... | |
void | igmpProcessMessage (NetInterface *interface, Ipv4PseudoHeader *pseudoHeader, const NetBuffer *buffer, size_t offset, NetRxAncillary *ancillary) |
Process incoming IGMP message. More... | |
void | igmpDumpMessage (const IgmpMessage *message) |
Dump IGMP message for debugging purpose. More... | |
Variables | |
systime_t | igmpTickCounter |
Detailed Description
Definitions common to IGMP host, router and snooping switch.
License
SPDX-License-Identifier: GPL-2.0-or-later
Copyright (C) 2010-2023 Oryx Embedded SARL. All rights reserved.
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.
- Version
- 2.2.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 132 of file igmp_common.h.
◆ IGMP_ALL_SYSTEMS_ADDR
#define IGMP_ALL_SYSTEMS_ADDR IPV4_ADDR(224, 0, 0, 1) |
Definition at line 130 of file igmp_common.h.
◆ IGMP_GROUP_MEMBERSHIP_INTERVAL
#define IGMP_GROUP_MEMBERSHIP_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 |
Definition at line 102 of file igmp_common.h.
◆ IGMP_OTHER_QUERIER_PRESENT_INTERVAL
#define IGMP_OTHER_QUERIER_PRESENT_INTERVAL |
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 1000 |
Definition at line 39 of file igmp_common.h.
◆ IGMP_TTL
#define IGMP_TTL 1 |
Definition at line 127 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_V1_ROUTER_PRESENT_TIMEOUT
#define IGMP_V1_ROUTER_PRESENT_TIMEOUT 400000 |
Definition at line 114 of file igmp_common.h.
Typedef Documentation
◆ IgmpMessage
typedef { ... } IgmpMessage |
General IGMP message format.
Enumeration Type Documentation
◆ IgmpType
enum IgmpType |
IGMP message type.
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 144 of file igmp_common.h.
Function Documentation
◆ igmpDumpMessage()
void igmpDumpMessage | ( | const IgmpMessage * | message | ) |
Dump IGMP message for debugging purpose.
- Parameters
-
[in] message Pointer to the IGMP message
Definition at line 339 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 59 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 123 of file igmp_common.c.
◆ igmpProcessMessage()
void igmpProcessMessage | ( | NetInterface * | interface, |
Ipv4PseudoHeader * | pseudoHeader, | ||
const NetBuffer * | buffer, | ||
size_t | offset, | ||
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 259 of file igmp_common.c.
◆ igmpSendMessage()
error_t igmpSendMessage | ( | NetInterface * | interface, |
Ipv4Addr | destAddr, | ||
const IgmpMessage * | message, | ||
size_t | length | ||
) |
Send IGMP message.
- Parameters
-
[in] interface Underlying network interface [in] destAddr Destination IP address [in] message Pointer to the IGMP message [in] length Length of the IGMP message, in bytes
- Returns
- Error code
Definition at line 141 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 91 of file igmp_common.c.
Variable Documentation
◆ checksum
uint16_t checksum |
Definition at line 168 of file igmp_common.h.
◆ groupAddr
Ipv4Addr groupAddr |
Definition at line 169 of file igmp_common.h.
◆ igmpTickCounter
|
extern |
Definition at line 50 of file igmp_common.c.
◆ maxRespTime
uint8_t maxRespTime |
Definition at line 167 of file igmp_common.h.
◆ type
uint8_t type |
Definition at line 166 of file igmp_common.h.