aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/include/mmc_spi.h
diff options
context:
space:
mode:
Diffstat (limited to 'os/hal/include/mmc_spi.h')
-rw-r--r--os/hal/include/mmc_spi.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/os/hal/include/mmc_spi.h b/os/hal/include/mmc_spi.h
index cc698c3de..6af424d29 100644
--- a/os/hal/include/mmc_spi.h
+++ b/os/hal/include/mmc_spi.h
@@ -181,11 +181,23 @@ typedef struct {
/**
* @brief Returns the driver state.
+ *
+ * @param[in] mmcp pointer to the @p MMCDriver object
+ * @return The driver state.
+ *
+ * @api
*/
#define mmcGetDriverState(mmcp) ((mmcp)->mmc_state)
/**
* @brief Returns the write protect status.
+ *
+ * @param[in] mmcp pointer to the @p MMCDriver object
+ * @return The card state.
+ * @retval FALSE card not inserted.
+ * @retval TRUE card inserted.
+ *
+ * @api
*/
#define mmcIsWriteProtected(mmcp) ((mmcp)->mmc_is_protected())