diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2012-06-14 16:45:57 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2012-06-14 16:45:57 +0000 |
| commit | 2b1173e29246cbc82f45490d0b1b1443d7bf897a (patch) | |
| tree | 43a43b5de70a4463ae050560f6ebde75f502b0b7 /os/hal/dox/i2s.dox | |
| parent | 18cab5548c02bd6c52af77be2a737a8a8fd47070 (diff) | |
| download | ChibiOS-2b1173e29246cbc82f45490d0b1b1443d7bf897a.tar.gz ChibiOS-2b1173e29246cbc82f45490d0b1b1443d7bf897a.tar.bz2 ChibiOS-2b1173e29246cbc82f45490d0b1b1443d7bf897a.zip | |
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@4276 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/dox/i2s.dox')
| -rw-r--r-- | os/hal/dox/i2s.dox | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/os/hal/dox/i2s.dox b/os/hal/dox/i2s.dox new file mode 100644 index 000000000..2c6cc4ca2 --- /dev/null +++ b/os/hal/dox/i2s.dox @@ -0,0 +1,31 @@ +/*
+ ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
+ 2011,2012 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/>.
+*/
+
+/**
+ * @defgroup I2S I2S Driver
+ * @brief Generic I2S Driver.
+ * @details This module implements a generic I2S driver.
+ * @pre In order to use the I2S driver the @p HAL_USE_I2S option
+ * must be enabled in @p halconf.h.
+ *
+ * @section i2s_1 Driver State Machine
+ *
+ * @ingroup IO
+ */
|