]> git.sur5r.net Git - freertos/blob - FreeRTOS-Labs/Source/FreeRTOS-Plus-TCP/History.txt
Update TCP to last release versions in preparation for kernel V10.3.0 release.
[freertos] / FreeRTOS-Labs / Source / FreeRTOS-Plus-TCP / History.txt
1 Changes between 180821 and TBD.\r
2         Currently FreeRTOS+TCP files under this directory have version number "2.2.x Labs copy". \r
3         Please be aware that the projects under FreeRTOS-Labs are experimental and in working \r
4         progress. \r
5 \r
6 Changes between 160919 and 180821 releases:\r
7 \r
8         + Multiple security improvements and fixes in packet parsing routines, DNS\r
9           caching, and TCP sequence number and ID generation.\r
10         + Disable NBNS and LLMNR by default.\r
11         + Add TCP hang protection by default.\r
12 \r
13 We thank Ori Karliner of Zimperium zLabs Team for reporting these issues.\r
14 \r
15 Changes between 160908 and 160919 releases:\r
16 \r
17         + Add a NULL check before attempting to close the DHCP socket.  [Prior to\r
18           160823 the IP task closed the DHCP socket by calling a public API function\r
19           - which checked for the socket being NULL.  This was changed to call a\r
20           local private function, which did not have a NULL check, in place of the\r
21           public API function.]\r
22         + Various [internal only] naming changes to better comply with the FreeRTOS\r
23           naming conventions.\r
24         + Improvements to the Zynq network driver.  DMA transmission buffers now use\r
25           a counting semaphore. When all TX-buffers are in-use, the IP-task will\r
26           block momentarily until a TX-buffer becomes available.\r
27         + Experimental implementation of the TCP window scaling protocol.  The\r
28           scaling option will always be offered, at least with a factor 1. If the\r
29           TCP sliding window size becomes more than 64KB, the factor will increase\r
30           automatically.\r
31         + ipconfigETHERNET_MINIMUM_PACKET_BYTES is now applied for every protocol:\r
32           TCP, UDP, and ARP.\r
33         + Updated the Zynq project to use BufferAllocation_1.c rather than\r
34           BufferAllocation_2.c - which is a requirement with its current\r
35           configuration (due to the alignment requirements on the combined cache and\r
36           DMA configuration).\r
37 \r
38 Changes between 160823 and 160908 releases:\r
39 \r
40         + Use ipconfigZERO_COPY_TX_DRIVER as the xReleaseAfterSend() parameter where\r
41           prvTCPReturnPacket() is called in prvSendData() to prevent unnecessary\r
42           copying of data.\r
43         + Remove the use of the uxGetRxEventCount variable, which was used to give\r
44           priority to incoming messages, but could result in the IP task starving\r
45           application tasks of processing time.\r
46 \r
47 Changes between 160112 and 160823 releases\r
48 \r
49         NOTE:  The 160908 release is a maintenance release for the 160112 single\r
50         interface labs release - not a release of the current development branch.\r
51 \r
52         + Various minor stability enhancements, including the ability to work with\r
53           configTICK_RATE_HZ set to less than 1KHz, closing DHCP sockets directly\r
54           rather than via FreeRTOS_closesocket(), and better handling of unknown\r
55           TCP packets before an IP address has been assigned.\r
56         + ipBUFFER_PADDING is now configurable through the ipconfigBUFFER_PADDING\r
57           constant to improve network buffer alignment handling capabilities (expert\r
58           users/driver writers only).\r
59         + Multiple improvements to the FTP server, including to how read only and\r
60           zero length files are handled.\r
61         + ipconfigFTP_HAS_USER_PROPERTIES_HOOK (to allow each user to have a\r
62           different root directory and access rights) and\r
63           ipconfigHTTP_HAS_HANDLE_REQUEST_HOOK (to handle AJAX style data)\r
64           introduced, although these are not yet fully tested and the constant names\r
65           are likely to change.\r
66         + Introduce ipconfigHAS_TX_CRC_OFFLOADING.\r
67         + ipconfigUSE_DHCP_HOOK is now called ipconfigUSE_DHCP_HOOK, and the name\r
68           of the callback function has also changed.  See the web documentation for\r
69           details.\r
70         + ipconfigTCP_RX_BUF_LEN is now ipconfigTCP_RX_BUFFER_LENGTH, and\r
71           ipconfigTCP_TX_BUF_LEN is now ipconfigTCP_TX_BUFFER_LENGTH, which is\r
72           actually how they have always been documented.\r
73         + Added example TFTP server capable of receiving (not sending) files.\r
74           Intended for bootloader type functionality.\r
75         + Various variable name changes for consistency (mainly ensuring UDP, TCP,\r
76           DNS, etc. always use the same case letters, and type prefixes are correct).\r
77         + Various minor edits to improve types used by internal variables.\r
78         + Simplified mapping of standard library functions to their Visual Studio\r
79           equivalents.\r
80         + Improve robustness of network drivers.\r
81         + Introduce pxResizeNetworkBufferWithDescriptor().\r
82         + Removed obsolete FreeRTOSIPConfig.h constants from\r
83           FreeRTOSIPConfigDefaults.h.\r
84         + Added additional asserts() - predominantly to catch incorrect structure\r
85           packing.\r
86 \r
87 Changes between 160112 and 160111 releases\r
88 \r
89         + Updated the STM32 network driver so checksums are calculated by the\r
90           hardware.\r
91         + Implemented a simple "quit" command in the TCP command console.\r
92 \r
93 Changes between 150825 and 160111 releases\r
94 \r
95         + New device support:  Demo applications and example drivers are provided\r
96           for Atmel SAM4E and ST STM32F4 microcontrollers.\r
97         + Various updates to improve compliance with the FreeRTOS coding standard.\r
98         + Added a command console example that uses TCP/IP for input and output (the\r
99           pre-existing command console example uses UDP/IP).\r
100         + Updated the UDP logging example so it will send log messages to the local\r
101           UDP broadcast address if a specific IP address is not provided.  This\r
102           simplifies configuration, but note not all switches and routers will pass\r
103           broadcast messages.\r
104         + Add TCP echo client and TCP echo server examples to the Zynq demo.\r
105         + Minor updates to the Zynq network driver.\r
106         + Update the Zynq project to use version 2015.4 of the Xilinx SDK.\r
107         + Introduce FreeRTOS_SignalSocket(), which can be used to interrupt a task\r
108           that is blocked while reading from a socket ( FreeRTOS_recv[from] ).\r
109         + Make use of FreeRTOS_SignalSocket() in the FTP and HTTP servers.\r
110         + Major updates to the NTP client, although this is not included in any of\r
111           the pre-configured demo applications yet.\r
112         + Added support for DHCP zero pad option.\r
113         + Added uxGetMinimumIPQueueSpace(), a function to monitor the minimum amount\r
114           of space on the message queue.\r
115         + Better handling of zero length files in the FTP server.\r
116         + Fixed a bug reported by Andrey Ivanov from swissEmbedded that affects\r
117           users of 'ipconfigZERO_COPY_TX_DRIVER'.\r
118 \r
119 \r
120 Changes between 150825 150825 (?)\r
121 \r
122         + Added xApplicationDHCPUserHook() so a user defined hook will be\r
123           called at certain points in the DHCP process if\r
124           ipconfigDHCP_USES_USER_HOOK is set to 1.\r
125         + Added FreeRTOS_get_tx_head() to improve TCP zero copy behaviour - for\r
126           expert use only.\r
127         + RST is no longer sent if only the ACK flag is set.\r
128         + Previously, an immediate ACK was only sent when buffer space was\r
129           exhausted.  Now, to improve performance, it is possible to send an\r
130           immediate ACK earlier - dependent on the ipconfigTCP_ACK_EARLIER_PACKET\r
131           setting.\r
132         + LLMNR and NBNS requests can now be sent to locate other devices -\r
133           previously these protocols would only be replied to, not generated.\r
134         + Added Auto-IP functionality (still in test) in case DHCP fails.  Dependent\r
135           on the ipconfigDHCP_FALL_BACK_LINK_LAYER_ADDRESS and\r
136           ipconfigARP_USE_CLASH_DETECTION settings.\r
137         + Added NTP code and demo.\r
138         + FTP can now STOR and RETR zero-length files.\r
139         + Added LLMNR demo to Win32 demo - so now the Win32 responds to\r
140           "ping RTOSDemo".\r
141 \r
142 Changes between 141019 and 150825\r
143 \r
144         + Added FTP server, which uses the new FreeRTOS+FAT component.\r
145         + Added basic HTTP server, which uses the new FreeRTOS+FAT component.\r
146         + Multiple definitions that are now common with FreeRTOS+FAT have been moved\r
147           into FreeRTOS's ProjDefs.h header file, and so prefixed with 'pd'.\r
148         + Introduced ipconfigZERO_COPY_TX_DRIVER, which defines who is responsible\r
149           for freeing a buffer sent to to the MAC driver for transmission, and\r
150           facilitates the development of zero copy drivers.\r
151         + Introduced the FREERTOS_MSG_DONTWAIT flag.  The flag can be used as a\r
152           simpler and faster alternative to using FreeRTOS_setsockopt() to set the\r
153           send or receive timeout to 0.\r
154         + A few functions that were previously all lower case are now mixed case, as\r
155           lower case function names are only used when they are equivalent to a\r
156           a Berkeley sockets API function of the same name.\r
157         + Introduced uxGetMinimumFreeNetworkBuffers() to return the minimum number\r
158           of network buffers that have ever existed since the application started\r
159           executing.\r
160         + Introduce ipconfigETHERNET_MINIMUM_PACKET_BYTES to allow the application\r
161           writer to set their own minimum buffer size should the hardware not be\r
162           capable of padding under-sized Ethernet frames.\r
163         + vNetworkBufferRelease() renamed vReleaseNetworkBuffer() - just for\r
164           consistency with the names of other functions in the same file.\r
165         + Grouped DHCP status data into a structure.\r
166         + DHCP is now tried both with and without the broadcast flag.\r
167         + Replaced occurrences of configASSERT_VOID() with configASSERT().\r
168         + ipconfigDNS_USE_CALLBACKS introduced to allow FreeRTOS_gethostbyname() to\r
169           be used without blocking.\r
170         + Fix: LLMNR and NBNS behaviour when the reply is in a larger buffer than the\r
171           request, and BufferAllocation_2 was used.\r
172         + Introduced ipMAX_IP_TASK_SLEEP_TIME to allow the application writer to\r
173           override the default value of 10 seconds.\r
174         + Fix:  Correct error in *pxUDPPayloadBuffer_to_NetworkBuffer().\r
175         + FreeRTOS_recv() now recognises the FREERTOS_ZERO_COPY flag, which, when\r
176           set, the void *pvBuffer parameter is interpreted as void **pvBuffer.\r
177         + FreeRTOS_listen() now returns an error code.  Previously it always\r
178           returned 0.\r
179         + Fix:  Previously if a listening socket was reused, and a connection\r
180           failed, the TCP/IP stack closed the socket, now the socket is correctly\r
181           left unclosed as it is owned by the application.\r
182         + Various other formatting and minor fix alterations.\r