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 "../events.h"
29 #include "../buffer.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_BUFFER
39 static irqreturn_t lis3l02dq_nobuffer(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_BUFFER_TRIGGERED)
264 ret = lis3l02dq_read_accel_from_buffer(indio_dev->
269 reg = lis3l02dq_axis_map
270 [LIS3L02DQ_ACCEL][chan->address];
271 ret = lis3l02dq_read_reg_s16(indio_dev, reg, val);
273 mutex_unlock(&indio_dev->mlock);
275 case (1 << IIO_CHAN_INFO_SCALE_SHARED):
278 return IIO_VAL_INT_PLUS_MICRO;
279 case (1 << IIO_CHAN_INFO_CALIBSCALE_SEPARATE):
280 reg = lis3l02dq_axis_map[LIS3L02DQ_GAIN][chan->address];
281 ret = lis3l02dq_spi_read_reg_8(indio_dev, reg, &utemp);
284 /* to match with what previous code does */
288 case (1 << IIO_CHAN_INFO_CALIBBIAS_SEPARATE):
289 reg = lis3l02dq_axis_map[LIS3L02DQ_BIAS][chan->address];
290 ret = lis3l02dq_spi_read_reg_8(indio_dev, reg, (u8 *)&stemp);
291 /* to match with what previous code does */
299 static ssize_t lis3l02dq_read_frequency(struct device *dev,
300 struct device_attribute *attr,
303 struct iio_dev *indio_dev = dev_get_drvdata(dev);
306 ret = lis3l02dq_spi_read_reg_8(indio_dev,
307 LIS3L02DQ_REG_CTRL_1_ADDR,
311 t &= LIS3L02DQ_DEC_MASK;
313 case LIS3L02DQ_REG_CTRL_1_DF_128:
314 len = sprintf(buf, "280\n");
316 case LIS3L02DQ_REG_CTRL_1_DF_64:
317 len = sprintf(buf, "560\n");
319 case LIS3L02DQ_REG_CTRL_1_DF_32:
320 len = sprintf(buf, "1120\n");
322 case LIS3L02DQ_REG_CTRL_1_DF_8:
323 len = sprintf(buf, "4480\n");
329 static ssize_t lis3l02dq_write_frequency(struct device *dev,
330 struct device_attribute *attr,
334 struct iio_dev *indio_dev = dev_get_drvdata(dev);
339 ret = strict_strtol(buf, 10, &val);
343 mutex_lock(&indio_dev->mlock);
344 ret = lis3l02dq_spi_read_reg_8(indio_dev,
345 LIS3L02DQ_REG_CTRL_1_ADDR,
348 goto error_ret_mutex;
349 /* Wipe the bits clean */
350 t &= ~LIS3L02DQ_DEC_MASK;
353 t |= LIS3L02DQ_REG_CTRL_1_DF_128;
356 t |= LIS3L02DQ_REG_CTRL_1_DF_64;
359 t |= LIS3L02DQ_REG_CTRL_1_DF_32;
362 t |= LIS3L02DQ_REG_CTRL_1_DF_8;
366 goto error_ret_mutex;
369 ret = lis3l02dq_spi_write_reg_8(indio_dev,
370 LIS3L02DQ_REG_CTRL_1_ADDR,
374 mutex_unlock(&indio_dev->mlock);
376 return ret ? ret : len;
379 static int lis3l02dq_initial_setup(struct iio_dev *indio_dev)
381 struct lis3l02dq_state *st = iio_priv(indio_dev);
385 st->us->mode = SPI_MODE_3;
389 val = LIS3L02DQ_DEFAULT_CTRL1;
390 /* Write suitable defaults to ctrl1 */
391 ret = lis3l02dq_spi_write_reg_8(indio_dev,
392 LIS3L02DQ_REG_CTRL_1_ADDR,
395 dev_err(&st->us->dev, "problem with setup control register 1");
398 /* Repeat as sometimes doesn't work first time?*/
399 ret = lis3l02dq_spi_write_reg_8(indio_dev,
400 LIS3L02DQ_REG_CTRL_1_ADDR,
403 dev_err(&st->us->dev, "problem with setup control register 1");
407 /* Read back to check this has worked acts as loose test of correct
409 ret = lis3l02dq_spi_read_reg_8(indio_dev,
410 LIS3L02DQ_REG_CTRL_1_ADDR,
412 if (ret || (valtest != val)) {
413 dev_err(&indio_dev->dev,
414 "device not playing ball %d %d\n", valtest, val);
419 val = LIS3L02DQ_DEFAULT_CTRL2;
420 ret = lis3l02dq_spi_write_reg_8(indio_dev,
421 LIS3L02DQ_REG_CTRL_2_ADDR,
424 dev_err(&st->us->dev, "problem with setup control register 2");
428 val = LIS3L02DQ_REG_WAKE_UP_CFG_LATCH_SRC;
429 ret = lis3l02dq_spi_write_reg_8(indio_dev,
430 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
433 dev_err(&st->us->dev, "problem with interrupt cfg register");
439 static IIO_DEV_ATTR_SAMP_FREQ(S_IWUSR | S_IRUGO,
440 lis3l02dq_read_frequency,
441 lis3l02dq_write_frequency);
443 static IIO_CONST_ATTR_SAMP_FREQ_AVAIL("280 560 1120 4480");
445 static irqreturn_t lis3l02dq_event_handler(int irq, void *private)
447 struct iio_dev *indio_dev = private;
450 s64 timestamp = iio_get_time_ns();
452 lis3l02dq_spi_read_reg_8(indio_dev,
453 LIS3L02DQ_REG_WAKE_UP_SRC_ADDR,
456 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_Z_HIGH)
457 iio_push_event(indio_dev,
458 IIO_MOD_EVENT_CODE(IIO_ACCEL,
465 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_Z_LOW)
466 iio_push_event(indio_dev,
467 IIO_MOD_EVENT_CODE(IIO_ACCEL,
474 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_Y_HIGH)
475 iio_push_event(indio_dev,
476 IIO_MOD_EVENT_CODE(IIO_ACCEL,
483 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_Y_LOW)
484 iio_push_event(indio_dev,
485 IIO_MOD_EVENT_CODE(IIO_ACCEL,
492 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_X_HIGH)
493 iio_push_event(indio_dev,
494 IIO_MOD_EVENT_CODE(IIO_ACCEL,
501 if (t & LIS3L02DQ_REG_WAKE_UP_SRC_INTERRUPT_X_LOW)
502 iio_push_event(indio_dev,
503 IIO_MOD_EVENT_CODE(IIO_ACCEL,
510 /* Ack and allow for new interrupts */
511 lis3l02dq_spi_read_reg_8(indio_dev,
512 LIS3L02DQ_REG_WAKE_UP_ACK_ADDR,
518 #define LIS3L02DQ_INFO_MASK \
519 ((1 << IIO_CHAN_INFO_SCALE_SHARED) | \
520 (1 << IIO_CHAN_INFO_CALIBSCALE_SEPARATE) | \
521 (1 << IIO_CHAN_INFO_CALIBBIAS_SEPARATE))
523 #define LIS3L02DQ_EVENT_MASK \
524 (IIO_EV_BIT(IIO_EV_TYPE_THRESH, IIO_EV_DIR_RISING) | \
525 IIO_EV_BIT(IIO_EV_TYPE_THRESH, IIO_EV_DIR_FALLING))
527 static struct iio_chan_spec lis3l02dq_channels[] = {
528 IIO_CHAN(IIO_ACCEL, 1, 0, 0, NULL, 0, IIO_MOD_X, LIS3L02DQ_INFO_MASK,
529 0, 0, IIO_ST('s', 12, 16, 0), LIS3L02DQ_EVENT_MASK),
530 IIO_CHAN(IIO_ACCEL, 1, 0, 0, NULL, 0, IIO_MOD_Y, LIS3L02DQ_INFO_MASK,
531 1, 1, IIO_ST('s', 12, 16, 0), LIS3L02DQ_EVENT_MASK),
532 IIO_CHAN(IIO_ACCEL, 1, 0, 0, NULL, 0, IIO_MOD_Z, LIS3L02DQ_INFO_MASK,
533 2, 2, IIO_ST('s', 12, 16, 0), LIS3L02DQ_EVENT_MASK),
534 IIO_CHAN_SOFT_TIMESTAMP(3)
538 static ssize_t lis3l02dq_read_event_config(struct iio_dev *indio_dev,
544 u8 mask = (1 << (IIO_EVENT_CODE_EXTRACT_MODIFIER(event_code)*2 +
545 (IIO_EVENT_CODE_EXTRACT_DIR(event_code) ==
546 IIO_EV_DIR_RISING)));
547 ret = lis3l02dq_spi_read_reg_8(indio_dev,
548 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
553 return !!(val & mask);
556 int lis3l02dq_disable_all_events(struct iio_dev *indio_dev)
561 ret = lis3l02dq_spi_read_reg_8(indio_dev,
562 LIS3L02DQ_REG_CTRL_2_ADDR,
565 control &= ~LIS3L02DQ_REG_CTRL_2_ENABLE_INTERRUPT;
566 ret = lis3l02dq_spi_write_reg_8(indio_dev,
567 LIS3L02DQ_REG_CTRL_2_ADDR,
571 /* Also for consistency clear the mask */
572 ret = lis3l02dq_spi_read_reg_8(indio_dev,
573 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
579 ret = lis3l02dq_spi_write_reg_8(indio_dev,
580 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
590 static int lis3l02dq_write_event_config(struct iio_dev *indio_dev,
597 bool changed = false;
598 u8 mask = (1 << (IIO_EVENT_CODE_EXTRACT_MODIFIER(event_code)*2 +
599 (IIO_EVENT_CODE_EXTRACT_DIR(event_code) ==
600 IIO_EV_DIR_RISING)));
602 mutex_lock(&indio_dev->mlock);
603 /* read current control */
604 ret = lis3l02dq_spi_read_reg_8(indio_dev,
605 LIS3L02DQ_REG_CTRL_2_ADDR,
609 ret = lis3l02dq_spi_read_reg_8(indio_dev,
610 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
614 currentlyset = val & mask;
616 if (!currentlyset && state) {
619 } else if (currentlyset && !state) {
625 ret = lis3l02dq_spi_write_reg_8(indio_dev,
626 LIS3L02DQ_REG_WAKE_UP_CFG_ADDR,
630 control = val & 0x3f ?
631 (control | LIS3L02DQ_REG_CTRL_2_ENABLE_INTERRUPT) :
632 (control & ~LIS3L02DQ_REG_CTRL_2_ENABLE_INTERRUPT);
633 ret = lis3l02dq_spi_write_reg_8(indio_dev,
634 LIS3L02DQ_REG_CTRL_2_ADDR,
641 mutex_unlock(&indio_dev->mlock);
645 static struct attribute *lis3l02dq_attributes[] = {
646 &iio_dev_attr_sampling_frequency.dev_attr.attr,
647 &iio_const_attr_sampling_frequency_available.dev_attr.attr,
651 static const struct attribute_group lis3l02dq_attribute_group = {
652 .attrs = lis3l02dq_attributes,
655 static const struct iio_info lis3l02dq_info = {
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)
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_buffer(indio_dev);
695 ret = iio_buffer_register(indio_dev,
697 ARRAY_SIZE(lis3l02dq_channels));
699 printk(KERN_ERR "failed to initialize the buffer\n");
700 goto error_unreg_buffer_funcs;
703 if (spi->irq && gpio_is_valid(irq_to_gpio(spi->irq)) > 0) {
704 ret = request_threaded_irq(st->us->irq,
706 &lis3l02dq_event_handler,
711 goto error_uninitialize_buffer;
713 ret = lis3l02dq_probe_trigger(indio_dev);
715 goto error_free_interrupt;
718 /* Get the device into a sane initial state */
719 ret = lis3l02dq_initial_setup(indio_dev);
721 goto error_remove_trigger;
723 ret = iio_device_register(indio_dev);
725 goto error_remove_trigger;
729 error_remove_trigger:
730 if (indio_dev->modes & INDIO_BUFFER_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_buffer:
736 iio_buffer_unregister(indio_dev);
737 error_unreg_buffer_funcs:
738 lis3l02dq_unconfigure_buffer(indio_dev);
740 iio_free_device(indio_dev);
745 /* Power down the device */
746 static int lis3l02dq_stop_device(struct iio_dev *indio_dev)
749 struct lis3l02dq_state *st = iio_priv(indio_dev);
752 mutex_lock(&indio_dev->mlock);
753 ret = lis3l02dq_spi_write_reg_8(indio_dev,
754 LIS3L02DQ_REG_CTRL_1_ADDR,
757 dev_err(&st->us->dev, "problem with turning device off: ctrl1");
761 ret = lis3l02dq_spi_write_reg_8(indio_dev,
762 LIS3L02DQ_REG_CTRL_2_ADDR,
765 dev_err(&st->us->dev, "problem with turning device off: ctrl2");
767 mutex_unlock(&indio_dev->mlock);
771 /* fixme, confirm ordering in this function */
772 static int lis3l02dq_remove(struct spi_device *spi)
775 struct iio_dev *indio_dev = spi_get_drvdata(spi);
776 struct lis3l02dq_state *st = iio_priv(indio_dev);
778 iio_device_unregister(indio_dev);
780 ret = lis3l02dq_disable_all_events(indio_dev);
784 ret = lis3l02dq_stop_device(indio_dev);
788 if (spi->irq && gpio_is_valid(irq_to_gpio(spi->irq)) > 0)
789 free_irq(st->us->irq, indio_dev);
791 lis3l02dq_remove_trigger(indio_dev);
792 iio_buffer_unregister(indio_dev);
793 lis3l02dq_unconfigure_buffer(indio_dev);
795 iio_free_device(indio_dev);
800 static struct spi_driver lis3l02dq_driver = {
803 .owner = THIS_MODULE,
805 .probe = lis3l02dq_probe,
806 .remove = __devexit_p(lis3l02dq_remove),
809 static __init int lis3l02dq_init(void)
811 return spi_register_driver(&lis3l02dq_driver);
813 module_init(lis3l02dq_init);
815 static __exit void lis3l02dq_exit(void)
817 spi_unregister_driver(&lis3l02dq_driver);
819 module_exit(lis3l02dq_exit);
821 MODULE_AUTHOR("Jonathan Cameron <jic23@cam.ac.uk>");
822 MODULE_DESCRIPTION("ST LIS3L02DQ Accelerometer SPI driver");
823 MODULE_LICENSE("GPL v2");