Add declarations and comments

tony-josi-aws · Feb 28, 2024 · 148f580 · 148f580
1 parent 49f7bb3
commit 148f580
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/source/FreeRTOS_Routing.c b/source/FreeRTOS_Routing.c
@@ -586,6 +586,15 @@ struct xIPv6_Couple
 
     #if ( ipconfigUSE_IPv6 != 0 )
 
+/**
+ * @brief Find an end-point that handles a given IPv6-address on a given interface.
+ *
+ * @param[in] pxInterface Only end-points that have this interface are returned, unless
+ *                         pxInterface is NULL.
+ * @param[in] pxIPAddress The IPv6-address for which an end-point is looked-up.
+ * @param[in] ulWhere For debug logging
+ * @return An end-point that has the same network mask as the given IP-address.
+ */
    NetworkEndPoint_t * FreeRTOS_InterfaceEndPointOnNetMask_IPv6( const NetworkInterface_t * pxInterface,
                                                              const IPv6_Address_t * pxIPAddress,
                                                              uint32_t ulWhere )

diff --git a/source/include/FreeRTOS_Routing.h b/source/include/FreeRTOS_Routing.h
@@ -248,13 +248,21 @@
                                                         uint32_t ulWhere );
 
 /*
- * Find the best fitting end-point to reach a given IP-address on a given interface
+ * Find the best fitting IPv4 end-point to reach a given IP-address on a given interface
  * 'ulWhere' is temporary and or debugging only.
  */
     NetworkEndPoint_t * FreeRTOS_InterfaceEndPointOnNetMask( const NetworkInterface_t * pxInterface,
                                                              uint32_t ulIPAddress,
                                                              uint32_t ulWhere );
 
+/*
+ * Find the best fitting IPv6 end-point to reach a given IP-address on a given interface
+ * 'ulWhere' is temporary and or debugging only.
+ */
+   NetworkEndPoint_t * FreeRTOS_InterfaceEndPointOnNetMask_IPv6( const NetworkInterface_t * pxInterface,
+                                                             const IPv6_Address_t * pxIPAddress,
+                                                             uint32_t ulWhere );
+
     #if ( ipconfigUSE_IPv6 != 0 )
         NetworkEndPoint_t * FreeRTOS_FindEndPointOnNetMask_IPv6( const IPv6_Address_t * pxIPv6Address );
     #endif /* ipconfigUSE_IPv6 */