2 * wm8994-core.c -- Device access for Wolfson WM8994
4 * Copyright 2009 Wolfson Microelectronics PLC.
6 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
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.
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>
27 #include <linux/mfd/wm8994/core.h>
28 #include <linux/mfd/wm8994/pdata.h>
29 #include <linux/mfd/wm8994/registers.h>
31 static int wm8994_read(struct wm8994 *wm8994, unsigned short reg,
32 int bytes, void *dest)
34 return regmap_raw_read(wm8994->regmap, reg, dest, bytes);
38 * wm8994_reg_read: Read a single WM8994 register.
40 * @wm8994: Device to read from.
41 * @reg: Register to read.
43 int wm8994_reg_read(struct wm8994 *wm8994, unsigned short reg)
48 ret = regmap_read(wm8994->regmap, reg, &val);
55 EXPORT_SYMBOL_GPL(wm8994_reg_read);
58 * wm8994_bulk_read: Read multiple WM8994 registers
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.
65 int wm8994_bulk_read(struct wm8994 *wm8994, unsigned short reg,
68 return regmap_bulk_read(wm8994->regmap, reg, buf, count);
71 static int wm8994_write(struct wm8994 *wm8994, unsigned short reg,
72 int bytes, const void *src)
74 return regmap_raw_write(wm8994->regmap, reg, src, bytes);
78 * wm8994_reg_write: Write a single WM8994 register.
80 * @wm8994: Device to write to.
81 * @reg: Register to write to.
82 * @val: Value to write.
84 int wm8994_reg_write(struct wm8994 *wm8994, unsigned short reg,
87 return regmap_write(wm8994->regmap, reg, val);
89 EXPORT_SYMBOL_GPL(wm8994_reg_write);
92 * wm8994_bulk_write: Write multiple WM8994 registers
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.
99 int wm8994_bulk_write(struct wm8994 *wm8994, unsigned short reg,
100 int count, const u16 *buf)
102 return regmap_raw_write(wm8994->regmap, reg, buf, count * sizeof(u16));
104 EXPORT_SYMBOL_GPL(wm8994_bulk_write);
107 * wm8994_set_bits: Set the value of a bitfield in a WM8994 register
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)
114 int wm8994_set_bits(struct wm8994 *wm8994, unsigned short reg,
115 unsigned short mask, unsigned short val)
117 return regmap_update_bits(wm8994->regmap, reg, mask, val);
119 EXPORT_SYMBOL_GPL(wm8994_set_bits);
121 static struct mfd_cell wm8994_regulator_devs[] = {
123 .name = "wm8994-ldo",
125 .pm_runtime_no_callbacks = true,
128 .name = "wm8994-ldo",
130 .pm_runtime_no_callbacks = true,
134 static struct resource wm8994_codec_resources[] = {
136 .start = WM8994_IRQ_TEMP_SHUT,
137 .end = WM8994_IRQ_TEMP_WARN,
138 .flags = IORESOURCE_IRQ,
142 static struct resource wm8994_gpio_resources[] = {
144 .start = WM8994_IRQ_GPIO(1),
145 .end = WM8994_IRQ_GPIO(11),
146 .flags = IORESOURCE_IRQ,
150 static struct mfd_cell wm8994_devs[] = {
152 .name = "wm8994-codec",
153 .num_resources = ARRAY_SIZE(wm8994_codec_resources),
154 .resources = wm8994_codec_resources,
158 .name = "wm8994-gpio",
159 .num_resources = ARRAY_SIZE(wm8994_gpio_resources),
160 .resources = wm8994_gpio_resources,
161 .pm_runtime_no_callbacks = true,
166 * Supplies for the main bulk of CODEC; the LDO supplies are ignored
167 * and should be handled via the standard regulator API supply
170 static const char *wm8994_main_supplies[] = {
180 static const char *wm8958_main_supplies[] = {
193 static int wm8994_suspend(struct device *dev)
195 struct wm8994 *wm8994 = dev_get_drvdata(dev);
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);
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");
208 ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_4);
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");
218 ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_5);
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");
228 switch (wm8994->type) {
230 ret = wm8994_reg_read(wm8994, WM8958_MIC_DETECT_1);
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");
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);
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
253 ret = wm8994_read(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
256 dev_err(dev, "Failed to save GPIO registers: %d\n", ret);
258 /* For similar reasons we also stash the regulator states */
259 ret = wm8994_read(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
262 dev_err(dev, "Failed to save LDO registers: %d\n", ret);
264 /* Explicitly put the device into reset in case regulators
265 * don't get disabled in order to ensure consistent restart.
267 wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET, 0x8994);
269 wm8994->suspended = true;
271 ret = regulator_bulk_disable(wm8994->num_supplies,
274 dev_err(dev, "Failed to disable supplies: %d\n", ret);
281 static int wm8994_resume(struct device *dev)
283 struct wm8994 *wm8994 = dev_get_drvdata(dev);
286 /* We may have lied to the PM core about suspending */
287 if (!wm8994->suspended)
290 ret = regulator_bulk_enable(wm8994->num_supplies,
293 dev_err(dev, "Failed to enable supplies: %d\n", ret);
297 /* Write register at a time as we use the cache on the CPU so store
298 * it in native endian.
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]);
304 dev_err(dev, "Failed to restore interrupt masks: %d\n",
308 ret = wm8994_write(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
311 dev_err(dev, "Failed to restore LDO registers: %d\n", ret);
313 ret = wm8994_write(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
316 dev_err(dev, "Failed to restore GPIO registers: %d\n", ret);
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,
323 wm8994->suspended = false;
329 #ifdef CONFIG_REGULATOR
330 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
332 struct wm8994_ldo_pdata *ldo_pdata;
337 ldo_pdata = &pdata->ldo[ldo];
339 if (!ldo_pdata->init_data)
342 return ldo_pdata->init_data->num_consumer_supplies != 0;
345 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
351 static struct regmap_config wm8994_regmap_config = {
357 * Instantiate the generic non-control parts of the device.
359 static int wm8994_device_init(struct wm8994 *wm8994, int irq)
361 struct wm8994_pdata *pdata = wm8994->dev->platform_data;
365 dev_set_drvdata(wm8994->dev, wm8994);
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),
373 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
377 switch (wm8994->type) {
379 wm8994->num_supplies = ARRAY_SIZE(wm8994_main_supplies);
382 wm8994->num_supplies = ARRAY_SIZE(wm8958_main_supplies);
389 wm8994->supplies = kzalloc(sizeof(struct regulator_bulk_data) *
390 wm8994->num_supplies,
392 if (!wm8994->supplies) {
397 switch (wm8994->type) {
399 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
400 wm8994->supplies[i].supply = wm8994_main_supplies[i];
403 for (i = 0; i < ARRAY_SIZE(wm8958_main_supplies); i++)
404 wm8994->supplies[i].supply = wm8958_main_supplies[i];
411 ret = regulator_bulk_get(wm8994->dev, wm8994->num_supplies,
414 dev_err(wm8994->dev, "Failed to get supplies: %d\n", ret);
418 ret = regulator_bulk_enable(wm8994->num_supplies,
421 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
425 ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
427 dev_err(wm8994->dev, "Failed to read ID register\n");
433 if (wm8994->type != WM8994)
434 dev_warn(wm8994->dev, "Device registered as type %d\n",
436 wm8994->type = WM8994;
440 if (wm8994->type != WM8958)
441 dev_warn(wm8994->dev, "Device registered as type %d\n",
443 wm8994->type = WM8958;
446 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
452 ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
454 dev_err(wm8994->dev, "Failed to read revision register: %d\n",
459 switch (wm8994->type) {
464 dev_warn(wm8994->dev,
465 "revision %c not fully supported\n",
476 dev_info(wm8994->dev, "%s revision %c\n", devname, 'A' + ret);
479 wm8994->irq_base = pdata->irq_base;
480 wm8994->gpio_base = pdata->gpio_base;
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,
487 pdata->gpio_defaults[i]);
491 wm8994->ldo_ena_always_driven = pdata->ldo_ena_always_driven;
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,
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.
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);
510 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
511 WM8994_LDO1_DISCH, 0);
514 wm8994_irq_init(wm8994);
516 ret = mfd_add_devices(wm8994->dev, -1,
517 wm8994_devs, ARRAY_SIZE(wm8994_devs),
520 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
524 pm_runtime_enable(wm8994->dev);
525 pm_runtime_resume(wm8994->dev);
530 wm8994_irq_exit(wm8994);
532 regulator_bulk_disable(wm8994->num_supplies,
535 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
537 kfree(wm8994->supplies);
539 regmap_exit(wm8994->regmap);
540 mfd_remove_devices(wm8994->dev);
545 static void wm8994_device_exit(struct wm8994 *wm8994)
547 pm_runtime_disable(wm8994->dev);
548 mfd_remove_devices(wm8994->dev);
549 wm8994_irq_exit(wm8994);
550 regulator_bulk_disable(wm8994->num_supplies,
552 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
553 kfree(wm8994->supplies);
554 regmap_exit(wm8994->regmap);
558 static int wm8994_i2c_probe(struct i2c_client *i2c,
559 const struct i2c_device_id *id)
561 struct wm8994 *wm8994;
564 wm8994 = kzalloc(sizeof(struct wm8994), GFP_KERNEL);
568 i2c_set_clientdata(i2c, wm8994);
569 wm8994->dev = &i2c->dev;
570 wm8994->irq = i2c->irq;
571 wm8994->type = id->driver_data;
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",
582 return wm8994_device_init(wm8994, i2c->irq);
585 static int wm8994_i2c_remove(struct i2c_client *i2c)
587 struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
589 wm8994_device_exit(wm8994);
594 static const struct i2c_device_id wm8994_i2c_id[] = {
595 { "wm8994", WM8994 },
596 { "wm8958", WM8958 },
599 MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
601 static UNIVERSAL_DEV_PM_OPS(wm8994_pm_ops, wm8994_suspend, wm8994_resume,
604 static struct i2c_driver wm8994_i2c_driver = {
607 .owner = THIS_MODULE,
608 .pm = &wm8994_pm_ops,
610 .probe = wm8994_i2c_probe,
611 .remove = wm8994_i2c_remove,
612 .id_table = wm8994_i2c_id,
615 static int __init wm8994_i2c_init(void)
619 ret = i2c_add_driver(&wm8994_i2c_driver);
621 pr_err("Failed to register wm8994 I2C driver: %d\n", ret);
625 module_init(wm8994_i2c_init);
627 static void __exit wm8994_i2c_exit(void)
629 i2c_del_driver(&wm8994_i2c_driver);
631 module_exit(wm8994_i2c_exit);
633 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
634 MODULE_LICENSE("GPL");
635 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");