xref: /Kernel-v10.6.2/portable/Renesas/RX700v3_DPFPU/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 /* Hardware specifics. */
40     #include <machine.h>
41 
42 /*-----------------------------------------------------------
43  * Port specific definitions.
44  *
45  * The settings in this file configure FreeRTOS correctly for the
46  * given hardware and compiler.
47  *
48  * These settings should not be altered.
49  *-----------------------------------------------------------
50  */
51 
52 /* When the FIT configurator or the Smart Configurator is used, platform.h has to be
53  * used. */
54     #ifndef configINCLUDE_PLATFORM_H_INSTEAD_OF_IODEFINE_H
55         #define configINCLUDE_PLATFORM_H_INSTEAD_OF_IODEFINE_H 0
56     #endif
57 
58 /* If configUSE_TASK_DPFPU_SUPPORT is set to 1 (or undefined) then each task will
59  * be created without a DPFPU context, and a task must call vTaskUsesDPFPU() before
60  * making use of any DPFPU registers.  If configUSE_TASK_DPFPU_SUPPORT is set to 2 then
61  * tasks are created with a DPFPU context by default, and calling vTaskUsesDPFPU() has
62  * no effect.  If configUSE_TASK_DPFPU_SUPPORT is set to 0 then tasks never take care
63  * of any DPFPU context (even if DPFPU registers are used). */
64     #ifndef configUSE_TASK_DPFPU_SUPPORT
65         #define configUSE_TASK_DPFPU_SUPPORT 1
66     #endif
67 
68 /*-----------------------------------------------------------*/
69 
70 /* Type definitions - these are a bit legacy and not really used now, other than
71  * portSTACK_TYPE and portBASE_TYPE. */
72     #define portCHAR          char
73     #define portFLOAT         float
74     #define portDOUBLE        double
75     #define portLONG          long
76     #define portSHORT         short
77     #define portSTACK_TYPE    uint32_t
78     #define portBASE_TYPE     long
79 
80     typedef portSTACK_TYPE   StackType_t;
81     typedef long             BaseType_t;
82     typedef unsigned long    UBaseType_t;
83 
84     #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
85         typedef uint16_t     TickType_t;
86         #define portMAX_DELAY              ( TickType_t ) 0xffff
87     #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
88         typedef uint32_t     TickType_t;
89         #define portMAX_DELAY              ( TickType_t ) 0xffffffffUL
90 
91 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
92  * not need to be guarded with a critical section. */
93         #define portTICK_TYPE_IS_ATOMIC    1
94     #else
95         #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
96     #endif
97 
98 /*-----------------------------------------------------------*/
99 
100 /* Hardware specifics. */
101     #define portBYTE_ALIGNMENT    8     /* Could make four, according to manual. */
102     #define portSTACK_GROWTH      -1
103     #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
104     #define portNOP()    nop()
105 
106 /* Yield equivalent to "*portITU_SWINTR = 0x01; ( void ) *portITU_SWINTR;"
107  * where portITU_SWINTR is the location of the software interrupt register
108  * (0x000872E0).  Don't rely on the assembler to select a register, so instead
109  * save and restore clobbered registers manually. */
110     #pragma inline_asm vPortYield
vPortYield(void)111     static void vPortYield( void )
112     {
113     #ifndef __CDT_PARSER__
114         /* Save clobbered register - may not actually be necessary if inline asm
115          * functions are considered to use the same rules as function calls by the
116          * compiler. */
117         PUSH.L R5
118         /* Set ITU SWINTR. */
119         MOV.L # 000872E0H, R5
120         MOV.B # 1, [ R5 ]
121         /* Read back to ensure the value is taken before proceeding. */
122         CMP [ R5 ].UB, R5
123         /* Restore clobbered register to its previous value. */
124         POP R5
125     #endif
126     }
127 
128     #define portYIELD()                                       vPortYield()
129     #define portYIELD_FROM_ISR( x )                           do { if( ( x ) != pdFALSE ) portYIELD(); } while( 0 )
130 
131 /* These macros should not be called directly, but through the
132  * taskENTER_CRITICAL() and taskEXIT_CRITICAL() macros.  An extra check is
133  * performed if configASSERT() is defined to ensure an assertion handler does not
134  * inadvertently attempt to lower the IPL when the call to assert was triggered
135  * because the IPL value was found to be above  configMAX_SYSCALL_INTERRUPT_PRIORITY
136  * when an ISR safe FreeRTOS API function was executed.  ISR safe FreeRTOS API
137  * functions are those that end in FromISR.  FreeRTOS maintains a separate
138  * interrupt API to ensure API function and interrupt entry is as fast and as
139  * simple as possible. */
140     #define portENABLE_INTERRUPTS()                           set_ipl( ( long ) 0 )
141     #ifdef configASSERT
142         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()    configASSERT( ( get_ipl() <= configMAX_SYSCALL_INTERRUPT_PRIORITY ) )
143         #define portDISABLE_INTERRUPTS()                      if( get_ipl() < configMAX_SYSCALL_INTERRUPT_PRIORITY ) set_ipl( ( long ) configMAX_SYSCALL_INTERRUPT_PRIORITY )
144     #else
145         #define portDISABLE_INTERRUPTS()                      set_ipl( ( long ) configMAX_SYSCALL_INTERRUPT_PRIORITY )
146     #endif
147 
148 /* Critical nesting counts are stored in the TCB. */
149     #define portCRITICAL_NESTING_IN_TCB    ( 1 )
150 
151 /* The critical nesting functions defined within tasks.c. */
152     extern void vTaskEnterCritical( void );
153     extern void vTaskExitCritical( void );
154     #define portENTER_CRITICAL()    vTaskEnterCritical()
155     #define portEXIT_CRITICAL()     vTaskExitCritical()
156 
157 /* As this port allows interrupt nesting... */
158     #define portSET_INTERRUPT_MASK_FROM_ISR()                              ( UBaseType_t ) get_ipl(); set_ipl( ( long ) configMAX_SYSCALL_INTERRUPT_PRIORITY )
159     #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus )    set_ipl( ( long ) uxSavedInterruptStatus )
160 
161 /*-----------------------------------------------------------*/
162 
163 /* Task function macros as described on the FreeRTOS.org WEB site. */
164     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
165     #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
166 
167 /*-----------------------------------------------------------*/
168 
169 /* If configUSE_TASK_DPFPU_SUPPORT is set to 1 (or left undefined) then tasks are
170  * created without a DPFPU context and must call vPortTaskUsesDPFPU() to give
171  * themselves a DPFPU context before using any DPFPU instructions.  If
172  * configUSE_TASK_DPFPU_SUPPORT is set to 2 then all tasks will have a DPFPU context
173  * by default. */
174     #if( configUSE_TASK_DPFPU_SUPPORT == 1 )
175         void vPortTaskUsesDPFPU( void );
176     #else
177 /* Each task has a DPFPU context already, so define this function away to
178  * nothing to prevent it being called accidentally. */
179         #define vPortTaskUsesDPFPU()
180     #endif
181     #define portTASK_USES_DPFPU() vPortTaskUsesDPFPU()
182 
183 /* Definition to allow compatibility with existing FreeRTOS Demo using flop.c. */
184     #define portTASK_USES_FLOATING_POINT() vPortTaskUsesDPFPU()
185 
186 /* *INDENT-OFF* */
187 #ifdef __cplusplus
188     }
189 #endif
190 /* *INDENT-ON* */
191 
192 #endif /* PORTMACRO_H */
193