1 /* 2 * FreeRTOS Kernel V11.1.0 3 * Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. 4 * 5 * SPDX-License-Identifier: MIT 6 * 7 * Permission is hereby granted, free of charge, to any person obtaining a copy of 8 * this software and associated documentation files (the "Software"), to deal in 9 * the Software without restriction, including without limitation the rights to 10 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 11 * the Software, and to permit persons to whom the Software is furnished to do so, 12 * subject to the following conditions: 13 * 14 * The above copyright notice and this permission notice shall be included in all 15 * copies or substantial portions of the Software. 16 * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 19 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 20 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 21 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 23 * 24 * https://www.FreeRTOS.org 25 * https://github.com/FreeRTOS 26 * 27 */ 28 29 /******************************************************************************* 30 * This file provides an example FreeRTOSConfig.h header file, inclusive of an 31 * abbreviated explanation of each configuration item. Online and reference 32 * documentation provides more information. 33 * https://www.freertos.org/a00110.html 34 * 35 * Constant values enclosed in square brackets ('[' and ']') must be completed 36 * before this file will build. 37 * 38 * Use the FreeRTOSConfig.h supplied with the RTOS port in use rather than this 39 * generic file, if one is available. 40 ******************************************************************************/ 41 42 #ifndef FREERTOS_CONFIG_H 43 #define FREERTOS_CONFIG_H 44 45 /******************************************************************************/ 46 /* Hardware description related definitions. **********************************/ 47 /******************************************************************************/ 48 49 /* In most cases, configCPU_CLOCK_HZ must be set to the frequency of the clock 50 * that drives the peripheral used to generate the kernels periodic tick interrupt. 51 * The default value is set to 20MHz and matches the QEMU demo settings. Your 52 * application will certainly need a different value so set this correctly. 53 * This is very often, but not always, equal to the main system clock frequency. */ 54 #define configCPU_CLOCK_HZ ( ( unsigned long ) 20000000 ) 55 56 /* configSYSTICK_CLOCK_HZ is an optional parameter for ARM Cortex-M ports only. 57 * 58 * By default ARM Cortex-M ports generate the RTOS tick interrupt from the 59 * Cortex-M SysTick timer. Most Cortex-M MCUs run the SysTick timer at the same 60 * frequency as the MCU itself - when that is the case configSYSTICK_CLOCK_HZ is 61 * not needed and should be left undefined. If the SysTick timer is clocked at a 62 * different frequency to the MCU core then set configCPU_CLOCK_HZ to the MCU clock 63 * frequency, as normal, and configSYSTICK_CLOCK_HZ to the SysTick clock 64 * frequency. Not used if left undefined. 65 * The default value is undefined (commented out). If you need this value bring it 66 * back and set it to a suitable value. */ 67 68 /* 69 #define configSYSTICK_CLOCK_HZ [Platform specific] 70 */ 71 72 /******************************************************************************/ 73 /* Scheduling behaviour related definitions. **********************************/ 74 /******************************************************************************/ 75 76 /* configTICK_RATE_HZ sets frequency of the tick interrupt in Hz, normally 77 * calculated from the configCPU_CLOCK_HZ value. */ 78 #define configTICK_RATE_HZ 100 79 80 /* Set configUSE_PREEMPTION to 1 to use pre-emptive scheduling. Set 81 * configUSE_PREEMPTION to 0 to use co-operative scheduling. 82 * See https://www.freertos.org/single-core-amp-smp-rtos-scheduling.html. */ 83 #define configUSE_PREEMPTION 1 84 85 /* Set configUSE_TIME_SLICING to 1 to have the scheduler switch between Ready 86 * state tasks of equal priority on every tick interrupt. Set 87 * configUSE_TIME_SLICING to 0 to prevent the scheduler switching between Ready 88 * state tasks just because there was a tick interrupt. See 89 * https://freertos.org/single-core-amp-smp-rtos-scheduling.html. */ 90 #define configUSE_TIME_SLICING 0 91 92 /* Set configUSE_PORT_OPTIMISED_TASK_SELECTION to 1 to select the next task to 93 * run using an algorithm optimised to the instruction set of the target hardware - 94 * normally using a count leading zeros assembly instruction. Set to 0 to select 95 * the next task to run using a generic C algorithm that works for all FreeRTOS 96 * ports. Not all FreeRTOS ports have this option. Defaults to 0 if left 97 * undefined. */ 98 #define configUSE_PORT_OPTIMISED_TASK_SELECTION 0 99 100 /* Set configUSE_TICKLESS_IDLE to 1 to use the low power tickless mode. Set to 101 * 0 to keep the tick interrupt running at all times. Not all FreeRTOS ports 102 * support tickless mode. See https://www.freertos.org/low-power-tickless-rtos.html 103 * Defaults to 0 if left undefined. */ 104 #define configUSE_TICKLESS_IDLE 0 105 106 /* configMAX_PRIORITIES Sets the number of available task priorities. Tasks can 107 * be assigned priorities of 0 to (configMAX_PRIORITIES - 1). Zero is the lowest 108 * priority. */ 109 #define configMAX_PRIORITIES 5 110 111 /* configMINIMAL_STACK_SIZE defines the size of the stack used by the Idle task 112 * (in words, not in bytes!). The kernel does not use this constant for any other 113 * purpose. Demo applications use the constant to make the demos somewhat portable 114 * across hardware architectures. */ 115 #define configMINIMAL_STACK_SIZE 128 116 117 /* configMAX_TASK_NAME_LEN sets the maximum length (in characters) of a task's 118 * human readable name. Includes the NULL terminator. */ 119 #define configMAX_TASK_NAME_LEN 16 120 121 /* Time is measured in 'ticks' - which is the number of times the tick interrupt 122 * has executed since the RTOS kernel was started. 123 * The tick count is held in a variable of type TickType_t. 124 * 125 * configTICK_TYPE_WIDTH_IN_BITS controls the type (and therefore bit-width) of TickType_t: 126 * 127 * Defining configTICK_TYPE_WIDTH_IN_BITS as TICK_TYPE_WIDTH_16_BITS causes 128 * TickType_t to be defined (typedef'ed) as an unsigned 16-bit type. 129 * 130 * Defining configTICK_TYPE_WIDTH_IN_BITS as TICK_TYPE_WIDTH_32_BITS causes 131 * TickType_t to be defined (typedef'ed) as an unsigned 32-bit type. 132 * 133 * Defining configTICK_TYPE_WIDTH_IN_BITS as TICK_TYPE_WIDTH_64_BITS causes 134 * TickType_t to be defined (typedef'ed) as an unsigned 64-bit type. */ 135 #define configTICK_TYPE_WIDTH_IN_BITS TICK_TYPE_WIDTH_64_BITS 136 137 /* Set configIDLE_SHOULD_YIELD to 1 to have the Idle task yield to an 138 * application task if there is an Idle priority (priority 0) application task that 139 * can run. Set to 0 to have the Idle task use all of its timeslice. Default to 1 140 * if left undefined. */ 141 #define configIDLE_SHOULD_YIELD 1 142 143 /* Each task has an array of task notifications. 144 * configTASK_NOTIFICATION_ARRAY_ENTRIES sets the number of indexes in the array. 145 * See https://www.freertos.org/RTOS-task-notifications.html Defaults to 1 if 146 * left undefined. */ 147 #define configTASK_NOTIFICATION_ARRAY_ENTRIES 1 148 149 /* configQUEUE_REGISTRY_SIZE sets the maximum number of queues and semaphores 150 * that can be referenced from the queue registry. Only required when using a 151 * kernel aware debugger. Defaults to 0 if left undefined. */ 152 #define configQUEUE_REGISTRY_SIZE 0 153 154 /* Set configENABLE_BACKWARD_COMPATIBILITY to 1 to map function names and 155 * datatypes from old version of FreeRTOS to their latest equivalent. Defaults to 156 * 1 if left undefined. */ 157 #define configENABLE_BACKWARD_COMPATIBILITY 0 158 159 /* Each task has its own array of pointers that can be used as thread local 160 * storage. configNUM_THREAD_LOCAL_STORAGE_POINTERS set the number of indexes in 161 * the array. See https://www.freertos.org/thread-local-storage-pointers.html 162 * Defaults to 0 if left undefined. */ 163 #define configNUM_THREAD_LOCAL_STORAGE_POINTERS 0 164 165 /* When configUSE_MINI_LIST_ITEM is set to 0, MiniListItem_t and ListItem_t are 166 * both the same. When configUSE_MINI_LIST_ITEM is set to 1, MiniListItem_t contains 167 * 3 fewer fields than ListItem_t which saves some RAM at the cost of violating 168 * strict aliasing rules which some compilers depend on for optimization. Defaults 169 * to 1 if left undefined. */ 170 #define configUSE_MINI_LIST_ITEM 1 171 172 /* Sets the type used by the parameter to xTaskCreate() that specifies the stack 173 * size of the task being created. The same type is used to return information 174 * about stack usage in various other API calls. Defaults to size_t if left 175 * undefined. */ 176 #define configSTACK_DEPTH_TYPE size_t 177 178 /* configMESSAGE_BUFFER_LENGTH_TYPE sets the type used to store the length of 179 * each message written to a FreeRTOS message buffer (the length is also written to 180 * the message buffer. Defaults to size_t if left undefined - but that may waste 181 * space if messages never go above a length that could be held in a uint8_t. */ 182 #define configMESSAGE_BUFFER_LENGTH_TYPE size_t 183 184 /* If configHEAP_CLEAR_MEMORY_ON_FREE is set to 1, then blocks of memory allocated 185 * using pvPortMalloc() will be cleared (i.e. set to zero) when freed using 186 * vPortFree(). Defaults to 0 if left undefined. */ 187 #define configHEAP_CLEAR_MEMORY_ON_FREE 1 188 189 /* vTaskList and vTaskGetRunTimeStats APIs take a buffer as a parameter and assume 190 * that the length of the buffer is configSTATS_BUFFER_MAX_LENGTH. Defaults to 191 * 0xFFFF if left undefined. 192 * New applications are recommended to use vTaskListTasks and 193 * vTaskGetRunTimeStatistics APIs instead and supply the length of the buffer 194 * explicitly to avoid memory corruption. */ 195 #define configSTATS_BUFFER_MAX_LENGTH 0xFFFF 196 197 /* Set configUSE_NEWLIB_REENTRANT to 1 to have a newlib reent structure 198 * allocated for each task. Set to 0 to not support newlib reent structures. 199 * Default to 0 if left undefined. 200 * 201 * Note Newlib support has been included by popular demand, but is not used or 202 * tested by the FreeRTOS maintainers themselves. FreeRTOS is not responsible for 203 * resulting newlib operation. User must be familiar with newlib and must provide 204 * system-wide implementations of the necessary stubs. Note that (at the time of 205 * writing) the current newlib design implements a system-wide malloc() that must 206 * be provided with locks. */ 207 #define configUSE_NEWLIB_REENTRANT 0 208 209 /******************************************************************************/ 210 /* Software timer related definitions. ****************************************/ 211 /******************************************************************************/ 212 213 /* Set configUSE_TIMERS to 1 to include software timer functionality in the 214 * build. Set to 0 to exclude software timer functionality from the build. The 215 * FreeRTOS/source/timers.c source file must be included in the build if 216 * configUSE_TIMERS is set to 1. Default to 0 if left undefined. See 217 * https://www.freertos.org/RTOS-software-timer.html. */ 218 #define configUSE_TIMERS 1 219 220 /* configTIMER_TASK_PRIORITY sets the priority used by the timer task. Only 221 * used if configUSE_TIMERS is set to 1. The timer task is a standard FreeRTOS 222 * task, so its priority is set like any other task. See 223 * https://www.freertos.org/RTOS-software-timer-service-daemon-task.html Only used 224 * if configUSE_TIMERS is set to 1. */ 225 #define configTIMER_TASK_PRIORITY ( configMAX_PRIORITIES - 1 ) 226 227 /* configTIMER_TASK_STACK_DEPTH sets the size of the stack allocated to the 228 * timer task (in words, not in bytes!). The timer task is a standard FreeRTOS 229 * task. See https://www.freertos.org/RTOS-software-timer-service-daemon-task.html 230 * Only used if configUSE_TIMERS is set to 1. */ 231 #define configTIMER_TASK_STACK_DEPTH configMINIMAL_STACK_SIZE 232 233 /* configTIMER_QUEUE_LENGTH sets the length of the queue (the number of discrete 234 * items the queue can hold) used to send commands to the timer task. See 235 * https://www.freertos.org/RTOS-software-timer-service-daemon-task.html Only used 236 * if configUSE_TIMERS is set to 1. */ 237 #define configTIMER_QUEUE_LENGTH 10 238 239 /******************************************************************************/ 240 /* Event Group related definitions. *******************************************/ 241 /******************************************************************************/ 242 243 /* Set configUSE_EVENT_GROUPS to 1 to include event group functionality in the 244 * build. Set to 0 to exclude event group functionality from the build. The 245 * FreeRTOS/source/event_groups.c source file must be included in the build if 246 * configUSE_EVENT_GROUPS is set to 1. Defaults to 1 if left undefined. */ 247 248 #define configUSE_EVENT_GROUPS 1 249 250 /******************************************************************************/ 251 /* Stream Buffer related definitions. *****************************************/ 252 /******************************************************************************/ 253 254 /* Set configUSE_STREAM_BUFFERS to 1 to include stream buffer functionality in 255 * the build. Set to 0 to exclude event group functionality from the build. The 256 * FreeRTOS/source/stream_buffer.c source file must be included in the build if 257 * configUSE_STREAM_BUFFERS is set to 1. Defaults to 1 if left undefined. */ 258 259 #define configUSE_STREAM_BUFFERS 1 260 261 /******************************************************************************/ 262 /* Memory allocation related definitions. *************************************/ 263 /******************************************************************************/ 264 265 /* Set configSUPPORT_STATIC_ALLOCATION to 1 to include FreeRTOS API functions 266 * that create FreeRTOS objects (tasks, queues, etc.) using statically allocated 267 * memory in the build. Set to 0 to exclude the ability to create statically 268 * allocated objects from the build. Defaults to 0 if left undefined. See 269 * https://www.freertos.org/Static_Vs_Dynamic_Memory_Allocation.html. */ 270 #define configSUPPORT_STATIC_ALLOCATION 1 271 272 /* Set configSUPPORT_DYNAMIC_ALLOCATION to 1 to include FreeRTOS API functions 273 * that create FreeRTOS objects (tasks, queues, etc.) using dynamically allocated 274 * memory in the build. Set to 0 to exclude the ability to create dynamically 275 * allocated objects from the build. Defaults to 1 if left undefined. See 276 * https://www.freertos.org/Static_Vs_Dynamic_Memory_Allocation.html. */ 277 #define configSUPPORT_DYNAMIC_ALLOCATION 1 278 279 /* Sets the total size of the FreeRTOS heap, in bytes, when heap_1.c, heap_2.c 280 * or heap_4.c are included in the build. This value is defaulted to 4096 bytes but 281 * it must be tailored to each application. Note the heap will appear in the .bss 282 * section. See https://www.freertos.org/a00111.html. */ 283 #define configTOTAL_HEAP_SIZE 4096 284 285 /* Set configAPPLICATION_ALLOCATED_HEAP to 1 to have the application allocate 286 * the array used as the FreeRTOS heap. Set to 0 to have the linker allocate the 287 * array used as the FreeRTOS heap. Defaults to 0 if left undefined. */ 288 #define configAPPLICATION_ALLOCATED_HEAP 0 289 290 /* Set configSTACK_ALLOCATION_FROM_SEPARATE_HEAP to 1 to have task stacks 291 * allocated from somewhere other than the FreeRTOS heap. This is useful if you 292 * want to ensure stacks are held in fast memory. Set to 0 to have task stacks 293 * come from the standard FreeRTOS heap. The application writer must provide 294 * implementations for pvPortMallocStack() and vPortFreeStack() if set to 1. 295 * Defaults to 0 if left undefined. */ 296 #define configSTACK_ALLOCATION_FROM_SEPARATE_HEAP 0 297 298 /* Set configENABLE_HEAP_PROTECTOR to 1 to enable bounds checking and obfuscation 299 * to internal heap block pointers in heap_4.c and heap_5.c to help catch pointer 300 * corruptions. Defaults to 0 if left undefined. */ 301 #define configENABLE_HEAP_PROTECTOR 0 302 303 /******************************************************************************/ 304 /* Interrupt nesting behaviour configuration. *********************************/ 305 /******************************************************************************/ 306 307 /* configKERNEL_INTERRUPT_PRIORITY sets the priority of the tick and context 308 * switch performing interrupts. Not supported by all FreeRTOS ports. See 309 * https://www.freertos.org/RTOS-Cortex-M3-M4.html for information specific to 310 * ARM Cortex-M devices. */ 311 #define configKERNEL_INTERRUPT_PRIORITY 0 312 313 /* configMAX_SYSCALL_INTERRUPT_PRIORITY sets the interrupt priority above which 314 * FreeRTOS API calls must not be made. Interrupts above this priority are never 315 * disabled, so never delayed by RTOS activity. The default value is set to the 316 * highest interrupt priority (0). Not supported by all FreeRTOS ports. 317 * See https://www.freertos.org/RTOS-Cortex-M3-M4.html for information specific to 318 * ARM Cortex-M devices. */ 319 #define configMAX_SYSCALL_INTERRUPT_PRIORITY 0 320 321 /* Another name for configMAX_SYSCALL_INTERRUPT_PRIORITY - the name used depends 322 * on the FreeRTOS port. */ 323 #define configMAX_API_CALL_INTERRUPT_PRIORITY 0 324 325 /******************************************************************************/ 326 /* Hook and callback function related definitions. ****************************/ 327 /******************************************************************************/ 328 329 /* Set the following configUSE_* constants to 1 to include the named hook 330 * functionality in the build. Set to 0 to exclude the hook functionality from the 331 * build. The application writer is responsible for providing the hook function 332 * for any set to 1. See https://www.freertos.org/a00016.html. */ 333 #define configUSE_IDLE_HOOK 0 334 #define configUSE_TICK_HOOK 0 335 #define configUSE_MALLOC_FAILED_HOOK 0 336 #define configUSE_DAEMON_TASK_STARTUP_HOOK 0 337 338 /* Set configUSE_SB_COMPLETED_CALLBACK to 1 to have send and receive completed 339 * callbacks for each instance of a stream buffer or message buffer. When the 340 * option is set to 1, APIs xStreamBufferCreateWithCallback() and 341 * xStreamBufferCreateStaticWithCallback() (and likewise APIs for message 342 * buffer) can be used to create a stream buffer or message buffer instance 343 * with application provided callbacks. Defaults to 0 if left undefined. */ 344 #define configUSE_SB_COMPLETED_CALLBACK 0 345 346 /* Set configCHECK_FOR_STACK_OVERFLOW to 1 or 2 for FreeRTOS to check for a 347 * stack overflow at the time of a context switch. Set to 0 to not look for a 348 * stack overflow. If configCHECK_FOR_STACK_OVERFLOW is 1 then the check only 349 * looks for the stack pointer being out of bounds when a task's context is saved 350 * to its stack - this is fast but somewhat ineffective. If 351 * configCHECK_FOR_STACK_OVERFLOW is 2 then the check looks for a pattern written 352 * to the end of a task's stack having been overwritten. This is slower, but will 353 * catch most (but not all) stack overflows. The application writer must provide 354 * the stack overflow callback when configCHECK_FOR_STACK_OVERFLOW is set to 1. 355 * See https://www.freertos.org/Stacks-and-stack-overflow-checking.html Defaults 356 * to 0 if left undefined. */ 357 #define configCHECK_FOR_STACK_OVERFLOW 2 358 359 /******************************************************************************/ 360 /* Run time and task stats gathering related definitions. *********************/ 361 /******************************************************************************/ 362 363 /* Set configGENERATE_RUN_TIME_STATS to 1 to have FreeRTOS collect data on the 364 * processing time used by each task. Set to 0 to not collect the data. The 365 * application writer needs to provide a clock source if set to 1. Defaults to 0 366 * if left undefined. See https://www.freertos.org/rtos-run-time-stats.html. */ 367 #define configGENERATE_RUN_TIME_STATS 0 368 369 /* Set configUSE_TRACE_FACILITY to include additional task structure members 370 * are used by trace and visualisation functions and tools. Set to 0 to exclude 371 * the additional information from the structures. Defaults to 0 if left 372 * undefined. */ 373 #define configUSE_TRACE_FACILITY 0 374 375 /* Set to 1 to include the vTaskList() and vTaskGetRunTimeStats() functions in 376 * the build. Set to 0 to exclude these functions from the build. These two 377 * functions introduce a dependency on string formatting functions that would 378 * otherwise not exist - hence they are kept separate. Defaults to 0 if left 379 * undefined. */ 380 #define configUSE_STATS_FORMATTING_FUNCTIONS 0 381 382 /******************************************************************************/ 383 /* Co-routine related definitions. ********************************************/ 384 /******************************************************************************/ 385 386 /* Set configUSE_CO_ROUTINES to 1 to include co-routine functionality in the 387 * build, or 0 to omit co-routine functionality from the build. To include 388 * co-routines, croutine.c must be included in the project. Defaults to 0 if left 389 * undefined. */ 390 #define configUSE_CO_ROUTINES 0 391 392 /* configMAX_CO_ROUTINE_PRIORITIES defines the number of priorities available 393 * to the application co-routines. Any number of co-routines can share the same 394 * priority. Defaults to 0 if left undefined. */ 395 #define configMAX_CO_ROUTINE_PRIORITIES 1 396 397 /******************************************************************************/ 398 /* Debugging assistance. ******************************************************/ 399 /******************************************************************************/ 400 401 /* configASSERT() has the same semantics as the standard C assert(). It can 402 * either be defined to take an action when the assertion fails, or not defined 403 * at all (i.e. comment out or delete the definitions) to completely remove 404 * assertions. configASSERT() can be defined to anything you want, for example 405 * you can call a function if an assert fails that passes the filename and line 406 * number of the failing assert (for example, "vAssertCalled( __FILE__, __LINE__ )" 407 * or it can simple disable interrupts and sit in a loop to halt all execution 408 * on the failing line for viewing in a debugger. */ 409 #define configASSERT( x ) \ 410 if( ( x ) == 0 ) \ 411 { \ 412 taskDISABLE_INTERRUPTS(); \ 413 for( ; ; ) \ 414 ; \ 415 } 416 417 /******************************************************************************/ 418 /* FreeRTOS MPU specific definitions. *****************************************/ 419 /******************************************************************************/ 420 421 /* If configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS is set to 1 then 422 * the application writer can provide functions that execute in privileged mode. 423 * See: https://www.freertos.org/a00110.html#configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS 424 * Defaults to 0 if left undefined. Only used by the FreeRTOS Cortex-M MPU ports, 425 * not the standard ARMv7-M Cortex-M port. */ 426 #define configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS 0 427 428 /* Set configTOTAL_MPU_REGIONS to the number of MPU regions implemented on your 429 * target hardware. Normally 8 or 16. Only used by the FreeRTOS Cortex-M MPU 430 * ports, not the standard ARMv7-M Cortex-M port. Defaults to 8 if left 431 * undefined. */ 432 #define configTOTAL_MPU_REGIONS 8 433 434 /* configTEX_S_C_B_FLASH allows application writers to override the default 435 * values for the for TEX, Shareable (S), Cacheable (C) and Bufferable (B) bits for 436 * the MPU region covering Flash. Defaults to 0x07UL (which means TEX=000, S=1, 437 * C=1, B=1) if left undefined. Only used by the FreeRTOS Cortex-M MPU ports, not 438 * the standard ARMv7-M Cortex-M port. */ 439 #define configTEX_S_C_B_FLASH 0x07UL 440 441 /* configTEX_S_C_B_SRAM allows application writers to override the default 442 * values for the for TEX, Shareable (S), Cacheable (C) and Bufferable (B) bits for 443 * the MPU region covering RAM. Defaults to 0x07UL (which means TEX=000, S=1, C=1, 444 * B=1) if left undefined. Only used by the FreeRTOS Cortex-M MPU ports, not 445 * the standard ARMv7-M Cortex-M port. */ 446 #define configTEX_S_C_B_SRAM 0x07UL 447 448 /* Set configENFORCE_SYSTEM_CALLS_FROM_KERNEL_ONLY to 0 to prevent any privilege 449 * escalations originating from outside of the kernel code itself. Set to 1 to 450 * allow application tasks to raise privilege. Defaults to 1 if left undefined. 451 * Only used by the FreeRTOS Cortex-M MPU ports, not the standard ARMv7-M Cortex-M 452 * port. */ 453 #define configENFORCE_SYSTEM_CALLS_FROM_KERNEL_ONLY 1 454 455 /* Set configALLOW_UNPRIVILEGED_CRITICAL_SECTIONS to 1 to allow unprivileged 456 * tasks enter critical sections (effectively mask interrupts). Set to 0 to 457 * prevent unprivileged tasks entering critical sections. Defaults to 1 if left 458 * undefined. Only used by the FreeRTOS Cortex-M MPU ports, not the standard 459 * ARMv7-M Cortex-M port. */ 460 #define configALLOW_UNPRIVILEGED_CRITICAL_SECTIONS 0 461 462 /* FreeRTOS Kernel version 10.6.0 introduced a new v2 MPU wrapper, namely 463 * mpu_wrappers_v2.c. Set configUSE_MPU_WRAPPERS_V1 to 0 to use the new v2 MPU 464 * wrapper. Set configUSE_MPU_WRAPPERS_V1 to 1 to use the old v1 MPU wrapper 465 * (mpu_wrappers.c). Defaults to 0 if left undefined. */ 466 #define configUSE_MPU_WRAPPERS_V1 0 467 468 /* When using the v2 MPU wrapper, set configPROTECTED_KERNEL_OBJECT_POOL_SIZE to 469 * the total number of kernel objects, which includes tasks, queues, semaphores, 470 * mutexes, event groups, timers, stream buffers and message buffers, in your 471 * application. The application will not be able to have more than 472 * configPROTECTED_KERNEL_OBJECT_POOL_SIZE kernel objects at any point of 473 * time. */ 474 #define configPROTECTED_KERNEL_OBJECT_POOL_SIZE 10 475 476 /* When using the v2 MPU wrapper, set configSYSTEM_CALL_STACK_SIZE to the size 477 * of the system call stack in words. Each task has a statically allocated 478 * memory buffer of this size which is used as the stack to execute system 479 * calls. For example, if configSYSTEM_CALL_STACK_SIZE is defined as 128 and 480 * there are 10 tasks in the application, the total amount of memory used for 481 * system call stacks is 128 * 10 = 1280 words. */ 482 #define configSYSTEM_CALL_STACK_SIZE 128 483 484 /* When using the v2 MPU wrapper, set configENABLE_ACCESS_CONTROL_LIST to 1 to 485 * enable Access Control List (ACL) feature. When ACL is enabled, an 486 * unprivileged task by default does not have access to any kernel object other 487 * than itself. The application writer needs to explicitly grant the 488 * unprivileged task access to the kernel objects it needs using the APIs 489 * provided for the same. Defaults to 0 if left undefined. */ 490 #define configENABLE_ACCESS_CONTROL_LIST 1 491 492 /******************************************************************************/ 493 /* SMP( Symmetric MultiProcessing ) Specific Configuration definitions. *******/ 494 /******************************************************************************/ 495 496 /* Set configNUMBER_OF_CORES to the number of available processor cores. Defaults 497 * to 1 if left undefined. */ 498 499 /* 500 #define configNUMBER_OF_CORES [Num of available cores] 501 */ 502 503 /* When using SMP (i.e. configNUMBER_OF_CORES is greater than one), set 504 * configRUN_MULTIPLE_PRIORITIES to 0 to allow multiple tasks to run 505 * simultaneously only if they do not have equal priority, thereby maintaining 506 * the paradigm of a lower priority task never running if a higher priority task 507 * is able to run. If configRUN_MULTIPLE_PRIORITIES is set to 1, multiple tasks 508 * with different priorities may run simultaneously - so a higher and lower 509 * priority task may run on different cores at the same time. */ 510 #define configRUN_MULTIPLE_PRIORITIES 0 511 512 /* When using SMP (i.e. configNUMBER_OF_CORES is greater than one), set 513 * configUSE_CORE_AFFINITY to 1 to enable core affinity feature. When core 514 * affinity feature is enabled, the vTaskCoreAffinitySet and vTaskCoreAffinityGet 515 * APIs can be used to set and retrieve which cores a task can run on. If 516 * configUSE_CORE_AFFINITY is set to 0 then the FreeRTOS scheduler is free to 517 * run any task on any available core. */ 518 #define configUSE_CORE_AFFINITY 0 519 520 /* When using SMP with core affinity feature enabled, set 521 * configTASK_DEFAULT_CORE_AFFINITY to change the default core affinity mask for 522 * tasks created without an affinity mask specified. Setting the define to 1 would 523 * make such tasks run on core 0 and setting it to (1 << portGET_CORE_ID()) would 524 * make such tasks run on the current core. This config value is useful, if 525 * swapping tasks between cores is not supported (e.g. Tricore) or if legacy code 526 * should be controlled. Defaults to tskNO_AFFINITY if left undefined. */ 527 #define configTASK_DEFAULT_CORE_AFFINITY tskNO_AFFINITY 528 529 /* When using SMP (i.e. configNUMBER_OF_CORES is greater than one), if 530 * configUSE_TASK_PREEMPTION_DISABLE is set to 1, individual tasks can be set to 531 * either pre-emptive or co-operative mode using the vTaskPreemptionDisable and 532 * vTaskPreemptionEnable APIs. */ 533 #define configUSE_TASK_PREEMPTION_DISABLE 0 534 535 /* When using SMP (i.e. configNUMBER_OF_CORES is greater than one), set 536 * configUSE_PASSIVE_IDLE_HOOK to 1 to allow the application writer to use 537 * the passive idle task hook to add background functionality without the overhead 538 * of a separate task. Defaults to 0 if left undefined. */ 539 #define configUSE_PASSIVE_IDLE_HOOK 0 540 541 /* When using SMP (i.e. configNUMBER_OF_CORES is greater than one), 542 * configTIMER_SERVICE_TASK_CORE_AFFINITY allows the application writer to set 543 * the core affinity of the RTOS Daemon/Timer Service task. Defaults to 544 * tskNO_AFFINITY if left undefined. */ 545 #define configTIMER_SERVICE_TASK_CORE_AFFINITY tskNO_AFFINITY 546 547 548 /******************************************************************************/ 549 /* ARMv8-M secure side port related definitions. ******************************/ 550 /******************************************************************************/ 551 552 /* secureconfigMAX_SECURE_CONTEXTS define the maximum number of tasks that can 553 * call into the secure side of an ARMv8-M chip. Not used by any other ports. */ 554 #define secureconfigMAX_SECURE_CONTEXTS 5 555 556 /* Defines the kernel provided implementation of 557 * vApplicationGetIdleTaskMemory() and vApplicationGetTimerTaskMemory() 558 * to provide the memory that is used by the Idle task and Timer task respectively. 559 * The application can provide it's own implementation of 560 * vApplicationGetIdleTaskMemory() and vApplicationGetTimerTaskMemory() by 561 * setting configKERNEL_PROVIDED_STATIC_MEMORY to 0 or leaving it undefined. */ 562 #define configKERNEL_PROVIDED_STATIC_MEMORY 1 563 564 /******************************************************************************/ 565 /* ARMv8-M port Specific Configuration definitions. ***************************/ 566 /******************************************************************************/ 567 568 /* Set configENABLE_TRUSTZONE to 1 when running FreeRTOS on the non-secure side 569 * to enable the TrustZone support in FreeRTOS ARMv8-M ports which allows the 570 * non-secure FreeRTOS tasks to call the (non-secure callable) functions 571 * exported from secure side. */ 572 #define configENABLE_TRUSTZONE 1 573 574 /* If the application writer does not want to use TrustZone, but the hardware does 575 * not support disabling TrustZone then the entire application (including the FreeRTOS 576 * scheduler) can run on the secure side without ever branching to the non-secure side. 577 * To do that, in addition to setting configENABLE_TRUSTZONE to 0, also set 578 * configRUN_FREERTOS_SECURE_ONLY to 1. */ 579 #define configRUN_FREERTOS_SECURE_ONLY 1 580 581 /* Set configENABLE_MPU to 1 to enable the Memory Protection Unit (MPU), or 0 582 * to leave the Memory Protection Unit disabled. */ 583 #define configENABLE_MPU 1 584 585 /* Set configENABLE_FPU to 1 to enable the Floating Point Unit (FPU), or 0 586 * to leave the Floating Point Unit disabled. */ 587 #define configENABLE_FPU 1 588 589 /* Set configENABLE_MVE to 1 to enable the M-Profile Vector Extension (MVE) support, 590 * or 0 to leave the MVE support disabled. This option is only applicable to Cortex-M55 591 * and Cortex-M85 ports as M-Profile Vector Extension (MVE) is available only on 592 * these architectures. configENABLE_MVE must be left undefined, or defined to 0 593 * for the Cortex-M23,Cortex-M33 and Cortex-M35P ports. */ 594 #define configENABLE_MVE 1 595 596 /******************************************************************************/ 597 /* ARMv7-M and ARMv8-M port Specific Configuration definitions. ***************/ 598 /******************************************************************************/ 599 600 /* Set configCHECK_HANDLER_INSTALLATION to 1 to enable additional asserts to verify 601 * that the application has correctly installed FreeRTOS interrupt handlers. 602 * 603 * An application can install FreeRTOS interrupt handlers in one of the following ways: 604 * 1. Direct Routing - Install the functions vPortSVCHandler and xPortPendSVHandler 605 * for SVC call and PendSV interrupts respectively. 606 * 2. Indirect Routing - Install separate handlers for SVC call and PendSV 607 * interrupts and route program control from those handlers 608 * to vPortSVCHandler and xPortPendSVHandler functions. 609 * The applications that use Indirect Routing must set configCHECK_HANDLER_INSTALLATION to 0. 610 * 611 * Defaults to 1 if left undefined. */ 612 #define configCHECK_HANDLER_INSTALLATION 1 613 614 /******************************************************************************/ 615 /* Definitions that include or exclude functionality. *************************/ 616 /******************************************************************************/ 617 618 /* Set the following configUSE_* constants to 1 to include the named feature in 619 * the build, or 0 to exclude the named feature from the build. */ 620 #define configUSE_TASK_NOTIFICATIONS 1 621 #define configUSE_MUTEXES 1 622 #define configUSE_RECURSIVE_MUTEXES 1 623 #define configUSE_COUNTING_SEMAPHORES 1 624 #define configUSE_QUEUE_SETS 0 625 #define configUSE_APPLICATION_TASK_TAG 0 626 627 /* Set the following INCLUDE_* constants to 1 to incldue the named API function, 628 * or 0 to exclude the named API function. Most linkers will remove unused 629 * functions even when the constant is 1. */ 630 #define INCLUDE_vTaskPrioritySet 1 631 #define INCLUDE_uxTaskPriorityGet 1 632 #define INCLUDE_vTaskDelete 1 633 #define INCLUDE_vTaskSuspend 1 634 #define INCLUDE_xResumeFromISR 1 635 #define INCLUDE_vTaskDelayUntil 1 636 #define INCLUDE_vTaskDelay 1 637 #define INCLUDE_xTaskGetSchedulerState 1 638 #define INCLUDE_xTaskGetCurrentTaskHandle 1 639 #define INCLUDE_uxTaskGetStackHighWaterMark 0 640 #define INCLUDE_xTaskGetIdleTaskHandle 0 641 #define INCLUDE_eTaskGetState 0 642 #define INCLUDE_xEventGroupSetBitFromISR 1 643 #define INCLUDE_xTimerPendFunctionCall 0 644 #define INCLUDE_xTaskAbortDelay 0 645 #define INCLUDE_xTaskGetHandle 0 646 #define INCLUDE_xTaskResumeFromISR 1 647 648 #endif /* FREERTOS_CONFIG_H */ 649
