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 struct resource wm8994_codec_resources
[] = {
45 .start
= WM8994_IRQ_TEMP_SHUT
,
46 .end
= WM8994_IRQ_TEMP_WARN
,
47 .flags
= IORESOURCE_IRQ
,
51 static 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
[] = {
114 static int wm8994_suspend(struct device
*dev
)
116 struct wm8994
*wm8994
= dev_get_drvdata(dev
);
119 /* Don't actually go through with the suspend if the CODEC is
120 * still active for accessory detect. */
121 switch (wm8994
->type
) {
124 ret
= wm8994_reg_read(wm8994
, WM8958_MIC_DETECT_1
);
126 dev_err(dev
, "Failed to read power status: %d\n", ret
);
127 } else if (ret
& WM8958_MICD_ENA
) {
128 dev_dbg(dev
, "CODEC still active, ignoring suspend\n");
136 /* Disable LDO pulldowns while the device is suspended if we
137 * don't know that something will be driving them. */
138 if (!wm8994
->ldo_ena_always_driven
)
139 wm8994_set_bits(wm8994
, WM8994_PULL_CONTROL_2
,
140 WM8994_LDO1ENA_PD
| WM8994_LDO2ENA_PD
,
141 WM8994_LDO1ENA_PD
| WM8994_LDO2ENA_PD
);
143 /* Explicitly put the device into reset in case regulators
144 * don't get disabled in order to ensure consistent restart.
146 wm8994_reg_write(wm8994
, WM8994_SOFTWARE_RESET
,
147 wm8994_reg_read(wm8994
, WM8994_SOFTWARE_RESET
));
149 regcache_mark_dirty(wm8994
->regmap
);
151 /* Restore GPIO registers to prevent problems with mismatched
152 * pin configurations.
154 ret
= regcache_sync_region(wm8994
->regmap
, WM8994_GPIO_1
,
157 dev_err(dev
, "Failed to restore GPIO registers: %d\n", ret
);
159 /* In case one of the GPIOs is used as a wake input. */
160 ret
= regcache_sync_region(wm8994
->regmap
,
161 WM8994_INTERRUPT_STATUS_1_MASK
,
162 WM8994_INTERRUPT_STATUS_1_MASK
);
164 dev_err(dev
, "Failed to restore interrupt mask: %d\n", ret
);
166 regcache_cache_only(wm8994
->regmap
, true);
167 wm8994
->suspended
= true;
169 ret
= regulator_bulk_disable(wm8994
->num_supplies
,
172 dev_err(dev
, "Failed to disable supplies: %d\n", ret
);
179 static int wm8994_resume(struct device
*dev
)
181 struct wm8994
*wm8994
= dev_get_drvdata(dev
);
184 /* We may have lied to the PM core about suspending */
185 if (!wm8994
->suspended
)
188 ret
= regulator_bulk_enable(wm8994
->num_supplies
,
191 dev_err(dev
, "Failed to enable supplies: %d\n", ret
);
195 regcache_cache_only(wm8994
->regmap
, false);
196 ret
= regcache_sync(wm8994
->regmap
);
198 dev_err(dev
, "Failed to restore register map: %d\n", ret
);
202 /* Disable LDO pulldowns while the device is active */
203 wm8994_set_bits(wm8994
, WM8994_PULL_CONTROL_2
,
204 WM8994_LDO1ENA_PD
| WM8994_LDO2ENA_PD
,
207 wm8994
->suspended
= false;
212 regulator_bulk_disable(wm8994
->num_supplies
, wm8994
->supplies
);
218 #ifdef CONFIG_REGULATOR
219 static int wm8994_ldo_in_use(struct wm8994_pdata
*pdata
, int ldo
)
221 struct wm8994_ldo_pdata
*ldo_pdata
;
226 ldo_pdata
= &pdata
->ldo
[ldo
];
228 if (!ldo_pdata
->init_data
)
231 return ldo_pdata
->init_data
->num_consumer_supplies
!= 0;
234 static int wm8994_ldo_in_use(struct wm8994_pdata
*pdata
, int ldo
)
240 static const struct reg_sequence wm8994_revc_patch
[] = {
247 static const struct reg_sequence wm8958_reva_patch
[] = {
254 static const struct reg_sequence wm1811_reva_patch
[] = {
263 static int wm8994_set_pdata_from_of(struct wm8994
*wm8994
)
265 struct device_node
*np
= wm8994
->dev
->of_node
;
266 struct wm8994_pdata
*pdata
= &wm8994
->pdata
;
272 if (of_property_read_u32_array(np
, "wlf,gpio-cfg", pdata
->gpio_defaults
,
273 ARRAY_SIZE(pdata
->gpio_defaults
)) >= 0) {
274 for (i
= 0; i
< ARRAY_SIZE(pdata
->gpio_defaults
); i
++) {
275 if (wm8994
->pdata
.gpio_defaults
[i
] == 0)
276 pdata
->gpio_defaults
[i
]
277 = WM8994_CONFIGURE_GPIO
;
281 of_property_read_u32_array(np
, "wlf,micbias-cfg", pdata
->micbias
,
282 ARRAY_SIZE(pdata
->micbias
));
284 pdata
->lineout1_diff
= true;
285 pdata
->lineout2_diff
= true;
286 if (of_find_property(np
, "wlf,lineout1-se", NULL
))
287 pdata
->lineout1_diff
= false;
288 if (of_find_property(np
, "wlf,lineout2-se", NULL
))
289 pdata
->lineout2_diff
= false;
291 if (of_find_property(np
, "wlf,lineout1-feedback", NULL
))
292 pdata
->lineout1fb
= true;
293 if (of_find_property(np
, "wlf,lineout2-feedback", NULL
))
294 pdata
->lineout2fb
= true;
296 if (of_find_property(np
, "wlf,ldoena-always-driven", NULL
))
297 pdata
->lineout2fb
= true;
299 pdata
->spkmode_pu
= of_property_read_bool(np
, "wlf,spkmode-pu");
301 pdata
->csnaddr_pd
= of_property_read_bool(np
, "wlf,csnaddr-pd");
306 static int wm8994_set_pdata_from_of(struct wm8994
*wm8994
)
313 * Instantiate the generic non-control parts of the device.
315 static int wm8994_device_init(struct wm8994
*wm8994
, int irq
)
317 struct wm8994_pdata
*pdata
;
318 struct regmap_config
*regmap_config
;
319 const struct reg_sequence
*regmap_patch
= NULL
;
321 int ret
, i
, patch_regs
= 0;
324 if (dev_get_platdata(wm8994
->dev
)) {
325 pdata
= dev_get_platdata(wm8994
->dev
);
326 wm8994
->pdata
= *pdata
;
328 pdata
= &wm8994
->pdata
;
330 ret
= wm8994_set_pdata_from_of(wm8994
);
334 dev_set_drvdata(wm8994
->dev
, wm8994
);
336 /* Add the on-chip regulators first for bootstrapping */
337 ret
= mfd_add_devices(wm8994
->dev
, 0,
338 wm8994_regulator_devs
,
339 ARRAY_SIZE(wm8994_regulator_devs
),
342 dev_err(wm8994
->dev
, "Failed to add children: %d\n", ret
);
346 switch (wm8994
->type
) {
348 wm8994
->num_supplies
= ARRAY_SIZE(wm1811_main_supplies
);
351 wm8994
->num_supplies
= ARRAY_SIZE(wm8994_main_supplies
);
354 wm8994
->num_supplies
= ARRAY_SIZE(wm8958_main_supplies
);
361 wm8994
->supplies
= devm_kcalloc(wm8994
->dev
,
362 wm8994
->num_supplies
,
363 sizeof(struct regulator_bulk_data
),
365 if (!wm8994
->supplies
) {
370 switch (wm8994
->type
) {
372 for (i
= 0; i
< ARRAY_SIZE(wm1811_main_supplies
); i
++)
373 wm8994
->supplies
[i
].supply
= wm1811_main_supplies
[i
];
376 for (i
= 0; i
< ARRAY_SIZE(wm8994_main_supplies
); i
++)
377 wm8994
->supplies
[i
].supply
= wm8994_main_supplies
[i
];
380 for (i
= 0; i
< ARRAY_SIZE(wm8958_main_supplies
); i
++)
381 wm8994
->supplies
[i
].supply
= wm8958_main_supplies
[i
];
389 * Can't use devres helper here as some of the supplies are provided by
390 * wm8994->dev's children (regulators) and those regulators are
391 * unregistered by the devres core before the supplies are freed.
393 ret
= regulator_bulk_get(wm8994
->dev
, wm8994
->num_supplies
,
396 dev_err(wm8994
->dev
, "Failed to get supplies: %d\n", ret
);
400 ret
= regulator_bulk_enable(wm8994
->num_supplies
, wm8994
->supplies
);
402 dev_err(wm8994
->dev
, "Failed to enable supplies: %d\n", ret
);
403 goto err_regulator_free
;
406 ret
= wm8994_reg_read(wm8994
, WM8994_SOFTWARE_RESET
);
408 dev_err(wm8994
->dev
, "Failed to read ID register\n");
414 if (wm8994
->type
!= WM1811
)
415 dev_warn(wm8994
->dev
, "Device registered as type %d\n",
417 wm8994
->type
= WM1811
;
421 if (wm8994
->type
!= WM8994
)
422 dev_warn(wm8994
->dev
, "Device registered as type %d\n",
424 wm8994
->type
= WM8994
;
428 if (wm8994
->type
!= WM8958
)
429 dev_warn(wm8994
->dev
, "Device registered as type %d\n",
431 wm8994
->type
= WM8958
;
434 dev_err(wm8994
->dev
, "Device is not a WM8994, ID is %x\n",
440 ret
= wm8994_reg_read(wm8994
, WM8994_CHIP_REVISION
);
442 dev_err(wm8994
->dev
, "Failed to read revision register: %d\n",
446 wm8994
->revision
= ret
& WM8994_CHIP_REV_MASK
;
447 wm8994
->cust_id
= (ret
& WM8994_CUST_ID_MASK
) >> WM8994_CUST_ID_SHIFT
;
449 switch (wm8994
->type
) {
451 switch (wm8994
->revision
) {
454 dev_warn(wm8994
->dev
,
455 "revision %c not fully supported\n",
456 'A' + wm8994
->revision
);
461 regmap_patch
= wm8994_revc_patch
;
462 patch_regs
= ARRAY_SIZE(wm8994_revc_patch
);
468 switch (wm8994
->revision
) {
470 regmap_patch
= wm8958_reva_patch
;
471 patch_regs
= ARRAY_SIZE(wm8958_reva_patch
);
479 /* Revision C did not change the relevant layer */
480 if (wm8994
->revision
> 1)
483 regmap_patch
= wm1811_reva_patch
;
484 patch_regs
= ARRAY_SIZE(wm1811_reva_patch
);
491 dev_info(wm8994
->dev
, "%s revision %c CUST_ID %02x\n", devname
,
492 'A' + wm8994
->revision
, wm8994
->cust_id
);
494 switch (wm8994
->type
) {
496 regmap_config
= &wm1811_regmap_config
;
499 regmap_config
= &wm8994_regmap_config
;
502 regmap_config
= &wm8958_regmap_config
;
505 dev_err(wm8994
->dev
, "Unknown device type %d\n", wm8994
->type
);
510 ret
= regmap_reinit_cache(wm8994
->regmap
, regmap_config
);
512 dev_err(wm8994
->dev
, "Failed to reinit register cache: %d\n",
517 /* Explicitly put the device into reset in case regulators
518 * don't get disabled in order to ensure we know the device
521 ret
= wm8994_reg_write(wm8994
, WM8994_SOFTWARE_RESET
,
522 wm8994_reg_read(wm8994
, WM8994_SOFTWARE_RESET
));
524 dev_err(wm8994
->dev
, "Failed to reset device: %d\n", ret
);
529 ret
= regmap_register_patch(wm8994
->regmap
, regmap_patch
,
532 dev_err(wm8994
->dev
, "Failed to register patch: %d\n",
538 wm8994
->irq_base
= pdata
->irq_base
;
539 wm8994
->gpio_base
= pdata
->gpio_base
;
541 /* GPIO configuration is only applied if it's non-zero */
542 for (i
= 0; i
< ARRAY_SIZE(pdata
->gpio_defaults
); i
++) {
543 if (pdata
->gpio_defaults
[i
]) {
544 wm8994_set_bits(wm8994
, WM8994_GPIO_1
+ i
,
545 0xffff, pdata
->gpio_defaults
[i
]);
549 wm8994
->ldo_ena_always_driven
= pdata
->ldo_ena_always_driven
;
551 if (pdata
->spkmode_pu
)
552 pulls
|= WM8994_SPKMODE_PU
;
553 if (pdata
->csnaddr_pd
)
554 pulls
|= WM8994_CSNADDR_PD
;
556 /* Disable unneeded pulls */
557 wm8994_set_bits(wm8994
, WM8994_PULL_CONTROL_2
,
558 WM8994_LDO1ENA_PD
| WM8994_LDO2ENA_PD
|
559 WM8994_SPKMODE_PU
| WM8994_CSNADDR_PD
,
562 /* In some system designs where the regulators are not in use,
563 * we can achieve a small reduction in leakage currents by
564 * floating LDO outputs. This bit makes no difference if the
565 * LDOs are enabled, it only affects cases where the LDOs were
566 * in operation and are then disabled.
568 for (i
= 0; i
< WM8994_NUM_LDO_REGS
; i
++) {
569 if (wm8994_ldo_in_use(pdata
, i
))
570 wm8994_set_bits(wm8994
, WM8994_LDO_1
+ i
,
571 WM8994_LDO1_DISCH
, WM8994_LDO1_DISCH
);
573 wm8994_set_bits(wm8994
, WM8994_LDO_1
+ i
,
574 WM8994_LDO1_DISCH
, 0);
577 wm8994_irq_init(wm8994
);
579 ret
= mfd_add_devices(wm8994
->dev
, -1,
580 wm8994_devs
, ARRAY_SIZE(wm8994_devs
),
583 dev_err(wm8994
->dev
, "Failed to add children: %d\n", ret
);
587 pm_runtime_enable(wm8994
->dev
);
588 pm_runtime_idle(wm8994
->dev
);
593 wm8994_irq_exit(wm8994
);
595 regulator_bulk_disable(wm8994
->num_supplies
,
598 regulator_bulk_free(wm8994
->num_supplies
, wm8994
->supplies
);
600 mfd_remove_devices(wm8994
->dev
);
604 static void wm8994_device_exit(struct wm8994
*wm8994
)
606 pm_runtime_disable(wm8994
->dev
);
607 wm8994_irq_exit(wm8994
);
608 regulator_bulk_disable(wm8994
->num_supplies
, wm8994
->supplies
);
609 regulator_bulk_free(wm8994
->num_supplies
, wm8994
->supplies
);
610 mfd_remove_devices(wm8994
->dev
);
613 static const struct of_device_id wm8994_of_match
[] = {
614 { .compatible
= "wlf,wm1811", .data
= (void *)WM1811
},
615 { .compatible
= "wlf,wm8994", .data
= (void *)WM8994
},
616 { .compatible
= "wlf,wm8958", .data
= (void *)WM8958
},
619 MODULE_DEVICE_TABLE(of
, wm8994_of_match
);
621 static int wm8994_i2c_probe(struct i2c_client
*i2c
,
622 const struct i2c_device_id
*id
)
624 const struct of_device_id
*of_id
;
625 struct wm8994
*wm8994
;
628 wm8994
= devm_kzalloc(&i2c
->dev
, sizeof(struct wm8994
), GFP_KERNEL
);
632 i2c_set_clientdata(i2c
, wm8994
);
633 wm8994
->dev
= &i2c
->dev
;
634 wm8994
->irq
= i2c
->irq
;
636 if (i2c
->dev
.of_node
) {
637 of_id
= of_match_device(wm8994_of_match
, &i2c
->dev
);
639 wm8994
->type
= (enum wm8994_type
)of_id
->data
;
641 wm8994
->type
= id
->driver_data
;
644 wm8994
->regmap
= devm_regmap_init_i2c(i2c
, &wm8994_base_regmap_config
);
645 if (IS_ERR(wm8994
->regmap
)) {
646 ret
= PTR_ERR(wm8994
->regmap
);
647 dev_err(wm8994
->dev
, "Failed to allocate register map: %d\n",
652 return wm8994_device_init(wm8994
, i2c
->irq
);
655 static int wm8994_i2c_remove(struct i2c_client
*i2c
)
657 struct wm8994
*wm8994
= i2c_get_clientdata(i2c
);
659 wm8994_device_exit(wm8994
);
664 static const struct i2c_device_id wm8994_i2c_id
[] = {
665 { "wm1811", WM1811
},
666 { "wm1811a", WM1811
},
667 { "wm8994", WM8994
},
668 { "wm8958", WM8958
},
671 MODULE_DEVICE_TABLE(i2c
, wm8994_i2c_id
);
673 static const struct dev_pm_ops wm8994_pm_ops
= {
674 SET_RUNTIME_PM_OPS(wm8994_suspend
, wm8994_resume
, NULL
)
677 static struct i2c_driver wm8994_i2c_driver
= {
680 .pm
= &wm8994_pm_ops
,
681 .of_match_table
= of_match_ptr(wm8994_of_match
),
683 .probe
= wm8994_i2c_probe
,
684 .remove
= wm8994_i2c_remove
,
685 .id_table
= wm8994_i2c_id
,
688 module_i2c_driver(wm8994_i2c_driver
);
690 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
691 MODULE_LICENSE("GPL");
692 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");