From 0ae7b82c07c9dfeca4a6e6b2619c5289d94e3ee9 Mon Sep 17 00:00:00 2001 From: Przemyslaw Stekiel Date: Mon, 30 Oct 2017 09:20:32 +0100 Subject: [PATCH] Add minor modifications of lp/us tickers tests desctiption in ticker header files. Add one potential bug to the test description. Fix test function names to be consistant with desctiption and test header. Fix typos. --- hal/lp_ticker_api.h | 12 ++++++------ hal/us_ticker_api.h | 13 +++++++------ 2 files changed, 13 insertions(+), 12 deletions(-) diff --git a/hal/lp_ticker_api.h b/hal/lp_ticker_api.h index 0c23c32869..930592ef7e 100644 --- a/hal/lp_ticker_api.h +++ b/hal/lp_ticker_api.h @@ -34,9 +34,9 @@ extern "C" { * Low level interface to the low power ticker of a target * * # Defined behavior - * * Has a reported frequency between 8KHz and 64KHz - verified by lp_ticker_info_test - * * Has a counter that is at least 12 bits wide - verified by lp_ticker_info_test - * * Continues operating in deep sleep mode - verified by lp_ticker_sleep_test + * * Has a reported frequency between 8KHz and 64KHz - verified by ::lp_ticker_info_test + * * Has a counter that is at least 12 bits wide - verified by ::lp_ticker_info_test + * * Continues operating in deep sleep mode - verified by ::lp_ticker_deepsleep_test * * All behavior defined by the @ref hal_ticker_shared "ticker specification" * * # Undefined behavior @@ -65,7 +65,7 @@ typedef void (*ticker_irq_handler_type)(const ticker_data_t *const); * * @return previous ticker IRQ handler * - * @note by default IRQ handler is set to ticker_irq_handler() + * @note by default IRQ handler is set to ::ticker_irq_handler * @note this function is primarily for testing purposes and it's not required part of HAL implementation * */ @@ -114,7 +114,7 @@ void lp_ticker_init(void); /** Read the current tick * - * If no rollover has occurred, the seconds passed since ::lp_ticker_init + * If no rollover has occurred, the seconds passed since lp_ticker_init() * was called can be found by dividing the ticks returned by this function * by the frequency returned by ::lp_ticker_get_info. * @@ -147,7 +147,7 @@ uint32_t lp_ticker_read(void); * * @note no special handling needs to be done for times in the past * as the common timer code will detect this and call - * ::lp_ticker_fire_interrupt if this is the case + * lp_ticker_fire_interrupt() if this is the case * * @note calling this function with timestamp of more than the supported * number of bits returned by ::lp_ticker_get_info results in undefined diff --git a/hal/us_ticker_api.h b/hal/us_ticker_api.h index 0cd8df2645..d69861bab5 100644 --- a/hal/us_ticker_api.h +++ b/hal/us_ticker_api.h @@ -31,8 +31,8 @@ extern "C" { * Low level interface to the microsecond ticker of a target * * # Defined behavior - * * Has a reported frequency between 250KHz and 8MHz - * * Has a counter that is at least 16 bits wide + * * Has a reported frequency between 250KHz and 8MHz - Verified by test ::us_ticker_info_test + * * Has a counter that is at least 16 bits wide - Verified by test ::us_ticker_info_test * * All behavior defined by the @ref hal_ticker_shared "ticker specification" * * # Undefined behavior @@ -80,9 +80,10 @@ extern "C" { * * Calling ticker_set_interrupt with a value that has more than the supported number of bits * * # Potential bugs - * * Drift due to reschedule - Verified by ::ticker_reschedule_test + * * Drift due to reschedule - Verified by ::ticker_repeat_reschedule_test * * Incorrect overflow handling of timers - Verified by ::ticker_overflow_test * * Interrupting at a time of 0 - Verified by ::ticker_overflow_test + * * Interrupt triggered more than once - Verified by ::ticker_interrupt_test * * @ingroup hal_us_ticker * @ingroup hal_lp_ticker @@ -109,7 +110,7 @@ typedef void (*ticker_irq_handler_type)(const ticker_data_t *const); * * @return previous ticker IRQ handler * - * @note by default IRQ handler is set to ticker_irq_handler() + * @note by default IRQ handler is set to ::ticker_irq_handler * @note this function is primarily for testing purposes and it's not required part of HAL implementation * */ @@ -163,7 +164,7 @@ void us_ticker_init(void); /** Read the current tick * * Read the current counter value without performing frequency conversions. - * If no rollover has occurred, the seconds passed since ::us_ticker_init + * If no rollover has occurred, the seconds passed since us_ticker_init() * was called can be found by dividing the ticks returned by this function * by the frequency returned by ::us_ticker_get_info. * @@ -185,7 +186,7 @@ uint32_t us_ticker_read(void); * * @note no special handling needs to be done for times in the past * as the common timer code will detect this and call - * ::us_ticker_fire_interrupt if this is the case + * us_ticker_fire_interrupt() if this is the case * * @note calling this function with timestamp of more than the supported * number of bits returned by ::us_ticker_get_info results in undefined