aboutsummaryrefslogtreecommitdiff
path: root/lib/chibios/os/rt/dox/rt.dox
diff options
context:
space:
mode:
Diffstat (limited to 'lib/chibios/os/rt/dox/rt.dox')
-rw-r--r--lib/chibios/os/rt/dox/rt.dox157
1 files changed, 157 insertions, 0 deletions
diff --git a/lib/chibios/os/rt/dox/rt.dox b/lib/chibios/os/rt/dox/rt.dox
new file mode 100644
index 000000000..56d6e08e5
--- /dev/null
+++ b/lib/chibios/os/rt/dox/rt.dox
@@ -0,0 +1,157 @@
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 * @defgroup kernel RT Kernel
22 * @details The kernel is the portable part of ChibiOS/RT, this section
23 * documents the various kernel subsystems.
24 */
25
26/**
27 * @defgroup kernel_info Version Numbers and Identification
28 * @ingroup kernel
29 */
30
31/**
32 * @defgroup config_category Configuration
33 * @ingroup kernel
34 */
35
36/**
37 * @defgroup config Options
38 * @ingroup config_category
39 */
40
41/**
42 * @defgroup conf_checks Checks
43 * @ingroup config_category
44 */
45
46/**
47 * @defgroup rt_restrictions Restrictions
48 * @ingroup config_category
49 */
50
51/**
52 * @defgroup base Base Kernel Services
53 * @details Base kernel services, the base subsystems are always included in
54 * the OS builds.
55 * @ingroup kernel
56 */
57
58/**
59 * @defgroup mem Memory Alignment
60 * @ingroup base
61 */
62
63/**
64 * @defgroup system System Management
65 * @ingroup base
66 */
67
68/**
69 * @defgroup os_lists Lists and Queues
70 * @ingroup base
71 */
72
73/**
74 * @defgroup scheduler Scheduler
75 * @ingroup base
76 */
77
78/**
79 * @defgroup time_intervals Time and Intervals
80 * @ingroup base
81 */
82
83/**
84 * @defgroup time Virtual Timers
85 * @ingroup base
86 */
87
88/**
89 * @defgroup threads Threads
90 * @ingroup base
91 */
92
93/**
94 * @defgroup time_measurement Time Measurement
95 * @ingroup base
96 */
97
98/**
99 * @defgroup synchronization Synchronization
100 * @details Synchronization services.
101 * @ingroup kernel
102 */
103
104/**
105 * @defgroup semaphores Counting Semaphores
106 * @ingroup synchronization
107 */
108
109/**
110 * @defgroup mutexes Mutexes
111 * @ingroup synchronization
112 */
113
114/**
115 * @defgroup condvars Condition Variables
116 * @ingroup synchronization
117 */
118
119/**
120 * @defgroup events Event Flags
121 * @ingroup synchronization
122 */
123
124/**
125 * @defgroup messages Synchronous Messages
126 * @ingroup synchronization
127 */
128
129/**
130 * @defgroup dynamic_threads Dynamic Threads
131 * @ingroup kernel
132 */
133
134/**
135 * @defgroup registry Registry
136 * @ingroup kernel
137 */
138
139/**
140 * @defgroup debug Debug
141 * @ingroup kernel
142 */
143
144/**
145 * @defgroup checks_assertions Checks and Assertions
146 * @ingroup debug
147 */
148
149/**
150 * @defgroup trace Tracing
151 * @ingroup debug
152 */
153
154/**
155 * @defgroup statistics Statistics
156 * @ingroup debug
157 */