Skip to content

Add RTC HAL page to PG #242

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.

Sign up for GitHub

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 4 commits into from
Sep 15, 2017
Merged

Add RTC HAL page to PG #242

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
24e7ecd
Add RTC HAL page to PG
bulislaw Sep 8, 2017
91a4c9b
Copy edit rtc.md
Sep 11, 2017
bf8d10a
Add link to rtc.md
Sep 14, 2017
02e9c22
Delete section from rtc.md
Sep 15, 2017
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
Prev Previous commit
Delete section from rtc.md 
Delete testing section. Please add the content in a new PR once the content is ready for docs.
  • Loading branch information
Amanda Butler authored Sep 15, 2017
commit 02e9c229f9de2e20c57bb641628a711f7459c08a
11 changes: 0 additions & 11 deletions docs/contributing/rtc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,3 @@ The RTC HAL API provides a low-level interface to the Real Time Counter (RTC) of
RTC HAL API is in [hal/rtc_api.h](/docs/v5.4/mbed-os-api-doxy/rtc__api_8h_source.html). You need to implement the following functions to support RTC:

To enable sleep support in Mbed OS, you need to add the `RTC` label in the `device_has` option of the target's section in the `targets.json` file.

### Testing

The [RTC HAL API test suite]() validates:

- `rtc_init` is safe to call repeatedly - Verified by test `rtc_init_test`.
- `Init`/`free` doesn't stop RTC from counting - Verified by test `rtc_persist_test`.
- Software reset doesn't stop RTC from counting - Verified by `rtc_reset_test`.
- Sleep modes don't stop RTC from counting - Verified by `rtc_sleep_test`.
- Overflow handling - Verified by `rtc_range_test`.
- No backward glitches - Verified by `rtc_glitch_test`.