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/delay.h>
20 #include <linux/mfd/core.h>
21 #include <linux/pm_runtime.h>
22 #include <linux/regulator/consumer.h>
23 #include <linux/regulator/machine.h>
25 #include <linux/mfd/wm8994/core.h>
26 #include <linux/mfd/wm8994/pdata.h>
27 #include <linux/mfd/wm8994/registers.h>
29 static int wm8994_read(struct wm8994
*wm8994
, unsigned short reg
,
30 int bytes
, void *dest
)
38 ret
= wm8994
->read_dev(wm8994
, reg
, bytes
, dest
);
42 for (i
= 0; i
< bytes
/ 2; i
++) {
43 dev_vdbg(wm8994
->dev
, "Read %04x from R%d(0x%x)\n",
44 be16_to_cpu(buf
[i
]), reg
+ i
, reg
+ i
);
51 * wm8994_reg_read: Read a single WM8994 register.
53 * @wm8994: Device to read from.
54 * @reg: Register to read.
56 int wm8994_reg_read(struct wm8994
*wm8994
, unsigned short reg
)
61 mutex_lock(&wm8994
->io_lock
);
63 ret
= wm8994_read(wm8994
, reg
, 2, &val
);
65 mutex_unlock(&wm8994
->io_lock
);
70 return be16_to_cpu(val
);
72 EXPORT_SYMBOL_GPL(wm8994_reg_read
);
75 * wm8994_bulk_read: Read multiple WM8994 registers
77 * @wm8994: Device to read from
78 * @reg: First register
79 * @count: Number of registers
80 * @buf: Buffer to fill. The data will be returned big endian.
82 int wm8994_bulk_read(struct wm8994
*wm8994
, unsigned short reg
,
87 mutex_lock(&wm8994
->io_lock
);
89 ret
= wm8994_read(wm8994
, reg
, count
* 2, buf
);
91 mutex_unlock(&wm8994
->io_lock
);
95 EXPORT_SYMBOL_GPL(wm8994_bulk_read
);
97 static int wm8994_write(struct wm8994
*wm8994
, unsigned short reg
,
98 int bytes
, const void *src
)
100 const u16
*buf
= src
;
106 for (i
= 0; i
< bytes
/ 2; i
++) {
107 dev_vdbg(wm8994
->dev
, "Write %04x to R%d(0x%x)\n",
108 be16_to_cpu(buf
[i
]), reg
+ i
, reg
+ i
);
111 return wm8994
->write_dev(wm8994
, reg
, bytes
, src
);
115 * wm8994_reg_write: Write a single WM8994 register.
117 * @wm8994: Device to write to.
118 * @reg: Register to write to.
119 * @val: Value to write.
121 int wm8994_reg_write(struct wm8994
*wm8994
, unsigned short reg
,
126 val
= cpu_to_be16(val
);
128 mutex_lock(&wm8994
->io_lock
);
130 ret
= wm8994_write(wm8994
, reg
, 2, &val
);
132 mutex_unlock(&wm8994
->io_lock
);
136 EXPORT_SYMBOL_GPL(wm8994_reg_write
);
139 * wm8994_bulk_write: Write multiple WM8994 registers
141 * @wm8994: Device to write to
142 * @reg: First register
143 * @count: Number of registers
144 * @buf: Buffer to write from. Data must be big-endian formatted.
146 int wm8994_bulk_write(struct wm8994
*wm8994
, unsigned short reg
,
147 int count
, const u16
*buf
)
151 mutex_lock(&wm8994
->io_lock
);
153 ret
= wm8994_write(wm8994
, reg
, count
* 2, buf
);
155 mutex_unlock(&wm8994
->io_lock
);
159 EXPORT_SYMBOL_GPL(wm8994_bulk_write
);
162 * wm8994_set_bits: Set the value of a bitfield in a WM8994 register
164 * @wm8994: Device to write to.
165 * @reg: Register to write to.
166 * @mask: Mask of bits to set.
167 * @val: Value to set (unshifted)
169 int wm8994_set_bits(struct wm8994
*wm8994
, unsigned short reg
,
170 unsigned short mask
, unsigned short val
)
175 mutex_lock(&wm8994
->io_lock
);
177 ret
= wm8994_read(wm8994
, reg
, 2, &r
);
188 ret
= wm8994_write(wm8994
, reg
, 2, &r
);
191 mutex_unlock(&wm8994
->io_lock
);
195 EXPORT_SYMBOL_GPL(wm8994_set_bits
);
197 static struct mfd_cell wm8994_regulator_devs
[] = {
199 .name
= "wm8994-ldo",
201 .pm_runtime_no_callbacks
= true,
204 .name
= "wm8994-ldo",
206 .pm_runtime_no_callbacks
= true,
210 static struct resource wm8994_codec_resources
[] = {
212 .start
= WM8994_IRQ_TEMP_SHUT
,
213 .end
= WM8994_IRQ_TEMP_WARN
,
214 .flags
= IORESOURCE_IRQ
,
218 static struct resource wm8994_gpio_resources
[] = {
220 .start
= WM8994_IRQ_GPIO(1),
221 .end
= WM8994_IRQ_GPIO(11),
222 .flags
= IORESOURCE_IRQ
,
226 static struct mfd_cell wm8994_devs
[] = {
228 .name
= "wm8994-codec",
229 .num_resources
= ARRAY_SIZE(wm8994_codec_resources
),
230 .resources
= wm8994_codec_resources
,
234 .name
= "wm8994-gpio",
235 .num_resources
= ARRAY_SIZE(wm8994_gpio_resources
),
236 .resources
= wm8994_gpio_resources
,
237 .pm_runtime_no_callbacks
= true,
242 * Supplies for the main bulk of CODEC; the LDO supplies are ignored
243 * and should be handled via the standard regulator API supply
246 static const char *wm8994_main_supplies
[] = {
256 static const char *wm8958_main_supplies
[] = {
269 static int wm8994_suspend(struct device
*dev
)
271 struct wm8994
*wm8994
= dev_get_drvdata(dev
);
274 /* Don't actually go through with the suspend if the CODEC is
275 * still active (eg, for audio passthrough from CP. */
276 ret
= wm8994_reg_read(wm8994
, WM8994_POWER_MANAGEMENT_1
);
278 dev_err(dev
, "Failed to read power status: %d\n", ret
);
279 } else if (ret
& WM8994_VMID_SEL_MASK
) {
280 dev_dbg(dev
, "CODEC still active, ignoring suspend\n");
284 /* GPIO configuration state is saved here since we may be configuring
285 * the GPIO alternate functions even if we're not using the gpiolib
288 ret
= wm8994_read(wm8994
, WM8994_GPIO_1
, WM8994_NUM_GPIO_REGS
* 2,
291 dev_err(dev
, "Failed to save GPIO registers: %d\n", ret
);
293 /* For similar reasons we also stash the regulator states */
294 ret
= wm8994_read(wm8994
, WM8994_LDO_1
, WM8994_NUM_LDO_REGS
* 2,
297 dev_err(dev
, "Failed to save LDO registers: %d\n", ret
);
299 /* Explicitly put the device into reset in case regulators
300 * don't get disabled in order to ensure consistent restart.
302 wm8994_reg_write(wm8994
, WM8994_SOFTWARE_RESET
, 0x8994);
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 /* Write register at a time as we use the cache on the CPU so store
333 * it in native endian.
335 for (i
= 0; i
< ARRAY_SIZE(wm8994
->irq_masks_cur
); i
++) {
336 ret
= wm8994_reg_write(wm8994
, WM8994_INTERRUPT_STATUS_1_MASK
337 + i
, wm8994
->irq_masks_cur
[i
]);
339 dev_err(dev
, "Failed to restore interrupt masks: %d\n",
343 ret
= wm8994_write(wm8994
, WM8994_LDO_1
, WM8994_NUM_LDO_REGS
* 2,
346 dev_err(dev
, "Failed to restore LDO registers: %d\n", ret
);
348 ret
= wm8994_write(wm8994
, WM8994_GPIO_1
, WM8994_NUM_GPIO_REGS
* 2,
351 dev_err(dev
, "Failed to restore GPIO registers: %d\n", ret
);
353 wm8994
->suspended
= false;
359 #ifdef CONFIG_REGULATOR
360 static int wm8994_ldo_in_use(struct wm8994_pdata
*pdata
, int ldo
)
362 struct wm8994_ldo_pdata
*ldo_pdata
;
367 ldo_pdata
= &pdata
->ldo
[ldo
];
369 if (!ldo_pdata
->init_data
)
372 return ldo_pdata
->init_data
->num_consumer_supplies
!= 0;
375 static int wm8994_ldo_in_use(struct wm8994_pdata
*pdata
, int ldo
)
382 * Instantiate the generic non-control parts of the device.
384 static int wm8994_device_init(struct wm8994
*wm8994
, int irq
)
386 struct wm8994_pdata
*pdata
= wm8994
->dev
->platform_data
;
390 mutex_init(&wm8994
->io_lock
);
391 dev_set_drvdata(wm8994
->dev
, wm8994
);
393 /* Add the on-chip regulators first for bootstrapping */
394 ret
= mfd_add_devices(wm8994
->dev
, -1,
395 wm8994_regulator_devs
,
396 ARRAY_SIZE(wm8994_regulator_devs
),
399 dev_err(wm8994
->dev
, "Failed to add children: %d\n", ret
);
403 switch (wm8994
->type
) {
405 wm8994
->num_supplies
= ARRAY_SIZE(wm8994_main_supplies
);
408 wm8994
->num_supplies
= ARRAY_SIZE(wm8958_main_supplies
);
415 wm8994
->supplies
= kzalloc(sizeof(struct regulator_bulk_data
) *
416 wm8994
->num_supplies
,
418 if (!wm8994
->supplies
) {
423 switch (wm8994
->type
) {
425 for (i
= 0; i
< ARRAY_SIZE(wm8994_main_supplies
); i
++)
426 wm8994
->supplies
[i
].supply
= wm8994_main_supplies
[i
];
429 for (i
= 0; i
< ARRAY_SIZE(wm8958_main_supplies
); i
++)
430 wm8994
->supplies
[i
].supply
= wm8958_main_supplies
[i
];
437 ret
= regulator_bulk_get(wm8994
->dev
, wm8994
->num_supplies
,
440 dev_err(wm8994
->dev
, "Failed to get supplies: %d\n", ret
);
444 ret
= regulator_bulk_enable(wm8994
->num_supplies
,
447 dev_err(wm8994
->dev
, "Failed to enable supplies: %d\n", ret
);
451 ret
= wm8994_reg_read(wm8994
, WM8994_SOFTWARE_RESET
);
453 dev_err(wm8994
->dev
, "Failed to read ID register\n");
459 if (wm8994
->type
!= WM8994
)
460 dev_warn(wm8994
->dev
, "Device registered as type %d\n",
462 wm8994
->type
= WM8994
;
466 if (wm8994
->type
!= WM8958
)
467 dev_warn(wm8994
->dev
, "Device registered as type %d\n",
469 wm8994
->type
= WM8958
;
472 dev_err(wm8994
->dev
, "Device is not a WM8994, ID is %x\n",
478 ret
= wm8994_reg_read(wm8994
, WM8994_CHIP_REVISION
);
480 dev_err(wm8994
->dev
, "Failed to read revision register: %d\n",
485 switch (wm8994
->type
) {
490 dev_warn(wm8994
->dev
,
491 "revision %c not fully supported\n",
502 dev_info(wm8994
->dev
, "%s revision %c\n", devname
, 'A' + ret
);
505 wm8994
->irq_base
= pdata
->irq_base
;
506 wm8994
->gpio_base
= pdata
->gpio_base
;
508 /* GPIO configuration is only applied if it's non-zero */
509 for (i
= 0; i
< ARRAY_SIZE(pdata
->gpio_defaults
); i
++) {
510 if (pdata
->gpio_defaults
[i
]) {
511 wm8994_set_bits(wm8994
, WM8994_GPIO_1
+ i
,
513 pdata
->gpio_defaults
[i
]);
518 /* In some system designs where the regulators are not in use,
519 * we can achieve a small reduction in leakage currents by
520 * floating LDO outputs. This bit makes no difference if the
521 * LDOs are enabled, it only affects cases where the LDOs were
522 * in operation and are then disabled.
524 for (i
= 0; i
< WM8994_NUM_LDO_REGS
; i
++) {
525 if (wm8994_ldo_in_use(pdata
, i
))
526 wm8994_set_bits(wm8994
, WM8994_LDO_1
+ i
,
527 WM8994_LDO1_DISCH
, WM8994_LDO1_DISCH
);
529 wm8994_set_bits(wm8994
, WM8994_LDO_1
+ i
,
530 WM8994_LDO1_DISCH
, 0);
533 wm8994_irq_init(wm8994
);
535 ret
= mfd_add_devices(wm8994
->dev
, -1,
536 wm8994_devs
, ARRAY_SIZE(wm8994_devs
),
539 dev_err(wm8994
->dev
, "Failed to add children: %d\n", ret
);
543 pm_runtime_enable(wm8994
->dev
);
544 pm_runtime_resume(wm8994
->dev
);
549 wm8994_irq_exit(wm8994
);
551 regulator_bulk_disable(wm8994
->num_supplies
,
554 regulator_bulk_free(wm8994
->num_supplies
, wm8994
->supplies
);
556 kfree(wm8994
->supplies
);
558 mfd_remove_devices(wm8994
->dev
);
563 static void wm8994_device_exit(struct wm8994
*wm8994
)
565 pm_runtime_disable(wm8994
->dev
);
566 mfd_remove_devices(wm8994
->dev
);
567 wm8994_irq_exit(wm8994
);
568 regulator_bulk_disable(wm8994
->num_supplies
,
570 regulator_bulk_free(wm8994
->num_supplies
, wm8994
->supplies
);
571 kfree(wm8994
->supplies
);
575 static int wm8994_i2c_read_device(struct wm8994
*wm8994
, unsigned short reg
,
576 int bytes
, void *dest
)
578 struct i2c_client
*i2c
= wm8994
->control_data
;
580 u16 r
= cpu_to_be16(reg
);
582 ret
= i2c_master_send(i2c
, (unsigned char *)&r
, 2);
588 ret
= i2c_master_recv(i2c
, dest
, bytes
);
596 static int wm8994_i2c_write_device(struct wm8994
*wm8994
, unsigned short reg
,
597 int bytes
, const void *src
)
599 struct i2c_client
*i2c
= wm8994
->control_data
;
600 struct i2c_msg xfer
[2];
603 reg
= cpu_to_be16(reg
);
605 xfer
[0].addr
= i2c
->addr
;
608 xfer
[0].buf
= (char *)®
;
610 xfer
[1].addr
= i2c
->addr
;
611 xfer
[1].flags
= I2C_M_NOSTART
;
613 xfer
[1].buf
= (char *)src
;
615 ret
= i2c_transfer(i2c
->adapter
, xfer
, 2);
624 static int wm8994_i2c_probe(struct i2c_client
*i2c
,
625 const struct i2c_device_id
*id
)
627 struct wm8994
*wm8994
;
629 wm8994
= kzalloc(sizeof(struct wm8994
), GFP_KERNEL
);
633 i2c_set_clientdata(i2c
, wm8994
);
634 wm8994
->dev
= &i2c
->dev
;
635 wm8994
->control_data
= i2c
;
636 wm8994
->read_dev
= wm8994_i2c_read_device
;
637 wm8994
->write_dev
= wm8994_i2c_write_device
;
638 wm8994
->irq
= i2c
->irq
;
639 wm8994
->type
= id
->driver_data
;
641 return wm8994_device_init(wm8994
, i2c
->irq
);
644 static int wm8994_i2c_remove(struct i2c_client
*i2c
)
646 struct wm8994
*wm8994
= i2c_get_clientdata(i2c
);
648 wm8994_device_exit(wm8994
);
653 static const struct i2c_device_id wm8994_i2c_id
[] = {
654 { "wm8994", WM8994
},
655 { "wm8958", WM8958
},
658 MODULE_DEVICE_TABLE(i2c
, wm8994_i2c_id
);
660 static UNIVERSAL_DEV_PM_OPS(wm8994_pm_ops
, wm8994_suspend
, wm8994_resume
,
663 static struct i2c_driver wm8994_i2c_driver
= {
666 .owner
= THIS_MODULE
,
667 .pm
= &wm8994_pm_ops
,
669 .probe
= wm8994_i2c_probe
,
670 .remove
= wm8994_i2c_remove
,
671 .id_table
= wm8994_i2c_id
,
674 static int __init
wm8994_i2c_init(void)
678 ret
= i2c_add_driver(&wm8994_i2c_driver
);
680 pr_err("Failed to register wm8994 I2C driver: %d\n", ret
);
684 module_init(wm8994_i2c_init
);
686 static void __exit
wm8994_i2c_exit(void)
688 i2c_del_driver(&wm8994_i2c_driver
);
690 module_exit(wm8994_i2c_exit
);
692 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
693 MODULE_LICENSE("GPL");
694 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");