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[] = {
222 static int wm8994_device_suspend(struct device *dev)
224 struct wm8994 *wm8994 = dev_get_drvdata(dev);
227 /* GPIO configuration state is saved here since we may be configuring
228 * the GPIO alternate functions even if we're not using the gpiolib
231 ret = wm8994_read(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
234 dev_err(dev, "Failed to save GPIO registers: %d\n", ret);
236 /* For similar reasons we also stash the regulator states */
237 ret = wm8994_read(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
240 dev_err(dev, "Failed to save LDO registers: %d\n", ret);
242 ret = regulator_bulk_disable(ARRAY_SIZE(wm8994_main_supplies),
245 dev_err(dev, "Failed to disable supplies: %d\n", ret);
252 static int wm8994_device_resume(struct device *dev)
254 struct wm8994 *wm8994 = dev_get_drvdata(dev);
257 ret = regulator_bulk_enable(ARRAY_SIZE(wm8994_main_supplies),
260 dev_err(dev, "Failed to enable supplies: %d\n", ret);
264 ret = wm8994_write(wm8994, WM8994_INTERRUPT_STATUS_1_MASK,
265 WM8994_NUM_IRQ_REGS * 2, &wm8994->irq_masks_cur);
267 dev_err(dev, "Failed to restore interrupt masks: %d\n", ret);
269 ret = wm8994_write(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
272 dev_err(dev, "Failed to restore LDO registers: %d\n", ret);
274 ret = wm8994_write(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
277 dev_err(dev, "Failed to restore GPIO registers: %d\n", ret);
283 #ifdef CONFIG_REGULATOR
284 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
286 struct wm8994_ldo_pdata *ldo_pdata;
291 ldo_pdata = &pdata->ldo[ldo];
293 if (!ldo_pdata->init_data)
296 return ldo_pdata->init_data->num_consumer_supplies != 0;
299 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
306 * Instantiate the generic non-control parts of the device.
308 static int wm8994_device_init(struct wm8994 *wm8994, unsigned long id, int irq)
310 struct wm8994_pdata *pdata = wm8994->dev->platform_data;
313 mutex_init(&wm8994->io_lock);
314 dev_set_drvdata(wm8994->dev, wm8994);
316 /* Add the on-chip regulators first for bootstrapping */
317 ret = mfd_add_devices(wm8994->dev, -1,
318 wm8994_regulator_devs,
319 ARRAY_SIZE(wm8994_regulator_devs),
322 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
326 wm8994->supplies = kzalloc(sizeof(struct regulator_bulk_data) *
327 ARRAY_SIZE(wm8994_main_supplies),
329 if (!wm8994->supplies)
332 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
333 wm8994->supplies[i].supply = wm8994_main_supplies[i];
335 ret = regulator_bulk_get(wm8994->dev, ARRAY_SIZE(wm8994_main_supplies),
338 dev_err(wm8994->dev, "Failed to get supplies: %d\n", ret);
342 ret = regulator_bulk_enable(ARRAY_SIZE(wm8994_main_supplies),
345 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
349 ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
351 dev_err(wm8994->dev, "Failed to read ID register\n");
355 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
361 ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
363 dev_err(wm8994->dev, "Failed to read revision register: %d\n",
371 dev_warn(wm8994->dev, "revision %c not fully supported\n",
375 dev_info(wm8994->dev, "revision %c\n", 'A' + ret);
381 wm8994->irq_base = pdata->irq_base;
382 wm8994->gpio_base = pdata->gpio_base;
384 /* GPIO configuration is only applied if it's non-zero */
385 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
386 if (pdata->gpio_defaults[i]) {
387 wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
389 pdata->gpio_defaults[i]);
394 /* In some system designs where the regulators are not in use,
395 * we can achieve a small reduction in leakage currents by
396 * floating LDO outputs. This bit makes no difference if the
397 * LDOs are enabled, it only affects cases where the LDOs were
398 * in operation and are then disabled.
400 for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
401 if (wm8994_ldo_in_use(pdata, i))
402 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
403 WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
405 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
406 WM8994_LDO1_DISCH, 0);
409 wm8994_irq_init(wm8994);
411 ret = mfd_add_devices(wm8994->dev, -1,
412 wm8994_devs, ARRAY_SIZE(wm8994_devs),
415 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
422 wm8994_irq_exit(wm8994);
424 regulator_bulk_disable(ARRAY_SIZE(wm8994_main_supplies),
427 regulator_bulk_free(ARRAY_SIZE(wm8994_main_supplies), wm8994->supplies);
429 kfree(wm8994->supplies);
431 mfd_remove_devices(wm8994->dev);
436 static void wm8994_device_exit(struct wm8994 *wm8994)
438 mfd_remove_devices(wm8994->dev);
439 wm8994_irq_exit(wm8994);
440 regulator_bulk_disable(ARRAY_SIZE(wm8994_main_supplies),
442 regulator_bulk_free(ARRAY_SIZE(wm8994_main_supplies), wm8994->supplies);
443 kfree(wm8994->supplies);
447 static int wm8994_i2c_read_device(struct wm8994 *wm8994, unsigned short reg,
448 int bytes, void *dest)
450 struct i2c_client *i2c = wm8994->control_data;
452 u16 r = cpu_to_be16(reg);
454 ret = i2c_master_send(i2c, (unsigned char *)&r, 2);
460 ret = i2c_master_recv(i2c, dest, bytes);
468 /* Currently we allocate the write buffer on the stack; this is OK for
469 * small writes - if we need to do large writes this will need to be
472 static int wm8994_i2c_write_device(struct wm8994 *wm8994, unsigned short reg,
473 int bytes, void *src)
475 struct i2c_client *i2c = wm8994->control_data;
476 unsigned char msg[bytes + 2];
479 reg = cpu_to_be16(reg);
480 memcpy(&msg[0], ®, 2);
481 memcpy(&msg[2], src, bytes);
483 ret = i2c_master_send(i2c, msg, bytes + 2);
492 static int wm8994_i2c_probe(struct i2c_client *i2c,
493 const struct i2c_device_id *id)
495 struct wm8994 *wm8994;
497 wm8994 = kzalloc(sizeof(struct wm8994), GFP_KERNEL);
498 if (wm8994 == NULL) {
503 i2c_set_clientdata(i2c, wm8994);
504 wm8994->dev = &i2c->dev;
505 wm8994->control_data = i2c;
506 wm8994->read_dev = wm8994_i2c_read_device;
507 wm8994->write_dev = wm8994_i2c_write_device;
508 wm8994->irq = i2c->irq;
510 return wm8994_device_init(wm8994, id->driver_data, i2c->irq);
513 static int wm8994_i2c_remove(struct i2c_client *i2c)
515 struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
517 wm8994_device_exit(wm8994);
523 static int wm8994_i2c_suspend(struct i2c_client *i2c, pm_message_t state)
525 return wm8994_device_suspend(&i2c->dev);
528 static int wm8994_i2c_resume(struct i2c_client *i2c)
530 return wm8994_device_resume(&i2c->dev);
533 #define wm8994_i2c_suspend NULL
534 #define wm8994_i2c_resume NULL
537 static const struct i2c_device_id wm8994_i2c_id[] = {
541 MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
543 static struct i2c_driver wm8994_i2c_driver = {
546 .owner = THIS_MODULE,
548 .probe = wm8994_i2c_probe,
549 .remove = wm8994_i2c_remove,
550 .suspend = wm8994_i2c_suspend,
551 .resume = wm8994_i2c_resume,
552 .id_table = wm8994_i2c_id,
555 static int __init wm8994_i2c_init(void)
559 ret = i2c_add_driver(&wm8994_i2c_driver);
561 pr_err("Failed to register wm8994 I2C driver: %d\n", ret);
565 module_init(wm8994_i2c_init);
567 static void __exit wm8994_i2c_exit(void)
569 i2c_del_driver(&wm8994_i2c_driver);
571 module_exit(wm8994_i2c_exit);
573 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
574 MODULE_LICENSE("GPL");
575 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");