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
30 #ifndef PORTMACRO_H
31 #define PORTMACRO_H
32
33 /* *INDENT-OFF* */
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 /* *INDENT-ON* */
38
39 /*-----------------------------------------------------------
40 * Port specific definitions.
41 *
42 * The settings in this file configure FreeRTOS correctly for the
43 * given hardware and compiler.
44 *
45 * These settings should not be altered.
46 *-----------------------------------------------------------
47 */
48
49 /* IAR includes. */
50 #include <intrinsics.h>
51
52 /* Type definitions. */
53 #define portCHAR char
54 #define portFLOAT float
55 #define portDOUBLE double
56 #define portLONG long
57 #define portSHORT short
58 #define portSTACK_TYPE uint32_t
59 #define portBASE_TYPE long
60
61 typedef portSTACK_TYPE StackType_t;
62 typedef long BaseType_t;
63 typedef unsigned long UBaseType_t;
64
65 #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
66 typedef uint16_t TickType_t;
67 #define portMAX_DELAY ( TickType_t ) 0xffff
68 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
69 typedef uint32_t TickType_t;
70 #define portMAX_DELAY ( TickType_t ) 0xffffffffUL
71
72 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
73 * not need to be guarded with a critical section. */
74 #define portTICK_TYPE_IS_ATOMIC 1
75 #else
76 #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
77 #endif
78 /*-----------------------------------------------------------*/
79
80 /* Architecture specifics. */
81 #define portSTACK_GROWTH ( -1 )
82 #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
83 #define portBYTE_ALIGNMENT 8
84 /*-----------------------------------------------------------*/
85
86 /* Compiler directives. */
87 #define portWEAK_SYMBOL __attribute__( ( weak ) )
88
89 /*-----------------------------------------------------------*/
90
91
92 /* Scheduler utilities. */
93 #define portYIELD() \
94 { \
95 /* Set a PendSV to request a context switch. */ \
96 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; \
97 __DSB(); \
98 __ISB(); \
99 }
100
101 #define portNVIC_INT_CTRL_REG ( *( ( volatile uint32_t * ) 0xe000ed04 ) )
102 #define portNVIC_PENDSVSET_BIT ( 1UL << 28UL )
103 #define portEND_SWITCHING_ISR( xSwitchRequired ) \
104 do \
105 { \
106 if( xSwitchRequired != pdFALSE ) \
107 { \
108 traceISR_EXIT_TO_SCHEDULER(); \
109 portYIELD(); \
110 } \
111 else \
112 { \
113 traceISR_EXIT(); \
114 } \
115 } while( 0 )
116 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )
117
118 /*-----------------------------------------------------------*/
119
120 /* Architecture specific optimisations. */
121 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
122 #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1
123 #endif
124
125 #if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 1 )
126
127 /* Check the configuration. */
128 #if ( configMAX_PRIORITIES > 32 )
129 #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.
130 #endif
131
132 /* Store/clear the ready priorities in a bit map. */
133 #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )
134 #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )
135
136 /*-----------------------------------------------------------*/
137
138 #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31UL - ( ( uint32_t ) __CLZ( ( uxReadyPriorities ) ) ) )
139
140 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
141 /*-----------------------------------------------------------*/
142
143 /* Critical section management. */
144 extern void vPortEnterCritical( void );
145 extern void vPortExitCritical( void );
146
147 #define portDISABLE_INTERRUPTS() \
148 { \
149 __set_BASEPRI( configMAX_SYSCALL_INTERRUPT_PRIORITY ); \
150 __DSB(); \
151 __ISB(); \
152 }
153
154 #define portENABLE_INTERRUPTS() __set_BASEPRI( 0 )
155 #define portENTER_CRITICAL() vPortEnterCritical()
156 #define portEXIT_CRITICAL() vPortExitCritical()
157 #define portSET_INTERRUPT_MASK_FROM_ISR() __get_BASEPRI(); portDISABLE_INTERRUPTS()
158 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x ) __set_BASEPRI( x )
159 /*-----------------------------------------------------------*/
160
161 /* Tickless idle/low power functionality. */
162 #ifndef portSUPPRESS_TICKS_AND_SLEEP
163 extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );
164 #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime )
165 #endif
166
167 /*-----------------------------------------------------------*/
168
169 /* Task function macros as described on the FreeRTOS.org WEB site. These are
170 * not necessary for to use this port. They are defined so the common demo files
171 * (which build with all the ports) will build. */
172 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters )
173 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters )
174 /*-----------------------------------------------------------*/
175
176 #ifdef configASSERT
177 void vPortValidateInterruptPriority( void );
178 #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() vPortValidateInterruptPriority()
179 #endif
180
181 /* portNOP() is not required by this port. */
182 #define portNOP()
183
184 #define portINLINE __inline
185
186 #ifndef portFORCE_INLINE
187 #define portFORCE_INLINE inline __attribute__( ( always_inline ) )
188 #endif
189
190 /*-----------------------------------------------------------*/
191
xPortIsInsideInterrupt(void)192 portFORCE_INLINE static BaseType_t xPortIsInsideInterrupt( void )
193 {
194 uint32_t ulCurrentInterrupt;
195 BaseType_t xReturn;
196
197 /* Obtain the number of the currently executing interrupt. */
198 __asm volatile ( "mrs %0, ipsr" : "=r" ( ulCurrentInterrupt )::"memory" );
199
200 if( ulCurrentInterrupt == 0 )
201 {
202 xReturn = pdFALSE;
203 }
204 else
205 {
206 xReturn = pdTRUE;
207 }
208
209 return xReturn;
210 }
211
212 /*-----------------------------------------------------------*/
213
214 /* Suppress warnings that are generated by the IAR tools, but cannot be fixed in
215 * the source code because to do so would cause other compilers to generate
216 * warnings. */
217 #pragma diag_suppress=Pe191
218 #pragma diag_suppress=Pa082
219
220 /* *INDENT-OFF* */
221 #ifdef __cplusplus
222 }
223 #endif
224 /* *INDENT-ON* */
225
226 #endif /* PORTMACRO_H */
227
