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 * @set_sample_rate: Configure the sampling rate for a specific channel.
88 * @test_pattern_set: Configure a test pattern.
89 * @chan_status: Get the channel status.
90 * @iodelay_set: Set digital I/O delay.
91 * @data_sample_trigger: Control when to sample data.
92 * @request_buffer: Request an IIO buffer.
93 * @free_buffer: Free an IIO buffer.
94 * @extend_chan_spec: Extend an IIO channel.
95 * @ext_info_set: Extended info setter.
96 * @ext_info_get: Extended info getter.
97 * @interface_type_get: Interface type.
98 * @data_size_set: Data size.
99 * @oversampling_ratio_set: Set Oversampling ratio.
100 * @read_raw: Read a channel attribute from a backend device
101 * @debugfs_print_chan_status: Print channel status into a buffer.
102 * @debugfs_reg_access: Read or write register value of backend.
103 * @ddr_enable: Enable interface DDR (Double Data Rate) mode.
104 * @ddr_disable: Disable interface DDR (Double Data Rate) mode.
105 * @data_stream_enable: Enable data stream.
106 * @data_stream_disable: Disable data stream.
107 * @data_transfer_addr: Set data address.
108 **/
109 struct iio_backend_ops {
110 int (*enable)(struct iio_backend *back);
111 void (*disable)(struct iio_backend *back);
112 int (*chan_enable)(struct iio_backend *back, unsigned int chan);
113 int (*chan_disable)(struct iio_backend *back, unsigned int chan);
114 int (*data_format_set)(struct iio_backend *back, unsigned int chan,
115 const struct iio_backend_data_fmt *data);
116 int (*data_source_set)(struct iio_backend *back, unsigned int chan,
117 enum iio_backend_data_source data);
118 int (*set_sample_rate)(struct iio_backend *back, unsigned int chan,
119 u64 sample_rate_hz);
120 int (*test_pattern_set)(struct iio_backend *back,
121 unsigned int chan,
122 enum iio_backend_test_pattern pattern);
123 int (*chan_status)(struct iio_backend *back, unsigned int chan,
124 bool *error);
125 int (*iodelay_set)(struct iio_backend *back, unsigned int chan,
126 unsigned int taps);
127 int (*data_sample_trigger)(struct iio_backend *back,
128 enum iio_backend_sample_trigger trigger);
129 struct iio_buffer *(*request_buffer)(struct iio_backend *back,
130 struct iio_dev *indio_dev);
131 void (*free_buffer)(struct iio_backend *back,
132 struct iio_buffer *buffer);
133 int (*extend_chan_spec)(struct iio_backend *back,
134 struct iio_chan_spec *chan);
135 int (*ext_info_set)(struct iio_backend *back, uintptr_t private,
136 const struct iio_chan_spec *chan,
137 const char *buf, size_t len);
138 int (*ext_info_get)(struct iio_backend *back, uintptr_t private,
139 const struct iio_chan_spec *chan, char *buf);
140 int (*interface_type_get)(struct iio_backend *back,
141 enum iio_backend_interface_type *type);
142 int (*data_size_set)(struct iio_backend *back, unsigned int size);
143 int (*oversampling_ratio_set)(struct iio_backend *back,
144 unsigned int ratio);
145 int (*read_raw)(struct iio_backend *back,
146 struct iio_chan_spec const *chan, int *val, int *val2,
147 long mask);
148 int (*debugfs_print_chan_status)(struct iio_backend *back,
149 unsigned int chan, char *buf,
150 size_t len);
151 int (*debugfs_reg_access)(struct iio_backend *back, unsigned int reg,
152 unsigned int writeval, unsigned int *readval);
153 int (*ddr_enable)(struct iio_backend *back);
154 int (*ddr_disable)(struct iio_backend *back);
155 int (*data_stream_enable)(struct iio_backend *back);
156 int (*data_stream_disable)(struct iio_backend *back);
157 int (*data_transfer_addr)(struct iio_backend *back, u32 address);
158 };
159
160 /**
161 * struct iio_backend_info - info structure for an iio_backend
162 * @name: Backend name.
163 * @ops: Backend operations.
164 */
165 struct iio_backend_info {
166 const char *name;
167 const struct iio_backend_ops *ops;
168 };
169
170 int iio_backend_chan_enable(struct iio_backend *back, unsigned int chan);
171 int iio_backend_chan_disable(struct iio_backend *back, unsigned int chan);
172 int devm_iio_backend_enable(struct device *dev, struct iio_backend *back);
173 int iio_backend_enable(struct iio_backend *back);
174 void iio_backend_disable(struct iio_backend *back);
175 int iio_backend_data_format_set(struct iio_backend *back, unsigned int chan,
176 const struct iio_backend_data_fmt *data);
177 int iio_backend_data_source_set(struct iio_backend *back, unsigned int chan,
178 enum iio_backend_data_source data);
179 int iio_backend_set_sampling_freq(struct iio_backend *back, unsigned int chan,
180 u64 sample_rate_hz);
181 int iio_backend_test_pattern_set(struct iio_backend *back,
182 unsigned int chan,
183 enum iio_backend_test_pattern pattern);
184 int iio_backend_chan_status(struct iio_backend *back, unsigned int chan,
185 bool *error);
186 int iio_backend_iodelay_set(struct iio_backend *back, unsigned int lane,
187 unsigned int taps);
188 int iio_backend_data_sample_trigger(struct iio_backend *back,
189 enum iio_backend_sample_trigger trigger);
190 int devm_iio_backend_request_buffer(struct device *dev,
191 struct iio_backend *back,
192 struct iio_dev *indio_dev);
193 int iio_backend_ddr_enable(struct iio_backend *back);
194 int iio_backend_ddr_disable(struct iio_backend *back);
195 int iio_backend_data_stream_enable(struct iio_backend *back);
196 int iio_backend_data_stream_disable(struct iio_backend *back);
197 int iio_backend_data_transfer_addr(struct iio_backend *back, u32 address);
198 ssize_t iio_backend_ext_info_set(struct iio_dev *indio_dev, uintptr_t private,
199 const struct iio_chan_spec *chan,
200 const char *buf, size_t len);
201 ssize_t iio_backend_ext_info_get(struct iio_dev *indio_dev, uintptr_t private,
202 const struct iio_chan_spec *chan, char *buf);
203 int iio_backend_interface_type_get(struct iio_backend *back,
204 enum iio_backend_interface_type *type);
205 int iio_backend_data_size_set(struct iio_backend *back, unsigned int size);
206 int iio_backend_oversampling_ratio_set(struct iio_backend *back,
207 unsigned int ratio);
208 int iio_backend_read_raw(struct iio_backend *back,
209 struct iio_chan_spec const *chan, int *val, int *val2,
210 long mask);
211 int iio_backend_extend_chan_spec(struct iio_backend *back,
212 struct iio_chan_spec *chan);
213 void *iio_backend_get_priv(const struct iio_backend *conv);
214 struct iio_backend *devm_iio_backend_get(struct device *dev, const char *name);
215 struct iio_backend *devm_iio_backend_fwnode_get(struct device *dev,
216 const char *name,
217 struct fwnode_handle *fwnode);
218 struct iio_backend *
219 __devm_iio_backend_get_from_fwnode_lookup(struct device *dev,
220 struct fwnode_handle *fwnode);
221
222 int devm_iio_backend_register(struct device *dev,
223 const struct iio_backend_info *info, void *priv);
224
iio_backend_read_scale(struct iio_backend * back,struct iio_chan_spec const * chan,int * val,int * val2)225 static inline int iio_backend_read_scale(struct iio_backend *back,
226 struct iio_chan_spec const *chan,
227 int *val, int *val2)
228 {
229 return iio_backend_read_raw(back, chan, val, val2, IIO_CHAN_INFO_SCALE);
230 }
231
iio_backend_read_offset(struct iio_backend * back,struct iio_chan_spec const * chan,int * val,int * val2)232 static inline int iio_backend_read_offset(struct iio_backend *back,
233 struct iio_chan_spec const *chan,
234 int *val, int *val2)
235 {
236 return iio_backend_read_raw(back, chan, val, val2,
237 IIO_CHAN_INFO_OFFSET);
238 }
239
240 ssize_t iio_backend_debugfs_print_chan_status(struct iio_backend *back,
241 unsigned int chan, char *buf,
242 size_t len);
243 void iio_backend_debugfs_add(struct iio_backend *back,
244 struct iio_dev *indio_dev);
245 #endif
246