xref: /Kernel-v10.6.2/portable/GCC/H8S2329/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  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()        asm volatile( "STC  CCR, @-ER7" ); \
87                                     portDISABLE_INTERRUPTS();
88 
89 /* Pop the CCR to set the interrupt masking back to its previous state. */
90 #define  portEXIT_CRITICAL()        asm volatile( "LDC  @ER7+, CCR" );
91 /*-----------------------------------------------------------*/
92 
93 /* Task utilities. */
94 
95 /* Context switch macros.  These macros are very simple as the context
96 is saved simply by selecting the saveall attribute of the context switch
97 interrupt service routines.  These macros save and restore the stack
98 pointer to the TCB. */
99 
100 #define portSAVE_STACK_POINTER()                                \
101 extern void* pxCurrentTCB;                                      \
102                                                                 \
103     asm volatile(                                               \
104                     "MOV.L  @_pxCurrentTCB, ER5         \n\t"   \
105                     "MOV.L  ER7, @ER5                   \n\t"   \
106                 );                                              \
107     ( void ) pxCurrentTCB;
108 
109 
110 #define portRESTORE_STACK_POINTER()                             \
111 extern void* pxCurrentTCB;                                      \
112                                                                 \
113     asm volatile(                                               \
114                     "MOV.L  @_pxCurrentTCB, ER5         \n\t"   \
115                     "MOV.L  @ER5, ER7                   \n\t"   \
116                 );                                              \
117     ( void ) pxCurrentTCB;
118 
119 /*-----------------------------------------------------------*/
120 
121 /* Macros to allow a context switch from within an application ISR. */
122 
123 #define portENTER_SWITCHING_ISR() portSAVE_STACK_POINTER(); {
124 
125 #define portEXIT_SWITCHING_ISR( x )                         \
126     if( x )                                                 \
127     {                                                       \
128         extern void vTaskSwitchContext( void );             \
129         vTaskSwitchContext();                               \
130     }                                                       \
131     } portRESTORE_STACK_POINTER();
132 /*-----------------------------------------------------------*/
133 
134 /* Task function macros as described on the FreeRTOS.org WEB site. */
135 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
136 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
137 
138 /* *INDENT-OFF* */
139 #ifdef __cplusplus
140     }
141 #endif
142 /* *INDENT-ON* */
143 
144 #endif /* PORTMACRO_H */
145