diff options
Diffstat (limited to 'os/hal/include/mmc_spi.h')
-rw-r--r-- | os/hal/include/mmc_spi.h | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/os/hal/include/mmc_spi.h b/os/hal/include/mmc_spi.h index 2be2673fb..e4c3ee157 100644 --- a/os/hal/include/mmc_spi.h +++ b/os/hal/include/mmc_spi.h @@ -18,8 +18,9 @@ */
/**
- * @file mmc_spi.h
- * @brief MMC over SPI driver header.
+ * @file mmc_spi.h
+ * @brief MMC over SPI driver header.
+ *
* @addtogroup MMC_SPI
* @{
*/
@@ -52,14 +53,14 @@ /*===========================================================================*/
/**
- * @brief Block size for MMC transfers.
+ * @brief Block size for MMC transfers.
*/
#if !defined(MMC_SECTOR_SIZE) || defined(__DOXYGEN__)
#define MMC_SECTOR_SIZE 512
#endif
/**
- * @brief Delays insertions.
+ * @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.
@@ -71,15 +72,15 @@ #endif
/**
- * @brief Number of positive insertion queries before generating the
- * insertion event. + * @brief Number of positive insertion queries before generating the
+ * insertion event. */
#if !defined(MMC_POLLING_INTERVAL) || defined(__DOXYGEN__)
#define MMC_POLLING_INTERVAL 10
#endif
/**
- * @brief Interval, in milliseconds, between insertion queries. + * @brief Interval, in milliseconds, between insertion queries. */
#if !defined(MMC_POLLING_DELAY) || defined(__DOXYGEN__)
#define MMC_POLLING_DELAY 10
@@ -98,7 +99,7 @@ /*===========================================================================*/
/**
- * @brief Driver state machine possible states.
+ * @brief Driver state machine possible states.
*/
typedef enum {
MMC_UNINIT = 0, /**< @brief Not initialized. */
@@ -111,21 +112,21 @@ typedef enum { } mmcstate_t;
/**
- * @brief Function used to query some hardware status bits.
+ * @brief Function used to query some hardware status bits.
*
- * @return The status.
+ * @return The status.
*/
typedef bool_t (*mmcquery_t)(void);
/**
- * @brief Driver configuration structure.
+ * @brief Driver configuration structure.
*/
typedef struct {
} MMCConfig;
/**
- * @brief Structure representing a MMC driver.
+ * @brief Structure representing a MMC driver.
*/
typedef struct {
/**
@@ -179,12 +180,12 @@ typedef struct { /*===========================================================================*/
/**
- * @brief Returns the driver state. + * @brief Returns the driver state. */
#define mmcGetDriverState(mmcp) ((mmcp)->mmc_state)
/**
- * @brief Returns the write protect status. + * @brief Returns the write protect status. */
#define mmcIsWriteProtected(mmcp) ((mmcp)->mmc_is_protected())
|