diff options
| author | Giovanni Di Sirio <gdisirio@gmail.com> | 2018-03-23 11:58:28 +0000 |
|---|---|---|
| committer | Giovanni Di Sirio <gdisirio@gmail.com> | 2018-03-23 11:58:28 +0000 |
| commit | e9f502f1713049fb7f4e9cae67f8df8c919c72a2 (patch) | |
| tree | 5bcd871babc892535b65ec413e5180cfeb031d2c /os | |
| parent | a9feb302569832fe89376943528e37e231abbd10 (diff) | |
| download | ChibiOS-e9f502f1713049fb7f4e9cae67f8df8c919c72a2.tar.gz ChibiOS-e9f502f1713049fb7f4e9cae67f8df8c919c72a2.tar.bz2 ChibiOS-e9f502f1713049fb7f4e9cae67f8df8c919c72a2.zip | |
Documentation fixes to the ICU driver.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11840 110e8d01-0319-4d1e-a829-52ad28d1bb01
Diffstat (limited to 'os')
| -rw-r--r-- | os/hal/include/hal_icu.h | 6 | ||||
| -rw-r--r-- | os/hal/ports/STM32/LLD/TIMv1/hal_icu_lld.c | 6 | ||||
| -rw-r--r-- | os/hal/src/hal_icu.c | 6 | ||||
| -rw-r--r-- | os/hal/templates/hal_icu_lld.c | 6 |
4 files changed, 16 insertions, 8 deletions
diff --git a/os/hal/include/hal_icu.h b/os/hal/include/hal_icu.h index 8408b4a1d..89c4a62ef 100644 --- a/os/hal/include/hal_icu.h +++ b/os/hal/include/hal_icu.h @@ -102,7 +102,8 @@ typedef void (*icucallback_t)(ICUDriver *icup); /**
* @brief Enables notifications.
- * @pre The ICU unit must have been activated using @p icuStart().
+ * @pre The ICU unit must have been activated using @p icuStart() and the
+ * capture started using @p icuStartCapture().
* @note If the notification is already enabled then the call has no effect.
*
* @param[in] icup pointer to the @p ICUDriver object
@@ -113,7 +114,8 @@ typedef void (*icucallback_t)(ICUDriver *icup); /**
* @brief Disables notifications.
- * @pre The ICU unit must have been activated using @p icuStart().
+ * @pre The ICU unit must have been activated using @p icuStart() and the
+ * capture started using @p icuStartCapture().
* @note If the notification is already disabled then the call has no effect.
*
* @param[in] icup pointer to the @p ICUDriver object
diff --git a/os/hal/ports/STM32/LLD/TIMv1/hal_icu_lld.c b/os/hal/ports/STM32/LLD/TIMv1/hal_icu_lld.c index 73341736a..cbd7cee57 100644 --- a/os/hal/ports/STM32/LLD/TIMv1/hal_icu_lld.c +++ b/os/hal/ports/STM32/LLD/TIMv1/hal_icu_lld.c @@ -712,7 +712,8 @@ void icu_lld_stop_capture(ICUDriver *icup) { /**
* @brief Enables notifications.
- * @pre The ICU unit must have been activated using @p icuStart().
+ * @pre The ICU unit must have been activated using @p icuStart() and the
+ * capture started using @p icuStartCapture().
* @note If the notification is already enabled then the call has no effect.
*
* @param[in] icup pointer to the @p ICUDriver object
@@ -758,7 +759,8 @@ void icu_lld_enable_notifications(ICUDriver *icup) { /**
* @brief Disables notifications.
- * @pre The ICU unit must have been activated using @p icuStart().
+ * @pre The ICU unit must have been activated using @p icuStart() and the
+ * capture started using @p icuStartCapture().
* @note If the notification is already disabled then the call has no effect.
*
* @param[in] icup pointer to the @p ICUDriver object
diff --git a/os/hal/src/hal_icu.c b/os/hal/src/hal_icu.c index 1e8d27bef..67f9955c2 100644 --- a/os/hal/src/hal_icu.c +++ b/os/hal/src/hal_icu.c @@ -186,7 +186,8 @@ void icuStopCapture(ICUDriver *icup) { /**
* @brief Enables notifications.
- * @pre The ICU unit must have been activated using @p icuStart().
+ * @pre The ICU unit must have been activated using @p icuStart() and the
+ * capture started using @p icuStartCapture().
* @note If the notification is already enabled then the call has no effect.
*
* @param[in] icup pointer to the @p ICUDriver object
@@ -206,7 +207,8 @@ void icuEnableNotifications(ICUDriver *icup) { /**
* @brief Disables notifications.
- * @pre The ICU unit must have been activated using @p icuStart().
+ * @pre The ICU unit must have been activated using @p icuStart() and the
+ * capture started using @p icuStartCapture().
* @note If the notification is already disabled then the call has no effect.
*
* @param[in] icup pointer to the @p ICUDriver object
diff --git a/os/hal/templates/hal_icu_lld.c b/os/hal/templates/hal_icu_lld.c index e70f87ba5..4fd2d7832 100644 --- a/os/hal/templates/hal_icu_lld.c +++ b/os/hal/templates/hal_icu_lld.c @@ -154,7 +154,8 @@ void icu_lld_stop_capture(ICUDriver *icup) { /**
* @brief Enables notifications.
- * @pre The ICU unit must have been activated using @p icuStart().
+ * @pre The ICU unit must have been activated using @p icuStart() and the
+ * capture started using @p icuStartCapture().
* @note If the notification is already enabled then the call has no effect.
*
* @param[in] icup pointer to the @p ICUDriver object
@@ -168,7 +169,8 @@ void icu_lld_enable_notifications(ICUDriver *icup) { /**
* @brief Disables notifications.
- * @pre The ICU unit must have been activated using @p icuStart().
+ * @pre The ICU unit must have been activated using @p icuStart() and the
+ * capture started using @p icuStartCapture().
* @note If the notification is already disabled then the call has no effect.
*
* @param[in] icup pointer to the @p ICUDriver object
|