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