2 FreeRTOS V7.4.0 - Copyright (C) 2013 Real Time Engineers Ltd.
4 FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME. PLEASE VISIT
5 http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
7 ***************************************************************************
9 * FreeRTOS tutorial books are available in pdf and paperback. *
10 * Complete, revised, and edited pdf reference manuals are also *
13 * Purchasing FreeRTOS documentation will not only help you, by *
14 * ensuring you get running as quickly as possible and with an *
15 * in-depth knowledge of how to use FreeRTOS, it will also help *
16 * the FreeRTOS project to continue with its mission of providing *
17 * professional grade, cross platform, de facto standard solutions *
18 * for microcontrollers - completely free of charge! *
20 * >>> See http://www.FreeRTOS.org/Documentation for details. <<< *
22 * Thank you for using FreeRTOS, and thank you for your support! *
24 ***************************************************************************
27 This file is part of the FreeRTOS distribution.
29 FreeRTOS is free software; you can redistribute it and/or modify it under
30 the terms of the GNU General Public License (version 2) as published by the
31 Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
33 >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to
34 distribute a combined work that includes FreeRTOS without being obliged to
35 provide the source code for proprietary components outside of the FreeRTOS
38 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
39 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
40 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
41 details. You should have received a copy of the GNU General Public License
42 and the FreeRTOS license exception along with FreeRTOS; if not itcan be
43 viewed here: http://www.freertos.org/a00114.html and also obtained by
44 writing to Real Time Engineers Ltd., contact details for whom are available
45 on the FreeRTOS WEB site.
49 ***************************************************************************
51 * Having a problem? Start by reading the FAQ "My application does *
52 * not run, what could be wrong?" *
54 * http://www.FreeRTOS.org/FAQHelp.html *
56 ***************************************************************************
59 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
60 license and Real Time Engineers Ltd. contact details.
62 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
63 including FreeRTOS+Trace - an indispensable productivity tool, and our new
64 fully thread aware and reentrant UDP/IP stack.
66 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
67 Integrity Systems, who sell the code with commercial support,
68 indemnification and middleware, under the OpenRTOS brand.
70 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
71 engineered and independently SIL3 certified version for use in safety and
72 mission critical applications that require provable dependability.
75 #ifndef STACK_MACROS_H
76 #define STACK_MACROS_H
79 * Call the stack overflow hook function if the stack of the task being swapped
80 * out is currently overflowed, or looks like it might have overflowed in the
83 * Setting configCHECK_FOR_STACK_OVERFLOW to 1 will cause the macro to check
84 * the current stack state only - comparing the current top of stack value to
85 * the stack limit. Setting configCHECK_FOR_STACK_OVERFLOW to greater than 1
86 * will also cause the last few stack bytes to be checked to ensure the value
87 * to which the bytes were set when the task was created have not been
88 * overwritten. Note this second test does not guarantee that an overflowed
89 * stack will always be recognised.
92 /*-----------------------------------------------------------*/
94 #if( configCHECK_FOR_STACK_OVERFLOW == 0 )
96 /* FreeRTOSConfig.h is not set to check for stack overflows. */
97 #define taskFIRST_CHECK_FOR_STACK_OVERFLOW()
98 #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()
100 #endif /* configCHECK_FOR_STACK_OVERFLOW == 0 */
101 /*-----------------------------------------------------------*/
103 #if( configCHECK_FOR_STACK_OVERFLOW == 1 )
105 /* FreeRTOSConfig.h is only set to use the first method of
106 overflow checking. */
107 #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()
110 /*-----------------------------------------------------------*/
112 #if( ( configCHECK_FOR_STACK_OVERFLOW > 0 ) && ( portSTACK_GROWTH < 0 ) )
114 /* Only the current stack state is to be checked. */
115 #define taskFIRST_CHECK_FOR_STACK_OVERFLOW() \
117 /* Is the currently saved stack pointer within the stack limit? */ \
118 if( pxCurrentTCB->pxTopOfStack <= pxCurrentTCB->pxStack ) \
120 vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
124 #endif /* configCHECK_FOR_STACK_OVERFLOW > 0 */
125 /*-----------------------------------------------------------*/
127 #if( ( configCHECK_FOR_STACK_OVERFLOW > 0 ) && ( portSTACK_GROWTH > 0 ) )
129 /* Only the current stack state is to be checked. */
130 #define taskFIRST_CHECK_FOR_STACK_OVERFLOW() \
133 /* Is the currently saved stack pointer within the stack limit? */ \
134 if( pxCurrentTCB->pxTopOfStack >= pxCurrentTCB->pxEndOfStack ) \
136 vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
140 #endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */
141 /*-----------------------------------------------------------*/
143 #if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH < 0 ) )
145 #define taskSECOND_CHECK_FOR_STACK_OVERFLOW() \
147 static const unsigned char ucExpectedStackBytes[] = { tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
148 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
149 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
150 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
151 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE }; \
154 /* Has the extremity of the task stack ever been written over? */ \
155 if( memcmp( ( void * ) pxCurrentTCB->pxStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 ) \
157 vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
161 #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */
162 /*-----------------------------------------------------------*/
164 #if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH > 0 ) )
166 #define taskSECOND_CHECK_FOR_STACK_OVERFLOW() \
168 char *pcEndOfStack = ( char * ) pxCurrentTCB->pxEndOfStack; \
169 static const unsigned char ucExpectedStackBytes[] = { tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
170 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
171 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
172 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
173 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE }; \
176 pcEndOfStack -= sizeof( ucExpectedStackBytes ); \
178 /* Has the extremity of the task stack ever been written over? */ \
179 if( memcmp( ( void * ) pcEndOfStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 ) \
181 vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
185 #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */
186 /*-----------------------------------------------------------*/
188 #endif /* STACK_MACROS_H */