]> begriffs open source - cmsis-freertos/blob - Source/portable/RVDS/ARM_CA9/portmacro.h
Update cmsis_os2.c
[cmsis-freertos] / Source / portable / RVDS / ARM_CA9 / portmacro.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 PORTMACRO_H
71 #define PORTMACRO_H
72
73 #ifdef __cplusplus
74 extern "C" {
75 #endif
76
77 /*-----------------------------------------------------------
78  * Port specific definitions.
79  *
80  * The settings in this file configure FreeRTOS correctly for the given hardware
81  * and compiler.
82  *
83  * These settings should not be altered.
84  *-----------------------------------------------------------
85  */
86
87 /* Type definitions. */
88 #define portCHAR                char
89 #define portFLOAT               float
90 #define portDOUBLE              double
91 #define portLONG                long
92 #define portSHORT               short
93 #define portSTACK_TYPE  uint32_t
94 #define portBASE_TYPE   long
95
96 typedef portSTACK_TYPE StackType_t;
97 typedef long BaseType_t;
98 typedef unsigned long UBaseType_t;
99
100
101 #if( configUSE_16_BIT_TICKS == 1 )
102         typedef uint16_t TickType_t;
103         #define portMAX_DELAY ( TickType_t ) 0xffff
104 #else
105         typedef uint32_t TickType_t;
106         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL
107
108         /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
109         not need to be guarded with a critical section. */
110         #define portTICK_TYPE_IS_ATOMIC 1
111 #endif
112 /*-----------------------------------------------------------*/
113
114 /* Hardware specifics. */
115 #define portSTACK_GROWTH                        ( -1 )
116 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
117 #define portBYTE_ALIGNMENT                      8
118
119 /*-----------------------------------------------------------*/
120
121 /* Task utilities. */
122
123 /* Called at the end of an ISR that can cause a context switch. */
124 #define portEND_SWITCHING_ISR( xSwitchRequired )\
125 {                                                                                               \
126 extern uint32_t ulPortYieldRequired;                    \
127                                                                                                 \
128         if( xSwitchRequired != pdFALSE )                        \
129         {                                                                                       \
130                 ulPortYieldRequired = pdTRUE;                   \
131         }                                                                                       \
132 }
133
134 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )
135 #define portYIELD() __asm( "SWI 0" );
136
137
138 /*-----------------------------------------------------------
139  * Critical section control
140  *----------------------------------------------------------*/
141
142 extern void vPortEnterCritical( void );
143 extern void vPortExitCritical( void );
144 extern uint32_t ulPortSetInterruptMask( void );
145 extern void vPortClearInterruptMask( uint32_t ulNewMaskValue );
146
147 /* These macros do not globally disable/enable interrupts.  They do mask off
148 interrupts that have a priority below configMAX_API_CALL_INTERRUPT_PRIORITY. */
149 #define portENTER_CRITICAL()            vPortEnterCritical();
150 #define portEXIT_CRITICAL()                     vPortExitCritical();
151 #define portDISABLE_INTERRUPTS()        ulPortSetInterruptMask()
152 #define portENABLE_INTERRUPTS()         vPortClearInterruptMask( 0 )
153 #define portSET_INTERRUPT_MASK_FROM_ISR()               ulPortSetInterruptMask()
154 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vPortClearInterruptMask(x)
155
156 /*-----------------------------------------------------------*/
157
158 /* Task function macros as described on the FreeRTOS.org WEB site.  These are
159 not required for this port but included in case common demo code that uses these
160 macros is used. */
161 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )      void vFunction( void *pvParameters )
162 #define portTASK_FUNCTION( vFunction, pvParameters )    void vFunction( void *pvParameters )
163
164 /* Prototype of the FreeRTOS tick handler.  This must be installed as the
165 handler for whichever peripheral is used to generate the RTOS tick. */
166 void FreeRTOS_Tick_Handler( void );
167
168 /* Any task that uses the floating point unit MUST call vPortTaskUsesFPU()
169 before any floating point instructions are executed. */
170 void vPortTaskUsesFPU( void );
171 #define portTASK_USES_FLOATING_POINT() vPortTaskUsesFPU()
172
173 #define portLOWEST_INTERRUPT_PRIORITY ( ( ( uint32_t ) configUNIQUE_INTERRUPT_PRIORITIES ) - 1UL )
174 #define portLOWEST_USABLE_INTERRUPT_PRIORITY ( portLOWEST_INTERRUPT_PRIORITY - 1UL )
175
176 /* Architecture specific optimisations. */
177 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
178         #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1
179 #endif
180
181 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1
182
183         /* Store/clear the ready priorities in a bit map. */
184         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )
185         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )
186
187         /*-----------------------------------------------------------*/
188
189         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31 - __clz( uxReadyPriorities ) )
190
191 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
192
193 #ifdef configASSERT
194         void vPortValidateInterruptPriority( void );
195         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()      vPortValidateInterruptPriority()
196 #endif
197
198 #define portNOP() __nop()
199
200 #ifdef __cplusplus
201 }
202 #endif
203
204 #endif /* PORTMACRO_H */
205