]> git.sur5r.net Git - freertos/blob - Source/portable/GCC/CORTUS_APS3/portmacro.h
Work in progress on the Cortus port.
[freertos] / Source / portable / GCC / CORTUS_APS3 / portmacro.h
1 /*
2     FreeRTOS V6.0.4 - Copyright (C) 2010 Real Time Engineers Ltd.
3
4     ***************************************************************************
5     *                                                                         *
6     * If you are:                                                             *
7     *                                                                         *
8     *    + New to FreeRTOS,                                                   *
9     *    + Wanting to learn FreeRTOS or multitasking in general quickly       *
10     *    + Looking for basic training,                                        *
11     *    + Wanting to improve your FreeRTOS skills and productivity           *
12     *                                                                         *
13     * then take a look at the FreeRTOS eBook                                  *
14     *                                                                         *
15     *        "Using the FreeRTOS Real Time Kernel - a Practical Guide"        *
16     *                  http://www.FreeRTOS.org/Documentation                  *
17     *                                                                         *
18     * A pdf reference manual is also available.  Both are usually delivered   *
19     * to your inbox within 20 minutes to two hours when purchased between 8am *
20     * and 8pm GMT (although please allow up to 24 hours in case of            *
21     * exceptional circumstances).  Thank you for your support!                *
22     *                                                                         *
23     ***************************************************************************
24
25     This file is part of the FreeRTOS distribution.
26
27     FreeRTOS is free software; you can redistribute it and/or modify it under
28     the terms of the GNU General Public License (version 2) as published by the
29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
30     ***NOTE*** The exception to the GPL is included to allow you to distribute
31     a combined work that includes FreeRTOS without being obliged to provide the
32     source code for proprietary components outside of the FreeRTOS kernel.
33     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT
34     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
35     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
36     more details. You should have received a copy of the GNU General Public
37     License and the FreeRTOS license exception along with FreeRTOS; if not it
38     can be viewed here: http://www.freertos.org/a00114.html and also obtained
39     by writing to Richard Barry, contact details for whom are available on the
40     FreeRTOS WEB site.
41
42     1 tab == 4 spaces!
43
44     http://www.FreeRTOS.org - Documentation, latest information, license and
45     contact details.
46
47     http://www.SafeRTOS.com - A version that is certified for use in safety
48     critical systems.
49
50     http://www.OpenRTOS.com - Commercial support, development, porting,
51     licensing and training services.
52 */
53
54 #ifndef PORTMACRO_H
55 #define PORTMACRO_H
56
57 #ifdef __cplusplus
58 extern "C" {
59 #endif
60
61 #include <machine/ic.h>
62
63 /*-----------------------------------------------------------
64  * Port specific definitions.
65  *
66  * The settings in this file configure FreeRTOS correctly for the
67  * given hardware and compiler.
68  *
69  * These settings should not be altered.
70  *-----------------------------------------------------------
71  */
72
73 /* Type definitions. */
74 #define portCHAR                char
75 #define portFLOAT               float
76 #define portDOUBLE              double
77 #define portLONG                long
78 #define portSHORT               short
79 #define portSTACK_TYPE  unsigned portLONG
80 #define portBASE_TYPE   portLONG
81
82 #if( configUSE_16_BIT_TICKS == 1 )
83         typedef unsigned portSHORT portTickType;
84         #define portMAX_DELAY ( portTickType ) 0xffff
85 #else
86         typedef unsigned portLONG portTickType;
87         #define portMAX_DELAY ( portTickType ) 0xffffffff
88 #endif
89 /*-----------------------------------------------------------*/
90
91 /* Architecture specifics. */
92 #define portSTACK_GROWTH                                                        ( -1 )
93 #define portTICK_RATE_MS                                                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )
94 #define portBYTE_ALIGNMENT                                                      4
95 #define portNOP()                                                                       __asm__ volatile ( "mov r0,r0; nop" )
96 #define portCRITICAL_NESTING_IN_TCB                                     1
97 #define portIRQ_TRAP_YIELD                                                      31
98 #define portKERNEL_INTERRUPT_PRIORITY_LEVEL                     0
99 #define portSYSTEM_INTERRUPT_PRIORITY_LEVEL                     1
100 /*-----------------------------------------------------------*/
101
102 /* Task utilities. */
103
104 extern void vPortYield( void );
105
106 /**
107  * Interrupt Handlers that access RTOS API functions use a separate interrupt stack
108  * and so the nesting depth needs to be recorded to know when to switch from the
109  * interrupt stack back to the Task stack.
110  */
111 extern volatile unsigned portBASE_TYPE uxInterruptNestingCount;
112 /*---------------------------------------------------------------------------*/
113
114 #define portYIELD()             asm __volatile__( " trap #%0 "::"i"(portIRQ_TRAP_YIELD):"memory")
115 /*---------------------------------------------------------------------------*/
116
117 extern void vTaskEnterCritical( void );
118 extern void vTaskExitCritical( void );
119 #define portENTER_CRITICAL()            vTaskEnterCritical()
120 #define portEXIT_CRITICAL()                     vTaskExitCritical()
121 /*---------------------------------------------------------------------------*/
122
123 /* Critical section management. */
124 #define portDISABLE_INTERRUPTS() ic->cpl = ( portSYSTEM_INTERRUPT_PRIORITY_LEVEL + 1 )
125 #define portENABLE_INTERRUPTS() ic->cpl = portKERNEL_INTERRUPT_PRIORITY_LEVEL
126
127 #define portSET_INTERRUPT_MASK_FROM_ISR() ic->cpl; portDISABLE_INTERRUPTS()
128 #define portRESTORE_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus ) ic->cpl = uxSavedInterruptStatus
129 /*---------------------------------------------------------------------------*/
130
131 #define portYIELD_FROM_ISR()                                                                                                                            \
132         {                                                                                                                                                                               \
133                 asm __volatile__(                                                                                                                                       \
134                         " sub           r1, #4                  \n"             /* Make space on the stack. */                          \
135                         " movhi         r2, #16384              \n"             /* Load the pointer to the IC. */                       \
136                         " ldub          r3, [r2]+2              \n"             /* Copy the Current Priority Level. */          \
137                         " st            r3, [r1]                \n"             /* Store it on the stack. */                            \
138                         " mov           r3, #%0                 \n"             /* Load the highest priority level. */          \
139                         " stb           r3, [r2]+2              \n"             /* Set the CPL to the highest level. */         \
140                         " call          vTaskSwitchContext      \n"     /* Select a new pxCurrentTCB. */                        \
141                         " ld            r3, [r1]                \n"             /* Load the previous CPL from the stack. */     \
142                         " movhi         r2, #16384              \n"             /* Load the pointer to the IC. */                       \
143                         " stb           r3, [r2]+2              \n"             /* Set the CPL to the previous CPL. */          \
144                         " add           r1, #4                  "               /* Fix the stack. */                                            \
145                         :                                                                                                                                                               \
146                         :"i"(portSYSTEM_INTERRUPT_PRIORITY_LEVEL+1)                                                                             \
147                         :"r2","r3");                                                                                                                                    \
148         }
149
150 /*---------------------------------------------------------------------------*/
151
152 #define portSAVE_CONTEXT_REDUCED()                              \
153         {                                                                                       \
154                 asm __volatile__(                                               \
155                         /* "sub r1, #0x28"              */                      /* Prologue generated by the compiler. */ \
156                         /* "stq r4, [r1]+0x8"   */                      \
157                         /* "mov r6, psr"                */                      \
158                         /* "mov r7, rtt"                */                      \
159                         /* "std r6, [r1]+0x20"  */                      \
160                         /* "std r14, [r1]+0x18" */                      \
161                         /* "std r2, [r1]"       */                              \
162                         /* "mov r14, r1"        */                              \
163                         "sub    r1, #0x1c                               \n"     /* Make space on the stack. */  \
164                         "stq    r8, [r1]                                \n"     /* Store the remaining context registers. */    \
165                         "std    r12, [r1]+0x10                  \n"     \
166                         "movhi  r2, #16384                              \n"     /* Set the pointer to the IC. */        \
167                         "ldub   r3, [r2]+2                              \n"     /* Load the current priority level. */  \
168                         "st             r3, [r1]+0x18                   \n"     /* Store the current priority level on the stack. */ \
169                         "ldub   r3, [r2]+3                              \n"     /* Load the interrupt priority level. */        \
170                         "add    r3, #1                                  \n"     /* Increase the priority by one. */     \
171                         "stb    r3, [r2]+2                              \n" /* Set the current priority level to be above this one. */  \
172                         "ld             r4, [r0]+short(puxInterruptNestingCount)        \n"     /*[r0]+short(puxInterruptNestingCount) */ \
173                         "ld             r5, [r4]                                \n"     \
174                         "add    r5, #1                                  \n"     /* Increment the interrupt nesting count. */    \
175                         "st             r5, [r4]                                \n"     \
176                         "cmp    r5, #1                                  \n"     /* Is this the first interrupt? */      \
177                         "bne.s  12                                              \n" /* If it is then save the stack pointer to the current TCB? */      \
178                         "ld             r2, [r0]+short(pxCurrentTCB)    \n"     /* Load the pointer to the TCB. */      \
179                         "st             r1, [r2]                                \n"     /* Save the stack pointer into the TCB. */      \
180                         "ld             r1, [r0]+short(puxTopOfInterruptStack)          \n"     /* Switch to the dedicated interrupt stack. */  /* [r0]+short(uxInterruptStack) */      \
181                         "mov    r14, r1                                 \n"     /* Compiler expects r14 to be set to the function stack. */     \
182                         "movhi  r2, #3                                  \n"     /* Re-enable interrupts (re-enable breakpoints). */     \
183                         "mov    psr, r2                                 \n"     \
184                         :::"r2","r3","r4","r5","r15"    );      /* Clobber list includes all of the caller saved registers so that they are saved as part of the Interrupt handler pre-amble. */        \
185         }
186 /*---------------------------------------------------------------------------*/
187
188 #define portRESTORE_CONTEXT_REDUCED()                   \
189         {                                                                                       \
190                 asm __volatile__(                                               \
191                         "movhi  r2, #2                                  \n"     /* Disable interrupts (disable breakpoints). */ \
192                         "mov    psr, r2                                 \n"     \
193                         "ld             r2, [r0]+short(puxInterruptNestingCount)        \n"     \
194                         "ld             r3, [r2]                                \n"     \
195                         "sub    r3, #1                                  \n"     /* Decrement the interrupt nesting count. */    \
196                         "st             r3, [r2]                                \n"     \
197                         "cmp    r3, r0                                  \n"     /* Is this the first interrupt? */      \
198                         "bne.s  8                                               \n"     /* Are we at the end of unrolling the interrupt nesting? */     \
199                         "ld             r2, [r0]+short(pxCurrentTCB)    \n"     /* Load the TCB to find the stack pointer and context. */       \
200                         "ld             r1, [r2]                                \n"     \
201                         "movhi  r2, #16384                              \n"     /* Set the pointer to the IC. */        \
202                         "ld             r3, [r1]+0x18                   \n"     /* Load the previous current priority level. */ \
203                         "stb    r3, [r2]+2                      \n"     /* Set the current priority level to be the previous. */        \
204                         "ldd    r12, [r1]+0x10                  \n"     /* Restore the callee saved registers. Caller saved registers are restored by the function exit. */     \
205                         "ldq    r8, [r1]                                \n"     \
206                         "add    r1, #0x1c                               \n"     \
207                         "mov    r14, r1                                 \n"     \
208                         /* "mov r1, r14"                */              /* Epilogue generated by the compiler. */       \
209                         /* "ldd r6, [r1]+0x20"  */                      \
210                         /* "mov psr, r6"                */                      \
211                         /* "mov rtt, r7"                */                      \
212                         /* "ldd r14, [r1]+0x18" */                      \
213                         /* "ldq r4, [r1]+0x8"   */                      \
214                         /* "ldd r2, [r1]"               */                      \
215                         /* "add r1, #0x28"              */                      \
216                         /* "rti"                                */                      \
217                         );                                                                      \
218         }
219 /*---------------------------------------------------------------------------*/
220
221 /* Task function macros as described on the FreeRTOS.org WEB site. */
222 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
223 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
224 /*---------------------------------------------------------------------------*/
225
226 #ifdef __cplusplus
227 }
228 #endif
229
230 #endif /* PORTMACRO_H */