11-FreeRTOS配置函数 FreeRTOSConfig.h（上）-阿里云开发者社区

1-FreeRTOSConfig.h介绍

FreeRTOS中的相关定义多数都在FreeRTOSConfig.h中，整个FreeRTOS的定义调用都可以在这里定义，当然你也可以自己命名一个文件实现自定义。

下面是这个文件的内容，如下：

1#ifndef FREERTOS_CONFIG_H
  2#define FREERTOS_CONFIG_H
  3
  4/* Here is a good place to include header files that are required across
  5your application. */
  6#include "something.h"
  7
  8#define configUSE_PREEMPTION 1
  9#define configUSE_PORT_OPTIMISED_TASK_SELECTION 0
 10#define configUSE_TICKLESS_IDLE 0
 11#define configCPU_CLOCK_HZ 60000000
 12#define configSYSTICK_CLOCK_HZ 1000000
 13#define configTICK_RATE_HZ 250
 14#define configMAX_PRIORITIES 5
 15#define configMINIMAL_STACK_SIZE 128
 16#define configMAX_TASK_NAME_LEN 16
 17#define configUSE_16_BIT_TICKS 0
 18#define configIDLE_SHOULD_YIELD 1
 19#define configUSE_TASK_NOTIFICATIONS 1
 20#define configTASK_NOTIFICATION_ARRAY_ENTRIES 3
 21#define configUSE_MUTEXES 0
 22#define configUSE_RECURSIVE_MUTEXES 0
 23#define configUSE_COUNTING_SEMAPHORES 0
 24#define configUSE_ALTERNATIVE_API 0 /* Deprecated! */
 25#define configQUEUE_REGISTRY_SIZE 10
 26#define configUSE_QUEUE_SETS 0
 27#define configUSE_TIME_SLICING 0
 28#define configUSE_NEWLIB_REENTRANT 0
 29#define configENABLE_BACKWARD_COMPATIBILITY 0
 30#define configNUM_THREAD_LOCAL_STORAGE_POINTERS 5
 31#define configUSE_MINI_LIST_ITEM 1
 32#define configSTACK_DEPTH_TYPE uint16_t
 33#define configMESSAGE_BUFFER_LENGTH_TYPE size_t
 34#define configHEAP_CLEAR_MEMORY_ON_FREE 1
 35
 36/* Memory allocation related definitions. */
 37#define configSUPPORT_STATIC_ALLOCATION 1
 38#define configSUPPORT_DYNAMIC_ALLOCATION 1
 39#define configTOTAL_HEAP_SIZE 10240
 40#define configAPPLICATION_ALLOCATED_HEAP 1
 41#define configSTACK_ALLOCATION_FROM_SEPARATE_HEAP 1
 42
 43/* Hook function related definitions. */
 44#define configUSE_IDLE_HOOK 0
 45#define configUSE_TICK_HOOK 0
 46#define configCHECK_FOR_STACK_OVERFLOW 0
 47#define configUSE_MALLOC_FAILED_HOOK 0
 48#define configUSE_DAEMON_TASK_STARTUP_HOOK 0
 49#define configUSE_SB_COMPLETED_CALLBACK 0
 50
 51/* Run time and task stats gathering related definitions. */
 52#define configGENERATE_RUN_TIME_STATS 0
 53#define configUSE_TRACE_FACILITY 0
 54#define configUSE_STATS_FORMATTING_FUNCTIONS 0
 55
 56/* Co-routine related definitions. */
 57#define configUSE_CO_ROUTINES 0
 58#define configMAX_CO_ROUTINE_PRIORITIES 1
 59
 60/* Software timer related definitions. */
 61#define configUSE_TIMERS 1
 62#define configTIMER_TASK_PRIORITY 3
 63#define configTIMER_QUEUE_LENGTH 10
 64#define configTIMER_TASK_STACK_DEPTH configMINIMAL_STACK_SIZE
 65
 66/* Interrupt nesting behaviour configuration. */
 67#define configKERNEL_INTERRUPT_PRIORITY [dependent of processor]
 68#define configMAX_SYSCALL_INTERRUPT_PRIORITY [dependent on processor and application]
 69#define configMAX_API_CALL_INTERRUPT_PRIORITY [dependent on processor and application]
 70
 71/* Define to trap errors during development. */
 72#define configASSERT( ( x ) ) if( ( x ) == 0 ) vAssertCalled( __FILE__, __LINE__ )
 73
 74/* FreeRTOS MPU specific definitions. */
 75#define configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS 0
 76#define configTOTAL_MPU_REGIONS 8 /* Default value. */
 77#define configTEX_S_C_B_FLASH 0x07UL /* Default value. */
 78#define configTEX_S_C_B_SRAM 0x07UL /* Default value. */
 79#define configENFORCE_SYSTEM_CALLS_FROM_KERNEL_ONLY 1
 80#define configALLOW_UNPRIVILEGED_CRITICAL_SECTIONS 1
 81#define configENABLE_ERRATA_837070_WORKAROUND 1
 82
 83/* ARMv8-M secure side port related definitions. */
 84#define secureconfigMAX_SECURE_CONTEXTS 5
 85
 86/* Optional functions - most linkers will remove unused functions anyway. */
 87#define INCLUDE_vTaskPrioritySet 1
 88#define INCLUDE_uxTaskPriorityGet 1
 89#define INCLUDE_vTaskDelete 1
 90#define INCLUDE_vTaskSuspend 1
 91#define INCLUDE_xResumeFromISR 1
 92#define INCLUDE_vTaskDelayUntil 1
 93#define INCLUDE_vTaskDelay 1
 94#define INCLUDE_xTaskGetSchedulerState 1
 95#define INCLUDE_xTaskGetCurrentTaskHandle 1
 96#define INCLUDE_uxTaskGetStackHighWaterMark 0
 97#define INCLUDE_uxTaskGetStackHighWaterMark2 0
 98#define INCLUDE_xTaskGetIdleTaskHandle 0
 99#define INCLUDE_eTaskGetState 0
100#define INCLUDE_xEventGroupSetBitFromISR 1
101#define INCLUDE_xTimerPendFunctionCall 0
102#define INCLUDE_xTaskAbortDelay 0
103#define INCLUDE_xTaskGetHandle 0
104#define INCLUDE_xTaskResumeFromISR 1
105
106/* A header file that defines trace macro can be included here. */
107
108#endif /* FREERTOS_CONFIG_H */

下面我们就来对上面的定义进行一些简单的说明。

2- 定义说明

2.1 configUSE_PREEMPTION

这个表示是否启用调度函数，1表示使用抢占式RTOS调度程序，0是表示使用协程RTOS调度程序

2.2 configUSE_PORT_OPTIMISED_TASK_SELECTION

FreeRTOS端口有两种方法来选择要执行的下一个任务——通用方法和特定于该端口的方法。

如下：

1-通用方式

当configUSE_PORT_OPTIMISED_TASK_SELECTION为0时使用，或者未实现特定于端口的方法时使用。
可以与所有FreeRTOS端口一起使用。
完全是用C编写的，使其效率低于特定于端口方法

没有优先级最大数量的限制

2-特定方式

不是所有的端口都可用
configUSE_PORT_OPTIMISED_TASK_SELECTION设置为1时使用。
依赖于一个或多个特定于体系结构的汇编指令(通常是前导零计数[CLZ]或等效指令)，因此只能用于专门为其编写的体系结构。
比通用方式更有效
通常对可用优先级的最大数量限制在32。

2.3 configUSE_TICKLESS_IDLE

如果configUSE_TICKLESS_IDLE设置为1，将启用无时钟低功耗模式，设置为0则是始终保持时钟周期中断运行。但是低功耗无时钟不是所有的RTOS端口都提供的。

2.4 configUSE_IDLE_HOOK

设置1表示启动钩子函数，0表示不使用

当RTOS调度器开始工作后，为了保证至少有一个任务在运行，空闲任务被自动创建，占用最低优先级（0优先级）。对于已经删除的RTOS任务，空闲任务可以释放分配给它们的堆栈内存。因此，在应用中应该注意，使用vTaskDelete()函数时要确保空闲任务获得一定的处理器时间。除此之外，空闲任务没有其它特殊功能，因此可以任意的剥夺空闲任务的处理器时间。

应用程序也可能和空闲任务共享同个优先级。

空闲任务钩子是一个函数，这个函数由用户来实现，RTOS规定了函数的名字和参数，这个函数在每个空闲任务周期都会被调用。

2.5 configUSE_MALLOC_FAILED_HOOK

每次创建任务、队列或信号量时，内核都会调用pvPortMalloc()从堆中分配内存。官方的FreeRTOS为此提供了四个示例内存分配方案。这些方案分别在heap_1.c、heap_2.c、heap_3.c、heap_4.c和heap_5.c源文件中实现。configUSE_MALLOC_FAILED_HOOK仅在使用这三个示例方案之一时才有意义。

如果定义并正确配置malloc()失败钩子函数，则这个函数会在pvPortMalloc()函数返回NULL时被调用。只有FreeRTOS在响应内存分配请求时发现堆内存不足才会返回NULL。

如果宏configUSE_MALLOC_FAILED_HOOK设置为1，那么必须定义一个malloc()失败钩子函数，如果宏configUSE_MALLOC_FAILED_HOOK设置为0，malloc()失败钩子函数不会被调用，即便已经定义了这个函数。malloc()失败钩子函数的函数名和原型必须如下所示：

1void vApplicationMallocFailedHook( void );

2.6 configUSE_DAEMON_TASK_STARTUP_HOOK

如果configUSE_TIMERS和configUSE_DAEMON_TASK_STARTUP_HOOK都被设置为1，那么应用程序必须定义一个具有确切名称和原型的钩子函数，如下所示。

void void vApplicationDaemonTaskStartupHook( void );

当RTOS守护任务(也称为定时器服务任务)第一次执行时，钩子函数将被精确地调用一次。任何需要运行RTOS的应用程序初始化代码都可以放在钩子函数中。

2.7 configUSE_SB_COMPLETED_CALLBACK

在构建中设置configUSE_SB_COMPLETED_CALLBACK()、xStreamBufferCreateWithCallback()和xStreamBufferCreateStaticWithCallback()(以及它们的消息缓冲区)。使用这些函数创建的流和消息缓冲区可以有自己独特的发送完整和接收完整回调，而使用xStreamBufferCreate()和xStreamBufferCreateStatic()(以及它们的消息缓冲区等效物)创建的流和消息缓冲区都共享由sbSEND_COMPLETED()和sbRECEVE_COMPLETED()宏定义的回调。configUSE_SB_COMPLETED_CALLBACK默认为0，以便向后兼容。

2.8 configUSE_TICK_HOOK

为1使用时间片钩子（Tick Hook），0不适用时间片钩子。

注：时间片钩子函数（Tick Hook Function）

时间片中断可以周期性的调用一个被称为钩子函数（回调函数）的应用程序。时间片钩子函数可以很方便的实现一个定时器功能。

只有在FreeRTOSConfig.h中的configUSE_TICK_HOOK设置成1时才可以使用时间片钩子。一旦此值设置成1，就要定义钩子函数，函数名和参数如下所示：

void vApplicationTickHook( void );

vApplicationTickHook()函数在中断服务程序中执行，因此这个函数必须非常短小，不能大量使用堆栈，只能调用以”FromISR" 或 "FROM_ISR”结尾的API函数。

在FreeRTOSVx.x.x\FreeRTOS\Demo\Common\Minimal文件夹下的crhook.c文件中有使用时间片钩子函数的例程。

2.9 configCPU_CLOCK_HZ

输入驱动用于生成tick中断的外围设备的内部时钟将执行的频率(Hz)——这通常与驱动内部CPU时钟的时钟相同。要想准确的配置系统节拍这个是必须要设置的。

2.10 configSYSTICK_CLOCK_HZ

仅用于ARM Cortex-M端口。

默认情况下，ARM Cortex-M端口从Cortex-M SysTick定时器生成RTOS tick中断。大多数Cortex-M MCU以与MCU本身相同的频率运行SysTick定时器——在这种情况下，configSYSTICK_CLOCK_HZ不需要定义。如果SysTick定时器的时钟频率与MCU核心不同，则将configCPU_CLOCK_HZ设置为MCU时钟频率，正常情况下，将configSYSTICK_CLOCK_HZ设置为SysTick时钟频率。

2.11 configTICK_RATE_HZ

实时操作系统时钟周期中断的频率。

系统节拍中断用来测量时间，因此，越高的测量频率意味着可测到越高的分辨率时间。但是，高的系统节拍中断频率也意味着RTOS内核占用更多的CPU时间，因此会降低效率。RTOS演示例程都是使用系统节拍中断频率为1000HZ，这是为了测试RTOS内核，比实际使用的要高。（实际使用时不用这么高的系统节拍中断频率）

多个任务可以共享一个优先级，RTOS调度器为相同优先级的任务分享CPU时间，在每一个RTOS 系统节拍中断到来时进行任务切换。高的系统节拍中断频率会降低分配给每一个任务的“时间片”持续时间。

2.12 configMAX_PRIORITIES

配置应用程序有效的优先级数目。任何数量的任务都可以共享一个优先级，使用协程可以单独的给与它们优先权。见configMAX_CO_ROUTINE_PRIORITIES。

每一个任务都会被分配一个优先级，优先级值从0~ （configMAX_PRIORITIES - 1）之间。低优先级数表示低优先级任务。空闲任务的优先级为0（tskIDLE_PRIORITY），因此它是最低优先级任务。

FreeRTOS调度器将确保处于就绪状态（Ready）或运行状态（Running）的高优先级任务比同样处于就绪状态的低优先级任务优先获取处理器时间。换句话说，处于运行状态的任务永远是高优先级任务。

处于就绪状态的相同优先级任务使用时间片调度机制共享处理器时间。

2.13 configMINIMAL_STACK_SIZE

定义空闲任务使用的堆栈大小。通常此值不应小于对应处理器演示例程文件FreeRTOSConfig.h中定义的数值。

就像xTaskCreate()函数的堆栈大小参数一样，堆栈大小不是以字节为单位而是以字为单位的，比如在32位架构下，栈大小为100表示栈内存占用400字节的空间(每32位消耗4个字节，一个字节等于8位)。

2.14 configMAX_TASK_NAME_LEN

调用任务函数时，需要设置描述任务信息的字符串，这个宏用来定义该字符串的最大长度。这里定义的长度包括字符串结束符’\0’。

2.15 configUSE_TRACE_FACILITY

设置成1表示启动可视化跟踪调试，会激活一些附加的结构体成员和函数。

2.16 configUSE_STATS_FORMATTING_FUNCTIONS

设置宏configUSE_TRACE_FACILITY和configUSE_STATS_FORMATTING_FUNCTIONS为1会编译vTaskList()和vTaskGetRunTimeStats()函数。如果将这两个宏任意一个设置为0，上述两个函数不会被编译。

2.17 configUSE_16_BIT_TICKS

定义系统节拍计数器的变量类型，即定义TickType_t是表示16位变量还是32位变量。

定义configUSE_16_BIT_TICKS为1意味着TickType_t被定义为16位无符号整形，定义configUSE_16_BIT_TICKS为0意味着TickType_t被定义为32位无符号整形。

使用16位类型可以大大提高8位和16位架构微处理器的性能，但这也限制了最大时钟计数为65535个’Tick’。因此，如果Tick频率为250HZ（4MS中断一次），对于任务最大延时或阻塞时间，16位计数器是262秒，而32位是17179869秒。

2.18 configIDLE_SHOULD_YIELD

这个参数控制任务在空闲优先级中的行为。仅在满足下列条件后，才会起作用。

使用抢占式内核调度
用户任务使用空闲优先级。
通过时间片共享同一个优先级的多个任务，如果共享的优先级大于空闲优先级，并假设没有更高优先级任务，这些任务应该获得相同的处理器时间。
但如果共享空闲优先级时，情况会稍微有些不同。当configIDLE_SHOULD_YIELD为1时，其它共享空闲优先级的用户任务就绪时，空闲任务立刻让出CPU，用户任务运行，这样确保了能最快响应用户任务。处于这种模式下也会有不良效果（取决于你的程序需要），如下所示：

图中描述了四个处于空闲优先级的任务，任务A、B和C是用户任务，任务I是空闲任务。上下文切换周期性的发生在T0、T1…T6时刻。当用户任务运行时，空闲任务立刻让出CPU，但是，空闲任务已经消耗了当前时间片中的一定时间。这样的结果就是空闲任务I和用户任务A共享一个时间片。用户任务B和用户任务C因此获得了比用户任务A更多的处理器时间。
这种情况可以通过以下方式避免：
1-创建的用户优先级大于空闲任务的优先级。
2-如果可以的话，使用空闲钩子函数将处于空闲优先级的各独立任务进行代替。
3-configIDLE_SHOULD_YIELD设置为0。
设置configIDLE_SHOULD_YIELD为0将阻止空闲任务为用户任务让出CPU，直到空闲任务的时间片结束。这确保所有处在空闲优先级的任务分配到相同多的处理器时间，但是，这是以分配给空闲任务更高比例的处理器时间为代价的。

2.19 configUSE_TASK_NOTIFICATIONS

设置宏configUSE_TASK_NOTIFICATIONS为1（或不定义宏configUSE_TASK_NOTIFICATIONS）将会开启任务通知功能，有关的API函数也会被编译。设置宏configUSE_TASK_NOTIFICATIONS为0则关闭任务通知功能，相关API函数也不会被编译。默认这个功能是开启的。开启后，每个任务多增加8字节RAM。

每个RTOS任务具有一个32位的通知值，RTOS任务通知相当于直接向任务发送一个事件，接收到通知的任务可以解除任务的阻塞状态（因等待任务通知而进入阻塞状态）。相对于以前必须分别创建队列、二进制信号量、计数信号量或事件组的情况，使用任务通知显然更灵活。更好的是，相比于使用信号量解除任务阻塞，使用任务通知可以快45%（使用GCC编译器，-o2优化级别）。

2.20 configTASK_NOTIFICATION_ARRAY_ENTRIES

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

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

2.21 configUSE_MUTEXES

设置为1表示使用互斥量，设置成0表示忽略互斥量。读者应该了解在FreeRTOS中互斥量和二进制信号量的区别。

关于互斥量和二进制信号量简单说：

互斥型信号量必须是同一个任务申请，同一个任务释放，其他任务释放无效。

二进制信号量，一个任务申请成功后，可以由另一个任务释放。

互斥型信号量是二进制信号量的子集

2.22 configUSE_RECURSIVE_MUTEXES

设置成1表示使用递归互斥量，设置成0表示不使用。

2.23 configUSE_COUNTING_SEMAPHORES

设置成1表示使用计数信号量，设置成0表示不使用。

2.24 configUSE_ALTERNATIVE_API

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

需要注意：可代替的API已弃用，不应在新设计中使用

2.25 configCHECK_FOR_STACK_OVERFLOW

每个任务维护自己的栈空间，任务创建时会自动分配任务需要的占内存，分配内存大小由创建任务函数（xTaskCreate()）的一个参数指定。堆栈溢出是设备运行不稳定的最常见原因，因此FreeeRTOS提供了两个可选机制用来辅助检测和改正堆栈溢出。配置宏configCHECK_FOR_STACK_OVERFLOW为不同的常量来使用不同堆栈溢出检测机制。

注意，这个选项仅适用于内存映射未分段的微处理器架构。并且，在RTOS检测到堆栈溢出发生之前，一些处理器可能先产生故障（fault）或异常（exception）来反映堆栈使用的恶化。如果宏configCHECK_FOR_STACK_OVERFLOW没有设置成0，用户必须提供一个栈溢出钩子函数，这个钩子函数的函数名和参数必须如下所示：

void vApplicationStackOverflowHook(TaskHandle_t xTask, signed char *pcTaskName );

具体的前面已经介绍过这两种方法请查看：堆栈溢出保护

2.26 configQUEUE_REGISTRY_SIZE

队列记录有两个目的，都涉及到RTOS内核的调试：

它允许在调试GUI中使用一个队列的文本名称来简单识别队列；
包含调试器需要的每一个记录队列和信号量定位信息；
除了进行内核调试外，队列记录没有其它任何目的。
configQUEUE_REGISTRY_SIZE定义可以记录的队列和信号量的最大数目。如果你想使用RTOS内核调试器查看队列和信号量信息，则必须先将这些队列和信号量进行注册，只有注册后的队列和信号量才可以使用RTOS内核调试器查看。查看API参考手册中的vQueueAddToRegistry() 和vQueueUnregisterQueue()函数获取更多信息。

11-FreeRTOS配置函数 FreeRTOSConfig.h（上）

1-FreeRTOSConfig.h介绍

2- 定义说明

2.1 configUSE_PREEMPTION

2.2 configUSE_PORT_OPTIMISED_TASK_SELECTION

1-通用方式

2-特定方式

2.3 configUSE_TICKLESS_IDLE

2.4 configUSE_IDLE_HOOK

2.5 configUSE_MALLOC_FAILED_HOOK

2.6 configUSE_DAEMON_TASK_STARTUP_HOOK

2.7 configUSE_SB_COMPLETED_CALLBACK

2.8 configUSE_TICK_HOOK

2.9 configCPU_CLOCK_HZ

2.10 configSYSTICK_CLOCK_HZ

2.11 configTICK_RATE_HZ

2.12 configMAX_PRIORITIES

2.13 configMINIMAL_STACK_SIZE

2.14 configMAX_TASK_NAME_LEN

2.15 configUSE_TRACE_FACILITY

2.16 configUSE_STATS_FORMATTING_FUNCTIONS

2.17 configUSE_16_BIT_TICKS

2.18 configIDLE_SHOULD_YIELD

2.19 configUSE_TASK_NOTIFICATIONS

2.20 configTASK_NOTIFICATION_ARRAY_ENTRIES

2.21 configUSE_MUTEXES

2.22 configUSE_RECURSIVE_MUTEXES

2.23 configUSE_COUNTING_SEMAPHORES

2.24 configUSE_ALTERNATIVE_API

2.25 configCHECK_FOR_STACK_OVERFLOW

2.26 configQUEUE_REGISTRY_SIZE

热门文章

最新文章

相关电子书

热门

活动广场

任务中心

开发者评测

高校计划

乘风者计划

训练营

阿里云MVP

话题

直播

下载

镜像站

技术资料

插件

11-FreeRTOS配置函数 FreeRTOSConfig.h（上）

1-FreeRTOSConfig.h介绍

2- 定义说明

2.1 configUSE_PREEMPTION

2.2 configUSE_PORT_OPTIMISED_TASK_SELECTION

1-通用方式

2-特定方式

2.3 configUSE_TICKLESS_IDLE

2.4 configUSE_IDLE_HOOK

2.5 configUSE_MALLOC_FAILED_HOOK

2.6 configUSE_DAEMON_TASK_STARTUP_HOOK

2.7 configUSE_SB_COMPLETED_CALLBACK

2.8 configUSE_TICK_HOOK

2.9 configCPU_CLOCK_HZ

2.10 configSYSTICK_CLOCK_HZ

2.11 configTICK_RATE_HZ

2.12 configMAX_PRIORITIES

2.13 configMINIMAL_STACK_SIZE

2.14 configMAX_TASK_NAME_LEN

2.15 configUSE_TRACE_FACILITY

2.16 configUSE_STATS_FORMATTING_FUNCTIONS

2.17 configUSE_16_BIT_TICKS

2.18 configIDLE_SHOULD_YIELD

2.19 configUSE_TASK_NOTIFICATIONS

2.20 configTASK_NOTIFICATION_ARRAY_ENTRIES

2.21 configUSE_MUTEXES

2.22 configUSE_RECURSIVE_MUTEXES

2.23 configUSE_COUNTING_SEMAPHORES

2.24 configUSE_ALTERNATIVE_API

2.25 configCHECK_FOR_STACK_OVERFLOW

2.26 configQUEUE_REGISTRY_SIZE

热门文章

最新文章

相关电子书