GM6000 Digital Heater Controller Branch: main
SDX-1330
StackMacros.h
1/*
2 * FreeRTOS Kernel V10.0.0
3 * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
6 * this software and associated documentation files (the "Software"), to deal in
7 * the Software without restriction, including without limitation the rights to
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9 * the Software, and to permit persons to whom the Software is furnished to do so,
10 * subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software. If you wish to use our Amazon
14 * FreeRTOS name, please do so in a fair use way that does not cause confusion.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
18 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
19 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
20 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 *
23 * http://www.FreeRTOS.org
24 * http://aws.amazon.com/freertos
25 *
26 * 1 tab == 4 spaces!
27 */
28
29#ifndef STACK_MACROS_H
30#define STACK_MACROS_H
31
32#ifndef _MSC_VER /* Visual Studio doesn't support #warning. */
33#warning The name of this file has changed to stack_macros.h. Please update your code accordingly. This source file (which has the original name) will be removed in future released.
34#endif
35
36/*
37 * Call the stack overflow hook function if the stack of the task being swapped
38 * out is currently overflowed, or looks like it might have overflowed in the
39 * past.
40 *
41 * Setting configCHECK_FOR_STACK_OVERFLOW to 1 will cause the macro to check
42 * the current stack state only - comparing the current top of stack value to
43 * the stack limit. Setting configCHECK_FOR_STACK_OVERFLOW to greater than 1
44 * will also cause the last few stack bytes to be checked to ensure the value
45 * to which the bytes were set when the task was created have not been
46 * overwritten. Note this second test does not guarantee that an overflowed
47 * stack will always be recognised.
48 */
49
50/*-----------------------------------------------------------*/
51
52#if ((configCHECK_FOR_STACK_OVERFLOW == 1) && (portSTACK_GROWTH < 0))
53
54/* Only the current stack state is to be checked. */
55#define taskCHECK_FOR_STACK_OVERFLOW() \
56 { \
57 /* Is the currently saved stack pointer within the stack limit? */ \
58 if (pxCurrentTCB->pxTopOfStack <= pxCurrentTCB->pxStack) { \
59 vApplicationStackOverflowHook((TaskHandle_t)pxCurrentTCB, pxCurrentTCB->pcTaskName); \
60 } \
61 }
62
63#endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */
64/*-----------------------------------------------------------*/
65
66#if ((configCHECK_FOR_STACK_OVERFLOW == 1) && (portSTACK_GROWTH > 0))
67
68/* Only the current stack state is to be checked. */
69#define taskCHECK_FOR_STACK_OVERFLOW() \
70 { \
71 \
72 /* Is the currently saved stack pointer within the stack limit? */ \
73 if (pxCurrentTCB->pxTopOfStack >= pxCurrentTCB->pxEndOfStack) { \
74 vApplicationStackOverflowHook((TaskHandle_t)pxCurrentTCB, pxCurrentTCB->pcTaskName); \
75 } \
76 }
77
78#endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */
79/*-----------------------------------------------------------*/
80
81#if ((configCHECK_FOR_STACK_OVERFLOW > 1) && (portSTACK_GROWTH < 0))
82
83#define taskCHECK_FOR_STACK_OVERFLOW() \
84 { \
85 const uint32_t *const pulStack = (uint32_t *)pxCurrentTCB->pxStack; \
86 const uint32_t ulCheckValue = (uint32_t)0xa5a5a5a5; \
87 \
88 if ((pulStack[0] != ulCheckValue) || (pulStack[1] != ulCheckValue) || (pulStack[2] != ulCheckValue) \
89 || (pulStack[3] != ulCheckValue)) { \
90 vApplicationStackOverflowHook((TaskHandle_t)pxCurrentTCB, pxCurrentTCB->pcTaskName); \
91 } \
92 }
93
94#endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */
95/*-----------------------------------------------------------*/
96
97#if ((configCHECK_FOR_STACK_OVERFLOW > 1) && (portSTACK_GROWTH > 0))
98
99#define taskCHECK_FOR_STACK_OVERFLOW() \
100 { \
101 int8_t * pcEndOfStack = (int8_t *)pxCurrentTCB->pxEndOfStack; \
102 static const uint8_t ucExpectedStackBytes[] \
103 = {tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
104 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
105 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
106 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE}; \
107 \
108 pcEndOfStack -= sizeof(ucExpectedStackBytes); \
109 \
110 /* Has the extremity of the task stack ever been written over? */ \
111 if (memcmp((void *)pcEndOfStack, (void *)ucExpectedStackBytes, sizeof(ucExpectedStackBytes)) != 0) { \
112 vApplicationStackOverflowHook((TaskHandle_t)pxCurrentTCB, pxCurrentTCB->pcTaskName); \
113 } \
114 }
115
116#endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */
117/*-----------------------------------------------------------*/
118
119/* Remove stack overflow macro if not being used. */
120#ifndef taskCHECK_FOR_STACK_OVERFLOW
121#define taskCHECK_FOR_STACK_OVERFLOW()
122#endif
123
124#endif /* STACK_MACROS_H */
Generated on Sat Jan 18 2025 22:23:55 for GM6000 Digital Heater Controller by doxygen 1.9.8