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 #ifndef FREERTOS_CONFIG_H
28 #define FREERTOS_CONFIG_H
29 
30 /*-----------------------------------------------------------
31 * Application specific definitions.
32 *
33 * These definitions should be adjusted for your particular hardware and
34 * application requirements.
35 *
36 * THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE
37 * FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE.
38 * https://www.FreeRTOS.org/a00110.html
39 *
40 * The bottom of this file contains some constants specific to running the UDP
41 * stack in this demo.  Constants specific to FreeRTOS+TCP itself (rather than
42 * the demo) are contained in FreeRTOSIPConfig.h.
43 *----------------------------------------------------------*/
44 #define configENABLE_BACKWARD_COMPATIBILITY        1
45 #define configUSE_PREEMPTION                       1
46 #define configUSE_PORT_OPTIMISED_TASK_SELECTION    1
47 #define configMAX_PRIORITIES                       ( 7 )
48 #define configTICK_RATE_HZ                         ( 1000 )                  /* In this non-real time simulated environment the tick frequency has to be at least a multiple of the Win32 tick frequency, and therefore very slow. */
49 #define configMINIMAL_STACK_SIZE                   ( ( unsigned short ) 60 ) /* In this simulated case, the stack only has to hold one small structure as the real stack is part of the Win32 thread. */
50 #define configTOTAL_HEAP_SIZE                      ( ( size_t ) ( 2048U * 1024U ) )
51 #define configMAX_TASK_NAME_LEN                    ( 15 )
52 #define configUSE_TRACE_FACILITY                   1
53 #define configUSE_16_BIT_TICKS                     0
54 #define configIDLE_SHOULD_YIELD                    1
55 #define configUSE_MUTEXES                          1
56 #define configUSE_RECURSIVE_MUTEXES                1
57 #define configQUEUE_REGISTRY_SIZE                  0
58 #define configUSE_APPLICATION_TASK_TAG             0
59 #define configUSE_COUNTING_SEMAPHORES              1
60 #define configUSE_ALTERNATIVE_API                  0
61 #define configNUM_THREAD_LOCAL_STORAGE_POINTERS    3 /* FreeRTOS+FAT requires 2 pointers if a CWD is supported. */
62 
63 /* Hook function related definitions. */
64 #define configUSE_TICK_HOOK                        0
65 #define configUSE_IDLE_HOOK                        1
66 #define configUSE_MALLOC_FAILED_HOOK               0
67 #define configCHECK_FOR_STACK_OVERFLOW             0 /* Not applicable to the Win32 port. */
68 
69 /* Software timer related definitions. */
70 #define configUSE_TIMERS                           1
71 #define configTIMER_TASK_PRIORITY                  ( configMAX_PRIORITIES - 1 )
72 #define configTIMER_QUEUE_LENGTH                   5
73 #define configTIMER_TASK_STACK_DEPTH               ( configMINIMAL_STACK_SIZE * 2 )
74 
75 /* Event group related definitions. */
76 #define configUSE_EVENT_GROUPS                     1
77 
78 /* Run time stats gathering definitions. */
79 #define configGENERATE_RUN_TIME_STATS              0
80 
81 /* Set the following definitions to 1 to include the API function, or zero
82  * to exclude the API function. */
83 #define INCLUDE_vTaskPrioritySet                   1
84 #define INCLUDE_uxTaskPriorityGet                  1
85 #define INCLUDE_vTaskDelete                        1
86 #define INCLUDE_vTaskCleanUpResources              0
87 #define INCLUDE_vTaskSuspend                       1
88 #define INCLUDE_vTaskDelayUntil                    1
89 #define INCLUDE_vTaskDelay                         1
90 #define INCLUDE_uxTaskGetStackHighWaterMark        1
91 #define INCLUDE_xTaskGetSchedulerState             1
92 #define INCLUDE_xTimerGetTimerTaskHandle           0
93 #define INCLUDE_xTaskGetIdleTaskHandle             0
94 #define INCLUDE_xQueueGetMutexHolder               1
95 #define INCLUDE_eTaskGetState                      1
96 #define INCLUDE_xEventGroupSetBitsFromISR          1
97 #define INCLUDE_xTimerPendFunctionCall             1
98 #define INCLUDE_pcTaskGetTaskName                  1
99 
100 /* This demo makes use of one or more example stats formatting functions.  These
101  * format the raw data provided by the uxTaskGetSystemState() function in to human
102  * readable ASCII form.  See the notes in the implementation of vTaskList() within
103  * FreeRTOS/Source/tasks.c for limitations.  configUSE_STATS_FORMATTING_FUNCTIONS
104  * is set to 2 so the formatting functions are included without the stdio.h being
105  * included in tasks.c.  That is because this project defines its own sprintf()
106  * functions. */
107 #define configUSE_STATS_FORMATTING_FUNCTIONS       1
108 
109 /* Assert call defined for debug builds. */
110 #ifdef _DEBUG
111     extern void vAssertCalled( const char * pcFile,
112                                uint32_t ulLine );
113     #define configASSERT( x )    if( ( x ) == 0 ) vAssertCalled( __FILE__, __LINE__ )
114 #endif /* _DEBUG */
115 
116 
117 
118 /* Application specific definitions follow. **********************************/
119 
120 /* If configINCLUDE_DEMO_DEBUG_STATS is set to one, then a few basic IP trace
121  * macros are defined to gather some UDP stack statistics that can then be viewed
122  * through the CLI interface. */
123 #define configINCLUDE_DEMO_DEBUG_STATS       1
124 
125 /* The size of the global output buffer that is available for use when there
126  * are multiple command interpreters running at once (for example, one on a UART
127  * and one on TCP/IP).  This is done to prevent an output buffer being defined by
128  * each implementation - which would waste RAM.  In this case, there is only one
129  * command interpreter running, and it has its own local output buffer, so the
130  * global buffer is just set to be one byte long as it is not used and should not
131  * take up unnecessary RAM. */
132 #define configCOMMAND_INT_MAX_OUTPUT_SIZE    1
133 
134 /* Only used when running in the FreeRTOS Windows simulator.  Defines the
135  * priority of the task used to simulate Ethernet interrupts. */
136 #define configMAC_ISR_SIMULATOR_PRIORITY     ( configMAX_PRIORITIES - 1 )
137 
138 /* This demo creates a virtual network connection by accessing the raw Ethernet
139  * or WiFi data to and from a real network connection.  Many computers have more
140  * than one real network port, and configNETWORK_INTERFACE_TO_USE is used to tell
141  * the demo which real port should be used to create the virtual port.  The ports
142  * available are displayed on the console when the application is executed.  For
143  * example, on my development laptop setting configNETWORK_INTERFACE_TO_USE to 4
144  * results in the wired network being used, while setting
145  * configNETWORK_INTERFACE_TO_USE to 2 results in the wireless network being
146  * used. */
147 #define configNETWORK_INTERFACE_TO_USE       6L
148 
149 /* The address of an echo server that will be used by the two demo echo client
150  * tasks.
151  * http://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_Echo_Clients.html
152  * http://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/UDP_Echo_Clients.html */
153 #define configECHO_SERVER_ADDR0              192
154 #define configECHO_SERVER_ADDR1              168
155 #define configECHO_SERVER_ADDR2              0
156 #define configECHO_SERVER_ADDR3              11
157 
158 /* Default MAC address configuration.  The demo creates a virtual network
159  * connection that uses this MAC address by accessing the raw Ethernet/WiFi data
160  * to and from a real network connection on the host PC.  See the
161  * configNETWORK_INTERFACE_TO_USE definition above for information on how to
162  * configure the real network connection to use. */
163 #define configMAC_ADDR0                      0x00
164 #define configMAC_ADDR1                      0x11
165 #define configMAC_ADDR2                      0x22
166 #define configMAC_ADDR3                      0x33
167 #define configMAC_ADDR4                      0x44
168 #define configMAC_ADDR5                      0x41
169 
170 /* Default IP address configuration.  Used in ipconfigUSE_DNS is set to 0, or
171  * ipconfigUSE_DNS is set to 1 but a DNS server cannot be contacted. */
172 #define configIP_ADDR0                       10
173 #define configIP_ADDR1                       10
174 #define configIP_ADDR2                       10
175 #define configIP_ADDR3                       200
176 
177 /* Default gateway IP address configuration.  Used in ipconfigUSE_DNS is set to
178  * 0, or ipconfigUSE_DNS is set to 1 but a DNS server cannot be contacted. */
179 #define configGATEWAY_ADDR0                  10
180 #define configGATEWAY_ADDR1                  10
181 #define configGATEWAY_ADDR2                  10
182 #define configGATEWAY_ADDR3                  1
183 
184 /* Default DNS server configuration.  OpenDNS addresses are 208.67.222.222 and
185  * 208.67.220.220.  Used in ipconfigUSE_DNS is set to 0, or ipconfigUSE_DNS is set
186  * to 1 but a DNS server cannot be contacted.*/
187 #define configDNS_SERVER_ADDR0               208
188 #define configDNS_SERVER_ADDR1               67
189 #define configDNS_SERVER_ADDR2               222
190 #define configDNS_SERVER_ADDR3               222
191 
192 /* Default netmask configuration.  Used in ipconfigUSE_DNS is set to 0, or
193  * ipconfigUSE_DNS is set to 1 but a DNS server cannot be contacted. */
194 #define configNET_MASK0                      255
195 #define configNET_MASK1                      0
196 #define configNET_MASK2                      0
197 #define configNET_MASK3                      0
198 
199 /* The UDP port to which print messages are sent. */
200 #define configPRINT_PORT                     ( 15000 )
201 
202 #if ( defined( _MSC_VER ) && ( _MSC_VER <= 1600 ) && !defined( snprintf ) )
203     /* Map to Windows names. */
204     #define snprintf     _snprintf
205     #define vsnprintf    _vsnprintf
206 #endif
207 
208 /* Visual studio does not have an implementation of strcasecmp(). */
209 #define strcasecmp     _stricmp
210 #define strncasecmp    _strnicmp
211 #define strcmpi        _strcmpi
212 
213 #endif /* FREERTOS_CONFIG_H */
214