2 * twl6040-vibra.c - TWL6040 Vibrator driver
4 * Author: Jorge Eduardo Candelaria <jorge.candelaria@ti.com>
5 * Author: Misael Lopez Cruz <misael.lopez@ti.com>
7 * Copyright: (C) 2011 Texas Instruments, Inc.
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>
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.
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.
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
28 #include <linux/module.h>
29 #include <linux/platform_device.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>
38 #define EFFECT_DIR_180_DEG 0x8000
40 /* Recommended modulation index 85% */
41 #define TWL6040_VIBRA_MOD 85
43 #define TWL6040_NUM_SUPPLIES 2
47 struct input_dev *input_dev;
48 struct workqueue_struct *workqueue;
49 struct work_struct play_work;
58 unsigned int vibldrv_res;
59 unsigned int vibrdrv_res;
60 unsigned int viblmotor_res;
61 unsigned int vibrmotor_res;
63 struct regulator_bulk_data supplies[TWL6040_NUM_SUPPLIES];
65 struct twl6040 *twl6040;
68 static irqreturn_t twl6040_vib_irq_handler(int irq, void *data)
70 struct vibra_info *info = data;
71 struct twl6040 *twl6040 = info->twl6040;
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,
80 if (status & TWL6040_VIBROCDET) {
81 dev_warn(info->dev, "Right Vibrator overcurrent detected\n");
82 twl6040_clear_bits(twl6040, TWL6040_REG_VIBCTLR,
89 static void twl6040_vibra_enable(struct vibra_info *info)
91 struct twl6040 *twl6040 = info->twl6040;
94 ret = regulator_bulk_enable(ARRAY_SIZE(info->supplies), info->supplies);
96 dev_err(info->dev, "failed to enable regulators %d\n", ret);
100 twl6040_power(info->twl6040, 1);
101 if (twl6040_get_revid(twl6040) <= TWL6040_REV_ES1_1) {
103 * ERRATA: Disable overcurrent protection for at least
104 * 3ms when enabling vibrator drivers to avoid false
105 * overcurrent detection
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);
114 twl6040_reg_write(twl6040, TWL6040_REG_VIBCTLL,
116 twl6040_reg_write(twl6040, TWL6040_REG_VIBCTLR,
119 info->enabled = true;
122 static void twl6040_vibra_disable(struct vibra_info *info)
124 struct twl6040 *twl6040 = info->twl6040;
126 twl6040_reg_write(twl6040, TWL6040_REG_VIBCTLL, 0x00);
127 twl6040_reg_write(twl6040, TWL6040_REG_VIBCTLR, 0x00);
128 twl6040_power(info->twl6040, 0);
130 regulator_bulk_disable(ARRAY_SIZE(info->supplies), info->supplies);
132 info->enabled = false;
135 static u8 twl6040_vibra_code(int vddvib, int vibdrv_res, int motor_res,
136 int speed, int direction)
142 vpk = (vddvib * motor_res * TWL6040_VIBRA_MOD) /
143 (100 * (vibdrv_res + motor_res));
145 /* 50mV per VIBDAT code step */
147 if (max_code > TWL6040_VIBDAT_MAX)
148 max_code = TWL6040_VIBDAT_MAX;
150 /* scale speed to max allowed code */
151 vibdat = (u8)((speed * max_code) / USHRT_MAX);
153 /* 2's complement for direction > 180 degrees */
159 static void twl6040_vibra_set_effect(struct vibra_info *info)
161 struct twl6040 *twl6040 = info->twl6040;
166 volt = regulator_get_voltage(info->supplies[0].consumer) / 1000;
167 vibdatl = twl6040_vibra_code(volt, info->vibldrv_res,
169 info->weak_speed, info->direction);
172 volt = regulator_get_voltage(info->supplies[1].consumer) / 1000;
173 vibdatr = twl6040_vibra_code(volt, info->vibrdrv_res,
175 info->strong_speed, info->direction);
177 twl6040_reg_write(twl6040, TWL6040_REG_VIBDATL, vibdatl);
178 twl6040_reg_write(twl6040, TWL6040_REG_VIBDATR, vibdatr);
181 static void vibra_play_work(struct work_struct *work)
183 struct vibra_info *info = container_of(work,
184 struct vibra_info, play_work);
186 mutex_lock(&info->mutex);
188 if (info->weak_speed || info->strong_speed) {
190 twl6040_vibra_enable(info);
192 twl6040_vibra_set_effect(info);
193 } else if (info->enabled)
194 twl6040_vibra_disable(info);
196 mutex_unlock(&info->mutex);
199 static int vibra_play(struct input_dev *input, void *data,
200 struct ff_effect *effect)
202 struct vibra_info *info = input_get_drvdata(input);
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");
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;
216 ret = queue_work(info->workqueue, &info->play_work);
218 dev_info(&input->dev, "work is already on queue\n");
225 static void twl6040_vibra_close(struct input_dev *input)
227 struct vibra_info *info = input_get_drvdata(input);
229 cancel_work_sync(&info->play_work);
231 mutex_lock(&info->mutex);
234 twl6040_vibra_disable(info);
236 mutex_unlock(&info->mutex);
239 #ifdef CONFIG_PM_SLEEP
240 static int twl6040_vibra_suspend(struct device *dev)
242 struct platform_device *pdev = to_platform_device(dev);
243 struct vibra_info *info = platform_get_drvdata(pdev);
245 mutex_lock(&info->mutex);
248 twl6040_vibra_disable(info);
250 mutex_unlock(&info->mutex);
257 static SIMPLE_DEV_PM_OPS(twl6040_vibra_pm_ops, twl6040_vibra_suspend, NULL);
259 static int __devinit twl6040_vibra_probe(struct platform_device *pdev)
261 struct twl6040_vibra_data *pdata = pdev->dev.platform_data;
262 struct device_node *node = pdev->dev.of_node;
263 struct vibra_info *info;
268 if (!pdata && !node) {
269 dev_err(&pdev->dev, "platform_data not available\n");
273 info = kzalloc(sizeof(*info), GFP_KERNEL);
275 dev_err(&pdev->dev, "couldn't allocate memory\n");
279 info->dev = &pdev->dev;
281 info->twl6040 = dev_get_drvdata(pdev->dev.parent);
283 info->vibldrv_res = pdata->vibldrv_res;
284 info->vibrdrv_res = pdata->vibrdrv_res;
285 info->viblmotor_res = pdata->viblmotor_res;
286 info->vibrmotor_res = pdata->vibrmotor_res;
287 vddvibl_uV = pdata->vddvibl_uV;
288 vddvibr_uV = pdata->vddvibr_uV;
290 of_property_read_u32(node, "vibldrv_res", &info->vibldrv_res);
291 of_property_read_u32(node, "vibrdrv_res", &info->vibrdrv_res);
292 of_property_read_u32(node, "viblmotor_res",
293 &info->viblmotor_res);
294 of_property_read_u32(node, "vibrmotor_res",
295 &info->vibrmotor_res);
296 of_property_read_u32(node, "vddvibl_uV", &vddvibl_uV);
297 of_property_read_u32(node, "vddvibr_uV", &vddvibr_uV);
300 if ((!info->vibldrv_res && !info->viblmotor_res) ||
301 (!info->vibrdrv_res && !info->vibrmotor_res)) {
302 dev_err(info->dev, "invalid vibra driver/motor resistance\n");
307 info->irq = platform_get_irq(pdev, 0);
309 dev_err(info->dev, "invalid irq\n");
314 mutex_init(&info->mutex);
316 info->input_dev = input_allocate_device();
317 if (info->input_dev == NULL) {
318 dev_err(info->dev, "couldn't allocate input device\n");
323 input_set_drvdata(info->input_dev, info);
325 info->input_dev->name = "twl6040:vibrator";
326 info->input_dev->id.version = 1;
327 info->input_dev->dev.parent = pdev->dev.parent;
328 info->input_dev->close = twl6040_vibra_close;
329 __set_bit(FF_RUMBLE, info->input_dev->ffbit);
331 ret = input_ff_create_memless(info->input_dev, NULL, vibra_play);
333 dev_err(info->dev, "couldn't register vibrator to FF\n");
337 ret = input_register_device(info->input_dev);
339 dev_err(info->dev, "couldn't register input device\n");
343 platform_set_drvdata(pdev, info);
345 ret = request_threaded_irq(info->irq, NULL, twl6040_vib_irq_handler, 0,
346 "twl6040_irq_vib", info);
348 dev_err(info->dev, "VIB IRQ request failed: %d\n", ret);
352 info->supplies[0].supply = "vddvibl";
353 info->supplies[1].supply = "vddvibr";
354 ret = regulator_bulk_get(info->dev, ARRAY_SIZE(info->supplies),
357 dev_err(info->dev, "couldn't get regulators %d\n", ret);
362 ret = regulator_set_voltage(info->supplies[0].consumer,
363 vddvibl_uV, vddvibl_uV);
365 dev_err(info->dev, "failed to set VDDVIBL volt %d\n",
372 ret = regulator_set_voltage(info->supplies[1].consumer,
373 vddvibr_uV, vddvibr_uV);
375 dev_err(info->dev, "failed to set VDDVIBR volt %d\n",
381 info->workqueue = alloc_workqueue("twl6040-vibra", 0, 0);
382 if (info->workqueue == NULL) {
383 dev_err(info->dev, "couldn't create workqueue\n");
387 INIT_WORK(&info->play_work, vibra_play_work);
392 regulator_bulk_free(ARRAY_SIZE(info->supplies), info->supplies);
394 free_irq(info->irq, info);
396 input_unregister_device(info->input_dev);
397 info->input_dev = NULL;
400 input_ff_destroy(info->input_dev);
402 input_free_device(info->input_dev);
408 static int __devexit twl6040_vibra_remove(struct platform_device *pdev)
410 struct vibra_info *info = platform_get_drvdata(pdev);
412 input_unregister_device(info->input_dev);
413 free_irq(info->irq, info);
414 regulator_bulk_free(ARRAY_SIZE(info->supplies), info->supplies);
415 destroy_workqueue(info->workqueue);
421 static const struct of_device_id twl6040_vibra_of_match[] = {
422 {.compatible = "ti,twl6040-vibra", },
425 MODULE_DEVICE_TABLE(of, twl6040_vibra_of_match);
427 static struct platform_driver twl6040_vibra_driver = {
428 .probe = twl6040_vibra_probe,
429 .remove = __devexit_p(twl6040_vibra_remove),
431 .name = "twl6040-vibra",
432 .owner = THIS_MODULE,
433 .pm = &twl6040_vibra_pm_ops,
434 .of_match_table = twl6040_vibra_of_match,
437 module_platform_driver(twl6040_vibra_driver);
439 MODULE_ALIAS("platform:twl6040-vibra");
440 MODULE_DESCRIPTION("TWL6040 Vibra driver");
441 MODULE_LICENSE("GPL");
442 MODULE_AUTHOR("Jorge Eduardo Candelaria <jorge.candelaria@ti.com>");
443 MODULE_AUTHOR("Misael Lopez Cruz <misael.lopez@ti.com>");