Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * wm8994-core.c -- Device access for Wolfson WM8994
4 *
5 * Copyright 2009 Wolfson Microelectronics PLC.
6 *
7 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
8 */
9
10#include <linux/kernel.h>
11#include <linux/module.h>
12#include <linux/slab.h>
13#include <linux/i2c.h>
14#include <linux/err.h>
15#include <linux/delay.h>
16#include <linux/mfd/core.h>
17#include <linux/of.h>
18#include <linux/pm_runtime.h>
19#include <linux/regmap.h>
20#include <linux/regulator/consumer.h>
21#include <linux/regulator/machine.h>
22
23#include <linux/mfd/wm8994/core.h>
24#include <linux/mfd/wm8994/pdata.h>
25#include <linux/mfd/wm8994/registers.h>
26
27#include "wm8994.h"
28
29static const struct mfd_cell wm8994_regulator_devs[] = {
30 {
31 .name = "wm8994-ldo",
32 .id = 0,
33 .pm_runtime_no_callbacks = true,
34 },
35 {
36 .name = "wm8994-ldo",
37 .id = 1,
38 .pm_runtime_no_callbacks = true,
39 },
40};
41
42static const struct resource wm8994_codec_resources[] = {
43 {
44 .start = WM8994_IRQ_TEMP_SHUT,
45 .end = WM8994_IRQ_TEMP_WARN,
46 .flags = IORESOURCE_IRQ,
47 },
48};
49
50static const struct resource wm8994_gpio_resources[] = {
51 {
52 .start = WM8994_IRQ_GPIO(1),
53 .end = WM8994_IRQ_GPIO(11),
54 .flags = IORESOURCE_IRQ,
55 },
56};
57
58static const struct mfd_cell wm8994_devs[] = {
59 {
60 .name = "wm8994-codec",
61 .num_resources = ARRAY_SIZE(wm8994_codec_resources),
62 .resources = wm8994_codec_resources,
63 },
64
65 {
66 .name = "wm8994-gpio",
67 .num_resources = ARRAY_SIZE(wm8994_gpio_resources),
68 .resources = wm8994_gpio_resources,
69 .pm_runtime_no_callbacks = true,
70 },
71};
72
73/*
74 * Supplies for the main bulk of CODEC; the LDO supplies are ignored
75 * and should be handled via the standard regulator API supply
76 * management.
77 */
78static const char *wm1811_main_supplies[] = {
79 "DBVDD1",
80 "DBVDD2",
81 "DBVDD3",
82 "DCVDD",
83 "AVDD1",
84 "AVDD2",
85 "CPVDD",
86 "SPKVDD1",
87 "SPKVDD2",
88};
89
90static const char *wm8994_main_supplies[] = {
91 "DBVDD",
92 "DCVDD",
93 "AVDD1",
94 "AVDD2",
95 "CPVDD",
96 "SPKVDD1",
97 "SPKVDD2",
98};
99
100static const char *wm8958_main_supplies[] = {
101 "DBVDD1",
102 "DBVDD2",
103 "DBVDD3",
104 "DCVDD",
105 "AVDD1",
106 "AVDD2",
107 "CPVDD",
108 "SPKVDD1",
109 "SPKVDD2",
110};
111
112static int wm8994_suspend(struct device *dev)
113{
114 struct wm8994 *wm8994 = dev_get_drvdata(dev);
115 int ret;
116
117 /* Don't actually go through with the suspend if the CODEC is
118 * still active for accessory detect. */
119 switch (wm8994->type) {
120 case WM8958:
121 case WM1811:
122 ret = wm8994_reg_read(wm8994, WM8958_MIC_DETECT_1);
123 if (ret < 0) {
124 dev_err(dev, "Failed to read power status: %d\n", ret);
125 } else if (ret & WM8958_MICD_ENA) {
126 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
127 return 0;
128 }
129 break;
130 default:
131 break;
132 }
133
134 /* Disable LDO pulldowns while the device is suspended if we
135 * don't know that something will be driving them. */
136 if (!wm8994->ldo_ena_always_driven)
137 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
138 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
139 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD);
140
141 /* Explicitly put the device into reset in case regulators
142 * don't get disabled in order to ensure consistent restart.
143 */
144 wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET,
145 wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET));
146
147 regcache_mark_dirty(wm8994->regmap);
148
149 /* Restore GPIO registers to prevent problems with mismatched
150 * pin configurations.
151 */
152 ret = regcache_sync_region(wm8994->regmap, WM8994_GPIO_1,
153 WM8994_GPIO_11);
154 if (ret != 0)
155 dev_err(dev, "Failed to restore GPIO registers: %d\n", ret);
156
157 /* In case one of the GPIOs is used as a wake input. */
158 ret = regcache_sync_region(wm8994->regmap,
159 WM8994_INTERRUPT_STATUS_1_MASK,
160 WM8994_INTERRUPT_STATUS_1_MASK);
161 if (ret != 0)
162 dev_err(dev, "Failed to restore interrupt mask: %d\n", ret);
163
164 regcache_cache_only(wm8994->regmap, true);
165 wm8994->suspended = true;
166
167 ret = regulator_bulk_disable(wm8994->num_supplies,
168 wm8994->supplies);
169 if (ret != 0) {
170 dev_err(dev, "Failed to disable supplies: %d\n", ret);
171 return ret;
172 }
173
174 return 0;
175}
176
177static int wm8994_resume(struct device *dev)
178{
179 struct wm8994 *wm8994 = dev_get_drvdata(dev);
180 int ret;
181
182 /* We may have lied to the PM core about suspending */
183 if (!wm8994->suspended)
184 return 0;
185
186 ret = regulator_bulk_enable(wm8994->num_supplies,
187 wm8994->supplies);
188 if (ret != 0) {
189 dev_err(dev, "Failed to enable supplies: %d\n", ret);
190 return ret;
191 }
192
193 regcache_cache_only(wm8994->regmap, false);
194 ret = regcache_sync(wm8994->regmap);
195 if (ret != 0) {
196 dev_err(dev, "Failed to restore register map: %d\n", ret);
197 goto err_enable;
198 }
199
200 /* Disable LDO pulldowns while the device is active */
201 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
202 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
203 0);
204
205 wm8994->suspended = false;
206
207 return 0;
208
209err_enable:
210 regulator_bulk_disable(wm8994->num_supplies, wm8994->supplies);
211
212 return ret;
213}
214
215#ifdef CONFIG_REGULATOR
216static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
217{
218 struct wm8994_ldo_pdata *ldo_pdata;
219
220 if (!pdata)
221 return 0;
222
223 ldo_pdata = &pdata->ldo[ldo];
224
225 if (!ldo_pdata->init_data)
226 return 0;
227
228 return ldo_pdata->init_data->num_consumer_supplies != 0;
229}
230#else
231static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
232{
233 return 0;
234}
235#endif
236
237static const struct reg_sequence wm8994_revc_patch[] = {
238 { 0x102, 0x3 },
239 { 0x56, 0x3 },
240 { 0x817, 0x0 },
241 { 0x102, 0x0 },
242};
243
244static const struct reg_sequence wm8958_reva_patch[] = {
245 { 0x102, 0x3 },
246 { 0xcb, 0x81 },
247 { 0x817, 0x0 },
248 { 0x102, 0x0 },
249};
250
251static const struct reg_sequence wm1811_reva_patch[] = {
252 { 0x102, 0x3 },
253 { 0x56, 0xc07 },
254 { 0x5d, 0x7e },
255 { 0x5e, 0x0 },
256 { 0x102, 0x0 },
257};
258
259#ifdef CONFIG_OF
260static int wm8994_set_pdata_from_of(struct wm8994 *wm8994)
261{
262 struct device_node *np = wm8994->dev->of_node;
263 struct wm8994_pdata *pdata = &wm8994->pdata;
264 int i;
265
266 if (!np)
267 return 0;
268
269 if (of_property_read_u32_array(np, "wlf,gpio-cfg", pdata->gpio_defaults,
270 ARRAY_SIZE(pdata->gpio_defaults)) >= 0) {
271 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
272 if (wm8994->pdata.gpio_defaults[i] == 0)
273 pdata->gpio_defaults[i]
274 = WM8994_CONFIGURE_GPIO;
275 }
276 }
277
278 of_property_read_u32_array(np, "wlf,micbias-cfg", pdata->micbias,
279 ARRAY_SIZE(pdata->micbias));
280
281 pdata->lineout1_diff = !of_property_read_bool(np, "wlf,lineout1-se");
282 pdata->lineout2_diff = !of_property_read_bool(np, "wlf,lineout2-se");
283 pdata->lineout1fb = of_property_read_bool(np, "wlf,lineout1-feedback");
284 pdata->lineout2fb = of_property_read_bool(np, "wlf,lineout2-feedback") ||
285 of_property_read_bool(np, "wlf,ldoena-always-driven");
286
287 pdata->spkmode_pu = of_property_read_bool(np, "wlf,spkmode-pu");
288
289 pdata->csnaddr_pd = of_property_read_bool(np, "wlf,csnaddr-pd");
290
291 return 0;
292}
293#else
294static int wm8994_set_pdata_from_of(struct wm8994 *wm8994)
295{
296 return 0;
297}
298#endif
299
300/*
301 * Instantiate the generic non-control parts of the device.
302 */
303static int wm8994_device_init(struct wm8994 *wm8994, int irq)
304{
305 struct wm8994_pdata *pdata;
306 struct regmap_config *regmap_config;
307 const struct reg_sequence *regmap_patch = NULL;
308 const char *devname;
309 int ret, i, patch_regs = 0;
310 int pulls = 0;
311
312 if (dev_get_platdata(wm8994->dev)) {
313 pdata = dev_get_platdata(wm8994->dev);
314 wm8994->pdata = *pdata;
315 }
316 pdata = &wm8994->pdata;
317
318 ret = wm8994_set_pdata_from_of(wm8994);
319 if (ret != 0)
320 return ret;
321
322 /* Add the on-chip regulators first for bootstrapping */
323 ret = mfd_add_devices(wm8994->dev, 0,
324 wm8994_regulator_devs,
325 ARRAY_SIZE(wm8994_regulator_devs),
326 NULL, 0, NULL);
327 if (ret != 0) {
328 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
329 goto err;
330 }
331
332 switch (wm8994->type) {
333 case WM1811:
334 wm8994->num_supplies = ARRAY_SIZE(wm1811_main_supplies);
335 break;
336 case WM8994:
337 wm8994->num_supplies = ARRAY_SIZE(wm8994_main_supplies);
338 break;
339 case WM8958:
340 wm8994->num_supplies = ARRAY_SIZE(wm8958_main_supplies);
341 break;
342 default:
343 BUG();
344 goto err;
345 }
346
347 wm8994->supplies = devm_kcalloc(wm8994->dev,
348 wm8994->num_supplies,
349 sizeof(struct regulator_bulk_data),
350 GFP_KERNEL);
351 if (!wm8994->supplies) {
352 ret = -ENOMEM;
353 goto err;
354 }
355
356 switch (wm8994->type) {
357 case WM1811:
358 for (i = 0; i < ARRAY_SIZE(wm1811_main_supplies); i++)
359 wm8994->supplies[i].supply = wm1811_main_supplies[i];
360 break;
361 case WM8994:
362 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
363 wm8994->supplies[i].supply = wm8994_main_supplies[i];
364 break;
365 case WM8958:
366 for (i = 0; i < ARRAY_SIZE(wm8958_main_supplies); i++)
367 wm8994->supplies[i].supply = wm8958_main_supplies[i];
368 break;
369 default:
370 BUG();
371 goto err;
372 }
373
374 /*
375 * Can't use devres helper here as some of the supplies are provided by
376 * wm8994->dev's children (regulators) and those regulators are
377 * unregistered by the devres core before the supplies are freed.
378 */
379 ret = regulator_bulk_get(wm8994->dev, wm8994->num_supplies,
380 wm8994->supplies);
381 if (ret != 0) {
382 if (ret != -EPROBE_DEFER)
383 dev_err(wm8994->dev, "Failed to get supplies: %d\n",
384 ret);
385 goto err;
386 }
387
388 ret = regulator_bulk_enable(wm8994->num_supplies, wm8994->supplies);
389 if (ret != 0) {
390 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
391 goto err_regulator_free;
392 }
393
394 ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
395 if (ret < 0) {
396 dev_err(wm8994->dev, "Failed to read ID register\n");
397 goto err_enable;
398 }
399 switch (ret) {
400 case 0x1811:
401 devname = "WM1811";
402 if (wm8994->type != WM1811)
403 dev_warn(wm8994->dev, "Device registered as type %d\n",
404 wm8994->type);
405 wm8994->type = WM1811;
406 break;
407 case 0x8994:
408 devname = "WM8994";
409 if (wm8994->type != WM8994)
410 dev_warn(wm8994->dev, "Device registered as type %d\n",
411 wm8994->type);
412 wm8994->type = WM8994;
413 break;
414 case 0x8958:
415 devname = "WM8958";
416 if (wm8994->type != WM8958)
417 dev_warn(wm8994->dev, "Device registered as type %d\n",
418 wm8994->type);
419 wm8994->type = WM8958;
420 break;
421 default:
422 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
423 ret);
424 ret = -EINVAL;
425 goto err_enable;
426 }
427
428 ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
429 if (ret < 0) {
430 dev_err(wm8994->dev, "Failed to read revision register: %d\n",
431 ret);
432 goto err_enable;
433 }
434 wm8994->revision = ret & WM8994_CHIP_REV_MASK;
435 wm8994->cust_id = (ret & WM8994_CUST_ID_MASK) >> WM8994_CUST_ID_SHIFT;
436
437 switch (wm8994->type) {
438 case WM8994:
439 switch (wm8994->revision) {
440 case 0:
441 case 1:
442 dev_warn(wm8994->dev,
443 "revision %c not fully supported\n",
444 'A' + wm8994->revision);
445 break;
446 case 2:
447 case 3:
448 default:
449 regmap_patch = wm8994_revc_patch;
450 patch_regs = ARRAY_SIZE(wm8994_revc_patch);
451 break;
452 }
453 break;
454
455 case WM8958:
456 switch (wm8994->revision) {
457 case 0:
458 regmap_patch = wm8958_reva_patch;
459 patch_regs = ARRAY_SIZE(wm8958_reva_patch);
460 break;
461 default:
462 break;
463 }
464 break;
465
466 case WM1811:
467 /* Revision C did not change the relevant layer */
468 if (wm8994->revision > 1)
469 wm8994->revision++;
470
471 regmap_patch = wm1811_reva_patch;
472 patch_regs = ARRAY_SIZE(wm1811_reva_patch);
473 break;
474
475 default:
476 break;
477 }
478
479 dev_info(wm8994->dev, "%s revision %c CUST_ID %02x\n", devname,
480 'A' + wm8994->revision, wm8994->cust_id);
481
482 switch (wm8994->type) {
483 case WM1811:
484 regmap_config = &wm1811_regmap_config;
485 break;
486 case WM8994:
487 regmap_config = &wm8994_regmap_config;
488 break;
489 case WM8958:
490 regmap_config = &wm8958_regmap_config;
491 break;
492 default:
493 dev_err(wm8994->dev, "Unknown device type %d\n", wm8994->type);
494 ret = -EINVAL;
495 goto err_enable;
496 }
497
498 ret = regmap_reinit_cache(wm8994->regmap, regmap_config);
499 if (ret != 0) {
500 dev_err(wm8994->dev, "Failed to reinit register cache: %d\n",
501 ret);
502 goto err_enable;
503 }
504
505 /* Explicitly put the device into reset in case regulators
506 * don't get disabled in order to ensure we know the device
507 * state.
508 */
509 ret = wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET,
510 wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET));
511 if (ret != 0) {
512 dev_err(wm8994->dev, "Failed to reset device: %d\n", ret);
513 goto err_enable;
514 }
515
516 if (regmap_patch) {
517 ret = regmap_register_patch(wm8994->regmap, regmap_patch,
518 patch_regs);
519 if (ret != 0) {
520 dev_err(wm8994->dev, "Failed to register patch: %d\n",
521 ret);
522 goto err_enable;
523 }
524 }
525
526 wm8994->irq_base = pdata->irq_base;
527 wm8994->gpio_base = pdata->gpio_base;
528
529 /* GPIO configuration is only applied if it's non-zero */
530 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
531 if (pdata->gpio_defaults[i]) {
532 wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
533 0xffff, pdata->gpio_defaults[i]);
534 }
535 }
536
537 wm8994->ldo_ena_always_driven = pdata->ldo_ena_always_driven;
538
539 if (pdata->spkmode_pu)
540 pulls |= WM8994_SPKMODE_PU;
541 if (pdata->csnaddr_pd)
542 pulls |= WM8994_CSNADDR_PD;
543
544 /* Disable unneeded pulls */
545 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
546 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD |
547 WM8994_SPKMODE_PU | WM8994_CSNADDR_PD,
548 pulls);
549
550 /* In some system designs where the regulators are not in use,
551 * we can achieve a small reduction in leakage currents by
552 * floating LDO outputs. This bit makes no difference if the
553 * LDOs are enabled, it only affects cases where the LDOs were
554 * in operation and are then disabled.
555 */
556 for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
557 if (wm8994_ldo_in_use(pdata, i))
558 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
559 WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
560 else
561 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
562 WM8994_LDO1_DISCH, 0);
563 }
564
565 wm8994_irq_init(wm8994);
566
567 ret = mfd_add_devices(wm8994->dev, -1,
568 wm8994_devs, ARRAY_SIZE(wm8994_devs),
569 NULL, 0, NULL);
570 if (ret != 0) {
571 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
572 goto err_irq;
573 }
574
575 pm_runtime_set_active(wm8994->dev);
576 pm_runtime_enable(wm8994->dev);
577 pm_runtime_idle(wm8994->dev);
578
579 return 0;
580
581err_irq:
582 wm8994_irq_exit(wm8994);
583err_enable:
584 regulator_bulk_disable(wm8994->num_supplies,
585 wm8994->supplies);
586err_regulator_free:
587 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
588err:
589 mfd_remove_devices(wm8994->dev);
590 return ret;
591}
592
593static void wm8994_device_exit(struct wm8994 *wm8994)
594{
595 pm_runtime_get_sync(wm8994->dev);
596 pm_runtime_disable(wm8994->dev);
597 pm_runtime_put_noidle(wm8994->dev);
598 wm8994_irq_exit(wm8994);
599 regulator_bulk_disable(wm8994->num_supplies, wm8994->supplies);
600 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
601 mfd_remove_devices(wm8994->dev);
602}
603
604static const struct of_device_id wm8994_of_match[] = {
605 { .compatible = "wlf,wm1811", .data = (void *)WM1811 },
606 { .compatible = "wlf,wm8994", .data = (void *)WM8994 },
607 { .compatible = "wlf,wm8958", .data = (void *)WM8958 },
608 { }
609};
610MODULE_DEVICE_TABLE(of, wm8994_of_match);
611
612static int wm8994_i2c_probe(struct i2c_client *i2c)
613{
614 struct wm8994 *wm8994;
615 int ret;
616
617 wm8994 = devm_kzalloc(&i2c->dev, sizeof(struct wm8994), GFP_KERNEL);
618 if (wm8994 == NULL)
619 return -ENOMEM;
620
621 i2c_set_clientdata(i2c, wm8994);
622 wm8994->dev = &i2c->dev;
623 wm8994->irq = i2c->irq;
624
625 wm8994->type = (enum wm8994_type)i2c_get_match_data(i2c);
626
627 wm8994->regmap = devm_regmap_init_i2c(i2c, &wm8994_base_regmap_config);
628 if (IS_ERR(wm8994->regmap)) {
629 ret = PTR_ERR(wm8994->regmap);
630 dev_err(wm8994->dev, "Failed to allocate register map: %d\n",
631 ret);
632 return ret;
633 }
634
635 return wm8994_device_init(wm8994, i2c->irq);
636}
637
638static void wm8994_i2c_remove(struct i2c_client *i2c)
639{
640 struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
641
642 wm8994_device_exit(wm8994);
643}
644
645static const struct i2c_device_id wm8994_i2c_id[] = {
646 { "wm1811", WM1811 },
647 { "wm1811a", WM1811 },
648 { "wm8994", WM8994 },
649 { "wm8958", WM8958 },
650 { }
651};
652MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
653
654static const struct dev_pm_ops wm8994_pm_ops = {
655 RUNTIME_PM_OPS(wm8994_suspend, wm8994_resume, NULL)
656};
657
658static struct i2c_driver wm8994_i2c_driver = {
659 .driver = {
660 .name = "wm8994",
661 .pm = pm_ptr(&wm8994_pm_ops),
662 .of_match_table = wm8994_of_match,
663 },
664 .probe = wm8994_i2c_probe,
665 .remove = wm8994_i2c_remove,
666 .id_table = wm8994_i2c_id,
667};
668
669module_i2c_driver(wm8994_i2c_driver);
670
671MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
672MODULE_LICENSE("GPL");
673MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
674MODULE_SOFTDEP("pre: wm8994_regulator");
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * wm8994-core.c -- Device access for Wolfson WM8994
4 *
5 * Copyright 2009 Wolfson Microelectronics PLC.
6 *
7 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
8 */
9
10#include <linux/kernel.h>
11#include <linux/module.h>
12#include <linux/slab.h>
13#include <linux/i2c.h>
14#include <linux/err.h>
15#include <linux/delay.h>
16#include <linux/mfd/core.h>
17#include <linux/of.h>
18#include <linux/of_device.h>
19#include <linux/pm_runtime.h>
20#include <linux/regmap.h>
21#include <linux/regulator/consumer.h>
22#include <linux/regulator/machine.h>
23
24#include <linux/mfd/wm8994/core.h>
25#include <linux/mfd/wm8994/pdata.h>
26#include <linux/mfd/wm8994/registers.h>
27
28#include "wm8994.h"
29
30static const struct mfd_cell wm8994_regulator_devs[] = {
31 {
32 .name = "wm8994-ldo",
33 .id = 0,
34 .pm_runtime_no_callbacks = true,
35 },
36 {
37 .name = "wm8994-ldo",
38 .id = 1,
39 .pm_runtime_no_callbacks = true,
40 },
41};
42
43static const struct resource wm8994_codec_resources[] = {
44 {
45 .start = WM8994_IRQ_TEMP_SHUT,
46 .end = WM8994_IRQ_TEMP_WARN,
47 .flags = IORESOURCE_IRQ,
48 },
49};
50
51static const struct resource wm8994_gpio_resources[] = {
52 {
53 .start = WM8994_IRQ_GPIO(1),
54 .end = WM8994_IRQ_GPIO(11),
55 .flags = IORESOURCE_IRQ,
56 },
57};
58
59static const struct mfd_cell wm8994_devs[] = {
60 {
61 .name = "wm8994-codec",
62 .num_resources = ARRAY_SIZE(wm8994_codec_resources),
63 .resources = wm8994_codec_resources,
64 },
65
66 {
67 .name = "wm8994-gpio",
68 .num_resources = ARRAY_SIZE(wm8994_gpio_resources),
69 .resources = wm8994_gpio_resources,
70 .pm_runtime_no_callbacks = true,
71 },
72};
73
74/*
75 * Supplies for the main bulk of CODEC; the LDO supplies are ignored
76 * and should be handled via the standard regulator API supply
77 * management.
78 */
79static const char *wm1811_main_supplies[] = {
80 "DBVDD1",
81 "DBVDD2",
82 "DBVDD3",
83 "DCVDD",
84 "AVDD1",
85 "AVDD2",
86 "CPVDD",
87 "SPKVDD1",
88 "SPKVDD2",
89};
90
91static const char *wm8994_main_supplies[] = {
92 "DBVDD",
93 "DCVDD",
94 "AVDD1",
95 "AVDD2",
96 "CPVDD",
97 "SPKVDD1",
98 "SPKVDD2",
99};
100
101static const char *wm8958_main_supplies[] = {
102 "DBVDD1",
103 "DBVDD2",
104 "DBVDD3",
105 "DCVDD",
106 "AVDD1",
107 "AVDD2",
108 "CPVDD",
109 "SPKVDD1",
110 "SPKVDD2",
111};
112
113static int wm8994_suspend(struct device *dev)
114{
115 struct wm8994 *wm8994 = dev_get_drvdata(dev);
116 int ret;
117
118 /* Don't actually go through with the suspend if the CODEC is
119 * still active for accessory detect. */
120 switch (wm8994->type) {
121 case WM8958:
122 case WM1811:
123 ret = wm8994_reg_read(wm8994, WM8958_MIC_DETECT_1);
124 if (ret < 0) {
125 dev_err(dev, "Failed to read power status: %d\n", ret);
126 } else if (ret & WM8958_MICD_ENA) {
127 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
128 return 0;
129 }
130 break;
131 default:
132 break;
133 }
134
135 /* Disable LDO pulldowns while the device is suspended if we
136 * don't know that something will be driving them. */
137 if (!wm8994->ldo_ena_always_driven)
138 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
139 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
140 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD);
141
142 /* Explicitly put the device into reset in case regulators
143 * don't get disabled in order to ensure consistent restart.
144 */
145 wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET,
146 wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET));
147
148 regcache_mark_dirty(wm8994->regmap);
149
150 /* Restore GPIO registers to prevent problems with mismatched
151 * pin configurations.
152 */
153 ret = regcache_sync_region(wm8994->regmap, WM8994_GPIO_1,
154 WM8994_GPIO_11);
155 if (ret != 0)
156 dev_err(dev, "Failed to restore GPIO registers: %d\n", ret);
157
158 /* In case one of the GPIOs is used as a wake input. */
159 ret = regcache_sync_region(wm8994->regmap,
160 WM8994_INTERRUPT_STATUS_1_MASK,
161 WM8994_INTERRUPT_STATUS_1_MASK);
162 if (ret != 0)
163 dev_err(dev, "Failed to restore interrupt mask: %d\n", ret);
164
165 regcache_cache_only(wm8994->regmap, true);
166 wm8994->suspended = true;
167
168 ret = regulator_bulk_disable(wm8994->num_supplies,
169 wm8994->supplies);
170 if (ret != 0) {
171 dev_err(dev, "Failed to disable supplies: %d\n", ret);
172 return ret;
173 }
174
175 return 0;
176}
177
178static int wm8994_resume(struct device *dev)
179{
180 struct wm8994 *wm8994 = dev_get_drvdata(dev);
181 int ret;
182
183 /* We may have lied to the PM core about suspending */
184 if (!wm8994->suspended)
185 return 0;
186
187 ret = regulator_bulk_enable(wm8994->num_supplies,
188 wm8994->supplies);
189 if (ret != 0) {
190 dev_err(dev, "Failed to enable supplies: %d\n", ret);
191 return ret;
192 }
193
194 regcache_cache_only(wm8994->regmap, false);
195 ret = regcache_sync(wm8994->regmap);
196 if (ret != 0) {
197 dev_err(dev, "Failed to restore register map: %d\n", ret);
198 goto err_enable;
199 }
200
201 /* Disable LDO pulldowns while the device is active */
202 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
203 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
204 0);
205
206 wm8994->suspended = false;
207
208 return 0;
209
210err_enable:
211 regulator_bulk_disable(wm8994->num_supplies, wm8994->supplies);
212
213 return ret;
214}
215
216#ifdef CONFIG_REGULATOR
217static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
218{
219 struct wm8994_ldo_pdata *ldo_pdata;
220
221 if (!pdata)
222 return 0;
223
224 ldo_pdata = &pdata->ldo[ldo];
225
226 if (!ldo_pdata->init_data)
227 return 0;
228
229 return ldo_pdata->init_data->num_consumer_supplies != 0;
230}
231#else
232static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
233{
234 return 0;
235}
236#endif
237
238static const struct reg_sequence wm8994_revc_patch[] = {
239 { 0x102, 0x3 },
240 { 0x56, 0x3 },
241 { 0x817, 0x0 },
242 { 0x102, 0x0 },
243};
244
245static const struct reg_sequence wm8958_reva_patch[] = {
246 { 0x102, 0x3 },
247 { 0xcb, 0x81 },
248 { 0x817, 0x0 },
249 { 0x102, 0x0 },
250};
251
252static const struct reg_sequence wm1811_reva_patch[] = {
253 { 0x102, 0x3 },
254 { 0x56, 0xc07 },
255 { 0x5d, 0x7e },
256 { 0x5e, 0x0 },
257 { 0x102, 0x0 },
258};
259
260#ifdef CONFIG_OF
261static int wm8994_set_pdata_from_of(struct wm8994 *wm8994)
262{
263 struct device_node *np = wm8994->dev->of_node;
264 struct wm8994_pdata *pdata = &wm8994->pdata;
265 int i;
266
267 if (!np)
268 return 0;
269
270 if (of_property_read_u32_array(np, "wlf,gpio-cfg", pdata->gpio_defaults,
271 ARRAY_SIZE(pdata->gpio_defaults)) >= 0) {
272 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
273 if (wm8994->pdata.gpio_defaults[i] == 0)
274 pdata->gpio_defaults[i]
275 = WM8994_CONFIGURE_GPIO;
276 }
277 }
278
279 of_property_read_u32_array(np, "wlf,micbias-cfg", pdata->micbias,
280 ARRAY_SIZE(pdata->micbias));
281
282 pdata->lineout1_diff = true;
283 pdata->lineout2_diff = true;
284 if (of_find_property(np, "wlf,lineout1-se", NULL))
285 pdata->lineout1_diff = false;
286 if (of_find_property(np, "wlf,lineout2-se", NULL))
287 pdata->lineout2_diff = false;
288
289 if (of_find_property(np, "wlf,lineout1-feedback", NULL))
290 pdata->lineout1fb = true;
291 if (of_find_property(np, "wlf,lineout2-feedback", NULL))
292 pdata->lineout2fb = true;
293
294 if (of_find_property(np, "wlf,ldoena-always-driven", NULL))
295 pdata->lineout2fb = true;
296
297 pdata->spkmode_pu = of_property_read_bool(np, "wlf,spkmode-pu");
298
299 pdata->csnaddr_pd = of_property_read_bool(np, "wlf,csnaddr-pd");
300
301 return 0;
302}
303#else
304static int wm8994_set_pdata_from_of(struct wm8994 *wm8994)
305{
306 return 0;
307}
308#endif
309
310/*
311 * Instantiate the generic non-control parts of the device.
312 */
313static int wm8994_device_init(struct wm8994 *wm8994, int irq)
314{
315 struct wm8994_pdata *pdata;
316 struct regmap_config *regmap_config;
317 const struct reg_sequence *regmap_patch = NULL;
318 const char *devname;
319 int ret, i, patch_regs = 0;
320 int pulls = 0;
321
322 if (dev_get_platdata(wm8994->dev)) {
323 pdata = dev_get_platdata(wm8994->dev);
324 wm8994->pdata = *pdata;
325 }
326 pdata = &wm8994->pdata;
327
328 ret = wm8994_set_pdata_from_of(wm8994);
329 if (ret != 0)
330 return ret;
331
332 dev_set_drvdata(wm8994->dev, wm8994);
333
334 /* Add the on-chip regulators first for bootstrapping */
335 ret = mfd_add_devices(wm8994->dev, 0,
336 wm8994_regulator_devs,
337 ARRAY_SIZE(wm8994_regulator_devs),
338 NULL, 0, NULL);
339 if (ret != 0) {
340 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
341 goto err;
342 }
343
344 switch (wm8994->type) {
345 case WM1811:
346 wm8994->num_supplies = ARRAY_SIZE(wm1811_main_supplies);
347 break;
348 case WM8994:
349 wm8994->num_supplies = ARRAY_SIZE(wm8994_main_supplies);
350 break;
351 case WM8958:
352 wm8994->num_supplies = ARRAY_SIZE(wm8958_main_supplies);
353 break;
354 default:
355 BUG();
356 goto err;
357 }
358
359 wm8994->supplies = devm_kcalloc(wm8994->dev,
360 wm8994->num_supplies,
361 sizeof(struct regulator_bulk_data),
362 GFP_KERNEL);
363 if (!wm8994->supplies) {
364 ret = -ENOMEM;
365 goto err;
366 }
367
368 switch (wm8994->type) {
369 case WM1811:
370 for (i = 0; i < ARRAY_SIZE(wm1811_main_supplies); i++)
371 wm8994->supplies[i].supply = wm1811_main_supplies[i];
372 break;
373 case WM8994:
374 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
375 wm8994->supplies[i].supply = wm8994_main_supplies[i];
376 break;
377 case WM8958:
378 for (i = 0; i < ARRAY_SIZE(wm8958_main_supplies); i++)
379 wm8994->supplies[i].supply = wm8958_main_supplies[i];
380 break;
381 default:
382 BUG();
383 goto err;
384 }
385
386 /*
387 * Can't use devres helper here as some of the supplies are provided by
388 * wm8994->dev's children (regulators) and those regulators are
389 * unregistered by the devres core before the supplies are freed.
390 */
391 ret = regulator_bulk_get(wm8994->dev, wm8994->num_supplies,
392 wm8994->supplies);
393 if (ret != 0) {
394 if (ret != -EPROBE_DEFER)
395 dev_err(wm8994->dev, "Failed to get supplies: %d\n",
396 ret);
397 goto err;
398 }
399
400 ret = regulator_bulk_enable(wm8994->num_supplies, wm8994->supplies);
401 if (ret != 0) {
402 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
403 goto err_regulator_free;
404 }
405
406 ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
407 if (ret < 0) {
408 dev_err(wm8994->dev, "Failed to read ID register\n");
409 goto err_enable;
410 }
411 switch (ret) {
412 case 0x1811:
413 devname = "WM1811";
414 if (wm8994->type != WM1811)
415 dev_warn(wm8994->dev, "Device registered as type %d\n",
416 wm8994->type);
417 wm8994->type = WM1811;
418 break;
419 case 0x8994:
420 devname = "WM8994";
421 if (wm8994->type != WM8994)
422 dev_warn(wm8994->dev, "Device registered as type %d\n",
423 wm8994->type);
424 wm8994->type = WM8994;
425 break;
426 case 0x8958:
427 devname = "WM8958";
428 if (wm8994->type != WM8958)
429 dev_warn(wm8994->dev, "Device registered as type %d\n",
430 wm8994->type);
431 wm8994->type = WM8958;
432 break;
433 default:
434 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
435 ret);
436 ret = -EINVAL;
437 goto err_enable;
438 }
439
440 ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
441 if (ret < 0) {
442 dev_err(wm8994->dev, "Failed to read revision register: %d\n",
443 ret);
444 goto err_enable;
445 }
446 wm8994->revision = ret & WM8994_CHIP_REV_MASK;
447 wm8994->cust_id = (ret & WM8994_CUST_ID_MASK) >> WM8994_CUST_ID_SHIFT;
448
449 switch (wm8994->type) {
450 case WM8994:
451 switch (wm8994->revision) {
452 case 0:
453 case 1:
454 dev_warn(wm8994->dev,
455 "revision %c not fully supported\n",
456 'A' + wm8994->revision);
457 break;
458 case 2:
459 case 3:
460 default:
461 regmap_patch = wm8994_revc_patch;
462 patch_regs = ARRAY_SIZE(wm8994_revc_patch);
463 break;
464 }
465 break;
466
467 case WM8958:
468 switch (wm8994->revision) {
469 case 0:
470 regmap_patch = wm8958_reva_patch;
471 patch_regs = ARRAY_SIZE(wm8958_reva_patch);
472 break;
473 default:
474 break;
475 }
476 break;
477
478 case WM1811:
479 /* Revision C did not change the relevant layer */
480 if (wm8994->revision > 1)
481 wm8994->revision++;
482
483 regmap_patch = wm1811_reva_patch;
484 patch_regs = ARRAY_SIZE(wm1811_reva_patch);
485 break;
486
487 default:
488 break;
489 }
490
491 dev_info(wm8994->dev, "%s revision %c CUST_ID %02x\n", devname,
492 'A' + wm8994->revision, wm8994->cust_id);
493
494 switch (wm8994->type) {
495 case WM1811:
496 regmap_config = &wm1811_regmap_config;
497 break;
498 case WM8994:
499 regmap_config = &wm8994_regmap_config;
500 break;
501 case WM8958:
502 regmap_config = &wm8958_regmap_config;
503 break;
504 default:
505 dev_err(wm8994->dev, "Unknown device type %d\n", wm8994->type);
506 ret = -EINVAL;
507 goto err_enable;
508 }
509
510 ret = regmap_reinit_cache(wm8994->regmap, regmap_config);
511 if (ret != 0) {
512 dev_err(wm8994->dev, "Failed to reinit register cache: %d\n",
513 ret);
514 goto err_enable;
515 }
516
517 /* Explicitly put the device into reset in case regulators
518 * don't get disabled in order to ensure we know the device
519 * state.
520 */
521 ret = wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET,
522 wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET));
523 if (ret != 0) {
524 dev_err(wm8994->dev, "Failed to reset device: %d\n", ret);
525 goto err_enable;
526 }
527
528 if (regmap_patch) {
529 ret = regmap_register_patch(wm8994->regmap, regmap_patch,
530 patch_regs);
531 if (ret != 0) {
532 dev_err(wm8994->dev, "Failed to register patch: %d\n",
533 ret);
534 goto err_enable;
535 }
536 }
537
538 wm8994->irq_base = pdata->irq_base;
539 wm8994->gpio_base = pdata->gpio_base;
540
541 /* GPIO configuration is only applied if it's non-zero */
542 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
543 if (pdata->gpio_defaults[i]) {
544 wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
545 0xffff, pdata->gpio_defaults[i]);
546 }
547 }
548
549 wm8994->ldo_ena_always_driven = pdata->ldo_ena_always_driven;
550
551 if (pdata->spkmode_pu)
552 pulls |= WM8994_SPKMODE_PU;
553 if (pdata->csnaddr_pd)
554 pulls |= WM8994_CSNADDR_PD;
555
556 /* Disable unneeded pulls */
557 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
558 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD |
559 WM8994_SPKMODE_PU | WM8994_CSNADDR_PD,
560 pulls);
561
562 /* In some system designs where the regulators are not in use,
563 * we can achieve a small reduction in leakage currents by
564 * floating LDO outputs. This bit makes no difference if the
565 * LDOs are enabled, it only affects cases where the LDOs were
566 * in operation and are then disabled.
567 */
568 for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
569 if (wm8994_ldo_in_use(pdata, i))
570 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
571 WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
572 else
573 wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
574 WM8994_LDO1_DISCH, 0);
575 }
576
577 wm8994_irq_init(wm8994);
578
579 ret = mfd_add_devices(wm8994->dev, -1,
580 wm8994_devs, ARRAY_SIZE(wm8994_devs),
581 NULL, 0, NULL);
582 if (ret != 0) {
583 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
584 goto err_irq;
585 }
586
587 pm_runtime_set_active(wm8994->dev);
588 pm_runtime_enable(wm8994->dev);
589 pm_runtime_idle(wm8994->dev);
590
591 return 0;
592
593err_irq:
594 wm8994_irq_exit(wm8994);
595err_enable:
596 regulator_bulk_disable(wm8994->num_supplies,
597 wm8994->supplies);
598err_regulator_free:
599 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
600err:
601 mfd_remove_devices(wm8994->dev);
602 return ret;
603}
604
605static void wm8994_device_exit(struct wm8994 *wm8994)
606{
607 pm_runtime_get_sync(wm8994->dev);
608 pm_runtime_disable(wm8994->dev);
609 pm_runtime_put_noidle(wm8994->dev);
610 wm8994_irq_exit(wm8994);
611 regulator_bulk_disable(wm8994->num_supplies, wm8994->supplies);
612 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
613 mfd_remove_devices(wm8994->dev);
614}
615
616static const struct of_device_id wm8994_of_match[] = {
617 { .compatible = "wlf,wm1811", .data = (void *)WM1811 },
618 { .compatible = "wlf,wm8994", .data = (void *)WM8994 },
619 { .compatible = "wlf,wm8958", .data = (void *)WM8958 },
620 { }
621};
622MODULE_DEVICE_TABLE(of, wm8994_of_match);
623
624static int wm8994_i2c_probe(struct i2c_client *i2c)
625{
626 const struct i2c_device_id *id = i2c_client_get_device_id(i2c);
627 const struct of_device_id *of_id;
628 struct wm8994 *wm8994;
629 int ret;
630
631 wm8994 = devm_kzalloc(&i2c->dev, sizeof(struct wm8994), GFP_KERNEL);
632 if (wm8994 == NULL)
633 return -ENOMEM;
634
635 i2c_set_clientdata(i2c, wm8994);
636 wm8994->dev = &i2c->dev;
637 wm8994->irq = i2c->irq;
638
639 if (i2c->dev.of_node) {
640 of_id = of_match_device(wm8994_of_match, &i2c->dev);
641 if (of_id)
642 wm8994->type = (enum wm8994_type)of_id->data;
643 } else {
644 wm8994->type = id->driver_data;
645 }
646
647 wm8994->regmap = devm_regmap_init_i2c(i2c, &wm8994_base_regmap_config);
648 if (IS_ERR(wm8994->regmap)) {
649 ret = PTR_ERR(wm8994->regmap);
650 dev_err(wm8994->dev, "Failed to allocate register map: %d\n",
651 ret);
652 return ret;
653 }
654
655 return wm8994_device_init(wm8994, i2c->irq);
656}
657
658static void wm8994_i2c_remove(struct i2c_client *i2c)
659{
660 struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
661
662 wm8994_device_exit(wm8994);
663}
664
665static const struct i2c_device_id wm8994_i2c_id[] = {
666 { "wm1811", WM1811 },
667 { "wm1811a", WM1811 },
668 { "wm8994", WM8994 },
669 { "wm8958", WM8958 },
670 { }
671};
672MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
673
674static const struct dev_pm_ops wm8994_pm_ops = {
675 RUNTIME_PM_OPS(wm8994_suspend, wm8994_resume, NULL)
676};
677
678static struct i2c_driver wm8994_i2c_driver = {
679 .driver = {
680 .name = "wm8994",
681 .pm = pm_ptr(&wm8994_pm_ops),
682 .of_match_table = wm8994_of_match,
683 },
684 .probe_new = wm8994_i2c_probe,
685 .remove = wm8994_i2c_remove,
686 .id_table = wm8994_i2c_id,
687};
688
689module_i2c_driver(wm8994_i2c_driver);
690
691MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
692MODULE_LICENSE("GPL");
693MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
694MODULE_SOFTDEP("pre: wm8994_regulator");