1This file lists major changes between release versions that require 2ports or applications to be changed. Use it to update a port or an 3application written for an older version of lwIP to correctly work 4with newer versions. 5 6 7(git master) 8 9 * [Enter new changes just after this line - do not remove this line] 10 11(2.0.2) 12 13 ++ Application changes: 14 15 * slipif: The way to pass serial port number has changed. netif->num is not 16 supported any more, netif->state is interpreted as an u8_t port number now 17 (it's not a POINTER to an u8_t any more!) 18 19(2.0.1) 20 21 ++ Application changes: 22 23 * UDP does NOT receive multicast traffic from ALL netifs on an UDP PCB bound to a specific 24 netif any more. Users need to bind to IP_ADDR_ANY to receive multicast traffic and compare 25 ip_current_netif() to the desired netif for every packet. 26 See bug #49662 for an explanation. 27 28(2.0.0) 29 30 ++ Application changes: 31 32 * Changed netif "up" flag handling to be an administrative flag (as opposed to the previous meaning of 33 "ip4-address-valid", a netif will now not be used for transmission if not up) -> even a DHCP netif 34 has to be set "up" before starting the DHCP client 35 * Added IPv6 support (dual-stack or IPv4/IPv6 only) 36 * Changed ip_addr_t to be a union in dual-stack mode (use ip4_addr_t where referring to IPv4 only). 37 * Major rewrite of SNMP (added MIB parser that creates code stubs for custom MIBs); 38 supports SNMPv2c (experimental v3 support) 39 * Moved some core applications from contrib repository to src/apps (and include/lwip/apps) 40 41 +++ Raw API: 42 * Changed TCP listen backlog: removed tcp_accepted(), added the function pair tcp_backlog_delayed()/ 43 tcp_backlog_accepted() to explicitly delay backlog handling on a connection pcb 44 45 +++ Socket API: 46 * Added an implementation for posix sendmsg() 47 * Added LWIP_FIONREAD_LINUXMODE that makes ioctl/FIONREAD return the size of the next pending datagram 48 49 ++ Port changes 50 51 +++ new files: 52 * MANY new and moved files! 53 * Added src/Filelists.mk for use in Makefile projects 54 * Continued moving stack-internal parts from abc.h to abc_priv.h in sub-folder "priv" 55 to let abc.h only contain the actual application programmer's API 56 57 +++ sys layer: 58 * Made LWIP_TCPIP_CORE_LOCKING==1 the default as it usually performs better than 59 the traditional message passing (although with LWIP_COMPAT_MUTEX you are still 60 open to priority inversion, so this is not recommended any more) 61 * Added LWIP_NETCONN_SEM_PER_THREAD to use one "op_completed" semaphore per thread 62 instead of using one per netconn (these semaphores are used even with core locking 63 enabled as some longer lasting functions like big writes still need to delay) 64 * Added generalized abstraction for itoa(), strnicmp(), stricmp() and strnstr() 65 in def.h (to be overridden in cc.h) instead of config 66 options for netbiosns, httpd, dns, etc. ... 67 * New abstraction for hton* and ntoh* functions in def.h. 68 To override them, use the following in cc.h: 69 #define lwip_htons(x) <your_htons> 70 #define lwip_htonl(x) <your_htonl> 71 72 +++ new options: 73 * TODO 74 75 +++ new pools: 76 * Added LWIP_MEMPOOL_* (declare/init/alloc/free) to declare private memp pools 77 that share memp.c code but do not have to be made global via lwippools.h 78 * Added pools for IPv6, MPU_COMPATIBLE, dns-api, netif-api, etc. 79 * added hook LWIP_HOOK_MEMP_AVAILABLE() to get informed when a memp pool was empty and an item 80 is now available 81 82 * Signature of LWIP_HOOK_VLAN_SET macro was changed 83 84 * LWIP_DECLARE_MEMORY_ALIGNED() may be used to declare aligned memory buffers (mem/memp) 85 or to move buffers to dedicated memory using compiler attributes 86 87 * Standard C headers are used to define sized types and printf formatters 88 (disable by setting LWIP_NO_STDINT_H=1 or LWIP_NO_INTTYPES_H=1 if your compiler 89 does not support these) 90 91 92 ++ Major bugfixes/improvements 93 94 * Added IPv6 support (dual-stack or IPv4/IPv6 only) 95 * Major rewrite of PPP (incl. keep-up with apache pppd) 96 see doc/ppp.txt for an upgrading how-to 97 * Major rewrite of SNMP (incl. MIB parser) 98 * Fixed timing issues that might have lead to losing a DHCP lease 99 * Made rx processing path more robust against crafted errors 100 * TCP window scaling support 101 * modification of api modules to support FreeRTOS-MPU (don't pass stack-pointers to other threads) 102 * made DNS client more robust 103 * support PBUF_REF for RX packets 104 * LWIP_NETCONN_FULLDUPLEX allows netconn/sockets to be used for reading/writing from separate 105 threads each (needs LWIP_NETCONN_SEM_PER_THREAD) 106 * Moved and reordered stats (mainly memp/mib2) 107 108(1.4.0) 109 110 ++ Application changes: 111 112 * Replaced struct ip_addr by typedef ip_addr_t (struct ip_addr is kept for 113 compatibility to old applications, but will be removed in the future). 114 115 * Renamed mem_realloc() to mem_trim() to prevent confusion with realloc() 116 117 +++ Raw API: 118 * Changed the semantics of tcp_close() (since it was rather a 119 shutdown before): Now the application does *NOT* get any calls to the recv 120 callback (aside from NULL/closed) after calling tcp_close() 121 122 * When calling tcp_abort() from a raw API TCP callback function, 123 make sure you return ERR_ABRT to prevent accessing unallocated memory. 124 (ERR_ABRT now means the applicaiton has called tcp_abort!) 125 126 +++ Netconn API: 127 * Changed netconn_receive() and netconn_accept() to return 128 err_t, not a pointer to new data/netconn. 129 130 +++ Socket API: 131 * LWIP_SO_RCVTIMEO: when accept() or recv() time out, they 132 now set errno to EWOULDBLOCK/EAGAIN, not ETIMEDOUT. 133 134 * Added a minimal version of posix fctl() to have a 135 standardised way to set O_NONBLOCK for nonblocking sockets. 136 137 +++ all APIs: 138 * correctly implemented SO(F)_REUSEADDR 139 140 ++ Port changes 141 142 +++ new files: 143 144 * Added 4 new files: def.c, timers.c, timers.h, tcp_impl.h: 145 146 * Moved stack-internal parts of tcp.h to tcp_impl.h, tcp.h now only contains 147 the actual application programmer's API 148 149 * Separated timer implementation from sys.h/.c, moved to timers.h/.c; 150 Added timer implementation for NO_SYS==1, set NO_SYS_NO_TIMERS==1 if you 151 still want to use your own timer implementation for NO_SYS==0 (as before). 152 153 +++ sys layer: 154 155 * Converted mbox- and semaphore-functions to take pointers to sys_mbox_t/ 156 sys_sem_t; 157 158 * Converted sys_mbox_new/sys_sem_new to take pointers and return err_t; 159 160 * Added Mutex concept in sys_arch (define LWIP_COMPAT_MUTEX to let sys.h use 161 binary semaphores instead of mutexes - as before) 162 163 +++ new options: 164 165 * Don't waste memory when chaining segments, added option TCP_OVERSIZE to 166 prevent creating many small pbufs when calling tcp_write with many small 167 blocks of data. Instead, pbufs are allocated larger than needed and the 168 space is used for later calls to tcp_write. 169 170 * Added LWIP_NETIF_TX_SINGLE_PBUF to always copy to try to create single pbufs 171 in tcp_write/udp_send. 172 173 * Added an additional option LWIP_ETHERNET to support ethernet without ARP 174 (necessary for pure PPPoE) 175 176 * Add MEMP_SEPARATE_POOLS to place memory pools in separate arrays. This may 177 be used to place these pools into user-defined memory by using external 178 declaration. 179 180 * Added TCP_SNDQUEUELOWAT corresponding to TCP_SNDLOWAT 181 182 +++ new pools: 183 184 * Netdb uses a memp pool for allocating memory when getaddrinfo() is called, 185 so MEMP_NUM_NETDB has to be set accordingly. 186 187 * DNS_LOCAL_HOSTLIST_IS_DYNAMIC uses a memp pool instead of the heap, so 188 MEMP_NUM_LOCALHOSTLIST has to be set accordingly. 189 190 * Snmp-agent uses a memp pools instead of the heap, so MEMP_NUM_SNMP_* have 191 to be set accordingly. 192 193 * PPPoE uses a MEMP pool instead of the heap, so MEMP_NUM_PPPOE_INTERFACES 194 has to be set accordingly 195 196 * Integrated loopif into netif.c - loopif does not have to be created by the 197 port any more, just define LWIP_HAVE_LOOPIF to 1. 198 199 * Added define LWIP_RAND() for lwip-wide randomization (needs to be defined 200 in cc.h, e.g. used by igmp) 201 202 * Added printf-formatter X8_F to printf u8_t as hex 203 204 * The heap now may be moved to user-defined memory by defining 205 LWIP_RAM_HEAP_POINTER as a void pointer to that memory's address 206 207 * added autoip_set_struct() and dhcp_set_struct() to let autoip and dhcp work 208 with user-allocated structs instead of calling mem_malloc 209 210 * Added const char* name to mem- and memp-stats for easier debugging. 211 212 * Calculate the TCP/UDP checksum while copying to only fetch data once: 213 Define LWIP_CHKSUM_COPY to a memcpy-like function that returns the checksum 214 215 * Added SO_REUSE_RXTOALL to pass received UDP broadcast/multicast packets to 216 more than one pcb. 217 218 * Changed the semantics of ARP_QUEUEING==0: ARP_QUEUEING now cannot be turned 219 off any more, if this is set to 0, only one packet (the most recent one) is 220 queued (like demanded by RFC 1122). 221 222 223 ++ Major bugfixes/improvements 224 225 * Implemented tcp_shutdown() to only shut down one end of a connection 226 * Implemented shutdown() at socket- and netconn-level 227 * Added errorset support to select() + improved select speed overhead 228 * Merged pppd to v2.3.11 (including some backported bugfixes from 2.4.x) 229 * Added timer implementation for NO_SYS==1 (may be disabled with NO_SYS_NO_TIMERS==1 230 * Use macros defined in ip_addr.h to work with IP addresses 231 * Implemented many nonblocking socket/netconn functions 232 * Fixed ARP input processing: only add a new entry if a request was directed as us 233 * mem_realloc() to mem_trim() to prevent confusion with realloc() 234 * Some improvements for AutoIP (don't route/forward link-local addresses, don't break 235 existing connections when assigning a routable address) 236 * Correctly handle remote side overrunning our rcv_wnd in ooseq case 237 * Removed packing from ip_addr_t, the packed version is now only used in protocol headers 238 * Corrected PBUF_POOL_BUFSIZE for ports where ETH_PAD_SIZE > 0 239 * Added support for static ARP table entries 240 241(STABLE-1.3.2) 242 243 * initial version of this file 244