lp ticker wrapper: Add undefined behavior warning

pull/8279/head
Filip Jagodzinski 2018-10-19 17:27:36 +02:00
parent 023603faa7
commit effabc5271
2 changed files with 6 additions and 0 deletions

View File

@ -74,6 +74,9 @@ public:
*
* This stops to wrapper layer from using the microsecond ticker.
* This should be called before using the low power ticker APIs directly.
*
* @warning: Make sure to suspend the LP ticker first (call ticker_suspend()),
* otherwise the behavior is undefined.
*/
void suspend();

View File

@ -53,6 +53,9 @@ const ticker_data_t *get_lp_ticker_wrapper_data(const ticker_data_t *data);
*
* Pass through all interrupts to the low power ticker and stop using
* the microsecond ticker.
*
* @warning: Make sure to suspend the LP ticker first (call ticker_suspend()),
* otherwise the behavior is undefined.
*/
void lp_ticker_wrapper_suspend(void);