| 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 |
|
|
#ifndef STACK_MACROS_H
|
| 55 |
|
|
#define STACK_MACROS_H
|
| 56 |
|
|
|
| 57 |
|
|
/*
|
| 58 |
|
|
* Call the stack overflow hook function if the stack of the task being swapped
|
| 59 |
|
|
* out is currently overflowed, or looks like it might have overflowed in the
|
| 60 |
|
|
* past.
|
| 61 |
|
|
*
|
| 62 |
|
|
* Setting configCHECK_FOR_STACK_OVERFLOW to 1 will cause the macro to check
|
| 63 |
|
|
* the current stack state only - comparing the current top of stack value to
|
| 64 |
|
|
* the stack limit. Setting configCHECK_FOR_STACK_OVERFLOW to greater than 1
|
| 65 |
|
|
* will also cause the last few stack bytes to be checked to ensure the value
|
| 66 |
|
|
* to which the bytes were set when the task was created have not been
|
| 67 |
|
|
* overwritten. Note this second test does not guarantee that an overflowed
|
| 68 |
|
|
* stack will always be recognised.
|
| 69 |
|
|
*/
|
| 70 |
|
|
|
| 71 |
|
|
/*-----------------------------------------------------------*/
|
| 72 |
|
|
|
| 73 |
|
|
#if( configCHECK_FOR_STACK_OVERFLOW == 0 )
|
| 74 |
|
|
|
| 75 |
|
|
/* FreeRTOSConfig.h is not set to check for stack overflows. */
|
| 76 |
|
|
#define taskFIRST_CHECK_FOR_STACK_OVERFLOW()
|
| 77 |
|
|
#define taskSECOND_CHECK_FOR_STACK_OVERFLOW()
|
| 78 |
|
|
|
| 79 |
|
|
#endif /* configCHECK_FOR_STACK_OVERFLOW == 0 */
|
| 80 |
|
|
/*-----------------------------------------------------------*/
|
| 81 |
|
|
|
| 82 |
|
|
#if( configCHECK_FOR_STACK_OVERFLOW == 1 )
|
| 83 |
|
|
|
| 84 |
|
|
/* FreeRTOSConfig.h is only set to use the first method of
|
| 85 |
|
|
overflow checking. */
|
| 86 |
|
|
#define taskSECOND_CHECK_FOR_STACK_OVERFLOW()
|
| 87 |
|
|
|
| 88 |
|
|
#endif
|
| 89 |
|
|
/*-----------------------------------------------------------*/
|
| 90 |
|
|
|
| 91 |
|
|
#if( ( configCHECK_FOR_STACK_OVERFLOW > 0 ) && ( portSTACK_GROWTH < 0 ) )
|
| 92 |
|
|
|
| 93 |
|
|
/* Only the current stack state is to be checked. */
|
| 94 |
|
|
#define taskFIRST_CHECK_FOR_STACK_OVERFLOW() \
|
| 95 |
|
|
{ \
|
| 96 |
|
|
extern void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed char *pcTaskName ); \
|
| 97 |
|
|
\
|
| 98 |
|
|
/* Is the currently saved stack pointer within the stack limit? */ \
|
| 99 |
|
|
if( pxCurrentTCB->pxTopOfStack <= pxCurrentTCB->pxStack ) \
|
| 100 |
|
|
{ \
|
| 101 |
|
|
vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
|
| 102 |
|
|
} \
|
| 103 |
|
|
}
|
| 104 |
|
|
|
| 105 |
|
|
#endif /* configCHECK_FOR_STACK_OVERFLOW > 0 */
|
| 106 |
|
|
/*-----------------------------------------------------------*/
|
| 107 |
|
|
|
| 108 |
|
|
#if( ( configCHECK_FOR_STACK_OVERFLOW > 0 ) && ( portSTACK_GROWTH > 0 ) )
|
| 109 |
|
|
|
| 110 |
|
|
/* Only the current stack state is to be checked. */
|
| 111 |
|
|
#define taskFIRST_CHECK_FOR_STACK_OVERFLOW() \
|
| 112 |
|
|
{ \
|
| 113 |
|
|
extern void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed char *pcTaskName ); \
|
| 114 |
|
|
\
|
| 115 |
|
|
/* Is the currently saved stack pointer within the stack limit? */ \
|
| 116 |
|
|
if( pxCurrentTCB->pxTopOfStack >= pxCurrentTCB->pxEndOfStack ) \
|
| 117 |
|
|
{ \
|
| 118 |
|
|
vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
|
| 119 |
|
|
} \
|
| 120 |
|
|
}
|
| 121 |
|
|
|
| 122 |
|
|
#endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */
|
| 123 |
|
|
/*-----------------------------------------------------------*/
|
| 124 |
|
|
|
| 125 |
|
|
#if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH < 0 ) )
|
| 126 |
|
|
|
| 127 |
|
|
#define taskSECOND_CHECK_FOR_STACK_OVERFLOW() \
|
| 128 |
|
|
{ \
|
| 129 |
|
|
extern void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed char *pcTaskName ); \
|
| 130 |
|
|
static const unsigned char ucExpectedStackBytes[] = { tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
|
| 131 |
|
|
tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
|
| 132 |
|
|
tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
|
| 133 |
|
|
tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
|
| 134 |
|
|
tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE }; \
|
| 135 |
|
|
\
|
| 136 |
|
|
\
|
| 137 |
|
|
/* Has the extremity of the task stack ever been written over? */ \
|
| 138 |
|
|
if( memcmp( ( void * ) pxCurrentTCB->pxStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 ) \
|
| 139 |
|
|
{ \
|
| 140 |
|
|
vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
|
| 141 |
|
|
} \
|
| 142 |
|
|
}
|
| 143 |
|
|
|
| 144 |
|
|
#endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */
|
| 145 |
|
|
/*-----------------------------------------------------------*/
|
| 146 |
|
|
|
| 147 |
|
|
#if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH > 0 ) )
|
| 148 |
|
|
|
| 149 |
|
|
#define taskSECOND_CHECK_FOR_STACK_OVERFLOW() \
|
| 150 |
|
|
{ \
|
| 151 |
|
|
extern void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed char *pcTaskName ); \
|
| 152 |
|
|
char *pcEndOfStack = ( char * ) pxCurrentTCB->pxEndOfStack; \
|
| 153 |
|
|
static const unsigned char ucExpectedStackBytes[] = { tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
|
| 154 |
|
|
tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
|
| 155 |
|
|
tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
|
| 156 |
|
|
tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
|
| 157 |
|
|
tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE }; \
|
| 158 |
|
|
\
|
| 159 |
|
|
\
|
| 160 |
|
|
pcEndOfStack -= sizeof( ucExpectedStackBytes ); \
|
| 161 |
|
|
\
|
| 162 |
|
|
/* Has the extremity of the task stack ever been written over? */ \
|
| 163 |
|
|
if( memcmp( ( void * ) pcEndOfStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 ) \
|
| 164 |
|
|
{ \
|
| 165 |
|
|
vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
|
| 166 |
|
|
} \
|
| 167 |
|
|
}
|
| 168 |
|
|
|
| 169 |
|
|
#endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */
|
| 170 |
|
|
/*-----------------------------------------------------------*/
|
| 171 |
|
|
|
| 172 |
|
|
#endif /* STACK_MACROS_H */
|
| 173 |
|
|
|
