2 * lis3l02dq.c support STMicroelectronics LISD02DQ
3 * 3d 2g Linear Accelerometers via SPI
5 * Copyright (c) 2007 Jonathan Cameron <jic23@kernel.org>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
12 * 16 bit left justified mode used.
15 #include <linux/interrupt.h>
16 #include <linux/irq.h>
17 #include <linux/gpio.h>
18 #include <linux/of_gpio.h>
19 #include <linux/mutex.h>
20 #include <linux/device.h>
21 #include <linux/kernel.h>
22 #include <linux/spi/spi.h>
23 #include <linux/slab.h>
24 #include <linux/sysfs.h>
25 #include <linux/module.h>
27 #include <linux/iio/iio.h>
28 #include <linux/iio/sysfs.h>
29 #include <linux/iio/events.h>
30 #include <linux/iio/buffer.h>
32 #include "lis3l02dq.h"
34 /* At the moment the spi framework doesn't allow global setting of cs_change.
35 * It's in the likely to be added comment at the top of spi.h.
36 * This means that use cannot be made of spi_write etc.
38 /* direct copy of the irq_default_primary_handler */
39 #ifndef CONFIG_IIO_BUFFER
40 static irqreturn_t lis3l02dq_nobuffer(int irq, void *private)
42 return IRQ_WAKE_THREAD;
47 * lis3l02dq_spi_read_reg_8() - read single byte from a single register
48 * @indio_dev: iio_dev for this actual device
49 * @reg_address: the address of the register to be read
50 * @val: pass back the resulting value
52 int lis3l02dq_spi_read_reg_8(struct iio_dev *indio_dev,
53 u8 reg_address, u8 *val)
55 struct lis3l02dq_state *st = iio_priv(indio_dev);
57 struct spi_transfer xfer = {
64 mutex_lock(&st->buf_lock);
65 st->tx[0] = LIS3L02DQ_READ_REG(reg_address);
68 ret = spi_sync_transfer(st->us, &xfer, 1);
70 mutex_unlock(&st->buf_lock);
76 * lis3l02dq_spi_write_reg_8() - write single byte to a register
77 * @indio_dev: iio_dev for this device
78 * @reg_address: the address of the register to be written
79 * @val: the value to write
81 int lis3l02dq_spi_write_reg_8(struct iio_dev *indio_dev,
86 struct lis3l02dq_state *st = iio_priv(indio_dev);
88 mutex_lock(&st->buf_lock);
89 st->tx[0] = LIS3L02DQ_WRITE_REG(reg_address);
91 ret = spi_write(st->us, st->tx, 2);
92 mutex_unlock(&st->buf_lock);
98 * lisl302dq_spi_write_reg_s16() - write 2 bytes to a pair of registers
99 * @indio_dev: iio_dev for this device
100 * @lower_reg_address: the address of the lower of the two registers.
101 * Second register is assumed to have address one greater.
102 * @value: value to be written
104 static int lis3l02dq_spi_write_reg_s16(struct iio_dev *indio_dev,
105 u8 lower_reg_address,
109 struct lis3l02dq_state *st = iio_priv(indio_dev);
110 struct spi_transfer xfers[] = { {
116 .tx_buf = st->tx + 2,
122 mutex_lock(&st->buf_lock);
123 st->tx[0] = LIS3L02DQ_WRITE_REG(lower_reg_address);
124 st->tx[1] = value & 0xFF;
125 st->tx[2] = LIS3L02DQ_WRITE_REG(lower_reg_address + 1);
126 st->tx[3] = (value >> 8) & 0xFF;
128 ret = spi_sync_transfer(st->us, xfers, ARRAY_SIZE(xfers));
129 mutex_unlock(&st->buf_lock);
134 static int lis3l02dq_read_reg_s16(struct iio_dev *indio_dev,
135 u8 lower_reg_address,
138 struct lis3l02dq_state *st = iio_priv(indio_dev);
141 struct spi_transfer xfers[] = { {
148 .tx_buf = st->tx + 2,
149 .rx_buf = st->rx + 2,
155 mutex_lock(&st->buf_lock);
156 st->tx[0] = LIS3L02DQ_READ_REG(lower_reg_address);
158 st->tx[2] = LIS3L02DQ_READ_REG(lower_reg_address + 1);
161 ret = spi_sync_transfer(st->us, xfers, ARRAY_SIZE(xfers));
163 dev_err(&st->us->dev, "problem when reading 16 bit register");
166 tempval = (s16)(st->rx[1]) | ((s16)(st->rx[3]) << 8);
170 mutex_unlock(&st->buf_lock);
174 enum lis3l02dq_rm_ind {
180 static u8 lis3l02dq_axis_map[3][3] = {
181 [LIS3L02DQ_ACCEL] = { LIS3L02DQ_REG_OUT_X_L_ADDR,
182 LIS3L02DQ_REG_OUT_Y_L_ADDR,
183 LIS3L02DQ_REG_OUT_Z_L_ADDR },
184 [LIS3L02DQ_GAIN] = { LIS3L02DQ_REG_GAIN_X_ADDR,
185 LIS3L02DQ_REG_GAIN_Y_ADDR,
186 LIS3L02DQ_REG_GAIN_Z_ADDR },
187 [LIS3L02DQ_BIAS] = { LIS3L02DQ_REG_OFFSET_X_ADDR,
188 LIS3L02DQ_REG_OFFSET_Y_ADDR,
189 LIS3L02DQ_REG_OFFSET_Z_ADDR }
192 static int lis3l02dq_read_thresh(struct iio_dev *indio_dev,
193 const struct iio_chan_spec *chan,
194 enum iio_event_type type,
195 enum iio_event_direction dir,
196 enum iio_event_info info,
201 ret = lis3l02dq_read_reg_s16(indio_dev, LIS3L02DQ_REG_THS_L_ADDR, val);
207 static int lis3l02dq_write_thresh(struct iio_dev *indio_dev,
208 const struct iio_chan_spec *chan,
209 enum iio_event_type type,
210 enum iio_event_direction dir,
211 enum iio_event_info info,
216 return lis3l02dq_spi_write_reg_s16(indio_dev,
217 LIS3L02DQ_REG_THS_L_ADDR,
221 static int lis3l02dq_write_raw(struct iio_dev *indio_dev,
222 struct iio_chan_spec const *chan,
227 int ret = -EINVAL, reg;
232 case IIO_CHAN_INFO_CALIBBIAS:
233 if (val > 255 || val < -256)
236 reg = lis3l02dq_axis_map[LIS3L02DQ_BIAS][chan->address];
237 ret = lis3l02dq_spi_write_reg_8(indio_dev, reg, sval);
239 case IIO_CHAN_INFO_CALIBSCALE:
243 reg = lis3l02dq_axis_map[LIS3L02DQ_GAIN][chan->address];
244 ret = lis3l02dq_spi_write_reg_8(indio_dev, reg, uval);
250 static int lis3l02dq_read_raw(struct iio_dev *indio_dev,
251 struct iio_chan_spec const *chan,
262 case IIO_CHAN_INFO_RAW:
263 /* Take the iio_dev status lock */
264 mutex_lock(&indio_dev->mlock);
265 if (indio_dev->currentmode == INDIO_BUFFER_TRIGGERED) {
268 reg = lis3l02dq_axis_map
269 [LIS3L02DQ_ACCEL][chan->address];
270 ret = lis3l02dq_read_reg_s16(indio_dev, reg, val);
272 mutex_unlock(&indio_dev->mlock);
276 case IIO_CHAN_INFO_SCALE:
279 return IIO_VAL_INT_PLUS_MICRO;
280 case IIO_CHAN_INFO_CALIBSCALE:
281 reg = lis3l02dq_axis_map[LIS3L02DQ_GAIN][chan->address];
282 ret = lis3l02dq_spi_read_reg_8(indio_dev, reg, &utemp);
285 /* to match with what previous code does */
289 case IIO_CHAN_INFO_CALIBBIAS:
290 reg = lis3l02dq_axis_map[LIS3L02DQ_BIAS][chan->address];
291 ret = lis3l02dq_spi_read_reg_8(indio_dev, reg, (u8 *)&stemp);
292 /* to match with what previous code does */
300 static ssize_t lis3l02dq_read_frequency(struct device *dev,
301 struct device_attribute *attr,
304 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
308 ret = lis3l02dq_spi_read_reg_8(indio_dev,
309 LIS3L02DQ_REG_CTRL_1_ADDR,
313 t &= LIS3L02DQ_DEC_MASK;
315 case LIS3L02DQ_REG_CTRL_1_DF_128:
316 len = sprintf(buf, "280\n");
318 case LIS3L02DQ_REG_CTRL_1_DF_64:
319 len = sprintf(buf, "560\n");
321 case LIS3L02DQ_REG_CTRL_1_DF_32:
322 len = sprintf(buf, "1120\n");
324 case LIS3L02DQ_REG_CTRL_1_DF_8:
325 len = sprintf(buf, "4480\n");
331 static ssize_t lis3l02dq_write_frequency(struct device *dev,
332 struct device_attribute *attr,
336 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
341 ret = kstrtoul(buf, 10, &val);
345 mutex_lock(&indio_dev->mlock);
346 ret = lis3l02dq_spi_read_reg_8(indio_dev,
347 LIS3L02DQ_REG_CTRL_1_ADDR,
350 goto error_ret_mutex;
351 /* Wipe the bits clean */
352 t &= ~LIS3L02DQ_DEC_MASK;
355 t |= LIS3L02DQ_REG_CTRL_1_DF_128;
358 t |= LIS3L02DQ_REG_CTRL_1_DF_64;
361 t |= LIS3L02DQ_REG_CTRL_1_DF_32;
364 t |= LIS3L02DQ_REG_CTRL_1_DF_8;
368 goto error_ret_mutex;
371 ret = lis3l02dq_spi_write_reg_8(indio_dev,
372 LIS3L02DQ_REG_CTRL_1_ADDR,
376 mutex_unlock(&indio_dev->mlock);
378 return ret ? ret : len;
381 static int lis3l02dq_initial_setup(struct iio_dev *indio_dev)
383 struct lis3l02dq_state *st = iio_priv(indio_dev);
387 st->us->mode = SPI_MODE_3;
391 val = LIS3L02DQ_DEFAULT_CTRL1;
392 /* Write suitable defaults to ctrl1 */
393 ret = lis3l02dq_spi_write_reg_8(indio_dev,
394 LIS3L02DQ_REG_CTRL_1_ADDR,
397 dev_err(&st->us->dev, "problem with setup control register 1");
400 /* Repeat as sometimes doesn't work first time? */
401 ret = lis3l02dq_spi_write_reg_8(indio_dev,
402 LIS3L02DQ_REG_CTRL_1_ADDR,
405 dev_err(&st->us->dev, "problem with setup control register 1");
410 * Read back to check this has worked acts as loose test of correct
413 ret = lis3l02dq_spi_read_reg_8(indio_dev,
414 LIS3L02DQ_REG_CTRL_1_ADDR,
416 if (ret || (valtest != val)) {
417 dev_err(&indio_dev->dev,
418 "device not playing ball %d %d\n", valtest, val);
423 val = LIS3L02DQ_DEFAULT_CTRL2;
424 ret = lis3l02dq_spi_write_reg_8(indio_dev,
425 LIS3L02DQ_REG_CTRL_2_ADDR,
428 dev_err(&st->us->dev, "problem with setup control register 2");
432 val = LIS3L02DQ_REG_WAKE_UP_CFG_LATCH_SRC;
433 ret = lis3l02dq_spi_write_reg_8(indio_dev,
434 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
437 dev_err(&st->us->dev, "problem with interrupt cfg register");
443 static IIO_DEV_ATTR_SAMP_FREQ(S_IWUSR | S_IRUGO,
444 lis3l02dq_read_frequency,
445 lis3l02dq_write_frequency);
447 static IIO_CONST_ATTR_SAMP_FREQ_AVAIL("280 560 1120 4480");
449 static irqreturn_t lis3l02dq_event_handler(int irq, void *private)
451 struct iio_dev *indio_dev = private;
454 s64 timestamp = iio_get_time_ns();
456 lis3l02dq_spi_read_reg_8(indio_dev,
457 LIS3L02DQ_REG_WAKE_UP_SRC_ADDR,
460 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_Z_HIGH)
461 iio_push_event(indio_dev,
462 IIO_MOD_EVENT_CODE(IIO_ACCEL,
469 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_Z_LOW)
470 iio_push_event(indio_dev,
471 IIO_MOD_EVENT_CODE(IIO_ACCEL,
478 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_Y_HIGH)
479 iio_push_event(indio_dev,
480 IIO_MOD_EVENT_CODE(IIO_ACCEL,
487 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_Y_LOW)
488 iio_push_event(indio_dev,
489 IIO_MOD_EVENT_CODE(IIO_ACCEL,
496 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_X_HIGH)
497 iio_push_event(indio_dev,
498 IIO_MOD_EVENT_CODE(IIO_ACCEL,
505 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_X_LOW)
506 iio_push_event(indio_dev,
507 IIO_MOD_EVENT_CODE(IIO_ACCEL,
514 /* Ack and allow for new interrupts */
515 lis3l02dq_spi_read_reg_8(indio_dev,
516 LIS3L02DQ_REG_WAKE_UP_ACK_ADDR,
522 static const struct iio_event_spec lis3l02dq_event[] = {
524 .type = IIO_EV_TYPE_THRESH,
525 .dir = IIO_EV_DIR_RISING,
526 .mask_separate = BIT(IIO_EV_INFO_ENABLE),
527 .mask_shared_by_type = BIT(IIO_EV_INFO_VALUE),
529 .type = IIO_EV_TYPE_THRESH,
530 .dir = IIO_EV_DIR_FALLING,
531 .mask_separate = BIT(IIO_EV_INFO_ENABLE),
532 .mask_shared_by_type = BIT(IIO_EV_INFO_VALUE),
536 #define LIS3L02DQ_CHAN(index, mod) \
541 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
542 BIT(IIO_CHAN_INFO_CALIBSCALE) | \
543 BIT(IIO_CHAN_INFO_CALIBBIAS), \
544 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE), \
546 .scan_index = index, \
552 .event_spec = lis3l02dq_event, \
553 .num_event_specs = ARRAY_SIZE(lis3l02dq_event), \
556 static const struct iio_chan_spec lis3l02dq_channels[] = {
557 LIS3L02DQ_CHAN(0, IIO_MOD_X),
558 LIS3L02DQ_CHAN(1, IIO_MOD_Y),
559 LIS3L02DQ_CHAN(2, IIO_MOD_Z),
560 IIO_CHAN_SOFT_TIMESTAMP(3)
563 static int lis3l02dq_read_event_config(struct iio_dev *indio_dev,
564 const struct iio_chan_spec *chan,
565 enum iio_event_type type,
566 enum iio_event_direction dir)
570 u8 mask = (1 << (chan->channel2 * 2 + (dir == IIO_EV_DIR_RISING)));
572 ret = lis3l02dq_spi_read_reg_8(indio_dev,
573 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
578 return !!(val & mask);
581 int lis3l02dq_disable_all_events(struct iio_dev *indio_dev)
586 ret = lis3l02dq_spi_read_reg_8(indio_dev,
587 LIS3L02DQ_REG_CTRL_2_ADDR,
590 control &= ~LIS3L02DQ_REG_CTRL_2_ENABLE_INTERRUPT;
591 ret = lis3l02dq_spi_write_reg_8(indio_dev,
592 LIS3L02DQ_REG_CTRL_2_ADDR,
596 /* Also for consistency clear the mask */
597 ret = lis3l02dq_spi_read_reg_8(indio_dev,
598 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
604 ret = lis3l02dq_spi_write_reg_8(indio_dev,
605 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
615 static int lis3l02dq_write_event_config(struct iio_dev *indio_dev,
616 const struct iio_chan_spec *chan,
617 enum iio_event_type type,
618 enum iio_event_direction dir,
624 bool changed = false;
625 u8 mask = (1 << (chan->channel2 * 2 + (dir == IIO_EV_DIR_RISING)));
627 mutex_lock(&indio_dev->mlock);
628 /* read current control */
629 ret = lis3l02dq_spi_read_reg_8(indio_dev,
630 LIS3L02DQ_REG_CTRL_2_ADDR,
634 ret = lis3l02dq_spi_read_reg_8(indio_dev,
635 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
639 currentlyset = val & mask;
641 if (!currentlyset && state) {
644 } else if (currentlyset && !state) {
650 ret = lis3l02dq_spi_write_reg_8(indio_dev,
651 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
655 control = val & 0x3f ?
656 (control | LIS3L02DQ_REG_CTRL_2_ENABLE_INTERRUPT) :
657 (control & ~LIS3L02DQ_REG_CTRL_2_ENABLE_INTERRUPT);
658 ret = lis3l02dq_spi_write_reg_8(indio_dev,
659 LIS3L02DQ_REG_CTRL_2_ADDR,
666 mutex_unlock(&indio_dev->mlock);
670 static struct attribute *lis3l02dq_attributes[] = {
671 &iio_dev_attr_sampling_frequency.dev_attr.attr,
672 &iio_const_attr_sampling_frequency_available.dev_attr.attr,
676 static const struct attribute_group lis3l02dq_attribute_group = {
677 .attrs = lis3l02dq_attributes,
680 static const struct iio_info lis3l02dq_info = {
681 .read_raw = &lis3l02dq_read_raw,
682 .write_raw = &lis3l02dq_write_raw,
683 .read_event_value = &lis3l02dq_read_thresh,
684 .write_event_value = &lis3l02dq_write_thresh,
685 .write_event_config = &lis3l02dq_write_event_config,
686 .read_event_config = &lis3l02dq_read_event_config,
687 .driver_module = THIS_MODULE,
688 .attrs = &lis3l02dq_attribute_group,
691 static int lis3l02dq_probe(struct spi_device *spi)
694 struct lis3l02dq_state *st;
695 struct iio_dev *indio_dev;
697 indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
700 st = iio_priv(indio_dev);
701 /* this is only used for removal purposes */
702 spi_set_drvdata(spi, indio_dev);
705 st->gpio = of_get_gpio(spi->dev.of_node, 0);
706 mutex_init(&st->buf_lock);
707 indio_dev->name = spi->dev.driver->name;
708 indio_dev->dev.parent = &spi->dev;
709 indio_dev->info = &lis3l02dq_info;
710 indio_dev->channels = lis3l02dq_channels;
711 indio_dev->num_channels = ARRAY_SIZE(lis3l02dq_channels);
713 indio_dev->modes = INDIO_DIRECT_MODE;
715 ret = lis3l02dq_configure_buffer(indio_dev);
720 ret = request_threaded_irq(st->us->irq,
722 &lis3l02dq_event_handler,
727 goto error_unreg_buffer_funcs;
729 ret = lis3l02dq_probe_trigger(indio_dev);
731 goto error_free_interrupt;
734 /* Get the device into a sane initial state */
735 ret = lis3l02dq_initial_setup(indio_dev);
737 goto error_remove_trigger;
739 ret = iio_device_register(indio_dev);
741 goto error_remove_trigger;
745 error_remove_trigger:
747 lis3l02dq_remove_trigger(indio_dev);
748 error_free_interrupt:
750 free_irq(st->us->irq, indio_dev);
751 error_unreg_buffer_funcs:
752 lis3l02dq_unconfigure_buffer(indio_dev);
756 /* Power down the device */
757 static int lis3l02dq_stop_device(struct iio_dev *indio_dev)
760 struct lis3l02dq_state *st = iio_priv(indio_dev);
763 mutex_lock(&indio_dev->mlock);
764 ret = lis3l02dq_spi_write_reg_8(indio_dev,
765 LIS3L02DQ_REG_CTRL_1_ADDR,
768 dev_err(&st->us->dev, "problem with turning device off: ctrl1");
772 ret = lis3l02dq_spi_write_reg_8(indio_dev,
773 LIS3L02DQ_REG_CTRL_2_ADDR,
776 dev_err(&st->us->dev, "problem with turning device off: ctrl2");
778 mutex_unlock(&indio_dev->mlock);
782 /* fixme, confirm ordering in this function */
783 static int lis3l02dq_remove(struct spi_device *spi)
785 struct iio_dev *indio_dev = spi_get_drvdata(spi);
786 struct lis3l02dq_state *st = iio_priv(indio_dev);
788 iio_device_unregister(indio_dev);
790 lis3l02dq_disable_all_events(indio_dev);
791 lis3l02dq_stop_device(indio_dev);
794 free_irq(st->us->irq, indio_dev);
796 lis3l02dq_remove_trigger(indio_dev);
797 lis3l02dq_unconfigure_buffer(indio_dev);
802 static struct spi_driver lis3l02dq_driver = {
805 .owner = THIS_MODULE,
807 .probe = lis3l02dq_probe,
808 .remove = lis3l02dq_remove,
810 module_spi_driver(lis3l02dq_driver);
812 MODULE_AUTHOR("Jonathan Cameron <jic23@kernel.org>");
813 MODULE_DESCRIPTION("ST LIS3L02DQ Accelerometer SPI driver");
814 MODULE_LICENSE("GPL v2");
815 MODULE_ALIAS("spi:lis3l02dq");