]> begriffs open source - freertos/blob - portable/IAR/RX700v3_DPFPU/portmacro.h
Use the bigger priority whenever possible. (#760)
[freertos] / portable / IAR / RX700v3_DPFPU / portmacro.h
1 /*
2  * FreeRTOS Kernel <DEVELOPMENT BRANCH>
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 /* Hardware specifics. */
34     #include <intrinsics.h>
35
36 /* *INDENT-OFF* */
37 #ifdef __cplusplus
38     extern "C" {
39 #endif
40 /* *INDENT-ON* */
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()    __no_operation()
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     #define portYIELD()           \
111     __asm volatile                \
112     (                             \
113         "PUSH.L R10                 \n"\
114         "MOV.L  #0x872E0, R10       \n"\
115         "MOV.B  #0x1, [R10]         \n"\
116         "CMP    [R10].UB, R10       \n"\
117         "POP    R10                 \n"\
118         portCDT_NO_PARSE( ::: ) "cc"\
119     )
120
121     #define portYIELD_FROM_ISR( x )                           do { if( ( x ) != pdFALSE ) portYIELD(); } while( 0 )
122
123 /* Workaround to reduce errors/warnings caused by e2 studio CDT's INDEXER and CODAN. */
124     #ifdef __CDT_PARSER__
125     #ifndef __asm
126     #define __asm asm
127     #endif
128     #ifndef __attribute__
129     #define __attribute__( ... )
130     #endif
131     #define portCDT_NO_PARSE( token )
132     #else
133     #define portCDT_NO_PARSE( token ) token
134     #endif
135
136 /* These macros should not be called directly, but through the
137  * taskENTER_CRITICAL() and taskEXIT_CRITICAL() macros.  An extra check is
138  * performed if configASSERT() is defined to ensure an assertion handler does not
139  * inadvertently attempt to lower the IPL when the call to assert was triggered
140  * because the IPL value was found to be above  configMAX_SYSCALL_INTERRUPT_PRIORITY
141  * when an ISR safe FreeRTOS API function was executed.  ISR safe FreeRTOS API
142  * functions are those that end in FromISR.  FreeRTOS maintains a separate
143  * interrupt API to ensure API function and interrupt entry is as fast and as
144  * simple as possible. */
145     #define portENABLE_INTERRUPTS()                           __set_interrupt_level( ( uint8_t ) 0 )
146     #ifdef configASSERT
147         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()    configASSERT( ( __get_interrupt_level() <= configMAX_SYSCALL_INTERRUPT_PRIORITY ) )
148         #define portDISABLE_INTERRUPTS()                      if( __get_interrupt_level() < configMAX_SYSCALL_INTERRUPT_PRIORITY ) __set_interrupt_level( ( uint8_t ) configMAX_SYSCALL_INTERRUPT_PRIORITY )
149     #else
150         #define portDISABLE_INTERRUPTS()                      __set_interrupt_level( ( uint8_t ) configMAX_SYSCALL_INTERRUPT_PRIORITY )
151     #endif
152
153 /* Critical nesting counts are stored in the TCB. */
154     #define portCRITICAL_NESTING_IN_TCB    ( 1 )
155
156 /* The critical nesting functions defined within tasks.c. */
157     extern void vTaskEnterCritical( void );
158     extern void vTaskExitCritical( void );
159     #define portENTER_CRITICAL()    vTaskEnterCritical()
160     #define portEXIT_CRITICAL()     vTaskExitCritical()
161
162 /* As this port allows interrupt nesting... */
163     #define portSET_INTERRUPT_MASK_FROM_ISR()                              __get_interrupt_level(); portDISABLE_INTERRUPTS()
164     #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus )    __set_interrupt_level( ( uint8_t ) ( uxSavedInterruptStatus ) )
165
166 /*-----------------------------------------------------------*/
167
168 /* Task function macros as described on the FreeRTOS.org WEB site. */
169     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
170     #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
171
172 /*-----------------------------------------------------------*/
173
174 /* If configUSE_TASK_DPFPU_SUPPORT is set to 1 (or left undefined) then tasks are
175  * created without a DPFPU context and must call vPortTaskUsesDPFPU() to give
176  * themselves a DPFPU context before using any DPFPU instructions.  If
177  * configUSE_TASK_DPFPU_SUPPORT is set to 2 then all tasks will have a DPFPU context
178  * by default. */
179     #if( configUSE_TASK_DPFPU_SUPPORT == 1 )
180         void vPortTaskUsesDPFPU( void );
181     #else
182 /* Each task has a DPFPU context already, so define this function away to
183  * nothing to prevent it being called accidentally. */
184         #define vPortTaskUsesDPFPU()
185     #endif
186     #define portTASK_USES_DPFPU() vPortTaskUsesDPFPU()
187
188 /* Definition to allow compatibility with existing FreeRTOS Demo using flop.c. */
189     #define portTASK_USES_FLOATING_POINT() vPortTaskUsesDPFPU()
190
191 /* Prevent warnings of undefined behaviour: the order of volatile accesses is
192  * undefined - all warnings have been manually checked and are not an issue, and
193  * the warnings cannot be prevent by code changes without undesirable effects. */
194     #pragma diag_suppress=Pa082
195
196 /* *INDENT-OFF* */
197 #ifdef __cplusplus
198     }
199 #endif
200 /* *INDENT-ON* */
201
202 #endif /* PORTMACRO_H */