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