diff options
Diffstat (limited to 'os/hal/dox/main.dox')
| -rw-r--r-- | os/hal/dox/main.dox | 132 |
1 files changed, 132 insertions, 0 deletions
diff --git a/os/hal/dox/main.dox b/os/hal/dox/main.dox new file mode 100644 index 000000000..a704c9c90 --- /dev/null +++ b/os/hal/dox/main.dox @@ -0,0 +1,132 @@ +/*
+ ChibiOS - Copyright (C) 2006,2007,2008,2009,2010,
+ 2011,2012,2013,2014 Giovanni Di Sirio.
+
+ This file is part of ChibiOS/HAL
+
+ ChibiOS/HAL 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 IO HAL
+ * @brief Hardware Abstraction Layer.
+ * @details Under ChibiOS/RT the set of the various device driver interfaces
+ * is called the HAL subsystem: Hardware Abstraction Layer. The HAL is the
+ * abstract interface between ChibiOS/RT application and hardware.
+ *
+ * @section hal_device_driver_arch HAL Device Drivers Architecture
+ * The HAL contains several kind of modules:
+ * - Normal Device Drivers
+ * - Complex Device Drivers
+ * - Interfaces
+ * - Inner Code
+ * .
+ * @section hal_normal_device_drivers HAL Normal Device Drivers
+ * Normal device are meant to interface the application to the underlying
+ * hardware through an high level API. Normal Device Drivers are split in two
+ * layers:
+ * - High Level Device Driver (<b>HLD</b>). This layer contains the definitions
+ * of the driver's APIs and the platform independent part of the driver.<br>
+ * An HLD is composed by two files:
+ * - @p @<driver@>.c, the HLD implementation file. This file must be
+ * included in the Makefile in order to use the driver.
+ * - @p @<driver@>.h, the HLD header file. This file is implicitly
+ * included by the HAL header file @p hal.h.
+ * .
+ * - Low Level Device Driver (<b>LLD</b>). This layer contains the platform
+ * dependent part of the driver.<br>
+ * A LLD is composed by two files:
+ * - @p @<driver@>_lld.c, the LLD implementation file. This file must be
+ * included in the Makefile in order to use the driver.
+ * - @p @<driver@>_lld.h, the LLD header file. This file is implicitly
+ * included by the HLD header file.
+ * .
+ * .
+ * @subsection hal_device_driver_diagram Diagram
+ * @dot
+ digraph example {
+ graph [size="5, 7", pad="1.5, 0"];
+ node [shape=rectangle, fontname=Helvetica, fontsize=8,
+ fixedsize="true", width="2.0", height="0.4"];
+ edge [fontname=Helvetica, fontsize=8];
+
+ app [label="Application"];
+ hld [label="High Level Driver"];
+ lld [label="Low Level Driver"];
+ hw [label="Microcontroller Hardware"];
+ hal_lld [label="HAL shared low level code"];
+
+ app->hld;
+ hld->lld;
+ lld-> hw;
+ lld->hal_lld;
+ hal_lld->hw;
+ }
+ * @enddot
+ *
+ * @section hal_complex_device_drivers HAL Complex Device Drivers
+ * It is a class of device drivers that offer an high level API but do not
+ * use the hardware directly. Complex device drivers use other drivers for
+ * accessing the machine resources.
+ *
+ * @section hal_interfaces HAL Interfaces
+ * An interface is a binary structure allowing the access to a service
+ * using virtual functions. This allows to create drivers that can be
+ * accessed using a common interface.
+ * The concept of interface is commonly found in object-oriented languages
+ * like Java or C++, their meaning in ChibiOS/HAL is exactly the same.
+ *
+ * @section hal_inner_code HAL Inner Code
+ * Some modules are shared among multiple device drivers and are not
+ * necessarily meant to be used by the application layer.
+ */
+
+/**
+ * @defgroup HAL_CONF Configuration
+ * @brief HAL Configuration.
+ * @details The file @p halconf.h contains the high level settings for all
+ * the drivers supported by the HAL. The low level, platform dependent,
+ * settings are contained in the @p mcuconf.h file instead and are describe
+ * in the various platforms reference manuals.
+ *
+ * @ingroup IO
+ */
+
+/**
+ * @defgroup HAL_NORMAL_DRIVERS Normal Drivers
+ * @brief HAL Normal Drivers.
+ *
+ * @ingroup IO
+ */
+
+/**
+ * @defgroup HAL_COMPLEX_DRIVERS Complex Drivers
+ * @brief HAL Complex Drivers.
+ *
+ * @ingroup IO
+ */
+
+/**
+ * @defgroup HAL_INTERFACES Interfaces
+ * @brief HAL Interfaces.
+ *
+ * @ingroup IO
+ */
+
+/**
+ * @defgroup HAL_INNER_CODE Inner Code
+ * @brief HAL Inner Code.
+ *
+ * @ingroup IO
+ */
|