2 * STMicroelectronics sensors library driver
4 * Copyright 2012-2013 STMicroelectronics Inc.
6 * Denis Ciocca <denis.ciocca@st.com>
8 * Licensed under the GPL-2.
14 #include <linux/i2c.h>
15 #include <linux/spi/spi.h>
16 #include <linux/irqreturn.h>
17 #include <linux/iio/trigger.h>
18 #include <linux/bitops.h>
19 #include <linux/regulator/consumer.h>
21 #include <linux/platform_data/st_sensors_pdata.h>
23 #define ST_SENSORS_TX_MAX_LENGTH 2
24 #define ST_SENSORS_RX_MAX_LENGTH 6
26 #define ST_SENSORS_ODR_LIST_MAX 10
27 #define ST_SENSORS_FULLSCALE_AVL_MAX 10
29 #define ST_SENSORS_NUMBER_ALL_CHANNELS 4
30 #define ST_SENSORS_ENABLE_ALL_AXIS 0x07
31 #define ST_SENSORS_SCAN_X 0
32 #define ST_SENSORS_SCAN_Y 1
33 #define ST_SENSORS_SCAN_Z 2
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
40 #define ST_SENSORS_DEFAULT_STAT_ADDR 0x27
42 #define ST_SENSORS_MAX_NAME 17
43 #define ST_SENSORS_MAX_4WAI 7
45 #define ST_SENSORS_LSM_CHANNELS(device_type, mask, index, mod, \
46 ch2, s, endian, rbits, sbits, addr) \
48 .type = device_type, \
50 .info_mask_separate = mask, \
51 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ), \
52 .scan_index = index, \
58 .shift = sbits - rbits, \
59 .storagebits = sbits, \
60 .endianness = endian, \
64 #define ST_SENSORS_DEV_ATTR_SAMP_FREQ_AVAIL() \
65 IIO_DEV_ATTR_SAMP_FREQ_AVAIL( \
66 st_sensors_sysfs_sampling_frequency_avail)
68 #define ST_SENSORS_DEV_ATTR_SCALE_AVAIL(name) \
69 IIO_DEVICE_ATTR(name, S_IRUGO, \
70 st_sensors_sysfs_scale_avail, NULL , 0);
72 struct st_sensor_odr_avl
{
77 struct st_sensor_odr
{
80 struct st_sensor_odr_avl odr_avl
[ST_SENSORS_ODR_LIST_MAX
];
83 struct st_sensor_power
{
90 struct st_sensor_axis
{
95 struct st_sensor_fullscale_avl
{
102 struct st_sensor_fullscale
{
105 struct st_sensor_fullscale_avl fs_avl
[ST_SENSORS_FULLSCALE_AVL_MAX
];
108 struct st_sensor_sim
{
114 * struct st_sensor_bdu - ST sensor device block data update
115 * @addr: address of the register.
116 * @mask: mask to write the block data update flag.
118 struct st_sensor_bdu
{
124 * struct st_sensor_das - ST sensor device data alignment selection
125 * @addr: address of the register.
126 * @mask: mask to write the das flag for left alignment.
128 struct st_sensor_das
{
134 * struct st_sensor_data_ready_irq - ST sensor device data-ready interrupt
135 * @addr: address of the register.
136 * @mask_int1: mask to enable/disable IRQ on INT1 pin.
137 * @mask_int2: mask to enable/disable IRQ on INT2 pin.
138 * @addr_ihl: address to enable/disable active low on the INT lines.
139 * @mask_ihl: mask to enable/disable active low on the INT lines.
140 * @addr_od: address to enable/disable Open Drain on the INT lines.
141 * @mask_od: mask to enable/disable Open Drain on the INT lines.
142 * @addr_stat_drdy: address to read status of DRDY (data ready) interrupt
143 * struct ig1 - represents the Interrupt Generator 1 of sensors.
144 * @en_addr: address of the enable ig1 register.
145 * @en_mask: mask to write the on/off value for enable.
147 struct st_sensor_data_ready_irq
{
163 * struct st_sensor_transfer_buffer - ST sensor device I/O buffer
164 * @buf_lock: Mutex to protect rx and tx buffers.
165 * @tx_buf: Buffer used by SPI transfer function to send data to the sensors.
166 * This buffer is used to avoid DMA not-aligned issue.
167 * @rx_buf: Buffer used by SPI transfer to receive data from sensors.
168 * This buffer is used to avoid DMA not-aligned issue.
170 struct st_sensor_transfer_buffer
{
171 struct mutex buf_lock
;
172 u8 rx_buf
[ST_SENSORS_RX_MAX_LENGTH
];
173 u8 tx_buf
[ST_SENSORS_TX_MAX_LENGTH
] ____cacheline_aligned
;
177 * struct st_sensor_transfer_function - ST sensor device I/O function
178 * @read_byte: Function used to read one byte.
179 * @write_byte: Function used to write one byte.
180 * @read_multiple_byte: Function used to read multiple byte.
182 struct st_sensor_transfer_function
{
183 int (*read_byte
) (struct st_sensor_transfer_buffer
*tb
,
184 struct device
*dev
, u8 reg_addr
, u8
*res_byte
);
185 int (*write_byte
) (struct st_sensor_transfer_buffer
*tb
,
186 struct device
*dev
, u8 reg_addr
, u8 data
);
187 int (*read_multiple_byte
) (struct st_sensor_transfer_buffer
*tb
,
188 struct device
*dev
, u8 reg_addr
, int len
, u8
*data
,
193 * struct st_sensor_settings - ST specific sensor settings
194 * @wai: Contents of WhoAmI register.
195 * @wai_addr: The address of WhoAmI register.
196 * @sensors_supported: List of supported sensors by struct itself.
197 * @ch: IIO channels for the sensor.
198 * @odr: Output data rate register and ODR list available.
199 * @pw: Power register of the sensor.
200 * @enable_axis: Enable one or more axis of the sensor.
201 * @fs: Full scale register and full scale list available.
202 * @bdu: Block data update register.
203 * @das: Data Alignment Selection register.
204 * @drdy_irq: Data ready register of the sensor.
205 * @sim: SPI serial interface mode register of the sensor.
206 * @multi_read_bit: Use or not particular bit for [I2C/SPI] multi-read.
207 * @bootime: samples to discard when sensor passing from power-down to power-up.
209 struct st_sensor_settings
{
212 char sensors_supported
[ST_SENSORS_MAX_4WAI
][ST_SENSORS_MAX_NAME
];
213 struct iio_chan_spec
*ch
;
215 struct st_sensor_odr odr
;
216 struct st_sensor_power pw
;
217 struct st_sensor_axis enable_axis
;
218 struct st_sensor_fullscale fs
;
219 struct st_sensor_bdu bdu
;
220 struct st_sensor_das das
;
221 struct st_sensor_data_ready_irq drdy_irq
;
222 struct st_sensor_sim sim
;
224 unsigned int bootime
;
228 * struct st_sensor_data - ST sensor device status
229 * @dev: Pointer to instance of struct device (I2C or SPI).
230 * @trig: The trigger in use by the core driver.
231 * @sensor_settings: Pointer to the specific sensor settings in use.
232 * @current_fullscale: Maximum range of measure by the sensor.
233 * @vdd: Pointer to sensor's Vdd power supply
234 * @vdd_io: Pointer to sensor's Vdd-IO power supply
235 * @enabled: Status of the sensor (false->off, true->on).
236 * @multiread_bit: Use or not particular bit for [I2C/SPI] multiread.
237 * @buffer_data: Data used by buffer part.
238 * @odr: Output data rate of the sensor [Hz].
239 * num_data_channels: Number of data channels used in buffer.
240 * @drdy_int_pin: Redirect DRDY on pin 1 (1) or pin 2 (2).
241 * @int_pin_open_drain: Set the interrupt/DRDY to open drain.
242 * @get_irq_data_ready: Function to get the IRQ used for data ready signal.
243 * @tf: Transfer function structure used by I/O operations.
244 * @tb: Transfer buffers and mutex used by I/O operations.
245 * @edge_irq: the IRQ triggers on edges and need special handling.
246 * @hw_irq_trigger: if we're using the hardware interrupt on the sensor.
247 * @hw_timestamp: Latest timestamp from the interrupt handler, when in use.
249 struct st_sensor_data
{
251 struct iio_trigger
*trig
;
252 struct st_sensor_settings
*sensor_settings
;
253 struct st_sensor_fullscale_avl
*current_fullscale
;
254 struct regulator
*vdd
;
255 struct regulator
*vdd_io
;
263 unsigned int num_data_channels
;
266 bool int_pin_open_drain
;
268 unsigned int (*get_irq_data_ready
) (struct iio_dev
*indio_dev
);
270 const struct st_sensor_transfer_function
*tf
;
271 struct st_sensor_transfer_buffer tb
;
278 #ifdef CONFIG_IIO_BUFFER
279 irqreturn_t
st_sensors_trigger_handler(int irq
, void *p
);
282 #ifdef CONFIG_IIO_TRIGGER
283 int st_sensors_allocate_trigger(struct iio_dev
*indio_dev
,
284 const struct iio_trigger_ops
*trigger_ops
);
286 void st_sensors_deallocate_trigger(struct iio_dev
*indio_dev
);
287 int st_sensors_validate_device(struct iio_trigger
*trig
,
288 struct iio_dev
*indio_dev
);
290 static inline int st_sensors_allocate_trigger(struct iio_dev
*indio_dev
,
291 const struct iio_trigger_ops
*trigger_ops
)
295 static inline void st_sensors_deallocate_trigger(struct iio_dev
*indio_dev
)
299 #define st_sensors_validate_device NULL
302 int st_sensors_init_sensor(struct iio_dev
*indio_dev
,
303 struct st_sensors_platform_data
*pdata
);
305 int st_sensors_set_enable(struct iio_dev
*indio_dev
, bool enable
);
307 int st_sensors_set_axis_enable(struct iio_dev
*indio_dev
, u8 axis_enable
);
309 int st_sensors_power_enable(struct iio_dev
*indio_dev
);
311 void st_sensors_power_disable(struct iio_dev
*indio_dev
);
313 int st_sensors_debugfs_reg_access(struct iio_dev
*indio_dev
,
314 unsigned reg
, unsigned writeval
,
317 int st_sensors_set_odr(struct iio_dev
*indio_dev
, unsigned int odr
);
319 int st_sensors_set_dataready_irq(struct iio_dev
*indio_dev
, bool enable
);
321 int st_sensors_set_fullscale_by_gain(struct iio_dev
*indio_dev
, int scale
);
323 int st_sensors_read_info_raw(struct iio_dev
*indio_dev
,
324 struct iio_chan_spec
const *ch
, int *val
);
326 int st_sensors_check_device_support(struct iio_dev
*indio_dev
,
327 int num_sensors_list
, const struct st_sensor_settings
*sensor_settings
);
329 ssize_t
st_sensors_sysfs_sampling_frequency_avail(struct device
*dev
,
330 struct device_attribute
*attr
, char *buf
);
332 ssize_t
st_sensors_sysfs_scale_avail(struct device
*dev
,
333 struct device_attribute
*attr
, char *buf
);
335 #endif /* ST_SENSORS_H */