a752c7ab
 elopes
add first test an...
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*
* Copyright (C) 2014-2015 Freie Universitรคt Berlin
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup drivers_periph_adc ADC
* @ingroup drivers_periph
* @brief Low-level ADC peripheral driver interface
*
* This is a very simple ADC interface to allow platform independent access to
* a MCU's ADC unit(s). This interface is intentionally designed as simple as
* possible, to allow for very easy implementation and maximal portability.
*
* As of now, the interface does not allow for any advanced ADC concepts (e.g.
* continuous mode, scan sequences, injections). It is to be determined, if
* these features will ever be integrated in this interface, or if it does make
* more sense to create a second, advanced ADC interface for this.
*
* The ADC driver interface is built around the concept of ADC lines. An ADC
* line in this context is a tuple consisting out of a hardware ADC device (an
* ADC functional unit on the MCU) and an ADC channel connected to pin.
*
* If a MCU has more than one hardware ADC unit, the ADC lines can be mapped in
* a way, that it is possible to sample multiple lines in parallel, given that
* the ADC implementation allows for interruption of the program flow while
* waiting for the result of a conversion (e.g. through putting the calling
* thread to sleep while waiting for the conversion results).
*
* @todo Extend interface for continuous mode?
*
* @{
*
* @file
* @brief Low-level ADC peripheral driver interface definitions
*
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/
#ifndef PERIPH_ADC_H
#define PERIPH_ADC_H
#include <limits.h>
#include "periph_cpu.h"
#include "periph_conf.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Define default ADC type identifier
*/
#ifndef HAVE_ADC_T
typedef unsigned int adc_t;
#endif
/**
* @brief Default ADC undefined value
*/
#ifndef ADC_UNDEF
#define ADC_UNDEF (UINT_MAX)
#endif
/**
* @brief Default ADC line access macro
*/
#ifndef ADC_LINE
#define ADC_LINE(x) (x)
#endif
/**
* @brief Possible ADC resolution settings
*/
#ifndef HAVE_ADC_RES_T
typedef enum {
ADC_RES_6BIT = 0, /**< ADC resolution: 6 bit */
ADC_RES_8BIT, /**< ADC resolution: 8 bit */
ADC_RES_10BIT, /**< ADC resolution: 10 bit */
ADC_RES_12BIT, /**< ADC resolution: 12 bit */
ADC_RES_14BIT, /**< ADC resolution: 14 bit */
ADC_RES_16BIT, /**< ADC resolution: 16 bit */
} adc_res_t;
#endif
/**
* @brief Initialize the given ADC line
*
* The ADC line is initialized in synchronous, blocking mode.
*
* @param[in] line line to initialize
*
* @return 0 on success
* @return -1 on invalid ADC line
*/
int adc_init(adc_t line);
/**
* @brief Sample a value from the given ADC line
*
* This function blocks until the conversion has finished. Please note, that if
* more than one line share the same ADC device, and if these lines are sampled
* at the same time (e.g. from different threads), the one called secondly waits
* for the first to finish before its conversion starts.
*
* @param[in] line line to sample
* @param[in] res resolution to use for conversion
*
* @return the sampled value on success
* @return -1 if resolution is not applicable
*/
int adc_sample(adc_t line, adc_res_t res);
#ifdef __cplusplus
}
#endif
#endif /* PERIPH_ADC_H */
/** @} */
|