Adds defines for MLD packets like the Multicast Listener Report.

Emil Popov · Emil Popov · commit 9ea0f53e7a10 · 2023-10-19T09:18:33.000-04:00
Adds a function to generate and send MLD v1 Report packets.
Begins sending unsolicited MLD Reports on a hard-coded 15s interval.
Generates an MLD report for the solicited-node multicast addresses corresponding to all unicast IPv6 addresses
Uncrustify + lots of refactoring
diff --git a/source/FreeRTOS_IGMP.c b/source/FreeRTOS_IGMP.c
diff --git a/source/FreeRTOS_IP.c b/source/FreeRTOS_IP.c
@@ -659,8 +659,66 @@ TaskHandle_t FreeRTOS_GetIPTaskHandle( void )
  */
 void vIPNetworkUpCalls( struct xNetworkEndPoint * pxEndPoint )
 {
+    #if ( ipconfigSUPPORT_IP_MULTICAST != 0 )
+        MCastReportData_t * pxMRD;
+        IPv6_Type_t xAddressType;
+        MACAddress_t xMACAddress;
+    #endif /* ( ipconfigSUPPORT_IP_MULTICAST != 0 ) */
+
     pxEndPoint->bits.bEndPointUp = pdTRUE_UNSIGNED;
 
+    #if ( ipconfigSUPPORT_IP_MULTICAST != 0 )
+        if( pxEndPoint->bits.bIPv6 == pdTRUE_UNSIGNED )
+        {
+            /* Now that the network is up, pxEndPoint->ipv6_settings should hold the actual address of this
+             * end-point. For unicast addresses, generate the solicited-node multicast address that corresponds
+             * to the address and generate an MLD report for it.
+             * ToDo: Figure out what the proper place is to remove multicast addresses that are no longer valid. For
+             * example when a DHCPv6 lease expires. */
+            xAddressType = xIPv6_GetIPType( &( pxEndPoint->ipv6_settings.xIPAddress ) );
+
+            if( ( xAddressType == eIPv6_LinkLocal ) || ( xAddressType == eIPv6_SiteLocal ) || ( xAddressType == eIPv6_Global ) )
+            {
+                if( NULL != ( pxMRD = ( MCastReportData_t * ) pvPortMalloc( sizeof( MCastReportData_t ) ) ) )
+                {
+                    listSET_LIST_ITEM_OWNER( &( pxMRD->xListItem ), ( void * ) pxMRD );
+                    pxMRD->pxEndPoint = pxEndPoint;
+                    pxMRD->xMCastGroupAddress.xIs_IPv6 = pdTRUE_UNSIGNED;
+
+                    /* Generate the solicited-node multicast address in the form of
+                     * ff02::1:ffnn:nnnn, where nn:nnnn are the last 3 bytes of the IPv6 address. */
+                    pxMRD->xMCastGroupAddress.xIPAddress.xIP_IPv6.ucBytes[ 0 ] = 0xFFU;
+                    pxMRD->xMCastGroupAddress.xIPAddress.xIP_IPv6.ucBytes[ 1 ] = 0x02U;
+                    ( void ) memset( &pxMRD->xMCastGroupAddress.xIPAddress.xIP_IPv6.ucBytes[ 2 ], 0x00, 9 );
+                    pxMRD->xMCastGroupAddress.xIPAddress.xIP_IPv6.ucBytes[ 11 ] = 0x01U;
+                    pxMRD->xMCastGroupAddress.xIPAddress.xIP_IPv6.ucBytes[ 12 ] = 0xFFU;
+                    ( void ) memcpy( &pxMRD->xMCastGroupAddress.xIPAddress.xIP_IPv6.ucBytes[ 13 ], &pxEndPoint->ipv6_settings.xIPAddress.ucBytes[ 13 ], 3 );
+
+                    if( pdTRUE != xAddIGMPReportToList( pxMRD ) )
+                    {
+                        vPortFree( pxMRD );
+                        pxMRD = NULL;
+                    }
+                    else
+                    {
+                        /* The report was consumed, therfore it was added to the list. Tell the network
+                         * driver to begin receiving the associated MAC address */
+                        if( pxEndPoint->pxNetworkInterface && ( pxEndPoint->pxNetworkInterface->pfAddMulticastMAC != NULL ) )
+                        {
+                            xMACAddress.ucBytes[ 0 ] = 0x33;
+                            xMACAddress.ucBytes[ 1 ] = 0x33;
+                            xMACAddress.ucBytes[ 2 ] = 0xFF;
+                            xMACAddress.ucBytes[ 3 ] = pxEndPoint->ipv6_settings.xIPAddress.ucBytes[ 13 ];
+                            xMACAddress.ucBytes[ 4 ] = pxEndPoint->ipv6_settings.xIPAddress.ucBytes[ 14 ];
+                            xMACAddress.ucBytes[ 5 ] = pxEndPoint->ipv6_settings.xIPAddress.ucBytes[ 15 ];
+                            pxEndPoint->pxNetworkInterface->pfAddMulticastMAC( xMACAddress.ucBytes );
+                        }
+                    }
+                }
+            }
+        }
+    #endif /* ( ipconfigSUPPORT_IP_MULTICAST != 0 ) */
+
     #if ( ipconfigUSE_NETWORK_EVENT_HOOK == 1 )
     #if ( ipconfigIPv4_BACKWARD_COMPATIBLE == 1 )
         {
diff --git a/source/FreeRTOS_IPv6.c b/source/FreeRTOS_IPv6.c
@@ -386,7 +386,7 @@ BaseType_t xIsIPv6AllowedMulticast( const IPv6_Address_t * pxIPAddress )
 /**
  * @brief Compares 2 IPv6 addresses and checks if the one
  * on the left can handle the one on right. Note that 'xCompareIPv6_Address' will also check if 'pxRight' is
- * the special unicast address: ff02::1:ffnn:nnnn, where nn:nnnn are
+ * the special multicast address: ff02::1:ffnn:nnnn, where nn:nnnn are
  * the last 3 bytes of the IPv6 address.
  *
  * @param[in] pxLeft First IP address.
@@ -410,6 +410,7 @@ BaseType_t xCompareIPv6_Address( const IPv6_Address_t * pxLeft,
         ( pxRight->ucBytes[ 12 ] == 0xffU ) )
     {
         /* This is an LLMNR address. */
+        /* _EP_: I don't think this is LLMNR. Did someone mean to say "the solicited-node multicast address" ? */
         xResult = memcmp( &( pxLeft->ucBytes[ 13 ] ), &( pxRight->ucBytes[ 13 ] ), 3 );
     }
     else
diff --git a/source/FreeRTOS_Sockets.c b/source/FreeRTOS_Sockets.c
@@ -6442,12 +6442,12 @@ void * pvSocketGetSocketID( const ConstSocket_t xSocket )
 
                    if( ( pxSocket->bits.bIsIPv6 == pdFALSE_UNSIGNED ) || ( pxSocket->ucProtocol != ( uint8_t ) FREERTOS_IPPROTO_UDP ) || ( uxOptionLength != sizeof( BaseType_t ) ) )
                    {
-                       break;  /* will return -pdFREERTOS_ERRNO_EINVAL */
+                       break; /* will return -pdFREERTOS_ERRNO_EINVAL */
                    }
 
                    if( ( xValue < -1 ) || ( xValue > 255 ) )
                    {
-                       break;  /* will return -pdFREERTOS_ERRNO_EINVAL */
+                       break; /* will return -pdFREERTOS_ERRNO_EINVAL */
                    }
                    else if( xValue == -1 )
                    {
diff --git a/source/include/FreeRTOS_IGMP.h b/source/include/FreeRTOS_IGMP.h
@@ -92,6 +92,9 @@
     void vRemoveIGMPReportFromList( struct freertos_ip_mreq * pMCastGroup );
     BaseType_t xAddIGMPReportToList( MCastReportData_t * pNewEntry );
     eFrameProcessingResult_t eProcessIGMPPacket( NetworkBufferDescriptor_t * const pxNetworkBuffer );
+    BaseType_t xSendMulticastListenerReport_v1( const IPv6_Address_t * pxGroupAddress,
+                                                NetworkEndPoint_t * pxEndPoint,
+                                                TickType_t uxBlockTimeTicks );
 
 
     #ifdef __cplusplus
diff --git a/source/include/FreeRTOS_IPv6.h b/source/include/FreeRTOS_IPv6.h
@@ -54,10 +54,13 @@
 #define ipICMP_PARAMETER_PROBLEM_IPv6            ( ( uint8_t ) 4U )
 #define ipICMP_PING_REQUEST_IPv6                 ( ( uint8_t ) 128U )
 #define ipICMP_PING_REPLY_IPv6                   ( ( uint8_t ) 129U )
+#define ipICMP_MULTICAST_LISTENER_QUERY          ( ( uint8_t ) 130U )
+#define ipICMP_MULTICAST_LISTENER_REPORT_V1      ( ( uint8_t ) 131U )
 #define ipICMP_ROUTER_SOLICITATION_IPv6          ( ( uint8_t ) 133U )
 #define ipICMP_ROUTER_ADVERTISEMENT_IPv6         ( ( uint8_t ) 134U )
 #define ipICMP_NEIGHBOR_SOLICITATION_IPv6        ( ( uint8_t ) 135U )
 #define ipICMP_NEIGHBOR_ADVERTISEMENT_IPv6       ( ( uint8_t ) 136U )
+#define ipICMP_MULTICAST_LISTENER_REPORT_V2      ( ( uint8_t ) 143U )
 
 
 #define ipIPv6_EXT_HEADER_HOP_BY_HOP             0U
@@ -113,7 +116,7 @@ extern void FreeRTOS_ClearND( void );
 BaseType_t xIsIPv6AllowedMulticast( const IPv6_Address_t * pxIPAddress );
 
 /* Note that 'xCompareIPv6_Address' will also check if 'pxRight' is
- * the special unicast address: ff02::1:ffnn:nnnn, where nn:nnnn are
+ * the special multicast address: ff02::1:ffnn:nnnn, where nn:nnnn are
  * the last 3 bytes of the IPv6 address. */
 BaseType_t xCompareIPv6_Address( const IPv6_Address_t * pxLeft,
                                  const IPv6_Address_t * pxRight,
diff --git a/source/include/FreeRTOS_IPv6_Private.h b/source/include/FreeRTOS_IPv6_Private.h
@@ -212,6 +212,62 @@ typedef struct xICMPRouterSolicitation_IPv6 ICMPRouterSolicitation_IPv6_t;
     typedef struct xICMPPrefixOption_IPv6 ICMPPrefixOption_IPv6_t;
 #endif /* ipconfigUSE_RA != 0 */
 
+#if ( ipconfigSUPPORT_IP_MULTICAST != 0 )
+    #include "pack_struct_start.h"
+    struct xIP_HOP_BY_HOP_EXT_ROUTER_ALERT_IPv6
+    {
+        uint8_t ucNextHeader;      /**< Next header: TCP, UDP, or ICMP.                                            0 +  1 =  1 */
+        uint8_t ucHeaderExtLength; /**< Length of this header in 8-octet units, not including the first 8 octets.  1 +  1 =  2 */
+        struct
+        {
+            uint8_t ucType;
+            uint8_t ucLength;
+            uint16_t usValue;
+        }
+        xRouterAlert;
+        struct
+        {
+            uint8_t ucType;
+            uint8_t ucLength;
+        }
+        xPadding;
+    }
+    #include "pack_struct_end.h"
+    typedef struct xIP_HOP_BY_HOP_EXT_ROUTER_ALERT_IPv6 IPHopByHopExtRouterAlert_IPv6_t;
+
+    #include "pack_struct_start.h"
+    struct xICMPv6_MLD_REPORTv1
+    {
+        uint8_t ucTypeOfMessage;      /**< The message type.     0 +  1 = 1 */
+        uint8_t ucTypeOfService;      /**< Type of service.      1 +  1 = 2 */
+        uint16_t usChecksum;          /**< Checksum.             2 +  2 = 4 */
+        uint16_t usMaxResponseDelay;  /**< Max Response Delay.   4 +  2 = 6 */
+        uint16_t usReserved;          /**< Reserved.             6 +  2 = 8 */
+        IPv6_Address_t xGroupAddress; /**< The IPv6 address.     8 + 16 = 24 */
+    }
+    #include "pack_struct_end.h"
+    typedef struct xICMPv6_MLD_REPORTv1 ICMPv6_MLDReportv1_t;
+
+    struct xICMPv6_MLD_REPORTv1_PACKET
+    {
+        EthernetHeader_t xEthernetHeader;          /*  0 + 14 = 14 */
+        IPHeader_IPv6_t xIPHeader;                 /* 14 + 40 = 54 */
+        IPHopByHopExtRouterAlert_IPv6_t xRAOption; /* 54 +  8 = 62 */
+        ICMPv6_MLDReportv1_t xICMPv6_MLDReport;    /* 62 + 24 = 86 */
+    }
+    #include "pack_struct_end.h"
+    typedef struct xICMPv6_MLD_REPORTv1_PACKET MLDReportPacket_v1_t;
+
+/** @brief Options that can be sent in a Multicast Listener Report packet.
+ * more info at https://www.rfc-editor.org/rfc/rfc2711#section-2.0 */
+    #define ipROUTER_ALERT_VALUE_MLD     0
+
+/** from https://www.iana.org/assignments/ipv6-parameters/ipv6-parameters.xhtml#ipv6-parameters-2 */
+    #define ipHOP_BY_HOP_ROUTER_ALERT    5
+    #define ipHOP_BY_HOP_PadN            1
+
+#endif /* ( ipconfigSUPPORT_IP_MULTICAST != 0 ) */
+
 /*-----------------------------------------------------------*/
 /* Nested protocol packets.                                  */
 /*-----------------------------------------------------------*/
diff --git a/source/portable/NetworkInterface/DriverSAM/NetworkInterface.c b/source/portable/NetworkInterface/DriverSAM/NetworkInterface.c
@@ -188,7 +188,7 @@ static uint32_t prvEMACRxPoll( void );
 
 static BaseType_t prvSAM_NetworkInterfaceInitialise( NetworkInterface_t * pxInterface );
 static BaseType_t prvSAM_NetworkInterfaceOutput( NetworkInterface_t * pxInterface,
-                                                 NetworkBufferDescriptor_t * const pxBuffer,
+                                                 NetworkBufferDescriptor_t * const pxDescriptor,
                                                  BaseType_t bReleaseAfterSend );
 static BaseType_t prvSAM_GetPhyLinkStatus( NetworkInterface_t * pxInterface );
 
@@ -741,21 +741,6 @@ static BaseType_t prvGMACInit( NetworkInterface_t * pxInterface )
         }
         #endif /* ipconfigUSE_MDNS */
 
-        for( pxEndPoint = FreeRTOS_FirstEndPoint( pxMyInterface );
-             pxEndPoint != NULL;
-             pxEndPoint = FreeRTOS_NextEndPoint( pxMyInterface, pxEndPoint ) )
-        {
-            if( pxEndPoint->bits.bIPv6 != pdFALSE_UNSIGNED )
-            {
-                /* Since this is an IPv6 end point, add the solicited-node MAC address. */
-                uint8_t ucMACAddress[ 6 ] = { 0x33, 0x33, 0xff, 0, 0, 0 };
-
-                ucMACAddress[ 3 ] = pxEndPoint->ipv6_settings.xIPAddress.ucBytes[ 13 ];
-                ucMACAddress[ 4 ] = pxEndPoint->ipv6_settings.xIPAddress.ucBytes[ 14 ];
-                ucMACAddress[ 5 ] = pxEndPoint->ipv6_settings.xIPAddress.ucBytes[ 15 ];
-                prvAddMulticastMACAddress( ucMACAddress );
-            }
-        }
     }
     #endif /* ipconfigUSE_IPv6 */
 
@@ -848,7 +833,7 @@ static void prvAddMulticastMACAddress( const uint8_t * ucMacAddress )
 
     vTaskSuspendAll();
 
-    /* If the bin counter corresponding to this mac address has is already non-zero, */
+    /* If the bin counter corresponding to this mac address is already non-zero, */
     /* a multicast address with the same hash has already been added, so there's nothing more to do. */
     if( 0 == prvAddressHashCounters[ ucBinNumber ] )
     {

Original file line number	Diff line number	Diff line change
`@@ -386,7 +386,7 @@ BaseType_t xIsIPv6AllowedMulticast( const IPv6_Address_t * pxIPAddress )`
`386`	`386`	`/**`
`387`	`387`	`* @brief Compares 2 IPv6 addresses and checks if the one`
`388`	`388`	`* on the left can handle the one on right. Note that 'xCompareIPv6_Address' will also check if 'pxRight' is`
`389`		`- * the special unicast address: ff02::1:ffnn:nnnn, where nn:nnnn are`
	`389`	`+ * the special multicast address: ff02::1:ffnn:nnnn, where nn:nnnn are`
`390`	`390`	`* the last 3 bytes of the IPv6 address.`
`391`	`391`	`*`
`392`	`392`	`* @param[in] pxLeft First IP address.`
`@@ -410,6 +410,7 @@ BaseType_t xCompareIPv6_Address( const IPv6_Address_t * pxLeft,`
`410`	`410`	`( pxRight->ucBytes[ 12 ] == 0xffU ) )`
`411`	`411`	`{`
`412`	`412`	`/* This is an LLMNR address. */`
	`413`	`+ /* _EP_: I don't think this is LLMNR. Did someone mean to say "the solicited-node multicast address" ? */`
`413`	`414`	`xResult = memcmp( &( pxLeft->ucBytes[ 13 ] ), &( pxRight->ucBytes[ 13 ] ), 3 );`
`414`	`415`	`}`
`415`	`416`	`else`
Original file line number	Diff line number	Diff line change
`@@ -6442,12 +6442,12 @@ void * pvSocketGetSocketID( const ConstSocket_t xSocket )`
`6442`	`6442`
`6443`	`6443`	`if( ( pxSocket->bits.bIsIPv6 == pdFALSE_UNSIGNED ) \|\| ( pxSocket->ucProtocol != ( uint8_t ) FREERTOS_IPPROTO_UDP ) \|\| ( uxOptionLength != sizeof( BaseType_t ) ) )`
`6444`	`6444`	`{`
`6445`		`- break; /* will return -pdFREERTOS_ERRNO_EINVAL */`
	`6445`	`+ break; /* will return -pdFREERTOS_ERRNO_EINVAL */`
`6446`	`6446`	`}`
`6447`	`6447`
`6448`	`6448`	`if( ( xValue < -1 ) \|\| ( xValue > 255 ) )`
`6449`	`6449`	`{`
`6450`		`- break; /* will return -pdFREERTOS_ERRNO_EINVAL */`
	`6450`	`+ break; /* will return -pdFREERTOS_ERRNO_EINVAL */`
`6451`	`6451`	`}`
`6452`	`6452`	`else if( xValue == -1 )`
`6453`	`6453`	`{`