HTRamsey
diff --git a/‎.github/.cSpellWords.txt‎
Lines changed: 1494 additions & 0 deletions b/‎.github/.cSpellWords.txt‎
Lines changed: 1494 additions & 0 deletions
diff --git a/‎.github/workflows/ci.yml‎
Lines changed: 217 additions & 57 deletions b/‎.github/workflows/ci.yml‎
Lines changed: 217 additions & 57 deletions
diff --git a/‎.github/workflows/formatting.yml‎
Lines changed: 23 additions & 0 deletions b/‎.github/workflows/formatting.yml‎
Lines changed: 23 additions & 0 deletions
diff --git a/‎.github/workflows/release-candidate.yml‎
Lines changed: 1 addition & 1 deletion b/‎.github/workflows/release-candidate.yml‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎.github/workflows/release.yml‎
Lines changed: 14 additions & 2 deletions b/‎.github/workflows/release.yml‎
Lines changed: 14 additions & 2 deletions
diff --git a/‎.github/workflows/uncrustify.yml‎
Lines changed: 0 additions & 74 deletions b/‎.github/workflows/uncrustify.yml‎
Lines changed: 0 additions & 74 deletions
diff --git a/‎.gitignore‎
Lines changed: 16 additions & 0 deletions b/‎.gitignore‎
Lines changed: 16 additions & 0 deletions
diff --git a/‎CMakeLists.txt‎
Lines changed: 20 additions & 3 deletions b/‎CMakeLists.txt‎
Lines changed: 20 additions & 3 deletions
diff --git a/‎GettingStarted_4.0.0-rc3.md‎ renamed to ‎GettingStarted.md‎
Lines changed: 4 additions & 4 deletions b/‎GettingStarted_4.0.0-rc3.md‎ renamed to ‎GettingStarted.md‎
Lines changed: 4 additions & 4 deletions
diff --git a/‎History.txt‎
Lines changed: 51 additions & 2 deletions b/‎History.txt‎
Lines changed: 51 additions & 2 deletions
@@ -0,0 +1,23 @@
+name: Format Pull Request Files
+
+on:
+  issue_comment:
+    types: [created]
+
+env:
+  bashPass: \033[32;1mPASSED -
+  bashInfo: \033[33;1mINFO -
+  bashFail: \033[31;1mFAILED -
+  bashEnd:  \033[0m
+
+jobs:
+  Formatting:
+    name: Run Formatting Check
+    if: ${{ github.event.issue.pull_request &&
+        ( ( github.event.comment.body == '/bot run uncrustify' ) ||
+          ( github.event.comment.body == '/bot run formatting' ) ) }}
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Apply Formatting Fix
+      uses: FreeRTOS/CI-CD-Github-Actions/formatting-bot@main
+      id: check-formatting
@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           ref: ${{ github.event.inputs.commit_id }}
       - name: Configure git identity
 
@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           ref: ${{ github.event.inputs.commit_id }}
       - name: Configure git identity
@@ -53,7 +53,7 @@ jobs:
       - name: Install ZIP tools
         run: sudo apt-get install zip unzip
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           ref: ${{ github.event.inputs.commit_id }}
           path: FreeRTOS-Plus-TCP
@@ -138,3 +138,15 @@ jobs:
           asset_path: ./FreeRTOS-Plus-TCP-${{ github.event.inputs.version_number }}.zip
           asset_name: FreeRTOS-Plus-TCP-${{ github.event.inputs.version_number }}.zip
           asset_content_type: application/zip
+  cleanup:
+    needs:
+      - create-release
+    name: Cleanup
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Delete branch created for Tag by SBOM generator
+        run: |
+          # Delete the branch created for Tag by SBOM generator
+          git push -u origin --delete refs/heads/${{ github.event.inputs.version_number }}
@@ -1,3 +1,19 @@
+# Ignore MacOS file system related.
+**/*.DS_Store*
+
+# Ignore build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Dd]ebug_with_Libslirp/
+[Rr]elease/
+[Rr]eleases/
+[Bb]in/
+[Oo]bj/
+[Ll]og/
+[Ll]ogs/
+[Bb]uild/
+__pycache__/
+
 **/*.d
 **/*.o
 **/*.su
@@ -27,7 +27,7 @@ option(FREERTOS_PLUS_TCP_BUILD_TEST "Build the test for FreeRTOS Plus TCP" OFF)
 #   Optional: set(FREERTOS_PLUS_TCP_COMPILER "" CACHE STRING "" FORCE)
 #   Required: set(FREERTOS_PLUS_TCP_NETWORK_IF "POSIX" CACHE STRING "" FORCE)
 
-# Select the appropriate buffer allocaiton method.
+# Select the appropriate buffer allocation method.
 # See: https://freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/Embedded_Ethernet_Buffer_Management.html
 if (NOT FREERTOS_PLUS_TCP_BUFFER_ALLOCATION)
     message(STATUS "Using default FREERTOS_PLUS_TCP_BUFFER_ALLOCATION = 2")
@@ -58,9 +58,11 @@ set(FREERTOS_PLUS_TCP_NETWORK_IF_LIST
     DRIVER_SAM
     ESP32
     KSZ8851SNL
+    LIBSLIRP
     LPC17xx LPC18xx LPC54018
     M487
     MPS2_AN385
+    MPS3_AN552
     MW300_RD
     PIC32MZEF_ETH PIC32MZEF_WIFI
     POSIX WIN_PCAP  # Native Linux & Windows respectively
@@ -96,12 +98,14 @@ if(NOT FREERTOS_PLUS_TCP_NETWORK_IF IN_LIST FREERTOS_PLUS_TCP_NETWORK_IF_LIST )
         " DRIVER_SAM             Target: Driver SAM         Tested: TODO\n"
         " ESP32                  Target: ESP-32             Tested: TODO\n"
         " KSZ8851SNL             Target: ksz8851snl         Tested: TODO\n"
+        " LIBSLIRP               Target: libslirp           Tested: TODO\n"
         " POSIX                  Target: linux/Posix\n"
         " LPC17xx                Target: LPC17xx            Tested: TODO\n"
         " LPC18xx                Target: LPC18xx            Tested: TODO\n"
         " LPC54018               Target: LPC54018           Tested: TODO\n"
         " M487                   Target: M487               Tested: TODO\n"
         " MPS2_AN385             Target: MPS2_AN385         Tested: TODO\n"
+        " MPS3_AN552             Target: MPS3_AN552"
         " MW300_RD               Target: mw300_rd           Tested: TODO\n"
         " PIC32MZEF_ETH          Target: pic32mzef ethernet Tested: TODO\n"
         " PIC32MZEF_WIFI         Target: pic32mzef Wifi     Tested: TODO\n"
@@ -128,7 +132,7 @@ elseif((FREERTOS_PORT STREQUAL "A_CUSTOM_PORT") AND (NOT TARGET freertos_kernel_
     "   target_include_directories(freertos_plus_tcp_network_if\n"
     "     PUBLIC\n"
     "      .)\n\n"
-    "   taget_link_libraries(freertos_plus_tcp_network_if\n"
+    "   target_link_libraries(freertos_plus_tcp_network_if\n"
     "     PUBLIC\n"
     "       freertos_plus_tcp_port\n"
     "       freertos_plus_tcp_network_if_common\n"
@@ -154,6 +158,7 @@ set(FREERTOS_PLUS_TCP_TEST_CONFIGURATION_LIST
     ENABLE_ALL_IPV6_TCP     # Enable all configuration settings IPv6 TCP
     ENABLE_ALL_IPV4_IPV6    # Enable all configuration settings IPv4 IPv6 UDP
     DISABLE_ALL             # Disable all configuration settings
+    HEADER_SELF_CONTAIN     # Enable header self contain test
     DEFAULT_CONF            # Default (typical) configuration
 )
 if(NOT FREERTOS_PLUS_TCP_TEST_CONFIGURATION IN_LIST FREERTOS_PLUS_TCP_TEST_CONFIGURATION_LIST)
@@ -195,10 +200,22 @@ add_compile_options(
     $<$<COMPILE_LANG_AND_ID:C,Clang,GNU>:-Wall>
     $<$<COMPILE_LANG_AND_ID:C,Clang,GNU>:-Wextra>
     $<$<COMPILE_LANG_AND_ID:C,Clang,GNU>:-Werror>
+    $<$<COMPILE_LANG_AND_ID:C,Clang>:-Wpedantic>
+    $<$<COMPILE_LANG_AND_ID:C,Clang,GNU>:-Wconversion>
     $<$<COMPILE_LANG_AND_ID:C,Clang,GNU>:-Wunused-variable>
     $<$<COMPILE_LANG_AND_ID:C,Clang>:-Weverything>
 
-    # TODO: Add in other Compilers here.
+    # Suppressions required to build clean with clang.
+    $<$<COMPILE_LANG_AND_ID:C,Clang>:-Wno-unused-macros>
+    $<$<COMPILE_LANG_AND_ID:C,Clang>:-Wno-cast-qual>
+    $<$<COMPILE_LANG_AND_ID:C,Clang>:-Wno-switch-enum>
+    $<$<COMPILE_LANG_AND_ID:C,Clang>:-Wno-declaration-after-statement>
+    $<$<COMPILE_LANG_AND_ID:C,Clang>:-Wno-padded>
+    $<$<COMPILE_LANG_AND_ID:C,Clang>:-Wno-missing-variable-declarations>
+    $<$<COMPILE_LANG_AND_ID:C,Clang>:-Wno-covered-switch-default>
+    $<$<COMPILE_LANG_AND_ID:C,Clang>:-Wno-extra-semi-stmt>
+    $<$<COMPILE_LANG_AND_ID:C,Clang>:-Wno-missing-noreturn>
+    $<$<COMPILE_LANG_AND_ID:C,Clang>:-Wno-cast-align>
 )
 
 ########################################################################
 
@@ -1,16 +1,16 @@
-Moving to 4.0.0-rc1/rc2/rc3 from 3.x.x:
+Moving to 4.0.0 from 3.x.x:
 --------------------------------
 
-Version 4.0.0-rc1/rc2/rc3 adds new files to support IPv6 functionality, breaking each file into logically separated IPv4 and IPv6 files. The folder structure of FreeRTOS-Plus-TCP remains unchanged. Build separation is added to make the library modular, enabling users to compile and create a low-footprint binary with only the required functionalities. For more details on supported build combinations, see [History.txt](https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/main/History.txt) .
+Version 4.0.0 adds new files to support IPv6 functionality, breaking each file into logically separated IPv4 and IPv6 files. The folder structure of FreeRTOS-Plus-TCP remains unchanged. Build separation is added to make the library modular, enabling users to compile and create a low-footprint binary with only the required functionalities. For more details on supported build combinations, see [History.txt](https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/main/History.txt) .
 
 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/rc2/rc3, then set the "ipconfigIPv4_BACKWARD_COMPATIBLE" macro to 1 in “FreeRTOSIPConfigDefaults.h” to run the code in backward compatible mode.
+   If you are moving your code from V3.x.x to V4.0.0, 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/rc2/rc3:
+API changes in 4.0.0:
 ----------------------
 
 The changes mentioned below uses ipconfigIPv4_BACKWARD_COMPATIBLE flag to differentiate between old API and new API.
 
@@ -1,3 +1,52 @@
+Documentation and download available at https://www.FreeRTOS.org/
+
+Changes between FreeRTOS-plus-TCP V4.0.0 and V3.1.0 released August 10, 2023
+	+ Unified code for both IPv4 and IPv6 protocols.
+        + Multiple Interface and Multiple Endpoint support
+		1. The stack supports multiple Physical Interfaces.
+		2. The stack also supports multiple endpoints (or Virtual interfaces) on the same physical interface.
+        + New WinSim demo to support IPv4, IPv6 and multi-interface together.
+	(Reference: https://github.com/FreeRTOS/FreeRTOS/tree/main/FreeRTOS-Plus/Demo/FreeRTOS_Plus_TCP_IPv6_Demo/IPv6_Multi_WinSim_demo)
+	+ Build separation feature introduced to achieve low memory footprint. Supported build combinations:
+		    1. IPv4 + UDP
+		    2. IPv4 + UDP + TCP
+		    3. IPv6 + UDP
+		    4. IPv6 + UDP + TCP
+		    5. IPv4 + IPv6 + UDP
+		    6. IPv4 + IPv6 + UDP + TCP
+	+ Support added in FreeRTOS-plus-TCP git repository CI tool to validate various build configurations before PR merge.
+	+ Achieved 100% unit test coverage for both IPv4 and IPv6.
+	+ MISRA c-2012 compliance for both IPv4 and IPv6.
+	+ Addressed several issues observed by Maxwell Protocol tester.
+	+ Memory safety proofs for IPv6 code using[ CBMC automated reasoning tool ] (https://www.cprover.org/cbmc/).
+	+ Stack is Penetration tested and a memory leak issue has been identified and fixed in the process.
+	(Reference: https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/pull/973)
+	+ Improved Documentation:
+		1. Multi-interface and Multi-endpoint documentation.
+		2. Updated stack initialization documentation to support multi-interface and endpoint.
+		(Reference: https://freertos-wordpress.corp.amazon.com/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_Networking_Tutorial_Initialising_TCP.updated.html)
+		3. Code size details for various build configurations
+		(Reference: https://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/index.html).
+		4. Documentation added for IPv6 protocol support.
+		5. Documentation added for various IPv6 functionalities like DHCPv6, ND (Neighbour Discovery), RA (Router Advertisement).
+		6. README added for the network ports.
+
+We thank the following people for their inputs in these enhancements:
+	+ Add mDNS fixes for IPv6. Contributed by @evpopov.
+	+ IP offset calculation improvement. Contributed by @evpopov.
+	+ CCS compiler fix for packed structs. Contributed by @rahul-arasikere.
+	+ Add tasking compiler support. Contributed by @go2sh.
+	+ Add NetworkDown notification support to STM32FXX. Contributed by @zipperowiec.
+	+ CMake changes. Contributed by @phelter.
+	+ STM32Hxx porting fixes. Contributed by @miguelfreitas.
+	+ Allow use of loopback addresses. Contributed by @adam-stamand.
+	+ CBMC proof-running GitHub Action. Contributed by @karkhaz.
+	+ CBMC XML output to enable VSCode debugger. Contributed by @karkhaz.
+	+ vTaskDelay for sleep in the network-interface of xilinx_ultrascale.Contributed by @ChristosZosi.
+	+ Read mac address using FreeRTOS_GetMACAddress(). Contributed by @sayyadumar.
+	+ Minor warning fixes. Contributed by @ChristosZosi.
+	+ Network-interface fix for Xilinx UltraScale port. Contributed by @ChristosZosi.
+
 Changes between 4.0.0-RC3 and 4.0.0-RC2 releases:
 		+ Added memory safety proofs for IPv6 using[ CBMC automated reasoning tool ] ( https:/*www.cprover.org/cbmc/)
 		+ Introduced build separation feature to achieve low memory footprint. Supported build combinations:
@@ -71,7 +120,7 @@ Changes between V2.3.1 and V2.3.2 releases:
 	  instead of being given the eCLOSE_WAIT status. A client socket, which calls
 	  connect() to establish a connection, will receive the eCLOSE_WAIT status,
 	  just like before.
-	+ Fixed a race condition in DHCP state machine which occured when the macro
+	+ Fixed a race condition in DHCP state machine which occurred when the macro
 	  dhcpINITIAL_TIMER_PERIOD was set to a very low value.
 
 Changes between V2.3.0 and V2.3.1 releases:
@@ -291,7 +340,7 @@ Changes between 141019 and 150825
 	+ Introduced ipMAX_IP_TASK_SLEEP_TIME to allow the application writer to
 	  override the default value of 10 seconds.
 	+ Fix:  Correct error in *pxUDPPayloadBuffer_to_NetworkBuffer().
-	+ FreeRTOS_recv() now recognises the FREERTOS_ZERO_COPY flag, which, when
+	+ FreeRTOS_recv() now recognizes the FREERTOS_ZERO_COPY flag, which, when
 	  set, the void *pvBuffer parameter is interpreted as void **pvBuffer.
 	+ FreeRTOS_listen() now returns an error code.  Previously it always
 	  returned 0.