begriffs open source - cmsis-freertos/blob - Demo/Posix_GCC/FreeRTOSConfig.h

   1 /*
   2  * FreeRTOS V202107.00
   3  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   6  * this software and associated documentation files (the "Software"), to deal in
   7  * the Software without restriction, including without limitation the rights to
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
   9  * the Software, and to permit persons to whom the Software is furnished to do so,
  10  * subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in all
  13  * copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * https://www.FreeRTOS.org
  23  * https://github.com/FreeRTOS
  24  *
  25  */
  26 #ifndef FREERTOS_CONFIG_H
  27 #define FREERTOS_CONFIG_H
  28
  29 /*-----------------------------------------------------------
  30 * Application specific definitions.
  31 *
  32 * These definitions should be adjusted for your particular hardware and
  33 * application requirements.
  34 *
  35 * THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE
  36 * FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE.  See
  37 * http://www.freertos.org/a00110.html
  38 *----------------------------------------------------------*/
  39
  40 #define configUSE_PREEMPTION                       1
  41 #define configUSE_PORT_OPTIMISED_TASK_SELECTION    0
  42 #define configUSE_IDLE_HOOK                        1
  43 #define configUSE_TICK_HOOK                        1
  44 #define configUSE_DAEMON_TASK_STARTUP_HOOK         1
  45 #define configTICK_RATE_HZ                         ( 1000 )                  /* In this non-real time simulated environment the tick frequency has to be at least a multiple of the Win32 tick frequency, and therefore very slow. */
  46 #define configMINIMAL_STACK_SIZE                   ( ( unsigned short ) 70 ) /* In this simulated case, the stack only has to hold one small structure as the real stack is part of the win32 thread. */
  47 #define configTOTAL_HEAP_SIZE                      ( ( size_t ) ( 65 * 1024 ) )
  48 #define configMAX_TASK_NAME_LEN                    ( 12 )
  49 #define configUSE_TRACE_FACILITY                   1
  50 #define configUSE_16_BIT_TICKS                     0
  51 #define configIDLE_SHOULD_YIELD                    1
  52 #define configUSE_MUTEXES                          1
  53 #define configCHECK_FOR_STACK_OVERFLOW             0
  54 #define configUSE_RECURSIVE_MUTEXES                1
  55 #define configQUEUE_REGISTRY_SIZE                  20
  56 #define configUSE_APPLICATION_TASK_TAG             1
  57 #define configUSE_COUNTING_SEMAPHORES              1
  58 #define configUSE_ALTERNATIVE_API                  0
  59 #define configUSE_QUEUE_SETS                       1
  60 #define configUSE_TASK_NOTIFICATIONS               1
  61 #define configSUPPORT_STATIC_ALLOCATION            1
  62
  63 /* Software timer related configuration options.  The maximum possible task
  64  * priority is configMAX_PRIORITIES - 1.  The priority of the timer task is
  65  * deliberately set higher to ensure it is correctly capped back to
  66  * configMAX_PRIORITIES - 1. */
  67 #define configUSE_TIMERS                           1
  68 #define configTIMER_TASK_PRIORITY                  ( configMAX_PRIORITIES - 1 )
  69 #define configTIMER_QUEUE_LENGTH                   20
  70 #define configTIMER_TASK_STACK_DEPTH               ( configMINIMAL_STACK_SIZE * 2 )
  71
  72 #define configMAX_PRIORITIES                       ( 7 )
  73
  74 /* Run time stats gathering configuration options. */
  75 unsigned long ulGetRunTimeCounterValue( void ); /* Prototype of function that returns run time counter. */
  76 void vConfigureTimerForRunTimeStats( void );    /* Prototype of function that initialises the run time counter. */
  77 #define configGENERATE_RUN_TIME_STATS             1
  78
  79 /* Co-routine related configuration options. */
  80 #define configUSE_CO_ROUTINES                     0
  81 #define configMAX_CO_ROUTINE_PRIORITIES           ( 2 )
  82
  83 /* This demo can use of one or more example stats formatting functions.  These
  84  * format the raw data provided by the uxTaskGetSystemState() function in to human
  85  * readable ASCII form.  See the notes in the implementation of vTaskList() within
  86  * FreeRTOS/Source/tasks.c for limitations. */
  87 #define configUSE_STATS_FORMATTING_FUNCTIONS      0
  88
  89 /* Enables the test whereby a stack larger than the total heap size is
  90  * requested. */
  91 #define configSTACK_DEPTH_TYPE                    uint32_t
  92
  93 /* Set the following definitions to 1 to include the API function, or zero
  94  * to exclude the API function.  In most cases the linker will remove unused
  95  * functions anyway. */
  96 #define INCLUDE_vTaskPrioritySet                  1
  97 #define INCLUDE_uxTaskPriorityGet                 1
  98 #define INCLUDE_vTaskDelete                       1
  99 #define INCLUDE_vTaskCleanUpResources             0
 100 #define INCLUDE_vTaskSuspend                      1
 101 #define INCLUDE_vTaskDelayUntil                   1
 102 #define INCLUDE_vTaskDelay                        1
 103 #define INCLUDE_uxTaskGetStackHighWaterMark       1
 104 #define INCLUDE_uxTaskGetStackHighWaterMark2      1
 105 #define INCLUDE_xTaskGetSchedulerState            1
 106 #define INCLUDE_xTimerGetTimerDaemonTaskHandle    1
 107 #define INCLUDE_xTaskGetIdleTaskHandle            1
 108 #define INCLUDE_xTaskGetHandle                    1
 109 #define INCLUDE_eTaskGetState                     1
 110 #define INCLUDE_xSemaphoreGetMutexHolder          1
 111 #define INCLUDE_xTimerPendFunctionCall            1
 112 #define INCLUDE_xTaskAbortDelay                   1
 113
 114 #define configINCLUDE_MESSAGE_BUFFER_AMP_DEMO     0
 115 #if ( configINCLUDE_MESSAGE_BUFFER_AMP_DEMO == 1 )
 116     extern void vGenerateCoreBInterrupt( void * xUpdatedMessageBuffer );
 117     #define sbSEND_COMPLETED( pxStreamBuffer )    vGenerateCoreBInterrupt( pxStreamBuffer )
 118 #endif /* configINCLUDE_MESSAGE_BUFFER_AMP_DEMO */
 119
 120 extern void vAssertCalled( const char * const pcFileName,
 121                            unsigned long ulLine );
 122
 123 /* projCOVERAGE_TEST should be defined on the command line so this file can be
 124  * used with multiple project configurations.  If it is
 125  */
 126 #ifndef projCOVERAGE_TEST
 127     #error projCOVERAGE_TEST should be defined to 1 or 0 on the command line.
 128 #endif
 129
 130 #if ( projCOVERAGE_TEST == 1 )
 131
 132 /* Insert NOPs in empty decision paths to ensure both true and false paths
 133  * are being tested. */
 134     #define mtCOVERAGE_TEST_MARKER()    __asm volatile ( "NOP" )
 135
 136 /* Ensure the tick count overflows during the coverage test. */
 137     #define configINITIAL_TICK_COUNT        0xffffd800UL
 138
 139 /* Allows tests of trying to allocate more than the heap has free. */
 140     #define configUSE_MALLOC_FAILED_HOOK    0
 141
 142 /* To test builds that remove the static qualifier for debug builds. */
 143     #define portREMOVE_STATIC_QUALIFIER
 144 #else /* if ( projCOVERAGE_TEST == 1 ) */
 145
 146 /* It is a good idea to define configASSERT() while developing.  configASSERT()
 147  * uses the same semantics as the standard C assert() macro.  Don't define
 148  * configASSERT() when performing code coverage tests though, as it is not
 149  * intended to asserts() to fail, some some code is intended not to run if no
 150  * errors are present. */
 151     #define configASSERT( x )    if( ( x ) == 0 ) vAssertCalled( __FILE__, __LINE__ )
 152
 153     #define configUSE_MALLOC_FAILED_HOOK    1
 154
 155 /* Include the FreeRTOS+Trace FreeRTOS trace macro definitions. */
 156     #include "trcRecorder.h"
 157 #endif /* if ( projCOVERAGE_TEST == 1 ) */
 158
 159 /* networking definitions */
 160 #define configMAC_ISR_SIMULATOR_PRIORITY    ( configMAX_PRIORITIES - 1 )
 161
 162 /* Prototype for the function used to print out.  In this case it prints to the
 163  * console before the network is connected then a UDP port after the network has
 164  * connected. */
 165 extern void vLoggingPrintf( const char * pcFormatString,
 166                             ... );
 167
 168 /* Set to 1 to print out debug messages.  If ipconfigHAS_DEBUG_PRINTF is set to
 169  * 1 then FreeRTOS_debug_printf should be defined to the function used to print
 170  * out the debugging messages. */
 171 #define ipconfigHAS_DEBUG_PRINTF    1
 172 #if ( ipconfigHAS_DEBUG_PRINTF == 1 )
 173     #define FreeRTOS_debug_printf( X )    vLoggingPrintf X
 174 #endif
 175
 176 /* Set to 1 to print out non debugging messages, for example the output of the
 177  * FreeRTOS_netstat() command, and ping replies.  If ipconfigHAS_PRINTF is set to 1
 178  * then FreeRTOS_printf should be set to the function used to print out the
 179  * messages. */
 180 #define ipconfigHAS_PRINTF    0
 181 #if ( ipconfigHAS_PRINTF == 1 )
 182     #define FreeRTOS_printf( X )    vLoggingPrintf X
 183 #endif
 184 #endif /* FREERTOS_CONFIG_H */