Debian Codegraph @

ports/cc3200/FreeRTOS/Source/portable/GCC/ARM_CM3/portmacro.h

raw
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 PORTMACRO_H
72 #define PORTMACRO_H
73
74 #ifdef __cplusplus
75 extern "C" {
76 #endif
77
78 /*-----------------------------------------------------------
79 * Port specific definitions.
80 *
81 * The settings in this file configure FreeRTOS correctly for the
82 * given hardware and compiler.
83 *
84 * These settings should not be altered.
85 *-----------------------------------------------------------
86 */
87
88 /* Type definitions. */
89 #define portCHAR char
90 #define portFLOAT float
91 #define portDOUBLE double
92 #define portLONG long
93 #define portSHORT short
94 #define portSTACK_TYPE uint32_t
95 #define portBASE_TYPE long
96
97 typedef portSTACK_TYPE StackType_t;
98 typedef long BaseType_t;
99 typedef unsigned long UBaseType_t;
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 /* Architecture 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 /* Scheduler utilities. */
121 #define portYIELD() \
122 { \
123 /* Set a PendSV to request a context switch. */ \
124 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; \
125 \
126 /* Barriers are normally not required but do ensure the code is completely \
127 within the specified behaviour for the architecture. */ \
128 __asm volatile( "dsb" ); \
129 __asm volatile( "isb" ); \
130 }
131
132 #define portNVIC_INT_CTRL_REG ( * ( ( volatile uint32_t * ) 0xe000ed04 ) )
133 #define portNVIC_PENDSVSET_BIT ( 1UL << 28UL )
134 #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired != pdFALSE ) portYIELD()
135 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )
136 /*-----------------------------------------------------------*/
137
138 /* Critical section management. */
139 extern void vPortEnterCritical( void );
140 extern void vPortExitCritical( void );
141 #define portSET_INTERRUPT_MASK_FROM_ISR() ulPortRaiseBASEPRI()
142 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x) vPortSetBASEPRI(x)
143 #define portDISABLE_INTERRUPTS() vPortRaiseBASEPRI()
144 #define portENABLE_INTERRUPTS() vPortSetBASEPRI(0)
145 #define portENTER_CRITICAL() vPortEnterCritical()
146 #define portEXIT_CRITICAL() vPortExitCritical()
147
148 /*-----------------------------------------------------------*/
149
150 /* Task function macros as described on the FreeRTOS.org WEB site. These are
151 not necessary for to use this port. They are defined so the common demo files
152 (which build with all the ports) will build. */
153 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
154 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
155 /*-----------------------------------------------------------*/
156
157 /* Tickless idle/low power functionality. */
158 #ifndef portSUPPRESS_TICKS_AND_SLEEP
159 extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );
160 #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime )
161 #endif
162 /*-----------------------------------------------------------*/
163
164 /* Architecture specific optimisations. */
165 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
166 #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1
167 #endif
168
169 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1
170
171 /* Generic helper function. */
172 __attribute__( ( always_inline ) ) static inline uint8_t ucPortCountLeadingZeros( uint32_t ulBitmap )
173 {
174 uint8_t ucReturn;
175
176 __asm volatile ( "clz %0, %1" : "=r" ( ucReturn ) : "r" ( ulBitmap ) );
177 return ucReturn;
178 }
179
180 /* Check the configuration. */
181 #if( configMAX_PRIORITIES > 32 )
182 #error configUSE_PORT_OPTIMISED_TASK_SELECTION can only be set to 1 when configMAX_PRIORITIES is less than or equal to 32. It is very rare that a system requires more than 10 to 15 difference priorities as tasks that share a priority will time slice.
183 #endif
184
185 /* Store/clear the ready priorities in a bit map. */
186 #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )
187 #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )
188
189 /*-----------------------------------------------------------*/
190
191 #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31UL - ( uint32_t ) ucPortCountLeadingZeros( ( uxReadyPriorities ) ) )
192
193 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
194
195 /*-----------------------------------------------------------*/
196
197 #ifdef configASSERT
198 void vPortValidateInterruptPriority( void );
199 #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() vPortValidateInterruptPriority()
200 #endif
201
202 /* portNOP() is not required by this port. */
203 #define portNOP()
204
205 #define portINLINE __inline
206
207 #ifndef portFORCE_INLINE
208 #define portFORCE_INLINE inline __attribute__(( always_inline))
209 #endif
210
211 portFORCE_INLINE static BaseType_t xPortIsInsideInterrupt( void )
212 {
213 uint32_t ulCurrentInterrupt;
214 BaseType_t xReturn;
215
216 /* Obtain the number of the currently executing interrupt. */
217 __asm volatile( "mrs %0, ipsr" : "=r"( ulCurrentInterrupt ) );
218
219 if( ulCurrentInterrupt == 0 )
220 {
221 xReturn = pdFALSE;
222 }
223 else
224 {
225 xReturn = pdTRUE;
226 }
227
228 return xReturn;
229 }
230
231 /*-----------------------------------------------------------*/
232
233 portFORCE_INLINE static void vPortRaiseBASEPRI( void )
234 {
235 uint32_t ulNewBASEPRI;
236
237 __asm volatile
238 (
239 " mov %0, %1 \n" \
240 " msr basepri, %0 \n" \
241 " isb \n" \
242 " dsb \n" \
243 :"=r" (ulNewBASEPRI) : "i" ( configMAX_SYSCALL_INTERRUPT_PRIORITY )
244 );
245 }
246
247 /*-----------------------------------------------------------*/
248
249 portFORCE_INLINE static uint32_t ulPortRaiseBASEPRI( void )
250 {
251 uint32_t ulOriginalBASEPRI, ulNewBASEPRI;
252
253 __asm volatile
254 (
255 " mrs %0, basepri \n" \
256 " mov %1, %2 \n" \
257 " msr basepri, %1 \n" \
258 " isb \n" \
259 " dsb \n" \
260 :"=r" (ulOriginalBASEPRI), "=r" (ulNewBASEPRI) : "i" ( configMAX_SYSCALL_INTERRUPT_PRIORITY )
261 );
262
263 /* This return will not be reached but is necessary to prevent compiler
264 warnings. */
265 return ulOriginalBASEPRI;
266 }
267 /*-----------------------------------------------------------*/
268
269 portFORCE_INLINE static void vPortSetBASEPRI( uint32_t ulNewMaskValue )
270 {
271 __asm volatile
272 (
273 " msr basepri, %0 " :: "r" ( ulNewMaskValue )
274 );
275 }
276 /*-----------------------------------------------------------*/
277
278
279 #ifdef __cplusplus
280 }
281 #endif
282
283 #endif /* PORTMACRO_H */
284