aboutsummaryrefslogtreecommitdiffstats
path: root/os/rt/rt.dox
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2013-08-10 14:56:07 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2013-08-10 14:56:07 +0000
commitff1b36acdc78609a835e3e20bf9897399c08806f (patch)
tree4663f23c18cb0a7da77388e5ea11619340043cea /os/rt/rt.dox
parent101156b2e64976b44b2a63af7156a98755f7bcdd (diff)
downloadChibiOS-ff1b36acdc78609a835e3e20bf9897399c08806f.tar.gz
ChibiOS-ff1b36acdc78609a835e3e20bf9897399c08806f.tar.bz2
ChibiOS-ff1b36acdc78609a835e3e20bf9897399c08806f.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/branches/kernel_3_dev@6125 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/rt/rt.dox')
-rw-r--r--os/rt/rt.dox173
1 files changed, 173 insertions, 0 deletions
diff --git a/os/rt/rt.dox b/os/rt/rt.dox
new file mode 100644
index 000000000..05753a8f6
--- /dev/null
+++ b/os/rt/rt.dox
@@ -0,0 +1,173 @@
+/*
+ ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
+ 2011,2012,2013 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/>.
+*/
+
+/**
+ * @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 io_queues I/O Queues
+ * @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 streams Streams and Files
+ * @details Stream and Files interfaces.
+ * @ingroup kernel
+ */
+
+/**
+ * @defgroup data_streams Abstract Sequential Streams
+ * @ingroup streams
+ */
+
+/**
+ * @defgroup data_files Abstract File Streams
+ * @ingroup streams
+ */
+
+/**
+ * @defgroup registry Registry
+ * @ingroup kernel
+ */
+
+/**
+ * @defgroup debug Debug
+ * @ingroup kernel
+ */
+
+/**
+ * @defgroup internals Internals
+ * @ingroup kernel
+ */
+