1 // SPDX-License-Identifier: GPL-2.0-only
3 * Core MFD support for Cirrus Logic Madera codecs
5 * Copyright (C) 2015-2018 Cirrus Logic
8 #include <linux/device.h>
9 #include <linux/delay.h>
10 #include <linux/err.h>
11 #include <linux/gpio.h>
12 #include <linux/mfd/core.h>
13 #include <linux/module.h>
14 #include <linux/mutex.h>
15 #include <linux/notifier.h>
17 #include <linux/of_gpio.h>
18 #include <linux/platform_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>
23 #include <linux/regulator/of_regulator.h>
25 #include <linux/mfd/madera/core.h>
26 #include <linux/mfd/madera/registers.h>
30 #define CS47L15_SILICON_ID 0x6370
31 #define CS47L35_SILICON_ID 0x6360
32 #define CS47L85_SILICON_ID 0x6338
33 #define CS47L90_SILICON_ID 0x6364
34 #define CS47L92_SILICON_ID 0x6371
36 #define MADERA_32KZ_MCLK2 1
38 #define MADERA_RESET_MIN_US 2000
39 #define MADERA_RESET_MAX_US 3000
41 static const char * const madera_core_supplies[] = {
46 static const struct mfd_cell madera_ldo1_devs[] = {
48 .name = "madera-ldo1",
49 .level = MFD_DEP_LEVEL_HIGH,
53 static const char * const cs47l15_supplies[] = {
59 static const struct mfd_cell cs47l15_devs[] = {
60 { .name = "madera-pinctrl", },
61 { .name = "madera-irq", },
62 { .name = "madera-gpio", },
64 .name = "madera-extcon",
65 .parent_supplies = cs47l15_supplies,
66 .num_parent_supplies = 1, /* We only need MICVDD */
69 .name = "cs47l15-codec",
70 .parent_supplies = cs47l15_supplies,
71 .num_parent_supplies = ARRAY_SIZE(cs47l15_supplies),
75 static const char * const cs47l35_supplies[] = {
83 static const struct mfd_cell cs47l35_devs[] = {
84 { .name = "madera-pinctrl", },
85 { .name = "madera-irq", },
86 { .name = "madera-micsupp", },
87 { .name = "madera-gpio", },
89 .name = "madera-extcon",
90 .parent_supplies = cs47l35_supplies,
91 .num_parent_supplies = 1, /* We only need MICVDD */
94 .name = "cs47l35-codec",
95 .parent_supplies = cs47l35_supplies,
96 .num_parent_supplies = ARRAY_SIZE(cs47l35_supplies),
100 static const char * const cs47l85_supplies[] = {
111 static const struct mfd_cell cs47l85_devs[] = {
112 { .name = "madera-pinctrl", },
113 { .name = "madera-irq", },
114 { .name = "madera-micsupp", },
115 { .name = "madera-gpio", },
117 .name = "madera-extcon",
118 .parent_supplies = cs47l85_supplies,
119 .num_parent_supplies = 1, /* We only need MICVDD */
122 .name = "cs47l85-codec",
123 .parent_supplies = cs47l85_supplies,
124 .num_parent_supplies = ARRAY_SIZE(cs47l85_supplies),
128 static const char * const cs47l90_supplies[] = {
137 static const struct mfd_cell cs47l90_devs[] = {
138 { .name = "madera-pinctrl", },
139 { .name = "madera-irq", },
140 { .name = "madera-micsupp", },
141 { .name = "madera-gpio", },
143 .name = "madera-extcon",
144 .parent_supplies = cs47l90_supplies,
145 .num_parent_supplies = 1, /* We only need MICVDD */
148 .name = "cs47l90-codec",
149 .parent_supplies = cs47l90_supplies,
150 .num_parent_supplies = ARRAY_SIZE(cs47l90_supplies),
154 static const char * const cs47l92_supplies[] = {
160 static const struct mfd_cell cs47l92_devs[] = {
161 { .name = "madera-pinctrl", },
162 { .name = "madera-irq", },
163 { .name = "madera-micsupp", },
164 { .name = "madera-gpio", },
166 .name = "madera-extcon",
167 .parent_supplies = cs47l92_supplies,
168 .num_parent_supplies = 1, /* We only need MICVDD */
171 .name = "cs47l92-codec",
172 .parent_supplies = cs47l92_supplies,
173 .num_parent_supplies = ARRAY_SIZE(cs47l92_supplies),
177 /* Used by madera-i2c and madera-spi drivers */
178 const char *madera_name_from_type(enum madera_type type)
203 EXPORT_SYMBOL_GPL(madera_name_from_type);
205 #define MADERA_BOOT_POLL_INTERVAL_USEC 5000
206 #define MADERA_BOOT_POLL_TIMEOUT_USEC 25000
208 static int madera_wait_for_boot_noack(struct madera *madera)
211 unsigned int val = 0;
215 * We can't use an interrupt as we need to runtime resume to do so,
216 * so we poll the status bit. This won't race with the interrupt
217 * handler because it will be blocked on runtime resume.
218 * The chip could NAK a read request while it is booting so ignore
219 * errors from regmap_read.
221 timeout = ktime_add_us(ktime_get(), MADERA_BOOT_POLL_TIMEOUT_USEC);
222 regmap_read(madera->regmap, MADERA_IRQ1_RAW_STATUS_1, &val);
223 while (!(val & MADERA_BOOT_DONE_STS1) &&
224 !ktime_after(ktime_get(), timeout)) {
225 usleep_range(MADERA_BOOT_POLL_INTERVAL_USEC / 2,
226 MADERA_BOOT_POLL_INTERVAL_USEC);
227 regmap_read(madera->regmap, MADERA_IRQ1_RAW_STATUS_1, &val);
230 if (!(val & MADERA_BOOT_DONE_STS1)) {
231 dev_err(madera->dev, "Polling BOOT_DONE_STS timed out\n");
238 static int madera_wait_for_boot(struct madera *madera)
240 int ret = madera_wait_for_boot_noack(madera);
243 * BOOT_DONE defaults to unmasked on boot so we must ack it.
244 * Do this even after a timeout to avoid interrupt storms.
246 regmap_write(madera->regmap, MADERA_IRQ1_STATUS_1,
247 MADERA_BOOT_DONE_EINT1);
249 pm_runtime_mark_last_busy(madera->dev);
254 static int madera_soft_reset(struct madera *madera)
258 ret = regmap_write(madera->regmap, MADERA_SOFTWARE_RESET, 0);
260 dev_err(madera->dev, "Failed to soft reset device: %d\n", ret);
264 /* Allow time for internal clocks to startup after reset */
265 usleep_range(MADERA_RESET_MIN_US, MADERA_RESET_MAX_US);
270 static void madera_enable_hard_reset(struct madera *madera)
273 * There are many existing out-of-tree users of these codecs that we
274 * can't break so preserve the expected behaviour of setting the line
275 * low to assert reset.
277 gpiod_set_raw_value_cansleep(madera->pdata.reset, 0);
280 static void madera_disable_hard_reset(struct madera *madera)
282 gpiod_set_raw_value_cansleep(madera->pdata.reset, 1);
284 usleep_range(MADERA_RESET_MIN_US, MADERA_RESET_MAX_US);
287 static int __maybe_unused madera_runtime_resume(struct device *dev)
289 struct madera *madera = dev_get_drvdata(dev);
292 dev_dbg(dev, "Leaving sleep mode\n");
294 ret = regulator_enable(madera->dcvdd);
296 dev_err(dev, "Failed to enable DCVDD: %d\n", ret);
300 regcache_cache_only(madera->regmap, false);
301 regcache_cache_only(madera->regmap_32bit, false);
303 usleep_range(MADERA_RESET_MIN_US, MADERA_RESET_MAX_US);
305 ret = madera_wait_for_boot(madera);
309 ret = regcache_sync(madera->regmap);
311 dev_err(dev, "Failed to restore 16-bit register cache\n");
315 ret = regcache_sync(madera->regmap_32bit);
317 dev_err(dev, "Failed to restore 32-bit register cache\n");
324 regcache_cache_only(madera->regmap_32bit, true);
325 regcache_cache_only(madera->regmap, true);
326 regulator_disable(madera->dcvdd);
331 static int __maybe_unused madera_runtime_suspend(struct device *dev)
333 struct madera *madera = dev_get_drvdata(dev);
335 dev_dbg(madera->dev, "Entering sleep mode\n");
337 regcache_cache_only(madera->regmap, true);
338 regcache_mark_dirty(madera->regmap);
339 regcache_cache_only(madera->regmap_32bit, true);
340 regcache_mark_dirty(madera->regmap_32bit);
342 regulator_disable(madera->dcvdd);
347 const struct dev_pm_ops madera_pm_ops = {
348 SET_RUNTIME_PM_OPS(madera_runtime_suspend,
349 madera_runtime_resume,
352 EXPORT_SYMBOL_GPL(madera_pm_ops);
354 const struct of_device_id madera_of_match[] = {
355 { .compatible = "cirrus,cs47l15", .data = (void *)CS47L15 },
356 { .compatible = "cirrus,cs47l35", .data = (void *)CS47L35 },
357 { .compatible = "cirrus,cs47l85", .data = (void *)CS47L85 },
358 { .compatible = "cirrus,cs47l90", .data = (void *)CS47L90 },
359 { .compatible = "cirrus,cs47l91", .data = (void *)CS47L91 },
360 { .compatible = "cirrus,cs42l92", .data = (void *)CS42L92 },
361 { .compatible = "cirrus,cs47l92", .data = (void *)CS47L92 },
362 { .compatible = "cirrus,cs47l93", .data = (void *)CS47L93 },
363 { .compatible = "cirrus,wm1840", .data = (void *)WM1840 },
366 MODULE_DEVICE_TABLE(of, madera_of_match);
367 EXPORT_SYMBOL_GPL(madera_of_match);
369 static int madera_get_reset_gpio(struct madera *madera)
371 struct gpio_desc *reset;
374 if (madera->pdata.reset)
377 reset = devm_gpiod_get_optional(madera->dev, "reset", GPIOD_OUT_LOW);
379 ret = PTR_ERR(reset);
380 if (ret != -EPROBE_DEFER)
381 dev_err(madera->dev, "Failed to request /RESET: %d\n",
387 * A hard reset is needed for full reset of the chip. We allow running
388 * without hard reset only because it can be useful for early
389 * prototyping and some debugging, but we need to warn it's not ideal.
392 dev_warn(madera->dev,
393 "Running without reset GPIO is not recommended\n");
395 madera->pdata.reset = reset;
400 static void madera_set_micbias_info(struct madera *madera)
403 * num_childbias is an array because future codecs can have different
404 * childbiases for each micbias. Unspecified values default to 0.
406 switch (madera->type) {
408 madera->num_micbias = 1;
409 madera->num_childbias[0] = 3;
412 madera->num_micbias = 2;
413 madera->num_childbias[0] = 2;
414 madera->num_childbias[1] = 2;
418 madera->num_micbias = 4;
419 /* no child biases */
423 madera->num_micbias = 2;
424 madera->num_childbias[0] = 4;
425 madera->num_childbias[1] = 4;
430 madera->num_micbias = 2;
431 madera->num_childbias[0] = 4;
432 madera->num_childbias[1] = 2;
439 int madera_dev_init(struct madera *madera)
441 struct device *dev = madera->dev;
443 int (*patch_fn)(struct madera *) = NULL;
444 const struct mfd_cell *mfd_devs;
448 dev_set_drvdata(madera->dev, madera);
449 BLOCKING_INIT_NOTIFIER_HEAD(&madera->notifier);
450 mutex_init(&madera->dapm_ptr_lock);
452 madera_set_micbias_info(madera);
455 * We need writable hw config info that all children can share.
456 * Simplest to take one shared copy of pdata struct.
458 if (dev_get_platdata(madera->dev)) {
459 memcpy(&madera->pdata, dev_get_platdata(madera->dev),
460 sizeof(madera->pdata));
463 madera->mclk[MADERA_MCLK1].id = "mclk1";
464 madera->mclk[MADERA_MCLK2].id = "mclk2";
465 madera->mclk[MADERA_MCLK3].id = "mclk3";
467 ret = devm_clk_bulk_get_optional(madera->dev, ARRAY_SIZE(madera->mclk),
470 dev_err(madera->dev, "Failed to get clocks: %d\n", ret);
474 /* Not using devm_clk_get to prevent breakage of existing DTs */
475 if (!madera->mclk[MADERA_MCLK2].clk)
476 dev_warn(madera->dev, "Missing MCLK2, requires 32kHz clock\n");
478 ret = madera_get_reset_gpio(madera);
482 regcache_cache_only(madera->regmap, true);
483 regcache_cache_only(madera->regmap_32bit, true);
485 for (i = 0; i < ARRAY_SIZE(madera_core_supplies); i++)
486 madera->core_supplies[i].supply = madera_core_supplies[i];
488 madera->num_core_supplies = ARRAY_SIZE(madera_core_supplies);
491 * On some codecs DCVDD could be supplied by the internal LDO1.
492 * For those we must add the LDO1 driver before requesting DCVDD
493 * No devm_ because we need to control shutdown order of children.
495 switch (madera->type) {
506 ret = mfd_add_devices(madera->dev, PLATFORM_DEVID_NONE,
508 ARRAY_SIZE(madera_ldo1_devs),
511 dev_err(dev, "Failed to add LDO1 child: %d\n", ret);
516 /* No point continuing if the type is unknown */
517 dev_err(madera->dev, "Unknown device type %d\n", madera->type);
521 ret = devm_regulator_bulk_get(dev, madera->num_core_supplies,
522 madera->core_supplies);
524 dev_err(dev, "Failed to request core supplies: %d\n", ret);
529 * Don't use devres here. If the regulator is one of our children it
530 * will already have been removed before devres cleanup on this mfd
531 * driver tries to call put() on it. We need control of shutdown order.
533 madera->dcvdd = regulator_get(madera->dev, "DCVDD");
534 if (IS_ERR(madera->dcvdd)) {
535 ret = PTR_ERR(madera->dcvdd);
536 dev_err(dev, "Failed to request DCVDD: %d\n", ret);
540 ret = regulator_bulk_enable(madera->num_core_supplies,
541 madera->core_supplies);
543 dev_err(dev, "Failed to enable core supplies: %d\n", ret);
547 ret = regulator_enable(madera->dcvdd);
549 dev_err(dev, "Failed to enable DCVDD: %d\n", ret);
553 madera_disable_hard_reset(madera);
555 regcache_cache_only(madera->regmap, false);
556 regcache_cache_only(madera->regmap_32bit, false);
558 ret = madera_wait_for_boot_noack(madera);
560 dev_err(madera->dev, "Device failed initial boot: %d\n", ret);
565 * Now we can power up and verify that this is a chip we know about
566 * before we start doing any writes to its registers.
568 ret = regmap_read(madera->regmap, MADERA_SOFTWARE_RESET, &hwid);
570 dev_err(dev, "Failed to read ID register: %d\n", ret);
575 case CS47L15_SILICON_ID:
576 if (IS_ENABLED(CONFIG_MFD_CS47L15)) {
577 switch (madera->type) {
579 patch_fn = &cs47l15_patch;
580 mfd_devs = cs47l15_devs;
581 n_devs = ARRAY_SIZE(cs47l15_devs);
588 case CS47L35_SILICON_ID:
589 if (IS_ENABLED(CONFIG_MFD_CS47L35)) {
590 switch (madera->type) {
592 patch_fn = cs47l35_patch;
593 mfd_devs = cs47l35_devs;
594 n_devs = ARRAY_SIZE(cs47l35_devs);
601 case CS47L85_SILICON_ID:
602 if (IS_ENABLED(CONFIG_MFD_CS47L85)) {
603 switch (madera->type) {
606 patch_fn = cs47l85_patch;
607 mfd_devs = cs47l85_devs;
608 n_devs = ARRAY_SIZE(cs47l85_devs);
615 case CS47L90_SILICON_ID:
616 if (IS_ENABLED(CONFIG_MFD_CS47L90)) {
617 switch (madera->type) {
620 patch_fn = cs47l90_patch;
621 mfd_devs = cs47l90_devs;
622 n_devs = ARRAY_SIZE(cs47l90_devs);
629 case CS47L92_SILICON_ID:
630 if (IS_ENABLED(CONFIG_MFD_CS47L92)) {
631 switch (madera->type) {
635 patch_fn = cs47l92_patch;
636 mfd_devs = cs47l92_devs;
637 n_devs = ARRAY_SIZE(cs47l92_devs);
645 dev_err(madera->dev, "Unknown device ID: %x\n", hwid);
651 dev_err(madera->dev, "Device ID 0x%x not a %s\n", hwid,
658 * It looks like a device we support. If we don't have a hard reset
659 * we can now attempt a soft reset.
661 if (!madera->pdata.reset) {
662 ret = madera_soft_reset(madera);
667 ret = madera_wait_for_boot(madera);
669 dev_err(madera->dev, "Failed to clear boot done: %d\n", ret);
673 ret = regmap_read(madera->regmap, MADERA_HARDWARE_REVISION,
676 dev_err(dev, "Failed to read revision register: %d\n", ret);
679 madera->rev &= MADERA_HW_REVISION_MASK;
681 dev_info(dev, "%s silicon revision %d\n", madera->type_name,
684 /* Apply hardware patch */
686 ret = patch_fn(madera);
688 dev_err(madera->dev, "Failed to apply patch %d\n", ret);
693 /* Init 32k clock sourced from MCLK2 */
694 ret = clk_prepare_enable(madera->mclk[MADERA_MCLK2].clk);
696 dev_err(madera->dev, "Failed to enable 32k clock: %d\n", ret);
700 ret = regmap_update_bits(madera->regmap,
702 MADERA_CLK_32K_ENA_MASK | MADERA_CLK_32K_SRC_MASK,
703 MADERA_CLK_32K_ENA | MADERA_32KZ_MCLK2);
705 dev_err(madera->dev, "Failed to init 32k clock: %d\n", ret);
709 pm_runtime_set_active(madera->dev);
710 pm_runtime_enable(madera->dev);
711 pm_runtime_set_autosuspend_delay(madera->dev, 100);
712 pm_runtime_use_autosuspend(madera->dev);
714 /* No devm_ because we need to control shutdown order of children */
715 ret = mfd_add_devices(madera->dev, PLATFORM_DEVID_NONE,
719 dev_err(madera->dev, "Failed to add subdevices: %d\n", ret);
726 pm_runtime_disable(madera->dev);
728 clk_disable_unprepare(madera->mclk[MADERA_MCLK2].clk);
730 madera_enable_hard_reset(madera);
731 regulator_disable(madera->dcvdd);
733 regulator_bulk_disable(madera->num_core_supplies,
734 madera->core_supplies);
736 regulator_put(madera->dcvdd);
738 mfd_remove_devices(dev);
742 EXPORT_SYMBOL_GPL(madera_dev_init);
744 int madera_dev_exit(struct madera *madera)
746 /* Prevent any IRQs being serviced while we clean up */
747 disable_irq(madera->irq);
749 pm_runtime_get_sync(madera->dev);
751 mfd_remove_devices(madera->dev);
753 pm_runtime_disable(madera->dev);
755 regulator_disable(madera->dcvdd);
756 regulator_put(madera->dcvdd);
758 mfd_remove_devices_late(madera->dev);
760 pm_runtime_set_suspended(madera->dev);
761 pm_runtime_put_noidle(madera->dev);
763 clk_disable_unprepare(madera->mclk[MADERA_MCLK2].clk);
765 madera_enable_hard_reset(madera);
767 regulator_bulk_disable(madera->num_core_supplies,
768 madera->core_supplies);
771 EXPORT_SYMBOL_GPL(madera_dev_exit);
773 MODULE_DESCRIPTION("Madera core MFD driver");
775 MODULE_LICENSE("GPL v2");