Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

features/FEATURE_LWIP/lwip-interface/lwip/UPGRADING@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

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