2 FreeRTOS V9.0.0 - Copyright (C) 2016 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 This file is part of the FreeRTOS distribution.
\r
9 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
10 the terms of the GNU General Public License (version 2) as published by the
\r
11 Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
\r
13 ***************************************************************************
\r
14 >>! NOTE: The modification to the GPL is included to allow you to !<<
\r
15 >>! distribute a combined work that includes FreeRTOS without being !<<
\r
16 >>! obliged to provide the source code for proprietary components !<<
\r
17 >>! outside of the FreeRTOS kernel. !<<
\r
18 ***************************************************************************
\r
20 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
21 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
22 FOR A PARTICULAR PURPOSE. Full license text is available on the following
\r
23 link: http://www.freertos.org/a00114.html
\r
25 ***************************************************************************
\r
27 * FreeRTOS provides completely free yet professionally developed, *
\r
28 * robust, strictly quality controlled, supported, and cross *
\r
29 * platform software that is more than just the market leader, it *
\r
30 * is the industry's de facto standard. *
\r
32 * Help yourself get started quickly while simultaneously helping *
\r
33 * to support the FreeRTOS project by purchasing a FreeRTOS *
\r
34 * tutorial book, reference manual, or both: *
\r
35 * http://www.FreeRTOS.org/Documentation *
\r
37 ***************************************************************************
\r
39 http://www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading
\r
40 the FAQ page "My application does not run, what could be wrong?". Have you
\r
41 defined configASSERT()?
\r
43 http://www.FreeRTOS.org/support - In return for receiving this top quality
\r
44 embedded software for free we request you assist our global community by
\r
45 participating in the support forum.
\r
47 http://www.FreeRTOS.org/training - Investing in training allows your team to
\r
48 be as productive as possible as early as possible. Now you can receive
\r
49 FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
\r
50 Ltd, and the world's leading authority on the world's leading RTOS.
\r
52 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
53 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
54 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
56 http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
\r
57 Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
\r
59 http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
\r
60 Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
61 licenses offer ticketed support, indemnification and commercial middleware.
\r
63 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
64 engineered and independently SIL3 certified version for use in safety and
\r
65 mission critical applications that require provable dependability.
\r
71 /*****************************************************************************
\r
73 * See the following URL for configuration information.
\r
74 * http://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_IP_Configuration.html
\r
76 *****************************************************************************/
\r
78 #ifndef FREERTOS_IP_CONFIG_H
\r
79 #define FREERTOS_IP_CONFIG_H
\r
81 /* Prototype for the function used to print out. In this case it prints to the
\r
82 console before the network is connected then a UDP port after the network has
\r
84 extern void vLoggingPrintf( const char *pcFormatString, ... );
\r
86 /* Set to 1 to print out debug messages. If ipconfigHAS_DEBUG_PRINTF is set to
\r
87 1 then FreeRTOS_debug_printf should be defined to the function used to print
\r
88 out the debugging messages. */
\r
89 #define ipconfigHAS_DEBUG_PRINTF 0
\r
90 #if( ipconfigHAS_DEBUG_PRINTF == 1 )
\r
91 #define FreeRTOS_debug_printf(X) vLoggingPrintf X
\r
94 /* Set to 1 to print out non debugging messages, for example the output of the
\r
95 FreeRTOS_netstat() command, and ping replies. If ipconfigHAS_PRINTF is set to 1
\r
96 then FreeRTOS_printf should be set to the function used to print out the
\r
98 #define ipconfigHAS_PRINTF 1
\r
99 #if( ipconfigHAS_PRINTF == 1 )
\r
100 #define FreeRTOS_printf(X) vLoggingPrintf X
\r
103 /* Define the byte order of the target MCU (the MCU FreeRTOS+TCP is executing
\r
104 on). Valid options are pdFREERTOS_BIG_ENDIAN and pdFREERTOS_LITTLE_ENDIAN. */
\r
105 #define ipconfigBYTE_ORDER pdFREERTOS_LITTLE_ENDIAN
\r
107 /* If the network card/driver includes checksum offloading (IP/TCP/UDP checksums)
\r
108 then set ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
\r
109 stack repeating the checksum calculations. */
\r
110 #define ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM 1
\r
112 /* Several API's will block until the result is known, or the action has been
\r
113 performed, for example FreeRTOS_send() and FreeRTOS_recv(). The timeouts can be
\r
114 set per socket, using setsockopt(). If not set, the times below will be
\r
115 used as defaults. */
\r
116 #define ipconfigSOCK_DEFAULT_RECEIVE_BLOCK_TIME ( 5000 )
\r
117 #define ipconfigSOCK_DEFAULT_SEND_BLOCK_TIME ( 5000 )
\r
119 /* Include support for LLMNR: Link-local Multicast Name Resolution
\r
121 #define ipconfigUSE_LLMNR ( 1 )
\r
123 /* Include support for NBNS: NetBIOS Name Service (Microsoft) */
\r
124 #define ipconfigUSE_NBNS ( 1 )
\r
126 /* Include support for DNS caching. For TCP, having a small DNS cache is very
\r
127 useful. When a cache is present, ipconfigDNS_REQUEST_ATTEMPTS can be kept low
\r
128 and also DNS may use small timeouts. If a DNS reply comes in after the DNS
\r
129 socket has been destroyed, the result will be stored into the cache. The next
\r
130 call to FreeRTOS_gethostbyname() will return immediately, without even creating
\r
132 #define ipconfigUSE_DNS_CACHE ( 1 )
\r
133 #define ipconfigDNS_CACHE_NAME_LENGTH ( 16 )
\r
134 #define ipconfigDNS_CACHE_ENTRIES ( 4 )
\r
135 #define ipconfigDNS_REQUEST_ATTEMPTS ( 2 )
\r
137 /* The IP stack executes it its own task (although any application task can make
\r
138 use of its services through the published sockets API). ipconfigUDP_TASK_PRIORITY
\r
139 sets the priority of the task that executes the IP stack. The priority is a
\r
140 standard FreeRTOS task priority so can take any value from 0 (the lowest
\r
141 priority) to (configMAX_PRIORITIES - 1) (the highest priority).
\r
142 configMAX_PRIORITIES is a standard FreeRTOS configuration parameter defined in
\r
143 FreeRTOSConfig.h, not FreeRTOSIPConfig.h. Consideration needs to be given as to
\r
144 the priority assigned to the task executing the IP stack relative to the
\r
145 priority assigned to tasks that use the IP stack. */
\r
146 #define ipconfigIP_TASK_PRIORITY ( configMAX_PRIORITIES - 2 )
\r
148 /* The size, in words (not bytes), of the stack allocated to the FreeRTOS+TCP
\r
149 task. This setting is less important when the FreeRTOS Win32 simulator is used
\r
150 as the Win32 simulator only stores a fixed amount of information on the task
\r
151 stack. FreeRTOS includes optional stack overflow detection, see:
\r
152 http://www.freertos.org/Stacks-and-stack-overflow-checking.html */
\r
153 #define ipconfigIP_TASK_STACK_SIZE_WORDS ( configMINIMAL_STACK_SIZE * 5 )
\r
155 /* ipconfigRAND32() is called by the IP stack to generate random numbers for
\r
156 things such as a DHCP transaction number or initial sequence number. Random
\r
157 number generation is performed via this macro to allow applications to use their
\r
158 own random number generation method. For example, it might be possible to
\r
159 generate a random number by sampling noise on an analogue input. */
\r
160 extern UBaseType_t uxRand();
\r
161 #define ipconfigRAND32() uxRand()
\r
163 /* If ipconfigUSE_NETWORK_EVENT_HOOK is set to 1 then FreeRTOS+TCP will call the
\r
164 network event hook at the appropriate times. If ipconfigUSE_NETWORK_EVENT_HOOK
\r
165 is not set to 1 then the network event hook will never be called. See
\r
166 http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_UDP/API/vApplicationIPNetworkEventHook.shtml
\r
168 #define ipconfigUSE_NETWORK_EVENT_HOOK 1
\r
170 /* Sockets have a send block time attribute. If FreeRTOS_sendto() is called but
\r
171 a network buffer cannot be obtained then the calling task is held in the Blocked
\r
172 state (so other tasks can continue to executed) until either a network buffer
\r
173 becomes available or the send block time expires. If the send block time expires
\r
174 then the send operation is aborted. The maximum allowable send block time is
\r
175 capped to the value set by ipconfigMAX_SEND_BLOCK_TIME_TICKS. Capping the
\r
176 maximum allowable send block time prevents prevents a deadlock occurring when
\r
177 all the network buffers are in use and the tasks that process (and subsequently
\r
178 free) the network buffers are themselves blocked waiting for a network buffer.
\r
179 ipconfigMAX_SEND_BLOCK_TIME_TICKS is specified in RTOS ticks. A time in
\r
180 milliseconds can be converted to a time in ticks by dividing the time in
\r
181 milliseconds by portTICK_PERIOD_MS. */
\r
182 #define ipconfigUDP_MAX_SEND_BLOCK_TIME_TICKS ( 5000 / portTICK_PERIOD_MS )
\r
184 /* If ipconfigUSE_DHCP is 1 then FreeRTOS+TCP will attempt to retrieve an IP
\r
185 address, netmask, DNS server address and gateway address from a DHCP server. If
\r
186 ipconfigUSE_DHCP is 0 then FreeRTOS+TCP will use a static IP address. The
\r
187 stack will revert to using the static IP address even when ipconfigUSE_DHCP is
\r
188 set to 1 if a valid configuration cannot be obtained from a DHCP server for any
\r
189 reason. The static configuration used is that passed into the stack by the
\r
190 FreeRTOS_IPInit() function call. */
\r
191 #define ipconfigUSE_DHCP 1
\r
193 /* If ipconfigUSE_DHCP_HOOK is set to 1 then the application must provide a
\r
194 hook (or 'callback') function called xApplicationDHCPHook(), the use of which is
\r
195 explained on the following URL:
\r
196 http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_IP_Configuration.html#ipconfigUSE_DHCP_HOOK */
\r
197 #define ipconfigUSE_DHCP_HOOK 0
\r
199 /* When ipconfigUSE_DHCP is set to 1, DHCP requests will be sent out at
\r
200 increasing time intervals until either a reply is received from a DHCP server
\r
201 and accepted, or the interval between transmissions reaches
\r
202 ipconfigMAXIMUM_DISCOVER_TX_PERIOD. The IP stack will revert to using the
\r
203 static IP address passed as a parameter to FreeRTOS_IPInit() if the
\r
204 re-transmission time interval reaches ipconfigMAXIMUM_DISCOVER_TX_PERIOD without
\r
205 a DHCP reply being received. */
\r
206 #define ipconfigMAXIMUM_DISCOVER_TX_PERIOD ( 120000 / portTICK_PERIOD_MS )
\r
208 /* The ARP cache is a table that maps IP addresses to MAC addresses. The IP
\r
209 stack can only send a UDP message to a remove IP address if it knowns the MAC
\r
210 address associated with the IP address, or the MAC address of the router used to
\r
211 contact the remote IP address. When a UDP message is received from a remote IP
\r
212 address the MAC address and IP address are added to the ARP cache. When a UDP
\r
213 message is sent to a remote IP address that does not already appear in the ARP
\r
214 cache then the UDP message is replaced by a ARP message that solicits the
\r
215 required MAC address information. ipconfigARP_CACHE_ENTRIES defines the maximum
\r
216 number of entries that can exist in the ARP table at any one time. */
\r
217 #define ipconfigARP_CACHE_ENTRIES 6
\r
219 /* ARP requests that do not result in an ARP response will be re-transmitted a
\r
220 maximum of ipconfigMAX_ARP_RETRANSMISSIONS times before the ARP request is
\r
222 #define ipconfigMAX_ARP_RETRANSMISSIONS ( 5 )
\r
224 /* ipconfigMAX_ARP_AGE defines the maximum time between an entry in the ARP
\r
225 table being created or refreshed and the entry being removed because it is stale.
\r
226 New ARP requests are sent for ARP cache entries that are nearing their maximum
\r
227 age. ipconfigMAX_ARP_AGE is specified in tens of seconds, so a value of 150 is
\r
228 equal to 1500 seconds (or 25 minutes). */
\r
229 #define ipconfigMAX_ARP_AGE 150
\r
231 /* Implementing FreeRTOS_inet_addr() necessitates the use of string handling
\r
232 routines, which are relatively large. To save code space the full
\r
233 FreeRTOS_inet_addr() implementation is made optional, and a smaller and faster
\r
234 alternative called FreeRTOS_inet_addr_quick() is provided. FreeRTOS_inet_addr()
\r
235 takes an IP in decimal dot format (for example, "192.168.0.1") as its parameter.
\r
236 FreeRTOS_inet_addr_quick() takes an IP address as four separate numerical octets
\r
237 (for example, 192, 168, 0, 1) as its parameters. If
\r
238 ipconfigINCLUDE_FULL_INET_ADDR is set to 1 then both FreeRTOS_inet_addr() and
\r
239 FreeRTOS_indet_addr_quick() are available. If ipconfigINCLUDE_FULL_INET_ADDR is
\r
240 not set to 1 then only FreeRTOS_indet_addr_quick() is available. */
\r
241 #define ipconfigINCLUDE_FULL_INET_ADDR 1
\r
243 /* ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS defines the total number of network buffer that
\r
244 are available to the IP stack. The total number of network buffers is limited
\r
245 to ensure the total amount of RAM that can be consumed by the IP stack is capped
\r
246 to a pre-determinable value. */
\r
247 #define ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS 60
\r
249 /* A FreeRTOS queue is used to send events from application tasks to the IP
\r
250 stack. ipconfigEVENT_QUEUE_LENGTH sets the maximum number of events that can
\r
251 be queued for processing at any one time. The event queue must be a minimum of
\r
252 5 greater than the total number of network buffers. */
\r
253 #define ipconfigEVENT_QUEUE_LENGTH ( ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS + 5 )
\r
255 /* The address of a socket is the combination of its IP address and its port
\r
256 number. FreeRTOS_bind() is used to manually allocate a port number to a socket
\r
257 (to 'bind' the socket to a port), but manual binding is not normally necessary
\r
258 for client sockets (those sockets that initiate outgoing connections rather than
\r
259 wait for incoming connections on a known port number). If
\r
260 ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND is set to 1 then calling
\r
261 FreeRTOS_sendto() on a socket that has not yet been bound will result in the IP
\r
262 stack automatically binding the socket to a port number from the range
\r
263 socketAUTO_PORT_ALLOCATION_START_NUMBER to 0xffff. If
\r
264 ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND is set to 0 then calling FreeRTOS_sendto()
\r
265 on a socket that has not yet been bound will result in the send operation being
\r
267 #define ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND 1
\r
269 /* Defines the Time To Live (TTL) values used in outgoing UDP packets. */
\r
270 #define ipconfigUDP_TIME_TO_LIVE 128
\r
271 #define ipconfigTCP_TIME_TO_LIVE 128 /* also defined in FreeRTOSIPConfigDefaults.h */
\r
273 /* USE_TCP: Use TCP and all its features */
\r
274 #define ipconfigUSE_TCP ( 1 )
\r
276 /* USE_WIN: Let TCP use windowing mechanism. */
\r
277 #define ipconfigUSE_TCP_WIN ( 1 )
\r
279 /* The MTU is the maximum number of bytes the payload of a network frame can
\r
280 contain. For normal Ethernet V2 frames the maximum MTU is 1500. Setting a
\r
281 lower value can save RAM, depending on the buffer management scheme used. If
\r
282 ipconfigCAN_FRAGMENT_OUTGOING_PACKETS is 1 then (ipconfigNETWORK_MTU - 28) must
\r
283 be divisible by 8. */
\r
284 #define ipconfigNETWORK_MTU 1200
\r
286 /* Set ipconfigUSE_DNS to 1 to include a basic DNS client/resolver. DNS is used
\r
287 through the FreeRTOS_gethostbyname() API function. */
\r
288 #define ipconfigUSE_DNS 1
\r
290 /* If ipconfigREPLY_TO_INCOMING_PINGS is set to 1 then the IP stack will
\r
291 generate replies to incoming ICMP echo (ping) requests. */
\r
292 #define ipconfigREPLY_TO_INCOMING_PINGS 1
\r
294 /* If ipconfigSUPPORT_OUTGOING_PINGS is set to 1 then the
\r
295 FreeRTOS_SendPingRequest() API function is available. */
\r
296 #define ipconfigSUPPORT_OUTGOING_PINGS 1
\r
298 /* If ipconfigSUPPORT_SELECT_FUNCTION is set to 1 then the FreeRTOS_select()
\r
299 (and associated) API function is available. */
\r
300 #define ipconfigSUPPORT_SELECT_FUNCTION 1
\r
302 /* If ipconfigFILTER_OUT_NON_ETHERNET_II_FRAMES is set to 1 then Ethernet frames
\r
303 that are not in Ethernet II format will be dropped. This option is included for
\r
304 potential future IP stack developments. */
\r
305 #define ipconfigFILTER_OUT_NON_ETHERNET_II_FRAMES 1
\r
307 /* If ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES is set to 1 then it is the
\r
308 responsibility of the Ethernet interface to filter out packets that are of no
\r
309 interest. If the Ethernet interface does not implement this functionality, then
\r
310 set ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES to 0 to have the IP stack
\r
311 perform the filtering instead (it is much less efficient for the stack to do it
\r
312 because the packet will already have been passed into the stack). If the
\r
313 Ethernet driver does all the necessary filtering in hardware then software
\r
314 filtering can be removed by using a value other than 1 or 0. */
\r
315 #define ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES 1
\r
317 /* The windows simulator cannot really simulate MAC interrupts, and needs to
\r
318 block occasionally to allow other tasks to run. */
\r
319 #define configWINDOWS_MAC_INTERRUPT_SIMULATOR_DELAY ( 10 / portTICK_PERIOD_MS )
\r
321 /* Advanced only: in order to access 32-bit fields in the IP packets with
\r
322 32-bit memory instructions, all packets will be stored 32-bit-aligned, plus 16-bits.
\r
323 This has to do with the contents of the IP-packets: all 32-bit fields are
\r
324 32-bit-aligned, plus 16-bit(!) */
\r
325 #define ipconfigPACKET_FILLER_SIZE 2
\r
328 /* Define the size of the pool of TCP window descriptors. On the average, each
\r
329 TCP socket will use up to 2 x 6 descriptors, meaning that it can have 2 x 6
\r
330 outstanding packets (for Rx and Tx). When using up to 10 TP sockets
\r
331 simultaneously, one could define TCP_WIN_SEG_COUNT as 120. */
\r
332 #define ipconfigTCP_WIN_SEG_COUNT 240
\r
334 /* Each TCP socket has a circular buffers for Rx and Tx, which have a fixed
\r
335 maximum size. Define the size of Rx buffer for TCP sockets. */
\r
336 #define ipconfigTCP_RX_BUFFER_LENGTH ( 1000 )
\r
338 /* Define the size of Tx buffer for TCP sockets. */
\r
339 #define ipconfigTCP_TX_BUFFER_LENGTH ( 1000 )
\r
341 /* When using call-back handlers, the driver may check if the handler points to
\r
342 real program memory (RAM or flash) or just has a random non-zero value. */
\r
343 #define ipconfigIS_VALID_PROG_ADDRESS(x) ( (x) != NULL )
\r
345 /* Include support for TCP hang protection. All sockets in a connecting or
\r
346 disconnecting stage will timeout after a period of non-activity. */
\r
347 #define ipconfigTCP_HANG_PROTECTION ( 1 )
\r
348 #define ipconfigTCP_HANG_PROTECTION_TIME ( 30 )
\r
350 /* Include support for TCP keep-alive messages. */
\r
351 #define ipconfigTCP_KEEP_ALIVE ( 1 )
\r
352 #define ipconfigTCP_KEEP_ALIVE_INTERVAL ( 20 ) /* in seconds */
\r
354 /* Include both TCP and HTTP. */
\r
355 #define ipconfigUSE_FTP 1
\r
356 #define ipconfigUSE_HTTP 1
\r
358 /* Dimension the buffers and windows used by the FTP and HTTP servers. */
\r
359 #define ipconfigFTP_TX_BUFSIZE ( 8 * 1024 )
\r
360 #define ipconfigFTP_TX_WINSIZE ( 4 )
\r
361 #define ipconfigFTP_RX_BUFSIZE ( 8 * ipconfigNETWORK_MTU )
\r
362 #define ipconfigFTP_RX_WINSIZE ( 4 )
\r
363 #define ipconfigHTTP_TX_BUFSIZE ( 8 * ipconfigNETWORK_MTU )
\r
364 #define ipconfigHTTP_TX_WINSIZE ( 4 )
\r
365 #define ipconfigHTTP_RX_BUFSIZE ( 8 * ipconfigNETWORK_MTU )
\r
366 #define ipconfigHTTP_RX_WINSIZE ( 4 )
\r
367 #define portINLINE __inline
\r
370 #define ipconfigTFTP_TIME_OUT_MS ( 10000 ) /*_RB_ Parameters need commenting and documenting. */
\r
371 #define ipconfigTFTP_MAX_RETRIES ( 6 )
\r
373 /* The example IP trace macros are included here so the definitions are
\r
374 available in all the FreeRTOS+TCP source files. */
\r
375 #include "DemoIPTrace.h"
\r
377 #endif /* FREERTOS_IP_CONFIG_H */
\r
projects / freertos / blob