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/i2c.h>
18 #include <linux/delay.h>
19 #include <linux/mfd/core.h>
20 #include <linux/regulator/consumer.h>
21 #include <linux/regulator/machine.h>
23 #include <linux/mfd/wm8994/core.h>
24 #include <linux/mfd/wm8994/pdata.h>
25 #include <linux/mfd/wm8994/registers.h>
27 static int wm8994_read(struct wm8994 *wm8994, unsigned short reg,
28 int bytes, void *dest)
36 ret = wm8994->read_dev(wm8994, reg, bytes, dest);
40 for (i = 0; i < bytes / 2; i++) {
41 buf[i] = be16_to_cpu(buf[i]);
43 dev_vdbg(wm8994->dev, "Read %04x from R%d(0x%x)\n",
44 buf[i], reg + i, reg + i);
51 * wm8994_reg_read: Read a single WM8994 register.
53 * @wm8994: Device to read from.
54 * @reg: Register to read.
56 int wm8994_reg_read(struct wm8994 *wm8994, unsigned short reg)
61 mutex_lock(&wm8994->io_lock);
63 ret = wm8994_read(wm8994, reg, 2, &val);
65 mutex_unlock(&wm8994->io_lock);
72 EXPORT_SYMBOL_GPL(wm8994_reg_read);
75 * wm8994_bulk_read: Read multiple WM8994 registers
77 * @wm8994: Device to read from
78 * @reg: First register
79 * @count: Number of registers
80 * @buf: Buffer to fill.
82 int wm8994_bulk_read(struct wm8994 *wm8994, unsigned short reg,
87 mutex_lock(&wm8994->io_lock);
89 ret = wm8994_read(wm8994, reg, count * 2, buf);
91 mutex_unlock(&wm8994->io_lock);
95 EXPORT_SYMBOL_GPL(wm8994_bulk_read);
97 static int wm8994_write(struct wm8994 *wm8994, unsigned short reg,
106 for (i = 0; i < bytes / 2; i++) {
107 dev_vdbg(wm8994->dev, "Write %04x to R%d(0x%x)\n",
108 buf[i], reg + i, reg + i);
110 buf[i] = cpu_to_be16(buf[i]);
113 return wm8994->write_dev(wm8994, reg, bytes, src);
117 * wm8994_reg_write: Write a single WM8994 register.
119 * @wm8994: Device to write to.
120 * @reg: Register to write to.
121 * @val: Value to write.
123 int wm8994_reg_write(struct wm8994 *wm8994, unsigned short reg,
128 mutex_lock(&wm8994->io_lock);
130 ret = wm8994_write(wm8994, reg, 2, &val);
132 mutex_unlock(&wm8994->io_lock);
136 EXPORT_SYMBOL_GPL(wm8994_reg_write);
139 * wm8994_set_bits: Set the value of a bitfield in a WM8994 register
141 * @wm8994: Device to write to.
142 * @reg: Register to write to.
143 * @mask: Mask of bits to set.
144 * @val: Value to set (unshifted)
146 int wm8994_set_bits(struct wm8994 *wm8994, unsigned short reg,
147 unsigned short mask, unsigned short val)
152 mutex_lock(&wm8994->io_lock);
154 ret = wm8994_read(wm8994, reg, 2, &r);
161 ret = wm8994_write(wm8994, reg, 2, &r);
164 mutex_unlock(&wm8994->io_lock);
168 EXPORT_SYMBOL_GPL(wm8994_set_bits);
170 static struct mfd_cell wm8994_regulator_devs[] = {
171 { .name = "wm8994-ldo", .id = 1 },
172 { .name = "wm8994-ldo", .id = 2 },
175 static struct mfd_cell wm8994_devs[] = {
176 { .name = "wm8994-codec" },
177 { .name = "wm8994-gpio" },
181 * Supplies for the main bulk of CODEC; the LDO supplies are ignored
182 * and should be handled via the standard regulator API supply
185 static const char *wm8994_main_supplies[] = {
196 static int wm8994_device_suspend(struct device *dev)
198 struct wm8994 *wm8994 = dev_get_drvdata(dev);
201 /* GPIO configuration state is saved here since we may be configuring
202 * the GPIO alternate functions even if we're not using the gpiolib
205 ret = wm8994_read(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
208 dev_err(dev, "Failed to save GPIO registers: %d\n", ret);
210 /* For similar reasons we also stash the regulator states */
211 ret = wm8994_read(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
214 dev_err(dev, "Failed to save LDO registers: %d\n", ret);
216 ret = regulator_bulk_disable(ARRAY_SIZE(wm8994_main_supplies),
219 dev_err(dev, "Failed to disable supplies: %d\n", ret);
226 static int wm8994_device_resume(struct device *dev)
228 struct wm8994 *wm8994 = dev_get_drvdata(dev);
231 ret = regulator_bulk_enable(ARRAY_SIZE(wm8994_main_supplies),
234 dev_err(dev, "Failed to enable supplies: %d\n", ret);
238 ret = wm8994_write(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
241 dev_err(dev, "Failed to restore LDO registers: %d\n", ret);
243 ret = wm8994_write(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
246 dev_err(dev, "Failed to restore GPIO registers: %d\n", ret);
252 #ifdef CONFIG_REGULATOR
253 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
255 struct wm8994_ldo_pdata *ldo_pdata;
260 ldo_pdata = &pdata->ldo[ldo];
262 if (!ldo_pdata->init_data)
265 return ldo_pdata->init_data->num_consumer_supplies != 0;
268 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
275 * Instantiate the generic non-control parts of the device.
277 static int wm8994_device_init(struct wm8994 *wm8994, unsigned long id, int irq)
279 struct wm8994_pdata *pdata = wm8994->dev->platform_data;
282 mutex_init(&wm8994->io_lock);
283 dev_set_drvdata(wm8994->dev, wm8994);
285 /* Add the on-chip regulators first for bootstrapping */
286 ret = mfd_add_devices(wm8994->dev, -1,
287 wm8994_regulator_devs,
288 ARRAY_SIZE(wm8994_regulator_devs),
291 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
295 wm8994->supplies = kzalloc(sizeof(struct regulator_bulk_data) *
296 ARRAY_SIZE(wm8994_main_supplies),
298 if (!wm8994->supplies)
301 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
302 wm8994->supplies[i].supply = wm8994_main_supplies[i];
304 ret = regulator_bulk_get(wm8994->dev, ARRAY_SIZE(wm8994_main_supplies),
307 dev_err(wm8994->dev, "Failed to get supplies: %d\n", ret);
311 ret = regulator_bulk_enable(ARRAY_SIZE(wm8994_main_supplies),
314 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
318 ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
320 dev_err(wm8994->dev, "Failed to read ID register\n");
324 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
330 ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
332 dev_err(wm8994->dev, "Failed to read revision register: %d\n",
340 dev_warn(wm8994->dev, "revision %c not fully supported\n",
344 dev_info(wm8994->dev, "revision %c\n", 'A' + ret);
350 wm8994->gpio_base = pdata->gpio_base;
352 /* GPIO configuration is only applied if it's non-zero */
353 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
354 if (pdata->gpio_defaults[i]) {
355 wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
357 pdata->gpio_defaults[i]);
362 /* In some system designs where the regulators are not in use,
363 * we can achieve a small reduction in leakage currents by
364 * floating LDO outputs. This bit makes no difference if the
365 * LDOs are enabled, it only affects cases where the LDOs were
366 * in operation and are then disabled.
368 for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
369 if (wm8994_ldo_in_use(pdata, i))
370 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
371 WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
373 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
374 WM8994_LDO1_DISCH, 0);
377 ret = mfd_add_devices(wm8994->dev, -1,
378 wm8994_devs, ARRAY_SIZE(wm8994_devs),
381 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
388 regulator_bulk_disable(ARRAY_SIZE(wm8994_main_supplies),
391 regulator_bulk_free(ARRAY_SIZE(wm8994_main_supplies), wm8994->supplies);
393 kfree(wm8994->supplies);
395 mfd_remove_devices(wm8994->dev);
400 static void wm8994_device_exit(struct wm8994 *wm8994)
402 mfd_remove_devices(wm8994->dev);
403 regulator_bulk_disable(ARRAY_SIZE(wm8994_main_supplies),
405 regulator_bulk_free(ARRAY_SIZE(wm8994_main_supplies), wm8994->supplies);
406 kfree(wm8994->supplies);
410 static int wm8994_i2c_read_device(struct wm8994 *wm8994, unsigned short reg,
411 int bytes, void *dest)
413 struct i2c_client *i2c = wm8994->control_data;
415 u16 r = cpu_to_be16(reg);
417 ret = i2c_master_send(i2c, (unsigned char *)&r, 2);
423 ret = i2c_master_recv(i2c, dest, bytes);
431 /* Currently we allocate the write buffer on the stack; this is OK for
432 * small writes - if we need to do large writes this will need to be
435 static int wm8994_i2c_write_device(struct wm8994 *wm8994, unsigned short reg,
436 int bytes, void *src)
438 struct i2c_client *i2c = wm8994->control_data;
439 unsigned char msg[bytes + 2];
442 reg = cpu_to_be16(reg);
443 memcpy(&msg[0], ®, 2);
444 memcpy(&msg[2], src, bytes);
446 ret = i2c_master_send(i2c, msg, bytes + 2);
455 static int wm8994_i2c_probe(struct i2c_client *i2c,
456 const struct i2c_device_id *id)
458 struct wm8994 *wm8994;
460 wm8994 = kzalloc(sizeof(struct wm8994), GFP_KERNEL);
461 if (wm8994 == NULL) {
466 i2c_set_clientdata(i2c, wm8994);
467 wm8994->dev = &i2c->dev;
468 wm8994->control_data = i2c;
469 wm8994->read_dev = wm8994_i2c_read_device;
470 wm8994->write_dev = wm8994_i2c_write_device;
472 return wm8994_device_init(wm8994, id->driver_data, i2c->irq);
475 static int wm8994_i2c_remove(struct i2c_client *i2c)
477 struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
479 wm8994_device_exit(wm8994);
485 static int wm8994_i2c_suspend(struct i2c_client *i2c, pm_message_t state)
487 return wm8994_device_suspend(&i2c->dev);
490 static int wm8994_i2c_resume(struct i2c_client *i2c)
492 return wm8994_device_resume(&i2c->dev);
495 #define wm8994_i2c_suspend NULL
496 #define wm8994_i2c_resume NULL
499 static const struct i2c_device_id wm8994_i2c_id[] = {
503 MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
505 static struct i2c_driver wm8994_i2c_driver = {
508 .owner = THIS_MODULE,
510 .probe = wm8994_i2c_probe,
511 .remove = wm8994_i2c_remove,
512 .suspend = wm8994_i2c_suspend,
513 .resume = wm8994_i2c_resume,
514 .id_table = wm8994_i2c_id,
517 static int __init wm8994_i2c_init(void)
521 ret = i2c_add_driver(&wm8994_i2c_driver);
523 pr_err("Failed to register wm8994 I2C driver: %d\n", ret);
527 module_init(wm8994_i2c_init);
529 static void __exit wm8994_i2c_exit(void)
531 i2c_del_driver(&wm8994_i2c_driver);
533 module_exit(wm8994_i2c_exit);
535 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
536 MODULE_LICENSE("GPL");
537 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");