]> git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blame - include/linux/iio/common/st_sensors.h
iio:st_sensors: emulate SMBus block read if needed
[mirror_ubuntu-eoan-kernel.git] / include / linux / iio / common / st_sensors.h
CommitLineData
23491b51
DC
1/*
2 * STMicroelectronics sensors library driver
3 *
4 * Copyright 2012-2013 STMicroelectronics Inc.
5 *
6 * Denis Ciocca <denis.ciocca@st.com>
7 *
8 * Licensed under the GPL-2.
9 */
10
11#ifndef ST_SENSORS_H
12#define ST_SENSORS_H
13
14#include <linux/i2c.h>
15#include <linux/spi/spi.h>
16#include <linux/irqreturn.h>
17#include <linux/iio/trigger.h>
5ea86494 18#include <linux/bitops.h>
77448761 19#include <linux/regulator/consumer.h>
23491b51 20
23cde4d6
DC
21#include <linux/platform_data/st_sensors_pdata.h>
22
23491b51
DC
23#define ST_SENSORS_TX_MAX_LENGTH 2
24#define ST_SENSORS_RX_MAX_LENGTH 6
25
26#define ST_SENSORS_ODR_LIST_MAX 10
27#define ST_SENSORS_FULLSCALE_AVL_MAX 10
28
29#define ST_SENSORS_NUMBER_ALL_CHANNELS 4
23491b51 30#define ST_SENSORS_ENABLE_ALL_AXIS 0x07
23491b51
DC
31#define ST_SENSORS_SCAN_X 0
32#define ST_SENSORS_SCAN_Y 1
33#define ST_SENSORS_SCAN_Z 2
23491b51
DC
34#define ST_SENSORS_DEFAULT_POWER_ON_VALUE 0x01
35#define ST_SENSORS_DEFAULT_POWER_OFF_VALUE 0x00
36#define ST_SENSORS_DEFAULT_WAI_ADDRESS 0x0f
37#define ST_SENSORS_DEFAULT_AXIS_ADDR 0x20
38#define ST_SENSORS_DEFAULT_AXIS_MASK 0x07
39#define ST_SENSORS_DEFAULT_AXIS_N_BIT 3
97865fe4 40#define ST_SENSORS_DEFAULT_STAT_ADDR 0x27
23491b51
DC
41
42#define ST_SENSORS_MAX_NAME 17
43#define ST_SENSORS_MAX_4WAI 7
44
762011d6
DC
45#define ST_SENSORS_LSM_CHANNELS(device_type, mask, index, mod, \
46 ch2, s, endian, rbits, sbits, addr) \
23491b51
DC
47{ \
48 .type = device_type, \
762011d6
DC
49 .modified = mod, \
50 .info_mask_separate = mask, \
2d239c9e 51 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ), \
23491b51 52 .scan_index = index, \
762011d6 53 .channel2 = ch2, \
23491b51
DC
54 .address = addr, \
55 .scan_type = { \
762011d6
DC
56 .sign = s, \
57 .realbits = rbits, \
58 .shift = sbits - rbits, \
59 .storagebits = sbits, \
23491b51
DC
60 .endianness = endian, \
61 }, \
62}
63
23491b51
DC
64#define ST_SENSORS_DEV_ATTR_SAMP_FREQ_AVAIL() \
65 IIO_DEV_ATTR_SAMP_FREQ_AVAIL( \
66 st_sensors_sysfs_sampling_frequency_avail)
67
68#define ST_SENSORS_DEV_ATTR_SCALE_AVAIL(name) \
69 IIO_DEVICE_ATTR(name, S_IRUGO, \
70 st_sensors_sysfs_scale_avail, NULL , 0);
71
72struct st_sensor_odr_avl {
73 unsigned int hz;
74 u8 value;
75};
76
77struct st_sensor_odr {
78 u8 addr;
79 u8 mask;
80 struct st_sensor_odr_avl odr_avl[ST_SENSORS_ODR_LIST_MAX];
81};
82
83struct st_sensor_power {
84 u8 addr;
85 u8 mask;
86 u8 value_off;
87 u8 value_on;
88};
89
90struct st_sensor_axis {
91 u8 addr;
92 u8 mask;
93};
94
95struct st_sensor_fullscale_avl {
96 unsigned int num;
97 u8 value;
98 unsigned int gain;
99 unsigned int gain2;
100};
101
102struct st_sensor_fullscale {
103 u8 addr;
104 u8 mask;
105 struct st_sensor_fullscale_avl fs_avl[ST_SENSORS_FULLSCALE_AVL_MAX];
106};
107
108/**
109 * struct st_sensor_bdu - ST sensor device block data update
110 * @addr: address of the register.
111 * @mask: mask to write the block data update flag.
112 */
113struct st_sensor_bdu {
114 u8 addr;
115 u8 mask;
116};
117
118/**
119 * struct st_sensor_data_ready_irq - ST sensor device data-ready interrupt
120 * @addr: address of the register.
23cde4d6
DC
121 * @mask_int1: mask to enable/disable IRQ on INT1 pin.
122 * @mask_int2: mask to enable/disable IRQ on INT2 pin.
a9fd053b
LW
123 * @addr_ihl: address to enable/disable active low on the INT lines.
124 * @mask_ihl: mask to enable/disable active low on the INT lines.
0e6f6871
LW
125 * @addr_od: address to enable/disable Open Drain on the INT lines.
126 * @mask_od: mask to enable/disable Open Drain on the INT lines.
97865fe4 127 * @addr_stat_drdy: address to read status of DRDY (data ready) interrupt
23491b51
DC
128 * struct ig1 - represents the Interrupt Generator 1 of sensors.
129 * @en_addr: address of the enable ig1 register.
130 * @en_mask: mask to write the on/off value for enable.
131 */
132struct st_sensor_data_ready_irq {
133 u8 addr;
23cde4d6
DC
134 u8 mask_int1;
135 u8 mask_int2;
a9fd053b
LW
136 u8 addr_ihl;
137 u8 mask_ihl;
0e6f6871
LW
138 u8 addr_od;
139 u8 mask_od;
97865fe4 140 u8 addr_stat_drdy;
23491b51
DC
141 struct {
142 u8 en_addr;
143 u8 en_mask;
144 } ig1;
145};
146
147/**
148 * struct st_sensor_transfer_buffer - ST sensor device I/O buffer
149 * @buf_lock: Mutex to protect rx and tx buffers.
150 * @tx_buf: Buffer used by SPI transfer function to send data to the sensors.
151 * This buffer is used to avoid DMA not-aligned issue.
152 * @rx_buf: Buffer used by SPI transfer to receive data from sensors.
153 * This buffer is used to avoid DMA not-aligned issue.
154 */
155struct st_sensor_transfer_buffer {
156 struct mutex buf_lock;
157 u8 rx_buf[ST_SENSORS_RX_MAX_LENGTH];
158 u8 tx_buf[ST_SENSORS_TX_MAX_LENGTH] ____cacheline_aligned;
159};
160
161/**
162 * struct st_sensor_transfer_function - ST sensor device I/O function
163 * @read_byte: Function used to read one byte.
164 * @write_byte: Function used to write one byte.
165 * @read_multiple_byte: Function used to read multiple byte.
166 */
167struct st_sensor_transfer_function {
168 int (*read_byte) (struct st_sensor_transfer_buffer *tb,
169 struct device *dev, u8 reg_addr, u8 *res_byte);
170 int (*write_byte) (struct st_sensor_transfer_buffer *tb,
171 struct device *dev, u8 reg_addr, u8 data);
172 int (*read_multiple_byte) (struct st_sensor_transfer_buffer *tb,
173 struct device *dev, u8 reg_addr, int len, u8 *data,
174 bool multiread_bit);
175};
176
177/**
a7ee8839 178 * struct st_sensor_settings - ST specific sensor settings
23491b51 179 * @wai: Contents of WhoAmI register.
bc27381e 180 * @wai_addr: The address of WhoAmI register.
23491b51
DC
181 * @sensors_supported: List of supported sensors by struct itself.
182 * @ch: IIO channels for the sensor.
183 * @odr: Output data rate register and ODR list available.
184 * @pw: Power register of the sensor.
185 * @enable_axis: Enable one or more axis of the sensor.
186 * @fs: Full scale register and full scale list available.
187 * @bdu: Block data update register.
188 * @drdy_irq: Data ready register of the sensor.
189 * @multi_read_bit: Use or not particular bit for [I2C/SPI] multi-read.
190 * @bootime: samples to discard when sensor passing from power-down to power-up.
191 */
a7ee8839 192struct st_sensor_settings {
23491b51 193 u8 wai;
bc27381e 194 u8 wai_addr;
23491b51
DC
195 char sensors_supported[ST_SENSORS_MAX_4WAI][ST_SENSORS_MAX_NAME];
196 struct iio_chan_spec *ch;
ea01f2c1 197 int num_ch;
23491b51
DC
198 struct st_sensor_odr odr;
199 struct st_sensor_power pw;
200 struct st_sensor_axis enable_axis;
201 struct st_sensor_fullscale fs;
202 struct st_sensor_bdu bdu;
203 struct st_sensor_data_ready_irq drdy_irq;
204 bool multi_read_bit;
205 unsigned int bootime;
206};
207
208/**
209 * struct st_sensor_data - ST sensor device status
210 * @dev: Pointer to instance of struct device (I2C or SPI).
211 * @trig: The trigger in use by the core driver.
a7ee8839 212 * @sensor_settings: Pointer to the specific sensor settings in use.
23491b51 213 * @current_fullscale: Maximum range of measure by the sensor.
77448761 214 * @vdd: Pointer to sensor's Vdd power supply
71e1980c 215 * @vdd_io: Pointer to sensor's Vdd-IO power supply
23491b51
DC
216 * @enabled: Status of the sensor (false->off, true->on).
217 * @multiread_bit: Use or not particular bit for [I2C/SPI] multiread.
218 * @buffer_data: Data used by buffer part.
219 * @odr: Output data rate of the sensor [Hz].
607a568a 220 * num_data_channels: Number of data channels used in buffer.
23cde4d6 221 * @drdy_int_pin: Redirect DRDY on pin 1 (1) or pin 2 (2).
0e6f6871 222 * @int_pin_open_drain: Set the interrupt/DRDY to open drain.
23491b51
DC
223 * @get_irq_data_ready: Function to get the IRQ used for data ready signal.
224 * @tf: Transfer function structure used by I/O operations.
225 * @tb: Transfer buffers and mutex used by I/O operations.
226 */
227struct st_sensor_data {
228 struct device *dev;
229 struct iio_trigger *trig;
a7ee8839 230 struct st_sensor_settings *sensor_settings;
23491b51 231 struct st_sensor_fullscale_avl *current_fullscale;
77448761 232 struct regulator *vdd;
71e1980c 233 struct regulator *vdd_io;
23491b51
DC
234
235 bool enabled;
236 bool multiread_bit;
237
238 char *buffer_data;
239
240 unsigned int odr;
607a568a 241 unsigned int num_data_channels;
23491b51 242
23cde4d6 243 u8 drdy_int_pin;
0e6f6871 244 bool int_pin_open_drain;
23cde4d6 245
23491b51
DC
246 unsigned int (*get_irq_data_ready) (struct iio_dev *indio_dev);
247
248 const struct st_sensor_transfer_function *tf;
249 struct st_sensor_transfer_buffer tb;
250};
251
252#ifdef CONFIG_IIO_BUFFER
5a4d7291 253irqreturn_t st_sensors_trigger_handler(int irq, void *p);
5a4d7291
GR
254#endif
255
256#ifdef CONFIG_IIO_TRIGGER
23491b51
DC
257int st_sensors_allocate_trigger(struct iio_dev *indio_dev,
258 const struct iio_trigger_ops *trigger_ops);
259
260void st_sensors_deallocate_trigger(struct iio_dev *indio_dev);
261
91ffbabf
DC
262#else
263static inline int st_sensors_allocate_trigger(struct iio_dev *indio_dev,
264 const struct iio_trigger_ops *trigger_ops)
265{
266 return 0;
267}
268static inline void st_sensors_deallocate_trigger(struct iio_dev *indio_dev)
269{
270 return;
271}
23491b51
DC
272#endif
273
23cde4d6
DC
274int st_sensors_init_sensor(struct iio_dev *indio_dev,
275 struct st_sensors_platform_data *pdata);
23491b51
DC
276
277int st_sensors_set_enable(struct iio_dev *indio_dev, bool enable);
278
279int st_sensors_set_axis_enable(struct iio_dev *indio_dev, u8 axis_enable);
280
ea7e586b
LW
281void st_sensors_power_enable(struct iio_dev *indio_dev);
282
283void st_sensors_power_disable(struct iio_dev *indio_dev);
284
a0175b9c
LW
285int st_sensors_debugfs_reg_access(struct iio_dev *indio_dev,
286 unsigned reg, unsigned writeval,
287 unsigned *readval);
288
23491b51
DC
289int st_sensors_set_odr(struct iio_dev *indio_dev, unsigned int odr);
290
291int st_sensors_set_dataready_irq(struct iio_dev *indio_dev, bool enable);
292
293int st_sensors_set_fullscale_by_gain(struct iio_dev *indio_dev, int scale);
294
295int st_sensors_read_info_raw(struct iio_dev *indio_dev,
296 struct iio_chan_spec const *ch, int *val);
297
298int st_sensors_check_device_support(struct iio_dev *indio_dev,
a7ee8839 299 int num_sensors_list, const struct st_sensor_settings *sensor_settings);
23491b51 300
23491b51
DC
301ssize_t st_sensors_sysfs_sampling_frequency_avail(struct device *dev,
302 struct device_attribute *attr, char *buf);
303
304ssize_t st_sensors_sysfs_scale_avail(struct device *dev,
305 struct device_attribute *attr, char *buf);
306
307#endif /* ST_SENSORS_H */