* [PATCH v2] input: Add support for Kionix KXTJ9 accelerometer
@ 2011-05-16 18:39 chudson
2011-05-17 9:22 ` Jonathan Cameron
0 siblings, 1 reply; 2+ messages in thread
From: chudson @ 2011-05-16 18:39 UTC (permalink / raw)
To: linux-input; +Cc: dmitry.torokhov, alan, jic23, chudson
From: <chudson@kionix.com>
Changes from v1:
- odr_table changed to static const
- i2c function returns simplified
- memcpy used for filling write buffer in i2c_write function
- dev_err call removed from update_g_range function
- locks added to sysfs functions
- 3/5 sysfs nodes removed; we need to keep enable and delay
- switched to using i2c_board_info->irq instead of passing in the raw GPIO
- added some comments documenting sysfs nodes and platform data structure
- removed disable_irq calls in case the irq is shared
- fixed memory leaks in probe function
- changed to threaded irq format
Please let me know if I missed anything or what else should be changed.
Signed-off-by: Chris Hudson <chudson@kionix.com>
---
drivers/input/misc/Kconfig | 10 +
drivers/input/misc/Makefile | 1 +
drivers/input/misc/kxtj9.c | 721 +++++++++++++++++++++++++++++++++++++++++++
include/linux/input/kxtj9.h | 86 +++++
4 files changed, 818 insertions(+), 0 deletions(-)
create mode 100644 drivers/input/misc/kxtj9.c
create mode 100644 include/linux/input/kxtj9.h
diff --git a/drivers/input/misc/Kconfig b/drivers/input/misc/Kconfig
index f9cf088..567f3d2 100644
--- a/drivers/input/misc/Kconfig
+++ b/drivers/input/misc/Kconfig
@@ -467,4 +467,14 @@ config INPUT_XEN_KBDDEV_FRONTEND
To compile this driver as a module, choose M here: the
module will be called xen-kbdfront.
+config INPUT_KXTJ9
+ tristate "Kionix KXTJ9 tri-axis digital accelerometer"
+ depends on I2C && SYSFS
+ help
+ If you say yes here you get support for the Kionix KXTJ9 digital
+ tri-axis accelerometer.
+
+ This driver can also be built as a module. If so, the module
+ will be called kxtj9.
+
endif
diff --git a/drivers/input/misc/Makefile b/drivers/input/misc/Makefile
index e3f7984..f2477ef 100644
--- a/drivers/input/misc/Makefile
+++ b/drivers/input/misc/Makefile
@@ -25,6 +25,7 @@ obj-$(CONFIG_INPUT_DM355EVM) += dm355evm_keys.o
obj-$(CONFIG_HP_SDC_RTC) += hp_sdc_rtc.o
obj-$(CONFIG_INPUT_IXP4XX_BEEPER) += ixp4xx-beeper.o
obj-$(CONFIG_INPUT_KEYSPAN_REMOTE) += keyspan_remote.o
+obj-$(CONFIG_INPUT_KXTJ9) += kxtj9.o
obj-$(CONFIG_INPUT_M68K_BEEP) += m68kspkr.o
obj-$(CONFIG_INPUT_MAX8925_ONKEY) += max8925_onkey.o
obj-$(CONFIG_INPUT_PCAP) += pcap_keys.o
diff --git a/drivers/input/misc/kxtj9.c b/drivers/input/misc/kxtj9.c
new file mode 100644
index 0000000..a757c3e
--- /dev/null
+++ b/drivers/input/misc/kxtj9.c
@@ -0,0 +1,721 @@
+/*
+ * Copyright (C) 2011 Kionix, Inc.
+ * Written by Chris Hudson <chudson@kionix.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+ * 02111-1307, USA
+ */
+
+#include <linux/err.h>
+#include <linux/errno.h>
+#include <linux/delay.h>
+#include <linux/fs.h>
+#include <linux/i2c.h>
+#include <linux/input.h>
+#include <linux/uaccess.h>
+#include <linux/workqueue.h>
+#include <linux/irq.h>
+#include <linux/kthread.h>
+#include <linux/interrupt.h>
+#include <linux/slab.h>
+#include <linux/input/kxtj9.h>
+
+#define NAME "kxtj9"
+#define G_MAX 8000
+/* OUTPUT REGISTERS */
+#define XOUT_L 0x06
+#define WHO_AM_I 0x0F
+/* CONTROL REGISTERS */
+#define INT_REL 0x1A
+#define CTRL_REG1 0x1B
+#define INT_CTRL1 0x1E
+#define DATA_CTRL 0x21
+/* CONTROL REGISTER 1 BITS */
+#define PC1_OFF 0x7F
+#define PC1_ON 0x80
+/* INPUT_ABS CONSTANTS */
+#define FUZZ 3
+#define FLAT 3
+/* RESUME STATE INDICES */
+#define RES_DATA_CTRL 0
+#define RES_CTRL_REG1 1
+#define RES_INT_CTRL1 2
+#define RESUME_ENTRIES 3
+
+/*
+ * The following table lists the maximum appropriate poll interval for each
+ * available output data rate.
+ */
+static const struct {
+ unsigned int cutoff;
+ u8 mask;
+} kxtj9_odr_table[] = {
+ {
+ 3, ODR800F}, {
+ 5, ODR400F}, {
+ 10, ODR200F}, {
+ 20, ODR100F}, {
+ 40, ODR50F}, {
+ 80, ODR25F}, {
+ 0, ODR12_5F},
+};
+
+struct kxtj9_data {
+ struct i2c_client *client;
+ struct kxtj9_platform_data *pdata;
+ struct mutex lock;
+ struct delayed_work input_work;
+ struct input_dev *input_dev;
+
+ int hw_initialized;
+ atomic_t enabled;
+ u8 resume[RESUME_ENTRIES];
+ int res_interval;
+ int drdy_enabled;
+ int irq;
+};
+
+static int kxtj9_i2c_read(struct kxtj9_data *tj9, u8 addr, u8 *data, int len)
+{
+ int err;
+
+ struct i2c_msg msgs[] = {
+ {
+ .addr = tj9->client->addr,
+ .flags = tj9->client->flags,
+ .len = 1,
+ .buf = &addr,
+ },
+ {
+ .addr = tj9->client->addr,
+ .flags = tj9->client->flags | I2C_M_RD,
+ .len = len,
+ .buf = data,
+ },
+ };
+ err = i2c_transfer(tj9->client->adapter, msgs, 2);
+
+ return err;
+}
+
+static int kxtj9_i2c_write(struct kxtj9_data *tj9, u8 addr, u8 *data, int len)
+{
+ int err;
+ u8 buf[len + 1];
+
+ struct i2c_msg msgs[] = {
+ {
+ .addr = tj9->client->addr,
+ .flags = tj9->client->flags,
+ .len = len + 1,
+ .buf = buf,
+ },
+ };
+
+ buf[0] = addr;
+ memcpy(buf + 1, data, len);
+
+ err = i2c_transfer(tj9->client->adapter, msgs, 1);
+
+ return err;
+}
+
+static int kxtj9_verify(struct kxtj9_data *tj9)
+{
+ int err;
+ u8 buf;
+
+ err = kxtj9_i2c_read(tj9, WHO_AM_I, &buf, 1);
+ if (err < 0)
+ dev_err(&tj9->client->dev, "read err int source\n");
+ if (buf != 0x06)
+ err = -1;
+
+ return err;
+}
+
+int kxtj9_update_g_range(struct kxtj9_data *tj9, u8 new_g_range)
+{
+ int err;
+ u8 shift;
+ u8 buf;
+ u8 out;
+
+ switch (new_g_range) {
+ case KXTJ9_G_2G:
+ shift = SHIFT_ADJ_2G;
+ break;
+ case KXTJ9_G_4G:
+ shift = SHIFT_ADJ_4G;
+ break;
+ case KXTJ9_G_8G:
+ shift = SHIFT_ADJ_8G;
+ break;
+ default:
+ return -EINVAL;
+ }
+
+ out = (tj9->resume[RES_CTRL_REG1] & 0xE7) | new_g_range;
+ if (shift != tj9->pdata->shift_adj) {
+ if (atomic_read(&tj9->enabled)) {
+ buf = 0;
+ err = kxtj9_i2c_write(tj9, CTRL_REG1, &buf, 1);
+ if (err < 0)
+ return err;
+ err = kxtj9_i2c_write(tj9, CTRL_REG1, &out, 1);
+ if (err < 0)
+ return err;
+ }
+ }
+
+ tj9->resume[RES_CTRL_REG1] = out;
+ tj9->pdata->shift_adj = shift;
+
+ return 0;
+}
+
+int kxtj9_update_odr(struct kxtj9_data *tj9, int poll_interval)
+{
+ int err = -1;
+ int i;
+ u8 config;
+ u8 temp = 0;
+
+ /* Use the lowest ODR that can support the requested poll interval */
+ for (i = 0; i < ARRAY_SIZE(kxtj9_odr_table); i++) {
+ config = kxtj9_odr_table[i].mask;
+ if (poll_interval < kxtj9_odr_table[i].cutoff)
+ break;
+ }
+
+ if (atomic_read(&tj9->enabled)) {
+ err = kxtj9_i2c_write(tj9, CTRL_REG1, &temp, 1);
+ if (err < 0)
+ return err;
+ err = kxtj9_i2c_write(tj9, DATA_CTRL, &config, 1);
+ if (err < 0)
+ return err;
+ temp = tj9->resume[RES_CTRL_REG1];
+ err = kxtj9_i2c_write(tj9, CTRL_REG1, &temp, 1);
+ if (err < 0)
+ return err;
+ /* Valid input_dev indicates that input_init passed and this
+ * workqueue is available */
+ if (tj9->input_dev) {
+ cancel_delayed_work_sync(&tj9->input_work);
+ schedule_delayed_work(&tj9->input_work,
+ msecs_to_jiffies(poll_interval));
+ }
+ }
+ tj9->resume[RES_DATA_CTRL] = config;
+
+ return 0;
+}
+
+static int kxtj9_hw_init(struct kxtj9_data *tj9)
+{
+ int err;
+ u8 buf = 0;
+
+ err = kxtj9_i2c_write(tj9, CTRL_REG1, &buf, 1);
+ if (err < 0)
+ return err;
+ err = kxtj9_i2c_write(tj9, DATA_CTRL, &tj9->resume[RES_DATA_CTRL], 1);
+ if (err < 0)
+ return err;
+ err = kxtj9_i2c_write(tj9, INT_CTRL1, &tj9->resume[RES_INT_CTRL1], 1);
+ if (err < 0)
+ return err;
+
+ err = kxtj9_update_g_range(tj9, tj9->pdata->g_range);
+ if (err < 0)
+ return err;
+
+ buf = (tj9->resume[RES_CTRL_REG1] | PC1_ON);
+ err = kxtj9_i2c_write(tj9, CTRL_REG1, &buf, 1);
+ if (err < 0)
+ return err;
+ tj9->resume[RES_CTRL_REG1] = buf;
+
+ if ((buf & DRDYE) > 0)
+ tj9->drdy_enabled = 1;
+ else
+ tj9->drdy_enabled = 0;
+
+ err = kxtj9_update_odr(tj9, tj9->res_interval);
+ if (err < 0)
+ return err;
+
+ tj9->hw_initialized = 1;
+
+ return 0;
+}
+
+static void kxtj9_device_power_off(struct kxtj9_data *tj9)
+{
+ int err;
+ u8 buf;
+
+ buf = tj9->resume[RES_CTRL_REG1] & PC1_OFF;
+ err = kxtj9_i2c_write(tj9, CTRL_REG1, &buf, 1);
+ if (err < 0)
+ dev_err(&tj9->client->dev, "soft power off failed\n");
+ if (tj9->pdata->power_off)
+ tj9->pdata->power_off();
+ tj9->resume[RES_CTRL_REG1] = buf;
+ tj9->hw_initialized = 0;
+}
+
+static int kxtj9_device_power_on(struct kxtj9_data *tj9)
+{
+ int err;
+
+ if (tj9->pdata->power_on) {
+ err = tj9->pdata->power_on();
+ if (err < 0)
+ return err;
+ }
+ if (!tj9->hw_initialized) {
+ mdelay(40);
+ err = kxtj9_hw_init(tj9);
+ if (err < 0) {
+ kxtj9_device_power_off(tj9);
+ return err;
+ }
+ }
+
+ return 0;
+}
+
+static void kxtj9_report_values(struct kxtj9_data *tj9, int *xyz)
+{
+ input_report_abs(tj9->input_dev, ABS_X, xyz[0]);
+ input_report_abs(tj9->input_dev, ABS_Y, xyz[1]);
+ input_report_abs(tj9->input_dev, ABS_Z, xyz[2]);
+}
+
+static int kxtj9_get_acceleration_data(struct kxtj9_data *tj9, int *xyz)
+{
+ int err;
+ /* Data bytes from hardware xL, xH, yL, yH, zL, zH */
+ u8 acc_data[6];
+ /* x,y,z hardware values */
+ int hw_d[3];
+
+ err = kxtj9_i2c_read(tj9, XOUT_L, acc_data, 6);
+ if (err < 0)
+ return err;
+
+
+ hw_d[0] = (int) (((acc_data[1]) << 8) | acc_data[0]);
+ hw_d[1] = (int) (((acc_data[3]) << 8) | acc_data[2]);
+ hw_d[2] = (int) (((acc_data[5]) << 8) | acc_data[4]);
+
+ if (hw_d[0] & 0x8000)
+ hw_d[0] |= 0xFFFF0000;
+ if (hw_d[1] & 0x8000)
+ hw_d[1] |= 0xFFFF0000;
+ if (hw_d[2] & 0x8000)
+ hw_d[2] |= 0xFFFF0000;
+
+ hw_d[0] >>= tj9->pdata->shift_adj;
+ hw_d[1] >>= tj9->pdata->shift_adj;
+ hw_d[2] >>= tj9->pdata->shift_adj;
+
+ xyz[0] = ((tj9->pdata->negate_x) ? (-hw_d[tj9->pdata->axis_map_x])
+ : (hw_d[tj9->pdata->axis_map_x]));
+ xyz[1] = ((tj9->pdata->negate_y) ? (-hw_d[tj9->pdata->axis_map_y])
+ : (hw_d[tj9->pdata->axis_map_y]));
+ xyz[2] = ((tj9->pdata->negate_z) ? (-hw_d[tj9->pdata->axis_map_z])
+ : (hw_d[tj9->pdata->axis_map_z]));
+
+ return err;
+}
+
+static irqreturn_t kxtj9_isr(int irq, void *dev)
+{
+ struct kxtj9_data *tj9 = dev;
+ int err;
+ u8 buf;
+ int xyz[3];
+
+ /* data ready is the only possible interrupt type */
+ if (kxtj9_get_acceleration_data(tj9, xyz) == 0)
+ kxtj9_report_values(tj9, xyz);
+
+ err = kxtj9_i2c_read(tj9, INT_REL, &buf, 1);
+ if (err < 0)
+ dev_err(&tj9->client->dev,
+ "error clearing interrupt status: %d\n", err);
+
+ return IRQ_HANDLED;
+}
+
+static int kxtj9_enable(struct kxtj9_data *tj9)
+{
+ int err;
+ u8 buf;
+
+ if (!atomic_cmpxchg(&tj9->enabled, 0, 1)) {
+ err = kxtj9_device_power_on(tj9);
+ err = kxtj9_i2c_read(tj9, INT_REL, &buf, 1);
+ if (err < 0) {
+ dev_err(&tj9->client->dev,
+ "error clearing interrupt: %d\n", err);
+ atomic_set(&tj9->enabled, 0);
+ return err;
+ }
+ schedule_delayed_work(&tj9->input_work,
+ msecs_to_jiffies(tj9->res_interval));
+ }
+
+ return 0;
+}
+
+static int kxtj9_disable(struct kxtj9_data *tj9)
+{
+ if (atomic_cmpxchg(&tj9->enabled, 1, 0)) {
+ cancel_delayed_work_sync(&tj9->input_work);
+ kxtj9_device_power_off(tj9);
+ }
+
+ return 0;
+}
+
+static void kxtj9_input_work_func(struct work_struct *work)
+{
+ struct kxtj9_data *tj9 = container_of((struct delayed_work *)work,
+ struct kxtj9_data, input_work);
+ int xyz[3] = { 0 };
+
+ if (tj9->drdy_enabled == 0) {
+ mutex_lock(&tj9->lock);
+
+ if (kxtj9_get_acceleration_data(tj9, xyz) == 0)
+ kxtj9_report_values(tj9, xyz);
+
+ schedule_delayed_work(&tj9->input_work,
+ msecs_to_jiffies(tj9->res_interval));
+ mutex_unlock(&tj9->lock);
+ }
+}
+
+int kxtj9_input_open(struct input_dev *input)
+{
+ struct kxtj9_data *tj9 = input_get_drvdata(input);
+
+ return kxtj9_enable(tj9);
+}
+
+void kxtj9_input_close(struct input_dev *dev)
+{
+ struct kxtj9_data *tj9 = input_get_drvdata(dev);
+
+ kxtj9_disable(tj9);
+}
+
+static int kxtj9_input_init(struct kxtj9_data *tj9)
+{
+ int err;
+
+ INIT_DELAYED_WORK(&tj9->input_work, kxtj9_input_work_func);
+ tj9->input_dev = input_allocate_device();
+ if (!tj9->input_dev) {
+ err = -ENOMEM;
+ dev_err(&tj9->client->dev, "input device allocate failed\n");
+ goto err0;
+ }
+ tj9->input_dev->open = kxtj9_input_open;
+ tj9->input_dev->close = kxtj9_input_close;
+
+ input_set_drvdata(tj9->input_dev, tj9);
+
+ set_bit(EV_ABS, tj9->input_dev->evbit);
+ set_bit(EV_REL, tj9->input_dev->evbit);
+
+ input_set_abs_params(tj9->input_dev, ABS_X, -G_MAX, G_MAX, FUZZ, FLAT);
+ input_set_abs_params(tj9->input_dev, ABS_Y, -G_MAX, G_MAX, FUZZ, FLAT);
+ input_set_abs_params(tj9->input_dev, ABS_Z, -G_MAX, G_MAX, FUZZ, FLAT);
+
+ tj9->input_dev->name = "kxtj9_accel";
+
+ err = input_register_device(tj9->input_dev);
+ if (err) {
+ dev_err(&tj9->client->dev,
+ "unable to register input polled device %s: %d\n",
+ tj9->input_dev->name, err);
+ goto err1;
+ }
+
+ return 0;
+err1:
+ input_free_device(tj9->input_dev);
+err0:
+ return err;
+}
+
+static void kxtj9_input_cleanup(struct kxtj9_data *tj9)
+{
+ input_unregister_device(tj9->input_dev);
+}
+
+/* sysfs */
+
+/* kxtj9_delay_show: returns the currently selected poll interval */
+static ssize_t kxtj9_delay_show(struct device *dev,
+ struct device_attribute *attr, char *buf)
+{
+ struct i2c_client *client = to_i2c_client(dev);
+ struct kxtj9_data *tj9 = i2c_get_clientdata(client);
+ return sprintf(buf, "%d\n", tj9->res_interval);
+}
+
+/* kxtj9_delay_store: allows the user to select a new poll interval */
+static ssize_t kxtj9_delay_store(struct device *dev,
+ struct device_attribute *attr,
+ const char *buf, size_t count)
+{
+ struct i2c_client *client = to_i2c_client(dev);
+ struct kxtj9_data *tj9 = i2c_get_clientdata(client);
+ unsigned long val;
+ int ret = kstrtoul(buf, 10, &val);
+ if (ret < 0)
+ return ret;
+
+ mutex_lock(&tj9->lock);
+ /* the selected interval is the greater of the minimum interval or
+ the requested interval */
+ tj9->res_interval = max((int)val, tj9->pdata->min_interval);
+ kxtj9_update_odr(tj9, tj9->res_interval);
+ mutex_unlock(&tj9->lock);
+
+ return count;
+}
+
+/* kxtj9_enable_show: returns the enable status of the part */
+static ssize_t kxtj9_enable_show(struct device *dev,
+ struct device_attribute *attr, char *buf)
+{
+ struct i2c_client *client = to_i2c_client(dev);
+ struct kxtj9_data *tj9 = i2c_get_clientdata(client);
+ return sprintf(buf, "%d\n", atomic_read(&tj9->enabled));
+}
+
+/* kxtj9_enable_store: allows the user to enable or disable the part */
+static ssize_t kxtj9_enable_store(struct device *dev,
+ struct device_attribute *attr,
+ const char *buf, size_t count)
+{
+ struct i2c_client *client = to_i2c_client(dev);
+ struct kxtj9_data *tj9 = i2c_get_clientdata(client);
+ unsigned long val;
+ int ret = kstrtoul(buf, 10, &val);
+ if (ret < 0)
+ return ret;
+
+ mutex_lock(&tj9->lock);
+ if (val) /* non-zero argument enables the part */
+ kxtj9_enable(tj9);
+ else /* zero argument disables the part */
+ kxtj9_disable(tj9);
+ mutex_unlock(&tj9->lock);
+
+ return count;
+}
+
+static DEVICE_ATTR(delay, S_IRUGO|S_IWUSR, kxtj9_delay_show, kxtj9_delay_store);
+static DEVICE_ATTR(enable, S_IRUGO|S_IWUSR, kxtj9_enable_show,
+ kxtj9_enable_store);
+
+static struct attribute *kxtj9_attributes[] = {
+ &dev_attr_delay.attr,
+ &dev_attr_enable.attr,
+ NULL
+};
+
+static struct attribute_group kxtj9_attribute_group = {
+ .attrs = kxtj9_attributes
+};
+/* /sysfs */
+
+static int __devinit kxtj9_probe(struct i2c_client *client,
+ const struct i2c_device_id *id)
+{
+ int err = -1;
+ struct kxtj9_data *tj9 = kzalloc(sizeof(*tj9), GFP_KERNEL);
+ if (tj9 == NULL) {
+ dev_err(&client->dev,
+ "failed to allocate memory for module data\n");
+ err = -ENOMEM;
+ goto err0;
+ }
+ if (client->dev.platform_data == NULL) {
+ dev_err(&client->dev, "platform data is NULL; exiting\n");
+ err = -ENODEV;
+ goto err0;
+ }
+ if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
+ dev_err(&client->dev, "client not i2c capable\n");
+ err = -ENODEV;
+ goto err0;
+ }
+ mutex_init(&tj9->lock);
+ mutex_lock(&tj9->lock);
+ tj9->client = client;
+ i2c_set_clientdata(client, tj9);
+
+ tj9->pdata = kmalloc(sizeof(*tj9->pdata), GFP_KERNEL);
+ if (tj9->pdata == NULL)
+ goto err1;
+
+ err = sysfs_create_group(&client->dev.kobj, &kxtj9_attribute_group);
+ if (err)
+ goto err1;
+
+ memcpy(tj9->pdata, client->dev.platform_data, sizeof(*tj9->pdata));
+ if (tj9->pdata->init) {
+ err = tj9->pdata->init();
+ if (err < 0)
+ goto err2;
+ }
+
+ memset(tj9->resume, 0, ARRAY_SIZE(tj9->resume));
+ tj9->resume[RES_DATA_CTRL] = tj9->pdata->data_odr_init;
+ tj9->resume[RES_CTRL_REG1] = tj9->pdata->ctrl_reg1_init;
+ tj9->resume[RES_INT_CTRL1] = tj9->pdata->int_ctrl_init;
+ tj9->res_interval = tj9->pdata->poll_interval;
+
+ err = kxtj9_device_power_on(tj9);
+ if (err < 0)
+ goto err3;
+ atomic_set(&tj9->enabled, 1);
+
+ err = kxtj9_verify(tj9);
+ if (err < 0) {
+ dev_err(&client->dev, "unresolved i2c client\n");
+ goto err4;
+ }
+
+ err = kxtj9_update_g_range(tj9, tj9->pdata->g_range);
+ if (err < 0)
+ goto err4;
+
+ err = kxtj9_update_odr(tj9, tj9->res_interval);
+ if (err < 0)
+ goto err4;
+
+ err = kxtj9_input_init(tj9);
+ if (err < 0)
+ goto err4;
+
+ kxtj9_device_power_off(tj9);
+ atomic_set(&tj9->enabled, 0);
+
+ if (client->irq) {
+ tj9->irq = client->irq;
+ err = request_threaded_irq(tj9->irq, NULL, kxtj9_isr,
+ IRQF_TRIGGER_RISING, "kxtj9-irq", tj9);
+ if (err < 0) {
+ pr_err("%s: request irq failed: %d\n", __func__, err);
+ goto err5;
+ }
+ }
+
+ mutex_unlock(&tj9->lock);
+
+ return 0;
+
+err5:
+ kxtj9_input_cleanup(tj9);
+err4:
+ kxtj9_device_power_off(tj9);
+err3:
+ if (tj9->pdata->exit)
+ tj9->pdata->exit();
+err2:
+ kfree(tj9->pdata);
+ sysfs_remove_group(&client->dev.kobj, &kxtj9_attribute_group);
+err1:
+ mutex_unlock(&tj9->lock);
+err0:
+ kfree(tj9);
+ return err;
+}
+
+static int __devexit kxtj9_remove(struct i2c_client *client)
+{
+ struct kxtj9_data *tj9 = i2c_get_clientdata(client);
+
+ free_irq(tj9->irq, tj9);
+ kxtj9_input_cleanup(tj9);
+ kxtj9_device_power_off(tj9);
+ if (tj9->pdata->exit)
+ tj9->pdata->exit();
+ kfree(tj9->pdata);
+ sysfs_remove_group(&client->dev.kobj, &kxtj9_attribute_group);
+ kfree(tj9);
+
+ return 0;
+}
+
+#ifdef CONFIG_PM
+static int kxtj9_resume(struct i2c_client *client)
+{
+ struct kxtj9_data *tj9 = i2c_get_clientdata(client);
+
+ return kxtj9_enable(tj9);
+}
+
+static int kxtj9_suspend(struct i2c_client *client, pm_message_t mesg)
+{
+ struct kxtj9_data *tj9 = i2c_get_clientdata(client);
+
+ return kxtj9_disable(tj9);
+}
+#endif
+
+static const struct i2c_device_id kxtj9_id[] = {
+ {NAME, 0},
+ {},
+};
+
+MODULE_DEVICE_TABLE(i2c, kxtj9_id);
+
+static struct i2c_driver kxtj9_driver = {
+ .driver = {
+ .name = NAME,
+ },
+ .probe = kxtj9_probe,
+ .remove = __devexit_p(kxtj9_remove),
+ .resume = kxtj9_resume,
+ .suspend = kxtj9_suspend,
+ .id_table = kxtj9_id,
+};
+
+static int __init kxtj9_init(void)
+{
+ return i2c_add_driver(&kxtj9_driver);
+}
+
+static void __exit kxtj9_exit(void)
+{
+ i2c_del_driver(&kxtj9_driver);
+}
+
+module_init(kxtj9_init);
+module_exit(kxtj9_exit);
+
+MODULE_DESCRIPTION("KXTJ9 accelerometer driver");
+MODULE_AUTHOR("Chris Hudson <chudson@kionix.com>");
+MODULE_LICENSE("GPL");
diff --git a/include/linux/input/kxtj9.h b/include/linux/input/kxtj9.h
new file mode 100644
index 0000000..0064731
--- /dev/null
+++ b/include/linux/input/kxtj9.h
@@ -0,0 +1,86 @@
+/*
+ * Copyright (C) 2011 Kionix, Inc.
+ * Written by Chris Hudson <chudson@kionix.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+ * 02111-1307, USA
+ */
+
+#ifndef __KXTJ9_H__
+#define __KXTJ9_H__
+
+#define KXTJ9_I2C_ADDR 0x0F
+/* CONTROL REGISTER 1 BITS */
+#define RES_12BIT 0x40
+#define KXTJ9_G_2G 0x00
+#define KXTJ9_G_4G 0x08
+#define KXTJ9_G_8G 0x10
+#define SHIFT_ADJ_2G 4
+#define SHIFT_ADJ_4G 3
+#define SHIFT_ADJ_8G 2
+#define DRDYE 0x20 /* data ready function enable bit */
+/* INTERRUPT CONTROL REGISTER 1 BITS */
+#define KXTJ9_IEN 0x20 /* interrupt enable */
+#define KXTJ9_IEA 0x10 /* interrupt polarity */
+#define KXTJ9_IEL 0x08 /* interrupt response */
+/* DATA CONTROL REGISTER BITS */
+#define ODR800F 0x06 /* lpf output ODR masks */
+#define ODR400F 0x05
+#define ODR200F 0x04
+#define ODR100F 0x03
+#define ODR50F 0x02
+#define ODR25F 0x01
+#define ODR12_5F 0x00
+
+#ifdef __KERNEL__
+struct kxtj9_platform_data {
+ int poll_interval; /* current poll interval */
+ int min_interval; /* minimum poll interval */
+
+ u8 g_range; /* selected g-range */
+ u8 shift_adj; /* data shift for selected g-range */
+
+ /* by default, x is axis 0, y is axis 1, z is axis 2; these can be
+ changed to account for sensor orientation within the host device */
+ u8 axis_map_x;
+ u8 axis_map_y;
+ u8 axis_map_z;
+
+ /* each axis can be negated to account for sensor orientation within
+ the host device; 1 = negate this axis; 0 = do not negate this axis */
+ u8 negate_x;
+ u8 negate_y;
+ u8 negate_z;
+
+ /* data_odr_init is the initial setting for DATA_CTRL_REG, which
+ controls the output data rate of the part */
+ u8 data_odr_init;
+
+ /* ctrl_reg1_init is the initial setting for CTRL_REG1, which controls
+ part resolution, g-range, data ready enable, and part enable */
+ u8 ctrl_reg1_init;
+
+ /* int_ctrl_init is the initial setting for INT_CTRL_REG1, which
+ controls physical interrupt pin enable, polarity, and response */
+ u8 int_ctrl_init;
+
+ int (*init)(void);
+ void (*exit)(void);
+ int (*power_on)(void);
+ int (*power_off)(void);
+};
+#endif /* __KERNEL__ */
+
+#endif /* __KXTJ9_H__ */
+
--
1.5.4.3
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH v2] input: Add support for Kionix KXTJ9 accelerometer
2011-05-16 18:39 [PATCH v2] input: Add support for Kionix KXTJ9 accelerometer chudson
@ 2011-05-17 9:22 ` Jonathan Cameron
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Cameron @ 2011-05-17 9:22 UTC (permalink / raw)
To: chudson; +Cc: linux-input, dmitry.torokhov, alan
On 05/16/11 19:39, chudson@kionix.com wrote:
> From: <chudson@kionix.com>
>
> Changes from v1:
> - odr_table changed to static const
> - i2c function returns simplified
> - memcpy used for filling write buffer in i2c_write function
> - dev_err call removed from update_g_range function
> - locks added to sysfs functions
> - 3/5 sysfs nodes removed; we need to keep enable and delay
> - switched to using i2c_board_info->irq instead of passing in the raw GPIO
> - added some comments documenting sysfs nodes and platform data structure
> - removed disable_irq calls in case the irq is shared
Does this not have some side effects?
> - fixed memory leaks in probe function
> - changed to threaded irq format
>
> Please let me know if I missed anything or what else should be changed.
Hi Chris,
Few bits and pieces of trivial stuff in line.
>
> Signed-off-by: Chris Hudson <chudson@kionix.com>
> ---
> drivers/input/misc/Kconfig | 10 +
> drivers/input/misc/Makefile | 1 +
> drivers/input/misc/kxtj9.c | 721 +++++++++++++++++++++++++++++++++++++++++++
> include/linux/input/kxtj9.h | 86 +++++
> 4 files changed, 818 insertions(+), 0 deletions(-)
> create mode 100644 drivers/input/misc/kxtj9.c
> create mode 100644 include/linux/input/kxtj9.h
>
> diff --git a/drivers/input/misc/Kconfig b/drivers/input/misc/Kconfig
> index f9cf088..567f3d2 100644
> --- a/drivers/input/misc/Kconfig
> +++ b/drivers/input/misc/Kconfig
> @@ -467,4 +467,14 @@ config INPUT_XEN_KBDDEV_FRONTEND
> To compile this driver as a module, choose M here: the
> module will be called xen-kbdfront.
>
> +config INPUT_KXTJ9
> + tristate "Kionix KXTJ9 tri-axis digital accelerometer"
> + depends on I2C && SYSFS
> + help
> + If you say yes here you get support for the Kionix KXTJ9 digital
> + tri-axis accelerometer.
> +
> + This driver can also be built as a module. If so, the module
> + will be called kxtj9.
> +
> endif
> diff --git a/drivers/input/misc/Makefile b/drivers/input/misc/Makefile
> index e3f7984..f2477ef 100644
> --- a/drivers/input/misc/Makefile
> +++ b/drivers/input/misc/Makefile
> @@ -25,6 +25,7 @@ obj-$(CONFIG_INPUT_DM355EVM) += dm355evm_keys.o
> obj-$(CONFIG_HP_SDC_RTC) += hp_sdc_rtc.o
> obj-$(CONFIG_INPUT_IXP4XX_BEEPER) += ixp4xx-beeper.o
> obj-$(CONFIG_INPUT_KEYSPAN_REMOTE) += keyspan_remote.o
> +obj-$(CONFIG_INPUT_KXTJ9) += kxtj9.o
> obj-$(CONFIG_INPUT_M68K_BEEP) += m68kspkr.o
> obj-$(CONFIG_INPUT_MAX8925_ONKEY) += max8925_onkey.o
> obj-$(CONFIG_INPUT_PCAP) += pcap_keys.o
> diff --git a/drivers/input/misc/kxtj9.c b/drivers/input/misc/kxtj9.c
> new file mode 100644
> index 0000000..a757c3e
> --- /dev/null
> +++ b/drivers/input/misc/kxtj9.c
> @@ -0,0 +1,721 @@
> +/*
> + * Copyright (C) 2011 Kionix, Inc.
> + * Written by Chris Hudson <chudson@kionix.com>
> + *
> + * This program is free software; you can redistribute it and/or modify
> + * it under the terms of the GNU General Public License version 2 as
> + * published by the Free Software Foundation.
> + *
> + * This program is distributed in the hope that it will be useful,
> + * but WITHOUT ANY WARRANTY; without even the implied warranty of
> + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> + * GNU General Public License for more details.
> + *
> + * You should have received a copy of the GNU General Public License
> + * along with this program; if not, write to the Free Software
> + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
> + * 02111-1307, USA
> + */
> +
> +#include <linux/err.h>
> +#include <linux/errno.h>
> +#include <linux/delay.h>
> +#include <linux/fs.h>
> +#include <linux/i2c.h>
> +#include <linux/input.h>
> +#include <linux/uaccess.h>
> +#include <linux/workqueue.h>
> +#include <linux/irq.h>
> +#include <linux/kthread.h>
> +#include <linux/interrupt.h>
> +#include <linux/slab.h>
> +#include <linux/input/kxtj9.h>
> +
> +#define NAME "kxtj9"
> +#define G_MAX 8000
> +/* OUTPUT REGISTERS */
> +#define XOUT_L 0x06
> +#define WHO_AM_I 0x0F
> +/* CONTROL REGISTERS */
> +#define INT_REL 0x1A
> +#define CTRL_REG1 0x1B
> +#define INT_CTRL1 0x1E
> +#define DATA_CTRL 0x21
> +/* CONTROL REGISTER 1 BITS */
> +#define PC1_OFF 0x7F
> +#define PC1_ON 0x80
> +/* INPUT_ABS CONSTANTS */
> +#define FUZZ 3
> +#define FLAT 3
> +/* RESUME STATE INDICES */
> +#define RES_DATA_CTRL 0
> +#define RES_CTRL_REG1 1
> +#define RES_INT_CTRL1 2
> +#define RESUME_ENTRIES 3
> +
> +/*
> + * The following table lists the maximum appropriate poll interval for each
> + * available output data rate.
> + */
> +static const struct {
> + unsigned int cutoff;
> + u8 mask;
> +} kxtj9_odr_table[] = {
> + {
> + 3, ODR800F}, {
> + 5, ODR400F}, {
> + 10, ODR200F}, {
> + 20, ODR100F}, {
> + 40, ODR50F}, {
> + 80, ODR25F}, {
> + 0, ODR12_5F},
> +};
> +
> +struct kxtj9_data {
> + struct i2c_client *client;
> + struct kxtj9_platform_data *pdata;
Given this always exists, why allocate is seperately.
Just embed the actual structure in here.
> + struct mutex lock;
> + struct delayed_work input_work;
> + struct input_dev *input_dev;
> +
> + int hw_initialized;
bool or bitfield if you prefer.
> + atomic_t enabled;
> + u8 resume[RESUME_ENTRIES];
> + int res_interval;
> + int drdy_enabled;
bool
> + int irq;
As stated below, you don't need a copy of client->irq in here.
> +};
> +
> +static int kxtj9_i2c_read(struct kxtj9_data *tj9, u8 addr, u8 *data, int len)
> +{
> + int err;
> +
> + struct i2c_msg msgs[] = {
> + {
> + .addr = tj9->client->addr,
> + .flags = tj9->client->flags,
> + .len = 1,
> + .buf = &addr,
> + },
> + {
> + .addr = tj9->client->addr,
> + .flags = tj9->client->flags | I2C_M_RD,
> + .len = len,
> + .buf = data,
> + },
> + };
> + err = i2c_transfer(tj9->client->adapter, msgs, 2);
Looks very similar to i2c_smbus_read_i2c_block_data...
I might be missing something. If so please point it out!
> +
> + return err;
> +}
> +
> +static int kxtj9_i2c_write(struct kxtj9_data *tj9, u8 addr, u8 *data, int len)
> +{
> + int err;
> + u8 buf[len + 1];
> +
Why an array? It only has one element.
> + struct i2c_msg msgs[] = {
> + {
> + .addr = tj9->client->addr,
> + .flags = tj9->client->flags,
> + .len = len + 1,
> + .buf = buf,
> + },
> + };
> +
> + buf[0] = addr;
> + memcpy(buf + 1, data, len);
This looks familiar... Its very close to i2c_smbus_write_i2c_block_data.
Don't suppose you could verify if that would work?
Err. Hang on. You only ever write 1 byte anyway as far as I can see.
No reason for this nice generic function to exist.
> +
> + err = i2c_transfer(tj9->client->adapter, msgs, 1);
> +
> + return err;
> +}
> +
> +static int kxtj9_verify(struct kxtj9_data *tj9)
> +{
> + int err;
> + u8 buf;
> +
> + err = kxtj9_i2c_read(tj9, WHO_AM_I, &buf, 1);
> + if (err < 0)
> + dev_err(&tj9->client->dev, "read err int source\n");
> + if (buf != 0x06)
> + err = -1;
> +
> + return err;
> +}
> +
> +int kxtj9_update_g_range(struct kxtj9_data *tj9, u8 new_g_range)
> +{
> + int err;
> + u8 shift;
> + u8 buf;
> + u8 out;
> +
> + switch (new_g_range) {
> + case KXTJ9_G_2G:
> + shift = SHIFT_ADJ_2G;
> + break;
> + case KXTJ9_G_4G:
> + shift = SHIFT_ADJ_4G;
> + break;
> + case KXTJ9_G_8G:
> + shift = SHIFT_ADJ_8G;
> + break;
> + default:
> + return -EINVAL;
> + }
> +
> + out = (tj9->resume[RES_CTRL_REG1] & 0xE7) | new_g_range;
> + if (shift != tj9->pdata->shift_adj) {
> + if (atomic_read(&tj9->enabled)) {
> + buf = 0;
> + err = kxtj9_i2c_write(tj9, CTRL_REG1, &buf, 1);
> + if (err < 0)
> + return err;
> + err = kxtj9_i2c_write(tj9, CTRL_REG1, &out, 1);
> + if (err < 0)
> + return err;
> + }
> + }
> +
> + tj9->resume[RES_CTRL_REG1] = out;
> + tj9->pdata->shift_adj = shift;
> +
> + return 0;
> +}
> +
> +int kxtj9_update_odr(struct kxtj9_data *tj9, int poll_interval)
> +{
> + int err = -1;
I can't see a route in which this err isn't set to something else
before being used. So doesn't need initializing.
> + int i;
> + u8 config;
> + u8 temp = 0;
> +
> + /* Use the lowest ODR that can support the requested poll interval */
> + for (i = 0; i < ARRAY_SIZE(kxtj9_odr_table); i++) {
> + config = kxtj9_odr_table[i].mask;
> + if (poll_interval < kxtj9_odr_table[i].cutoff)
> + break;
> + }
> +
> + if (atomic_read(&tj9->enabled)) {
> + err = kxtj9_i2c_write(tj9, CTRL_REG1, &temp, 1);
> + if (err < 0)
> + return err;
> + err = kxtj9_i2c_write(tj9, DATA_CTRL, &config, 1);
> + if (err < 0)
> + return err;
> + temp = tj9->resume[RES_CTRL_REG1];
> + err = kxtj9_i2c_write(tj9, CTRL_REG1, &temp, 1);
> + if (err < 0)
> + return err;
> + /* Valid input_dev indicates that input_init passed and this
> + * workqueue is available */
> + if (tj9->input_dev) {
> + cancel_delayed_work_sync(&tj9->input_work);
> + schedule_delayed_work(&tj9->input_work,
> + msecs_to_jiffies(poll_interval));
> + }
> + }
> + tj9->resume[RES_DATA_CTRL] = config;
> +
> + return 0;
> +}
> +
> +static int kxtj9_hw_init(struct kxtj9_data *tj9)
> +{
> + int err;
> + u8 buf = 0;
> +
> + err = kxtj9_i2c_write(tj9, CTRL_REG1, &buf, 1);
> + if (err < 0)
> + return err;
> + err = kxtj9_i2c_write(tj9, DATA_CTRL, &tj9->resume[RES_DATA_CTRL], 1);
> + if (err < 0)
> + return err;
> + err = kxtj9_i2c_write(tj9, INT_CTRL1, &tj9->resume[RES_INT_CTRL1], 1);
> + if (err < 0)
> + return err;
> +
> + err = kxtj9_update_g_range(tj9, tj9->pdata->g_range);
> + if (err < 0)
> + return err;
This update has also occured in the probe. Hence runs twice (I think with
the same values).
> +
> + buf = (tj9->resume[RES_CTRL_REG1] | PC1_ON);
> + err = kxtj9_i2c_write(tj9, CTRL_REG1, &buf, 1);
> + if (err < 0)
> + return err;
> + tj9->resume[RES_CTRL_REG1] = buf;
> +
> + if ((buf & DRDYE) > 0)
> + tj9->drdy_enabled = 1;
> + else
> + tj9->drdy_enabled = 0;
tj9->drdy_enable = (buf & DRDYE) > 0;
> +
> + err = kxtj9_update_odr(tj9, tj9->res_interval);
Also looks like probe will run this twice....
> + if (err < 0)
> + return err;
> +
> + tj9->hw_initialized = 1;
> +
> + return 0;
> +}
> +
> +static void kxtj9_device_power_off(struct kxtj9_data *tj9)
> +{
> + int err;
> + u8 buf;
> +
> + buf = tj9->resume[RES_CTRL_REG1] & PC1_OFF;
> + err = kxtj9_i2c_write(tj9, CTRL_REG1, &buf, 1);
> + if (err < 0)
> + dev_err(&tj9->client->dev, "soft power off failed\n");
> + if (tj9->pdata->power_off)
> + tj9->pdata->power_off();
> + tj9->resume[RES_CTRL_REG1] = buf;
> + tj9->hw_initialized = 0;
> +}
> +
> +static int kxtj9_device_power_on(struct kxtj9_data *tj9)
> +{
> + int err;
> +
> + if (tj9->pdata->power_on) {
> + err = tj9->pdata->power_on();
> + if (err < 0)
> + return err;
> + }
> + if (!tj9->hw_initialized) {
> + mdelay(40);
> + err = kxtj9_hw_init(tj9);
> + if (err < 0) {
> + kxtj9_device_power_off(tj9);
> + return err;
> + }
> + }
> +
> + return 0;
> +}
> +
> +static void kxtj9_report_values(struct kxtj9_data *tj9, int *xyz)
> +{
> + input_report_abs(tj9->input_dev, ABS_X, xyz[0]);
> + input_report_abs(tj9->input_dev, ABS_Y, xyz[1]);
> + input_report_abs(tj9->input_dev, ABS_Z, xyz[2]);
> +}
> +
> +static int kxtj9_get_acceleration_data(struct kxtj9_data *tj9, int *xyz)
> +{
> + int err;
> + /* Data bytes from hardware xL, xH, yL, yH, zL, zH */
> + u8 acc_data[6];
These are u16s in reality. Define them as such (needed
to ensure alignment for endian conversions anwyay.
> + /* x,y,z hardware values */
> + int hw_d[3];
> +
> + err = kxtj9_i2c_read(tj9, XOUT_L, acc_data, 6);
> + if (err < 0)
> + return err;
> +
> +
> + hw_d[0] = (int) (((acc_data[1]) << 8) | acc_data[0]);
Look like endian conversions to me. So use le16_to_cpu etc
> + hw_d[1] = (int) (((acc_data[3]) << 8) | acc_data[2]);
> + hw_d[2] = (int) (((acc_data[5]) << 8) | acc_data[4]);
> +
> + if (hw_d[0] & 0x8000)
> + hw_d[0] |= 0xFFFF0000;
> + if (hw_d[1] & 0x8000)
> + hw_d[1] |= 0xFFFF0000;
> + if (hw_d[2] & 0x8000)
> + hw_d[2] |= 0xFFFF0000;
Looks like sign extension to me. Why not just store
these values in s16's in the first place rather than
extending up to s32. Also there are much neater ways
of sign extending without conditionals.
Assuming hw_d etc are s32s
hw_d[0] = (s32)(hw_d[0] << 16) >> 16;
etc. Got to love signed extended shifting.
> +
> + hw_d[0] >>= tj9->pdata->shift_adj;
> + hw_d[1] >>= tj9->pdata->shift_adj;
> + hw_d[2] >>= tj9->pdata->shift_adj;
> +
> + xyz[0] = ((tj9->pdata->negate_x) ? (-hw_d[tj9->pdata->axis_map_x])
> + : (hw_d[tj9->pdata->axis_map_x]));
> + xyz[1] = ((tj9->pdata->negate_y) ? (-hw_d[tj9->pdata->axis_map_y])
> + : (hw_d[tj9->pdata->axis_map_y]));
> + xyz[2] = ((tj9->pdata->negate_z) ? (-hw_d[tj9->pdata->axis_map_z])
> + : (hw_d[tj9->pdata->axis_map_z]));
> +
> + return err;
> +}
> +
> +static irqreturn_t kxtj9_isr(int irq, void *dev)
> +{
> + struct kxtj9_data *tj9 = dev;
> + int err;
> + u8 buf;
> + int xyz[3];
> +
> + /* data ready is the only possible interrupt type */
> + if (kxtj9_get_acceleration_data(tj9, xyz) == 0)
> + kxtj9_report_values(tj9, xyz);
> +
> + err = kxtj9_i2c_read(tj9, INT_REL, &buf, 1);
> + if (err < 0)
> + dev_err(&tj9->client->dev,
> + "error clearing interrupt status: %d\n", err);
> +
> + return IRQ_HANDLED;
> +}
> +
> +static int kxtj9_enable(struct kxtj9_data *tj9)
> +{
> + int err;
> + u8 buf;
> +
> + if (!atomic_cmpxchg(&tj9->enabled, 0, 1)) {
> + err = kxtj9_device_power_on(tj9);
> + err = kxtj9_i2c_read(tj9, INT_REL, &buf, 1);
> + if (err < 0) {
> + dev_err(&tj9->client->dev,
> + "error clearing interrupt: %d\n", err);
> + atomic_set(&tj9->enabled, 0);
> + return err;
> + }
> + schedule_delayed_work(&tj9->input_work,
> + msecs_to_jiffies(tj9->res_interval));
> + }
> +
> + return 0;
> +}
> +
> +static int kxtj9_disable(struct kxtj9_data *tj9)
> +{
> + if (atomic_cmpxchg(&tj9->enabled, 1, 0)) {
> + cancel_delayed_work_sync(&tj9->input_work);
> + kxtj9_device_power_off(tj9);
> + }
> +
> + return 0;
> +}
> +
> +static void kxtj9_input_work_func(struct work_struct *work)
> +{
> + struct kxtj9_data *tj9 = container_of((struct delayed_work *)work,
> + struct kxtj9_data, input_work);
> + int xyz[3] = { 0 };
Whats this doing running if the data ready signal is enabled?
Also why zero xyz. You only use it if get_acceleration_data
succeeds anyway.
> +
> + if (tj9->drdy_enabled == 0) {
> + mutex_lock(&tj9->lock);
> +
> + if (kxtj9_get_acceleration_data(tj9, xyz) == 0)
> + kxtj9_report_values(tj9, xyz);
> +
> + schedule_delayed_work(&tj9->input_work,
> + msecs_to_jiffies(tj9->res_interval));
> + mutex_unlock(&tj9->lock);
> + }
> +}
> +
> +int kxtj9_input_open(struct input_dev *input)
> +{
> + struct kxtj9_data *tj9 = input_get_drvdata(input);
> +
> + return kxtj9_enable(tj9);
> +}
> +
> +void kxtj9_input_close(struct input_dev *dev)
> +{
> + struct kxtj9_data *tj9 = input_get_drvdata(dev);
> +
> + kxtj9_disable(tj9);
Roll these into one liners.
> +}
> +
> +static int kxtj9_input_init(struct kxtj9_data *tj9)
> +{
> + int err;
> +
> + INIT_DELAYED_WORK(&tj9->input_work, kxtj9_input_work_func);
> + tj9->input_dev = input_allocate_device();
> + if (!tj9->input_dev) {
> + err = -ENOMEM;
> + dev_err(&tj9->client->dev, "input device allocate failed\n");
> + goto err0;
> + }
> + tj9->input_dev->open = kxtj9_input_open;
> + tj9->input_dev->close = kxtj9_input_close;
> +
> + input_set_drvdata(tj9->input_dev, tj9);
> +
> + set_bit(EV_ABS, tj9->input_dev->evbit);
> + set_bit(EV_REL, tj9->input_dev->evbit);
> +
> + input_set_abs_params(tj9->input_dev, ABS_X, -G_MAX, G_MAX, FUZZ, FLAT);
> + input_set_abs_params(tj9->input_dev, ABS_Y, -G_MAX, G_MAX, FUZZ, FLAT);
> + input_set_abs_params(tj9->input_dev, ABS_Z, -G_MAX, G_MAX, FUZZ, FLAT);
> +
> + tj9->input_dev->name = "kxtj9_accel";
> +
> + err = input_register_device(tj9->input_dev);
> + if (err) {
> + dev_err(&tj9->client->dev,
> + "unable to register input polled device %s: %d\n",
> + tj9->input_dev->name, err);
> + goto err1;
> + }
> +
> + return 0;
> +err1:
> + input_free_device(tj9->input_dev);
> +err0:
> + return err;
> +}
> +
> +static void kxtj9_input_cleanup(struct kxtj9_data *tj9)
> +{
> + input_unregister_device(tj9->input_dev);
> +}
> +
> +/* sysfs */
> +
> +/* kxtj9_delay_show: returns the currently selected poll interval */
> +static ssize_t kxtj9_delay_show(struct device *dev,
> + struct device_attribute *attr, char *buf)
> +{
> + struct i2c_client *client = to_i2c_client(dev);
> + struct kxtj9_data *tj9 = i2c_get_clientdata(client);
> + return sprintf(buf, "%d\n", tj9->res_interval);
> +}
> +
> +/* kxtj9_delay_store: allows the user to select a new poll interval */
It needs docs to tell use what the units are etc. If at all possible they
need to be in something vaguely standard such as microseconds.
> +static ssize_t kxtj9_delay_store(struct device *dev,
> + struct device_attribute *attr,
> + const char *buf, size_t count)
> +{
> + struct i2c_client *client = to_i2c_client(dev);
> + struct kxtj9_data *tj9 = i2c_get_clientdata(client);
> + unsigned long val;
> + int ret = kstrtoul(buf, 10, &val);
> + if (ret < 0)
> + return ret;
> +
> + mutex_lock(&tj9->lock);
> + /* the selected interval is the greater of the minimum interval or
> + the requested interval */
> + tj9->res_interval = max((int)val, tj9->pdata->min_interval);
> + kxtj9_update_odr(tj9, tj9->res_interval);
> + mutex_unlock(&tj9->lock);
> +
> + return count;
> +}
> +
> +/* kxtj9_enable_show: returns the enable status of the part */
> +static ssize_t kxtj9_enable_show(struct device *dev,
> + struct device_attribute *attr, char *buf)
> +{
> + struct i2c_client *client = to_i2c_client(dev);
> + struct kxtj9_data *tj9 = i2c_get_clientdata(client);
Could shorten the above to: (its a mater of personal taste, so up to you!)
struct kxtj9_data *tj9 = i2c_get_clientdata(to_i2c_client(dev));
> + return sprintf(buf, "%d\n", atomic_read(&tj9->enabled));
> +}
> +
> +/* kxtj9_enable_store: allows the user to enable or disable the part */
> +static ssize_t kxtj9_enable_store(struct device *dev,
> + struct device_attribute *attr,
> + const char *buf, size_t count)
> +{
> + struct i2c_client *client = to_i2c_client(dev);
> + struct kxtj9_data *tj9 = i2c_get_clientdata(client);
> + unsigned long val;
> + int ret = kstrtoul(buf, 10, &val);
> + if (ret < 0)
> + return ret;
> +
There should shortly be a nice strtobool function entering mainline.
Makes for more consistent handling of yes no questions like this ;)
Perhaps we may want to convert this later...
> + mutex_lock(&tj9->lock);
> + if (val) /* non-zero argument enables the part */
> + kxtj9_enable(tj9);
> + else /* zero argument disables the part */
> + kxtj9_disable(tj9);
> + mutex_unlock(&tj9->lock);
> +
> + return count;
> +}
> +
> +static DEVICE_ATTR(delay, S_IRUGO|S_IWUSR, kxtj9_delay_show, kxtj9_delay_store);
> +static DEVICE_ATTR(enable, S_IRUGO|S_IWUSR, kxtj9_enable_show,
> + kxtj9_enable_store);
> +
> +static struct attribute *kxtj9_attributes[] = {
> + &dev_attr_delay.attr,
Still needs docs. Actually this sort of attribute probably needs a formal
RFC to input mailing list to see if people have other methods they prefer for
controlling it...
> + &dev_attr_enable.attr,
> + NULL
> +};
> +
> +static struct attribute_group kxtj9_attribute_group = {
> + .attrs = kxtj9_attributes
> +};
> +/* /sysfs */
Hmm. personal preference but I'm really anti uninformative section
titles like this... Dmitry's preference rules in input though and I
have no idea if he cares!
> +
> +static int __devinit kxtj9_probe(struct i2c_client *client,
> + const struct i2c_device_id *id)
> +{
> + int err = -1;
> + struct kxtj9_data *tj9 = kzalloc(sizeof(*tj9), GFP_KERNEL);
> + if (tj9 == NULL) {
> + dev_err(&client->dev,
> + "failed to allocate memory for module data\n");
> + err = -ENOMEM;
> + goto err0;
> + }
> + if (client->dev.platform_data == NULL) {
> + dev_err(&client->dev, "platform data is NULL; exiting\n");
> + err = -ENODEV;
> + goto err0;
> + }
> + if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
> + dev_err(&client->dev, "client not i2c capable\n");
> + err = -ENODEV;
> + goto err0;
> + }
> + mutex_init(&tj9->lock);
> + mutex_lock(&tj9->lock);
> + tj9->client = client;
> + i2c_set_clientdata(client, tj9);
> +
> + tj9->pdata = kmalloc(sizeof(*tj9->pdata), GFP_KERNEL);
> + if (tj9->pdata == NULL)
If this happens then return -ENOMEM, not -1.
> + goto err1;
> +
> + err = sysfs_create_group(&client->dev.kobj, &kxtj9_attribute_group);
> + if (err)
If this path occurs, you have a memory leak of tj9->pdata.
> + goto err1;
> +
> + memcpy(tj9->pdata, client->dev.platform_data, sizeof(*tj9->pdata));
Ordering is a little odd here. I'd probably fill this immediately after
creating rather than doing the sysfs_create_group in between.
> + if (tj9->pdata->init) {
> + err = tj9->pdata->init();
> + if (err < 0)
> + goto err2;
> + }
> +
> + memset(tj9->resume, 0, ARRAY_SIZE(tj9->resume));
Don't need this memset. You are just about to set all the value anyway.
Even if that were not true, you kzalloc'd the structure containing the array so its
already 0.
> + tj9->resume[RES_DATA_CTRL] = tj9->pdata->data_odr_init;
> + tj9->resume[RES_CTRL_REG1] = tj9->pdata->ctrl_reg1_init;
> + tj9->resume[RES_INT_CTRL1] = tj9->pdata->int_ctrl_init;
> + tj9->res_interval = tj9->pdata->poll_interval;
Why maintain two copies of this? Given you have made a local copy of
the platform data, surely you can just use the value in that copy
to store updates to this?
> +
> + err = kxtj9_device_power_on(tj9);
> + if (err < 0)
> + goto err3;
> + atomic_set(&tj9->enabled, 1);
> +
> + err = kxtj9_verify(tj9);
> + if (err < 0) {
What does unresolved mean in the case of an i2c client? Not found?
> + dev_err(&client->dev, "unresolved i2c client\n");
> + goto err4;
> + }
> +
> + err = kxtj9_update_g_range(tj9, tj9->pdata->g_range);
> + if (err < 0)
> + goto err4;
> +
> + err = kxtj9_update_odr(tj9, tj9->res_interval);
> + if (err < 0)
> + goto err4;
> +
> + err = kxtj9_input_init(tj9);
> + if (err < 0)
> + goto err4;
> +
> + kxtj9_device_power_off(tj9);
possible unhandled error from the above.
> + atomic_set(&tj9->enabled, 0);
> +
> + if (client->irq) {
> + tj9->irq = client->irq;
Why copy the irq value? client is available everywhere it is needed.
> + err = request_threaded_irq(tj9->irq, NULL, kxtj9_isr,
> + IRQF_TRIGGER_RISING, "kxtj9-irq", tj9);
In your previous version, the isr disable the irq. That is the equivalent of
having IRQF_ONESHOT in the flags here.
Was the original wrong or is this update?
> + if (err < 0) {
> + pr_err("%s: request irq failed: %d\n", __func__, err);
> + goto err5;
> + }
> + }
> +
> + mutex_unlock(&tj9->lock);
> +
> + return 0;
> +
> +err5:
> + kxtj9_input_cleanup(tj9);
> +err4:
> + kxtj9_device_power_off(tj9);
> +err3:
> + if (tj9->pdata->exit)
> + tj9->pdata->exit();
> +err2:
> + kfree(tj9->pdata);
> + sysfs_remove_group(&client->dev.kobj, &kxtj9_attribute_group);
> +err1:
> + mutex_unlock(&tj9->lock);
> +err0:
> + kfree(tj9);
> + return err;
> +}
> +
> +static int __devexit kxtj9_remove(struct i2c_client *client)
> +{
> + struct kxtj9_data *tj9 = i2c_get_clientdata(client);
> +
> + free_irq(tj9->irq, tj9);
What if remove occurs when dataready is enabled? I'd imagine you want
an explicit disable of the interrupt first.
> + kxtj9_input_cleanup(tj9);
> + kxtj9_device_power_off(tj9);
> + if (tj9->pdata->exit)
> + tj9->pdata->exit();
> + kfree(tj9->pdata);
> + sysfs_remove_group(&client->dev.kobj, &kxtj9_attribute_group);
> + kfree(tj9);
> +
> + return 0;
> +}
> +
> +#ifdef CONFIG_PM
> +static int kxtj9_resume(struct i2c_client *client)
> +{
> + struct kxtj9_data *tj9 = i2c_get_clientdata(client);
> +
> + return kxtj9_enable(tj9);
kxtj9_enable(i2c_get_clientdata(client)); does the job.
> +}
> +
> +static int kxtj9_suspend(struct i2c_client *client, pm_message_t mesg)
> +{
> + struct kxtj9_data *tj9 = i2c_get_clientdata(client);
> +
> + return kxtj9_disable(tj9);
kxtj9_disable(i2c_get_clientdata(client); does the job and is more consise.
> +}
> +#endif
> +
> +static const struct i2c_device_id kxtj9_id[] = {
> + {NAME, 0},
> + {},
> +};
> +
> +MODULE_DEVICE_TABLE(i2c, kxtj9_id);
> +
> +static struct i2c_driver kxtj9_driver = {
> + .driver = {
> + .name = NAME,
> + },
> + .probe = kxtj9_probe,
> + .remove = __devexit_p(kxtj9_remove),
> + .resume = kxtj9_resume,
> + .suspend = kxtj9_suspend,
> + .id_table = kxtj9_id,
> +};
> +
> +static int __init kxtj9_init(void)
> +{
> + return i2c_add_driver(&kxtj9_driver);
> +}
> +
> +static void __exit kxtj9_exit(void)
> +{
> + i2c_del_driver(&kxtj9_driver);
> +}
> +
> +module_init(kxtj9_init);
> +module_exit(kxtj9_exit);
> +
> +MODULE_DESCRIPTION("KXTJ9 accelerometer driver");
> +MODULE_AUTHOR("Chris Hudson <chudson@kionix.com>");
> +MODULE_LICENSE("GPL");
> diff --git a/include/linux/input/kxtj9.h b/include/linux/input/kxtj9.h
> new file mode 100644
> index 0000000..0064731
> --- /dev/null
> +++ b/include/linux/input/kxtj9.h
> @@ -0,0 +1,86 @@
> +/*
> + * Copyright (C) 2011 Kionix, Inc.
> + * Written by Chris Hudson <chudson@kionix.com>
> + *
> + * This program is free software; you can redistribute it and/or modify
> + * it under the terms of the GNU General Public License version 2 as
> + * published by the Free Software Foundation.
> + *
> + * This program is distributed in the hope that it will be useful,
> + * but WITHOUT ANY WARRANTY; without even the implied warranty of
> + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> + * GNU General Public License for more details.
> + *
> + * You should have received a copy of the GNU General Public License
> + * along with this program; if not, write to the Free Software
> + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
> + * 02111-1307, USA
> + */
> +
> +#ifndef __KXTJ9_H__
> +#define __KXTJ9_H__
> +
> +#define KXTJ9_I2C_ADDR 0x0F
> +/* CONTROL REGISTER 1 BITS */
> +#define RES_12BIT 0x40
> +#define KXTJ9_G_2G 0x00
> +#define KXTJ9_G_4G 0x08
> +#define KXTJ9_G_8G 0x10
> +#define SHIFT_ADJ_2G 4
> +#define SHIFT_ADJ_4G 3
> +#define SHIFT_ADJ_8G 2
> +#define DRDYE 0x20 /* data ready function enable bit */
> +/* INTERRUPT CONTROL REGISTER 1 BITS */
> +#define KXTJ9_IEN 0x20 /* interrupt enable */
> +#define KXTJ9_IEA 0x10 /* interrupt polarity */
> +#define KXTJ9_IEL 0x08 /* interrupt response */
> +/* DATA CONTROL REGISTER BITS */
> +#define ODR800F 0x06 /* lpf output ODR masks */
> +#define ODR400F 0x05
> +#define ODR200F 0x04
> +#define ODR100F 0x03
> +#define ODR50F 0x02
> +#define ODR25F 0x01
> +#define ODR12_5F 0x00
> +
Good to see the docs in here. Makes it much easier to review!
> +#ifdef __KERNEL__
> +struct kxtj9_platform_data {
> + int poll_interval; /* current poll interval */
units?
> + int min_interval; /* minimum poll interval */
> +
> + u8 g_range; /* selected g-range */
> + u8 shift_adj; /* data shift for selected g-range */
Can this not be established from g_range?
> +
> + /* by default, x is axis 0, y is axis 1, z is axis 2; these can be
> + changed to account for sensor orientation within the host device */
> + u8 axis_map_x;
> + u8 axis_map_y;
> + u8 axis_map_z;
> +
> + /* each axis can be negated to account for sensor orientation within
> + the host device; 1 = negate this axis; 0 = do not negate this axis */
> + u8 negate_x;
> + u8 negate_y;
> + u8 negate_z;
Now this confuses me. Surely axis_map and negate are tied together - you can't just
negate one sensor and end up with right handed axis (which I'm guessing would be what
userspace expects?)
How many parameters are needed to indicate a valid configuration? Thinking quickly
I make it two. Which axis is effectively down, then rotation about that axis
(which may take 3 values). Dmitry, does a similar circumstance occur anywhere else
in input?
> +
> + /* data_odr_init is the initial setting for DATA_CTRL_REG, which
> + controls the output data rate of the part */
> + u8 data_odr_init;
> +
> + /* ctrl_reg1_init is the initial setting for CTRL_REG1, which controls
> + part resolution, g-range, data ready enable, and part enable */
> + u8 ctrl_reg1_init;
Would it be clearer to have this broken out into the various elements? Certainly
make it easier to review the addition of the chip to board files.
> +
> + /* int_ctrl_init is the initial setting for INT_CTRL_REG1, which
> + controls physical interrupt pin enable, polarity, and response */
> + u8 int_ctrl_init;
Same here on breaking out the various elements.
> +
> + int (*init)(void);
> + void (*exit)(void);
> + int (*power_on)(void);
> + int (*power_off)(void);
> +};
> +#endif /* __KERNEL__ */
> +
> +#endif /* __KXTJ9_H__ */
> +
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2011-05-17 9:20 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2011-05-16 18:39 [PATCH v2] input: Add support for Kionix KXTJ9 accelerometer chudson
2011-05-17 9:22 ` Jonathan Cameron
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.