FreeRTOSConfig.h 文件

　　FreeRTOS 的配置基本是通过在 FreeRTOSConfig.h 中使用“#define” 这样的语句来定义宏定义实现的。 在 FreeRTOS 的官方 demo 中，每个工程都有一个 FreeRTOSConfig.h 文件，我们在使用的时候可以参考这个文件，甚至直接复制粘贴使用。
1、“INCLUDE_”开始的宏
　　使用“INCLUDE_”开头的宏用来表示使能或除能 FreeRTOS 中相应的 API 函数， 作用就是用来配置 FreeRTOS 中的可选 API 函数的。比如当宏 INCLUDE_vTaskPrioritySet 设置为 0 的时候 表示不能 使用函数 vTaskPrioritySet() ， 当设置 为 1 的时 候就表示可 以使用函 数vTaskPrioritySet()。这个功能其实就是条件编译，在文件 tasks.c 中有如下图所示的代码。

　　从上 图 可 以 看 出 当 满 足 条 件 ： NCLUDE_vTaskPrioritySet == 1 的 时 候 ， 函 数vTaskPrioritySet()才会被编译， 注意，这里为了缩小篇幅将函数 vTaskPrioritySet()的内容进行了折叠。FreeRTOS 中的裁剪和配置就是这种用条件编译的方法来实现的，不止 FreeRTOS这么干，很多的协议栈、 RTOS 系统和 GUI 库等都是使用条件编译的方法来完成配置和裁剪的。 条件编译的好处就是节省空间，不需要的功能就不用编译，这样就可以根据实际需求来减少系统占用的 ROM 和 RAM 大小，根据自己所使用的 MCU 来调整系统消耗，降低成本。下面来看看“INCLUDE_”开始的都有哪些宏，它们的功能都是什么。

2、 “config”开始的宏
　　“config”开始的宏和“INCLUDE_”开始的宏一样，都是用来完成 FreeRTOS 的配置和裁剪的。

 

/*
    FreeRTOS V9.0.0 - Copyright (C) 2016 Real Time Engineers Ltd.
    All rights reserved

    VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.

    This file is part of the FreeRTOS distribution.

    FreeRTOS is free software; you can redistribute it and/or modify it under
    the terms of the GNU General Public License (version 2) as published by the
    Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.

    ***************************************************************************
    >>!   NOTE: The modification to the GPL is included to allow you to     !<<
    >>!   distribute a combined work that includes FreeRTOS without being   !<<
    >>!   obliged to provide the source code for proprietary components     !<<
    >>!   outside of the FreeRTOS kernel.                                   !<<
    ***************************************************************************

    FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    FOR A PARTICULAR PURPOSE.  Full license text is available on the following
    link: http://www.freertos.org/a00114.html

    ***************************************************************************
     *                                                                       *
     *    FreeRTOS provides completely free yet professionally developed,    *
     *    robust, strictly quality controlled, supported, and cross          *
     *    platform software that is more than just the market leader, it     *
     *    is the industry's de facto standard.                               *
     *                                                                       *
     *    Help yourself get started quickly while simultaneously helping     *
     *    to support the FreeRTOS project by purchasing a FreeRTOS           *
     *    tutorial book, reference manual, or both:                          *
     *    http://www.FreeRTOS.org/Documentation                              *
     *                                                                       *
    ***************************************************************************

    http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading
    the FAQ page "My application does not run, what could be wrong?".  Have you
    defined configASSERT()?

    http://www.FreeRTOS.org/support - In return for receiving this top quality
    embedded software for free we request you assist our global community by
    participating in the support forum.

    http://www.FreeRTOS.org/training - Investing in training allows your team to
    be as productive as possible as early as possible.  Now you can receive
    FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
    Ltd, and the world's leading authority on the world's leading RTOS.

    http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
    including FreeRTOS+Trace - an indispensable productivity tool, a DOS
    compatible FAT file system, and our tiny thread aware UDP/IP stack.

    http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
    Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.

    http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
    Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS
    licenses offer ticketed support, indemnification and commercial middleware.

    http://www.SafeRTOS.com - High Integrity Systems also provide a safety
    engineered and independently SIL3 certified version for use in safety and
    mission critical applications that require provable dependability.
*/

#ifndef __FREERTOS_CONFIG_H
#define __FREERTOS_CONFIG_H


#include "stm32f10x.h"
#include "hal_usb_1_driver.h"

//针对不同的编译器调用不同的stdint.h文件，在 MDK 中，我们默认的是__CC_ARM
#if defined(__ICCARM__) || defined(__CC_ARM) || defined(__GNUC__)
    #include <stdint.h>
    extern uint32_t SystemCoreClock;
#endif



//断言
#define vAssertCalled(char,int) DBG_PRINTF("Error:%s,%d\r\n",char,int)
#define configASSERT(x) if((x)==0) vAssertCalled(__FILE__,__LINE__)



/************************************************************************
                    FreeRTOS基础配置配置选项 
************************************************************************/

/** 
  * 注：在多任务管理机制上，操作系统可以分为抢占式和协作式两种。
  * 协作式调度器是任务执行完主动释放CPU后，再切换到下一个任务，任务切换的时机完全取决于正在运行的任务
  * 抢占式调度器是任务要么被高优先级的抢占，要么就是执行遇到阻塞式API来释放CPU使用权，让低优先级的任务执行
  */
#define configUSE_PREEMPTION            1  //0：RTOS使用协作式调度器（时间片） 1：RTOS使用抢占式调度器
#define configUSE_TIME_SLICING            1  //1：使能时间片调度(默认使能)      在使用抢占式调度器时当任务的优先级相同时会以时间片来切换任务



/**
  *如何找到最高优先级的就绪任务的TCB？
  *某些硬件运行FreeRTOS有两种方法选择下一个要执行的任务：通用方法和特定于硬件的方法（以下简称“特殊方法”）。
  *查找最高优先级的就绪任务
  * 
  * 通用方法：
  *      1.configUSE_PORT_OPTIMISED_TASK_SELECTION 为 0 或者硬件不支持这种特殊方法。
  *      2.可以用于所有FreeRTOS支持的硬件
  *      3.完全用C实现，效率略低于特殊方法。
  *      4.不强制要求限制最大可用优先级数目
  * 特殊方法：
  *      1.必须将configUSE_PORT_OPTIMISED_TASK_SELECTION设置为1。
  *      2.依赖一个或多个特定架构的汇编指令（一般是类似计算前导零[CLZ]指令）。
  *      3.比通用方法更高效
  *      4.一般强制限定最大可用优先级数目为32
  * 一般是硬件计算前导零指令，如果所使用的MCU没有这些硬件指令的话此宏应该设置为0！
  */
#define configUSE_PORT_OPTIMISED_TASK_SELECTION            1 //0：通用方法  1：特殊方法 (根据处理器优化的方法）      


/** 
  * 低功耗模式的使能，假设开启低功耗的话可能会导致下载出现问题，因为程序在睡眠中,可用以下办法解决
  * 
  * 下载方法：
  *      1.将开发版正常连接好
  *      2.按住复位按键，点击下载瞬间松开复位按键
  *     
  *      1.通过跳线帽将 BOOT 0 接高电平(3.3V)
  *      2.重新上电，下载
  *    
  *         1.使用FlyMcu擦除一下芯片，然后进行下载
  *        STMISP -> 清除芯片(z)
  */
#define configUSE_TICKLESS_IDLE                    1 //1：使能低功耗tickless模式   0：保持系统节拍（tick）中断一直运行


/**
  * 写入实际的CPU内核时钟频率，也就是CPU指令执行频率，通常称为Fclk
  * Fclk为供给CPU内核的时钟信号，我们所说的cpu主频为 XX MHz，
  * 就是指的这个时钟信号，相应的，1/Fclk即为cpu时钟周期；
  */
#define configCPU_CLOCK_HZ                        (SystemCoreClock)


#define configTICK_RATE_HZ                        (( TickType_t )1000)    //1000表示1ms中断1次，RTOS系统节拍中断的频率，即系统时钟周期。即一秒中断的次数，每次中断RTOS都会进行任务调度
#define configMAX_PRIORITIES                    (32)                    //可使用的最大优先级，最大支持 256 个优先级，使用特殊方法时最多支持32个优先级
#define configMINIMAL_STACK_SIZE                ((unsigned short)128)   //空闲任务使用的堆栈大小，以字为单位，128*4=512字节
#define configMAX_TASK_NAME_LEN                    (30)                    //任务名字字符串长度，包括'\0'

 
#define configUSE_16_BIT_TICKS                   0 //系统节拍计数器变量数据类型，1表示为16位无符号整形，0表示为32位无符号整形，STM32为32位          
#define configIDLE_SHOULD_YIELD                  1 //为1时空闲任务放弃CPU使用权给其他同优先级的用户任务 
#define configUSE_QUEUE_SETS                     1 //为1时启用消息队列
#define configUSE_TASK_NOTIFICATIONS             1 //为1时开启任务通知功能，默认开启
#define configUSE_MUTEXES                        1 //为1时使用互斥信号量                           
#define configUSE_RECURSIVE_MUTEXES              1 //为1时使用递归互斥信号量    
#define configUSE_COUNTING_SEMAPHORES            1 //为1时使用计数信号量


#define configQUEUE_REGISTRY_SIZE                10 //设置可以注册的信号量和消息队列个数
#define configUSE_APPLICATION_TASK_TAG             0  //设置可以注册的消息队列个数




/*****************************************************************
              FreeRTOS与内存申请有关配置选项                                               
*****************************************************************/
#define configSUPPORT_DYNAMIC_ALLOCATION        1                      //0：不支持动态内存申请    1：支持动态内存申请        
#define configSUPPORT_STATIC_ALLOCATION            0                       //0：不支持静态内存申请    1：支持静态内存申请                
#define configTOTAL_HEAP_SIZE                    ((size_t)(36*1024))    //系统所有堆的大小，即总共有多少堆


/***************************************************************
             FreeRTOS与钩子函数有关的配置选项                                            
**************************************************************/
/** 
  * 
  * 空闲任务钩子是一个函数，这个函数由用户来实现，
  * FreeRTOS规定了函数的名字和参数：void vApplicationIdleHook(void )，这个函数在每个空闲任务周期都会被调用。
  * 对于已经删除的RTOS任务，空闲任务可以释放分配给它们的堆栈内存。
  * 因此必须保证空闲任务可以被CPU执行
  * 使用空闲钩子函数设置CPU进入省电模式是很常见的
  * 会引起空闲任务阻塞的API函数不能调用
  */
#define configUSE_IDLE_HOOK                        0 //1：使用空闲钩子（Idle Hook类似于回调函数）   0：忽略空闲钩子

/** 
  * 时间片钩子是一个函数，这个函数由用户来实现，
  * FreeRTOS规定了函数的名字和参数：void vApplicationTickHook(void )
  * 时间片中断可以周期性的调用
  * 函数必须非常短小，不能大量使用堆栈，
  * 不能调用以”FromISR" 或 "FROM_ISR”结尾的API函数
  */
/*xTaskIncrementTick函数是在xPortSysTickHandler中断函数中被调用的。因此，vApplicationTickHook()函数执行的时间必须很短才行*/
#define configUSE_TICK_HOOK                        0 //1：使用时间片钩子（Tick Hook）   0：忽略时间片钩子  


#define configUSE_MALLOC_FAILED_HOOK            0 //1：使用内存申请失败钩子函数    

/**
  * 大于0时启用堆栈溢出检测功能，如果使用此功能，用户必须提供一个栈溢出钩子函数，如果使用的话此值可以为1或者2，因为有两种栈溢出检测方法 
  */
#define configCHECK_FOR_STACK_OVERFLOW            0   




/********************************************************************
          FreeRTOS与运行时间和任务状态收集有关的配置选项   
**********************************************************************/
#define configGENERATE_RUN_TIME_STATS            0 //为1时启用运行时间统计功能      
#define configUSE_TRACE_FACILITY                0 //为1时启用可视化跟踪调试



/** 与宏configUSE_TRACE_FACILITY同时为1时会编译下面3个函数
  * prvWriteNameToBuffer()
  * vTaskList(),
  * vTaskGetRunTimeStats()
  */
#define configUSE_STATS_FORMATTING_FUNCTIONS    1                       
                                                                        


/********************************************************************
                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                10                             //软件定时器队列长度                        
#define configTIMER_TASK_STACK_DEPTH            (configMINIMAL_STACK_SIZE*2)   //软件定时器任务堆栈大小 


/************************************************************
            FreeRTOS可选函数配置选项                                                     
************************************************************/
//必须将对应得宏置1才能使用对应得函数
#define INCLUDE_xTaskGetSchedulerState           1                       
#define INCLUDE_vTaskPrioritySet                 1
#define INCLUDE_uxTaskPriorityGet                 1
#define INCLUDE_vTaskDelete                         1
#define INCLUDE_vTaskCleanUpResources             1
#define INCLUDE_vTaskSuspend                     1
#define INCLUDE_vTaskDelayUntil                     1
#define INCLUDE_vTaskDelay                         1
#define INCLUDE_eTaskGetState                     1
#define INCLUDE_xTimerPendFunctionCall             1
//#define INCLUDE_xTaskGetCurrentTaskHandle       1
//#define INCLUDE_uxTaskGetStackHighWaterMark     0
//#define INCLUDE_xTaskGetIdleTaskHandle          0




/******************************************************************
            FreeRTOS与中断有关的配置选项                                                 
******************************************************************/
#ifdef __NVIC_PRIO_BITS
    #define configPRIO_BITS               __NVIC_PRIO_BITS
#else
    #define configPRIO_BITS               4                  //使用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) )    /* 240 */
#define configMAX_SYSCALL_INTERRUPT_PRIORITY     ( configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY << (8 - configPRIO_BITS) )   //用来配置中断屏蔽寄存器 BASEPRI 的值， 高四位有效


/****************************************************************
            FreeRTOS与中断服务函数有关的配置选项                         
****************************************************************/
#define xPortPendSVHandler     PendSV_Handler
//#define xPortSysTickHandler SysTick_Handler
#define vPortSVCHandler     SVC_Handler



/*以下为使用Percepio Tracealyzer需要的东西，不需要时将configUSE_TRACE_FACILITY定义为0*/
#if ( configUSE_TRACE_FACILITY == 1 )
    #include "trcRecorder.h"
    #define INCLUDE_xTaskGetCurrentTaskHandle               1   // 启用一个可选函数（该函数被 Trace源码使用，默认该值为0 表示不用）
#endif


#endif