ts3a227e.c 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * TS3A227E Autonomous Audio Accessory Detection and Configuration Switch
  4. *
  5. * Copyright (C) 2014 Google, Inc.
  6. */
  7. #include <linux/gpio.h>
  8. #include <linux/i2c.h>
  9. #include <linux/init.h>
  10. #include <linux/input.h>
  11. #include <linux/module.h>
  12. #include <linux/of_gpio.h>
  13. #include <linux/regmap.h>
  14. #include <linux/acpi.h>
  15. #include <sound/core.h>
  16. #include <sound/jack.h>
  17. #include <sound/soc.h>
  18. #include "ts3a227e.h"
  19. struct ts3a227e {
  20. struct device *dev;
  21. struct regmap *regmap;
  22. struct snd_soc_jack *jack;
  23. bool plugged;
  24. bool mic_present;
  25. unsigned int buttons_held;
  26. int irq;
  27. };
  28. /* Button values to be reported on the jack */
  29. static const int ts3a227e_buttons[] = {
  30. SND_JACK_BTN_0,
  31. SND_JACK_BTN_1,
  32. SND_JACK_BTN_2,
  33. SND_JACK_BTN_3,
  34. };
  35. #define TS3A227E_NUM_BUTTONS 4
  36. #define TS3A227E_JACK_MASK (SND_JACK_HEADPHONE | \
  37. SND_JACK_MICROPHONE | \
  38. SND_JACK_BTN_0 | \
  39. SND_JACK_BTN_1 | \
  40. SND_JACK_BTN_2 | \
  41. SND_JACK_BTN_3)
  42. /* TS3A227E registers */
  43. #define TS3A227E_REG_DEVICE_ID 0x00
  44. #define TS3A227E_REG_INTERRUPT 0x01
  45. #define TS3A227E_REG_KP_INTERRUPT 0x02
  46. #define TS3A227E_REG_INTERRUPT_DISABLE 0x03
  47. #define TS3A227E_REG_SETTING_1 0x04
  48. #define TS3A227E_REG_SETTING_2 0x05
  49. #define TS3A227E_REG_SETTING_3 0x06
  50. #define TS3A227E_REG_SWITCH_CONTROL_1 0x07
  51. #define TS3A227E_REG_SWITCH_CONTROL_2 0x08
  52. #define TS3A227E_REG_SWITCH_STATUS_1 0x09
  53. #define TS3A227E_REG_SWITCH_STATUS_2 0x0a
  54. #define TS3A227E_REG_ACCESSORY_STATUS 0x0b
  55. #define TS3A227E_REG_ADC_OUTPUT 0x0c
  56. #define TS3A227E_REG_KP_THRESHOLD_1 0x0d
  57. #define TS3A227E_REG_KP_THRESHOLD_2 0x0e
  58. #define TS3A227E_REG_KP_THRESHOLD_3 0x0f
  59. /* TS3A227E_REG_INTERRUPT 0x01 */
  60. #define INS_REM_EVENT 0x01
  61. #define DETECTION_COMPLETE_EVENT 0x02
  62. /* TS3A227E_REG_KP_INTERRUPT 0x02 */
  63. #define PRESS_MASK(idx) (0x01 << (2 * (idx)))
  64. #define RELEASE_MASK(idx) (0x02 << (2 * (idx)))
  65. /* TS3A227E_REG_INTERRUPT_DISABLE 0x03 */
  66. #define INS_REM_INT_DISABLE 0x01
  67. #define DETECTION_COMPLETE_INT_DISABLE 0x02
  68. #define ADC_COMPLETE_INT_DISABLE 0x04
  69. #define INTB_DISABLE 0x08
  70. /* TS3A227E_REG_SETTING_2 0x05 */
  71. #define KP_ENABLE 0x04
  72. /* TS3A227E_REG_SETTING_3 0x06 */
  73. #define MICBIAS_SETTING_SFT (3)
  74. #define MICBIAS_SETTING_MASK (0x7 << MICBIAS_SETTING_SFT)
  75. /* TS3A227E_REG_ACCESSORY_STATUS 0x0b */
  76. #define TYPE_3_POLE 0x01
  77. #define TYPE_4_POLE_OMTP 0x02
  78. #define TYPE_4_POLE_STANDARD 0x04
  79. #define JACK_INSERTED 0x08
  80. #define EITHER_MIC_MASK (TYPE_4_POLE_OMTP | TYPE_4_POLE_STANDARD)
  81. static const struct reg_default ts3a227e_reg_defaults[] = {
  82. { TS3A227E_REG_DEVICE_ID, 0x10 },
  83. { TS3A227E_REG_INTERRUPT, 0x00 },
  84. { TS3A227E_REG_KP_INTERRUPT, 0x00 },
  85. { TS3A227E_REG_INTERRUPT_DISABLE, 0x08 },
  86. { TS3A227E_REG_SETTING_1, 0x23 },
  87. { TS3A227E_REG_SETTING_2, 0x00 },
  88. { TS3A227E_REG_SETTING_3, 0x0e },
  89. { TS3A227E_REG_SWITCH_CONTROL_1, 0x00 },
  90. { TS3A227E_REG_SWITCH_CONTROL_2, 0x00 },
  91. { TS3A227E_REG_SWITCH_STATUS_1, 0x0c },
  92. { TS3A227E_REG_SWITCH_STATUS_2, 0x00 },
  93. { TS3A227E_REG_ACCESSORY_STATUS, 0x00 },
  94. { TS3A227E_REG_ADC_OUTPUT, 0x00 },
  95. { TS3A227E_REG_KP_THRESHOLD_1, 0x20 },
  96. { TS3A227E_REG_KP_THRESHOLD_2, 0x40 },
  97. { TS3A227E_REG_KP_THRESHOLD_3, 0x68 },
  98. };
  99. static bool ts3a227e_readable_reg(struct device *dev, unsigned int reg)
  100. {
  101. switch (reg) {
  102. case TS3A227E_REG_DEVICE_ID ... TS3A227E_REG_KP_THRESHOLD_3:
  103. return true;
  104. default:
  105. return false;
  106. }
  107. }
  108. static bool ts3a227e_writeable_reg(struct device *dev, unsigned int reg)
  109. {
  110. switch (reg) {
  111. case TS3A227E_REG_INTERRUPT_DISABLE ... TS3A227E_REG_SWITCH_CONTROL_2:
  112. case TS3A227E_REG_KP_THRESHOLD_1 ... TS3A227E_REG_KP_THRESHOLD_3:
  113. return true;
  114. default:
  115. return false;
  116. }
  117. }
  118. static bool ts3a227e_volatile_reg(struct device *dev, unsigned int reg)
  119. {
  120. switch (reg) {
  121. case TS3A227E_REG_INTERRUPT ... TS3A227E_REG_INTERRUPT_DISABLE:
  122. case TS3A227E_REG_SETTING_2:
  123. case TS3A227E_REG_SWITCH_STATUS_1 ... TS3A227E_REG_ADC_OUTPUT:
  124. return true;
  125. default:
  126. return false;
  127. }
  128. }
  129. static void ts3a227e_jack_report(struct ts3a227e *ts3a227e)
  130. {
  131. unsigned int i;
  132. int report = 0;
  133. if (!ts3a227e->jack)
  134. return;
  135. if (ts3a227e->plugged)
  136. report = SND_JACK_HEADPHONE;
  137. if (ts3a227e->mic_present)
  138. report |= SND_JACK_MICROPHONE;
  139. for (i = 0; i < TS3A227E_NUM_BUTTONS; i++) {
  140. if (ts3a227e->buttons_held & (1 << i))
  141. report |= ts3a227e_buttons[i];
  142. }
  143. snd_soc_jack_report(ts3a227e->jack, report, TS3A227E_JACK_MASK);
  144. }
  145. static void ts3a227e_new_jack_state(struct ts3a227e *ts3a227e, unsigned acc_reg)
  146. {
  147. bool plugged, mic_present;
  148. plugged = !!(acc_reg & JACK_INSERTED);
  149. mic_present = plugged && !!(acc_reg & EITHER_MIC_MASK);
  150. ts3a227e->plugged = plugged;
  151. if (mic_present != ts3a227e->mic_present) {
  152. ts3a227e->mic_present = mic_present;
  153. ts3a227e->buttons_held = 0;
  154. if (mic_present) {
  155. /* Enable key press detection. */
  156. regmap_update_bits(ts3a227e->regmap,
  157. TS3A227E_REG_SETTING_2,
  158. KP_ENABLE, KP_ENABLE);
  159. }
  160. }
  161. }
  162. static irqreturn_t ts3a227e_interrupt(int irq, void *data)
  163. {
  164. struct ts3a227e *ts3a227e = (struct ts3a227e *)data;
  165. struct regmap *regmap = ts3a227e->regmap;
  166. unsigned int int_reg, kp_int_reg, acc_reg, i;
  167. struct device *dev = ts3a227e->dev;
  168. int ret;
  169. /* Check for plug/unplug. */
  170. ret = regmap_read(regmap, TS3A227E_REG_INTERRUPT, &int_reg);
  171. if (ret) {
  172. dev_err(dev, "failed to clear interrupt ret=%d\n", ret);
  173. return IRQ_NONE;
  174. }
  175. if (int_reg & (DETECTION_COMPLETE_EVENT | INS_REM_EVENT)) {
  176. regmap_read(regmap, TS3A227E_REG_ACCESSORY_STATUS, &acc_reg);
  177. ts3a227e_new_jack_state(ts3a227e, acc_reg);
  178. }
  179. /* Report any key events. */
  180. ret = regmap_read(regmap, TS3A227E_REG_KP_INTERRUPT, &kp_int_reg);
  181. if (ret) {
  182. dev_err(dev, "failed to clear key interrupt ret=%d\n", ret);
  183. return IRQ_NONE;
  184. }
  185. for (i = 0; i < TS3A227E_NUM_BUTTONS; i++) {
  186. if (kp_int_reg & PRESS_MASK(i))
  187. ts3a227e->buttons_held |= (1 << i);
  188. if (kp_int_reg & RELEASE_MASK(i))
  189. ts3a227e->buttons_held &= ~(1 << i);
  190. }
  191. ts3a227e_jack_report(ts3a227e);
  192. return IRQ_HANDLED;
  193. }
  194. /**
  195. * ts3a227e_enable_jack_detect - Specify a jack for event reporting
  196. *
  197. * @component: component to register the jack with
  198. * @jack: jack to use to report headset and button events on
  199. *
  200. * After this function has been called the headset insert/remove and button
  201. * events 0-3 will be routed to the given jack. Jack can be null to stop
  202. * reporting.
  203. */
  204. int ts3a227e_enable_jack_detect(struct snd_soc_component *component,
  205. struct snd_soc_jack *jack)
  206. {
  207. struct ts3a227e *ts3a227e = snd_soc_component_get_drvdata(component);
  208. snd_jack_set_key(jack->jack, SND_JACK_BTN_0, KEY_PLAYPAUSE);
  209. snd_jack_set_key(jack->jack, SND_JACK_BTN_1, KEY_VOICECOMMAND);
  210. snd_jack_set_key(jack->jack, SND_JACK_BTN_2, KEY_VOLUMEUP);
  211. snd_jack_set_key(jack->jack, SND_JACK_BTN_3, KEY_VOLUMEDOWN);
  212. ts3a227e->jack = jack;
  213. ts3a227e_jack_report(ts3a227e);
  214. return 0;
  215. }
  216. EXPORT_SYMBOL_GPL(ts3a227e_enable_jack_detect);
  217. static struct snd_soc_component_driver ts3a227e_soc_driver;
  218. static const struct regmap_config ts3a227e_regmap_config = {
  219. .val_bits = 8,
  220. .reg_bits = 8,
  221. .max_register = TS3A227E_REG_KP_THRESHOLD_3,
  222. .readable_reg = ts3a227e_readable_reg,
  223. .writeable_reg = ts3a227e_writeable_reg,
  224. .volatile_reg = ts3a227e_volatile_reg,
  225. .cache_type = REGCACHE_RBTREE,
  226. .reg_defaults = ts3a227e_reg_defaults,
  227. .num_reg_defaults = ARRAY_SIZE(ts3a227e_reg_defaults),
  228. };
  229. static int ts3a227e_parse_device_property(struct ts3a227e *ts3a227e,
  230. struct device *dev)
  231. {
  232. u32 micbias;
  233. int err;
  234. err = device_property_read_u32(dev, "ti,micbias", &micbias);
  235. if (!err) {
  236. regmap_update_bits(ts3a227e->regmap, TS3A227E_REG_SETTING_3,
  237. MICBIAS_SETTING_MASK,
  238. (micbias & 0x07) << MICBIAS_SETTING_SFT);
  239. }
  240. return 0;
  241. }
  242. static int ts3a227e_i2c_probe(struct i2c_client *i2c,
  243. const struct i2c_device_id *id)
  244. {
  245. struct ts3a227e *ts3a227e;
  246. struct device *dev = &i2c->dev;
  247. int ret;
  248. unsigned int acc_reg;
  249. ts3a227e = devm_kzalloc(&i2c->dev, sizeof(*ts3a227e), GFP_KERNEL);
  250. if (ts3a227e == NULL)
  251. return -ENOMEM;
  252. i2c_set_clientdata(i2c, ts3a227e);
  253. ts3a227e->dev = dev;
  254. ts3a227e->irq = i2c->irq;
  255. ts3a227e->regmap = devm_regmap_init_i2c(i2c, &ts3a227e_regmap_config);
  256. if (IS_ERR(ts3a227e->regmap))
  257. return PTR_ERR(ts3a227e->regmap);
  258. ret = ts3a227e_parse_device_property(ts3a227e, dev);
  259. if (ret) {
  260. dev_err(dev, "Failed to parse device property: %d\n", ret);
  261. return ret;
  262. }
  263. ret = devm_request_threaded_irq(dev, i2c->irq, NULL, ts3a227e_interrupt,
  264. IRQF_TRIGGER_LOW | IRQF_ONESHOT,
  265. "TS3A227E", ts3a227e);
  266. if (ret) {
  267. dev_err(dev, "Cannot request irq %d (%d)\n", i2c->irq, ret);
  268. return ret;
  269. }
  270. ret = devm_snd_soc_register_component(&i2c->dev, &ts3a227e_soc_driver,
  271. NULL, 0);
  272. if (ret)
  273. return ret;
  274. /* Enable interrupts except for ADC complete. */
  275. regmap_update_bits(ts3a227e->regmap, TS3A227E_REG_INTERRUPT_DISABLE,
  276. INTB_DISABLE | ADC_COMPLETE_INT_DISABLE,
  277. ADC_COMPLETE_INT_DISABLE);
  278. /* Read jack status because chip might not trigger interrupt at boot. */
  279. regmap_read(ts3a227e->regmap, TS3A227E_REG_ACCESSORY_STATUS, &acc_reg);
  280. ts3a227e_new_jack_state(ts3a227e, acc_reg);
  281. ts3a227e_jack_report(ts3a227e);
  282. return 0;
  283. }
  284. #ifdef CONFIG_PM_SLEEP
  285. static int ts3a227e_suspend(struct device *dev)
  286. {
  287. struct ts3a227e *ts3a227e = dev_get_drvdata(dev);
  288. dev_dbg(ts3a227e->dev, "suspend disable irq\n");
  289. disable_irq(ts3a227e->irq);
  290. return 0;
  291. }
  292. static int ts3a227e_resume(struct device *dev)
  293. {
  294. struct ts3a227e *ts3a227e = dev_get_drvdata(dev);
  295. dev_dbg(ts3a227e->dev, "resume enable irq\n");
  296. enable_irq(ts3a227e->irq);
  297. return 0;
  298. }
  299. #endif
  300. static const struct dev_pm_ops ts3a227e_pm = {
  301. SET_SYSTEM_SLEEP_PM_OPS(ts3a227e_suspend, ts3a227e_resume)
  302. };
  303. static const struct i2c_device_id ts3a227e_i2c_ids[] = {
  304. { "ts3a227e", 0 },
  305. { }
  306. };
  307. MODULE_DEVICE_TABLE(i2c, ts3a227e_i2c_ids);
  308. static const struct of_device_id ts3a227e_of_match[] = {
  309. { .compatible = "ti,ts3a227e", },
  310. { }
  311. };
  312. MODULE_DEVICE_TABLE(of, ts3a227e_of_match);
  313. #ifdef CONFIG_ACPI
  314. static struct acpi_device_id ts3a227e_acpi_match[] = {
  315. { "104C227E", 0 },
  316. {},
  317. };
  318. MODULE_DEVICE_TABLE(acpi, ts3a227e_acpi_match);
  319. #endif
  320. static struct i2c_driver ts3a227e_driver = {
  321. .driver = {
  322. .name = "ts3a227e",
  323. .pm = &ts3a227e_pm,
  324. .of_match_table = of_match_ptr(ts3a227e_of_match),
  325. .acpi_match_table = ACPI_PTR(ts3a227e_acpi_match),
  326. },
  327. .probe = ts3a227e_i2c_probe,
  328. .id_table = ts3a227e_i2c_ids,
  329. };
  330. module_i2c_driver(ts3a227e_driver);
  331. MODULE_DESCRIPTION("ASoC ts3a227e driver");
  332. MODULE_AUTHOR("Dylan Reid <dgreid@chromium.org>");
  333. MODULE_LICENSE("GPL v2");