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/gyro.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/gyro.dox')
-rw-r--r-- | os/ex/dox/gyro.dox | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/os/ex/dox/gyro.dox b/os/ex/dox/gyro.dox new file mode 100644 index 000000000..da0fce44e --- /dev/null +++ b/os/ex/dox/gyro.dox @@ -0,0 +1,38 @@ +/*
+ 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 HAL HAL
+ * @brief Hardware Abstraction Layer.
+ * @details Under ChibiOS the set of the various device driver interfaces
+ * is called the HAL subsystem: Hardware Abstraction Layer. The HAL is the
+ * abstract interface between ChibiOS applications and hardware.
+ *
+ * @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.
+ *
+ */
+
+/**
+ * @defgroup HAL_GYROSCOPE Generic Gyroscope Interfaces
+ * @brief HAL Generic Gyroscope Interfaces.
+ *
+ * @ingroup HAL_PERIPHERAL_INTERFACES
+ */
|