examples/freertos/src/FreeRTOSConfig.h

/*
 * FreeRTOS V202212.00
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  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.
 *
 * https://www.FreeRTOS.org
 * https://github.com/FreeRTOS
 *
 */

#ifndef FREERTOS_CONFIG_H
#define FREERTOS_CONFIG_H

#if MEMFAULT_TEST_USE_PORT_TEMPLATE != 1
  #include "memfault/ports/freertos_trace.h"
#endif

/*-----------------------------------------------------------
 * Application specific definitions.
 *
 * These definitions should be adjusted for your particular hardware and
 * application requirements.
 *
 * THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE
 * FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE.
 *
 * See https://www.freertos.org/a00110.html
 *----------------------------------------------------------*/

#if MEMFAULT_TEST_USE_PORT_TEMPLATE != 1
  #define configASSERT_DEFINED 1
extern void vAssertCalled(const char *file, int line);
  #define configASSERT(x) \
    if ((x) == 0) vAssertCalled(__FILE__, __LINE__)
#else
  // Disable this check, to avoid an unused variable warning due to FreeRTOS
  // configASSERT() being compiled out by default.
  // https://github.com/FreeRTOS/FreeRTOS-Kernel/blob/0adc196d4bd52a2d91102b525b0aafc1e14a2386/portable/GCC/ARM_CM3/port.c#L282-L302
  #define configCHECK_HANDLER_INSTALLATION 0

  // There's an unused variable warning here too, disable these stats.
  #define configGENERATE_RUN_TIME_STATS 0
#endif
#define configQUEUE_REGISTRY_SIZE 20

#define configUSE_PREEMPTION 1
#define configUSE_TIME_SLICING 0
#define configUSE_PORT_OPTIMISED_TASK_SELECTION 0

#define configUSE_IDLE_HOOK 0
#define configUSE_TICK_HOOK 0
#define configUSE_DAEMON_TASK_STARTUP_HOOK 0
#define configCPU_CLOCK_HZ ((unsigned long)20000000)
#define configTICK_RATE_HZ ((TickType_t)1000)
#define configMINIMAL_STACK_SIZE ((unsigned short)1000)
#define configMINIMAL_SECURE_STACK_SIZE (1024)
#define configTOTAL_HEAP_SIZE ((size_t)(2048))
#define configUSE_16_BIT_TICKS 0
#define configIDLE_SHOULD_YIELD 1

#define configMAX_PRIORITIES (10)
#define configTIMER_QUEUE_LENGTH 20
#define configTIMER_TASK_PRIORITY (configMAX_PRIORITIES - 1)
#define configUSE_COUNTING_SEMAPHORES 1
#define configSUPPORT_DYNAMIC_ALLOCATION 1
#define configSUPPORT_STATIC_ALLOCATION 1
#define configNUM_TX_DESCRIPTORS 15
#define configSTREAM_BUFFER_TRIGGER_LEVEL_TEST_MARGIN 2

/* Set the following definitions to 1 to include the API function, or zero
 * to exclude the API function. */

#if MEMFAULT_TEST_USE_PORT_TEMPLATE != 1
  #define configCHECK_FOR_STACK_OVERFLOW 2
#else
  #define configCHECK_FOR_STACK_OVERFLOW 0
#endif

#define configUSE_MALLOC_FAILED_HOOK 0
#define configUSE_MUTEXES 1
#define configUSE_RECURSIVE_MUTEXES 1
#define configUSE_TIMERS 1
#define configTIMER_TASK_STACK_DEPTH (configMINIMAL_STACK_SIZE * 2)
#define configRECORD_STACK_HIGH_ADDRESS 1

#if !defined(configGENERATE_RUN_TIME_STATS)
  #define configGENERATE_RUN_TIME_STATS 1
#endif
#define configUSE_TRACE_FACILITY 1
#define portCONFIGURE_TIMER_FOR_RUN_TIME_STATS()  // unused
#define portGET_RUN_TIME_COUNTER_VALUE() ulGetRunTimeCounterValue()
#define configUSE_STATS_FORMATTING_FUNCTIONS 1

#define INCLUDE_vTaskPrioritySet 1
#define INCLUDE_uxTaskPriorityGet 1
#define INCLUDE_vTaskDelete 1
#define INCLUDE_vTaskCleanUpResources 0
#define INCLUDE_vTaskSuspend 1
#define INCLUDE_vTaskDelayUntil 1
#define INCLUDE_vTaskDelay 1
#define INCLUDE_uxTaskGetStackHighWaterMark 1
#define INCLUDE_uxTaskGetStackHighWaterMark2 1
#define INCLUDE_xTaskGetSchedulerState 1
#define INCLUDE_xTimerGetTimerDaemonTaskHandle 1
#define INCLUDE_xTaskGetIdleTaskHandle 1
#define INCLUDE_xTaskGetHandle 1
#define INCLUDE_eTaskGetState 1
#define INCLUDE_xSemaphoreGetMutexHolder 1
#define INCLUDE_xTimerPendFunctionCall 1
#define INCLUDE_xTaskAbortDelay 1

unsigned long ulGetRunTimeCounterValue(
  void); /* Prototype of function that returns run time counter. */

#define projCOVERAGE_TEST 0

#define configKERNEL_INTERRUPT_PRIORITY 255

/* !!!! configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to zero !!!!
 * See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html. */
// On a device implementing 8 priority bits (like our emulated QEMU hardware),
// all of the bits are considered for priority, and the LSB MUST NOT be set, or
// the kernel crashes on startup. Set it to 4.
#define configMAX_SYSCALL_INTERRUPT_PRIORITY 4

// For the qemu_mps2_an505 target, configENABLE_PAC must be defined since it is referenced here:
// https://github.com/FreeRTOS/FreeRTOS-Kernel/blob/V11.2.0/portable/GCC/ARM_CM33/non_secure/portmacrocommon.h#L131
#define configENABLE_PAC 0

/* Prototype for the function used to print out. */
extern void vLoggingPrintf(const char *pcFormatString, ...);

#ifdef HEAP3
  #define xPortGetMinimumEverFreeHeapSize (x)
  #define xPortGetFreeHeapSize (x)
#endif

#endif /* FREERTOS_CONFIG_H */