blob: bfb159ca527542ae7f3dd34562c4f499fe2d4c97 (
plain)
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
/**
* @file
* @brief ADC public API header file.
*/
/*
* Copyright (c) 2015 Intel Corporation
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef __INCLUDE_ADC_H__
#define __INCLUDE_ADC_H__
#include <zephyr/types.h>
#include <device.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief ADC driver APIs
* @defgroup adc_interface ADC driver APIs
* @ingroup io_interfaces
* @{
*/
/**
* @brief ADC driver Sequence entry
*
* This structure defines a sequence entry used
* to define a sample from a specific channel.
*/
struct adc_seq_entry {
/** Clock ticks delay before sampling the ADC. */
s32_t sampling_delay;
/** Buffer pointer where the sample is written.*/
u8_t *buffer;
/** Length of the sampling buffer.*/
u32_t buffer_length;
/** Channel ID that should be sampled from the ADC */
u8_t channel_id;
u8_t stride[3];
};
/**
* @brief ADC driver Sequence table
*
* This structure defines a list of sequence entries
* used to execute a sequence of samplings.
*/
struct adc_seq_table {
/* Pointer to a sequence entry array. */
struct adc_seq_entry *entries;
/* Number of entries in the sequence entry array. */
u8_t num_entries;
u8_t stride[3];
};
/**
* @brief ADC driver API
*
* This structure holds all API function pointers.
*/
struct adc_driver_api {
/** Pointer to the enable routine. */
void (*enable)(struct device *dev);
/** Pointer to the disable routine. */
void (*disable)(struct device *dev);
/** Pointer to the read routine. */
int (*read)(struct device *dev, struct adc_seq_table *seq_table);
};
/**
* @brief Enable ADC hardware
*
* This routine enables the ADC hardware block for data sampling for the
* specified device.
*
* @param dev Pointer to the device structure for the driver instance.
*
* @return N/A
*/
static inline void adc_enable(struct device *dev)
{
const struct adc_driver_api *api = dev->driver_api;
api->enable(dev);
}
/**
* @brief Disable ADC hardware
*
* This routine disables the ADC hardware block for data sampling for the
* specified device.
*
* @param dev Pointer to the device structure for the driver instance.
*
* @return N/A
*/
static inline void adc_disable(struct device *dev)
{
const struct adc_driver_api *api = dev->driver_api;
api->disable(dev);
}
/**
* @brief Set a read request.
*
* This routine sends a read or sampling request to the ADC hardware block.
* A sequence table describes the read request.
* The routine returns once the ADC completes the read sequence.
* The sample data can be retrieved from the memory buffers in
* the sequence table structure.
*
* @param dev Pointer to the device structure for the driver instance.
* @param seq_table Pointer to the structure representing the sequence table.
*
* @retval 0 On success
* @retval else Otherwise.
*/
static inline int adc_read(struct device *dev, struct adc_seq_table *seq_table)
{
const struct adc_driver_api *api = dev->driver_api;
return api->read(dev, seq_table);
}
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif /* __INCLUDE_ADC_H__ */
|
