Skip to content

Add synchronization delay section in lp ticker #491

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 1, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/reference/contributing/target/lp_ticker.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ Be careful around these common trouble areas when implementing this API:
- The ticker keeps counting when it rolls over
- The ticker interrupt fires when the compare value is set to 0 and and overflow occurs

#### Handling synchronization delay

Some low power tickers require multiple low power clock cycles for the compare value that `ticker_set_interrupt` sets to take effect. Further complicating this issue, a new compare value typically cannot be set until the first has taken effect. Because of this, when you make back-to-back calls to `ticker_set_interrupt` without a delay, the second call blocks and violates the above requirement that `ticker_set_interrupt` completes in 20us.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Query: Who or what typically sets a new compare value?


To meet this timing requirement, targets that have this synchronization delay must set `LOWPOWERTIMER_DELAY_TICKS` to the number of low power clock cycles it takes for a call to `ticker_set_interrupt` to take effect. When the targets set this value, the timer code prevents `lp_ticker_set_interrupt` from being called twice within that number of clock cycles. It does this by using the microsecond time to schedule the write to happen at a future date.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi
So LOWPOWERTIMER_DELAY_TICKS will not be renamed as LPTICKER_DELAY_TICKS ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @jeromecoutant sorry for not responding earlier. I'm not sure when the feature branch is going to be merged to master, so I left this with the name on master. Once the feature branch is merged to master I'll update this for the new name.


### Dependencies

Hardware low power ticker capabilities.
Expand Down