[linux-block.git] / drivers / iio / accel / kxsd9.c

/*
 * kxsd9.c	simple support for the Kionix KXSD9 3D
 *		accelerometer.
 *
 * Copyright (c) 2008-2009 Jonathan Cameron <jic23@kernel.org>
 *
 * 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.
 *
 * The i2c interface is very similar, so shouldn't be a problem once
 * I have a suitable wire made up.
 *
 * TODO:	Support the motion detector
 *		Uses register address incrementing so could have a
 *		heavily optimized ring buffer access function.
 */

#include <linux/device.h>
#include <linux/kernel.h>
#include <linux/spi/spi.h>
#include <linux/sysfs.h>
#include <linux/slab.h>
#include <linux/module.h>

#include <linux/iio/iio.h>
#include <linux/iio/sysfs.h>

#define KXSD9_REG_X		0x00
#define KXSD9_REG_Y		0x02
#define KXSD9_REG_Z		0x04
#define KXSD9_REG_AUX		0x06
#define KXSD9_REG_RESET		0x0a
#define KXSD9_REG_CTRL_C	0x0c

#define KXSD9_FS_MASK		0x03

#define KXSD9_REG_CTRL_B	0x0d
#define KXSD9_REG_CTRL_A	0x0e

#define KXSD9_READ(a) (0x80 | (a))
#define KXSD9_WRITE(a) (a)

#define KXSD9_STATE_RX_SIZE 2
#define KXSD9_STATE_TX_SIZE 2
/**
 * struct kxsd9_state - device related storage
 * @buf_lock:	protect the rx and tx buffers.
 * @us:		spi device
 * @rx:		single rx buffer storage
 * @tx:		single tx buffer storage
 **/
struct kxsd9_state {
	struct mutex buf_lock;
	struct spi_device *us;
	u8 rx[KXSD9_STATE_RX_SIZE] ____cacheline_aligned;
	u8 tx[KXSD9_STATE_TX_SIZE];
};

#define KXSD9_SCALE_2G "0.011978"
#define KXSD9_SCALE_4G "0.023927"
#define KXSD9_SCALE_6G "0.035934"
#define KXSD9_SCALE_8G "0.047853"

/* reverse order */
static const int kxsd9_micro_scales[4] = { 47853, 35934, 23927, 11978 };

static int kxsd9_write_scale(struct iio_dev *indio_dev, int micro)
{
	int ret, i;
	struct kxsd9_state *st = iio_priv(indio_dev);
	bool foundit = false;

	for (i = 0; i < 4; i++)
		if (micro == kxsd9_micro_scales[i]) {
			foundit = true;
			break;
		}
	if (!foundit)
		return -EINVAL;

	mutex_lock(&st->buf_lock);
	ret = spi_w8r8(st->us, KXSD9_READ(KXSD9_REG_CTRL_C));
	if (ret)
		goto error_ret;
	st->tx[0] = KXSD9_WRITE(KXSD9_REG_CTRL_C);
	st->tx[1] = (ret & ~KXSD9_FS_MASK) | i;

	ret = spi_write(st->us, st->tx, 2);
error_ret:
	mutex_unlock(&st->buf_lock);
	return ret;
}

static int kxsd9_read(struct iio_dev *indio_dev, u8 address)
{
	int ret;
	struct kxsd9_state *st = iio_priv(indio_dev);
	struct spi_transfer xfers[] = {
		{
			.bits_per_word = 8,
			.len = 1,
			.delay_usecs = 200,
			.tx_buf = st->tx,
		}, {
			.bits_per_word = 8,
			.len = 2,
			.rx_buf = st->rx,
		},
	};

	mutex_lock(&st->buf_lock);
	st->tx[0] = KXSD9_READ(address);
	ret = spi_sync_transfer(st->us, xfers, ARRAY_SIZE(xfers));
	if (ret)
		return ret;
	return (((u16)(st->rx[0])) << 8) | (st->rx[1] & 0xF0);
}

static IIO_CONST_ATTR(accel_scale_available,
		KXSD9_SCALE_2G " "
		KXSD9_SCALE_4G " "
		KXSD9_SCALE_6G " "
		KXSD9_SCALE_8G);

static struct attribute *kxsd9_attributes[] = {
	&iio_const_attr_accel_scale_available.dev_attr.attr,
	NULL,
};

static int kxsd9_write_raw(struct iio_dev *indio_dev,
			   struct iio_chan_spec const *chan,
			   int val,
			   int val2,
			   long mask)
{
	int ret = -EINVAL;

	if (mask == IIO_CHAN_INFO_SCALE) {
		/* Check no integer component */
		if (val)
			return -EINVAL;
		ret = kxsd9_write_scale(indio_dev, val2);
	}

	return ret;
}

static int kxsd9_read_raw(struct iio_dev *indio_dev,
			  struct iio_chan_spec const *chan,
			  int *val, int *val2, long mask)
{
	int ret = -EINVAL;
	struct kxsd9_state *st = iio_priv(indio_dev);

	switch (mask) {
	case IIO_CHAN_INFO_RAW:
		ret = kxsd9_read(indio_dev, chan->address);
		if (ret < 0)
			goto error_ret;
		*val = ret;
		break;
	case IIO_CHAN_INFO_SCALE:
		ret = spi_w8r8(st->us, KXSD9_READ(KXSD9_REG_CTRL_C));
		if (ret)
			goto error_ret;
		*val2 = kxsd9_micro_scales[ret & KXSD9_FS_MASK];
		ret = IIO_VAL_INT_PLUS_MICRO;
		break;
	}

error_ret:
	return ret;
};
#define KXSD9_ACCEL_CHAN(axis)						\
	{								\
		.type = IIO_ACCEL,					\
		.modified = 1,						\
		.channel2 = IIO_MOD_##axis,				\
		.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),		\
		.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),	\
		.address = KXSD9_REG_##axis,				\
	}

static const struct iio_chan_spec kxsd9_channels[] = {
	KXSD9_ACCEL_CHAN(X), KXSD9_ACCEL_CHAN(Y), KXSD9_ACCEL_CHAN(Z),
	{
		.type = IIO_VOLTAGE,
		.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
		.indexed = 1,
		.address = KXSD9_REG_AUX,
	}
};

static const struct attribute_group kxsd9_attribute_group = {
	.attrs = kxsd9_attributes,
};

static int kxsd9_power_up(struct kxsd9_state *st)
{
	int ret;

	st->tx[0] = 0x0d;
	st->tx[1] = 0x40;
	ret = spi_write(st->us, st->tx, 2);
	if (ret)
		return ret;

	st->tx[0] = 0x0c;
	st->tx[1] = 0x9b;
	return spi_write(st->us, st->tx, 2);
};

static const struct iio_info kxsd9_info = {
	.read_raw = &kxsd9_read_raw,
	.write_raw = &kxsd9_write_raw,
	.attrs = &kxsd9_attribute_group,
	.driver_module = THIS_MODULE,
};

static int kxsd9_probe(struct spi_device *spi)
{
	struct iio_dev *indio_dev;
	struct kxsd9_state *st;
	int ret;

	indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
	if (!indio_dev)
		return -ENOMEM;

	st = iio_priv(indio_dev);
	spi_set_drvdata(spi, indio_dev);

	st->us = spi;
	mutex_init(&st->buf_lock);
	indio_dev->channels = kxsd9_channels;
	indio_dev->num_channels = ARRAY_SIZE(kxsd9_channels);
	indio_dev->name = spi_get_device_id(spi)->name;
	indio_dev->dev.parent = &spi->dev;
	indio_dev->info = &kxsd9_info;
	indio_dev->modes = INDIO_DIRECT_MODE;

	spi->mode = SPI_MODE_0;
	spi_setup(spi);
	kxsd9_power_up(st);

	ret = iio_device_register(indio_dev);
	if (ret)
		return ret;

	return 0;
}

static int kxsd9_remove(struct spi_device *spi)
{
	iio_device_unregister(spi_get_drvdata(spi));

	return 0;
}

static const struct spi_device_id kxsd9_id[] = {
	{"kxsd9", 0},
	{ },
};
MODULE_DEVICE_TABLE(spi, kxsd9_id);

static struct spi_driver kxsd9_driver = {
	.driver = {
		.name = "kxsd9",
		.owner = THIS_MODULE,
	},
	.probe = kxsd9_probe,
	.remove = kxsd9_remove,
	.id_table = kxsd9_id,
};
module_spi_driver(kxsd9_driver);

MODULE_AUTHOR("Jonathan Cameron <jic23@kernel.org>");
MODULE_DESCRIPTION("Kionix KXSD9 SPI driver");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
e435bc19 JC	1	/*
	2	* kxsd9.c simple support for the Kionix KXSD9 3D
	3	* accelerometer.
	4	*
0f8c9620	5	* Copyright (c) 2008-2009 Jonathan Cameron <jic23@kernel.org>
e435bc19 JC	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License version 2 as
	9	* published by the Free Software Foundation.
	10	*
	11	* The i2c interface is very similar, so shouldn't be a problem once
	12	* I have a suitable wire made up.
	13	*
	14	* TODO: Support the motion detector
	15	* Uses register address incrementing so could have a
	16	* heavily optimized ring buffer access function.
	17	*/
	18
e435bc19 JC	19	#include <linux/device.h>
	20	#include <linux/kernel.h>
	21	#include <linux/spi/spi.h>
	22	#include <linux/sysfs.h>
5a0e3ad6	23	#include <linux/slab.h>
99c97852	24	#include <linux/module.h>
e435bc19	25
06458e27 JC	26	#include <linux/iio/iio.h>
06458e27 JC	27	#include <linux/iio/sysfs.h>
e435bc19 JC	28
	29	#define KXSD9_REG_X 0x00
	30	#define KXSD9_REG_Y 0x02
	31	#define KXSD9_REG_Z 0x04
	32	#define KXSD9_REG_AUX 0x06
	33	#define KXSD9_REG_RESET 0x0a
	34	#define KXSD9_REG_CTRL_C 0x0c
	35
e435bc19 JC	36	#define KXSD9_FS_MASK 0x03
	37
	38	#define KXSD9_REG_CTRL_B 0x0d
	39	#define KXSD9_REG_CTRL_A 0x0e
	40
	41	#define KXSD9_READ(a) (0x80 \| (a))
	42	#define KXSD9_WRITE(a) (a)
	43
e435bc19	44	#define KXSD9_STATE_RX_SIZE 2
d34dbee8	45	#define KXSD9_STATE_TX_SIZE 2
e435bc19 JC	46	/**
	47	* struct kxsd9_state - device related storage
	48	* @buf_lock: protect the rx and tx buffers.
e435bc19 JC	49	* @us: spi device
	50	* @rx: single rx buffer storage
	51	* @tx: single tx buffer storage
	52	**/
	53	struct kxsd9_state {
	54	struct mutex buf_lock;
e435bc19	55	struct spi_device *us;
ed0c012b JC	56	u8 rx[KXSD9_STATE_RX_SIZE] ____cacheline_aligned;
ed0c012b JC	57	u8 tx[KXSD9_STATE_TX_SIZE];
e435bc19 JC	58	};
e435bc19 JC	59
d34dbee8 JC	60	#define KXSD9_SCALE_2G "0.011978"
	61	#define KXSD9_SCALE_4G "0.023927"
	62	#define KXSD9_SCALE_6G "0.035934"
	63	#define KXSD9_SCALE_8G "0.047853"
e435bc19	64
d34dbee8 JC	65	/* reverse order */
d34dbee8 JC	66	static const int kxsd9_micro_scales[4] = { 47853, 35934, 23927, 11978 };
e435bc19	67
d34dbee8	68	static int kxsd9_write_scale(struct iio_dev *indio_dev, int micro)
e435bc19	69	{
d34dbee8	70	int ret, i;
ed0c012b	71	struct kxsd9_state *st = iio_priv(indio_dev);
d34dbee8 JC	72	bool foundit = false;
	73
	74	for (i = 0; i < 4; i++)
	75	if (micro == kxsd9_micro_scales[i]) {
	76	foundit = true;
	77	break;
	78	}
	79	if (!foundit)
e435bc19	80	return -EINVAL;
f3fb0011	81
e435bc19	82	mutex_lock(&st->buf_lock);
d34dbee8	83	ret = spi_w8r8(st->us, KXSD9_READ(KXSD9_REG_CTRL_C));
e435bc19 JC	84	if (ret)
	85	goto error_ret;
	86	st->tx[0] = KXSD9_WRITE(KXSD9_REG_CTRL_C);
d34dbee8	87	st->tx[1] = (ret & ~KXSD9_FS_MASK) \| i;
e435bc19	88
d34dbee8	89	ret = spi_write(st->us, st->tx, 2);
e435bc19 JC	90	error_ret:
e435bc19 JC	91	mutex_unlock(&st->buf_lock);
d34dbee8	92	return ret;
e435bc19	93	}
f3fb0011	94
d34dbee8	95	static int kxsd9_read(struct iio_dev *indio_dev, u8 address)
e435bc19	96	{
e435bc19	97	int ret;
ed0c012b	98	struct kxsd9_state *st = iio_priv(indio_dev);
e435bc19 JC	99	struct spi_transfer xfers[] = {
	100	{
	101	.bits_per_word = 8,
	102	.len = 1,
e435bc19 JC	103	.delay_usecs = 200,
	104	.tx_buf = st->tx,
	105	}, {
	106	.bits_per_word = 8,
	107	.len = 2,
e435bc19 JC	108	.rx_buf = st->rx,
	109	},
	110	};
	111
	112	mutex_lock(&st->buf_lock);
d34dbee8	113	st->tx[0] = KXSD9_READ(address);
14543a00	114	ret = spi_sync_transfer(st->us, xfers, ARRAY_SIZE(xfers));
e435bc19	115	if (ret)
d34dbee8 JC	116	return ret;
d34dbee8 JC	117	return (((u16)(st->rx[0])) << 8) \| (st->rx[1] & 0xF0);
e435bc19 JC	118	}
e435bc19 JC	119
f3fb0011 JC	120	static IIO_CONST_ATTR(accel_scale_available,
	121	KXSD9_SCALE_2G " "
	122	KXSD9_SCALE_4G " "
	123	KXSD9_SCALE_6G " "
	124	KXSD9_SCALE_8G);
e435bc19 JC	125
e435bc19 JC	126	static struct attribute *kxsd9_attributes[] = {
f3fb0011	127	&iio_const_attr_accel_scale_available.dev_attr.attr,
e435bc19 JC	128	NULL,
	129	};
	130
d34dbee8 JC	131	static int kxsd9_write_raw(struct iio_dev *indio_dev,
	132	struct iio_chan_spec const *chan,
	133	int val,
	134	int val2,
	135	long mask)
	136	{
	137	int ret = -EINVAL;
	138
c8a9f805	139	if (mask == IIO_CHAN_INFO_SCALE) {
d34dbee8 JC	140	/* Check no integer component */
	141	if (val)
	142	return -EINVAL;
	143	ret = kxsd9_write_scale(indio_dev, val2);
	144	}
	145
	146	return ret;
	147	}
	148
	149	static int kxsd9_read_raw(struct iio_dev *indio_dev,
	150	struct iio_chan_spec const *chan,
	151	int val, int val2, long mask)
	152	{
	153	int ret = -EINVAL;
	154	struct kxsd9_state *st = iio_priv(indio_dev);
	155
	156	switch (mask) {
31313fc6	157	case IIO_CHAN_INFO_RAW:
d34dbee8 JC	158	ret = kxsd9_read(indio_dev, chan->address);
	159	if (ret < 0)
	160	goto error_ret;
	161	*val = ret;
	162	break;
c8a9f805	163	case IIO_CHAN_INFO_SCALE:
d34dbee8 JC	164	ret = spi_w8r8(st->us, KXSD9_READ(KXSD9_REG_CTRL_C));
	165	if (ret)
	166	goto error_ret;
	167	*val2 = kxsd9_micro_scales[ret & KXSD9_FS_MASK];
	168	ret = IIO_VAL_INT_PLUS_MICRO;
	169	break;
73327b4c	170	}
d34dbee8 JC	171
	172	error_ret:
	173	return ret;
	174	};
	175	#define KXSD9_ACCEL_CHAN(axis) \
	176	{ \
	177	.type = IIO_ACCEL, \
	178	.modified = 1, \
	179	.channel2 = IIO_MOD_##axis, \
2f6bb534 JC	180	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
2f6bb534 JC	181	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE), \
d34dbee8 JC	182	.address = KXSD9_REG_##axis, \
	183	}
	184
f4e4b955	185	static const struct iio_chan_spec kxsd9_channels[] = {
d34dbee8 JC	186	KXSD9_ACCEL_CHAN(X), KXSD9_ACCEL_CHAN(Y), KXSD9_ACCEL_CHAN(Z),
d34dbee8 JC	187	{
6835cb6b	188	.type = IIO_VOLTAGE,
2f6bb534	189	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
d34dbee8 JC	190	.indexed = 1,
	191	.address = KXSD9_REG_AUX,
	192	}
	193	};
	194
e435bc19 JC	195	static const struct attribute_group kxsd9_attribute_group = {
	196	.attrs = kxsd9_attributes,
	197	};
	198
4ae1c61f	199	static int kxsd9_power_up(struct kxsd9_state *st)
e435bc19	200	{
d34dbee8 JC	201	int ret;
d34dbee8 JC	202
3fd47d44	203	st->tx[0] = 0x0d;
3fd47d44	204	st->tx[1] = 0x40;
d34dbee8 JC	205	ret = spi_write(st->us, st->tx, 2);
	206	if (ret)
	207	return ret;
e435bc19	208
d34dbee8 JC	209	st->tx[0] = 0x0c;
	210	st->tx[1] = 0x9b;
	211	return spi_write(st->us, st->tx, 2);
e435bc19 JC	212	};
e435bc19 JC	213
6fe8135f	214	static const struct iio_info kxsd9_info = {
d34dbee8 JC	215	.read_raw = &kxsd9_read_raw,
d34dbee8 JC	216	.write_raw = &kxsd9_write_raw,
6fe8135f JC	217	.attrs = &kxsd9_attribute_group,
	218	.driver_module = THIS_MODULE,
	219	};
	220
4ae1c61f	221	static int kxsd9_probe(struct spi_device *spi)
e435bc19	222	{
ed0c012b	223	struct iio_dev *indio_dev;
e435bc19	224	struct kxsd9_state *st;
d526e513	225	int ret;
e435bc19	226
4ee30933 SK	227	indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
	228	if (!indio_dev)
	229	return -ENOMEM;
	230
ed0c012b JC	231	st = iio_priv(indio_dev);
ed0c012b JC	232	spi_set_drvdata(spi, indio_dev);
e435bc19 JC	233
	234	st->us = spi;
	235	mutex_init(&st->buf_lock);
d34dbee8 JC	236	indio_dev->channels = kxsd9_channels;
	237	indio_dev->num_channels = ARRAY_SIZE(kxsd9_channels);
	238	indio_dev->name = spi_get_device_id(spi)->name;
ed0c012b JC	239	indio_dev->dev.parent = &spi->dev;
	240	indio_dev->info = &kxsd9_info;
	241	indio_dev->modes = INDIO_DIRECT_MODE;
	242
e435bc19 JC	243	spi->mode = SPI_MODE_0;
e435bc19 JC	244	spi_setup(spi);
3fd47d44	245	kxsd9_power_up(st);
e435bc19	246
d526e513 JC	247	ret = iio_device_register(indio_dev);
d526e513 JC	248	if (ret)
4ee30933	249	return ret;
d526e513	250
e435bc19	251	return 0;
e435bc19 JC	252	}
e435bc19 JC	253
447d4f29	254	static int kxsd9_remove(struct spi_device *spi)
e435bc19	255	{
ed0c012b	256	iio_device_unregister(spi_get_drvdata(spi));
e435bc19 JC	257
	258	return 0;
	259	}
	260
d34dbee8	261	static const struct spi_device_id kxsd9_id[] = {
55e4390c LPC	262	{"kxsd9", 0},
55e4390c LPC	263	{ },
d34dbee8	264	};
55e4390c	265	MODULE_DEVICE_TABLE(spi, kxsd9_id);
d34dbee8	266
e435bc19 JC	267	static struct spi_driver kxsd9_driver = {
	268	.driver = {
	269	.name = "kxsd9",
	270	.owner = THIS_MODULE,
	271	},
	272	.probe = kxsd9_probe,
e543acf0	273	.remove = kxsd9_remove,
d34dbee8	274	.id_table = kxsd9_id,
e435bc19	275	};
ae6ae6fe	276	module_spi_driver(kxsd9_driver);
e435bc19	277
0f8c9620	278	MODULE_AUTHOR("Jonathan Cameron <jic23@kernel.org>");
e435bc19 JC	279	MODULE_DESCRIPTION("Kionix KXSD9 SPI driver");
e435bc19 JC	280	MODULE_LICENSE("GPL v2");