1 /*
2 * FreeRTOS Kernel V11.1.0
3 * Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
4 *
5 * SPDX-License-Identifier: MIT
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy of
8 * this software and associated documentation files (the "Software"), to deal in
9 * the Software without restriction, including without limitation the rights to
10 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
11 * the Software, and to permit persons to whom the Software is furnished to do so,
12 * subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in all
15 * copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
19 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
20 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
21 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 *
24 * https://www.FreeRTOS.org
25 * https://github.com/FreeRTOS
26 *
27 */
28
29 #ifndef PORTMACRO_H
30 #define PORTMACRO_H
31
32 /* *INDENT-OFF* */
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 /* *INDENT-ON* */
37
38 /*-----------------------------------------------------------
39 * Port specific definitions.
40 *
41 * The settings in this file configure FreeRTOS correctly for the
42 * given hardware and compiler.
43 *
44 * These settings should not be altered.
45 *-----------------------------------------------------------
46 */
47
48 /* IAR includes. */
49 #include <intrinsics.h>
50
51 /* Type definitions. */
52 #define portCHAR char
53 #define portFLOAT float
54 #define portDOUBLE double
55 #define portLONG long
56 #define portSHORT short
57 #define portSTACK_TYPE uint32_t
58 #define portBASE_TYPE long
59
60 typedef portSTACK_TYPE StackType_t;
61 typedef long BaseType_t;
62 typedef unsigned long UBaseType_t;
63
64 #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
65 typedef uint16_t TickType_t;
66 #define portMAX_DELAY ( TickType_t ) 0xffff
67 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
68 typedef uint32_t TickType_t;
69 #define portMAX_DELAY ( TickType_t ) 0xffffffffUL
70
71 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
72 * not need to be guarded with a critical section. */
73 #define portTICK_TYPE_IS_ATOMIC 1
74 #else
75 #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
76 #endif
77 /*-----------------------------------------------------------*/
78
79 /* Architecture specifics. */
80 #define portSTACK_GROWTH ( -1 )
81 #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
82 #define portBYTE_ALIGNMENT 8
83 /*-----------------------------------------------------------*/
84
85 /* Compiler directives. */
86 #define portWEAK_SYMBOL __attribute__( ( weak ) )
87
88 /*-----------------------------------------------------------*/
89
90
91 /* Scheduler utilities. */
92 #define portYIELD() \
93 { \
94 /* Set a PendSV to request a context switch. */ \
95 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; \
96 __DSB(); \
97 __ISB(); \
98 }
99
100 #define portNVIC_INT_CTRL_REG ( *( ( volatile uint32_t * ) 0xe000ed04 ) )
101 #define portNVIC_PENDSVSET_BIT ( 1UL << 28UL )
102 #define portEND_SWITCHING_ISR( xSwitchRequired ) \
103 do \
104 { \
105 if( xSwitchRequired != pdFALSE ) \
106 { \
107 traceISR_EXIT_TO_SCHEDULER(); \
108 portYIELD(); \
109 } \
110 else \
111 { \
112 traceISR_EXIT(); \
113 } \
114 } while( 0 )
115 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )
116
117 /*-----------------------------------------------------------*/
118
119 /* Architecture specific optimisations. */
120 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
121 #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1
122 #endif
123
124 #if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 1 )
125
126 /* Check the configuration. */
127 #if ( configMAX_PRIORITIES > 32 )
128 #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.
129 #endif
130
131 /* Store/clear the ready priorities in a bit map. */
132 #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )
133 #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )
134
135 /*-----------------------------------------------------------*/
136
137 #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31UL - ( ( uint32_t ) __CLZ( ( uxReadyPriorities ) ) ) )
138
139 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
140 /*-----------------------------------------------------------*/
141
142 /* Critical section management. */
143 extern void vPortEnterCritical( void );
144 extern void vPortExitCritical( void );
145
146 #define portDISABLE_INTERRUPTS() \
147 { \
148 /* Errata work around. */ \
149 __disable_interrupt(); \
150 __set_BASEPRI( configMAX_SYSCALL_INTERRUPT_PRIORITY ); \
151 __DSB(); \
152 __ISB(); \
153 __enable_interrupt(); \
154 }
155
156 #define portENABLE_INTERRUPTS() __set_BASEPRI( 0 )
157 #define portENTER_CRITICAL() vPortEnterCritical()
158 #define portEXIT_CRITICAL() vPortExitCritical()
159 #define portSET_INTERRUPT_MASK_FROM_ISR() __get_BASEPRI(); portDISABLE_INTERRUPTS()
160 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x ) __set_BASEPRI( x )
161 /*-----------------------------------------------------------*/
162
163 /* Tickless idle/low power functionality. */
164 #ifndef portSUPPRESS_TICKS_AND_SLEEP
165 extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );
166 #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime )
167 #endif
168
169 /*-----------------------------------------------------------*/
170
171 /* Task function macros as described on the FreeRTOS.org WEB site. These are
172 * not necessary for to use this port. They are defined so the common demo files
173 * (which build with all the ports) will build. */
174 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters )
175 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters )
176 /*-----------------------------------------------------------*/
177
178 #ifdef configASSERT
179 void vPortValidateInterruptPriority( void );
180 #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() vPortValidateInterruptPriority()
181 #endif
182
183 /* portNOP() is not required by this port. */
184 #define portNOP()
185
186 #define portINLINE __inline
187
188 #ifndef portFORCE_INLINE
189 #define portFORCE_INLINE inline __attribute__( ( always_inline ) )
190 #endif
191
192 /*-----------------------------------------------------------*/
193
xPortIsInsideInterrupt(void)194 portFORCE_INLINE static BaseType_t xPortIsInsideInterrupt( void )
195 {
196 uint32_t ulCurrentInterrupt;
197 BaseType_t xReturn;
198
199 /* Obtain the number of the currently executing interrupt. */
200 __asm volatile ( "mrs %0, ipsr" : "=r" ( ulCurrentInterrupt )::"memory" );
201
202 if( ulCurrentInterrupt == 0 )
203 {
204 xReturn = pdFALSE;
205 }
206 else
207 {
208 xReturn = pdTRUE;
209 }
210
211 return xReturn;
212 }
213
214 /*-----------------------------------------------------------*/
215
216 /* Suppress warnings that are generated by the IAR tools, but cannot be fixed in
217 * the source code because to do so would cause other compilers to generate
218 * warnings. */
219 #pragma diag_suppress=Pe191
220 #pragma diag_suppress=Pa082
221
222 /* *INDENT-OFF* */
223 #ifdef __cplusplus
224 }
225 #endif
226 /* *INDENT-ON* */
227
228 #endif /* PORTMACRO_H */
229
