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 ret = wm8994_write(wm8994, WM8994_INTERRUPT_STATUS_1_MASK,
333 WM8994_NUM_IRQ_REGS * 2, &wm8994->irq_masks_cur);
335 dev_err(dev, "Failed to restore interrupt masks: %d\n", ret);
337 ret = wm8994_write(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
340 dev_err(dev, "Failed to restore LDO registers: %d\n", ret);
342 ret = wm8994_write(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
345 dev_err(dev, "Failed to restore GPIO registers: %d\n", ret);
347 wm8994->suspended = false;
353 #ifdef CONFIG_REGULATOR
354 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
356 struct wm8994_ldo_pdata *ldo_pdata;
361 ldo_pdata = &pdata->ldo[ldo];
363 if (!ldo_pdata->init_data)
366 return ldo_pdata->init_data->num_consumer_supplies != 0;
369 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
376 * Instantiate the generic non-control parts of the device.
378 static int wm8994_device_init(struct wm8994 *wm8994, int irq)
380 struct wm8994_pdata *pdata = wm8994->dev->platform_data;
384 mutex_init(&wm8994->io_lock);
385 dev_set_drvdata(wm8994->dev, wm8994);
387 /* Add the on-chip regulators first for bootstrapping */
388 ret = mfd_add_devices(wm8994->dev, -1,
389 wm8994_regulator_devs,
390 ARRAY_SIZE(wm8994_regulator_devs),
393 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
397 switch (wm8994->type) {
399 wm8994->num_supplies = ARRAY_SIZE(wm8994_main_supplies);
402 wm8994->num_supplies = ARRAY_SIZE(wm8958_main_supplies);
409 wm8994->supplies = kzalloc(sizeof(struct regulator_bulk_data) *
410 wm8994->num_supplies,
412 if (!wm8994->supplies) {
417 switch (wm8994->type) {
419 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
420 wm8994->supplies[i].supply = wm8994_main_supplies[i];
423 for (i = 0; i < ARRAY_SIZE(wm8958_main_supplies); i++)
424 wm8994->supplies[i].supply = wm8958_main_supplies[i];
431 ret = regulator_bulk_get(wm8994->dev, wm8994->num_supplies,
434 dev_err(wm8994->dev, "Failed to get supplies: %d\n", ret);
438 ret = regulator_bulk_enable(wm8994->num_supplies,
441 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
445 ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
447 dev_err(wm8994->dev, "Failed to read ID register\n");
453 if (wm8994->type != WM8994)
454 dev_warn(wm8994->dev, "Device registered as type %d\n",
456 wm8994->type = WM8994;
460 if (wm8994->type != WM8958)
461 dev_warn(wm8994->dev, "Device registered as type %d\n",
463 wm8994->type = WM8958;
466 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
472 ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
474 dev_err(wm8994->dev, "Failed to read revision register: %d\n",
482 if (wm8994->type == WM8994)
483 dev_warn(wm8994->dev,
484 "revision %c not fully supported\n",
491 dev_info(wm8994->dev, "%s revision %c\n", devname, 'A' + ret);
494 wm8994->irq_base = pdata->irq_base;
495 wm8994->gpio_base = pdata->gpio_base;
497 /* GPIO configuration is only applied if it's non-zero */
498 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
499 if (pdata->gpio_defaults[i]) {
500 wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
502 pdata->gpio_defaults[i]);
507 /* In some system designs where the regulators are not in use,
508 * we can achieve a small reduction in leakage currents by
509 * floating LDO outputs. This bit makes no difference if the
510 * LDOs are enabled, it only affects cases where the LDOs were
511 * in operation and are then disabled.
513 for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
514 if (wm8994_ldo_in_use(pdata, i))
515 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
516 WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
518 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
519 WM8994_LDO1_DISCH, 0);
522 wm8994_irq_init(wm8994);
524 ret = mfd_add_devices(wm8994->dev, -1,
525 wm8994_devs, ARRAY_SIZE(wm8994_devs),
528 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
532 pm_runtime_enable(wm8994->dev);
533 pm_runtime_resume(wm8994->dev);
538 wm8994_irq_exit(wm8994);
540 regulator_bulk_disable(wm8994->num_supplies,
543 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
545 kfree(wm8994->supplies);
547 mfd_remove_devices(wm8994->dev);
552 static void wm8994_device_exit(struct wm8994 *wm8994)
554 pm_runtime_disable(wm8994->dev);
555 mfd_remove_devices(wm8994->dev);
556 wm8994_irq_exit(wm8994);
557 regulator_bulk_disable(wm8994->num_supplies,
559 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
560 kfree(wm8994->supplies);
564 static int wm8994_i2c_read_device(struct wm8994 *wm8994, unsigned short reg,
565 int bytes, void *dest)
567 struct i2c_client *i2c = wm8994->control_data;
569 u16 r = cpu_to_be16(reg);
571 ret = i2c_master_send(i2c, (unsigned char *)&r, 2);
577 ret = i2c_master_recv(i2c, dest, bytes);
585 static int wm8994_i2c_write_device(struct wm8994 *wm8994, unsigned short reg,
586 int bytes, const void *src)
588 struct i2c_client *i2c = wm8994->control_data;
589 struct i2c_msg xfer[2];
592 reg = cpu_to_be16(reg);
594 xfer[0].addr = i2c->addr;
597 xfer[0].buf = (char *)®
599 xfer[1].addr = i2c->addr;
600 xfer[1].flags = I2C_M_NOSTART;
602 xfer[1].buf = (char *)src;
604 ret = i2c_transfer(i2c->adapter, xfer, 2);
613 static int wm8994_i2c_probe(struct i2c_client *i2c,
614 const struct i2c_device_id *id)
616 struct wm8994 *wm8994;
618 wm8994 = kzalloc(sizeof(struct wm8994), GFP_KERNEL);
622 i2c_set_clientdata(i2c, wm8994);
623 wm8994->dev = &i2c->dev;
624 wm8994->control_data = i2c;
625 wm8994->read_dev = wm8994_i2c_read_device;
626 wm8994->write_dev = wm8994_i2c_write_device;
627 wm8994->irq = i2c->irq;
628 wm8994->type = id->driver_data;
630 return wm8994_device_init(wm8994, i2c->irq);
633 static int wm8994_i2c_remove(struct i2c_client *i2c)
635 struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
637 wm8994_device_exit(wm8994);
642 static const struct i2c_device_id wm8994_i2c_id[] = {
643 { "wm8994", WM8994 },
644 { "wm8958", WM8958 },
647 MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
649 static UNIVERSAL_DEV_PM_OPS(wm8994_pm_ops, wm8994_suspend, wm8994_resume,
652 static struct i2c_driver wm8994_i2c_driver = {
655 .owner = THIS_MODULE,
656 .pm = &wm8994_pm_ops,
658 .probe = wm8994_i2c_probe,
659 .remove = wm8994_i2c_remove,
660 .id_table = wm8994_i2c_id,
663 static int __init wm8994_i2c_init(void)
667 ret = i2c_add_driver(&wm8994_i2c_driver);
669 pr_err("Failed to register wm8994 I2C driver: %d\n", ret);
673 module_init(wm8994_i2c_init);
675 static void __exit wm8994_i2c_exit(void)
677 i2c_del_driver(&wm8994_i2c_driver);
679 module_exit(wm8994_i2c_exit);
681 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
682 MODULE_LICENSE("GPL");
683 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");