aboutsummaryrefslogtreecommitdiffstats
path: root/doc/hal/src
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2014-12-02 09:28:04 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2014-12-02 09:28:04 +0000
commitbad3f755e18bb9964adacbec3402253b5a483336 (patch)
tree362045c1f9cb043e1c6bc28a64a63392cc3b9034 /doc/hal/src
parentea6e4f54b0584bc9ff2b34e9ce0cb56acdb6000c (diff)
downloadChibiOS-bad3f755e18bb9964adacbec3402253b5a483336.tar.gz
ChibiOS-bad3f755e18bb9964adacbec3402253b5a483336.tar.bz2
ChibiOS-bad3f755e18bb9964adacbec3402253b5a483336.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@7553 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'doc/hal/src')
-rw-r--r--doc/hal/src/main.dox42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/hal/src/main.dox b/doc/hal/src/main.dox
new file mode 100644
index 000000000..6fbeca00c
--- /dev/null
+++ b/doc/hal/src/main.dox
@@ -0,0 +1,42 @@
+/*
+ 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/>.
+
+ ---
+
+ A special exception to the GPL can be applied should you wish to distribute
+ a combined work that includes ChibiOS/RT, without being obliged to provide
+ the source code for any proprietary components. See the file exception.txt
+ for full details of how and when the exception can be applied.
+*/
+
+/**
+ * @mainpage Introdution
+ * @author Giovanni Di Sirio (gdisirio@users.sourceforge.net).
+ *
+ * <h2>Features</h2>
+ * - Hardware Abstraction Layer (HAL) supporting numerous high level device
+ * drivers abstracting common features in modern MCUs.
+ * - Driver models for: ADC, CAN, DAC, EXT, GPT, I2C, I2S, ICU, MAC, MMC, PAL,
+ * PWM, RTC, SDC, Serial, USB, USB-CDC, SPI, ST.
+ * - Abstraction of streams.
+ * - Abstraction of block devices.
+ * - The drivers can be ported to virtually any MCU architecture thanks to
+ * an high level API.
+ * .
+ */