aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-03-08 15:58:28 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-03-08 15:58:28 +0000
commit773f580e37e9248096bc25eb0e64af292a5f53bd (patch)
treecb16fe6e952b49356ac1dce7647c725e8834c5fa /docs
parentd730c17bf29d98d28969a02c6e98364c4815cdf2 (diff)
downloadChibiOS-773f580e37e9248096bc25eb0e64af292a5f53bd.tar.gz
ChibiOS-773f580e37e9248096bc25eb0e64af292a5f53bd.tar.bz2
ChibiOS-773f580e37e9248096bc25eb0e64af292a5f53bd.zip
Added architecture diagram to the concepts page.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@820 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'docs')
-rw-r--r--docs/src/concepts.dox27
1 files changed, 25 insertions, 2 deletions
diff --git a/docs/src/concepts.dox b/docs/src/concepts.dox
index 360e5f4f2..d8d874bac 100644
--- a/docs/src/concepts.dox
+++ b/docs/src/concepts.dox
@@ -18,9 +18,19 @@
*/
/**
- * @page concepts Concepts
+ * @page concepts Concepts and Architecture
* @{
* @brief ChibiOS/RT Concepts and Architecture
+ * - @ref naming
+ * - @ref api_suffixes
+ * - @ref interrupt_classes
+ * - @ref system_states
+ * - @ref scheduling
+ * - @ref thread_states
+ * - @ref priority
+ * - @ref warea
+ * - @ref architecture
+ * .
* @section naming Naming Conventions
* ChibiOS/RT APIs are all named following this convention:
* @a ch\<group\>\<action\>\<suffix\>().
@@ -218,7 +228,7 @@
* (inclusive) are reserved. This is the highest numerical value of the
* priorities space.
* .
- * @section warea Thread Working Area
+ * @section warea Threads Working Area
* Each thread has its own stack, a Thread structure and some preemption
* areas. All the structures are allocated into a "Thread Working Area",
* a thread private heap, usually statically declared in your code.
@@ -237,5 +247,18 @@
* .
* See the @ref Core documentation for details, the area may change on
* the various ports and some structures may not be present (or be zero-sized).
+ *
+ * @section architecture Architectural Diagram
+ * The following diagram shows the relationships among the hardware, the
+ * various ChibiOS/RT subsystems and the application code.
+ * <br><br>
+ * @image html arch.png
+ * <br>
+ * In this diagram the device drivers are at the same level of the application
+ * code because both have access to the system services and can directly
+ * access the hardware.<br>
+ * Of course it is possible to create in the application architecture several
+ * extra layers, this is just not part of the kernel architecture but part of
+ * the overall system design.
*/
/** @} */