[DELAYIMP] Fix 2 Clang-Cl warnings about __pfnDliNotifyHook2Default and __pfnDliFailu...
[reactos.git] / sdk / lib / drivers / lwip / UPGRADING
1 This file lists major changes between release versions that require
2 ports or applications to be changed. Use it to update a port or an
3 application written for an older version of lwIP to correctly work
4 with newer versions.
5
6
7 (CVS HEAD)
8
9 * [Enter new changes just after this line - do not remove this line]
10
11 ++ Application changes:
12
13 * Replaced struct ip_addr by typedef ip_addr_t (struct ip_addr is kept for
14 compatibility to old applications, but will be removed in the future).
15
16 * Renamed mem_realloc() to mem_trim() to prevent confusion with realloc()
17
18 +++ Raw API:
19 * Changed the semantics of tcp_close() (since it was rather a
20 shutdown before): Now the application does *NOT* get any calls to the recv
21 callback (aside from NULL/closed) after calling tcp_close()
22
23 * When calling tcp_abort() from a raw API TCP callback function,
24 make sure you return ERR_ABRT to prevent accessing unallocated memory.
25 (ERR_ABRT now means the applicaiton has called tcp_abort!)
26
27 +++ Netconn API:
28 * Changed netconn_receive() and netconn_accept() to return
29 err_t, not a pointer to new data/netconn.
30
31 +++ Socket API:
32 * LWIP_SO_RCVTIMEO: when accept() or recv() time out, they
33 now set errno to EWOULDBLOCK/EAGAIN, not ETIMEDOUT.
34
35 * Added a minimal version of posix fctl() to have a
36 standardised way to set O_NONBLOCK for nonblocking sockets.
37
38 +++ all APIs:
39 * correctly implemented SO(F)_REUSEADDR
40
41 ++ Port changes
42
43 +++ new files:
44
45 * Added 4 new files: def.c, timers.c, timers.h, tcp_impl.h:
46
47 * Moved stack-internal parts of tcp.h to tcp_impl.h, tcp.h now only contains
48 the actual application programmer's API
49
50 * Separated timer implementation from sys.h/.c, moved to timers.h/.c;
51 Added timer implementation for NO_SYS==1, set NO_SYS_NO_TIMERS==1 if you
52 still want to use your own timer implementation for NO_SYS==0 (as before).
53
54 +++ sys layer:
55
56 * Converted mbox- and semaphore-functions to take pointers to sys_mbox_t/
57 sys_sem_t;
58
59 * Converted sys_mbox_new/sys_sem_new to take pointers and return err_t;
60
61 * Added Mutex concept in sys_arch (define LWIP_COMPAT_MUTEX to let sys.h use
62 binary semaphores instead of mutexes - as before)
63
64 +++ new options:
65
66 * Don't waste memory when chaining segments, added option TCP_OVERSIZE to
67 prevent creating many small pbufs when calling tcp_write with many small
68 blocks of data. Instead, pbufs are allocated larger than needed and the
69 space is used for later calls to tcp_write.
70
71 * Added LWIP_NETIF_TX_SINGLE_PBUF to always copy to try to create single pbufs
72 in tcp_write/udp_send.
73
74 * Added an additional option LWIP_ETHERNET to support ethernet without ARP
75 (necessary for pure PPPoE)
76
77 * Add MEMP_SEPARATE_POOLS to place memory pools in separate arrays. This may
78 be used to place these pools into user-defined memory by using external
79 declaration.
80
81 * Added TCP_SNDQUEUELOWAT corresponding to TCP_SNDLOWAT
82
83 +++ new pools:
84
85 * Netdb uses a memp pool for allocating memory when getaddrinfo() is called,
86 so MEMP_NUM_NETDB has to be set accordingly.
87
88 * DNS_LOCAL_HOSTLIST_IS_DYNAMIC uses a memp pool instead of the heap, so
89 MEMP_NUM_LOCALHOSTLIST has to be set accordingly.
90
91 * Snmp-agent uses a memp pools instead of the heap, so MEMP_NUM_SNMP_* have
92 to be set accordingly.
93
94 * PPPoE uses a MEMP pool instead of the heap, so MEMP_NUM_PPPOE_INTERFACES
95 has to be set accordingly
96
97 * Integrated loopif into netif.c - loopif does not have to be created by the
98 port any more, just define LWIP_HAVE_LOOPIF to 1.
99
100 * Added define LWIP_RAND() for lwip-wide randomization (needs to be defined
101 in cc.h, e.g. used by igmp)
102
103 * Added printf-formatter X8_F to printf u8_t as hex
104
105 * The heap now may be moved to user-defined memory by defining
106 LWIP_RAM_HEAP_POINTER as a void pointer to that memory's address
107
108 * added autoip_set_struct() and dhcp_set_struct() to let autoip and dhcp work
109 with user-allocated structs instead of calling mem_malloc
110
111 * Added const char* name to mem- and memp-stats for easier debugging.
112
113 * Calculate the TCP/UDP checksum while copying to only fetch data once:
114 Define LWIP_CHKSUM_COPY to a memcpy-like function that returns the checksum
115
116 * Added SO_REUSE_RXTOALL to pass received UDP broadcast/multicast packets to
117 more than one pcb.
118
119 * Changed the semantics of ARP_QUEUEING==0: ARP_QUEUEING now cannot be turned
120 off any more, if this is set to 0, only one packet (the most recent one) is
121 queued (like demanded by RFC 1122).
122
123
124 ++ Major bugfixes/improvements
125
126 * Implemented tcp_shutdown() to only shut down one end of a connection
127 * Implemented shutdown() at socket- and netconn-level
128 * Added errorset support to select() + improved select speed overhead
129 * Merged pppd to v2.3.11 (including some backported bugfixes from 2.4.x)
130 * Added timer implementation for NO_SYS==1 (may be disabled with NO_SYS_NO_TIMERS==1
131 * Use macros defined in ip_addr.h to work with IP addresses
132 * Implemented many nonblocking socket/netconn functions
133 * Fixed ARP input processing: only add a new entry if a request was directed as us
134 * mem_realloc() to mem_trim() to prevent confusion with realloc()
135 * Some improvements for AutoIP (don't route/forward link-local addresses, don't break
136 existing connections when assigning a routable address)
137 * Correctly handle remote side overrunning our rcv_wnd in ooseq case
138 * Removed packing from ip_addr_t, the packed version is now only used in protocol headers
139 * Corrected PBUF_POOL_BUFSIZE for ports where ETH_PAD_SIZE > 0
140 * Added support for static ARP table entries
141
142 (STABLE-1.3.2)
143
144 * initial version of this file