2 * KXCJK-1013 3-axis accelerometer driver
3 * Copyright (c) 2014, Intel Corporation.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 #include <linux/module.h>
16 #include <linux/i2c.h>
17 #include <linux/interrupt.h>
18 #include <linux/delay.h>
19 #include <linux/bitops.h>
20 #include <linux/slab.h>
21 #include <linux/string.h>
22 #include <linux/acpi.h>
23 #include <linux/gpio/consumer.h>
24 #include <linux/iio/iio.h>
25 #include <linux/iio/sysfs.h>
26 #include <linux/iio/buffer.h>
27 #include <linux/iio/trigger.h>
28 #include <linux/iio/trigger_consumer.h>
29 #include <linux/iio/triggered_buffer.h>
30 #include <linux/iio/accel/kxcjk_1013.h>
32 #define KXCJK1013_DRV_NAME "kxcjk1013"
33 #define KXCJK1013_IRQ_NAME "kxcjk1013_event"
35 #define KXCJK1013_REG_XOUT_L 0x06
37 * From low byte X axis register, all the other addresses of Y and Z can be
38 * obtained by just applying axis offset. The following axis defines are just
39 * provide clarity, but not used.
41 #define KXCJK1013_REG_XOUT_H 0x07
42 #define KXCJK1013_REG_YOUT_L 0x08
43 #define KXCJK1013_REG_YOUT_H 0x09
44 #define KXCJK1013_REG_ZOUT_L 0x0A
45 #define KXCJK1013_REG_ZOUT_H 0x0B
47 #define KXCJK1013_REG_DCST_RESP 0x0C
48 #define KXCJK1013_REG_WHO_AM_I 0x0F
49 #define KXCJK1013_REG_INT_SRC1 0x16
50 #define KXCJK1013_REG_INT_SRC2 0x17
51 #define KXCJK1013_REG_STATUS_REG 0x18
52 #define KXCJK1013_REG_INT_REL 0x1A
53 #define KXCJK1013_REG_CTRL1 0x1B
54 #define KXCJK1013_REG_CTRL2 0x1D
55 #define KXCJK1013_REG_INT_CTRL1 0x1E
56 #define KXCJK1013_REG_INT_CTRL2 0x1F
57 #define KXCJK1013_REG_DATA_CTRL 0x21
58 #define KXCJK1013_REG_WAKE_TIMER 0x29
59 #define KXCJK1013_REG_SELF_TEST 0x3A
60 #define KXCJK1013_REG_WAKE_THRES 0x6A
62 #define KXCJK1013_REG_CTRL1_BIT_PC1 BIT(7)
63 #define KXCJK1013_REG_CTRL1_BIT_RES BIT(6)
64 #define KXCJK1013_REG_CTRL1_BIT_DRDY BIT(5)
65 #define KXCJK1013_REG_CTRL1_BIT_GSEL1 BIT(4)
66 #define KXCJK1013_REG_CTRL1_BIT_GSEL0 BIT(3)
67 #define KXCJK1013_REG_CTRL1_BIT_WUFE BIT(1)
68 #define KXCJK1013_REG_INT_REG1_BIT_IEA BIT(4)
69 #define KXCJK1013_REG_INT_REG1_BIT_IEN BIT(5)
71 #define KXCJK1013_DATA_MASK_12_BIT 0x0FFF
72 #define KXCJK1013_MAX_STARTUP_TIME_US 100000
74 struct kxcjk1013_data
{
75 struct i2c_client
*client
;
76 struct iio_trigger
*trig
;
82 bool active_high_intr
;
100 } samp_freq_table
[] = { {0, 781000, 0x08}, {1, 563000, 0x09},
101 {3, 125000, 0x0A}, {6, 250000, 0x0B}, {12, 500000, 0},
102 {25, 0, 0x01}, {50, 0, 0x02}, {100, 0, 0x03},
103 {200, 0, 0x04}, {400, 0, 0x05}, {800, 0, 0x06},
106 /* Refer to section 4 of the specification */
107 static const struct {
110 } odr_start_up_times
[] = { {0x08, 100000}, {0x09, 100000}, {0x0A, 100000},
111 {0x0B, 100000}, { 0, 80000}, {0x01, 41000},
112 {0x02, 21000}, {0x03, 11000}, {0x04, 6400},
113 {0x05, 3900}, {0x06, 2700}, {0x07, 2100} };
115 static int kxcjk1013_set_mode(struct kxcjk1013_data
*data
,
116 enum kxcjk1013_mode mode
)
120 ret
= i2c_smbus_read_byte_data(data
->client
, KXCJK1013_REG_CTRL1
);
122 dev_err(&data
->client
->dev
, "Error reading reg_ctrl1\n");
127 ret
&= ~KXCJK1013_REG_CTRL1_BIT_PC1
;
129 ret
|= KXCJK1013_REG_CTRL1_BIT_PC1
;
131 ret
= i2c_smbus_write_byte_data(data
->client
,
132 KXCJK1013_REG_CTRL1
, ret
);
134 dev_err(&data
->client
->dev
, "Error writing reg_ctrl1\n");
141 static int kxcjk1013_chip_ack_intr(struct kxcjk1013_data
*data
)
145 ret
= i2c_smbus_read_byte_data(data
->client
, KXCJK1013_REG_INT_REL
);
147 dev_err(&data
->client
->dev
, "Error writing reg_int_rel\n");
154 static int kxcjk1013_chip_init(struct kxcjk1013_data
*data
)
158 ret
= i2c_smbus_read_byte_data(data
->client
, KXCJK1013_REG_WHO_AM_I
);
160 dev_err(&data
->client
->dev
, "Error reading who_am_i\n");
164 dev_dbg(&data
->client
->dev
, "KXCJK1013 Chip Id %x\n", ret
);
166 ret
= kxcjk1013_set_mode(data
, STANDBY
);
170 ret
= i2c_smbus_read_byte_data(data
->client
, KXCJK1013_REG_CTRL1
);
172 dev_err(&data
->client
->dev
, "Error reading reg_ctrl1\n");
176 /* Setting range to 4G */
177 ret
|= KXCJK1013_REG_CTRL1_BIT_GSEL0
;
178 ret
&= ~KXCJK1013_REG_CTRL1_BIT_GSEL1
;
180 /* Set 12 bit mode */
181 ret
|= KXCJK1013_REG_CTRL1_BIT_RES
;
183 ret
= i2c_smbus_write_byte_data(data
->client
, KXCJK1013_REG_CTRL1
,
186 dev_err(&data
->client
->dev
, "Error reading reg_ctrl\n");
190 ret
= i2c_smbus_read_byte_data(data
->client
, KXCJK1013_REG_DATA_CTRL
);
192 dev_err(&data
->client
->dev
, "Error reading reg_data_ctrl\n");
196 data
->odr_bits
= ret
;
198 /* Set up INT polarity */
199 ret
= i2c_smbus_read_byte_data(data
->client
, KXCJK1013_REG_INT_CTRL1
);
201 dev_err(&data
->client
->dev
, "Error reading reg_int_ctrl1\n");
205 if (data
->active_high_intr
)
206 ret
|= KXCJK1013_REG_INT_REG1_BIT_IEA
;
208 ret
&= ~KXCJK1013_REG_INT_REG1_BIT_IEA
;
210 ret
= i2c_smbus_write_byte_data(data
->client
, KXCJK1013_REG_INT_CTRL1
,
213 dev_err(&data
->client
->dev
, "Error writing reg_int_ctrl1\n");
220 static int kxcjk1013_chip_setup_interrupt(struct kxcjk1013_data
*data
,
225 /* This is requirement by spec to change state to STANDBY */
226 ret
= kxcjk1013_set_mode(data
, STANDBY
);
230 ret
= i2c_smbus_read_byte_data(data
->client
, KXCJK1013_REG_INT_CTRL1
);
232 dev_err(&data
->client
->dev
, "Error reading reg_int_ctrl1\n");
237 ret
|= KXCJK1013_REG_INT_REG1_BIT_IEN
;
239 ret
&= ~KXCJK1013_REG_INT_REG1_BIT_IEN
;
241 ret
= i2c_smbus_write_byte_data(data
->client
, KXCJK1013_REG_INT_CTRL1
,
244 dev_err(&data
->client
->dev
, "Error writing reg_int_ctrl1\n");
248 ret
= i2c_smbus_read_byte_data(data
->client
, KXCJK1013_REG_CTRL1
);
250 dev_err(&data
->client
->dev
, "Error reading reg_ctrl1\n");
255 ret
|= KXCJK1013_REG_CTRL1_BIT_DRDY
;
257 ret
&= ~KXCJK1013_REG_CTRL1_BIT_DRDY
;
259 ret
= i2c_smbus_write_byte_data(data
->client
,
260 KXCJK1013_REG_CTRL1
, ret
);
262 dev_err(&data
->client
->dev
, "Error writing reg_ctrl1\n");
269 static int kxcjk1013_convert_freq_to_bit(int val
, int val2
)
273 for (i
= 0; i
< ARRAY_SIZE(samp_freq_table
); ++i
) {
274 if (samp_freq_table
[i
].val
== val
&&
275 samp_freq_table
[i
].val2
== val2
) {
276 return samp_freq_table
[i
].odr_bits
;
283 static int kxcjk1013_set_odr(struct kxcjk1013_data
*data
, int val
, int val2
)
288 odr_bits
= kxcjk1013_convert_freq_to_bit(val
, val2
);
292 /* To change ODR, the chip must be set to STANDBY as per spec */
293 ret
= kxcjk1013_set_mode(data
, STANDBY
);
297 ret
= i2c_smbus_write_byte_data(data
->client
, KXCJK1013_REG_DATA_CTRL
,
300 dev_err(&data
->client
->dev
, "Error writing data_ctrl\n");
304 data
->odr_bits
= odr_bits
;
306 /* Check, if the ODR is changed after data enable */
307 if (data
->power_state
) {
308 /* Set the state back to operation */
309 ret
= kxcjk1013_set_mode(data
, OPERATION
);
317 static int kxcjk1013_get_odr(struct kxcjk1013_data
*data
, int *val
, int *val2
)
321 for (i
= 0; i
< ARRAY_SIZE(samp_freq_table
); ++i
) {
322 if (samp_freq_table
[i
].odr_bits
== data
->odr_bits
) {
323 *val
= samp_freq_table
[i
].val
;
324 *val2
= samp_freq_table
[i
].val2
;
325 return IIO_VAL_INT_PLUS_MICRO
;
332 static int kxcjk1013_get_acc_reg(struct kxcjk1013_data
*data
, int axis
)
334 u8 reg
= KXCJK1013_REG_XOUT_L
+ axis
* 2;
337 ret
= i2c_smbus_read_word_data(data
->client
, reg
);
339 dev_err(&data
->client
->dev
,
340 "failed to read accel_%c registers\n", 'x' + axis
);
347 static int kxcjk1013_get_startup_times(struct kxcjk1013_data
*data
)
351 for (i
= 0; i
< ARRAY_SIZE(odr_start_up_times
); ++i
) {
352 if (odr_start_up_times
[i
].odr_bits
== data
->odr_bits
)
353 return odr_start_up_times
[i
].usec
;
356 return KXCJK1013_MAX_STARTUP_TIME_US
;
359 static int kxcjk1013_read_raw(struct iio_dev
*indio_dev
,
360 struct iio_chan_spec
const *chan
, int *val
,
361 int *val2
, long mask
)
363 struct kxcjk1013_data
*data
= iio_priv(indio_dev
);
367 case IIO_CHAN_INFO_RAW
:
368 mutex_lock(&data
->mutex
);
369 if (iio_buffer_enabled(indio_dev
))
374 ret
= kxcjk1013_set_mode(data
, OPERATION
);
376 mutex_unlock(&data
->mutex
);
380 sleep_val
= kxcjk1013_get_startup_times(data
);
381 if (sleep_val
< 20000)
382 usleep_range(sleep_val
, 20000);
384 msleep_interruptible(sleep_val
/1000);
385 ret
= kxcjk1013_get_acc_reg(data
, chan
->scan_index
);
386 if (--data
->power_state
== 0)
387 kxcjk1013_set_mode(data
, STANDBY
);
389 mutex_unlock(&data
->mutex
);
394 *val
= sign_extend32(ret
>> 4, 11);
397 case IIO_CHAN_INFO_SCALE
:
399 *val2
= 19163; /* range +-4g (4/2047*9.806650) */
400 return IIO_VAL_INT_PLUS_MICRO
;
402 case IIO_CHAN_INFO_SAMP_FREQ
:
403 mutex_lock(&data
->mutex
);
404 ret
= kxcjk1013_get_odr(data
, val
, val2
);
405 mutex_unlock(&data
->mutex
);
413 static int kxcjk1013_write_raw(struct iio_dev
*indio_dev
,
414 struct iio_chan_spec
const *chan
, int val
,
417 struct kxcjk1013_data
*data
= iio_priv(indio_dev
);
421 case IIO_CHAN_INFO_SAMP_FREQ
:
422 mutex_lock(&data
->mutex
);
423 ret
= kxcjk1013_set_odr(data
, val
, val2
);
424 mutex_unlock(&data
->mutex
);
433 static int kxcjk1013_validate_trigger(struct iio_dev
*indio_dev
,
434 struct iio_trigger
*trig
)
436 struct kxcjk1013_data
*data
= iio_priv(indio_dev
);
438 if (data
->trig
!= trig
)
444 static IIO_CONST_ATTR_SAMP_FREQ_AVAIL(
445 "0.781000 1.563000 3.125000 6.250000 12.500000 25 50 100 200 400 800 1600");
447 static struct attribute
*kxcjk1013_attributes
[] = {
448 &iio_const_attr_sampling_frequency_available
.dev_attr
.attr
,
452 static const struct attribute_group kxcjk1013_attrs_group
= {
453 .attrs
= kxcjk1013_attributes
,
456 #define KXCJK1013_CHANNEL(_axis) { \
459 .channel2 = IIO_MOD_##_axis, \
460 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
461 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE) | \
462 BIT(IIO_CHAN_INFO_SAMP_FREQ), \
463 .scan_index = AXIS_##_axis, \
469 .endianness = IIO_LE, \
473 static const struct iio_chan_spec kxcjk1013_channels
[] = {
474 KXCJK1013_CHANNEL(X
),
475 KXCJK1013_CHANNEL(Y
),
476 KXCJK1013_CHANNEL(Z
),
477 IIO_CHAN_SOFT_TIMESTAMP(3),
480 static const struct iio_info kxcjk1013_info
= {
481 .attrs
= &kxcjk1013_attrs_group
,
482 .read_raw
= kxcjk1013_read_raw
,
483 .write_raw
= kxcjk1013_write_raw
,
484 .validate_trigger
= kxcjk1013_validate_trigger
,
485 .driver_module
= THIS_MODULE
,
488 static irqreturn_t
kxcjk1013_trigger_handler(int irq
, void *p
)
490 struct iio_poll_func
*pf
= p
;
491 struct iio_dev
*indio_dev
= pf
->indio_dev
;
492 struct kxcjk1013_data
*data
= iio_priv(indio_dev
);
495 mutex_lock(&data
->mutex
);
497 for_each_set_bit(bit
, indio_dev
->buffer
->scan_mask
,
498 indio_dev
->masklength
) {
499 ret
= kxcjk1013_get_acc_reg(data
, bit
);
501 kxcjk1013_chip_ack_intr(data
);
502 mutex_unlock(&data
->mutex
);
505 data
->buffer
[i
++] = ret
;
508 kxcjk1013_chip_ack_intr(data
);
510 mutex_unlock(&data
->mutex
);
512 iio_push_to_buffers_with_timestamp(indio_dev
, data
->buffer
,
515 iio_trigger_notify_done(indio_dev
->trig
);
520 static int kxcjk1013_data_rdy_trigger_set_state(struct iio_trigger
*trig
,
523 struct iio_dev
*indio_dev
= iio_trigger_get_drvdata(trig
);
524 struct kxcjk1013_data
*data
= iio_priv(indio_dev
);
526 mutex_lock(&data
->mutex
);
528 kxcjk1013_chip_setup_interrupt(data
, true);
529 kxcjk1013_set_mode(data
, OPERATION
);
532 if (--data
->power_state
) {
533 mutex_unlock(&data
->mutex
);
536 kxcjk1013_chip_setup_interrupt(data
, false);
537 kxcjk1013_set_mode(data
, STANDBY
);
539 mutex_unlock(&data
->mutex
);
544 static const struct iio_trigger_ops kxcjk1013_trigger_ops
= {
545 .set_trigger_state
= kxcjk1013_data_rdy_trigger_set_state
,
546 .owner
= THIS_MODULE
,
549 static int kxcjk1013_acpi_gpio_probe(struct i2c_client
*client
,
550 struct kxcjk1013_data
*data
)
552 const struct acpi_device_id
*id
;
554 struct gpio_desc
*gpio
;
561 if (!ACPI_HANDLE(dev
))
564 id
= acpi_match_device(dev
->driver
->acpi_match_table
, dev
);
568 /* data ready gpio interrupt pin */
569 gpio
= devm_gpiod_get_index(dev
, "kxcjk1013_int", 0);
571 dev_err(dev
, "acpi gpio get index failed\n");
572 return PTR_ERR(gpio
);
575 ret
= gpiod_direction_input(gpio
);
579 ret
= gpiod_to_irq(gpio
);
581 dev_dbg(dev
, "GPIO resource, no:%d irq:%d\n", desc_to_gpio(gpio
), ret
);
586 static int kxcjk1013_probe(struct i2c_client
*client
,
587 const struct i2c_device_id
*id
)
589 struct kxcjk1013_data
*data
;
590 struct iio_dev
*indio_dev
;
591 struct iio_trigger
*trig
= NULL
;
592 struct kxcjk_1013_platform_data
*pdata
;
595 indio_dev
= devm_iio_device_alloc(&client
->dev
, sizeof(*data
));
599 data
= iio_priv(indio_dev
);
600 i2c_set_clientdata(client
, indio_dev
);
601 data
->client
= client
;
603 pdata
= dev_get_platdata(&client
->dev
);
605 data
->active_high_intr
= pdata
->active_high_intr
;
607 data
->active_high_intr
= true; /* default polarity */
609 ret
= kxcjk1013_chip_init(data
);
613 mutex_init(&data
->mutex
);
615 indio_dev
->dev
.parent
= &client
->dev
;
616 indio_dev
->channels
= kxcjk1013_channels
;
617 indio_dev
->num_channels
= ARRAY_SIZE(kxcjk1013_channels
);
618 indio_dev
->name
= KXCJK1013_DRV_NAME
;
619 indio_dev
->modes
= INDIO_DIRECT_MODE
;
620 indio_dev
->info
= &kxcjk1013_info
;
623 client
->irq
= kxcjk1013_acpi_gpio_probe(client
, data
);
625 if (client
->irq
>= 0) {
626 trig
= iio_trigger_alloc("%s-dev%d", indio_dev
->name
,
631 data
->trig_mode
= true;
633 ret
= devm_request_irq(&client
->dev
, client
->irq
,
634 iio_trigger_generic_data_rdy_poll
,
639 dev_err(&client
->dev
, "unable to request IRQ\n");
640 goto err_trigger_free
;
643 trig
->dev
.parent
= &client
->dev
;
644 trig
->ops
= &kxcjk1013_trigger_ops
;
645 iio_trigger_set_drvdata(trig
, indio_dev
);
647 indio_dev
->trig
= trig
;
649 ret
= iio_trigger_register(trig
);
651 goto err_trigger_free
;
653 ret
= iio_triggered_buffer_setup(indio_dev
,
654 &iio_pollfunc_store_time
,
655 kxcjk1013_trigger_handler
,
658 dev_err(&client
->dev
,
659 "iio triggered buffer setup failed\n");
660 goto err_trigger_unregister
;
664 ret
= devm_iio_device_register(&client
->dev
, indio_dev
);
666 dev_err(&client
->dev
, "unable to register iio device\n");
667 goto err_buffer_cleanup
;
674 iio_triggered_buffer_cleanup(indio_dev
);
675 err_trigger_unregister
:
677 iio_trigger_unregister(trig
);
680 iio_trigger_free(trig
);
685 static int kxcjk1013_remove(struct i2c_client
*client
)
687 struct iio_dev
*indio_dev
= i2c_get_clientdata(client
);
688 struct kxcjk1013_data
*data
= iio_priv(indio_dev
);
690 if (data
->trig_mode
) {
691 iio_triggered_buffer_cleanup(indio_dev
);
692 iio_trigger_unregister(data
->trig
);
693 iio_trigger_free(data
->trig
);
696 mutex_lock(&data
->mutex
);
697 kxcjk1013_set_mode(data
, STANDBY
);
698 mutex_unlock(&data
->mutex
);
703 #ifdef CONFIG_PM_SLEEP
704 static int kxcjk1013_suspend(struct device
*dev
)
706 struct iio_dev
*indio_dev
= i2c_get_clientdata(to_i2c_client(dev
));
707 struct kxcjk1013_data
*data
= iio_priv(indio_dev
);
709 mutex_lock(&data
->mutex
);
710 kxcjk1013_set_mode(data
, STANDBY
);
711 mutex_unlock(&data
->mutex
);
716 static int kxcjk1013_resume(struct device
*dev
)
718 struct iio_dev
*indio_dev
= i2c_get_clientdata(to_i2c_client(dev
));
719 struct kxcjk1013_data
*data
= iio_priv(indio_dev
);
721 mutex_lock(&data
->mutex
);
723 if (data
->power_state
)
724 kxcjk1013_set_mode(data
, OPERATION
);
726 mutex_unlock(&data
->mutex
);
731 static SIMPLE_DEV_PM_OPS(kxcjk1013_pm_ops
, kxcjk1013_suspend
, kxcjk1013_resume
);
732 #define KXCJK1013_PM_OPS (&kxcjk1013_pm_ops)
734 #define KXCJK1013_PM_OPS NULL
737 static const struct acpi_device_id kx_acpi_match
[] = {
741 MODULE_DEVICE_TABLE(acpi
, kx_acpi_match
);
743 static const struct i2c_device_id kxcjk1013_id
[] = {
748 MODULE_DEVICE_TABLE(i2c
, kxcjk1013_id
);
750 static struct i2c_driver kxcjk1013_driver
= {
752 .name
= KXCJK1013_DRV_NAME
,
753 .acpi_match_table
= ACPI_PTR(kx_acpi_match
),
754 .pm
= KXCJK1013_PM_OPS
,
756 .probe
= kxcjk1013_probe
,
757 .remove
= kxcjk1013_remove
,
758 .id_table
= kxcjk1013_id
,
760 module_i2c_driver(kxcjk1013_driver
);
762 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>");
763 MODULE_LICENSE("GPL v2");
764 MODULE_DESCRIPTION("KXCJK1013 accelerometer driver");