twl6040-vibra.c 11 KB

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