xref: /Kernel-v10.6.2/portable/GCC/RX600/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 /* When the FIT configurator or the Smart Configurator is used, platform.h has to be
50  * used. */
51 #ifndef configINCLUDE_PLATFORM_H_INSTEAD_OF_IODEFINE_H
52     #define configINCLUDE_PLATFORM_H_INSTEAD_OF_IODEFINE_H 0
53 #endif
54 
55 /* Type definitions - these are a bit legacy and not really used now, other than
56 portSTACK_TYPE and portBASE_TYPE. */
57 #define portCHAR        char
58 #define portFLOAT       float
59 #define portDOUBLE      double
60 #define portLONG        long
61 #define portSHORT       short
62 #define portSTACK_TYPE  uint32_t
63 #define portBASE_TYPE   long
64 
65 typedef portSTACK_TYPE StackType_t;
66 typedef long BaseType_t;
67 typedef unsigned long UBaseType_t;
68 
69 #if( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
70     typedef uint16_t TickType_t;
71     #define portMAX_DELAY ( TickType_t ) 0xffff
72 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
73     typedef uint32_t TickType_t;
74     #define portMAX_DELAY ( TickType_t ) 0xffffffffUL
75 
76     /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
77     not need to be guarded with a critical section. */
78     #define portTICK_TYPE_IS_ATOMIC 1
79 #else
80     #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
81 #endif
82 /*-----------------------------------------------------------*/
83 
84 /* Hardware specifics. */
85 #define portBYTE_ALIGNMENT          8   /* Could make four, according to manual. */
86 #define portSTACK_GROWTH            -1
87 #define portTICK_PERIOD_MS          ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
88 #define portNOP()                   __asm volatile( "NOP" )
89 
90 /* Yield equivalent to "*portITU_SWINTR = 0x01; ( void ) *portITU_SWINTR;"
91 where portITU_SWINTR is the location of the software interrupt register
92 (0x000872E0).  Don't rely on the assembler to select a register, so instead
93 save and restore clobbered registers manually. */
94 #define portYIELD()                         \
95     __asm volatile                          \
96     (                                       \
97         "PUSH.L R10                 \n"     \
98         "MOV.L  #0x872E0, R10       \n"     \
99         "MOV.B  #0x1, [R10]         \n"     \
100         "MOV.L  [R10], R10          \n"     \
101         "POP    R10                 \n"     \
102     )
103 
104 #define portYIELD_FROM_ISR( x ) do { if( x != pdFALSE ) portYIELD(); } while( 0 )
105 
106 /* These macros should not be called directly, but through the
107 taskENTER_CRITICAL() and taskEXIT_CRITICAL() macros.  An extra check is
108 performed if configASSERT() is defined to ensure an assertion handler does not
109 inadvertently attempt to lower the IPL when the call to assert was triggered
110 because the IPL value was found to be above configMAX_SYSCALL_INTERRUPT_PRIORITY
111 when an ISR safe FreeRTOS API function was executed.  ISR safe FreeRTOS API
112 functions are those that end in FromISR.  FreeRTOS maintains a separate
113 interrupt API to ensure API function and interrupt entry is as fast and as
114 simple as possible. */
115 #define portENABLE_INTERRUPTS()     __asm volatile ( "MVTIPL    #0" )
116 #ifdef configASSERT
117     #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() configASSERT( ( ulPortGetIPL() <= configMAX_SYSCALL_INTERRUPT_PRIORITY ) )
118     #define portDISABLE_INTERRUPTS()    if( ulPortGetIPL() < configMAX_SYSCALL_INTERRUPT_PRIORITY ) __asm volatile ( "MVTIPL    %0" ::"i"(configMAX_SYSCALL_INTERRUPT_PRIORITY) )
119 #else
120     #define portDISABLE_INTERRUPTS()    __asm volatile ( "MVTIPL    %0" ::"i"(configMAX_SYSCALL_INTERRUPT_PRIORITY) )
121 #endif
122 
123 /* Critical nesting counts are stored in the TCB. */
124 #define portCRITICAL_NESTING_IN_TCB ( 1 )
125 
126 /* The critical nesting functions defined within tasks.c. */
127 extern void vTaskEnterCritical( void );
128 extern void vTaskExitCritical( void );
129 #define portENTER_CRITICAL()    vTaskEnterCritical()
130 #define portEXIT_CRITICAL()     vTaskExitCritical()
131 
132 /* As this port allows interrupt nesting... */
133 uint32_t ulPortGetIPL( void ) __attribute__((naked));
134 void vPortSetIPL( uint32_t ulNewIPL ) __attribute__((naked));
135 #define portSET_INTERRUPT_MASK_FROM_ISR() ulPortGetIPL(); portDISABLE_INTERRUPTS()
136 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus ) vPortSetIPL( uxSavedInterruptStatus )
137 
138 /*-----------------------------------------------------------*/
139 
140 /* Task function macros as described on the FreeRTOS.org WEB site. */
141 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
142 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
143 
144 /* *INDENT-OFF* */
145 #ifdef __cplusplus
146     }
147 #endif
148 /* *INDENT-ON* */
149 
150 #endif /* PORTMACRO_H */
151