1 /*
2 * FreeRTOS Kernel V11.0.1
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 /* Type definitions. */
50 #define portCHAR char
51 #define portFLOAT float
52 #define portDOUBLE double
53 #define portLONG long
54 #define portSHORT short
55 #define portSTACK_TYPE uint32_t
56 #define portBASE_TYPE long
57
58 typedef portSTACK_TYPE StackType_t;
59 typedef long BaseType_t;
60 typedef unsigned long UBaseType_t;
61
62 #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
63 typedef uint16_t TickType_t;
64 #define portMAX_DELAY ( TickType_t ) 0xffff
65 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
66 typedef uint32_t TickType_t;
67 #define portMAX_DELAY ( TickType_t ) 0xffffffffUL
68
69 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
70 * not need to be guarded with a critical section. */
71 #define portTICK_TYPE_IS_ATOMIC 1
72 #else
73 #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
74 #endif
75 /*-----------------------------------------------------------*/
76
77 /* Architecture specifics. */
78 #define portSTACK_GROWTH ( -1 )
79 #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
80 #define portBYTE_ALIGNMENT 8
81 #define portDONT_DISCARD __attribute__( ( used ) )
82 /*-----------------------------------------------------------*/
83
84
85 /* Scheduler utilities. */
86 extern void vPortYield( void );
87 #define portNVIC_INT_CTRL_REG ( *( ( volatile uint32_t * ) 0xe000ed04 ) )
88 #define portNVIC_PENDSVSET_BIT ( 1UL << 28UL )
89 #define portYIELD() vPortYield()
90 #define portEND_SWITCHING_ISR( xSwitchRequired ) \
91 do \
92 { \
93 if( xSwitchRequired ) \
94 { \
95 traceISR_EXIT_TO_SCHEDULER(); \
96 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; \
97 } \
98 else \
99 { \
100 traceISR_EXIT(); \
101 } \
102 } while( 0 )
103 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )
104 /*-----------------------------------------------------------*/
105
106
107 /* Critical section management. */
108 extern void vPortEnterCritical( void );
109 extern void vPortExitCritical( void );
110 extern uint32_t ulSetInterruptMaskFromISR( void ) __attribute__( ( naked ) );
111 extern void vClearInterruptMaskFromISR( uint32_t ulMask ) __attribute__( ( naked ) );
112
113 #define portSET_INTERRUPT_MASK_FROM_ISR() ulSetInterruptMaskFromISR()
114 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x ) vClearInterruptMaskFromISR( x )
115 #define portDISABLE_INTERRUPTS() __asm volatile ( " cpsid i " ::: "memory" )
116 #define portENABLE_INTERRUPTS() __asm volatile ( " cpsie i " ::: "memory" )
117 #define portENTER_CRITICAL() vPortEnterCritical()
118 #define portEXIT_CRITICAL() vPortExitCritical()
119
120 /*-----------------------------------------------------------*/
121
122 /* Tickless idle/low power functionality. */
123 #ifndef portSUPPRESS_TICKS_AND_SLEEP
124 extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );
125 #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime )
126 #endif
127 /*-----------------------------------------------------------*/
128
129 /* Task function macros as described on the FreeRTOS.org WEB site. */
130 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters )
131 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters )
132
133 #define portNOP()
134
135 #define portMEMORY_BARRIER() __asm volatile ( "" ::: "memory" )
136
137
138 #define portINLINE __inline
139
140 #ifndef portFORCE_INLINE
141 #define portFORCE_INLINE inline __attribute__( ( always_inline ) )
142 #endif
143
144 /*-----------------------------------------------------------*/
145
xPortIsInsideInterrupt(void)146 portFORCE_INLINE static BaseType_t xPortIsInsideInterrupt( void )
147 {
148 uint32_t ulCurrentInterrupt;
149 BaseType_t xReturn;
150
151 /* Obtain the number of the currently executing interrupt. */
152 __asm volatile ( "mrs %0, ipsr" : "=r" ( ulCurrentInterrupt )::"memory" );
153
154 if( ulCurrentInterrupt == 0 )
155 {
156 xReturn = pdFALSE;
157 }
158 else
159 {
160 xReturn = pdTRUE;
161 }
162
163 return xReturn;
164 }
165
166 /*-----------------------------------------------------------*/
167
168 /* *INDENT-OFF* */
169 #ifdef __cplusplus
170 }
171 #endif
172 /* *INDENT-ON* */
173
174 #endif /* PORTMACRO_H */
175
