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