mirror of
https://github.com/espressif/esp-idf.git
synced 2025-08-10 12:53:29 +00:00
9bb8f0e38d
The following changes have been made in this commit: 1. configMINIMAL_STACK_SIZE is now defined as CONFIG_FREERTOS_IDLE_TASK_STACKSIZE. 2. Removed configIDLE_TASK_STACK_SIZE config as it was redundant. 3. Updates the order of allocating the TCB and stack memory to avoid the stack memory overriding the TCB memory when the stack grows downwards. 4. CONFIG_FREERTOS_IDLE_TASK_STACKSIZE is now incorporated into the FreeRTOSConfig_smp.h to configure the IDLE0 stack size.
292 lines
12 KiB
C
292 lines
12 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef FREERTOS_CONFIG_H
|
|
#define FREERTOS_CONFIG_H
|
|
|
|
#include "sdkconfig.h"
|
|
|
|
/*
|
|
This file get's pulled into assembly sources. Therefore, some includes need to be wrapped in #ifndef __ASSEMBLER__
|
|
*/
|
|
|
|
#ifndef __ASSEMBLER__
|
|
#include <assert.h> //For configASSERT()
|
|
#endif /* def __ASSEMBLER__ */
|
|
|
|
#ifdef CONFIG_FREERTOS_SMP
|
|
|
|
// Pull in the SMP configuration
|
|
#include "freertos/FreeRTOSConfig_smp.h"
|
|
|
|
#else // CONFIG_FREERTOS_SMP
|
|
|
|
// The arch-specific FreeRTOSConfig_arch.h in port/<arch>/include.
|
|
#include "freertos/FreeRTOSConfig_arch.h"
|
|
|
|
#if !(defined(FREERTOS_CONFIG_XTENSA_H) \
|
|
|| defined(FREERTOS_CONFIG_RISCV_H) \
|
|
|| defined(FREERTOS_CONFIG_LINUX_H))
|
|
#error "Needs architecture-speific FreeRTOSConfig.h!"
|
|
#endif
|
|
|
|
/* ----------------------------------------------------- Helpers -------------------------------------------------------
|
|
* - Macros that the FreeRTOS configuration macros depend on
|
|
* ------------------------------------------------------------------------------------------------------------------ */
|
|
|
|
/* Higher stack checker modes cause overhead on each function call */
|
|
#if CONFIG_STACK_CHECK_ALL || CONFIG_STACK_CHECK_STRONG
|
|
#define STACK_OVERHEAD_CHECKER 256
|
|
#else
|
|
#define STACK_OVERHEAD_CHECKER 0
|
|
#endif
|
|
|
|
/* with optimizations disabled, scheduler uses additional stack */
|
|
#if CONFIG_COMPILER_OPTIMIZATION_NONE
|
|
#define STACK_OVERHEAD_OPTIMIZATION 320
|
|
#else
|
|
#define STACK_OVERHEAD_OPTIMIZATION 0
|
|
#endif
|
|
|
|
/* apptrace mdule increases minimum stack usage */
|
|
#if CONFIG_APPTRACE_ENABLE
|
|
#define STACK_OVERHEAD_APPTRACE 1280
|
|
#else
|
|
#define STACK_OVERHEAD_APPTRACE 0
|
|
#endif
|
|
|
|
/* Stack watchpoint decreases minimum usable stack size by up to 60 bytes.
|
|
See FreeRTOS FREERTOS_WATCHPOINT_END_OF_STACK option in Kconfig. */
|
|
#if CONFIG_FREERTOS_WATCHPOINT_END_OF_STACK
|
|
#define STACK_OVERHEAD_WATCHPOINT 60
|
|
#else
|
|
#define STACK_OVERHEAD_WATCHPOINT 0
|
|
#endif
|
|
|
|
#define configSTACK_OVERHEAD_TOTAL ( \
|
|
STACK_OVERHEAD_CHECKER + \
|
|
STACK_OVERHEAD_OPTIMIZATION + \
|
|
STACK_OVERHEAD_APPTRACE + \
|
|
STACK_OVERHEAD_WATCHPOINT \
|
|
)
|
|
|
|
/* ------------------------------------------------- FreeRTOS Config ---------------------------------------------------
|
|
* - All Vanilla FreeRTOS configuration goes into this section
|
|
* - Keep this section in-sync with the corresponding version of single-core upstream version of FreeRTOS
|
|
* - Don't put any SMP or ESP-IDF exclusive FreeRTOS configurations here. Those go into the next section
|
|
* - Not all FreeRTOS configuration are listed. Some configurations have default values set in FreeRTOS.h thus don't
|
|
* need to be explicitly defined.
|
|
* ------------------------------------------------------------------------------------------------------------------ */
|
|
|
|
/*-----------------------------------------------------------
|
|
* Application specific definitions.
|
|
*
|
|
* These definitions should be adjusted for your particular hardware and
|
|
* application requirements.
|
|
*
|
|
* THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE
|
|
* FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE.
|
|
*
|
|
* See http://www.freertos.org/a00110.html
|
|
*----------------------------------------------------------*/
|
|
|
|
// ------------------ Scheduler Related --------------------
|
|
|
|
#define configUSE_PREEMPTION 1
|
|
#define configUSE_TICKLESS_IDLE CONFIG_FREERTOS_USE_TICKLESS_IDLE
|
|
#if configUSE_TICKLESS_IDLE
|
|
#define configEXPECTED_IDLE_TIME_BEFORE_SLEEP CONFIG_FREERTOS_IDLE_TIME_BEFORE_SLEEP
|
|
#endif //configUSE_TICKLESS_IDLE
|
|
#define configCPU_CLOCK_HZ (CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ * 1000000)
|
|
#define configTICK_RATE_HZ CONFIG_FREERTOS_HZ
|
|
#ifdef CONFIG_IDF_TARGET_LINUX
|
|
#define configMAX_PRIORITIES ( 7 ) // Default in upstream simulator
|
|
/* The stack allocated by FreeRTOS will be passed passed to a pthread.
|
|
pthread has a minimal stack size which currently is 16KB.
|
|
The rest is for additional structures of the POSIX/Linux port.
|
|
This is a magic number since PTHREAD_STACK_MIN seems to not be a constant. */
|
|
#define configMINIMAL_STACK_SIZE ( ( unsigned short ) (0x4000 + 40) / sizeof(portSTACK_TYPE) )
|
|
#else
|
|
#define configMAX_PRIORITIES ( 25 ) //This has impact on speed of search for highest priority
|
|
#define configMINIMAL_STACK_SIZE ( CONFIG_FREERTOS_IDLE_TASK_STACKSIZE + configSTACK_OVERHEAD_TOTAL )
|
|
#endif
|
|
#define configUSE_TIME_SLICING 1
|
|
#define configUSE_16_BIT_TICKS 0
|
|
#define configIDLE_SHOULD_YIELD 0
|
|
#define configKERNEL_INTERRUPT_PRIORITY 1 //Todo: This currently isn't used anywhere
|
|
|
|
// ------------- Synchronization Primitives ----------------
|
|
|
|
#define configUSE_MUTEXES 1
|
|
#define configUSE_RECURSIVE_MUTEXES 1
|
|
#define configUSE_COUNTING_SEMAPHORES 1
|
|
#define configUSE_QUEUE_SETS 1
|
|
#define configQUEUE_REGISTRY_SIZE CONFIG_FREERTOS_QUEUE_REGISTRY_SIZE
|
|
#define configUSE_TASK_NOTIFICATIONS 1
|
|
#define configTASK_NOTIFICATION_ARRAY_ENTRIES 1
|
|
|
|
// ----------------------- System --------------------------
|
|
|
|
#define configMAX_TASK_NAME_LEN CONFIG_FREERTOS_MAX_TASK_NAME_LEN
|
|
#define configNUM_THREAD_LOCAL_STORAGE_POINTERS CONFIG_FREERTOS_THREAD_LOCAL_STORAGE_POINTERS
|
|
#define configSTACK_DEPTH_TYPE uint32_t
|
|
#ifndef CONFIG_IDF_TARGET_LINUX
|
|
#define configUSE_NEWLIB_REENTRANT 1
|
|
#define configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H 1
|
|
#else
|
|
#define configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H 0 // Default in upstream simulator
|
|
#endif
|
|
#if CONFIG_FREERTOS_ENABLE_BACKWARD_COMPATIBILITY
|
|
#define configENABLE_BACKWARD_COMPATIBILITY 1
|
|
#else
|
|
#define configENABLE_BACKWARD_COMPATIBILITY 0
|
|
#endif
|
|
#define configASSERT(a) assert(a)
|
|
|
|
// ----------------------- Memory -------------------------
|
|
|
|
#define configSUPPORT_STATIC_ALLOCATION 1
|
|
#define configSUPPORT_DYNAMIC_ALLOCATION 1
|
|
#ifdef CONFIG_IDF_TARGET_LINUX
|
|
#define configTOTAL_HEAP_SIZE ( ( size_t ) ( 65 * 1024 ) ) // Default in upstream simulator
|
|
#else
|
|
//We define the heap to span all of the non-statically-allocated shared RAM. ToDo: Make sure there
|
|
//is some space left for the app and main cpu when running outside of a thread.
|
|
#define configTOTAL_HEAP_SIZE (&_heap_end - &_heap_start)//( ( size_t ) (64 * 1024) )
|
|
#endif
|
|
#define configAPPLICATION_ALLOCATED_HEAP 1
|
|
#define configSTACK_ALLOCATION_FROM_SEPARATE_HEAP 0
|
|
|
|
// ------------------------ Hooks --------------------------
|
|
|
|
#define configUSE_IDLE_HOOK CONFIG_FREERTOS_USE_IDLE_HOOK
|
|
#define configUSE_TICK_HOOK CONFIG_FREERTOS_USE_TICK_HOOK
|
|
#if CONFIG_FREERTOS_CHECK_STACKOVERFLOW_NONE
|
|
#define configCHECK_FOR_STACK_OVERFLOW 0
|
|
#elif CONFIG_FREERTOS_CHECK_STACKOVERFLOW_PTRVAL
|
|
#define configCHECK_FOR_STACK_OVERFLOW 1
|
|
#elif CONFIG_FREERTOS_CHECK_STACKOVERFLOW_CANARY
|
|
#define configCHECK_FOR_STACK_OVERFLOW 2
|
|
#endif
|
|
#define configRECORD_STACK_HIGH_ADDRESS 1
|
|
|
|
// ------------------- Run-time Stats ----------------------
|
|
|
|
#ifdef CONFIG_FREERTOS_GENERATE_RUN_TIME_STATS
|
|
#define configGENERATE_RUN_TIME_STATS 1 /* Used by vTaskGetRunTimeStats() */
|
|
#endif
|
|
#ifdef CONFIG_IDF_TARGET_LINUX
|
|
#define configUSE_TRACE_FACILITY 1
|
|
#else
|
|
#ifdef CONFIG_FREERTOS_USE_TRACE_FACILITY
|
|
#define configUSE_TRACE_FACILITY 1 /* Used by uxTaskGetSystemState(), and other trace facility functions */
|
|
#endif
|
|
#endif
|
|
#ifdef CONFIG_FREERTOS_USE_STATS_FORMATTING_FUNCTIONS
|
|
#define configUSE_STATS_FORMATTING_FUNCTIONS 1 /* Used by vTaskList() */
|
|
#endif
|
|
|
|
// -------------------- Co-routines -----------------------
|
|
|
|
#define configUSE_CO_ROUTINES 0 // CO_ROUTINES are not supported in ESP-IDF
|
|
#define configMAX_CO_ROUTINE_PRIORITIES 2
|
|
|
|
// ------------------- Software Timer ----------------------
|
|
|
|
#define configUSE_TIMERS 1
|
|
#define configTIMER_TASK_PRIORITY CONFIG_FREERTOS_TIMER_TASK_PRIORITY
|
|
#define configTIMER_QUEUE_LENGTH CONFIG_FREERTOS_TIMER_QUEUE_LENGTH
|
|
#define configTIMER_TASK_STACK_DEPTH CONFIG_FREERTOS_TIMER_TASK_STACK_DEPTH
|
|
|
|
// -------------------- API Includes -----------------------
|
|
|
|
#if CONFIG_FREERTOS_ENABLE_BACKWARD_COMPATIBILITY
|
|
#define configENABLE_BACKWARD_COMPATIBILITY 1
|
|
#else
|
|
#define configENABLE_BACKWARD_COMPATIBILITY 0
|
|
#endif
|
|
|
|
#define INCLUDE_vTaskPrioritySet 1
|
|
#define INCLUDE_uxTaskPriorityGet 1
|
|
#define INCLUDE_vTaskDelete 1
|
|
#define INCLUDE_vTaskSuspend 1
|
|
#define INCLUDE_vTaskDelay 1
|
|
#define INCLUDE_xTaskGetIdleTaskHandle 1
|
|
#define INCLUDE_xTaskAbortDelay 1
|
|
#define INCLUDE_xSemaphoreGetMutexHolder 1
|
|
#define INCLUDE_xTaskGetHandle 1
|
|
#define INCLUDE_uxTaskGetStackHighWaterMark 1
|
|
#define INCLUDE_uxTaskGetStackHighWaterMark2 0
|
|
#define INCLUDE_eTaskGetState 1
|
|
#define INCLUDE_xTaskResumeFromISR 1
|
|
#define INCLUDE_xTimerPendFunctionCall 1
|
|
#define INCLUDE_xTaskGetSchedulerState 1
|
|
#ifdef CONFIG_IDF_TARGET_LINUX
|
|
#define INCLUDE_xTaskGetCurrentTaskHandle 0 // not defined in POSIX simulator
|
|
#define INCLUDE_vTaskDelayUntil 1
|
|
#else
|
|
#define INCLUDE_xTaskDelayUntil 1
|
|
#define INCLUDE_xTaskGetCurrentTaskHandle 1
|
|
#endif
|
|
//Unlisted
|
|
#define INCLUDE_pxTaskGetStackStart 1
|
|
|
|
// -------------------- Trace Macros -----------------------
|
|
|
|
/*
|
|
For trace macros.
|
|
Note: Include trace macros here and not above as trace macros are dependent on some of the FreeRTOS configs
|
|
*/
|
|
#ifndef __ASSEMBLER__
|
|
#if CONFIG_SYSVIEW_ENABLE
|
|
#include "SEGGER_SYSVIEW_FreeRTOS.h"
|
|
#undef INLINE // to avoid redefinition
|
|
#endif //CONFIG_SYSVIEW_ENABLE
|
|
#endif /* def __ASSEMBLER__ */
|
|
|
|
/* ------------------------------------------------ ESP-IDF Additions --------------------------------------------------
|
|
* - All FreeRTOS related configurations no part of Vanilla FreeRTOS goes into this section
|
|
* - FreeRTOS configurations related to SMP and ESP-IDF additions go into this section
|
|
* ------------------------------------------------------------------------------------------------------------------ */
|
|
|
|
// ------------------------- SMP ---------------------------
|
|
|
|
#ifndef CONFIG_FREERTOS_UNICORE
|
|
#define portNUM_PROCESSORS 2
|
|
#else
|
|
#define portNUM_PROCESSORS 1
|
|
#endif
|
|
#define configNUM_CORES portNUM_PROCESSORS
|
|
#ifdef CONFIG_FREERTOS_VTASKLIST_INCLUDE_COREID
|
|
#define configTASKLIST_INCLUDE_COREID 1
|
|
#endif
|
|
|
|
// ---------------------- Features -------------------------
|
|
|
|
#define configTHREAD_LOCAL_STORAGE_DELETE_CALLBACKS CONFIG_FREERTOS_TLSP_DELETION_CALLBACKS
|
|
|
|
#if CONFIG_FREERTOS_CHECK_MUTEX_GIVEN_BY_OWNER
|
|
#define configCHECK_MUTEX_GIVEN_BY_OWNER 1
|
|
#else
|
|
#define configCHECK_MUTEX_GIVEN_BY_OWNER 0
|
|
#endif
|
|
|
|
#ifndef __ASSEMBLER__
|
|
#if CONFIG_FREERTOS_ENABLE_STATIC_TASK_CLEAN_UP
|
|
extern void vPortCleanUpTCB ( void *pxTCB );
|
|
#define portCLEAN_UP_TCB( pxTCB ) vPortCleanUpTCB( pxTCB )
|
|
#endif
|
|
#endif
|
|
|
|
// -------------------- Compatibility ----------------------
|
|
|
|
// backward compatibility for 4.4
|
|
#define xTaskRemoveFromUnorderedEventList vTaskRemoveFromUnorderedEventList
|
|
|
|
#endif // CONFIG_FREERTOS_SMP
|
|
|
|
#endif /* FREERTOS_CONFIG_H */
|