xref: /Kernel-v10.6.2/portable/GCC/STR75x/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 
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 #else
69     #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
70 #endif
71 /*-----------------------------------------------------------*/
72 
73 /* Hardware specifics. */
74 #define portSTACK_GROWTH            ( -1 )
75 #define portTICK_PERIOD_MS          ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
76 #define portBYTE_ALIGNMENT          8
77 #define portYIELD()                 asm volatile ( "SWI 0" )
78 #define portNOP()                   asm volatile ( "NOP" )
79 /*-----------------------------------------------------------*/
80 
81 /* Critical section handling. */
82 /*
83  * The interrupt management utilities can only be called from ARM mode.  When
84  * THUMB_INTERWORK is defined the utilities are defined as functions in
85  * portISR.c to ensure a switch to ARM mode.  When THUMB_INTERWORK is not
86  * defined then the utilities are defined as macros here - as per other ports.
87  */
88 
89 #ifdef THUMB_INTERWORK
90 
91     extern void vPortDisableInterruptsFromThumb( void ) __attribute__ ((naked));
92     extern void vPortEnableInterruptsFromThumb( void ) __attribute__ ((naked));
93 
94     #define portDISABLE_INTERRUPTS()    vPortDisableInterruptsFromThumb()
95     #define portENABLE_INTERRUPTS()     vPortEnableInterruptsFromThumb()
96 
97 #else
98 
99     #define portDISABLE_INTERRUPTS()                                            \
100         asm volatile (                                                          \
101             "STMDB  SP!, {R0}       \n\t"   /* Push R0.                     */  \
102             "MRS    R0, CPSR        \n\t"   /* Get CPSR.                    */  \
103             "ORR    R0, R0, #0xC0   \n\t"   /* Disable IRQ, FIQ.            */  \
104             "MSR    CPSR, R0        \n\t"   /* Write back modified value.   */  \
105             "LDMIA  SP!, {R0}           " ) /* Pop R0.                      */
106 
107     #define portENABLE_INTERRUPTS()                                             \
108         asm volatile (                                                          \
109             "STMDB  SP!, {R0}       \n\t"   /* Push R0.                     */  \
110             "MRS    R0, CPSR        \n\t"   /* Get CPSR.                    */  \
111             "BIC    R0, R0, #0xC0   \n\t"   /* Enable IRQ, FIQ.             */  \
112             "MSR    CPSR, R0        \n\t"   /* Write back modified value.   */  \
113             "LDMIA  SP!, {R0}           " ) /* Pop R0.                      */
114 
115 #endif /* THUMB_INTERWORK */
116 
117 extern void vPortEnterCritical( void );
118 extern void vPortExitCritical( void );
119 
120 #define portENTER_CRITICAL()        vPortEnterCritical();
121 #define portEXIT_CRITICAL()         vPortExitCritical();
122 /*-----------------------------------------------------------*/
123 
124 /* Task utilities. */
125 #define portEND_SWITCHING_ISR( xSwitchRequired )    \
126 {                                                   \
127 extern void vTaskSwitchContext( void );             \
128                                                     \
129     if( xSwitchRequired )                           \
130     {                                               \
131         vTaskSwitchContext();                       \
132     }                                               \
133 }
134 /*-----------------------------------------------------------*/
135 
136 /* Task function macros as described on the FreeRTOS.org WEB site. */
137 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters )
138 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters )
139 
140 /* *INDENT-OFF* */
141 #ifdef __cplusplus
142     }
143 #endif
144 /* *INDENT-ON* */
145 
146 #endif /* PORTMACRO_H */
147