| 1 |
572 |
jeremybenn |
/*
|
| 2 |
|
|
FreeRTOS V6.1.1 - Copyright (C) 2011 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 books - available as PDF or paperback *
|
| 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 |
|
|
|
| 55 |
|
|
#ifndef PORTMACRO_H
|
| 56 |
|
|
#define PORTMACRO_H
|
| 57 |
|
|
|
| 58 |
|
|
/*-----------------------------------------------------------
|
| 59 |
|
|
* Port specific definitions.
|
| 60 |
|
|
*
|
| 61 |
|
|
* The settings in this file configure FreeRTOS correctly for the
|
| 62 |
|
|
* given hardware and compiler.
|
| 63 |
|
|
*
|
| 64 |
|
|
* These settings should not be altered.
|
| 65 |
|
|
*-----------------------------------------------------------
|
| 66 |
|
|
*/
|
| 67 |
|
|
|
| 68 |
|
|
/* Type definitions. */
|
| 69 |
|
|
#define portCHAR char
|
| 70 |
|
|
#define portFLOAT float
|
| 71 |
|
|
#define portDOUBLE double
|
| 72 |
|
|
#define portLONG long
|
| 73 |
|
|
#define portSHORT short
|
| 74 |
|
|
#define portSTACK_TYPE unsigned portCHAR
|
| 75 |
|
|
#define portBASE_TYPE char
|
| 76 |
|
|
|
| 77 |
|
|
#if( configUSE_16_BIT_TICKS == 1 )
|
| 78 |
|
|
typedef unsigned portSHORT portTickType;
|
| 79 |
|
|
#define portMAX_DELAY ( portTickType ) 0xffff
|
| 80 |
|
|
#else
|
| 81 |
|
|
typedef unsigned portLONG portTickType;
|
| 82 |
|
|
#define portMAX_DELAY ( portTickType ) 0xffffffff
|
| 83 |
|
|
#endif
|
| 84 |
|
|
/*-----------------------------------------------------------*/
|
| 85 |
|
|
|
| 86 |
|
|
/* Hardware specifics. */
|
| 87 |
|
|
#define portBYTE_ALIGNMENT 1
|
| 88 |
|
|
#define portSTACK_GROWTH ( -1 )
|
| 89 |
|
|
#define portTICK_RATE_MS ( ( portTickType ) 1000 / configTICK_RATE_HZ )
|
| 90 |
|
|
#define portYIELD() __asm( "swi" );
|
| 91 |
|
|
#define portNOP() __asm( "nop" );
|
| 92 |
|
|
/*-----------------------------------------------------------*/
|
| 93 |
|
|
|
| 94 |
|
|
/* Critical section handling. */
|
| 95 |
|
|
#define portENABLE_INTERRUPTS() __asm( "cli" )
|
| 96 |
|
|
#define portDISABLE_INTERRUPTS() __asm( "sei" )
|
| 97 |
|
|
|
| 98 |
|
|
/*
|
| 99 |
|
|
* Disable interrupts before incrementing the count of critical section nesting.
|
| 100 |
|
|
* The nesting count is maintained so we know when interrupts should be
|
| 101 |
|
|
* re-enabled. Once interrupts are disabled the nesting count can be accessed
|
| 102 |
|
|
* directly. Each task maintains its own nesting count.
|
| 103 |
|
|
*/
|
| 104 |
|
|
#define portENTER_CRITICAL() \
|
| 105 |
|
|
{ \
|
| 106 |
|
|
extern volatile unsigned portBASE_TYPE uxCriticalNesting; \
|
| 107 |
|
|
\
|
| 108 |
|
|
portDISABLE_INTERRUPTS(); \
|
| 109 |
|
|
uxCriticalNesting++; \
|
| 110 |
|
|
}
|
| 111 |
|
|
|
| 112 |
|
|
/*
|
| 113 |
|
|
* Interrupts are disabled so we can access the nesting count directly. If the
|
| 114 |
|
|
* nesting is found to be 0 (no nesting) then we are leaving the critical
|
| 115 |
|
|
* section and interrupts can be re-enabled.
|
| 116 |
|
|
*/
|
| 117 |
|
|
#define portEXIT_CRITICAL() \
|
| 118 |
|
|
{ \
|
| 119 |
|
|
extern volatile unsigned portBASE_TYPE uxCriticalNesting; \
|
| 120 |
|
|
\
|
| 121 |
|
|
uxCriticalNesting--; \
|
| 122 |
|
|
if( uxCriticalNesting == 0 ) \
|
| 123 |
|
|
{ \
|
| 124 |
|
|
portENABLE_INTERRUPTS(); \
|
| 125 |
|
|
} \
|
| 126 |
|
|
}
|
| 127 |
|
|
/*-----------------------------------------------------------*/
|
| 128 |
|
|
|
| 129 |
|
|
/* Task utilities. */
|
| 130 |
|
|
|
| 131 |
|
|
/*
|
| 132 |
|
|
* These macros are very simple as the processor automatically saves and
|
| 133 |
|
|
* restores its registers as interrupts are entered and exited. In
|
| 134 |
|
|
* addition to the (automatically stacked) registers we also stack the
|
| 135 |
|
|
* critical nesting count. Each task maintains its own critical nesting
|
| 136 |
|
|
* count as it is legitimate for a task to yield from within a critical
|
| 137 |
|
|
* section. If the banked memory model is being used then the PPAGE
|
| 138 |
|
|
* register is also stored as part of the tasks context.
|
| 139 |
|
|
*/
|
| 140 |
|
|
|
| 141 |
|
|
#ifdef BANKED_MODEL
|
| 142 |
|
|
/*
|
| 143 |
|
|
* Load the stack pointer for the task, then pull the critical nesting
|
| 144 |
|
|
* count and PPAGE register from the stack. The remains of the
|
| 145 |
|
|
* context are restored by the RTI instruction.
|
| 146 |
|
|
*/
|
| 147 |
|
|
#define portRESTORE_CONTEXT() \
|
| 148 |
|
|
{ \
|
| 149 |
|
|
extern volatile void * pxCurrentTCB; \
|
| 150 |
|
|
extern volatile unsigned portBASE_TYPE uxCriticalNesting; \
|
| 151 |
|
|
\
|
| 152 |
|
|
__asm( "ldx pxCurrentTCB" ); \
|
| 153 |
|
|
__asm( "lds 0, x" ); \
|
| 154 |
|
|
__asm( "pula" ); \
|
| 155 |
|
|
__asm( "staa uxCriticalNesting" ); \
|
| 156 |
|
|
__asm( "pula" ); \
|
| 157 |
|
|
__asm( "staa 0x30" ); /* 0x30 = PPAGE */ \
|
| 158 |
|
|
}
|
| 159 |
|
|
|
| 160 |
|
|
/*
|
| 161 |
|
|
* By the time this macro is called the processor has already stacked the
|
| 162 |
|
|
* registers. Simply stack the nesting count and PPAGE value, then save
|
| 163 |
|
|
* the task stack pointer.
|
| 164 |
|
|
*/
|
| 165 |
|
|
#define portSAVE_CONTEXT() \
|
| 166 |
|
|
{ \
|
| 167 |
|
|
extern volatile void * pxCurrentTCB; \
|
| 168 |
|
|
extern volatile unsigned portBASE_TYPE uxCriticalNesting; \
|
| 169 |
|
|
\
|
| 170 |
|
|
__asm( "ldaa 0x30" ); /* 0x30 = PPAGE */ \
|
| 171 |
|
|
__asm( "psha" ); \
|
| 172 |
|
|
__asm( "ldaa uxCriticalNesting" ); \
|
| 173 |
|
|
__asm( "psha" ); \
|
| 174 |
|
|
__asm( "ldx pxCurrentTCB" ); \
|
| 175 |
|
|
__asm( "sts 0, x" ); \
|
| 176 |
|
|
}
|
| 177 |
|
|
#else
|
| 178 |
|
|
|
| 179 |
|
|
/*
|
| 180 |
|
|
* These macros are as per the BANKED versions above, but without saving
|
| 181 |
|
|
* and restoring the PPAGE register.
|
| 182 |
|
|
*/
|
| 183 |
|
|
|
| 184 |
|
|
#define portRESTORE_CONTEXT() \
|
| 185 |
|
|
{ \
|
| 186 |
|
|
extern volatile void * pxCurrentTCB; \
|
| 187 |
|
|
extern volatile unsigned portBASE_TYPE uxCriticalNesting; \
|
| 188 |
|
|
\
|
| 189 |
|
|
__asm( "ldx pxCurrentTCB" ); \
|
| 190 |
|
|
__asm( "lds 0, x" ); \
|
| 191 |
|
|
__asm( "pula" ); \
|
| 192 |
|
|
__asm( "staa uxCriticalNesting" ); \
|
| 193 |
|
|
}
|
| 194 |
|
|
|
| 195 |
|
|
#define portSAVE_CONTEXT() \
|
| 196 |
|
|
{ \
|
| 197 |
|
|
extern volatile void * pxCurrentTCB; \
|
| 198 |
|
|
extern volatile unsigned portBASE_TYPE uxCriticalNesting; \
|
| 199 |
|
|
\
|
| 200 |
|
|
__asm( "ldaa uxCriticalNesting" ); \
|
| 201 |
|
|
__asm( "psha" ); \
|
| 202 |
|
|
__asm( "ldx pxCurrentTCB" ); \
|
| 203 |
|
|
__asm( "sts 0, x" ); \
|
| 204 |
|
|
}
|
| 205 |
|
|
#endif
|
| 206 |
|
|
|
| 207 |
|
|
/*
|
| 208 |
|
|
* Utility macro to call macros above in correct order in order to perform a
|
| 209 |
|
|
* task switch from within a standard ISR. This macro can only be used if
|
| 210 |
|
|
* the ISR does not use any local (stack) variables. If the ISR uses stack
|
| 211 |
|
|
* variables portYIELD() should be used in it's place.
|
| 212 |
|
|
*/
|
| 213 |
|
|
#define portTASK_SWITCH_FROM_ISR() \
|
| 214 |
|
|
portSAVE_CONTEXT(); \
|
| 215 |
|
|
vTaskSwitchContext(); \
|
| 216 |
|
|
portRESTORE_CONTEXT();
|
| 217 |
|
|
|
| 218 |
|
|
|
| 219 |
|
|
/* Task function macros as described on the FreeRTOS.org WEB site. */
|
| 220 |
|
|
#define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
|
| 221 |
|
|
#define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
|
| 222 |
|
|
|
| 223 |
|
|
#endif /* PORTMACRO_H */
|
| 224 |
|
|
|
