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_set_bits: Set the value of a bitfield in a WM8994 register
143 * @wm8994: Device to write to.
144 * @reg: Register to write to.
145 * @mask: Mask of bits to set.
146 * @val: Value to set (unshifted)
148 int wm8994_set_bits(struct wm8994 *wm8994, unsigned short reg,
149 unsigned short mask, unsigned short val)
154 mutex_lock(&wm8994->io_lock);
156 ret = wm8994_read(wm8994, reg, 2, &r);
163 ret = wm8994_write(wm8994, reg, 2, &r);
166 mutex_unlock(&wm8994->io_lock);
170 EXPORT_SYMBOL_GPL(wm8994_set_bits);
172 static struct mfd_cell wm8994_regulator_devs[] = {
174 .name = "wm8994-ldo",
176 .pm_runtime_no_callbacks = true,
179 .name = "wm8994-ldo",
181 .pm_runtime_no_callbacks = true,
185 static struct resource wm8994_codec_resources[] = {
187 .start = WM8994_IRQ_TEMP_SHUT,
188 .end = WM8994_IRQ_TEMP_WARN,
189 .flags = IORESOURCE_IRQ,
193 static struct resource wm8994_gpio_resources[] = {
195 .start = WM8994_IRQ_GPIO(1),
196 .end = WM8994_IRQ_GPIO(11),
197 .flags = IORESOURCE_IRQ,
201 static struct mfd_cell wm8994_devs[] = {
203 .name = "wm8994-codec",
204 .num_resources = ARRAY_SIZE(wm8994_codec_resources),
205 .resources = wm8994_codec_resources,
209 .name = "wm8994-gpio",
210 .num_resources = ARRAY_SIZE(wm8994_gpio_resources),
211 .resources = wm8994_gpio_resources,
212 .pm_runtime_no_callbacks = true,
217 * Supplies for the main bulk of CODEC; the LDO supplies are ignored
218 * and should be handled via the standard regulator API supply
221 static const char *wm8994_main_supplies[] = {
231 static const char *wm8958_main_supplies[] = {
244 static int wm8994_suspend(struct device *dev)
246 struct wm8994 *wm8994 = dev_get_drvdata(dev);
249 /* GPIO configuration state is saved here since we may be configuring
250 * the GPIO alternate functions even if we're not using the gpiolib
253 ret = wm8994_read(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
256 dev_err(dev, "Failed to save GPIO registers: %d\n", ret);
258 /* For similar reasons we also stash the regulator states */
259 ret = wm8994_read(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
262 dev_err(dev, "Failed to save LDO registers: %d\n", ret);
264 ret = regulator_bulk_disable(wm8994->num_supplies,
267 dev_err(dev, "Failed to disable supplies: %d\n", ret);
274 static int wm8994_resume(struct device *dev)
276 struct wm8994 *wm8994 = dev_get_drvdata(dev);
279 ret = regulator_bulk_enable(wm8994->num_supplies,
282 dev_err(dev, "Failed to enable supplies: %d\n", ret);
286 ret = wm8994_write(wm8994, WM8994_INTERRUPT_STATUS_1_MASK,
287 WM8994_NUM_IRQ_REGS * 2, &wm8994->irq_masks_cur);
289 dev_err(dev, "Failed to restore interrupt masks: %d\n", ret);
291 ret = wm8994_write(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
294 dev_err(dev, "Failed to restore LDO registers: %d\n", ret);
296 ret = wm8994_write(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
299 dev_err(dev, "Failed to restore GPIO registers: %d\n", ret);
305 #ifdef CONFIG_REGULATOR
306 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
308 struct wm8994_ldo_pdata *ldo_pdata;
313 ldo_pdata = &pdata->ldo[ldo];
315 if (!ldo_pdata->init_data)
318 return ldo_pdata->init_data->num_consumer_supplies != 0;
321 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
328 * Instantiate the generic non-control parts of the device.
330 static int wm8994_device_init(struct wm8994 *wm8994, int irq)
332 struct wm8994_pdata *pdata = wm8994->dev->platform_data;
336 mutex_init(&wm8994->io_lock);
337 dev_set_drvdata(wm8994->dev, wm8994);
339 /* Add the on-chip regulators first for bootstrapping */
340 ret = mfd_add_devices(wm8994->dev, -1,
341 wm8994_regulator_devs,
342 ARRAY_SIZE(wm8994_regulator_devs),
345 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
349 switch (wm8994->type) {
351 wm8994->num_supplies = ARRAY_SIZE(wm8994_main_supplies);
354 wm8994->num_supplies = ARRAY_SIZE(wm8958_main_supplies);
361 wm8994->supplies = kzalloc(sizeof(struct regulator_bulk_data) *
362 wm8994->num_supplies,
364 if (!wm8994->supplies) {
369 switch (wm8994->type) {
371 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
372 wm8994->supplies[i].supply = wm8994_main_supplies[i];
375 for (i = 0; i < ARRAY_SIZE(wm8958_main_supplies); i++)
376 wm8994->supplies[i].supply = wm8958_main_supplies[i];
383 ret = regulator_bulk_get(wm8994->dev, wm8994->num_supplies,
386 dev_err(wm8994->dev, "Failed to get supplies: %d\n", ret);
390 ret = regulator_bulk_enable(wm8994->num_supplies,
393 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
397 ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
399 dev_err(wm8994->dev, "Failed to read ID register\n");
405 if (wm8994->type != WM8994)
406 dev_warn(wm8994->dev, "Device registered as type %d\n",
408 wm8994->type = WM8994;
412 if (wm8994->type != WM8958)
413 dev_warn(wm8994->dev, "Device registered as type %d\n",
415 wm8994->type = WM8958;
418 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
424 ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
426 dev_err(wm8994->dev, "Failed to read revision register: %d\n",
434 if (wm8994->type == WM8994)
435 dev_warn(wm8994->dev,
436 "revision %c not fully supported\n",
443 dev_info(wm8994->dev, "%s revision %c\n", devname, 'A' + ret);
446 wm8994->irq_base = pdata->irq_base;
447 wm8994->gpio_base = pdata->gpio_base;
449 /* GPIO configuration is only applied if it's non-zero */
450 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
451 if (pdata->gpio_defaults[i]) {
452 wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
454 pdata->gpio_defaults[i]);
459 /* In some system designs where the regulators are not in use,
460 * we can achieve a small reduction in leakage currents by
461 * floating LDO outputs. This bit makes no difference if the
462 * LDOs are enabled, it only affects cases where the LDOs were
463 * in operation and are then disabled.
465 for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
466 if (wm8994_ldo_in_use(pdata, i))
467 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
468 WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
470 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
471 WM8994_LDO1_DISCH, 0);
474 wm8994_irq_init(wm8994);
476 ret = mfd_add_devices(wm8994->dev, -1,
477 wm8994_devs, ARRAY_SIZE(wm8994_devs),
480 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
484 pm_runtime_enable(wm8994->dev);
485 pm_runtime_resume(wm8994->dev);
490 wm8994_irq_exit(wm8994);
492 regulator_bulk_disable(wm8994->num_supplies,
495 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
497 kfree(wm8994->supplies);
499 mfd_remove_devices(wm8994->dev);
504 static void wm8994_device_exit(struct wm8994 *wm8994)
506 pm_runtime_disable(wm8994->dev);
507 mfd_remove_devices(wm8994->dev);
508 wm8994_irq_exit(wm8994);
509 regulator_bulk_disable(wm8994->num_supplies,
511 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
512 kfree(wm8994->supplies);
516 static int wm8994_i2c_read_device(struct wm8994 *wm8994, unsigned short reg,
517 int bytes, void *dest)
519 struct i2c_client *i2c = wm8994->control_data;
521 u16 r = cpu_to_be16(reg);
523 ret = i2c_master_send(i2c, (unsigned char *)&r, 2);
529 ret = i2c_master_recv(i2c, dest, bytes);
537 /* Currently we allocate the write buffer on the stack; this is OK for
538 * small writes - if we need to do large writes this will need to be
541 static int wm8994_i2c_write_device(struct wm8994 *wm8994, unsigned short reg,
542 int bytes, void *src)
544 struct i2c_client *i2c = wm8994->control_data;
545 unsigned char msg[bytes + 2];
548 reg = cpu_to_be16(reg);
549 memcpy(&msg[0], ®, 2);
550 memcpy(&msg[2], src, bytes);
552 ret = i2c_master_send(i2c, msg, bytes + 2);
561 static int wm8994_i2c_probe(struct i2c_client *i2c,
562 const struct i2c_device_id *id)
564 struct wm8994 *wm8994;
566 wm8994 = kzalloc(sizeof(struct wm8994), GFP_KERNEL);
570 i2c_set_clientdata(i2c, wm8994);
571 wm8994->dev = &i2c->dev;
572 wm8994->control_data = i2c;
573 wm8994->read_dev = wm8994_i2c_read_device;
574 wm8994->write_dev = wm8994_i2c_write_device;
575 wm8994->irq = i2c->irq;
576 wm8994->type = id->driver_data;
578 return wm8994_device_init(wm8994, i2c->irq);
581 static int wm8994_i2c_remove(struct i2c_client *i2c)
583 struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
585 wm8994_device_exit(wm8994);
590 static const struct i2c_device_id wm8994_i2c_id[] = {
591 { "wm8994", WM8994 },
592 { "wm8958", WM8958 },
595 MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
597 UNIVERSAL_DEV_PM_OPS(wm8994_pm_ops, wm8994_suspend, wm8994_resume, NULL);
599 static struct i2c_driver wm8994_i2c_driver = {
602 .owner = THIS_MODULE,
603 .pm = &wm8994_pm_ops,
605 .probe = wm8994_i2c_probe,
606 .remove = wm8994_i2c_remove,
607 .id_table = wm8994_i2c_id,
610 static int __init wm8994_i2c_init(void)
614 ret = i2c_add_driver(&wm8994_i2c_driver);
616 pr_err("Failed to register wm8994 I2C driver: %d\n", ret);
620 module_init(wm8994_i2c_init);
622 static void __exit wm8994_i2c_exit(void)
624 i2c_del_driver(&wm8994_i2c_driver);
626 module_exit(wm8994_i2c_exit);
628 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
629 MODULE_LICENSE("GPL");
630 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");