定制
[配置]

FreeRTOS 使用 FreeRTOSConfig.h 配置文件进行定制。每个 FreeRTOS 应用程序必须在其预处理器的包含路径中包含 FreeRTOSConfig.h 头文件。 FreeRTOSConfig.h 为正在构建的应用程序定制 RTOS 内核。因此它是特定于应用程序的，而非 RTOS，并且应当位于应用程序目录，而不是 RTOS 内核源代码目录。

RTOS 源代码下载内容中的每个演示应用程序都有自己的 FreeRTOSConfig.h 文件。一些演示版本比较旧，没有包含所有可用的配置选项。其中省略的配置选项在 RTOS 源文件中被设置为默认值。

以下是一个典型的 FreeRTOSConfig.h 定义，后面是每个参数的解释：

#ifndef FREERTOS_CONFIG_H
#define FREERTOS_CONFIG_H

/* Here is a good place to include header files that are required across
your application. */
#include "something.h"

#define configUSE_PREEMPTION                    1
#define configUSE_PORT_OPTIMISED_TASK_SELECTION 0
#define configUSE_TICKLESS_IDLE                 0
#define configCPU_CLOCK_HZ                      60000000
#define configSYSTICK_CLOCK_HZ                  1000000
#define configTICK_RATE_HZ                      250
#define configMAX_PRIORITIES                    5
#define configMINIMAL_STACK_SIZE                128
#define configMAX_TASK_NAME_LEN                 16
#define configUSE_16_BIT_TICKS                  0
#define configTICK_TYPE_WIDTH_IN_BITS           TICK_TYPE_WIDTH_16_BITS
#define configIDLE_SHOULD_YIELD                 1
#define configUSE_TASK_NOTIFICATIONS            1
#define configTASK_NOTIFICATION_ARRAY_ENTRIES   3
#define configUSE_MUTEXES                       0
#define configUSE_RECURSIVE_MUTEXES             0
#define configUSE_COUNTING_SEMAPHORES           0
#define configUSE_ALTERNATIVE_API               0 /* Deprecated! */
#define configQUEUE_REGISTRY_SIZE               10
#define configUSE_QUEUE_SETS                    0
#define configUSE_TIME_SLICING                  0
#define configUSE_NEWLIB_REENTRANT              0
#define configENABLE_BACKWARD_COMPATIBILITY     0
#define configNUM_THREAD_LOCAL_STORAGE_POINTERS 5
#define configUSE_MINI_LIST_ITEM                1
#define configSTACK_DEPTH_TYPE                  uint32_t
#define configMESSAGE_BUFFER_LENGTH_TYPE        size_t
#define configHEAP_CLEAR_MEMORY_ON_FREE         1
#define configUSE_APPLICATION_TASK_TAG          0
#define configSTATS_BUFFER_MAX_LENGTH           0xFFFF

/* Memory allocation related definitions. */
#define configSUPPORT_STATIC_ALLOCATION             1
#define configSUPPORT_DYNAMIC_ALLOCATION            1
#define configKERNEL_PROVIDED_STATIC_MEMORY         1
#define configTOTAL_HEAP_SIZE                       10240
#define configAPPLICATION_ALLOCATED_HEAP            1
#define configSTACK_ALLOCATION_FROM_SEPARATE_HEAP   1
#define configENABLE_HEAP_PROTECTOR                 1

/* Hook function related definitions. */
#define configUSE_IDLE_HOOK                     0
#define configUSE_TICK_HOOK                     0
#define configCHECK_FOR_STACK_OVERFLOW          0
#define configUSE_MALLOC_FAILED_HOOK            0
#define configUSE_DAEMON_TASK_STARTUP_HOOK      0
#define configUSE_SB_COMPLETED_CALLBACK         0

/* Run time and task stats gathering related definitions. */
#define configGENERATE_RUN_TIME_STATS           0
#define configUSE_TRACE_FACILITY                0
#define configUSE_STATS_FORMATTING_FUNCTIONS    0

/* Co-routine related definitions. */
#define configUSE_CO_ROUTINES                   0
#define configMAX_CO_ROUTINE_PRIORITIES         1

/* Software timer related definitions. */
#define configUSE_TIMERS                        1
#define configTIMER_TASK_PRIORITY               3
#define configTIMER_QUEUE_LENGTH                10
#define configTIMER_TASK_STACK_DEPTH            configMINIMAL_STACK_SIZE

/* Interrupt nesting behaviour configuration. */
#define configKERNEL_INTERRUPT_PRIORITY         [dependent of processor]
#define configMAX_SYSCALL_INTERRUPT_PRIORITY    [dependent on processor and application]
#define configMAX_API_CALL_INTERRUPT_PRIORITY   [dependent on processor and application]

/* Define to trap errors during development. */
#define configASSERT( ( x ) ) if( ( x ) == 0 ) vAssertCalled( __FILE__, __LINE__ )

/* FreeRTOS MPU specific definitions. */
#define configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS 0
#define configTOTAL_MPU_REGIONS                                8 /* Default value. */
#define configTEX_S_C_B_FLASH                                  0x07UL /* Default value. */
#define configTEX_S_C_B_SRAM                                   0x07UL /* Default value. */
#define configENFORCE_SYSTEM_CALLS_FROM_KERNEL_ONLY            1
#define configALLOW_UNPRIVILEGED_CRITICAL_SECTIONS             1
#define configENABLE_ERRATA_837070_WORKAROUND                  1
#define configUSE_MPU_WRAPPERS_V1                              0
#define configPROTECTED_KERNEL_OBJECT_POOL_SIZE                10
#define configSYSTEM_CALL_STACK_SIZE                           128
#define configENABLE_ACCESS_CONTROL_LIST                       1

/* ARMv8-M secure side port related definitions. */
#define secureconfigMAX_SECURE_CONTEXTS         5

/* Optional functions - most linkers will remove unused functions anyway. */
#define INCLUDE_vTaskPrioritySet                1
#define INCLUDE_uxTaskPriorityGet               1
#define INCLUDE_vTaskDelete                     1
#define INCLUDE_vTaskSuspend                    1
#define INCLUDE_xResumeFromISR                  1
#define INCLUDE_vTaskDelayUntil                 1
#define INCLUDE_vTaskDelay                      1
#define INCLUDE_xTaskGetSchedulerState          1
#define INCLUDE_xTaskGetCurrentTaskHandle       1
#define INCLUDE_uxTaskGetStackHighWaterMark     0
#define INCLUDE_uxTaskGetStackHighWaterMark2    0
#define INCLUDE_xTaskGetIdleTaskHandle          0
#define INCLUDE_eTaskGetState                   0
#define INCLUDE_xEventGroupSetBitFromISR        1
#define INCLUDE_xTimerPendFunctionCall          0
#define INCLUDE_xTaskAbortDelay                 0
#define INCLUDE_xTaskGetHandle                  0
#define INCLUDE_xTaskResumeFromISR              1

/* A header file that defines trace macro can be included here. */

#endif /* FREERTOS_CONFIG_H */

'config' 参数

configUSE_PREEMPTION

设置为 1，使用抢占式 RTOS 调度器；设置为 0，使用协同式 RTOS 调度器。

configUSE_PORT_OPTIMISED_TASK_SELECTION

一些 FreeRTOS 移植有两种选择下一个执行任务的方法，一种是通用方法，另一种是移植特定的方法。

通用方法：

在 configUSE_PORT_OPTIMISED_TASK_SELECTION 设置为 0 时，或没有实现移植特定的方法时使用。
可用于所有 FreeRTOS 移植。
完全使用 C 编写，比移植特定的方法低效。
不限制可用优先级的最大数量。

移植特定的方法：

部分移植不可用。
当 configUSE_PORT_OPTIMISED_TASK_SELECTION 设置为 1 时使用。
依赖于一种或多种架构特定的汇编指令（通常是前导零计数 [CLZ] 指令或同等指令），因此仅适用于专为其编写该指令的架构。
比通用方法更高效。
通常限制可用优先级的最大数量为 32 。

configUSE_滴答LESS_IDLE

将 configUSE_滴答LESS_IDLE 设置为 1，使用低功耗无滴答模式，或设置为 0，保持滴答中断始终运行。并非所有 FreeRTOS 移植都实现了低功耗无滴答模式。

configUSE_MALLOC_FAILED_HOOK

创建任务、队列或信号量时，内核调用 pvPortMalloc() 从堆中分配内存。官方 FreeRTOS 下载内容中包括4 种内存分配方案样例。这些方案分别实现在 heap_1.c、heap_2.c、heap_3.c、heap_4.c 和 heap_5.c 源文件中。 configUSE_MALLOC_FAILED_HOOK 仅在用到这3 种方案时适用。。

malloc() 失败的钩子函数是一个钩子（或回调）函数，在已经定义和配置的情况下，如果 pvPortMalloc() 返回 NULL ，它将被调用。只有当 FreeRTOS 堆剩余的内存不足以分配请求的内存时，它才会返回 NULL 。

如果 configUSE_MALLOC_FAILED_HOOK 设置为 1，那么应用程序必须定义 malloc() 失败的钩子函数。如果 configUSE_MALLOC_FAILED_HOOK 设置为 0，那么 malloc() 失败的钩子函数将不会被调用，即使定义了钩子函数。 malloc() 失败的钩子函数必须具有如下所示的名称和原型。

void vApplicationMallocFailedHook( void );

configUSE_DAEMON_TASK_STARTUP_HOOK

如果 configUSE_TIMERS 和 configUSE_DAEMON_TASK_STARTUP_HOOK 都设置为 1，那么应用程序必须定义钩子函数，而且它必须和如下的函数具有相同的名称和原型。当 RTOS 守护进程任务（也称为定时器服务任务）首次执行时，钩子函数将会且只会被调用一次。任何需要 RTOS 运行的应用程序初始化代码，可放在钩子函数中。

void void vApplicationDaemonTaskStartupHook( void );

configUSE_SB_COMPLETED_CALLBACK

设置 configUSE_SB_COMPLETED_CALLBACK() 时需要设置构建中的 xStreamBufferCreateWithCallback() 和 xStreamBufferCreateStaticWithCallback() （及其消息缓冲区等效函数）。使用这些函数创建的流缓冲区和消息缓冲区可以有自己唯一的发送完成回调和接收完成回调，其中通过 xStreamBufferCreate() 和 xStreamBufferCreateStatic ()（及其消息缓冲区等效函数）创建的流缓冲区和消息缓冲区都共享 sbSEND_COMPLETED() 和 sbRECEVE_COMPLETED() 宏定义的回调。 configUSE_SB_COMPLETED_CALLBACK 默认为 0 ，以便向后兼容。

configUSE_滴答_HOOK

将其设置为 1，使用滴答钩子，或设置为 0，忽略滴答钩子。

configCPU_CLOCK_HZ

输入驱动生成滴答中断的外设所用的内部时钟的执行频率（以赫兹为单位）。内部时钟通常也是驱动内部 CPU 的时钟。此值是正确配置定时器外围设备所必需的。

configSYS滴答_CLOCK_HZ

仅适用于 ARM Cortex-M 移植的可选参数。

ARM Cortex-M 移植默认从 Cortex-M Sys滴答定时器生成 RTOS 滴答中断。大多数 Cortex-M MCU 以与 MCU 自身相同的频率运行 SysTick 定时器，如果这样，则不需要 configSYSTICK_CLOCK_HZ，而且它应保持未定义状态。如果 SysTick 定时器的频率与 MCU 核心不同，那么应将 configCPU_CLOCK_HZ 设置为正常的 MCU 时钟频率，将 configSYSTICK_CLOCK_HZ 设置为 SysTick 时钟频率。

configTICK_RATE_HZ

RTOS 滴答中断的频率。

滴答中断用于测定时间。因此，滴答频率越高，时间测定的分辨率越高。然而，滴答频率高也意味着 RTOS 内核将使用更多的 CPU 时间，因此效率会降低。 RTOS 演示应用程序使用的滴答频率均为 1000 Hz。此频率用于测试 RTOS 内核，高于正常的频率要求。

多个任务可以共用相同的优先级。 RTOS 调度器将会在每个 RTOS 滴答期间切换具有相同优先级的任务，让它们共享处理器时间。因此，滴答频率高也会减少分给每个任务的“时间切片”。

configMAX_PRIORITIES

应用程序任务可用的优先级数量。任意数量的任务可共用相同的优先级。协程单独分配优先级，请参阅 configMAX_CO_ROUTINE_PRIORITIES。

每个可用的优先级都消耗了 RTOS 内核一些 RAM，因此不应将该值设置得高于应用程序实际需要的优先级数量。

如果 configUSE_PORT_OPTIMISED_TASK_SELECTION 设置为 1，那么将限制最大允许值。

configMINIMAL_STACK_SIZE

空闲任务使用的堆栈大小。通常，该值不应小于 FreeRTOSConfig.h 中设置的值，该头文件位于您使用的移植的演示应用程序。

此堆栈大小与 xTaskCreate() 和 xTaskCreateStatic() 函数的堆栈大小参数类似，是按字指定，而不是按字节指定。如果堆栈上的每个元素为 32 位，那么大小为 100 元素的堆栈包含 400 字节（每个堆栈元素 32 位，消耗 4 个字节）。

configMAX_TASK_NAME_LEN

创建任务时，任务描述性名称的最大允许长度。该长度按字符数指定，包括 NULL 终止字节。

configUSE_TRACE_FACILITY

如果想包含其他结构成员和函数来辅助执行可视化和跟踪，将其设置为 1。

configUSE_STATS_FORMATTING_FUNCTIONS

将 configUSE_TRACE_FACILITY 和 configUSE_STATS_FORMATTING_FUNCTIONS 设置为 1，包含 vTaskList() 和 vTaskGetRunTimeStats() 函数中的功能。设置任意一个为 0，会在构建时忽略 vTaskList() 和 vTaskGetRunTimeStates()。

configUSE_16_BIT_滴答S

时间以 '滴答s' 为单位测定，这是 RTOS 内核启动后，滴答中断已经执行的次数。滴答数存放在滴答Type_t 类型的变量中。

将 configUSE_16_BIT_滴答S 定义为 1，会将滴答Type_t 定义为 (typedef) 无符号的 16 位类型。将 configUSE_16_BIT_滴答S 定义为 0，会将滴答Type_t 定义为 (typedef) 无符号的 32 位类型。

在 8 位和 16 位架构上使用 16 位类型，将大大提高性能，但会限制最大可指定的时间段为 65535 '滴答s'。因此，假设滴答频率为 250 Hz，当使用 16 位计数器时，任务可以延迟或阻塞的最大时间为 262 秒，而使用 32 位计数器时，则为 17179869 秒。

增加了 configTICK_TYPE_WIDTH_IN_BITS，以支持大于 32 位的滴答计数。新设计应使用 configTICK_TYPE_WIDTH_IN_BITS，而不是 configUSE_16_BIT_TICKS。

configTICK_TYPE_WIDTH_IN_BITS

时间以 '滴答s' 为单位测定，这是 RTOS 内核启动后，滴答中断已经执行的次数。滴答数存放在滴答Type_t 类型的变量中。

configTICK_TYPE_WIDTH_IN_BITS 控制 TickType_t 的类型（以及位宽）：

将 configTICK_TYPE_WIDTH_IN_BITS 定义为 TICK_TYPE_WIDTH_16_BITS，会导致 TickType_t 被定义（typedef'ed）为无符号 16 位类型。
将 configTICK_TYPE_WIDTH_IN_BITS 定义为 TICK_TYPE_WIDTH_32_BITS，会导致 TickType_t 被定义（typedef'ed）为无符号 32 位类型。
将 configTICK_TYPE_WIDTH_IN_BITS 定义为 TICK_TYPE_WIDTH_64_BITS，会导致 TickType_t 被定义（typedef'ed）为无符号 64 位类型。

使用 16 位类型可大大提高 8 位和 16 位架构的性能，但会将可指定的最大时间段限制为 65535 个“滴答”。同样，使用 32 位类型可提高 32 位架构的性能，但会将可指定的最大周期限制为 4294967295 个“滴答”。

configIDLE_SHOULD_YIELD

此参数控制空闲优先级任务的行为。它仅在以下情况下有效：

使用抢占式调度器。
应用程序创建运行在空闲优先级的任务。

如果 configUSE_TIME_SLICING 设置为 1（或未定义），那么优先级相同的任务将使用时间切片。如果没有任务被抢占，那么可以假设每个给定优先级的任务将分配相同的处理时间——如果优先级高于空闲优先级，那么情况确实如此。

如果任务均为空闲优先级，其行为可能略有不同。如果 configIDLE_SHOULD_YIELD 设置为 1，那么如果其他空闲优先级任务准备运行，空闲任务将立即挂起。这确保当有应用程序任务可调度时，空闲任务花费的时间最少。然而，这种行为可能产生如下所示的不良效应（取决于您的应用需求）：

上图显示了四个空闲优先级任务的执行模式。任务 A、B 和 C 是应用程序任务。任务 I 是空闲任务。上下文在时间 T0、T1、……、T6 定期切换。当空闲任务挂起，任务 A 开始执行，但当前时间片已经被空闲任务消耗了一部分。这导致实际上任务 I 和任务 A 共用同一时间片。因此，应用程序任务 B 和 C 获得的处理时间多于应用任务 A。

这种情况可以通过以下方式避免：

如果适当，使用空闲钩子代替单独的空闲优先级任务。
以高于空闲的优先级创建所有应用程序任务。
将 configIDLE_SHOULD_YIELD 设置为 0。

将 configIDLE_SHOULD_YIELD 设置为 0 会阻止空闲任务让出处理时间，直到其时间片结束。这可以确保所有空闲优先级任务分配相同的处理时间（如果没有任务被抢占），但这是以分配给空闲任务更高比例的处理时间为代价的。

configUSE_TASK_NOTIFICATIONS

将 configUSE_TASK_NOTIFICATIONS 设置为 1（或未定 configUSE_TASK_NOTIFICATIONS），将在构建中包含直达任务通知功能及其相关的 API。

将 configUSE_TASK_NOTIFICATIONS 设置为 0，构建中将不包括直达任务通知功能及其相关的 API。

如果在构建中包含直达任务通知，每个任务将额外消耗 8 字节 RAM。

configTASK_NOTIFICATION_ARRAY_ENTRIES

每个 RTOS 任务都有一个任务通知数组。 configTASK_NOTIFICATION_ARRAY_ENTRIES 设置数组的索引数。

在 FreeRTOS V10.4.0 之前，任务只有一个通知值，而不是通知值数组，因此出于向后兼容考虑，如果 configTASK_NOTIFICATION_ARRAY_ENTRIES 未定义，则默认为 1。

configUSE_MUTEXES

将其设置为 1，将在构建中包含互斥功能，或设置为 0，将在构建中忽略互斥功能。读者应熟悉互斥锁和二进制信号量之间对于 FreeRTOS 功能的差异。

configUSE_RECURSIVE_MUTEXES

将其设置为 1，将在构建中包含递归互斥锁功能，或设置为 0，将在构建中忽略递归互斥锁功能。

configUSE_COUNTING_SEMAPHORES

将其设置为 1，将在构建中包含计数信号量功能，或设置为 0，将在构建中忽略计数信号量功能。

configUSE_ALTERNATIVE_API

将其设置为 1，将在构建中包含“替代”队列函数，或设置为 0，将在构建中忽略“替代”队列函数。替代队列 API 描述在 queue.h 头文件中。 替代队列 API 已弃用，不应用于新的设计。

configCHECK_FOR_STACK_OVERFLOW

堆栈溢出检测页面说明了此参数。

configQUEUE_REGISTRY_SIZE

队列注册表有两个目的，都与 RTOS 内核感知调试相关：

可以关联文本名称和队列，便于在调试 GUI 中识别队列。
包含调试器定位每个已注册队列和信号量所需的信息。

除非使用 RTOS 内核感知调试器，否则队列注册表没有任何用途。

configQUEUE_REGISTRY_SIZE 定义了可以注册的队列和信号量的最大数量。只需要注册那些要使用 RTOS 内核感知调试器查看的队列和信号量。请查阅 API 引用文档，了解更多关于 vQueueAddToRegistry() 和 vQueueUnregisterQueue() 的信息。

configUSE_QUEUE_SETS

将其设置为 1，包含队列集合功能（可以阻塞或挂起多个队列和信号量），或设置为 0，忽略队列集合功能。

configUSE_TIME_SLICING

默认情况下（如果 configUSE_TIME_SLICING 未定义，或者 configUSE_TIME_SLICING 定义为 1）FreeRTOS 使用带时间片的抢占式优先级调度。这意味着 RTOS 调度器将始终运行优先级最高且处于就绪状态的任务，并在每个 RTOS 滴答中断时，在具有相同优先级的任务之间切换。如果 configUSE_TIME_SLICING 设置为 0，RTOS 调度器仍将运行优先级最高且处于就绪状态的任务，但不会因为发生滴答中断而在具有相同优先级的任务之间切换。

configUSE_NEWLIB_REENTRANT

如果 configUSE_NEWLIB_REENTRANT 设置为 1，那么将为每个创建的任务分配一个newlib 重入结构体。

请注意，应大众需求已经包含 newlib 支持，但未被 FreeRTOS 维护者使用。 FreeRTOS不是不为由此产生的 newlib 操作负责。用户必须熟悉 newlib，而且必须实现全系统的必要桩函数。请注意，在撰写本文档时，当前的 newlib 设计实现了必须提供锁的全系统 malloc()。

configENABLE_BACKWARD_COMPATIBILITY

FreeRTOS.h 头文件包含一组 #define 宏，用于将 FreeRTOS 8.0.0 之前的版本中使用的数据类型名称映射到 FreeRTOS 8.0.0 版本中使用的名称。该宏可以将构建应用程序代码所依据的 FreeRTOS 版本从 8.0.0 之前的版本升级到 8.0.0 之后版本，而无需修改代码。将 FreeRTOSConfig.h 中的 configENABLE_BACKWARD_COMPATIBILITY 设置为 0，将在构建中忽略该宏。而且这样做可以确认没有使用 8.0.0 版本之前的名称。

configNUM_THREAD_LOCAL_STORAGE_POINTERS

设置每个任务的线程本地存储数组攫取值。

configUSE_MINI_LIST_ITEM

MiniListItem_t 用于 FreeRTOS 列表中的开始和结束标记节点， ListItem_t 用于 FreeRTOS 列表中的所有其他节点。当 configUSE_MINI_LIST_ITEM 设置为 0 时， MiniListItem_t 和 ListItem_t 保持一致。当 configUSE_MINI_LIST_ITEM 设置为 1 时，MiniListItem_t 包含的字段比 ListItem_t 少 3 个，这样可以节省一些 RAM，但代价是违反了某些编译器用于优化的严格别名规则。如果未定义， configUSE_MINI_LIST_ITEM 默认为 1 ，以便向后兼容。

configSTACK_DEPTH_TYPE

设置调用 xTaskCreate() 时用于指定堆栈深度的类型，以及许多其他使用堆栈大小的地方（例如，返回堆栈高水位线）。

旧版的 FreeRTOS 使用 UBaseType_t 类型变量指定堆栈大小，但这对 8 位微控制器的限制过于严格。 configSTACK_DEPTH_TYPE 通过让应用程序开发人员指定使用的类型来解除该限制。

configMESSAGE_BUFFER_LENGTH_TYPE

FreeRTOS 消息缓冲区使用 configMESSAGE_BUFFER_LENGTH_TYPE 类型的变量存储每个消息的长度。如果未定义 configMESSAGE_BUFFER_LENGTH_TYPE ，那么它将默认为 size_t。如果存储在消息缓冲区中的消息不会超过 255 字节，那么在 32 位微控制器上将 configMESSAGE_BUFFER_LENGTH_TYPE 定义为 uint8_t 将为每个消息节约 3 个字节。类似地，如果存储在消息缓冲区中的消息不会超过 65535 字节，那么在 32 位微控制器上将 configMESSAGE_BUFFER_LENGTH_TYPE 定义为 uint16_t 将为每个消息节约 2 个字节。

configSUPPORT_STATIC_ALLOCATION

如果将 configSUPPORT_STATIC_ALLOCATION 设置为 1，那么 RTOS 对象可以使用应用程序编写者提供的 RAM 创建。

如果将 configSUPPORT_STATIC_ALLOCATION 设置为 0，那么 RTOS 对象只能使用从 FreeRTOS 堆中分配的 RAM 创建。

如果 configSUPPORT_STATIC_ALLOCATION 未定义，那么它默认为 0。

如果 configSUPPORT_STATIC_ALLOCATION 设置为 1，那么应用程序编写者还必须提供两个回调函数： vApplicationGetIdleTaskMemory() 提供内存供 RTOS 空闲任务使用，并且（如果 configUSE_TIMERS 设置为 1），vApplicationGetTimerTaskMemory() 用于提供 RTOS 守护/定时器服务任务使用的内存。示例具体请参阅下文。



/* configSUPPORT_STATIC_ALLOCATION is set to 1, so the application must provide an

implementation of vApplicationGetIdleTaskMemory() to provide the memory that is

used by the Idle task. */

void vApplicationGetIdleTaskMemory( StaticTask_t **ppxIdleTaskTCBBuffer,

                                    StackType_t **ppxIdleTaskStackBuffer,

                                    configSTACK_DEPTH_TYPE *puxIdleTaskStackSize )

{

/* If the buffers to be provided to the Idle task are declared inside this

function then they must be declared static - otherwise they will be allocated on

the stack and so not exists after this function exits. */

static StaticTask_t xIdleTaskTCB;

static StackType_t uxIdleTaskStack[ configMINIMAL_STACK_SIZE ];



    /* Pass out a pointer to the StaticTask_t structure in which the Idle task's

    state will be stored. */

    *ppxIdleTaskTCBBuffer = &xIdleTaskTCB



    /* Pass out the array that will be used as the Idle task's stack. */

    *ppxIdleTaskStackBuffer = uxIdleTaskStack;



    /* Pass out the size of the array pointed to by *ppxIdleTaskStackBuffer.

    Note that, as the array is necessarily of type StackType_t,

    configMINIMAL_STACK_SIZE is specified in words, not bytes. */

    *puxIdleTaskStackSize = configMINIMAL_STACK_SIZE;

}

/*-----------------------------------------------------------*/



/* configSUPPORT_STATIC_ALLOCATION and configUSE_TIMERS are both set to 1, so the

application must provide an implementation of vApplicationGetTimerTaskMemory()

to provide the memory that is used by the Timer service task. */

void vApplicationGetTimerTaskMemory( StaticTask_t **ppxTimerTaskTCBBuffer,

                                     StackType_t **ppxTimerTaskStackBuffer,

                                     configSTACK_DEPTH_TYPE *puxTimerTaskStackSize )

{

/* If the buffers to be provided to the Timer task are declared inside this

function then they must be declared static - otherwise they will be allocated on

the stack and so not exists after this function exits. */

static StaticTask_t xTimerTaskTCB;

static StackType_t uxTimerTaskStack[ configTIMER_TASK_STACK_DEPTH ];



    /* Pass out a pointer to the StaticTask_t structure in which the Timer

    task's state will be stored. */

    *ppxTimerTaskTCBBuffer = &xTimerTaskTCB



    /* Pass out the array that will be used as the Timer task's stack. */

    *ppxTimerTaskStackBuffer = uxTimerTaskStack;



    /* Pass out the size of the array pointed to by *ppxTimerTaskStackBuffer.

    Note that, as the array is necessarily of type StackType_t,

    configTIMER_TASK_STACK_DEPTH is specified in words, not bytes. */

    *puxTimerTaskStackSize = configTIMER_TASK_STACK_DEPTH;

}



Examples of the callback functions that must be provided by the application to

supply the RAM used by the Idle and Timer Service tasks if configSUPPORT_STATIC_ALLOCATION

is set to 1.

使用对称多处理 (SMP) 支持时，应用程序还需要提供 vApplicationGetPassiveIdleTaskMemory 来提供内存供 (configNUMBER_OF_CORES - 1)个被动空闲任务使用。参见以下示例：



void vApplicationGetPassiveIdleTaskMemory( StaticTask_t **ppxIdleTaskTCBBuffer,

                                           StackType_t **ppxIdleTaskStackBuffer,

                                           configSTACK_DEPTH_TYPE *puxIdleTaskStackSize

                                           BaseType_t xPassiveIdleTaskIndex  )

{

    /* If the buffers to be provided to the Idle task are declared inside this


     * function then they must be declared static - otherwise they will be allocated on


     * the stack and so not exist after this function exits. */

    static StaticTask_t xIdleTaskTCBs[ configNUMBER_OF_CORES - 1 ];

    static StackType_t uxIdleTaskStacks[ configNUMBER_OF_CORES - 1 ][ configMINIMAL_STACK_SIZE ];

    

    /* Pass out a pointer to the StaticTask_t structure in which the Idle task's


     * state will be stored. */

    *ppxIdleTaskTCBBuffer = &( xIdleTaskTCBs[ xPassiveIdleTaskIndex  ] );

    

    /* Pass out the array that will be used as the Idle task's stack. */

    *ppxIdleTaskStackBuffer = &( uxIdleTaskStacks[ xPassiveIdleTaskIndex  ][ 0 ] );

    

    /* Pass out the size of the array pointed to by *ppxIdleTaskStackBuffer.


     * Note that, as the array is necessarily of type StackType_t,


     * configMINIMAL_STACK_SIZE is specified in words, not bytes. */

    *puxIdleTaskStackSize = configMINIMAL_STACK_SIZE;

}

或者，应用程序编写者可以在 FreeRTOSConfig.h 文件中将 configKERNEL_PROVIDED_STATIC_MEMORY 设置为 1，以使用内核提供的这些回调的默认实现。

请参阅静态内存分配 Vs 动态内存分配页面，了解更多信息。

configSUPPORT_DYNAMIC_ALLOCATION

如果将 configSUPPORT_DYNAMIC_ALLOCATION 设置为 1，那么 RTOS 对象可以使用从 FreeRTOS 堆中自动分配的 RAM 创建。

如果 configSUPPORT_DYNAMIC_ALLOCATION 设置为 0，那么 RTOS 对象只能使用应用程序编写者提供的 RAM 创建。

如果 configSUPPORT_DYNAMIC_ALLOCATION 未定义，那么它默认为 1。

请参阅静态内存分配 Vs 动态内存分配页面，了解更多信息。

configKERNEL_PROVIDED_STATIC_MEMORY

如果 configSUPPORT_STATIC_ALLOCATION 设置为 1 ，则应用程序编写者需要提供两个回调函数： vApplicationGetIdleTaskMemory() 提供内存供 RTOS 空闲任务使用，以及（如果 configUSE_TIMERS 设置为 1) vApplicationGetTimerTaskMemory() 提供内存供 RTOS 守护进程/定时器服务任务使用。应用程序编写者可以在 FreeRTOSConfig.h 中将 configKERNEL_PROVIDED_STATIC_MEMORY 设置为 1，以使用内核提供的这些回调的默认实现。

如果 configKERNEL_PROVIDED_STATIC_MEMORY 未定义，则默认值为 0。

注意：回调函数的默认实现仅适用于非 MPU 端口。

configTOTAL_HEAP_SIZE

FreeRTOS 堆中可用的 RAM 总量。

只有在 configSUPPORT_DYNAMIC_ALLOCATION 设置为 1 时，才使用该值。而且应用程序使用 FreeRTOS 源代码下载内容中提供的一种示例内存分配方案。请参阅内存配置部分，了解更多详细信息。

configAPPLICATION_ALLOCATED_HEAP

默认情况下，FreeRTOS 堆由 FreeRTOS 声明并由链接器放置在存储器中。将 configAPPLICATION_ALLOCATED_HEAP 设置为 1，允许应用程序编写者声明堆，这使得应用程序编写者可以将堆放置在内存的任意位置。

如果使用 heap_1.c、heap_2.c 或 heap_4.c，并且将 configAPPLICATION_ALLOCATED_HEAP 设置为 1，那么应用程序编写者必须提供一个 uint8_t 数组，其确切的名称和大小如下所示。该数组将用作 FreeRTOS 堆。数组如何放置在内存的特定位置取决于使用的编译器，请参阅编译器的文档。

uint8_t ucHeap[ configTOTAL_HEAP_SIZE ];

configSTACK_ALLOCATION_FROM_SEPARATE_HEAP

如果 configSTACK_ALLOCATION_FROM_SEPARATE_HEAP 设置为 1，那么对于任何使用 xTaskCreate 或 xTaskCreateRestricted API 创建的任务，其堆栈使用 pvPortMallocStack 函数分配并使用 vPortFreeStack 函数释放。用户需要实现线程安全的 pvPortMallocStack 和 vPortFreeStack 函数。这使得用户可以从独立的内存区域为任务分配堆栈（可能是与 FreeRTOS 堆不同的另一个堆）。

如果 configSTACK_ALLOCATION_FROM_SEPARATE_HEAP 未定义，那么它默认为 0。

pvPortMallocStack 和 vPortFreeStack 函数实现的示例如下：



void * pvPortMallocStack( size_t xWantedSize  )

{

    /* Allocate a memory block of size xWantedSize. The function used for


     * allocating memory must be thread safe. */

    return MyThreadSafeMalloc( xWantedSize );

}



void vPortFreeStack( void * pv )

{

    /* Free the memory previously allocated using pvPortMallocStack. The


     * function used for freeing the memory must be thread safe. */

    MyThreadSafeFree( pv );

}

configENABLE_HEAP_PROTECTOR

应用程序编写者可以将 configENABLE_HEAP_PROTECTOR 设置为 1，以启用堆 4.c 和堆 5.c 中的内部堆块指针的边界检查和混淆，以帮助捕捉指针损坏。

configGENERATE_RUN_TIME_STATS

configUSE_CO_ROUTINES

configMAX_CO_ROUTINE_PRIORITIES

configUSE_TIMERS

configTIMER_TASK_PRIORITY

configTIMER_QUEUE_LENGTH

configTIMER_TASK_STACK_DEPTH

configKERNEL_INTERRUPT_PRIORITY
configMAX_SYSCALL_INTERRUPT_PRIORITY 和
configMAX_API_CALL_INTERRUPT_PRIORITY

ARM Cortex-M3 和 ARM Cortex-M4 用户请注意本节末尾的特别注意事项！

configMAX_API_CALL_INTERRUPT_PRIORITY 是 configMAX_SYSCALL_INTERRUPT_PRIORITY 的新名称，仅用于新版移植。这两者是等效的。

请注意，在下面的讨论中，只有以 "FromISR" 结尾的 API 函数才能从中断服务程序中调用。

对于仅实现 configKERNEL_INTERRUPT_PRIORITY 的移植
configKERNEL_INTERRUPT_PRIORITY 设置 RTOS 内核自身使用的中断优先级。调用 API 函数的中断也必须执行在此优先级。不调用 API 函数的中断可以执行在更高的优先级，因此它们的执行不会被 RTOS 内核活动（在硬件自身的限制范围内）延迟。

对于同时实现 configKERNEL_INTERRUPT_PRIORITY 和 configMAX_SYSCALL_INTERRUPT_PRIORITY 的移植：
configKERNEL_INTERRUPT_PRIORITY 设置 RTOS 内核自身使用的中断优先级。 configMAX_SYSCALL_INTERRUPT_PRIORITY 设置了调用中断安全的 FreeRTOS API 函数的最高中断优先级。

完全中断嵌套模型是通过将 configMAX_SYSCALL_INTERRUPT_PRIORITY 置于 configKERNEL_INTERRUPT_PRIORITY 之上（也就是优先级水平更高）实现的。 这意味着 FreeRTOS 内核不会完全禁用中断，即使是在临界区。 此外，这没有分段内核架构的缺点。但请注意，某些微控制器架构会在接受新中断时（在硬件中）禁用中断，这意味着在硬件接受中断和 FreeRTOS 代码重启中断的短暂期间内，中断不可避免地被禁用。

不调用 API 函数的中断可以在高于 configMAX_SYSCALL_INTERRUPT_PRIORITY 的优先级执行，因此不会被 RTOS 内核的运行延迟。

例如，假定微控制器具有8个中断优先级：0 为最低优先级，7 为最高优先级（请参阅本节末尾 ARM Cortex-M3 用户的特别注意事项）。下面的图片描述了如果这两个配置常数设置为 4 和 0，在各个优先级上哪些操作可以做以及哪些操作不可以做，如图所示：

ARM Cortex-M3 和 ARM Cortex-M4 用户的特别注意事项：请参阅专门介绍 ARM Cortex-M 设备中断优先级设置的页面。您至少要记住 ARM Cortex-M3 核心使用低数值数字来表示高优先级中断，这似乎有悖直觉，而且很容易忘记！如果您希望将中断分配为低优先级，请不要将中断的优先级指定为 0（或其他较小数值），因为这可能会导致中断实际上在系统中具有最高优先级 - 因此，如果该优先级高于 configMAX_SYSCALL_INTERRUPT_PRIORITY，则可能会导致系统崩溃。

ARM Cortex-M3 核心的最低优先级实际上是 255，然而，不同的 ARM Cortex-M3 供应商采用了不同数量的优先位，并且提供了以不同方式指定优先级的库函数。例如，在 STM32 上，您可以在 ST 驱动函数库调用中指定的最低优先级实际上是 15，您可以指定的最高优先级是 0。

configASSERT

configASSERT() 在整个 FreeRTOS 源文件中被调用，检查应用程序正在如何使用 FreeRTOS。我们强烈建议开发 FreeRTOS 应用程序时定义 configASSERT()。

示例定义（显示在文件的顶部，并复制在下方）调用 vAssertCalled()，传入文件名和触发 configASSERT() 调用的行号（__ FILE __ 和 __ LINE __是大多数编译器提供的标准宏）。这只是为了演示，因为 vAssertCalled() 不是 FreeRTOS 函数， configASSERT() 可以定义为执行应用程序编写者认为适当的任何操作。

通常情况下，会将 configASSERT() 定义为阻止应用程序进一步执行。这么做是出于两个原因：在断言处停止应用程序可以对导致断言的原因进行调试，而且触发断言后继续执行无论如何都可能导致程序崩溃。

请注意，定义 configASSERT() 不仅会增加应用程序代码量也会增加执行时间。当应用程序足够稳定时，只要将 configASSERT() 在 FreeRTOSConfig.h 中的定义注释掉，就可以消除额外的开销。

如果在调试器控中运行 FreeRTOS，那么可以将 configASSERT() 定义为仅禁用中断并进入循环，如下所示。这会将代码停在没能通过断言测试的那一行，暂停调试器将立即转到有问题的那一行，这样就可以查找它失败的原因。

configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS

如果 configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS 设置为 1，那么应用程序编写者必须提 "application_defined_privileged_functions.h" 头文件，可以在其中实现需要在特权模式下执行的函数。请注意，尽管有 .h 扩展名，该头文件应包含 C 函数的实现，而不仅仅是函数的原型。

在 "application_defined_privileged_functions.h" 中实现的函数必须分别使用 prvRaisePrivilege() 函数和 portRESET_PRIVILEGE() 宏保存和还原处理器的特权状态。例如，如果由库提供的打印函数访问的 RAM 超出应用程序编写者控制范围，因而不能分配给内存保护的用户模式任务，那么打印函数可使用以下代码封装在特权函数中：

这种技术只应该在开发过程中使用，而不能用于部署阶段，因为它会绕过内存保护。

configTOTAL_MPU_REGIONS

ARM Cortex-M4 微控制器的 FreeRTOS MPU（内存保护单元）移植支持具有 16 个 MPU 区域的设备。对于具有 16 个 MPU 区域的设备，应将 configTOTAL_MPU_REGIONS 设置为 16。如果未定义，则默认为 8。

configTEX_S_C_B_FLASH

TEX、可共享 (S)、可缓存 (C) 和可缓冲 (B) 位定义了内存类型，而且如果有需要还可以定义 MPU 区域的可缓存和可共享属性。configTEX_S_C_B_FLASH 允许应用程序编写者可以对包含 Flash 的 MPU 区域的 TEX、可共享 (S)、可缓存 (C)、和可缓冲 (B) 位进行覆盖。如果它未定义，那么默认为 0x07UL，即 TEX = 000、S = 1、C = 1、B = 1。

configTEX_S_C_B_SRAM

TEX、可共享 (S)、可缓存 (C) 和可缓冲 (B) 位定义了内存类型，而且如果有需要还可以定义 MPU 区域的可缓存和可共享属性。configTEX_S_C_B_SRAM 允许应用程序编写者可以对包含 RAM 的 MPU 区域的 TEX、可共享 (S)、可缓存 (C)、和可缓冲 (B) 位进行覆盖。如果它未定义，那么默认为 0x07UL，即 TEX = 000、S = 1、C = 1、B = 1。

configENFORCE_SYSTEM_CALLS_FROM_KERNEL_ONLY

可以将 configENFORCE_SYSTEM_CALLS_FROM_KERNEL_ONLY 定义为 1，防止任何来自内核代码外部的特权升级（进入中断时硬件本身执行的升级除外）。如果 configENFORCE_SYSTEM_CALLS_FROM_KERNEL_ONLY 在 FreeRTOSConfig.h 中设置为 1，变量 __syscalls_flash_start__ 和 __syscalls_flash_end__ 需要从链接器脚本中导出，以分别表明系统调用内存的起始和终止地址。建议将其定义为1 ，以获得最高的安全性。

configALLOW_UNPRIVILEGED_CRITICAL_SECTIONS

将其设置为 0，防止非特权应用程序任务使用 taskENTER_CRITICAL() 宏创建临界区。将此常量设置为 1，或未定义，会允许特权或非特权任务创建临界区。请注意：建议将此常量定义为 0，以获得最高的安全性。因此，如果此常量未定义，编译器会输出警告。

configENABLE_ERRATA_837070_WORKAROUND

在 Cortex-M7 r0p0/r0p1核心上使用 Cortex-M4 MPU 移植时，将 configENABLE_ERRATA_837070_WORKAROUND 设置为 1 ，以激活 ARM 勘误表 837070 所需的解决方法。

configUSE_MPU_WRAPPERS_V1

configUSE_MPU_WRAPPERS_V1 适用于 FreeRTOS V10.6.0 及之后版本中支持内存保护单元 (MPU) 的移植。

FreeRTOS V10.6.0 引入了一个新的 MPU 包装器，具有多种安全增强功能。将 configUSE_MPU_WRAPPERS_V1 设置为 1，可允许应用程序编写者使用旧的 MPU 包装器，以实现向后兼容。将 configUSE_MPU_WRAPPERS_V1 设置为 0 则可使用新的 MPU 包装器。如果未定义， configUSE_MPU_WRAPPERS_V1 默认为 0。

注意：建议将 configUSE_MPU_WRAPPERS_V1 定义为 0 或保持未定义，以获得最大安全性。

configPROTECTED_KERNEL_OBJECT_POOL_SIZE

configPROTECTED_KERNEL_OBJECT_POOL_SIZE 适用于 FreeRTOS V10.6.0 及之后版本中支持内存保护单元 (MPU) 的移植，前提是使用了新的 MPU 包装器（即 configUSE_MPU_WRAPPERS_V1 设置为 0 或未定义）。

将 configPROTECTED_KERNEL_OBJECT_POOL_SIZE 设置为应用程序中内核对象（包括任务、队列、信号量、互斥锁、事件组、定时器、流缓冲区和消息缓冲区）的总数。应用程序在任何时候都不能拥有超过 configPROTECTED_KERNEL_OBJECT_POOL_SIZE 个内核对象。

configSYSTEM_CALL_STACK_SIZE

configSYSTEM_CALL_STACK_SIZE 适用于 FreeRTOS V10.6.0 及之后版本中支持内存保护单元 (MPU) 的移植，前提是使用了新的 MPU包装器（即 configUSE_MPU_WRAPPERS_V1 设置为 0 或未定义）。

将 configSYSTEM_CALL_STACK_SIZE 设置为系统调用堆栈的大小（单位：字）。每个任务都有一个静态分配的内存缓冲区，大小为 configSYSTEM_CALL_STACK_SIZE，用作执行系统调用的堆栈。例如，如果 configSYSTEM_CALL_STACK_SIZE 定义为 128，并且应用程序中有 10 个任务，则用于系统调用堆栈的总内存量为 128 * 10 = 1280 字。

configENABLE_ACCESS_CONTROL_LIST

在使用 MPU 包装器 v2 时，应用程序编写者可以在其 FreeRTOSConfig.h 中将 configENABLE_ACCESS_CONTROL_LIST 设置为 1，以启用访问控制列表（ACL）功能。当启用 ACL 时，默认情况下，非特权任务除自身外无法访问任何内核对象。应用程序编写者需要使用为此目的提供的 API 显式授予非特权任务访问所需的内核对象的权限。

configHEAP_CLEAR_MEMORY_ON_FREE

如果设置为 1 ，则使用 pvPortMalloc()分配的内存块将在通过 vPortFree() 释放时清除。如果不定义， configHEAP_CLEAR_MEMORY_ON_FREE 默认为 0，以便向后兼容性。为了提高安全性，我们建议将 configHEAP_CLEAR_MEMORY_ON_FREE 设置为 1。

configUSE_APPLICATION_TASK_TAG

将 configUSE_APPLICATION_TASK_TAG 设置为 1 将在构建中包含任务标记功能及其相关 API。可为每个任务分配“标签”值。RTOS 内核本身不以任何方式使用它。文件页面 RTOS 追踪宏文档页面提供了一个很好的示例，介绍了应用程序如何使用此功能。

configSTATS_BUFFER_MAX_LENGTH

vTaskList 和 vTaskGetRunTimeStats API 将缓冲区作为参数，并假设缓冲区的长度为 configSTATS_BUFFER_MAX_LENGTH。默认情况下，它设置为 0xFFFF，以确保现有的应用程序不会出现问题。如果默认值不适合应用程序，应用程序编写者可以在其 FreeRTOSConfig.h 中将其设置为不同的值。建议新应用程序使用 vTaskListTasks 和 vTaskGetRunTimeStatistics API，并显式提供缓冲区的长度，以避免内存损坏。

secureconfigMAX_SECURE_CONTEXTS

从 ARMv8-M MCU（ARM Cortex-M23、Cortex-M33 和 Cortex-M55 ）的非安全端调用安全函数的任务有两个上下文：一个在非安全端，一个在安全端。在 FreeRTOS v10.4.5 之前，ARMv8-M 安全端移植在运行时分配引用安全端上下文的结构体。 FreeRTOS v10.4.5 开始，结构体在编译时静态分配。 secureconfigMAX_SECURE_CONTEXTS 设置静态分配的安全上下文的数量。 secureconfigMAX_SECURE_CONTEXTS 如果未定义，则默认为 8。仅在 ARMv8-M 微控制器非安全端使用 FreeRTOS 代码的应用程序，例如在安全端运行第三方代码的应用程序，不需要此常量。

出色的 RTOS & 嵌入式软件 下载 FreeRTOS 菜单

定制 [配置]

'config' 参数

configSYS滴答_CLOCK_HZ

出色的 RTOS & 嵌入式软件

下载 FreeRTOS
菜单

定制
[配置]