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 8 #include <linux/i2c.h> 9 #include <linux/init.h> 10 #include <linux/input.h> 11 #include <linux/module.h> 12 #include <linux/regmap.h> 13 #include <linux/acpi.h> 14 15 #include <sound/core.h> 16 #include <sound/jack.h> 17 #include <sound/soc.h> 18 19 #include "ts3a227e.h" 20 21 struct ts3a227e { 22 struct device *dev; 23 struct regmap *regmap; 24 struct snd_soc_jack *jack; 25 bool plugged; 26 bool mic_present; 27 unsigned int buttons_held; 28 int irq; 29 }; 30 31 /* Button values to be reported on the jack */ 32 static const int ts3a227e_buttons[] = { 33 SND_JACK_BTN_0, 34 SND_JACK_BTN_1, 35 SND_JACK_BTN_2, 36 SND_JACK_BTN_3, 37 }; 38 39 #define TS3A227E_NUM_BUTTONS 4 40 #define TS3A227E_JACK_MASK (SND_JACK_HEADPHONE | \ 41 SND_JACK_MICROPHONE | \ 42 SND_JACK_BTN_0 | \ 43 SND_JACK_BTN_1 | \ 44 SND_JACK_BTN_2 | \ 45 SND_JACK_BTN_3) 46 47 /* TS3A227E registers */ 48 #define TS3A227E_REG_DEVICE_ID 0x00 49 #define TS3A227E_REG_INTERRUPT 0x01 50 #define TS3A227E_REG_KP_INTERRUPT 0x02 51 #define TS3A227E_REG_INTERRUPT_DISABLE 0x03 52 #define TS3A227E_REG_SETTING_1 0x04 53 #define TS3A227E_REG_SETTING_2 0x05 54 #define TS3A227E_REG_SETTING_3 0x06 55 #define TS3A227E_REG_SWITCH_CONTROL_1 0x07 56 #define TS3A227E_REG_SWITCH_CONTROL_2 0x08 57 #define TS3A227E_REG_SWITCH_STATUS_1 0x09 58 #define TS3A227E_REG_SWITCH_STATUS_2 0x0a 59 #define TS3A227E_REG_ACCESSORY_STATUS 0x0b 60 #define TS3A227E_REG_ADC_OUTPUT 0x0c 61 #define TS3A227E_REG_KP_THRESHOLD_1 0x0d 62 #define TS3A227E_REG_KP_THRESHOLD_2 0x0e 63 #define TS3A227E_REG_KP_THRESHOLD_3 0x0f 64 65 /* TS3A227E_REG_INTERRUPT 0x01 */ 66 #define INS_REM_EVENT 0x01 67 #define DETECTION_COMPLETE_EVENT 0x02 68 69 /* TS3A227E_REG_KP_INTERRUPT 0x02 */ 70 #define PRESS_MASK(idx) (0x01 << (2 * (idx))) 71 #define RELEASE_MASK(idx) (0x02 << (2 * (idx))) 72 73 /* TS3A227E_REG_INTERRUPT_DISABLE 0x03 */ 74 #define INS_REM_INT_DISABLE 0x01 75 #define DETECTION_COMPLETE_INT_DISABLE 0x02 76 #define ADC_COMPLETE_INT_DISABLE 0x04 77 #define INTB_DISABLE 0x08 78 79 /* TS3A227E_REG_SETTING_1 0x4 */ 80 #define DEBOUNCE_INSERTION_SETTING_SFT (0) 81 #define DEBOUNCE_INSERTION_SETTING_MASK (0x7 << DEBOUNCE_PRESS_SETTING_SFT) 82 83 /* TS3A227E_REG_SETTING_2 0x05 */ 84 #define KP_ENABLE 0x04 85 86 /* TS3A227E_REG_SETTING_3 0x06 */ 87 #define MICBIAS_SETTING_SFT 3 88 #define MICBIAS_SETTING_MASK (0x7 << MICBIAS_SETTING_SFT) 89 #define DEBOUNCE_RELEASE_SETTING_SFT 2 90 #define DEBOUNCE_RELEASE_SETTING_MASK (0x1 << DEBOUNCE_RELEASE_SETTING_SFT) 91 #define DEBOUNCE_PRESS_SETTING_SFT 0 92 #define DEBOUNCE_PRESS_SETTING_MASK (0x3 << DEBOUNCE_PRESS_SETTING_SFT) 93 94 /* TS3A227E_REG_ACCESSORY_STATUS 0x0b */ 95 #define TYPE_3_POLE 0x01 96 #define TYPE_4_POLE_OMTP 0x02 97 #define TYPE_4_POLE_STANDARD 0x04 98 #define JACK_INSERTED 0x08 99 #define EITHER_MIC_MASK (TYPE_4_POLE_OMTP | TYPE_4_POLE_STANDARD) 100 101 static const struct reg_default ts3a227e_reg_defaults[] = { 102 { TS3A227E_REG_DEVICE_ID, 0x10 }, 103 { TS3A227E_REG_INTERRUPT, 0x00 }, 104 { TS3A227E_REG_KP_INTERRUPT, 0x00 }, 105 { TS3A227E_REG_INTERRUPT_DISABLE, 0x08 }, 106 { TS3A227E_REG_SETTING_1, 0x23 }, 107 { TS3A227E_REG_SETTING_2, 0x00 }, 108 { TS3A227E_REG_SETTING_3, 0x0e }, 109 { TS3A227E_REG_SWITCH_CONTROL_1, 0x00 }, 110 { TS3A227E_REG_SWITCH_CONTROL_2, 0x00 }, 111 { TS3A227E_REG_SWITCH_STATUS_1, 0x0c }, 112 { TS3A227E_REG_SWITCH_STATUS_2, 0x00 }, 113 { TS3A227E_REG_ACCESSORY_STATUS, 0x00 }, 114 { TS3A227E_REG_ADC_OUTPUT, 0x00 }, 115 { TS3A227E_REG_KP_THRESHOLD_1, 0x20 }, 116 { TS3A227E_REG_KP_THRESHOLD_2, 0x40 }, 117 { TS3A227E_REG_KP_THRESHOLD_3, 0x68 }, 118 }; 119 120 static bool ts3a227e_readable_reg(struct device *dev, unsigned int reg) 121 { 122 switch (reg) { 123 case TS3A227E_REG_DEVICE_ID ... TS3A227E_REG_KP_THRESHOLD_3: 124 return true; 125 default: 126 return false; 127 } 128 } 129 130 static bool ts3a227e_writeable_reg(struct device *dev, unsigned int reg) 131 { 132 switch (reg) { 133 case TS3A227E_REG_INTERRUPT_DISABLE ... TS3A227E_REG_SWITCH_CONTROL_2: 134 case TS3A227E_REG_KP_THRESHOLD_1 ... TS3A227E_REG_KP_THRESHOLD_3: 135 return true; 136 default: 137 return false; 138 } 139 } 140 141 static bool ts3a227e_volatile_reg(struct device *dev, unsigned int reg) 142 { 143 switch (reg) { 144 case TS3A227E_REG_INTERRUPT ... TS3A227E_REG_INTERRUPT_DISABLE: 145 case TS3A227E_REG_SETTING_1 ... TS3A227E_REG_SETTING_2: 146 case TS3A227E_REG_SWITCH_STATUS_1 ... TS3A227E_REG_ADC_OUTPUT: 147 return true; 148 default: 149 return false; 150 } 151 } 152 153 static void ts3a227e_jack_report(struct ts3a227e *ts3a227e) 154 { 155 unsigned int i; 156 int report = 0; 157 158 if (!ts3a227e->jack) 159 return; 160 161 if (ts3a227e->plugged) 162 report = SND_JACK_HEADPHONE; 163 if (ts3a227e->mic_present) 164 report |= SND_JACK_MICROPHONE; 165 for (i = 0; i < TS3A227E_NUM_BUTTONS; i++) { 166 if (ts3a227e->buttons_held & (1 << i)) 167 report |= ts3a227e_buttons[i]; 168 } 169 snd_soc_jack_report(ts3a227e->jack, report, TS3A227E_JACK_MASK); 170 } 171 172 static void ts3a227e_new_jack_state(struct ts3a227e *ts3a227e, unsigned acc_reg) 173 { 174 bool plugged, mic_present; 175 176 plugged = !!(acc_reg & JACK_INSERTED); 177 mic_present = plugged && !!(acc_reg & EITHER_MIC_MASK); 178 179 ts3a227e->plugged = plugged; 180 181 if (mic_present != ts3a227e->mic_present) { 182 ts3a227e->mic_present = mic_present; 183 ts3a227e->buttons_held = 0; 184 if (mic_present) { 185 /* Enable key press detection. */ 186 regmap_update_bits(ts3a227e->regmap, 187 TS3A227E_REG_SETTING_2, 188 KP_ENABLE, KP_ENABLE); 189 } 190 } 191 } 192 193 static irqreturn_t ts3a227e_interrupt(int irq, void *data) 194 { 195 struct ts3a227e *ts3a227e = (struct ts3a227e *)data; 196 struct regmap *regmap = ts3a227e->regmap; 197 unsigned int int_reg, kp_int_reg, acc_reg, i; 198 struct device *dev = ts3a227e->dev; 199 int ret; 200 201 /* Check for plug/unplug. */ 202 ret = regmap_read(regmap, TS3A227E_REG_INTERRUPT, &int_reg); 203 if (ret) { 204 dev_err(dev, "failed to clear interrupt ret=%d\n", ret); 205 return IRQ_NONE; 206 } 207 208 if (int_reg & (DETECTION_COMPLETE_EVENT | INS_REM_EVENT)) { 209 regmap_read(regmap, TS3A227E_REG_ACCESSORY_STATUS, &acc_reg); 210 ts3a227e_new_jack_state(ts3a227e, acc_reg); 211 } 212 213 /* Report any key events. */ 214 ret = regmap_read(regmap, TS3A227E_REG_KP_INTERRUPT, &kp_int_reg); 215 if (ret) { 216 dev_err(dev, "failed to clear key interrupt ret=%d\n", ret); 217 return IRQ_NONE; 218 } 219 220 for (i = 0; i < TS3A227E_NUM_BUTTONS; i++) { 221 if (kp_int_reg & PRESS_MASK(i)) 222 ts3a227e->buttons_held |= (1 << i); 223 if (kp_int_reg & RELEASE_MASK(i)) 224 ts3a227e->buttons_held &= ~(1 << i); 225 } 226 227 ts3a227e_jack_report(ts3a227e); 228 229 return IRQ_HANDLED; 230 } 231 232 /** 233 * ts3a227e_enable_jack_detect - Specify a jack for event reporting 234 * 235 * @component: component to register the jack with 236 * @jack: jack to use to report headset and button events on 237 * 238 * After this function has been called the headset insert/remove and button 239 * events 0-3 will be routed to the given jack. Jack can be null to stop 240 * reporting. 241 */ 242 int ts3a227e_enable_jack_detect(struct snd_soc_component *component, 243 struct snd_soc_jack *jack) 244 { 245 struct ts3a227e *ts3a227e = snd_soc_component_get_drvdata(component); 246 247 snd_jack_set_key(jack->jack, SND_JACK_BTN_0, KEY_PLAYPAUSE); 248 snd_jack_set_key(jack->jack, SND_JACK_BTN_1, KEY_VOICECOMMAND); 249 snd_jack_set_key(jack->jack, SND_JACK_BTN_2, KEY_VOLUMEUP); 250 snd_jack_set_key(jack->jack, SND_JACK_BTN_3, KEY_VOLUMEDOWN); 251 252 ts3a227e->jack = jack; 253 ts3a227e_jack_report(ts3a227e); 254 255 return 0; 256 } 257 EXPORT_SYMBOL_GPL(ts3a227e_enable_jack_detect); 258 259 static int ts3a227e_set_jack(struct snd_soc_component *component, 260 struct snd_soc_jack *jack, void *data) 261 { 262 if (jack == NULL) 263 return -EINVAL; 264 265 return ts3a227e_enable_jack_detect(component, jack); 266 } 267 268 static int ts3a227e_get_jack_type(struct snd_soc_component *component) 269 { 270 return SND_JACK_HEADSET; 271 } 272 273 static const struct snd_soc_component_driver ts3a227e_soc_driver = { 274 .name = "ti,ts3a227e", 275 .set_jack = ts3a227e_set_jack, 276 .get_jack_type = ts3a227e_get_jack_type, 277 }; 278 279 static const struct regmap_config ts3a227e_regmap_config = { 280 .val_bits = 8, 281 .reg_bits = 8, 282 283 .max_register = TS3A227E_REG_KP_THRESHOLD_3, 284 .readable_reg = ts3a227e_readable_reg, 285 .writeable_reg = ts3a227e_writeable_reg, 286 .volatile_reg = ts3a227e_volatile_reg, 287 288 .cache_type = REGCACHE_RBTREE, 289 .reg_defaults = ts3a227e_reg_defaults, 290 .num_reg_defaults = ARRAY_SIZE(ts3a227e_reg_defaults), 291 }; 292 293 static int ts3a227e_parse_device_property(struct ts3a227e *ts3a227e, 294 struct device *dev) 295 { 296 u32 value; 297 u32 value_ms; 298 u32 setting3_value = 0; 299 u32 setting3_mask = 0; 300 int err; 301 302 err = device_property_read_u32(dev, "ti,micbias", &value); 303 if (!err) { 304 setting3_mask = MICBIAS_SETTING_MASK; 305 setting3_value = (value << MICBIAS_SETTING_SFT) & 306 MICBIAS_SETTING_MASK; 307 } 308 309 err = device_property_read_u32(dev, "ti,debounce-release-ms", 310 &value_ms); 311 if (!err) { 312 value = (value_ms > 10); 313 setting3_mask |= DEBOUNCE_RELEASE_SETTING_MASK; 314 setting3_value |= (value << DEBOUNCE_RELEASE_SETTING_SFT) & 315 DEBOUNCE_RELEASE_SETTING_MASK; 316 } 317 318 err = device_property_read_u32(dev, "ti,debounce-press-ms", &value_ms); 319 if (!err) { 320 value = (value_ms + 20) / 40; 321 if (value > 3) 322 value = 3; 323 setting3_mask |= DEBOUNCE_PRESS_SETTING_MASK; 324 setting3_value |= (value << DEBOUNCE_PRESS_SETTING_SFT) & 325 DEBOUNCE_PRESS_SETTING_MASK; 326 } 327 328 if (setting3_mask) 329 regmap_update_bits(ts3a227e->regmap, TS3A227E_REG_SETTING_3, 330 setting3_mask, setting3_value); 331 332 err = device_property_read_u32(dev, "ti,debounce-insertion-ms", 333 &value_ms); 334 if (!err) { 335 if (value_ms < 165) 336 value = (value_ms + 15) / 30; 337 else if (value_ms < 1500) 338 value = 6; 339 else 340 value = 7; 341 regmap_update_bits(ts3a227e->regmap, TS3A227E_REG_SETTING_1, 342 DEBOUNCE_INSERTION_SETTING_MASK, 343 (value << DEBOUNCE_INSERTION_SETTING_SFT) & 344 DEBOUNCE_INSERTION_SETTING_MASK); 345 } 346 347 return 0; 348 } 349 350 static int ts3a227e_i2c_probe(struct i2c_client *i2c) 351 { 352 struct ts3a227e *ts3a227e; 353 struct device *dev = &i2c->dev; 354 int ret; 355 unsigned int acc_reg; 356 357 ts3a227e = devm_kzalloc(&i2c->dev, sizeof(*ts3a227e), GFP_KERNEL); 358 if (ts3a227e == NULL) 359 return -ENOMEM; 360 361 i2c_set_clientdata(i2c, ts3a227e); 362 ts3a227e->dev = dev; 363 ts3a227e->irq = i2c->irq; 364 365 ts3a227e->regmap = devm_regmap_init_i2c(i2c, &ts3a227e_regmap_config); 366 if (IS_ERR(ts3a227e->regmap)) 367 return PTR_ERR(ts3a227e->regmap); 368 369 ret = ts3a227e_parse_device_property(ts3a227e, dev); 370 if (ret) { 371 dev_err(dev, "Failed to parse device property: %d\n", ret); 372 return ret; 373 } 374 375 ret = devm_request_threaded_irq(dev, i2c->irq, NULL, ts3a227e_interrupt, 376 IRQF_TRIGGER_LOW | IRQF_ONESHOT, 377 "TS3A227E", ts3a227e); 378 if (ret) { 379 dev_err(dev, "Cannot request irq %d (%d)\n", i2c->irq, ret); 380 return ret; 381 } 382 383 ret = devm_snd_soc_register_component(&i2c->dev, &ts3a227e_soc_driver, 384 NULL, 0); 385 if (ret) 386 return ret; 387 388 /* Enable interrupts except for ADC complete. */ 389 regmap_update_bits(ts3a227e->regmap, TS3A227E_REG_INTERRUPT_DISABLE, 390 INTB_DISABLE | ADC_COMPLETE_INT_DISABLE, 391 ADC_COMPLETE_INT_DISABLE); 392 393 /* Read jack status because chip might not trigger interrupt at boot. */ 394 regmap_read(ts3a227e->regmap, TS3A227E_REG_ACCESSORY_STATUS, &acc_reg); 395 ts3a227e_new_jack_state(ts3a227e, acc_reg); 396 ts3a227e_jack_report(ts3a227e); 397 398 return 0; 399 } 400 401 static int ts3a227e_suspend(struct device *dev) 402 { 403 struct ts3a227e *ts3a227e = dev_get_drvdata(dev); 404 405 dev_dbg(ts3a227e->dev, "suspend disable irq\n"); 406 disable_irq(ts3a227e->irq); 407 408 return 0; 409 } 410 411 static int ts3a227e_resume(struct device *dev) 412 { 413 struct ts3a227e *ts3a227e = dev_get_drvdata(dev); 414 415 dev_dbg(ts3a227e->dev, "resume enable irq\n"); 416 enable_irq(ts3a227e->irq); 417 418 return 0; 419 } 420 421 static const struct dev_pm_ops ts3a227e_pm = { 422 SYSTEM_SLEEP_PM_OPS(ts3a227e_suspend, ts3a227e_resume) 423 }; 424 425 static const struct i2c_device_id ts3a227e_i2c_ids[] = { 426 { "ts3a227e" }, 427 { } 428 }; 429 MODULE_DEVICE_TABLE(i2c, ts3a227e_i2c_ids); 430 431 #ifdef CONFIG_OF 432 static const struct of_device_id ts3a227e_of_match[] = { 433 { .compatible = "ti,ts3a227e", }, 434 { } 435 }; 436 MODULE_DEVICE_TABLE(of, ts3a227e_of_match); 437 #endif 438 439 #ifdef CONFIG_ACPI 440 static struct acpi_device_id ts3a227e_acpi_match[] = { 441 { "104C227E", 0 }, 442 {}, 443 }; 444 MODULE_DEVICE_TABLE(acpi, ts3a227e_acpi_match); 445 #endif 446 447 static struct i2c_driver ts3a227e_driver = { 448 .driver = { 449 .name = "ts3a227e", 450 .pm = pm_ptr(&ts3a227e_pm), 451 .of_match_table = of_match_ptr(ts3a227e_of_match), 452 .acpi_match_table = ACPI_PTR(ts3a227e_acpi_match), 453 }, 454 .probe = ts3a227e_i2c_probe, 455 .id_table = ts3a227e_i2c_ids, 456 }; 457 module_i2c_driver(ts3a227e_driver); 458 459 MODULE_DESCRIPTION("ASoC ts3a227e driver"); 460 MODULE_AUTHOR("Dylan Reid <dgreid@chromium.org>"); 461 MODULE_LICENSE("GPL v2"); 462