FreeRTOSConfig.h

Go to the documentation of this file.

/*
 * FreeRTOS Kernel V10.3.1
 * Portion Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 * Portion Copyright (C) 2019 StMicroelectronics, Inc.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://www.FreeRTOS.org
 * http://aws.amazon.com/freertos
 *
 * 1 tab == 4 spaces!
 */
 
#ifndef FREERTOS_CONFIG_H
#define FREERTOS_CONFIG_H
 
// #include "main.h"
// #include "stm32h7xx_hal.h"
#include "freertos_utils.h"
 
/*-----------------------------------------------------------
 * Application specific definitions.
 *
 * These definitions should be adjusted for your particular hardware and
 * application requirements.
 *
 * These parameters and more 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
 *----------------------------------------------------------*/
 
/* Ensure definitions are only used by the compiler, and not by the assembler. */
#if defined(__ICCARM__) || defined(__CC_ARM) || defined(__GNUC__)
    #include <stdint.h>
extern uint32_t SystemCoreClock;
#endif
#ifndef CMSIS_device_header
    #define CMSIS_device_header "stm32h7xx.h"
#endif /* CMSIS_device_header */
 
#define configENABLE_FPU 1
#define configENABLE_MPU 0
 
// This config option needs to be enabled for fully reentrant stdlib calls
// (newlib is the C standard library implementation used by arm-none-eabi-gcc).
// Do not disable!
#define configUSE_NEWLIB_REENTRANT 1
 
#define configUSE_PREEMPTION                  1
#define configSUPPORT_STATIC_ALLOCATION       1
#define configSUPPORT_DYNAMIC_ALLOCATION      1
#define configUSE_IDLE_HOOK                   0
#define configUSE_TICK_HOOK                   0
#define configCPU_CLOCK_HZ                    (SystemCoreClock)
#define configTICK_RATE_HZ                    ((TickType_t)1000)
#define configMAX_PRIORITIES                  (8)
#define configMINIMAL_STACK_SIZE              ((StackType_t)512)  // Value is in words - 256 words = 1024 bytes = 1KB
#define configTOTAL_HEAP_SIZE                 ((size_t)0x10000)   // Value is in bytes - 64kb total heap size
#define configMAX_TASK_NAME_LEN               (32)
 
// #ifndef configUSE_TRACE_FACILITY
//     #define configUSE_TRACE_FACILITY 0
// #endif
 
#define configUSE_16_BIT_TICKS                0
#define configUSE_MUTEXES                     1
#define configQUEUE_REGISTRY_SIZE             8
#define configUSE_RECURSIVE_MUTEXES           1
#define configUSE_COUNTING_SEMAPHORES         1
#define configUSE_TASK_NOTIFICATIONS          1
#define configTASK_NOTIFICATION_ARRAY_ENTRIES 4
// #define configUSE_PORT_OPTIMISED_TASK_SELECTION 0
/* Defaults to size_t for backward compatibility, but can be changed
   if lengths will always be less than the number of bytes in a size_t. */
#define configMESSAGE_BUFFER_LENGTH_TYPE      uint8_t  // Message lengths will always be <255 bytes
#define configKERNEL_PROVIDED_STATIC_MEMORY   1
#define configUSE_STATS_FORMATTING_FUNCTIONS  1
 
// For runtime statistics
extern void freertos_runtime_stats_start(void);
 
#define configGENERATE_RUN_TIME_STATS            1
#define configRUN_TIME_COUNTER_TYPE              uint32_t
#define portCONFIGURE_TIMER_FOR_RUN_TIME_STATS() freertos_stats_timer_start()
#define portGET_RUN_TIME_COUNTER_VALUE()         freertos_stats_timer_get()
#define configRECORD_STACK_HIGH_ADDRESS          1
 
/* Co-routine definitions. */
#define configUSE_CO_ROUTINES           0
#define configMAX_CO_ROUTINE_PRIORITIES (2)
 
/* Software timer definitions. */
#define configUSE_TIMERS             1
// TODO
#define configTIMER_TASK_PRIORITY    5  // PRIO_LUDICROUS
#define configTIMER_QUEUE_LENGTH     50
#define configTIMER_TASK_STACK_DEPTH (configMINIMAL_STACK_SIZE)
 
/* Set the following definitions to 1 to include the API function, or zero
to exclude the API function. */
#define INCLUDE_vTaskPrioritySet            1
#define INCLUDE_uxTaskPriorityGet           1
#define INCLUDE_vTaskDelete                 1
#define INCLUDE_vTaskCleanUpResources       0
#define INCLUDE_vTaskSuspend                1
#define INCLUDE_xTaskDelayUntil             1
#define INCLUDE_vTaskDelay                  1
#define INCLUDE_xTaskGetSchedulerState      1
#define INCLUDE_xTimerPendFunctionCall      1
#define INCLUDE_xQueueGetMutexHolder        1
#define INCLUDE_uxTaskGetStackHighWaterMark 1
#define INCLUDE_xTaskGetCurrentTaskHandle   1
#define INCLUDE_eTaskGetState               1
#define INCLUDE_ulTaskGetRunTimePercent     1
#define INCLUDE_xTaskDelayUntil             1
 
/* Cortex-M specific definitions. */
#ifdef __NVIC_PRIO_BITS
    /* __BVIC_PRIO_BITS will be specified when CMSIS is being used. */
    #define configPRIO_BITS __NVIC_PRIO_BITS
#else
    #define configPRIO_BITS 4
#endif
 
// Map FreeRTOS interrupt handlers to CMSIS equivalents
#define vPortSVCHandler     SVC_Handler
#define xPortPendSVHandler  PendSV_Handler
#define xPortSysTickHandler SysTick_Handler
 
/* The lowest interrupt priority that can be used in a call to a "set priority"
function. */
#define configLIBRARY_LOWEST_INTERRUPT_PRIORITY 15
 
/* The highest interrupt priority that can be used by any interrupt service
routine that makes calls to interrupt safe FreeRTOS API functions.  DO NOT CALL
INTERRUPT SAFE FREERTOS API FUNCTIONS FROM ANY INTERRUPT THAT HAS A HIGHER
PRIORITY THAN THIS! (higher priorities are lower numeric values. */
#define configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY 1
 
/* Interrupt priorities used by the kernel port layer itself.  These are generic
to all Cortex-M ports, and do not rely on any particular library functions. */
#define configKERNEL_INTERRUPT_PRIORITY      (configLIBRARY_LOWEST_INTERRUPT_PRIORITY << (8 - configPRIO_BITS))
/* !!!! configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to zero !!!!
See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html. */
#define configMAX_SYSCALL_INTERRUPT_PRIORITY (configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY << (8 - configPRIO_BITS))
 
// This should be more than big enough, adjust if needed
#define configSTATS_BUFFER_MAX_LENGTH 0x400
 
/* Normal assert() semantics without relying on the provision of an assert.h header file. */
#define configASSERT(x)           \
    if ((x) == 0) {               \
        taskDISABLE_INTERRUPTS(); \
        for (;;);                 \
    }
 
#if defined(configUSE_TRACE_FACILITY) && configUSE_TRACE_FACILITY == 1
    #include "trcRecorder.h"
#endif
 
#endif /* FREERTOS_CONFIG_H */