pwm-beeper.c 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262
  1. // SPDX-License-Identifier: GPL-2.0-or-later
  2. /*
  3. * Copyright (C) 2010, Lars-Peter Clausen <[email protected]>
  4. * PWM beeper driver
  5. */
  6. #include <linux/input.h>
  7. #include <linux/regulator/consumer.h>
  8. #include <linux/module.h>
  9. #include <linux/kernel.h>
  10. #include <linux/of.h>
  11. #include <linux/platform_device.h>
  12. #include <linux/property.h>
  13. #include <linux/pwm.h>
  14. #include <linux/slab.h>
  15. #include <linux/workqueue.h>
  16. struct pwm_beeper {
  17. struct input_dev *input;
  18. struct pwm_device *pwm;
  19. struct regulator *amplifier;
  20. struct work_struct work;
  21. unsigned long period;
  22. unsigned int bell_frequency;
  23. bool suspended;
  24. bool amplifier_on;
  25. };
  26. #define HZ_TO_NANOSECONDS(x) (1000000000UL/(x))
  27. static int pwm_beeper_on(struct pwm_beeper *beeper, unsigned long period)
  28. {
  29. struct pwm_state state;
  30. int error;
  31. pwm_get_state(beeper->pwm, &state);
  32. state.enabled = true;
  33. state.period = period;
  34. pwm_set_relative_duty_cycle(&state, 50, 100);
  35. error = pwm_apply_state(beeper->pwm, &state);
  36. if (error)
  37. return error;
  38. if (!beeper->amplifier_on) {
  39. error = regulator_enable(beeper->amplifier);
  40. if (error) {
  41. pwm_disable(beeper->pwm);
  42. return error;
  43. }
  44. beeper->amplifier_on = true;
  45. }
  46. return 0;
  47. }
  48. static void pwm_beeper_off(struct pwm_beeper *beeper)
  49. {
  50. if (beeper->amplifier_on) {
  51. regulator_disable(beeper->amplifier);
  52. beeper->amplifier_on = false;
  53. }
  54. pwm_disable(beeper->pwm);
  55. }
  56. static void pwm_beeper_work(struct work_struct *work)
  57. {
  58. struct pwm_beeper *beeper = container_of(work, struct pwm_beeper, work);
  59. unsigned long period = READ_ONCE(beeper->period);
  60. if (period)
  61. pwm_beeper_on(beeper, period);
  62. else
  63. pwm_beeper_off(beeper);
  64. }
  65. static int pwm_beeper_event(struct input_dev *input,
  66. unsigned int type, unsigned int code, int value)
  67. {
  68. struct pwm_beeper *beeper = input_get_drvdata(input);
  69. if (type != EV_SND || value < 0)
  70. return -EINVAL;
  71. switch (code) {
  72. case SND_BELL:
  73. value = value ? beeper->bell_frequency : 0;
  74. break;
  75. case SND_TONE:
  76. break;
  77. default:
  78. return -EINVAL;
  79. }
  80. if (value == 0)
  81. beeper->period = 0;
  82. else
  83. beeper->period = HZ_TO_NANOSECONDS(value);
  84. if (!beeper->suspended)
  85. schedule_work(&beeper->work);
  86. return 0;
  87. }
  88. static void pwm_beeper_stop(struct pwm_beeper *beeper)
  89. {
  90. cancel_work_sync(&beeper->work);
  91. pwm_beeper_off(beeper);
  92. }
  93. static void pwm_beeper_close(struct input_dev *input)
  94. {
  95. struct pwm_beeper *beeper = input_get_drvdata(input);
  96. pwm_beeper_stop(beeper);
  97. }
  98. static int pwm_beeper_probe(struct platform_device *pdev)
  99. {
  100. struct device *dev = &pdev->dev;
  101. struct pwm_beeper *beeper;
  102. struct pwm_state state;
  103. u32 bell_frequency;
  104. int error;
  105. beeper = devm_kzalloc(dev, sizeof(*beeper), GFP_KERNEL);
  106. if (!beeper)
  107. return -ENOMEM;
  108. beeper->pwm = devm_pwm_get(dev, NULL);
  109. if (IS_ERR(beeper->pwm)) {
  110. error = PTR_ERR(beeper->pwm);
  111. if (error != -EPROBE_DEFER)
  112. dev_err(dev, "Failed to request PWM device: %d\n",
  113. error);
  114. return error;
  115. }
  116. /* Sync up PWM state and ensure it is off. */
  117. pwm_init_state(beeper->pwm, &state);
  118. state.enabled = false;
  119. error = pwm_apply_state(beeper->pwm, &state);
  120. if (error) {
  121. dev_err(dev, "failed to apply initial PWM state: %d\n",
  122. error);
  123. return error;
  124. }
  125. beeper->amplifier = devm_regulator_get(dev, "amp");
  126. if (IS_ERR(beeper->amplifier)) {
  127. error = PTR_ERR(beeper->amplifier);
  128. if (error != -EPROBE_DEFER)
  129. dev_err(dev, "Failed to get 'amp' regulator: %d\n",
  130. error);
  131. return error;
  132. }
  133. INIT_WORK(&beeper->work, pwm_beeper_work);
  134. error = device_property_read_u32(dev, "beeper-hz", &bell_frequency);
  135. if (error) {
  136. bell_frequency = 1000;
  137. dev_dbg(dev,
  138. "failed to parse 'beeper-hz' property, using default: %uHz\n",
  139. bell_frequency);
  140. }
  141. beeper->bell_frequency = bell_frequency;
  142. beeper->input = devm_input_allocate_device(dev);
  143. if (!beeper->input) {
  144. dev_err(dev, "Failed to allocate input device\n");
  145. return -ENOMEM;
  146. }
  147. beeper->input->name = "pwm-beeper";
  148. beeper->input->phys = "pwm/input0";
  149. beeper->input->id.bustype = BUS_HOST;
  150. beeper->input->id.vendor = 0x001f;
  151. beeper->input->id.product = 0x0001;
  152. beeper->input->id.version = 0x0100;
  153. input_set_capability(beeper->input, EV_SND, SND_TONE);
  154. input_set_capability(beeper->input, EV_SND, SND_BELL);
  155. beeper->input->event = pwm_beeper_event;
  156. beeper->input->close = pwm_beeper_close;
  157. input_set_drvdata(beeper->input, beeper);
  158. error = input_register_device(beeper->input);
  159. if (error) {
  160. dev_err(dev, "Failed to register input device: %d\n", error);
  161. return error;
  162. }
  163. platform_set_drvdata(pdev, beeper);
  164. return 0;
  165. }
  166. static int __maybe_unused pwm_beeper_suspend(struct device *dev)
  167. {
  168. struct pwm_beeper *beeper = dev_get_drvdata(dev);
  169. /*
  170. * Spinlock is taken here is not to protect write to
  171. * beeper->suspended, but to ensure that pwm_beeper_event
  172. * does not re-submit work once flag is set.
  173. */
  174. spin_lock_irq(&beeper->input->event_lock);
  175. beeper->suspended = true;
  176. spin_unlock_irq(&beeper->input->event_lock);
  177. pwm_beeper_stop(beeper);
  178. return 0;
  179. }
  180. static int __maybe_unused pwm_beeper_resume(struct device *dev)
  181. {
  182. struct pwm_beeper *beeper = dev_get_drvdata(dev);
  183. spin_lock_irq(&beeper->input->event_lock);
  184. beeper->suspended = false;
  185. spin_unlock_irq(&beeper->input->event_lock);
  186. /* Let worker figure out if we should resume beeping */
  187. schedule_work(&beeper->work);
  188. return 0;
  189. }
  190. static SIMPLE_DEV_PM_OPS(pwm_beeper_pm_ops,
  191. pwm_beeper_suspend, pwm_beeper_resume);
  192. #ifdef CONFIG_OF
  193. static const struct of_device_id pwm_beeper_match[] = {
  194. { .compatible = "pwm-beeper", },
  195. { },
  196. };
  197. MODULE_DEVICE_TABLE(of, pwm_beeper_match);
  198. #endif
  199. static struct platform_driver pwm_beeper_driver = {
  200. .probe = pwm_beeper_probe,
  201. .driver = {
  202. .name = "pwm-beeper",
  203. .pm = &pwm_beeper_pm_ops,
  204. .of_match_table = of_match_ptr(pwm_beeper_match),
  205. },
  206. };
  207. module_platform_driver(pwm_beeper_driver);
  208. MODULE_AUTHOR("Lars-Peter Clausen <[email protected]>");
  209. MODULE_DESCRIPTION("PWM beeper driver");
  210. MODULE_LICENSE("GPL");
  211. MODULE_ALIAS("platform:pwm-beeper");