xref: /Kernel-v10.6.2/portable/IAR/RXv2/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 #include <intrinsics.h>
34 
35 /* *INDENT-OFF* */
36 #ifdef __cplusplus
37     extern "C" {
38 #endif
39 /* *INDENT-ON* */
40 
41 /*-----------------------------------------------------------
42  * Port specific definitions.
43  *
44  * The settings in this file configure FreeRTOS correctly for the
45  * given hardware and compiler.
46  *
47  * These settings should not be altered.
48  *-----------------------------------------------------------
49  */
50 
51 /* Type definitions - these are a bit legacy and not really used now, other than
52 portSTACK_TYPE and portBASE_TYPE. */
53 #define portCHAR        char
54 #define portFLOAT       float
55 #define portDOUBLE      double
56 #define portLONG        long
57 #define portSHORT       short
58 #define portSTACK_TYPE  uint32_t
59 #define portBASE_TYPE   long
60 
61 typedef portSTACK_TYPE StackType_t;
62 typedef long BaseType_t;
63 typedef unsigned long UBaseType_t;
64 
65 
66 #if( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
67     typedef uint16_t TickType_t;
68     #define portMAX_DELAY ( TickType_t ) 0xffff
69 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
70     typedef uint32_t TickType_t;
71     #define portMAX_DELAY ( TickType_t ) 0xffffffffUL
72 
73     /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
74     not need to be guarded with a critical section. */
75     #define portTICK_TYPE_IS_ATOMIC 1
76 #else
77     #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
78 #endif
79 /*-----------------------------------------------------------*/
80 
81 /* Hardware specifics. */
82 #define portBYTE_ALIGNMENT          8   /* Could make four, according to manual. */
83 #define portSTACK_GROWTH            -1
84 #define portTICK_PERIOD_MS          ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
85 #define portNOP()                   __no_operation()
86 
87 /* Yield equivalent to "*portITU_SWINTR = 0x01; ( void ) *portITU_SWINTR;"
88 where portITU_SWINTR is the location of the software interrupt register
89 (0x000872E0).  Don't rely on the assembler to select a register, so instead
90 save and restore clobbered registers manually. */
91 #define portYIELD()                         \
92     __asm volatile                          \
93     (                                       \
94         "PUSH.L R10                 \n"     \
95         "MOV.L  #0x872E0, R10       \n"     \
96         "MOV.B  #0x1, [R10]         \n"     \
97         "MOV.L  [R10], R10          \n"     \
98         "POP    R10                 \n"     \
99     )
100 
101 #define portYIELD_FROM_ISR( x ) do { if( ( x ) != pdFALSE ) portYIELD(); } while( 0 )
102 
103 /* These macros should not be called directly, but through the
104 taskENTER_CRITICAL() and taskEXIT_CRITICAL() macros.  An extra check is
105 performed if configASSERT() is defined to ensure an assertion handler does not
106 inadvertently attempt to lower the IPL when the call to assert was triggered
107 because the IPL value was found to be above configMAX_SYSCALL_INTERRUPT_PRIORITY
108 when an ISR safe FreeRTOS API function was executed.  ISR safe FreeRTOS API
109 functions are those that end in FromISR.  FreeRTOS maintains a separate
110 interrupt API to ensure API function and interrupt entry is as fast and as
111 simple as possible. */
112 #define portENABLE_INTERRUPTS()     __set_interrupt_level( ( uint8_t ) 0 )
113 #ifdef configASSERT
114     #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() configASSERT( ( __get_interrupt_level() <= configMAX_SYSCALL_INTERRUPT_PRIORITY ) )
115     #define portDISABLE_INTERRUPTS()    if( __get_interrupt_level() < configMAX_SYSCALL_INTERRUPT_PRIORITY ) __set_interrupt_level( ( uint8_t ) configMAX_SYSCALL_INTERRUPT_PRIORITY )
116 #else
117     #define portDISABLE_INTERRUPTS()    __set_interrupt_level( ( uint8_t ) configMAX_SYSCALL_INTERRUPT_PRIORITY )
118 #endif
119 
120 /* Critical nesting counts are stored in the TCB. */
121 #define portCRITICAL_NESTING_IN_TCB ( 1 )
122 
123 /* The critical nesting functions defined within tasks.c. */
124 extern void vTaskEnterCritical( void );
125 extern void vTaskExitCritical( void );
126 #define portENTER_CRITICAL()    vTaskEnterCritical()
127 #define portEXIT_CRITICAL()     vTaskExitCritical()
128 
129 /* As this port allows interrupt nesting... */
130 #define portSET_INTERRUPT_MASK_FROM_ISR() __get_interrupt_level(); portDISABLE_INTERRUPTS()
131 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus ) __set_interrupt_level( ( uint8_t ) ( uxSavedInterruptStatus ) )
132 
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 /* Prevent warnings of undefined behaviour: the order of volatile accesses is
140 undefined - all warnings have been manually checked and are not an issue, and
141 the warnings cannot be prevent by code changes without undesirable effects. */
142 #pragma diag_suppress=Pa082
143 
144 /* *INDENT-OFF* */
145 #ifdef __cplusplus
146     }
147 #endif
148 /* *INDENT-ON* */
149 
150 #endif /* PORTMACRO_H */
151