[linux-block.git] / drivers / hwmon / lis3lv02d.h

/*
 *  lis3lv02d.h - ST LIS3LV02DL accelerometer driver
 *
 *  Copyright (C) 2007-2008 Yan Burman
 *  Copyright (C) 2008-2009 Eric Piel
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  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/platform_device.h>
#include <linux/input-polldev.h>

/*
 * This driver tries to support the "digital" accelerometer chips from
 * STMicroelectronics such as LIS3LV02DL, LIS302DL, LIS3L02DQ, LIS331DL,
 * LIS35DE, or LIS202DL. They are very similar in terms of programming, with
 * almost the same registers. In addition to differing on physical properties,
 * they differ on the number of axes (2/3), precision (8/12 bits), and special
 * features (freefall detection, click...). Unfortunately, not all the
 * differences can be probed via a register.
 * They can be connected either via I²C or SPI.
 */

#include <linux/lis3lv02d.h>

enum lis3_reg {
	WHO_AM_I	= 0x0F,
	OFFSET_X	= 0x16,
	OFFSET_Y	= 0x17,
	OFFSET_Z	= 0x18,
	GAIN_X		= 0x19,
	GAIN_Y		= 0x1A,
	GAIN_Z		= 0x1B,
	CTRL_REG1	= 0x20,
	CTRL_REG2	= 0x21,
	CTRL_REG3	= 0x22,
	CTRL_REG4	= 0x23,
	HP_FILTER_RESET	= 0x23,
	STATUS_REG	= 0x27,
	OUTX_L		= 0x28,
	OUTX_H		= 0x29,
	OUTX		= 0x29,
	OUTY_L		= 0x2A,
	OUTY_H		= 0x2B,
	OUTY		= 0x2B,
	OUTZ_L		= 0x2C,
	OUTZ_H		= 0x2D,
	OUTZ		= 0x2D,
};

enum lis302d_reg {
	FF_WU_CFG_1	= 0x30,
	FF_WU_SRC_1	= 0x31,
	FF_WU_THS_1	= 0x32,
	FF_WU_DURATION_1 = 0x33,
	FF_WU_CFG_2	= 0x34,
	FF_WU_SRC_2	= 0x35,
	FF_WU_THS_2	= 0x36,
	FF_WU_DURATION_2 = 0x37,
	CLICK_CFG	= 0x38,
	CLICK_SRC	= 0x39,
	CLICK_THSY_X	= 0x3B,
	CLICK_THSZ	= 0x3C,
	CLICK_TIMELIMIT	= 0x3D,
	CLICK_LATENCY	= 0x3E,
	CLICK_WINDOW	= 0x3F,
};

enum lis3lv02d_reg {
	FF_WU_CFG	= 0x30,
	FF_WU_SRC	= 0x31,
	FF_WU_ACK	= 0x32,
	FF_WU_THS_L	= 0x34,
	FF_WU_THS_H	= 0x35,
	FF_WU_DURATION	= 0x36,
	DD_CFG		= 0x38,
	DD_SRC		= 0x39,
	DD_ACK		= 0x3A,
	DD_THSI_L	= 0x3C,
	DD_THSI_H	= 0x3D,
	DD_THSE_L	= 0x3E,
	DD_THSE_H	= 0x3F,
};

enum lis3_who_am_i {
	WAI_3DC		= 0x33,	/* 8 bits: LIS3DC, HP3DC */
	WAI_12B		= 0x3A, /* 12 bits: LIS3LV02D[LQ]... */
	WAI_8B		= 0x3B, /* 8 bits: LIS[23]02D[LQ]... */
	WAI_6B		= 0x52, /* 6 bits: LIS331DLF - not supported */
};

enum lis3lv02d_ctrl1_12b {
	CTRL1_Xen	= 0x01,
	CTRL1_Yen	= 0x02,
	CTRL1_Zen	= 0x04,
	CTRL1_ST	= 0x08,
	CTRL1_DF0	= 0x10,
	CTRL1_DF1	= 0x20,
	CTRL1_PD0	= 0x40,
	CTRL1_PD1	= 0x80,
};

/* Delta to ctrl1_12b version */
enum lis3lv02d_ctrl1_8b {
	CTRL1_STM	= 0x08,
	CTRL1_STP	= 0x10,
	CTRL1_FS	= 0x20,
	CTRL1_PD	= 0x40,
	CTRL1_DR	= 0x80,
};

enum lis3lv02d_ctrl1_3dc {
	CTRL1_ODR0	= 0x10,
	CTRL1_ODR1	= 0x20,
	CTRL1_ODR2	= 0x40,
	CTRL1_ODR3	= 0x80,
};

enum lis3lv02d_ctrl2 {
	CTRL2_DAS	= 0x01,
	CTRL2_SIM	= 0x02,
	CTRL2_DRDY	= 0x04,
	CTRL2_IEN	= 0x08,
	CTRL2_BOOT	= 0x10,
	CTRL2_BLE	= 0x20,
	CTRL2_BDU	= 0x40, /* Block Data Update */
	CTRL2_FS	= 0x80, /* Full Scale selection */
};

enum lis3lv02d_ctrl4_3dc {
	CTRL4_SIM	= 0x01,
	CTRL4_ST0	= 0x02,
	CTRL4_ST1	= 0x04,
	CTRL4_FS0	= 0x10,
	CTRL4_FS1	= 0x20,
};

enum lis302d_ctrl2 {
	HP_FF_WU2	= 0x08,
	HP_FF_WU1	= 0x04,
};

enum lis3lv02d_ctrl3 {
	CTRL3_CFS0	= 0x01,
	CTRL3_CFS1	= 0x02,
	CTRL3_FDS	= 0x10,
	CTRL3_HPFF	= 0x20,
	CTRL3_HPDD	= 0x40,
	CTRL3_ECK	= 0x80,
};

enum lis3lv02d_status_reg {
	STATUS_XDA	= 0x01,
	STATUS_YDA	= 0x02,
	STATUS_ZDA	= 0x04,
	STATUS_XYZDA	= 0x08,
	STATUS_XOR	= 0x10,
	STATUS_YOR	= 0x20,
	STATUS_ZOR	= 0x40,
	STATUS_XYZOR	= 0x80,
};

enum lis3lv02d_ff_wu_cfg {
	FF_WU_CFG_XLIE	= 0x01,
	FF_WU_CFG_XHIE	= 0x02,
	FF_WU_CFG_YLIE	= 0x04,
	FF_WU_CFG_YHIE	= 0x08,
	FF_WU_CFG_ZLIE	= 0x10,
	FF_WU_CFG_ZHIE	= 0x20,
	FF_WU_CFG_LIR	= 0x40,
	FF_WU_CFG_AOI	= 0x80,
};

enum lis3lv02d_ff_wu_src {
	FF_WU_SRC_XL	= 0x01,
	FF_WU_SRC_XH	= 0x02,
	FF_WU_SRC_YL	= 0x04,
	FF_WU_SRC_YH	= 0x08,
	FF_WU_SRC_ZL	= 0x10,
	FF_WU_SRC_ZH	= 0x20,
	FF_WU_SRC_IA	= 0x40,
};

enum lis3lv02d_dd_cfg {
	DD_CFG_XLIE	= 0x01,
	DD_CFG_XHIE	= 0x02,
	DD_CFG_YLIE	= 0x04,
	DD_CFG_YHIE	= 0x08,
	DD_CFG_ZLIE	= 0x10,
	DD_CFG_ZHIE	= 0x20,
	DD_CFG_LIR	= 0x40,
	DD_CFG_IEND	= 0x80,
};

enum lis3lv02d_dd_src {
	DD_SRC_XL	= 0x01,
	DD_SRC_XH	= 0x02,
	DD_SRC_YL	= 0x04,
	DD_SRC_YH	= 0x08,
	DD_SRC_ZL	= 0x10,
	DD_SRC_ZH	= 0x20,
	DD_SRC_IA	= 0x40,
};

enum lis3lv02d_click_src_8b {
	CLICK_SINGLE_X	= 0x01,
	CLICK_DOUBLE_X	= 0x02,
	CLICK_SINGLE_Y	= 0x04,
	CLICK_DOUBLE_Y	= 0x08,
	CLICK_SINGLE_Z	= 0x10,
	CLICK_DOUBLE_Z	= 0x20,
	CLICK_IA	= 0x40,
};

union axis_conversion {
	struct {
		int x, y, z;
	};
	int as_array[3];
};

struct lis3lv02d {
	void			*bus_priv; /* used by the bus layer only */
	int (*init) (struct lis3lv02d *lis3);
	int (*write) (struct lis3lv02d *lis3, int reg, u8 val);
	int (*read) (struct lis3lv02d *lis3, int reg, u8 *ret);

	int                     *odrs;     /* Supported output data rates */
	u8                      odr_mask;  /* ODR bit mask */
	u8			whoami;    /* indicates measurement precision */
	s16 (*read_data) (struct lis3lv02d *lis3, int reg);
	int			mdps_max_val;
	int			pwron_delay;
	int                     scale; /*
					* relationship between 1 LBS and mG
					* (1/1000th of earth gravity)
					*/

	struct input_polled_dev	*idev;     /* input device */
	struct platform_device	*pdev;     /* platform device */
	atomic_t		count;     /* interrupt count after last read */
	union axis_conversion	ac;        /* hw -> logical axis */
	int			mapped_btns[3];

	u32			irq;       /* IRQ number */
	struct fasync_struct	*async_queue; /* queue for the misc device */
	wait_queue_head_t	misc_wait; /* Wait queue for the misc device */
	unsigned long		misc_opened; /* bit0: whether the device is open */

	struct lis3lv02d_platform_data *pdata;	/* for passing board config */
	struct mutex		mutex;     /* Serialize poll and selftest */
};

int lis3lv02d_init_device(struct lis3lv02d *lis3);
int lis3lv02d_joystick_enable(void);
void lis3lv02d_joystick_disable(void);
void lis3lv02d_poweroff(struct lis3lv02d *lis3);
void lis3lv02d_poweron(struct lis3lv02d *lis3);
int lis3lv02d_remove_fs(struct lis3lv02d *lis3);

extern struct lis3lv02d lis3_dev;
Commit	Line	Data
455fbdd3 PM	1	/*
	2	* lis3lv02d.h - ST LIS3LV02DL accelerometer driver
	3	*
	4	* Copyright (C) 2007-2008 Yan Burman
bc62c147	5	* Copyright (C) 2008-2009 Eric Piel
455fbdd3 PM	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 as published by
	9	* the Free Software Foundation; either version 2 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	20	*/
dc6ea97b EP	21	#include <linux/platform_device.h>
dc6ea97b EP	22	#include <linux/input-polldev.h>
455fbdd3 PM	23
455fbdd3 PM	24	/*
bc62c147 ÉP	25	* This driver tries to support the "digital" accelerometer chips from
	26	* STMicroelectronics such as LIS3LV02DL, LIS302DL, LIS3L02DQ, LIS331DL,
	27	* LIS35DE, or LIS202DL. They are very similar in terms of programming, with
	28	* almost the same registers. In addition to differing on physical properties,
	29	* they differ on the number of axes (2/3), precision (8/12 bits), and special
	30	* features (freefall detection, click...). Unfortunately, not all the
	31	* differences can be probed via a register.
	32	* They can be connected either via I²C or SPI.
455fbdd3 PM	33	*/
455fbdd3 PM	34
8f3128e7 DM	35	#include <linux/lis3lv02d.h>
8f3128e7 DM	36
8f3128e7	37	enum lis3_reg {
455fbdd3 PM	38	WHO_AM_I = 0x0F,
	39	OFFSET_X = 0x16,
	40	OFFSET_Y = 0x17,
	41	OFFSET_Z = 0x18,
	42	GAIN_X = 0x19,
	43	GAIN_Y = 0x1A,
	44	GAIN_Z = 0x1B,
	45	CTRL_REG1 = 0x20,
	46	CTRL_REG2 = 0x21,
	47	CTRL_REG3 = 0x22,
78537c3b	48	CTRL_REG4 = 0x23,
455fbdd3 PM	49	HP_FILTER_RESET = 0x23,
	50	STATUS_REG = 0x27,
	51	OUTX_L = 0x28,
	52	OUTX_H = 0x29,
137bad32	53	OUTX = 0x29,
455fbdd3 PM	54	OUTY_L = 0x2A,
455fbdd3 PM	55	OUTY_H = 0x2B,
137bad32	56	OUTY = 0x2B,
455fbdd3 PM	57	OUTZ_L = 0x2C,
455fbdd3 PM	58	OUTZ_H = 0x2D,
137bad32	59	OUTZ = 0x2D,
8f3128e7 DM	60	};
	61
	62	enum lis302d_reg {
8873c334 DM	63	FF_WU_CFG_1 = 0x30,
	64	FF_WU_SRC_1 = 0x31,
	65	FF_WU_THS_1 = 0x32,
	66	FF_WU_DURATION_1 = 0x33,
	67	FF_WU_CFG_2 = 0x34,
	68	FF_WU_SRC_2 = 0x35,
	69	FF_WU_THS_2 = 0x36,
	70	FF_WU_DURATION_2 = 0x37,
8f3128e7 DM	71	CLICK_CFG = 0x38,
	72	CLICK_SRC = 0x39,
	73	CLICK_THSY_X = 0x3B,
	74	CLICK_THSZ = 0x3C,
	75	CLICK_TIMELIMIT = 0x3D,
	76	CLICK_LATENCY = 0x3E,
	77	CLICK_WINDOW = 0x3F,
	78	};
	79
	80	enum lis3lv02d_reg {
8873c334 DM	81	FF_WU_CFG = 0x30,
	82	FF_WU_SRC = 0x31,
	83	FF_WU_ACK = 0x32,
	84	FF_WU_THS_L = 0x34,
	85	FF_WU_THS_H = 0x35,
	86	FF_WU_DURATION = 0x36,
455fbdd3 PM	87	DD_CFG = 0x38,
	88	DD_SRC = 0x39,
	89	DD_ACK = 0x3A,
	90	DD_THSI_L = 0x3C,
	91	DD_THSI_H = 0x3D,
	92	DD_THSE_L = 0x3E,
	93	DD_THSE_H = 0x3F,
	94	};
	95
bc62c147	96	enum lis3_who_am_i {
78537c3b	97	WAI_3DC = 0x33, /* 8 bits: LIS3DC, HP3DC */
bc62c147 ÉP	98	WAI_12B = 0x3A, /* 12 bits: LIS3LV02D[LQ]... */
	99	WAI_8B = 0x3B, /* 8 bits: LIS[23]02D[LQ]... */
	100	WAI_6B = 0x52, /* 6 bits: LIS331DLF - not supported */
	101	};
	102
2db4a76d	103	enum lis3lv02d_ctrl1_12b {
455fbdd3 PM	104	CTRL1_Xen = 0x01,
	105	CTRL1_Yen = 0x02,
	106	CTRL1_Zen = 0x04,
	107	CTRL1_ST = 0x08,
	108	CTRL1_DF0 = 0x10,
	109	CTRL1_DF1 = 0x20,
	110	CTRL1_PD0 = 0x40,
	111	CTRL1_PD1 = 0x80,
	112	};
2db4a76d SO	113
	114	/* Delta to ctrl1_12b version */
	115	enum lis3lv02d_ctrl1_8b {
	116	CTRL1_STM = 0x08,
	117	CTRL1_STP = 0x10,
	118	CTRL1_FS = 0x20,
	119	CTRL1_PD = 0x40,
	120	CTRL1_DR = 0x80,
	121	};
	122
78537c3b TI	123	enum lis3lv02d_ctrl1_3dc {
	124	CTRL1_ODR0 = 0x10,
	125	CTRL1_ODR1 = 0x20,
	126	CTRL1_ODR2 = 0x40,
	127	CTRL1_ODR3 = 0x80,
	128	};
	129
455fbdd3 PM	130	enum lis3lv02d_ctrl2 {
	131	CTRL2_DAS = 0x01,
	132	CTRL2_SIM = 0x02,
	133	CTRL2_DRDY = 0x04,
	134	CTRL2_IEN = 0x08,
	135	CTRL2_BOOT = 0x10,
	136	CTRL2_BLE = 0x20,
	137	CTRL2_BDU = 0x40, /* Block Data Update */
	138	CTRL2_FS = 0x80, /* Full Scale selection */
	139	};
	140
78537c3b TI	141	enum lis3lv02d_ctrl4_3dc {
	142	CTRL4_SIM = 0x01,
	143	CTRL4_ST0 = 0x02,
	144	CTRL4_ST1 = 0x04,
	145	CTRL4_FS0 = 0x10,
	146	CTRL4_FS1 = 0x20,
	147	};
	148
8873c334 DM	149	enum lis302d_ctrl2 {
	150	HP_FF_WU2 = 0x08,
	151	HP_FF_WU1 = 0x04,
	152	};
455fbdd3 PM	153
	154	enum lis3lv02d_ctrl3 {
	155	CTRL3_CFS0 = 0x01,
	156	CTRL3_CFS1 = 0x02,
	157	CTRL3_FDS = 0x10,
	158	CTRL3_HPFF = 0x20,
	159	CTRL3_HPDD = 0x40,
	160	CTRL3_ECK = 0x80,
	161	};
	162
	163	enum lis3lv02d_status_reg {
	164	STATUS_XDA = 0x01,
	165	STATUS_YDA = 0x02,
	166	STATUS_ZDA = 0x04,
	167	STATUS_XYZDA = 0x08,
	168	STATUS_XOR = 0x10,
	169	STATUS_YOR = 0x20,
	170	STATUS_ZOR = 0x40,
	171	STATUS_XYZOR = 0x80,
	172	};
	173
	174	enum lis3lv02d_ff_wu_cfg {
	175	FF_WU_CFG_XLIE = 0x01,
	176	FF_WU_CFG_XHIE = 0x02,
	177	FF_WU_CFG_YLIE = 0x04,
	178	FF_WU_CFG_YHIE = 0x08,
	179	FF_WU_CFG_ZLIE = 0x10,
	180	FF_WU_CFG_ZHIE = 0x20,
	181	FF_WU_CFG_LIR = 0x40,
	182	FF_WU_CFG_AOI = 0x80,
	183	};
	184
	185	enum lis3lv02d_ff_wu_src {
	186	FF_WU_SRC_XL = 0x01,
	187	FF_WU_SRC_XH = 0x02,
	188	FF_WU_SRC_YL = 0x04,
	189	FF_WU_SRC_YH = 0x08,
	190	FF_WU_SRC_ZL = 0x10,
	191	FF_WU_SRC_ZH = 0x20,
	192	FF_WU_SRC_IA = 0x40,
	193	};
	194
	195	enum lis3lv02d_dd_cfg {
	196	DD_CFG_XLIE = 0x01,
	197	DD_CFG_XHIE = 0x02,
	198	DD_CFG_YLIE = 0x04,
	199	DD_CFG_YHIE = 0x08,
	200	DD_CFG_ZLIE = 0x10,
	201	DD_CFG_ZHIE = 0x20,
	202	DD_CFG_LIR = 0x40,
	203	DD_CFG_IEND = 0x80,
	204	};
	205
	206	enum lis3lv02d_dd_src {
	207	DD_SRC_XL = 0x01,
	208	DD_SRC_XH = 0x02,
	209	DD_SRC_YL = 0x04,
	210	DD_SRC_YH = 0x08,
	211	DD_SRC_ZL = 0x10,
	212	DD_SRC_ZH = 0x20,
	213	DD_SRC_IA = 0x40,
	214	};
	215
58e81422 SO	216	enum lis3lv02d_click_src_8b {
	217	CLICK_SINGLE_X = 0x01,
	218	CLICK_DOUBLE_X = 0x02,
	219	CLICK_SINGLE_Y = 0x04,
	220	CLICK_DOUBLE_Y = 0x08,
	221	CLICK_SINGLE_Z = 0x10,
	222	CLICK_DOUBLE_Z = 0x20,
	223	CLICK_IA = 0x40,
	224	};
	225
2ee32144 TI	226	union axis_conversion {
	227	struct {
	228	int x, y, z;
	229	};
	230	int as_array[3];
cfce41a6 EP	231	};
cfce41a6 EP	232
a38da2ed DM	233	struct lis3lv02d {
	234	void bus_priv; / used by the bus layer only */
	235	int (init) (struct lis3lv02d lis3);
	236	int (write) (struct lis3lv02d lis3, int reg, u8 val);
	237	int (read) (struct lis3lv02d lis3, int reg, u8 *ret);
cfce41a6	238
a253aaef SO	239	int odrs; / Supported output data rates */
a253aaef SO	240	u8 odr_mask; /* ODR bit mask */
bc62c147	241	u8 whoami; /* indicates measurement precision */
a38da2ed	242	s16 (read_data) (struct lis3lv02d lis3, int reg);
137bad32	243	int mdps_max_val;
641615ab	244	int pwron_delay;
32496c76 SO	245	int scale; /*
	246	* relationship between 1 LBS and mG
	247	* (1/1000th of earth gravity)
	248	*/
137bad32	249
dc6ea97b	250	struct input_polled_dev idev; / input device */
cfce41a6 EP	251	struct platform_device pdev; / platform device */
cfce41a6 EP	252	atomic_t count; /* interrupt count after last read */
2ee32144	253	union axis_conversion ac; /* hw -> logical axis */
6d94d408	254	int mapped_btns[3];
ef2cfc79 PM	255
	256	u32 irq; /* IRQ number */
	257	struct fasync_struct async_queue; / queue for the misc device */
	258	wait_queue_head_t misc_wait; /* Wait queue for the misc device */
	259	unsigned long misc_opened; /* bit0: whether the device is open */
8f3128e7 DM	260
8f3128e7 DM	261	struct lis3lv02d_platform_data pdata; / for passing board config */
2db4a76d	262	struct mutex mutex; /* Serialize poll and selftest */
cfce41a6 EP	263	};
cfce41a6 EP	264
a38da2ed	265	int lis3lv02d_init_device(struct lis3lv02d *lis3);
cfce41a6 EP	266	int lis3lv02d_joystick_enable(void);
cfce41a6 EP	267	void lis3lv02d_joystick_disable(void);
a38da2ed DM	268	void lis3lv02d_poweroff(struct lis3lv02d *lis3);
a38da2ed DM	269	void lis3lv02d_poweron(struct lis3lv02d *lis3);
a002ee89	270	int lis3lv02d_remove_fs(struct lis3lv02d *lis3);
cfce41a6	271
a38da2ed	272	extern struct lis3lv02d lis3_dev;