RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

Merge pull request #1469 from haukepetersen/fix_periph_adcif

Browse Source 
drivers: some improvements to the ADC driver interface
This commit is contained in:
Hauke Petersen 2014-07-28 17:23:04 +02:00
commit 5cb11e5608
1 changed files with 41 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -10,7 +10,7 @@
* @brief Low-level ADC peripheral driver
* @{
*
* @file periph/adc.h
* @file
* @brief Low-level ADC peripheral driver interface definitions
*
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
@ -21,6 +21,8 @@
#include "periph_conf.h"
/* guard file in case no ADC device is defined */
#if ADC_NUMOF
/**
* @brief Definition available ADC devices
@ -30,20 +32,31 @@
*/
typedef enum {
#if ADC_0_EN
ADC_0, /*< ADC device 0 */
ADC_0 = 0, /**< ADC device 0 */
#endif
#if ADC_1_EN
ADC_1, /*< ADC device 1 */
ADC_1, /**< ADC device 1 */
#endif
#if ADC_2_EN
ADC_2, /*< ADC device 2 */
ADC_2, /**< ADC device 2 */
#endif
#if ADC_3_EN
ADC_3, /*< ADC device 3 */
ADC_3, /**< ADC device 3 */
#endif
ADC_UNDEFINED
} adc_t;
/**
* @brief Possible ADC precision settings
*/
typedef enum {
ADC_RES_6BIT = 0, /**< ADC precision: 6 bit */
ADC_RES_8BIT, /**< ADC precision: 8 bit */
ADC_RES_10BIT, /**< ADC precision: 10 bit */
ADC_RES_12BIT, /**< ADC precision: 12 bit */
ADC_RES_14BIT, /**< ADC precision: 14 bit */
ADC_RES_16BIT, /**< ADC precision: 16 bit */
} adc_precision_t;
/**
* @brief Initialization of a given ADC device
*
@ -52,12 +65,12 @@ typedef enum {
* range of some us).
*
* @param[in] dev the device to initialize
* @param[in] precision the conversion precision in bits, will LSBs will be stuffed if
* precision > max precision of hardware
* @param[in] precision the precision to use for conversion
*
* @return 1 on success, -1 on error
* @return 0 on success
* @return -1 on precision not available
*/
int adc_init(adc_t dev, int precision);
int adc_init(adc_t dev, adc_precision_t precision);
/**
* @brief Start a new conversion by using the given channel.
@ -67,10 +80,25 @@ int adc_init(adc_t dev, int precision);
* @param[in] dev the ADC device to use for the conversion
* @param[in] channel the channel to convert from
*
* @return the converted value with the defined precision, -1 on error
* @return the converted value
* @return -1 on invalid channel
*/
int adc_sample(adc_t dev, int channel);
/**
* @brief Enable the power for the given ADC device
*
* @param[in] dev the ADC device to power up
*/
void adc_poweron(adc_t dev);
/**
* @brief Disable the power for the given ADC device
*
* @param[in] dev the ADC device to power down
*/
void adc_poweroff(adc_t dev);
/**
* @brief Helper function to map a converted value to the given integer range.
*
@ -101,5 +129,7 @@ int adc_map(adc_t dev, int value, int min, int max);
*/
float adc_mapf(adc_t dev, int value, float min, float max);
#endif /* ADC_NUMOF */
#endif /* __ADC_H */
/** @} */