N3_sub/modules/ChibiOS/os/hal/dox/hal_mmc_spi.dox

/*
    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
 */