1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * wm8994-core.c -- Device access for Wolfson WM8994
5 * Copyright 2009 Wolfson Microelectronics PLC.
7 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <linux/slab.h>
13 #include <linux/i2c.h>
14 #include <linux/err.h>
15 #include <linux/delay.h>
16 #include <linux/mfd/core.h>
18 #include <linux/of_device.h>
19 #include <linux/pm_runtime.h>
20 #include <linux/regmap.h>
21 #include <linux/regulator/consumer.h>
22 #include <linux/regulator/machine.h>
24 #include <linux/mfd/wm8994/core.h>
25 #include <linux/mfd/wm8994/pdata.h>
26 #include <linux/mfd/wm8994/registers.h>
30 static const struct mfd_cell wm8994_regulator_devs[] = {
34 .pm_runtime_no_callbacks = true,
39 .pm_runtime_no_callbacks = true,
43 static const struct resource wm8994_codec_resources[] = {
45 .start = WM8994_IRQ_TEMP_SHUT,
46 .end = WM8994_IRQ_TEMP_WARN,
47 .flags = IORESOURCE_IRQ,
51 static const struct resource wm8994_gpio_resources[] = {
53 .start = WM8994_IRQ_GPIO(1),
54 .end = WM8994_IRQ_GPIO(11),
55 .flags = IORESOURCE_IRQ,
59 static const struct mfd_cell wm8994_devs[] = {
61 .name = "wm8994-codec",
62 .num_resources = ARRAY_SIZE(wm8994_codec_resources),
63 .resources = wm8994_codec_resources,
67 .name = "wm8994-gpio",
68 .num_resources = ARRAY_SIZE(wm8994_gpio_resources),
69 .resources = wm8994_gpio_resources,
70 .pm_runtime_no_callbacks = true,
75 * Supplies for the main bulk of CODEC; the LDO supplies are ignored
76 * and should be handled via the standard regulator API supply
79 static const char *wm1811_main_supplies[] = {
91 static const char *wm8994_main_supplies[] = {
101 static const char *wm8958_main_supplies[] = {
113 static int wm8994_suspend(struct device *dev)
115 struct wm8994 *wm8994 = dev_get_drvdata(dev);
118 /* Don't actually go through with the suspend if the CODEC is
119 * still active for accessory detect. */
120 switch (wm8994->type) {
123 ret = wm8994_reg_read(wm8994, WM8958_MIC_DETECT_1);
125 dev_err(dev, "Failed to read power status: %d\n", ret);
126 } else if (ret & WM8958_MICD_ENA) {
127 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
135 /* Disable LDO pulldowns while the device is suspended if we
136 * don't know that something will be driving them. */
137 if (!wm8994->ldo_ena_always_driven)
138 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
139 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
140 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD);
142 /* Explicitly put the device into reset in case regulators
143 * don't get disabled in order to ensure consistent restart.
145 wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET,
146 wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET));
148 regcache_mark_dirty(wm8994->regmap);
150 /* Restore GPIO registers to prevent problems with mismatched
151 * pin configurations.
153 ret = regcache_sync_region(wm8994->regmap, WM8994_GPIO_1,
156 dev_err(dev, "Failed to restore GPIO registers: %d\n", ret);
158 /* In case one of the GPIOs is used as a wake input. */
159 ret = regcache_sync_region(wm8994->regmap,
160 WM8994_INTERRUPT_STATUS_1_MASK,
161 WM8994_INTERRUPT_STATUS_1_MASK);
163 dev_err(dev, "Failed to restore interrupt mask: %d\n", ret);
165 regcache_cache_only(wm8994->regmap, true);
166 wm8994->suspended = true;
168 ret = regulator_bulk_disable(wm8994->num_supplies,
171 dev_err(dev, "Failed to disable supplies: %d\n", ret);
178 static int wm8994_resume(struct device *dev)
180 struct wm8994 *wm8994 = dev_get_drvdata(dev);
183 /* We may have lied to the PM core about suspending */
184 if (!wm8994->suspended)
187 ret = regulator_bulk_enable(wm8994->num_supplies,
190 dev_err(dev, "Failed to enable supplies: %d\n", ret);
194 regcache_cache_only(wm8994->regmap, false);
195 ret = regcache_sync(wm8994->regmap);
197 dev_err(dev, "Failed to restore register map: %d\n", ret);
201 /* Disable LDO pulldowns while the device is active */
202 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
203 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
206 wm8994->suspended = false;
211 regulator_bulk_disable(wm8994->num_supplies, wm8994->supplies);
216 #ifdef CONFIG_REGULATOR
217 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
219 struct wm8994_ldo_pdata *ldo_pdata;
224 ldo_pdata = &pdata->ldo[ldo];
226 if (!ldo_pdata->init_data)
229 return ldo_pdata->init_data->num_consumer_supplies != 0;
232 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
238 static const struct reg_sequence wm8994_revc_patch[] = {
245 static const struct reg_sequence wm8958_reva_patch[] = {
252 static const struct reg_sequence wm1811_reva_patch[] = {
261 static int wm8994_set_pdata_from_of(struct wm8994 *wm8994)
263 struct device_node *np = wm8994->dev->of_node;
264 struct wm8994_pdata *pdata = &wm8994->pdata;
270 if (of_property_read_u32_array(np, "wlf,gpio-cfg", pdata->gpio_defaults,
271 ARRAY_SIZE(pdata->gpio_defaults)) >= 0) {
272 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
273 if (wm8994->pdata.gpio_defaults[i] == 0)
274 pdata->gpio_defaults[i]
275 = WM8994_CONFIGURE_GPIO;
279 of_property_read_u32_array(np, "wlf,micbias-cfg", pdata->micbias,
280 ARRAY_SIZE(pdata->micbias));
282 pdata->lineout1_diff = !of_property_read_bool(np, "wlf,lineout1-se");
283 pdata->lineout2_diff = !of_property_read_bool(np, "wlf,lineout2-se");
284 pdata->lineout1fb = of_property_read_bool(np, "wlf,lineout1-feedback");
285 pdata->lineout2fb = of_property_read_bool(np, "wlf,lineout2-feedback") ||
286 of_property_read_bool(np, "wlf,ldoena-always-driven");
288 pdata->spkmode_pu = of_property_read_bool(np, "wlf,spkmode-pu");
290 pdata->csnaddr_pd = of_property_read_bool(np, "wlf,csnaddr-pd");
295 static int wm8994_set_pdata_from_of(struct wm8994 *wm8994)
302 * Instantiate the generic non-control parts of the device.
304 static int wm8994_device_init(struct wm8994 *wm8994, int irq)
306 struct wm8994_pdata *pdata;
307 struct regmap_config *regmap_config;
308 const struct reg_sequence *regmap_patch = NULL;
310 int ret, i, patch_regs = 0;
313 if (dev_get_platdata(wm8994->dev)) {
314 pdata = dev_get_platdata(wm8994->dev);
315 wm8994->pdata = *pdata;
317 pdata = &wm8994->pdata;
319 ret = wm8994_set_pdata_from_of(wm8994);
323 /* Add the on-chip regulators first for bootstrapping */
324 ret = mfd_add_devices(wm8994->dev, 0,
325 wm8994_regulator_devs,
326 ARRAY_SIZE(wm8994_regulator_devs),
329 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
333 switch (wm8994->type) {
335 wm8994->num_supplies = ARRAY_SIZE(wm1811_main_supplies);
338 wm8994->num_supplies = ARRAY_SIZE(wm8994_main_supplies);
341 wm8994->num_supplies = ARRAY_SIZE(wm8958_main_supplies);
348 wm8994->supplies = devm_kcalloc(wm8994->dev,
349 wm8994->num_supplies,
350 sizeof(struct regulator_bulk_data),
352 if (!wm8994->supplies) {
357 switch (wm8994->type) {
359 for (i = 0; i < ARRAY_SIZE(wm1811_main_supplies); i++)
360 wm8994->supplies[i].supply = wm1811_main_supplies[i];
363 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
364 wm8994->supplies[i].supply = wm8994_main_supplies[i];
367 for (i = 0; i < ARRAY_SIZE(wm8958_main_supplies); i++)
368 wm8994->supplies[i].supply = wm8958_main_supplies[i];
376 * Can't use devres helper here as some of the supplies are provided by
377 * wm8994->dev's children (regulators) and those regulators are
378 * unregistered by the devres core before the supplies are freed.
380 ret = regulator_bulk_get(wm8994->dev, wm8994->num_supplies,
383 if (ret != -EPROBE_DEFER)
384 dev_err(wm8994->dev, "Failed to get supplies: %d\n",
389 ret = regulator_bulk_enable(wm8994->num_supplies, wm8994->supplies);
391 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
392 goto err_regulator_free;
395 ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
397 dev_err(wm8994->dev, "Failed to read ID register\n");
403 if (wm8994->type != WM1811)
404 dev_warn(wm8994->dev, "Device registered as type %d\n",
406 wm8994->type = WM1811;
410 if (wm8994->type != WM8994)
411 dev_warn(wm8994->dev, "Device registered as type %d\n",
413 wm8994->type = WM8994;
417 if (wm8994->type != WM8958)
418 dev_warn(wm8994->dev, "Device registered as type %d\n",
420 wm8994->type = WM8958;
423 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
429 ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
431 dev_err(wm8994->dev, "Failed to read revision register: %d\n",
435 wm8994->revision = ret & WM8994_CHIP_REV_MASK;
436 wm8994->cust_id = (ret & WM8994_CUST_ID_MASK) >> WM8994_CUST_ID_SHIFT;
438 switch (wm8994->type) {
440 switch (wm8994->revision) {
443 dev_warn(wm8994->dev,
444 "revision %c not fully supported\n",
445 'A' + wm8994->revision);
450 regmap_patch = wm8994_revc_patch;
451 patch_regs = ARRAY_SIZE(wm8994_revc_patch);
457 switch (wm8994->revision) {
459 regmap_patch = wm8958_reva_patch;
460 patch_regs = ARRAY_SIZE(wm8958_reva_patch);
468 /* Revision C did not change the relevant layer */
469 if (wm8994->revision > 1)
472 regmap_patch = wm1811_reva_patch;
473 patch_regs = ARRAY_SIZE(wm1811_reva_patch);
480 dev_info(wm8994->dev, "%s revision %c CUST_ID %02x\n", devname,
481 'A' + wm8994->revision, wm8994->cust_id);
483 switch (wm8994->type) {
485 regmap_config = &wm1811_regmap_config;
488 regmap_config = &wm8994_regmap_config;
491 regmap_config = &wm8958_regmap_config;
494 dev_err(wm8994->dev, "Unknown device type %d\n", wm8994->type);
499 ret = regmap_reinit_cache(wm8994->regmap, regmap_config);
501 dev_err(wm8994->dev, "Failed to reinit register cache: %d\n",
506 /* Explicitly put the device into reset in case regulators
507 * don't get disabled in order to ensure we know the device
510 ret = wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET,
511 wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET));
513 dev_err(wm8994->dev, "Failed to reset device: %d\n", ret);
518 ret = regmap_register_patch(wm8994->regmap, regmap_patch,
521 dev_err(wm8994->dev, "Failed to register patch: %d\n",
527 wm8994->irq_base = pdata->irq_base;
528 wm8994->gpio_base = pdata->gpio_base;
530 /* GPIO configuration is only applied if it's non-zero */
531 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
532 if (pdata->gpio_defaults[i]) {
533 wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
534 0xffff, pdata->gpio_defaults[i]);
538 wm8994->ldo_ena_always_driven = pdata->ldo_ena_always_driven;
540 if (pdata->spkmode_pu)
541 pulls |= WM8994_SPKMODE_PU;
542 if (pdata->csnaddr_pd)
543 pulls |= WM8994_CSNADDR_PD;
545 /* Disable unneeded pulls */
546 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
547 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD |
548 WM8994_SPKMODE_PU | WM8994_CSNADDR_PD,
551 /* In some system designs where the regulators are not in use,
552 * we can achieve a small reduction in leakage currents by
553 * floating LDO outputs. This bit makes no difference if the
554 * LDOs are enabled, it only affects cases where the LDOs were
555 * in operation and are then disabled.
557 for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
558 if (wm8994_ldo_in_use(pdata, i))
559 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
560 WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
562 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
563 WM8994_LDO1_DISCH, 0);
566 wm8994_irq_init(wm8994);
568 ret = mfd_add_devices(wm8994->dev, -1,
569 wm8994_devs, ARRAY_SIZE(wm8994_devs),
572 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
576 pm_runtime_set_active(wm8994->dev);
577 pm_runtime_enable(wm8994->dev);
578 pm_runtime_idle(wm8994->dev);
583 wm8994_irq_exit(wm8994);
585 regulator_bulk_disable(wm8994->num_supplies,
588 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
590 mfd_remove_devices(wm8994->dev);
594 static void wm8994_device_exit(struct wm8994 *wm8994)
596 pm_runtime_get_sync(wm8994->dev);
597 pm_runtime_disable(wm8994->dev);
598 pm_runtime_put_noidle(wm8994->dev);
599 wm8994_irq_exit(wm8994);
600 regulator_bulk_disable(wm8994->num_supplies, wm8994->supplies);
601 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
602 mfd_remove_devices(wm8994->dev);
605 static const struct of_device_id wm8994_of_match[] = {
606 { .compatible = "wlf,wm1811", .data = (void *)WM1811 },
607 { .compatible = "wlf,wm8994", .data = (void *)WM8994 },
608 { .compatible = "wlf,wm8958", .data = (void *)WM8958 },
611 MODULE_DEVICE_TABLE(of, wm8994_of_match);
613 static int wm8994_i2c_probe(struct i2c_client *i2c)
615 const struct i2c_device_id *id = i2c_client_get_device_id(i2c);
616 const struct of_device_id *of_id;
617 struct wm8994 *wm8994;
620 wm8994 = devm_kzalloc(&i2c->dev, sizeof(struct wm8994), GFP_KERNEL);
624 i2c_set_clientdata(i2c, wm8994);
625 wm8994->dev = &i2c->dev;
626 wm8994->irq = i2c->irq;
628 if (i2c->dev.of_node) {
629 of_id = of_match_device(wm8994_of_match, &i2c->dev);
631 wm8994->type = (uintptr_t)of_id->data;
633 wm8994->type = id->driver_data;
636 wm8994->regmap = devm_regmap_init_i2c(i2c, &wm8994_base_regmap_config);
637 if (IS_ERR(wm8994->regmap)) {
638 ret = PTR_ERR(wm8994->regmap);
639 dev_err(wm8994->dev, "Failed to allocate register map: %d\n",
644 return wm8994_device_init(wm8994, i2c->irq);
647 static void wm8994_i2c_remove(struct i2c_client *i2c)
649 struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
651 wm8994_device_exit(wm8994);
654 static const struct i2c_device_id wm8994_i2c_id[] = {
655 { "wm1811", WM1811 },
656 { "wm1811a", WM1811 },
657 { "wm8994", WM8994 },
658 { "wm8958", WM8958 },
661 MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
663 static const struct dev_pm_ops wm8994_pm_ops = {
664 RUNTIME_PM_OPS(wm8994_suspend, wm8994_resume, NULL)
667 static struct i2c_driver wm8994_i2c_driver = {
670 .pm = pm_ptr(&wm8994_pm_ops),
671 .of_match_table = wm8994_of_match,
673 .probe = wm8994_i2c_probe,
674 .remove = wm8994_i2c_remove,
675 .id_table = wm8994_i2c_id,
678 module_i2c_driver(wm8994_i2c_driver);
680 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
681 MODULE_LICENSE("GPL");
682 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
683 MODULE_SOFTDEP("pre: wm8994_regulator");