u-boot/include/adc.h

5  * SPDX-License-Identifier:	GPL-2.0+
11 /* ADC_CHANNEL() - ADC channel bit mask, to select only required channels */
14 /* The last possible selected channel with 32-bit mask */
20  * - ADC_DATA_FORMAT_BIN - binary offset
21  * - ADC_DATA_FORMAT_2S  - two's complement
32  * struct adc_channel - structure to hold channel conversion data.
33  * Useful to keep the result of a multi-channel conversion output.
35  * @id   - channel id
36  * @data - channel conversion data
44  * struct adc_uclass_platdata - basic ADC info
53  * - adc_vdd_value()
54  * - adc_vss_value()
56  * * Vdd: +3.3V; Vss: -3.3V -> 6.6 Vdiff
57  * * Vdd: +3.3V; Vss: +0.3V -> 3.0 Vdiff
58  * * Vdd: +3.3V; Vss:  0.0V -> 3.3 Vdiff
62  * - doc/device-tree-bindings/adc/adc.txt
64  * @data_mask              - conversion output data mask
65  * @data_timeout_us        - single channel conversion timeout
66  * @multidata_timeout_us   - multi channel conversion timeout
67  * @channel_mask           - bit mask of available channels [0:31]
68  * @vdd_supply             - positive reference Voltage supply (regulator)
69  * @vss_supply             - negative reference Voltage supply (regulator)
70  * @vdd_polarity_negative  - positive reference Voltage has negative polarity
71  * @vss_polarity_negative  - negative reference Voltage has negative polarity
72  * @vdd_microvolts         - positive reference Voltage value
73  * @vss_microvolts         - negative reference Voltage value
90  * struct adc_ops - ADC device operations for single/multi-channel operation.
94 	 * start_channel() - start conversion with its default parameters
95 	 *                   for the given channel number.
98 	 * @channel:      analog channel number
99 	 * @return:       0 if OK, -ve on error
101 	int (*start_channel)(struct udevice *dev, int channel);
104 	 * start_channels() - start conversion with its default parameters
105 	 *                    for the channel numbers selected by the bit mask.
108 	 * conversion by the single software trigger.
112 	 * @return:       0 if OK, -ve on error
117 	 * channel_data() - get conversion output data for the given channel.
122 	 * return with -EBUSY value. The ADC API will call it in a loop,
128 	 * @channel:      selected analog channel number
129 	 * @data:         returned pointer to selected channel's output data
130 	 * @return:       0 if OK, -EBUSY if busy, and other negative on error
132 	int (*channel_data)(struct udevice *dev, int channel,
136 	 * channels_data() - get conversion data for the selected channels.
139 	 * by the hardware, by the single software trigger.
149 	 * @return:       0 if OK, -ve on error
155 	 * stop() - stop conversion of the given ADC device
158 	 * @return:       0 if OK, -ve on error
164  * adc_start_channel() - start conversion for given device/channel and exit.
167  * @channel: analog channel number
168  * @return:  0 if OK, -ve on error
170 int adc_start_channel(struct udevice *dev, int channel);
173  * adc_start_channels() - start conversion for given device/channels and exit.
179  * @channel_mask: channel selection - a bit mask
181  * @return:       0 if OK, -ve on error
186  * adc_channel_data() - get conversion data for the given device channel number.
189  * @channel: analog channel number
190  * @data:    pointer to returned channel's data
191  * @return:  0 if OK, -ve on error
193 int adc_channel_data(struct udevice *dev, int channel, unsigned int *data);
196  * adc_channels_data() - get conversion data for the channels selected by mask
200  * - start_channels()
201  * - channels_data()
204  * @channel_mask: channel selection - a bit mask
205  * @channels:     pointer to structure array of returned data for each channel
206  * @return:       0 if OK, -ve on error
212  * adc_data_mask() - get data mask (ADC resolution bitmask) for given ADC device
218  * @return: 0 if OK, -ve on error
223  * adc_channel_single_shot() - get output data of conversion for the ADC
224  * device's channel. This function searches for the device with the given name,
225  * starts the given channel conversion and returns the output data.
228  * - start_channel()
229  * - channel_data()
232  * @channel: device's input channel to init
234  * @return:  0 if OK, -ve on error
236 int adc_channel_single_shot(const char *name, int channel, unsigned int *data);
239  * adc_channels_single_shot() - get ADC conversion output data for the selected
244  * Note: This function can be used if device implements one of ADC's single
245  * or multi-channel operation API. If multi-channel operation is not supported,
246  * then each selected channel is triggered by the sequence start/data in a loop.
249  * @channel_mask: channel selection - a bit mask
251  * @return:       0 if OK, -ve on error
257  * adc_vdd_value() - get the ADC device's positive reference Voltage value
264  * @return:  0 on success or -ve on error
269  * adc_vss_value() - get the ADC device's negative reference Voltage value
276  * @return:  0 on success or -ve on error
281  * adc_stop() - stop operation for given ADC device.
284  * @return:  0 if OK, -ve on error