文件简介
FreeRTOS是使用一个名为FreeRTOSConfig.h的配置文件定制的。每个 FreeRTOS 应用程序在其预处理器包含路径中都必须有一个 FreeRTOSConfig.h 头文件。FreeRTOSConfig.h 为正在构建的应用程序定制 RTOS 内核。因此,它特定于应用程序,而不是RTOS,并且应该位于应用程序目录中,而不是位于RTOS内核源代码目录之一中。------FreeRTOS官网
FreeRTOS的功能是可以配置和裁剪的,可以通过FreeConfig.h文件使能配置我们需要的功能(配置内存大小,可选择功能块等)
“INCLUDE_”开始的宏
使用“INCLUDE_”开始的宏可以使能或者除能FreeRTOS中的API函数,宏定义1为使能,0为除能。
#define INCLUDE_vTaskPrioritySet 1
代码上方中的vTaskPrioritySet函数在tasks.c中的可以找到如下源码
#if ( INCLUDE_vTaskPrioritySet == 1 )
void vTaskPrioritySet( TaskHandle_t xTask, UBaseType_t uxNewPriority ){...}//具体内容省略
#endif /* INCLUDE_vTaskPrioritySet */
通过源码可以发现该类函数为条件编译函数,所以可以通过宏定义的方式决定其是否编译,FreeRTOS 中的裁剪和配置就是这种用条件编译的方法来实现的。
这样条件编译的好处就是节省空间,不需要的功能就不用编译,这样就可以根据实际需求来减少系统占用的 ROM 和 RAM 大小,根据自己所使用的 MCU 来调整系统消耗。
下面列举“INCLUDE_”的宏以及他们的功能
#define INCLUDE_vTaskPrioritySet //设置任务优先级
#define INCLUDE_uxTaskPriorityGet //获取任务优先级
#define INCLUDE_vTaskDelete // 任务删除
#define INCLUDE_vTaskSuspend // 任务的挂起和恢复
#define INCLUDE_xTaskResumeFromISR // 任务从中断中恢复
#define INCLUDE_vTaskDelayUntil // 任务绝对延时
#define INCLUDE_vTaskDelay // 任务相对延时
#define INCLUDE_xTaskGetSchedulerState// 获取调度器的状态
#define INCLUDE_xTaskGetCurrentTaskHandle // 获取当前正在运行的任务的任务句柄
#define INCLUDE_uxTaskGetStackHighWaterMark// 获取任务的堆栈的历史剩余最小值,FreeRTOS中叫做“高水位线”
#define INCLUDE_xTaskGetIdleTaskHandle// 获取空闲任务的任务句柄
#define INCLUDE_eTaskGetState // 获取任务的状态
#define INCLUDE_xEventGroupSetBitFromISR // 事件标志
#define INCLUDE_xTimerPendFunctionCall // 将函数的执行挂起到 RTOS 守护程序任务
#define INCLUDE_xTaskAbortDelay // 使任务强制任务离开“ 已阻止”状态,然后进入“就绪”状态
#define INCLUDE_xTaskGetHandle //根据任务名字查找该任务的句柄
#define INCLUDE_xTaskResumeFromISR //恢复可从ISR内部调用的挂起任务的
以上几种INCLUDE_为官网例程中出现的INCLUDE_类宏函数
“config”开始的宏
“config”开始的宏和“INCLUDE_”开始的宏类似,都是用来完成 FreeRTOS 的配置和裁剪的。
#define configUSE_PREEMPTION 1
同样的如“INCLUDE_”宏定义为1为使能,宏定义为0为除能。
下面列举“config”的宏以及他们的功能
/***************************************************************************************************************/
/* FreeRTOS基础配置配置选项 */
/***************************************************************************************************************/
#define configUSE_PREEMPTION 1 //1使用抢占式内核,0使用协程
#define configUSE_TIME_SLICING 1 //1使能时间片调度(默认式使能的)
#define configUSE_PORT_OPTIMISED_TASK_SELECTION 1 //1启用特殊方法来选择下一个要运行的任务
//一般是硬件计算前导零指令,如果所使用的
//MCU没有这些硬件指令的话此宏应该设置为0!
#define configUSE_TICKLESS_IDLE 0 //1启用低功耗tickless模式
#define configUSE_QUEUE_SETS 1 //为1时启用队列
#define configCPU_CLOCK_HZ (SystemCoreClock) //CPU频率
#define configTICK_RATE_HZ (1000) //时钟节拍频率,这里设置为1000,周期就是1ms
#define configMAX_PRIORITIES (32) //可使用的最大优先级
#define configMINIMAL_STACK_SIZE ((unsigned short)130) //空闲任务使用的堆栈大小
#define configMAX_TASK_NAME_LEN (16) //任务名字字符串长度
#define configUSE_16_BIT_TICKS 0 //系统节拍计数器变量数据类型,
//1表示为16位无符号整形,0表示为32位无符号整形
#define configIDLE_SHOULD_YIELD 1 //为1时空闲任务放弃CPU使用权给其他同优先级的用户任务
#define configUSE_TASK_NOTIFICATIONS 1 //为1时开启任务通知功能,默认开启
#define configUSE_MUTEXES 1 //为1时使用互斥信号量
#define configQUEUE_REGISTRY_SIZE 8 //不为0时表示启用队列记录,具体的值是可以
//记录的队列和信号量最大数目。
#define configCHECK_FOR_STACK_OVERFLOW 0 //大于0时启用堆栈溢出检测功能,如果使用此功能
//用户必须提供一个栈溢出钩子函数,如果使用的话
//此值可以为1或者2,因为有两种栈溢出检测方法。
#define configUSE_RECURSIVE_MUTEXES 1 //为1时使用递归互斥信号量
#define configUSE_MALLOC_FAILED_HOOK 0 //1使用内存申请失败钩子函数
#define configUSE_APPLICATION_TASK_TAG 0
#define configUSE_COUNTING_SEMAPHORES 1 //为1时使用计数信号量
/***************************************************************************************************************/
/* FreeRTOS与内存申请有关配置选项 */
/***************************************************************************************************************/
#define configSUPPORT_DYNAMIC_ALLOCATION 1 //支持动态内存申请
#define configTOTAL_HEAP_SIZE ((size_t)(20*1024)) //系统所有总的堆大小
/***************************************************************************************************************/
/* FreeRTOS与钩子函数有关的配置选项 */
/***************************************************************************************************************/
#define configUSE_IDLE_HOOK 0 //1,使用空闲钩子;0,不使用
#define configUSE_TICK_HOOK 0 //1,使用时间片钩子;0,不使用
/***************************************************************************************************************/
/* FreeRTOS与运行时间和任务状态收集有关的配置选项 */
/***************************************************************************************************************/
#define configGENERATE_RUN_TIME_STATS 0 //为1时启用运行时间统计功能
#define configUSE_TRACE_FACILITY 1 //为1启用可视化跟踪调试
#define configUSE_STATS_FORMATTING_FUNCTIONS 1 //与宏configUSE_TRACE_FACILITY同时为1时会编译下面3个函数
//prvWriteNameToBuffer(),vTaskList(),
//vTaskGetRunTimeStats()
/***************************************************************************************************************/
/* FreeRTOS与协程有关的配置选项 */
/***************************************************************************************************************/
#define configUSE_CO_ROUTINES 0 //为1时启用协程,启用协程以后必须添加文件croutine.c
#define configMAX_CO_ROUTINE_PRIORITIES ( 2 ) //协程的有效优先级数目
/***************************************************************************************************************/
/* FreeRTOS与软件定时器有关的配置选项 */
/***************************************************************************************************************/
#define configUSE_TIMERS 1 //为1时启用软件定时器
#define configTIMER_TASK_PRIORITY (configMAX_PRIORITIES-1) //软件定时器优先级
#define configTIMER_QUEUE_LENGTH 5 //软件定时器队列长度
#define configTIMER_TASK_STACK_DEPTH (configMINIMAL_STACK_SIZE*2) //软件定时器任务堆栈大小
/***************************************************************************************************************/
/* FreeRTOS与中断有关的配置选项 */
/***************************************************************************************************************/
#ifdef __NVIC_PRIO_BITS
#define configPRIO_BITS __NVIC_PRIO_BITS
#else
#define configPRIO_BITS 4
#endif
#define configLIBRARY_LOWEST_INTERRUPT_PRIORITY 15 //中断最低优先级
#define configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY 5 //系统可管理的最高中断优先级
#define configKERNEL_INTERRUPT_PRIORITY ( configLIBRARY_LOWEST_INTERRUPT_PRIORITY << (8 - configPRIO_BITS) )
#define configMAX_SYSCALL_INTERRUPT_PRIORITY ( configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY << (8 - configPRIO_BITS) )