2 * wm8994-core.c -- Device access for Wolfson WM8994
4 * Copyright 2009 Wolfson Microelectronics PLC.
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>
23 #include <linux/of_device.h>
24 #include <linux/pm_runtime.h>
25 #include <linux/regmap.h>
26 #include <linux/regulator/consumer.h>
27 #include <linux/regulator/machine.h>
29 #include <linux/mfd/wm8994/core.h>
30 #include <linux/mfd/wm8994/pdata.h>
31 #include <linux/mfd/wm8994/registers.h>
35 static const struct mfd_cell wm8994_regulator_devs[] = {
39 .pm_runtime_no_callbacks = true,
44 .pm_runtime_no_callbacks = true,
48 static struct resource wm8994_codec_resources[] = {
50 .start = WM8994_IRQ_TEMP_SHUT,
51 .end = WM8994_IRQ_TEMP_WARN,
52 .flags = IORESOURCE_IRQ,
56 static struct resource wm8994_gpio_resources[] = {
58 .start = WM8994_IRQ_GPIO(1),
59 .end = WM8994_IRQ_GPIO(11),
60 .flags = IORESOURCE_IRQ,
64 static const struct mfd_cell wm8994_devs[] = {
66 .name = "wm8994-codec",
67 .num_resources = ARRAY_SIZE(wm8994_codec_resources),
68 .resources = wm8994_codec_resources,
72 .name = "wm8994-gpio",
73 .num_resources = ARRAY_SIZE(wm8994_gpio_resources),
74 .resources = wm8994_gpio_resources,
75 .pm_runtime_no_callbacks = true,
80 * Supplies for the main bulk of CODEC; the LDO supplies are ignored
81 * and should be handled via the standard regulator API supply
84 static const char *wm1811_main_supplies[] = {
96 static const char *wm8994_main_supplies[] = {
106 static const char *wm8958_main_supplies[] = {
119 static int wm8994_suspend(struct device *dev)
121 struct wm8994 *wm8994 = dev_get_drvdata(dev);
124 /* Don't actually go through with the suspend if the CODEC is
125 * still active for accessory detect. */
126 switch (wm8994->type) {
129 ret = wm8994_reg_read(wm8994, WM8958_MIC_DETECT_1);
131 dev_err(dev, "Failed to read power status: %d\n", ret);
132 } else if (ret & WM8958_MICD_ENA) {
133 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
141 /* Disable LDO pulldowns while the device is suspended if we
142 * don't know that something will be driving them. */
143 if (!wm8994->ldo_ena_always_driven)
144 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
145 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
146 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD);
148 /* Explicitly put the device into reset in case regulators
149 * don't get disabled in order to ensure consistent restart.
151 wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET,
152 wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET));
154 regcache_mark_dirty(wm8994->regmap);
156 /* Restore GPIO registers to prevent problems with mismatched
157 * pin configurations.
159 ret = regcache_sync_region(wm8994->regmap, WM8994_GPIO_1,
162 dev_err(dev, "Failed to restore GPIO registers: %d\n", ret);
164 /* In case one of the GPIOs is used as a wake input. */
165 ret = regcache_sync_region(wm8994->regmap,
166 WM8994_INTERRUPT_STATUS_1_MASK,
167 WM8994_INTERRUPT_STATUS_1_MASK);
169 dev_err(dev, "Failed to restore interrupt mask: %d\n", ret);
171 regcache_cache_only(wm8994->regmap, true);
172 wm8994->suspended = true;
174 ret = regulator_bulk_disable(wm8994->num_supplies,
177 dev_err(dev, "Failed to disable supplies: %d\n", ret);
184 static int wm8994_resume(struct device *dev)
186 struct wm8994 *wm8994 = dev_get_drvdata(dev);
189 /* We may have lied to the PM core about suspending */
190 if (!wm8994->suspended)
193 ret = regulator_bulk_enable(wm8994->num_supplies,
196 dev_err(dev, "Failed to enable supplies: %d\n", ret);
200 regcache_cache_only(wm8994->regmap, false);
201 ret = regcache_sync(wm8994->regmap);
203 dev_err(dev, "Failed to restore register map: %d\n", ret);
207 /* Disable LDO pulldowns while the device is active */
208 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
209 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
212 wm8994->suspended = false;
217 regulator_bulk_disable(wm8994->num_supplies, wm8994->supplies);
223 #ifdef CONFIG_REGULATOR
224 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
226 struct wm8994_ldo_pdata *ldo_pdata;
231 ldo_pdata = &pdata->ldo[ldo];
233 if (!ldo_pdata->init_data)
236 return ldo_pdata->init_data->num_consumer_supplies != 0;
239 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
245 static const struct reg_sequence wm8994_revc_patch[] = {
252 static const struct reg_sequence wm8958_reva_patch[] = {
259 static const struct reg_sequence wm1811_reva_patch[] = {
268 static int wm8994_set_pdata_from_of(struct wm8994 *wm8994)
270 struct device_node *np = wm8994->dev->of_node;
271 struct wm8994_pdata *pdata = &wm8994->pdata;
277 if (of_property_read_u32_array(np, "wlf,gpio-cfg", pdata->gpio_defaults,
278 ARRAY_SIZE(pdata->gpio_defaults)) >= 0) {
279 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
280 if (wm8994->pdata.gpio_defaults[i] == 0)
281 pdata->gpio_defaults[i]
282 = WM8994_CONFIGURE_GPIO;
286 of_property_read_u32_array(np, "wlf,micbias-cfg", pdata->micbias,
287 ARRAY_SIZE(pdata->micbias));
289 pdata->lineout1_diff = true;
290 pdata->lineout2_diff = true;
291 if (of_find_property(np, "wlf,lineout1-se", NULL))
292 pdata->lineout1_diff = false;
293 if (of_find_property(np, "wlf,lineout2-se", NULL))
294 pdata->lineout2_diff = false;
296 if (of_find_property(np, "wlf,lineout1-feedback", NULL))
297 pdata->lineout1fb = true;
298 if (of_find_property(np, "wlf,lineout2-feedback", NULL))
299 pdata->lineout2fb = true;
301 if (of_find_property(np, "wlf,ldoena-always-driven", NULL))
302 pdata->lineout2fb = true;
304 pdata->spkmode_pu = of_property_read_bool(np, "wlf,spkmode-pu");
306 pdata->csnaddr_pd = of_property_read_bool(np, "wlf,csnaddr-pd");
311 static int wm8994_set_pdata_from_of(struct wm8994 *wm8994)
318 * Instantiate the generic non-control parts of the device.
320 static int wm8994_device_init(struct wm8994 *wm8994, int irq)
322 struct wm8994_pdata *pdata;
323 struct regmap_config *regmap_config;
324 const struct reg_sequence *regmap_patch = NULL;
326 int ret, i, patch_regs = 0;
329 if (dev_get_platdata(wm8994->dev)) {
330 pdata = dev_get_platdata(wm8994->dev);
331 wm8994->pdata = *pdata;
333 pdata = &wm8994->pdata;
335 ret = wm8994_set_pdata_from_of(wm8994);
339 dev_set_drvdata(wm8994->dev, wm8994);
341 /* Add the on-chip regulators first for bootstrapping */
342 ret = mfd_add_devices(wm8994->dev, 0,
343 wm8994_regulator_devs,
344 ARRAY_SIZE(wm8994_regulator_devs),
347 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
351 switch (wm8994->type) {
353 wm8994->num_supplies = ARRAY_SIZE(wm1811_main_supplies);
356 wm8994->num_supplies = ARRAY_SIZE(wm8994_main_supplies);
359 wm8994->num_supplies = ARRAY_SIZE(wm8958_main_supplies);
366 wm8994->supplies = devm_kcalloc(wm8994->dev,
367 wm8994->num_supplies,
368 sizeof(struct regulator_bulk_data),
370 if (!wm8994->supplies) {
375 switch (wm8994->type) {
377 for (i = 0; i < ARRAY_SIZE(wm1811_main_supplies); i++)
378 wm8994->supplies[i].supply = wm1811_main_supplies[i];
381 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
382 wm8994->supplies[i].supply = wm8994_main_supplies[i];
385 for (i = 0; i < ARRAY_SIZE(wm8958_main_supplies); i++)
386 wm8994->supplies[i].supply = wm8958_main_supplies[i];
394 * Can't use devres helper here as some of the supplies are provided by
395 * wm8994->dev's children (regulators) and those regulators are
396 * unregistered by the devres core before the supplies are freed.
398 ret = regulator_bulk_get(wm8994->dev, wm8994->num_supplies,
401 dev_err(wm8994->dev, "Failed to get supplies: %d\n", ret);
405 ret = regulator_bulk_enable(wm8994->num_supplies, wm8994->supplies);
407 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
408 goto err_regulator_free;
411 ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
413 dev_err(wm8994->dev, "Failed to read ID register\n");
419 if (wm8994->type != WM1811)
420 dev_warn(wm8994->dev, "Device registered as type %d\n",
422 wm8994->type = WM1811;
426 if (wm8994->type != WM8994)
427 dev_warn(wm8994->dev, "Device registered as type %d\n",
429 wm8994->type = WM8994;
433 if (wm8994->type != WM8958)
434 dev_warn(wm8994->dev, "Device registered as type %d\n",
436 wm8994->type = WM8958;
439 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
445 ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
447 dev_err(wm8994->dev, "Failed to read revision register: %d\n",
451 wm8994->revision = ret & WM8994_CHIP_REV_MASK;
452 wm8994->cust_id = (ret & WM8994_CUST_ID_MASK) >> WM8994_CUST_ID_SHIFT;
454 switch (wm8994->type) {
456 switch (wm8994->revision) {
459 dev_warn(wm8994->dev,
460 "revision %c not fully supported\n",
461 'A' + wm8994->revision);
466 regmap_patch = wm8994_revc_patch;
467 patch_regs = ARRAY_SIZE(wm8994_revc_patch);
473 switch (wm8994->revision) {
475 regmap_patch = wm8958_reva_patch;
476 patch_regs = ARRAY_SIZE(wm8958_reva_patch);
484 /* Revision C did not change the relevant layer */
485 if (wm8994->revision > 1)
488 regmap_patch = wm1811_reva_patch;
489 patch_regs = ARRAY_SIZE(wm1811_reva_patch);
496 dev_info(wm8994->dev, "%s revision %c CUST_ID %02x\n", devname,
497 'A' + wm8994->revision, wm8994->cust_id);
499 switch (wm8994->type) {
501 regmap_config = &wm1811_regmap_config;
504 regmap_config = &wm8994_regmap_config;
507 regmap_config = &wm8958_regmap_config;
510 dev_err(wm8994->dev, "Unknown device type %d\n", wm8994->type);
515 ret = regmap_reinit_cache(wm8994->regmap, regmap_config);
517 dev_err(wm8994->dev, "Failed to reinit register cache: %d\n",
522 /* Explicitly put the device into reset in case regulators
523 * don't get disabled in order to ensure we know the device
526 ret = wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET,
527 wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET));
529 dev_err(wm8994->dev, "Failed to reset device: %d\n", ret);
534 ret = regmap_register_patch(wm8994->regmap, regmap_patch,
537 dev_err(wm8994->dev, "Failed to register patch: %d\n",
543 wm8994->irq_base = pdata->irq_base;
544 wm8994->gpio_base = pdata->gpio_base;
546 /* GPIO configuration is only applied if it's non-zero */
547 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
548 if (pdata->gpio_defaults[i]) {
549 wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
550 0xffff, pdata->gpio_defaults[i]);
554 wm8994->ldo_ena_always_driven = pdata->ldo_ena_always_driven;
556 if (pdata->spkmode_pu)
557 pulls |= WM8994_SPKMODE_PU;
558 if (pdata->csnaddr_pd)
559 pulls |= WM8994_CSNADDR_PD;
561 /* Disable unneeded pulls */
562 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
563 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD |
564 WM8994_SPKMODE_PU | WM8994_CSNADDR_PD,
567 /* In some system designs where the regulators are not in use,
568 * we can achieve a small reduction in leakage currents by
569 * floating LDO outputs. This bit makes no difference if the
570 * LDOs are enabled, it only affects cases where the LDOs were
571 * in operation and are then disabled.
573 for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
574 if (wm8994_ldo_in_use(pdata, i))
575 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
576 WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
578 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
579 WM8994_LDO1_DISCH, 0);
582 wm8994_irq_init(wm8994);
584 ret = mfd_add_devices(wm8994->dev, -1,
585 wm8994_devs, ARRAY_SIZE(wm8994_devs),
588 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
592 pm_runtime_enable(wm8994->dev);
593 pm_runtime_idle(wm8994->dev);
598 wm8994_irq_exit(wm8994);
600 regulator_bulk_disable(wm8994->num_supplies,
603 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
605 mfd_remove_devices(wm8994->dev);
609 static void wm8994_device_exit(struct wm8994 *wm8994)
611 pm_runtime_disable(wm8994->dev);
612 wm8994_irq_exit(wm8994);
613 regulator_bulk_disable(wm8994->num_supplies, wm8994->supplies);
614 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
615 mfd_remove_devices(wm8994->dev);
618 static const struct of_device_id wm8994_of_match[] = {
619 { .compatible = "wlf,wm1811", .data = (void *)WM1811 },
620 { .compatible = "wlf,wm8994", .data = (void *)WM8994 },
621 { .compatible = "wlf,wm8958", .data = (void *)WM8958 },
624 MODULE_DEVICE_TABLE(of, wm8994_of_match);
626 static int wm8994_i2c_probe(struct i2c_client *i2c,
627 const struct i2c_device_id *id)
629 const struct of_device_id *of_id;
630 struct wm8994 *wm8994;
633 wm8994 = devm_kzalloc(&i2c->dev, sizeof(struct wm8994), GFP_KERNEL);
637 i2c_set_clientdata(i2c, wm8994);
638 wm8994->dev = &i2c->dev;
639 wm8994->irq = i2c->irq;
641 if (i2c->dev.of_node) {
642 of_id = of_match_device(wm8994_of_match, &i2c->dev);
644 wm8994->type = (enum wm8994_type)of_id->data;
646 wm8994->type = id->driver_data;
649 wm8994->regmap = devm_regmap_init_i2c(i2c, &wm8994_base_regmap_config);
650 if (IS_ERR(wm8994->regmap)) {
651 ret = PTR_ERR(wm8994->regmap);
652 dev_err(wm8994->dev, "Failed to allocate register map: %d\n",
657 return wm8994_device_init(wm8994, i2c->irq);
660 static int wm8994_i2c_remove(struct i2c_client *i2c)
662 struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
664 wm8994_device_exit(wm8994);
669 static const struct i2c_device_id wm8994_i2c_id[] = {
670 { "wm1811", WM1811 },
671 { "wm1811a", WM1811 },
672 { "wm8994", WM8994 },
673 { "wm8958", WM8958 },
676 MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
678 static const struct dev_pm_ops wm8994_pm_ops = {
679 SET_RUNTIME_PM_OPS(wm8994_suspend, wm8994_resume, NULL)
682 static struct i2c_driver wm8994_i2c_driver = {
685 .pm = &wm8994_pm_ops,
686 .of_match_table = of_match_ptr(wm8994_of_match),
688 .probe = wm8994_i2c_probe,
689 .remove = wm8994_i2c_remove,
690 .id_table = wm8994_i2c_id,
693 module_i2c_driver(wm8994_i2c_driver);
695 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
696 MODULE_LICENSE("GPL");