sound/soc/codecs/wm8741.c

   1 /*
   2  * wm8741.c  --  WM8741 ALSA SoC Audio driver
   3  *
   4  * Copyright 2010-1 Wolfson Microelectronics plc
   5  *
   6  * Author: Ian Lartey <ian@opensource.wolfsonmicro.com>
   7  *
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License version 2 as
  11  * published by the Free Software Foundation.
  12  */
  13
  14 #include <linux/module.h>
  15 #include <linux/moduleparam.h>
  16 #include <linux/init.h>
  17 #include <linux/delay.h>
  18 #include <linux/pm.h>
  19 #include <linux/i2c.h>
  20 #include <linux/spi/spi.h>
  21 #include <linux/regulator/consumer.h>
  22 #include <linux/slab.h>
  23 #include <linux/of_device.h>
  24 #include <sound/core.h>
  25 #include <sound/pcm.h>
  26 #include <sound/pcm_params.h>
  27 #include <sound/soc.h>
  28 #include <sound/initval.h>
  29 #include <sound/tlv.h>
  30
  31 #include "wm8741.h"
  32
  33 #define WM8741_NUM_SUPPLIES 2
  34 static const char *wm8741_supply_names[WM8741_NUM_SUPPLIES] = {
  35         "AVDD",
  36         "DVDD",
  37 };
  38
  39 #define WM8741_NUM_RATES 6
  40
  41 /* codec private data */
  42 struct wm8741_priv {
  43         enum snd_soc_control_type control_type;
  44         struct regulator_bulk_data supplies[WM8741_NUM_SUPPLIES];
  45         unsigned int sysclk;
  46         struct snd_pcm_hw_constraint_list *sysclk_constraints;
  47 };
  48
  49 static const u16 wm8741_reg_defaults[WM8741_REGISTER_COUNT] = {
  50         0x0000,     /* R0  - DACLLSB Attenuation */
  51         0x0000,     /* R1  - DACLMSB Attenuation */
  52         0x0000,     /* R2  - DACRLSB Attenuation */
  53         0x0000,     /* R3  - DACRMSB Attenuation */
  54         0x0000,     /* R4  - Volume Control */
  55         0x000A,     /* R5  - Format Control */
  56         0x0000,     /* R6  - Filter Control */
  57         0x0000,     /* R7  - Mode Control 1 */
  58         0x0002,     /* R8  - Mode Control 2 */
  59         0x0000,     /* R9  - Reset */
  60         0x0002,     /* R32 - ADDITONAL_CONTROL_1 */
  61 };
  62
  63
  64 static int wm8741_reset(struct snd_soc_codec *codec)
  65 {
  66         return snd_soc_write(codec, WM8741_RESET, 0);
  67 }
  68
  69 static const DECLARE_TLV_DB_SCALE(dac_tlv_fine, -12700, 13, 0);
  70 static const DECLARE_TLV_DB_SCALE(dac_tlv, -12700, 400, 0);
  71
  72 static const struct snd_kcontrol_new wm8741_snd_controls[] = {
  73 SOC_DOUBLE_R_TLV("Fine Playback Volume", WM8741_DACLLSB_ATTENUATION,
  74                  WM8741_DACRLSB_ATTENUATION, 1, 255, 1, dac_tlv_fine),
  75 SOC_DOUBLE_R_TLV("Playback Volume", WM8741_DACLMSB_ATTENUATION,
  76                  WM8741_DACRMSB_ATTENUATION, 0, 511, 1, dac_tlv),
  77 };
  78
  79 static const struct snd_soc_dapm_widget wm8741_dapm_widgets[] = {
  80 SND_SOC_DAPM_DAC("DACL", "Playback", SND_SOC_NOPM, 0, 0),
  81 SND_SOC_DAPM_DAC("DACR", "Playback", SND_SOC_NOPM, 0, 0),
  82 SND_SOC_DAPM_OUTPUT("VOUTLP"),
  83 SND_SOC_DAPM_OUTPUT("VOUTLN"),
  84 SND_SOC_DAPM_OUTPUT("VOUTRP"),
  85 SND_SOC_DAPM_OUTPUT("VOUTRN"),
  86 };
  87
  88 static const struct snd_soc_dapm_route wm8741_dapm_routes[] = {
  89         { "VOUTLP", NULL, "DACL" },
  90         { "VOUTLN", NULL, "DACL" },
  91         { "VOUTRP", NULL, "DACR" },
  92         { "VOUTRN", NULL, "DACR" },
  93 };
  94
  95 static struct {
  96         int value;
  97         int ratio;
  98 } lrclk_ratios[WM8741_NUM_RATES] = {
  99         { 1, 128 },
 100         { 2, 192 },
 101         { 3, 256 },
 102         { 4, 384 },
 103         { 5, 512 },
 104         { 6, 768 },
 105 };
 106
 107 static unsigned int rates_11289[] = {
 108         44100, 88235,
 109 };
 110
 111 static struct snd_pcm_hw_constraint_list constraints_11289 = {
 112         .count  = ARRAY_SIZE(rates_11289),
 113         .list   = rates_11289,
 114 };
 115
 116 static unsigned int rates_12288[] = {
 117         32000, 48000, 96000,
 118 };
 119
 120 static struct snd_pcm_hw_constraint_list constraints_12288 = {
 121         .count  = ARRAY_SIZE(rates_12288),
 122         .list   = rates_12288,
 123 };
 124
 125 static unsigned int rates_16384[] = {
 126         32000,
 127 };
 128
 129 static struct snd_pcm_hw_constraint_list constraints_16384 = {
 130         .count  = ARRAY_SIZE(rates_16384),
 131         .list   = rates_16384,
 132 };
 133
 134 static unsigned int rates_16934[] = {
 135         44100, 88235,
 136 };
 137
 138 static struct snd_pcm_hw_constraint_list constraints_16934 = {
 139         .count  = ARRAY_SIZE(rates_16934),
 140         .list   = rates_16934,
 141 };
 142
 143 static unsigned int rates_18432[] = {
 144         48000, 96000,
 145 };
 146
 147 static struct snd_pcm_hw_constraint_list constraints_18432 = {
 148         .count  = ARRAY_SIZE(rates_18432),
 149         .list   = rates_18432,
 150 };
 151
 152 static unsigned int rates_22579[] = {
 153         44100, 88235, 1764000
 154 };
 155
 156 static struct snd_pcm_hw_constraint_list constraints_22579 = {
 157         .count  = ARRAY_SIZE(rates_22579),
 158         .list   = rates_22579,
 159 };
 160
 161 static unsigned int rates_24576[] = {
 162         32000, 48000, 96000, 192000
 163 };
 164
 165 static struct snd_pcm_hw_constraint_list constraints_24576 = {
 166         .count  = ARRAY_SIZE(rates_24576),
 167         .list   = rates_24576,
 168 };
 169
 170 static unsigned int rates_36864[] = {
 171         48000, 96000, 19200
 172 };
 173
 174 static struct snd_pcm_hw_constraint_list constraints_36864 = {
 175         .count  = ARRAY_SIZE(rates_36864),
 176         .list   = rates_36864,
 177 };
 178
 179
 180 static int wm8741_startup(struct snd_pcm_substream *substream,
 181                           struct snd_soc_dai *dai)
 182 {
 183         struct snd_soc_codec *codec = dai->codec;
 184         struct wm8741_priv *wm8741 = snd_soc_codec_get_drvdata(codec);
 185
 186         /* The set of sample rates that can be supported depends on the
 187          * MCLK supplied to the CODEC - enforce this.
 188          */
 189         if (!wm8741->sysclk) {
 190                 dev_err(codec->dev,
 191                         "No MCLK configured, call set_sysclk() on init\n");
 192                 return -EINVAL;
 193         }
 194
 195         snd_pcm_hw_constraint_list(substream->runtime, 0,
 196                                    SNDRV_PCM_HW_PARAM_RATE,
 197                                    wm8741->sysclk_constraints);
 198
 199         return 0;
 200 }
 201
 202 static int wm8741_hw_params(struct snd_pcm_substream *substream,
 203                             struct snd_pcm_hw_params *params,
 204                             struct snd_soc_dai *dai)
 205 {
 206         struct snd_soc_codec *codec = dai->codec;
 207         struct wm8741_priv *wm8741 = snd_soc_codec_get_drvdata(codec);
 208         u16 iface = snd_soc_read(codec, WM8741_FORMAT_CONTROL) & 0x1FC;
 209         int i;
 210
 211         /* Find a supported LRCLK ratio */
 212         for (i = 0; i < ARRAY_SIZE(lrclk_ratios); i++) {
 213                 if (wm8741->sysclk / params_rate(params) ==
 214                     lrclk_ratios[i].ratio)
 215                         break;
 216         }
 217
 218         /* Should never happen, should be handled by constraints */
 219         if (i == ARRAY_SIZE(lrclk_ratios)) {
 220                 dev_err(codec->dev, "MCLK/fs ratio %d unsupported\n",
 221                         wm8741->sysclk / params_rate(params));
 222                 return -EINVAL;
 223         }
 224
 225         /* bit size */
 226         switch (params_format(params)) {
 227         case SNDRV_PCM_FORMAT_S16_LE:
 228                 break;
 229         case SNDRV_PCM_FORMAT_S20_3LE:
 230                 iface |= 0x0001;
 231                 break;
 232         case SNDRV_PCM_FORMAT_S24_LE:
 233                 iface |= 0x0002;
 234                 break;
 235         case SNDRV_PCM_FORMAT_S32_LE:
 236                 iface |= 0x0003;
 237                 break;
 238         default:
 239                 dev_dbg(codec->dev, "wm8741_hw_params:    Unsupported bit size param = %d",
 240                         params_format(params));
 241                 return -EINVAL;
 242         }
 243
 244         dev_dbg(codec->dev, "wm8741_hw_params:    bit size param = %d",
 245                 params_format(params));
 246
 247         snd_soc_write(codec, WM8741_FORMAT_CONTROL, iface);
 248         return 0;
 249 }
 250
 251 static int wm8741_set_dai_sysclk(struct snd_soc_dai *codec_dai,
 252                 int clk_id, unsigned int freq, int dir)
 253 {
 254         struct snd_soc_codec *codec = codec_dai->codec;
 255         struct wm8741_priv *wm8741 = snd_soc_codec_get_drvdata(codec);
 256
 257         dev_dbg(codec->dev, "wm8741_set_dai_sysclk info: freq=%dHz\n", freq);
 258
 259         switch (freq) {
 260         case 11289600:
 261                 wm8741->sysclk_constraints = &constraints_11289;
 262                 wm8741->sysclk = freq;
 263                 return 0;
 264
 265         case 12288000:
 266                 wm8741->sysclk_constraints = &constraints_12288;
 267                 wm8741->sysclk = freq;
 268                 return 0;
 269
 270         case 16384000:
 271                 wm8741->sysclk_constraints = &constraints_16384;
 272                 wm8741->sysclk = freq;
 273                 return 0;
 274
 275         case 16934400:
 276                 wm8741->sysclk_constraints = &constraints_16934;
 277                 wm8741->sysclk = freq;
 278                 return 0;
 279
 280         case 18432000:
 281                 wm8741->sysclk_constraints = &constraints_18432;
 282                 wm8741->sysclk = freq;
 283                 return 0;
 284
 285         case 22579200:
 286         case 33868800:
 287                 wm8741->sysclk_constraints = &constraints_22579;
 288                 wm8741->sysclk = freq;
 289                 return 0;
 290
 291         case 24576000:
 292                 wm8741->sysclk_constraints = &constraints_24576;
 293                 wm8741->sysclk = freq;
 294                 return 0;
 295
 296         case 36864000:
 297                 wm8741->sysclk_constraints = &constraints_36864;
 298                 wm8741->sysclk = freq;
 299                 return 0;
 300         }
 301         return -EINVAL;
 302 }
 303
 304 static int wm8741_set_dai_fmt(struct snd_soc_dai *codec_dai,
 305                 unsigned int fmt)
 306 {
 307         struct snd_soc_codec *codec = codec_dai->codec;
 308         u16 iface = snd_soc_read(codec, WM8741_FORMAT_CONTROL) & 0x1C3;
 309
 310         /* check master/slave audio interface */
 311         switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
 312         case SND_SOC_DAIFMT_CBS_CFS:
 313                 break;
 314         default:
 315                 return -EINVAL;
 316         }
 317
 318         /* interface format */
 319         switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
 320         case SND_SOC_DAIFMT_I2S:
 321                 iface |= 0x0008;
 322                 break;
 323         case SND_SOC_DAIFMT_RIGHT_J:
 324                 break;
 325         case SND_SOC_DAIFMT_LEFT_J:
 326                 iface |= 0x0004;
 327                 break;
 328         case SND_SOC_DAIFMT_DSP_A:
 329                 iface |= 0x000C;
 330                 break;
 331         case SND_SOC_DAIFMT_DSP_B:
 332                 iface |= 0x001C;
 333                 break;
 334         default:
 335                 return -EINVAL;
 336         }
 337
 338         /* clock inversion */
 339         switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
 340         case SND_SOC_DAIFMT_NB_NF:
 341                 break;
 342         case SND_SOC_DAIFMT_IB_IF:
 343                 iface |= 0x0010;
 344                 break;
 345         case SND_SOC_DAIFMT_IB_NF:
 346                 iface |= 0x0020;
 347                 break;
 348         case SND_SOC_DAIFMT_NB_IF:
 349                 iface |= 0x0030;
 350                 break;
 351         default:
 352                 return -EINVAL;
 353         }
 354
 355
 356         dev_dbg(codec->dev, "wm8741_set_dai_fmt:    Format=%x, Clock Inv=%x\n",
 357                                 fmt & SND_SOC_DAIFMT_FORMAT_MASK,
 358                                 ((fmt & SND_SOC_DAIFMT_INV_MASK)));
 359
 360         snd_soc_write(codec, WM8741_FORMAT_CONTROL, iface);
 361         return 0;
 362 }
 363
 364 #define WM8741_RATES (SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 | \
 365                         SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 | \
 366                         SNDRV_PCM_RATE_96000 | SNDRV_PCM_RATE_176400 | \
 367                         SNDRV_PCM_RATE_192000)
 368
 369 #define WM8741_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
 370                         SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
 371
 372 static const struct snd_soc_dai_ops wm8741_dai_ops = {
 373         .startup        = wm8741_startup,
 374         .hw_params      = wm8741_hw_params,
 375         .set_sysclk     = wm8741_set_dai_sysclk,
 376         .set_fmt        = wm8741_set_dai_fmt,
 377 };
 378
 379 static struct snd_soc_dai_driver wm8741_dai = {
 380         .name = "wm8741",
 381         .playback = {
 382                 .stream_name = "Playback",
 383                 .channels_min = 2,  /* Mono modes not yet supported */
 384                 .channels_max = 2,
 385                 .rates = WM8741_RATES,
 386                 .formats = WM8741_FORMATS,
 387         },
 388         .ops = &wm8741_dai_ops,
 389 };
 390
 391 #ifdef CONFIG_PM
 392 static int wm8741_resume(struct snd_soc_codec *codec)
 393 {
 394         snd_soc_cache_sync(codec);
 395         return 0;
 396 }
 397 #else
 398 #define wm8741_suspend NULL
 399 #define wm8741_resume NULL
 400 #endif
 401
 402 static int wm8741_probe(struct snd_soc_codec *codec)
 403 {
 404         struct wm8741_priv *wm8741 = snd_soc_codec_get_drvdata(codec);
 405         int ret = 0;
 406
 407         ret = regulator_bulk_enable(ARRAY_SIZE(wm8741->supplies),
 408                                     wm8741->supplies);
 409         if (ret != 0) {
 410                 dev_err(codec->dev, "Failed to enable supplies: %d\n", ret);
 411                 goto err_get;
 412         }
 413
 414         ret = snd_soc_codec_set_cache_io(codec, 7, 9, wm8741->control_type);
 415         if (ret != 0) {
 416                 dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
 417                 goto err_enable;
 418         }
 419
 420         ret = wm8741_reset(codec);
 421         if (ret < 0) {
 422                 dev_err(codec->dev, "Failed to issue reset\n");
 423                 goto err_enable;
 424         }
 425
 426         /* Change some default settings - latch VU */
 427         snd_soc_update_bits(codec, WM8741_DACLLSB_ATTENUATION,
 428                             WM8741_UPDATELL, WM8741_UPDATELL);
 429         snd_soc_update_bits(codec, WM8741_DACLMSB_ATTENUATION,
 430                             WM8741_UPDATELM, WM8741_UPDATELM);
 431         snd_soc_update_bits(codec, WM8741_DACRLSB_ATTENUATION,
 432                             WM8741_UPDATERL, WM8741_UPDATERL);
 433         snd_soc_update_bits(codec, WM8741_DACRMSB_ATTENUATION,
 434                             WM8741_UPDATERM, WM8741_UPDATERM);
 435
 436         dev_dbg(codec->dev, "Successful registration\n");
 437         return ret;
 438
 439 err_enable:
 440         regulator_bulk_disable(ARRAY_SIZE(wm8741->supplies), wm8741->supplies);
 441 err_get:
 442 err:
 443         return ret;
 444 }
 445
 446 static int wm8741_remove(struct snd_soc_codec *codec)
 447 {
 448         struct wm8741_priv *wm8741 = snd_soc_codec_get_drvdata(codec);
 449
 450         regulator_bulk_disable(ARRAY_SIZE(wm8741->supplies), wm8741->supplies);
 451
 452         return 0;
 453 }
 454
 455 static struct snd_soc_codec_driver soc_codec_dev_wm8741 = {
 456         .probe =        wm8741_probe,
 457         .remove =       wm8741_remove,
 458         .resume =       wm8741_resume,
 459         .reg_cache_size = ARRAY_SIZE(wm8741_reg_defaults),
 460         .reg_word_size = sizeof(u16),
 461         .reg_cache_default = wm8741_reg_defaults,
 462
 463         .controls = wm8741_snd_controls,
 464         .num_controls = ARRAY_SIZE(wm8741_snd_controls),
 465         .dapm_widgets = wm8741_dapm_widgets,
 466         .num_dapm_widgets = ARRAY_SIZE(wm8741_dapm_widgets),
 467         .dapm_routes = wm8741_dapm_routes,
 468         .num_dapm_routes = ARRAY_SIZE(wm8741_dapm_routes),
 469 };
 470
 471 static const struct of_device_id wm8741_of_match[] = {
 472         { .compatible = "wlf,wm8741", },
 473         { }
 474 };
 475 MODULE_DEVICE_TABLE(of, wm8741_of_match);
 476
 477 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
 478 static int wm8741_i2c_probe(struct i2c_client *i2c,
 479                             const struct i2c_device_id *id)
 480 {
 481         struct wm8741_priv *wm8741;
 482         int ret, i;
 483
 484         wm8741 = devm_kzalloc(&i2c->dev, sizeof(struct wm8741_priv),
 485                               GFP_KERNEL);
 486         if (wm8741 == NULL)
 487                 return -ENOMEM;
 488
 489         for (i = 0; i < ARRAY_SIZE(wm8741->supplies); i++)
 490                 wm8741->supplies[i].supply = wm8741_supply_names[i];
 491
 492         ret = devm_regulator_bulk_get(&i2c->dev, ARRAY_SIZE(wm8741->supplies),
 493                                       wm8741->supplies);
 494         if (ret != 0) {
 495                 dev_err(codec->dev, "Failed to request supplies: %d\n", ret);
 496                 goto err;
 497         }
 498
 499         i2c_set_clientdata(i2c, wm8741);
 500         wm8741->control_type = SND_SOC_I2C;
 501
 502         ret = snd_soc_register_codec(&i2c->dev,
 503                                      &soc_codec_dev_wm8741, &wm8741_dai, 1);
 504
 505         return ret;
 506 }
 507
 508 static int wm8741_i2c_remove(struct i2c_client *client)
 509 {
 510         snd_soc_unregister_codec(&client->dev);
 511         return 0;
 512 }
 513
 514 static const struct i2c_device_id wm8741_i2c_id[] = {
 515         { "wm8741", 0 },
 516         { }
 517 };
 518 MODULE_DEVICE_TABLE(i2c, wm8741_i2c_id);
 519
 520 static struct i2c_driver wm8741_i2c_driver = {
 521         .driver = {
 522                 .name = "wm8741",
 523                 .owner = THIS_MODULE,
 524                 .of_match_table = wm8741_of_match,
 525         },
 526         .probe =    wm8741_i2c_probe,
 527         .remove =   wm8741_i2c_remove,
 528         .id_table = wm8741_i2c_id,
 529 };
 530 #endif
 531
 532 #if defined(CONFIG_SPI_MASTER)
 533 static int __devinit wm8741_spi_probe(struct spi_device *spi)
 534 {
 535         struct wm8741_priv *wm8741;
 536         int ret, i;
 537
 538         wm8741 = devm_kzalloc(&spi->dev, sizeof(struct wm8741_priv),
 539                              GFP_KERNEL);
 540         if (wm8741 == NULL)
 541                 return -ENOMEM;
 542
 543         for (i = 0; i < ARRAY_SIZE(wm8741->supplies); i++)
 544                 wm8741->supplies[i].supply = wm8741_supply_names[i];
 545
 546         ret = devm_regulator_bulk_get(&i2c->dev, ARRAY_SIZE(wm8741->supplies),
 547                                       wm8741->supplies);
 548         if (ret != 0) {
 549                 dev_err(&spi->dev, "Failed to request supplies: %d\n", ret);
 550                 goto err;
 551         }
 552
 553         wm8741->control_type = SND_SOC_SPI;
 554         spi_set_drvdata(spi, wm8741);
 555
 556         ret = snd_soc_register_codec(&spi->dev,
 557                         &soc_codec_dev_wm8741, &wm8741_dai, 1);
 558         return ret;
 559 }
 560
 561 static int __devexit wm8741_spi_remove(struct spi_device *spi)
 562 {
 563         snd_soc_unregister_codec(&spi->dev);
 564         return 0;
 565 }
 566
 567 static struct spi_driver wm8741_spi_driver = {
 568         .driver = {
 569                 .name   = "wm8741",
 570                 .owner  = THIS_MODULE,
 571                 .of_match_table = wm8741_of_match,
 572         },
 573         .probe          = wm8741_spi_probe,
 574         .remove         = __devexit_p(wm8741_spi_remove),
 575 };
 576 #endif /* CONFIG_SPI_MASTER */
 577
 578 static int __init wm8741_modinit(void)
 579 {
 580         int ret = 0;
 581
 582 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
 583         ret = i2c_add_driver(&wm8741_i2c_driver);
 584         if (ret != 0)
 585                 pr_err("Failed to register WM8741 I2C driver: %d\n", ret);
 586 #endif
 587 #if defined(CONFIG_SPI_MASTER)
 588         ret = spi_register_driver(&wm8741_spi_driver);
 589         if (ret != 0) {
 590                 printk(KERN_ERR "Failed to register wm8741 SPI driver: %d\n",
 591                        ret);
 592         }
 593 #endif
 594
 595         return ret;
 596 }
 597 module_init(wm8741_modinit);
 598
 599 static void __exit wm8741_exit(void)
 600 {
 601 #if defined(CONFIG_SPI_MASTER)
 602         spi_unregister_driver(&wm8741_spi_driver);
 603 #endif
 604 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
 605         i2c_del_driver(&wm8741_i2c_driver);
 606 #endif
 607 }
 608 module_exit(wm8741_exit);
 609
 610 MODULE_DESCRIPTION("ASoC WM8741 driver");
 611 MODULE_AUTHOR("Ian Lartey <ian@opensource.wolfsonmicro.com>");
 612 MODULE_LICENSE("GPL");