Modify requirement for the ticker_init function.

mprse · cmonr · commit b0c68d9372a6 · 2018-02-13T11:53:37.000-06:00
Current version: The function ticker_init resets the internal count and disables the ticker interrupt. Proposed version: The function ticker_init allows the ticker to keep counting and disables the ticker interrupt. This is a result of the following discussion: #5233 (review)
diff --git a/hal/us_ticker_api.h b/hal/us_ticker_api.h
@@ -61,7 +61,7 @@ extern "C" {
  *
  * # Defined behavior
  * * The function ticker_init is safe to call repeatedly - Verified by test ::ticker_init_test
- * * The function ticker_init resets the internal count and disables the ticker interrupt - Verified by test ::ticker_init_test
+ * * The function ticker_init allows the ticker to keep counting and disables the ticker interrupt - Verified by test ::ticker_init_test
  * * Ticker frequency is non-zero and counter is at least 8 bits - Verified by ::ticker_info_test
  * * The ticker rolls over at (1 << bits) and continues counting starting from 0 - Verified by ::ticker_overflow_test
  * * The ticker counts at the specified frequency +- 10% - Verified by ::ticker_frequency_test

Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ extern "C" {`
`61`	`61`	`*`
`62`	`62`	`* # Defined behavior`
`63`	`63`	`* * The function ticker_init is safe to call repeatedly - Verified by test ::ticker_init_test`
`64`		`- * * The function ticker_init resets the internal count and disables the ticker interrupt - Verified by test ::ticker_init_test`
	`64`	`+ * * The function ticker_init allows the ticker to keep counting and disables the ticker interrupt - Verified by test ::ticker_init_test`
`65`	`65`	`* * Ticker frequency is non-zero and counter is at least 8 bits - Verified by ::ticker_info_test`
`66`	`66`	`* * The ticker rolls over at (1 << bits) and continues counting starting from 0 - Verified by ::ticker_overflow_test`
`67`	`67`	`* * The ticker counts at the specified frequency +- 10% - Verified by ::ticker_frequency_test`