xref: /Kernel-v10.6.2/portable/IAR/ARM_CA5_No_GIC/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 /* IAR includes. */
39 #ifdef __ICCARM__
40 
41     #include <intrinsics.h>
42 
43 
44 
45     /*-----------------------------------------------------------
46      * Port specific definitions.
47      *
48      * The settings in this file configure FreeRTOS correctly for the given hardware
49      * and compiler.
50      *
51      * These settings should not be altered.
52      *-----------------------------------------------------------
53      */
54 
55     /* Type definitions. */
56     #define portCHAR        char
57     #define portFLOAT       float
58     #define portDOUBLE      double
59     #define portLONG        long
60     #define portSHORT       short
61     #define portSTACK_TYPE  uint32_t
62     #define portBASE_TYPE   long
63 
64     typedef portSTACK_TYPE StackType_t;
65     typedef long BaseType_t;
66     typedef unsigned long UBaseType_t;
67 
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 
75     /*-----------------------------------------------------------*/
76 
77     /* Hardware specifics. */
78     #define portSTACK_GROWTH            ( -1 )
79     #define portTICK_PERIOD_MS          ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
80     #define portBYTE_ALIGNMENT          8
81 
82     /*-----------------------------------------------------------*/
83 
84     /* Task utilities. */
85 
86     /* Called at the end of an ISR that can cause a context switch. */
87     #define portEND_SWITCHING_ISR( xSwitchRequired )\
88     {                                               \
89     extern uint32_t ulPortYieldRequired;            \
90                                                     \
91         if( xSwitchRequired != pdFALSE )            \
92         {                                           \
93             ulPortYieldRequired = pdTRUE;           \
94         }                                           \
95     }
96 
97     #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )
98     #define portYIELD() __asm volatile ( "SWI 0" ); __ISB()
99 
100 
101     /*-----------------------------------------------------------
102      * Critical section control
103      *----------------------------------------------------------*/
104 
105     extern void vPortEnterCritical( void );
106     extern void vPortExitCritical( void );
107     extern uint32_t ulPortSetInterruptMask( void );
108     extern void vPortClearInterruptMask( uint32_t ulNewMaskValue );
109 
110     #define portENTER_CRITICAL()        vPortEnterCritical();
111     #define portEXIT_CRITICAL()         vPortExitCritical();
112     #define portDISABLE_INTERRUPTS()    __disable_irq(); __DSB(); __ISB() /* No priority mask register so global disable is used. */
113     #define portENABLE_INTERRUPTS()     __enable_irq()
114     #define portSET_INTERRUPT_MASK_FROM_ISR()       __get_interrupt_state(); __disable_irq() /* No priority mask register so global disable is used. */
115     #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    __set_interrupt_state(x)
116 
117     /*-----------------------------------------------------------*/
118 
119     /* Task function macros as described on the FreeRTOS.org WEB site.  These are
120     not required for this port but included in case common demo code that uses these
121     macros is used. */
122     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )  void vFunction( void *pvParameters )
123     #define portTASK_FUNCTION( vFunction, pvParameters )    void vFunction( void *pvParameters )
124 
125     /* Prototype of the FreeRTOS tick handler.  This must be installed as the
126     handler for whichever peripheral is used to generate the RTOS tick. */
127     void FreeRTOS_Tick_Handler( void );
128 
129     /* Any task that uses the floating point unit MUST call vPortTaskUsesFPU()
130     before any floating point instructions are executed. */
131     void vPortTaskUsesFPU( void );
132     #define portTASK_USES_FLOATING_POINT() vPortTaskUsesFPU()
133 
134     /* Architecture specific optimisations. */
135     #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
136         #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1
137     #endif
138 
139     #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1
140 
141         /* Store/clear the ready priorities in a bit map. */
142         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )
143         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )
144 
145         /*-----------------------------------------------------------*/
146 
147         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31 - __CLZ( uxReadyPriorities ) )
148 
149     #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
150 
151     #define portNOP() __asm volatile( "NOP" )
152 
153     /* Suppress warnings that are generated by the IAR tools, but cannot be
154     fixed in the source code because to do so would cause other compilers to
155     generate warnings. */
156     #pragma diag_suppress=Pe191
157     #pragma diag_suppress=Pa082
158 
159 #endif /* __ICCARM__ */
160 
161 /* *INDENT-OFF* */
162 #ifdef __cplusplus
163     }
164 #endif
165 /* *INDENT-ON* */
166 
167 #endif /* PORTMACRO_H */
168