diff options
| author | Giovanni Di Sirio <gdisirio@gmail.com> | 2019-01-21 19:42:49 +0000 |
|---|---|---|
| committer | Giovanni Di Sirio <gdisirio@gmail.com> | 2019-01-21 19:42:49 +0000 |
| commit | a3e9966359c432405c8ab1eb49a27133e5271ba2 (patch) | |
| tree | 03216e3986c61339f7ca9ad4c03671b6438a4b27 /os/hal/dox/hal_mmc_spi.dox | |
| parent | 5a41bbc5e100fc1e946702a046f0802e625a8de5 (diff) | |
| download | ChibiOS-a3e9966359c432405c8ab1eb49a27133e5271ba2.tar.gz ChibiOS-a3e9966359c432405c8ab1eb49a27133e5271ba2.tar.bz2 ChibiOS-a3e9966359c432405c8ab1eb49a27133e5271ba2.zip | |
More renaming for consistency.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12571 110e8d01-0319-4d1e-a829-52ad28d1bb01
Diffstat (limited to 'os/hal/dox/hal_mmc_spi.dox')
| -rw-r--r-- | os/hal/dox/hal_mmc_spi.dox | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/os/hal/dox/hal_mmc_spi.dox b/os/hal/dox/hal_mmc_spi.dox new file mode 100644 index 000000000..1dc4b27b8 --- /dev/null +++ b/os/hal/dox/hal_mmc_spi.dox @@ -0,0 +1,35 @@ +/*
+ 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 MMC_SPI MMC over SPI Driver
+ * @brief Generic MMC driver.
+ * @details This module implements a portable MMC/SD driver that uses a SPI
+ * driver as physical layer. Hot plugging and removal are supported
+ * through kernel events.
+ * @pre In order to use the MMC_SPI driver the @p HAL_USE_MMC_SPI and
+ * @p HAL_USE_SPI options must be enabled in @p halconf.h.
+ *
+ * @section mmc_spi_1 Driver State Machine
+ * This driver implements a state machine internally, see the @ref IO_BLOCK
+ * module documentation for details.
+ *
+ * @section mmc_spi_2 Driver Operations
+ * This driver allows to read or write single or multiple 512 bytes blocks
+ * on a SD Card.
+ *
+ * @ingroup HAL_COMPLEX_DRIVERS
+ */
|