aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/dox/qspi.dox
diff options
context:
space:
mode:
authorGiovanni Di Sirio <gdisirio@gmail.com>2017-02-07 09:15:42 +0000
committerGiovanni Di Sirio <gdisirio@gmail.com>2017-02-07 09:15:42 +0000
commit3b2070d6e7df5bafd95e24c5b4c5435e8aefcaf4 (patch)
tree5509891d0a5e2fb18e20fb0bcaa70759e2a8fe31 /os/hal/dox/qspi.dox
parentaf22a2dcaf9d9750ba5604d4ef9a82d0540a0c20 (diff)
downloadChibiOS-3b2070d6e7df5bafd95e24c5b4c5435e8aefcaf4.tar.gz
ChibiOS-3b2070d6e7df5bafd95e24c5b4c5435e8aefcaf4.tar.bz2
ChibiOS-3b2070d6e7df5bafd95e24c5b4c5435e8aefcaf4.zip
Documentation-related fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@10093 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/dox/qspi.dox')
-rwxr-xr-xos/hal/dox/qspi.dox26
1 files changed, 26 insertions, 0 deletions
diff --git a/os/hal/dox/qspi.dox b/os/hal/dox/qspi.dox
new file mode 100755
index 000000000..c24e96754
--- /dev/null
+++ b/os/hal/dox/qspi.dox
@@ -0,0 +1,26 @@
+/*
+ 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 QSPI QSPI Driver
+ * @brief Generic QSPI Driver
+ * @details This module defines an abstract interface for a Quad SPI
+ * communication interface.
+ * @pre In order to use the QSPI driver the @p HAL_USE_QSPI option
+ * must be enabled in @p halconf.h.
+ *
+ * @ingroup HAL_NORMAL_DRIVERS
+ */