]> git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/GCC/RX600/portmacro.h
Update RX ports to only include additional check on the existing IPL (so it is not...
[freertos] / FreeRTOS / Source / portable / GCC / RX600 / portmacro.h
1 /*\r
2     FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
3 \r
4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
6 \r
7     ***************************************************************************\r
8      *                                                                       *\r
9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
10      *    Complete, revised, and edited pdf reference manuals are also       *\r
11      *    available.                                                         *\r
12      *                                                                       *\r
13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
14      *    ensuring you get running as quickly as possible and with an        *\r
15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
16      *    the FreeRTOS project to continue with its mission of providing     *\r
17      *    professional grade, cross platform, de facto standard solutions    *\r
18      *    for microcontrollers - completely free of charge!                  *\r
19      *                                                                       *\r
20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
21      *                                                                       *\r
22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
23      *                                                                       *\r
24     ***************************************************************************\r
25 \r
26 \r
27     This file is part of the FreeRTOS distribution.\r
28 \r
29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
30     the terms of the GNU General Public License (version 2) as published by the\r
31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
32 \r
33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
34     distribute a combined work that includes FreeRTOS without being obliged to\r
35     provide the source code for proprietary components outside of the FreeRTOS\r
36     kernel.\r
37 \r
38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
41     details. You should have received a copy of the GNU General Public License\r
42     and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
44     writing to Real Time Engineers Ltd., contact details for whom are available\r
45     on the FreeRTOS WEB site.\r
46 \r
47     1 tab == 4 spaces!\r
48 \r
49     ***************************************************************************\r
50      *                                                                       *\r
51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
52      *    not run, what could be wrong?"                                     *\r
53      *                                                                       *\r
54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
55      *                                                                       *\r
56     ***************************************************************************\r
57 \r
58 \r
59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
60     license and Real Time Engineers Ltd. contact details.\r
61 \r
62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
64     fully thread aware and reentrant UDP/IP stack.\r
65 \r
66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
67     Integrity Systems, who sell the code with commercial support, \r
68     indemnification and middleware, under the OpenRTOS brand.\r
69     \r
70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
71     engineered and independently SIL3 certified version for use in safety and \r
72     mission critical applications that require provable dependability.\r
73 */\r
74 \r
75 \r
76 #ifndef PORTMACRO_H\r
77 #define PORTMACRO_H\r
78 \r
79 #ifdef __cplusplus\r
80 extern "C" {\r
81 #endif\r
82 \r
83 /*-----------------------------------------------------------\r
84  * Port specific definitions.  \r
85  *\r
86  * The settings in this file configure FreeRTOS correctly for the\r
87  * given hardware and compiler.\r
88  *\r
89  * These settings should not be altered.\r
90  *-----------------------------------------------------------\r
91  */\r
92 \r
93 /* Type definitions - these are a bit legacy and not really used now, other than\r
94 portSTACK_TYPE and portBASE_TYPE. */\r
95 #define portCHAR                char\r
96 #define portFLOAT               float\r
97 #define portDOUBLE              double\r
98 #define portLONG                long\r
99 #define portSHORT               short\r
100 #define portSTACK_TYPE  unsigned portLONG\r
101 #define portBASE_TYPE   long\r
102 \r
103 #if( configUSE_16_BIT_TICKS == 1 )\r
104         typedef unsigned portSHORT portTickType;\r
105         #define portMAX_DELAY ( portTickType ) 0xffff\r
106 #else\r
107         typedef unsigned portLONG portTickType;\r
108         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
109 #endif\r
110 /*-----------------------------------------------------------*/\r
111 \r
112 /* Hardware specifics. */\r
113 #define portBYTE_ALIGNMENT                      8       /* Could make four, according to manual. */\r
114 #define portSTACK_GROWTH                        -1\r
115 #define portTICK_RATE_MS                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )          \r
116 #define portNOP()                                       __asm volatile( "NOP" )\r
117 \r
118 /* Yield equivalent to "*portITU_SWINTR = 0x01; ( void ) *portITU_SWINTR;"\r
119 where portITU_SWINTR is the location of the software interrupt register\r
120 (0x000872E0).  Don't rely on the assembler to select a register, so instead \r
121 save and restore clobbered registers manually. */\r
122 #define portYIELD()                                                     \\r
123         __asm volatile                                                  \\r
124         (                                                                               \\r
125                 "PUSH.L R10                                     \n"             \\r
126                 "MOV.L  #0x872E0, R10           \n"             \\r
127                 "MOV.B  #0x1, [R10]                     \n"             \\r
128                 "MOV.L  [R10], R10                      \n"             \\r
129                 "POP    R10                                     \n"             \\r
130         )\r
131 \r
132 #define portYIELD_FROM_ISR( x ) if( x != pdFALSE ) portYIELD()\r
133 \r
134 /* These macros should not be called directly, but through the \r
135 taskENTER_CRITICAL() and taskEXIT_CRITICAL() macros.  An extra check is \r
136 performed if configASSERT() is defined to ensure an assertion handler does not \r
137 inadvertently attempt to lower the IPL when the call to assert was triggered \r
138 because the IPL value was found to be above     configMAX_SYSCALL_INTERRUPT_PRIORITY \r
139 when an ISR safe FreeRTOS API function was executed.  ISR safe FreeRTOS API \r
140 functions are those that end in FromISR.  FreeRTOS maintains a separate \r
141 interrupt API to ensure API function and interrupt entry is as fast and as \r
142 simple as possible. */\r
143 #define portENABLE_INTERRUPTS()         __asm volatile ( "MVTIPL        #0" )\r
144 #ifdef configASSERT\r
145         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() configASSERT( ( ulPortGetIPL() <= configMAX_SYSCALL_INTERRUPT_PRIORITY ) )\r
146         #define portDISABLE_INTERRUPTS()        if( ulPortGetIPL() < configMAX_SYSCALL_INTERRUPT_PRIORITY ) __asm volatile ( "MVTIPL    %0" ::"i"(configMAX_SYSCALL_INTERRUPT_PRIORITY) )\r
147 #else\r
148         #define portDISABLE_INTERRUPTS()        __asm volatile ( "MVTIPL        %0" ::"i"(configMAX_SYSCALL_INTERRUPT_PRIORITY) )\r
149 #endif\r
150 \r
151 /* Critical nesting counts are stored in the TCB. */\r
152 #define portCRITICAL_NESTING_IN_TCB ( 1 )\r
153 \r
154 /* The critical nesting functions defined within tasks.c. */\r
155 extern void vTaskEnterCritical( void );\r
156 extern void vTaskExitCritical( void );\r
157 #define portENTER_CRITICAL()    vTaskEnterCritical()\r
158 #define portEXIT_CRITICAL()             vTaskExitCritical()\r
159 \r
160 /* As this port allows interrupt nesting... */\r
161 unsigned long ulPortGetIPL( void ) __attribute__((naked));\r
162 void vPortSetIPL( unsigned long ulNewIPL ) __attribute__((naked));\r
163 #define portSET_INTERRUPT_MASK_FROM_ISR() ulPortGetIPL(); portDISABLE_INTERRUPTS()\r
164 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus ) vPortSetIPL( uxSavedInterruptStatus )\r
165 \r
166 /*-----------------------------------------------------------*/\r
167 \r
168 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
169 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
170 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
171 \r
172 #ifdef __cplusplus\r
173 }\r
174 #endif\r
175 \r
176 #endif /* PORTMACRO_H */\r
177 \r