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 *wm1811_main_supplies[] = {
182 static const char *wm8994_main_supplies[] = {
192 static const char *wm8958_main_supplies[] = {
205 static int wm8994_suspend(struct device *dev)
207 struct wm8994 *wm8994 = dev_get_drvdata(dev);
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);
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");
220 ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_4);
222 dev_err(dev, "Failed to read power status: %d\n", ret);
223 } else if (ret & (WM8994_AIF2ADCL_ENA | WM8994_AIF2ADCR_ENA |
224 WM8994_AIF1ADC2L_ENA | WM8994_AIF1ADC2R_ENA |
225 WM8994_AIF1ADC1L_ENA | WM8994_AIF1ADC1R_ENA)) {
226 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
230 ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_5);
232 dev_err(dev, "Failed to read power status: %d\n", ret);
233 } else if (ret & (WM8994_AIF2DACL_ENA | WM8994_AIF2DACR_ENA |
234 WM8994_AIF1DAC2L_ENA | WM8994_AIF1DAC2R_ENA |
235 WM8994_AIF1DAC1L_ENA | WM8994_AIF1DAC1R_ENA)) {
236 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
240 switch (wm8994->type) {
242 ret = wm8994_reg_read(wm8994, WM8958_MIC_DETECT_1);
244 dev_err(dev, "Failed to read power status: %d\n", ret);
245 } else if (ret & WM8958_MICD_ENA) {
246 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
254 /* Disable LDO pulldowns while the device is suspended if we
255 * don't know that something will be driving them. */
256 if (!wm8994->ldo_ena_always_driven)
257 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
258 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
259 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD);
261 /* GPIO configuration state is saved here since we may be configuring
262 * the GPIO alternate functions even if we're not using the gpiolib
265 ret = wm8994_read(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
268 dev_err(dev, "Failed to save GPIO registers: %d\n", ret);
270 /* For similar reasons we also stash the regulator states */
271 ret = wm8994_read(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
274 dev_err(dev, "Failed to save LDO registers: %d\n", ret);
276 /* Explicitly put the device into reset in case regulators
277 * don't get disabled in order to ensure consistent restart.
279 wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET,
280 wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET));
282 wm8994->suspended = true;
284 ret = regulator_bulk_disable(wm8994->num_supplies,
287 dev_err(dev, "Failed to disable supplies: %d\n", ret);
294 static int wm8994_resume(struct device *dev)
296 struct wm8994 *wm8994 = dev_get_drvdata(dev);
299 /* We may have lied to the PM core about suspending */
300 if (!wm8994->suspended)
303 ret = regulator_bulk_enable(wm8994->num_supplies,
306 dev_err(dev, "Failed to enable supplies: %d\n", ret);
310 /* Write register at a time as we use the cache on the CPU so store
311 * it in native endian.
313 for (i = 0; i < ARRAY_SIZE(wm8994->irq_masks_cur); i++) {
314 ret = wm8994_reg_write(wm8994, WM8994_INTERRUPT_STATUS_1_MASK
315 + i, wm8994->irq_masks_cur[i]);
317 dev_err(dev, "Failed to restore interrupt masks: %d\n",
321 ret = wm8994_write(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
324 dev_err(dev, "Failed to restore LDO registers: %d\n", ret);
326 ret = wm8994_write(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
329 dev_err(dev, "Failed to restore GPIO registers: %d\n", ret);
331 /* Disable LDO pulldowns while the device is active */
332 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
333 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
336 wm8994->suspended = false;
342 #ifdef CONFIG_REGULATOR
343 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
345 struct wm8994_ldo_pdata *ldo_pdata;
350 ldo_pdata = &pdata->ldo[ldo];
352 if (!ldo_pdata->init_data)
355 return ldo_pdata->init_data->num_consumer_supplies != 0;
358 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
364 static struct regmap_config wm8994_regmap_config = {
370 * Instantiate the generic non-control parts of the device.
372 static int wm8994_device_init(struct wm8994 *wm8994, int irq)
374 struct wm8994_pdata *pdata = wm8994->dev->platform_data;
379 dev_set_drvdata(wm8994->dev, wm8994);
381 /* Add the on-chip regulators first for bootstrapping */
382 ret = mfd_add_devices(wm8994->dev, -1,
383 wm8994_regulator_devs,
384 ARRAY_SIZE(wm8994_regulator_devs),
387 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
391 switch (wm8994->type) {
393 wm8994->num_supplies = ARRAY_SIZE(wm1811_main_supplies);
396 wm8994->num_supplies = ARRAY_SIZE(wm8994_main_supplies);
399 wm8994->num_supplies = ARRAY_SIZE(wm8958_main_supplies);
406 wm8994->supplies = devm_kzalloc(wm8994->dev,
407 sizeof(struct regulator_bulk_data) *
408 wm8994->num_supplies, GFP_KERNEL);
409 if (!wm8994->supplies) {
414 switch (wm8994->type) {
416 for (i = 0; i < ARRAY_SIZE(wm1811_main_supplies); i++)
417 wm8994->supplies[i].supply = wm1811_main_supplies[i];
420 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
421 wm8994->supplies[i].supply = wm8994_main_supplies[i];
424 for (i = 0; i < ARRAY_SIZE(wm8958_main_supplies); i++)
425 wm8994->supplies[i].supply = wm8958_main_supplies[i];
432 ret = regulator_bulk_get(wm8994->dev, wm8994->num_supplies,
435 dev_err(wm8994->dev, "Failed to get supplies: %d\n", ret);
439 ret = regulator_bulk_enable(wm8994->num_supplies,
442 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
446 ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
448 dev_err(wm8994->dev, "Failed to read ID register\n");
454 if (wm8994->type != WM1811)
455 dev_warn(wm8994->dev, "Device registered as type %d\n",
457 wm8994->type = WM1811;
461 if (wm8994->type != WM8994)
462 dev_warn(wm8994->dev, "Device registered as type %d\n",
464 wm8994->type = WM8994;
468 if (wm8994->type != WM8958)
469 dev_warn(wm8994->dev, "Device registered as type %d\n",
471 wm8994->type = WM8958;
474 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
480 ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
482 dev_err(wm8994->dev, "Failed to read revision register: %d\n",
487 switch (wm8994->type) {
492 dev_warn(wm8994->dev,
493 "revision %c not fully supported\n",
504 dev_info(wm8994->dev, "%s revision %c\n", devname, 'A' + ret);
507 wm8994->irq_base = pdata->irq_base;
508 wm8994->gpio_base = pdata->gpio_base;
510 /* GPIO configuration is only applied if it's non-zero */
511 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
512 if (pdata->gpio_defaults[i]) {
513 wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
515 pdata->gpio_defaults[i]);
519 wm8994->ldo_ena_always_driven = pdata->ldo_ena_always_driven;
521 if (pdata->spkmode_pu)
522 pulls |= WM8994_SPKMODE_PU;
525 /* Disable unneeded pulls */
526 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
527 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD |
528 WM8994_SPKMODE_PU | WM8994_CSNADDR_PD,
531 /* In some system designs where the regulators are not in use,
532 * we can achieve a small reduction in leakage currents by
533 * floating LDO outputs. This bit makes no difference if the
534 * LDOs are enabled, it only affects cases where the LDOs were
535 * in operation and are then disabled.
537 for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
538 if (wm8994_ldo_in_use(pdata, i))
539 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
540 WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
542 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
543 WM8994_LDO1_DISCH, 0);
546 wm8994_irq_init(wm8994);
548 ret = mfd_add_devices(wm8994->dev, -1,
549 wm8994_devs, ARRAY_SIZE(wm8994_devs),
552 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
556 pm_runtime_enable(wm8994->dev);
557 pm_runtime_resume(wm8994->dev);
562 wm8994_irq_exit(wm8994);
564 regulator_bulk_disable(wm8994->num_supplies,
567 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
569 regmap_exit(wm8994->regmap);
570 mfd_remove_devices(wm8994->dev);
574 static void wm8994_device_exit(struct wm8994 *wm8994)
576 pm_runtime_disable(wm8994->dev);
577 mfd_remove_devices(wm8994->dev);
578 wm8994_irq_exit(wm8994);
579 regulator_bulk_disable(wm8994->num_supplies,
581 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
582 regmap_exit(wm8994->regmap);
585 static const struct of_device_id wm8994_of_match[] = {
586 { .compatible = "wlf,wm1811", },
587 { .compatible = "wlf,wm8994", },
588 { .compatible = "wlf,wm8958", },
591 MODULE_DEVICE_TABLE(of, wm8994_of_match);
593 static int wm8994_i2c_probe(struct i2c_client *i2c,
594 const struct i2c_device_id *id)
596 struct wm8994 *wm8994;
599 wm8994 = devm_kzalloc(&i2c->dev, sizeof(struct wm8994), GFP_KERNEL);
603 i2c_set_clientdata(i2c, wm8994);
604 wm8994->dev = &i2c->dev;
605 wm8994->irq = i2c->irq;
606 wm8994->type = id->driver_data;
608 wm8994->regmap = regmap_init_i2c(i2c, &wm8994_regmap_config);
609 if (IS_ERR(wm8994->regmap)) {
610 ret = PTR_ERR(wm8994->regmap);
611 dev_err(wm8994->dev, "Failed to allocate register map: %d\n",
616 return wm8994_device_init(wm8994, i2c->irq);
619 static int wm8994_i2c_remove(struct i2c_client *i2c)
621 struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
623 wm8994_device_exit(wm8994);
628 static const struct i2c_device_id wm8994_i2c_id[] = {
629 { "wm1811", WM1811 },
630 { "wm8994", WM8994 },
631 { "wm8958", WM8958 },
634 MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
636 static UNIVERSAL_DEV_PM_OPS(wm8994_pm_ops, wm8994_suspend, wm8994_resume,
639 static struct i2c_driver wm8994_i2c_driver = {
642 .owner = THIS_MODULE,
643 .pm = &wm8994_pm_ops,
644 .of_match_table = wm8994_of_match,
646 .probe = wm8994_i2c_probe,
647 .remove = wm8994_i2c_remove,
648 .id_table = wm8994_i2c_id,
651 static int __init wm8994_i2c_init(void)
655 ret = i2c_add_driver(&wm8994_i2c_driver);
657 pr_err("Failed to register wm8994 I2C driver: %d\n", ret);
661 module_init(wm8994_i2c_init);
663 static void __exit wm8994_i2c_exit(void)
665 i2c_del_driver(&wm8994_i2c_driver);
667 module_exit(wm8994_i2c_exit);
669 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
670 MODULE_LICENSE("GPL");
671 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");