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/pm_runtime.h>
19 #include <linux/regmap.h>
20 #include <linux/regulator/consumer.h>
21 #include <linux/regulator/machine.h>
23 #include <linux/mfd/wm8994/core.h>
24 #include <linux/mfd/wm8994/pdata.h>
25 #include <linux/mfd/wm8994/registers.h>
29 static const struct mfd_cell wm8994_regulator_devs
[] = {
33 .pm_runtime_no_callbacks
= true,
38 .pm_runtime_no_callbacks
= true,
42 static const struct resource wm8994_codec_resources
[] = {
44 .start
= WM8994_IRQ_TEMP_SHUT
,
45 .end
= WM8994_IRQ_TEMP_WARN
,
46 .flags
= IORESOURCE_IRQ
,
50 static const struct resource wm8994_gpio_resources
[] = {
52 .start
= WM8994_IRQ_GPIO(1),
53 .end
= WM8994_IRQ_GPIO(11),
54 .flags
= IORESOURCE_IRQ
,
58 static const struct mfd_cell wm8994_devs
[] = {
60 .name
= "wm8994-codec",
61 .num_resources
= ARRAY_SIZE(wm8994_codec_resources
),
62 .resources
= wm8994_codec_resources
,
66 .name
= "wm8994-gpio",
67 .num_resources
= ARRAY_SIZE(wm8994_gpio_resources
),
68 .resources
= wm8994_gpio_resources
,
69 .pm_runtime_no_callbacks
= true,
74 * Supplies for the main bulk of CODEC; the LDO supplies are ignored
75 * and should be handled via the standard regulator API supply
78 static const char *wm1811_main_supplies
[] = {
90 static const char *wm8994_main_supplies
[] = {
100 static const char *wm8958_main_supplies
[] = {
112 static int wm8994_suspend(struct device
*dev
)
114 struct wm8994
*wm8994
= dev_get_drvdata(dev
);
117 /* Don't actually go through with the suspend if the CODEC is
118 * still active for accessory detect. */
119 switch (wm8994
->type
) {
122 ret
= wm8994_reg_read(wm8994
, WM8958_MIC_DETECT_1
);
124 dev_err(dev
, "Failed to read power status: %d\n", ret
);
125 } else if (ret
& WM8958_MICD_ENA
) {
126 dev_dbg(dev
, "CODEC still active, ignoring suspend\n");
134 /* Disable LDO pulldowns while the device is suspended if we
135 * don't know that something will be driving them. */
136 if (!wm8994
->ldo_ena_always_driven
)
137 wm8994_set_bits(wm8994
, WM8994_PULL_CONTROL_2
,
138 WM8994_LDO1ENA_PD
| WM8994_LDO2ENA_PD
,
139 WM8994_LDO1ENA_PD
| WM8994_LDO2ENA_PD
);
141 /* Explicitly put the device into reset in case regulators
142 * don't get disabled in order to ensure consistent restart.
144 wm8994_reg_write(wm8994
, WM8994_SOFTWARE_RESET
,
145 wm8994_reg_read(wm8994
, WM8994_SOFTWARE_RESET
));
147 regcache_mark_dirty(wm8994
->regmap
);
149 /* Restore GPIO registers to prevent problems with mismatched
150 * pin configurations.
152 ret
= regcache_sync_region(wm8994
->regmap
, WM8994_GPIO_1
,
155 dev_err(dev
, "Failed to restore GPIO registers: %d\n", ret
);
157 /* In case one of the GPIOs is used as a wake input. */
158 ret
= regcache_sync_region(wm8994
->regmap
,
159 WM8994_INTERRUPT_STATUS_1_MASK
,
160 WM8994_INTERRUPT_STATUS_1_MASK
);
162 dev_err(dev
, "Failed to restore interrupt mask: %d\n", ret
);
164 regcache_cache_only(wm8994
->regmap
, true);
165 wm8994
->suspended
= true;
167 ret
= regulator_bulk_disable(wm8994
->num_supplies
,
170 dev_err(dev
, "Failed to disable supplies: %d\n", ret
);
177 static int wm8994_resume(struct device
*dev
)
179 struct wm8994
*wm8994
= dev_get_drvdata(dev
);
182 /* We may have lied to the PM core about suspending */
183 if (!wm8994
->suspended
)
186 ret
= regulator_bulk_enable(wm8994
->num_supplies
,
189 dev_err(dev
, "Failed to enable supplies: %d\n", ret
);
193 regcache_cache_only(wm8994
->regmap
, false);
194 ret
= regcache_sync(wm8994
->regmap
);
196 dev_err(dev
, "Failed to restore register map: %d\n", ret
);
200 /* Disable LDO pulldowns while the device is active */
201 wm8994_set_bits(wm8994
, WM8994_PULL_CONTROL_2
,
202 WM8994_LDO1ENA_PD
| WM8994_LDO2ENA_PD
,
205 wm8994
->suspended
= false;
210 regulator_bulk_disable(wm8994
->num_supplies
, wm8994
->supplies
);
215 #ifdef CONFIG_REGULATOR
216 static int wm8994_ldo_in_use(struct wm8994_pdata
*pdata
, int ldo
)
218 struct wm8994_ldo_pdata
*ldo_pdata
;
223 ldo_pdata
= &pdata
->ldo
[ldo
];
225 if (!ldo_pdata
->init_data
)
228 return ldo_pdata
->init_data
->num_consumer_supplies
!= 0;
231 static int wm8994_ldo_in_use(struct wm8994_pdata
*pdata
, int ldo
)
237 static const struct reg_sequence wm8994_revc_patch
[] = {
244 static const struct reg_sequence wm8958_reva_patch
[] = {
251 static const struct reg_sequence wm1811_reva_patch
[] = {
260 static int wm8994_set_pdata_from_of(struct wm8994
*wm8994
)
262 struct device_node
*np
= wm8994
->dev
->of_node
;
263 struct wm8994_pdata
*pdata
= &wm8994
->pdata
;
269 if (of_property_read_u32_array(np
, "wlf,gpio-cfg", pdata
->gpio_defaults
,
270 ARRAY_SIZE(pdata
->gpio_defaults
)) >= 0) {
271 for (i
= 0; i
< ARRAY_SIZE(pdata
->gpio_defaults
); i
++) {
272 if (wm8994
->pdata
.gpio_defaults
[i
] == 0)
273 pdata
->gpio_defaults
[i
]
274 = WM8994_CONFIGURE_GPIO
;
278 of_property_read_u32_array(np
, "wlf,micbias-cfg", pdata
->micbias
,
279 ARRAY_SIZE(pdata
->micbias
));
281 pdata
->lineout1_diff
= !of_property_read_bool(np
, "wlf,lineout1-se");
282 pdata
->lineout2_diff
= !of_property_read_bool(np
, "wlf,lineout2-se");
283 pdata
->lineout1fb
= of_property_read_bool(np
, "wlf,lineout1-feedback");
284 pdata
->lineout2fb
= of_property_read_bool(np
, "wlf,lineout2-feedback") ||
285 of_property_read_bool(np
, "wlf,ldoena-always-driven");
287 pdata
->spkmode_pu
= of_property_read_bool(np
, "wlf,spkmode-pu");
289 pdata
->csnaddr_pd
= of_property_read_bool(np
, "wlf,csnaddr-pd");
294 static int wm8994_set_pdata_from_of(struct wm8994
*wm8994
)
301 * Instantiate the generic non-control parts of the device.
303 static int wm8994_device_init(struct wm8994
*wm8994
, int irq
)
305 struct wm8994_pdata
*pdata
;
306 struct regmap_config
*regmap_config
;
307 const struct reg_sequence
*regmap_patch
= NULL
;
309 int ret
, i
, patch_regs
= 0;
312 if (dev_get_platdata(wm8994
->dev
)) {
313 pdata
= dev_get_platdata(wm8994
->dev
);
314 wm8994
->pdata
= *pdata
;
316 pdata
= &wm8994
->pdata
;
318 ret
= wm8994_set_pdata_from_of(wm8994
);
322 /* Add the on-chip regulators first for bootstrapping */
323 ret
= mfd_add_devices(wm8994
->dev
, 0,
324 wm8994_regulator_devs
,
325 ARRAY_SIZE(wm8994_regulator_devs
),
328 dev_err(wm8994
->dev
, "Failed to add children: %d\n", ret
);
332 switch (wm8994
->type
) {
334 wm8994
->num_supplies
= ARRAY_SIZE(wm1811_main_supplies
);
337 wm8994
->num_supplies
= ARRAY_SIZE(wm8994_main_supplies
);
340 wm8994
->num_supplies
= ARRAY_SIZE(wm8958_main_supplies
);
347 wm8994
->supplies
= devm_kcalloc(wm8994
->dev
,
348 wm8994
->num_supplies
,
349 sizeof(struct regulator_bulk_data
),
351 if (!wm8994
->supplies
) {
356 switch (wm8994
->type
) {
358 for (i
= 0; i
< ARRAY_SIZE(wm1811_main_supplies
); i
++)
359 wm8994
->supplies
[i
].supply
= wm1811_main_supplies
[i
];
362 for (i
= 0; i
< ARRAY_SIZE(wm8994_main_supplies
); i
++)
363 wm8994
->supplies
[i
].supply
= wm8994_main_supplies
[i
];
366 for (i
= 0; i
< ARRAY_SIZE(wm8958_main_supplies
); i
++)
367 wm8994
->supplies
[i
].supply
= wm8958_main_supplies
[i
];
375 * Can't use devres helper here as some of the supplies are provided by
376 * wm8994->dev's children (regulators) and those regulators are
377 * unregistered by the devres core before the supplies are freed.
379 ret
= regulator_bulk_get(wm8994
->dev
, wm8994
->num_supplies
,
382 if (ret
!= -EPROBE_DEFER
)
383 dev_err(wm8994
->dev
, "Failed to get supplies: %d\n",
388 ret
= regulator_bulk_enable(wm8994
->num_supplies
, wm8994
->supplies
);
390 dev_err(wm8994
->dev
, "Failed to enable supplies: %d\n", ret
);
391 goto err_regulator_free
;
394 ret
= wm8994_reg_read(wm8994
, WM8994_SOFTWARE_RESET
);
396 dev_err(wm8994
->dev
, "Failed to read ID register\n");
402 if (wm8994
->type
!= WM1811
)
403 dev_warn(wm8994
->dev
, "Device registered as type %d\n",
405 wm8994
->type
= WM1811
;
409 if (wm8994
->type
!= WM8994
)
410 dev_warn(wm8994
->dev
, "Device registered as type %d\n",
412 wm8994
->type
= WM8994
;
416 if (wm8994
->type
!= WM8958
)
417 dev_warn(wm8994
->dev
, "Device registered as type %d\n",
419 wm8994
->type
= WM8958
;
422 dev_err(wm8994
->dev
, "Device is not a WM8994, ID is %x\n",
428 ret
= wm8994_reg_read(wm8994
, WM8994_CHIP_REVISION
);
430 dev_err(wm8994
->dev
, "Failed to read revision register: %d\n",
434 wm8994
->revision
= ret
& WM8994_CHIP_REV_MASK
;
435 wm8994
->cust_id
= (ret
& WM8994_CUST_ID_MASK
) >> WM8994_CUST_ID_SHIFT
;
437 switch (wm8994
->type
) {
439 switch (wm8994
->revision
) {
442 dev_warn(wm8994
->dev
,
443 "revision %c not fully supported\n",
444 'A' + wm8994
->revision
);
449 regmap_patch
= wm8994_revc_patch
;
450 patch_regs
= ARRAY_SIZE(wm8994_revc_patch
);
456 switch (wm8994
->revision
) {
458 regmap_patch
= wm8958_reva_patch
;
459 patch_regs
= ARRAY_SIZE(wm8958_reva_patch
);
467 /* Revision C did not change the relevant layer */
468 if (wm8994
->revision
> 1)
471 regmap_patch
= wm1811_reva_patch
;
472 patch_regs
= ARRAY_SIZE(wm1811_reva_patch
);
479 dev_info(wm8994
->dev
, "%s revision %c CUST_ID %02x\n", devname
,
480 'A' + wm8994
->revision
, wm8994
->cust_id
);
482 switch (wm8994
->type
) {
484 regmap_config
= &wm1811_regmap_config
;
487 regmap_config
= &wm8994_regmap_config
;
490 regmap_config
= &wm8958_regmap_config
;
493 dev_err(wm8994
->dev
, "Unknown device type %d\n", wm8994
->type
);
498 ret
= regmap_reinit_cache(wm8994
->regmap
, regmap_config
);
500 dev_err(wm8994
->dev
, "Failed to reinit register cache: %d\n",
505 /* Explicitly put the device into reset in case regulators
506 * don't get disabled in order to ensure we know the device
509 ret
= wm8994_reg_write(wm8994
, WM8994_SOFTWARE_RESET
,
510 wm8994_reg_read(wm8994
, WM8994_SOFTWARE_RESET
));
512 dev_err(wm8994
->dev
, "Failed to reset device: %d\n", ret
);
517 ret
= regmap_register_patch(wm8994
->regmap
, regmap_patch
,
520 dev_err(wm8994
->dev
, "Failed to register patch: %d\n",
526 wm8994
->irq_base
= pdata
->irq_base
;
527 wm8994
->gpio_base
= pdata
->gpio_base
;
529 /* GPIO configuration is only applied if it's non-zero */
530 for (i
= 0; i
< ARRAY_SIZE(pdata
->gpio_defaults
); i
++) {
531 if (pdata
->gpio_defaults
[i
]) {
532 wm8994_set_bits(wm8994
, WM8994_GPIO_1
+ i
,
533 0xffff, pdata
->gpio_defaults
[i
]);
537 wm8994
->ldo_ena_always_driven
= pdata
->ldo_ena_always_driven
;
539 if (pdata
->spkmode_pu
)
540 pulls
|= WM8994_SPKMODE_PU
;
541 if (pdata
->csnaddr_pd
)
542 pulls
|= WM8994_CSNADDR_PD
;
544 /* Disable unneeded pulls */
545 wm8994_set_bits(wm8994
, WM8994_PULL_CONTROL_2
,
546 WM8994_LDO1ENA_PD
| WM8994_LDO2ENA_PD
|
547 WM8994_SPKMODE_PU
| WM8994_CSNADDR_PD
,
550 /* In some system designs where the regulators are not in use,
551 * we can achieve a small reduction in leakage currents by
552 * floating LDO outputs. This bit makes no difference if the
553 * LDOs are enabled, it only affects cases where the LDOs were
554 * in operation and are then disabled.
556 for (i
= 0; i
< WM8994_NUM_LDO_REGS
; i
++) {
557 if (wm8994_ldo_in_use(pdata
, i
))
558 wm8994_set_bits(wm8994
, WM8994_LDO_1
+ i
,
559 WM8994_LDO1_DISCH
, WM8994_LDO1_DISCH
);
561 wm8994_set_bits(wm8994
, WM8994_LDO_1
+ i
,
562 WM8994_LDO1_DISCH
, 0);
565 wm8994_irq_init(wm8994
);
567 ret
= mfd_add_devices(wm8994
->dev
, -1,
568 wm8994_devs
, ARRAY_SIZE(wm8994_devs
),
571 dev_err(wm8994
->dev
, "Failed to add children: %d\n", ret
);
575 pm_runtime_set_active(wm8994
->dev
);
576 pm_runtime_enable(wm8994
->dev
);
577 pm_runtime_idle(wm8994
->dev
);
582 wm8994_irq_exit(wm8994
);
584 regulator_bulk_disable(wm8994
->num_supplies
,
587 regulator_bulk_free(wm8994
->num_supplies
, wm8994
->supplies
);
589 mfd_remove_devices(wm8994
->dev
);
593 static void wm8994_device_exit(struct wm8994
*wm8994
)
595 pm_runtime_get_sync(wm8994
->dev
);
596 pm_runtime_disable(wm8994
->dev
);
597 pm_runtime_put_noidle(wm8994
->dev
);
598 wm8994_irq_exit(wm8994
);
599 regulator_bulk_disable(wm8994
->num_supplies
, wm8994
->supplies
);
600 regulator_bulk_free(wm8994
->num_supplies
, wm8994
->supplies
);
601 mfd_remove_devices(wm8994
->dev
);
604 static const struct of_device_id wm8994_of_match
[] = {
605 { .compatible
= "wlf,wm1811", .data
= (void *)WM1811
},
606 { .compatible
= "wlf,wm8994", .data
= (void *)WM8994
},
607 { .compatible
= "wlf,wm8958", .data
= (void *)WM8958
},
610 MODULE_DEVICE_TABLE(of
, wm8994_of_match
);
612 static int wm8994_i2c_probe(struct i2c_client
*i2c
)
614 struct wm8994
*wm8994
;
617 wm8994
= devm_kzalloc(&i2c
->dev
, sizeof(struct wm8994
), GFP_KERNEL
);
621 i2c_set_clientdata(i2c
, wm8994
);
622 wm8994
->dev
= &i2c
->dev
;
623 wm8994
->irq
= i2c
->irq
;
625 wm8994
->type
= (kernel_ulong_t
)i2c_get_match_data(i2c
);
627 wm8994
->regmap
= devm_regmap_init_i2c(i2c
, &wm8994_base_regmap_config
);
628 if (IS_ERR(wm8994
->regmap
)) {
629 ret
= PTR_ERR(wm8994
->regmap
);
630 dev_err(wm8994
->dev
, "Failed to allocate register map: %d\n",
635 return wm8994_device_init(wm8994
, i2c
->irq
);
638 static void wm8994_i2c_remove(struct i2c_client
*i2c
)
640 struct wm8994
*wm8994
= i2c_get_clientdata(i2c
);
642 wm8994_device_exit(wm8994
);
645 static const struct i2c_device_id wm8994_i2c_id
[] = {
646 { "wm1811", WM1811
},
647 { "wm1811a", WM1811
},
648 { "wm8994", WM8994
},
649 { "wm8958", WM8958
},
652 MODULE_DEVICE_TABLE(i2c
, wm8994_i2c_id
);
654 static const struct dev_pm_ops wm8994_pm_ops
= {
655 RUNTIME_PM_OPS(wm8994_suspend
, wm8994_resume
, NULL
)
658 static struct i2c_driver wm8994_i2c_driver
= {
661 .pm
= pm_ptr(&wm8994_pm_ops
),
662 .of_match_table
= wm8994_of_match
,
664 .probe
= wm8994_i2c_probe
,
665 .remove
= wm8994_i2c_remove
,
666 .id_table
= wm8994_i2c_id
,
669 module_i2c_driver(wm8994_i2c_driver
);
671 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
672 MODULE_LICENSE("GPL");
673 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
674 MODULE_SOFTDEP("pre: wm8994_regulator");