twl6040-vibra.c revision 840a746be2beddd2ada0e5ba772147316d071f25 
1/*
2 * twl6040-vibra.c - TWL6040 Vibrator driver
3 *
4 * Author:      Jorge Eduardo Candelaria <jorge.candelaria@ti.com>
5 * Author:      Misael Lopez Cruz <misael.lopez@ti.com>
6 *
7 * Copyright:   (C) 2011 Texas Instruments, Inc.
8 *
9 * Based on twl4030-vibra.c by Henrik Saari <henrik.saari@nokia.com>
10 *				Felipe Balbi <felipe.balbi@nokia.com>
11 *				Jari Vanhala <ext-javi.vanhala@nokia.com>
12 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License version 2 as
15 * published by the Free Software Foundation.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
25 * 02110-1301 USA
26 *
27 */
28#include <linux/module.h>
29#include <linux/platform_device.h>
30#include <linux/workqueue.h>
31#include <linux/i2c/twl.h>
32#include <linux/mfd/twl6040.h>
33#include <linux/slab.h>
34#include <linux/delay.h>
35#include <linux/regulator/consumer.h>
36
37#define EFFECT_DIR_180_DEG	0x8000
38
39/* Recommended modulation index 85% */
40#define TWL6040_VIBRA_MOD	85
41
42#define TWL6040_NUM_SUPPLIES 2
43
44struct vibra_info {
45	struct device *dev;
46	struct input_dev *input_dev;
47	struct workqueue_struct *workqueue;
48	struct work_struct play_work;
49	struct mutex mutex;
50	int irq;
51
52	bool enabled;
53	int weak_speed;
54	int strong_speed;
55	int direction;
56
57	unsigned int vibldrv_res;
58	unsigned int vibrdrv_res;
59	unsigned int viblmotor_res;
60	unsigned int vibrmotor_res;
61
62	struct regulator_bulk_data supplies[TWL6040_NUM_SUPPLIES];
63
64	struct twl6040 *twl6040;
65};
66
67static irqreturn_t twl6040_vib_irq_handler(int irq, void *data)
68{
69	struct vibra_info *info = data;
70	struct twl6040 *twl6040 = info->twl6040;
71	u8 status;
72
73	status = twl6040_reg_read(twl6040, TWL6040_REG_STATUS);
74	if (status & TWL6040_VIBLOCDET) {
75		dev_warn(info->dev, "Left Vibrator overcurrent detected\n");
76		twl6040_clear_bits(twl6040, TWL6040_REG_VIBCTLL,
77				   TWL6040_VIBENA);
78	}
79	if (status & TWL6040_VIBROCDET) {
80		dev_warn(info->dev, "Right Vibrator overcurrent detected\n");
81		twl6040_clear_bits(twl6040, TWL6040_REG_VIBCTLR,
82				   TWL6040_VIBENA);
83	}
84
85	return IRQ_HANDLED;
86}
87
88static void twl6040_vibra_enable(struct vibra_info *info)
89{
90	struct twl6040 *twl6040 = info->twl6040;
91	int ret;
92
93	ret = regulator_bulk_enable(ARRAY_SIZE(info->supplies), info->supplies);
94	if (ret) {
95		dev_err(info->dev, "failed to enable regulators %d\n", ret);
96		return;
97	}
98
99	twl6040_power(info->twl6040, 1);
100	if (twl6040_get_revid(twl6040) <= TWL6040_REV_ES1_1) {
101		/*
102		 * ERRATA: Disable overcurrent protection for at least
103		 * 3ms when enabling vibrator drivers to avoid false
104		 * overcurrent detection
105		 */
106		twl6040_reg_write(twl6040, TWL6040_REG_VIBCTLL,
107				  TWL6040_VIBENA | TWL6040_VIBCTRL);
108		twl6040_reg_write(twl6040, TWL6040_REG_VIBCTLR,
109				  TWL6040_VIBENA | TWL6040_VIBCTRL);
110		usleep_range(3000, 3500);
111	}
112
113	twl6040_reg_write(twl6040, TWL6040_REG_VIBCTLL,
114			  TWL6040_VIBENA);
115	twl6040_reg_write(twl6040, TWL6040_REG_VIBCTLR,
116			  TWL6040_VIBENA);
117
118	info->enabled = true;
119}
120
121static void twl6040_vibra_disable(struct vibra_info *info)
122{
123	struct twl6040 *twl6040 = info->twl6040;
124
125	twl6040_reg_write(twl6040, TWL6040_REG_VIBCTLL, 0x00);
126	twl6040_reg_write(twl6040, TWL6040_REG_VIBCTLR, 0x00);
127	twl6040_power(info->twl6040, 0);
128
129	regulator_bulk_disable(ARRAY_SIZE(info->supplies), info->supplies);
130
131	info->enabled = false;
132}
133
134static u8 twl6040_vibra_code(int vddvib, int vibdrv_res, int motor_res,
135			     int speed, int direction)
136{
137	int vpk, max_code;
138	u8 vibdat;
139
140	/* output swing */
141	vpk = (vddvib * motor_res * TWL6040_VIBRA_MOD) /
142		(100 * (vibdrv_res + motor_res));
143
144	/* 50mV per VIBDAT code step */
145	max_code = vpk / 50;
146	if (max_code > TWL6040_VIBDAT_MAX)
147		max_code = TWL6040_VIBDAT_MAX;
148
149	/* scale speed to max allowed code */
150	vibdat = (u8)((speed * max_code) / USHRT_MAX);
151
152	/* 2's complement for direction > 180 degrees */
153	vibdat *= direction;
154
155	return vibdat;
156}
157
158static void twl6040_vibra_set_effect(struct vibra_info *info)
159{
160	struct twl6040 *twl6040 = info->twl6040;
161	u8 vibdatl, vibdatr;
162	int volt;
163
164	/* weak motor */
165	volt = regulator_get_voltage(info->supplies[0].consumer) / 1000;
166	vibdatl = twl6040_vibra_code(volt, info->vibldrv_res,
167				     info->viblmotor_res,
168				     info->weak_speed, info->direction);
169
170	/* strong motor */
171	volt = regulator_get_voltage(info->supplies[1].consumer) / 1000;
172	vibdatr = twl6040_vibra_code(volt, info->vibrdrv_res,
173				     info->vibrmotor_res,
174				     info->strong_speed, info->direction);
175
176	twl6040_reg_write(twl6040, TWL6040_REG_VIBDATL, vibdatl);
177	twl6040_reg_write(twl6040, TWL6040_REG_VIBDATR, vibdatr);
178}
179
180static void vibra_play_work(struct work_struct *work)
181{
182	struct vibra_info *info = container_of(work,
183				struct vibra_info, play_work);
184
185	mutex_lock(&info->mutex);
186
187	if (info->weak_speed || info->strong_speed) {
188		if (!info->enabled)
189			twl6040_vibra_enable(info);
190
191		twl6040_vibra_set_effect(info);
192	} else if (info->enabled)
193		twl6040_vibra_disable(info);
194
195	mutex_unlock(&info->mutex);
196}
197
198static int vibra_play(struct input_dev *input, void *data,
199		      struct ff_effect *effect)
200{
201	struct vibra_info *info = input_get_drvdata(input);
202	int ret;
203
204	/* Do not allow effect, while the routing is set to use audio */
205	ret = twl6040_get_vibralr_status(info->twl6040);
206	if (ret & TWL6040_VIBSEL) {
207		dev_info(&input->dev, "Vibra is configured for audio\n");
208		return -EBUSY;
209	}
210
211	info->weak_speed = effect->u.rumble.weak_magnitude;
212	info->strong_speed = effect->u.rumble.strong_magnitude;
213	info->direction = effect->direction < EFFECT_DIR_180_DEG ? 1 : -1;
214
215	ret = queue_work(info->workqueue, &info->play_work);
216	if (!ret) {
217		dev_info(&input->dev, "work is already on queue\n");
218		return ret;
219	}
220
221	return 0;
222}
223
224static void twl6040_vibra_close(struct input_dev *input)
225{
226	struct vibra_info *info = input_get_drvdata(input);
227
228	cancel_work_sync(&info->play_work);
229
230	mutex_lock(&info->mutex);
231
232	if (info->enabled)
233		twl6040_vibra_disable(info);
234
235	mutex_unlock(&info->mutex);
236}
237
238#ifdef CONFIG_PM_SLEEP
239static int twl6040_vibra_suspend(struct device *dev)
240{
241	struct platform_device *pdev = to_platform_device(dev);
242	struct vibra_info *info = platform_get_drvdata(pdev);
243
244	mutex_lock(&info->mutex);
245
246	if (info->enabled)
247		twl6040_vibra_disable(info);
248
249	mutex_unlock(&info->mutex);
250
251	return 0;
252}
253
254#endif
255
256static SIMPLE_DEV_PM_OPS(twl6040_vibra_pm_ops, twl6040_vibra_suspend, NULL);
257
258static int __devinit twl6040_vibra_probe(struct platform_device *pdev)
259{
260	struct twl4030_vibra_data *pdata = pdev->dev.platform_data;
261	struct vibra_info *info;
262	int ret;
263
264	if (!pdata) {
265		dev_err(&pdev->dev, "platform_data not available\n");
266		return -EINVAL;
267	}
268
269	info = kzalloc(sizeof(*info), GFP_KERNEL);
270	if (!info) {
271		dev_err(&pdev->dev, "couldn't allocate memory\n");
272		return -ENOMEM;
273	}
274
275	info->dev = &pdev->dev;
276	info->twl6040 = dev_get_drvdata(pdev->dev.parent);
277	info->vibldrv_res = pdata->vibldrv_res;
278	info->vibrdrv_res = pdata->vibrdrv_res;
279	info->viblmotor_res = pdata->viblmotor_res;
280	info->vibrmotor_res = pdata->vibrmotor_res;
281	if ((!info->vibldrv_res && !info->viblmotor_res) ||
282	    (!info->vibrdrv_res && !info->vibrmotor_res)) {
283		dev_err(info->dev, "invalid vibra driver/motor resistance\n");
284		ret = -EINVAL;
285		goto err_kzalloc;
286	}
287
288	info->irq = platform_get_irq(pdev, 0);
289	if (info->irq < 0) {
290		dev_err(info->dev, "invalid irq\n");
291		ret = -EINVAL;
292		goto err_kzalloc;
293	}
294
295	mutex_init(&info->mutex);
296
297	info->input_dev = input_allocate_device();
298	if (info->input_dev == NULL) {
299		dev_err(info->dev, "couldn't allocate input device\n");
300		ret = -ENOMEM;
301		goto err_kzalloc;
302	}
303
304	input_set_drvdata(info->input_dev, info);
305
306	info->input_dev->name = "twl6040:vibrator";
307	info->input_dev->id.version = 1;
308	info->input_dev->dev.parent = pdev->dev.parent;
309	info->input_dev->close = twl6040_vibra_close;
310	__set_bit(FF_RUMBLE, info->input_dev->ffbit);
311
312	ret = input_ff_create_memless(info->input_dev, NULL, vibra_play);
313	if (ret < 0) {
314		dev_err(info->dev, "couldn't register vibrator to FF\n");
315		goto err_ialloc;
316	}
317
318	ret = input_register_device(info->input_dev);
319	if (ret < 0) {
320		dev_err(info->dev, "couldn't register input device\n");
321		goto err_iff;
322	}
323
324	platform_set_drvdata(pdev, info);
325
326	ret = request_threaded_irq(info->irq, NULL, twl6040_vib_irq_handler, 0,
327				   "twl6040_irq_vib", info);
328	if (ret) {
329		dev_err(info->dev, "VIB IRQ request failed: %d\n", ret);
330		goto err_irq;
331	}
332
333	info->supplies[0].supply = "vddvibl";
334	info->supplies[1].supply = "vddvibr";
335	ret = regulator_bulk_get(info->dev, ARRAY_SIZE(info->supplies),
336				 info->supplies);
337	if (ret) {
338		dev_err(info->dev, "couldn't get regulators %d\n", ret);
339		goto err_regulator;
340	}
341
342	if (pdata->vddvibl_uV) {
343		ret = regulator_set_voltage(info->supplies[0].consumer,
344					    pdata->vddvibl_uV,
345					    pdata->vddvibl_uV);
346		if (ret) {
347			dev_err(info->dev, "failed to set VDDVIBL volt %d\n",
348				ret);
349			goto err_voltage;
350		}
351	}
352
353	if (pdata->vddvibr_uV) {
354		ret = regulator_set_voltage(info->supplies[1].consumer,
355					    pdata->vddvibr_uV,
356					    pdata->vddvibr_uV);
357		if (ret) {
358			dev_err(info->dev, "failed to set VDDVIBR volt %d\n",
359				ret);
360			goto err_voltage;
361		}
362	}
363
364	info->workqueue = alloc_workqueue("twl6040-vibra", 0, 0);
365	if (info->workqueue == NULL) {
366		dev_err(info->dev, "couldn't create workqueue\n");
367		ret = -ENOMEM;
368		goto err_voltage;
369	}
370	INIT_WORK(&info->play_work, vibra_play_work);
371
372	return 0;
373
374err_voltage:
375	regulator_bulk_free(ARRAY_SIZE(info->supplies), info->supplies);
376err_regulator:
377	free_irq(info->irq, info);
378err_irq:
379	input_unregister_device(info->input_dev);
380	info->input_dev = NULL;
381err_iff:
382	if (info->input_dev)
383		input_ff_destroy(info->input_dev);
384err_ialloc:
385	input_free_device(info->input_dev);
386err_kzalloc:
387	kfree(info);
388	return ret;
389}
390
391static int __devexit twl6040_vibra_remove(struct platform_device *pdev)
392{
393	struct vibra_info *info = platform_get_drvdata(pdev);
394
395	input_unregister_device(info->input_dev);
396	free_irq(info->irq, info);
397	regulator_bulk_free(ARRAY_SIZE(info->supplies), info->supplies);
398	destroy_workqueue(info->workqueue);
399	kfree(info);
400
401	return 0;
402}
403
404static struct platform_driver twl6040_vibra_driver = {
405	.probe		= twl6040_vibra_probe,
406	.remove		= __devexit_p(twl6040_vibra_remove),
407	.driver		= {
408		.name	= "twl6040-vibra",
409		.owner	= THIS_MODULE,
410		.pm	= &twl6040_vibra_pm_ops,
411	},
412};
413module_platform_driver(twl6040_vibra_driver);
414
415MODULE_ALIAS("platform:twl6040-vibra");
416MODULE_DESCRIPTION("TWL6040 Vibra driver");
417MODULE_LICENSE("GPL");
418MODULE_AUTHOR("Jorge Eduardo Candelaria <jorge.candelaria@ti.com>");
419MODULE_AUTHOR("Misael Lopez Cruz <misael.lopez@ti.com>");
420