]> begriffs open source - cmsis-freertos/blob - Demo/CORTEX_SmartFusion2_M2S050_SoftConsole/RTOSDemo/FreeRTOSConfig.h
Changed documentation according to the latest Arm branding guidelines.
[cmsis-freertos] / Demo / CORTEX_SmartFusion2_M2S050_SoftConsole / RTOSDemo / FreeRTOSConfig.h
1 /*
2     FreeRTOS V9.0.0 - Copyright (C) 2016 Real Time Engineers Ltd.
3     All rights reserved
4
5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
6
7     This file is part of the FreeRTOS distribution.
8
9     FreeRTOS is free software; you can redistribute it and/or modify it under
10     the terms of the GNU General Public License (version 2) as published by the
11     Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.
12
13     ***************************************************************************
14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<
15     >>!   distribute a combined work that includes FreeRTOS without being   !<<
16     >>!   obliged to provide the source code for proprietary components     !<<
17     >>!   outside of the FreeRTOS kernel.                                   !<<
18     ***************************************************************************
19
20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following
23     link: http://www.freertos.org/a00114.html
24
25     ***************************************************************************
26      *                                                                       *
27      *    FreeRTOS provides completely free yet professionally developed,    *
28      *    robust, strictly quality controlled, supported, and cross          *
29      *    platform software that is more than just the market leader, it     *
30      *    is the industry's de facto standard.                               *
31      *                                                                       *
32      *    Help yourself get started quickly while simultaneously helping     *
33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *
34      *    tutorial book, reference manual, or both:                          *
35      *    http://www.FreeRTOS.org/Documentation                              *
36      *                                                                       *
37     ***************************************************************************
38
39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading
40     the FAQ page "My application does not run, what could be wrong?".  Have you
41     defined configASSERT()?
42
43     http://www.FreeRTOS.org/support - In return for receiving this top quality
44     embedded software for free we request you assist our global community by
45     participating in the support forum.
46
47     http://www.FreeRTOS.org/training - Investing in training allows your team to
48     be as productive as possible as early as possible.  Now you can receive
49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
50     Ltd, and the world's leading authority on the world's leading RTOS.
51
52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS
54     compatible FAT file system, and our tiny thread aware UDP/IP stack.
55
56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
58
59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS
61     licenses offer ticketed support, indemnification and commercial middleware.
62
63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety
64     engineered and independently SIL3 certified version for use in safety and
65     mission critical applications that require provable dependability.
66
67     1 tab == 4 spaces!
68 */
69
70
71 #ifndef FREERTOS_CONFIG_H
72 #define FREERTOS_CONFIG_H
73
74 /*
75  * The following #error directive is to remind users that a batch file must be
76  * executed prior to this project being built.  Once it has been executed
77  * remove the #error line below.
78  */
79 //#error Ensure CreateProjectDirectoryStructure.bat has been executed before building.  See comment immediately above.
80
81 /*
82  * Set configCREATE_SIMPLE_BLINKY_DEMO_ONLY to one to run the simple blinky demo,
83  * or 0 to run the more comprehensive test and demo application.
84  */
85 #define configCREATE_SIMPLE_BLINKY_DEMO_ONLY    0
86
87 /*
88  * Set configBUILD_FOR_DEVELOPMENT_KIT to 1 to run the demo on the SmartFusion2
89  * development kit, or 0 to run the demo on the SmartFusion2 starter kit.  Refer
90  * to the documentation page for this demo on the FreeRTOS.org website for
91  * instruction on switching between the two hardware platforms.
92  */
93 #define configBUILD_FOR_DEVELOPMENT_KIT 0
94
95 /*-----------------------------------------------------------
96  * Application specific definitions.
97  *
98  * These definitions should be adjusted for your particular hardware and
99  * application requirements.
100  *
101  * THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE
102  * FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE.
103  *
104  * See http://www.freertos.org/a00110.html.
105  *----------------------------------------------------------*/
106
107 #include <stdint.h>
108 extern uint32_t SystemCoreClock;
109
110 #define configUSE_PREEMPTION                    1
111 #define configUSE_IDLE_HOOK                             1
112 #define configUSE_TICK_HOOK                             0
113 #define configCPU_CLOCK_HZ                              ( SystemCoreClock )
114 #define configTICK_RATE_HZ                              ( ( TickType_t ) 1000 )
115 #define configMAX_PRIORITIES                    ( 5 )
116 #define configMINIMAL_STACK_SIZE                ( ( unsigned short ) 80 )
117 #define configTOTAL_HEAP_SIZE                   ( ( size_t ) ( 25000 ) )
118 #define configMAX_TASK_NAME_LEN                 ( 10 )
119 #define configUSE_TRACE_FACILITY                1
120 #define configUSE_16_BIT_TICKS                  0
121 #define configIDLE_SHOULD_YIELD                 1
122 #define configUSE_MUTEXES                               1
123 #define configQUEUE_REGISTRY_SIZE               0
124 #define configCHECK_FOR_STACK_OVERFLOW  2
125 #define configUSE_RECURSIVE_MUTEXES             1
126 #define configUSE_MALLOC_FAILED_HOOK    1
127 #define configUSE_APPLICATION_TASK_TAG  0
128 #define configUSE_COUNTING_SEMAPHORES   1
129
130 /* Co-routine definitions. */
131 #define configUSE_CO_ROUTINES                   0
132 #define configMAX_CO_ROUTINE_PRIORITIES ( 2 )
133
134 /* Software timer definitions. */
135 #define configUSE_TIMERS                                1
136 #define configTIMER_TASK_PRIORITY               ( 2 )
137 #define configTIMER_QUEUE_LENGTH                5
138 #define configTIMER_TASK_STACK_DEPTH    ( configMINIMAL_STACK_SIZE * 2 )
139
140 /* Run time stats gathering definitions. */
141 void vConfigureTimerForRunTimeStats( void );
142 uint32_t ulGetRunTimeCounterValue( void );
143 #define configGENERATE_RUN_TIME_STATS   1
144 #define portCONFIGURE_TIMER_FOR_RUN_TIME_STATS() vConfigureTimerForRunTimeStats()
145 #define portGET_RUN_TIME_COUNTER_VALUE() ulGetRunTimeCounterValue()
146
147 /* Set the following definitions to 1 to include the API function, or zero
148 to exclude the API function. */
149 #define INCLUDE_vTaskPrioritySet                1
150 #define INCLUDE_uxTaskPriorityGet               1
151 #define INCLUDE_vTaskDelete                             1
152 #define INCLUDE_vTaskCleanUpResources   1
153 #define INCLUDE_vTaskSuspend                    1
154 #define INCLUDE_vTaskDelayUntil                 1
155 #define INCLUDE_vTaskDelay                              1
156
157 /* This demo makes use of one or more example stats formatting functions.  These
158 format the raw data provided by the uxTaskGetSystemState() function in to human
159 readable ASCII form.  See the notes in the implementation of vTaskList() within
160 FreeRTOS/Source/tasks.c for limitations. */
161 #define configUSE_STATS_FORMATTING_FUNCTIONS    1
162
163 /* The size of the global output buffer that is available for use when there
164 are multiple command interpreters running at once (for example, one on a UART
165 and one on TCP/IP).  This is done to prevent an output buffer being defined by
166 each implementation - which would waste RAM.  In this case, there is only one
167 command interpreter running. */
168 #define configCOMMAND_INT_MAX_OUTPUT_SIZE 2048
169
170 /* Cortex-M specific definitions. */
171 #ifdef __NVIC_PRIO_BITS
172         /* __BVIC_PRIO_BITS will be specified when CMSIS is being used. */
173         #define configPRIO_BITS                 __NVIC_PRIO_BITS
174 #else
175         #define configPRIO_BITS                 4        /* 15 priority levels */
176 #endif
177
178 /* The lowest interrupt priority that can be used in a call to a "set priority"
179 function. */
180 #define configLIBRARY_LOWEST_INTERRUPT_PRIORITY                 0x0f
181
182 /* The highest interrupt priority that can be used by any interrupt service
183 routine that makes calls to interrupt safe FreeRTOS API functions.  DO NOT CALL
184 INTERRUPT SAFE FREERTOS API FUNCTIONS FROM ANY INTERRUPT THAT HAS A HIGHER
185 PRIORITY THAN THIS! (higher priorities are lower numeric values. */
186 #define configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY    10
187
188 /* Interrupt priorities used by the kernel port layer itself.  These are generic
189 to all Cortex-M ports, and do not rely on any particular library functions. */
190 #define configKERNEL_INTERRUPT_PRIORITY                 ( configLIBRARY_LOWEST_INTERRUPT_PRIORITY << (8 - configPRIO_BITS) )
191 /* !!!! configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to zero !!!!
192 See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html. */
193 #define configMAX_SYSCALL_INTERRUPT_PRIORITY    ( configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY << (8 - configPRIO_BITS) )
194
195 /* Normal assert() semantics without relying on the provision of an assert.h
196 header file. */
197 #define configASSERT( x ) if( ( x ) == 0 ) { taskDISABLE_INTERRUPTS(); for( ;; ); }
198
199 /* Definitions that map the FreeRTOS port interrupt handlers to their CMSIS
200 standard names. */
201 #define vPortSVCHandler SVC_Handler
202 #define xPortPendSVHandler PendSV_Handler
203 #define xPortSysTickHandler SysTick_Handler
204
205 #endif /* FREERTOS_CONFIG_H */
206