2 * lis3l02dq.c support STMicroelectronics LISD02DQ
3 * 3d 2g Linear Accelerometers via SPI
5 * Copyright (c) 2007 Jonathan Cameron <jic23@cam.ac.uk>
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/mutex.h>
19 #include <linux/device.h>
20 #include <linux/kernel.h>
21 #include <linux/spi/spi.h>
22 #include <linux/slab.h>
23 #include <linux/sysfs.h>
24 #include <linux/module.h>
28 #include "../ring_generic.h"
30 #include "lis3l02dq.h"
32 /* At the moment the spi framework doesn't allow global setting of cs_change.
33 * It's in the likely to be added comment at the top of spi.h.
34 * This means that use cannot be made of spi_write etc.
36 /* direct copy of the irq_default_primary_handler */
37 #ifndef CONFIG_IIO_RING_BUFFER
38 static irqreturn_t lis3l02dq_noring(int irq, void *private)
40 return IRQ_WAKE_THREAD;
45 * lis3l02dq_spi_read_reg_8() - read single byte from a single register
46 * @indio_dev: iio_dev for this actual device
47 * @reg_address: the address of the register to be read
48 * @val: pass back the resulting value
50 int lis3l02dq_spi_read_reg_8(struct iio_dev *indio_dev,
51 u8 reg_address, u8 *val)
53 struct lis3l02dq_state *st = iio_priv(indio_dev);
54 struct spi_message msg;
56 struct spi_transfer xfer = {
63 mutex_lock(&st->buf_lock);
64 st->tx[0] = LIS3L02DQ_READ_REG(reg_address);
67 spi_message_init(&msg);
68 spi_message_add_tail(&xfer, &msg);
69 ret = spi_sync(st->us, &msg);
71 mutex_unlock(&st->buf_lock);
77 * lis3l02dq_spi_write_reg_8() - write single byte to a register
78 * @indio_dev: iio_dev for this device
79 * @reg_address: the address of the register to be written
80 * @val: the value to write
82 int lis3l02dq_spi_write_reg_8(struct iio_dev *indio_dev,
87 struct lis3l02dq_state *st = iio_priv(indio_dev);
89 mutex_lock(&st->buf_lock);
90 st->tx[0] = LIS3L02DQ_WRITE_REG(reg_address);
92 ret = spi_write(st->us, st->tx, 2);
93 mutex_unlock(&st->buf_lock);
99 * lisl302dq_spi_write_reg_s16() - write 2 bytes to a pair of registers
100 * @indio_dev: iio_dev for this device
101 * @lower_reg_address: the address of the lower of the two registers.
102 * Second register is assumed to have address one greater.
103 * @value: value to be written
105 static int lis3l02dq_spi_write_reg_s16(struct iio_dev *indio_dev,
106 u8 lower_reg_address,
110 struct spi_message msg;
111 struct lis3l02dq_state *st = iio_priv(indio_dev);
112 struct spi_transfer xfers[] = { {
118 .tx_buf = st->tx + 2,
124 mutex_lock(&st->buf_lock);
125 st->tx[0] = LIS3L02DQ_WRITE_REG(lower_reg_address);
126 st->tx[1] = value & 0xFF;
127 st->tx[2] = LIS3L02DQ_WRITE_REG(lower_reg_address + 1);
128 st->tx[3] = (value >> 8) & 0xFF;
130 spi_message_init(&msg);
131 spi_message_add_tail(&xfers[0], &msg);
132 spi_message_add_tail(&xfers[1], &msg);
133 ret = spi_sync(st->us, &msg);
134 mutex_unlock(&st->buf_lock);
139 static int lis3l02dq_read_reg_s16(struct iio_dev *indio_dev,
140 u8 lower_reg_address,
143 struct lis3l02dq_state *st = iio_priv(indio_dev);
145 struct spi_message msg;
148 struct spi_transfer xfers[] = { {
155 .tx_buf = st->tx + 2,
156 .rx_buf = st->rx + 2,
162 mutex_lock(&st->buf_lock);
163 st->tx[0] = LIS3L02DQ_READ_REG(lower_reg_address);
165 st->tx[2] = LIS3L02DQ_READ_REG(lower_reg_address + 1);
168 spi_message_init(&msg);
169 spi_message_add_tail(&xfers[0], &msg);
170 spi_message_add_tail(&xfers[1], &msg);
171 ret = spi_sync(st->us, &msg);
173 dev_err(&st->us->dev, "problem when reading 16 bit register");
176 tempval = (s16)(st->rx[1]) | ((s16)(st->rx[3]) << 8);
180 mutex_unlock(&st->buf_lock);
184 enum lis3l02dq_rm_ind {
190 static u8 lis3l02dq_axis_map[3][3] = {
191 [LIS3L02DQ_ACCEL] = { LIS3L02DQ_REG_OUT_X_L_ADDR,
192 LIS3L02DQ_REG_OUT_Y_L_ADDR,
193 LIS3L02DQ_REG_OUT_Z_L_ADDR },
194 [LIS3L02DQ_GAIN] = { LIS3L02DQ_REG_GAIN_X_ADDR,
195 LIS3L02DQ_REG_GAIN_Y_ADDR,
196 LIS3L02DQ_REG_GAIN_Z_ADDR },
197 [LIS3L02DQ_BIAS] = { LIS3L02DQ_REG_OFFSET_X_ADDR,
198 LIS3L02DQ_REG_OFFSET_Y_ADDR,
199 LIS3L02DQ_REG_OFFSET_Z_ADDR }
202 static int lis3l02dq_read_thresh(struct iio_dev *indio_dev,
206 return lis3l02dq_read_reg_s16(indio_dev, LIS3L02DQ_REG_THS_L_ADDR, val);
209 static int lis3l02dq_write_thresh(struct iio_dev *indio_dev,
214 return lis3l02dq_spi_write_reg_s16(indio_dev,
215 LIS3L02DQ_REG_THS_L_ADDR,
219 static int lis3l02dq_write_raw(struct iio_dev *indio_dev,
220 struct iio_chan_spec const *chan,
225 int ret = -EINVAL, reg;
229 case (1 << IIO_CHAN_INFO_CALIBBIAS_SEPARATE):
230 if (val > 255 || val < -256)
233 reg = lis3l02dq_axis_map[LIS3L02DQ_BIAS][chan->address];
234 ret = lis3l02dq_spi_write_reg_8(indio_dev, reg, sval);
236 case (1 << IIO_CHAN_INFO_CALIBSCALE_SEPARATE):
240 reg = lis3l02dq_axis_map[LIS3L02DQ_GAIN][chan->address];
241 ret = lis3l02dq_spi_write_reg_8(indio_dev, reg, uval);
247 static int lis3l02dq_read_raw(struct iio_dev *indio_dev,
248 struct iio_chan_spec const *chan,
260 /* Take the iio_dev status lock */
261 mutex_lock(&indio_dev->mlock);
262 if (indio_dev->currentmode == INDIO_RING_TRIGGERED)
263 ret = lis3l02dq_read_accel_from_ring(indio_dev->ring,
267 reg = lis3l02dq_axis_map
268 [LIS3L02DQ_ACCEL][chan->address];
269 ret = lis3l02dq_read_reg_s16(indio_dev, reg, val);
271 mutex_unlock(&indio_dev->mlock);
273 case (1 << IIO_CHAN_INFO_SCALE_SHARED):
276 return IIO_VAL_INT_PLUS_MICRO;
277 case (1 << IIO_CHAN_INFO_CALIBSCALE_SEPARATE):
278 reg = lis3l02dq_axis_map[LIS3L02DQ_GAIN][chan->address];
279 ret = lis3l02dq_spi_read_reg_8(indio_dev, reg, &utemp);
282 /* to match with what previous code does */
286 case (1 << IIO_CHAN_INFO_CALIBBIAS_SEPARATE):
287 reg = lis3l02dq_axis_map[LIS3L02DQ_BIAS][chan->address];
288 ret = lis3l02dq_spi_read_reg_8(indio_dev, reg, (u8 *)&stemp);
289 /* to match with what previous code does */
297 static ssize_t lis3l02dq_read_frequency(struct device *dev,
298 struct device_attribute *attr,
301 struct iio_dev *indio_dev = dev_get_drvdata(dev);
304 ret = lis3l02dq_spi_read_reg_8(indio_dev,
305 LIS3L02DQ_REG_CTRL_1_ADDR,
309 t &= LIS3L02DQ_DEC_MASK;
311 case LIS3L02DQ_REG_CTRL_1_DF_128:
312 len = sprintf(buf, "280\n");
314 case LIS3L02DQ_REG_CTRL_1_DF_64:
315 len = sprintf(buf, "560\n");
317 case LIS3L02DQ_REG_CTRL_1_DF_32:
318 len = sprintf(buf, "1120\n");
320 case LIS3L02DQ_REG_CTRL_1_DF_8:
321 len = sprintf(buf, "4480\n");
327 static ssize_t lis3l02dq_write_frequency(struct device *dev,
328 struct device_attribute *attr,
332 struct iio_dev *indio_dev = dev_get_drvdata(dev);
337 ret = strict_strtol(buf, 10, &val);
341 mutex_lock(&indio_dev->mlock);
342 ret = lis3l02dq_spi_read_reg_8(indio_dev,
343 LIS3L02DQ_REG_CTRL_1_ADDR,
346 goto error_ret_mutex;
347 /* Wipe the bits clean */
348 t &= ~LIS3L02DQ_DEC_MASK;
351 t |= LIS3L02DQ_REG_CTRL_1_DF_128;
354 t |= LIS3L02DQ_REG_CTRL_1_DF_64;
357 t |= LIS3L02DQ_REG_CTRL_1_DF_32;
360 t |= LIS3L02DQ_REG_CTRL_1_DF_8;
364 goto error_ret_mutex;
367 ret = lis3l02dq_spi_write_reg_8(indio_dev,
368 LIS3L02DQ_REG_CTRL_1_ADDR,
372 mutex_unlock(&indio_dev->mlock);
374 return ret ? ret : len;
377 static int lis3l02dq_initial_setup(struct iio_dev *indio_dev)
379 struct lis3l02dq_state *st = iio_priv(indio_dev);
383 st->us->mode = SPI_MODE_3;
387 val = LIS3L02DQ_DEFAULT_CTRL1;
388 /* Write suitable defaults to ctrl1 */
389 ret = lis3l02dq_spi_write_reg_8(indio_dev,
390 LIS3L02DQ_REG_CTRL_1_ADDR,
393 dev_err(&st->us->dev, "problem with setup control register 1");
396 /* Repeat as sometimes doesn't work first time?*/
397 ret = lis3l02dq_spi_write_reg_8(indio_dev,
398 LIS3L02DQ_REG_CTRL_1_ADDR,
401 dev_err(&st->us->dev, "problem with setup control register 1");
405 /* Read back to check this has worked acts as loose test of correct
407 ret = lis3l02dq_spi_read_reg_8(indio_dev,
408 LIS3L02DQ_REG_CTRL_1_ADDR,
410 if (ret || (valtest != val)) {
411 dev_err(&indio_dev->dev,
412 "device not playing ball %d %d\n", valtest, val);
417 val = LIS3L02DQ_DEFAULT_CTRL2;
418 ret = lis3l02dq_spi_write_reg_8(indio_dev,
419 LIS3L02DQ_REG_CTRL_2_ADDR,
422 dev_err(&st->us->dev, "problem with setup control register 2");
426 val = LIS3L02DQ_REG_WAKE_UP_CFG_LATCH_SRC;
427 ret = lis3l02dq_spi_write_reg_8(indio_dev,
428 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
431 dev_err(&st->us->dev, "problem with interrupt cfg register");
437 static IIO_DEV_ATTR_SAMP_FREQ(S_IWUSR | S_IRUGO,
438 lis3l02dq_read_frequency,
439 lis3l02dq_write_frequency);
441 static IIO_CONST_ATTR_SAMP_FREQ_AVAIL("280 560 1120 4480");
443 static irqreturn_t lis3l02dq_event_handler(int irq, void *private)
445 struct iio_dev *indio_dev = private;
448 s64 timestamp = iio_get_time_ns();
450 lis3l02dq_spi_read_reg_8(indio_dev,
451 LIS3L02DQ_REG_WAKE_UP_SRC_ADDR,
454 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_Z_HIGH)
455 iio_push_event(indio_dev,
456 IIO_MOD_EVENT_CODE(IIO_ACCEL,
463 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_Z_LOW)
464 iio_push_event(indio_dev,
465 IIO_MOD_EVENT_CODE(IIO_ACCEL,
472 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_Y_HIGH)
473 iio_push_event(indio_dev,
474 IIO_MOD_EVENT_CODE(IIO_ACCEL,
481 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_Y_LOW)
482 iio_push_event(indio_dev,
483 IIO_MOD_EVENT_CODE(IIO_ACCEL,
490 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_X_HIGH)
491 iio_push_event(indio_dev,
492 IIO_MOD_EVENT_CODE(IIO_ACCEL,
499 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_X_LOW)
500 iio_push_event(indio_dev,
501 IIO_MOD_EVENT_CODE(IIO_ACCEL,
508 /* Ack and allow for new interrupts */
509 lis3l02dq_spi_read_reg_8(indio_dev,
510 LIS3L02DQ_REG_WAKE_UP_ACK_ADDR,
516 #define LIS3L02DQ_INFO_MASK \
517 ((1 << IIO_CHAN_INFO_SCALE_SHARED) | \
518 (1 << IIO_CHAN_INFO_CALIBSCALE_SEPARATE) | \
519 (1 << IIO_CHAN_INFO_CALIBBIAS_SEPARATE))
521 #define LIS3L02DQ_EVENT_MASK \
522 (IIO_EV_BIT(IIO_EV_TYPE_THRESH, IIO_EV_DIR_RISING) | \
523 IIO_EV_BIT(IIO_EV_TYPE_THRESH, IIO_EV_DIR_FALLING))
525 static struct iio_chan_spec lis3l02dq_channels[] = {
526 IIO_CHAN(IIO_ACCEL, 1, 0, 0, NULL, 0, IIO_MOD_X, LIS3L02DQ_INFO_MASK,
527 0, 0, IIO_ST('s', 12, 16, 0), LIS3L02DQ_EVENT_MASK),
528 IIO_CHAN(IIO_ACCEL, 1, 0, 0, NULL, 0, IIO_MOD_Y, LIS3L02DQ_INFO_MASK,
529 1, 1, IIO_ST('s', 12, 16, 0), LIS3L02DQ_EVENT_MASK),
530 IIO_CHAN(IIO_ACCEL, 1, 0, 0, NULL, 0, IIO_MOD_Z, LIS3L02DQ_INFO_MASK,
531 2, 2, IIO_ST('s', 12, 16, 0), LIS3L02DQ_EVENT_MASK),
532 IIO_CHAN_SOFT_TIMESTAMP(3)
536 static ssize_t lis3l02dq_read_event_config(struct iio_dev *indio_dev,
542 u8 mask = (1 << (IIO_EVENT_CODE_EXTRACT_MODIFIER(event_code)*2 +
543 (IIO_EVENT_CODE_EXTRACT_DIR(event_code) ==
544 IIO_EV_DIR_RISING)));
545 ret = lis3l02dq_spi_read_reg_8(indio_dev,
546 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
551 return !!(val & mask);
554 int lis3l02dq_disable_all_events(struct iio_dev *indio_dev)
559 ret = lis3l02dq_spi_read_reg_8(indio_dev,
560 LIS3L02DQ_REG_CTRL_2_ADDR,
563 control &= ~LIS3L02DQ_REG_CTRL_2_ENABLE_INTERRUPT;
564 ret = lis3l02dq_spi_write_reg_8(indio_dev,
565 LIS3L02DQ_REG_CTRL_2_ADDR,
569 /* Also for consistency clear the mask */
570 ret = lis3l02dq_spi_read_reg_8(indio_dev,
571 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
577 ret = lis3l02dq_spi_write_reg_8(indio_dev,
578 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
588 static int lis3l02dq_write_event_config(struct iio_dev *indio_dev,
595 bool changed = false;
596 u8 mask = (1 << (IIO_EVENT_CODE_EXTRACT_MODIFIER(event_code)*2 +
597 (IIO_EVENT_CODE_EXTRACT_DIR(event_code) ==
598 IIO_EV_DIR_RISING)));
600 mutex_lock(&indio_dev->mlock);
601 /* read current control */
602 ret = lis3l02dq_spi_read_reg_8(indio_dev,
603 LIS3L02DQ_REG_CTRL_2_ADDR,
607 ret = lis3l02dq_spi_read_reg_8(indio_dev,
608 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
612 currentlyset = val & mask;
614 if (!currentlyset && state) {
617 } else if (currentlyset && !state) {
623 ret = lis3l02dq_spi_write_reg_8(indio_dev,
624 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
628 control = val & 0x3f ?
629 (control | LIS3L02DQ_REG_CTRL_2_ENABLE_INTERRUPT) :
630 (control & ~LIS3L02DQ_REG_CTRL_2_ENABLE_INTERRUPT);
631 ret = lis3l02dq_spi_write_reg_8(indio_dev,
632 LIS3L02DQ_REG_CTRL_2_ADDR,
639 mutex_unlock(&indio_dev->mlock);
643 static struct attribute *lis3l02dq_attributes[] = {
644 &iio_dev_attr_sampling_frequency.dev_attr.attr,
645 &iio_const_attr_sampling_frequency_available.dev_attr.attr,
649 static const struct attribute_group lis3l02dq_attribute_group = {
650 .attrs = lis3l02dq_attributes,
653 static const struct iio_info lis3l02dq_info = {
654 .read_raw = &lis3l02dq_read_raw,
655 .write_raw = &lis3l02dq_write_raw,
656 .read_event_value = &lis3l02dq_read_thresh,
657 .write_event_value = &lis3l02dq_write_thresh,
658 .write_event_config = &lis3l02dq_write_event_config,
659 .read_event_config = &lis3l02dq_read_event_config,
660 .driver_module = THIS_MODULE,
661 .attrs = &lis3l02dq_attribute_group,
664 static int __devinit lis3l02dq_probe(struct spi_device *spi)
666 int ret, regdone = 0;
667 struct lis3l02dq_state *st;
668 struct iio_dev *indio_dev;
670 indio_dev = iio_allocate_device(sizeof *st);
671 if (indio_dev == NULL) {
675 st = iio_priv(indio_dev);
676 /* this is only used tor removal purposes */
677 spi_set_drvdata(spi, indio_dev);
680 mutex_init(&st->buf_lock);
681 indio_dev->name = spi->dev.driver->name;
682 indio_dev->dev.parent = &spi->dev;
683 indio_dev->info = &lis3l02dq_info;
684 indio_dev->channels = lis3l02dq_channels;
685 indio_dev->num_channels = ARRAY_SIZE(lis3l02dq_channels);
687 indio_dev->modes = INDIO_DIRECT_MODE;
689 ret = lis3l02dq_configure_ring(indio_dev);
693 ret = iio_device_register(indio_dev);
695 goto error_unreg_ring_funcs;
698 ret = iio_ring_buffer_register_ex(indio_dev, 0,
700 ARRAY_SIZE(lis3l02dq_channels));
702 printk(KERN_ERR "failed to initialize the ring\n");
703 goto error_unreg_ring_funcs;
706 if (spi->irq && gpio_is_valid(irq_to_gpio(spi->irq)) > 0) {
707 ret = request_threaded_irq(st->us->irq,
709 &lis3l02dq_event_handler,
714 goto error_uninitialize_ring;
716 ret = lis3l02dq_probe_trigger(indio_dev);
718 goto error_free_interrupt;
721 /* Get the device into a sane initial state */
722 ret = lis3l02dq_initial_setup(indio_dev);
724 goto error_remove_trigger;
727 error_remove_trigger:
728 if (indio_dev->modes & INDIO_RING_TRIGGERED)
729 lis3l02dq_remove_trigger(indio_dev);
730 error_free_interrupt:
731 if (spi->irq && gpio_is_valid(irq_to_gpio(spi->irq)) > 0)
732 free_irq(st->us->irq, indio_dev);
733 error_uninitialize_ring:
734 iio_ring_buffer_unregister(indio_dev);
735 error_unreg_ring_funcs:
736 lis3l02dq_unconfigure_ring(indio_dev);
739 iio_device_unregister(indio_dev);
741 iio_free_device(indio_dev);
746 /* Power down the device */
747 static int lis3l02dq_stop_device(struct iio_dev *indio_dev)
750 struct lis3l02dq_state *st = iio_priv(indio_dev);
753 mutex_lock(&indio_dev->mlock);
754 ret = lis3l02dq_spi_write_reg_8(indio_dev,
755 LIS3L02DQ_REG_CTRL_1_ADDR,
758 dev_err(&st->us->dev, "problem with turning device off: ctrl1");
762 ret = lis3l02dq_spi_write_reg_8(indio_dev,
763 LIS3L02DQ_REG_CTRL_2_ADDR,
766 dev_err(&st->us->dev, "problem with turning device off: ctrl2");
768 mutex_unlock(&indio_dev->mlock);
772 /* fixme, confirm ordering in this function */
773 static int lis3l02dq_remove(struct spi_device *spi)
776 struct iio_dev *indio_dev = spi_get_drvdata(spi);
777 struct lis3l02dq_state *st = iio_priv(indio_dev);
779 ret = lis3l02dq_disable_all_events(indio_dev);
783 ret = lis3l02dq_stop_device(indio_dev);
787 if (spi->irq && gpio_is_valid(irq_to_gpio(spi->irq)) > 0)
788 free_irq(st->us->irq, indio_dev);
790 lis3l02dq_remove_trigger(indio_dev);
791 iio_ring_buffer_unregister(indio_dev);
792 lis3l02dq_unconfigure_ring(indio_dev);
793 iio_device_unregister(indio_dev);
801 static struct spi_driver lis3l02dq_driver = {
804 .owner = THIS_MODULE,
806 .probe = lis3l02dq_probe,
807 .remove = __devexit_p(lis3l02dq_remove),
810 static __init int lis3l02dq_init(void)
812 return spi_register_driver(&lis3l02dq_driver);
814 module_init(lis3l02dq_init);
816 static __exit void lis3l02dq_exit(void)
818 spi_unregister_driver(&lis3l02dq_driver);
820 module_exit(lis3l02dq_exit);
822 MODULE_AUTHOR("Jonathan Cameron <jic23@cam.ac.uk>");
823 MODULE_DESCRIPTION("ST LIS3L02DQ Accelerometer SPI driver");
824 MODULE_LICENSE("GPL v2");