9302d21d764003e725dcde1eda095a0aa92186d1
[pandora-kernel.git] / drivers / mfd / wm8994-core.c
1 /*
2  * wm8994-core.c  --  Device access for Wolfson WM8994
3  *
4  * Copyright 2009 Wolfson Microelectronics PLC.
5  *
6  * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
7  *
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.
12  *
13  */
14
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>
26
27 #include <linux/mfd/wm8994/core.h>
28 #include <linux/mfd/wm8994/pdata.h>
29 #include <linux/mfd/wm8994/registers.h>
30
31 static int wm8994_read(struct wm8994 *wm8994, unsigned short reg,
32                        int bytes, void *dest)
33 {
34         return regmap_raw_read(wm8994->regmap, reg, dest, bytes);
35 }
36
37 /**
38  * wm8994_reg_read: Read a single WM8994 register.
39  *
40  * @wm8994: Device to read from.
41  * @reg: Register to read.
42  */
43 int wm8994_reg_read(struct wm8994 *wm8994, unsigned short reg)
44 {
45         unsigned int val;
46         int ret;
47
48         ret = regmap_read(wm8994->regmap, reg, &val);
49
50         if (ret < 0)
51                 return ret;
52         else
53                 return val;
54 }
55 EXPORT_SYMBOL_GPL(wm8994_reg_read);
56
57 /**
58  * wm8994_bulk_read: Read multiple WM8994 registers
59  *
60  * @wm8994: Device to read from
61  * @reg: First register
62  * @count: Number of registers
63  * @buf: Buffer to fill.  The data will be returned big endian.
64  */
65 int wm8994_bulk_read(struct wm8994 *wm8994, unsigned short reg,
66                      int count, u16 *buf)
67 {
68         return regmap_bulk_read(wm8994->regmap, reg, buf, count);
69 }
70
71 static int wm8994_write(struct wm8994 *wm8994, unsigned short reg,
72                         int bytes, const void *src)
73 {
74         return regmap_raw_write(wm8994->regmap, reg, src, bytes);
75 }
76
77 /**
78  * wm8994_reg_write: Write a single WM8994 register.
79  *
80  * @wm8994: Device to write to.
81  * @reg: Register to write to.
82  * @val: Value to write.
83  */
84 int wm8994_reg_write(struct wm8994 *wm8994, unsigned short reg,
85                      unsigned short val)
86 {
87         return regmap_write(wm8994->regmap, reg, val);
88 }
89 EXPORT_SYMBOL_GPL(wm8994_reg_write);
90
91 /**
92  * wm8994_bulk_write: Write multiple WM8994 registers
93  *
94  * @wm8994: Device to write to
95  * @reg: First register
96  * @count: Number of registers
97  * @buf: Buffer to write from.  Data must be big-endian formatted.
98  */
99 int wm8994_bulk_write(struct wm8994 *wm8994, unsigned short reg,
100                       int count, const u16 *buf)
101 {
102         return regmap_raw_write(wm8994->regmap, reg, buf, count * sizeof(u16));
103 }
104 EXPORT_SYMBOL_GPL(wm8994_bulk_write);
105
106 /**
107  * wm8994_set_bits: Set the value of a bitfield in a WM8994 register
108  *
109  * @wm8994: Device to write to.
110  * @reg: Register to write to.
111  * @mask: Mask of bits to set.
112  * @val: Value to set (unshifted)
113  */
114 int wm8994_set_bits(struct wm8994 *wm8994, unsigned short reg,
115                     unsigned short mask, unsigned short val)
116 {
117         return regmap_update_bits(wm8994->regmap, reg, mask, val);
118 }
119 EXPORT_SYMBOL_GPL(wm8994_set_bits);
120
121 static struct mfd_cell wm8994_regulator_devs[] = {
122         {
123                 .name = "wm8994-ldo",
124                 .id = 1,
125                 .pm_runtime_no_callbacks = true,
126         },
127         {
128                 .name = "wm8994-ldo",
129                 .id = 2,
130                 .pm_runtime_no_callbacks = true,
131         },
132 };
133
134 static struct resource wm8994_codec_resources[] = {
135         {
136                 .start = WM8994_IRQ_TEMP_SHUT,
137                 .end   = WM8994_IRQ_TEMP_WARN,
138                 .flags = IORESOURCE_IRQ,
139         },
140 };
141
142 static struct resource wm8994_gpio_resources[] = {
143         {
144                 .start = WM8994_IRQ_GPIO(1),
145                 .end   = WM8994_IRQ_GPIO(11),
146                 .flags = IORESOURCE_IRQ,
147         },
148 };
149
150 static struct mfd_cell wm8994_devs[] = {
151         {
152                 .name = "wm8994-codec",
153                 .num_resources = ARRAY_SIZE(wm8994_codec_resources),
154                 .resources = wm8994_codec_resources,
155         },
156
157         {
158                 .name = "wm8994-gpio",
159                 .num_resources = ARRAY_SIZE(wm8994_gpio_resources),
160                 .resources = wm8994_gpio_resources,
161                 .pm_runtime_no_callbacks = true,
162         },
163 };
164
165 /*
166  * Supplies for the main bulk of CODEC; the LDO supplies are ignored
167  * and should be handled via the standard regulator API supply
168  * management.
169  */
170 static const char *wm1811_main_supplies[] = {
171         "DBVDD1",
172         "DBVDD2",
173         "DBVDD3",
174         "DCVDD",
175         "AVDD1",
176         "AVDD2",
177         "CPVDD",
178         "SPKVDD1",
179         "SPKVDD2",
180 };
181
182 static const char *wm8994_main_supplies[] = {
183         "DBVDD",
184         "DCVDD",
185         "AVDD1",
186         "AVDD2",
187         "CPVDD",
188         "SPKVDD1",
189         "SPKVDD2",
190 };
191
192 static const char *wm8958_main_supplies[] = {
193         "DBVDD1",
194         "DBVDD2",
195         "DBVDD3",
196         "DCVDD",
197         "AVDD1",
198         "AVDD2",
199         "CPVDD",
200         "SPKVDD1",
201         "SPKVDD2",
202 };
203
204 #ifdef CONFIG_PM
205 static int wm8994_suspend(struct device *dev)
206 {
207         struct wm8994 *wm8994 = dev_get_drvdata(dev);
208         int ret;
209
210         /* Don't actually go through with the suspend if the CODEC is
211          * still active (eg, for audio passthrough from CP. */
212         ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_1);
213         if (ret < 0) {
214                 dev_err(dev, "Failed to read power status: %d\n", ret);
215         } else if (ret & WM8994_VMID_SEL_MASK) {
216                 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
217                 return 0;
218         }
219
220         ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_4);
221         if (ret < 0) {
222                 dev_err(dev, "Failed to read power status: %d\n", ret);
223         } else if (ret & (WM8994_AIF2ADCL_ENA | WM8994_AIF2ADCR_ENA |
224                           WM8994_AIF1ADC2L_ENA | WM8994_AIF1ADC2R_ENA |
225                           WM8994_AIF1ADC1L_ENA | WM8994_AIF1ADC1R_ENA)) {
226                 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
227                 return 0;
228         }
229
230         ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_5);
231         if (ret < 0) {
232                 dev_err(dev, "Failed to read power status: %d\n", ret);
233         } else if (ret & (WM8994_AIF2DACL_ENA | WM8994_AIF2DACR_ENA |
234                           WM8994_AIF1DAC2L_ENA | WM8994_AIF1DAC2R_ENA |
235                           WM8994_AIF1DAC1L_ENA | WM8994_AIF1DAC1R_ENA)) {
236                 dev_dbg(dev, "CODEC still active, ignoring suspend\n");
237                 return 0;
238         }
239
240         switch (wm8994->type) {
241         case WM8958:
242         case WM1811:
243                 ret = wm8994_reg_read(wm8994, WM8958_MIC_DETECT_1);
244                 if (ret < 0) {
245                         dev_err(dev, "Failed to read power status: %d\n", ret);
246                 } else if (ret & WM8958_MICD_ENA) {
247                         dev_dbg(dev, "CODEC still active, ignoring suspend\n");
248                         return 0;
249                 }
250                 break;
251         default:
252                 break;
253         }
254
255         switch (wm8994->type) {
256         case WM1811:
257                 ret = wm8994_reg_read(wm8994, WM8994_ANTIPOP_2);
258                 if (ret < 0) {
259                         dev_err(dev, "Failed to read jackdet: %d\n", ret);
260                 } else if (ret & WM1811_JACKDET_MODE_MASK) {
261                         dev_dbg(dev, "CODEC still active, ignoring suspend\n");
262                         return 0;
263                 }
264                 break;
265         default:
266                 break;
267         }
268
269         /* Disable LDO pulldowns while the device is suspended if we
270          * don't know that something will be driving them. */
271         if (!wm8994->ldo_ena_always_driven)
272                 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
273                                 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
274                                 WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD);
275
276         /* GPIO configuration state is saved here since we may be configuring
277          * the GPIO alternate functions even if we're not using the gpiolib
278          * driver for them.
279          */
280         ret = wm8994_read(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
281                           &wm8994->gpio_regs);
282         if (ret < 0)
283                 dev_err(dev, "Failed to save GPIO registers: %d\n", ret);
284
285         /* For similar reasons we also stash the regulator states */
286         ret = wm8994_read(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
287                           &wm8994->ldo_regs);
288         if (ret < 0)
289                 dev_err(dev, "Failed to save LDO registers: %d\n", ret);
290
291         /* Explicitly put the device into reset in case regulators
292          * don't get disabled in order to ensure consistent restart.
293          */
294         wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET, 0x8994);
295
296         wm8994->suspended = true;
297
298         ret = regulator_bulk_disable(wm8994->num_supplies,
299                                      wm8994->supplies);
300         if (ret != 0) {
301                 dev_err(dev, "Failed to disable supplies: %d\n", ret);
302                 return ret;
303         }
304
305         return 0;
306 }
307
308 static int wm8994_resume(struct device *dev)
309 {
310         struct wm8994 *wm8994 = dev_get_drvdata(dev);
311         int ret, i;
312
313         /* We may have lied to the PM core about suspending */
314         if (!wm8994->suspended)
315                 return 0;
316
317         ret = regulator_bulk_enable(wm8994->num_supplies,
318                                     wm8994->supplies);
319         if (ret != 0) {
320                 dev_err(dev, "Failed to enable supplies: %d\n", ret);
321                 return ret;
322         }
323
324         /* Write register at a time as we use the cache on the CPU so store
325          * it in native endian.
326          */
327         for (i = 0; i < ARRAY_SIZE(wm8994->irq_masks_cur); i++) {
328                 ret = wm8994_reg_write(wm8994, WM8994_INTERRUPT_STATUS_1_MASK
329                                        + i, wm8994->irq_masks_cur[i]);
330                 if (ret < 0)
331                         dev_err(dev, "Failed to restore interrupt masks: %d\n",
332                                 ret);
333         }
334
335         ret = wm8994_write(wm8994, WM8994_LDO_1, WM8994_NUM_LDO_REGS * 2,
336                            &wm8994->ldo_regs);
337         if (ret < 0)
338                 dev_err(dev, "Failed to restore LDO registers: %d\n", ret);
339
340         ret = wm8994_write(wm8994, WM8994_GPIO_1, WM8994_NUM_GPIO_REGS * 2,
341                            &wm8994->gpio_regs);
342         if (ret < 0)
343                 dev_err(dev, "Failed to restore GPIO registers: %d\n", ret);
344
345         /* Disable LDO pulldowns while the device is active */
346         wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
347                         WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
348                         0);
349
350         wm8994->suspended = false;
351
352         return 0;
353 }
354 #endif
355
356 #ifdef CONFIG_REGULATOR
357 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
358 {
359         struct wm8994_ldo_pdata *ldo_pdata;
360
361         if (!pdata)
362                 return 0;
363
364         ldo_pdata = &pdata->ldo[ldo];
365
366         if (!ldo_pdata->init_data)
367                 return 0;
368
369         return ldo_pdata->init_data->num_consumer_supplies != 0;
370 }
371 #else
372 static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
373 {
374         return 0;
375 }
376 #endif
377
378 static struct regmap_config wm8994_regmap_config = {
379         .reg_bits = 16,
380         .val_bits = 16,
381 };
382
383 /*
384  * Instantiate the generic non-control parts of the device.
385  */
386 static int wm8994_device_init(struct wm8994 *wm8994, int irq)
387 {
388         struct wm8994_pdata *pdata = wm8994->dev->platform_data;
389         const char *devname;
390         int ret, i;
391
392         dev_set_drvdata(wm8994->dev, wm8994);
393
394         /* Add the on-chip regulators first for bootstrapping */
395         ret = mfd_add_devices(wm8994->dev, -1,
396                               wm8994_regulator_devs,
397                               ARRAY_SIZE(wm8994_regulator_devs),
398                               NULL, 0);
399         if (ret != 0) {
400                 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
401                 goto err_regmap;
402         }
403
404         switch (wm8994->type) {
405         case WM1811:
406                 wm8994->num_supplies = ARRAY_SIZE(wm1811_main_supplies);
407                 break;
408         case WM8994:
409                 wm8994->num_supplies = ARRAY_SIZE(wm8994_main_supplies);
410                 break;
411         case WM8958:
412                 wm8994->num_supplies = ARRAY_SIZE(wm8958_main_supplies);
413                 break;
414         default:
415                 BUG();
416                 goto err_regmap;
417         }
418
419         wm8994->supplies = kzalloc(sizeof(struct regulator_bulk_data) *
420                                    wm8994->num_supplies,
421                                    GFP_KERNEL);
422         if (!wm8994->supplies) {
423                 ret = -ENOMEM;
424                 goto err_regmap;
425         }
426
427         switch (wm8994->type) {
428         case WM1811:
429                 for (i = 0; i < ARRAY_SIZE(wm1811_main_supplies); i++)
430                         wm8994->supplies[i].supply = wm1811_main_supplies[i];
431                 break;
432         case WM8994:
433                 for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
434                         wm8994->supplies[i].supply = wm8994_main_supplies[i];
435                 break;
436         case WM8958:
437                 for (i = 0; i < ARRAY_SIZE(wm8958_main_supplies); i++)
438                         wm8994->supplies[i].supply = wm8958_main_supplies[i];
439                 break;
440         default:
441                 BUG();
442                 goto err_regmap;
443         }
444                 
445         ret = regulator_bulk_get(wm8994->dev, wm8994->num_supplies,
446                                  wm8994->supplies);
447         if (ret != 0) {
448                 dev_err(wm8994->dev, "Failed to get supplies: %d\n", ret);
449                 goto err_supplies;
450         }
451
452         ret = regulator_bulk_enable(wm8994->num_supplies,
453                                     wm8994->supplies);
454         if (ret != 0) {
455                 dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
456                 goto err_get;
457         }
458
459         ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
460         if (ret < 0) {
461                 dev_err(wm8994->dev, "Failed to read ID register\n");
462                 goto err_enable;
463         }
464         switch (ret) {
465         case 0x1811:
466                 devname = "WM1811";
467                 if (wm8994->type != WM1811)
468                         dev_warn(wm8994->dev, "Device registered as type %d\n",
469                                  wm8994->type);
470                 wm8994->type = WM1811;
471                 break;
472         case 0x8994:
473                 devname = "WM8994";
474                 if (wm8994->type != WM8994)
475                         dev_warn(wm8994->dev, "Device registered as type %d\n",
476                                  wm8994->type);
477                 wm8994->type = WM8994;
478                 break;
479         case 0x8958:
480                 devname = "WM8958";
481                 if (wm8994->type != WM8958)
482                         dev_warn(wm8994->dev, "Device registered as type %d\n",
483                                  wm8994->type);
484                 wm8994->type = WM8958;
485                 break;
486         default:
487                 dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
488                         ret);
489                 ret = -EINVAL;
490                 goto err_enable;
491         }
492
493         ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
494         if (ret < 0) {
495                 dev_err(wm8994->dev, "Failed to read revision register: %d\n",
496                         ret);
497                 goto err_enable;
498         }
499
500         switch (wm8994->type) {
501         case WM8994:
502                 switch (ret) {
503                 case 0:
504                 case 1:
505                         dev_warn(wm8994->dev,
506                                  "revision %c not fully supported\n",
507                                  'A' + ret);
508                         break;
509                 default:
510                         break;
511                 }
512                 break;
513         default:
514                 break;
515         }
516
517         dev_info(wm8994->dev, "%s revision %c\n", devname, 'A' + ret);
518
519         if (pdata) {
520                 wm8994->irq_base = pdata->irq_base;
521                 wm8994->gpio_base = pdata->gpio_base;
522
523                 /* GPIO configuration is only applied if it's non-zero */
524                 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
525                         if (pdata->gpio_defaults[i]) {
526                                 wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
527                                                 0xffff,
528                                                 pdata->gpio_defaults[i]);
529                         }
530                 }
531
532                 wm8994->ldo_ena_always_driven = pdata->ldo_ena_always_driven;
533         }
534
535         /* Disable LDO pulldowns while the device is active */
536         wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
537                         WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
538                         0);
539
540         /* In some system designs where the regulators are not in use,
541          * we can achieve a small reduction in leakage currents by
542          * floating LDO outputs.  This bit makes no difference if the
543          * LDOs are enabled, it only affects cases where the LDOs were
544          * in operation and are then disabled.
545          */
546         for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
547                 if (wm8994_ldo_in_use(pdata, i))
548                         wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
549                                         WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
550                 else
551                         wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
552                                         WM8994_LDO1_DISCH, 0);
553         }
554
555         wm8994_irq_init(wm8994);
556
557         ret = mfd_add_devices(wm8994->dev, -1,
558                               wm8994_devs, ARRAY_SIZE(wm8994_devs),
559                               NULL, 0);
560         if (ret != 0) {
561                 dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
562                 goto err_irq;
563         }
564
565         pm_runtime_enable(wm8994->dev);
566         pm_runtime_resume(wm8994->dev);
567
568         return 0;
569
570 err_irq:
571         wm8994_irq_exit(wm8994);
572 err_enable:
573         regulator_bulk_disable(wm8994->num_supplies,
574                                wm8994->supplies);
575 err_get:
576         regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
577 err_supplies:
578         kfree(wm8994->supplies);
579 err_regmap:
580         regmap_exit(wm8994->regmap);
581         mfd_remove_devices(wm8994->dev);
582         kfree(wm8994);
583         return ret;
584 }
585
586 static void wm8994_device_exit(struct wm8994 *wm8994)
587 {
588         pm_runtime_disable(wm8994->dev);
589         mfd_remove_devices(wm8994->dev);
590         wm8994_irq_exit(wm8994);
591         regulator_bulk_disable(wm8994->num_supplies,
592                                wm8994->supplies);
593         regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
594         kfree(wm8994->supplies);
595         regmap_exit(wm8994->regmap);
596         kfree(wm8994);
597 }
598
599 static int wm8994_i2c_probe(struct i2c_client *i2c,
600                             const struct i2c_device_id *id)
601 {
602         struct wm8994 *wm8994;
603         int ret;
604
605         wm8994 = kzalloc(sizeof(struct wm8994), GFP_KERNEL);
606         if (wm8994 == NULL)
607                 return -ENOMEM;
608
609         i2c_set_clientdata(i2c, wm8994);
610         wm8994->dev = &i2c->dev;
611         wm8994->irq = i2c->irq;
612         wm8994->type = id->driver_data;
613
614         wm8994->regmap = regmap_init_i2c(i2c, &wm8994_regmap_config);
615         if (IS_ERR(wm8994->regmap)) {
616                 ret = PTR_ERR(wm8994->regmap);
617                 dev_err(wm8994->dev, "Failed to allocate register map: %d\n",
618                         ret);
619                 kfree(wm8994);
620                 return ret;
621         }
622
623         return wm8994_device_init(wm8994, i2c->irq);
624 }
625
626 static int wm8994_i2c_remove(struct i2c_client *i2c)
627 {
628         struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
629
630         wm8994_device_exit(wm8994);
631
632         return 0;
633 }
634
635 static const struct i2c_device_id wm8994_i2c_id[] = {
636         { "wm1811", WM1811 },
637         { "wm8994", WM8994 },
638         { "wm8958", WM8958 },
639         { }
640 };
641 MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
642
643 static UNIVERSAL_DEV_PM_OPS(wm8994_pm_ops, wm8994_suspend, wm8994_resume,
644                             NULL);
645
646 static struct i2c_driver wm8994_i2c_driver = {
647         .driver = {
648                 .name = "wm8994",
649                 .owner = THIS_MODULE,
650                 .pm = &wm8994_pm_ops,
651         },
652         .probe = wm8994_i2c_probe,
653         .remove = wm8994_i2c_remove,
654         .id_table = wm8994_i2c_id,
655 };
656
657 static int __init wm8994_i2c_init(void)
658 {
659         int ret;
660
661         ret = i2c_add_driver(&wm8994_i2c_driver);
662         if (ret != 0)
663                 pr_err("Failed to register wm8994 I2C driver: %d\n", ret);
664
665         return ret;
666 }
667 module_init(wm8994_i2c_init);
668
669 static void __exit wm8994_i2c_exit(void)
670 {
671         i2c_del_driver(&wm8994_i2c_driver);
672 }
673 module_exit(wm8994_i2c_exit);
674
675 MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
676 MODULE_LICENSE("GPL");
677 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");