summaryrefstree
path: root/kernel/include/linux/drv2624.h
blob: 2b4097e7fb2f3a49863e0e05f96aacc2a781cdc8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
#ifndef __DRV2624_H__
#define __DRV2624_H__
/*
** =============================================================================
** Copyright (c)2016  Texas Instruments Inc.
**
** 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
**
** File:
**     drv2624.h
**
** Description:
**     Header file for drv2624.c
**
** =============================================================================
*/

#include <linux/regmap.h>
#include <linux/timer.h>
#include <linux/workqueue.h>
#include <../../../drivers/staging/android/timed_output.h>
#include <linux/hrtimer.h>
#include <linux/wakelock.h>
#include <linux/mutex.h>
#include <linux/cdev.h>
//#include <linux/timed_output.h>
#include <linux/kthread.h>

#define HAPTICS_DEVICE_NAME "drv2624"

#define	DRV2624_REG_ID				0x00
#define	DRV2624_ID					0x02

#define	DRV2624_REG_STATUS			0x01
#define	DIAG_MASK					0x80
#define	DIAG_SUCCESS				0x00
#define	DIAG_SHIFT					0x07
#define	INT_MASK					0x1f
#define	PRG_ERR_MASK				0x10
#define	PROCESS_DONE_MASK			0x08
#define	ULVO_MASK					0x04
#define	OVERTEMPRATURE_MASK			0x02
#define	OVERCURRENT_MASK			0x01

#define	DRV2624_REG_INT_ENABLE		0x02
#define	INT_MASK_ALL				0x1f
#define	INT_ENABLE_ALL				0x00

#define	DRV2624_REG_DIAG_Z			0x03

#define	DRV2624_REG_MODE			0x07
#define	DRV2624MODE_MASK			0x03
#define	MODE_RTP					0x00
#define	MODE_WAVEFORM_SEQUENCER		0x01
#define	MODE_DIAGNOSTIC				0x02
#define	MODE_CALIBRATION			0x03
#define	PINFUNC_MASK				0x0c
#define	PINFUNC_INT					0x02
#define	PINFUNC_SHIFT				0x02

#define	DRV2624_REG_CONTROL1		0x08
#define	ACTUATOR_MASK				0x80
#define	ACTUATOR_SHIFT				7
#define	LOOP_MASK					0x40
#define	LOOP_SHIFT					6
#define	AUTOBRK_OK_MASK				0x10
#define	AUTOBRK_OK_ENABLE			0x10

#define	DRV2624_REG_GO				0x0c

#define	DRV2624_REG_CONTROL2		0x0d
#define	LIB_LRA						0x02
#define	LIB_ERM						0x03
#define	LIB_MASK					0xc0
#define	LIB_SHIFT					0x06
#define	SCALE_MASK					0x03
#define	INTERVAL_MASK				0x20
#define	INTERVAL_SHIFT				0x05

#define	DRV2624_REG_RTP_INPUT		0x0e

#define	DRV2624_REG_SEQUENCER_1		0x0f

#define	DRV2624_REG_SEQ_LOOP_1		0x17

#define	DRV2624_REG_SEQ_LOOP_2		0x18

#define	DRV2624_REG_MAIN_LOOP		0x19

#define	DRV2624_REG_RATED_VOLTAGE	0x1f

#define	DRV2624_REG_OVERDRIVE_CLAMP	0x20

#define	DRV2624_REG_CAL_COMP		0x21

#define	DRV2624_REG_CAL_BEMF		0x22

#define	DRV2624_REG_LOOP_CONTROL	0x23
#define	BEMFGAIN_MASK				0x03

#define	DRV2624_REG_DRIVE_TIME		0x27
#define	DRIVE_TIME_MASK				0x1f
#define	MINFREQ_SEL_45HZ			0x01
#define	MINFREQ_SEL_MASK			0x80
#define	MINFREQ_SEL_SHIFT			0x07

#define DRV2624_REG_BLANKKING_IDISS_TIME	0x28
#define DRV2624_REG_OD_CLAMP_SAMPLE_ZC_DET_TIME	0x29

#define	DRV2624_REG_OL_PERIOD_H		0x2e

#define	DRV2624_REG_OL_PERIOD_L		0x2f

#define	DRV2624_REG_DIAG_K			0x30

#define	DRV2624_REG_RAM_ADDR_UPPER		0xfd
#define	DRV2624_REG_RAM_ADDR_LOWER		0xfe
#define	DRV2624_REG_RAM_DATA			0xff

#define GO_BIT_POLL_INTERVAL    15
#define STANDBY_WAKE_DELAY      1
#define WAKE_STANDBY_DELAY      3

/* Commands */
#define HAPTIC_CMDID_PLAY_SINGLE_EFFECT     0x01
#define HAPTIC_CMDID_PLAY_EFFECT_SEQUENCE   0x02
#define HAPTIC_CMDID_PLAY_TIMED_EFFECT      0x03
#define HAPTIC_CMDID_GET_DEV_ID             0x04
#define HAPTIC_CMDID_RUN_DIAG               0x05
#define HAPTIC_CMDID_AUDIOHAPTIC_ENABLE     0x06
#define HAPTIC_CMDID_AUDIOHAPTIC_DISABLE    0x07
#define HAPTIC_CMDID_AUDIOHAPTIC_GETSTATUS  0x08

#define HAPTIC_CMDID_REG_WRITE  	0x09
#define HAPTIC_CMDID_REG_READ   	0x0a
#define HAPTIC_CMDID_REG_SETBIT  	0x0b

#define HAPTIC_CMDID_PATTERN_RTP      0x0c
#define HAPTIC_CMDID_RTP_SEQUENCE	  0x0d
#define HAPTIC_CMDID_GET_EFFECT_COUNT		0x10
#define HAPTIC_CMDID_UPDATE_FIRMWARE		0x11
#define HAPTIC_CMDID_READ_FIRMWARE			0x12
#define	HAPTIC_CMDID_AUTO_CAL				0x13

#define HAPTIC_CMDID_STOP                   0xFF

#define MAX_TIMEOUT 	10000 /* 10s */
#define	MAX_READ_BYTES	0xff
#define	DRV2624_SEQUENCER_SIZE	8

#define	WORK_IDLE					0
#define	WORK_VIBRATOR				0x01
#define	WORK_IRQ					0x02

#define	YES		1
#define NO		0
#define	GO		1
#define STOP	0

#define MAX_INTENSITY		10000
#define VIB_BUFSIZE		30
#define PACKET_MAX_SIZE		1000

struct vib_packet {
	int time;
	int intensity;
	int freq;
};

enum actuator_type {
	ERM,
	LRA
};

enum loop_type {
	CLOSE_LOOP,
	OPEN_LOOP	
};

struct actuator_data {
	enum actuator_type meActuatorType;
	unsigned char 	mnRatedVoltage;
	unsigned char 	mnOverDriveClampVoltage;
	unsigned char   mnLRAFreq;	
};

enum wave_seq_loop {
	SEQ_NO_LOOP,
	SEQ_LOOP_ONCE,
	SEQ_LOOP_TWICE,
	SEQ_LOOP_TRIPPLE
};

enum wave_main_loop {
	MAIN_NO_LOOP,
	MAIN_LOOP_ONCE,
	MAIN_LOOP_TWICE,
	MAIN_LOOP_3_TIMES,
	MAIN_LOOP_4_TIMES,
	MAIN_LOOP_5_TIMES,
	MAIN_LOOP_6_TIMES,
	MAIN_LOOP_INFINITELY
};

enum wave_main_scale {
	PERCENTAGE_100,
	PERCENTAGE_75,
	PERCENTAGE_50,
	PERCENTAGE_25
};

enum wave_main_interval {
	INTERVAL_5MS,
	INTERVAL_1MS
};

struct drv2624_waveform {
	enum wave_seq_loop meLoop;
	unsigned char mnIndex;
};

struct drv2624_waveform_sequencer {
	enum wave_main_loop meLoop;
	struct drv2624_waveform msWaveform[DRV2624_SEQUENCER_SIZE];
};

struct drv2624_platform_data {
	int	mnGpioNRST;
	int 	mnGpioMODE;
//	int	mnGpioINT;
	enum loop_type	meLoop; 
	struct actuator_data msActuator;
};

#define DRV2624_MAGIC	0x2624

struct drv2624_fw_header{
	unsigned int fw_magic;
	unsigned int fw_size;
	unsigned int fw_date;
	unsigned int fw_chksum;
	unsigned int fw_effCount;
};

struct drv2624_data {
	struct drv2624_platform_data msPlatData;
	unsigned char mnDeviceID;
	struct device *dev;
	struct regmap *mpRegmap;
	unsigned char mnIntStatus;
	struct drv2624_waveform_sequencer msWaveformSequencer;	
	unsigned char mnFileCmd;
	volatile int mnVibratorPlaying;
	volatile char mnWorkMode;
	unsigned char mnCurrentReg;
	int intensity;

	/* for multi-frequency */
	int multi_frequency;
	int freq_num;
	u32 *multi_freq1;
	u32 *multi_freq2;

	int timeout;
	bool f_packet_en;
	int packet_size;
	int packet_cnt;
	struct vib_packet test_pac[PACKET_MAX_SIZE];

	struct wake_lock wklock;
	struct hrtimer timer;
	struct mutex lock;
	struct kthread_worker kworker;
//	struct work_struct vibrator_work;
	struct kthread_work vibrator_work;
	struct timed_output_dev to_dev;		

	struct drv2624_fw_header msFwHeader;	
	unsigned char mnFwAddUpper;
	unsigned char mnFwAddLower;
};

struct drv2624_seq_loop {
	enum wave_seq_loop mpLoop[DRV2624_SEQUENCER_SIZE];
};

struct drv2624_wave_seq {
	unsigned char mpWaveIndex[DRV2624_SEQUENCER_SIZE];
};

struct drv2624_wave_setting {
	enum wave_main_loop meLoop;
	enum wave_main_scale meScale;
	enum wave_main_interval meInterval;
};

struct drv2624_autocal_result {
	int mnFinished;
	unsigned char mnResult;
	unsigned char mnCalComp;
	unsigned char mnCalBemf;
	unsigned char mnCalGain;
};

struct drv2624_diag_result {
	int mnFinished;
	unsigned char mnResult;
	unsigned char mnDiagZ;
	unsigned char mnDiagK;
};

#define	DRV2624_MAGIC_NUMBER	0x32363234	/* '2624' */

#define	DRV2624_SET_SEQ_LOOP	 			_IOWR(DRV2624_MAGIC_NUMBER, 1, struct drv2624_seq_loop *)
#define	DRV2624_SET_MAIN	 				_IOWR(DRV2624_MAGIC_NUMBER, 2, struct drv2624_wave_setting *)
#define	DRV2624_SET_WAV_SEQ 				_IOWR(DRV2624_MAGIC_NUMBER, 3, struct drv2624_wave_seq *)
#define	DRV2624_WAVSEQ_PLAY		 			_IOWR(DRV2624_MAGIC_NUMBER, 4, unsigned long)
#define	DRV2624_STOP			 			_IOWR(DRV2624_MAGIC_NUMBER, 5, unsigned long)
#define	DRV2624_RUN_DIAGNOSTIC			 	_IOWR(DRV2624_MAGIC_NUMBER, 6, unsigned long)
#define	DRV2624_GET_DIAGRESULT			 	_IOWR(DRV2624_MAGIC_NUMBER, 7, struct drv2624_diag_result *)
#define	DRV2624_RUN_AUTOCAL				 	_IOWR(DRV2624_MAGIC_NUMBER, 8, unsigned long)
#define	DRV2624_GET_CALRESULT			 	_IOWR(DRV2624_MAGIC_NUMBER, 9, struct drv2624_autocal_result *)

#endif