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 mfd_cell wm8994_devs[] = {
177 { .name = "wm8994-codec" },
178 { .name = "wm8994-gpio" },
182 * Supplies for the main bulk of CODEC; the LDO supplies are ignored
183 * and should be handled via the standard regulator API supply
186 static const char *wm8994_main_supplies[] = {
197 static int wm8994_device_suspend(struct device *dev)
199 struct wm8994 *wm8994 = dev_get_drvdata(dev);
202 /* GPIO configuration state is saved here since we may be configuring
203 * the GPIO alternate functions even if we're not using the gpiolib
206 ret = wm8994_read(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
209 dev_err(dev, "Failed to save GPIO registers: %d\n", ret);
211 /* For similar reasons we also stash the regulator states */
212 ret = wm8994_read(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
215 dev_err(dev, "Failed to save LDO registers: %d\n", ret);
217 ret = regulator_bulk_disable(ARRAY_SIZE(wm8994_main_supplies),
220 dev_err(dev, "Failed to disable supplies: %d\n", ret);
227 static int wm8994_device_resume(struct device *dev)
229 struct wm8994 *wm8994 = dev_get_drvdata(dev);
232 ret = regulator_bulk_enable(ARRAY_SIZE(wm8994_main_supplies),
235 dev_err(dev, "Failed to enable supplies: %d\n", ret);
239 ret = wm8994_write(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
242 dev_err(dev, "Failed to restore LDO registers: %d\n", ret);
244 ret = wm8994_write(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
247 dev_err(dev, "Failed to restore GPIO registers: %d\n", ret);
253 #ifdef CONFIG_REGULATOR
254 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
256 struct wm8994_ldo_pdata *ldo_pdata;
261 ldo_pdata = &pdata->ldo[ldo];
263 if (!ldo_pdata->init_data)
266 return ldo_pdata->init_data->num_consumer_supplies != 0;
269 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
276 * Instantiate the generic non-control parts of the device.
278 static int wm8994_device_init(struct wm8994 *wm8994, unsigned long id, int irq)
280 struct wm8994_pdata *pdata = wm8994->dev->platform_data;
283 mutex_init(&wm8994->io_lock);
284 dev_set_drvdata(wm8994->dev, wm8994);
286 /* Add the on-chip regulators first for bootstrapping */
287 ret = mfd_add_devices(wm8994->dev, -1,
288 wm8994_regulator_devs,
289 ARRAY_SIZE(wm8994_regulator_devs),
292 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
296 wm8994->supplies = kzalloc(sizeof(struct regulator_bulk_data) *
297 ARRAY_SIZE(wm8994_main_supplies),
299 if (!wm8994->supplies)
302 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
303 wm8994->supplies[i].supply = wm8994_main_supplies[i];
305 ret = regulator_bulk_get(wm8994->dev, ARRAY_SIZE(wm8994_main_supplies),
308 dev_err(wm8994->dev, "Failed to get supplies: %d\n", ret);
312 ret = regulator_bulk_enable(ARRAY_SIZE(wm8994_main_supplies),
315 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
319 ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
321 dev_err(wm8994->dev, "Failed to read ID register\n");
325 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
331 ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
333 dev_err(wm8994->dev, "Failed to read revision register: %d\n",
341 dev_warn(wm8994->dev, "revision %c not fully supported\n",
345 dev_info(wm8994->dev, "revision %c\n", 'A' + ret);
351 wm8994->gpio_base = pdata->gpio_base;
353 /* GPIO configuration is only applied if it's non-zero */
354 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
355 if (pdata->gpio_defaults[i]) {
356 wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
358 pdata->gpio_defaults[i]);
363 /* In some system designs where the regulators are not in use,
364 * we can achieve a small reduction in leakage currents by
365 * floating LDO outputs. This bit makes no difference if the
366 * LDOs are enabled, it only affects cases where the LDOs were
367 * in operation and are then disabled.
369 for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
370 if (wm8994_ldo_in_use(pdata, i))
371 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
372 WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
374 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
375 WM8994_LDO1_DISCH, 0);
378 ret = mfd_add_devices(wm8994->dev, -1,
379 wm8994_devs, ARRAY_SIZE(wm8994_devs),
382 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
389 regulator_bulk_disable(ARRAY_SIZE(wm8994_main_supplies),
392 regulator_bulk_free(ARRAY_SIZE(wm8994_main_supplies), wm8994->supplies);
394 kfree(wm8994->supplies);
396 mfd_remove_devices(wm8994->dev);
401 static void wm8994_device_exit(struct wm8994 *wm8994)
403 mfd_remove_devices(wm8994->dev);
404 regulator_bulk_disable(ARRAY_SIZE(wm8994_main_supplies),
406 regulator_bulk_free(ARRAY_SIZE(wm8994_main_supplies), wm8994->supplies);
407 kfree(wm8994->supplies);
411 static int wm8994_i2c_read_device(struct wm8994 *wm8994, unsigned short reg,
412 int bytes, void *dest)
414 struct i2c_client *i2c = wm8994->control_data;
416 u16 r = cpu_to_be16(reg);
418 ret = i2c_master_send(i2c, (unsigned char *)&r, 2);
424 ret = i2c_master_recv(i2c, dest, bytes);
432 /* Currently we allocate the write buffer on the stack; this is OK for
433 * small writes - if we need to do large writes this will need to be
436 static int wm8994_i2c_write_device(struct wm8994 *wm8994, unsigned short reg,
437 int bytes, void *src)
439 struct i2c_client *i2c = wm8994->control_data;
440 unsigned char msg[bytes + 2];
443 reg = cpu_to_be16(reg);
444 memcpy(&msg[0], ®, 2);
445 memcpy(&msg[2], src, bytes);
447 ret = i2c_master_send(i2c, msg, bytes + 2);
456 static int wm8994_i2c_probe(struct i2c_client *i2c,
457 const struct i2c_device_id *id)
459 struct wm8994 *wm8994;
461 wm8994 = kzalloc(sizeof(struct wm8994), GFP_KERNEL);
462 if (wm8994 == NULL) {
467 i2c_set_clientdata(i2c, wm8994);
468 wm8994->dev = &i2c->dev;
469 wm8994->control_data = i2c;
470 wm8994->read_dev = wm8994_i2c_read_device;
471 wm8994->write_dev = wm8994_i2c_write_device;
473 return wm8994_device_init(wm8994, id->driver_data, i2c->irq);
476 static int wm8994_i2c_remove(struct i2c_client *i2c)
478 struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
480 wm8994_device_exit(wm8994);
486 static int wm8994_i2c_suspend(struct i2c_client *i2c, pm_message_t state)
488 return wm8994_device_suspend(&i2c->dev);
491 static int wm8994_i2c_resume(struct i2c_client *i2c)
493 return wm8994_device_resume(&i2c->dev);
496 #define wm8994_i2c_suspend NULL
497 #define wm8994_i2c_resume NULL
500 static const struct i2c_device_id wm8994_i2c_id[] = {
504 MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
506 static struct i2c_driver wm8994_i2c_driver = {
509 .owner = THIS_MODULE,
511 .probe = wm8994_i2c_probe,
512 .remove = wm8994_i2c_remove,
513 .suspend = wm8994_i2c_suspend,
514 .resume = wm8994_i2c_resume,
515 .id_table = wm8994_i2c_id,
518 static int __init wm8994_i2c_init(void)
522 ret = i2c_add_driver(&wm8994_i2c_driver);
524 pr_err("Failed to register wm8994 I2C driver: %d\n", ret);
528 module_init(wm8994_i2c_init);
530 static void __exit wm8994_i2c_exit(void)
532 i2c_del_driver(&wm8994_i2c_driver);
534 module_exit(wm8994_i2c_exit);
536 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
537 MODULE_LICENSE("GPL");
538 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");