[go: nahoru, domu]
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/of.h>
31#include <linux/workqueue.h>
32#include <linux/input.h>
33#include <linux/mfd/twl6040.h>
34#include <linux/slab.h>
35#include <linux/delay.h>
36#include <linux/regulator/consumer.h>
37
38#define EFFECT_DIR_180_DEG	0x8000
39
40/* Recommended modulation index 85% */
41#define TWL6040_VIBRA_MOD	85
42
43#define TWL6040_NUM_SUPPLIES 2
44
45struct vibra_info {
46	struct device *dev;
47	struct input_dev *input_dev;
48	struct workqueue_struct *workqueue;
49	struct work_struct play_work;
50	struct mutex mutex;
51	int irq;
52
53	bool enabled;
54	int weak_speed;
55	int strong_speed;
56	int direction;
57
58	unsigned int vibldrv_res;
59	unsigned int vibrdrv_res;
60	unsigned int viblmotor_res;
61	unsigned int vibrmotor_res;
62
63	struct regulator_bulk_data supplies[TWL6040_NUM_SUPPLIES];
64
65	struct twl6040 *twl6040;
66};
67
68static irqreturn_t twl6040_vib_irq_handler(int irq, void *data)
69{
70	struct vibra_info *info = data;
71	struct twl6040 *twl6040 = info->twl6040;
72	u8 status;
73
74	status = twl6040_reg_read(twl6040, TWL6040_REG_STATUS);
75	if (status & TWL6040_VIBLOCDET) {
76		dev_warn(info->dev, "Left Vibrator overcurrent detected\n");
77		twl6040_clear_bits(twl6040, TWL6040_REG_VIBCTLL,
78				   TWL6040_VIBENA);
79	}
80	if (status & TWL6040_VIBROCDET) {
81		dev_warn(info->dev, "Right Vibrator overcurrent detected\n");
82		twl6040_clear_bits(twl6040, TWL6040_REG_VIBCTLR,
83				   TWL6040_VIBENA);
84	}
85
86	return IRQ_HANDLED;
87}
88
89static void twl6040_vibra_enable(struct vibra_info *info)
90{
91	struct twl6040 *twl6040 = info->twl6040;
92	int ret;
93
94	ret = regulator_bulk_enable(ARRAY_SIZE(info->supplies), info->supplies);
95	if (ret) {
96		dev_err(info->dev, "failed to enable regulators %d\n", ret);
97		return;
98	}
99
100	twl6040_power(info->twl6040, 1);
101	if (twl6040_get_revid(twl6040) <= TWL6040_REV_ES1_1) {
102		/*
103		 * ERRATA: Disable overcurrent protection for at least
104		 * 3ms when enabling vibrator drivers to avoid false
105		 * overcurrent detection
106		 */
107		twl6040_reg_write(twl6040, TWL6040_REG_VIBCTLL,
108				  TWL6040_VIBENA | TWL6040_VIBCTRL);
109		twl6040_reg_write(twl6040, TWL6040_REG_VIBCTLR,
110				  TWL6040_VIBENA | TWL6040_VIBCTRL);
111		usleep_range(3000, 3500);
112	}
113
114	twl6040_reg_write(twl6040, TWL6040_REG_VIBCTLL,
115			  TWL6040_VIBENA);
116	twl6040_reg_write(twl6040, TWL6040_REG_VIBCTLR,
117			  TWL6040_VIBENA);
118
119	info->enabled = true;
120}
121
122static void twl6040_vibra_disable(struct vibra_info *info)
123{
124	struct twl6040 *twl6040 = info->twl6040;
125
126	twl6040_reg_write(twl6040, TWL6040_REG_VIBCTLL, 0x00);
127	twl6040_reg_write(twl6040, TWL6040_REG_VIBCTLR, 0x00);
128	twl6040_power(info->twl6040, 0);
129
130	regulator_bulk_disable(ARRAY_SIZE(info->supplies), info->supplies);
131
132	info->enabled = false;
133}
134
135static u8 twl6040_vibra_code(int vddvib, int vibdrv_res, int motor_res,
136			     int speed, int direction)
137{
138	int vpk, max_code;
139	u8 vibdat;
140
141	/* output swing */
142	vpk = (vddvib * motor_res * TWL6040_VIBRA_MOD) /
143		(100 * (vibdrv_res + motor_res));
144
145	/* 50mV per VIBDAT code step */
146	max_code = vpk / 50;
147	if (max_code > TWL6040_VIBDAT_MAX)
148		max_code = TWL6040_VIBDAT_MAX;
149
150	/* scale speed to max allowed code */
151	vibdat = (u8)((speed * max_code) / USHRT_MAX);
152
153	/* 2's complement for direction > 180 degrees */
154	vibdat *= direction;
155
156	return vibdat;
157}
158
159static void twl6040_vibra_set_effect(struct vibra_info *info)
160{
161	struct twl6040 *twl6040 = info->twl6040;
162	u8 vibdatl, vibdatr;
163	int volt;
164
165	/* weak motor */
166	volt = regulator_get_voltage(info->supplies[0].consumer) / 1000;
167	vibdatl = twl6040_vibra_code(volt, info->vibldrv_res,
168				     info->viblmotor_res,
169				     info->weak_speed, info->direction);
170
171	/* strong motor */
172	volt = regulator_get_voltage(info->supplies[1].consumer) / 1000;
173	vibdatr = twl6040_vibra_code(volt, info->vibrdrv_res,
174				     info->vibrmotor_res,
175				     info->strong_speed, info->direction);
176
177	twl6040_reg_write(twl6040, TWL6040_REG_VIBDATL, vibdatl);
178	twl6040_reg_write(twl6040, TWL6040_REG_VIBDATR, vibdatr);
179}
180
181static void vibra_play_work(struct work_struct *work)
182{
183	struct vibra_info *info = container_of(work,
184				struct vibra_info, play_work);
185
186	mutex_lock(&info->mutex);
187
188	if (info->weak_speed || info->strong_speed) {
189		if (!info->enabled)
190			twl6040_vibra_enable(info);
191
192		twl6040_vibra_set_effect(info);
193	} else if (info->enabled)
194		twl6040_vibra_disable(info);
195
196	mutex_unlock(&info->mutex);
197}
198
199static int vibra_play(struct input_dev *input, void *data,
200		      struct ff_effect *effect)
201{
202	struct vibra_info *info = input_get_drvdata(input);
203	int ret;
204
205	/* Do not allow effect, while the routing is set to use audio */
206	ret = twl6040_get_vibralr_status(info->twl6040);
207	if (ret & TWL6040_VIBSEL) {
208		dev_info(&input->dev, "Vibra is configured for audio\n");
209		return -EBUSY;
210	}
211
212	info->weak_speed = effect->u.rumble.weak_magnitude;
213	info->strong_speed = effect->u.rumble.strong_magnitude;
214	info->direction = effect->direction < EFFECT_DIR_180_DEG ? 1 : -1;
215
216	ret = queue_work(info->workqueue, &info->play_work);
217	if (!ret) {
218		dev_info(&input->dev, "work is already on queue\n");
219		return ret;
220	}
221
222	return 0;
223}
224
225static void twl6040_vibra_close(struct input_dev *input)
226{
227	struct vibra_info *info = input_get_drvdata(input);
228
229	cancel_work_sync(&info->play_work);
230
231	mutex_lock(&info->mutex);
232
233	if (info->enabled)
234		twl6040_vibra_disable(info);
235
236	mutex_unlock(&info->mutex);
237}
238
239#ifdef CONFIG_PM_SLEEP
240static int twl6040_vibra_suspend(struct device *dev)
241{
242	struct platform_device *pdev = to_platform_device(dev);
243	struct vibra_info *info = platform_get_drvdata(pdev);
244
245	mutex_lock(&info->mutex);
246
247	if (info->enabled)
248		twl6040_vibra_disable(info);
249
250	mutex_unlock(&info->mutex);
251
252	return 0;
253}
254#endif
255
256static SIMPLE_DEV_PM_OPS(twl6040_vibra_pm_ops, twl6040_vibra_suspend, NULL);
257
258static int twl6040_vibra_probe(struct platform_device *pdev)
259{
260	struct device *twl6040_core_dev = pdev->dev.parent;
261	struct device_node *twl6040_core_node;
262	struct vibra_info *info;
263	int vddvibl_uV = 0;
264	int vddvibr_uV = 0;
265	int error;
266
267	twl6040_core_node = of_find_node_by_name(twl6040_core_dev->of_node,
268						 "vibra");
269	if (!twl6040_core_node) {
270		dev_err(&pdev->dev, "parent of node is missing?\n");
271		return -EINVAL;
272	}
273
274	info = devm_kzalloc(&pdev->dev, sizeof(*info), GFP_KERNEL);
275	if (!info) {
276		of_node_put(twl6040_core_node);
277		dev_err(&pdev->dev, "couldn't allocate memory\n");
278		return -ENOMEM;
279	}
280
281	info->dev = &pdev->dev;
282
283	info->twl6040 = dev_get_drvdata(pdev->dev.parent);
284
285	of_property_read_u32(twl6040_core_node, "ti,vibldrv-res",
286			     &info->vibldrv_res);
287	of_property_read_u32(twl6040_core_node, "ti,vibrdrv-res",
288			     &info->vibrdrv_res);
289	of_property_read_u32(twl6040_core_node, "ti,viblmotor-res",
290			     &info->viblmotor_res);
291	of_property_read_u32(twl6040_core_node, "ti,vibrmotor-res",
292			     &info->vibrmotor_res);
293	of_property_read_u32(twl6040_core_node, "ti,vddvibl-uV", &vddvibl_uV);
294	of_property_read_u32(twl6040_core_node, "ti,vddvibr-uV", &vddvibr_uV);
295
296	of_node_put(twl6040_core_node);
297
298	if ((!info->vibldrv_res && !info->viblmotor_res) ||
299	    (!info->vibrdrv_res && !info->vibrmotor_res)) {
300		dev_err(info->dev, "invalid vibra driver/motor resistance\n");
301		return -EINVAL;
302	}
303
304	info->irq = platform_get_irq(pdev, 0);
305	if (info->irq < 0) {
306		dev_err(info->dev, "invalid irq\n");
307		return -EINVAL;
308	}
309
310	mutex_init(&info->mutex);
311
312	error = devm_request_threaded_irq(&pdev->dev, info->irq, NULL,
313					  twl6040_vib_irq_handler, 0,
314					  "twl6040_irq_vib", info);
315	if (error) {
316		dev_err(info->dev, "VIB IRQ request failed: %d\n", error);
317		return error;
318	}
319
320	info->supplies[0].supply = "vddvibl";
321	info->supplies[1].supply = "vddvibr";
322	/*
323	 * When booted with Device tree the regulators are attached to the
324	 * parent device (twl6040 MFD core)
325	 */
326	error = devm_regulator_bulk_get(twl6040_core_dev,
327					ARRAY_SIZE(info->supplies),
328					info->supplies);
329	if (error) {
330		dev_err(info->dev, "couldn't get regulators %d\n", error);
331		return error;
332	}
333
334	if (vddvibl_uV) {
335		error = regulator_set_voltage(info->supplies[0].consumer,
336					      vddvibl_uV, vddvibl_uV);
337		if (error) {
338			dev_err(info->dev, "failed to set VDDVIBL volt %d\n",
339				error);
340			return error;
341		}
342	}
343
344	if (vddvibr_uV) {
345		error = regulator_set_voltage(info->supplies[1].consumer,
346					      vddvibr_uV, vddvibr_uV);
347		if (error) {
348			dev_err(info->dev, "failed to set VDDVIBR volt %d\n",
349				error);
350			return error;
351		}
352	}
353
354	INIT_WORK(&info->play_work, vibra_play_work);
355
356	info->input_dev = devm_input_allocate_device(&pdev->dev);
357	if (!info->input_dev) {
358		dev_err(info->dev, "couldn't allocate input device\n");
359		return -ENOMEM;
360	}
361
362	input_set_drvdata(info->input_dev, info);
363
364	info->input_dev->name = "twl6040:vibrator";
365	info->input_dev->id.version = 1;
366	info->input_dev->dev.parent = pdev->dev.parent;
367	info->input_dev->close = twl6040_vibra_close;
368	__set_bit(FF_RUMBLE, info->input_dev->ffbit);
369
370	error = input_ff_create_memless(info->input_dev, NULL, vibra_play);
371	if (error) {
372		dev_err(info->dev, "couldn't register vibrator to FF\n");
373		return error;
374	}
375
376	error = input_register_device(info->input_dev);
377	if (error) {
378		dev_err(info->dev, "couldn't register input device\n");
379		return error;
380	}
381
382	platform_set_drvdata(pdev, info);
383
384	return 0;
385}
386
387static struct platform_driver twl6040_vibra_driver = {
388	.probe		= twl6040_vibra_probe,
389	.driver		= {
390		.name	= "twl6040-vibra",
391		.owner	= THIS_MODULE,
392		.pm	= &twl6040_vibra_pm_ops,
393	},
394};
395module_platform_driver(twl6040_vibra_driver);
396
397MODULE_ALIAS("platform:twl6040-vibra");
398MODULE_DESCRIPTION("TWL6040 Vibra driver");
399MODULE_LICENSE("GPL");
400MODULE_AUTHOR("Jorge Eduardo Candelaria <jorge.candelaria@ti.com>");
401MODULE_AUTHOR("Misael Lopez Cruz <misael.lopez@ti.com>");
402