Skip to content

Commit b3cbea7

Browse files
committed
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.
1 parent a607483 commit b3cbea7

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

hal/lp_ticker_api.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ extern "C" {
3434
* Low level interface to the low power ticker of a target
3535
*
3636
* # Defined behavior
37-
* * Has a reported frequency between 8KHz and 64KHz - verified by lp_ticker_info_test
38-
* * Has a counter that is at least 12 bits wide - verified by lp_ticker_info_test
39-
* * Continues operating in deep sleep mode - verified by lp_ticker_sleep_test
37+
* * Has a reported frequency between 8KHz and 64KHz - verified by ::lp_ticker_info_test
38+
* * Has a counter that is at least 12 bits wide - verified by ::lp_ticker_info_test
39+
* * Continues operating in deep sleep mode - verified by ::lp_ticker_deepsleep_test
4040
* * All behavior defined by the @ref hal_ticker_shared "ticker specification"
4141
*
4242
* # Undefined behavior
@@ -65,7 +65,7 @@ typedef void (*ticker_irq_handler_type)(const ticker_data_t *const);
6565
*
6666
* @return previous ticker IRQ handler
6767
*
68-
* @note by default IRQ handler is set to ticker_irq_handler()
68+
* @note by default IRQ handler is set to ::ticker_irq_handler
6969
* @note this function is primarily for testing purposes and it's not required part of HAL implementation
7070
*
7171
*/
@@ -114,7 +114,7 @@ void lp_ticker_init(void);
114114

115115
/** Read the current tick
116116
*
117-
* If no rollover has occurred, the seconds passed since ::lp_ticker_init
117+
* If no rollover has occurred, the seconds passed since lp_ticker_init()
118118
* was called can be found by dividing the ticks returned by this function
119119
* by the frequency returned by ::lp_ticker_get_info.
120120
*
@@ -147,7 +147,7 @@ uint32_t lp_ticker_read(void);
147147
*
148148
* @note no special handling needs to be done for times in the past
149149
* as the common timer code will detect this and call
150-
* ::lp_ticker_fire_interrupt if this is the case
150+
* lp_ticker_fire_interrupt() if this is the case
151151
*
152152
* @note calling this function with timestamp of more than the supported
153153
* number of bits returned by ::lp_ticker_get_info results in undefined

hal/us_ticker_api.h

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ extern "C" {
3131
* Low level interface to the microsecond ticker of a target
3232
*
3333
* # Defined behavior
34-
* * Has a reported frequency between 250KHz and 8MHz
35-
* * Has a counter that is at least 16 bits wide
34+
* * Has a reported frequency between 250KHz and 8MHz - Verified by test ::us_ticker_info_test
35+
* * Has a counter that is at least 16 bits wide - Verified by test ::us_ticker_info_test
3636
* * All behavior defined by the @ref hal_ticker_shared "ticker specification"
3737
*
3838
* # Undefined behavior
@@ -80,9 +80,10 @@ extern "C" {
8080
* * Calling ticker_set_interrupt with a value that has more than the supported number of bits
8181
*
8282
* # Potential bugs
83-
* * Drift due to reschedule - Verified by ::ticker_reschedule_test
83+
* * Drift due to reschedule - Verified by ::ticker_repeat_reschedule_test
8484
* * Incorrect overflow handling of timers - Verified by ::ticker_overflow_test
8585
* * Interrupting at a time of 0 - Verified by ::ticker_overflow_test
86+
* * Interrupt triggered more than once - Verified by ::ticker_interrupt_test
8687
*
8788
* @ingroup hal_us_ticker
8889
* @ingroup hal_lp_ticker
@@ -109,7 +110,7 @@ typedef void (*ticker_irq_handler_type)(const ticker_data_t *const);
109110
*
110111
* @return previous ticker IRQ handler
111112
*
112-
* @note by default IRQ handler is set to ticker_irq_handler()
113+
* @note by default IRQ handler is set to ::ticker_irq_handler
113114
* @note this function is primarily for testing purposes and it's not required part of HAL implementation
114115
*
115116
*/
@@ -163,7 +164,7 @@ void us_ticker_init(void);
163164
/** Read the current tick
164165
*
165166
* Read the current counter value without performing frequency conversions.
166-
* If no rollover has occurred, the seconds passed since ::us_ticker_init
167+
* If no rollover has occurred, the seconds passed since us_ticker_init()
167168
* was called can be found by dividing the ticks returned by this function
168169
* by the frequency returned by ::us_ticker_get_info.
169170
*
@@ -185,7 +186,7 @@ uint32_t us_ticker_read(void);
185186
*
186187
* @note no special handling needs to be done for times in the past
187188
* as the common timer code will detect this and call
188-
* ::us_ticker_fire_interrupt if this is the case
189+
* us_ticker_fire_interrupt() if this is the case
189190
*
190191
* @note calling this function with timestamp of more than the supported
191192
* number of bits returned by ::us_ticker_get_info results in undefined

0 commit comments

Comments
 (0)