1/*
2 *  lis3lv02d.h - ST LIS3LV02DL accelerometer driver
3 *
4 *  Copyright (C) 2007-2008 Yan Burman
5 *  Copyright (C) 2008-2009 Eric Piel
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 */
21#include <linux/platform_device.h>
22#include <linux/input-polldev.h>
23#include <linux/regulator/consumer.h>
24#include <linux/miscdevice.h>
25
26/*
27 * This driver tries to support the "digital" accelerometer chips from
28 * STMicroelectronics such as LIS3LV02DL, LIS302DL, LIS3L02DQ, LIS331DL,
29 * LIS331DLH, LIS35DE, or LIS202DL. They are very similar in terms of
30 * programming, with almost the same registers. In addition to differing
31 * on physical properties, they differ on the number of axes (2/3),
32 * precision (8/12 bits), and special features (freefall detection,
33 * click...). Unfortunately, not all the differences can be probed via
34 * a register. They can be connected either via I²C or SPI.
35 */
36
37#include <linux/lis3lv02d.h>
38
39enum lis3_reg {
40	WHO_AM_I	= 0x0F,
41	OFFSET_X	= 0x16,
42	OFFSET_Y	= 0x17,
43	OFFSET_Z	= 0x18,
44	GAIN_X		= 0x19,
45	GAIN_Y		= 0x1A,
46	GAIN_Z		= 0x1B,
47	CTRL_REG1	= 0x20,
48	CTRL_REG2	= 0x21,
49	CTRL_REG3	= 0x22,
50	CTRL_REG4	= 0x23,
51	HP_FILTER_RESET	= 0x23,
52	STATUS_REG	= 0x27,
53	OUTX_L		= 0x28,
54	OUTX_H		= 0x29,
55	OUTX		= 0x29,
56	OUTY_L		= 0x2A,
57	OUTY_H		= 0x2B,
58	OUTY		= 0x2B,
59	OUTZ_L		= 0x2C,
60	OUTZ_H		= 0x2D,
61	OUTZ		= 0x2D,
62};
63
64enum lis302d_reg {
65	FF_WU_CFG_1	= 0x30,
66	FF_WU_SRC_1	= 0x31,
67	FF_WU_THS_1	= 0x32,
68	FF_WU_DURATION_1 = 0x33,
69	FF_WU_CFG_2	= 0x34,
70	FF_WU_SRC_2	= 0x35,
71	FF_WU_THS_2	= 0x36,
72	FF_WU_DURATION_2 = 0x37,
73	CLICK_CFG	= 0x38,
74	CLICK_SRC	= 0x39,
75	CLICK_THSY_X	= 0x3B,
76	CLICK_THSZ	= 0x3C,
77	CLICK_TIMELIMIT	= 0x3D,
78	CLICK_LATENCY	= 0x3E,
79	CLICK_WINDOW	= 0x3F,
80};
81
82enum lis3lv02d_reg {
83	FF_WU_CFG	= 0x30,
84	FF_WU_SRC	= 0x31,
85	FF_WU_ACK	= 0x32,
86	FF_WU_THS_L	= 0x34,
87	FF_WU_THS_H	= 0x35,
88	FF_WU_DURATION	= 0x36,
89	DD_CFG		= 0x38,
90	DD_SRC		= 0x39,
91	DD_ACK		= 0x3A,
92	DD_THSI_L	= 0x3C,
93	DD_THSI_H	= 0x3D,
94	DD_THSE_L	= 0x3E,
95	DD_THSE_H	= 0x3F,
96};
97
98enum lis3_who_am_i {
99	WAI_3DLH	= 0x32,	/* 16 bits: LIS331DLH */
100	WAI_3DC		= 0x33,	/* 8 bits: LIS3DC, HP3DC */
101	WAI_12B		= 0x3A, /* 12 bits: LIS3LV02D[LQ]... */
102	WAI_8B		= 0x3B, /* 8 bits: LIS[23]02D[LQ]... */
103	WAI_6B		= 0x52, /* 6 bits: LIS331DLF - not supported */
104};
105
106enum lis3_type {
107	LIS3LV02D,
108	LIS3DC,
109	HP3DC,
110	LIS2302D,
111	LIS331DLF,
112	LIS331DLH,
113};
114
115enum lis3lv02d_ctrl1_12b {
116	CTRL1_Xen	= 0x01,
117	CTRL1_Yen	= 0x02,
118	CTRL1_Zen	= 0x04,
119	CTRL1_ST	= 0x08,
120	CTRL1_DF0	= 0x10,
121	CTRL1_DF1	= 0x20,
122	CTRL1_PD0	= 0x40,
123	CTRL1_PD1	= 0x80,
124};
125
126/* Delta to ctrl1_12b version */
127enum lis3lv02d_ctrl1_8b {
128	CTRL1_STM	= 0x08,
129	CTRL1_STP	= 0x10,
130	CTRL1_FS	= 0x20,
131	CTRL1_PD	= 0x40,
132	CTRL1_DR	= 0x80,
133};
134
135enum lis3lv02d_ctrl1_3dc {
136	CTRL1_ODR0	= 0x10,
137	CTRL1_ODR1	= 0x20,
138	CTRL1_ODR2	= 0x40,
139	CTRL1_ODR3	= 0x80,
140};
141
142enum lis331dlh_ctrl1 {
143	CTRL1_DR0	= 0x08,
144	CTRL1_DR1	= 0x10,
145	CTRL1_PM0	= 0x20,
146	CTRL1_PM1	= 0x40,
147	CTRL1_PM2	= 0x80,
148};
149
150enum lis331dlh_ctrl2 {
151	CTRL2_HPEN1	= 0x04,
152	CTRL2_HPEN2	= 0x08,
153	CTRL2_FDS_3DLH	= 0x10,
154	CTRL2_BOOT_3DLH	= 0x80,
155};
156
157enum lis331dlh_ctrl4 {
158	CTRL4_STSIGN	= 0x08,
159	CTRL4_BLE	= 0x40,
160	CTRL4_BDU	= 0x80,
161};
162
163enum lis3lv02d_ctrl2 {
164	CTRL2_DAS	= 0x01,
165	CTRL2_SIM	= 0x02,
166	CTRL2_DRDY	= 0x04,
167	CTRL2_IEN	= 0x08,
168	CTRL2_BOOT	= 0x10,
169	CTRL2_BLE	= 0x20,
170	CTRL2_BDU	= 0x40, /* Block Data Update */
171	CTRL2_FS	= 0x80, /* Full Scale selection */
172};
173
174enum lis3lv02d_ctrl4_3dc {
175	CTRL4_SIM	= 0x01,
176	CTRL4_ST0	= 0x02,
177	CTRL4_ST1	= 0x04,
178	CTRL4_FS0	= 0x10,
179	CTRL4_FS1	= 0x20,
180};
181
182enum lis302d_ctrl2 {
183	HP_FF_WU2	= 0x08,
184	HP_FF_WU1	= 0x04,
185	CTRL2_BOOT_8B   = 0x40,
186};
187
188enum lis3lv02d_ctrl3 {
189	CTRL3_CFS0	= 0x01,
190	CTRL3_CFS1	= 0x02,
191	CTRL3_FDS	= 0x10,
192	CTRL3_HPFF	= 0x20,
193	CTRL3_HPDD	= 0x40,
194	CTRL3_ECK	= 0x80,
195};
196
197enum lis3lv02d_status_reg {
198	STATUS_XDA	= 0x01,
199	STATUS_YDA	= 0x02,
200	STATUS_ZDA	= 0x04,
201	STATUS_XYZDA	= 0x08,
202	STATUS_XOR	= 0x10,
203	STATUS_YOR	= 0x20,
204	STATUS_ZOR	= 0x40,
205	STATUS_XYZOR	= 0x80,
206};
207
208enum lis3lv02d_ff_wu_cfg {
209	FF_WU_CFG_XLIE	= 0x01,
210	FF_WU_CFG_XHIE	= 0x02,
211	FF_WU_CFG_YLIE	= 0x04,
212	FF_WU_CFG_YHIE	= 0x08,
213	FF_WU_CFG_ZLIE	= 0x10,
214	FF_WU_CFG_ZHIE	= 0x20,
215	FF_WU_CFG_LIR	= 0x40,
216	FF_WU_CFG_AOI	= 0x80,
217};
218
219enum lis3lv02d_ff_wu_src {
220	FF_WU_SRC_XL	= 0x01,
221	FF_WU_SRC_XH	= 0x02,
222	FF_WU_SRC_YL	= 0x04,
223	FF_WU_SRC_YH	= 0x08,
224	FF_WU_SRC_ZL	= 0x10,
225	FF_WU_SRC_ZH	= 0x20,
226	FF_WU_SRC_IA	= 0x40,
227};
228
229enum lis3lv02d_dd_cfg {
230	DD_CFG_XLIE	= 0x01,
231	DD_CFG_XHIE	= 0x02,
232	DD_CFG_YLIE	= 0x04,
233	DD_CFG_YHIE	= 0x08,
234	DD_CFG_ZLIE	= 0x10,
235	DD_CFG_ZHIE	= 0x20,
236	DD_CFG_LIR	= 0x40,
237	DD_CFG_IEND	= 0x80,
238};
239
240enum lis3lv02d_dd_src {
241	DD_SRC_XL	= 0x01,
242	DD_SRC_XH	= 0x02,
243	DD_SRC_YL	= 0x04,
244	DD_SRC_YH	= 0x08,
245	DD_SRC_ZL	= 0x10,
246	DD_SRC_ZH	= 0x20,
247	DD_SRC_IA	= 0x40,
248};
249
250enum lis3lv02d_click_src_8b {
251	CLICK_SINGLE_X	= 0x01,
252	CLICK_DOUBLE_X	= 0x02,
253	CLICK_SINGLE_Y	= 0x04,
254	CLICK_DOUBLE_Y	= 0x08,
255	CLICK_SINGLE_Z	= 0x10,
256	CLICK_DOUBLE_Z	= 0x20,
257	CLICK_IA	= 0x40,
258};
259
260enum lis3lv02d_reg_state {
261	LIS3_REG_OFF	= 0x00,
262	LIS3_REG_ON	= 0x01,
263};
264
265union axis_conversion {
266	struct {
267		int x, y, z;
268	};
269	int as_array[3];
270
271};
272
273struct lis3lv02d {
274	void			*bus_priv; /* used by the bus layer only */
275	struct device		*pm_dev; /* for pm_runtime purposes */
276	int (*init) (struct lis3lv02d *lis3);
277	int (*write) (struct lis3lv02d *lis3, int reg, u8 val);
278	int (*read) (struct lis3lv02d *lis3, int reg, u8 *ret);
279	int (*blkread) (struct lis3lv02d *lis3, int reg, int len, u8 *ret);
280	int (*reg_ctrl) (struct lis3lv02d *lis3, bool state);
281
282	int                     *odrs;     /* Supported output data rates */
283	u8			*regs;	   /* Regs to store / restore */
284	int			regs_size;
285	u8                      *reg_cache;
286	bool			regs_stored;
287	u8                      odr_mask;  /* ODR bit mask */
288	u8			whoami;    /* indicates measurement precision */
289	s16 (*read_data) (struct lis3lv02d *lis3, int reg);
290	int			mdps_max_val;
291	int			pwron_delay;
292	int                     scale; /*
293					* relationship between 1 LBS and mG
294					* (1/1000th of earth gravity)
295					*/
296
297	struct input_polled_dev	*idev;     /* input device */
298	struct platform_device	*pdev;     /* platform device */
299	struct regulator_bulk_data regulators[2];
300	atomic_t		count;     /* interrupt count after last read */
301	union axis_conversion	ac;        /* hw -> logical axis */
302	int			mapped_btns[3];
303
304	u32			irq;       /* IRQ number */
305	struct fasync_struct	*async_queue; /* queue for the misc device */
306	wait_queue_head_t	misc_wait; /* Wait queue for the misc device */
307	unsigned long		misc_opened; /* bit0: whether the device is open */
308	struct miscdevice	miscdev;
309
310	int                     data_ready_count[2];
311	atomic_t		wake_thread;
312	unsigned char           irq_cfg;
313	unsigned int		shift_adj;
314
315	struct lis3lv02d_platform_data *pdata;	/* for passing board config */
316	struct mutex		mutex;     /* Serialize poll and selftest */
317
318#ifdef CONFIG_OF
319	struct device_node	*of_node;
320#endif
321};
322
323int lis3lv02d_init_device(struct lis3lv02d *lis3);
324int lis3lv02d_joystick_enable(struct lis3lv02d *lis3);
325void lis3lv02d_joystick_disable(struct lis3lv02d *lis3);
326void lis3lv02d_poweroff(struct lis3lv02d *lis3);
327int lis3lv02d_poweron(struct lis3lv02d *lis3);
328int lis3lv02d_remove_fs(struct lis3lv02d *lis3);
329int lis3lv02d_init_dt(struct lis3lv02d *lis3);
330
331extern struct lis3lv02d lis3_dev;
332