riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

periph/adc: add doc on low power implications

Browse Source
This commit is contained in:
Hauke Petersen 2018-12-06 09:58:17 +01:00
parent aed628f08b
commit f361ebc0bd
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
drivers/include/periph/adc.h
View File

@ -30,6 +30,18 @@
* waiting for the result of a conversion (e.g. through putting the calling * waiting for the result of a conversion (e.g. through putting the calling
* thread to sleep while waiting for the conversion results). * thread to sleep while waiting for the conversion results).
* *
* # (Low-) Power Implications
*
* The ADC peripheral(s) **should** only be powered on while adc_sample() is
* active. For implementing adc_sample() this means, that the peripheral should
* be powered on (i.e. through peripheral clock gating) at the beginning of the
* function and it should be powered back off at the end of the function.
*
* If the adc_sample() function is implemented in a way, that it will put the
* active thread to sleep for a certain amount of time, the implementation
* might need to block certain power states.
*
*
* @todo Extend interface for continuous mode? * @todo Extend interface for continuous mode?
* *
* @{ * @{