aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/include/mmc_spi.h
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2011-08-23 13:36:25 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2011-08-23 13:36:25 +0000
commit718dc5084f7719f91eaacfc99e8c7de654eb2ad8 (patch)
tree14b0f47f04f720f251828ed87fbf008b0331e91a /os/hal/include/mmc_spi.h
parentc9be79def630f153b0b2d28e905939c15743f989 (diff)
downloadChibiOS-718dc5084f7719f91eaacfc99e8c7de654eb2ad8.tar.gz
ChibiOS-718dc5084f7719f91eaacfc99e8c7de654eb2ad8.tar.bz2
ChibiOS-718dc5084f7719f91eaacfc99e8c7de654eb2ad8.zip
HAL documentation improvements.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@3252 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/include/mmc_spi.h')
-rw-r--r--os/hal/include/mmc_spi.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/os/hal/include/mmc_spi.h b/os/hal/include/mmc_spi.h
index 6940ca479..f51bd6765 100644
--- a/os/hal/include/mmc_spi.h
+++ b/os/hal/include/mmc_spi.h
@@ -54,6 +54,10 @@
/*===========================================================================*/
/**
+ * @name MMC_SPI configuration options
+ * @{
+ */
+/**
* @brief Block size for MMC transfers.
*/
#if !defined(MMC_SECTOR_SIZE) || defined(__DOXYGEN__)
@@ -86,6 +90,7 @@
#if !defined(MMC_POLLING_DELAY) || defined(__DOXYGEN__)
#define MMC_POLLING_DELAY 10
#endif
+/** @} */
/*===========================================================================*/
/* Derived constants and error checks. */
@@ -182,6 +187,10 @@ typedef struct {
/*===========================================================================*/
/**
+ * @name Macro Functions
+ * @{
+ */
+/**
* @brief Returns the driver state.
*
* @param[in] mmcp pointer to the @p MMCDriver object
@@ -202,6 +211,7 @@ typedef struct {
* @api
*/
#define mmcIsWriteProtected(mmcp) ((mmcp)->is_protected())
+/** @} */
/*===========================================================================*/
/* External declarations. */