u-boot/include/adc.h

1 /* SPDX-License-Identifier: GPL-2.0+ */
10 /* ADC_CHANNEL() - ADC channel bit mask, to select only required channels */
13 /* The last possible selected channel with 32-bit mask */
17  * adc_data_format: define the ADC output data format, can be useful when
19  * - ADC_DATA_FORMAT_BIN - binary offset
20  * - ADC_DATA_FORMAT_2S  - two's complement
31  * struct adc_channel - structure to hold channel conversion data.
32  * Useful to keep the result of a multi-channel conversion output.
34  * @id   - channel id
35  * @data - channel conversion data
43  * struct adc_uclass_platdata - basic ADC info
52  * - adc_vdd_value()
53  * - adc_vss_value()
54  * Those are useful for some cases of ADC's references, e.g.:
55  * * Vdd: +3.3V; Vss: -3.3V -> 6.6 Vdiff
56  * * Vdd: +3.3V; Vss: +0.3V -> 3.0 Vdiff
57  * * Vdd: +3.3V; Vss:  0.0V -> 3.3 Vdiff
61  * - doc/device-tree-bindings/adc/adc.txt
63  * @data_mask              - conversion output data mask
64  * @data_timeout_us        - single channel conversion timeout
65  * @multidata_timeout_us   - multi channel conversion timeout
66  * @channel_mask           - bit mask of available channels [0:31]
67  * @vdd_supply             - positive reference Voltage supply (regulator)
68  * @vss_supply             - negative reference Voltage supply (regulator)
69  * @vdd_polarity_negative  - positive reference Voltage has negative polarity
70  * @vss_polarity_negative  - negative reference Voltage has negative polarity
71  * @vdd_microvolts         - positive reference Voltage value
72  * @vss_microvolts         - negative reference Voltage value
89  * struct adc_ops - ADC device operations for single/multi-channel operation.
93 	 * start_channel() - start conversion with its default parameters
96 	 * @dev:          ADC device to init
98 	 * @return:       0 if OK, -ve on error
103 	 * start_channels() - start conversion with its default parameters
109 	 * @dev:          ADC device to init
110 	 * @channel_mask: bit mask of selected analog channels
111 	 * @return:       0 if OK, -ve on error
116 	 * channel_data() - get conversion output data for the given channel.
121 	 * return with -EBUSY value. The ADC API will call it in a loop,
124 	 * in ADC uclasses platform data structure.
126 	 * @dev:          ADC device to trigger
129 	 * @return:       0 if OK, -EBUSY if busy, and other negative on error
135 	 * channels_data() - get conversion data for the selected channels.
144 	 * @dev:          ADC device to trigger
145 	 * @channel_mask: bit mask of selected analog channels
146 	 * @channels:     returned pointer to array of output data for channels
148 	 * @return:       0 if OK, -ve on error
151 			     struct adc_channel *channels);
154 	 * stop() - stop conversion of the given ADC device
156 	 * @dev:          ADC device to stop
157 	 * @return:       0 if OK, -ve on error
163  * adc_start_channel() - start conversion for given device/channel and exit.
165  * @dev:     ADC device
167  * @return:  0 if OK, -ve on error
172  * adc_start_channels() - start conversion for given device/channels and exit.
177  * @dev:          ADC device to start
178  * @channel_mask: channel selection - a bit mask
179  * @channel_mask: bit mask of analog channels
180  * @return:       0 if OK, -ve on error
185  * adc_channel_data() - get conversion data for the given device channel number.
187  * @dev:     ADC device to read
190  * @return:  0 if OK, -ve on error
195  * adc_channels_data() - get conversion data for the channels selected by mask
199  * - start_channels()
200  * - channels_data()
202  * @dev:          ADC device to read
203  * @channel_mask: channel selection - a bit mask
204  * @channels:     pointer to structure array of returned data for each channel
205  * @return:       0 if OK, -ve on error
208 		      struct adc_channel *channels);
211  * adc_data_mask() - get data mask (ADC resolution bitmask) for given ADC device
213  * This can be used if adc uclass platform data is filled.
215  * @dev:       ADC device to check
217  * @return: 0 if OK, -ve on error
222  * adc_channel_mask() - get channel mask for given ADC device
224  * This can be used if adc uclass platform data is filled.
226  * @dev:       ADC device to check
228  * @return: 0 if OK, -ve on error
233  * adc_channel_single_shot() - get output data of conversion for the ADC
238  * - start_channel()
239  * - channel_data()
244  * @return:  0 if OK, -ve on error
249  * adc_channels_single_shot() - get ADC conversion output data for the selected
250  * device's channels. This function searches for the device by the given name,
251  * starts the selected channels conversion and returns the output data as array
254  * Note: This function can be used if device implements one of ADC's single
255  * or multi-channel operation API. If multi-channel operation is not supported,
259  * @channel_mask: channel selection - a bit mask
260  * @channels:     pointer to conversion output data for the selected channels
261  * @return:       0 if OK, -ve on error
264 			     struct adc_channel *channels);
267  * adc_vdd_value() - get the ADC device's positive reference Voltage value
272  * @dev:     ADC device to check
274  * @return:  0 on success or -ve on error
279  * adc_vss_value() - get the ADC device's negative reference Voltage value
284  * @dev:     ADC device to check
286  * @return:  0 on success or -ve on error
291  * adc_stop() - stop operation for given ADC device.
293  * @dev:     ADC device to stop
294  * @return:  0 if OK, -ve on error
299  * adc_raw_to_uV() - converts raw value to microvolts for given ADC device.
301  * @dev:     ADC device used from conversion
304  * @return:  0 on success or -ve on error