diff options
| author | roccomarco <roccomarco@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2017-07-01 18:45:25 +0000 |
|---|---|---|
| committer | roccomarco <roccomarco@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2017-07-01 18:45:25 +0000 |
| commit | 3588ac33a33bb10d22cd6a30ab22ea28514943a0 (patch) | |
| tree | d760dba90f35da35288a953df44476de0d92a467 /os/ex/dox/main.dox | |
| parent | 3edd2f7ccb1ecca032efb47d3192c4f4065e20ed (diff) | |
| download | ChibiOS-3588ac33a33bb10d22cd6a30ab22ea28514943a0.tar.gz ChibiOS-3588ac33a33bb10d22cd6a30ab22ea28514943a0.tar.bz2 ChibiOS-3588ac33a33bb10d22cd6a30ab22ea28514943a0.zip | |
Improved ChibiOS\EX documentation (Still uncomplete)
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@10274 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/ex/dox/main.dox')
| -rw-r--r-- | os/ex/dox/main.dox | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/os/ex/dox/main.dox b/os/ex/dox/main.dox new file mode 100644 index 000000000..dbb73d7b4 --- /dev/null +++ b/os/ex/dox/main.dox @@ -0,0 +1,65 @@ +/*
+ ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+
+/**
+ * @defgroup EX EX
+ * @brief EXternal periferals.
+ * @details Under ChibiOS the set of the complex device driver interfaces
+ * dedicated to external peripherals is called the EX subsystem. The EX resides
+ * on top of HAL and is actually a set of libraries for external devices like
+ * MEMS, Displays, Flash memories and so on. These libraries are the
+ * implementation of one or more Abstract Interfaces brought by HAL subsystem.
+ * EX also relies on HAL normal drivers to interface the peripherals.
+ *
+ * @section ex_complex_drivers_architecture EX Complex Drivers Architecture
+ * Each EX driver can be considered as a standalone Complex Device Driver. For
+ * ease of use these drivers are grouped by vendor:
+ * - Micron Technology Peripherals
+ * - STMicroelectronics Peripherals
+ * .
+ * @section micron_devices Micron Technology Devices
+ * This section contains all the drivers of devices produced by
+ * Micron Technology. Devices currently supported are FLASH and are:
+ * - @b M25Q: Serial NOR flash;
+ * .
+ *
+ * @section stmicroelectronics_devices STMicroelectronics Devices
+ * This section contains all the drivers of devices produced by
+ * STMicroelectronics. Devices currently supported are MEMS and are:
+ * - @b HTS221: Capacitive digital humidity sensor;
+ * - @b L3GD20: 3-axis digital gyroscope;
+ * - @b LIS3DSH: 3-axis digital motion sensor;
+ * - @b LIS3MDL: Ultra low power, high performances 3-axis magnetometer;
+ * - @b LIS302DL: 3-axis motion sensor;
+ * - @b LPS25H: Piezoresistive 260-1260 hPa pressure sensor;
+ * - @b LSM6DS0: 6-axis iNEMO inertial module;
+ * - @b LSM303DLHC: Ultra compact high performance e-compass;
+ * .
+ */
+
+/**
+ * @defgroup EX_MICRON Micron Technology Devices
+ * @brief Micron Technology Devices.
+ *
+ * @ingroup EX
+ */
+
+/**
+ * @defgroup EX_ST STMicroelectronics Devices
+ * @brief STMicroelectronics Devices.
+ *
+ * @ingroup EX
+ */
|