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 
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    uint8_t
56 #define portBASE_TYPE     char
57 
58 typedef portSTACK_TYPE   StackType_t;
59 typedef signed char      BaseType_t;
60 typedef unsigned char    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 portBYTE_ALIGNMENT    2
75 #define portSTACK_GROWTH      ( -1 )
76 #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
77 #define portYIELD()    asm volatile ( "TRAPA #0" )
78 #define portNOP()      asm volatile ( "NOP" )
79 /*-----------------------------------------------------------*/
80 
81 /* Critical section handling. */
82 #define portENABLE_INTERRUPTS()     asm volatile ( "ANDC #0x7F, CCR" );
83 #define portDISABLE_INTERRUPTS()    asm volatile ( "ORC  #0x80, CCR" );
84 
85 /* Push the CCR then disable interrupts. */
86 #define portENTER_CRITICAL()            \
87     asm volatile ( "STC  CCR, @-ER7" ); \
88     portDISABLE_INTERRUPTS();
89 
90 /* Pop the CCR to set the interrupt masking back to its previous state. */
91 #define  portEXIT_CRITICAL()    asm volatile ( "LDC  @ER7+, CCR" );
92 /*-----------------------------------------------------------*/
93 
94 /* Task utilities. */
95 
96 /* Context switch macros.  These macros are very simple as the context
97  * is saved simply by selecting the saveall attribute of the context switch
98  * interrupt service routines.  These macros save and restore the stack
99  * pointer to the TCB. */
100 
101 #define portSAVE_STACK_POINTER()                  \
102     extern void * pxCurrentTCB;                   \
103                                                   \
104     asm volatile (                                \
105         "MOV.L  @_pxCurrentTCB, ER5         \n\t" \
106         "MOV.L  ER7, @ER5                   \n\t" \
107         );                                        \
108     ( void ) pxCurrentTCB;
109 
110 
111 #define portRESTORE_STACK_POINTER()               \
112     extern void * pxCurrentTCB;                   \
113                                                   \
114     asm volatile (                                \
115         "MOV.L  @_pxCurrentTCB, ER5         \n\t" \
116         "MOV.L  @ER5, ER7                   \n\t" \
117         );                                        \
118     ( void ) pxCurrentTCB;
119 
120 /*-----------------------------------------------------------*/
121 
122 /* Macros to allow a context switch from within an application ISR. */
123 
124 #define portENTER_SWITCHING_ISR()    portSAVE_STACK_POINTER(); {
125 #define portEXIT_SWITCHING_ISR( x )             \
126     if( x )                                     \
127     {                                           \
128         extern void vTaskSwitchContext( void ); \
129         vTaskSwitchContext();                   \
130     }                                           \
131 }                                               \
132     portRESTORE_STACK_POINTER();
133 /*-----------------------------------------------------------*/
134 
135 /* Task function macros as described on the FreeRTOS.org WEB site. */
136 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
137 #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
138 
139 /* *INDENT-OFF* */
140 #ifdef __cplusplus
141     }
142 #endif
143 /* *INDENT-ON* */
144 
145 #endif /* PORTMACRO_H */
146