/* | |
FreeRTOS.org V5.2.0 - Copyright (C) 2003-2009 Richard Barry. | |
This file is part of the FreeRTOS.org distribution. | |
FreeRTOS.org is free software; you can redistribute it and/or modify it | |
under the terms of the GNU General Public License (version 2) as published | |
by the Free Software Foundation and modified by the FreeRTOS exception. | |
FreeRTOS.org is distributed in the hope that it will be useful, but WITHOUT | |
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for | |
more details. | |
You should have received a copy of the GNU General Public License along | |
with FreeRTOS.org; if not, write to the Free Software Foundation, Inc., 59 | |
Temple Place, Suite 330, Boston, MA 02111-1307 USA. | |
A special exception to the GPL is included to allow you to distribute a | |
combined work that includes FreeRTOS.org without being obliged to provide | |
the source code for any proprietary components. See the licensing section | |
of http://www.FreeRTOS.org for full details. | |
*************************************************************************** | |
* * | |
* Get the FreeRTOS eBook! See http://www.FreeRTOS.org/Documentation * | |
* * | |
* This is a concise, step by step, 'hands on' guide that describes both * | |
* general multitasking concepts and FreeRTOS specifics. It presents and * | |
* explains numerous examples that are written using the FreeRTOS API. * | |
* Full source code for all the examples is provided in an accompanying * | |
* .zip file. * | |
* * | |
*************************************************************************** | |
1 tab == 4 spaces! | |
Please ensure to read the configuration and relevant port sections of the | |
online documentation. | |
http://www.FreeRTOS.org - Documentation, latest information, license and | |
contact details. | |
http://www.SafeRTOS.com - A version that is certified for use in safety | |
critical systems. | |
http://www.OpenRTOS.com - Commercial support, development, porting, | |
licensing and training services. | |
*/ | |
#ifndef STACK_MACROS_H | |
#define STACK_MACROS_H | |
/* | |
* Call the stack overflow hook function if the stack of the task being swapped | |
* out is currently overflowed, or looks like it might have overflowed in the | |
* past. | |
* | |
* Setting configCHECK_FOR_STACK_OVERFLOW to 1 will cause the macro to check | |
* the current stack state only - comparing the current top of stack value to | |
* the stack limit. Setting configCHECK_FOR_STACK_OVERFLOW to greater than 1 | |
* will also cause the last few stack bytes to be checked to ensure the value | |
* to which the bytes were set when the task was created have not been | |
* overwritten. Note this second test does not guarantee that an overflowed | |
* stack will always be recognised. | |
*/ | |
/*-----------------------------------------------------------*/ | |
#if( configCHECK_FOR_STACK_OVERFLOW == 0 ) | |
/* FreeRTOSConfig.h is not set to check for stack overflows. */ | |
#define taskFIRST_CHECK_FOR_STACK_OVERFLOW() | |
#define taskSECOND_CHECK_FOR_STACK_OVERFLOW() | |
#endif /* configCHECK_FOR_STACK_OVERFLOW == 0 */ | |
/*-----------------------------------------------------------*/ | |
#if( configCHECK_FOR_STACK_OVERFLOW == 1 ) | |
/* FreeRTOSConfig.h is only set to use the first method of | |
overflow checking. */ | |
#define taskSECOND_CHECK_FOR_STACK_OVERFLOW() | |
#endif | |
/*-----------------------------------------------------------*/ | |
#if( ( configCHECK_FOR_STACK_OVERFLOW > 0 ) && ( portSTACK_GROWTH < 0 ) ) | |
/* Only the current stack state is to be checked. */ | |
#define taskFIRST_CHECK_FOR_STACK_OVERFLOW() \ | |
{ \ | |
extern void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed portCHAR *pcTaskName ); \ | |
\ | |
/* Is the currently saved stack pointer within the stack limit? */ \ | |
if( pxCurrentTCB->pxTopOfStack <= pxCurrentTCB->pxStack ) \ | |
{ \ | |
vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \ | |
} \ | |
} | |
#endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */ | |
/*-----------------------------------------------------------*/ | |
#if( ( configCHECK_FOR_STACK_OVERFLOW > 0 ) && ( portSTACK_GROWTH > 0 ) ) | |
/* Only the current stack state is to be checked. */ | |
#define taskFIRST_CHECK_FOR_STACK_OVERFLOW() \ | |
{ \ | |
extern void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed portCHAR *pcTaskName ); \ | |
\ | |
/* Is the currently saved stack pointer within the stack limit? */ \ | |
if( pxCurrentTCB->pxTopOfStack >= pxCurrentTCB->pxEndOfStack ) \ | |
{ \ | |
vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \ | |
} \ | |
} | |
#endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */ | |
/*-----------------------------------------------------------*/ | |
#if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH < 0 ) ) | |
#define taskSECOND_CHECK_FOR_STACK_OVERFLOW() \ | |
{ \ | |
extern void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed portCHAR *pcTaskName ); \ | |
static const unsigned portCHAR ucExpectedStackBytes[] = { tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \ | |
tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \ | |
tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \ | |
tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \ | |
tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE }; \ | |
\ | |
\ | |
/* Has the extremity of the task stack ever been written over? */ \ | |
if( memcmp( ( void * ) pxCurrentTCB->pxStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 ) \ | |
{ \ | |
vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \ | |
} \ | |
} | |
#endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */ | |
/*-----------------------------------------------------------*/ | |
#if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH > 0 ) ) | |
#define taskSECOND_CHECK_FOR_STACK_OVERFLOW() \ | |
{ \ | |
extern void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed portCHAR *pcTaskName ); \ | |
portCHAR *pcEndOfStack = ( portCHAR * ) pxCurrentTCB->pxEndOfStack; \ | |
static const unsigned portCHAR ucExpectedStackBytes[] = { tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \ | |
tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \ | |
tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \ | |
tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \ | |
tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE }; \ | |
\ | |
\ | |
pcEndOfStack -= sizeof( ucExpectedStackBytes ); \ | |
\ | |
/* Has the extremity of the task stack ever been written over? */ \ | |
if( memcmp( ( void * ) pcEndOfStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 ) \ | |
{ \ | |
vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \ | |
} \ | |
} | |
#endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */ | |
/*-----------------------------------------------------------*/ | |
#endif /* STACK_MACROS_H */ | |