217 lines
7.8 KiB
C
217 lines
7.8 KiB
C
/*
|
|
ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
|
|
2011,2012 Giovanni Di Sirio.
|
|
|
|
This file is part of ChibiOS/RT.
|
|
|
|
ChibiOS/RT 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/>.
|
|
*/
|
|
|
|
/**
|
|
* @file sdc.h
|
|
* @brief SDC Driver macros and structures.
|
|
*
|
|
* @addtogroup SDC
|
|
* @{
|
|
*/
|
|
|
|
#ifndef _SDC_H_
|
|
#define _SDC_H_
|
|
|
|
#if HAL_USE_SDC || defined(__DOXYGEN__)
|
|
|
|
/*===========================================================================*/
|
|
/* Driver constants. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @name SD cart types
|
|
* @{
|
|
*/
|
|
#define SDC_MODE_CARDTYPE_MASK 0xF /**< @brief Card type mask. */
|
|
#define SDC_MODE_CARDTYPE_SDV11 0 /**< @brief Card is SD V1.1.*/
|
|
#define SDC_MODE_CARDTYPE_SDV20 1 /**< @brief Card is SD V2.0.*/
|
|
#define SDC_MODE_CARDTYPE_MMC 2 /**< @brief Card is MMC. */
|
|
#define SDC_MODE_HIGH_CAPACITY 0x10 /**< @brief High cap.card. */
|
|
/** @} */
|
|
|
|
/**
|
|
* @name SDC bus error conditions
|
|
* @{
|
|
*/
|
|
#define SDC_NO_ERROR 0 /**< @brief No error. */
|
|
#define SDC_CMD_CRC_ERROR 1 /**< @brief Command CRC error. */
|
|
#define SDC_DATA_CRC_ERROR 2 /**< @brief Data CRC error. */
|
|
#define SDC_DATA_TIMEOUT 4 /**< @brief HW write timeout. */
|
|
#define SDC_COMMAND_TIMEOUT 8 /**< @brief HW read timeout. */
|
|
#define SDC_TX_UNDERRUN 16 /**< @brief TX buffer underrun. */
|
|
#define SDC_RX_OVERRUN 32 /**< @brief RX buffer overrun. */
|
|
#define SDC_STARTBIT_ERROR 64 /**< @brief Start bit missing. */
|
|
#define SDC_OVERFLOW_ERROR 128 /**< @brief Card overflow error. */
|
|
#define SDC_UNHANDLED_ERROR 0xFFFFFFFF
|
|
/** @} */
|
|
|
|
/*===========================================================================*/
|
|
/* Driver pre-compile time settings. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @name SDC configuration options
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief Number of initialization attempts before rejecting the card.
|
|
* @note Attempts are performed at 10mS intervals.
|
|
*/
|
|
#if !defined(SDC_INIT_RETRY) || defined(__DOXYGEN__)
|
|
#define SDC_INIT_RETRY 100
|
|
#endif
|
|
|
|
/**
|
|
* @brief Include support for MMC cards.
|
|
* @note MMC support is not yet implemented so this option must be kept
|
|
* at @p FALSE.
|
|
*/
|
|
#if !defined(SDC_MMC_SUPPORT) || defined(__DOXYGEN__)
|
|
#define SDC_MMC_SUPPORT FALSE
|
|
#endif
|
|
|
|
/**
|
|
* @brief Delays insertions.
|
|
* @details If enabled this options inserts delays into the MMC waiting
|
|
* routines releasing some extra CPU time for the threads with
|
|
* lower priority, this may slow down the driver a bit however.
|
|
*/
|
|
#if !defined(SDC_NICE_WAITING) || defined(__DOXYGEN__)
|
|
#define SDC_NICE_WAITING TRUE
|
|
#endif
|
|
/** @} */
|
|
|
|
/*===========================================================================*/
|
|
/* Derived constants and error checks. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver data structures and types. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Driver state machine possible states.
|
|
*/
|
|
typedef enum {
|
|
SDC_UNINIT = 0, /**< Not initialized. */
|
|
SDC_STOP = 1, /**< Stopped. */
|
|
SDC_READY = 2, /**< Ready. */
|
|
SDC_CONNECTING = 3, /**< Card connection in progress. */
|
|
SDC_DISCONNECTING = 4, /**< Card disconnection in progress. */
|
|
SDC_ACTIVE = 5, /**< Cart initialized. */
|
|
SDC_READING = 6, /**< Read operation in progress. */
|
|
SDC_WRITING = 7, /**< Write operation in progress. */
|
|
} sdcstate_t;
|
|
|
|
#include "sdc_lld.h"
|
|
|
|
/*===========================================================================*/
|
|
/* Driver macros. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @name Macro Functions
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief Returns the driver state.
|
|
*
|
|
* @param[in] sdcp pointer to the @p SDCDriver object
|
|
* @return The driver state.
|
|
*
|
|
* @api
|
|
*/
|
|
#define sdcGetDriverState(sdcp) ((sdcp)->state)
|
|
|
|
/**
|
|
* @brief Returns the card insertion status.
|
|
* @note This macro wraps a low level function named
|
|
* @p sdc_lld_is_card_inserted(), this function must be
|
|
* provided by the application because it is not part of the
|
|
* SDC driver.
|
|
*
|
|
* @param[in] sdcp pointer to the @p SDCDriver object
|
|
* @return The card state.
|
|
* @retval FALSE card not inserted.
|
|
* @retval TRUE card inserted.
|
|
*
|
|
* @api
|
|
*/
|
|
#define sdcIsCardInserted(sdcp) (sdc_lld_is_card_inserted(sdcp))
|
|
|
|
/**
|
|
* @brief Returns the write protect status.
|
|
* @note This macro wraps a low level function named
|
|
* @p sdc_lld_is_write_protected(), this function must be
|
|
* provided by the application because it is not part of the
|
|
* SDC driver.
|
|
*
|
|
* @param[in] sdcp pointer to the @p SDCDriver object
|
|
* @return The card state.
|
|
* @retval FALSE not write protected.
|
|
* @retval TRUE write protected.
|
|
*
|
|
* @api
|
|
*/
|
|
#define sdcIsWriteProtected(sdcp) (sdc_lld_is_write_protected(sdcp))
|
|
|
|
/**
|
|
* @brief Returns the card capacity in blocks.
|
|
*
|
|
* @param[in] sdcp pointer to the @p SDCDriver object
|
|
* @return The card capacity.
|
|
*
|
|
* @api
|
|
*/
|
|
#define sdcGetCardCapacity(sdcp) ((sdcp)->capacity)
|
|
/** @} */
|
|
|
|
/*===========================================================================*/
|
|
/* External declarations. */
|
|
/*===========================================================================*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
void sdcInit(void);
|
|
void sdcObjectInit(SDCDriver *sdcp);
|
|
void sdcStart(SDCDriver *sdcp, const SDCConfig *config);
|
|
void sdcStop(SDCDriver *sdcp);
|
|
bool_t sdcConnect(SDCDriver *sdcp);
|
|
bool_t sdcDisconnect(SDCDriver *sdcp);
|
|
bool_t sdcRead(SDCDriver *sdcp, uint32_t startblk,
|
|
uint8_t *buffer, uint32_t n);
|
|
bool_t sdcWrite(SDCDriver *sdcp, uint32_t startblk,
|
|
const uint8_t *buffer, uint32_t n);
|
|
sdcflags_t sdcGetAndClearErrors(SDCDriver *sdcp);
|
|
bool_t sdcSync(SDCDriver *sdcp);
|
|
bool_t sdcGetInfo(SDCDriver *sdcp, BlockDeviceInfo *bdip);
|
|
bool_t sdcErase(SDCDriver *mmcp, uint32_t startblk, uint32_t endblk);
|
|
bool_t _sdc_wait_for_transfer_state(SDCDriver *sdcp);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* HAL_USE_SDC */
|
|
|
|
#endif /* _SDC_H_ */
|
|
|
|
/** @} */
|