diff options
author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-10-04 17:16:18 +0000 |
---|---|---|
committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-10-04 17:16:18 +0000 |
commit | 2891f7d645c4be187ac96ee4011207531d25c34a (patch) | |
tree | ddfb8134c4c918893cb0cb50075bd5be3f4248a9 /os/hal/include/mmc_spi.h | |
parent | 7f61cb948ccdbd728643e0f174ee87542d9a862d (diff) | |
download | ChibiOS-2891f7d645c4be187ac96ee4011207531d25c34a.tar.gz ChibiOS-2891f7d645c4be187ac96ee4011207531d25c34a.tar.bz2 ChibiOS-2891f7d645c4be187ac96ee4011207531d25c34a.zip |
Documentation improvements, fixed a small error in the STM32 serial driver.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2234 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/include/mmc_spi.h')
-rw-r--r-- | os/hal/include/mmc_spi.h | 12 |
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())
|