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
[] = {
46 .measurement_mode_freq
= 250,
47 .option_mode_1
= SCA3000_OP_MODE_BYPASS
,
48 .option_mode_1_freq
= 250,
49 .mot_det_mult_xz
= {50, 100, 200, 350, 650, 1300},
50 .mot_det_mult_y
= {50, 100, 150, 250, 450, 850, 1750},
54 .measurement_mode_freq
= 125,
55 .option_mode_1
= SCA3000_OP_MODE_NARROW
,
56 .option_mode_1_freq
= 63,
57 .mot_det_mult_xz
= {100, 150, 300, 550, 1050, 2050},
58 .mot_det_mult_y
= {50, 100, 200, 350, 700, 1350, 2700},
62 .measurement_mode_freq
= 100,
63 .option_mode_1
= SCA3000_OP_MODE_NARROW
,
64 .option_mode_1_freq
= 50,
65 .option_mode_2
= SCA3000_OP_MODE_WIDE
,
66 .option_mode_2_freq
= 400,
67 .mot_det_mult_xz
= {200, 300, 600, 1100, 2100, 4100},
68 .mot_det_mult_y
= {100, 200, 400, 7000, 1400, 2700, 54000},
72 .measurement_mode_freq
= 200,
73 .option_mode_1
= SCA3000_OP_MODE_NARROW
,
74 .option_mode_1_freq
= 50,
75 .option_mode_2
= SCA3000_OP_MODE_WIDE
,
76 .option_mode_2_freq
= 400,
77 .mot_det_mult_xz
= {600, 900, 1700, 3200, 6100, 11900},
78 .mot_det_mult_y
= {300, 600, 1200, 2000, 4100, 7800, 15600},
82 int sca3000_write_reg(struct sca3000_state
*st
, u8 address
, u8 val
)
84 st
->tx
[0] = SCA3000_WRITE_REG(address
);
86 return spi_write(st
->us
, st
->tx
, 2);
89 int sca3000_read_data_short(struct sca3000_state
*st
,
90 uint8_t reg_address_high
,
93 struct spi_message msg
;
94 struct spi_transfer xfer
[2] = {
103 st
->tx
[0] = SCA3000_READ_REG(reg_address_high
);
104 spi_message_init(&msg
);
105 spi_message_add_tail(&xfer
[0], &msg
);
106 spi_message_add_tail(&xfer
[1], &msg
);
108 return spi_sync(st
->us
, &msg
);
112 * sca3000_reg_lock_on() test if the ctrl register lock is on
116 static int sca3000_reg_lock_on(struct sca3000_state
*st
)
120 ret
= sca3000_read_data_short(st
, SCA3000_REG_ADDR_STATUS
, 1);
124 return !(st
->rx
[0] & SCA3000_LOCKED
);
128 * __sca3000_unlock_reg_lock() unlock the control registers
130 * Note the device does not appear to support doing this in a single transfer.
131 * This should only ever be used as part of ctrl reg read.
132 * Lock must be held before calling this
134 static int __sca3000_unlock_reg_lock(struct sca3000_state
*st
)
136 struct spi_message msg
;
137 struct spi_transfer xfer
[3] = {
145 .tx_buf
= st
->tx
+ 2,
148 .tx_buf
= st
->tx
+ 4,
151 st
->tx
[0] = SCA3000_WRITE_REG(SCA3000_REG_ADDR_UNLOCK
);
153 st
->tx
[2] = SCA3000_WRITE_REG(SCA3000_REG_ADDR_UNLOCK
);
155 st
->tx
[4] = SCA3000_WRITE_REG(SCA3000_REG_ADDR_UNLOCK
);
157 spi_message_init(&msg
);
158 spi_message_add_tail(&xfer
[0], &msg
);
159 spi_message_add_tail(&xfer
[1], &msg
);
160 spi_message_add_tail(&xfer
[2], &msg
);
162 return spi_sync(st
->us
, &msg
);
166 * sca3000_write_ctrl_reg() write to a lock protect ctrl register
167 * @sel: selects which registers we wish to write to
168 * @val: the value to be written
170 * Certain control registers are protected against overwriting by the lock
171 * register and use a shared write address. This function allows writing of
175 static int sca3000_write_ctrl_reg(struct sca3000_state
*st
,
182 ret
= sca3000_reg_lock_on(st
);
186 ret
= __sca3000_unlock_reg_lock(st
);
191 /* Set the control select register */
192 ret
= sca3000_write_reg(st
, SCA3000_REG_ADDR_CTRL_SEL
, sel
);
196 /* Write the actual value into the register */
197 ret
= sca3000_write_reg(st
, SCA3000_REG_ADDR_CTRL_DATA
, val
);
203 /* Crucial that lock is called before calling this */
205 * sca3000_read_ctrl_reg() read from lock protected control register.
209 static int sca3000_read_ctrl_reg(struct sca3000_state
*st
,
214 ret
= sca3000_reg_lock_on(st
);
218 ret
= __sca3000_unlock_reg_lock(st
);
222 /* Set the control select register */
223 ret
= sca3000_write_reg(st
, SCA3000_REG_ADDR_CTRL_SEL
, ctrl_reg
);
226 ret
= sca3000_read_data_short(st
, SCA3000_REG_ADDR_CTRL_DATA
, 1);
237 * sca3000_check_status() check the status register
239 * Only used for debugging purposes
241 static int sca3000_check_status(struct device
*dev
)
244 struct iio_dev
*indio_dev
= dev_get_drvdata(dev
);
245 struct sca3000_state
*st
= iio_priv(indio_dev
);
247 mutex_lock(&st
->lock
);
248 ret
= sca3000_read_data_short(st
, SCA3000_REG_ADDR_STATUS
, 1);
251 if (st
->rx
[0] & SCA3000_EEPROM_CS_ERROR
)
252 dev_err(dev
, "eeprom error\n");
253 if (st
->rx
[0] & SCA3000_SPI_FRAME_ERROR
)
254 dev_err(dev
, "Previous SPI Frame was corrupt\n");
257 mutex_unlock(&st
->lock
);
260 #endif /* SCA3000_DEBUG */
264 * sca3000_show_reg() - sysfs interface to read the chip revision number
266 static ssize_t
sca3000_show_rev(struct device
*dev
,
267 struct device_attribute
*attr
,
271 struct iio_dev
*dev_info
= dev_get_drvdata(dev
);
272 struct sca3000_state
*st
= iio_priv(dev_info
);
274 mutex_lock(&st
->lock
);
275 ret
= sca3000_read_data_short(st
, SCA3000_REG_ADDR_REVID
, 1);
278 len
+= sprintf(buf
+ len
,
279 "major=%d, minor=%d\n",
280 st
->rx
[0] & SCA3000_REVID_MAJOR_MASK
,
281 st
->rx
[0] & SCA3000_REVID_MINOR_MASK
);
283 mutex_unlock(&st
->lock
);
285 return ret
? ret
: len
;
289 * sca3000_show_available_measurement_modes() display available modes
291 * This is all read from chip specific data in the driver. Not all
292 * of the sca3000 series support modes other than normal.
295 sca3000_show_available_measurement_modes(struct device
*dev
,
296 struct device_attribute
*attr
,
299 struct iio_dev
*dev_info
= dev_get_drvdata(dev
);
300 struct sca3000_state
*st
= iio_priv(dev_info
);
303 len
+= sprintf(buf
+ len
, "0 - normal mode");
304 switch (st
->info
->option_mode_1
) {
305 case SCA3000_OP_MODE_NARROW
:
306 len
+= sprintf(buf
+ len
, ", 1 - narrow mode");
308 case SCA3000_OP_MODE_BYPASS
:
309 len
+= sprintf(buf
+ len
, ", 1 - bypass mode");
312 switch (st
->info
->option_mode_2
) {
313 case SCA3000_OP_MODE_WIDE
:
314 len
+= sprintf(buf
+ len
, ", 2 - wide mode");
317 /* always supported */
318 len
+= sprintf(buf
+ len
, " 3 - motion detection\n");
324 * sca3000_show_measurmenet_mode() sysfs read of current mode
327 sca3000_show_measurement_mode(struct device
*dev
,
328 struct device_attribute
*attr
,
331 struct iio_dev
*dev_info
= dev_get_drvdata(dev
);
332 struct sca3000_state
*st
= iio_priv(dev_info
);
335 mutex_lock(&st
->lock
);
336 ret
= sca3000_read_data_short(st
, SCA3000_REG_ADDR_MODE
, 1);
339 /* mask bottom 2 bits - only ones that are relevant */
342 case SCA3000_MEAS_MODE_NORMAL
:
343 len
+= sprintf(buf
+ len
, "0 - normal mode\n");
345 case SCA3000_MEAS_MODE_MOT_DET
:
346 len
+= sprintf(buf
+ len
, "3 - motion detection\n");
348 case SCA3000_MEAS_MODE_OP_1
:
349 switch (st
->info
->option_mode_1
) {
350 case SCA3000_OP_MODE_NARROW
:
351 len
+= sprintf(buf
+ len
, "1 - narrow mode\n");
353 case SCA3000_OP_MODE_BYPASS
:
354 len
+= sprintf(buf
+ len
, "1 - bypass mode\n");
358 case SCA3000_MEAS_MODE_OP_2
:
359 switch (st
->info
->option_mode_2
) {
360 case SCA3000_OP_MODE_WIDE
:
361 len
+= sprintf(buf
+ len
, "2 - wide mode\n");
368 mutex_unlock(&st
->lock
);
370 return ret
? ret
: len
;
374 * sca3000_store_measurement_mode() set the current mode
377 sca3000_store_measurement_mode(struct device
*dev
,
378 struct device_attribute
*attr
,
382 struct iio_dev
*dev_info
= dev_get_drvdata(dev
);
383 struct sca3000_state
*st
= iio_priv(dev_info
);
388 mutex_lock(&st
->lock
);
389 ret
= strict_strtol(buf
, 10, &val
);
392 ret
= sca3000_read_data_short(st
, SCA3000_REG_ADDR_MODE
, 1);
396 st
->rx
[0] |= (val
& mask
);
397 ret
= sca3000_write_reg(st
, SCA3000_REG_ADDR_MODE
, st
->rx
[0]);
400 mutex_unlock(&st
->lock
);
405 mutex_unlock(&st
->lock
);
411 /* Not even vaguely standard attributes so defined here rather than
412 * in the relevant IIO core headers
414 static IIO_DEVICE_ATTR(measurement_mode_available
, S_IRUGO
,
415 sca3000_show_available_measurement_modes
,
418 static IIO_DEVICE_ATTR(measurement_mode
, S_IRUGO
| S_IWUSR
,
419 sca3000_show_measurement_mode
,
420 sca3000_store_measurement_mode
,
423 /* More standard attributes */
425 static IIO_DEV_ATTR_REV(sca3000_show_rev
);
427 #define SCA3000_INFO_MASK \
428 (1 << IIO_CHAN_INFO_SCALE_SHARED)
429 #define SCA3000_EVENT_MASK \
430 (IIO_EV_BIT(IIO_EV_TYPE_MAG, IIO_EV_DIR_RISING))
432 static struct iio_chan_spec sca3000_channels
[] = {
433 IIO_CHAN(IIO_ACCEL
, 1, 0, 0, NULL
, 0, IIO_MOD_X
, SCA3000_INFO_MASK
,
434 0, 0, IIO_ST('s', 11, 16, 5), SCA3000_EVENT_MASK
),
435 IIO_CHAN(IIO_ACCEL
, 1, 0, 0, NULL
, 0, IIO_MOD_Y
, SCA3000_INFO_MASK
,
436 1, 1, IIO_ST('s', 11, 16, 5), SCA3000_EVENT_MASK
),
437 IIO_CHAN(IIO_ACCEL
, 1, 0, 0, NULL
, 0, IIO_MOD_Z
, SCA3000_INFO_MASK
,
438 2, 2, IIO_ST('s', 11, 16, 5), SCA3000_EVENT_MASK
),
441 static u8 sca3000_addresses
[3][3] = {
442 [0] = {SCA3000_REG_ADDR_X_MSB
, SCA3000_REG_CTRL_SEL_MD_X_TH
,
443 SCA3000_MD_CTRL_OR_X
},
444 [1] = {SCA3000_REG_ADDR_Y_MSB
, SCA3000_REG_CTRL_SEL_MD_Y_TH
,
445 SCA3000_MD_CTRL_OR_Y
},
446 [2] = {SCA3000_REG_ADDR_Z_MSB
, SCA3000_REG_CTRL_SEL_MD_Z_TH
,
447 SCA3000_MD_CTRL_OR_Z
},
450 static int sca3000_read_raw(struct iio_dev
*indio_dev
,
451 struct iio_chan_spec
const *chan
,
456 struct sca3000_state
*st
= iio_priv(indio_dev
);
462 mutex_lock(&st
->lock
);
463 if (st
->mo_det_use_count
) {
464 mutex_unlock(&st
->lock
);
467 address
= sca3000_addresses
[chan
->address
][0];
468 ret
= sca3000_read_data_short(st
, address
, 2);
470 mutex_unlock(&st
->lock
);
473 *val
= (be16_to_cpup((__be16
*)st
->rx
) >> 3) & 0x1FFF;
474 *val
= ((*val
) << (sizeof(*val
)*8 - 13)) >>
475 (sizeof(*val
)*8 - 13);
476 mutex_unlock(&st
->lock
);
478 case (1 << IIO_CHAN_INFO_SCALE_SHARED
):
480 if (chan
->type
== IIO_ACCEL
)
481 *val2
= st
->info
->scale
;
482 else /* temperature */
484 return IIO_VAL_INT_PLUS_MICRO
;
491 * sca3000_read_av_freq() sysfs function to get available frequencies
493 * The later modes are only relevant to the ring buffer - and depend on current
494 * mode. Note that data sheet gives rather wide tolerances for these so integer
495 * division will give good enough answer and not all chips have them specified
498 static ssize_t
sca3000_read_av_freq(struct device
*dev
,
499 struct device_attribute
*attr
,
502 struct iio_dev
*indio_dev
= dev_get_drvdata(dev
);
503 struct sca3000_state
*st
= iio_priv(indio_dev
);
504 int len
= 0, ret
, val
;
506 mutex_lock(&st
->lock
);
507 ret
= sca3000_read_data_short(st
, SCA3000_REG_ADDR_MODE
, 1);
509 mutex_unlock(&st
->lock
);
513 switch (val
& 0x03) {
514 case SCA3000_MEAS_MODE_NORMAL
:
515 len
+= sprintf(buf
+ len
, "%d %d %d\n",
516 st
->info
->measurement_mode_freq
,
517 st
->info
->measurement_mode_freq
/2,
518 st
->info
->measurement_mode_freq
/4);
520 case SCA3000_MEAS_MODE_OP_1
:
521 len
+= sprintf(buf
+ len
, "%d %d %d\n",
522 st
->info
->option_mode_1_freq
,
523 st
->info
->option_mode_1_freq
/2,
524 st
->info
->option_mode_1_freq
/4);
526 case SCA3000_MEAS_MODE_OP_2
:
527 len
+= sprintf(buf
+ len
, "%d %d %d\n",
528 st
->info
->option_mode_2_freq
,
529 st
->info
->option_mode_2_freq
/2,
530 st
->info
->option_mode_2_freq
/4);
538 * __sca3000_get_base_frequency() obtain mode specific base frequency
542 static inline int __sca3000_get_base_freq(struct sca3000_state
*st
,
543 const struct sca3000_chip_info
*info
,
548 ret
= sca3000_read_data_short(st
, SCA3000_REG_ADDR_MODE
, 1);
551 switch (0x03 & st
->rx
[0]) {
552 case SCA3000_MEAS_MODE_NORMAL
:
553 *base_freq
= info
->measurement_mode_freq
;
555 case SCA3000_MEAS_MODE_OP_1
:
556 *base_freq
= info
->option_mode_1_freq
;
558 case SCA3000_MEAS_MODE_OP_2
:
559 *base_freq
= info
->option_mode_2_freq
;
567 * sca3000_read_frequency() sysfs interface to get the current frequency
569 static ssize_t
sca3000_read_frequency(struct device
*dev
,
570 struct device_attribute
*attr
,
573 struct iio_dev
*indio_dev
= dev_get_drvdata(dev
);
574 struct sca3000_state
*st
= iio_priv(indio_dev
);
575 int ret
, len
= 0, base_freq
= 0, val
;
577 mutex_lock(&st
->lock
);
578 ret
= __sca3000_get_base_freq(st
, st
->info
, &base_freq
);
581 ret
= sca3000_read_ctrl_reg(st
, SCA3000_REG_CTRL_SEL_OUT_CTRL
);
582 mutex_unlock(&st
->lock
);
587 switch (val
& 0x03) {
590 len
= sprintf(buf
, "%d\n", base_freq
);
593 len
= sprintf(buf
, "%d\n", base_freq
/2);
596 len
= sprintf(buf
, "%d\n", base_freq
/4);
602 mutex_unlock(&st
->lock
);
608 * sca3000_set_frequency() sysfs interface to set the current frequency
610 static ssize_t
sca3000_set_frequency(struct device
*dev
,
611 struct device_attribute
*attr
,
615 struct iio_dev
*indio_dev
= dev_get_drvdata(dev
);
616 struct sca3000_state
*st
= iio_priv(indio_dev
);
617 int ret
, base_freq
= 0;
621 ret
= strict_strtol(buf
, 10, &val
);
625 mutex_lock(&st
->lock
);
626 /* What mode are we in? */
627 ret
= __sca3000_get_base_freq(st
, st
->info
, &base_freq
);
629 goto error_free_lock
;
631 ret
= sca3000_read_ctrl_reg(st
, SCA3000_REG_CTRL_SEL_OUT_CTRL
);
633 goto error_free_lock
;
638 if (val
== base_freq
/2) {
639 ctrlval
|= SCA3000_OUT_CTRL_BUF_DIV_2
;
640 } else if (val
== base_freq
/4) {
641 ctrlval
|= SCA3000_OUT_CTRL_BUF_DIV_4
;
642 } else if (val
!= base_freq
) {
644 goto error_free_lock
;
646 ret
= sca3000_write_ctrl_reg(st
, SCA3000_REG_CTRL_SEL_OUT_CTRL
,
649 mutex_unlock(&st
->lock
);
651 return ret
? ret
: len
;
654 /* Should only really be registered if ring buffer support is compiled in.
655 * Does no harm however and doing it right would add a fair bit of complexity
657 static IIO_DEV_ATTR_SAMP_FREQ_AVAIL(sca3000_read_av_freq
);
659 static IIO_DEV_ATTR_SAMP_FREQ(S_IWUSR
| S_IRUGO
,
660 sca3000_read_frequency
,
661 sca3000_set_frequency
);
665 * sca3000_read_temp() sysfs interface to get the temperature when available
667 * The alignment of data in here is downright odd. See data sheet.
668 * Converting this into a meaningful value is left to inline functions in
669 * userspace part of header.
671 static ssize_t
sca3000_read_temp(struct device
*dev
,
672 struct device_attribute
*attr
,
675 struct iio_dev
*indio_dev
= dev_get_drvdata(dev
);
676 struct sca3000_state
*st
= iio_priv(indio_dev
);
679 ret
= sca3000_read_data_short(st
, SCA3000_REG_ADDR_TEMP_MSB
, 2);
682 val
= ((st
->rx
[0] & 0x3F) << 3) | ((st
->rx
[1] & 0xE0) >> 5);
684 return sprintf(buf
, "%d\n", val
);
689 static IIO_DEV_ATTR_TEMP_RAW(sca3000_read_temp
);
691 static IIO_CONST_ATTR_TEMP_SCALE("0.555556");
692 static IIO_CONST_ATTR_TEMP_OFFSET("-214.6");
695 * sca3000_read_thresh() - query of a threshold
697 static int sca3000_read_thresh(struct iio_dev
*indio_dev
,
702 struct sca3000_state
*st
= iio_priv(indio_dev
);
703 int num
= IIO_EVENT_CODE_EXTRACT_MODIFIER(e
);
704 mutex_lock(&st
->lock
);
705 ret
= sca3000_read_ctrl_reg(st
, sca3000_addresses
[num
][1]);
706 mutex_unlock(&st
->lock
);
711 for_each_set_bit(i
, (unsigned long *)&ret
,
712 ARRAY_SIZE(st
->info
->mot_det_mult_y
))
713 *val
+= st
->info
->mot_det_mult_y
[i
];
715 for_each_set_bit(i
, (unsigned long *)&ret
,
716 ARRAY_SIZE(st
->info
->mot_det_mult_xz
))
717 *val
+= st
->info
->mot_det_mult_xz
[i
];
723 * sca3000_write_thresh() control of threshold
725 static int sca3000_write_thresh(struct iio_dev
*indio_dev
,
729 struct sca3000_state
*st
= iio_priv(indio_dev
);
730 int num
= IIO_EVENT_CODE_EXTRACT_MODIFIER(e
);
736 i
= ARRAY_SIZE(st
->info
->mot_det_mult_y
);
738 if (val
>= st
->info
->mot_det_mult_y
[--i
]) {
739 nonlinear
|= (1 << i
);
740 val
-= st
->info
->mot_det_mult_y
[i
];
743 i
= ARRAY_SIZE(st
->info
->mot_det_mult_xz
);
745 if (val
>= st
->info
->mot_det_mult_xz
[--i
]) {
746 nonlinear
|= (1 << i
);
747 val
-= st
->info
->mot_det_mult_xz
[i
];
751 mutex_lock(&st
->lock
);
752 ret
= sca3000_write_ctrl_reg(st
, sca3000_addresses
[num
][1], nonlinear
);
753 mutex_unlock(&st
->lock
);
758 static struct attribute
*sca3000_attributes
[] = {
759 &iio_dev_attr_revision
.dev_attr
.attr
,
760 &iio_dev_attr_measurement_mode_available
.dev_attr
.attr
,
761 &iio_dev_attr_measurement_mode
.dev_attr
.attr
,
762 &iio_dev_attr_sampling_frequency_available
.dev_attr
.attr
,
763 &iio_dev_attr_sampling_frequency
.dev_attr
.attr
,
767 static struct attribute
*sca3000_attributes_with_temp
[] = {
768 &iio_dev_attr_revision
.dev_attr
.attr
,
769 &iio_dev_attr_measurement_mode_available
.dev_attr
.attr
,
770 &iio_dev_attr_measurement_mode
.dev_attr
.attr
,
771 &iio_dev_attr_sampling_frequency_available
.dev_attr
.attr
,
772 &iio_dev_attr_sampling_frequency
.dev_attr
.attr
,
773 /* Only present if temp sensor is */
774 &iio_dev_attr_temp_raw
.dev_attr
.attr
,
775 &iio_const_attr_temp_offset
.dev_attr
.attr
,
776 &iio_const_attr_temp_scale
.dev_attr
.attr
,
780 static const struct attribute_group sca3000_attribute_group
= {
781 .attrs
= sca3000_attributes
,
784 static const struct attribute_group sca3000_attribute_group_with_temp
= {
785 .attrs
= sca3000_attributes_with_temp
,
788 /* RING RELATED interrupt handler */
789 /* depending on event, push to the ring buffer event chrdev or the event one */
792 * sca3000_event_handler() - handling ring and non ring events
794 * This function is complicated by the fact that the devices can signify ring
795 * and non ring events via the same interrupt line and they can only
796 * be distinguished via a read of the relevant status register.
798 static irqreturn_t
sca3000_event_handler(int irq
, void *private)
800 struct iio_dev
*indio_dev
= private;
801 struct sca3000_state
*st
= iio_priv(indio_dev
);
803 s64 last_timestamp
= iio_get_time_ns();
805 /* Could lead if badly timed to an extra read of status reg,
806 * but ensures no interrupt is missed.
808 mutex_lock(&st
->lock
);
809 ret
= sca3000_read_data_short(st
, SCA3000_REG_ADDR_INT_STATUS
, 1);
811 mutex_unlock(&st
->lock
);
815 sca3000_ring_int_process(val
, indio_dev
->ring
);
817 if (val
& SCA3000_INT_STATUS_FREE_FALL
)
818 iio_push_event(indio_dev
, 0,
819 IIO_MOD_EVENT_CODE(IIO_EV_CLASS_ACCEL
,
821 IIO_EV_MOD_X_AND_Y_AND_Z
,
826 if (val
& SCA3000_INT_STATUS_Y_TRIGGER
)
827 iio_push_event(indio_dev
, 0,
828 IIO_MOD_EVENT_CODE(IIO_EV_CLASS_ACCEL
,
835 if (val
& SCA3000_INT_STATUS_X_TRIGGER
)
836 iio_push_event(indio_dev
, 0,
837 IIO_MOD_EVENT_CODE(IIO_EV_CLASS_ACCEL
,
844 if (val
& SCA3000_INT_STATUS_Z_TRIGGER
)
845 iio_push_event(indio_dev
, 0,
846 IIO_MOD_EVENT_CODE(IIO_EV_CLASS_ACCEL
,
858 * sca3000_read_event_config() what events are enabled
860 static int sca3000_read_event_config(struct iio_dev
*indio_dev
,
863 struct sca3000_state
*st
= iio_priv(indio_dev
);
865 u8 protect_mask
= 0x03;
866 int num
= IIO_EVENT_CODE_EXTRACT_MODIFIER(e
);
868 /* read current value of mode register */
869 mutex_lock(&st
->lock
);
870 ret
= sca3000_read_data_short(st
, SCA3000_REG_ADDR_MODE
, 1);
874 if ((st
->rx
[0] & protect_mask
) != SCA3000_MEAS_MODE_MOT_DET
)
877 ret
= sca3000_read_ctrl_reg(st
, SCA3000_REG_CTRL_SEL_MD_CTRL
);
880 /* only supporting logical or's for now */
881 ret
= !!(ret
& sca3000_addresses
[num
][2]);
884 mutex_unlock(&st
->lock
);
889 * sca3000_query_free_fall_mode() is free fall mode enabled
891 static ssize_t
sca3000_query_free_fall_mode(struct device
*dev
,
892 struct device_attribute
*attr
,
896 struct iio_dev
*indio_dev
= dev_get_drvdata(dev
);
897 struct sca3000_state
*st
= iio_priv(indio_dev
);
900 mutex_lock(&st
->lock
);
901 ret
= sca3000_read_data_short(st
, SCA3000_REG_ADDR_MODE
, 1);
903 mutex_unlock(&st
->lock
);
906 len
= sprintf(buf
, "%d\n",
907 !!(val
& SCA3000_FREE_FALL_DETECT
));
912 * sca3000_set_free_fall_mode() simple on off control for free fall int
914 * In these chips the free fall detector should send an interrupt if
915 * the device falls more than 25cm. This has not been tested due
919 static ssize_t
sca3000_set_free_fall_mode(struct device
*dev
,
920 struct device_attribute
*attr
,
924 struct iio_dev
*indio_dev
= dev_get_drvdata(dev
);
925 struct sca3000_state
*st
= iio_priv(indio_dev
);
928 u8 protect_mask
= SCA3000_FREE_FALL_DETECT
;
930 mutex_lock(&st
->lock
);
931 ret
= strict_strtol(buf
, 10, &val
);
935 /* read current value of mode register */
936 ret
= sca3000_read_data_short(st
, SCA3000_REG_ADDR_MODE
, 1);
940 /*if off and should be on*/
941 if (val
&& !(st
->rx
[0] & protect_mask
))
942 ret
= sca3000_write_reg(st
, SCA3000_REG_ADDR_MODE
,
943 (st
->rx
[0] | SCA3000_FREE_FALL_DETECT
));
944 /* if on and should be off */
945 else if (!val
&& (st
->rx
[0] & protect_mask
))
946 ret
= sca3000_write_reg(st
, SCA3000_REG_ADDR_MODE
,
947 (st
->rx
[0] & ~protect_mask
));
949 mutex_unlock(&st
->lock
);
951 return ret
? ret
: len
;
955 * sca3000_set_mo_det() simple on off control for motion detector
957 * This is a per axis control, but enabling any will result in the
958 * motion detector unit being enabled.
959 * N.B. enabling motion detector stops normal data acquisition.
960 * There is a complexity in knowing which mode to return to when
961 * this mode is disabled. Currently normal mode is assumed.
963 static int sca3000_write_event_config(struct iio_dev
*indio_dev
,
967 struct sca3000_state
*st
= iio_priv(indio_dev
);
969 u8 protect_mask
= 0x03;
970 int num
= IIO_EVENT_CODE_EXTRACT_MODIFIER(e
);
972 mutex_lock(&st
->lock
);
973 /* First read the motion detector config to find out if
975 ret
= sca3000_read_ctrl_reg(st
, SCA3000_REG_CTRL_SEL_MD_CTRL
);
979 /* Off and should be on */
980 if (state
&& !(ctrlval
& sca3000_addresses
[num
][2])) {
981 ret
= sca3000_write_ctrl_reg(st
,
982 SCA3000_REG_CTRL_SEL_MD_CTRL
,
984 sca3000_addresses
[num
][2]);
987 st
->mo_det_use_count
++;
988 } else if (!state
&& (ctrlval
& sca3000_addresses
[num
][2])) {
989 ret
= sca3000_write_ctrl_reg(st
,
990 SCA3000_REG_CTRL_SEL_MD_CTRL
,
992 ~(sca3000_addresses
[num
][2]));
995 st
->mo_det_use_count
--;
998 /* read current value of mode register */
999 ret
= sca3000_read_data_short(st
, SCA3000_REG_ADDR_MODE
, 1);
1002 /*if off and should be on*/
1003 if ((st
->mo_det_use_count
)
1004 && ((st
->rx
[0] & protect_mask
) != SCA3000_MEAS_MODE_MOT_DET
))
1005 ret
= sca3000_write_reg(st
, SCA3000_REG_ADDR_MODE
,
1006 (st
->rx
[0] & ~protect_mask
)
1007 | SCA3000_MEAS_MODE_MOT_DET
);
1008 /* if on and should be off */
1009 else if (!(st
->mo_det_use_count
)
1010 && ((st
->rx
[0] & protect_mask
) == SCA3000_MEAS_MODE_MOT_DET
))
1011 ret
= sca3000_write_reg(st
, SCA3000_REG_ADDR_MODE
,
1012 (st
->rx
[0] & ~protect_mask
));
1014 mutex_unlock(&st
->lock
);
1019 /* Free fall detector related event attribute */
1020 static IIO_DEVICE_ATTR_NAMED(accel_xayaz_mag_falling_en
,
1021 accel_x
&y
&z_mag_falling_en
,
1023 sca3000_query_free_fall_mode
,
1024 sca3000_set_free_fall_mode
,
1027 static IIO_CONST_ATTR_NAMED(accel_xayaz_mag_falling_period
,
1028 accel_x
&y
&z_mag_falling_period
,
1031 static struct attribute
*sca3000_event_attributes
[] = {
1032 &iio_dev_attr_accel_xayaz_mag_falling_en
.dev_attr
.attr
,
1033 &iio_const_attr_accel_xayaz_mag_falling_period
.dev_attr
.attr
,
1037 static struct attribute_group sca3000_event_attribute_group
= {
1038 .attrs
= sca3000_event_attributes
,
1042 * sca3000_clean_setup() get the device into a predictable state
1044 * Devices use flash memory to store many of the register values
1045 * and hence can come up in somewhat unpredictable states.
1046 * Hence reset everything on driver load.
1048 static int sca3000_clean_setup(struct sca3000_state
*st
)
1052 mutex_lock(&st
->lock
);
1053 /* Ensure all interrupts have been acknowledged */
1054 ret
= sca3000_read_data_short(st
, SCA3000_REG_ADDR_INT_STATUS
, 1);
1058 /* Turn off all motion detection channels */
1059 ret
= sca3000_read_ctrl_reg(st
, SCA3000_REG_CTRL_SEL_MD_CTRL
);
1062 ret
= sca3000_write_ctrl_reg(st
, SCA3000_REG_CTRL_SEL_MD_CTRL
,
1063 ret
& SCA3000_MD_CTRL_PROT_MASK
);
1067 /* Disable ring buffer */
1068 ret
= sca3000_read_ctrl_reg(st
, SCA3000_REG_CTRL_SEL_OUT_CTRL
);
1069 ret
= sca3000_write_ctrl_reg(st
, SCA3000_REG_CTRL_SEL_OUT_CTRL
,
1070 (ret
& SCA3000_OUT_CTRL_PROT_MASK
)
1071 | SCA3000_OUT_CTRL_BUF_X_EN
1072 | SCA3000_OUT_CTRL_BUF_Y_EN
1073 | SCA3000_OUT_CTRL_BUF_Z_EN
1074 | SCA3000_OUT_CTRL_BUF_DIV_4
);
1077 /* Enable interrupts, relevant to mode and set up as active low */
1078 ret
= sca3000_read_data_short(st
, SCA3000_REG_ADDR_INT_MASK
, 1);
1081 ret
= sca3000_write_reg(st
,
1082 SCA3000_REG_ADDR_INT_MASK
,
1083 (ret
& SCA3000_INT_MASK_PROT_MASK
)
1084 | SCA3000_INT_MASK_ACTIVE_LOW
);
1087 /* Select normal measurement mode, free fall off, ring off */
1088 /* Ring in 12 bit mode - it is fine to overwrite reserved bits 3,5
1089 * as that occurs in one of the example on the datasheet */
1090 ret
= sca3000_read_data_short(st
, SCA3000_REG_ADDR_MODE
, 1);
1093 ret
= sca3000_write_reg(st
, SCA3000_REG_ADDR_MODE
,
1094 (st
->rx
[0] & SCA3000_MODE_PROT_MASK
));
1098 mutex_unlock(&st
->lock
);
1102 static const struct iio_info sca3000_info
= {
1103 .attrs
= &sca3000_attribute_group
,
1104 .read_raw
= &sca3000_read_raw
,
1105 .num_interrupt_lines
= 1,
1106 .event_attrs
= &sca3000_event_attribute_group
,
1107 .read_event_value
= &sca3000_read_thresh
,
1108 .write_event_value
= &sca3000_write_thresh
,
1109 .read_event_config
= &sca3000_read_event_config
,
1110 .write_event_config
= &sca3000_write_event_config
,
1111 .driver_module
= THIS_MODULE
,
1114 static const struct iio_info sca3000_info_with_temp
= {
1115 .attrs
= &sca3000_attribute_group_with_temp
,
1116 .read_raw
= &sca3000_read_raw
,
1117 .read_event_value
= &sca3000_read_thresh
,
1118 .write_event_value
= &sca3000_write_thresh
,
1119 .read_event_config
= &sca3000_read_event_config
,
1120 .write_event_config
= &sca3000_write_event_config
,
1121 .driver_module
= THIS_MODULE
,
1124 static int __devinit
sca3000_probe(struct spi_device
*spi
)
1126 int ret
, regdone
= 0;
1127 struct sca3000_state
*st
;
1128 struct iio_dev
*indio_dev
;
1130 indio_dev
= iio_allocate_device(sizeof(*st
));
1131 if (indio_dev
== NULL
) {
1136 st
= iio_priv(indio_dev
);
1137 spi_set_drvdata(spi
, indio_dev
);
1139 mutex_init(&st
->lock
);
1140 st
->info
= &sca3000_spi_chip_info_tbl
[spi_get_device_id(spi
)
1143 indio_dev
->dev
.parent
= &spi
->dev
;
1144 indio_dev
->name
= spi_get_device_id(spi
)->name
;
1145 if (st
->info
->temp_output
)
1146 indio_dev
->info
= &sca3000_info_with_temp
;
1148 indio_dev
->info
= &sca3000_info
;
1149 indio_dev
->channels
= sca3000_channels
;
1150 indio_dev
->num_channels
= ARRAY_SIZE(sca3000_channels
);
1152 indio_dev
->modes
= INDIO_DIRECT_MODE
;
1154 sca3000_configure_ring(indio_dev
);
1155 ret
= iio_device_register(indio_dev
);
1157 goto error_free_dev
;
1159 ret
= iio_ring_buffer_register_ex(indio_dev
->ring
, 0,
1161 ARRAY_SIZE(sca3000_channels
));
1163 goto error_unregister_dev
;
1164 if (spi
->irq
&& gpio_is_valid(irq_to_gpio(spi
->irq
)) > 0) {
1165 ret
= request_threaded_irq(spi
->irq
,
1167 &sca3000_event_handler
,
1168 IRQF_TRIGGER_FALLING
,
1172 goto error_unregister_ring
;
1174 sca3000_register_ring_funcs(indio_dev
);
1175 ret
= sca3000_clean_setup(st
);
1177 goto error_free_irq
;
1181 if (spi
->irq
&& gpio_is_valid(irq_to_gpio(spi
->irq
)) > 0)
1182 free_irq(spi
->irq
, indio_dev
);
1183 error_unregister_ring
:
1184 iio_ring_buffer_unregister(indio_dev
->ring
);
1185 error_unregister_dev
:
1188 iio_device_unregister(indio_dev
);
1190 iio_free_device(indio_dev
);
1196 static int sca3000_stop_all_interrupts(struct sca3000_state
*st
)
1200 mutex_lock(&st
->lock
);
1201 ret
= sca3000_read_data_short(st
, SCA3000_REG_ADDR_INT_MASK
, 1);
1204 ret
= sca3000_write_reg(st
, SCA3000_REG_ADDR_INT_MASK
,
1206 ~(SCA3000_INT_MASK_RING_THREE_QUARTER
|
1207 SCA3000_INT_MASK_RING_HALF
|
1208 SCA3000_INT_MASK_ALL_INTS
)));
1210 mutex_unlock(&st
->lock
);
1214 static int sca3000_remove(struct spi_device
*spi
)
1216 struct iio_dev
*indio_dev
= spi_get_drvdata(spi
);
1217 struct sca3000_state
*st
= iio_priv(indio_dev
);
1219 /* Must ensure no interrupts can be generated after this!*/
1220 ret
= sca3000_stop_all_interrupts(st
);
1223 if (spi
->irq
&& gpio_is_valid(irq_to_gpio(spi
->irq
)) > 0)
1224 free_irq(spi
->irq
, indio_dev
);
1225 iio_ring_buffer_unregister(indio_dev
->ring
);
1226 sca3000_unconfigure_ring(indio_dev
);
1227 iio_device_unregister(indio_dev
);
1232 static const struct spi_device_id sca3000_id
[] = {
1233 {"sca3000_d01", d01
},
1234 {"sca3000_e02", e02
},
1235 {"sca3000_e04", e04
},
1236 {"sca3000_e05", e05
},
1240 static struct spi_driver sca3000_driver
= {
1243 .owner
= THIS_MODULE
,
1245 .probe
= sca3000_probe
,
1246 .remove
= __devexit_p(sca3000_remove
),
1247 .id_table
= sca3000_id
,
1250 static __init
int sca3000_init(void)
1252 return spi_register_driver(&sca3000_driver
);
1254 module_init(sca3000_init
);
1256 static __exit
void sca3000_exit(void)
1258 spi_unregister_driver(&sca3000_driver
);
1260 module_exit(sca3000_exit
);
1262 MODULE_AUTHOR("Jonathan Cameron <jic23@cam.ac.uk>");
1263 MODULE_DESCRIPTION("VTI SCA3000 Series Accelerometers SPI driver");
1264 MODULE_LICENSE("GPL v2");