2 * sca3000_core.c -- support VTI sca3000 series accelerometers via SPI
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 as published by
6 * the Free Software Foundation.
8 * Copyright (c) 2009 Jonathan Cameron <jic23@cam.ac.uk>
10 * See industrialio/accels/sca3000.h for comments.
13 #include <linux/interrupt.h>
14 #include <linux/gpio.h>
16 #include <linux/device.h>
17 #include <linux/slab.h>
18 #include <linux/kernel.h>
19 #include <linux/spi/spi.h>
20 #include <linux/sysfs.h>
23 #include "../ring_generic.h"
28 enum sca3000_variant {
35 /* Note where option modes are not defined, the chip simply does not
37 * Other chips in the sca3000 series use i2c and are not included here.
39 * Some of these devices are only listed in the family data sheet and
40 * do not actually appear to be available.
42 static const struct sca3000_chip_info sca3000_spi_chip_info_tbl[] = {
44 .name = "sca3000-d01",
45 .scale = " 0.0073575",
47 .measurement_mode_freq = 250,
48 .option_mode_1 = SCA3000_OP_MODE_BYPASS,
49 .option_mode_1_freq = 250,
51 .name = "sca3000-e02",
53 .measurement_mode_freq = 125,
54 .option_mode_1 = SCA3000_OP_MODE_NARROW,
55 .option_mode_1_freq = 63,
57 .name = "sca3000-e04",
59 .measurement_mode_freq = 100,
60 .option_mode_1 = SCA3000_OP_MODE_NARROW,
61 .option_mode_1_freq = 50,
62 .option_mode_2 = SCA3000_OP_MODE_WIDE,
63 .option_mode_2_freq = 400,
65 .name = "sca3000-e05",
67 .measurement_mode_freq = 200,
68 .option_mode_1 = SCA3000_OP_MODE_NARROW,
69 .option_mode_1_freq = 50,
70 .option_mode_2 = SCA3000_OP_MODE_WIDE,
71 .option_mode_2_freq = 400,
76 int sca3000_write_reg(struct sca3000_state *st, u8 address, u8 val)
78 struct spi_transfer xfer = {
84 struct spi_message msg;
86 st->tx[0] = SCA3000_WRITE_REG(address);
88 spi_message_init(&msg);
89 spi_message_add_tail(&xfer, &msg);
91 return spi_sync(st->us, &msg);
94 int sca3000_read_data(struct sca3000_state *st,
95 uint8_t reg_address_high,
100 struct spi_message msg;
101 struct spi_transfer xfer = {
108 *rx_p = kmalloc(len + 1, GFP_KERNEL);
114 st->tx[0] = SCA3000_READ_REG(reg_address_high);
115 spi_message_init(&msg);
116 spi_message_add_tail(&xfer, &msg);
118 ret = spi_sync(st->us, &msg);
121 dev_err(get_device(&st->us->dev), "problem reading register");
133 * sca3000_reg_lock_on() test if the ctrl register lock is on
137 static int sca3000_reg_lock_on(struct sca3000_state *st)
142 ret = sca3000_read_data(st, SCA3000_REG_ADDR_STATUS, &rx, 1);
146 ret = !(rx[1] & SCA3000_LOCKED);
153 * __sca3000_unlock_reg_lock() unlock the control registers
155 * Note the device does not appear to support doing this in a single transfer.
156 * This should only ever be used as part of ctrl reg read.
157 * Lock must be held before calling this
159 static int __sca3000_unlock_reg_lock(struct sca3000_state *st)
161 struct spi_message msg;
162 struct spi_transfer xfer[3] = {
172 .tx_buf = st->tx + 2,
177 .tx_buf = st->tx + 4,
180 st->tx[0] = SCA3000_WRITE_REG(SCA3000_REG_ADDR_UNLOCK);
182 st->tx[2] = SCA3000_WRITE_REG(SCA3000_REG_ADDR_UNLOCK);
184 st->tx[4] = SCA3000_WRITE_REG(SCA3000_REG_ADDR_UNLOCK);
186 spi_message_init(&msg);
187 spi_message_add_tail(&xfer[0], &msg);
188 spi_message_add_tail(&xfer[1], &msg);
189 spi_message_add_tail(&xfer[2], &msg);
191 return spi_sync(st->us, &msg);
195 * sca3000_write_ctrl_reg() write to a lock protect ctrl register
196 * @sel: selects which registers we wish to write to
197 * @val: the value to be written
199 * Certain control registers are protected against overwriting by the lock
200 * register and use a shared write address. This function allows writing of
204 static int sca3000_write_ctrl_reg(struct sca3000_state *st,
211 ret = sca3000_reg_lock_on(st);
215 ret = __sca3000_unlock_reg_lock(st);
220 /* Set the control select register */
221 ret = sca3000_write_reg(st, SCA3000_REG_ADDR_CTRL_SEL, sel);
225 /* Write the actual value into the register */
226 ret = sca3000_write_reg(st, SCA3000_REG_ADDR_CTRL_DATA, val);
232 /* Crucial that lock is called before calling this */
234 * sca3000_read_ctrl_reg() read from lock protected control register.
238 static int sca3000_read_ctrl_reg(struct sca3000_state *st,
244 ret = sca3000_reg_lock_on(st);
248 ret = __sca3000_unlock_reg_lock(st);
252 /* Set the control select register */
253 ret = sca3000_write_reg(st, SCA3000_REG_ADDR_CTRL_SEL, ctrl_reg);
256 ret = sca3000_read_data(st, SCA3000_REG_ADDR_CTRL_DATA, rx_p, 1);
264 * sca3000_check_status() check the status register
266 * Only used for debugging purposes
268 static int sca3000_check_status(struct device *dev)
272 struct iio_dev *indio_dev = dev_get_drvdata(dev);
273 struct sca3000_state *st = indio_dev->dev_data;
275 mutex_lock(&st->lock);
276 ret = sca3000_read_data(st, SCA3000_REG_ADDR_STATUS, &rx, 1);
279 if (rx[1] & SCA3000_EEPROM_CS_ERROR)
280 dev_err(dev, "eeprom error\n");
281 if (rx[1] & SCA3000_SPI_FRAME_ERROR)
282 dev_err(dev, "Previous SPI Frame was corrupt\n");
286 mutex_unlock(&st->lock);
289 #endif /* SCA3000_DEBUG */
292 * sca3000_read_13bit_signed() sysfs interface to read 13 bit signed registers
294 * These are described as signed 12 bit on the data sheet, which appears
295 * to be a conventional 2's complement 13 bit.
297 static ssize_t sca3000_read_13bit_signed(struct device *dev,
298 struct device_attribute *attr,
303 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
305 struct iio_dev *indio_dev = dev_get_drvdata(dev);
306 struct sca3000_state *st = indio_dev->dev_data;
308 mutex_lock(&st->lock);
309 ret = sca3000_read_data(st, this_attr->address, &rx, 2);
312 val = sca3000_13bit_convert(rx[1], rx[2]);
313 len += sprintf(buf + len, "%d\n", val);
316 mutex_unlock(&st->lock);
318 return ret ? ret : len;
321 static ssize_t sca3000_show_scale(struct device *dev,
322 struct device_attribute *attr,
325 struct iio_dev *dev_info = dev_get_drvdata(dev);
326 struct sca3000_state *st = dev_info->dev_data;
327 return sprintf(buf, "%s\n", st->info->scale);
330 static ssize_t sca3000_show_name(struct device *dev,
331 struct device_attribute *attr,
334 struct iio_dev *dev_info = dev_get_drvdata(dev);
335 struct sca3000_state *st = dev_info->dev_data;
336 return sprintf(buf, "%s\n", st->info->name);
339 * sca3000_show_reg() - sysfs interface to read the chip revision number
341 static ssize_t sca3000_show_rev(struct device *dev,
342 struct device_attribute *attr,
346 struct iio_dev *dev_info = dev_get_drvdata(dev);
347 struct sca3000_state *st = dev_info->dev_data;
351 mutex_lock(&st->lock);
352 ret = sca3000_read_data(st, SCA3000_REG_ADDR_REVID, &rx, 1);
355 len += sprintf(buf + len,
356 "major=%d, minor=%d\n",
357 rx[1] & SCA3000_REVID_MAJOR_MASK,
358 rx[1] & SCA3000_REVID_MINOR_MASK);
362 mutex_unlock(&st->lock);
364 return ret ? ret : len;
368 * sca3000_show_available_measurement_modes() display available modes
370 * This is all read from chip specific data in the driver. Not all
371 * of the sca3000 series support modes other than normal.
374 sca3000_show_available_measurement_modes(struct device *dev,
375 struct device_attribute *attr,
378 struct iio_dev *dev_info = dev_get_drvdata(dev);
379 struct sca3000_state *st = dev_info->dev_data;
382 len += sprintf(buf + len, "0 - normal mode");
383 switch (st->info->option_mode_1) {
384 case SCA3000_OP_MODE_NARROW:
385 len += sprintf(buf + len, ", 1 - narrow mode");
387 case SCA3000_OP_MODE_BYPASS:
388 len += sprintf(buf + len, ", 1 - bypass mode");
391 switch (st->info->option_mode_2) {
392 case SCA3000_OP_MODE_WIDE:
393 len += sprintf(buf + len, ", 2 - wide mode");
396 /* always supported */
397 len += sprintf(buf + len, " 3 - motion detection\n");
403 * sca3000_show_measurmenet_mode() sysfs read of current mode
406 sca3000_show_measurement_mode(struct device *dev,
407 struct device_attribute *attr,
410 struct iio_dev *dev_info = dev_get_drvdata(dev);
411 struct sca3000_state *st = dev_info->dev_data;
415 mutex_lock(&st->lock);
416 ret = sca3000_read_data(st, SCA3000_REG_ADDR_MODE, &rx, 1);
419 /* mask bottom 2 bits - only ones that are relevant */
422 case SCA3000_MEAS_MODE_NORMAL:
423 len += sprintf(buf + len, "0 - normal mode\n");
425 case SCA3000_MEAS_MODE_MOT_DET:
426 len += sprintf(buf + len, "3 - motion detection\n");
428 case SCA3000_MEAS_MODE_OP_1:
429 switch (st->info->option_mode_1) {
430 case SCA3000_OP_MODE_NARROW:
431 len += sprintf(buf + len, "1 - narrow mode\n");
433 case SCA3000_OP_MODE_BYPASS:
434 len += sprintf(buf + len, "1 - bypass mode\n");
438 case SCA3000_MEAS_MODE_OP_2:
439 switch (st->info->option_mode_2) {
440 case SCA3000_OP_MODE_WIDE:
441 len += sprintf(buf + len, "2 - wide mode\n");
448 mutex_unlock(&st->lock);
450 return ret ? ret : len;
454 * sca3000_store_measurement_mode() set the current mode
457 sca3000_store_measurement_mode(struct device *dev,
458 struct device_attribute *attr,
462 struct iio_dev *dev_info = dev_get_drvdata(dev);
463 struct sca3000_state *st = dev_info->dev_data;
469 mutex_lock(&st->lock);
470 ret = strict_strtol(buf, 10, &val);
473 ret = sca3000_read_data(st, SCA3000_REG_ADDR_MODE, &rx, 1);
477 rx[1] |= (val & mask);
478 ret = sca3000_write_reg(st, SCA3000_REG_ADDR_MODE, rx[1]);
481 mutex_unlock(&st->lock);
488 mutex_unlock(&st->lock);
494 /* Not even vaguely standard attributes so defined here rather than
495 * in the relevant IIO core headers
497 static IIO_DEVICE_ATTR(measurement_mode_available, S_IRUGO,
498 sca3000_show_available_measurement_modes,
501 static IIO_DEVICE_ATTR(measurement_mode, S_IRUGO | S_IWUSR,
502 sca3000_show_measurement_mode,
503 sca3000_store_measurement_mode,
506 /* More standard attributes */
508 static IIO_DEV_ATTR_NAME(sca3000_show_name);
509 static IIO_DEV_ATTR_REV(sca3000_show_rev);
510 static IIO_DEVICE_ATTR(accel_scale, S_IRUGO, sca3000_show_scale,
513 static IIO_DEV_ATTR_ACCEL_X(sca3000_read_13bit_signed,
514 SCA3000_REG_ADDR_X_MSB);
515 static IIO_DEV_ATTR_ACCEL_Y(sca3000_read_13bit_signed,
516 SCA3000_REG_ADDR_Y_MSB);
517 static IIO_DEV_ATTR_ACCEL_Z(sca3000_read_13bit_signed,
518 SCA3000_REG_ADDR_Z_MSB);
522 * sca3000_read_av_freq() sysfs function to get available frequencies
524 * The later modes are only relevant to the ring buffer - and depend on current
525 * mode. Note that data sheet gives rather wide tolerances for these so integer
526 * division will give good enough answer and not all chips have them specified
529 static ssize_t sca3000_read_av_freq(struct device *dev,
530 struct device_attribute *attr,
533 struct iio_dev *indio_dev = dev_get_drvdata(dev);
534 struct sca3000_state *st = indio_dev->dev_data;
537 mutex_lock(&st->lock);
538 ret = sca3000_read_data(st, SCA3000_REG_ADDR_MODE, &rx, 1);
539 mutex_unlock(&st->lock);
544 case SCA3000_MEAS_MODE_NORMAL:
545 len += sprintf(buf + len, "%d %d %d\n",
546 st->info->measurement_mode_freq,
547 st->info->measurement_mode_freq/2,
548 st->info->measurement_mode_freq/4);
550 case SCA3000_MEAS_MODE_OP_1:
551 len += sprintf(buf + len, "%d %d %d\n",
552 st->info->option_mode_1_freq,
553 st->info->option_mode_1_freq/2,
554 st->info->option_mode_1_freq/4);
556 case SCA3000_MEAS_MODE_OP_2:
557 len += sprintf(buf + len, "%d %d %d\n",
558 st->info->option_mode_2_freq,
559 st->info->option_mode_2_freq/2,
560 st->info->option_mode_2_freq/4);
569 * __sca3000_get_base_frequency() obtain mode specific base frequency
573 static inline int __sca3000_get_base_freq(struct sca3000_state *st,
574 const struct sca3000_chip_info *info,
580 ret = sca3000_read_data(st, SCA3000_REG_ADDR_MODE, &rx, 1);
583 switch (0x03 & rx[1]) {
584 case SCA3000_MEAS_MODE_NORMAL:
585 *base_freq = info->measurement_mode_freq;
587 case SCA3000_MEAS_MODE_OP_1:
588 *base_freq = info->option_mode_1_freq;
590 case SCA3000_MEAS_MODE_OP_2:
591 *base_freq = info->option_mode_2_freq;
600 * sca3000_read_frequency() sysfs interface to get the current frequency
602 static ssize_t sca3000_read_frequency(struct device *dev,
603 struct device_attribute *attr,
606 struct iio_dev *indio_dev = dev_get_drvdata(dev);
607 struct sca3000_state *st = indio_dev->dev_data;
608 int ret, len = 0, base_freq = 0;
610 mutex_lock(&st->lock);
611 ret = __sca3000_get_base_freq(st, st->info, &base_freq);
614 ret = sca3000_read_ctrl_reg(st, SCA3000_REG_CTRL_SEL_OUT_CTRL, &rx);
615 mutex_unlock(&st->lock);
619 switch (rx[1]&0x03) {
622 len = sprintf(buf, "%d\n", base_freq);
625 len = sprintf(buf, "%d\n", base_freq/2);
628 len = sprintf(buf, "%d\n", base_freq/4);
634 mutex_unlock(&st->lock);
640 * sca3000_set_frequency() sysfs interface to set the current frequency
642 static ssize_t sca3000_set_frequency(struct device *dev,
643 struct device_attribute *attr,
647 struct iio_dev *indio_dev = dev_get_drvdata(dev);
648 struct sca3000_state *st = indio_dev->dev_data;
649 int ret, base_freq = 0;
653 ret = strict_strtol(buf, 10, &val);
657 mutex_lock(&st->lock);
658 /* What mode are we in? */
659 ret = __sca3000_get_base_freq(st, st->info, &base_freq);
661 goto error_free_lock;
663 ret = sca3000_read_ctrl_reg(st, SCA3000_REG_CTRL_SEL_OUT_CTRL, &rx);
665 goto error_free_lock;
669 if (val == base_freq/2) {
670 rx[1] |= SCA3000_OUT_CTRL_BUF_DIV_2;
671 } else if (val == base_freq/4) {
672 rx[1] |= SCA3000_OUT_CTRL_BUF_DIV_4;
673 } else if (val != base_freq) {
675 goto error_free_lock;
677 ret = sca3000_write_ctrl_reg(st, SCA3000_REG_CTRL_SEL_OUT_CTRL, rx[1]);
679 mutex_unlock(&st->lock);
681 return ret ? ret : len;
684 /* Should only really be registered if ring buffer support is compiled in.
685 * Does no harm however and doing it right would add a fair bit of complexity
687 static IIO_DEV_ATTR_SAMP_FREQ_AVAIL(sca3000_read_av_freq);
689 static IIO_DEV_ATTR_SAMP_FREQ(S_IWUSR | S_IRUGO,
690 sca3000_read_frequency,
691 sca3000_set_frequency);
695 * sca3000_read_temp() sysfs interface to get the temperature when available
697 * The alignment of data in here is downright odd. See data sheet.
698 * Converting this into a meaningful value is left to inline functions in
699 * userspace part of header.
701 static ssize_t sca3000_read_temp(struct device *dev,
702 struct device_attribute *attr,
705 struct iio_dev *indio_dev = dev_get_drvdata(dev);
706 struct sca3000_state *st = indio_dev->dev_data;
710 ret = sca3000_read_data(st, SCA3000_REG_ADDR_TEMP_MSB, &rx, 2);
713 val = ((rx[1]&0x3F) << 3) | ((rx[2] & 0xE0) >> 5);
714 len += sprintf(buf + len, "%d\n", val);
722 static IIO_DEV_ATTR_TEMP_RAW(sca3000_read_temp);
724 static IIO_CONST_ATTR(temp_scale, "0.555556");
725 static IIO_CONST_ATTR(temp_offset, "-214.6");
728 * sca3000_show_thresh() sysfs query of a threshold
730 static ssize_t sca3000_show_thresh(struct device *dev,
731 struct device_attribute *attr,
734 struct iio_dev *indio_dev = dev_get_drvdata(dev);
735 struct sca3000_state *st = indio_dev->dev_data;
736 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
740 mutex_lock(&st->lock);
741 ret = sca3000_read_ctrl_reg(st,
744 mutex_unlock(&st->lock);
747 len += sprintf(buf + len, "%d\n", rx[1]);
754 * sca3000_write_thresh() sysfs control of threshold
756 static ssize_t sca3000_write_thresh(struct device *dev,
757 struct device_attribute *attr,
761 struct iio_dev *indio_dev = dev_get_drvdata(dev);
762 struct sca3000_state *st = indio_dev->dev_data;
763 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
767 ret = strict_strtol(buf, 10, &val);
770 mutex_lock(&st->lock);
771 ret = sca3000_write_ctrl_reg(st, this_attr->address, val);
772 mutex_unlock(&st->lock);
774 return ret ? ret : len;
777 static IIO_DEVICE_ATTR(accel_x_mag_either_rising_value,
780 sca3000_write_thresh,
781 SCA3000_REG_CTRL_SEL_MD_X_TH);
783 static IIO_DEVICE_ATTR(accel_y_mag_either_rising_value,
786 sca3000_write_thresh,
787 SCA3000_REG_CTRL_SEL_MD_Y_TH);
789 static IIO_DEVICE_ATTR(accel_z_mag_either_rising_value,
792 sca3000_write_thresh,
793 SCA3000_REG_CTRL_SEL_MD_Z_TH);
795 static struct attribute *sca3000_attributes[] = {
796 &iio_dev_attr_name.dev_attr.attr,
797 &iio_dev_attr_revision.dev_attr.attr,
798 &iio_dev_attr_accel_scale.dev_attr.attr,
799 &iio_dev_attr_accel_x_raw.dev_attr.attr,
800 &iio_dev_attr_accel_y_raw.dev_attr.attr,
801 &iio_dev_attr_accel_z_raw.dev_attr.attr,
802 &iio_dev_attr_measurement_mode_available.dev_attr.attr,
803 &iio_dev_attr_measurement_mode.dev_attr.attr,
804 &iio_dev_attr_sampling_frequency_available.dev_attr.attr,
805 &iio_dev_attr_sampling_frequency.dev_attr.attr,
809 static struct attribute *sca3000_attributes_with_temp[] = {
810 &iio_dev_attr_name.dev_attr.attr,
811 &iio_dev_attr_revision.dev_attr.attr,
812 &iio_dev_attr_accel_scale.dev_attr.attr,
813 &iio_dev_attr_accel_x_raw.dev_attr.attr,
814 &iio_dev_attr_accel_y_raw.dev_attr.attr,
815 &iio_dev_attr_accel_z_raw.dev_attr.attr,
816 &iio_dev_attr_measurement_mode_available.dev_attr.attr,
817 &iio_dev_attr_measurement_mode.dev_attr.attr,
818 &iio_dev_attr_sampling_frequency_available.dev_attr.attr,
819 &iio_dev_attr_sampling_frequency.dev_attr.attr,
820 /* Only present if temp sensor is */
821 &iio_dev_attr_temp_raw.dev_attr.attr,
822 &iio_const_attr_temp_offset.dev_attr.attr,
823 &iio_const_attr_temp_scale.dev_attr.attr,
827 static const struct attribute_group sca3000_attribute_group = {
828 .attrs = sca3000_attributes,
831 static const struct attribute_group sca3000_attribute_group_with_temp = {
832 .attrs = sca3000_attributes_with_temp,
835 /* RING RELATED interrupt handler */
836 /* depending on event, push to the ring buffer event chrdev or the event one */
839 * sca3000_interrupt_handler_bh() - handling ring and non ring events
841 * This function is complicated by the fact that the devices can signify ring
842 * and non ring events via the same interrupt line and they can only
843 * be distinguished via a read of the relevant status register.
845 static void sca3000_interrupt_handler_bh(struct work_struct *work_s)
847 struct sca3000_state *st
848 = container_of(work_s, struct sca3000_state,
849 interrupt_handler_ws);
853 /* Could lead if badly timed to an extra read of status reg,
854 * but ensures no interrupt is missed.
856 enable_irq(st->us->irq);
857 mutex_lock(&st->lock);
858 ret = sca3000_read_data(st, SCA3000_REG_ADDR_INT_STATUS,
860 mutex_unlock(&st->lock);
864 sca3000_ring_int_process(rx[1], st->indio_dev->ring);
866 if (rx[1] & SCA3000_INT_STATUS_FREE_FALL)
867 iio_push_event(st->indio_dev, 0,
868 IIO_EVENT_CODE_FREE_FALL,
871 if (rx[1] & SCA3000_INT_STATUS_Y_TRIGGER)
872 iio_push_event(st->indio_dev, 0,
873 IIO_EVENT_CODE_ACCEL_Y_HIGH,
876 if (rx[1] & SCA3000_INT_STATUS_X_TRIGGER)
877 iio_push_event(st->indio_dev, 0,
878 IIO_EVENT_CODE_ACCEL_X_HIGH,
881 if (rx[1] & SCA3000_INT_STATUS_Z_TRIGGER)
882 iio_push_event(st->indio_dev, 0,
883 IIO_EVENT_CODE_ACCEL_Z_HIGH,
892 * sca3000_handler_th() handles all interrupt events from device
894 * These devices deploy unified interrupt status registers meaning
895 * all interrupts must be handled together
897 static int sca3000_handler_th(struct iio_dev *dev_info,
902 struct sca3000_state *st = dev_info->dev_data;
904 st->last_timestamp = timestamp;
905 schedule_work(&st->interrupt_handler_ws);
911 * sca3000_query_mo_det() is motion detection enabled for this axis
913 * First queries if motion detection is enabled and then if this axis is
916 static ssize_t sca3000_query_mo_det(struct device *dev,
917 struct device_attribute *attr,
920 struct iio_dev *indio_dev = dev_get_drvdata(dev->parent);
921 struct sca3000_state *st = indio_dev->dev_data;
922 struct iio_event_attr *this_attr = to_iio_event_attr(attr);
925 u8 protect_mask = 0x03;
927 /* read current value of mode register */
928 mutex_lock(&st->lock);
929 ret = sca3000_read_data(st, SCA3000_REG_ADDR_MODE, &rx, 1);
933 if ((rx[1]&protect_mask) != SCA3000_MEAS_MODE_MOT_DET)
934 len += sprintf(buf + len, "0\n");
937 ret = sca3000_read_ctrl_reg(st,
938 SCA3000_REG_CTRL_SEL_MD_CTRL,
942 /* only supporting logical or's for now */
943 len += sprintf(buf + len, "%d\n",
944 (rx[1] & this_attr->mask) ? 1 : 0);
948 mutex_unlock(&st->lock);
950 return ret ? ret : len;
953 * sca3000_query_free_fall_mode() is free fall mode enabled
955 static ssize_t sca3000_query_free_fall_mode(struct device *dev,
956 struct device_attribute *attr,
961 struct iio_dev *indio_dev = dev_get_drvdata(dev);
962 struct sca3000_state *st = indio_dev->dev_data;
964 mutex_lock(&st->lock);
965 ret = sca3000_read_data(st, SCA3000_REG_ADDR_MODE, &rx, 1);
966 mutex_unlock(&st->lock);
969 len = sprintf(buf, "%d\n",
970 !!(rx[1] & SCA3000_FREE_FALL_DETECT));
976 * sca3000_query_ring_int() is the hardware ring status interrupt enabled
978 static ssize_t sca3000_query_ring_int(struct device *dev,
979 struct device_attribute *attr,
982 struct iio_event_attr *this_attr = to_iio_event_attr(attr);
985 struct iio_dev *indio_dev = dev_get_drvdata(dev->parent);
986 struct sca3000_state *st = indio_dev->dev_data;
987 mutex_lock(&st->lock);
988 ret = sca3000_read_data(st, SCA3000_REG_ADDR_INT_MASK, &rx, 1);
989 mutex_unlock(&st->lock);
992 len = sprintf(buf, "%d\n", (rx[1] & this_attr->mask) ? 1 : 0);
998 * sca3000_set_ring_int() set state of ring status interrupt
1000 static ssize_t sca3000_set_ring_int(struct device *dev,
1001 struct device_attribute *attr,
1005 struct iio_dev *indio_dev = dev_get_drvdata(dev->parent);
1006 struct sca3000_state *st = indio_dev->dev_data;
1007 struct iio_event_attr *this_attr = to_iio_event_attr(attr);
1013 mutex_lock(&st->lock);
1014 ret = strict_strtol(buf, 10, &val);
1017 ret = sca3000_read_data(st, SCA3000_REG_ADDR_INT_MASK, &rx, 1);
1021 ret = sca3000_write_reg(st,
1022 SCA3000_REG_ADDR_INT_MASK,
1023 rx[1] | this_attr->mask);
1025 ret = sca3000_write_reg(st,
1026 SCA3000_REG_ADDR_INT_MASK,
1027 rx[1] & ~this_attr->mask);
1030 mutex_unlock(&st->lock);
1032 return ret ? ret : len;
1036 * sca3000_set_free_fall_mode() simple on off control for free fall int
1038 * In these chips the free fall detector should send an interrupt if
1039 * the device falls more than 25cm. This has not been tested due
1040 * to fragile wiring.
1043 static ssize_t sca3000_set_free_fall_mode(struct device *dev,
1044 struct device_attribute *attr,
1048 struct iio_dev *indio_dev = dev_get_drvdata(dev);
1049 struct sca3000_state *st = indio_dev->dev_data;
1053 u8 protect_mask = SCA3000_FREE_FALL_DETECT;
1055 mutex_lock(&st->lock);
1056 ret = strict_strtol(buf, 10, &val);
1060 /* read current value of mode register */
1061 ret = sca3000_read_data(st, SCA3000_REG_ADDR_MODE, &rx, 1);
1065 /*if off and should be on*/
1066 if (val && !(rx[1] & protect_mask))
1067 ret = sca3000_write_reg(st, SCA3000_REG_ADDR_MODE,
1068 (rx[1] | SCA3000_FREE_FALL_DETECT));
1069 /* if on and should be off */
1070 else if (!val && (rx[1]&protect_mask))
1071 ret = sca3000_write_reg(st, SCA3000_REG_ADDR_MODE,
1072 (rx[1] & ~protect_mask));
1076 mutex_unlock(&st->lock);
1078 return ret ? ret : len;
1082 * sca3000_set_mo_det() simple on off control for motion detector
1084 * This is a per axis control, but enabling any will result in the
1085 * motion detector unit being enabled.
1086 * N.B. enabling motion detector stops normal data acquisition.
1087 * There is a complexity in knowing which mode to return to when
1088 * this mode is disabled. Currently normal mode is assumed.
1090 static ssize_t sca3000_set_mo_det(struct device *dev,
1091 struct device_attribute *attr,
1095 struct iio_dev *indio_dev = dev_get_drvdata(dev->parent);
1096 struct sca3000_state *st = indio_dev->dev_data;
1097 struct iio_event_attr *this_attr = to_iio_event_attr(attr);
1101 u8 protect_mask = 0x03;
1102 ret = strict_strtol(buf, 10, &val);
1106 mutex_lock(&st->lock);
1107 /* First read the motion detector config to find out if
1109 ret = sca3000_read_ctrl_reg(st,
1110 SCA3000_REG_CTRL_SEL_MD_CTRL,
1114 /* Off and should be on */
1115 if (val && !(rx[1] & this_attr->mask)) {
1116 ret = sca3000_write_ctrl_reg(st,
1117 SCA3000_REG_CTRL_SEL_MD_CTRL,
1118 rx[1] | this_attr->mask);
1120 goto exit_point_free_rx;
1121 st->mo_det_use_count++;
1122 } else if (!val && (rx[1]&this_attr->mask)) {
1123 ret = sca3000_write_ctrl_reg(st,
1124 SCA3000_REG_CTRL_SEL_MD_CTRL,
1125 rx[1] & ~(this_attr->mask));
1127 goto exit_point_free_rx;
1128 st->mo_det_use_count--;
1129 } else /* relies on clean state for device on boot */
1130 goto exit_point_free_rx;
1132 /* read current value of mode register */
1133 ret = sca3000_read_data(st, SCA3000_REG_ADDR_MODE, &rx, 1);
1136 /*if off and should be on*/
1137 if ((st->mo_det_use_count)
1138 && ((rx[1]&protect_mask) != SCA3000_MEAS_MODE_MOT_DET))
1139 ret = sca3000_write_reg(st, SCA3000_REG_ADDR_MODE,
1140 (rx[1] & ~protect_mask)
1141 | SCA3000_MEAS_MODE_MOT_DET);
1142 /* if on and should be off */
1143 else if (!(st->mo_det_use_count)
1144 && ((rx[1]&protect_mask) == SCA3000_MEAS_MODE_MOT_DET))
1145 ret = sca3000_write_reg(st, SCA3000_REG_ADDR_MODE,
1146 (rx[1] & ~protect_mask));
1150 mutex_unlock(&st->lock);
1152 return ret ? ret : len;
1155 /* Shared event handler for all events as single event status register */
1156 IIO_EVENT_SH(all, &sca3000_handler_th);
1158 /* Free fall detector related event attribute */
1159 IIO_EVENT_ATTR_FREE_FALL_DETECT_SH(iio_event_all,
1160 sca3000_query_free_fall_mode,
1161 sca3000_set_free_fall_mode,
1164 /* Motion detector related event attributes */
1165 IIO_EVENT_ATTR_SH(accel_x_mag_either_rising_en,
1167 sca3000_query_mo_det,
1169 SCA3000_MD_CTRL_OR_X);
1171 IIO_EVENT_ATTR_SH(accel_y_mag_either_rising_en,
1173 sca3000_query_mo_det,
1175 SCA3000_MD_CTRL_OR_Y);
1177 IIO_EVENT_ATTR_SH(accel_z_mag_either_rising_en,
1179 sca3000_query_mo_det,
1181 SCA3000_MD_CTRL_OR_Z);
1183 /* Hardware ring buffer related event attributes */
1184 IIO_EVENT_ATTR_RING_50_FULL_SH(iio_event_all,
1185 sca3000_query_ring_int,
1186 sca3000_set_ring_int,
1187 SCA3000_INT_MASK_RING_HALF);
1189 IIO_EVENT_ATTR_RING_75_FULL_SH(iio_event_all,
1190 sca3000_query_ring_int,
1191 sca3000_set_ring_int,
1192 SCA3000_INT_MASK_RING_THREE_QUARTER);
1194 static struct attribute *sca3000_event_attributes[] = {
1195 &iio_event_attr_free_fall.dev_attr.attr,
1196 &iio_event_attr_accel_x_mag_either_rising_en.dev_attr.attr,
1197 &iio_event_attr_accel_y_mag_either_rising_en.dev_attr.attr,
1198 &iio_event_attr_accel_z_mag_either_rising_en.dev_attr.attr,
1199 &iio_event_attr_ring_50_full.dev_attr.attr,
1200 &iio_event_attr_ring_75_full.dev_attr.attr,
1201 &iio_dev_attr_accel_x_mag_either_rising_value.dev_attr.attr,
1202 &iio_dev_attr_accel_y_mag_either_rising_value.dev_attr.attr,
1203 &iio_dev_attr_accel_z_mag_either_rising_value.dev_attr.attr,
1207 static struct attribute_group sca3000_event_attribute_group = {
1208 .attrs = sca3000_event_attributes,
1212 * sca3000_clean_setup() get the device into a predictable state
1214 * Devices use flash memory to store many of the register values
1215 * and hence can come up in somewhat unpredictable states.
1216 * Hence reset everything on driver load.
1218 static int sca3000_clean_setup(struct sca3000_state *st)
1223 mutex_lock(&st->lock);
1224 /* Ensure all interrupts have been acknowledged */
1225 ret = sca3000_read_data(st, SCA3000_REG_ADDR_INT_STATUS, &rx, 1);
1230 /* Turn off all motion detection channels */
1231 ret = sca3000_read_ctrl_reg(st,
1232 SCA3000_REG_CTRL_SEL_MD_CTRL,
1236 ret = sca3000_write_ctrl_reg(st,
1237 SCA3000_REG_CTRL_SEL_MD_CTRL,
1238 rx[1] & SCA3000_MD_CTRL_PROT_MASK);
1243 /* Disable ring buffer */
1244 sca3000_read_ctrl_reg(st,
1245 SCA3000_REG_CTRL_SEL_OUT_CTRL,
1247 /* Frequency of ring buffer sampling deliberately restricted to make
1248 * debugging easier - add control of this later */
1249 ret = sca3000_write_ctrl_reg(st,
1250 SCA3000_REG_CTRL_SEL_OUT_CTRL,
1251 (rx[1] & SCA3000_OUT_CTRL_PROT_MASK)
1252 | SCA3000_OUT_CTRL_BUF_X_EN
1253 | SCA3000_OUT_CTRL_BUF_Y_EN
1254 | SCA3000_OUT_CTRL_BUF_Z_EN
1255 | SCA3000_OUT_CTRL_BUF_DIV_4);
1260 /* Enable interrupts, relevant to mode and set up as active low */
1261 ret = sca3000_read_data(st,
1262 SCA3000_REG_ADDR_INT_MASK,
1266 ret = sca3000_write_reg(st,
1267 SCA3000_REG_ADDR_INT_MASK,
1268 (rx[1] & SCA3000_INT_MASK_PROT_MASK)
1269 | SCA3000_INT_MASK_ACTIVE_LOW);
1273 /* Select normal measurement mode, free fall off, ring off */
1274 /* Ring in 12 bit mode - it is fine to overwrite reserved bits 3,5
1275 * as that occurs in one of the example on the datasheet */
1276 ret = sca3000_read_data(st,
1277 SCA3000_REG_ADDR_MODE,
1281 ret = sca3000_write_reg(st,
1282 SCA3000_REG_ADDR_MODE,
1283 (rx[1] & SCA3000_MODE_PROT_MASK));
1288 mutex_unlock(&st->lock);
1292 static int __devinit __sca3000_probe(struct spi_device *spi,
1293 enum sca3000_variant variant)
1295 int ret, regdone = 0;
1296 struct sca3000_state *st;
1298 st = kzalloc(sizeof(struct sca3000_state), GFP_KERNEL);
1303 spi_set_drvdata(spi, st);
1305 st->tx = kmalloc(sizeof(*st->tx)*6, GFP_KERNEL);
1306 if (st->tx == NULL) {
1308 goto error_clear_st;
1310 st->rx = kmalloc(sizeof(*st->rx)*3, GFP_KERNEL);
1311 if (st->rx == NULL) {
1316 mutex_init(&st->lock);
1317 st->info = &sca3000_spi_chip_info_tbl[variant];
1319 st->indio_dev = iio_allocate_device();
1320 if (st->indio_dev == NULL) {
1325 st->indio_dev->dev.parent = &spi->dev;
1326 st->indio_dev->num_interrupt_lines = 1;
1327 st->indio_dev->event_attrs = &sca3000_event_attribute_group;
1328 if (st->info->temp_output)
1329 st->indio_dev->attrs = &sca3000_attribute_group_with_temp;
1331 st->indio_dev->attrs = &sca3000_attribute_group;
1332 st->indio_dev->dev_data = (void *)(st);
1333 st->indio_dev->modes = INDIO_DIRECT_MODE;
1335 sca3000_configure_ring(st->indio_dev);
1337 ret = iio_device_register(st->indio_dev);
1339 goto error_free_dev;
1341 ret = iio_ring_buffer_register(st->indio_dev->ring, 0);
1343 goto error_unregister_dev;
1344 if (spi->irq && gpio_is_valid(irq_to_gpio(spi->irq)) > 0) {
1345 INIT_WORK(&st->interrupt_handler_ws,
1346 sca3000_interrupt_handler_bh);
1347 ret = iio_register_interrupt_line(spi->irq,
1350 IRQF_TRIGGER_FALLING,
1353 goto error_unregister_ring;
1355 * Probably a common situation. All interrupts need an ack
1356 * and there is only one handler so the complicated list system
1357 * is overkill. At very least a simpler registration method
1358 * might be worthwhile.
1360 iio_add_event_to_list(
1361 iio_event_attr_accel_z_mag_either_rising_en.listel,
1363 ->interrupts[0]->ev_list);
1365 sca3000_register_ring_funcs(st->indio_dev);
1366 ret = sca3000_clean_setup(st);
1368 goto error_unregister_interrupt_line;
1371 error_unregister_interrupt_line:
1372 if (spi->irq && gpio_is_valid(irq_to_gpio(spi->irq)) > 0)
1373 iio_unregister_interrupt_line(st->indio_dev, 0);
1374 error_unregister_ring:
1375 iio_ring_buffer_unregister(st->indio_dev->ring);
1376 error_unregister_dev:
1379 iio_device_unregister(st->indio_dev);
1381 iio_free_device(st->indio_dev);
1392 static int sca3000_stop_all_interrupts(struct sca3000_state *st)
1397 mutex_lock(&st->lock);
1398 ret = sca3000_read_data(st, SCA3000_REG_ADDR_INT_MASK, &rx, 1);
1401 ret = sca3000_write_reg(st, SCA3000_REG_ADDR_INT_MASK,
1402 (rx[1] & ~(SCA3000_INT_MASK_RING_THREE_QUARTER
1403 | SCA3000_INT_MASK_RING_HALF
1404 | SCA3000_INT_MASK_ALL_INTS)));
1411 static int sca3000_remove(struct spi_device *spi)
1413 struct sca3000_state *st = spi_get_drvdata(spi);
1414 struct iio_dev *indio_dev = st->indio_dev;
1416 /* Must ensure no interrupts can be generated after this!*/
1417 ret = sca3000_stop_all_interrupts(st);
1420 if (spi->irq && gpio_is_valid(irq_to_gpio(spi->irq)) > 0)
1421 iio_unregister_interrupt_line(indio_dev, 0);
1422 iio_ring_buffer_unregister(indio_dev->ring);
1423 sca3000_unconfigure_ring(indio_dev);
1424 iio_device_unregister(indio_dev);
1433 /* These macros save on an awful lot of repeated code */
1434 #define SCA3000_VARIANT_PROBE(_name) \
1435 static int __devinit \
1436 sca3000_##_name##_probe(struct spi_device *spi) \
1438 return __sca3000_probe(spi, _name); \
1441 #define SCA3000_VARIANT_SPI_DRIVER(_name) \
1442 struct spi_driver sca3000_##_name##_driver = { \
1444 .name = "sca3000_" #_name, \
1445 .owner = THIS_MODULE, \
1447 .probe = sca3000_##_name##_probe, \
1448 .remove = __devexit_p(sca3000_remove), \
1451 SCA3000_VARIANT_PROBE(d01);
1452 static SCA3000_VARIANT_SPI_DRIVER(d01);
1454 SCA3000_VARIANT_PROBE(e02);
1455 static SCA3000_VARIANT_SPI_DRIVER(e02);
1457 SCA3000_VARIANT_PROBE(e04);
1458 static SCA3000_VARIANT_SPI_DRIVER(e04);
1460 SCA3000_VARIANT_PROBE(e05);
1461 static SCA3000_VARIANT_SPI_DRIVER(e05);
1463 static __init int sca3000_init(void)
1467 ret = spi_register_driver(&sca3000_d01_driver);
1470 ret = spi_register_driver(&sca3000_e02_driver);
1472 goto error_unreg_d01;
1473 ret = spi_register_driver(&sca3000_e04_driver);
1475 goto error_unreg_e02;
1476 ret = spi_register_driver(&sca3000_e05_driver);
1478 goto error_unreg_e04;
1483 spi_unregister_driver(&sca3000_e04_driver);
1485 spi_unregister_driver(&sca3000_e02_driver);
1487 spi_unregister_driver(&sca3000_d01_driver);
1493 static __exit void sca3000_exit(void)
1495 spi_unregister_driver(&sca3000_e05_driver);
1496 spi_unregister_driver(&sca3000_e04_driver);
1497 spi_unregister_driver(&sca3000_e02_driver);
1498 spi_unregister_driver(&sca3000_d01_driver);
1501 module_init(sca3000_init);
1502 module_exit(sca3000_exit);
1504 MODULE_AUTHOR("Jonathan Cameron <jic23@cam.ac.uk>");
1505 MODULE_DESCRIPTION("VTI SCA3000 Series Accelerometers SPI driver");
1506 MODULE_LICENSE("GPL v2");