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>
34 * wm8994_reg_read: Read a single WM8994 register.
36 * @wm8994: Device to read from.
37 * @reg: Register to read.
39 int wm8994_reg_read(struct wm8994 *wm8994, unsigned short reg)
44 ret = regmap_read(wm8994->regmap, reg, &val);
51 EXPORT_SYMBOL_GPL(wm8994_reg_read);
54 * wm8994_bulk_read: Read multiple WM8994 registers
56 * @wm8994: Device to read from
57 * @reg: First register
58 * @count: Number of registers
59 * @buf: Buffer to fill. The data will be returned big endian.
61 int wm8994_bulk_read(struct wm8994 *wm8994, unsigned short reg,
64 return regmap_bulk_read(wm8994->regmap, reg, buf, count);
68 * wm8994_reg_write: Write a single WM8994 register.
70 * @wm8994: Device to write to.
71 * @reg: Register to write to.
72 * @val: Value to write.
74 int wm8994_reg_write(struct wm8994 *wm8994, unsigned short reg,
77 return regmap_write(wm8994->regmap, reg, val);
79 EXPORT_SYMBOL_GPL(wm8994_reg_write);
82 * wm8994_bulk_write: Write multiple WM8994 registers
84 * @wm8994: Device to write to
85 * @reg: First register
86 * @count: Number of registers
87 * @buf: Buffer to write from. Data must be big-endian formatted.
89 int wm8994_bulk_write(struct wm8994 *wm8994, unsigned short reg,
90 int count, const u16 *buf)
92 return regmap_raw_write(wm8994->regmap, reg, buf, count * sizeof(u16));
94 EXPORT_SYMBOL_GPL(wm8994_bulk_write);
97 * wm8994_set_bits: Set the value of a bitfield in a WM8994 register
99 * @wm8994: Device to write to.
100 * @reg: Register to write to.
101 * @mask: Mask of bits to set.
102 * @val: Value to set (unshifted)
104 int wm8994_set_bits(struct wm8994 *wm8994, unsigned short reg,
105 unsigned short mask, unsigned short val)
107 return regmap_update_bits(wm8994->regmap, reg, mask, val);
109 EXPORT_SYMBOL_GPL(wm8994_set_bits);
111 static struct mfd_cell wm8994_regulator_devs[] = {
113 .name = "wm8994-ldo",
115 .pm_runtime_no_callbacks = true,
118 .name = "wm8994-ldo",
120 .pm_runtime_no_callbacks = true,
124 static struct resource wm8994_codec_resources[] = {
126 .start = WM8994_IRQ_TEMP_SHUT,
127 .end = WM8994_IRQ_TEMP_WARN,
128 .flags = IORESOURCE_IRQ,
132 static struct resource wm8994_gpio_resources[] = {
134 .start = WM8994_IRQ_GPIO(1),
135 .end = WM8994_IRQ_GPIO(11),
136 .flags = IORESOURCE_IRQ,
140 static struct mfd_cell wm8994_devs[] = {
142 .name = "wm8994-codec",
143 .num_resources = ARRAY_SIZE(wm8994_codec_resources),
144 .resources = wm8994_codec_resources,
148 .name = "wm8994-gpio",
149 .num_resources = ARRAY_SIZE(wm8994_gpio_resources),
150 .resources = wm8994_gpio_resources,
151 .pm_runtime_no_callbacks = true,
156 * Supplies for the main bulk of CODEC; the LDO supplies are ignored
157 * and should be handled via the standard regulator API supply
160 static const char *wm1811_main_supplies[] = {
172 static const char *wm8994_main_supplies[] = {
182 static const char *wm8958_main_supplies[] = {
195 static int wm8994_suspend(struct device *dev)
197 struct wm8994 *wm8994 = dev_get_drvdata(dev);
200 /* Don't actually go through with the suspend if the CODEC is
201 * still active (eg, for audio passthrough from CP. */
202 ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_1);
204 dev_err(dev, "Failed to read power status: %d\n", ret);
205 } else if (ret & WM8994_VMID_SEL_MASK) {
206 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
210 ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_4);
212 dev_err(dev, "Failed to read power status: %d\n", ret);
213 } else if (ret & (WM8994_AIF2ADCL_ENA | WM8994_AIF2ADCR_ENA |
214 WM8994_AIF1ADC2L_ENA | WM8994_AIF1ADC2R_ENA |
215 WM8994_AIF1ADC1L_ENA | WM8994_AIF1ADC1R_ENA)) {
216 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
220 ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_5);
222 dev_err(dev, "Failed to read power status: %d\n", ret);
223 } else if (ret & (WM8994_AIF2DACL_ENA | WM8994_AIF2DACR_ENA |
224 WM8994_AIF1DAC2L_ENA | WM8994_AIF1DAC2R_ENA |
225 WM8994_AIF1DAC1L_ENA | WM8994_AIF1DAC1R_ENA)) {
226 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
230 switch (wm8994->type) {
232 ret = wm8994_reg_read(wm8994, WM8958_MIC_DETECT_1);
234 dev_err(dev, "Failed to read power status: %d\n", ret);
235 } else if (ret & WM8958_MICD_ENA) {
236 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
244 switch (wm8994->type) {
246 ret = wm8994_reg_read(wm8994, WM8994_ANTIPOP_2);
248 dev_err(dev, "Failed to read jackdet: %d\n", ret);
249 } else if (ret & WM1811_JACKDET_MODE_MASK) {
250 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
258 /* Disable LDO pulldowns while the device is suspended if we
259 * don't know that something will be driving them. */
260 if (!wm8994->ldo_ena_always_driven)
261 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
262 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
263 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD);
265 /* Explicitly put the device into reset in case regulators
266 * don't get disabled in order to ensure consistent restart.
268 wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET,
269 wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET));
271 regcache_mark_dirty(wm8994->regmap);
273 wm8994->suspended = true;
275 ret = regulator_bulk_disable(wm8994->num_supplies,
278 dev_err(dev, "Failed to disable supplies: %d\n", ret);
285 static int wm8994_resume(struct device *dev)
287 struct wm8994 *wm8994 = dev_get_drvdata(dev);
290 /* We may have lied to the PM core about suspending */
291 if (!wm8994->suspended)
294 ret = regulator_bulk_enable(wm8994->num_supplies,
297 dev_err(dev, "Failed to enable supplies: %d\n", ret);
301 ret = regcache_sync(wm8994->regmap);
303 dev_err(dev, "Failed to restore register map: %d\n", ret);
307 /* Disable LDO pulldowns while the device is active */
308 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
309 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
312 wm8994->suspended = false;
317 regulator_bulk_disable(wm8994->num_supplies, wm8994->supplies);
323 #ifdef CONFIG_REGULATOR
324 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
326 struct wm8994_ldo_pdata *ldo_pdata;
331 ldo_pdata = &pdata->ldo[ldo];
333 if (!ldo_pdata->init_data)
336 return ldo_pdata->init_data->num_consumer_supplies != 0;
339 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
346 * Instantiate the generic non-control parts of the device.
348 static int wm8994_device_init(struct wm8994 *wm8994, int irq)
350 struct wm8994_pdata *pdata = wm8994->dev->platform_data;
351 struct regmap_config *regmap_config;
356 dev_set_drvdata(wm8994->dev, wm8994);
358 /* Add the on-chip regulators first for bootstrapping */
359 ret = mfd_add_devices(wm8994->dev, -1,
360 wm8994_regulator_devs,
361 ARRAY_SIZE(wm8994_regulator_devs),
364 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
368 switch (wm8994->type) {
370 wm8994->num_supplies = ARRAY_SIZE(wm1811_main_supplies);
373 wm8994->num_supplies = ARRAY_SIZE(wm8994_main_supplies);
376 wm8994->num_supplies = ARRAY_SIZE(wm8958_main_supplies);
383 wm8994->supplies = devm_kzalloc(wm8994->dev,
384 sizeof(struct regulator_bulk_data) *
385 wm8994->num_supplies, GFP_KERNEL);
386 if (!wm8994->supplies) {
391 switch (wm8994->type) {
393 for (i = 0; i < ARRAY_SIZE(wm1811_main_supplies); i++)
394 wm8994->supplies[i].supply = wm1811_main_supplies[i];
397 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
398 wm8994->supplies[i].supply = wm8994_main_supplies[i];
401 for (i = 0; i < ARRAY_SIZE(wm8958_main_supplies); i++)
402 wm8994->supplies[i].supply = wm8958_main_supplies[i];
409 ret = regulator_bulk_get(wm8994->dev, wm8994->num_supplies,
412 dev_err(wm8994->dev, "Failed to get supplies: %d\n", ret);
416 ret = regulator_bulk_enable(wm8994->num_supplies,
419 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
423 ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
425 dev_err(wm8994->dev, "Failed to read ID register\n");
431 if (wm8994->type != WM1811)
432 dev_warn(wm8994->dev, "Device registered as type %d\n",
434 wm8994->type = WM1811;
438 if (wm8994->type != WM8994)
439 dev_warn(wm8994->dev, "Device registered as type %d\n",
441 wm8994->type = WM8994;
445 if (wm8994->type != WM8958)
446 dev_warn(wm8994->dev, "Device registered as type %d\n",
448 wm8994->type = WM8958;
451 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
457 ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
459 dev_err(wm8994->dev, "Failed to read revision register: %d\n",
463 wm8994->revision = ret;
465 switch (wm8994->type) {
467 switch (wm8994->revision) {
470 dev_warn(wm8994->dev,
471 "revision %c not fully supported\n",
472 'A' + wm8994->revision);
479 /* Revision C did not change the relevant layer */
480 if (wm8994->revision > 1)
487 dev_info(wm8994->dev, "%s revision %c\n", devname,
488 'A' + wm8994->revision);
490 switch (wm8994->type) {
492 regmap_config = &wm1811_regmap_config;
495 regmap_config = &wm8994_regmap_config;
498 regmap_config = &wm8958_regmap_config;
501 dev_err(wm8994->dev, "Unknown device type %d\n", wm8994->type);
505 ret = regmap_reinit_cache(wm8994->regmap, regmap_config);
507 dev_err(wm8994->dev, "Failed to reinit register cache: %d\n",
513 wm8994->irq_base = pdata->irq_base;
514 wm8994->gpio_base = pdata->gpio_base;
516 /* GPIO configuration is only applied if it's non-zero */
517 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
518 if (pdata->gpio_defaults[i]) {
519 wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
521 pdata->gpio_defaults[i]);
525 wm8994->ldo_ena_always_driven = pdata->ldo_ena_always_driven;
527 if (pdata->spkmode_pu)
528 pulls |= WM8994_SPKMODE_PU;
531 /* Disable unneeded pulls */
532 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
533 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD |
534 WM8994_SPKMODE_PU | WM8994_CSNADDR_PD,
537 /* In some system designs where the regulators are not in use,
538 * we can achieve a small reduction in leakage currents by
539 * floating LDO outputs. This bit makes no difference if the
540 * LDOs are enabled, it only affects cases where the LDOs were
541 * in operation and are then disabled.
543 for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
544 if (wm8994_ldo_in_use(pdata, i))
545 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
546 WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
548 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
549 WM8994_LDO1_DISCH, 0);
552 wm8994_irq_init(wm8994);
554 ret = mfd_add_devices(wm8994->dev, -1,
555 wm8994_devs, ARRAY_SIZE(wm8994_devs),
558 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
562 pm_runtime_enable(wm8994->dev);
563 pm_runtime_resume(wm8994->dev);
568 wm8994_irq_exit(wm8994);
570 regulator_bulk_disable(wm8994->num_supplies,
573 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
575 regmap_exit(wm8994->regmap);
576 mfd_remove_devices(wm8994->dev);
580 static void wm8994_device_exit(struct wm8994 *wm8994)
582 pm_runtime_disable(wm8994->dev);
583 mfd_remove_devices(wm8994->dev);
584 wm8994_irq_exit(wm8994);
585 regulator_bulk_disable(wm8994->num_supplies,
587 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
588 regmap_exit(wm8994->regmap);
591 static const struct of_device_id wm8994_of_match[] = {
592 { .compatible = "wlf,wm1811", },
593 { .compatible = "wlf,wm8994", },
594 { .compatible = "wlf,wm8958", },
597 MODULE_DEVICE_TABLE(of, wm8994_of_match);
599 static int wm8994_i2c_probe(struct i2c_client *i2c,
600 const struct i2c_device_id *id)
602 struct wm8994 *wm8994;
605 wm8994 = devm_kzalloc(&i2c->dev, sizeof(struct wm8994), GFP_KERNEL);
609 i2c_set_clientdata(i2c, wm8994);
610 wm8994->dev = &i2c->dev;
611 wm8994->irq = i2c->irq;
612 wm8994->type = id->driver_data;
614 wm8994->regmap = regmap_init_i2c(i2c, &wm8994_base_regmap_config);
615 if (IS_ERR(wm8994->regmap)) {
616 ret = PTR_ERR(wm8994->regmap);
617 dev_err(wm8994->dev, "Failed to allocate register map: %d\n",
622 return wm8994_device_init(wm8994, i2c->irq);
625 static int wm8994_i2c_remove(struct i2c_client *i2c)
627 struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
629 wm8994_device_exit(wm8994);
634 static const struct i2c_device_id wm8994_i2c_id[] = {
635 { "wm1811", WM1811 },
636 { "wm1811a", WM1811 },
637 { "wm8994", WM8994 },
638 { "wm8958", WM8958 },
641 MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
643 static UNIVERSAL_DEV_PM_OPS(wm8994_pm_ops, wm8994_suspend, wm8994_resume,
646 static struct i2c_driver wm8994_i2c_driver = {
649 .owner = THIS_MODULE,
650 .pm = &wm8994_pm_ops,
651 .of_match_table = wm8994_of_match,
653 .probe = wm8994_i2c_probe,
654 .remove = wm8994_i2c_remove,
655 .id_table = wm8994_i2c_id,
658 static int __init wm8994_i2c_init(void)
662 ret = i2c_add_driver(&wm8994_i2c_driver);
664 pr_err("Failed to register wm8994 I2C driver: %d\n", ret);
668 module_init(wm8994_i2c_init);
670 static void __exit wm8994_i2c_exit(void)
672 i2c_del_driver(&wm8994_i2c_driver);
674 module_exit(wm8994_i2c_exit);
676 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
677 MODULE_LICENSE("GPL");
678 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");