2 * Copyright (C) 2011 Kionix, Inc.
3 * Written by Chris Hudson <chudson@kionix.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
20 #include <linux/delay.h>
21 #include <linux/i2c.h>
22 #include <linux/input.h>
23 #include <linux/interrupt.h>
24 #include <linux/module.h>
25 #include <linux/slab.h>
26 #include <linux/input/kxtj9.h>
27 #include <linux/input-polldev.h>
31 /* OUTPUT REGISTERS */
34 /* CONTROL REGISTERS */
36 #define CTRL_REG1 0x1B
37 #define INT_CTRL1 0x1E
38 #define DATA_CTRL 0x21
39 /* CONTROL REGISTER 1 BITS */
41 #define PC1_ON (1 << 7)
42 /* Data ready funtion enable bit: set during probe if using irq mode */
43 #define DRDYE (1 << 5)
44 /* DATA CONTROL REGISTER BITS */
52 /* INTERRUPT CONTROL REGISTER 1 BITS */
53 /* Set these during probe if using irq mode */
54 #define KXTJ9_IEL (1 << 3)
55 #define KXTJ9_IEA (1 << 4)
56 #define KXTJ9_IEN (1 << 5)
57 /* INPUT_ABS CONSTANTS */
60 /* RESUME STATE INDICES */
61 #define RES_DATA_CTRL 0
62 #define RES_CTRL_REG1 1
63 #define RES_INT_CTRL1 2
64 #define RESUME_ENTRIES 3
67 * The following table lists the maximum appropriate poll interval for each
68 * available output data rate.
73 } kxtj9_odr_table[] = {
84 struct i2c_client *client;
85 struct kxtj9_platform_data pdata;
86 struct input_dev *input_dev;
87 #ifdef CONFIG_INPUT_KXTJ9_POLLED_MODE
88 struct input_polled_dev *poll_dev;
90 unsigned int last_poll_interval;
97 static int kxtj9_i2c_read(struct kxtj9_data *tj9, u8 addr, u8 *data, int len)
99 struct i2c_msg msgs[] = {
101 .addr = tj9->client->addr,
102 .flags = tj9->client->flags,
107 .addr = tj9->client->addr,
108 .flags = tj9->client->flags | I2C_M_RD,
114 return i2c_transfer(tj9->client->adapter, msgs, 2);
117 static void kxtj9_report_acceleration_data(struct kxtj9_data *tj9)
119 s16 acc_data[3]; /* Data bytes from hardware xL, xH, yL, yH, zL, zH */
123 err = kxtj9_i2c_read(tj9, XOUT_L, (u8 *)acc_data, 6);
125 dev_err(&tj9->client->dev, "accelerometer data read failed\n");
127 x = le16_to_cpu(acc_data[tj9->pdata.axis_map_x]);
128 y = le16_to_cpu(acc_data[tj9->pdata.axis_map_y]);
129 z = le16_to_cpu(acc_data[tj9->pdata.axis_map_z]);
135 input_report_abs(tj9->input_dev, ABS_X, tj9->pdata.negate_x ? -x : x);
136 input_report_abs(tj9->input_dev, ABS_Y, tj9->pdata.negate_y ? -y : y);
137 input_report_abs(tj9->input_dev, ABS_Z, tj9->pdata.negate_z ? -z : z);
138 input_sync(tj9->input_dev);
141 static irqreturn_t kxtj9_isr(int irq, void *dev)
143 struct kxtj9_data *tj9 = dev;
146 /* data ready is the only possible interrupt type */
147 kxtj9_report_acceleration_data(tj9);
149 err = i2c_smbus_read_byte_data(tj9->client, INT_REL);
151 dev_err(&tj9->client->dev,
152 "error clearing interrupt status: %d\n", err);
157 static int kxtj9_update_g_range(struct kxtj9_data *tj9, u8 new_g_range)
159 switch (new_g_range) {
173 tj9->ctrl_reg1 &= 0xe7;
174 tj9->ctrl_reg1 |= new_g_range;
179 static int kxtj9_update_odr(struct kxtj9_data *tj9, unsigned int poll_interval)
184 /* Use the lowest ODR that can support the requested poll interval */
185 for (i = 0; i < ARRAY_SIZE(kxtj9_odr_table); i++) {
186 tj9->data_ctrl = kxtj9_odr_table[i].mask;
187 if (poll_interval < kxtj9_odr_table[i].cutoff)
191 err = i2c_smbus_write_byte_data(tj9->client, CTRL_REG1, 0);
195 err = i2c_smbus_write_byte_data(tj9->client, DATA_CTRL, tj9->data_ctrl);
199 err = i2c_smbus_write_byte_data(tj9->client, CTRL_REG1, tj9->ctrl_reg1);
206 static int kxtj9_device_power_on(struct kxtj9_data *tj9)
208 if (tj9->pdata.power_on)
209 return tj9->pdata.power_on();
214 static void kxtj9_device_power_off(struct kxtj9_data *tj9)
218 tj9->ctrl_reg1 &= PC1_OFF;
219 err = i2c_smbus_write_byte_data(tj9->client, CTRL_REG1, tj9->ctrl_reg1);
221 dev_err(&tj9->client->dev, "soft power off failed\n");
223 if (tj9->pdata.power_off)
224 tj9->pdata.power_off();
227 static int kxtj9_enable(struct kxtj9_data *tj9)
231 err = kxtj9_device_power_on(tj9);
235 /* ensure that PC1 is cleared before updating control registers */
236 err = i2c_smbus_write_byte_data(tj9->client, CTRL_REG1, 0);
240 /* only write INT_CTRL_REG1 if in irq mode */
241 if (tj9->client->irq) {
242 err = i2c_smbus_write_byte_data(tj9->client,
243 INT_CTRL1, tj9->int_ctrl);
248 err = kxtj9_update_g_range(tj9, tj9->pdata.g_range);
252 /* turn on outputs */
253 tj9->ctrl_reg1 |= PC1_ON;
254 err = i2c_smbus_write_byte_data(tj9->client, CTRL_REG1, tj9->ctrl_reg1);
258 err = kxtj9_update_odr(tj9, tj9->last_poll_interval);
262 /* clear initial interrupt if in irq mode */
263 if (tj9->client->irq) {
264 err = i2c_smbus_read_byte_data(tj9->client, INT_REL);
266 dev_err(&tj9->client->dev,
267 "error clearing interrupt: %d\n", err);
275 kxtj9_device_power_off(tj9);
279 static void kxtj9_disable(struct kxtj9_data *tj9)
281 kxtj9_device_power_off(tj9);
284 static int kxtj9_input_open(struct input_dev *input)
286 struct kxtj9_data *tj9 = input_get_drvdata(input);
288 return kxtj9_enable(tj9);
291 static void kxtj9_input_close(struct input_dev *dev)
293 struct kxtj9_data *tj9 = input_get_drvdata(dev);
298 static void __devinit kxtj9_init_input_device(struct kxtj9_data *tj9,
299 struct input_dev *input_dev)
301 __set_bit(EV_ABS, input_dev->evbit);
302 input_set_abs_params(input_dev, ABS_X, -G_MAX, G_MAX, FUZZ, FLAT);
303 input_set_abs_params(input_dev, ABS_Y, -G_MAX, G_MAX, FUZZ, FLAT);
304 input_set_abs_params(input_dev, ABS_Z, -G_MAX, G_MAX, FUZZ, FLAT);
306 input_dev->name = "kxtj9_accel";
307 input_dev->id.bustype = BUS_I2C;
308 input_dev->dev.parent = &tj9->client->dev;
311 static int __devinit kxtj9_setup_input_device(struct kxtj9_data *tj9)
313 struct input_dev *input_dev;
316 input_dev = input_allocate_device();
318 dev_err(&tj9->client->dev, "input device allocate failed\n");
322 tj9->input_dev = input_dev;
324 input_dev->open = kxtj9_input_open;
325 input_dev->close = kxtj9_input_close;
326 input_set_drvdata(input_dev, tj9);
328 kxtj9_init_input_device(tj9, input_dev);
330 err = input_register_device(tj9->input_dev);
332 dev_err(&tj9->client->dev,
333 "unable to register input polled device %s: %d\n",
334 tj9->input_dev->name, err);
335 input_free_device(tj9->input_dev);
343 * When IRQ mode is selected, we need to provide an interface to allow the user
344 * to change the output data rate of the part. For consistency, we are using
345 * the set_poll method, which accepts a poll interval in milliseconds, and then
346 * calls update_odr() while passing this value as an argument. In IRQ mode, the
347 * data outputs will not be read AT the requested poll interval, rather, the
348 * lowest ODR that can support the requested interval. The client application
349 * will be responsible for retrieving data from the input node at the desired
353 /* Returns currently selected poll interval (in ms) */
354 static ssize_t kxtj9_get_poll(struct device *dev,
355 struct device_attribute *attr, char *buf)
357 struct i2c_client *client = to_i2c_client(dev);
358 struct kxtj9_data *tj9 = i2c_get_clientdata(client);
360 return sprintf(buf, "%d\n", tj9->last_poll_interval);
363 /* Allow users to select a new poll interval (in ms) */
364 static ssize_t kxtj9_set_poll(struct device *dev, struct device_attribute *attr,
365 const char *buf, size_t count)
367 struct i2c_client *client = to_i2c_client(dev);
368 struct kxtj9_data *tj9 = i2c_get_clientdata(client);
369 struct input_dev *input_dev = tj9->input_dev;
370 unsigned int interval;
373 error = kstrtouint(buf, 10, &interval);
377 /* Lock the device to prevent races with open/close (and itself) */
378 mutex_lock(&input_dev->mutex);
380 disable_irq(client->irq);
383 * Set current interval to the greater of the minimum interval or
384 * the requested interval
386 tj9->last_poll_interval = max(interval, tj9->pdata.min_interval);
388 kxtj9_update_odr(tj9, tj9->last_poll_interval);
390 enable_irq(client->irq);
391 mutex_unlock(&input_dev->mutex);
396 static DEVICE_ATTR(poll, S_IRUGO|S_IWUSR, kxtj9_get_poll, kxtj9_set_poll);
398 static struct attribute *kxtj9_attributes[] = {
403 static struct attribute_group kxtj9_attribute_group = {
404 .attrs = kxtj9_attributes
408 #ifdef CONFIG_INPUT_KXTJ9_POLLED_MODE
409 static void kxtj9_poll(struct input_polled_dev *dev)
411 struct kxtj9_data *tj9 = dev->private;
412 unsigned int poll_interval = dev->poll_interval;
414 kxtj9_report_acceleration_data(tj9);
416 if (poll_interval != tj9->last_poll_interval) {
417 kxtj9_update_odr(tj9, poll_interval);
418 tj9->last_poll_interval = poll_interval;
422 static void kxtj9_polled_input_open(struct input_polled_dev *dev)
424 struct kxtj9_data *tj9 = dev->private;
429 static void kxtj9_polled_input_close(struct input_polled_dev *dev)
431 struct kxtj9_data *tj9 = dev->private;
436 static int __devinit kxtj9_setup_polled_device(struct kxtj9_data *tj9)
439 struct input_polled_dev *poll_dev;
440 poll_dev = input_allocate_polled_device();
443 dev_err(&tj9->client->dev,
444 "Failed to allocate polled device\n");
448 tj9->poll_dev = poll_dev;
449 tj9->input_dev = poll_dev->input;
451 poll_dev->private = tj9;
452 poll_dev->poll = kxtj9_poll;
453 poll_dev->open = kxtj9_polled_input_open;
454 poll_dev->close = kxtj9_polled_input_close;
456 kxtj9_init_input_device(tj9, poll_dev->input);
458 err = input_register_polled_device(poll_dev);
460 dev_err(&tj9->client->dev,
461 "Unable to register polled device, err=%d\n", err);
462 input_free_polled_device(poll_dev);
469 static void __devexit kxtj9_teardown_polled_device(struct kxtj9_data *tj9)
471 input_unregister_polled_device(tj9->poll_dev);
472 input_free_polled_device(tj9->poll_dev);
477 static inline int kxtj9_setup_polled_device(struct kxtj9_data *tj9)
482 static inline void kxtj9_teardown_polled_device(struct kxtj9_data *tj9)
488 static int __devinit kxtj9_verify(struct kxtj9_data *tj9)
492 retval = kxtj9_device_power_on(tj9);
496 retval = i2c_smbus_read_byte_data(tj9->client, WHO_AM_I);
498 dev_err(&tj9->client->dev, "read err int source\n");
502 retval = (retval != 0x07 && retval != 0x08) ? -EIO : 0;
505 kxtj9_device_power_off(tj9);
509 static int __devinit kxtj9_probe(struct i2c_client *client,
510 const struct i2c_device_id *id)
512 const struct kxtj9_platform_data *pdata = client->dev.platform_data;
513 struct kxtj9_data *tj9;
516 if (!i2c_check_functionality(client->adapter,
517 I2C_FUNC_I2C | I2C_FUNC_SMBUS_BYTE_DATA)) {
518 dev_err(&client->dev, "client is not i2c capable\n");
523 dev_err(&client->dev, "platform data is NULL; exiting\n");
527 tj9 = kzalloc(sizeof(*tj9), GFP_KERNEL);
529 dev_err(&client->dev,
530 "failed to allocate memory for module data\n");
534 tj9->client = client;
543 err = kxtj9_verify(tj9);
545 dev_err(&client->dev, "device not recognized\n");
549 i2c_set_clientdata(client, tj9);
551 tj9->ctrl_reg1 = tj9->pdata.res_12bit | tj9->pdata.g_range;
552 tj9->last_poll_interval = tj9->pdata.init_interval;
555 /* If in irq mode, populate INT_CTRL_REG1 and enable DRDY. */
556 tj9->int_ctrl |= KXTJ9_IEN | KXTJ9_IEA | KXTJ9_IEL;
557 tj9->ctrl_reg1 |= DRDYE;
559 err = kxtj9_setup_input_device(tj9);
563 err = request_threaded_irq(client->irq, NULL, kxtj9_isr,
564 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
567 dev_err(&client->dev, "request irq failed: %d\n", err);
568 goto err_destroy_input;
571 err = sysfs_create_group(&client->dev.kobj, &kxtj9_attribute_group);
573 dev_err(&client->dev, "sysfs create failed: %d\n", err);
578 err = kxtj9_setup_polled_device(tj9);
586 free_irq(client->irq, tj9);
588 input_unregister_device(tj9->input_dev);
597 static int __devexit kxtj9_remove(struct i2c_client *client)
599 struct kxtj9_data *tj9 = i2c_get_clientdata(client);
602 sysfs_remove_group(&client->dev.kobj, &kxtj9_attribute_group);
603 free_irq(client->irq, tj9);
604 input_unregister_device(tj9->input_dev);
606 kxtj9_teardown_polled_device(tj9);
617 #ifdef CONFIG_PM_SLEEP
618 static int kxtj9_suspend(struct device *dev)
620 struct i2c_client *client = to_i2c_client(dev);
621 struct kxtj9_data *tj9 = i2c_get_clientdata(client);
622 struct input_dev *input_dev = tj9->input_dev;
624 mutex_lock(&input_dev->mutex);
626 if (input_dev->users)
629 mutex_unlock(&input_dev->mutex);
633 static int kxtj9_resume(struct device *dev)
635 struct i2c_client *client = to_i2c_client(dev);
636 struct kxtj9_data *tj9 = i2c_get_clientdata(client);
637 struct input_dev *input_dev = tj9->input_dev;
640 mutex_lock(&input_dev->mutex);
642 if (input_dev->users)
645 mutex_unlock(&input_dev->mutex);
650 static SIMPLE_DEV_PM_OPS(kxtj9_pm_ops, kxtj9_suspend, kxtj9_resume);
652 static const struct i2c_device_id kxtj9_id[] = {
657 MODULE_DEVICE_TABLE(i2c, kxtj9_id);
659 static struct i2c_driver kxtj9_driver = {
662 .owner = THIS_MODULE,
665 .probe = kxtj9_probe,
666 .remove = kxtj9_remove,
667 .id_table = kxtj9_id,
670 module_i2c_driver(kxtj9_driver);
672 MODULE_DESCRIPTION("KXTJ9 accelerometer driver");
673 MODULE_AUTHOR("Chris Hudson <chudson@kionix.com>");
674 MODULE_LICENSE("GPL");