aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/dox/hal_wspi.dox
diff options
context:
space:
mode:
Diffstat (limited to 'os/hal/dox/hal_wspi.dox')
-rwxr-xr-xos/hal/dox/hal_wspi.dox26
1 files changed, 26 insertions, 0 deletions
diff --git a/os/hal/dox/hal_wspi.dox b/os/hal/dox/hal_wspi.dox
new file mode 100755
index 000000000..5cf29d9bc
--- /dev/null
+++ b/os/hal/dox/hal_wspi.dox
@@ -0,0 +1,26 @@
+/*
+ ChibiOS - Copyright (C) 2006..2018 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 WSPI WSPI Driver
+ * @brief Generic WSPI Driver
+ * @details This module defines an abstract interface for an wide SPI
+ * communication interface (Quad SPI, Octal SPI and similar).
+ * @pre In order to use the WSPI driver the @p HAL_USE_WSPI option
+ * must be enabled in @p halconf.h.
+ *
+ * @ingroup HAL_NORMAL_DRIVERS
+ */