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