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 *wm1811_main_supplies[] = {
 171         "DBVDD1",
 172         "DBVDD2",
 173         "DBVDD3",
 174         "DCVDD",
 175         "AVDD1",
 176         "AVDD2",
 177         "CPVDD",
 178         "SPKVDD1",
 179         "SPKVDD2",
 180 };
 181
 182 static const char *wm8994_main_supplies[] = {
 183         "DBVDD",
 184         "DCVDD",
 185         "AVDD1",
 186         "AVDD2",
 187         "CPVDD",
 188         "SPKVDD1",
 189         "SPKVDD2",
 190 };
 191
 192 static const char *wm8958_main_supplies[] = {
 193         "DBVDD1",
 194         "DBVDD2",
 195         "DBVDD3",
 196         "DCVDD",
 197         "AVDD1",
 198         "AVDD2",
 199         "CPVDD",
 200         "SPKVDD1",
 201         "SPKVDD2",
 202 };
 203
 204 #ifdef CONFIG_PM
 205 static int wm8994_suspend(struct device *dev)
 206 {
 207         struct wm8994 *wm8994 = dev_get_drvdata(dev);
 208         int ret;
 209
 210         /* Don't actually go through with the suspend if the CODEC is
 211          * still active (eg, for audio passthrough from CP. */
 212         ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_1);
 213         if (ret < 0) {
 214                 dev_err(dev, "Failed to read power status: %d\n", ret);
 215         } else if (ret & WM8994_VMID_SEL_MASK) {
 216                 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
 217                 return 0;
 218         }
 219
 220         /* GPIO configuration state is saved here since we may be configuring
 221          * the GPIO alternate functions even if we're not using the gpiolib
 222          * driver for them.
 223          */
 224         ret = wm8994_read(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
 225                           &wm8994->gpio_regs);
 226         if (ret < 0)
 227                 dev_err(dev, "Failed to save GPIO registers: %d\n", ret);
 228
 229         /* For similar reasons we also stash the regulator states */
 230         ret = wm8994_read(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
 231                           &wm8994->ldo_regs);
 232         if (ret < 0)
 233                 dev_err(dev, "Failed to save LDO registers: %d\n", ret);
 234
 235         /* Explicitly put the device into reset in case regulators
 236          * don't get disabled in order to ensure consistent restart.
 237          */
 238         wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET, 0x8994);
 239
 240         wm8994->suspended = true;
 241
 242         ret = regulator_bulk_disable(wm8994->num_supplies,
 243                                      wm8994->supplies);
 244         if (ret != 0) {
 245                 dev_err(dev, "Failed to disable supplies: %d\n", ret);
 246                 return ret;
 247         }
 248
 249         return 0;
 250 }
 251
 252 static int wm8994_resume(struct device *dev)
 253 {
 254         struct wm8994 *wm8994 = dev_get_drvdata(dev);
 255         int ret, i;
 256
 257         /* We may have lied to the PM core about suspending */
 258         if (!wm8994->suspended)
 259                 return 0;
 260
 261         ret = regulator_bulk_enable(wm8994->num_supplies,
 262                                     wm8994->supplies);
 263         if (ret != 0) {
 264                 dev_err(dev, "Failed to enable supplies: %d\n", ret);
 265                 return ret;
 266         }
 267
 268         /* Write register at a time as we use the cache on the CPU so store
 269          * it in native endian.
 270          */
 271         for (i = 0; i < ARRAY_SIZE(wm8994->irq_masks_cur); i++) {
 272                 ret = wm8994_reg_write(wm8994, WM8994_INTERRUPT_STATUS_1_MASK
 273                                        + i, wm8994->irq_masks_cur[i]);
 274                 if (ret < 0)
 275                         dev_err(dev, "Failed to restore interrupt masks: %d\n",
 276                                 ret);
 277         }
 278
 279         ret = wm8994_write(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
 280                            &wm8994->ldo_regs);
 281         if (ret < 0)
 282                 dev_err(dev, "Failed to restore LDO registers: %d\n", ret);
 283
 284         ret = wm8994_write(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
 285                            &wm8994->gpio_regs);
 286         if (ret < 0)
 287                 dev_err(dev, "Failed to restore GPIO registers: %d\n", ret);
 288
 289         wm8994->suspended = false;
 290
 291         return 0;
 292 }
 293 #endif
 294
 295 #ifdef CONFIG_REGULATOR
 296 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
 297 {
 298         struct wm8994_ldo_pdata *ldo_pdata;
 299
 300         if (!pdata)
 301                 return 0;
 302
 303         ldo_pdata = &pdata->ldo[ldo];
 304
 305         if (!ldo_pdata->init_data)
 306                 return 0;
 307
 308         return ldo_pdata->init_data->num_consumer_supplies != 0;
 309 }
 310 #else
 311 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
 312 {
 313         return 0;
 314 }
 315 #endif
 316
 317 static struct regmap_config wm8994_regmap_config = {
 318         .reg_bits = 16,
 319         .val_bits = 16,
 320 };
 321
 322 /*
 323  * Instantiate the generic non-control parts of the device.
 324  */
 325 static int wm8994_device_init(struct wm8994 *wm8994, int irq)
 326 {
 327         struct wm8994_pdata *pdata = wm8994->dev->platform_data;
 328         const char *devname;
 329         int ret, i;
 330
 331         dev_set_drvdata(wm8994->dev, wm8994);
 332
 333         /* Add the on-chip regulators first for bootstrapping */
 334         ret = mfd_add_devices(wm8994->dev, -1,
 335                               wm8994_regulator_devs,
 336                               ARRAY_SIZE(wm8994_regulator_devs),
 337                               NULL, 0);
 338         if (ret != 0) {
 339                 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
 340                 goto err_regmap;
 341         }
 342
 343         switch (wm8994->type) {
 344         case WM1811:
 345                 wm8994->num_supplies = ARRAY_SIZE(wm1811_main_supplies);
 346                 break;
 347         case WM8994:
 348                 wm8994->num_supplies = ARRAY_SIZE(wm8994_main_supplies);
 349                 break;
 350         case WM8958:
 351                 wm8994->num_supplies = ARRAY_SIZE(wm8958_main_supplies);
 352                 break;
 353         default:
 354                 BUG();
 355                 goto err_regmap;
 356         }
 357
 358         wm8994->supplies = kzalloc(sizeof(struct regulator_bulk_data) *
 359                                    wm8994->num_supplies,
 360                                    GFP_KERNEL);
 361         if (!wm8994->supplies) {
 362                 ret = -ENOMEM;
 363                 goto err_regmap;
 364         }
 365
 366         switch (wm8994->type) {
 367         case WM1811:
 368                 for (i = 0; i < ARRAY_SIZE(wm1811_main_supplies); i++)
 369                         wm8994->supplies[i].supply = wm1811_main_supplies[i];
 370                 break;
 371         case WM8994:
 372                 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
 373                         wm8994->supplies[i].supply = wm8994_main_supplies[i];
 374                 break;
 375         case WM8958:
 376                 for (i = 0; i < ARRAY_SIZE(wm8958_main_supplies); i++)
 377                         wm8994->supplies[i].supply = wm8958_main_supplies[i];
 378                 break;
 379         default:
 380                 BUG();
 381                 goto err_regmap;
 382         }
 383
 384         ret = regulator_bulk_get(wm8994->dev, wm8994->num_supplies,
 385                                  wm8994->supplies);
 386         if (ret != 0) {
 387                 dev_err(wm8994->dev, "Failed to get supplies: %d\n", ret);
 388                 goto err_supplies;
 389         }
 390
 391         ret = regulator_bulk_enable(wm8994->num_supplies,
 392                                     wm8994->supplies);
 393         if (ret != 0) {
 394                 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
 395                 goto err_get;
 396         }
 397
 398         ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
 399         if (ret < 0) {
 400                 dev_err(wm8994->dev, "Failed to read ID register\n");
 401                 goto err_enable;
 402         }
 403         switch (ret) {
 404         case 0x1811:
 405                 devname = "WM1811";
 406                 if (wm8994->type != WM1811)
 407                         dev_warn(wm8994->dev, "Device registered as type %d\n",
 408                                  wm8994->type);
 409                 wm8994->type = WM1811;
 410                 break;
 411         case 0x8994:
 412                 devname = "WM8994";
 413                 if (wm8994->type != WM8994)
 414                         dev_warn(wm8994->dev, "Device registered as type %d\n",
 415                                  wm8994->type);
 416                 wm8994->type = WM8994;
 417                 break;
 418         case 0x8958:
 419                 devname = "WM8958";
 420                 if (wm8994->type != WM8958)
 421                         dev_warn(wm8994->dev, "Device registered as type %d\n",
 422                                  wm8994->type);
 423                 wm8994->type = WM8958;
 424                 break;
 425         default:
 426                 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
 427                         ret);
 428                 ret = -EINVAL;
 429                 goto err_enable;
 430         }
 431
 432         ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
 433         if (ret < 0) {
 434                 dev_err(wm8994->dev, "Failed to read revision register: %d\n",
 435                         ret);
 436                 goto err_enable;
 437         }
 438
 439         switch (wm8994->type) {
 440         case WM8994:
 441                 switch (ret) {
 442                 case 0:
 443                 case 1:
 444                         dev_warn(wm8994->dev,
 445                                  "revision %c not fully supported\n",
 446                                  'A' + ret);
 447                         break;
 448                 default:
 449                         break;
 450                 }
 451                 break;
 452         default:
 453                 break;
 454         }
 455
 456         dev_info(wm8994->dev, "%s revision %c\n", devname, 'A' + ret);
 457
 458         if (pdata) {
 459                 wm8994->irq_base = pdata->irq_base;
 460                 wm8994->gpio_base = pdata->gpio_base;
 461
 462                 /* GPIO configuration is only applied if it's non-zero */
 463                 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
 464                         if (pdata->gpio_defaults[i]) {
 465                                 wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
 466                                                 0xffff,
 467                                                 pdata->gpio_defaults[i]);
 468                         }
 469                 }
 470         }
 471
 472         /* In some system designs where the regulators are not in use,
 473          * we can achieve a small reduction in leakage currents by
 474          * floating LDO outputs.  This bit makes no difference if the
 475          * LDOs are enabled, it only affects cases where the LDOs were
 476          * in operation and are then disabled.
 477          */
 478         for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
 479                 if (wm8994_ldo_in_use(pdata, i))
 480                         wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
 481                                         WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
 482                 else
 483                         wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
 484                                         WM8994_LDO1_DISCH, 0);
 485         }
 486
 487         wm8994_irq_init(wm8994);
 488
 489         ret = mfd_add_devices(wm8994->dev, -1,
 490                               wm8994_devs, ARRAY_SIZE(wm8994_devs),
 491                               NULL, 0);
 492         if (ret != 0) {
 493                 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
 494                 goto err_irq;
 495         }
 496
 497         pm_runtime_enable(wm8994->dev);
 498         pm_runtime_resume(wm8994->dev);
 499
 500         return 0;
 501
 502 err_irq:
 503         wm8994_irq_exit(wm8994);
 504 err_enable:
 505         regulator_bulk_disable(wm8994->num_supplies,
 506                                wm8994->supplies);
 507 err_get:
 508         regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
 509 err_supplies:
 510         kfree(wm8994->supplies);
 511 err_regmap:
 512         regmap_exit(wm8994->regmap);
 513         mfd_remove_devices(wm8994->dev);
 514         kfree(wm8994);
 515         return ret;
 516 }
 517
 518 static void wm8994_device_exit(struct wm8994 *wm8994)
 519 {
 520         pm_runtime_disable(wm8994->dev);
 521         mfd_remove_devices(wm8994->dev);
 522         wm8994_irq_exit(wm8994);
 523         regulator_bulk_disable(wm8994->num_supplies,
 524                                wm8994->supplies);
 525         regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
 526         kfree(wm8994->supplies);
 527         regmap_exit(wm8994->regmap);
 528         kfree(wm8994);
 529 }
 530
 531 static int wm8994_i2c_probe(struct i2c_client *i2c,
 532                             const struct i2c_device_id *id)
 533 {
 534         struct wm8994 *wm8994;
 535         int ret;
 536
 537         wm8994 = kzalloc(sizeof(struct wm8994), GFP_KERNEL);
 538         if (wm8994 == NULL)
 539                 return -ENOMEM;
 540
 541         i2c_set_clientdata(i2c, wm8994);
 542         wm8994->dev = &i2c->dev;
 543         wm8994->irq = i2c->irq;
 544         wm8994->type = id->driver_data;
 545
 546         wm8994->regmap = regmap_init_i2c(i2c, &wm8994_regmap_config);
 547         if (IS_ERR(wm8994->regmap)) {
 548                 ret = PTR_ERR(wm8994->regmap);
 549                 dev_err(wm8994->dev, "Failed to allocate register map: %d\n",
 550                         ret);
 551                 kfree(wm8994);
 552                 return ret;
 553         }
 554
 555         return wm8994_device_init(wm8994, i2c->irq);
 556 }
 557
 558 static int wm8994_i2c_remove(struct i2c_client *i2c)
 559 {
 560         struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
 561
 562         wm8994_device_exit(wm8994);
 563
 564         return 0;
 565 }
 566
 567 static const struct i2c_device_id wm8994_i2c_id[] = {
 568         { "wm1811", WM1811 },
 569         { "wm8994", WM8994 },
 570         { "wm8958", WM8958 },
 571         { }
 572 };
 573 MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
 574
 575 static UNIVERSAL_DEV_PM_OPS(wm8994_pm_ops, wm8994_suspend, wm8994_resume,
 576                             NULL);
 577
 578 static struct i2c_driver wm8994_i2c_driver = {
 579         .driver = {
 580                 .name = "wm8994",
 581                 .owner = THIS_MODULE,
 582                 .pm = &wm8994_pm_ops,
 583         },
 584         .probe = wm8994_i2c_probe,
 585         .remove = wm8994_i2c_remove,
 586         .id_table = wm8994_i2c_id,
 587 };
 588
 589 static int __init wm8994_i2c_init(void)
 590 {
 591         int ret;
 592
 593         ret = i2c_add_driver(&wm8994_i2c_driver);
 594         if (ret != 0)
 595                 pr_err("Failed to register wm8994 I2C driver: %d\n", ret);
 596
 597         return ret;
 598 }
 599 module_init(wm8994_i2c_init);
 600
 601 static void __exit wm8994_i2c_exit(void)
 602 {
 603         i2c_del_driver(&wm8994_i2c_driver);
 604 }
 605 module_exit(wm8994_i2c_exit);
 606
 607 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
 608 MODULE_LICENSE("GPL");
 609 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");