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 buf[i] = be16_to_cpu(buf[i]);
45 dev_vdbg(wm8994->dev, "Read %04x from R%d(0x%x)\n",
46 buf[i], reg + i, reg + i);
53 * wm8994_reg_read: Read a single WM8994 register.
55 * @wm8994: Device to read from.
56 * @reg: Register to read.
58 int wm8994_reg_read(struct wm8994 *wm8994, unsigned short reg)
63 mutex_lock(&wm8994->io_lock);
65 ret = wm8994_read(wm8994, reg, 2, &val);
67 mutex_unlock(&wm8994->io_lock);
74 EXPORT_SYMBOL_GPL(wm8994_reg_read);
77 * wm8994_bulk_read: Read multiple WM8994 registers
79 * @wm8994: Device to read from
80 * @reg: First register
81 * @count: Number of registers
82 * @buf: Buffer to fill.
84 int wm8994_bulk_read(struct wm8994 *wm8994, unsigned short reg,
89 mutex_lock(&wm8994->io_lock);
91 ret = wm8994_read(wm8994, reg, count * 2, buf);
93 mutex_unlock(&wm8994->io_lock);
97 EXPORT_SYMBOL_GPL(wm8994_bulk_read);
99 static int wm8994_write(struct wm8994 *wm8994, unsigned short reg,
100 int bytes, void *src)
108 for (i = 0; i < bytes / 2; i++) {
109 dev_vdbg(wm8994->dev, "Write %04x to R%d(0x%x)\n",
110 buf[i], reg + i, reg + i);
112 buf[i] = cpu_to_be16(buf[i]);
115 return wm8994->write_dev(wm8994, reg, bytes, src);
119 * wm8994_reg_write: Write a single WM8994 register.
121 * @wm8994: Device to write to.
122 * @reg: Register to write to.
123 * @val: Value to write.
125 int wm8994_reg_write(struct wm8994 *wm8994, unsigned short reg,
130 mutex_lock(&wm8994->io_lock);
132 ret = wm8994_write(wm8994, reg, 2, &val);
134 mutex_unlock(&wm8994->io_lock);
138 EXPORT_SYMBOL_GPL(wm8994_reg_write);
141 * wm8994_bulk_write: Write multiple WM8994 registers
143 * @wm8994: Device to write to
144 * @reg: First register
145 * @count: Number of registers
146 * @buf: Buffer to write from.
148 int wm8994_bulk_write(struct wm8994 *wm8994, unsigned short reg,
153 mutex_lock(&wm8994->io_lock);
155 ret = wm8994_write(wm8994, reg, count * 2, buf);
157 mutex_unlock(&wm8994->io_lock);
161 EXPORT_SYMBOL_GPL(wm8994_bulk_write);
164 * wm8994_set_bits: Set the value of a bitfield in a WM8994 register
166 * @wm8994: Device to write to.
167 * @reg: Register to write to.
168 * @mask: Mask of bits to set.
169 * @val: Value to set (unshifted)
171 int wm8994_set_bits(struct wm8994 *wm8994, unsigned short reg,
172 unsigned short mask, unsigned short val)
177 mutex_lock(&wm8994->io_lock);
179 ret = wm8994_read(wm8994, reg, 2, &r);
186 ret = wm8994_write(wm8994, reg, 2, &r);
189 mutex_unlock(&wm8994->io_lock);
193 EXPORT_SYMBOL_GPL(wm8994_set_bits);
195 static struct mfd_cell wm8994_regulator_devs[] = {
197 .name = "wm8994-ldo",
199 .pm_runtime_no_callbacks = true,
202 .name = "wm8994-ldo",
204 .pm_runtime_no_callbacks = true,
208 static struct resource wm8994_codec_resources[] = {
210 .start = WM8994_IRQ_TEMP_SHUT,
211 .end = WM8994_IRQ_TEMP_WARN,
212 .flags = IORESOURCE_IRQ,
216 static struct resource wm8994_gpio_resources[] = {
218 .start = WM8994_IRQ_GPIO(1),
219 .end = WM8994_IRQ_GPIO(11),
220 .flags = IORESOURCE_IRQ,
224 static struct mfd_cell wm8994_devs[] = {
226 .name = "wm8994-codec",
227 .num_resources = ARRAY_SIZE(wm8994_codec_resources),
228 .resources = wm8994_codec_resources,
232 .name = "wm8994-gpio",
233 .num_resources = ARRAY_SIZE(wm8994_gpio_resources),
234 .resources = wm8994_gpio_resources,
235 .pm_runtime_no_callbacks = true,
240 * Supplies for the main bulk of CODEC; the LDO supplies are ignored
241 * and should be handled via the standard regulator API supply
244 static const char *wm8994_main_supplies[] = {
254 static const char *wm8958_main_supplies[] = {
267 static int wm8994_suspend(struct device *dev)
269 struct wm8994 *wm8994 = dev_get_drvdata(dev);
272 /* Don't actually go through with the suspend if the CODEC is
273 * still active (eg, for audio passthrough from CP. */
274 ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_1);
276 dev_err(dev, "Failed to read power status: %d\n", ret);
277 } else if (ret & WM8994_VMID_SEL_MASK) {
278 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
282 /* GPIO configuration state is saved here since we may be configuring
283 * the GPIO alternate functions even if we're not using the gpiolib
286 ret = wm8994_read(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
289 dev_err(dev, "Failed to save GPIO registers: %d\n", ret);
291 /* For similar reasons we also stash the regulator states */
292 ret = wm8994_read(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
295 dev_err(dev, "Failed to save LDO registers: %d\n", ret);
297 /* Explicitly put the device into reset in case regulators
298 * don't get disabled in order to ensure consistent restart.
300 wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET, 0x8994);
302 wm8994->suspended = true;
304 ret = regulator_bulk_disable(wm8994->num_supplies,
307 dev_err(dev, "Failed to disable supplies: %d\n", ret);
314 static int wm8994_resume(struct device *dev)
316 struct wm8994 *wm8994 = dev_get_drvdata(dev);
319 /* We may have lied to the PM core about suspending */
320 if (!wm8994->suspended)
323 ret = regulator_bulk_enable(wm8994->num_supplies,
326 dev_err(dev, "Failed to enable supplies: %d\n", ret);
330 ret = wm8994_write(wm8994, WM8994_INTERRUPT_STATUS_1_MASK,
331 WM8994_NUM_IRQ_REGS * 2, &wm8994->irq_masks_cur);
333 dev_err(dev, "Failed to restore interrupt masks: %d\n", ret);
335 ret = wm8994_write(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
338 dev_err(dev, "Failed to restore LDO registers: %d\n", ret);
340 ret = wm8994_write(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
343 dev_err(dev, "Failed to restore GPIO registers: %d\n", ret);
345 wm8994->suspended = false;
351 #ifdef CONFIG_REGULATOR
352 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
354 struct wm8994_ldo_pdata *ldo_pdata;
359 ldo_pdata = &pdata->ldo[ldo];
361 if (!ldo_pdata->init_data)
364 return ldo_pdata->init_data->num_consumer_supplies != 0;
367 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
374 * Instantiate the generic non-control parts of the device.
376 static int wm8994_device_init(struct wm8994 *wm8994, int irq)
378 struct wm8994_pdata *pdata = wm8994->dev->platform_data;
382 mutex_init(&wm8994->io_lock);
383 dev_set_drvdata(wm8994->dev, wm8994);
385 /* Add the on-chip regulators first for bootstrapping */
386 ret = mfd_add_devices(wm8994->dev, -1,
387 wm8994_regulator_devs,
388 ARRAY_SIZE(wm8994_regulator_devs),
391 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
395 switch (wm8994->type) {
397 wm8994->num_supplies = ARRAY_SIZE(wm8994_main_supplies);
400 wm8994->num_supplies = ARRAY_SIZE(wm8958_main_supplies);
407 wm8994->supplies = kzalloc(sizeof(struct regulator_bulk_data) *
408 wm8994->num_supplies,
410 if (!wm8994->supplies) {
415 switch (wm8994->type) {
417 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
418 wm8994->supplies[i].supply = wm8994_main_supplies[i];
421 for (i = 0; i < ARRAY_SIZE(wm8958_main_supplies); i++)
422 wm8994->supplies[i].supply = wm8958_main_supplies[i];
429 ret = regulator_bulk_get(wm8994->dev, wm8994->num_supplies,
432 dev_err(wm8994->dev, "Failed to get supplies: %d\n", ret);
436 ret = regulator_bulk_enable(wm8994->num_supplies,
439 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
443 ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
445 dev_err(wm8994->dev, "Failed to read ID register\n");
451 if (wm8994->type != WM8994)
452 dev_warn(wm8994->dev, "Device registered as type %d\n",
454 wm8994->type = WM8994;
458 if (wm8994->type != WM8958)
459 dev_warn(wm8994->dev, "Device registered as type %d\n",
461 wm8994->type = WM8958;
464 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
470 ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
472 dev_err(wm8994->dev, "Failed to read revision register: %d\n",
480 if (wm8994->type == WM8994)
481 dev_warn(wm8994->dev,
482 "revision %c not fully supported\n",
489 dev_info(wm8994->dev, "%s revision %c\n", devname, 'A' + ret);
492 wm8994->irq_base = pdata->irq_base;
493 wm8994->gpio_base = pdata->gpio_base;
495 /* GPIO configuration is only applied if it's non-zero */
496 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
497 if (pdata->gpio_defaults[i]) {
498 wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
500 pdata->gpio_defaults[i]);
505 /* In some system designs where the regulators are not in use,
506 * we can achieve a small reduction in leakage currents by
507 * floating LDO outputs. This bit makes no difference if the
508 * LDOs are enabled, it only affects cases where the LDOs were
509 * in operation and are then disabled.
511 for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
512 if (wm8994_ldo_in_use(pdata, i))
513 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
514 WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
516 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
517 WM8994_LDO1_DISCH, 0);
520 wm8994_irq_init(wm8994);
522 ret = mfd_add_devices(wm8994->dev, -1,
523 wm8994_devs, ARRAY_SIZE(wm8994_devs),
526 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
530 pm_runtime_enable(wm8994->dev);
531 pm_runtime_resume(wm8994->dev);
536 wm8994_irq_exit(wm8994);
538 regulator_bulk_disable(wm8994->num_supplies,
541 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
543 kfree(wm8994->supplies);
545 mfd_remove_devices(wm8994->dev);
550 static void wm8994_device_exit(struct wm8994 *wm8994)
552 pm_runtime_disable(wm8994->dev);
553 mfd_remove_devices(wm8994->dev);
554 wm8994_irq_exit(wm8994);
555 regulator_bulk_disable(wm8994->num_supplies,
557 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
558 kfree(wm8994->supplies);
562 static int wm8994_i2c_read_device(struct wm8994 *wm8994, unsigned short reg,
563 int bytes, void *dest)
565 struct i2c_client *i2c = wm8994->control_data;
567 u16 r = cpu_to_be16(reg);
569 ret = i2c_master_send(i2c, (unsigned char *)&r, 2);
575 ret = i2c_master_recv(i2c, dest, bytes);
583 /* Currently we allocate the write buffer on the stack; this is OK for
584 * small writes - if we need to do large writes this will need to be
587 static int wm8994_i2c_write_device(struct wm8994 *wm8994, unsigned short reg,
588 int bytes, void *src)
590 struct i2c_client *i2c = wm8994->control_data;
591 unsigned char msg[bytes + 2];
594 reg = cpu_to_be16(reg);
595 memcpy(&msg[0], ®, 2);
596 memcpy(&msg[2], src, bytes);
598 ret = i2c_master_send(i2c, msg, bytes + 2);
607 static int wm8994_i2c_probe(struct i2c_client *i2c,
608 const struct i2c_device_id *id)
610 struct wm8994 *wm8994;
612 wm8994 = kzalloc(sizeof(struct wm8994), GFP_KERNEL);
616 i2c_set_clientdata(i2c, wm8994);
617 wm8994->dev = &i2c->dev;
618 wm8994->control_data = i2c;
619 wm8994->read_dev = wm8994_i2c_read_device;
620 wm8994->write_dev = wm8994_i2c_write_device;
621 wm8994->irq = i2c->irq;
622 wm8994->type = id->driver_data;
624 return wm8994_device_init(wm8994, i2c->irq);
627 static int wm8994_i2c_remove(struct i2c_client *i2c)
629 struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
631 wm8994_device_exit(wm8994);
636 static const struct i2c_device_id wm8994_i2c_id[] = {
637 { "wm8994", WM8994 },
638 { "wm8958", WM8958 },
641 MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
643 static UNIVERSAL_DEV_PM_OPS(wm8994_pm_ops, wm8994_suspend, wm8994_resume,
646 static struct i2c_driver wm8994_i2c_driver = {
649 .owner = THIS_MODULE,
650 .pm = &wm8994_pm_ops,
652 .probe = wm8994_i2c_probe,
653 .remove = wm8994_i2c_remove,
654 .id_table = wm8994_i2c_id,
657 static int __init wm8994_i2c_init(void)
661 ret = i2c_add_driver(&wm8994_i2c_driver);
663 pr_err("Failed to register wm8994 I2C driver: %d\n", ret);
667 module_init(wm8994_i2c_init);
669 static void __exit wm8994_i2c_exit(void)
671 i2c_del_driver(&wm8994_i2c_driver);
673 module_exit(wm8994_i2c_exit);
675 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
676 MODULE_LICENSE("GPL");
677 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");