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>
22 #include <linux/pm_runtime.h>
23 #include <linux/regmap.h>
24 #include <linux/regulator/consumer.h>
25 #include <linux/regulator/machine.h>
27 #include <linux/mfd/wm8994/core.h>
28 #include <linux/mfd/wm8994/pdata.h>
29 #include <linux/mfd/wm8994/registers.h>
34 * wm8994_reg_read: Read a single WM8994 register.
36 * @wm8994: Device to read from.
37 * @reg: Register to read.
39 int wm8994_reg_read(struct wm8994
*wm8994
, unsigned short reg
)
44 ret
= regmap_read(wm8994
->regmap
, reg
, &val
);
51 EXPORT_SYMBOL_GPL(wm8994_reg_read
);
54 * wm8994_bulk_read: Read multiple WM8994 registers
56 * @wm8994: Device to read from
57 * @reg: First register
58 * @count: Number of registers
59 * @buf: Buffer to fill. The data will be returned big endian.
61 int wm8994_bulk_read(struct wm8994
*wm8994
, unsigned short reg
,
64 return regmap_bulk_read(wm8994
->regmap
, reg
, buf
, count
);
68 * wm8994_reg_write: Write a single WM8994 register.
70 * @wm8994: Device to write to.
71 * @reg: Register to write to.
72 * @val: Value to write.
74 int wm8994_reg_write(struct wm8994
*wm8994
, unsigned short reg
,
77 return regmap_write(wm8994
->regmap
, reg
, val
);
79 EXPORT_SYMBOL_GPL(wm8994_reg_write
);
82 * wm8994_bulk_write: Write multiple WM8994 registers
84 * @wm8994: Device to write to
85 * @reg: First register
86 * @count: Number of registers
87 * @buf: Buffer to write from. Data must be big-endian formatted.
89 int wm8994_bulk_write(struct wm8994
*wm8994
, unsigned short reg
,
90 int count
, const u16
*buf
)
92 return regmap_raw_write(wm8994
->regmap
, reg
, buf
, count
* sizeof(u16
));
94 EXPORT_SYMBOL_GPL(wm8994_bulk_write
);
97 * wm8994_set_bits: Set the value of a bitfield in a WM8994 register
99 * @wm8994: Device to write to.
100 * @reg: Register to write to.
101 * @mask: Mask of bits to set.
102 * @val: Value to set (unshifted)
104 int wm8994_set_bits(struct wm8994
*wm8994
, unsigned short reg
,
105 unsigned short mask
, unsigned short val
)
107 return regmap_update_bits(wm8994
->regmap
, reg
, mask
, val
);
109 EXPORT_SYMBOL_GPL(wm8994_set_bits
);
111 static struct mfd_cell wm8994_regulator_devs
[] = {
113 .name
= "wm8994-ldo",
115 .pm_runtime_no_callbacks
= true,
118 .name
= "wm8994-ldo",
120 .pm_runtime_no_callbacks
= true,
124 static struct resource wm8994_codec_resources
[] = {
126 .start
= WM8994_IRQ_TEMP_SHUT
,
127 .end
= WM8994_IRQ_TEMP_WARN
,
128 .flags
= IORESOURCE_IRQ
,
132 static struct resource wm8994_gpio_resources
[] = {
134 .start
= WM8994_IRQ_GPIO(1),
135 .end
= WM8994_IRQ_GPIO(11),
136 .flags
= IORESOURCE_IRQ
,
140 static struct mfd_cell wm8994_devs
[] = {
142 .name
= "wm8994-codec",
143 .num_resources
= ARRAY_SIZE(wm8994_codec_resources
),
144 .resources
= wm8994_codec_resources
,
148 .name
= "wm8994-gpio",
149 .num_resources
= ARRAY_SIZE(wm8994_gpio_resources
),
150 .resources
= wm8994_gpio_resources
,
151 .pm_runtime_no_callbacks
= true,
156 * Supplies for the main bulk of CODEC; the LDO supplies are ignored
157 * and should be handled via the standard regulator API supply
160 static const char *wm1811_main_supplies
[] = {
172 static const char *wm8994_main_supplies
[] = {
182 static const char *wm8958_main_supplies
[] = {
195 static int wm8994_suspend(struct device
*dev
)
197 struct wm8994
*wm8994
= dev_get_drvdata(dev
);
200 /* Don't actually go through with the suspend if the CODEC is
201 * still active (eg, for audio passthrough from CP. */
202 ret
= wm8994_reg_read(wm8994
, WM8994_POWER_MANAGEMENT_1
);
204 dev_err(dev
, "Failed to read power status: %d\n", ret
);
205 } else if (ret
& WM8994_VMID_SEL_MASK
) {
206 dev_dbg(dev
, "CODEC still active, ignoring suspend\n");
210 ret
= wm8994_reg_read(wm8994
, WM8994_POWER_MANAGEMENT_4
);
212 dev_err(dev
, "Failed to read power status: %d\n", ret
);
213 } else if (ret
& (WM8994_AIF2ADCL_ENA
| WM8994_AIF2ADCR_ENA
|
214 WM8994_AIF1ADC2L_ENA
| WM8994_AIF1ADC2R_ENA
|
215 WM8994_AIF1ADC1L_ENA
| WM8994_AIF1ADC1R_ENA
)) {
216 dev_dbg(dev
, "CODEC still active, ignoring suspend\n");
220 ret
= wm8994_reg_read(wm8994
, WM8994_POWER_MANAGEMENT_5
);
222 dev_err(dev
, "Failed to read power status: %d\n", ret
);
223 } else if (ret
& (WM8994_AIF2DACL_ENA
| WM8994_AIF2DACR_ENA
|
224 WM8994_AIF1DAC2L_ENA
| WM8994_AIF1DAC2R_ENA
|
225 WM8994_AIF1DAC1L_ENA
| WM8994_AIF1DAC1R_ENA
)) {
226 dev_dbg(dev
, "CODEC still active, ignoring suspend\n");
230 switch (wm8994
->type
) {
233 ret
= wm8994_reg_read(wm8994
, WM8958_MIC_DETECT_1
);
235 dev_err(dev
, "Failed to read power status: %d\n", ret
);
236 } else if (ret
& WM8958_MICD_ENA
) {
237 dev_dbg(dev
, "CODEC still active, ignoring suspend\n");
245 switch (wm8994
->type
) {
247 ret
= wm8994_reg_read(wm8994
, WM8994_ANTIPOP_2
);
249 dev_err(dev
, "Failed to read jackdet: %d\n", ret
);
250 } else if (ret
& WM1811_JACKDET_MODE_MASK
) {
251 dev_dbg(dev
, "CODEC still active, ignoring suspend\n");
259 switch (wm8994
->type
) {
261 ret
= wm8994_reg_read(wm8994
, WM8994_ANTIPOP_2
);
263 dev_err(dev
, "Failed to read jackdet: %d\n", ret
);
264 } else if (ret
& WM1811_JACKDET_MODE_MASK
) {
265 dev_dbg(dev
, "CODEC still active, ignoring suspend\n");
273 /* Disable LDO pulldowns while the device is suspended if we
274 * don't know that something will be driving them. */
275 if (!wm8994
->ldo_ena_always_driven
)
276 wm8994_set_bits(wm8994
, WM8994_PULL_CONTROL_2
,
277 WM8994_LDO1ENA_PD
| WM8994_LDO2ENA_PD
,
278 WM8994_LDO1ENA_PD
| WM8994_LDO2ENA_PD
);
280 /* Explicitly put the device into reset in case regulators
281 * don't get disabled in order to ensure consistent restart.
283 wm8994_reg_write(wm8994
, WM8994_SOFTWARE_RESET
,
284 wm8994_reg_read(wm8994
, WM8994_SOFTWARE_RESET
));
286 regcache_mark_dirty(wm8994
->regmap
);
288 /* Restore GPIO registers to prevent problems with mismatched
289 * pin configurations.
291 ret
= regcache_sync_region(wm8994
->regmap
, WM8994_GPIO_1
,
294 dev_err(dev
, "Failed to restore GPIO registers: %d\n", ret
);
296 /* In case one of the GPIOs is used as a wake input. */
297 ret
= regcache_sync_region(wm8994
->regmap
,
298 WM8994_INTERRUPT_STATUS_1_MASK
,
299 WM8994_INTERRUPT_STATUS_1_MASK
);
301 dev_err(dev
, "Failed to restore interrupt mask: %d\n", ret
);
303 regcache_cache_only(wm8994
->regmap
, true);
304 wm8994
->suspended
= true;
306 ret
= regulator_bulk_disable(wm8994
->num_supplies
,
309 dev_err(dev
, "Failed to disable supplies: %d\n", ret
);
316 static int wm8994_resume(struct device
*dev
)
318 struct wm8994
*wm8994
= dev_get_drvdata(dev
);
321 /* We may have lied to the PM core about suspending */
322 if (!wm8994
->suspended
)
325 ret
= regulator_bulk_enable(wm8994
->num_supplies
,
328 dev_err(dev
, "Failed to enable supplies: %d\n", ret
);
332 regcache_cache_only(wm8994
->regmap
, false);
333 ret
= regcache_sync(wm8994
->regmap
);
335 dev_err(dev
, "Failed to restore register map: %d\n", ret
);
339 /* Disable LDO pulldowns while the device is active */
340 wm8994_set_bits(wm8994
, WM8994_PULL_CONTROL_2
,
341 WM8994_LDO1ENA_PD
| WM8994_LDO2ENA_PD
,
344 wm8994
->suspended
= false;
349 regulator_bulk_disable(wm8994
->num_supplies
, wm8994
->supplies
);
355 #ifdef CONFIG_REGULATOR
356 static int wm8994_ldo_in_use(struct wm8994_pdata
*pdata
, int ldo
)
358 struct wm8994_ldo_pdata
*ldo_pdata
;
363 ldo_pdata
= &pdata
->ldo
[ldo
];
365 if (!ldo_pdata
->init_data
)
368 return ldo_pdata
->init_data
->num_consumer_supplies
!= 0;
371 static int wm8994_ldo_in_use(struct wm8994_pdata
*pdata
, int ldo
)
377 static const struct reg_default wm8994_revc_patch
[] = {
384 static const struct reg_default wm8958_reva_patch
[] = {
391 static const struct reg_default wm1811_reva_patch
[] = {
400 * Instantiate the generic non-control parts of the device.
402 static int wm8994_device_init(struct wm8994
*wm8994
, int irq
)
404 struct wm8994_pdata
*pdata
;
405 struct regmap_config
*regmap_config
;
406 const struct reg_default
*regmap_patch
= NULL
;
408 int ret
, i
, patch_regs
;
411 if (dev_get_platdata(wm8994
->dev
)) {
412 pdata
= dev_get_platdata(wm8994
->dev
);
413 wm8994
->pdata
= *pdata
;
415 pdata
= &wm8994
->pdata
;
417 dev_set_drvdata(wm8994
->dev
, wm8994
);
419 /* Add the on-chip regulators first for bootstrapping */
420 ret
= mfd_add_devices(wm8994
->dev
, -1,
421 wm8994_regulator_devs
,
422 ARRAY_SIZE(wm8994_regulator_devs
),
425 dev_err(wm8994
->dev
, "Failed to add children: %d\n", ret
);
429 switch (wm8994
->type
) {
431 wm8994
->num_supplies
= ARRAY_SIZE(wm1811_main_supplies
);
434 wm8994
->num_supplies
= ARRAY_SIZE(wm8994_main_supplies
);
437 wm8994
->num_supplies
= ARRAY_SIZE(wm8958_main_supplies
);
444 wm8994
->supplies
= devm_kzalloc(wm8994
->dev
,
445 sizeof(struct regulator_bulk_data
) *
446 wm8994
->num_supplies
, GFP_KERNEL
);
447 if (!wm8994
->supplies
) {
452 switch (wm8994
->type
) {
454 for (i
= 0; i
< ARRAY_SIZE(wm1811_main_supplies
); i
++)
455 wm8994
->supplies
[i
].supply
= wm1811_main_supplies
[i
];
458 for (i
= 0; i
< ARRAY_SIZE(wm8994_main_supplies
); i
++)
459 wm8994
->supplies
[i
].supply
= wm8994_main_supplies
[i
];
462 for (i
= 0; i
< ARRAY_SIZE(wm8958_main_supplies
); i
++)
463 wm8994
->supplies
[i
].supply
= wm8958_main_supplies
[i
];
470 ret
= regulator_bulk_get(wm8994
->dev
, wm8994
->num_supplies
,
473 dev_err(wm8994
->dev
, "Failed to get supplies: %d\n", ret
);
477 ret
= regulator_bulk_enable(wm8994
->num_supplies
,
480 dev_err(wm8994
->dev
, "Failed to enable supplies: %d\n", ret
);
484 ret
= wm8994_reg_read(wm8994
, WM8994_SOFTWARE_RESET
);
486 dev_err(wm8994
->dev
, "Failed to read ID register\n");
492 if (wm8994
->type
!= WM1811
)
493 dev_warn(wm8994
->dev
, "Device registered as type %d\n",
495 wm8994
->type
= WM1811
;
499 if (wm8994
->type
!= WM8994
)
500 dev_warn(wm8994
->dev
, "Device registered as type %d\n",
502 wm8994
->type
= WM8994
;
506 if (wm8994
->type
!= WM8958
)
507 dev_warn(wm8994
->dev
, "Device registered as type %d\n",
509 wm8994
->type
= WM8958
;
512 dev_err(wm8994
->dev
, "Device is not a WM8994, ID is %x\n",
518 ret
= wm8994_reg_read(wm8994
, WM8994_CHIP_REVISION
);
520 dev_err(wm8994
->dev
, "Failed to read revision register: %d\n",
524 wm8994
->revision
= ret
& WM8994_CHIP_REV_MASK
;
525 wm8994
->cust_id
= (ret
& WM8994_CUST_ID_MASK
) >> WM8994_CUST_ID_SHIFT
;
527 switch (wm8994
->type
) {
529 switch (wm8994
->revision
) {
532 dev_warn(wm8994
->dev
,
533 "revision %c not fully supported\n",
534 'A' + wm8994
->revision
);
539 regmap_patch
= wm8994_revc_patch
;
540 patch_regs
= ARRAY_SIZE(wm8994_revc_patch
);
546 switch (wm8994
->revision
) {
548 regmap_patch
= wm8958_reva_patch
;
549 patch_regs
= ARRAY_SIZE(wm8958_reva_patch
);
557 /* Revision C did not change the relevant layer */
558 if (wm8994
->revision
> 1)
561 regmap_patch
= wm1811_reva_patch
;
562 patch_regs
= ARRAY_SIZE(wm1811_reva_patch
);
569 dev_info(wm8994
->dev
, "%s revision %c CUST_ID %02x\n", devname
,
570 'A' + wm8994
->revision
, wm8994
->cust_id
);
572 switch (wm8994
->type
) {
574 regmap_config
= &wm1811_regmap_config
;
577 regmap_config
= &wm8994_regmap_config
;
580 regmap_config
= &wm8958_regmap_config
;
583 dev_err(wm8994
->dev
, "Unknown device type %d\n", wm8994
->type
);
587 ret
= regmap_reinit_cache(wm8994
->regmap
, regmap_config
);
589 dev_err(wm8994
->dev
, "Failed to reinit register cache: %d\n",
595 ret
= regmap_register_patch(wm8994
->regmap
, regmap_patch
,
598 dev_err(wm8994
->dev
, "Failed to register patch: %d\n",
604 wm8994
->irq_base
= pdata
->irq_base
;
605 wm8994
->gpio_base
= pdata
->gpio_base
;
607 /* GPIO configuration is only applied if it's non-zero */
608 for (i
= 0; i
< ARRAY_SIZE(pdata
->gpio_defaults
); i
++) {
609 if (pdata
->gpio_defaults
[i
]) {
610 wm8994_set_bits(wm8994
, WM8994_GPIO_1
+ i
,
611 0xffff, pdata
->gpio_defaults
[i
]);
615 wm8994
->ldo_ena_always_driven
= pdata
->ldo_ena_always_driven
;
617 if (pdata
->spkmode_pu
)
618 pulls
|= WM8994_SPKMODE_PU
;
620 /* Disable unneeded pulls */
621 wm8994_set_bits(wm8994
, WM8994_PULL_CONTROL_2
,
622 WM8994_LDO1ENA_PD
| WM8994_LDO2ENA_PD
|
623 WM8994_SPKMODE_PU
| WM8994_CSNADDR_PD
,
626 /* In some system designs where the regulators are not in use,
627 * we can achieve a small reduction in leakage currents by
628 * floating LDO outputs. This bit makes no difference if the
629 * LDOs are enabled, it only affects cases where the LDOs were
630 * in operation and are then disabled.
632 for (i
= 0; i
< WM8994_NUM_LDO_REGS
; i
++) {
633 if (wm8994_ldo_in_use(pdata
, i
))
634 wm8994_set_bits(wm8994
, WM8994_LDO_1
+ i
,
635 WM8994_LDO1_DISCH
, WM8994_LDO1_DISCH
);
637 wm8994_set_bits(wm8994
, WM8994_LDO_1
+ i
,
638 WM8994_LDO1_DISCH
, 0);
641 wm8994_irq_init(wm8994
);
643 ret
= mfd_add_devices(wm8994
->dev
, -1,
644 wm8994_devs
, ARRAY_SIZE(wm8994_devs
),
647 dev_err(wm8994
->dev
, "Failed to add children: %d\n", ret
);
651 pm_runtime_enable(wm8994
->dev
);
652 pm_runtime_idle(wm8994
->dev
);
657 wm8994_irq_exit(wm8994
);
659 regulator_bulk_disable(wm8994
->num_supplies
,
662 regulator_bulk_free(wm8994
->num_supplies
, wm8994
->supplies
);
664 mfd_remove_devices(wm8994
->dev
);
668 static void wm8994_device_exit(struct wm8994
*wm8994
)
670 pm_runtime_disable(wm8994
->dev
);
671 mfd_remove_devices(wm8994
->dev
);
672 wm8994_irq_exit(wm8994
);
673 regulator_bulk_disable(wm8994
->num_supplies
,
675 regulator_bulk_free(wm8994
->num_supplies
, wm8994
->supplies
);
678 static const struct of_device_id wm8994_of_match
[] = {
679 { .compatible
= "wlf,wm1811", },
680 { .compatible
= "wlf,wm8994", },
681 { .compatible
= "wlf,wm8958", },
684 MODULE_DEVICE_TABLE(of
, wm8994_of_match
);
686 static int wm8994_i2c_probe(struct i2c_client
*i2c
,
687 const struct i2c_device_id
*id
)
689 struct wm8994
*wm8994
;
692 wm8994
= devm_kzalloc(&i2c
->dev
, sizeof(struct wm8994
), GFP_KERNEL
);
696 i2c_set_clientdata(i2c
, wm8994
);
697 wm8994
->dev
= &i2c
->dev
;
698 wm8994
->irq
= i2c
->irq
;
699 wm8994
->type
= id
->driver_data
;
701 wm8994
->regmap
= devm_regmap_init_i2c(i2c
, &wm8994_base_regmap_config
);
702 if (IS_ERR(wm8994
->regmap
)) {
703 ret
= PTR_ERR(wm8994
->regmap
);
704 dev_err(wm8994
->dev
, "Failed to allocate register map: %d\n",
709 return wm8994_device_init(wm8994
, i2c
->irq
);
712 static int wm8994_i2c_remove(struct i2c_client
*i2c
)
714 struct wm8994
*wm8994
= i2c_get_clientdata(i2c
);
716 wm8994_device_exit(wm8994
);
721 static const struct i2c_device_id wm8994_i2c_id
[] = {
722 { "wm1811", WM1811
},
723 { "wm1811a", WM1811
},
724 { "wm8994", WM8994
},
725 { "wm8958", WM8958
},
728 MODULE_DEVICE_TABLE(i2c
, wm8994_i2c_id
);
730 static UNIVERSAL_DEV_PM_OPS(wm8994_pm_ops
, wm8994_suspend
, wm8994_resume
,
733 static struct i2c_driver wm8994_i2c_driver
= {
736 .owner
= THIS_MODULE
,
737 .pm
= &wm8994_pm_ops
,
738 .of_match_table
= wm8994_of_match
,
740 .probe
= wm8994_i2c_probe
,
741 .remove
= wm8994_i2c_remove
,
742 .id_table
= wm8994_i2c_id
,
745 module_i2c_driver(wm8994_i2c_driver
);
747 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
748 MODULE_LICENSE("GPL");
749 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");