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 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() __asm volatile ( "SWI 0 \n" \
92 "ISB " ::: "memory" );
93
94
95 /*-----------------------------------------------------------
96 * Critical section control
97 *----------------------------------------------------------*/
98
99 extern void vPortEnterCritical( void );
100 extern void vPortExitCritical( void );
101 extern uint32_t ulPortSetInterruptMask( void );
102 extern void vPortClearInterruptMask( uint32_t ulNewMaskValue );
103 extern void vPortInstallFreeRTOSVectorTable( void );
104
105 /* The I bit within the CPSR. */
106 #define portINTERRUPT_ENABLE_BIT ( 1 << 7 )
107
108 /* In the absence of a priority mask register, these functions and macros
109 globally enable and disable interrupts. */
110 #define portENTER_CRITICAL() vPortEnterCritical();
111 #define portEXIT_CRITICAL() vPortExitCritical();
112 #define portENABLE_INTERRUPTS() __asm volatile ( "CPSIE i \n" ::: "memory" );
113 #define portDISABLE_INTERRUPTS() __asm volatile ( "CPSID i \n" \
114 "DSB \n" \
115 "ISB " ::: "memory" );
116
portINLINE_SET_INTERRUPT_MASK_FROM_ISR(void)117 __attribute__( ( always_inline ) ) static __inline uint32_t portINLINE_SET_INTERRUPT_MASK_FROM_ISR( void )
118 {
119 volatile uint32_t ulCPSR;
120
121 __asm volatile ( "MRS %0, CPSR" : "=r" (ulCPSR) :: "memory" );
122 ulCPSR &= portINTERRUPT_ENABLE_BIT;
123 portDISABLE_INTERRUPTS();
124 return ulCPSR;
125 }
126
127 #define portSET_INTERRUPT_MASK_FROM_ISR() portINLINE_SET_INTERRUPT_MASK_FROM_ISR()
128 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x) do { if( x == 0 ) portENABLE_INTERRUPTS(); } while( 0 )
129
130 /*-----------------------------------------------------------*/
131
132 /* Task function macros as described on the FreeRTOS.org WEB site. These are
133 not required for this port but included in case common demo code that uses these
134 macros is used. */
135 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
136 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
137
138 /* Tickless idle/low power functionality. */
139 #ifndef portSUPPRESS_TICKS_AND_SLEEP
140 extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );
141 #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime )
142 #endif
143
144 /* Prototype of the FreeRTOS tick handler. This must be installed as the
145 handler for whichever peripheral is used to generate the RTOS tick. */
146 void FreeRTOS_Tick_Handler( void );
147
148 /* Any task that uses the floating point unit MUST call vPortTaskUsesFPU()
149 before any floating point instructions are executed. */
150 void vPortTaskUsesFPU( void );
151 #define portTASK_USES_FLOATING_POINT() vPortTaskUsesFPU()
152
153 #define portLOWEST_INTERRUPT_PRIORITY ( ( ( uint32_t ) configUNIQUE_INTERRUPT_PRIORITIES ) - 1UL )
154 #define portLOWEST_USABLE_INTERRUPT_PRIORITY ( portLOWEST_INTERRUPT_PRIORITY - 1UL )
155
156 /* Architecture specific optimisations. */
157 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
158 #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1
159 #endif
160
161 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1
162
163 /* Store/clear the ready priorities in a bit map. */
164 #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )
165 #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )
166
167 /*-----------------------------------------------------------*/
168
169 #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31UL - ( uint32_t ) __builtin_clz( uxReadyPriorities ) )
170
171 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
172
173 #define portNOP() __asm volatile( "NOP" )
174 #define portINLINE __inline
175
176 #define portMEMORY_BARRIER() __asm volatile( "" ::: "memory" )
177
178 /* *INDENT-OFF* */
179 #ifdef __cplusplus
180 }
181 #endif
182 /* *INDENT-ON* */
183
184 #endif /* PORTMACRO_H */
185
