RTC specification (branch feature-hal-spec) #4931
Conversation
Add the doxygen group hal_specification as a container group for all the API specifications.
Add requirements, tests, an example implementation and additional function documentation to the HAL RTC API.
|
cc @bulislaw |
| */ | ||
| void rtc_init(void); | ||
|
|
||
| /** Deinitialize RTC | ||
| * | ||
| * TODO: The function is not used by rtc api in mbed-drivers. | ||
| * Powerdown the RTC after in preparation for sleep, powerdown or reset. |
There was a problem hiding this comment.
after in preparation
That's probably wrong
There was a problem hiding this comment.
Yep it is. I'll fix the wording
| * | ||
| * # Defined behavior | ||
| * * The function ::rtc_init is safe to call repeatedly - Verified by test ::rtc_init_test | ||
| * * RTC accuracy is at least 10% - Not verified |
There was a problem hiding this comment.
Is the 10% mentioned somewhere else than in tests?
There was a problem hiding this comment.
Nope, just here. There should be a hal test for the eventually though
There was a problem hiding this comment.
Should we mention it in the PG as well so people implementing the API have better picture of what's required.
| * * The function ::rtc_init is safe to call repeatedly - Verified by test ::rtc_init_test | ||
| * * RTC accuracy is at least 10% - Not verified | ||
| * * 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 |
There was a problem hiding this comment.
All these constraints/assumptions should be documented in main header and porting guide.
There was a problem hiding this comment.
The API header has example code for each function and should be embedded in the porting guide. This test header serves as additional information that will also be in the porting guide. Keeping test declarations out of the API header makes it easier to understand since all the functions in that header need to be implemented by the porter.
| @@ -0,0 +1,97 @@ | |||
| /* mbed Microcontroller Library | |||
There was a problem hiding this comment.
We don't usually have test headers, maybe it would make more sense to pull all the requirements to a main API header and porting guide and test case descriptions to the test c file? I think having yet another header to look at is a bit confusing.
There was a problem hiding this comment.
This is required to allow verification tests to be referenced from the doxygen.
theotherjimmy
changed the title
|
Any update here , @c1728p9 ? |
|
I created a dedicated branch for the RTC specification and create a new PR against it. Please add further comments on PR #5008 |
Add the RTC HAL API specification along with tests which verify it.