drivers/mfd/wm8994-core.c

   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/pm_runtime.h>
  23 #include <linux/regmap.h>
  24 #include <linux/regulator/consumer.h>
  25 #include <linux/regulator/machine.h>
  26
  27 #include <linux/mfd/wm8994/core.h>
  28 #include <linux/mfd/wm8994/pdata.h>
  29 #include <linux/mfd/wm8994/registers.h>
  30
  31 static int wm8994_read(struct wm8994 *wm8994, unsigned short reg,
  32                        int bytes, void *dest)
  33 {
  34         return regmap_raw_read(wm8994->regmap, reg, dest, bytes);
  35 }
  36
  37 /**
  38  * wm8994_reg_read: Read a single WM8994 register.
  39  *
  40  * @wm8994: Device to read from.
  41  * @reg: Register to read.
  42  */
  43 int wm8994_reg_read(struct wm8994 *wm8994, unsigned short reg)
  44 {
  45         unsigned int val;
  46         int ret;
  47
  48         ret = regmap_read(wm8994->regmap, reg, &val);
  49
  50         if (ret < 0)
  51                 return ret;
  52         else
  53                 return val;
  54 }
  55 EXPORT_SYMBOL_GPL(wm8994_reg_read);
  56
  57 /**
  58  * wm8994_bulk_read: Read multiple WM8994 registers
  59  *
  60  * @wm8994: Device to read from
  61  * @reg: First register
  62  * @count: Number of registers
  63  * @buf: Buffer to fill.  The data will be returned big endian.
  64  */
  65 int wm8994_bulk_read(struct wm8994 *wm8994, unsigned short reg,
  66                      int count, u16 *buf)
  67 {
  68         return regmap_bulk_read(wm8994->regmap, reg, buf, count);
  69 }
  70
  71 static int wm8994_write(struct wm8994 *wm8994, unsigned short reg,
  72                         int bytes, const void *src)
  73 {
  74         return regmap_raw_write(wm8994->regmap, reg, src, bytes);
  75 }
  76
  77 /**
  78  * wm8994_reg_write: Write a single WM8994 register.
  79  *
  80  * @wm8994: Device to write to.
  81  * @reg: Register to write to.
  82  * @val: Value to write.
  83  */
  84 int wm8994_reg_write(struct wm8994 *wm8994, unsigned short reg,
  85                      unsigned short val)
  86 {
  87         return regmap_write(wm8994->regmap, reg, val);
  88 }
  89 EXPORT_SYMBOL_GPL(wm8994_reg_write);
  90
  91 /**
  92  * wm8994_bulk_write: Write multiple WM8994 registers
  93  *
  94  * @wm8994: Device to write to
  95  * @reg: First register
  96  * @count: Number of registers
  97  * @buf: Buffer to write from.  Data must be big-endian formatted.
  98  */
  99 int wm8994_bulk_write(struct wm8994 *wm8994, unsigned short reg,
 100                       int count, const u16 *buf)
 101 {
 102         return regmap_raw_write(wm8994->regmap, reg, buf, count * sizeof(u16));
 103 }
 104 EXPORT_SYMBOL_GPL(wm8994_bulk_write);
 105
 106 /**
 107  * wm8994_set_bits: Set the value of a bitfield in a WM8994 register
 108  *
 109  * @wm8994: Device to write to.
 110  * @reg: Register to write to.
 111  * @mask: Mask of bits to set.
 112  * @val: Value to set (unshifted)
 113  */
 114 int wm8994_set_bits(struct wm8994 *wm8994, unsigned short reg,
 115                     unsigned short mask, unsigned short val)
 116 {
 117         return regmap_update_bits(wm8994->regmap, reg, mask, val);
 118 }
 119 EXPORT_SYMBOL_GPL(wm8994_set_bits);
 120
 121 static struct mfd_cell wm8994_regulator_devs[] = {
 122         {
 123                 .name = "wm8994-ldo",
 124                 .id = 1,
 125                 .pm_runtime_no_callbacks = true,
 126         },
 127         {
 128                 .name = "wm8994-ldo",
 129                 .id = 2,
 130                 .pm_runtime_no_callbacks = true,
 131         },
 132 };
 133
 134 static struct resource wm8994_codec_resources[] = {
 135         {
 136                 .start = WM8994_IRQ_TEMP_SHUT,
 137                 .end   = WM8994_IRQ_TEMP_WARN,
 138                 .flags = IORESOURCE_IRQ,
 139         },
 140 };
 141
 142 static struct resource wm8994_gpio_resources[] = {
 143         {
 144                 .start = WM8994_IRQ_GPIO(1),
 145                 .end   = WM8994_IRQ_GPIO(11),
 146                 .flags = IORESOURCE_IRQ,
 147         },
 148 };
 149
 150 static struct mfd_cell wm8994_devs[] = {
 151         {
 152                 .name = "wm8994-codec",
 153                 .num_resources = ARRAY_SIZE(wm8994_codec_resources),
 154                 .resources = wm8994_codec_resources,
 155         },
 156
 157         {
 158                 .name = "wm8994-gpio",
 159                 .num_resources = ARRAY_SIZE(wm8994_gpio_resources),
 160                 .resources = wm8994_gpio_resources,
 161                 .pm_runtime_no_callbacks = true,
 162         },
 163 };
 164
 165 /*
 166  * Supplies for the main bulk of CODEC; the LDO supplies are ignored
 167  * and should be handled via the standard regulator API supply
 168  * management.
 169  */
 170 static const char *wm8994_main_supplies[] = {
 171         "DBVDD",
 172         "DCVDD",
 173         "AVDD1",
 174         "AVDD2",
 175         "CPVDD",
 176         "SPKVDD1",
 177         "SPKVDD2",
 178 };
 179
 180 static const char *wm8958_main_supplies[] = {
 181         "DBVDD1",
 182         "DBVDD2",
 183         "DBVDD3",
 184         "DCVDD",
 185         "AVDD1",
 186         "AVDD2",
 187         "CPVDD",
 188         "SPKVDD1",
 189         "SPKVDD2",
 190 };
 191
 192 #ifdef CONFIG_PM
 193 static int wm8994_suspend(struct device *dev)
 194 {
 195         struct wm8994 *wm8994 = dev_get_drvdata(dev);
 196         int ret;
 197
 198         /* Don't actually go through with the suspend if the CODEC is
 199          * still active (eg, for audio passthrough from CP. */
 200         ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_1);
 201         if (ret < 0) {
 202                 dev_err(dev, "Failed to read power status: %d\n", ret);
 203         } else if (ret & WM8994_VMID_SEL_MASK) {
 204                 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
 205                 return 0;
 206         }
 207
 208         ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_4);
 209         if (ret < 0) {
 210                 dev_err(dev, "Failed to read power status: %d\n", ret);
 211         } else if (ret & (WM8994_AIF2ADCL_ENA | WM8994_AIF2ADCR_ENA |
 212                           WM8994_AIF1ADC2L_ENA | WM8994_AIF1ADC2R_ENA |
 213                           WM8994_AIF1ADC1L_ENA | WM8994_AIF1ADC1R_ENA)) {
 214                 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
 215                 return 0;
 216         }
 217
 218         ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_5);
 219         if (ret < 0) {
 220                 dev_err(dev, "Failed to read power status: %d\n", ret);
 221         } else if (ret & (WM8994_AIF2DACL_ENA | WM8994_AIF2DACR_ENA |
 222                           WM8994_AIF1DAC2L_ENA | WM8994_AIF1DAC2R_ENA |
 223                           WM8994_AIF1DAC1L_ENA | WM8994_AIF1DAC1R_ENA)) {
 224                 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
 225                 return 0;
 226         }
 227
 228         switch (wm8994->type) {
 229         case WM8958:
 230                 ret = wm8994_reg_read(wm8994, WM8958_MIC_DETECT_1);
 231                 if (ret < 0) {
 232                         dev_err(dev, "Failed to read power status: %d\n", ret);
 233                 } else if (ret & WM8958_MICD_ENA) {
 234                         dev_dbg(dev, "CODEC still active, ignoring suspend\n");
 235                         return 0;
 236                 }
 237                 break;
 238         default:
 239                 break;
 240         }
 241
 242         /* Disable LDO pulldowns while the device is suspended if we
 243          * don't know that something will be driving them. */
 244         if (!wm8994->ldo_ena_always_driven)
 245                 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
 246                                 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
 247                                 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD);
 248
 249         /* GPIO configuration state is saved here since we may be configuring
 250          * the GPIO alternate functions even if we're not using the gpiolib
 251          * driver for them.
 252          */
 253         ret = wm8994_read(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
 254                           &wm8994->gpio_regs);
 255         if (ret < 0)
 256                 dev_err(dev, "Failed to save GPIO registers: %d\n", ret);
 257
 258         /* For similar reasons we also stash the regulator states */
 259         ret = wm8994_read(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
 260                           &wm8994->ldo_regs);
 261         if (ret < 0)
 262                 dev_err(dev, "Failed to save LDO registers: %d\n", ret);
 263
 264         /* Explicitly put the device into reset in case regulators
 265          * don't get disabled in order to ensure consistent restart.
 266          */
 267         wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET, 0x8994);
 268
 269         wm8994->suspended = true;
 270
 271         ret = regulator_bulk_disable(wm8994->num_supplies,
 272                                      wm8994->supplies);
 273         if (ret != 0) {
 274                 dev_err(dev, "Failed to disable supplies: %d\n", ret);
 275                 return ret;
 276         }
 277
 278         return 0;
 279 }
 280
 281 static int wm8994_resume(struct device *dev)
 282 {
 283         struct wm8994 *wm8994 = dev_get_drvdata(dev);
 284         int ret, i;
 285
 286         /* We may have lied to the PM core about suspending */
 287         if (!wm8994->suspended)
 288                 return 0;
 289
 290         ret = regulator_bulk_enable(wm8994->num_supplies,
 291                                     wm8994->supplies);
 292         if (ret != 0) {
 293                 dev_err(dev, "Failed to enable supplies: %d\n", ret);
 294                 return ret;
 295         }
 296
 297         /* Write register at a time as we use the cache on the CPU so store
 298          * it in native endian.
 299          */
 300         for (i = 0; i < ARRAY_SIZE(wm8994->irq_masks_cur); i++) {
 301                 ret = wm8994_reg_write(wm8994, WM8994_INTERRUPT_STATUS_1_MASK
 302                                        + i, wm8994->irq_masks_cur[i]);
 303                 if (ret < 0)
 304                         dev_err(dev, "Failed to restore interrupt masks: %d\n",
 305                                 ret);
 306         }
 307
 308         ret = wm8994_write(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
 309                            &wm8994->ldo_regs);
 310         if (ret < 0)
 311                 dev_err(dev, "Failed to restore LDO registers: %d\n", ret);
 312
 313         ret = wm8994_write(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
 314                            &wm8994->gpio_regs);
 315         if (ret < 0)
 316                 dev_err(dev, "Failed to restore GPIO registers: %d\n", ret);
 317
 318         /* Disable LDO pulldowns while the device is active */
 319         wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
 320                         WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
 321                         0);
 322
 323         wm8994->suspended = false;
 324
 325         return 0;
 326 }
 327 #endif
 328
 329 #ifdef CONFIG_REGULATOR
 330 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
 331 {
 332         struct wm8994_ldo_pdata *ldo_pdata;
 333
 334         if (!pdata)
 335                 return 0;
 336
 337         ldo_pdata = &pdata->ldo[ldo];
 338
 339         if (!ldo_pdata->init_data)
 340                 return 0;
 341
 342         return ldo_pdata->init_data->num_consumer_supplies != 0;
 343 }
 344 #else
 345 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
 346 {
 347         return 0;
 348 }
 349 #endif
 350
 351 static struct regmap_config wm8994_regmap_config = {
 352         .reg_bits = 16,
 353         .val_bits = 16,
 354 };
 355
 356 /*
 357  * Instantiate the generic non-control parts of the device.
 358  */
 359 static int wm8994_device_init(struct wm8994 *wm8994, int irq)
 360 {
 361         struct wm8994_pdata *pdata = wm8994->dev->platform_data;
 362         const char *devname;
 363         int ret, i;
 364
 365         dev_set_drvdata(wm8994->dev, wm8994);
 366
 367         /* Add the on-chip regulators first for bootstrapping */
 368         ret = mfd_add_devices(wm8994->dev, -1,
 369                               wm8994_regulator_devs,
 370                               ARRAY_SIZE(wm8994_regulator_devs),
 371                               NULL, 0);
 372         if (ret != 0) {
 373                 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
 374                 goto err_regmap;
 375         }
 376
 377         switch (wm8994->type) {
 378         case WM8994:
 379                 wm8994->num_supplies = ARRAY_SIZE(wm8994_main_supplies);
 380                 break;
 381         case WM8958:
 382                 wm8994->num_supplies = ARRAY_SIZE(wm8958_main_supplies);
 383                 break;
 384         default:
 385                 BUG();
 386                 goto err_regmap;
 387         }
 388
 389         wm8994->supplies = kzalloc(sizeof(struct regulator_bulk_data) *
 390                                    wm8994->num_supplies,
 391                                    GFP_KERNEL);
 392         if (!wm8994->supplies) {
 393                 ret = -ENOMEM;
 394                 goto err_regmap;
 395         }
 396
 397         switch (wm8994->type) {
 398         case WM8994:
 399                 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
 400                         wm8994->supplies[i].supply = wm8994_main_supplies[i];
 401                 break;
 402         case WM8958:
 403                 for (i = 0; i < ARRAY_SIZE(wm8958_main_supplies); i++)
 404                         wm8994->supplies[i].supply = wm8958_main_supplies[i];
 405                 break;
 406         default:
 407                 BUG();
 408                 goto err_regmap;
 409         }
 410
 411         ret = regulator_bulk_get(wm8994->dev, wm8994->num_supplies,
 412                                  wm8994->supplies);
 413         if (ret != 0) {
 414                 dev_err(wm8994->dev, "Failed to get supplies: %d\n", ret);
 415                 goto err_supplies;
 416         }
 417
 418         ret = regulator_bulk_enable(wm8994->num_supplies,
 419                                     wm8994->supplies);
 420         if (ret != 0) {
 421                 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
 422                 goto err_get;
 423         }
 424
 425         ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
 426         if (ret < 0) {
 427                 dev_err(wm8994->dev, "Failed to read ID register\n");
 428                 goto err_enable;
 429         }
 430         switch (ret) {
 431         case 0x8994:
 432                 devname = "WM8994";
 433                 if (wm8994->type != WM8994)
 434                         dev_warn(wm8994->dev, "Device registered as type %d\n",
 435                                  wm8994->type);
 436                 wm8994->type = WM8994;
 437                 break;
 438         case 0x8958:
 439                 devname = "WM8958";
 440                 if (wm8994->type != WM8958)
 441                         dev_warn(wm8994->dev, "Device registered as type %d\n",
 442                                  wm8994->type);
 443                 wm8994->type = WM8958;
 444                 break;
 445         default:
 446                 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
 447                         ret);
 448                 ret = -EINVAL;
 449                 goto err_enable;
 450         }
 451
 452         ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
 453         if (ret < 0) {
 454                 dev_err(wm8994->dev, "Failed to read revision register: %d\n",
 455                         ret);
 456                 goto err_enable;
 457         }
 458
 459         switch (wm8994->type) {
 460         case WM8994:
 461                 switch (ret) {
 462                 case 0:
 463                 case 1:
 464                         dev_warn(wm8994->dev,
 465                                  "revision %c not fully supported\n",
 466                                  'A' + ret);
 467                         break;
 468                 default:
 469                         break;
 470                 }
 471                 break;
 472         default:
 473                 break;
 474         }
 475
 476         dev_info(wm8994->dev, "%s revision %c\n", devname, 'A' + ret);
 477
 478         if (pdata) {
 479                 wm8994->irq_base = pdata->irq_base;
 480                 wm8994->gpio_base = pdata->gpio_base;
 481
 482                 /* GPIO configuration is only applied if it's non-zero */
 483                 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
 484                         if (pdata->gpio_defaults[i]) {
 485                                 wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
 486                                                 0xffff,
 487                                                 pdata->gpio_defaults[i]);
 488                         }
 489                 }
 490
 491                 wm8994->ldo_ena_always_driven = pdata->ldo_ena_always_driven;
 492         }
 493
 494         /* Disable LDO pulldowns while the device is active */
 495         wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
 496                         WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
 497                         0);
 498
 499         /* In some system designs where the regulators are not in use,
 500          * we can achieve a small reduction in leakage currents by
 501          * floating LDO outputs.  This bit makes no difference if the
 502          * LDOs are enabled, it only affects cases where the LDOs were
 503          * in operation and are then disabled.
 504          */
 505         for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
 506                 if (wm8994_ldo_in_use(pdata, i))
 507                         wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
 508                                         WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
 509                 else
 510                         wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
 511                                         WM8994_LDO1_DISCH, 0);
 512         }
 513
 514         wm8994_irq_init(wm8994);
 515
 516         ret = mfd_add_devices(wm8994->dev, -1,
 517                               wm8994_devs, ARRAY_SIZE(wm8994_devs),
 518                               NULL, 0);
 519         if (ret != 0) {
 520                 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
 521                 goto err_irq;
 522         }
 523
 524         pm_runtime_enable(wm8994->dev);
 525         pm_runtime_resume(wm8994->dev);
 526
 527         return 0;
 528
 529 err_irq:
 530         wm8994_irq_exit(wm8994);
 531 err_enable:
 532         regulator_bulk_disable(wm8994->num_supplies,
 533                                wm8994->supplies);
 534 err_get:
 535         regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
 536 err_supplies:
 537         kfree(wm8994->supplies);
 538 err_regmap:
 539         regmap_exit(wm8994->regmap);
 540         mfd_remove_devices(wm8994->dev);
 541         kfree(wm8994);
 542         return ret;
 543 }
 544
 545 static void wm8994_device_exit(struct wm8994 *wm8994)
 546 {
 547         pm_runtime_disable(wm8994->dev);
 548         mfd_remove_devices(wm8994->dev);
 549         wm8994_irq_exit(wm8994);
 550         regulator_bulk_disable(wm8994->num_supplies,
 551                                wm8994->supplies);
 552         regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
 553         kfree(wm8994->supplies);
 554         regmap_exit(wm8994->regmap);
 555         kfree(wm8994);
 556 }
 557
 558 static int wm8994_i2c_probe(struct i2c_client *i2c,
 559                             const struct i2c_device_id *id)
 560 {
 561         struct wm8994 *wm8994;
 562         int ret;
 563
 564         wm8994 = kzalloc(sizeof(struct wm8994), GFP_KERNEL);
 565         if (wm8994 == NULL)
 566                 return -ENOMEM;
 567
 568         i2c_set_clientdata(i2c, wm8994);
 569         wm8994->dev = &i2c->dev;
 570         wm8994->irq = i2c->irq;
 571         wm8994->type = id->driver_data;
 572
 573         wm8994->regmap = regmap_init_i2c(i2c, &wm8994_regmap_config);
 574         if (IS_ERR(wm8994->regmap)) {
 575                 ret = PTR_ERR(wm8994->regmap);
 576                 dev_err(wm8994->dev, "Failed to allocate register map: %d\n",
 577                         ret);
 578                 kfree(wm8994);
 579                 return ret;
 580         }
 581
 582         return wm8994_device_init(wm8994, i2c->irq);
 583 }
 584
 585 static int wm8994_i2c_remove(struct i2c_client *i2c)
 586 {
 587         struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
 588
 589         wm8994_device_exit(wm8994);
 590
 591         return 0;
 592 }
 593
 594 static const struct i2c_device_id wm8994_i2c_id[] = {
 595         { "wm8994", WM8994 },
 596         { "wm8958", WM8958 },
 597         { }
 598 };
 599 MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
 600
 601 static UNIVERSAL_DEV_PM_OPS(wm8994_pm_ops, wm8994_suspend, wm8994_resume,
 602                             NULL);
 603
 604 static struct i2c_driver wm8994_i2c_driver = {
 605         .driver = {
 606                 .name = "wm8994",
 607                 .owner = THIS_MODULE,
 608                 .pm = &wm8994_pm_ops,
 609         },
 610         .probe = wm8994_i2c_probe,
 611         .remove = wm8994_i2c_remove,
 612         .id_table = wm8994_i2c_id,
 613 };
 614
 615 static int __init wm8994_i2c_init(void)
 616 {
 617         int ret;
 618
 619         ret = i2c_add_driver(&wm8994_i2c_driver);
 620         if (ret != 0)
 621                 pr_err("Failed to register wm8994 I2C driver: %d\n", ret);
 622
 623         return ret;
 624 }
 625 module_init(wm8994_i2c_init);
 626
 627 static void __exit wm8994_i2c_exit(void)
 628 {
 629         i2c_del_driver(&wm8994_i2c_driver);
 630 }
 631 module_exit(wm8994_i2c_exit);
 632
 633 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
 634 MODULE_LICENSE("GPL");
 635 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");