V4.1.0

Changes between FreeRTOS-plus-TCP V4.1.0 and V4.0.0 released March 8, 2024:

• Add new Network Interface for Corstone-300 FVP (MPS3_AN552).
  We thank @urutva for their contribution.
• Add new loopback Network Interface.
  We thank @htibosch for their contribution.
• Add FreeRTOS_get_tx_base() API to return the TCP Tx stream buffer pointer.
  We thank @htibosch for their contribution.
• Add FreeRTOS_InterfaceEPInSameSubnet_IPv6 API to find an IPv6 endpoint on
  the given interface that is in the same subnet as the given IP address.
• Add checks to prevent potential integer overflow in the buffer
  allocation APIs.
• Improve performance by removing redundant critical sections.
  We thank @htibosch for their contribution.
• Improve performance on 64-bit targets by correctly setting
  ipBUFFER_PADDING to satisfy the architecture’s alignment requirements.
  We thank @htibosch for their contribution.
• Improve FreeRTOS_send() API performance by not iterating more times than
  necessary when trying to send data.
  We thank @htibosch for their contribution.
• Update the Neighbour Discovery cache behavior to overwrite the oldest
  entry when the cache is full. We thank @evpopov for their contribution.
• Update the FreeRTOS_get_tx_head() API to create the TCP Tx stream buffer
  if it wasn't already created for the given socket.
• FreeRTOS_GetIPType is now always available, regardless of the value of
  ipconfigUSE_TCP. We thank @HTRamsey for their contribution.
• Improve tracing support by adding more trace macros.
  We thank @HTRamsey for their contribution.
• Add support for multiple endpoints in STM32Hxx Network Interface.
  Earlier it was capable of handling upto 3 endpoints only.
• Fix potential NULL pointer dereference when a packet from a subnet other
  than the endpoint's subnet is received on an endpoint that has no gateway
  configured. We thank @htibosch for their contribution.
• Fix TCP zero-copy functionality by removing incorrect NULL check for
  pvBuffer parameter in the FreeRTOS_Send API.
  We thank @evpopov for their contribution.
• Fix the network buffer leak in the Neighbour Discovery (ND) code.
  We thank @htibosch for their contribution.
• ARP requests are now sent only on the endpoint with IP address in the same
  subnet as the ARP request’s target address. Earlier ARP requests were sent
  over all the available endpoints.
  We thank @evpopov for their contribution.
• Neighbor Solicitation (NS) responses are now correctly sent on the same
  endpoint on which the Neighbor Solicitation request is received.
  Earlier, it could be sent out on a wrong interface when multiple IPv6
  Link Local endpoints were present on different interfaces.
  We thank @evpopov for their contribution.
• Responses to mDNS/LLMNR/NBNS requests are now sent on the the same
  endpoint on which the request was received. Earlier, it could be sent out
  on a wrong endpoint. We thank @evpopov for their contribution.
• Fix size calculation in the neighbor solicitation handling code to avoid a
  buffer reallocation always. We thank @evpopov for their contribution.
• Fix FreeRTOS_getaddrinfo_a API to use the address family supplied in
  xHints parameter instead of always using IPv6.
  We thank @evpopov for their contribution.
• Fix IPv4 incoming packet filtering logic to correctly filter out unicast
  packets not destined to the device, when
  ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES is enabled.
  We thank @evpopov for their contribution.
• Improve error handling in STM32H7xx Network Interface.
  We thank @htibosch for their contribution.
• Update the IPv4 packet filtering logic to correctly discard bad loopback
  packets originating outside of the network.
• Ensure that the hostname string in DNS resolution code is NULL terminated,
  even when the destination buffer is not large enough to hold the complete
  string. We thank @bjsowa for their contribution.
• Fix the network down and up process to correctly restart DHCP/RA timers.
  We thank @bjsowa for their contribution.
• Fix SAME70 Network Interface to correctly release Tx semaphore when the
  network interface fails to transmit.
  We thank @evpopov for their contribution.
• Update NXP1060 Network Interface to handle network cable disconnection.
  We thank @microcris for their contribution.
• Update the alignment specifier in TM4C Network Interface to make it
  compatible with both CCS and GCC compilers.
  We thank @jonathangjertsen for their contribution.
• Fix minimum length check for ICMP/ping packets.
  We thank @htibosch for their contribution.
• Fix received packet length calculation in the SAM Network Interface.
  We thank @htibosch for their contribution.
• Remove obsolete structs xNetworkAddressing and xDefaultAddressing.
  We thank @evpopov for their contribution.
• Fix compilation with Clang 17 and updated log output.
  We thank @Mixaill for their contribution.
• Fix compiler warnings with the -Wpedantic option.
  We thank @Mixaill for their contribution.
• Fix compiler warnings in the SAM Network Interface.
  We thank @Peter-Herrmann for their contribution.
• Streamline the usage of const in stream buffer APIs.
  We thank @HTRamsey for their contribution.
• Debug logs, printed using FreeRTOS_debug_printf, are now correctly
  guarded using the macro ipconfigHAS_DEBUG_PRINTF.
  We thank @microcris for their contribution.
• Add the LIBSLIRP Network Interface to be available in the CMakelists
  Network Interface selection. We thank @bjsowa for their contribution.
• Move static assert definition to a common header file to make it available
  to all the source files. Also, remove redundant macro check definitions.
  We thank @HTRamsey for their contribution.
• Remove the xCheckLoopback function. It is no longer needed as we now
  have a loopback interface. We thank @htibosch for their contribution.

V4.0.0

Changes between FreeRTOS-plus-TCP V4.0.0 released on August 14, 2023 and V3.1.0 :

• 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.
• 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.
• Stack is Penetration tested and a memory leak issue has been identified and fixed in the process.
  (Reference: #973)
• Improved Documentation:
  1. Multi-interface and Multi-endpoint documentation.
  2. Updated stack initialization documentation to support multi-interface and endpoint.
  3. Code size details for various build configurations
  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.

V3.1.0

Release V3.1.0 of the FreeRTOS-Plus-TCP Library.

Changes between V3.0.0 and V3.1.0 releases:

• Fixed a bug in the Connect function where multiple SYN and RST packet combinations can
  lead to orphaned sockets.
• Added network interface support for NetifSlirp.

V3.0.0

Changes between V3.0.0 and V2.4.0 releases:
+ Split the source files according to the function the code performs.
This makes the code modular and allows full unit-test coverage.
+ Improved RFC compliance.
+ Improved MISRA compliance.

Helpful links to help you upgrade to V3.0.0
+ https://github.com/FreeRTOS/FreeRTOS-plus-tcp#generating-pre-v300-folder-structure-for-backward-compatibility
+ https://www.freertos.org/2022/08/the-freertos-plus-tcp-library-is-now-more-robust-and-secure.html

V2.3.2 LTS Patch 2

Changes between V2.3.2 LTS Patch 1 and V2.3.2 LTS Patch 2

• Updated the maximum limit on the number of bytes which can be requested
  when using BufferAllocation2.c

V2.4.0

Changes between V2.3.4 and V2.4.0 releases:
+ Updated the maximum limit on the number of bytes which can be requested
when using BufferAllocation2.c
+ Improved MISRA compliance.
+ Added minor bug fixes to various network interfaces.
+ Improved RFC Compliance.

V2.3.3 Patch 1

Updated FreeRTOS_inet_pton4() so it rejects IP addresses that
have leading zeros. Previously, if the IP address had leading
zeros, perhaps because it was entered in octal format, the
address was interpreted as decimal (the leading zeros were
stripped). That could result in the function returning an
unexpected IP address.

V2.3.4

FreeRTOS+TCP only. Version 2.3.4.

Changes between V2.3.3 and V2.3.4 releases:
+ Added a check in BufferAllocation_2.c to ensure adding (2 +
ipBUFFER_PADDING) bytes to the requested allocation size does
not cause an integer overflow. Thanks to Bernard Lebel
(RMDS Innovation) reporting this potential issue.
+ Updated FreeRTOS_inet_pton4() so it rejects IP addresses that
have leading zeros. Previously, if the IP address had leading
zeros, perhaps because it was entered in octal format, the
address was interpreted as decimal (the leading zeros were
stripped). That could result in the function returning an
unexpected IP address.
+ Added logic to clear flags of a stored TCP packet to avoid
sending incorrect flags when receiving incorrect packets from
the peer.
+ Fixed the IP header checksum calculation of ICMP response.

V2.3.2 LTS Patch 1

Changes between V2.3.2 and V2.3.2 LTS Patch 1

+ In BufferAllocation_2.c
   (https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/main/portable/BufferManagement/BufferAllocation_2.c),
   there is an unchecked possible addition overflow when calculating the size of the block
   of memory to be allocated for a network buffer that could result in the size overflowing
   and the allocation returning success but allocating only a fraction of the memory asked 
   for. With default settings, this would only occur when attempting to allocate within
   12 bytes of 4 GB. Thanks to Bernard Lebel (RMDS Innovation) for reporting this potential
   issue.
+ Update FreeRTOS_inet_pton4() so it rejects IP addresses that have leading zeros.
   Previously, if the IP address had leading zeros, perhaps because it was entered in octal
   format, the address was interpreted as decimal (the leading zeros were stripped). That
   could result in the function returning an unexpected IP address, and so also to unwanted
   behavior.

V2.3.3

Update History.txt to reflect the latest changes. (#267)

* Update history.txt

* Remove trailing whitespace

* Update the wording in the history file.