2 * wm8994-core.c -- Device access for Wolfson WM8994
4 * Copyright 2009 Wolfson Microelectronics PLC.
6 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
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/of_gpio.h>
25 #include <linux/pm_runtime.h>
26 #include <linux/regmap.h>
27 #include <linux/regulator/consumer.h>
28 #include <linux/regulator/machine.h>
30 #include <linux/mfd/wm8994/core.h>
31 #include <linux/mfd/wm8994/pdata.h>
32 #include <linux/mfd/wm8994/registers.h>
36 static const struct mfd_cell wm8994_regulator_devs
[] = {
40 .pm_runtime_no_callbacks
= true,
45 .pm_runtime_no_callbacks
= true,
49 static struct resource wm8994_codec_resources
[] = {
51 .start
= WM8994_IRQ_TEMP_SHUT
,
52 .end
= WM8994_IRQ_TEMP_WARN
,
53 .flags
= IORESOURCE_IRQ
,
57 static struct resource wm8994_gpio_resources
[] = {
59 .start
= WM8994_IRQ_GPIO(1),
60 .end
= WM8994_IRQ_GPIO(11),
61 .flags
= IORESOURCE_IRQ
,
65 static const struct mfd_cell wm8994_devs
[] = {
67 .name
= "wm8994-codec",
68 .num_resources
= ARRAY_SIZE(wm8994_codec_resources
),
69 .resources
= wm8994_codec_resources
,
73 .name
= "wm8994-gpio",
74 .num_resources
= ARRAY_SIZE(wm8994_gpio_resources
),
75 .resources
= wm8994_gpio_resources
,
76 .pm_runtime_no_callbacks
= true,
81 * Supplies for the main bulk of CODEC; the LDO supplies are ignored
82 * and should be handled via the standard regulator API supply
85 static const char *wm1811_main_supplies
[] = {
97 static const char *wm8994_main_supplies
[] = {
107 static const char *wm8958_main_supplies
[] = {
119 #ifdef CONFIG_PM_RUNTIME
120 static int wm8994_suspend(struct device
*dev
)
122 struct wm8994
*wm8994
= dev_get_drvdata(dev
);
125 /* Don't actually go through with the suspend if the CODEC is
126 * still active for accessory detect. */
127 switch (wm8994
->type
) {
130 ret
= wm8994_reg_read(wm8994
, WM8958_MIC_DETECT_1
);
132 dev_err(dev
, "Failed to read power status: %d\n", ret
);
133 } else if (ret
& WM8958_MICD_ENA
) {
134 dev_dbg(dev
, "CODEC still active, ignoring suspend\n");
142 /* Disable LDO pulldowns while the device is suspended if we
143 * don't know that something will be driving them. */
144 if (!wm8994
->ldo_ena_always_driven
)
145 wm8994_set_bits(wm8994
, WM8994_PULL_CONTROL_2
,
146 WM8994_LDO1ENA_PD
| WM8994_LDO2ENA_PD
,
147 WM8994_LDO1ENA_PD
| WM8994_LDO2ENA_PD
);
149 /* Explicitly put the device into reset in case regulators
150 * don't get disabled in order to ensure consistent restart.
152 wm8994_reg_write(wm8994
, WM8994_SOFTWARE_RESET
,
153 wm8994_reg_read(wm8994
, WM8994_SOFTWARE_RESET
));
155 regcache_mark_dirty(wm8994
->regmap
);
157 /* Restore GPIO registers to prevent problems with mismatched
158 * pin configurations.
160 ret
= regcache_sync_region(wm8994
->regmap
, WM8994_GPIO_1
,
163 dev_err(dev
, "Failed to restore GPIO registers: %d\n", ret
);
165 /* In case one of the GPIOs is used as a wake input. */
166 ret
= regcache_sync_region(wm8994
->regmap
,
167 WM8994_INTERRUPT_STATUS_1_MASK
,
168 WM8994_INTERRUPT_STATUS_1_MASK
);
170 dev_err(dev
, "Failed to restore interrupt mask: %d\n", ret
);
172 regcache_cache_only(wm8994
->regmap
, true);
173 wm8994
->suspended
= true;
175 ret
= regulator_bulk_disable(wm8994
->num_supplies
,
178 dev_err(dev
, "Failed to disable supplies: %d\n", ret
);
185 static int wm8994_resume(struct device
*dev
)
187 struct wm8994
*wm8994
= dev_get_drvdata(dev
);
190 /* We may have lied to the PM core about suspending */
191 if (!wm8994
->suspended
)
194 ret
= regulator_bulk_enable(wm8994
->num_supplies
,
197 dev_err(dev
, "Failed to enable supplies: %d\n", ret
);
201 regcache_cache_only(wm8994
->regmap
, false);
202 ret
= regcache_sync(wm8994
->regmap
);
204 dev_err(dev
, "Failed to restore register map: %d\n", ret
);
208 /* Disable LDO pulldowns while the device is active */
209 wm8994_set_bits(wm8994
, WM8994_PULL_CONTROL_2
,
210 WM8994_LDO1ENA_PD
| WM8994_LDO2ENA_PD
,
213 wm8994
->suspended
= false;
218 regulator_bulk_disable(wm8994
->num_supplies
, wm8994
->supplies
);
224 #ifdef CONFIG_REGULATOR
225 static int wm8994_ldo_in_use(struct wm8994_pdata
*pdata
, int ldo
)
227 struct wm8994_ldo_pdata
*ldo_pdata
;
232 ldo_pdata
= &pdata
->ldo
[ldo
];
234 if (!ldo_pdata
->init_data
)
237 return ldo_pdata
->init_data
->num_consumer_supplies
!= 0;
240 static int wm8994_ldo_in_use(struct wm8994_pdata
*pdata
, int ldo
)
246 static const struct reg_default wm8994_revc_patch
[] = {
253 static const struct reg_default wm8958_reva_patch
[] = {
260 static const struct reg_default wm1811_reva_patch
[] = {
269 static int wm8994_set_pdata_from_of(struct wm8994
*wm8994
)
271 struct device_node
*np
= wm8994
->dev
->of_node
;
272 struct wm8994_pdata
*pdata
= &wm8994
->pdata
;
278 if (of_property_read_u32_array(np
, "wlf,gpio-cfg", pdata
->gpio_defaults
,
279 ARRAY_SIZE(pdata
->gpio_defaults
)) >= 0) {
280 for (i
= 0; i
< ARRAY_SIZE(pdata
->gpio_defaults
); i
++) {
281 if (wm8994
->pdata
.gpio_defaults
[i
] == 0)
282 pdata
->gpio_defaults
[i
]
283 = WM8994_CONFIGURE_GPIO
;
287 of_property_read_u32_array(np
, "wlf,micbias-cfg", pdata
->micbias
,
288 ARRAY_SIZE(pdata
->micbias
));
290 pdata
->lineout1_diff
= true;
291 pdata
->lineout2_diff
= true;
292 if (of_find_property(np
, "wlf,lineout1-se", NULL
))
293 pdata
->lineout1_diff
= false;
294 if (of_find_property(np
, "wlf,lineout2-se", NULL
))
295 pdata
->lineout2_diff
= false;
297 if (of_find_property(np
, "wlf,lineout1-feedback", NULL
))
298 pdata
->lineout1fb
= true;
299 if (of_find_property(np
, "wlf,lineout2-feedback", NULL
))
300 pdata
->lineout2fb
= true;
302 if (of_find_property(np
, "wlf,ldoena-always-driven", NULL
))
303 pdata
->lineout2fb
= true;
305 pdata
->ldo
[0].enable
= of_get_named_gpio(np
, "wlf,ldo1ena", 0);
306 if (pdata
->ldo
[0].enable
< 0)
307 pdata
->ldo
[0].enable
= 0;
309 pdata
->ldo
[1].enable
= of_get_named_gpio(np
, "wlf,ldo2ena", 0);
310 if (pdata
->ldo
[1].enable
< 0)
311 pdata
->ldo
[1].enable
= 0;
316 static int wm8994_set_pdata_from_of(struct wm8994
*wm8994
)
323 * Instantiate the generic non-control parts of the device.
325 static int wm8994_device_init(struct wm8994
*wm8994
, int irq
)
327 struct wm8994_pdata
*pdata
;
328 struct regmap_config
*regmap_config
;
329 const struct reg_default
*regmap_patch
= NULL
;
331 int ret
, i
, patch_regs
= 0;
334 if (dev_get_platdata(wm8994
->dev
)) {
335 pdata
= dev_get_platdata(wm8994
->dev
);
336 wm8994
->pdata
= *pdata
;
338 pdata
= &wm8994
->pdata
;
340 ret
= wm8994_set_pdata_from_of(wm8994
);
344 dev_set_drvdata(wm8994
->dev
, wm8994
);
346 /* Add the on-chip regulators first for bootstrapping */
347 ret
= mfd_add_devices(wm8994
->dev
, -1,
348 wm8994_regulator_devs
,
349 ARRAY_SIZE(wm8994_regulator_devs
),
352 dev_err(wm8994
->dev
, "Failed to add children: %d\n", ret
);
356 switch (wm8994
->type
) {
358 wm8994
->num_supplies
= ARRAY_SIZE(wm1811_main_supplies
);
361 wm8994
->num_supplies
= ARRAY_SIZE(wm8994_main_supplies
);
364 wm8994
->num_supplies
= ARRAY_SIZE(wm8958_main_supplies
);
371 wm8994
->supplies
= devm_kzalloc(wm8994
->dev
,
372 sizeof(struct regulator_bulk_data
) *
373 wm8994
->num_supplies
, GFP_KERNEL
);
374 if (!wm8994
->supplies
) {
379 switch (wm8994
->type
) {
381 for (i
= 0; i
< ARRAY_SIZE(wm1811_main_supplies
); i
++)
382 wm8994
->supplies
[i
].supply
= wm1811_main_supplies
[i
];
385 for (i
= 0; i
< ARRAY_SIZE(wm8994_main_supplies
); i
++)
386 wm8994
->supplies
[i
].supply
= wm8994_main_supplies
[i
];
389 for (i
= 0; i
< ARRAY_SIZE(wm8958_main_supplies
); i
++)
390 wm8994
->supplies
[i
].supply
= wm8958_main_supplies
[i
];
397 ret
= devm_regulator_bulk_get(wm8994
->dev
, wm8994
->num_supplies
,
400 dev_err(wm8994
->dev
, "Failed to get supplies: %d\n", ret
);
404 ret
= regulator_bulk_enable(wm8994
->num_supplies
,
407 dev_err(wm8994
->dev
, "Failed to enable supplies: %d\n", ret
);
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
);
514 ret
= regmap_reinit_cache(wm8994
->regmap
, regmap_config
);
516 dev_err(wm8994
->dev
, "Failed to reinit register cache: %d\n",
521 /* Explicitly put the device into reset in case regulators
522 * don't get disabled in order to ensure we know the device
525 ret
= wm8994_reg_write(wm8994
, WM8994_SOFTWARE_RESET
,
526 wm8994_reg_read(wm8994
, WM8994_SOFTWARE_RESET
));
528 dev_err(wm8994
->dev
, "Failed to reset device: %d\n", ret
);
533 ret
= regmap_register_patch(wm8994
->regmap
, regmap_patch
,
536 dev_err(wm8994
->dev
, "Failed to register patch: %d\n",
542 wm8994
->irq_base
= pdata
->irq_base
;
543 wm8994
->gpio_base
= pdata
->gpio_base
;
545 /* GPIO configuration is only applied if it's non-zero */
546 for (i
= 0; i
< ARRAY_SIZE(pdata
->gpio_defaults
); i
++) {
547 if (pdata
->gpio_defaults
[i
]) {
548 wm8994_set_bits(wm8994
, WM8994_GPIO_1
+ i
,
549 0xffff, pdata
->gpio_defaults
[i
]);
553 wm8994
->ldo_ena_always_driven
= pdata
->ldo_ena_always_driven
;
555 if (pdata
->spkmode_pu
)
556 pulls
|= WM8994_SPKMODE_PU
;
558 /* Disable unneeded pulls */
559 wm8994_set_bits(wm8994
, WM8994_PULL_CONTROL_2
,
560 WM8994_LDO1ENA_PD
| WM8994_LDO2ENA_PD
|
561 WM8994_SPKMODE_PU
| WM8994_CSNADDR_PD
,
564 /* In some system designs where the regulators are not in use,
565 * we can achieve a small reduction in leakage currents by
566 * floating LDO outputs. This bit makes no difference if the
567 * LDOs are enabled, it only affects cases where the LDOs were
568 * in operation and are then disabled.
570 for (i
= 0; i
< WM8994_NUM_LDO_REGS
; i
++) {
571 if (wm8994_ldo_in_use(pdata
, i
))
572 wm8994_set_bits(wm8994
, WM8994_LDO_1
+ i
,
573 WM8994_LDO1_DISCH
, WM8994_LDO1_DISCH
);
575 wm8994_set_bits(wm8994
, WM8994_LDO_1
+ i
,
576 WM8994_LDO1_DISCH
, 0);
579 wm8994_irq_init(wm8994
);
581 ret
= mfd_add_devices(wm8994
->dev
, -1,
582 wm8994_devs
, ARRAY_SIZE(wm8994_devs
),
585 dev_err(wm8994
->dev
, "Failed to add children: %d\n", ret
);
589 pm_runtime_enable(wm8994
->dev
);
590 pm_runtime_idle(wm8994
->dev
);
595 wm8994_irq_exit(wm8994
);
597 regulator_bulk_disable(wm8994
->num_supplies
,
600 mfd_remove_devices(wm8994
->dev
);
604 static void wm8994_device_exit(struct wm8994
*wm8994
)
606 pm_runtime_disable(wm8994
->dev
);
607 mfd_remove_devices(wm8994
->dev
);
608 wm8994_irq_exit(wm8994
);
609 regulator_bulk_disable(wm8994
->num_supplies
,
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 .owner
= THIS_MODULE
,
681 .pm
= &wm8994_pm_ops
,
682 .of_match_table
= of_match_ptr(wm8994_of_match
),
684 .probe
= wm8994_i2c_probe
,
685 .remove
= wm8994_i2c_remove
,
686 .id_table
= wm8994_i2c_id
,
689 module_i2c_driver(wm8994_i2c_driver
);
691 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
692 MODULE_LICENSE("GPL");
693 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");