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/regulator/consumer.h>
22 #include <linux/regulator/machine.h>
24 #include <linux/mfd/wm8994/core.h>
25 #include <linux/mfd/wm8994/pdata.h>
26 #include <linux/mfd/wm8994/registers.h>
28 static int wm8994_read(struct wm8994 *wm8994, unsigned short reg,
29 int bytes, void *dest)
37 ret = wm8994->read_dev(wm8994, reg, bytes, dest);
41 for (i = 0; i < bytes / 2; i++) {
42 buf[i] = be16_to_cpu(buf[i]);
44 dev_vdbg(wm8994->dev, "Read %04x from R%d(0x%x)\n",
45 buf[i], reg + i, reg + i);
52 * wm8994_reg_read: Read a single WM8994 register.
54 * @wm8994: Device to read from.
55 * @reg: Register to read.
57 int wm8994_reg_read(struct wm8994 *wm8994, unsigned short reg)
62 mutex_lock(&wm8994->io_lock);
64 ret = wm8994_read(wm8994, reg, 2, &val);
66 mutex_unlock(&wm8994->io_lock);
73 EXPORT_SYMBOL_GPL(wm8994_reg_read);
76 * wm8994_bulk_read: Read multiple WM8994 registers
78 * @wm8994: Device to read from
79 * @reg: First register
80 * @count: Number of registers
81 * @buf: Buffer to fill.
83 int wm8994_bulk_read(struct wm8994 *wm8994, unsigned short reg,
88 mutex_lock(&wm8994->io_lock);
90 ret = wm8994_read(wm8994, reg, count * 2, buf);
92 mutex_unlock(&wm8994->io_lock);
96 EXPORT_SYMBOL_GPL(wm8994_bulk_read);
98 static int wm8994_write(struct wm8994 *wm8994, unsigned short reg,
107 for (i = 0; i < bytes / 2; i++) {
108 dev_vdbg(wm8994->dev, "Write %04x to R%d(0x%x)\n",
109 buf[i], reg + i, reg + i);
111 buf[i] = cpu_to_be16(buf[i]);
114 return wm8994->write_dev(wm8994, reg, bytes, src);
118 * wm8994_reg_write: Write a single WM8994 register.
120 * @wm8994: Device to write to.
121 * @reg: Register to write to.
122 * @val: Value to write.
124 int wm8994_reg_write(struct wm8994 *wm8994, unsigned short reg,
129 mutex_lock(&wm8994->io_lock);
131 ret = wm8994_write(wm8994, reg, 2, &val);
133 mutex_unlock(&wm8994->io_lock);
137 EXPORT_SYMBOL_GPL(wm8994_reg_write);
140 * wm8994_set_bits: Set the value of a bitfield in a WM8994 register
142 * @wm8994: Device to write to.
143 * @reg: Register to write to.
144 * @mask: Mask of bits to set.
145 * @val: Value to set (unshifted)
147 int wm8994_set_bits(struct wm8994 *wm8994, unsigned short reg,
148 unsigned short mask, unsigned short val)
153 mutex_lock(&wm8994->io_lock);
155 ret = wm8994_read(wm8994, reg, 2, &r);
162 ret = wm8994_write(wm8994, reg, 2, &r);
165 mutex_unlock(&wm8994->io_lock);
169 EXPORT_SYMBOL_GPL(wm8994_set_bits);
171 static struct mfd_cell wm8994_regulator_devs[] = {
172 { .name = "wm8994-ldo", .id = 1 },
173 { .name = "wm8994-ldo", .id = 2 },
176 static struct resource wm8994_codec_resources[] = {
178 .start = WM8994_IRQ_TEMP_SHUT,
179 .end = WM8994_IRQ_TEMP_WARN,
180 .flags = IORESOURCE_IRQ,
184 static struct resource wm8994_gpio_resources[] = {
186 .start = WM8994_IRQ_GPIO(1),
187 .end = WM8994_IRQ_GPIO(11),
188 .flags = IORESOURCE_IRQ,
192 static struct mfd_cell wm8994_devs[] = {
194 .name = "wm8994-codec",
195 .num_resources = ARRAY_SIZE(wm8994_codec_resources),
196 .resources = wm8994_codec_resources,
200 .name = "wm8994-gpio",
201 .num_resources = ARRAY_SIZE(wm8994_gpio_resources),
202 .resources = wm8994_gpio_resources,
207 * Supplies for the main bulk of CODEC; the LDO supplies are ignored
208 * and should be handled via the standard regulator API supply
211 static const char *wm8994_main_supplies[] = {
221 static const char *wm8958_main_supplies[] = {
234 static int wm8994_device_suspend(struct device *dev)
236 struct wm8994 *wm8994 = dev_get_drvdata(dev);
239 /* GPIO configuration state is saved here since we may be configuring
240 * the GPIO alternate functions even if we're not using the gpiolib
243 ret = wm8994_read(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
246 dev_err(dev, "Failed to save GPIO registers: %d\n", ret);
248 /* For similar reasons we also stash the regulator states */
249 ret = wm8994_read(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
252 dev_err(dev, "Failed to save LDO registers: %d\n", ret);
254 ret = regulator_bulk_disable(wm8994->num_supplies,
257 dev_err(dev, "Failed to disable supplies: %d\n", ret);
264 static int wm8994_device_resume(struct device *dev)
266 struct wm8994 *wm8994 = dev_get_drvdata(dev);
269 ret = regulator_bulk_enable(wm8994->num_supplies,
272 dev_err(dev, "Failed to enable supplies: %d\n", ret);
276 ret = wm8994_write(wm8994, WM8994_INTERRUPT_STATUS_1_MASK,
277 WM8994_NUM_IRQ_REGS * 2, &wm8994->irq_masks_cur);
279 dev_err(dev, "Failed to restore interrupt masks: %d\n", ret);
281 ret = wm8994_write(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
284 dev_err(dev, "Failed to restore LDO registers: %d\n", ret);
286 ret = wm8994_write(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
289 dev_err(dev, "Failed to restore GPIO registers: %d\n", ret);
295 #ifdef CONFIG_REGULATOR
296 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
298 struct wm8994_ldo_pdata *ldo_pdata;
303 ldo_pdata = &pdata->ldo[ldo];
305 if (!ldo_pdata->init_data)
308 return ldo_pdata->init_data->num_consumer_supplies != 0;
311 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
318 * Instantiate the generic non-control parts of the device.
320 static int wm8994_device_init(struct wm8994 *wm8994, int irq)
322 struct wm8994_pdata *pdata = wm8994->dev->platform_data;
326 mutex_init(&wm8994->io_lock);
327 dev_set_drvdata(wm8994->dev, wm8994);
329 /* Add the on-chip regulators first for bootstrapping */
330 ret = mfd_add_devices(wm8994->dev, -1,
331 wm8994_regulator_devs,
332 ARRAY_SIZE(wm8994_regulator_devs),
335 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
339 switch (wm8994->type) {
341 wm8994->num_supplies = ARRAY_SIZE(wm8994_main_supplies);
344 wm8994->num_supplies = ARRAY_SIZE(wm8958_main_supplies);
351 wm8994->supplies = kzalloc(sizeof(struct regulator_bulk_data) *
352 wm8994->num_supplies,
354 if (!wm8994->supplies) {
359 switch (wm8994->type) {
361 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
362 wm8994->supplies[i].supply = wm8994_main_supplies[i];
365 for (i = 0; i < ARRAY_SIZE(wm8958_main_supplies); i++)
366 wm8994->supplies[i].supply = wm8958_main_supplies[i];
373 ret = regulator_bulk_get(wm8994->dev, wm8994->num_supplies,
376 dev_err(wm8994->dev, "Failed to get supplies: %d\n", ret);
380 ret = regulator_bulk_enable(wm8994->num_supplies,
383 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
387 ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
389 dev_err(wm8994->dev, "Failed to read ID register\n");
395 if (wm8994->type != WM8994)
396 dev_warn(wm8994->dev, "Device registered as type %d\n",
398 wm8994->type = WM8994;
402 if (wm8994->type != WM8958)
403 dev_warn(wm8994->dev, "Device registered as type %d\n",
405 wm8994->type = WM8958;
408 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
414 ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
416 dev_err(wm8994->dev, "Failed to read revision register: %d\n",
424 if (wm8994->type == WM8994)
425 dev_warn(wm8994->dev,
426 "revision %c not fully supported\n",
433 dev_info(wm8994->dev, "%s revision %c\n", devname, 'A' + ret);
436 wm8994->irq_base = pdata->irq_base;
437 wm8994->gpio_base = pdata->gpio_base;
439 /* GPIO configuration is only applied if it's non-zero */
440 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
441 if (pdata->gpio_defaults[i]) {
442 wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
444 pdata->gpio_defaults[i]);
449 /* In some system designs where the regulators are not in use,
450 * we can achieve a small reduction in leakage currents by
451 * floating LDO outputs. This bit makes no difference if the
452 * LDOs are enabled, it only affects cases where the LDOs were
453 * in operation and are then disabled.
455 for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
456 if (wm8994_ldo_in_use(pdata, i))
457 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
458 WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
460 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
461 WM8994_LDO1_DISCH, 0);
464 wm8994_irq_init(wm8994);
466 ret = mfd_add_devices(wm8994->dev, -1,
467 wm8994_devs, ARRAY_SIZE(wm8994_devs),
470 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
477 wm8994_irq_exit(wm8994);
479 regulator_bulk_disable(wm8994->num_supplies,
482 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
484 kfree(wm8994->supplies);
486 mfd_remove_devices(wm8994->dev);
491 static void wm8994_device_exit(struct wm8994 *wm8994)
493 mfd_remove_devices(wm8994->dev);
494 wm8994_irq_exit(wm8994);
495 regulator_bulk_disable(wm8994->num_supplies,
497 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
498 kfree(wm8994->supplies);
502 static int wm8994_i2c_read_device(struct wm8994 *wm8994, unsigned short reg,
503 int bytes, void *dest)
505 struct i2c_client *i2c = wm8994->control_data;
507 u16 r = cpu_to_be16(reg);
509 ret = i2c_master_send(i2c, (unsigned char *)&r, 2);
515 ret = i2c_master_recv(i2c, dest, bytes);
523 /* Currently we allocate the write buffer on the stack; this is OK for
524 * small writes - if we need to do large writes this will need to be
527 static int wm8994_i2c_write_device(struct wm8994 *wm8994, unsigned short reg,
528 int bytes, void *src)
530 struct i2c_client *i2c = wm8994->control_data;
531 unsigned char msg[bytes + 2];
534 reg = cpu_to_be16(reg);
535 memcpy(&msg[0], ®, 2);
536 memcpy(&msg[2], src, bytes);
538 ret = i2c_master_send(i2c, msg, bytes + 2);
547 static int wm8994_i2c_probe(struct i2c_client *i2c,
548 const struct i2c_device_id *id)
550 struct wm8994 *wm8994;
552 wm8994 = kzalloc(sizeof(struct wm8994), GFP_KERNEL);
556 i2c_set_clientdata(i2c, wm8994);
557 wm8994->dev = &i2c->dev;
558 wm8994->control_data = i2c;
559 wm8994->read_dev = wm8994_i2c_read_device;
560 wm8994->write_dev = wm8994_i2c_write_device;
561 wm8994->irq = i2c->irq;
562 wm8994->type = id->driver_data;
564 return wm8994_device_init(wm8994, i2c->irq);
567 static int wm8994_i2c_remove(struct i2c_client *i2c)
569 struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
571 wm8994_device_exit(wm8994);
577 static int wm8994_i2c_suspend(struct i2c_client *i2c, pm_message_t state)
579 return wm8994_device_suspend(&i2c->dev);
582 static int wm8994_i2c_resume(struct i2c_client *i2c)
584 return wm8994_device_resume(&i2c->dev);
587 #define wm8994_i2c_suspend NULL
588 #define wm8994_i2c_resume NULL
591 static const struct i2c_device_id wm8994_i2c_id[] = {
592 { "wm8994", WM8994 },
593 { "wm8958", WM8958 },
596 MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
598 static struct i2c_driver wm8994_i2c_driver = {
601 .owner = THIS_MODULE,
603 .probe = wm8994_i2c_probe,
604 .remove = wm8994_i2c_remove,
605 .suspend = wm8994_i2c_suspend,
606 .resume = wm8994_i2c_resume,
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>");