mld.h File Reference

MLD (Multicast Listener Discovery for IPv6) More...

#include "core/net.h"

Go to the source code of this file.

Macros

#define MLD_SUPPORT   DISABLED
 
#define MLD_TICK_INTERVAL   1000
 
#define MLD_UNSOLICITED_REPORT_INTERVAL   10000
 
#define MLD_HOP_LIMIT   1
 

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 []
 
   uint32_t   packetLen
 
   uint8_t   paddingLen
 
   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
 
MldMessage
 MLD message. More...
 

Enumerations

enum  MldState { MLD_STATE_NON_LISTENER = 0, MLD_STATE_DELAYING_LISTENER = 1, MLD_STATE_IDLE_LISTENER = 2 }
 MLD node states. More...
 

Functions

error_t mldInit (NetInterface *interface)
 MLD initialization. More...
 
error_t mldStartListening (NetInterface *interface, Ipv6FilterEntry *entry)
 Start listening to the address on the interface. More...
 
error_t mldStopListening (NetInterface *interface, Ipv6FilterEntry *entry)
 Stop listening to the address on the interface. More...
 
void mldTick (NetInterface *interface)
 MLD timer handler. More...
 
void mldLinkChangeEvent (NetInterface *interface)
 Callback function for link change event. More...
 
void mldProcessListenerQuery (NetInterface *interface, Ipv6PseudoHeader *pseudoHeader, const NetBuffer *buffer, size_t offset, uint8_t hopLimit)
 Process incoming Multicast Listener Query message. More...
 
void mldProcessListenerReport (NetInterface *interface, Ipv6PseudoHeader *pseudoHeader, const NetBuffer *buffer, size_t offset, uint8_t hopLimit)
 Process incoming Multicast Listener Report message. More...
 
error_t mldSendListenerReport (NetInterface *interface, Ipv6Addr *ipAddr)
 Send Multicast Listener Report message. More...
 
error_t mldSendListenerDone (NetInterface *interface, Ipv6Addr *ipAddr)
 Send Multicast Listener Done message. More...
 
void mldDumpMessage (const MldMessage *message)
 Dump MLD message for debugging purpose. More...
 

Variables

systime_t mldTickCounter
 

Detailed Description

MLD (Multicast Listener Discovery for IPv6)

License

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

Copyright (C) 2010-2022 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.

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

Definition in file mld.h.

Macro Definition Documentation

◆ MLD_HOP_LIMIT

#define MLD_HOP_LIMIT   1

Definition at line 59 of file mld.h.

◆ MLD_SUPPORT

#define MLD_SUPPORT   DISABLED

Definition at line 39 of file mld.h.

◆ MLD_TICK_INTERVAL

#define MLD_TICK_INTERVAL   1000

Definition at line 46 of file mld.h.

◆ MLD_UNSOLICITED_REPORT_INTERVAL

#define MLD_UNSOLICITED_REPORT_INTERVAL   10000

Definition at line 53 of file mld.h.

Typedef Documentation

◆ MldMessage

typedef { ... } MldMessage

MLD message.

Enumeration Type Documentation

◆ MldState

enum MldState

MLD node states.

Enumerator
MLD_STATE_NON_LISTENER 
MLD_STATE_DELAYING_LISTENER 
MLD_STATE_IDLE_LISTENER 

Definition at line 71 of file mld.h.

Function Documentation

◆ mldDumpMessage()

void mldDumpMessage ( const MldMessage message)

Dump MLD message for debugging purpose.

Parameters
[in]messagePointer to the MLD message

Definition at line 608 of file mld.c.

◆ mldInit()

error_t mldInit ( NetInterface interface)

MLD initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 65 of file mld.c.

◆ mldLinkChangeEvent()

void mldLinkChangeEvent ( NetInterface interface)

Callback function for link change event.

Parameters
[in]interfaceUnderlying network interface

Definition at line 198 of file mld.c.

◆ mldProcessListenerQuery()

void mldProcessListenerQuery ( NetInterface interface,
Ipv6PseudoHeader pseudoHeader,
const NetBuffer buffer,
size_t  offset,
uint8_t  hopLimit 
)

Process incoming Multicast Listener Query message.

Parameters
[in]interfaceUnderlying network interface
[in]pseudoHeaderIPv6 pseudo header
[in]bufferMulti-part buffer containing the incoming MLD message
[in]offsetOffset to the first byte of the MLD message
[in]hopLimitHop Limit field from IPv6 header

Definition at line 268 of file mld.c.

◆ mldProcessListenerReport()

void mldProcessListenerReport ( NetInterface interface,
Ipv6PseudoHeader pseudoHeader,
const NetBuffer buffer,
size_t  offset,
uint8_t  hopLimit 
)

Process incoming Multicast Listener Report message.

Parameters
[in]interfaceUnderlying network interface
[in]pseudoHeaderIPv6 pseudo header
[in]bufferMulti-part buffer containing the incoming MLD message
[in]offsetOffset to the first byte of the MLD message
[in]hopLimitHop Limit field from IPv6 header

Definition at line 371 of file mld.c.

◆ mldSendListenerDone()

error_t mldSendListenerDone ( NetInterface interface,
Ipv6Addr ipAddr 
)

Send Multicast Listener Done message.

Parameters
[in]interfaceUnderlying network interface
[in]ipAddrIPv6 address specifying the multicast address being left
Returns
Error code

Definition at line 524 of file mld.c.

◆ mldSendListenerReport()

error_t mldSendListenerReport ( NetInterface interface,
Ipv6Addr ipAddr 
)

Send Multicast Listener Report message.

Parameters
[in]interfaceUnderlying network interface
[in]ipAddrIPv6 address specifying the multicast address
Returns
Error code

Definition at line 438 of file mld.c.

◆ mldStartListening()

error_t mldStartListening ( NetInterface interface,
Ipv6FilterEntry entry 
)

Start listening to the address on the interface.

Parameters
[in]interfaceUnderlying network interface
[in]entryIPv6 filter entry identifying the address to listen to
Returns
Error code

Definition at line 79 of file mld.c.

◆ mldStopListening()

error_t mldStopListening ( NetInterface interface,
Ipv6FilterEntry entry 
)

Stop listening to the address on the interface.

Parameters
[in]interfaceUnderlying network interface
[in]entryIPv6 filter entry identifying the multicast address to leave
Returns
Error code

Definition at line 128 of file mld.c.

◆ mldTick()

void mldTick ( NetInterface interface)

MLD timer handler.

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

Parameters
[in]interfaceUnderlying network interface

Definition at line 155 of file mld.c.

Variable Documentation

◆ checksum

uint16_t checksum

Definition at line 93 of file mld.h.

◆ code

uint8_t code

Definition at line 92 of file mld.h.

◆ maxRespDelay

uint16_t maxRespDelay

Definition at line 94 of file mld.h.

◆ mldTickCounter

systime_t mldTickCounter
extern

Definition at line 56 of file mld.c.

◆ multicastAddr

Ipv6Addr multicastAddr

Definition at line 96 of file mld.h.

◆ reserved

uint16_t reserved

Definition at line 95 of file mld.h.

◆ type

uint8_t type

Definition at line 91 of file mld.h.