aboutsummaryrefslogtreecommitdiffstats
path: root/doc/hal-stm32f3/src/main.dox
diff options
context:
space:
mode:
Diffstat (limited to 'doc/hal-stm32f3/src/main.dox')
-rwxr-xr-xdoc/hal-stm32f3/src/main.dox38
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/hal-stm32f3/src/main.dox b/doc/hal-stm32f3/src/main.dox
new file mode 100755
index 000000000..3a96776bb
--- /dev/null
+++ b/doc/hal-stm32f3/src/main.dox
@@ -0,0 +1,38 @@
+/*
+ ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio.
+
+ This file is part of ChibiOS.
+
+ ChibiOS 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 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/>.
+*/
+
+/**
+ * @mainpage Introduction
+ * @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, UART, USB, USB-CDC, SPI, ST, WDG.
+ * - Abstraction of streams.
+ * - Abstraction of block devices.
+ * - The drivers can be ported to virtually any MCU architecture thanks to
+ * an high level API.
+ * - The HAL can be used with or without an RTOS.
+ * - The HAL can be adapted to any reasonable RTOS thanks to an Operating
+ * System Abstraction Layer (OSAL). ChibiOS/RT and ChibiOS/NIL are supported
+ * out of the box.
+ * .
+ */