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_cache_only(wm8994
->regmap
, true);
287 regcache_mark_dirty(wm8994
->regmap
);
289 wm8994
->suspended
= true;
291 ret
= regulator_bulk_disable(wm8994
->num_supplies
,
294 dev_err(dev
, "Failed to disable supplies: %d\n", ret
);
301 static int wm8994_resume(struct device
*dev
)
303 struct wm8994
*wm8994
= dev_get_drvdata(dev
);
306 /* We may have lied to the PM core about suspending */
307 if (!wm8994
->suspended
)
310 ret
= regulator_bulk_enable(wm8994
->num_supplies
,
313 dev_err(dev
, "Failed to enable supplies: %d\n", ret
);
317 regcache_cache_only(wm8994
->regmap
, false);
318 ret
= regcache_sync(wm8994
->regmap
);
320 dev_err(dev
, "Failed to restore register map: %d\n", ret
);
324 /* Disable LDO pulldowns while the device is active */
325 wm8994_set_bits(wm8994
, WM8994_PULL_CONTROL_2
,
326 WM8994_LDO1ENA_PD
| WM8994_LDO2ENA_PD
,
329 wm8994
->suspended
= false;
334 regulator_bulk_disable(wm8994
->num_supplies
, wm8994
->supplies
);
340 #ifdef CONFIG_REGULATOR
341 static int wm8994_ldo_in_use(struct wm8994_pdata
*pdata
, int ldo
)
343 struct wm8994_ldo_pdata
*ldo_pdata
;
348 ldo_pdata
= &pdata
->ldo
[ldo
];
350 if (!ldo_pdata
->init_data
)
353 return ldo_pdata
->init_data
->num_consumer_supplies
!= 0;
356 static int wm8994_ldo_in_use(struct wm8994_pdata
*pdata
, int ldo
)
362 static const __devinitdata
struct reg_default wm8994_revc_patch
[] = {
369 static const __devinitdata
struct reg_default wm8958_reva_patch
[] = {
376 static const __devinitdata
struct reg_default wm1811_reva_patch
[] = {
385 * Instantiate the generic non-control parts of the device.
387 static __devinit
int wm8994_device_init(struct wm8994
*wm8994
, int irq
)
389 struct wm8994_pdata
*pdata
= wm8994
->dev
->platform_data
;
390 struct regmap_config
*regmap_config
;
391 const struct reg_default
*regmap_patch
= NULL
;
393 int ret
, i
, patch_regs
;
396 dev_set_drvdata(wm8994
->dev
, wm8994
);
398 /* Add the on-chip regulators first for bootstrapping */
399 ret
= mfd_add_devices(wm8994
->dev
, -1,
400 wm8994_regulator_devs
,
401 ARRAY_SIZE(wm8994_regulator_devs
),
404 dev_err(wm8994
->dev
, "Failed to add children: %d\n", ret
);
408 switch (wm8994
->type
) {
410 wm8994
->num_supplies
= ARRAY_SIZE(wm1811_main_supplies
);
413 wm8994
->num_supplies
= ARRAY_SIZE(wm8994_main_supplies
);
416 wm8994
->num_supplies
= ARRAY_SIZE(wm8958_main_supplies
);
423 wm8994
->supplies
= devm_kzalloc(wm8994
->dev
,
424 sizeof(struct regulator_bulk_data
) *
425 wm8994
->num_supplies
, GFP_KERNEL
);
426 if (!wm8994
->supplies
) {
431 switch (wm8994
->type
) {
433 for (i
= 0; i
< ARRAY_SIZE(wm1811_main_supplies
); i
++)
434 wm8994
->supplies
[i
].supply
= wm1811_main_supplies
[i
];
437 for (i
= 0; i
< ARRAY_SIZE(wm8994_main_supplies
); i
++)
438 wm8994
->supplies
[i
].supply
= wm8994_main_supplies
[i
];
441 for (i
= 0; i
< ARRAY_SIZE(wm8958_main_supplies
); i
++)
442 wm8994
->supplies
[i
].supply
= wm8958_main_supplies
[i
];
449 ret
= regulator_bulk_get(wm8994
->dev
, wm8994
->num_supplies
,
452 dev_err(wm8994
->dev
, "Failed to get supplies: %d\n", ret
);
456 ret
= regulator_bulk_enable(wm8994
->num_supplies
,
459 dev_err(wm8994
->dev
, "Failed to enable supplies: %d\n", ret
);
463 ret
= wm8994_reg_read(wm8994
, WM8994_SOFTWARE_RESET
);
465 dev_err(wm8994
->dev
, "Failed to read ID register\n");
471 if (wm8994
->type
!= WM1811
)
472 dev_warn(wm8994
->dev
, "Device registered as type %d\n",
474 wm8994
->type
= WM1811
;
478 if (wm8994
->type
!= WM8994
)
479 dev_warn(wm8994
->dev
, "Device registered as type %d\n",
481 wm8994
->type
= WM8994
;
485 if (wm8994
->type
!= WM8958
)
486 dev_warn(wm8994
->dev
, "Device registered as type %d\n",
488 wm8994
->type
= WM8958
;
491 dev_err(wm8994
->dev
, "Device is not a WM8994, ID is %x\n",
497 ret
= wm8994_reg_read(wm8994
, WM8994_CHIP_REVISION
);
499 dev_err(wm8994
->dev
, "Failed to read revision register: %d\n",
503 wm8994
->revision
= ret
;
505 switch (wm8994
->type
) {
507 switch (wm8994
->revision
) {
510 dev_warn(wm8994
->dev
,
511 "revision %c not fully supported\n",
512 'A' + wm8994
->revision
);
516 regmap_patch
= wm8994_revc_patch
;
517 patch_regs
= ARRAY_SIZE(wm8994_revc_patch
);
525 switch (wm8994
->revision
) {
527 regmap_patch
= wm8958_reva_patch
;
528 patch_regs
= ARRAY_SIZE(wm8958_reva_patch
);
536 /* Revision C did not change the relevant layer */
537 if (wm8994
->revision
> 1)
539 switch (wm8994
->revision
) {
544 regmap_patch
= wm1811_reva_patch
;
545 patch_regs
= ARRAY_SIZE(wm1811_reva_patch
);
556 dev_info(wm8994
->dev
, "%s revision %c\n", devname
,
557 'A' + wm8994
->revision
);
559 switch (wm8994
->type
) {
561 regmap_config
= &wm1811_regmap_config
;
564 regmap_config
= &wm8994_regmap_config
;
567 regmap_config
= &wm8958_regmap_config
;
570 dev_err(wm8994
->dev
, "Unknown device type %d\n", wm8994
->type
);
574 ret
= regmap_reinit_cache(wm8994
->regmap
, regmap_config
);
576 dev_err(wm8994
->dev
, "Failed to reinit register cache: %d\n",
582 ret
= regmap_register_patch(wm8994
->regmap
, regmap_patch
,
585 dev_err(wm8994
->dev
, "Failed to register patch: %d\n",
592 wm8994
->irq_base
= pdata
->irq_base
;
593 wm8994
->gpio_base
= pdata
->gpio_base
;
595 /* GPIO configuration is only applied if it's non-zero */
596 for (i
= 0; i
< ARRAY_SIZE(pdata
->gpio_defaults
); i
++) {
597 if (pdata
->gpio_defaults
[i
]) {
598 wm8994_set_bits(wm8994
, WM8994_GPIO_1
+ i
,
600 pdata
->gpio_defaults
[i
]);
604 wm8994
->ldo_ena_always_driven
= pdata
->ldo_ena_always_driven
;
606 if (pdata
->spkmode_pu
)
607 pulls
|= WM8994_SPKMODE_PU
;
610 /* Disable unneeded pulls */
611 wm8994_set_bits(wm8994
, WM8994_PULL_CONTROL_2
,
612 WM8994_LDO1ENA_PD
| WM8994_LDO2ENA_PD
|
613 WM8994_SPKMODE_PU
| WM8994_CSNADDR_PD
,
616 /* In some system designs where the regulators are not in use,
617 * we can achieve a small reduction in leakage currents by
618 * floating LDO outputs. This bit makes no difference if the
619 * LDOs are enabled, it only affects cases where the LDOs were
620 * in operation and are then disabled.
622 for (i
= 0; i
< WM8994_NUM_LDO_REGS
; i
++) {
623 if (wm8994_ldo_in_use(pdata
, i
))
624 wm8994_set_bits(wm8994
, WM8994_LDO_1
+ i
,
625 WM8994_LDO1_DISCH
, WM8994_LDO1_DISCH
);
627 wm8994_set_bits(wm8994
, WM8994_LDO_1
+ i
,
628 WM8994_LDO1_DISCH
, 0);
631 wm8994_irq_init(wm8994
);
633 ret
= mfd_add_devices(wm8994
->dev
, -1,
634 wm8994_devs
, ARRAY_SIZE(wm8994_devs
),
637 dev_err(wm8994
->dev
, "Failed to add children: %d\n", ret
);
641 pm_runtime_enable(wm8994
->dev
);
642 pm_runtime_idle(wm8994
->dev
);
647 wm8994_irq_exit(wm8994
);
649 regulator_bulk_disable(wm8994
->num_supplies
,
652 regulator_bulk_free(wm8994
->num_supplies
, wm8994
->supplies
);
654 mfd_remove_devices(wm8994
->dev
);
658 static __devexit
void wm8994_device_exit(struct wm8994
*wm8994
)
660 pm_runtime_disable(wm8994
->dev
);
661 mfd_remove_devices(wm8994
->dev
);
662 wm8994_irq_exit(wm8994
);
663 regulator_bulk_disable(wm8994
->num_supplies
,
665 regulator_bulk_free(wm8994
->num_supplies
, wm8994
->supplies
);
668 static const struct of_device_id wm8994_of_match
[] = {
669 { .compatible
= "wlf,wm1811", },
670 { .compatible
= "wlf,wm8994", },
671 { .compatible
= "wlf,wm8958", },
674 MODULE_DEVICE_TABLE(of
, wm8994_of_match
);
676 static __devinit
int wm8994_i2c_probe(struct i2c_client
*i2c
,
677 const struct i2c_device_id
*id
)
679 struct wm8994
*wm8994
;
682 wm8994
= devm_kzalloc(&i2c
->dev
, sizeof(struct wm8994
), GFP_KERNEL
);
686 i2c_set_clientdata(i2c
, wm8994
);
687 wm8994
->dev
= &i2c
->dev
;
688 wm8994
->irq
= i2c
->irq
;
689 wm8994
->type
= id
->driver_data
;
691 wm8994
->regmap
= devm_regmap_init_i2c(i2c
, &wm8994_base_regmap_config
);
692 if (IS_ERR(wm8994
->regmap
)) {
693 ret
= PTR_ERR(wm8994
->regmap
);
694 dev_err(wm8994
->dev
, "Failed to allocate register map: %d\n",
699 return wm8994_device_init(wm8994
, i2c
->irq
);
702 static __devexit
int wm8994_i2c_remove(struct i2c_client
*i2c
)
704 struct wm8994
*wm8994
= i2c_get_clientdata(i2c
);
706 wm8994_device_exit(wm8994
);
711 static const struct i2c_device_id wm8994_i2c_id
[] = {
712 { "wm1811", WM1811
},
713 { "wm1811a", WM1811
},
714 { "wm8994", WM8994
},
715 { "wm8958", WM8958
},
718 MODULE_DEVICE_TABLE(i2c
, wm8994_i2c_id
);
720 static UNIVERSAL_DEV_PM_OPS(wm8994_pm_ops
, wm8994_suspend
, wm8994_resume
,
723 static struct i2c_driver wm8994_i2c_driver
= {
726 .owner
= THIS_MODULE
,
727 .pm
= &wm8994_pm_ops
,
728 .of_match_table
= wm8994_of_match
,
730 .probe
= wm8994_i2c_probe
,
731 .remove
= __devexit_p(wm8994_i2c_remove
),
732 .id_table
= wm8994_i2c_id
,
735 static int __init
wm8994_i2c_init(void)
739 ret
= i2c_add_driver(&wm8994_i2c_driver
);
741 pr_err("Failed to register wm8994 I2C driver: %d\n", ret
);
745 module_init(wm8994_i2c_init
);
747 static void __exit
wm8994_i2c_exit(void)
749 i2c_del_driver(&wm8994_i2c_driver
);
751 module_exit(wm8994_i2c_exit
);
753 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
754 MODULE_LICENSE("GPL");
755 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");