1 /* 2 * wm8994-core.c -- Device access for Wolfson WM8994 3 * 4 * Copyright 2009 Wolfson Microelectronics PLC. 5 * 6 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com> 7 * 8 * This program is free software; you can redistribute it and/or modify it 9 * under the terms of the GNU General Public License as published by the 10 * Free Software Foundation; either version 2 of the License, or (at your 11 * option) any later version. 12 * 13 */ 14 15 #include <linux/kernel.h> 16 #include <linux/module.h> 17 #include <linux/slab.h> 18 #include <linux/i2c.h> 19 #include <linux/err.h> 20 #include <linux/delay.h> 21 #include <linux/mfd/core.h> 22 #include <linux/of.h> 23 #include <linux/of_device.h> 24 #include <linux/pm_runtime.h> 25 #include <linux/regmap.h> 26 #include <linux/regulator/consumer.h> 27 #include <linux/regulator/machine.h> 28 29 #include <linux/mfd/wm8994/core.h> 30 #include <linux/mfd/wm8994/pdata.h> 31 #include <linux/mfd/wm8994/registers.h> 32 33 #include "wm8994.h" 34 35 static const struct mfd_cell wm8994_regulator_devs[] = { 36 { 37 .name = "wm8994-ldo", 38 .id = 0, 39 .pm_runtime_no_callbacks = true, 40 }, 41 { 42 .name = "wm8994-ldo", 43 .id = 1, 44 .pm_runtime_no_callbacks = true, 45 }, 46 }; 47 48 static struct resource wm8994_codec_resources[] = { 49 { 50 .start = WM8994_IRQ_TEMP_SHUT, 51 .end = WM8994_IRQ_TEMP_WARN, 52 .flags = IORESOURCE_IRQ, 53 }, 54 }; 55 56 static struct resource wm8994_gpio_resources[] = { 57 { 58 .start = WM8994_IRQ_GPIO(1), 59 .end = WM8994_IRQ_GPIO(11), 60 .flags = IORESOURCE_IRQ, 61 }, 62 }; 63 64 static const struct mfd_cell wm8994_devs[] = { 65 { 66 .name = "wm8994-codec", 67 .num_resources = ARRAY_SIZE(wm8994_codec_resources), 68 .resources = wm8994_codec_resources, 69 }, 70 71 { 72 .name = "wm8994-gpio", 73 .num_resources = ARRAY_SIZE(wm8994_gpio_resources), 74 .resources = wm8994_gpio_resources, 75 .pm_runtime_no_callbacks = true, 76 }, 77 }; 78 79 /* 80 * Supplies for the main bulk of CODEC; the LDO supplies are ignored 81 * and should be handled via the standard regulator API supply 82 * management. 83 */ 84 static const char *wm1811_main_supplies[] = { 85 "DBVDD1", 86 "DBVDD2", 87 "DBVDD3", 88 "DCVDD", 89 "AVDD1", 90 "AVDD2", 91 "CPVDD", 92 "SPKVDD1", 93 "SPKVDD2", 94 }; 95 96 static const char *wm8994_main_supplies[] = { 97 "DBVDD", 98 "DCVDD", 99 "AVDD1", 100 "AVDD2", 101 "CPVDD", 102 "SPKVDD1", 103 "SPKVDD2", 104 }; 105 106 static const char *wm8958_main_supplies[] = { 107 "DBVDD1", 108 "DBVDD2", 109 "DBVDD3", 110 "DCVDD", 111 "AVDD1", 112 "AVDD2", 113 "CPVDD", 114 "SPKVDD1", 115 "SPKVDD2", 116 }; 117 118 #ifdef CONFIG_PM 119 static int wm8994_suspend(struct device *dev) 120 { 121 struct wm8994 *wm8994 = dev_get_drvdata(dev); 122 int ret; 123 124 /* Don't actually go through with the suspend if the CODEC is 125 * still active for accessory detect. */ 126 switch (wm8994->type) { 127 case WM8958: 128 case WM1811: 129 ret = wm8994_reg_read(wm8994, WM8958_MIC_DETECT_1); 130 if (ret < 0) { 131 dev_err(dev, "Failed to read power status: %d\n", ret); 132 } else if (ret & WM8958_MICD_ENA) { 133 dev_dbg(dev, "CODEC still active, ignoring suspend\n"); 134 return 0; 135 } 136 break; 137 default: 138 break; 139 } 140 141 /* Disable LDO pulldowns while the device is suspended if we 142 * don't know that something will be driving them. */ 143 if (!wm8994->ldo_ena_always_driven) 144 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2, 145 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD, 146 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD); 147 148 /* Explicitly put the device into reset in case regulators 149 * don't get disabled in order to ensure consistent restart. 150 */ 151 wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET, 152 wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET)); 153 154 regcache_mark_dirty(wm8994->regmap); 155 156 /* Restore GPIO registers to prevent problems with mismatched 157 * pin configurations. 158 */ 159 ret = regcache_sync_region(wm8994->regmap, WM8994_GPIO_1, 160 WM8994_GPIO_11); 161 if (ret != 0) 162 dev_err(dev, "Failed to restore GPIO registers: %d\n", ret); 163 164 /* In case one of the GPIOs is used as a wake input. */ 165 ret = regcache_sync_region(wm8994->regmap, 166 WM8994_INTERRUPT_STATUS_1_MASK, 167 WM8994_INTERRUPT_STATUS_1_MASK); 168 if (ret != 0) 169 dev_err(dev, "Failed to restore interrupt mask: %d\n", ret); 170 171 regcache_cache_only(wm8994->regmap, true); 172 wm8994->suspended = true; 173 174 ret = regulator_bulk_disable(wm8994->num_supplies, 175 wm8994->supplies); 176 if (ret != 0) { 177 dev_err(dev, "Failed to disable supplies: %d\n", ret); 178 return ret; 179 } 180 181 return 0; 182 } 183 184 static int wm8994_resume(struct device *dev) 185 { 186 struct wm8994 *wm8994 = dev_get_drvdata(dev); 187 int ret; 188 189 /* We may have lied to the PM core about suspending */ 190 if (!wm8994->suspended) 191 return 0; 192 193 ret = regulator_bulk_enable(wm8994->num_supplies, 194 wm8994->supplies); 195 if (ret != 0) { 196 dev_err(dev, "Failed to enable supplies: %d\n", ret); 197 return ret; 198 } 199 200 regcache_cache_only(wm8994->regmap, false); 201 ret = regcache_sync(wm8994->regmap); 202 if (ret != 0) { 203 dev_err(dev, "Failed to restore register map: %d\n", ret); 204 goto err_enable; 205 } 206 207 /* Disable LDO pulldowns while the device is active */ 208 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2, 209 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD, 210 0); 211 212 wm8994->suspended = false; 213 214 return 0; 215 216 err_enable: 217 regulator_bulk_disable(wm8994->num_supplies, wm8994->supplies); 218 219 return ret; 220 } 221 #endif 222 223 #ifdef CONFIG_REGULATOR 224 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo) 225 { 226 struct wm8994_ldo_pdata *ldo_pdata; 227 228 if (!pdata) 229 return 0; 230 231 ldo_pdata = &pdata->ldo[ldo]; 232 233 if (!ldo_pdata->init_data) 234 return 0; 235 236 return ldo_pdata->init_data->num_consumer_supplies != 0; 237 } 238 #else 239 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo) 240 { 241 return 0; 242 } 243 #endif 244 245 static const struct reg_sequence wm8994_revc_patch[] = { 246 { 0x102, 0x3 }, 247 { 0x56, 0x3 }, 248 { 0x817, 0x0 }, 249 { 0x102, 0x0 }, 250 }; 251 252 static const struct reg_sequence wm8958_reva_patch[] = { 253 { 0x102, 0x3 }, 254 { 0xcb, 0x81 }, 255 { 0x817, 0x0 }, 256 { 0x102, 0x0 }, 257 }; 258 259 static const struct reg_sequence wm1811_reva_patch[] = { 260 { 0x102, 0x3 }, 261 { 0x56, 0xc07 }, 262 { 0x5d, 0x7e }, 263 { 0x5e, 0x0 }, 264 { 0x102, 0x0 }, 265 }; 266 267 #ifdef CONFIG_OF 268 static int wm8994_set_pdata_from_of(struct wm8994 *wm8994) 269 { 270 struct device_node *np = wm8994->dev->of_node; 271 struct wm8994_pdata *pdata = &wm8994->pdata; 272 int i; 273 274 if (!np) 275 return 0; 276 277 if (of_property_read_u32_array(np, "wlf,gpio-cfg", pdata->gpio_defaults, 278 ARRAY_SIZE(pdata->gpio_defaults)) >= 0) { 279 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) { 280 if (wm8994->pdata.gpio_defaults[i] == 0) 281 pdata->gpio_defaults[i] 282 = WM8994_CONFIGURE_GPIO; 283 } 284 } 285 286 of_property_read_u32_array(np, "wlf,micbias-cfg", pdata->micbias, 287 ARRAY_SIZE(pdata->micbias)); 288 289 pdata->lineout1_diff = true; 290 pdata->lineout2_diff = true; 291 if (of_find_property(np, "wlf,lineout1-se", NULL)) 292 pdata->lineout1_diff = false; 293 if (of_find_property(np, "wlf,lineout2-se", NULL)) 294 pdata->lineout2_diff = false; 295 296 if (of_find_property(np, "wlf,lineout1-feedback", NULL)) 297 pdata->lineout1fb = true; 298 if (of_find_property(np, "wlf,lineout2-feedback", NULL)) 299 pdata->lineout2fb = true; 300 301 if (of_find_property(np, "wlf,ldoena-always-driven", NULL)) 302 pdata->lineout2fb = true; 303 304 return 0; 305 } 306 #else 307 static int wm8994_set_pdata_from_of(struct wm8994 *wm8994) 308 { 309 return 0; 310 } 311 #endif 312 313 /* 314 * Instantiate the generic non-control parts of the device. 315 */ 316 static int wm8994_device_init(struct wm8994 *wm8994, int irq) 317 { 318 struct wm8994_pdata *pdata; 319 struct regmap_config *regmap_config; 320 const struct reg_sequence *regmap_patch = NULL; 321 const char *devname; 322 int ret, i, patch_regs = 0; 323 int pulls = 0; 324 325 if (dev_get_platdata(wm8994->dev)) { 326 pdata = dev_get_platdata(wm8994->dev); 327 wm8994->pdata = *pdata; 328 } 329 pdata = &wm8994->pdata; 330 331 ret = wm8994_set_pdata_from_of(wm8994); 332 if (ret != 0) 333 return ret; 334 335 dev_set_drvdata(wm8994->dev, wm8994); 336 337 /* Add the on-chip regulators first for bootstrapping */ 338 ret = mfd_add_devices(wm8994->dev, 0, 339 wm8994_regulator_devs, 340 ARRAY_SIZE(wm8994_regulator_devs), 341 NULL, 0, NULL); 342 if (ret != 0) { 343 dev_err(wm8994->dev, "Failed to add children: %d\n", ret); 344 goto err; 345 } 346 347 switch (wm8994->type) { 348 case WM1811: 349 wm8994->num_supplies = ARRAY_SIZE(wm1811_main_supplies); 350 break; 351 case WM8994: 352 wm8994->num_supplies = ARRAY_SIZE(wm8994_main_supplies); 353 break; 354 case WM8958: 355 wm8994->num_supplies = ARRAY_SIZE(wm8958_main_supplies); 356 break; 357 default: 358 BUG(); 359 goto err; 360 } 361 362 wm8994->supplies = devm_kzalloc(wm8994->dev, 363 sizeof(struct regulator_bulk_data) * 364 wm8994->num_supplies, GFP_KERNEL); 365 if (!wm8994->supplies) { 366 ret = -ENOMEM; 367 goto err; 368 } 369 370 switch (wm8994->type) { 371 case WM1811: 372 for (i = 0; i < ARRAY_SIZE(wm1811_main_supplies); i++) 373 wm8994->supplies[i].supply = wm1811_main_supplies[i]; 374 break; 375 case WM8994: 376 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++) 377 wm8994->supplies[i].supply = wm8994_main_supplies[i]; 378 break; 379 case WM8958: 380 for (i = 0; i < ARRAY_SIZE(wm8958_main_supplies); i++) 381 wm8994->supplies[i].supply = wm8958_main_supplies[i]; 382 break; 383 default: 384 BUG(); 385 goto err; 386 } 387 388 /* 389 * Can't use devres helper here as some of the supplies are provided by 390 * wm8994->dev's children (regulators) and those regulators are 391 * unregistered by the devres core before the supplies are freed. 392 */ 393 ret = regulator_bulk_get(wm8994->dev, wm8994->num_supplies, 394 wm8994->supplies); 395 if (ret != 0) { 396 dev_err(wm8994->dev, "Failed to get supplies: %d\n", ret); 397 goto err; 398 } 399 400 ret = regulator_bulk_enable(wm8994->num_supplies, wm8994->supplies); 401 if (ret != 0) { 402 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret); 403 goto err_regulator_free; 404 } 405 406 ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET); 407 if (ret < 0) { 408 dev_err(wm8994->dev, "Failed to read ID register\n"); 409 goto err_enable; 410 } 411 switch (ret) { 412 case 0x1811: 413 devname = "WM1811"; 414 if (wm8994->type != WM1811) 415 dev_warn(wm8994->dev, "Device registered as type %d\n", 416 wm8994->type); 417 wm8994->type = WM1811; 418 break; 419 case 0x8994: 420 devname = "WM8994"; 421 if (wm8994->type != WM8994) 422 dev_warn(wm8994->dev, "Device registered as type %d\n", 423 wm8994->type); 424 wm8994->type = WM8994; 425 break; 426 case 0x8958: 427 devname = "WM8958"; 428 if (wm8994->type != WM8958) 429 dev_warn(wm8994->dev, "Device registered as type %d\n", 430 wm8994->type); 431 wm8994->type = WM8958; 432 break; 433 default: 434 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n", 435 ret); 436 ret = -EINVAL; 437 goto err_enable; 438 } 439 440 ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION); 441 if (ret < 0) { 442 dev_err(wm8994->dev, "Failed to read revision register: %d\n", 443 ret); 444 goto err_enable; 445 } 446 wm8994->revision = ret & WM8994_CHIP_REV_MASK; 447 wm8994->cust_id = (ret & WM8994_CUST_ID_MASK) >> WM8994_CUST_ID_SHIFT; 448 449 switch (wm8994->type) { 450 case WM8994: 451 switch (wm8994->revision) { 452 case 0: 453 case 1: 454 dev_warn(wm8994->dev, 455 "revision %c not fully supported\n", 456 'A' + wm8994->revision); 457 break; 458 case 2: 459 case 3: 460 default: 461 regmap_patch = wm8994_revc_patch; 462 patch_regs = ARRAY_SIZE(wm8994_revc_patch); 463 break; 464 } 465 break; 466 467 case WM8958: 468 switch (wm8994->revision) { 469 case 0: 470 regmap_patch = wm8958_reva_patch; 471 patch_regs = ARRAY_SIZE(wm8958_reva_patch); 472 break; 473 default: 474 break; 475 } 476 break; 477 478 case WM1811: 479 /* Revision C did not change the relevant layer */ 480 if (wm8994->revision > 1) 481 wm8994->revision++; 482 483 regmap_patch = wm1811_reva_patch; 484 patch_regs = ARRAY_SIZE(wm1811_reva_patch); 485 break; 486 487 default: 488 break; 489 } 490 491 dev_info(wm8994->dev, "%s revision %c CUST_ID %02x\n", devname, 492 'A' + wm8994->revision, wm8994->cust_id); 493 494 switch (wm8994->type) { 495 case WM1811: 496 regmap_config = &wm1811_regmap_config; 497 break; 498 case WM8994: 499 regmap_config = &wm8994_regmap_config; 500 break; 501 case WM8958: 502 regmap_config = &wm8958_regmap_config; 503 break; 504 default: 505 dev_err(wm8994->dev, "Unknown device type %d\n", wm8994->type); 506 return -EINVAL; 507 } 508 509 ret = regmap_reinit_cache(wm8994->regmap, regmap_config); 510 if (ret != 0) { 511 dev_err(wm8994->dev, "Failed to reinit register cache: %d\n", 512 ret); 513 return ret; 514 } 515 516 /* Explicitly put the device into reset in case regulators 517 * don't get disabled in order to ensure we know the device 518 * state. 519 */ 520 ret = wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET, 521 wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET)); 522 if (ret != 0) { 523 dev_err(wm8994->dev, "Failed to reset device: %d\n", ret); 524 return ret; 525 } 526 527 if (regmap_patch) { 528 ret = regmap_register_patch(wm8994->regmap, regmap_patch, 529 patch_regs); 530 if (ret != 0) { 531 dev_err(wm8994->dev, "Failed to register patch: %d\n", 532 ret); 533 goto err; 534 } 535 } 536 537 wm8994->irq_base = pdata->irq_base; 538 wm8994->gpio_base = pdata->gpio_base; 539 540 /* GPIO configuration is only applied if it's non-zero */ 541 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) { 542 if (pdata->gpio_defaults[i]) { 543 wm8994_set_bits(wm8994, WM8994_GPIO_1 + i, 544 0xffff, pdata->gpio_defaults[i]); 545 } 546 } 547 548 wm8994->ldo_ena_always_driven = pdata->ldo_ena_always_driven; 549 550 if (pdata->spkmode_pu) 551 pulls |= WM8994_SPKMODE_PU; 552 553 /* Disable unneeded pulls */ 554 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2, 555 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD | 556 WM8994_SPKMODE_PU | WM8994_CSNADDR_PD, 557 pulls); 558 559 /* In some system designs where the regulators are not in use, 560 * we can achieve a small reduction in leakage currents by 561 * floating LDO outputs. This bit makes no difference if the 562 * LDOs are enabled, it only affects cases where the LDOs were 563 * in operation and are then disabled. 564 */ 565 for (i = 0; i < WM8994_NUM_LDO_REGS; i++) { 566 if (wm8994_ldo_in_use(pdata, i)) 567 wm8994_set_bits(wm8994, WM8994_LDO_1 + i, 568 WM8994_LDO1_DISCH, WM8994_LDO1_DISCH); 569 else 570 wm8994_set_bits(wm8994, WM8994_LDO_1 + i, 571 WM8994_LDO1_DISCH, 0); 572 } 573 574 wm8994_irq_init(wm8994); 575 576 ret = mfd_add_devices(wm8994->dev, -1, 577 wm8994_devs, ARRAY_SIZE(wm8994_devs), 578 NULL, 0, NULL); 579 if (ret != 0) { 580 dev_err(wm8994->dev, "Failed to add children: %d\n", ret); 581 goto err_irq; 582 } 583 584 pm_runtime_enable(wm8994->dev); 585 pm_runtime_idle(wm8994->dev); 586 587 return 0; 588 589 err_irq: 590 wm8994_irq_exit(wm8994); 591 err_enable: 592 regulator_bulk_disable(wm8994->num_supplies, 593 wm8994->supplies); 594 err_regulator_free: 595 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies); 596 err: 597 mfd_remove_devices(wm8994->dev); 598 return ret; 599 } 600 601 static void wm8994_device_exit(struct wm8994 *wm8994) 602 { 603 pm_runtime_disable(wm8994->dev); 604 wm8994_irq_exit(wm8994); 605 regulator_bulk_disable(wm8994->num_supplies, wm8994->supplies); 606 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies); 607 mfd_remove_devices(wm8994->dev); 608 } 609 610 static const struct of_device_id wm8994_of_match[] = { 611 { .compatible = "wlf,wm1811", .data = (void *)WM1811 }, 612 { .compatible = "wlf,wm8994", .data = (void *)WM8994 }, 613 { .compatible = "wlf,wm8958", .data = (void *)WM8958 }, 614 { } 615 }; 616 MODULE_DEVICE_TABLE(of, wm8994_of_match); 617 618 static int wm8994_i2c_probe(struct i2c_client *i2c, 619 const struct i2c_device_id *id) 620 { 621 const struct of_device_id *of_id; 622 struct wm8994 *wm8994; 623 int ret; 624 625 wm8994 = devm_kzalloc(&i2c->dev, sizeof(struct wm8994), GFP_KERNEL); 626 if (wm8994 == NULL) 627 return -ENOMEM; 628 629 i2c_set_clientdata(i2c, wm8994); 630 wm8994->dev = &i2c->dev; 631 wm8994->irq = i2c->irq; 632 633 if (i2c->dev.of_node) { 634 of_id = of_match_device(wm8994_of_match, &i2c->dev); 635 if (of_id) 636 wm8994->type = (enum wm8994_type)of_id->data; 637 } else { 638 wm8994->type = id->driver_data; 639 } 640 641 wm8994->regmap = devm_regmap_init_i2c(i2c, &wm8994_base_regmap_config); 642 if (IS_ERR(wm8994->regmap)) { 643 ret = PTR_ERR(wm8994->regmap); 644 dev_err(wm8994->dev, "Failed to allocate register map: %d\n", 645 ret); 646 return ret; 647 } 648 649 return wm8994_device_init(wm8994, i2c->irq); 650 } 651 652 static int wm8994_i2c_remove(struct i2c_client *i2c) 653 { 654 struct wm8994 *wm8994 = i2c_get_clientdata(i2c); 655 656 wm8994_device_exit(wm8994); 657 658 return 0; 659 } 660 661 static const struct i2c_device_id wm8994_i2c_id[] = { 662 { "wm1811", WM1811 }, 663 { "wm1811a", WM1811 }, 664 { "wm8994", WM8994 }, 665 { "wm8958", WM8958 }, 666 { } 667 }; 668 MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id); 669 670 static const struct dev_pm_ops wm8994_pm_ops = { 671 SET_RUNTIME_PM_OPS(wm8994_suspend, wm8994_resume, NULL) 672 }; 673 674 static struct i2c_driver wm8994_i2c_driver = { 675 .driver = { 676 .name = "wm8994", 677 .pm = &wm8994_pm_ops, 678 .of_match_table = of_match_ptr(wm8994_of_match), 679 }, 680 .probe = wm8994_i2c_probe, 681 .remove = wm8994_i2c_remove, 682 .id_table = wm8994_i2c_id, 683 }; 684 685 module_i2c_driver(wm8994_i2c_driver); 686 687 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC"); 688 MODULE_LICENSE("GPL"); 689 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>"); 690