5
Last change
on this file since 0938899 was
0938899,
checked in by Andreas Dachsberger <andreas.dachsberger@…>, on 04/16/19 at 05:46:47
|
doxygen: score: adjust doc in stack.h to doxygen guidelines
Update #3706.
|
-
Property mode set to
100644
|
File size:
1.5 KB
|
Line | |
---|
1 | /** |
---|
2 | * @file |
---|
3 | * |
---|
4 | * @ingroup RTEMSScoreStack |
---|
5 | * |
---|
6 | * @brief Information About the Thread Stack Handler |
---|
7 | * |
---|
8 | * This include file contains all information about the thread |
---|
9 | * Stack Handler. This Handler provides mechanisms which can be used to |
---|
10 | * initialize and utilize stacks. |
---|
11 | */ |
---|
12 | |
---|
13 | /* |
---|
14 | * COPYRIGHT (c) 1989-2006. |
---|
15 | * On-Line Applications Research Corporation (OAR). |
---|
16 | * |
---|
17 | * The license and distribution terms for this file may be |
---|
18 | * found in the file LICENSE in this distribution or at |
---|
19 | * http://www.rtems.org/license/LICENSE. |
---|
20 | */ |
---|
21 | |
---|
22 | #ifndef _RTEMS_SCORE_STACK_H |
---|
23 | #define _RTEMS_SCORE_STACK_H |
---|
24 | |
---|
25 | #include <rtems/score/basedefs.h> |
---|
26 | |
---|
27 | #ifdef __cplusplus |
---|
28 | extern "C" { |
---|
29 | #endif |
---|
30 | |
---|
31 | /** |
---|
32 | * @defgroup RTEMSScoreStack Stack Handler |
---|
33 | * |
---|
34 | * @ingroup RTEMSScore |
---|
35 | * |
---|
36 | * @brief Stack Handler |
---|
37 | * |
---|
38 | * This handler encapsulates functionality which is used in the management |
---|
39 | * of thread stacks. |
---|
40 | * |
---|
41 | * @{ |
---|
42 | */ |
---|
43 | |
---|
44 | /** |
---|
45 | * The following constant defines the minimum stack size which every |
---|
46 | * thread must exceed. |
---|
47 | */ |
---|
48 | #define STACK_MINIMUM_SIZE CPU_STACK_MINIMUM_SIZE |
---|
49 | |
---|
50 | /** |
---|
51 | * The following defines the control block used to manage each stack. |
---|
52 | */ |
---|
53 | typedef struct { |
---|
54 | /** This is the stack size. */ |
---|
55 | size_t size; |
---|
56 | /** This is the low memory address of stack. */ |
---|
57 | void *area; |
---|
58 | } Stack_Control; |
---|
59 | |
---|
60 | /** |
---|
61 | * This variable contains the the minimum stack size; |
---|
62 | * |
---|
63 | * @note It is instantiated and set by User Configuration via confdefs.h. |
---|
64 | */ |
---|
65 | extern uint32_t rtems_minimum_stack_size; |
---|
66 | |
---|
67 | /** @} */ |
---|
68 | |
---|
69 | #ifdef __cplusplus |
---|
70 | } |
---|
71 | #endif |
---|
72 | |
---|
73 | #endif |
---|
74 | /* end of include file */ |
---|
Note: See
TracBrowser
for help on using the repository browser.