xref: /Kernel-v10.6.2/portable/IAR/ARM_CM7/r0p1/portmacro.h (revision ef7b253b56c9788077f5ecd6c9deb4021923d646) 
1 /*
2  * FreeRTOS Kernel V10.6.2
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 )    do { if( xSwitchRequired != pdFALSE ) portYIELD(); } while( 0 )
103     #define portYIELD_FROM_ISR( x )                     portEND_SWITCHING_ISR( x )
104 
105 /*-----------------------------------------------------------*/
106 
107 /* Architecture specific optimisations. */
108     #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
109         #define configUSE_PORT_OPTIMISED_TASK_SELECTION    1
110     #endif
111 
112     #if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 1 )
113 
114 /* Check the configuration. */
115         #if ( configMAX_PRIORITIES > 32 )
116             #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.
117         #endif
118 
119 /* Store/clear the ready priorities in a bit map. */
120         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities )    ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )
121         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities )     ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )
122 
123 /*-----------------------------------------------------------*/
124 
125         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities )    uxTopPriority = ( 31UL - ( ( uint32_t ) __CLZ( ( uxReadyPriorities ) ) ) )
126 
127     #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
128 /*-----------------------------------------------------------*/
129 
130 /* Critical section management. */
131     extern void vPortEnterCritical( void );
132     extern void vPortExitCritical( void );
133 
134     #define portDISABLE_INTERRUPTS()                           \
135     {                                                          \
136         /* Errata work around. */                              \
137         __disable_interrupt();                                 \
138         __set_BASEPRI( configMAX_SYSCALL_INTERRUPT_PRIORITY ); \
139         __DSB();                                               \
140         __ISB();                                               \
141         __enable_interrupt();                                  \
142     }
143 
144     #define portENABLE_INTERRUPTS()                   __set_BASEPRI( 0 )
145     #define portENTER_CRITICAL()                      vPortEnterCritical()
146     #define portEXIT_CRITICAL()                       vPortExitCritical()
147     #define portSET_INTERRUPT_MASK_FROM_ISR()         __get_BASEPRI(); portDISABLE_INTERRUPTS()
148     #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x )    __set_BASEPRI( x )
149 /*-----------------------------------------------------------*/
150 
151 /* Tickless idle/low power functionality. */
152     #ifndef portSUPPRESS_TICKS_AND_SLEEP
153         extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );
154         #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime )    vPortSuppressTicksAndSleep( xExpectedIdleTime )
155     #endif
156 
157 /*-----------------------------------------------------------*/
158 
159 /* Task function macros as described on the FreeRTOS.org WEB site.  These are
160  * not necessary for to use this port.  They are defined so the common demo files
161  * (which build with all the ports) will build. */
162     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
163     #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
164 /*-----------------------------------------------------------*/
165 
166     #ifdef configASSERT
167         void vPortValidateInterruptPriority( void );
168         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()    vPortValidateInterruptPriority()
169     #endif
170 
171 /* portNOP() is not required by this port. */
172     #define portNOP()
173 
174     #define portINLINE              __inline
175 
176     #ifndef portFORCE_INLINE
177         #define portFORCE_INLINE    inline __attribute__( ( always_inline ) )
178     #endif
179 
180 /*-----------------------------------------------------------*/
181 
xPortIsInsideInterrupt(void)182     portFORCE_INLINE static BaseType_t xPortIsInsideInterrupt( void )
183     {
184         uint32_t ulCurrentInterrupt;
185         BaseType_t xReturn;
186 
187         /* Obtain the number of the currently executing interrupt. */
188         __asm volatile ( "mrs %0, ipsr" : "=r" ( ulCurrentInterrupt )::"memory" );
189 
190         if( ulCurrentInterrupt == 0 )
191         {
192             xReturn = pdFALSE;
193         }
194         else
195         {
196             xReturn = pdTRUE;
197         }
198 
199         return xReturn;
200     }
201 
202 /*-----------------------------------------------------------*/
203 
204 /* Suppress warnings that are generated by the IAR tools, but cannot be fixed in
205  * the source code because to do so would cause other compilers to generate
206  * warnings. */
207     #pragma diag_suppress=Pe191
208     #pragma diag_suppress=Pa082
209 
210 /* *INDENT-OFF* */
211 #ifdef __cplusplus
212     }
213 #endif
214 /* *INDENT-ON* */
215 
216 #endif /* PORTMACRO_H */
217