xref: /FreeRTOS-Plus-TCP-v4.0.0/test/build-combination/AllEnable/FreeRTOSIPConfig.h (revision 62f5d3a1fd65a52b480e9495cbe0ffcef2168754) 
1 /*
2  * FreeRTOS+TCP <DEVELOPMENT BRANCH>
3  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
6  * this software and associated documentation files (the "Software"), to deal in
7  * the Software without restriction, including without limitation the rights to
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9  * the Software, and to permit persons to whom the Software is furnished to do so,
10  * subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in all
13  * copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * http://aws.amazon.com/freertos
23  * http://www.FreeRTOS.org
24  */
25 
26 
27 /*****************************************************************************
28 *
29 * See the following URL for configuration information.
30 * http://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_IP_Configuration.html
31 *
32 *****************************************************************************/
33 
34 #ifndef FREERTOS_IP_CONFIG_H
35 #define FREERTOS_IP_CONFIG_H
36 
37 #define ipconfigUSE_DHCPv6                         1
38 #define ipconfigIPv4_BACKWARD_COMPATIBLE           1
39 #define ipconfigUSE_ARP_REVERSED_LOOKUP            1
40 #define ipconfigUSE_ARP_REMOVE_ENTRY               1
41 #define ipconfigARP_STORES_REMOTE_ADDRESSES        1
42 #define ipconfigUSE_LINKED_RX_MESSAGES             1
43 #define ipconfigFORCE_IP_DONT_FRAGMENT             1
44 #define ipconfigUDP_PASS_ZERO_CHECKSUM_PACKETS     1
45 #define ipconfigDHCP_FALL_BACK_AUTO_IP             1
46 #define ipconfigARP_USE_CLASH_DETECTION            1
47 #define ipconfigUSE_LLMNR                          1
48 #define ipconfigUSE_NBNS                           1
49 #define ipconfigUSE_MDNS                           1
50 #define ipconfigSUPPORT_OUTGOING_PINGS             1
51 #define ipconfigETHERNET_DRIVER_FILTERS_PACKETS    1
52 #define ipconfigZERO_COPY_TX_DRIVER                1
53 #define ipconfigZERO_COPY_RX_DRIVER                1
54 #define ipconfigDRIVER_INCLUDED_TX_IP_CHECKSUM     1
55 #define ipconfigSOCKET_HAS_USER_SEMAPHORE          1
56 #define ipconfigSELECT_USES_NOTIFY                 1
57 #define ipconfigSUPPORT_SIGNALS                    1
58 #define ipconfigPROCESS_CUSTOM_ETHERNET_FRAMES     1
59 #define ipconfigDNS_USE_CALLBACKS                  1
60 #define ipconfigCOMPATIBLE_WITH_SINGLE             1
61 #define ipconfigIGNORE_UNKNOWN_PACKETS             1
62 #define ipconfigCHECK_IP_QUEUE_SPACE               1
63 #define ipconfigUDP_MAX_RX_PACKETS                 1
64 #define ipconfigETHERNET_MINIMUM_PACKET_BYTES      1
65 #define ipconfigTCP_IP_SANITY                      1
66 #define ipconfigSUPPORT_NETWORK_DOWN_EVENT         1
67 
68 /* Set to 1 to print out debug messages.  If ipconfigHAS_DEBUG_PRINTF is set to
69  * 1 then FreeRTOS_debug_printf should be defined to the function used to print
70  * out the debugging messages. */
71 #define ipconfigHAS_DEBUG_PRINTF                   1
72 #if ( ipconfigHAS_DEBUG_PRINTF == 1 )
73     #define FreeRTOS_debug_printf( X )    printf X
74 #endif
75 
76 /* Set to 1 to print out non debugging messages, for example the output of the
77  * FreeRTOS_netstat() command, and ping replies.  If ipconfigHAS_PRINTF is set to 1
78  * then FreeRTOS_printf should be set to the function used to print out the
79  * messages. */
80 #define ipconfigHAS_PRINTF    1
81 #if ( ipconfigHAS_PRINTF == 1 )
82     #define FreeRTOS_printf( X )    printf X
83 #endif
84 
85 /* Define the byte order of the target MCU (the MCU FreeRTOS+TCP is executing
86  * on).  Valid options are pdFREERTOS_BIG_ENDIAN and pdFREERTOS_LITTLE_ENDIAN. */
87 #define ipconfigBYTE_ORDER                         pdFREERTOS_LITTLE_ENDIAN
88 
89 /* If the network card/driver includes checksum offloading then set
90  * ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
91  * stack repeating the checksum calculations. */
92 #define ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM     1
93 
94 /* Several API's will block until the result is known, or the action has been
95  * performed, for example FreeRTOS_send() and FreeRTOS_recv().  The timeouts can be
96  * set per socket, using setsockopt().  If not set, the times below will be
97  * used as defaults. */
98 #define ipconfigSOCK_DEFAULT_RECEIVE_BLOCK_TIME    ( 5000 )
99 #define ipconfigSOCK_DEFAULT_SEND_BLOCK_TIME       ( 5000 )
100 
101 /* Include support for DNS caching.  For TCP, having a small DNS cache is very
102  * useful.  When a cache is present, ipconfigDNS_REQUEST_ATTEMPTS can be kept low
103  * and also DNS may use small timeouts.  If a DNS reply comes in after the DNS
104  * socket has been destroyed, the result will be stored into the cache.  The next
105  * call to FreeRTOS_gethostbyname() will return immediately, without even creating
106  * a socket.
107  */
108 #define ipconfigUSE_DNS_CACHE                      ( 1 )
109 #define ipconfigDNS_CACHE_ADDRESSES_PER_ENTRY      ( 6 )
110 #define ipconfigDNS_REQUEST_ATTEMPTS               ( 2 )
111 
112 /* The IP stack executes it its own task (although any application task can make
113  * use of its services through the published sockets API). ipconfigUDP_TASK_PRIORITY
114  * sets the priority of the task that executes the IP stack.  The priority is a
115  * standard FreeRTOS task priority so can take any value from 0 (the lowest
116  * priority) to (configMAX_PRIORITIES - 1) (the highest priority).
117  * configMAX_PRIORITIES is a standard FreeRTOS configuration parameter defined in
118  * FreeRTOSConfig.h, not FreeRTOSIPConfig.h. Consideration needs to be given as to
119  * the priority assigned to the task executing the IP stack relative to the
120  * priority assigned to tasks that use the IP stack. */
121 #define ipconfigIP_TASK_PRIORITY                   ( configMAX_PRIORITIES - 2 )
122 
123 /* The size, in words (not bytes), of the stack allocated to the FreeRTOS+TCP
124  * task.  This setting is less important when the FreeRTOS Win32 simulator is used
125  * as the Win32 simulator only stores a fixed amount of information on the task
126  * stack.  FreeRTOS includes optional stack overflow detection, see:
127  * http://www.freertos.org/Stacks-and-stack-overflow-checking.html. */
128 #define ipconfigIP_TASK_STACK_SIZE_WORDS           ( configMINIMAL_STACK_SIZE * 5 )
129 
130 /* ipconfigRAND32() is called by the IP stack to generate random numbers for
131  * things such as a DHCP transaction number or initial sequence number.  Random
132  * number generation is performed via this macro to allow applications to use their
133  * own random number generation method.  For example, it might be possible to
134  * generate a random number by sampling noise on an analogue input. */
135 extern uint32_t ulRand();
136 #define ipconfigRAND32()    ulRand()
137 
138 /* If ipconfigUSE_NETWORK_EVENT_HOOK is set to 1 then FreeRTOS+TCP will call the
139  * network event hook at the appropriate times.  If ipconfigUSE_NETWORK_EVENT_HOOK
140  * is not set to 1 then the network event hook will never be called. See:
141  * http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_UDP/API/vApplicationIPNetworkEventHook.shtml.
142  */
143 #define ipconfigUSE_NETWORK_EVENT_HOOK           1
144 
145 /* Sockets have a send block time attribute.  If FreeRTOS_sendto() is called but
146  * a network buffer cannot be obtained then the calling task is held in the Blocked
147  * state (so other tasks can continue to executed) until either a network buffer
148  * becomes available or the send block time expires.  If the send block time expires
149  * then the send operation is aborted.  The maximum allowable send block time is
150  * capped to the value set by ipconfigMAX_SEND_BLOCK_TIME_TICKS.  Capping the
151  * maximum allowable send block time prevents prevents a deadlock occurring when
152  * all the network buffers are in use and the tasks that process (and subsequently
153  * free) the network buffers are themselves blocked waiting for a network buffer.
154  * ipconfigMAX_SEND_BLOCK_TIME_TICKS is specified in RTOS ticks.  A time in
155  * milliseconds can be converted to a time in ticks by dividing the time in
156  * milliseconds by portTICK_PERIOD_MS. */
157 #define ipconfigUDP_MAX_SEND_BLOCK_TIME_TICKS    ( 5000U / portTICK_PERIOD_MS )
158 
159 /* If ipconfigUSE_DHCP is 1 then FreeRTOS+TCP will attempt to retrieve an IP
160  * address, netmask, DNS server address and gateway address from a DHCP server.  If
161  * ipconfigUSE_DHCP is 0 then FreeRTOS+TCP will use a static IP address.  The
162  * stack will revert to using the static IP address even when ipconfigUSE_DHCP is
163  * set to 1 if a valid configuration cannot be obtained from a DHCP server for any
164  * reason.  The static configuration used is that passed into the stack by the
165  * FreeRTOS_IPInit() function call. */
166 #define ipconfigUSE_DHCP                         1
167 #define ipconfigDHCP_REGISTER_HOSTNAME           1
168 #define ipconfigDHCP_USES_UNICAST                1
169 
170 /* If ipconfigDHCP_USES_USER_HOOK is set to 1 then the application writer must
171  * provide an implementation of the DHCP callback function,
172  * xApplicationDHCPUserHook(). */
173 #define ipconfigUSE_DHCP_HOOK                    1
174 
175 /* When ipconfigUSE_DHCP is set to 1, DHCP requests will be sent out at
176  * increasing time intervals until either a reply is received from a DHCP server
177  * and accepted, or the interval between transmissions reaches
178  * ipconfigMAXIMUM_DISCOVER_TX_PERIOD.  The IP stack will revert to using the
179  * static IP address passed as a parameter to FreeRTOS_IPInit() if the
180  * re-transmission time interval reaches ipconfigMAXIMUM_DISCOVER_TX_PERIOD without
181  * a DHCP reply being received. */
182 #define ipconfigMAXIMUM_DISCOVER_TX_PERIOD \
183     ( 120000U / portTICK_PERIOD_MS )
184 
185 /* The ARP cache is a table that maps IP addresses to MAC addresses.  The IP
186  * stack can only send a UDP message to a remove IP address if it knowns the MAC
187  * address associated with the IP address, or the MAC address of the router used to
188  * contact the remote IP address.  When a UDP message is received from a remote IP
189  * address the MAC address and IP address are added to the ARP cache.  When a UDP
190  * message is sent to a remote IP address that does not already appear in the ARP
191  * cache then the UDP message is replaced by a ARP message that solicits the
192  * required MAC address information.  ipconfigARP_CACHE_ENTRIES defines the maximum
193  * number of entries that can exist in the ARP table at any one time. */
194 #define ipconfigARP_CACHE_ENTRIES                 6
195 
196 /* ARP requests that do not result in an ARP response will be re-transmitted a
197  * maximum of ipconfigMAX_ARP_RETRANSMISSIONS times before the ARP request is
198  * aborted. */
199 #define ipconfigMAX_ARP_RETRANSMISSIONS           ( 5 )
200 
201 /* ipconfigMAX_ARP_AGE defines the maximum time between an entry in the ARP
202  * table being created or refreshed and the entry being removed because it is stale.
203  * New ARP requests are sent for ARP cache entries that are nearing their maximum
204  * age.  ipconfigMAX_ARP_AGE is specified in tens of seconds, so a value of 150 is
205  * equal to 1500 seconds (or 25 minutes). */
206 #define ipconfigMAX_ARP_AGE                       150
207 
208 /* Implementing FreeRTOS_inet_addr() necessitates the use of string handling
209  * routines, which are relatively large.  To save code space the full
210  * FreeRTOS_inet_addr() implementation is made optional, and a smaller and faster
211  * alternative called FreeRTOS_inet_addr_quick() is provided.  FreeRTOS_inet_addr()
212  * takes an IP in decimal dot format (for example, "192.168.0.1") as its parameter.
213  * FreeRTOS_inet_addr_quick() takes an IP address as four separate numerical octets
214  * (for example, 192, 168, 0, 1) as its parameters.  If
215  * ipconfigINCLUDE_FULL_INET_ADDR is set to 1 then both FreeRTOS_inet_addr() and
216  * FreeRTOS_indet_addr_quick() are available.  If ipconfigINCLUDE_FULL_INET_ADDR is
217  * not set to 1 then only FreeRTOS_indet_addr_quick() is available. */
218 #define ipconfigINCLUDE_FULL_INET_ADDR            1
219 
220 /* ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS defines the total number of network buffer that
221  * are available to the IP stack.  The total number of network buffers is limited
222  * to ensure the total amount of RAM that can be consumed by the IP stack is capped
223  * to a pre-determinable value. */
224 #define ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS    60
225 
226 /* A FreeRTOS queue is used to send events from application tasks to the IP
227  * stack.  ipconfigEVENT_QUEUE_LENGTH sets the maximum number of events that can
228  * be queued for processing at any one time.  The event queue must be a minimum of
229  * 5 greater than the total number of network buffers. */
230 #define ipconfigEVENT_QUEUE_LENGTH \
231     ( ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS + 5 )
232 
233 /* The address of a socket is the combination of its IP address and its port
234  * number.  FreeRTOS_bind() is used to manually allocate a port number to a socket
235  * (to 'bind' the socket to a port), but manual binding is not normally necessary
236  * for client sockets (those sockets that initiate outgoing connections rather than
237  * wait for incoming connections on a known port number).  If
238  * ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND is set to 1 then calling
239  * FreeRTOS_sendto() on a socket that has not yet been bound will result in the IP
240  * stack automatically binding the socket to a port number from the range
241  * socketAUTO_PORT_ALLOCATION_START_NUMBER to 0xffff.  If
242  * ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND is set to 0 then calling FreeRTOS_sendto()
243  * on a socket that has not yet been bound will result in the send operation being
244  * aborted. */
245 #define ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND         1
246 
247 /* Defines the Time To Live (TTL) values used in outgoing UDP packets. */
248 #define ipconfigUDP_TIME_TO_LIVE                       128
249 /* Also defined in FreeRTOSIPConfigDefaults.h. */
250 #define ipconfigTCP_TIME_TO_LIVE                       128
251 
252 /* USE_TCP: Use TCP and all its features. */
253 #define ipconfigUSE_TCP                                ( 1 )
254 
255 /* USE_WIN: Let TCP use windowing mechanism. */
256 #define ipconfigUSE_TCP_WIN                            ( 1 )
257 
258 /* The MTU is the maximum number of bytes the payload of a network frame can
259  * contain.  For normal Ethernet V2 frames the maximum MTU is 1500.  Setting a
260  * lower value can save RAM, depending on the buffer management scheme used.  If
261  * ipconfigCAN_FRAGMENT_OUTGOING_PACKETS is 1 then (ipconfigNETWORK_MTU - 28) must
262  * be divisible by 8. */
263 #define ipconfigNETWORK_MTU                            1500U
264 
265 /* Set ipconfigUSE_DNS to 1 to include a basic DNS client/resolver.  DNS is used
266  * through the FreeRTOS_gethostbyname() API function. */
267 #define ipconfigUSE_DNS                                1
268 
269 /* If ipconfigREPLY_TO_INCOMING_PINGS is set to 1 then the IP stack will
270  * generate replies to incoming ICMP echo (ping) requests. */
271 #define ipconfigREPLY_TO_INCOMING_PINGS                1
272 
273 /* If ipconfigSUPPORT_OUTGOING_PINGS is set to 1 then the
274  * FreeRTOS_SendPingRequest() API function is available. */
275 #define ipconfigSUPPORT_OUTGOING_PINGS                 1
276 
277 /* If ipconfigSUPPORT_SELECT_FUNCTION is set to 1 then the FreeRTOS_select()
278  * (and associated) API function is available. */
279 #define ipconfigSUPPORT_SELECT_FUNCTION                1
280 
281 /* If ipconfigFILTER_OUT_NON_ETHERNET_II_FRAMES is set to 1 then Ethernet frames
282  * that are not in Ethernet II format will be dropped.  This option is included for
283  * potential future IP stack developments. */
284 #define ipconfigFILTER_OUT_NON_ETHERNET_II_FRAMES      1
285 
286 /* If ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES is set to 1 then it is the
287  * responsibility of the Ethernet interface to filter out packets that are of no
288  * interest.  If the Ethernet interface does not implement this functionality, then
289  * set ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES to 0 to have the IP stack
290  * perform the filtering instead (it is much less efficient for the stack to do it
291  * because the packet will already have been passed into the stack).  If the
292  * Ethernet driver does all the necessary filtering in hardware then software
293  * filtering can be removed by using a value other than 1 or 0. */
294 #define ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES    1
295 
296 /* The windows simulator cannot really simulate MAC interrupts, and needs to
297  * block occasionally to allow other tasks to run. */
298 #define configWINDOWS_MAC_INTERRUPT_SIMULATOR_DELAY    ( 20 / portTICK_PERIOD_MS )
299 
300 /* Advanced only: in order to access 32-bit fields in the IP packets with
301  * 32-bit memory instructions, all packets will be stored 32-bit-aligned,
302  * plus 16-bits. This has to do with the contents of the IP-packets: all
303  * 32-bit fields are 32-bit-aligned, plus 16-bit. */
304 #define ipconfigPACKET_FILLER_SIZE                     2U
305 
306 /* Define the size of the pool of TCP window descriptors.  On the average, each
307  * TCP socket will use up to 2 x 6 descriptors, meaning that it can have 2 x 6
308  * outstanding packets (for Rx and Tx).  When using up to 10 TP sockets
309  * simultaneously, one could define TCP_WIN_SEG_COUNT as 120. */
310 #define ipconfigTCP_WIN_SEG_COUNT                      240
311 
312 /* Each TCP socket has a circular buffers for Rx and Tx, which have a fixed
313  * maximum size.  Define the size of Rx buffer for TCP sockets. */
314 #define ipconfigTCP_RX_BUFFER_LENGTH                   ( 10000 )
315 
316 /* Define the size of Tx buffer for TCP sockets. */
317 #define ipconfigTCP_TX_BUFFER_LENGTH                   ( 10000 )
318 
319 /* When using call-back handlers, the driver may check if the handler points to
320  * real program memory (RAM or flash) or just has a random non-zero value. */
321 #define ipconfigIS_VALID_PROG_ADDRESS( x )    ( ( x ) != NULL )
322 
323 /* Include support for TCP keep-alive messages. */
324 #define ipconfigTCP_KEEP_ALIVE                   ( 1 )
325 #define ipconfigTCP_KEEP_ALIVE_INTERVAL          ( 20 ) /* Seconds. */
326 
327 /* The socket semaphore is used to unblock the MQTT task. */
328 #define ipconfigSOCKET_HAS_USER_SEMAPHORE        ( 1 )
329 
330 #define ipconfigSOCKET_HAS_USER_WAKE_CALLBACK    ( 1 )
331 #define ipconfigUSE_CALLBACKS                    ( 1 )
332 
333 
334 #define portINLINE                               __inline
335 
336 #endif /* FREERTOS_IP_CONFIG_H */
337