Skip to content

Commit 44b768d

Browse files
author
Amanda Butler
authored
Relax frequency requirements in us_ticker.md
Apply changes from PR #1123 to v5.13.
1 parent 881fcd8 commit 44b768d

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/porting/target/us_ticker.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ Implementing the microsecond ticker enables Mbed OS to perform operations that r
66

77
### Defined behavior
88

9-
- Has a reported frequency between 250KHz and 8MHz.
9+
- Has a reported frequency between 250 KHz and 8 MHz for counters that are less than 32 bits wide.
10+
- Has a reported frequency up to 100 MHz for counters that are 32 bits wide.
1011
- Has a counter that is at least 16 bits wide.
1112
- The function `ticker_init` is safe to call repeatedly.
1213
- The function `ticker_init` allows the ticker to keep counting and disables the ticker interrupt.
@@ -17,7 +18,7 @@ Implementing the microsecond ticker enables Mbed OS to perform operations that r
1718
- The ticker interrupt fires only when the ticker time increments to or past the value set by `ticker_set_interrupt`.
1819
- It is safe to call `ticker_set_interrupt` repeatedly before the handler is called.
1920
- The function `ticker_fire_interrupt` causes `ticker_irq_handler` to be called immediately from interrupt context.
20-
- The ticker operations `ticker_read`, `ticker_clear_interrupt`, `ticker_set_interrupt` and `ticker_fire_interrupt` take less than 20us to complete.
21+
- The ticker operations `ticker_read`, `ticker_clear_interrupt`, `ticker_set_interrupt` and `ticker_fire_interrupt` take less than 20 us to complete.
2122
- The ticker operations `ticker_init` and `ticker_read` are atomic.
2223

2324
### Undefined behavior
@@ -31,13 +32,13 @@ Implementing the microsecond ticker enables Mbed OS to perform operations that r
3132

3233
Be careful around these common trouble areas when implementing this API:
3334

34-
- The ticker cannot drift when rescheduled repeatedly
35-
- The ticker keeps counting when it rolls over
36-
- The ticker interrupt fires when the compare value is set to 0 and overflow occurs
35+
- The ticker cannot drift when rescheduled repeatedly.
36+
- The ticker keeps counting when it rolls over.
37+
- The ticker interrupt fires when the compare value is set to 0 and overflow occurs.
3738

3839
## Dependencies
3940

40-
To implement this API, the device must have a hardware counter that has a count value at least 16 bits wide and can operate between 250KHz and 8MHz.
41+
To implement this API, the device must have a hardware counter that has a count value at least 16 bits wide and can operate between 250 KHz and 8 MHz.
4142

4243
## Implementing the microsecond ticker API
4344

0 commit comments

Comments
 (0)