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 45 struct 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 68 static 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 89 static 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 122 static 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 135 static 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 159 static 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 181 static 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 199 static 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 225 static 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 240 static 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 255 #endif 256 257 static SIMPLE_DEV_PM_OPS(twl6040_vibra_pm_ops, twl6040_vibra_suspend, NULL); 258 259 static int __devinit twl6040_vibra_probe(struct platform_device *pdev) 260 { 261 struct twl6040_vibra_data *pdata = pdev->dev.platform_data; 262 struct device_node *node = pdev->dev.of_node; 263 struct vibra_info *info; 264 int vddvibl_uV = 0; 265 int vddvibr_uV = 0; 266 int ret; 267 268 if (!pdata && !node) { 269 dev_err(&pdev->dev, "platform_data not available\n"); 270 return -EINVAL; 271 } 272 273 info = kzalloc(sizeof(*info), GFP_KERNEL); 274 if (!info) { 275 dev_err(&pdev->dev, "couldn't allocate memory\n"); 276 return -ENOMEM; 277 } 278 279 info->dev = &pdev->dev; 280 281 info->twl6040 = dev_get_drvdata(pdev->dev.parent); 282 if (pdata) { 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; 289 } else { 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); 298 } 299 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"); 303 ret = -EINVAL; 304 goto err_kzalloc; 305 } 306 307 info->irq = platform_get_irq(pdev, 0); 308 if (info->irq < 0) { 309 dev_err(info->dev, "invalid irq\n"); 310 ret = -EINVAL; 311 goto err_kzalloc; 312 } 313 314 mutex_init(&info->mutex); 315 316 info->input_dev = input_allocate_device(); 317 if (info->input_dev == NULL) { 318 dev_err(info->dev, "couldn't allocate input device\n"); 319 ret = -ENOMEM; 320 goto err_kzalloc; 321 } 322 323 input_set_drvdata(info->input_dev, info); 324 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); 330 331 ret = input_ff_create_memless(info->input_dev, NULL, vibra_play); 332 if (ret < 0) { 333 dev_err(info->dev, "couldn't register vibrator to FF\n"); 334 goto err_ialloc; 335 } 336 337 ret = input_register_device(info->input_dev); 338 if (ret < 0) { 339 dev_err(info->dev, "couldn't register input device\n"); 340 goto err_iff; 341 } 342 343 platform_set_drvdata(pdev, info); 344 345 ret = request_threaded_irq(info->irq, NULL, twl6040_vib_irq_handler, 0, 346 "twl6040_irq_vib", info); 347 if (ret) { 348 dev_err(info->dev, "VIB IRQ request failed: %d\n", ret); 349 goto err_irq; 350 } 351 352 info->supplies[0].supply = "vddvibl"; 353 info->supplies[1].supply = "vddvibr"; 354 ret = regulator_bulk_get(info->dev, ARRAY_SIZE(info->supplies), 355 info->supplies); 356 if (ret) { 357 dev_err(info->dev, "couldn't get regulators %d\n", ret); 358 goto err_regulator; 359 } 360 361 if (vddvibl_uV) { 362 ret = regulator_set_voltage(info->supplies[0].consumer, 363 vddvibl_uV, vddvibl_uV); 364 if (ret) { 365 dev_err(info->dev, "failed to set VDDVIBL volt %d\n", 366 ret); 367 goto err_voltage; 368 } 369 } 370 371 if (vddvibr_uV) { 372 ret = regulator_set_voltage(info->supplies[1].consumer, 373 vddvibr_uV, vddvibr_uV); 374 if (ret) { 375 dev_err(info->dev, "failed to set VDDVIBR volt %d\n", 376 ret); 377 goto err_voltage; 378 } 379 } 380 381 info->workqueue = alloc_workqueue("twl6040-vibra", 0, 0); 382 if (info->workqueue == NULL) { 383 dev_err(info->dev, "couldn't create workqueue\n"); 384 ret = -ENOMEM; 385 goto err_voltage; 386 } 387 INIT_WORK(&info->play_work, vibra_play_work); 388 389 return 0; 390 391 err_voltage: 392 regulator_bulk_free(ARRAY_SIZE(info->supplies), info->supplies); 393 err_regulator: 394 free_irq(info->irq, info); 395 err_irq: 396 input_unregister_device(info->input_dev); 397 info->input_dev = NULL; 398 err_iff: 399 if (info->input_dev) 400 input_ff_destroy(info->input_dev); 401 err_ialloc: 402 input_free_device(info->input_dev); 403 err_kzalloc: 404 kfree(info); 405 return ret; 406 } 407 408 static int __devexit twl6040_vibra_remove(struct platform_device *pdev) 409 { 410 struct vibra_info *info = platform_get_drvdata(pdev); 411 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); 416 kfree(info); 417 418 return 0; 419 } 420 421 static const struct of_device_id twl6040_vibra_of_match[] = { 422 {.compatible = "ti,twl6040-vibra", }, 423 { }, 424 }; 425 MODULE_DEVICE_TABLE(of, twl6040_vibra_of_match); 426 427 static struct platform_driver twl6040_vibra_driver = { 428 .probe = twl6040_vibra_probe, 429 .remove = __devexit_p(twl6040_vibra_remove), 430 .driver = { 431 .name = "twl6040-vibra", 432 .owner = THIS_MODULE, 433 .pm = &twl6040_vibra_pm_ops, 434 .of_match_table = twl6040_vibra_of_match, 435 }, 436 }; 437 module_platform_driver(twl6040_vibra_driver); 438 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>"); 444