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>
27 #include "../ring_generic.h"
31 #include "lis3l02dq.h"
33 /* At the moment the spi framework doesn't allow global setting of cs_change.
34 * It's in the likely to be added comment at the top of spi.h.
35 * This means that use cannot be made of spi_write etc.
37 /* direct copy of the irq_default_primary_handler */
38 #ifndef CONFIG_IIO_RING_BUFFER
39 static irqreturn_t lis3l02dq_noring(int irq, void *private)
41 return IRQ_WAKE_THREAD;
46 * lis3l02dq_spi_read_reg_8() - read single byte from a single register
47 * @indio_dev: iio_dev for this actual device
48 * @reg_address: the address of the register to be read
49 * @val: pass back the resulting value
51 int lis3l02dq_spi_read_reg_8(struct iio_dev *indio_dev,
52 u8 reg_address, u8 *val)
54 struct lis3l02dq_state *st = iio_priv(indio_dev);
55 struct spi_message msg;
57 struct spi_transfer xfer = {
64 mutex_lock(&st->buf_lock);
65 st->tx[0] = LIS3L02DQ_READ_REG(reg_address);
68 spi_message_init(&msg);
69 spi_message_add_tail(&xfer, &msg);
70 ret = spi_sync(st->us, &msg);
72 mutex_unlock(&st->buf_lock);
78 * lis3l02dq_spi_write_reg_8() - write single byte to a register
79 * @indio_dev: iio_dev for this device
80 * @reg_address: the address of the register to be written
81 * @val: the value to write
83 int lis3l02dq_spi_write_reg_8(struct iio_dev *indio_dev,
88 struct lis3l02dq_state *st = iio_priv(indio_dev);
90 mutex_lock(&st->buf_lock);
91 st->tx[0] = LIS3L02DQ_WRITE_REG(reg_address);
93 ret = spi_write(st->us, st->tx, 2);
94 mutex_unlock(&st->buf_lock);
100 * lisl302dq_spi_write_reg_s16() - write 2 bytes to a pair of registers
101 * @indio_dev: iio_dev for this device
102 * @lower_reg_address: the address of the lower of the two registers.
103 * Second register is assumed to have address one greater.
104 * @value: value to be written
106 static int lis3l02dq_spi_write_reg_s16(struct iio_dev *indio_dev,
107 u8 lower_reg_address,
111 struct spi_message msg;
112 struct lis3l02dq_state *st = iio_priv(indio_dev);
113 struct spi_transfer xfers[] = { {
119 .tx_buf = st->tx + 2,
125 mutex_lock(&st->buf_lock);
126 st->tx[0] = LIS3L02DQ_WRITE_REG(lower_reg_address);
127 st->tx[1] = value & 0xFF;
128 st->tx[2] = LIS3L02DQ_WRITE_REG(lower_reg_address + 1);
129 st->tx[3] = (value >> 8) & 0xFF;
131 spi_message_init(&msg);
132 spi_message_add_tail(&xfers[0], &msg);
133 spi_message_add_tail(&xfers[1], &msg);
134 ret = spi_sync(st->us, &msg);
135 mutex_unlock(&st->buf_lock);
140 static int lis3l02dq_read_reg_s16(struct iio_dev *indio_dev,
141 u8 lower_reg_address,
144 struct lis3l02dq_state *st = iio_priv(indio_dev);
146 struct spi_message msg;
149 struct spi_transfer xfers[] = { {
156 .tx_buf = st->tx + 2,
157 .rx_buf = st->rx + 2,
163 mutex_lock(&st->buf_lock);
164 st->tx[0] = LIS3L02DQ_READ_REG(lower_reg_address);
166 st->tx[2] = LIS3L02DQ_READ_REG(lower_reg_address + 1);
169 spi_message_init(&msg);
170 spi_message_add_tail(&xfers[0], &msg);
171 spi_message_add_tail(&xfers[1], &msg);
172 ret = spi_sync(st->us, &msg);
174 dev_err(&st->us->dev, "problem when reading 16 bit register");
177 tempval = (s16)(st->rx[1]) | ((s16)(st->rx[3]) << 8);
181 mutex_unlock(&st->buf_lock);
185 enum lis3l02dq_rm_ind {
191 static u8 lis3l02dq_axis_map[3][3] = {
192 [LIS3L02DQ_ACCEL] = { LIS3L02DQ_REG_OUT_X_L_ADDR,
193 LIS3L02DQ_REG_OUT_Y_L_ADDR,
194 LIS3L02DQ_REG_OUT_Z_L_ADDR },
195 [LIS3L02DQ_GAIN] = { LIS3L02DQ_REG_GAIN_X_ADDR,
196 LIS3L02DQ_REG_GAIN_Y_ADDR,
197 LIS3L02DQ_REG_GAIN_Z_ADDR },
198 [LIS3L02DQ_BIAS] = { LIS3L02DQ_REG_OFFSET_X_ADDR,
199 LIS3L02DQ_REG_OFFSET_Y_ADDR,
200 LIS3L02DQ_REG_OFFSET_Z_ADDR }
203 static int lis3l02dq_read_thresh(struct iio_dev *indio_dev,
207 return lis3l02dq_read_reg_s16(indio_dev, LIS3L02DQ_REG_THS_L_ADDR, val);
210 static int lis3l02dq_write_thresh(struct iio_dev *indio_dev,
215 return lis3l02dq_spi_write_reg_s16(indio_dev,
216 LIS3L02DQ_REG_THS_L_ADDR,
220 static int lis3l02dq_write_raw(struct iio_dev *indio_dev,
221 struct iio_chan_spec const *chan,
226 int ret = -EINVAL, reg;
230 case (1 << IIO_CHAN_INFO_CALIBBIAS_SEPARATE):
231 if (val > 255 || val < -256)
234 reg = lis3l02dq_axis_map[LIS3L02DQ_BIAS][chan->address];
235 ret = lis3l02dq_spi_write_reg_8(indio_dev, reg, sval);
237 case (1 << IIO_CHAN_INFO_CALIBSCALE_SEPARATE):
241 reg = lis3l02dq_axis_map[LIS3L02DQ_GAIN][chan->address];
242 ret = lis3l02dq_spi_write_reg_8(indio_dev, reg, uval);
248 static int lis3l02dq_read_raw(struct iio_dev *indio_dev,
249 struct iio_chan_spec const *chan,
261 /* Take the iio_dev status lock */
262 mutex_lock(&indio_dev->mlock);
263 if (indio_dev->currentmode == INDIO_RING_TRIGGERED)
264 ret = lis3l02dq_read_accel_from_ring(indio_dev->ring,
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);
274 case (1 << IIO_CHAN_INFO_SCALE_SHARED):
277 return IIO_VAL_INT_PLUS_MICRO;
278 case (1 << IIO_CHAN_INFO_CALIBSCALE_SEPARATE):
279 reg = lis3l02dq_axis_map[LIS3L02DQ_GAIN][chan->address];
280 ret = lis3l02dq_spi_read_reg_8(indio_dev, reg, &utemp);
283 /* to match with what previous code does */
287 case (1 << IIO_CHAN_INFO_CALIBBIAS_SEPARATE):
288 reg = lis3l02dq_axis_map[LIS3L02DQ_BIAS][chan->address];
289 ret = lis3l02dq_spi_read_reg_8(indio_dev, reg, (u8 *)&stemp);
290 /* to match with what previous code does */
298 static ssize_t lis3l02dq_read_frequency(struct device *dev,
299 struct device_attribute *attr,
302 struct iio_dev *indio_dev = dev_get_drvdata(dev);
305 ret = lis3l02dq_spi_read_reg_8(indio_dev,
306 LIS3L02DQ_REG_CTRL_1_ADDR,
310 t &= LIS3L02DQ_DEC_MASK;
312 case LIS3L02DQ_REG_CTRL_1_DF_128:
313 len = sprintf(buf, "280\n");
315 case LIS3L02DQ_REG_CTRL_1_DF_64:
316 len = sprintf(buf, "560\n");
318 case LIS3L02DQ_REG_CTRL_1_DF_32:
319 len = sprintf(buf, "1120\n");
321 case LIS3L02DQ_REG_CTRL_1_DF_8:
322 len = sprintf(buf, "4480\n");
328 static ssize_t lis3l02dq_write_frequency(struct device *dev,
329 struct device_attribute *attr,
333 struct iio_dev *indio_dev = dev_get_drvdata(dev);
338 ret = strict_strtol(buf, 10, &val);
342 mutex_lock(&indio_dev->mlock);
343 ret = lis3l02dq_spi_read_reg_8(indio_dev,
344 LIS3L02DQ_REG_CTRL_1_ADDR,
347 goto error_ret_mutex;
348 /* Wipe the bits clean */
349 t &= ~LIS3L02DQ_DEC_MASK;
352 t |= LIS3L02DQ_REG_CTRL_1_DF_128;
355 t |= LIS3L02DQ_REG_CTRL_1_DF_64;
358 t |= LIS3L02DQ_REG_CTRL_1_DF_32;
361 t |= LIS3L02DQ_REG_CTRL_1_DF_8;
365 goto error_ret_mutex;
368 ret = lis3l02dq_spi_write_reg_8(indio_dev,
369 LIS3L02DQ_REG_CTRL_1_ADDR,
373 mutex_unlock(&indio_dev->mlock);
375 return ret ? ret : len;
378 static int lis3l02dq_initial_setup(struct iio_dev *indio_dev)
380 struct lis3l02dq_state *st = iio_priv(indio_dev);
384 st->us->mode = SPI_MODE_3;
388 val = LIS3L02DQ_DEFAULT_CTRL1;
389 /* Write suitable defaults to ctrl1 */
390 ret = lis3l02dq_spi_write_reg_8(indio_dev,
391 LIS3L02DQ_REG_CTRL_1_ADDR,
394 dev_err(&st->us->dev, "problem with setup control register 1");
397 /* Repeat as sometimes doesn't work first time?*/
398 ret = lis3l02dq_spi_write_reg_8(indio_dev,
399 LIS3L02DQ_REG_CTRL_1_ADDR,
402 dev_err(&st->us->dev, "problem with setup control register 1");
406 /* Read back to check this has worked acts as loose test of correct
408 ret = lis3l02dq_spi_read_reg_8(indio_dev,
409 LIS3L02DQ_REG_CTRL_1_ADDR,
411 if (ret || (valtest != val)) {
412 dev_err(&indio_dev->dev,
413 "device not playing ball %d %d\n", valtest, val);
418 val = LIS3L02DQ_DEFAULT_CTRL2;
419 ret = lis3l02dq_spi_write_reg_8(indio_dev,
420 LIS3L02DQ_REG_CTRL_2_ADDR,
423 dev_err(&st->us->dev, "problem with setup control register 2");
427 val = LIS3L02DQ_REG_WAKE_UP_CFG_LATCH_SRC;
428 ret = lis3l02dq_spi_write_reg_8(indio_dev,
429 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
432 dev_err(&st->us->dev, "problem with interrupt cfg register");
438 static IIO_DEV_ATTR_SAMP_FREQ(S_IWUSR | S_IRUGO,
439 lis3l02dq_read_frequency,
440 lis3l02dq_write_frequency);
442 static IIO_CONST_ATTR_SAMP_FREQ_AVAIL("280 560 1120 4480");
444 static irqreturn_t lis3l02dq_event_handler(int irq, void *private)
446 struct iio_dev *indio_dev = private;
449 s64 timestamp = iio_get_time_ns();
451 lis3l02dq_spi_read_reg_8(indio_dev,
452 LIS3L02DQ_REG_WAKE_UP_SRC_ADDR,
455 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_Z_HIGH)
456 iio_push_event(indio_dev, 0,
457 IIO_MOD_EVENT_CODE(IIO_EV_CLASS_ACCEL,
464 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_Z_LOW)
465 iio_push_event(indio_dev, 0,
466 IIO_MOD_EVENT_CODE(IIO_EV_CLASS_ACCEL,
473 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_Y_HIGH)
474 iio_push_event(indio_dev, 0,
475 IIO_MOD_EVENT_CODE(IIO_EV_CLASS_ACCEL,
482 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_Y_LOW)
483 iio_push_event(indio_dev, 0,
484 IIO_MOD_EVENT_CODE(IIO_EV_CLASS_ACCEL,
491 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_X_HIGH)
492 iio_push_event(indio_dev, 0,
493 IIO_MOD_EVENT_CODE(IIO_EV_CLASS_ACCEL,
500 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_X_LOW)
501 iio_push_event(indio_dev, 0,
502 IIO_MOD_EVENT_CODE(IIO_EV_CLASS_ACCEL,
509 /* Ack and allow for new interrupts */
510 lis3l02dq_spi_read_reg_8(indio_dev,
511 LIS3L02DQ_REG_WAKE_UP_ACK_ADDR,
517 #define LIS3L02DQ_INFO_MASK \
518 ((1 << IIO_CHAN_INFO_SCALE_SHARED) | \
519 (1 << IIO_CHAN_INFO_CALIBSCALE_SEPARATE) | \
520 (1 << IIO_CHAN_INFO_CALIBBIAS_SEPARATE))
522 #define LIS3L02DQ_EVENT_MASK \
523 (IIO_EV_BIT(IIO_EV_TYPE_THRESH, IIO_EV_DIR_RISING) | \
524 IIO_EV_BIT(IIO_EV_TYPE_THRESH, IIO_EV_DIR_FALLING))
526 static struct iio_chan_spec lis3l02dq_channels[] = {
527 IIO_CHAN(IIO_ACCEL, 1, 0, 0, NULL, 0, IIO_MOD_X, LIS3L02DQ_INFO_MASK,
528 0, 0, IIO_ST('s', 12, 16, 0), LIS3L02DQ_EVENT_MASK),
529 IIO_CHAN(IIO_ACCEL, 1, 0, 0, NULL, 0, IIO_MOD_Y, LIS3L02DQ_INFO_MASK,
530 1, 1, IIO_ST('s', 12, 16, 0), LIS3L02DQ_EVENT_MASK),
531 IIO_CHAN(IIO_ACCEL, 1, 0, 0, NULL, 0, IIO_MOD_Z, LIS3L02DQ_INFO_MASK,
532 2, 2, IIO_ST('s', 12, 16, 0), LIS3L02DQ_EVENT_MASK),
533 IIO_CHAN_SOFT_TIMESTAMP(3)
537 static ssize_t lis3l02dq_read_event_config(struct iio_dev *indio_dev,
543 u8 mask = (1 << (IIO_EVENT_CODE_EXTRACT_MODIFIER(event_code)*2 +
544 (IIO_EVENT_CODE_EXTRACT_DIR(event_code) ==
545 IIO_EV_DIR_RISING)));
546 ret = lis3l02dq_spi_read_reg_8(indio_dev,
547 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
552 return !!(val & mask);
555 int lis3l02dq_disable_all_events(struct iio_dev *indio_dev)
560 ret = lis3l02dq_spi_read_reg_8(indio_dev,
561 LIS3L02DQ_REG_CTRL_2_ADDR,
564 control &= ~LIS3L02DQ_REG_CTRL_2_ENABLE_INTERRUPT;
565 ret = lis3l02dq_spi_write_reg_8(indio_dev,
566 LIS3L02DQ_REG_CTRL_2_ADDR,
570 /* Also for consistency clear the mask */
571 ret = lis3l02dq_spi_read_reg_8(indio_dev,
572 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
578 ret = lis3l02dq_spi_write_reg_8(indio_dev,
579 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
589 static int lis3l02dq_write_event_config(struct iio_dev *indio_dev,
596 bool changed = false;
597 u8 mask = (1 << (IIO_EVENT_CODE_EXTRACT_MODIFIER(event_code)*2 +
598 (IIO_EVENT_CODE_EXTRACT_DIR(event_code) ==
599 IIO_EV_DIR_RISING)));
601 mutex_lock(&indio_dev->mlock);
602 /* read current control */
603 ret = lis3l02dq_spi_read_reg_8(indio_dev,
604 LIS3L02DQ_REG_CTRL_2_ADDR,
608 ret = lis3l02dq_spi_read_reg_8(indio_dev,
609 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
613 currentlyset = val & mask;
615 if (!currentlyset && state) {
618 } else if (currentlyset && !state) {
624 ret = lis3l02dq_spi_write_reg_8(indio_dev,
625 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
629 control = val & 0x3f ?
630 (control | LIS3L02DQ_REG_CTRL_2_ENABLE_INTERRUPT) :
631 (control & ~LIS3L02DQ_REG_CTRL_2_ENABLE_INTERRUPT);
632 ret = lis3l02dq_spi_write_reg_8(indio_dev,
633 LIS3L02DQ_REG_CTRL_2_ADDR,
640 mutex_unlock(&indio_dev->mlock);
644 static struct attribute *lis3l02dq_attributes[] = {
645 &iio_dev_attr_sampling_frequency.dev_attr.attr,
646 &iio_const_attr_sampling_frequency_available.dev_attr.attr,
650 static const struct attribute_group lis3l02dq_attribute_group = {
651 .attrs = lis3l02dq_attributes,
654 static const struct iio_info lis3l02dq_info = {
655 .num_interrupt_lines = 1,
656 .read_raw = &lis3l02dq_read_raw,
657 .write_raw = &lis3l02dq_write_raw,
658 .read_event_value = &lis3l02dq_read_thresh,
659 .write_event_value = &lis3l02dq_write_thresh,
660 .write_event_config = &lis3l02dq_write_event_config,
661 .read_event_config = &lis3l02dq_read_event_config,
662 .driver_module = THIS_MODULE,
663 .attrs = &lis3l02dq_attribute_group,
666 static int __devinit lis3l02dq_probe(struct spi_device *spi)
668 int ret, regdone = 0;
669 struct lis3l02dq_state *st;
670 struct iio_dev *indio_dev;
672 indio_dev = iio_allocate_device(sizeof *st);
673 if (indio_dev == NULL) {
677 st = iio_priv(indio_dev);
678 /* this is only used tor removal purposes */
679 spi_set_drvdata(spi, indio_dev);
682 mutex_init(&st->buf_lock);
683 indio_dev->name = spi->dev.driver->name;
684 indio_dev->dev.parent = &spi->dev;
685 indio_dev->info = &lis3l02dq_info;
686 indio_dev->channels = lis3l02dq_channels;
687 indio_dev->num_channels = ARRAY_SIZE(lis3l02dq_channels);
689 indio_dev->modes = INDIO_DIRECT_MODE;
691 ret = lis3l02dq_configure_ring(indio_dev);
695 ret = iio_device_register(indio_dev);
697 goto error_unreg_ring_funcs;
700 ret = iio_ring_buffer_register_ex(indio_dev->ring, 0,
702 ARRAY_SIZE(lis3l02dq_channels));
704 printk(KERN_ERR "failed to initialize the ring\n");
705 goto error_unreg_ring_funcs;
708 if (spi->irq && gpio_is_valid(irq_to_gpio(spi->irq)) > 0) {
709 ret = request_threaded_irq(st->us->irq,
711 &lis3l02dq_event_handler,
716 goto error_uninitialize_ring;
718 ret = lis3l02dq_probe_trigger(indio_dev);
720 goto error_free_interrupt;
723 /* Get the device into a sane initial state */
724 ret = lis3l02dq_initial_setup(indio_dev);
726 goto error_remove_trigger;
729 error_remove_trigger:
730 if (indio_dev->modes & INDIO_RING_TRIGGERED)
731 lis3l02dq_remove_trigger(indio_dev);
732 error_free_interrupt:
733 if (spi->irq && gpio_is_valid(irq_to_gpio(spi->irq)) > 0)
734 free_irq(st->us->irq, indio_dev);
735 error_uninitialize_ring:
736 iio_ring_buffer_unregister(indio_dev->ring);
737 error_unreg_ring_funcs:
738 lis3l02dq_unconfigure_ring(indio_dev);
741 iio_device_unregister(indio_dev);
743 iio_free_device(indio_dev);
748 /* Power down the device */
749 static int lis3l02dq_stop_device(struct iio_dev *indio_dev)
752 struct lis3l02dq_state *st = iio_priv(indio_dev);
755 mutex_lock(&indio_dev->mlock);
756 ret = lis3l02dq_spi_write_reg_8(indio_dev,
757 LIS3L02DQ_REG_CTRL_1_ADDR,
760 dev_err(&st->us->dev, "problem with turning device off: ctrl1");
764 ret = lis3l02dq_spi_write_reg_8(indio_dev,
765 LIS3L02DQ_REG_CTRL_2_ADDR,
768 dev_err(&st->us->dev, "problem with turning device off: ctrl2");
770 mutex_unlock(&indio_dev->mlock);
774 /* fixme, confirm ordering in this function */
775 static int lis3l02dq_remove(struct spi_device *spi)
778 struct iio_dev *indio_dev = spi_get_drvdata(spi);
779 struct lis3l02dq_state *st = iio_priv(indio_dev);
781 ret = lis3l02dq_disable_all_events(indio_dev);
785 ret = lis3l02dq_stop_device(indio_dev);
789 if (spi->irq && gpio_is_valid(irq_to_gpio(spi->irq)) > 0)
790 free_irq(st->us->irq, indio_dev);
792 lis3l02dq_remove_trigger(indio_dev);
793 iio_ring_buffer_unregister(indio_dev->ring);
794 lis3l02dq_unconfigure_ring(indio_dev);
795 iio_device_unregister(indio_dev);
803 static struct spi_driver lis3l02dq_driver = {
806 .owner = THIS_MODULE,
808 .probe = lis3l02dq_probe,
809 .remove = __devexit_p(lis3l02dq_remove),
812 static __init int lis3l02dq_init(void)
814 return spi_register_driver(&lis3l02dq_driver);
816 module_init(lis3l02dq_init);
818 static __exit void lis3l02dq_exit(void)
820 spi_unregister_driver(&lis3l02dq_driver);
822 module_exit(lis3l02dq_exit);
824 MODULE_AUTHOR("Jonathan Cameron <jic23@cam.ac.uk>");
825 MODULE_DESCRIPTION("ST LIS3L02DQ Accelerometer SPI driver");
826 MODULE_LICENSE("GPL v2");