GM6000 Digital Heater Controller Branch: main
SDX-1330
stack_macros.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/*
33 * Call the stack overflow hook function if the stack of the task being swapped
34 * out is currently overflowed, or looks like it might have overflowed in the
35 * past.
36 *
37 * Setting configCHECK_FOR_STACK_OVERFLOW to 1 will cause the macro to check
38 * the current stack state only - comparing the current top of stack value to
39 * the stack limit. Setting configCHECK_FOR_STACK_OVERFLOW to greater than 1
40 * will also cause the last few stack bytes to be checked to ensure the value
41 * to which the bytes were set when the task was created have not been
42 * overwritten. Note this second test does not guarantee that an overflowed
43 * stack will always be recognised.
44 */
45
46/*-----------------------------------------------------------*/
47
48#if ((configCHECK_FOR_STACK_OVERFLOW == 1) && (portSTACK_GROWTH < 0))
49
50/* Only the current stack state is to be checked. */
51#define taskCHECK_FOR_STACK_OVERFLOW() \
52 { \
53 /* Is the currently saved stack pointer within the stack limit? */ \
54 if (pxCurrentTCB->pxTopOfStack <= pxCurrentTCB->pxStack) { \
55 vApplicationStackOverflowHook((TaskHandle_t)pxCurrentTCB, pxCurrentTCB->pcTaskName); \
56 } \
57 }
58
59#endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */
60/*-----------------------------------------------------------*/
61
62#if ((configCHECK_FOR_STACK_OVERFLOW == 1) && (portSTACK_GROWTH > 0))
63
64/* Only the current stack state is to be checked. */
65#define taskCHECK_FOR_STACK_OVERFLOW() \
66 { \
67 \
68 /* Is the currently saved stack pointer within the stack limit? */ \
69 if (pxCurrentTCB->pxTopOfStack >= pxCurrentTCB->pxEndOfStack) { \
70 vApplicationStackOverflowHook((TaskHandle_t)pxCurrentTCB, pxCurrentTCB->pcTaskName); \
71 } \
72 }
73
74#endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */
75/*-----------------------------------------------------------*/
76
77#if ((configCHECK_FOR_STACK_OVERFLOW > 1) && (portSTACK_GROWTH < 0))
78
79#define taskCHECK_FOR_STACK_OVERFLOW() \
80 { \
81 const uint32_t *const pulStack = (uint32_t *)pxCurrentTCB->pxStack; \
82 const uint32_t ulCheckValue = (uint32_t)0xa5a5a5a5; \
83 \
84 if ((pulStack[0] != ulCheckValue) || (pulStack[1] != ulCheckValue) || (pulStack[2] != ulCheckValue) \
85 || (pulStack[3] != ulCheckValue)) { \
86 vApplicationStackOverflowHook((TaskHandle_t)pxCurrentTCB, pxCurrentTCB->pcTaskName); \
87 } \
88 }
89
90#endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */
91/*-----------------------------------------------------------*/
92
93#if ((configCHECK_FOR_STACK_OVERFLOW > 1) && (portSTACK_GROWTH > 0))
94
95#define taskCHECK_FOR_STACK_OVERFLOW() \
96 { \
97 int8_t * pcEndOfStack = (int8_t *)pxCurrentTCB->pxEndOfStack; \
98 static const uint8_t ucExpectedStackBytes[] \
99 = {tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
100 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
101 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
102 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE}; \
103 \
104 pcEndOfStack -= sizeof(ucExpectedStackBytes); \
105 \
106 /* Has the extremity of the task stack ever been written over? */ \
107 if (memcmp((void *)pcEndOfStack, (void *)ucExpectedStackBytes, sizeof(ucExpectedStackBytes)) != 0) { \
108 vApplicationStackOverflowHook((TaskHandle_t)pxCurrentTCB, pxCurrentTCB->pcTaskName); \
109 } \
110 }
111
112#endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */
113/*-----------------------------------------------------------*/
114
115/* Remove stack overflow macro if not being used. */
116#ifndef taskCHECK_FOR_STACK_OVERFLOW
117#define taskCHECK_FOR_STACK_OVERFLOW()
118#endif
119
120#endif /* STACK_MACROS_H */
Generated on Sat Jan 18 2025 22:23:55 for GM6000 Digital Heater Controller by doxygen 1.9.8