1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 #ifndef _IIO_BACKEND_H_
3 #define _IIO_BACKEND_H_
4
5 #include <linux/types.h>
6 #include <linux/iio/iio.h>
7
8 struct iio_chan_spec;
9 struct fwnode_handle;
10 struct iio_backend;
11 struct device;
12 struct iio_dev;
13
14 enum iio_backend_data_type {
15 IIO_BACKEND_TWOS_COMPLEMENT,
16 IIO_BACKEND_OFFSET_BINARY,
17 IIO_BACKEND_DATA_UNSIGNED,
18 IIO_BACKEND_DATA_TYPE_MAX
19 };
20
21 enum iio_backend_data_source {
22 IIO_BACKEND_INTERNAL_CONTINUOUS_WAVE,
23 IIO_BACKEND_EXTERNAL,
24 IIO_BACKEND_INTERNAL_RAMP_16BIT,
25 IIO_BACKEND_DATA_SOURCE_MAX
26 };
27
28 #define iio_backend_debugfs_ptr(ptr) PTR_IF(IS_ENABLED(CONFIG_DEBUG_FS), ptr)
29
30 /**
31 * IIO_BACKEND_EX_INFO - Helper for an IIO extended channel attribute
32 * @_name: Attribute name
33 * @_shared: Whether the attribute is shared between all channels
34 * @_what: Data private to the driver
35 */
36 #define IIO_BACKEND_EX_INFO(_name, _shared, _what) { \
37 .name = (_name), \
38 .shared = (_shared), \
39 .read = iio_backend_ext_info_get, \
40 .write = iio_backend_ext_info_set, \
41 .private = (_what), \
42 }
43
44 /**
45 * struct iio_backend_data_fmt - Backend data format
46 * @type: Data type.
47 * @sign_extend: Bool to tell if the data is sign extended.
48 * @enable: Enable/Disable the data format module. If disabled,
49 * not formatting will happen.
50 */
51 struct iio_backend_data_fmt {
52 enum iio_backend_data_type type;
53 bool sign_extend;
54 bool enable;
55 };
56
57 /* vendor specific from 32 */
58 enum iio_backend_test_pattern {
59 IIO_BACKEND_NO_TEST_PATTERN,
60 /* modified prbs9 */
61 IIO_BACKEND_ADI_PRBS_9A = 32,
62 /* modified prbs23 */
63 IIO_BACKEND_ADI_PRBS_23A,
64 IIO_BACKEND_TEST_PATTERN_MAX
65 };
66
67 enum iio_backend_sample_trigger {
68 IIO_BACKEND_SAMPLE_TRIGGER_EDGE_FALLING,
69 IIO_BACKEND_SAMPLE_TRIGGER_EDGE_RISING,
70 IIO_BACKEND_SAMPLE_TRIGGER_MAX
71 };
72
73 enum iio_backend_interface_type {
74 IIO_BACKEND_INTERFACE_SERIAL_LVDS,
75 IIO_BACKEND_INTERFACE_SERIAL_CMOS,
76 IIO_BACKEND_INTERFACE_MAX
77 };
78
79 /**
80 * struct iio_backend_ops - operations structure for an iio_backend
81 * @enable: Enable backend.
82 * @disable: Disable backend.
83 * @chan_enable: Enable one channel.
84 * @chan_disable: Disable one channel.
85 * @data_format_set: Configure the data format for a specific channel.
86 * @data_source_set: Configure the data source for a specific channel.
87 * @data_source_get: Data source getter for a specific channel.
88 * @set_sample_rate: Configure the sampling rate for a specific channel.
89 * @test_pattern_set: Configure a test pattern.
90 * @chan_status: Get the channel status.
91 * @iodelay_set: Set digital I/O delay.
92 * @data_sample_trigger: Control when to sample data.
93 * @request_buffer: Request an IIO buffer.
94 * @free_buffer: Free an IIO buffer.
95 * @extend_chan_spec: Extend an IIO channel.
96 * @ext_info_set: Extended info setter.
97 * @ext_info_get: Extended info getter.
98 * @interface_type_get: Interface type.
99 * @data_size_set: Data size.
100 * @oversampling_ratio_set: Set Oversampling ratio.
101 * @read_raw: Read a channel attribute from a backend device
102 * @debugfs_print_chan_status: Print channel status into a buffer.
103 * @debugfs_reg_access: Read or write register value of backend.
104 * @ddr_enable: Enable interface DDR (Double Data Rate) mode.
105 * @ddr_disable: Disable interface DDR (Double Data Rate) mode.
106 * @data_stream_enable: Enable data stream.
107 * @data_stream_disable: Disable data stream.
108 * @data_transfer_addr: Set data address.
109 **/
110 struct iio_backend_ops {
111 int (*enable)(struct iio_backend *back);
112 void (*disable)(struct iio_backend *back);
113 int (*chan_enable)(struct iio_backend *back, unsigned int chan);
114 int (*chan_disable)(struct iio_backend *back, unsigned int chan);
115 int (*data_format_set)(struct iio_backend *back, unsigned int chan,
116 const struct iio_backend_data_fmt *data);
117 int (*data_source_set)(struct iio_backend *back, unsigned int chan,
118 enum iio_backend_data_source data);
119 int (*data_source_get)(struct iio_backend *back, unsigned int chan,
120 enum iio_backend_data_source *data);
121 int (*set_sample_rate)(struct iio_backend *back, unsigned int chan,
122 u64 sample_rate_hz);
123 int (*test_pattern_set)(struct iio_backend *back,
124 unsigned int chan,
125 enum iio_backend_test_pattern pattern);
126 int (*chan_status)(struct iio_backend *back, unsigned int chan,
127 bool *error);
128 int (*iodelay_set)(struct iio_backend *back, unsigned int chan,
129 unsigned int taps);
130 int (*data_sample_trigger)(struct iio_backend *back,
131 enum iio_backend_sample_trigger trigger);
132 struct iio_buffer *(*request_buffer)(struct iio_backend *back,
133 struct iio_dev *indio_dev);
134 void (*free_buffer)(struct iio_backend *back,
135 struct iio_buffer *buffer);
136 int (*extend_chan_spec)(struct iio_backend *back,
137 struct iio_chan_spec *chan);
138 int (*ext_info_set)(struct iio_backend *back, uintptr_t private,
139 const struct iio_chan_spec *chan,
140 const char *buf, size_t len);
141 int (*ext_info_get)(struct iio_backend *back, uintptr_t private,
142 const struct iio_chan_spec *chan, char *buf);
143 int (*interface_type_get)(struct iio_backend *back,
144 enum iio_backend_interface_type *type);
145 int (*data_size_set)(struct iio_backend *back, unsigned int size);
146 int (*oversampling_ratio_set)(struct iio_backend *back,
147 unsigned int ratio);
148 int (*read_raw)(struct iio_backend *back,
149 struct iio_chan_spec const *chan, int *val, int *val2,
150 long mask);
151 int (*debugfs_print_chan_status)(struct iio_backend *back,
152 unsigned int chan, char *buf,
153 size_t len);
154 int (*debugfs_reg_access)(struct iio_backend *back, unsigned int reg,
155 unsigned int writeval, unsigned int *readval);
156 int (*ddr_enable)(struct iio_backend *back);
157 int (*ddr_disable)(struct iio_backend *back);
158 int (*data_stream_enable)(struct iio_backend *back);
159 int (*data_stream_disable)(struct iio_backend *back);
160 int (*data_transfer_addr)(struct iio_backend *back, u32 address);
161 };
162
163 /**
164 * struct iio_backend_info - info structure for an iio_backend
165 * @name: Backend name.
166 * @ops: Backend operations.
167 */
168 struct iio_backend_info {
169 const char *name;
170 const struct iio_backend_ops *ops;
171 };
172
173 int iio_backend_chan_enable(struct iio_backend *back, unsigned int chan);
174 int iio_backend_chan_disable(struct iio_backend *back, unsigned int chan);
175 int devm_iio_backend_enable(struct device *dev, struct iio_backend *back);
176 int iio_backend_enable(struct iio_backend *back);
177 void iio_backend_disable(struct iio_backend *back);
178 int iio_backend_data_format_set(struct iio_backend *back, unsigned int chan,
179 const struct iio_backend_data_fmt *data);
180 int iio_backend_data_source_set(struct iio_backend *back, unsigned int chan,
181 enum iio_backend_data_source data);
182 int iio_backend_data_source_get(struct iio_backend *back, unsigned int chan,
183 enum iio_backend_data_source *data);
184 int iio_backend_set_sampling_freq(struct iio_backend *back, unsigned int chan,
185 u64 sample_rate_hz);
186 int iio_backend_test_pattern_set(struct iio_backend *back,
187 unsigned int chan,
188 enum iio_backend_test_pattern pattern);
189 int iio_backend_chan_status(struct iio_backend *back, unsigned int chan,
190 bool *error);
191 int iio_backend_iodelay_set(struct iio_backend *back, unsigned int lane,
192 unsigned int taps);
193 int iio_backend_data_sample_trigger(struct iio_backend *back,
194 enum iio_backend_sample_trigger trigger);
195 int devm_iio_backend_request_buffer(struct device *dev,
196 struct iio_backend *back,
197 struct iio_dev *indio_dev);
198 int iio_backend_ddr_enable(struct iio_backend *back);
199 int iio_backend_ddr_disable(struct iio_backend *back);
200 int iio_backend_data_stream_enable(struct iio_backend *back);
201 int iio_backend_data_stream_disable(struct iio_backend *back);
202 int iio_backend_data_transfer_addr(struct iio_backend *back, u32 address);
203 ssize_t iio_backend_ext_info_set(struct iio_dev *indio_dev, uintptr_t private,
204 const struct iio_chan_spec *chan,
205 const char *buf, size_t len);
206 ssize_t iio_backend_ext_info_get(struct iio_dev *indio_dev, uintptr_t private,
207 const struct iio_chan_spec *chan, char *buf);
208 int iio_backend_interface_type_get(struct iio_backend *back,
209 enum iio_backend_interface_type *type);
210 int iio_backend_data_size_set(struct iio_backend *back, unsigned int size);
211 int iio_backend_oversampling_ratio_set(struct iio_backend *back,
212 unsigned int ratio);
213 int iio_backend_read_raw(struct iio_backend *back,
214 struct iio_chan_spec const *chan, int *val, int *val2,
215 long mask);
216 int iio_backend_extend_chan_spec(struct iio_backend *back,
217 struct iio_chan_spec *chan);
218 void *iio_backend_get_priv(const struct iio_backend *conv);
219 struct iio_backend *devm_iio_backend_get(struct device *dev, const char *name);
220 struct iio_backend *devm_iio_backend_fwnode_get(struct device *dev,
221 const char *name,
222 struct fwnode_handle *fwnode);
223 struct iio_backend *
224 __devm_iio_backend_get_from_fwnode_lookup(struct device *dev,
225 struct fwnode_handle *fwnode);
226
227 int devm_iio_backend_register(struct device *dev,
228 const struct iio_backend_info *info, void *priv);
229
iio_backend_read_scale(struct iio_backend * back,struct iio_chan_spec const * chan,int * val,int * val2)230 static inline int iio_backend_read_scale(struct iio_backend *back,
231 struct iio_chan_spec const *chan,
232 int *val, int *val2)
233 {
234 return iio_backend_read_raw(back, chan, val, val2, IIO_CHAN_INFO_SCALE);
235 }
236
iio_backend_read_offset(struct iio_backend * back,struct iio_chan_spec const * chan,int * val,int * val2)237 static inline int iio_backend_read_offset(struct iio_backend *back,
238 struct iio_chan_spec const *chan,
239 int *val, int *val2)
240 {
241 return iio_backend_read_raw(back, chan, val, val2,
242 IIO_CHAN_INFO_OFFSET);
243 }
244
245 ssize_t iio_backend_debugfs_print_chan_status(struct iio_backend *back,
246 unsigned int chan, char *buf,
247 size_t len);
248 void iio_backend_debugfs_add(struct iio_backend *back,
249 struct iio_dev *indio_dev);
250 #endif
251