tinySA/os/hal/dox/mmc_spi.dox

40 lines
1.5 KiB
Plaintext

/*
ChibiOS - Copyright (C) 2006,2007,2008,2009,2010,
2011,2012,2013,2014 Giovanni Di Sirio.
This file is part of ChibiOS/HAL
ChibiOS/HAL 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 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
*/