ASoC: cs35l32: Improve two size determinations in cs35l32_i2c_probe()
[sfrench/cifs-2.6.git] / sound / soc / codecs / cs35l32.c
1 /*
2  * cs35l32.c -- CS35L32 ALSA SoC audio driver
3  *
4  * Copyright 2014 CirrusLogic, Inc.
5  *
6  * Author: Brian Austin <brian.austin@cirrus.com>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11  *
12  */
13
14 #include <linux/module.h>
15 #include <linux/moduleparam.h>
16 #include <linux/kernel.h>
17 #include <linux/init.h>
18 #include <linux/delay.h>
19 #include <linux/i2c.h>
20 #include <linux/gpio.h>
21 #include <linux/regmap.h>
22 #include <linux/slab.h>
23 #include <linux/platform_device.h>
24 #include <linux/regulator/consumer.h>
25 #include <linux/gpio/consumer.h>
26 #include <linux/of_device.h>
27 #include <sound/core.h>
28 #include <sound/pcm.h>
29 #include <sound/pcm_params.h>
30 #include <sound/soc.h>
31 #include <sound/soc-dapm.h>
32 #include <sound/initval.h>
33 #include <sound/tlv.h>
34 #include <dt-bindings/sound/cs35l32.h>
35
36 #include "cs35l32.h"
37
38 #define CS35L32_NUM_SUPPLIES 2
39 static const char *const cs35l32_supply_names[CS35L32_NUM_SUPPLIES] = {
40         "VA",
41         "VP",
42 };
43
44 struct  cs35l32_private {
45         struct regmap *regmap;
46         struct snd_soc_codec *codec;
47         struct regulator_bulk_data supplies[CS35L32_NUM_SUPPLIES];
48         struct cs35l32_platform_data pdata;
49         struct gpio_desc *reset_gpio;
50 };
51
52 static const struct reg_default cs35l32_reg_defaults[] = {
53
54         { 0x06, 0x04 }, /* Power Ctl 1 */
55         { 0x07, 0xE8 }, /* Power Ctl 2 */
56         { 0x08, 0x40 }, /* Clock Ctl */
57         { 0x09, 0x20 }, /* Low Battery Threshold */
58         { 0x0A, 0x00 }, /* Voltage Monitor [RO] */
59         { 0x0B, 0x40 }, /* Conv Peak Curr Protection CTL */
60         { 0x0C, 0x07 }, /* IMON Scaling */
61         { 0x0D, 0x03 }, /* Audio/LED Pwr Manager */
62         { 0x0F, 0x20 }, /* Serial Port Control */
63         { 0x10, 0x14 }, /* Class D Amp CTL */
64         { 0x11, 0x00 }, /* Protection Release CTL */
65         { 0x12, 0xFF }, /* Interrupt Mask 1 */
66         { 0x13, 0xFF }, /* Interrupt Mask 2 */
67         { 0x14, 0xFF }, /* Interrupt Mask 3 */
68         { 0x19, 0x00 }, /* LED Flash Mode Current */
69         { 0x1A, 0x00 }, /* LED Movie Mode Current */
70         { 0x1B, 0x20 }, /* LED Flash Timer */
71         { 0x1C, 0x00 }, /* LED Flash Inhibit Current */
72 };
73
74 static bool cs35l32_readable_register(struct device *dev, unsigned int reg)
75 {
76         switch (reg) {
77         case CS35L32_DEVID_AB ... CS35L32_AUDIO_LED_MNGR:
78         case CS35L32_ADSP_CTL ... CS35L32_FLASH_INHIBIT:
79                 return true;
80         default:
81                 return false;
82         }
83 }
84
85 static bool cs35l32_volatile_register(struct device *dev, unsigned int reg)
86 {
87         switch (reg) {
88         case CS35L32_DEVID_AB ... CS35L32_REV_ID:
89         case CS35L32_INT_STATUS_1 ... CS35L32_LED_STATUS:
90                 return true;
91         default:
92                 return false;
93         }
94 }
95
96 static bool cs35l32_precious_register(struct device *dev, unsigned int reg)
97 {
98         switch (reg) {
99         case CS35L32_INT_STATUS_1 ... CS35L32_LED_STATUS:
100                 return true;
101         default:
102                 return false;
103         }
104 }
105
106 static DECLARE_TLV_DB_SCALE(classd_ctl_tlv, 900, 300, 0);
107
108 static const struct snd_kcontrol_new imon_ctl =
109         SOC_DAPM_SINGLE("Switch", CS35L32_PWRCTL2, 6, 1, 1);
110
111 static const struct snd_kcontrol_new vmon_ctl =
112         SOC_DAPM_SINGLE("Switch", CS35L32_PWRCTL2, 7, 1, 1);
113
114 static const struct snd_kcontrol_new vpmon_ctl =
115         SOC_DAPM_SINGLE("Switch", CS35L32_PWRCTL2, 5, 1, 1);
116
117 static const struct snd_kcontrol_new cs35l32_snd_controls[] = {
118         SOC_SINGLE_TLV("Speaker Volume", CS35L32_CLASSD_CTL,
119                        3, 0x04, 1, classd_ctl_tlv),
120         SOC_SINGLE("Zero Cross Switch", CS35L32_CLASSD_CTL, 2, 1, 0),
121         SOC_SINGLE("Gain Manager Switch", CS35L32_AUDIO_LED_MNGR, 3, 1, 0),
122 };
123
124 static const struct snd_soc_dapm_widget cs35l32_dapm_widgets[] = {
125
126         SND_SOC_DAPM_SUPPLY("BOOST", CS35L32_PWRCTL1, 2, 1, NULL, 0),
127         SND_SOC_DAPM_OUT_DRV("Speaker", CS35L32_PWRCTL1, 7, 1, NULL, 0),
128
129         SND_SOC_DAPM_AIF_OUT("SDOUT", NULL, 0, CS35L32_PWRCTL2, 3, 1),
130
131         SND_SOC_DAPM_INPUT("VP"),
132         SND_SOC_DAPM_INPUT("ISENSE"),
133         SND_SOC_DAPM_INPUT("VSENSE"),
134
135         SND_SOC_DAPM_SWITCH("VMON ADC", CS35L32_PWRCTL2, 7, 1, &vmon_ctl),
136         SND_SOC_DAPM_SWITCH("IMON ADC", CS35L32_PWRCTL2, 6, 1, &imon_ctl),
137         SND_SOC_DAPM_SWITCH("VPMON ADC", CS35L32_PWRCTL2, 5, 1, &vpmon_ctl),
138 };
139
140 static const struct snd_soc_dapm_route cs35l32_audio_map[] = {
141
142         {"Speaker", NULL, "BOOST"},
143
144         {"VMON ADC", NULL, "VSENSE"},
145         {"IMON ADC", NULL, "ISENSE"},
146         {"VPMON ADC", NULL, "VP"},
147
148         {"SDOUT", "Switch", "VMON ADC"},
149         {"SDOUT",  "Switch", "IMON ADC"},
150         {"SDOUT", "Switch", "VPMON ADC"},
151
152         {"Capture", NULL, "SDOUT"},
153 };
154
155 static int cs35l32_set_dai_fmt(struct snd_soc_dai *codec_dai, unsigned int fmt)
156 {
157         struct snd_soc_codec *codec = codec_dai->codec;
158
159         switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
160         case SND_SOC_DAIFMT_CBM_CFM:
161                 snd_soc_update_bits(codec, CS35L32_ADSP_CTL,
162                                     CS35L32_ADSP_MASTER_MASK,
163                                 CS35L32_ADSP_MASTER_MASK);
164                 break;
165         case SND_SOC_DAIFMT_CBS_CFS:
166                 snd_soc_update_bits(codec, CS35L32_ADSP_CTL,
167                                     CS35L32_ADSP_MASTER_MASK, 0);
168                 break;
169         default:
170                 return -EINVAL;
171         }
172
173         return 0;
174 }
175
176 static int cs35l32_set_tristate(struct snd_soc_dai *dai, int tristate)
177 {
178         struct snd_soc_codec *codec = dai->codec;
179
180         return snd_soc_update_bits(codec, CS35L32_PWRCTL2,
181                                         CS35L32_SDOUT_3ST, tristate << 3);
182 }
183
184 static const struct snd_soc_dai_ops cs35l32_ops = {
185         .set_fmt = cs35l32_set_dai_fmt,
186         .set_tristate = cs35l32_set_tristate,
187 };
188
189 static struct snd_soc_dai_driver cs35l32_dai[] = {
190         {
191                 .name = "cs35l32-monitor",
192                 .id = 0,
193                 .capture = {
194                         .stream_name = "Capture",
195                         .channels_min = 2,
196                         .channels_max = 2,
197                         .rates = CS35L32_RATES,
198                         .formats = CS35L32_FORMATS,
199                 },
200                 .ops = &cs35l32_ops,
201                 .symmetric_rates = 1,
202         }
203 };
204
205 static int cs35l32_codec_set_sysclk(struct snd_soc_codec *codec,
206                               int clk_id, int source, unsigned int freq, int dir)
207 {
208         unsigned int val;
209
210         switch (freq) {
211         case 6000000:
212                 val = CS35L32_MCLK_RATIO;
213                 break;
214         case 12000000:
215                 val = CS35L32_MCLK_DIV2_MASK | CS35L32_MCLK_RATIO;
216                 break;
217         case 6144000:
218                 val = 0;
219                 break;
220         case 12288000:
221                 val = CS35L32_MCLK_DIV2_MASK;
222                 break;
223         default:
224                 return -EINVAL;
225         }
226
227         return snd_soc_update_bits(codec, CS35L32_CLK_CTL,
228                         CS35L32_MCLK_DIV2_MASK | CS35L32_MCLK_RATIO_MASK, val);
229 }
230
231 static const struct snd_soc_codec_driver soc_codec_dev_cs35l32 = {
232         .set_sysclk = cs35l32_codec_set_sysclk,
233
234         .component_driver = {
235                 .controls               = cs35l32_snd_controls,
236                 .num_controls           = ARRAY_SIZE(cs35l32_snd_controls),
237                 .dapm_widgets           = cs35l32_dapm_widgets,
238                 .num_dapm_widgets       = ARRAY_SIZE(cs35l32_dapm_widgets),
239                 .dapm_routes            = cs35l32_audio_map,
240                 .num_dapm_routes        = ARRAY_SIZE(cs35l32_audio_map),
241         },
242 };
243
244 /* Current and threshold powerup sequence Pg37 in datasheet */
245 static const struct reg_sequence cs35l32_monitor_patch[] = {
246
247         { 0x00, 0x99 },
248         { 0x48, 0x17 },
249         { 0x49, 0x56 },
250         { 0x43, 0x01 },
251         { 0x3B, 0x62 },
252         { 0x3C, 0x80 },
253         { 0x00, 0x00 },
254 };
255
256 static const struct regmap_config cs35l32_regmap = {
257         .reg_bits = 8,
258         .val_bits = 8,
259
260         .max_register = CS35L32_MAX_REGISTER,
261         .reg_defaults = cs35l32_reg_defaults,
262         .num_reg_defaults = ARRAY_SIZE(cs35l32_reg_defaults),
263         .volatile_reg = cs35l32_volatile_register,
264         .readable_reg = cs35l32_readable_register,
265         .precious_reg = cs35l32_precious_register,
266         .cache_type = REGCACHE_RBTREE,
267 };
268
269 static int cs35l32_handle_of_data(struct i2c_client *i2c_client,
270                                     struct cs35l32_platform_data *pdata)
271 {
272         struct device_node *np = i2c_client->dev.of_node;
273         unsigned int val;
274
275         if (of_property_read_u32(np, "cirrus,sdout-share", &val) >= 0)
276                 pdata->sdout_share = val;
277
278         if (of_property_read_u32(np, "cirrus,boost-manager", &val))
279                 val = -1u;
280
281         switch (val) {
282         case CS35L32_BOOST_MGR_AUTO:
283         case CS35L32_BOOST_MGR_AUTO_AUDIO:
284         case CS35L32_BOOST_MGR_BYPASS:
285         case CS35L32_BOOST_MGR_FIXED:
286                 pdata->boost_mng = val;
287                 break;
288         case -1u:
289         default:
290                 dev_err(&i2c_client->dev,
291                         "Wrong cirrus,boost-manager DT value %d\n", val);
292                 pdata->boost_mng = CS35L32_BOOST_MGR_BYPASS;
293         }
294
295         if (of_property_read_u32(np, "cirrus,sdout-datacfg", &val))
296                 val = -1u;
297         switch (val) {
298         case CS35L32_DATA_CFG_LR_VP:
299         case CS35L32_DATA_CFG_LR_STAT:
300         case CS35L32_DATA_CFG_LR:
301         case CS35L32_DATA_CFG_LR_VPSTAT:
302                 pdata->sdout_datacfg = val;
303                 break;
304         case -1u:
305         default:
306                 dev_err(&i2c_client->dev,
307                         "Wrong cirrus,sdout-datacfg DT value %d\n", val);
308                 pdata->sdout_datacfg = CS35L32_DATA_CFG_LR;
309         }
310
311         if (of_property_read_u32(np, "cirrus,battery-threshold", &val))
312                 val = -1u;
313         switch (val) {
314         case CS35L32_BATT_THRESH_3_1V:
315         case CS35L32_BATT_THRESH_3_2V:
316         case CS35L32_BATT_THRESH_3_3V:
317         case CS35L32_BATT_THRESH_3_4V:
318                 pdata->batt_thresh = val;
319                 break;
320         case -1u:
321         default:
322                 dev_err(&i2c_client->dev,
323                         "Wrong cirrus,battery-threshold DT value %d\n", val);
324                 pdata->batt_thresh = CS35L32_BATT_THRESH_3_3V;
325         }
326
327         if (of_property_read_u32(np, "cirrus,battery-recovery", &val))
328                 val = -1u;
329         switch (val) {
330         case CS35L32_BATT_RECOV_3_1V:
331         case CS35L32_BATT_RECOV_3_2V:
332         case CS35L32_BATT_RECOV_3_3V:
333         case CS35L32_BATT_RECOV_3_4V:
334         case CS35L32_BATT_RECOV_3_5V:
335         case CS35L32_BATT_RECOV_3_6V:
336                 pdata->batt_recov = val;
337                 break;
338         case -1u:
339         default:
340                 dev_err(&i2c_client->dev,
341                         "Wrong cirrus,battery-recovery DT value %d\n", val);
342                 pdata->batt_recov = CS35L32_BATT_RECOV_3_4V;
343         }
344
345         return 0;
346 }
347
348 static int cs35l32_i2c_probe(struct i2c_client *i2c_client,
349                                        const struct i2c_device_id *id)
350 {
351         struct cs35l32_private *cs35l32;
352         struct cs35l32_platform_data *pdata =
353                 dev_get_platdata(&i2c_client->dev);
354         int ret, i;
355         unsigned int devid = 0;
356         unsigned int reg;
357
358         cs35l32 = devm_kzalloc(&i2c_client->dev, sizeof(*cs35l32), GFP_KERNEL);
359         if (!cs35l32)
360                 return -ENOMEM;
361
362         i2c_set_clientdata(i2c_client, cs35l32);
363
364         cs35l32->regmap = devm_regmap_init_i2c(i2c_client, &cs35l32_regmap);
365         if (IS_ERR(cs35l32->regmap)) {
366                 ret = PTR_ERR(cs35l32->regmap);
367                 dev_err(&i2c_client->dev, "regmap_init() failed: %d\n", ret);
368                 return ret;
369         }
370
371         if (pdata) {
372                 cs35l32->pdata = *pdata;
373         } else {
374                 pdata = devm_kzalloc(&i2c_client->dev, sizeof(*pdata),
375                                      GFP_KERNEL);
376                 if (!pdata)
377                         return -ENOMEM;
378
379                 if (i2c_client->dev.of_node) {
380                         ret = cs35l32_handle_of_data(i2c_client,
381                                                      &cs35l32->pdata);
382                         if (ret != 0)
383                                 return ret;
384                 }
385         }
386
387         for (i = 0; i < ARRAY_SIZE(cs35l32->supplies); i++)
388                 cs35l32->supplies[i].supply = cs35l32_supply_names[i];
389
390         ret = devm_regulator_bulk_get(&i2c_client->dev,
391                                       ARRAY_SIZE(cs35l32->supplies),
392                                       cs35l32->supplies);
393         if (ret != 0) {
394                 dev_err(&i2c_client->dev,
395                         "Failed to request supplies: %d\n", ret);
396                 return ret;
397         }
398
399         ret = regulator_bulk_enable(ARRAY_SIZE(cs35l32->supplies),
400                                     cs35l32->supplies);
401         if (ret != 0) {
402                 dev_err(&i2c_client->dev,
403                         "Failed to enable supplies: %d\n", ret);
404                 return ret;
405         }
406
407         /* Reset the Device */
408         cs35l32->reset_gpio = devm_gpiod_get_optional(&i2c_client->dev,
409                 "reset", GPIOD_OUT_LOW);
410         if (IS_ERR(cs35l32->reset_gpio))
411                 return PTR_ERR(cs35l32->reset_gpio);
412
413         gpiod_set_value_cansleep(cs35l32->reset_gpio, 1);
414
415         /* initialize codec */
416         ret = regmap_read(cs35l32->regmap, CS35L32_DEVID_AB, &reg);
417         devid = (reg & 0xFF) << 12;
418
419         ret = regmap_read(cs35l32->regmap, CS35L32_DEVID_CD, &reg);
420         devid |= (reg & 0xFF) << 4;
421
422         ret = regmap_read(cs35l32->regmap, CS35L32_DEVID_E, &reg);
423         devid |= (reg & 0xF0) >> 4;
424
425         if (devid != CS35L32_CHIP_ID) {
426                 ret = -ENODEV;
427                 dev_err(&i2c_client->dev,
428                         "CS35L32 Device ID (%X). Expected %X\n",
429                         devid, CS35L32_CHIP_ID);
430                 return ret;
431         }
432
433         ret = regmap_read(cs35l32->regmap, CS35L32_REV_ID, &reg);
434         if (ret < 0) {
435                 dev_err(&i2c_client->dev, "Get Revision ID failed\n");
436                 return ret;
437         }
438
439         ret = regmap_register_patch(cs35l32->regmap, cs35l32_monitor_patch,
440                                     ARRAY_SIZE(cs35l32_monitor_patch));
441         if (ret < 0) {
442                 dev_err(&i2c_client->dev, "Failed to apply errata patch\n");
443                 return ret;
444         }
445
446         dev_info(&i2c_client->dev,
447                  "Cirrus Logic CS35L32, Revision: %02X\n", reg & 0xFF);
448
449         /* Setup VBOOST Management */
450         if (cs35l32->pdata.boost_mng)
451                 regmap_update_bits(cs35l32->regmap, CS35L32_AUDIO_LED_MNGR,
452                                    CS35L32_BOOST_MASK,
453                                 cs35l32->pdata.boost_mng);
454
455         /* Setup ADSP Format Config */
456         if (cs35l32->pdata.sdout_share)
457                 regmap_update_bits(cs35l32->regmap, CS35L32_ADSP_CTL,
458                                     CS35L32_ADSP_SHARE_MASK,
459                                 cs35l32->pdata.sdout_share << 3);
460
461         /* Setup ADSP Data Configuration */
462         if (cs35l32->pdata.sdout_datacfg)
463                 regmap_update_bits(cs35l32->regmap, CS35L32_ADSP_CTL,
464                                    CS35L32_ADSP_DATACFG_MASK,
465                                 cs35l32->pdata.sdout_datacfg << 4);
466
467         /* Setup Low Battery Recovery  */
468         if (cs35l32->pdata.batt_recov)
469                 regmap_update_bits(cs35l32->regmap, CS35L32_BATT_THRESHOLD,
470                                    CS35L32_BATT_REC_MASK,
471                                 cs35l32->pdata.batt_recov << 1);
472
473         /* Setup Low Battery Threshold */
474         if (cs35l32->pdata.batt_thresh)
475                 regmap_update_bits(cs35l32->regmap, CS35L32_BATT_THRESHOLD,
476                                    CS35L32_BATT_THRESH_MASK,
477                                 cs35l32->pdata.batt_thresh << 4);
478
479         /* Power down the AMP */
480         regmap_update_bits(cs35l32->regmap, CS35L32_PWRCTL1, CS35L32_PDN_AMP,
481                             CS35L32_PDN_AMP);
482
483         /* Clear MCLK Error Bit since we don't have the clock yet */
484         ret = regmap_read(cs35l32->regmap, CS35L32_INT_STATUS_1, &reg);
485
486         ret =  snd_soc_register_codec(&i2c_client->dev,
487                         &soc_codec_dev_cs35l32, cs35l32_dai,
488                         ARRAY_SIZE(cs35l32_dai));
489         if (ret < 0)
490                 goto err_disable;
491
492         return 0;
493
494 err_disable:
495         regulator_bulk_disable(ARRAY_SIZE(cs35l32->supplies),
496                                cs35l32->supplies);
497         return ret;
498 }
499
500 static int cs35l32_i2c_remove(struct i2c_client *i2c_client)
501 {
502         struct cs35l32_private *cs35l32 = i2c_get_clientdata(i2c_client);
503
504         snd_soc_unregister_codec(&i2c_client->dev);
505
506         /* Hold down reset */
507         gpiod_set_value_cansleep(cs35l32->reset_gpio, 0);
508
509         return 0;
510 }
511
512 #ifdef CONFIG_PM
513 static int cs35l32_runtime_suspend(struct device *dev)
514 {
515         struct cs35l32_private *cs35l32 = dev_get_drvdata(dev);
516
517         regcache_cache_only(cs35l32->regmap, true);
518         regcache_mark_dirty(cs35l32->regmap);
519
520         /* Hold down reset */
521         gpiod_set_value_cansleep(cs35l32->reset_gpio, 0);
522
523         /* remove power */
524         regulator_bulk_disable(ARRAY_SIZE(cs35l32->supplies),
525                                cs35l32->supplies);
526
527         return 0;
528 }
529
530 static int cs35l32_runtime_resume(struct device *dev)
531 {
532         struct cs35l32_private *cs35l32 = dev_get_drvdata(dev);
533         int ret;
534
535         /* Enable power */
536         ret = regulator_bulk_enable(ARRAY_SIZE(cs35l32->supplies),
537                                     cs35l32->supplies);
538         if (ret != 0) {
539                 dev_err(dev, "Failed to enable supplies: %d\n",
540                         ret);
541                 return ret;
542         }
543
544         gpiod_set_value_cansleep(cs35l32->reset_gpio, 1);
545
546         regcache_cache_only(cs35l32->regmap, false);
547         regcache_sync(cs35l32->regmap);
548
549         return 0;
550 }
551 #endif
552
553 static const struct dev_pm_ops cs35l32_runtime_pm = {
554         SET_RUNTIME_PM_OPS(cs35l32_runtime_suspend, cs35l32_runtime_resume,
555                            NULL)
556 };
557
558 static const struct of_device_id cs35l32_of_match[] = {
559         { .compatible = "cirrus,cs35l32", },
560         {},
561 };
562 MODULE_DEVICE_TABLE(of, cs35l32_of_match);
563
564
565 static const struct i2c_device_id cs35l32_id[] = {
566         {"cs35l32", 0},
567         {}
568 };
569
570 MODULE_DEVICE_TABLE(i2c, cs35l32_id);
571
572 static struct i2c_driver cs35l32_i2c_driver = {
573         .driver = {
574                    .name = "cs35l32",
575                    .pm = &cs35l32_runtime_pm,
576                    .of_match_table = cs35l32_of_match,
577                    },
578         .id_table = cs35l32_id,
579         .probe = cs35l32_i2c_probe,
580         .remove = cs35l32_i2c_remove,
581 };
582
583 module_i2c_driver(cs35l32_i2c_driver);
584
585 MODULE_DESCRIPTION("ASoC CS35L32 driver");
586 MODULE_AUTHOR("Brian Austin, Cirrus Logic Inc, <brian.austin@cirrus.com>");
587 MODULE_LICENSE("GPL");