1 /* 2 * FreeRTOS V202212.00 3 * Copyright (C) 2020 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 * https://www.FreeRTOS.org 23 * https://github.com/FreeRTOS 24 * 25 */ 26 27 28 /***************************************************************************** 29 * 30 * See the following URL for configuration information. 31 * https://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_IP_Configuration.html 32 * 33 *****************************************************************************/ 34 35 #ifndef FREERTOS_IP_CONFIG_H 36 #define FREERTOS_IP_CONFIG_H 37 38 #ifdef HEAP3 39 #define xPortGetMinimumEverFreeHeapSize( x ) 0 40 #define xPortGetFreeHeapSize() 0 41 #endif 42 43 /* Prototype for the function used to print out. In this case it prints to the 44 * console before the network is connected then a UDP port after the network has 45 * connected. */ 46 extern void vLoggingPrintf( const char * pcFormatString, 47 ... ); 48 49 /* Set to 1 to enable IPv4. */ 50 #define ipconfigUSE_IPv4 ( 1 ) 51 52 /* Set to 1 to enable IPv6. */ 53 #define ipconfigUSE_IPv6 ( 1 ) 54 55 /* Set to 0 to disable backward compatible. */ 56 #define ipconfigIPv4_BACKWARD_COMPATIBLE 0 57 58 /* Set to 0 to disable compatible for multiple end-points/interfaces. 59 * Only one interface/end-point is allowed to use when ipconfigCOMPATIBLE_WITH_SINGLE 60 * is set to 1. */ 61 #define ipconfigCOMPATIBLE_WITH_SINGLE 0 62 63 /* Set to 1 to print out debug messages. If ipconfigHAS_DEBUG_PRINTF is set to 64 * 1 then FreeRTOS_debug_printf should be defined to the function used to print 65 * out the debugging messages. */ 66 #define ipconfigHAS_DEBUG_PRINTF 1 67 #if ( ipconfigHAS_DEBUG_PRINTF == 1 ) 68 #define FreeRTOS_debug_printf( X ) vLoggingPrintf X 69 #endif 70 71 /* Set to 1 to print out non debugging messages, for example the output of the 72 * FreeRTOS_netstat() command, and ping replies. If ipconfigHAS_PRINTF is set to 1 73 * then FreeRTOS_printf should be set to the function used to print out the 74 * messages. */ 75 #define ipconfigHAS_PRINTF 1 76 #if ( ipconfigHAS_PRINTF == 1 ) 77 #define FreeRTOS_printf( X ) vLoggingPrintf X 78 #endif 79 80 /* Define the byte order of the target MCU (the MCU FreeRTOS+TCP is executing 81 * on). Valid options are pdFREERTOS_BIG_ENDIAN and pdFREERTOS_LITTLE_ENDIAN. */ 82 #define ipconfigBYTE_ORDER pdFREERTOS_LITTLE_ENDIAN 83 84 /* If the network card/driver includes checksum offloading (IP/TCP/UDP checksums) 85 * then set ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software 86 * stack repeating the checksum calculations. */ 87 #define ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM 1 88 89 /* Several API's will block until the result is known, or the action has been 90 * performed, for example FreeRTOS_send() and FreeRTOS_recv(). The timeouts can be 91 * set per socket, using setsockopt(). If not set, the times below will be 92 * used as defaults. */ 93 #define ipconfigSOCK_DEFAULT_RECEIVE_BLOCK_TIME ( 5000 ) 94 #define ipconfigSOCK_DEFAULT_SEND_BLOCK_TIME ( 5000 ) 95 96 /* Include support for LLMNR: Link-local Multicast Name Resolution 97 * (non-Microsoft) */ 98 #define ipconfigUSE_LLMNR ( 1 ) 99 100 /* Include support for NBNS: NetBIOS Name Service (Microsoft) */ 101 #define ipconfigUSE_NBNS ( 1 ) 102 103 /* Include support for DNS caching. For TCP, having a small DNS cache is very 104 * useful. When a cache is present, ipconfigDNS_REQUEST_ATTEMPTS can be kept low 105 * and also DNS may use small timeouts. If a DNS reply comes in after the DNS 106 * socket has been destroyed, the result will be stored into the cache. The next 107 * call to FreeRTOS_gethostbyname() will return immediately, without even creating 108 * a socket. */ 109 #define ipconfigUSE_DNS_CACHE ( 1 ) 110 #define ipconfigDNS_CACHE_NAME_LENGTH ( 16 ) 111 #define ipconfigDNS_CACHE_ENTRIES ( 4 ) 112 #define ipconfigDNS_REQUEST_ATTEMPTS ( 2 ) 113 114 /* The IP stack executes it its own task (although any application task can make 115 * use of its services through the published sockets API). ipconfigUDP_TASK_PRIORITY 116 * sets the priority of the task that executes the IP stack. The priority is a 117 * standard FreeRTOS task priority so can take any value from 0 (the lowest 118 * priority) to (configMAX_PRIORITIES - 1) (the highest priority). 119 * configMAX_PRIORITIES is a standard FreeRTOS configuration parameter defined in 120 * FreeRTOSConfig.h, not FreeRTOSIPConfig.h. Consideration needs to be given as to 121 * the priority assigned to the task executing the IP stack relative to the 122 * priority assigned to tasks that use the IP stack. */ 123 #define ipconfigIP_TASK_PRIORITY ( configMAX_PRIORITIES - 2 ) 124 125 /* The size, in words (not bytes), of the stack allocated to the FreeRTOS+TCP 126 * task. This setting is less important when the FreeRTOS Win32 simulator is used 127 * as the Win32 simulator only stores a fixed amount of information on the task 128 * stack. FreeRTOS includes optional stack overflow detection, see: 129 * http://www.freertos.org/Stacks-and-stack-overflow-checking.html */ 130 #define ipconfigIP_TASK_STACK_SIZE_WORDS ( configMINIMAL_STACK_SIZE * 5 ) 131 132 /* If ipconfigUSE_NETWORK_EVENT_HOOK is set to 1 then FreeRTOS+TCP will call the 133 * network event hook at the appropriate times. If ipconfigUSE_NETWORK_EVENT_HOOK 134 * is not set to 1 then the network event hook will never be called. See 135 * http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_UDP/API/vApplicationIPNetworkEventHook.shtml 136 */ 137 #define ipconfigUSE_NETWORK_EVENT_HOOK 1 138 139 /* Sockets have a send block time attribute. If FreeRTOS_sendto() is called but 140 * a network buffer cannot be obtained then the calling task is held in the Blocked 141 * state (so other tasks can continue to executed) until either a network buffer 142 * becomes available or the send block time expires. If the send block time expires 143 * then the send operation is aborted. The maximum allowable send block time is 144 * capped to the value set by ipconfigMAX_SEND_BLOCK_TIME_TICKS. Capping the 145 * maximum allowable send block time prevents prevents a deadlock occurring when 146 * all the network buffers are in use and the tasks that process (and subsequently 147 * free) the network buffers are themselves blocked waiting for a network buffer. 148 * ipconfigMAX_SEND_BLOCK_TIME_TICKS is specified in RTOS ticks. A time in 149 * milliseconds can be converted to a time in ticks by dividing the time in 150 * milliseconds by portTICK_PERIOD_MS. */ 151 #define ipconfigUDP_MAX_SEND_BLOCK_TIME_TICKS ( 5000U / portTICK_PERIOD_MS ) 152 153 /* If ipconfigUSE_DHCP is 1 then FreeRTOS+TCP will attempt to retrieve an IP 154 * address, netmask, DNS server address and gateway address from a DHCP server. If 155 * ipconfigUSE_DHCP is 0 then FreeRTOS+TCP will use a static IP address. The 156 * stack will revert to using the static IP address even when ipconfigUSE_DHCP is 157 * set to 1 if a valid configuration cannot be obtained from a DHCP server for any 158 * reason. The static configuration used is that passed into the stack by the 159 * FreeRTOS_IPInit() function call. */ 160 #define ipconfigUSE_DHCP 1 161 162 /* When ipconfigUSE_DHCP is set to 1, DHCP requests will be sent out at 163 * increasing time intervals until either a reply is received from a DHCP server 164 * and accepted, or the interval between transmissions reaches 165 * ipconfigMAXIMUM_DISCOVER_TX_PERIOD. The IP stack will revert to using the 166 * static IP address passed as a parameter to FreeRTOS_IPInit() if the 167 * re-transmission time interval reaches ipconfigMAXIMUM_DISCOVER_TX_PERIOD without 168 * a DHCP reply being received. */ 169 #define ipconfigMAXIMUM_DISCOVER_TX_PERIOD ( 120000U / portTICK_PERIOD_MS ) 170 171 /* The ARP cache is a table that maps IP addresses to MAC addresses. The IP 172 * stack can only send a UDP message to a remove IP address if it knowns the MAC 173 * address associated with the IP address, or the MAC address of the router used to 174 * contact the remote IP address. When a UDP message is received from a remote IP 175 * address the MAC address and IP address are added to the ARP cache. When a UDP 176 * message is sent to a remote IP address that does not already appear in the ARP 177 * cache then the UDP message is replaced by a ARP message that solicits the 178 * required MAC address information. ipconfigARP_CACHE_ENTRIES defines the maximum 179 * number of entries that can exist in the ARP table at any one time. */ 180 #define ipconfigARP_CACHE_ENTRIES 6 181 182 /* ARP requests that do not result in an ARP response will be re-transmitted a 183 * maximum of ipconfigMAX_ARP_RETRANSMISSIONS times before the ARP request is 184 * aborted. */ 185 #define ipconfigMAX_ARP_RETRANSMISSIONS ( 5 ) 186 187 /* ipconfigMAX_ARP_AGE defines the maximum time between an entry in the ARP 188 * table being created or refreshed and the entry being removed because it is stale. 189 * New ARP requests are sent for ARP cache entries that are nearing their maximum 190 * age. ipconfigMAX_ARP_AGE is specified in tens of seconds, so a value of 150 is 191 * equal to 1500 seconds (or 25 minutes). */ 192 #define ipconfigMAX_ARP_AGE 150 193 194 /* Implementing FreeRTOS_inet_addr() necessitates the use of string handling 195 * routines, which are relatively large. To save code space the full 196 * FreeRTOS_inet_addr() implementation is made optional, and a smaller and faster 197 * alternative called FreeRTOS_inet_addr_quick() is provided. FreeRTOS_inet_addr() 198 * takes an IP in decimal dot format (for example, "192.168.0.1") as its parameter. 199 * FreeRTOS_inet_addr_quick() takes an IP address as four separate numerical octets 200 * (for example, 192, 168, 0, 1) as its parameters. If 201 * ipconfigINCLUDE_FULL_INET_ADDR is set to 1 then both FreeRTOS_inet_addr() and 202 * FreeRTOS_indet_addr_quick() are available. If ipconfigINCLUDE_FULL_INET_ADDR is 203 * not set to 1 then only FreeRTOS_indet_addr_quick() is available. */ 204 #define ipconfigINCLUDE_FULL_INET_ADDR 1 205 206 /* ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS defines the total number of network buffer that 207 * are available to the IP stack. The total number of network buffers is limited 208 * to ensure the total amount of RAM that can be consumed by the IP stack is capped 209 * to a pre-determinable value. */ 210 #define ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS 60 211 212 /* A FreeRTOS queue is used to send events from application tasks to the IP 213 * stack. ipconfigEVENT_QUEUE_LENGTH sets the maximum number of events that can 214 * be queued for processing at any one time. The event queue must be a minimum of 215 * 5 greater than the total number of network buffers. */ 216 #define ipconfigEVENT_QUEUE_LENGTH ( ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS + 5 ) 217 218 /* The address of a socket is the combination of its IP address and its port 219 * number. FreeRTOS_bind() is used to manually allocate a port number to a socket 220 * (to 'bind' the socket to a port), but manual binding is not normally necessary 221 * for client sockets (those sockets that initiate outgoing connections rather than 222 * wait for incoming connections on a known port number). If 223 * ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND is set to 1 then calling 224 * FreeRTOS_sendto() on a socket that has not yet been bound will result in the IP 225 * stack automatically binding the socket to a port number from the range 226 * socketAUTO_PORT_ALLOCATION_START_NUMBER to 0xffff. If 227 * ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND is set to 0 then calling FreeRTOS_sendto() 228 * on a socket that has not yet been bound will result in the send operation being 229 * aborted. */ 230 #define ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND 1 231 232 /* Defines the Time To Live (TTL) values used in outgoing UDP packets. */ 233 #define ipconfigUDP_TIME_TO_LIVE 128 234 #define ipconfigTCP_TIME_TO_LIVE 128 /* also defined in FreeRTOSIPConfigDefaults.h */ 235 236 /* USE_TCP: Use TCP and all its features */ 237 #define ipconfigUSE_TCP ( 1 ) 238 239 /* USE_WIN: Let TCP use windowing mechanism. */ 240 #define ipconfigUSE_TCP_WIN ( 1 ) 241 242 /* The MTU is the maximum number of bytes the payload of a network frame can 243 * contain. For normal Ethernet V2 frames the maximum MTU is 1500. Setting a 244 * lower value can save RAM, depending on the buffer management scheme used. If 245 * ipconfigCAN_FRAGMENT_OUTGOING_PACKETS is 1 then (ipconfigNETWORK_MTU - 28) must 246 * be divisible by 8. */ 247 #define ipconfigNETWORK_MTU 1500U 248 249 /* Set ipconfigUSE_DNS to 1 to include a basic DNS client/resolver. DNS is used 250 * through the FreeRTOS_gethostbyname() API function. */ 251 #define ipconfigUSE_DNS 1 252 253 /* If ipconfigREPLY_TO_INCOMING_PINGS is set to 1 then the IP stack will 254 * generate replies to incoming ICMP echo (ping) requests. */ 255 #define ipconfigREPLY_TO_INCOMING_PINGS 1 256 257 /* If ipconfigSUPPORT_OUTGOING_PINGS is set to 1 then the 258 * FreeRTOS_SendPingRequest() API function is available. */ 259 #define ipconfigSUPPORT_OUTGOING_PINGS 0 260 261 /* If ipconfigSUPPORT_SELECT_FUNCTION is set to 1 then the FreeRTOS_select() 262 * (and associated) API function is available. */ 263 #define ipconfigSUPPORT_SELECT_FUNCTION 1 264 265 /* If ipconfigFILTER_OUT_NON_ETHERNET_II_FRAMES is set to 1 then Ethernet frames 266 * that are not in Ethernet II format will be dropped. This option is included for 267 * potential future IP stack developments. */ 268 #define ipconfigFILTER_OUT_NON_ETHERNET_II_FRAMES 1 269 270 /* If ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES is set to 1 then it is the 271 * responsibility of the Ethernet interface to filter out packets that are of no 272 * interest. If the Ethernet interface does not implement this functionality, then 273 * set ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES to 0 to have the IP stack 274 * perform the filtering instead (it is much less efficient for the stack to do it 275 * because the packet will already have been passed into the stack). If the 276 * Ethernet driver does all the necessary filtering in hardware then software 277 * filtering can be removed by using a value other than 1 or 0. */ 278 #define ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES 1 279 280 /* The Linux simulator cannot really simulate MAC interrupts, and needs to 281 * block occasionally to allow other tasks to run. */ 282 #define configWINDOWS_MAC_INTERRUPT_SIMULATOR_DELAY ( 20 / portTICK_PERIOD_MS ) 283 284 /* Advanced only: in order to access 32-bit fields in the IP packets with 285 * 32-bit memory instructions, all packets will be stored 32-bit-aligned, plus 16-bits. 286 * This has to do with the contents of the IP-packets: all 32-bit fields are 287 * 32-bit-aligned, plus 16-bit(!) */ 288 #define ipconfigPACKET_FILLER_SIZE 2U 289 290 /* Define the size of the pool of TCP window descriptors. On the average, each 291 * TCP socket will use up to 2 x 6 descriptors, meaning that it can have 2 x 6 292 * outstanding packets (for Rx and Tx). When using up to 10 TP sockets 293 * simultaneously, one could define TCP_WIN_SEG_COUNT as 120. */ 294 #define ipconfigTCP_WIN_SEG_COUNT 240 295 296 /* Each TCP socket has a circular buffers for Rx and Tx, which have a fixed 297 * maximum size. Define the size of Rx buffer for TCP sockets. */ 298 #define ipconfigTCP_RX_BUFFER_LENGTH ( 1000 ) 299 300 /* Define the size of Tx buffer for TCP sockets. */ 301 #define ipconfigTCP_TX_BUFFER_LENGTH ( 1000 ) 302 303 /* When using call-back handlers, the driver may check if the handler points to 304 * real program memory (RAM or flash) or just has a random non-zero value. */ 305 #define ipconfigIS_VALID_PROG_ADDRESS( x ) ( ( x ) != NULL ) 306 307 /* Include support for TCP hang protection. All sockets in a connecting or 308 * disconnecting stage will timeout after a period of non-activity. */ 309 #define ipconfigTCP_HANG_PROTECTION ( 1 ) 310 #define ipconfigTCP_HANG_PROTECTION_TIME ( 30 ) 311 312 /* Include support for TCP keep-alive messages. */ 313 #define ipconfigTCP_KEEP_ALIVE ( 1 ) 314 #define ipconfigTCP_KEEP_ALIVE_INTERVAL ( 20 ) /* in seconds */ 315 316 #define portINLINE __inline 317 318 /* Set ipconfigBUFFER_PADDING on 64-bit platforms */ 319 #if INTPTR_MAX == INT64_MAX 320 #define ipconfigBUFFER_PADDING ( 14U ) 321 #endif /* INTPTR_MAX == INT64_MAX */ 322 323 #define ipconfigETHERNET_DRIVER_FILTERS_PACKETS ( 1 ) 324 325 #endif /* FREERTOS_IP_CONFIG_H */ 326