Merge branch 'dev/IPv6_integration' into dev-defines

Author: HTRamsey

GettingStarted_4.0.0-rc1.md

@@ -0,0 +1,60 @@
+Moving to 4.0.0-rc1 from 3.x.x:
+-----------------------------
+In version 4.0.0-rc1, new files have been added to support IPv6 functionality and each file has been broken down into logically separated IPv4 and IPv6 files. The folder structure of FreeRTOS-Plus-TCP has not changed.
+
+Some of the APIs have changed which is illustrated in the section below. However, there is a backward compatibility mode provided as well.
+
+Backward Compatibility Mode:
+---------------------------
+   If you are moving your code from V3.x.x to V4.0.0-rc1, then set the "ipconfigIPv4_BACKWARD_COMPATIBLE" macro to 1 in “FreeRTOSIPConfigDefaults.h” to run the code in backward compatible mode.
+   The "Existing API's" defined in all the API changes below work only when the backward compatibility mode is enabled.
+
+API changes in 4.0.0-rc1:
+----------------------
+Change 1:
+
+   - Existing API: FreeRTOS_IPInit
+      - Backward compatibility with the IPv4 FreeRTOS+TCP V3.x.x which only supports single network interface. This can be used for single  interface IPv4 systems.
+   - New API: FreeRTOS_IPInit_Multi
+      - Supports multiple interfaces. Before calling this function, at least 1 interface and 1 end-point must have been set-up. FreeRTOS_IPInit_Multi() replaces the earlier FreeRTOS_IPInit().
+
+Change 2:
+
+   - Existing API: FreeRTOS_GetAddressConfiguration/FreeRTOS_SetAddressConfiguration
+      - Get/Set the address configuration from the global variables initialised during FreeRTOS_IPInit
+   - New API: FreeRTOS_GetEndPointConfiguration/FreeRTOS_SetEndPointConfiguration
+      - Get/Set the same address configuration from/to the end point
+
+Change 3:
+
+   - Existing API:  FreeRTOS_GetUDPPayloadBuffer
+      - Backward compatibility with the IPv4 FreeRTOS+TCP V3.x.x. This can still be used for IPv4 use cases.
+   - New API:FreeRTOS_GetUDPPayloadBuffer_Multi
+      - A new argument (uint8_t ucIPType) to specify IP type to support both IPv4 and IPv6
+
+Change 4:
+
+   - Existing API: pxFillInterfaceDescriptor
+      - It is there for backward compatibility. The function FreeRTOS_IPInit() will call it to initialise the interface and end-point objects
+   - New API: prefix_pxFillInterfaceDescriptor
+      - where prefix = Network Interface Name
+      - E.g pxWinPcap_FillInterfaceDescriptor
+      - New function with the same functionality
+
+Change 5:
+
+   - Existing API: vApplicationIPNetworkEventHook
+   - New API: vApplicationIPNetworkEventHook_Multi
+      - New argument “struct xNetworkInterface * pxNetworkInterface” added.
+      - ipconfigIPv4_BACKWARD_COMPATIBLE flag is used to differentiate between old API and new API.
+
+**NOTE** : We are NOT considering the APIs changes in FreeRTOS_IP_Private.h for backward compatibility as those are not part of published interface.
+
+Running Demos:
+-------------
+The demos can be found at: https://github.com/FreeRTOS/FreeRTOS/tree/devIPv6/FreeRTOS-Plus/Demo
+
+In all the demos, there is a backward compatibility mode which can be enabled by setting the flag “ipconfigIPv4_BACKWARD_COMPATIBLE” to 1 in the header file “FreeRTOSIPConfigDefaults.h”.
+This flag is by default set to zero.
+
+New IPv6 WinSim Demo: https://github.com/FreeRTOS/FreeRTOS/tree/devIPv6/FreeRTOS-Plus/Demo/FreeRTOS_Plus_TCP_IPv6_Demo/IPv6_Multi_WinSim_demo

History.txt

@@ -1,8 +1,9 @@
 Changes between dev/ipv6_integration branch RC1 and main branch V3.0.0 releases:
         + Unified code for IPv4 and IPv6
-        + Multiple Interface/Endpoint support.
-        + Neighbour Discovery & Router Advertisement.
+        + Multiple Interface/Endpoint support
+	((Reference: https://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/freertostcp-multiple-interfaces.html).
         + New WinSim demo to support both IPv4 and IPv6.
+**Note**- This release does not support ESP32/ M487/ mw300_rd ports yet. This will be released soon.
 
 Changes between V3.0.0 and V2.4.0 releases:
         + Split the source files according to the function the code performs.

README.md

@@ -1,24 +1,26 @@
 ## NOTE - Work In Progress
 
-This branch is for development purpose of merging IPv4 and IPv6 code.
+This branch contains unified IPv4 and IPv6 functionalities.
+Refer to the Getting started Guide (found [here](https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/dev/IPv6_integration/GettingStarted_4.0.0-rc1.md)) for more details.
 
 ## FreeRTOS-Plus-TCP Library
 FreeRTOS-Plus-TCP is a lightweight TCP/IP stack for FreeRTOS. It provides a familiar Berkeley sockets interface, making it as simple to use and learn as possible. FreeRTOS-Plus-TCP's features and RAM footprint are fully scalable, making FreeRTOS-Plus-TCP equally applicable to smaller lower throughput microcontrollers as well as larger higher throughput microprocessors.
 
 This library has undergone static code analysis and checks for compliance with the [MISRA coding standard](https://www.misra.org.uk/). Any deviations from the MISRA C:2012 guidelines are documented under [MISRA Deviations](https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/main/MISRA.md). The library is validated for memory safety and data structure invariance through the [CBMC automated reasoning tool](https://www.cprover.org/cbmc/) for the functions that parse data originating from the network.
 
 ## Getting started
-The easiest way to use FreeRTOS-Plus-TCP is to start with the pre-configured demo application project (found in [this directory](https://github.com/FreeRTOS/FreeRTOS/tree/master/FreeRTOS-Plus/Demo/FreeRTOS_Plus_TCP_Minimal_Windows_Simulator)).  That way you will have the correct FreeRTOS source files included, and the correct include paths configured.  Once a demo application is building and executing you can remove the demo application files, and start to add in your own application source files.  See the [FreeRTOS Kernel Quick Start Guide](https://www.freertos.org/FreeRTOS-quick-start-guide.html) for detailed instructions and other useful links.
+The easiest way to use the 4.0.0-rc1 version of FreeRTOS-Plus-TCP is to refer to to the Getting started Guide (found [here](https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/dev/IPv6_integration/GettingStarted_4.0.0-rc1.md))
+Another way is to start with the pre-configured demo application project (found in [this directory](https://github.com/FreeRTOS/FreeRTOS/tree/devIPv6/FreeRTOS-Plus/Demo/FreeRTOS_Plus_TCP_Minimal_Windows_Simulator)).  That way you will have the correct FreeRTOS source files included, and the correct include paths configured.  Once a demo application is building and executing you can remove the demo application files, and start to add in your own application source files.  See the [FreeRTOS Kernel Quick Start Guide](https://www.freertos.org/FreeRTOS-quick-start-guide.html) for detailed instructions and other useful links.
 
 Additionally, for FreeRTOS-Plus-TCP source code organization refer to the [Documentation](http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_Networking_Tutorial.html), and [API Reference](https://freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/FreeRTOS_TCP_API_Functions.html).
 
-FreeRTOS-Plus-TCP V2.3.2-LTS-Patch-2 [source code](https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/tree/V2.3.2-LTS-Patch-2)(.c .h) is part of the [FreeRTOS 202012.04 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.04-LTS) release.
-
 ### Getting help
 If you have any questions or need assistance troubleshooting your FreeRTOS project, we have an active community that can help on the [FreeRTOS Community Support Forum](https://forums.freertos.org). Please also refer to [FAQ](http://www.freertos.org/FAQHelp.html) for frequently asked questions.
 
 Also see the [Submitting a bugs/feature request](https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/main/.github/CONTRIBUTING.md#submitting-a-bugsfeature-request) section of CONTRIBUTING.md for more details.
 
+**Note:** All the remaining sections are generic and applies to all the versions from V3.0.0 onwards.
+
 ## Upgrading to V3.0.0 and above
 In version 3.0.0 or higher, the folder structure of FreeRTOS-Plus-TCP has changed and the files have been broken down into smaller logically separated modules. This change makes the code more modular and conducive to unit-tests. FreeRTOS-Plus-TCP V3.0.0 improves the robustness, security, and modularity of the library. Version 3.0.0 adds comprehensive unit test coverage for all lines and branches of code and has undergone protocol testing, and penetration testing by AWS Security to reduce the exposure to security vulnerabilities. Additionally, the source files have been moved to a `source` directory. This change requires modification of any existing project(s) to include the modified source files and directories. There are examples on how to use the new files and directory structure. For a windows simulator based example, refer to this [demo](https://github.com/FreeRTOS/FreeRTOS/tree/TCPRefactorDemo/FreeRTOS-Plus/Demo/FreeRTOS_Plus_TCP_Minimal_Windows_Simulator). For an example based on the Xilinx Zynq-7000, use the code in this [branch](https://github.com/aws/amazon-freertos/tree/TCPRefactorDemo) and follow these [instructions](https://docs.aws.amazon.com/freertos/latest/userguide/getting_started_xilinx.html) to build and run the demo.
 

docs/doxygen/config.doxyfile

@@ -48,7 +48,7 @@ PROJECT_NAME           = FreeRTOS-Plus-TCP
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = V3.0.0
+PROJECT_NUMBER         = V4.0.0-rc1
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

manifest.yml

@@ -1,5 +1,5 @@
 name : "FreeRTOS-Plus-TCP"
-version: "V3.0.0"
+version: "V4.0.0-rc1"
 description: "Thread safe FreeRTOS TCP/IP stack working on top of the FreeRTOS-Kernel to implement the TCP/IP protocol. Suitable for microcontrollers."
 license: "MIT"
 dependencies:

source/FreeRTOS_DHCPv6.c

@@ -133,10 +133,10 @@
 
 /** @brief If a lease time is not received, use the default of two days.  48 hours in ticks.
  * Do not use the macro pdMS_TO_TICKS() here as integer overflow can occur. */
-#define dhcpDEFAULT_LEASE_TIME      ( ( 48U * 60U * 60U ) * configTICK_RATE_HZ )
+#define dhcpv6DEFAULT_LEASE_TIME    ( ( 48U * 60U * 60U ) * configTICK_RATE_HZ )
 
 /** @brief Don't allow the lease time to be too short. */
-#define dhcpMINIMUM_LEASE_TIME      ( pdMS_TO_TICKS( 60000U ) )                /* 60 seconds in ticks. */
+#define dhcpv6MINIMUM_LEASE_TIME    ( pdMS_TO_TICKS( 60000U ) )                  /* 60 seconds in ticks. */
 
 /** @brief The function time() counts since 1-1-1970.  The DHCPv6 time-stamp however
  * uses a time stamp that had zero on 1-1-2000. */
@@ -405,11 +405,11 @@ static void vDHCPv6ProcessEndPoint_HandleReply( NetworkEndPoint_t * pxEndPoint,
 
     if( EP_DHCPData.ulLeaseTime == 0U )
     {
-        EP_DHCPData.ulLeaseTime = dhcpDEFAULT_LEASE_TIME;
+        EP_DHCPData.ulLeaseTime = dhcpv6DEFAULT_LEASE_TIME;
     }
-    else if( EP_DHCPData.ulLeaseTime < dhcpMINIMUM_LEASE_TIME )
+    else if( EP_DHCPData.ulLeaseTime < dhcpv6MINIMUM_LEASE_TIME )
     {
-        EP_DHCPData.ulLeaseTime = dhcpMINIMUM_LEASE_TIME;
+        EP_DHCPData.ulLeaseTime = dhcpv6MINIMUM_LEASE_TIME;
     }
     else
     {
@@ -1033,7 +1033,7 @@ static void prvSendDHCPMessage( NetworkEndPoint_t * pxEndPoint )
             xAddress.sin_family = FREERTOS_AF_INET6;
             xAddress.sin_port = FreeRTOS_htons( DHCPv6_SERVER_PORT );
 
-            struct freertos_sockaddr * pxAddress = ( ( sockaddr4_t * ) &( xAddress ) );
+            struct freertos_sockaddr * pxAddress = &( xAddress );
 
             ( void ) FreeRTOS_sendto( EP_DHCPData.xDHCPSocket, ( const void * ) xMessage.ucContents, xMessage.uxIndex, 0, pxAddress, sizeof xAddress );
         }

source/include/FreeRTOSIPConfigDefaults.h

@@ -135,8 +135,7 @@
 /*---------------------------------------------------------------------------*/
 
 #if ( ipconfigUSE_IPv4 == 0 ) || ( ipconfigUSE_IPv6 == 0 )
-    #error "Build separation for both IPv4 and IPv6 is work in progress. \
-    Please enable both ipconfigUSE_IPv4 and ipconfigUSE_IPv6 flags."
+    #error "Build separation for both IPv4 and IPv6 is work in progress. Please enable both ipconfigUSE_IPv4 and ipconfigUSE_IPv6 flags."
 #endif
 
 /*---------------------------------------------------------------------------*/

source/portable/NetworkInterface/STM32Fxx/NetworkInterface.c

@@ -182,16 +182,14 @@ static void prvEthernetUpdateConfig( BaseType_t xForce );
  */
 static BaseType_t prvNetworkInterfaceInput( void );
 
-#if ( ipconfigUSE_LLMNR != 0 ) || ( ipconfigUSE_MDNS != 0 ) || ( ipconfigUSE_IPv6 != 0 )
 
 /*
  * For LLMNR, an extra MAC-address must be configured to
  * be able to receive the multicast messages.
  */
-    static void prvMACAddressConfig( ETH_HandleTypeDef * heth,
-                                     uint32_t ulIndex,
-                                     uint8_t * Addr );
-#endif
+static void prvMACAddressConfig( ETH_HandleTypeDef * heth,
+                                 uint32_t ulIndex,
+                                 uint8_t * Addr );
 
 /* FreeRTOS+TCP/multi :
  * Each network device has 3 access functions:
@@ -452,9 +450,7 @@ BaseType_t xSTM32F_NetworkInterfaceInitialise( NetworkInterface_t * pxInterface
     BaseType_t xResult;
     NetworkEndPoint_t * pxEndPoint;
 
-    #if ( ipconfigUSE_LLMNR != 0 ) || ( ipconfigUSE_MDNS != 0 )
-        BaseType_t xMACEntry = ETH_MAC_ADDRESS1; /* ETH_MAC_ADDRESS0 reserved for the primary MAC-address. */
-    #endif
+    BaseType_t xMACEntry = ETH_MAC_ADDRESS1; /* ETH_MAC_ADDRESS0 reserved for the primary MAC-address. */
 
     if( xMacInitStatus == eMACInit )
     {
@@ -757,28 +753,28 @@ static void prvDMARxDescListInit()
 }
 /*-----------------------------------------------------------*/
 
-#if ( ipconfigUSE_LLMNR != 0 ) || ( ipconfigUSE_MDNS != 0 )
-    static void prvMACAddressConfig( ETH_HandleTypeDef * heth,
-                                     uint32_t ulIndex,
-                                     uint8_t * Addr )
-    {
-        uint32_t ulTempReg;
 
-        ( void ) heth;
+static void prvMACAddressConfig( ETH_HandleTypeDef * heth,
+                                 uint32_t ulIndex,
+                                 uint8_t * Addr )
+{
+    uint32_t ulTempReg;
 
-        /* Calculate the selected MAC address high register. */
-        ulTempReg = 0x80000000ul | ( ( uint32_t ) Addr[ 5 ] << 8 ) | ( uint32_t ) Addr[ 4 ];
+    ( void ) heth;
 
-        /* Load the selected MAC address high register. */
-        ( *( __IO uint32_t * ) ( ( uint32_t ) ( ETH_MAC_ADDR_HBASE + ulIndex ) ) ) = ulTempReg;
+    /* Calculate the selected MAC address high register. */
+    ulTempReg = 0x80000000ul | ( ( uint32_t ) Addr[ 5 ] << 8 ) | ( uint32_t ) Addr[ 4 ];
 
-        /* Calculate the selected MAC address low register. */
-        ulTempReg = ( ( uint32_t ) Addr[ 3 ] << 24 ) | ( ( uint32_t ) Addr[ 2 ] << 16 ) | ( ( uint32_t ) Addr[ 1 ] << 8 ) | Addr[ 0 ];
+    /* Load the selected MAC address high register. */
+    ( *( __IO uint32_t * ) ( ( uint32_t ) ( ETH_MAC_ADDR_HBASE + ulIndex ) ) ) = ulTempReg;
+
+    /* Calculate the selected MAC address low register. */
+    ulTempReg = ( ( uint32_t ) Addr[ 3 ] << 24 ) | ( ( uint32_t ) Addr[ 2 ] << 16 ) | ( ( uint32_t ) Addr[ 1 ] << 8 ) | Addr[ 0 ];
+
+    /* Load the selected MAC address low register */
+    ( *( __IO uint32_t * ) ( ( uint32_t ) ( ETH_MAC_ADDR_LBASE + ulIndex ) ) ) = ulTempReg;
+}
 
-        /* Load the selected MAC address low register */
-        ( *( __IO uint32_t * ) ( ( uint32_t ) ( ETH_MAC_ADDR_LBASE + ulIndex ) ) ) = ulTempReg;
-    }
-#endif /* if ( ipconfigUSE_LLMNR != 0 ) || ( ipconfigUSE_MDNS != 0 ) */
 /*-----------------------------------------------------------*/
 
 static BaseType_t xSTM32F_NetworkInterfaceOutput( NetworkInterface_t * pxInterface,

test/build-combination/Common/main.c

@@ -123,9 +123,14 @@ int main( void )
     return 0;
 }
 /*-----------------------------------------------------------*/
-
-void vApplicationIPNetworkEventHook_Multi( eIPCallbackEvent_t eNetworkEvent,
-                                           struct xNetworkEndPoint * pxEndPoint )
+/* *INDENT-OFF* */
+#if ( ipconfigIPv4_BACKWARD_COMPATIBLE == 1 )
+    void vApplicationIPNetworkEventHook( eIPCallbackEvent_t eNetworkEvent )
+#else
+    void vApplicationIPNetworkEventHook_Multi( eIPCallbackEvent_t eNetworkEvent,
+                                               struct xNetworkEndPoint * pxEndPoint )
+#endif
+/* *INDENT-ON* */
 {
     static BaseType_t xTasksAlreadyCreated = pdFALSE;
 
@@ -314,3 +319,11 @@ void vApplicationPingReplyHook( ePingReplyStatus_t eStatus,
 {
     /* Provide a stub for this function. */
 }
+
+#if ( ipconfigUSE_IPv6 != 0 ) && ( ipconfigUSE_DHCPv6 != 0 )
+    /* DHCPv6 needs a time-stamp, seconds after 1970. */
+    uint32_t ulApplicationTimeHook( void )
+    {
+        return time( NULL );
+    }
+#endif