aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/include
diff options
context:
space:
mode:
authorGiovanni Di Sirio <gdisirio@gmail.com>2018-01-10 13:36:09 +0000
committerGiovanni Di Sirio <gdisirio@gmail.com>2018-01-10 13:36:09 +0000
commita8693baa481e1c4d91379af08bbc9f459b1b4d56 (patch)
tree190b755173b3e2159025260994a1d3208241ab4c /os/hal/include
parent0da6de11ee208137162df9206b3b5731e2980d28 (diff)
downloadChibiOS-a8693baa481e1c4d91379af08bbc9f459b1b4d56.tar.gz
ChibiOS-a8693baa481e1c4d91379af08bbc9f459b1b4d56.tar.bz2
ChibiOS-a8693baa481e1c4d91379af08bbc9f459b1b4d56.zip
SPIv1 and SPIv2 circular mode added. Rework of RCC files and all dependencies inside STM32 drivers. Documentation fixes in some HAL modules.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11247 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/include')
-rw-r--r--os/hal/include/hal_buffers.h4
-rw-r--r--os/hal/include/hal_ioblock.h12
-rw-r--r--os/hal/include/hal_mmc_spi.h8
-rw-r--r--os/hal/include/hal_mmcsd.h4
-rw-r--r--os/hal/include/hal_sdc.h8
5 files changed, 18 insertions, 18 deletions
diff --git a/os/hal/include/hal_buffers.h b/os/hal/include/hal_buffers.h
index ac541d286..4b41e7313 100644
--- a/os/hal/include/hal_buffers.h
+++ b/os/hal/include/hal_buffers.h
@@ -217,7 +217,7 @@ typedef io_buffers_queue_t output_buffers_queue_t;
}
/**
- * @brief Evaluates to @p TRUE if the specified input buffers queue is empty.
+ * @brief Evaluates to @p true if the specified input buffers queue is empty.
*
* @param[in] ibqp pointer to an @p input_buffers_queue_t structure
* @return The queue status.
@@ -229,7 +229,7 @@ typedef io_buffers_queue_t output_buffers_queue_t;
#define ibqIsEmptyI(ibqp) ((bool)(bqSpaceI(ibqp) == 0U))
/**
- * @brief Evaluates to @p TRUE if the specified input buffers queue is full.
+ * @brief Evaluates to @p true if the specified input buffers queue is full.
*
* @param[in] ibqp pointer to an @p input_buffers_queue_t structure
* @return The queue status.
diff --git a/os/hal/include/hal_ioblock.h b/os/hal/include/hal_ioblock.h
index e942cf1c9..06f3665b5 100644
--- a/os/hal/include/hal_ioblock.h
+++ b/os/hal/include/hal_ioblock.h
@@ -127,8 +127,8 @@ typedef struct {
* @param[in] ip pointer to a @p BaseBlockDevice or derived class
*
* @return The driver state.
- * @retval FALSE the device is not transferring data.
- * @retval TRUE the device not transferring data.
+ * @retval false the device is not transferring data.
+ * @retval true the device not transferring data.
*
* @special
*/
@@ -147,8 +147,8 @@ typedef struct {
* @param[in] ip pointer to a @p BaseBlockDevice or derived class
*
* @return The media state.
- * @retval FALSE media not inserted.
- * @retval TRUE media inserted.
+ * @retval false media not inserted.
+ * @retval true media inserted.
*
* @api
*/
@@ -160,8 +160,8 @@ typedef struct {
* @param[in] ip pointer to a @p BaseBlockDevice or derived class
*
* @return The media state.
- * @retval FALSE writable media.
- * @retval TRUE non writable media.
+ * @retval false writable media.
+ * @retval true non writable media.
*
* @api
*/
diff --git a/os/hal/include/hal_mmc_spi.h b/os/hal/include/hal_mmc_spi.h
index fc6bccc2a..7a9c50a90 100644
--- a/os/hal/include/hal_mmc_spi.h
+++ b/os/hal/include/hal_mmc_spi.h
@@ -140,8 +140,8 @@ typedef struct {
*
* @param[in] mmcp pointer to the @p MMCDriver object
* @return The card state.
- * @retval FALSE card not inserted.
- * @retval TRUE card inserted.
+ * @retval false card not inserted.
+ * @retval true card inserted.
*
* @api
*/
@@ -152,8 +152,8 @@ typedef struct {
*
* @param[in] mmcp pointer to the @p MMCDriver object
* @return The card state.
- * @retval FALSE card not inserted.
- * @retval TRUE card inserted.
+ * @retval false card not inserted.
+ * @retval true card inserted.
*
* @api
*/
diff --git a/os/hal/include/hal_mmcsd.h b/os/hal/include/hal_mmcsd.h
index f2e7d88d5..f69a7a1e4 100644
--- a/os/hal/include/hal_mmcsd.h
+++ b/os/hal/include/hal_mmcsd.h
@@ -428,7 +428,7 @@ typedef struct {
* @{
*/
/**
- * @brief Evaluates to @p TRUE if the R1 response contains error flags.
+ * @brief Evaluates to @p true if the R1 response contains error flags.
*
* @param[in] r1 the r1 response
*/
@@ -442,7 +442,7 @@ typedef struct {
#define MMCSD_R1_STS(r1) (((r1) >> 9U) & 15U)
/**
- * @brief Evaluates to @p TRUE if the R1 response indicates a locked card.
+ * @brief Evaluates to @p true if the R1 response indicates a locked card.
*
* @param[in] r1 the r1 response
*/
diff --git a/os/hal/include/hal_sdc.h b/os/hal/include/hal_sdc.h
index 6466b1d97..307636558 100644
--- a/os/hal/include/hal_sdc.h
+++ b/os/hal/include/hal_sdc.h
@@ -152,8 +152,8 @@ typedef enum {
*
* @param[in] sdcp pointer to the @p SDCDriver object
* @return The card state.
- * @retval FALSE card not inserted.
- * @retval TRUE card inserted.
+ * @retval false card not inserted.
+ * @retval true card inserted.
*
* @api
*/
@@ -168,8 +168,8 @@ typedef enum {
*
* @param[in] sdcp pointer to the @p SDCDriver object
* @return The card state.
- * @retval FALSE not write protected.
- * @retval TRUE write protected.
+ * @retval false not write protected.
+ * @retval true write protected.
*
* @api
*/