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 static int __maybe_unused
twl6040_vibra_suspend(struct device
*dev
)
241 struct platform_device
*pdev
= to_platform_device(dev
);
242 struct vibra_info
*info
= platform_get_drvdata(pdev
);
244 mutex_lock(&info
->mutex
);
247 twl6040_vibra_disable(info
);
249 mutex_unlock(&info
->mutex
);
254 static SIMPLE_DEV_PM_OPS(twl6040_vibra_pm_ops
, twl6040_vibra_suspend
, NULL
);
256 static int twl6040_vibra_probe(struct platform_device
*pdev
)
258 struct device
*twl6040_core_dev
= pdev
->dev
.parent
;
259 struct device_node
*twl6040_core_node
;
260 struct vibra_info
*info
;
265 twl6040_core_node
= of_find_node_by_name(twl6040_core_dev
->of_node
,
267 if (!twl6040_core_node
) {
268 dev_err(&pdev
->dev
, "parent of node is missing?\n");
272 info
= devm_kzalloc(&pdev
->dev
, sizeof(*info
), GFP_KERNEL
);
274 of_node_put(twl6040_core_node
);
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 of_property_read_u32(twl6040_core_node
, "ti,vibldrv-res",
285 of_property_read_u32(twl6040_core_node
, "ti,vibrdrv-res",
287 of_property_read_u32(twl6040_core_node
, "ti,viblmotor-res",
288 &info
->viblmotor_res
);
289 of_property_read_u32(twl6040_core_node
, "ti,vibrmotor-res",
290 &info
->vibrmotor_res
);
291 of_property_read_u32(twl6040_core_node
, "ti,vddvibl-uV", &vddvibl_uV
);
292 of_property_read_u32(twl6040_core_node
, "ti,vddvibr-uV", &vddvibr_uV
);
294 of_node_put(twl6040_core_node
);
296 if ((!info
->vibldrv_res
&& !info
->viblmotor_res
) ||
297 (!info
->vibrdrv_res
&& !info
->vibrmotor_res
)) {
298 dev_err(info
->dev
, "invalid vibra driver/motor resistance\n");
302 info
->irq
= platform_get_irq(pdev
, 0);
304 dev_err(info
->dev
, "invalid irq\n");
308 mutex_init(&info
->mutex
);
310 error
= devm_request_threaded_irq(&pdev
->dev
, info
->irq
, NULL
,
311 twl6040_vib_irq_handler
, 0,
312 "twl6040_irq_vib", info
);
314 dev_err(info
->dev
, "VIB IRQ request failed: %d\n", error
);
318 info
->supplies
[0].supply
= "vddvibl";
319 info
->supplies
[1].supply
= "vddvibr";
321 * When booted with Device tree the regulators are attached to the
322 * parent device (twl6040 MFD core)
324 error
= devm_regulator_bulk_get(twl6040_core_dev
,
325 ARRAY_SIZE(info
->supplies
),
328 dev_err(info
->dev
, "couldn't get regulators %d\n", error
);
333 error
= regulator_set_voltage(info
->supplies
[0].consumer
,
334 vddvibl_uV
, vddvibl_uV
);
336 dev_err(info
->dev
, "failed to set VDDVIBL volt %d\n",
343 error
= regulator_set_voltage(info
->supplies
[1].consumer
,
344 vddvibr_uV
, vddvibr_uV
);
346 dev_err(info
->dev
, "failed to set VDDVIBR volt %d\n",
352 INIT_WORK(&info
->play_work
, vibra_play_work
);
354 info
->input_dev
= devm_input_allocate_device(&pdev
->dev
);
355 if (!info
->input_dev
) {
356 dev_err(info
->dev
, "couldn't allocate input device\n");
360 input_set_drvdata(info
->input_dev
, info
);
362 info
->input_dev
->name
= "twl6040:vibrator";
363 info
->input_dev
->id
.version
= 1;
364 info
->input_dev
->dev
.parent
= pdev
->dev
.parent
;
365 info
->input_dev
->close
= twl6040_vibra_close
;
366 __set_bit(FF_RUMBLE
, info
->input_dev
->ffbit
);
368 error
= input_ff_create_memless(info
->input_dev
, NULL
, vibra_play
);
370 dev_err(info
->dev
, "couldn't register vibrator to FF\n");
374 error
= input_register_device(info
->input_dev
);
376 dev_err(info
->dev
, "couldn't register input device\n");
380 platform_set_drvdata(pdev
, info
);
385 static struct platform_driver twl6040_vibra_driver
= {
386 .probe
= twl6040_vibra_probe
,
388 .name
= "twl6040-vibra",
389 .owner
= THIS_MODULE
,
390 .pm
= &twl6040_vibra_pm_ops
,
393 module_platform_driver(twl6040_vibra_driver
);
395 MODULE_ALIAS("platform:twl6040-vibra");
396 MODULE_DESCRIPTION("TWL6040 Vibra driver");
397 MODULE_LICENSE("GPL");
398 MODULE_AUTHOR("Jorge Eduardo Candelaria <jorge.candelaria@ti.com>");
399 MODULE_AUTHOR("Misael Lopez Cruz <misael.lopez@ti.com>");