Blame view

Project/os/kernel/kernel.dox 3.73 KB
Imanol-Mikel Barba Sabariego authored
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/*
    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
                 2011,2012 Giovanni Di Sirio.

    This file is part of ChibiOS/RT.

    ChibiOS/RT is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    ChibiOS/RT is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

                                      ---

    A special exception to the GPL can be applied should you wish to distribute
    a combined work that includes ChibiOS/RT, without being obliged to provide
    the source code for any proprietary components. See the file exception.txt
    for full details of how and when the exception can be applied.
*/

/**
 * @defgroup kernel Kernel
 * @details The kernel is the portable part of ChibiOS/RT, this section
 *          documents the various kernel subsystems.
 */

/**
 * @defgroup kernel_info Version Numbers and Identification
 * @ingroup kernel
 */

/**
 * @defgroup config Configuration
 * @ingroup kernel
 */

/**
 * @defgroup types Types
 * @details The system types are defined into the port layer, please refer to
 * the core port implementation section.
 * @ingroup kernel
 */

/**
 * @defgroup base Base Kernel Services
 * @details Base kernel services, the base subsystems are always included in
 *          the OS builds.
 * @ingroup kernel
 */

/**
 * @defgroup system System Management
 * @ingroup base
 */

/**
 * @defgroup scheduler Scheduler
 * @ingroup base
 */

/**
 * @defgroup threads Threads
 * @ingroup base
 */

/**
 * @defgroup time Time and Virtual Timers
 * @ingroup base
 */

/**
 * @defgroup synchronization Synchronization
 * @details Synchronization services.
 * @ingroup kernel
 */

/**
 * @defgroup semaphores Counting Semaphores
 * @ingroup synchronization
 */

/**
 * @defgroup binary_semaphores Binary Semaphores
 * @ingroup synchronization
 */

/**
 * @defgroup mutexes Mutexes
 * @ingroup synchronization
 */

/**
 * @defgroup condvars Condition Variables
 * @ingroup synchronization
 */

/**
 * @defgroup events Event Flags
 * @ingroup synchronization
 */

/**
 * @defgroup messages Synchronous Messages
 * @ingroup synchronization
 */

/**
 * @defgroup mailboxes Mailboxes
 * @ingroup synchronization
 */

/**
 * @defgroup memory Memory Management
 * @details Memory Management services.
 * @ingroup kernel
 */

/**
 * @defgroup memcore Core Memory Manager
 * @ingroup memory
 */

/**
 * @defgroup heaps Heaps
 * @ingroup memory
 */

/**
 * @defgroup pools Memory Pools
 * @ingroup memory
 */

/**
 * @defgroup dynamic_threads Dynamic Threads
 * @ingroup memory
 */

 /**
 * @defgroup io_support I/O Support
 * @details I/O related services.
 * @ingroup kernel
 */

/**
 * @defgroup data_streams Abstract Sequential Streams
 * @ingroup io_support
 */

/**
 * @defgroup data_files Abstract File Streams
 * @ingroup io_support
 */

/**
 * @defgroup io_channels Abstract I/O Channels
 * @ingroup io_support
 */

/**
 * @defgroup io_queues I/O Queues
 * @ingroup io_support
 */

/**
 * @defgroup registry Registry
 * @ingroup kernel
 */

/**
 * @defgroup debug Debug
 * @ingroup kernel
 */

/**
 * @defgroup internals Internals
 * @ingroup kernel
 */