From 39fa1818ffe52d04832d5f5d25ae01fb7b6d514f Mon Sep 17 00:00:00 2001 From: gdisirio Date: Sat, 18 Feb 2012 16:46:21 +0000 Subject: Improvements to the STM32 ICU driver. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@3955 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/hal/include/icu.h | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'os/hal/include') diff --git a/os/hal/include/icu.h b/os/hal/include/icu.h index d01c18749..99cfc4e3c 100644 --- a/os/hal/include/icu.h +++ b/os/hal/include/icu.h @@ -103,25 +103,29 @@ typedef void (*icucallback_t)(ICUDriver *icup); * @brief Returns the width of the latest pulse. * @details The pulse width is defined as number of ticks between the start * edge and the stop edge. + * @note This function is meant to be invoked from the width capture + * callback only. * * @param[in] icup pointer to the @p ICUDriver object * @return The number of ticks. * - * @iclass + * @special */ -#define icuGetWidthI(icup) icu_lld_get_width(icup) +#define icuGetWidth(icup) icu_lld_get_width(icup) /** * @brief Returns the width of the latest cycle. * @details The cycle width is defined as number of ticks between a start * edge and the next start edge. + * @note This function is meant to be invoked from the width capture + * callback only. * * @param[in] icup pointer to the @p ICUDriver object * @return The number of ticks. * - * @iclass + * @special */ -#define icuGetPeriodI(icup) icu_lld_get_period(icup) +#define icuGetPeriod(icup) icu_lld_get_period(icup) /** @} */ /** -- cgit v1.2.3