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 */
18  * adc_data_format: define the ADC output data format, can be useful when
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()
55  * Those are useful for some cases of ADC's references, e.g.:
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
97 	 * @dev:          ADC device to init
99 	 * @return:       0 if OK, -ve on error
104 	 * start_channels() - start conversion with its default parameters
110 	 * @dev:          ADC device to init
111 	 * @channel_mask: bit mask of selected analog channels
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,
125 	 * in ADC uclasses platform data structure.
127 	 * @dev:          ADC device to trigger
130 	 * @return:       0 if OK, -EBUSY if busy, and other negative on error
136 	 * channels_data() - get conversion data for the selected channels.
145 	 * @dev:          ADC device to trigger
146 	 * @channel_mask: bit mask of selected analog channels
147 	 * @channels:     returned pointer to array of output data for channels
149 	 * @return:       0 if OK, -ve on error
152 			     struct adc_channel *channels);
155 	 * stop() - stop conversion of the given ADC device
157 	 * @dev:          ADC device to stop
158 	 * @return:       0 if OK, -ve on error
164  * adc_start_channel() - start conversion for given device/channel and exit.
166  * @dev:     ADC device
168  * @return:  0 if OK, -ve on error
173  * adc_start_channels() - start conversion for given device/channels and exit.
178  * @dev:          ADC device to start
179  * @channel_mask: channel selection - a bit mask
180  * @channel_mask: bit mask of analog channels
181  * @return:       0 if OK, -ve on error
186  * adc_channel_data() - get conversion data for the given device channel number.
188  * @dev:     ADC device to read
191  * @return:  0 if OK, -ve on error
196  * adc_channels_data() - get conversion data for the channels selected by mask
200  * - start_channels()
201  * - channels_data()
203  * @dev:          ADC device to read
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
209 		      struct adc_channel *channels);
212  * adc_data_mask() - get data mask (ADC resolution bitmask) for given ADC device
214  * This can be used if adc uclass platform data is filled.
216  * @dev:       ADC device to check
218  * @return: 0 if OK, -ve on error
223  * adc_channel_single_shot() - get output data of conversion for the ADC
228  * - start_channel()
229  * - channel_data()
234  * @return:  0 if OK, -ve on error
239  * adc_channels_single_shot() - get ADC conversion output data for the selected
240  * device's channels. This function searches for the device by the given name,
241  * starts the selected channels conversion and returns the output data as array
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,
249  * @channel_mask: channel selection - a bit mask
250  * @channels:     pointer to conversion output data for the selected channels
251  * @return:       0 if OK, -ve on error
254 			     struct adc_channel *channels);
257  * adc_vdd_value() - get the ADC device's positive reference Voltage value
262  * @dev:     ADC device to check
264  * @return:  0 on success or -ve on error
269  * adc_vss_value() - get the ADC device's negative reference Voltage value
274  * @dev:     ADC device to check
276  * @return:  0 on success or -ve on error
281  * adc_stop() - stop operation for given ADC device.
283  * @dev:     ADC device to stop
284  * @return:  0 if OK, -ve on error