spi-topcliff-pch: supports a spi mode setup and bit order setup by IO control
[zen-stable.git] / drivers / mfd / wm8994-core.c
blobf04920bca1343d9efc574d7a6668abe49f10757e
1 /*
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/err.h>
20 #include <linux/delay.h>
21 #include <linux/mfd/core.h>
22 #include <linux/pm_runtime.h>
23 #include <linux/regmap.h>
24 #include <linux/regulator/consumer.h>
25 #include <linux/regulator/machine.h>
27 #include <linux/mfd/wm8994/core.h>
28 #include <linux/mfd/wm8994/pdata.h>
29 #include <linux/mfd/wm8994/registers.h>
31 #include "wm8994.h"
33 /**
34 * wm8994_reg_read: Read a single WM8994 register.
36 * @wm8994: Device to read from.
37 * @reg: Register to read.
39 int wm8994_reg_read(struct wm8994 *wm8994, unsigned short reg)
41 unsigned int val;
42 int ret;
44 ret = regmap_read(wm8994->regmap, reg, &val);
46 if (ret < 0)
47 return ret;
48 else
49 return val;
51 EXPORT_SYMBOL_GPL(wm8994_reg_read);
53 /**
54 * wm8994_bulk_read: Read multiple WM8994 registers
56 * @wm8994: Device to read from
57 * @reg: First register
58 * @count: Number of registers
59 * @buf: Buffer to fill. The data will be returned big endian.
61 int wm8994_bulk_read(struct wm8994 *wm8994, unsigned short reg,
62 int count, u16 *buf)
64 return regmap_bulk_read(wm8994->regmap, reg, buf, count);
67 /**
68 * wm8994_reg_write: Write a single WM8994 register.
70 * @wm8994: Device to write to.
71 * @reg: Register to write to.
72 * @val: Value to write.
74 int wm8994_reg_write(struct wm8994 *wm8994, unsigned short reg,
75 unsigned short val)
77 return regmap_write(wm8994->regmap, reg, val);
79 EXPORT_SYMBOL_GPL(wm8994_reg_write);
81 /**
82 * wm8994_bulk_write: Write multiple WM8994 registers
84 * @wm8994: Device to write to
85 * @reg: First register
86 * @count: Number of registers
87 * @buf: Buffer to write from. Data must be big-endian formatted.
89 int wm8994_bulk_write(struct wm8994 *wm8994, unsigned short reg,
90 int count, const u16 *buf)
92 return regmap_raw_write(wm8994->regmap, reg, buf, count * sizeof(u16));
94 EXPORT_SYMBOL_GPL(wm8994_bulk_write);
96 /**
97 * wm8994_set_bits: Set the value of a bitfield in a WM8994 register
99 * @wm8994: Device to write to.
100 * @reg: Register to write to.
101 * @mask: Mask of bits to set.
102 * @val: Value to set (unshifted)
104 int wm8994_set_bits(struct wm8994 *wm8994, unsigned short reg,
105 unsigned short mask, unsigned short val)
107 return regmap_update_bits(wm8994->regmap, reg, mask, val);
109 EXPORT_SYMBOL_GPL(wm8994_set_bits);
111 static struct mfd_cell wm8994_regulator_devs[] = {
113 .name = "wm8994-ldo",
114 .id = 1,
115 .pm_runtime_no_callbacks = true,
118 .name = "wm8994-ldo",
119 .id = 2,
120 .pm_runtime_no_callbacks = true,
124 static struct resource wm8994_codec_resources[] = {
126 .start = WM8994_IRQ_TEMP_SHUT,
127 .end = WM8994_IRQ_TEMP_WARN,
128 .flags = IORESOURCE_IRQ,
132 static struct resource wm8994_gpio_resources[] = {
134 .start = WM8994_IRQ_GPIO(1),
135 .end = WM8994_IRQ_GPIO(11),
136 .flags = IORESOURCE_IRQ,
140 static struct mfd_cell wm8994_devs[] = {
142 .name = "wm8994-codec",
143 .num_resources = ARRAY_SIZE(wm8994_codec_resources),
144 .resources = wm8994_codec_resources,
148 .name = "wm8994-gpio",
149 .num_resources = ARRAY_SIZE(wm8994_gpio_resources),
150 .resources = wm8994_gpio_resources,
151 .pm_runtime_no_callbacks = true,
156 * Supplies for the main bulk of CODEC; the LDO supplies are ignored
157 * and should be handled via the standard regulator API supply
158 * management.
160 static const char *wm1811_main_supplies[] = {
161 "DBVDD1",
162 "DBVDD2",
163 "DBVDD3",
164 "DCVDD",
165 "AVDD1",
166 "AVDD2",
167 "CPVDD",
168 "SPKVDD1",
169 "SPKVDD2",
172 static const char *wm8994_main_supplies[] = {
173 "DBVDD",
174 "DCVDD",
175 "AVDD1",
176 "AVDD2",
177 "CPVDD",
178 "SPKVDD1",
179 "SPKVDD2",
182 static const char *wm8958_main_supplies[] = {
183 "DBVDD1",
184 "DBVDD2",
185 "DBVDD3",
186 "DCVDD",
187 "AVDD1",
188 "AVDD2",
189 "CPVDD",
190 "SPKVDD1",
191 "SPKVDD2",
194 #ifdef CONFIG_PM
195 static int wm8994_suspend(struct device *dev)
197 struct wm8994 *wm8994 = dev_get_drvdata(dev);
198 int ret;
200 /* Don't actually go through with the suspend if the CODEC is
201 * still active (eg, for audio passthrough from CP. */
202 ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_1);
203 if (ret < 0) {
204 dev_err(dev, "Failed to read power status: %d\n", ret);
205 } else if (ret & WM8994_VMID_SEL_MASK) {
206 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
207 return 0;
210 ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_4);
211 if (ret < 0) {
212 dev_err(dev, "Failed to read power status: %d\n", ret);
213 } else if (ret & (WM8994_AIF2ADCL_ENA | WM8994_AIF2ADCR_ENA |
214 WM8994_AIF1ADC2L_ENA | WM8994_AIF1ADC2R_ENA |
215 WM8994_AIF1ADC1L_ENA | WM8994_AIF1ADC1R_ENA)) {
216 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
217 return 0;
220 ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_5);
221 if (ret < 0) {
222 dev_err(dev, "Failed to read power status: %d\n", ret);
223 } else if (ret & (WM8994_AIF2DACL_ENA | WM8994_AIF2DACR_ENA |
224 WM8994_AIF1DAC2L_ENA | WM8994_AIF1DAC2R_ENA |
225 WM8994_AIF1DAC1L_ENA | WM8994_AIF1DAC1R_ENA)) {
226 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
227 return 0;
230 switch (wm8994->type) {
231 case WM8958:
232 case WM1811:
233 ret = wm8994_reg_read(wm8994, WM8958_MIC_DETECT_1);
234 if (ret < 0) {
235 dev_err(dev, "Failed to read power status: %d\n", ret);
236 } else if (ret & WM8958_MICD_ENA) {
237 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
238 return 0;
240 break;
241 default:
242 break;
245 switch (wm8994->type) {
246 case WM1811:
247 ret = wm8994_reg_read(wm8994, WM8994_ANTIPOP_2);
248 if (ret < 0) {
249 dev_err(dev, "Failed to read jackdet: %d\n", ret);
250 } else if (ret & WM1811_JACKDET_MODE_MASK) {
251 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
252 return 0;
254 break;
255 default:
256 break;
259 switch (wm8994->type) {
260 case WM1811:
261 ret = wm8994_reg_read(wm8994, WM8994_ANTIPOP_2);
262 if (ret < 0) {
263 dev_err(dev, "Failed to read jackdet: %d\n", ret);
264 } else if (ret & WM1811_JACKDET_MODE_MASK) {
265 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
266 return 0;
268 break;
269 default:
270 break;
273 switch (wm8994->type) {
274 case WM1811:
275 ret = wm8994_reg_read(wm8994, WM8994_ANTIPOP_2);
276 if (ret < 0) {
277 dev_err(dev, "Failed to read jackdet: %d\n", ret);
278 } else if (ret & WM1811_JACKDET_MODE_MASK) {
279 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
280 return 0;
282 break;
283 default:
284 break;
287 /* Disable LDO pulldowns while the device is suspended if we
288 * don't know that something will be driving them. */
289 if (!wm8994->ldo_ena_always_driven)
290 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
291 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
292 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD);
294 /* Explicitly put the device into reset in case regulators
295 * don't get disabled in order to ensure consistent restart.
297 wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET,
298 wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET));
300 regcache_cache_only(wm8994->regmap, true);
301 regcache_mark_dirty(wm8994->regmap);
303 wm8994->suspended = true;
305 ret = regulator_bulk_disable(wm8994->num_supplies,
306 wm8994->supplies);
307 if (ret != 0) {
308 dev_err(dev, "Failed to disable supplies: %d\n", ret);
309 return ret;
312 return 0;
315 static int wm8994_resume(struct device *dev)
317 struct wm8994 *wm8994 = dev_get_drvdata(dev);
318 int ret;
320 /* We may have lied to the PM core about suspending */
321 if (!wm8994->suspended)
322 return 0;
324 ret = regulator_bulk_enable(wm8994->num_supplies,
325 wm8994->supplies);
326 if (ret != 0) {
327 dev_err(dev, "Failed to enable supplies: %d\n", ret);
328 return ret;
331 regcache_cache_only(wm8994->regmap, false);
332 ret = regcache_sync(wm8994->regmap);
333 if (ret != 0) {
334 dev_err(dev, "Failed to restore register map: %d\n", ret);
335 goto err_enable;
338 /* Disable LDO pulldowns while the device is active */
339 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
340 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
343 wm8994->suspended = false;
345 return 0;
347 err_enable:
348 regulator_bulk_disable(wm8994->num_supplies, wm8994->supplies);
350 return ret;
352 #endif
354 #ifdef CONFIG_REGULATOR
355 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
357 struct wm8994_ldo_pdata *ldo_pdata;
359 if (!pdata)
360 return 0;
362 ldo_pdata = &pdata->ldo[ldo];
364 if (!ldo_pdata->init_data)
365 return 0;
367 return ldo_pdata->init_data->num_consumer_supplies != 0;
369 #else
370 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
372 return 0;
374 #endif
377 * Instantiate the generic non-control parts of the device.
379 static int wm8994_device_init(struct wm8994 *wm8994, int irq)
381 struct wm8994_pdata *pdata = wm8994->dev->platform_data;
382 struct regmap_config *regmap_config;
383 const char *devname;
384 int ret, i;
385 int pulls = 0;
387 dev_set_drvdata(wm8994->dev, wm8994);
389 /* Add the on-chip regulators first for bootstrapping */
390 ret = mfd_add_devices(wm8994->dev, -1,
391 wm8994_regulator_devs,
392 ARRAY_SIZE(wm8994_regulator_devs),
393 NULL, 0);
394 if (ret != 0) {
395 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
396 goto err_regmap;
399 switch (wm8994->type) {
400 case WM1811:
401 wm8994->num_supplies = ARRAY_SIZE(wm1811_main_supplies);
402 break;
403 case WM8994:
404 wm8994->num_supplies = ARRAY_SIZE(wm8994_main_supplies);
405 break;
406 case WM8958:
407 wm8994->num_supplies = ARRAY_SIZE(wm8958_main_supplies);
408 break;
409 default:
410 BUG();
411 goto err_regmap;
414 wm8994->supplies = devm_kzalloc(wm8994->dev,
415 sizeof(struct regulator_bulk_data) *
416 wm8994->num_supplies, GFP_KERNEL);
417 if (!wm8994->supplies) {
418 ret = -ENOMEM;
419 goto err_regmap;
422 switch (wm8994->type) {
423 case WM1811:
424 for (i = 0; i < ARRAY_SIZE(wm1811_main_supplies); i++)
425 wm8994->supplies[i].supply = wm1811_main_supplies[i];
426 break;
427 case WM8994:
428 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
429 wm8994->supplies[i].supply = wm8994_main_supplies[i];
430 break;
431 case WM8958:
432 for (i = 0; i < ARRAY_SIZE(wm8958_main_supplies); i++)
433 wm8994->supplies[i].supply = wm8958_main_supplies[i];
434 break;
435 default:
436 BUG();
437 goto err_regmap;
440 ret = regulator_bulk_get(wm8994->dev, wm8994->num_supplies,
441 wm8994->supplies);
442 if (ret != 0) {
443 dev_err(wm8994->dev, "Failed to get supplies: %d\n", ret);
444 goto err_regmap;
447 ret = regulator_bulk_enable(wm8994->num_supplies,
448 wm8994->supplies);
449 if (ret != 0) {
450 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
451 goto err_get;
454 ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
455 if (ret < 0) {
456 dev_err(wm8994->dev, "Failed to read ID register\n");
457 goto err_enable;
459 switch (ret) {
460 case 0x1811:
461 devname = "WM1811";
462 if (wm8994->type != WM1811)
463 dev_warn(wm8994->dev, "Device registered as type %d\n",
464 wm8994->type);
465 wm8994->type = WM1811;
466 break;
467 case 0x8994:
468 devname = "WM8994";
469 if (wm8994->type != WM8994)
470 dev_warn(wm8994->dev, "Device registered as type %d\n",
471 wm8994->type);
472 wm8994->type = WM8994;
473 break;
474 case 0x8958:
475 devname = "WM8958";
476 if (wm8994->type != WM8958)
477 dev_warn(wm8994->dev, "Device registered as type %d\n",
478 wm8994->type);
479 wm8994->type = WM8958;
480 break;
481 default:
482 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
483 ret);
484 ret = -EINVAL;
485 goto err_enable;
488 ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
489 if (ret < 0) {
490 dev_err(wm8994->dev, "Failed to read revision register: %d\n",
491 ret);
492 goto err_enable;
494 wm8994->revision = ret;
496 switch (wm8994->type) {
497 case WM8994:
498 switch (wm8994->revision) {
499 case 0:
500 case 1:
501 dev_warn(wm8994->dev,
502 "revision %c not fully supported\n",
503 'A' + wm8994->revision);
504 break;
505 default:
506 break;
508 break;
509 case WM1811:
510 /* Revision C did not change the relevant layer */
511 if (wm8994->revision > 1)
512 wm8994->revision++;
513 break;
514 default:
515 break;
518 dev_info(wm8994->dev, "%s revision %c\n", devname,
519 'A' + wm8994->revision);
521 switch (wm8994->type) {
522 case WM1811:
523 regmap_config = &wm1811_regmap_config;
524 break;
525 case WM8994:
526 regmap_config = &wm8994_regmap_config;
527 break;
528 case WM8958:
529 regmap_config = &wm8958_regmap_config;
530 break;
531 default:
532 dev_err(wm8994->dev, "Unknown device type %d\n", wm8994->type);
533 return -EINVAL;
536 ret = regmap_reinit_cache(wm8994->regmap, regmap_config);
537 if (ret != 0) {
538 dev_err(wm8994->dev, "Failed to reinit register cache: %d\n",
539 ret);
540 return ret;
543 if (pdata) {
544 wm8994->irq_base = pdata->irq_base;
545 wm8994->gpio_base = pdata->gpio_base;
547 /* GPIO configuration is only applied if it's non-zero */
548 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
549 if (pdata->gpio_defaults[i]) {
550 wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
551 0xffff,
552 pdata->gpio_defaults[i]);
556 wm8994->ldo_ena_always_driven = pdata->ldo_ena_always_driven;
558 if (pdata->spkmode_pu)
559 pulls |= WM8994_SPKMODE_PU;
562 /* Disable unneeded pulls */
563 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
564 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD |
565 WM8994_SPKMODE_PU | WM8994_CSNADDR_PD,
566 pulls);
568 /* In some system designs where the regulators are not in use,
569 * we can achieve a small reduction in leakage currents by
570 * floating LDO outputs. This bit makes no difference if the
571 * LDOs are enabled, it only affects cases where the LDOs were
572 * in operation and are then disabled.
574 for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
575 if (wm8994_ldo_in_use(pdata, i))
576 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
577 WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
578 else
579 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
580 WM8994_LDO1_DISCH, 0);
583 wm8994_irq_init(wm8994);
585 ret = mfd_add_devices(wm8994->dev, -1,
586 wm8994_devs, ARRAY_SIZE(wm8994_devs),
587 NULL, 0);
588 if (ret != 0) {
589 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
590 goto err_irq;
593 pm_runtime_enable(wm8994->dev);
594 pm_runtime_resume(wm8994->dev);
596 return 0;
598 err_irq:
599 wm8994_irq_exit(wm8994);
600 err_enable:
601 regulator_bulk_disable(wm8994->num_supplies,
602 wm8994->supplies);
603 err_get:
604 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
605 err_regmap:
606 regmap_exit(wm8994->regmap);
607 mfd_remove_devices(wm8994->dev);
608 return ret;
611 static void wm8994_device_exit(struct wm8994 *wm8994)
613 pm_runtime_disable(wm8994->dev);
614 mfd_remove_devices(wm8994->dev);
615 wm8994_irq_exit(wm8994);
616 regulator_bulk_disable(wm8994->num_supplies,
617 wm8994->supplies);
618 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
619 regmap_exit(wm8994->regmap);
622 static const struct of_device_id wm8994_of_match[] = {
623 { .compatible = "wlf,wm1811", },
624 { .compatible = "wlf,wm8994", },
625 { .compatible = "wlf,wm8958", },
628 MODULE_DEVICE_TABLE(of, wm8994_of_match);
630 static int wm8994_i2c_probe(struct i2c_client *i2c,
631 const struct i2c_device_id *id)
633 struct wm8994 *wm8994;
634 int ret;
636 wm8994 = devm_kzalloc(&i2c->dev, sizeof(struct wm8994), GFP_KERNEL);
637 if (wm8994 == NULL)
638 return -ENOMEM;
640 i2c_set_clientdata(i2c, wm8994);
641 wm8994->dev = &i2c->dev;
642 wm8994->irq = i2c->irq;
643 wm8994->type = id->driver_data;
645 wm8994->regmap = regmap_init_i2c(i2c, &wm8994_base_regmap_config);
646 if (IS_ERR(wm8994->regmap)) {
647 ret = PTR_ERR(wm8994->regmap);
648 dev_err(wm8994->dev, "Failed to allocate register map: %d\n",
649 ret);
650 return ret;
653 return wm8994_device_init(wm8994, i2c->irq);
656 static int wm8994_i2c_remove(struct i2c_client *i2c)
658 struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
660 wm8994_device_exit(wm8994);
662 return 0;
665 static const struct i2c_device_id wm8994_i2c_id[] = {
666 { "wm1811", WM1811 },
667 { "wm1811a", WM1811 },
668 { "wm8994", WM8994 },
669 { "wm8958", WM8958 },
672 MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
674 static UNIVERSAL_DEV_PM_OPS(wm8994_pm_ops, wm8994_suspend, wm8994_resume,
675 NULL);
677 static struct i2c_driver wm8994_i2c_driver = {
678 .driver = {
679 .name = "wm8994",
680 .owner = THIS_MODULE,
681 .pm = &wm8994_pm_ops,
682 .of_match_table = wm8994_of_match,
684 .probe = wm8994_i2c_probe,
685 .remove = wm8994_i2c_remove,
686 .id_table = wm8994_i2c_id,
689 static int __init wm8994_i2c_init(void)
691 int ret;
693 ret = i2c_add_driver(&wm8994_i2c_driver);
694 if (ret != 0)
695 pr_err("Failed to register wm8994 I2C driver: %d\n", ret);
697 return ret;
699 module_init(wm8994_i2c_init);
701 static void __exit wm8994_i2c_exit(void)
703 i2c_del_driver(&wm8994_i2c_driver);
705 module_exit(wm8994_i2c_exit);
707 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
708 MODULE_LICENSE("GPL");
709 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");