]> begriffs open source - cmsis-freertos/blob - Config/FreeRTOSConfig.h
Added example documentation for the i.MX6 ARM Cortex-A9.
[cmsis-freertos] / Config / 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 #ifndef FREERTOS_CONFIG_H
71 #define FREERTOS_CONFIG_H
72
73 /*-----------------------------------------------------------
74  * Application specific definitions.
75  *
76  * These definitions should be adjusted for your particular hardware and
77  * application requirements.
78  *
79  * THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE
80  * FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE.
81  *
82  * See http://www.freertos.org/a00110.html.
83  *----------------------------------------------------------*/
84
85 #include <stdint.h>
86
87 extern uint32_t SystemCoreClock;
88
89 #define configCPU_CLOCK_HZ                    (SystemCoreClock)
90 #define configTICK_RATE_HZ                    ((TickType_t)1000)
91 #define configTOTAL_HEAP_SIZE                 ((size_t)(4096))
92 #define configMINIMAL_STACK_SIZE              ((unsigned short)130)
93 #define configCHECK_FOR_STACK_OVERFLOW        0
94 #define configMAX_PRIORITIES                  (5)
95 #define configUSE_PREEMPTION                  1
96 #define configIDLE_SHOULD_YIELD               1
97 #define configMAX_TASK_NAME_LEN               (10)
98
99 /* Software timer definitions. */
100 #define configUSE_TIMERS                      1
101 #define configTIMER_TASK_PRIORITY             (2)
102 #define configTIMER_QUEUE_LENGTH              5
103 #define configTIMER_TASK_STACK_DEPTH          (configMINIMAL_STACK_SIZE * 2)
104
105 #define configUSE_MUTEXES                     1
106 #define configUSE_RECURSIVE_MUTEXES           1
107 #define configUSE_COUNTING_SEMAPHORES         1
108 #define configUSE_QUEUE_SETS                  1
109 #define configUSE_IDLE_HOOK                   0
110 #define configUSE_TICK_HOOK                   0
111 #define configUSE_MALLOC_FAILED_HOOK          0
112 #define configUSE_16_BIT_TICKS                0
113
114 /* Set the following definitions to 1 to include the API function, or zero
115 to exclude the API function. */
116 #define INCLUDE_vTaskPrioritySet              1
117 #define INCLUDE_uxTaskPriorityGet             1
118 #define INCLUDE_vTaskDelete                   1
119 #define INCLUDE_vTaskSuspend                  1
120 #define INCLUDE_vTaskDelayUntil               1
121 #define INCLUDE_vTaskDelay                    1
122 #define INCLUDE_eTaskGetState                 1
123
124 /* Cortex-M specific definitions. */
125 #ifdef __NVIC_PRIO_BITS
126   /* __BVIC_PRIO_BITS will be specified when CMSIS is being used. */
127   #define configPRIO_BITS                     __NVIC_PRIO_BITS
128 #else
129   /* 15 priority levels */
130   #define configPRIO_BITS                     4
131 #endif
132
133 /* The lowest interrupt priority that can be used in a call to a "set priority"
134 function. */
135 #define configLIBRARY_LOWEST_INTERRUPT_PRIORITY       0xff
136
137 /* The highest interrupt priority that can be used by any interrupt service
138 routine that makes calls to interrupt safe FreeRTOS API functions.  DO NOT CALL
139 INTERRUPT SAFE FREERTOS API FUNCTIONS FROM ANY INTERRUPT THAT HAS A HIGHER
140 PRIORITY THAN THIS! (higher priorities are lower numeric values. */
141 #define configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY  10
142
143 /* Interrupt priorities used by the kernel port layer itself.  These are generic
144 to all Cortex-M ports, and do not rely on any particular library functions. */
145 #define configKERNEL_INTERRUPT_PRIORITY               (configLIBRARY_LOWEST_INTERRUPT_PRIORITY << (8 - configPRIO_BITS))
146 /* !!!! configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to zero !!!!
147 See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html. */
148 #define configMAX_SYSCALL_INTERRUPT_PRIORITY          (configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY << (8 - configPRIO_BITS))
149
150 /* Normal assert() semantics without relying on the provision of an assert.h
151 header file. */
152 #define configASSERT( x ) if( ( x ) == 0 ) { taskDISABLE_INTERRUPTS(); for( ;; ); }
153
154 /* Map the FreeRTOS port interrupt handlers to their CMSIS standard names. */
155 #define xPortPendSVHandler                    PendSV_Handler
156 #define vPortSVCHandler                       SVC_Handler
157 #define xPortSysTickHandler                   SysTick_Handler
158
159 /* Include debug event definitions */
160 #include "freertos_evr.h"
161
162 #endif /* FREERTOS_CONFIG_H */