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 given hardware
42 * and compiler.
43 *
44 * These settings should not be altered.
45 *-----------------------------------------------------------
46 */
47
48 /* Type definitions. */
49 #define portCHAR char
50 #define portFLOAT float
51 #define portDOUBLE double
52 #define portLONG long
53 #define portSHORT short
54 #define portSTACK_TYPE uint32_t
55 #define portBASE_TYPE long
56
57 typedef portSTACK_TYPE StackType_t;
58 typedef long BaseType_t;
59 typedef unsigned long UBaseType_t;
60
61 typedef uint32_t TickType_t;
62 #define portMAX_DELAY ( TickType_t ) 0xffffffffUL
63
64 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
65 * not need to be guarded with a critical section. */
66 #define portTICK_TYPE_IS_ATOMIC 1
67
68 /*-----------------------------------------------------------*/
69
70 /* Hardware specifics. */
71 #define portSTACK_GROWTH ( -1 )
72 #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
73 #define portBYTE_ALIGNMENT 8
74
75 /*-----------------------------------------------------------*/
76
77 /* Task utilities. */
78
79 /* Called at the end of an ISR that can cause a context switch. */
80 #define portEND_SWITCHING_ISR( xSwitchRequired ) \
81 { \
82 extern volatile uint32_t ulPortYieldRequired; \
83 \
84 if( xSwitchRequired != pdFALSE ) \
85 { \
86 ulPortYieldRequired = pdTRUE; \
87 } \
88 }
89
90 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )
91 #define portYIELD() \
92 __asm volatile ( "SWI 0 \n" \
93 "ISB " ::: "memory" );
94
95
96 /*-----------------------------------------------------------
97 * Critical section control
98 *----------------------------------------------------------*/
99
100 extern void vPortEnterCritical( void );
101 extern void vPortExitCritical( void );
102 extern uint32_t ulPortSetInterruptMask( void );
103 extern void vPortClearInterruptMask( uint32_t ulNewMaskValue );
104 extern void vPortInstallFreeRTOSVectorTable( void );
105
106 /* The I bit within the CPSR. */
107 #define portINTERRUPT_ENABLE_BIT ( 1 << 7 )
108
109 /* In the absence of a priority mask register, these functions and macros
110 * globally enable and disable interrupts. */
111 #define portENTER_CRITICAL() vPortEnterCritical();
112 #define portEXIT_CRITICAL() vPortExitCritical();
113 #define portENABLE_INTERRUPTS() __asm volatile ( "CPSIE i \n" ::: "memory" );
114 #define portDISABLE_INTERRUPTS() \
115 __asm volatile ( "CPSID i \n" \
116 "DSB \n" \
117 "ISB " ::: "memory" );
118
portINLINE_SET_INTERRUPT_MASK_FROM_ISR(void)119 __attribute__( ( always_inline ) ) static __inline uint32_t portINLINE_SET_INTERRUPT_MASK_FROM_ISR( void )
120 {
121 volatile uint32_t ulCPSR;
122
123 __asm volatile ( "MRS %0, CPSR" : "=r" ( ulCPSR )::"memory" );
124
125 ulCPSR &= portINTERRUPT_ENABLE_BIT;
126 portDISABLE_INTERRUPTS();
127 return ulCPSR;
128 }
129
130 #define portSET_INTERRUPT_MASK_FROM_ISR() portINLINE_SET_INTERRUPT_MASK_FROM_ISR()
131 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x ) do { if( x == 0 ) portENABLE_INTERRUPTS( ); } while( 0 )
132
133 /*-----------------------------------------------------------*/
134
135 /* Task function macros as described on the FreeRTOS.org WEB site. These are
136 * not required for this port but included in case common demo code that uses these
137 * macros is used. */
138 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters )
139 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters )
140
141 /* Tickless idle/low power functionality. */
142 #ifndef portSUPPRESS_TICKS_AND_SLEEP
143 extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );
144 #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime )
145 #endif
146
147 /* Prototype of the FreeRTOS tick handler. This must be installed as the
148 * handler for whichever peripheral is used to generate the RTOS tick. */
149 void FreeRTOS_Tick_Handler( void );
150
151 /* Any task that uses the floating point unit MUST call vPortTaskUsesFPU()
152 * before any floating point instructions are executed. */
153 void vPortTaskUsesFPU( void );
154 #define portTASK_USES_FLOATING_POINT() vPortTaskUsesFPU()
155
156 #define portLOWEST_INTERRUPT_PRIORITY ( ( ( uint32_t ) configUNIQUE_INTERRUPT_PRIORITIES ) - 1UL )
157 #define portLOWEST_USABLE_INTERRUPT_PRIORITY ( portLOWEST_INTERRUPT_PRIORITY - 1UL )
158
159 /* Architecture specific optimisations. */
160 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
161 #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1
162 #endif
163
164 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1
165
166 /* Store/clear the ready priorities in a bit map. */
167 #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )
168 #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )
169
170 /*-----------------------------------------------------------*/
171
172 #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31UL - ( uint32_t ) __builtin_clz( uxReadyPriorities ) )
173
174 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
175
176 #define portNOP() __asm volatile ( "NOP" )
177 #define portINLINE __inline
178
179 #define portMEMORY_BARRIER() __asm volatile ( "" ::: "memory" )
180
181 /* *INDENT-OFF* */
182 #ifdef __cplusplus
183 }
184 #endif
185 /* *INDENT-ON* */
186
187 #endif /* PORTMACRO_H */
188
