ChibiOS/RT  6.1.4
chsystypes.h
Go to the documentation of this file.
1 /*
2  ChibiOS - Copyright (C) 2006,2007,2008,2009,2010,2011,2012,2013,2014,
3  2015,2016,2017,2018,2019,2020,2021 Giovanni Di Sirio.
4 
5  This file is part of ChibiOS.
6 
7  ChibiOS is free software; you can redistribute it and/or modify
8  it under the terms of the GNU General Public License as published by
9  the Free Software Foundation version 3 of the License.
10 
11  ChibiOS is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19 
20 /**
21  * @file rt/include/chsystypes.h
22  * @brief System types header.
23  *
24  * @addtogroup scheduler
25  * @{
26  */
27 
28 #ifndef CHSYSTYPES_H
29 #define CHSYSTYPES_H
30 
31 /*===========================================================================*/
32 /* Module constants. */
33 /*===========================================================================*/
34 
35 /*===========================================================================*/
36 /* Module pre-compile time settings. */
37 /*===========================================================================*/
38 
39 /*===========================================================================*/
40 /* Derived constants and error checks. */
41 /*===========================================================================*/
42 
43 /*===========================================================================*/
44 /* Module data structures and types. */
45 /*===========================================================================*/
46 
47 /**
48  * @extends threads_queue_t
49  *
50  * @brief Type of a thread structure.
51  */
52 typedef struct ch_thread thread_t;
53 
54 /**
55  * @brief Type of a thread reference.
56  */
57 typedef thread_t * thread_reference_t;
58 
59 /**
60  * @brief Type of a generic threads single link list, it works like a stack.
61  */
62 typedef struct ch_threads_list threads_list_t;
63 
64 /**
65  * @extends threads_list_t
66  *
67  * @brief Type of a generic threads bidirectional linked list header and element.
68  */
69 typedef struct ch_threads_queue threads_queue_t;
70 
71 /**
72  * @extends threads_queue_t
73  *
74  * @brief Type of a ready list header.
75  */
76 typedef struct ch_ready_list ready_list_t;
77 
78 /**
79  * @brief Type of a Virtual Timer callback function.
80  */
81 typedef void (*vtfunc_t)(void *p);
82 
83 /**
84  * @brief Type of a Virtual Timer structure.
85  */
86 typedef struct ch_virtual_timer virtual_timer_t;
87 
88 /**
89  * @brief Type of virtual timers list header.
90  */
91 typedef struct ch_virtual_timers_list virtual_timers_list_t;
92 
93 /**
94  * @brief Type of a system debug structure.
95  */
96 typedef struct ch_system_debug system_debug_t;
97 
98 /**
99  * @brief Type of system data structure.
100  */
101 typedef struct ch_system ch_system_t;
102 
103 /*===========================================================================*/
104 /* Module macros. */
105 /*===========================================================================*/
106 
107 /**
108  * @brief Utility to make the parameter a quoted string.
109  */
110 #define __CH_STRINGIFY(a) #a
111 
112 /*===========================================================================*/
113 /* External declarations. */
114 /*===========================================================================*/
115 
116 #ifdef __cplusplus
117 extern "C" {
118 #endif
119 
120 #ifdef __cplusplus
121 }
122 #endif
123 
124 /*===========================================================================*/
125 /* Module inline functions. */
126 /*===========================================================================*/
127 
128 #endif /* CHSYSTYPES_H */
129 
130 /** @} */
ch_threads_queue
Structure representing a threads queue.
Definition: chschd.h:124
ch_system
System data structure.
Definition: chschd.h:414
ch_thread
Structure representing a thread.
Definition: chschd.h:134
thread_reference_t
thread_t * thread_reference_t
Type of a thread reference.
Definition: chsystypes.h:57
ch_system_debug
System debug data structure.
Definition: chschd.h:382
ready_list_t
struct ch_ready_list ready_list_t
Type of a ready list header.
Definition: chsystypes.h:76
ch_virtual_timer
Structure representing a Virtual Timer.
Definition: chschd.h:321
ch_virtual_timers_list
Structure representing a virtual timers list header.
Definition: chschd.h:335
vtfunc_t
void(* vtfunc_t)(void *p)
Type of a Virtual Timer callback function.
Definition: chsystypes.h:81
threads_list_t
struct ch_threads_list threads_list_t
Type of a generic threads single link list, it works like a stack.
Definition: chsystypes.h:62