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