kernel/sound/soc/codecs/cs4349.c

   1 /*
   2  * cs4349.c  --  CS4349 ALSA Soc Audio driver
   3  *
   4  * Copyright 2015 Cirrus Logic, Inc.
   5  *
   6  * Authors: Tim Howe <Tim.Howe@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 #include <linux/module.h>
  14 #include <linux/moduleparam.h>
  15 #include <linux/kernel.h>
  16 #include <linux/init.h>
  17 #include <linux/delay.h>
  18 #include <linux/gpio.h>
  19 #include <linux/gpio/consumer.h>
  20 #include <linux/platform_device.h>
  21 #include <linux/pm.h>
  22 #include <linux/i2c.h>
  23 #include <linux/of_device.h>
  24 #include <linux/regmap.h>
  25 #include <linux/slab.h>
  26 #include <sound/core.h>
  27 #include <sound/pcm.h>
  28 #include <sound/pcm_params.h>
  29 #include <sound/soc.h>
  30 #include <sound/soc-dapm.h>
  31 #include <sound/initval.h>
  32 #include <sound/tlv.h>
  33 #include "cs4349.h"
  34
  35
  36 static const struct reg_default cs4349_reg_defaults[] = {
  37         { 2, 0x00 },    /* r02  - Mode Control */
  38         { 3, 0x09 },    /* r03  - Volume, Mixing and Inversion Control */
  39         { 4, 0x81 },    /* r04  - Mute Control */
  40         { 5, 0x00 },    /* r05  - Channel A Volume Control */
  41         { 6, 0x00 },    /* r06  - Channel B Volume Control */
  42         { 7, 0xB1 },    /* r07  - Ramp and Filter Control */
  43         { 8, 0x1C },    /* r08  - Misc. Control */
  44 };
  45
  46 /* Private data for the CS4349 */
  47 struct  cs4349_private {
  48         struct regmap                   *regmap;
  49         struct gpio_desc                *reset_gpio;
  50         unsigned int                    mode;
  51         int                             rate;
  52 };
  53
  54 static bool cs4349_readable_register(struct device *dev, unsigned int reg)
  55 {
  56         switch (reg) {
  57         case CS4349_CHIPID ... CS4349_MISC:
  58                 return true;
  59         default:
  60                 return false;
  61         }
  62 }
  63
  64 static bool cs4349_writeable_register(struct device *dev, unsigned int reg)
  65 {
  66         switch (reg) {
  67         case CS4349_MODE ...  CS4349_MISC:
  68                 return true;
  69         default:
  70                 return false;
  71         }
  72 }
  73
  74 static int cs4349_set_dai_fmt(struct snd_soc_dai *codec_dai,
  75                               unsigned int format)
  76 {
  77         struct snd_soc_codec *codec = codec_dai->codec;
  78         struct cs4349_private *cs4349 = snd_soc_codec_get_drvdata(codec);
  79         unsigned int fmt;
  80
  81         fmt = format & SND_SOC_DAIFMT_FORMAT_MASK;
  82
  83         switch (fmt) {
  84         case SND_SOC_DAIFMT_I2S:
  85         case SND_SOC_DAIFMT_LEFT_J:
  86         case SND_SOC_DAIFMT_RIGHT_J:
  87                 cs4349->mode = format & SND_SOC_DAIFMT_FORMAT_MASK;
  88                 break;
  89         default:
  90                 return -EINVAL;
  91         }
  92
  93         return 0;
  94 }
  95
  96 static int cs4349_pcm_hw_params(struct snd_pcm_substream *substream,
  97                             struct snd_pcm_hw_params *params,
  98                             struct snd_soc_dai *dai)
  99 {
 100         struct snd_soc_codec *codec = dai->codec;
 101         struct cs4349_private *cs4349 = snd_soc_codec_get_drvdata(codec);
 102         int fmt, ret;
 103
 104         cs4349->rate = params_rate(params);
 105
 106         switch (cs4349->mode) {
 107         case SND_SOC_DAIFMT_I2S:
 108                 fmt = DIF_I2S;
 109                 break;
 110         case SND_SOC_DAIFMT_LEFT_J:
 111                 fmt = DIF_LEFT_JST;
 112                 break;
 113         case SND_SOC_DAIFMT_RIGHT_J:
 114                 switch (params_width(params)) {
 115                 case 16:
 116                         fmt = DIF_RGHT_JST16;
 117                         break;
 118                 case 24:
 119                         fmt = DIF_RGHT_JST24;
 120                         break;
 121                 default:
 122                         return -EINVAL;
 123                 }
 124                 break;
 125         default:
 126                 return -EINVAL;
 127         }
 128
 129         ret = snd_soc_update_bits(codec, CS4349_MODE, DIF_MASK,
 130                                   MODE_FORMAT(fmt));
 131         if (ret < 0)
 132                 return ret;
 133
 134         return 0;
 135 }
 136
 137 static int cs4349_digital_mute(struct snd_soc_dai *dai, int mute)
 138 {
 139         struct snd_soc_codec *codec = dai->codec;
 140         int reg;
 141
 142         reg = 0;
 143         if (mute)
 144                 reg = MUTE_AB_MASK;
 145
 146         return snd_soc_update_bits(codec, CS4349_MUTE, MUTE_AB_MASK, reg);
 147 }
 148
 149 static DECLARE_TLV_DB_SCALE(dig_tlv, -12750, 50, 0);
 150
 151 static const char * const chan_mix_texts[] = {
 152         "Mute", "MuteA", "MuteA SwapB", "MuteA MonoB", "SwapA MuteB",
 153         "BothR", "Swap", "SwapA MonoB", "MuteB", "Normal", "BothL",
 154         "MonoB", "MonoA MuteB", "MonoA", "MonoA SwapB", "Mono",
 155         /*Normal == Channel A = Left, Channel B = Right*/
 156 };
 157
 158 static const char * const fm_texts[] = {
 159         "Auto", "Single", "Double", "Quad",
 160 };
 161
 162 static const char * const deemph_texts[] = {
 163         "None", "44.1k", "48k", "32k",
 164 };
 165
 166 static const char * const softr_zeroc_texts[] = {
 167         "Immediate", "Zero Cross", "Soft Ramp", "SR on ZC",
 168 };
 169
 170 static int deemph_values[] = {
 171         0, 4, 8, 12,
 172 };
 173
 174 static int softr_zeroc_values[] = {
 175         0, 64, 128, 192,
 176 };
 177
 178 static const struct soc_enum chan_mix_enum =
 179         SOC_ENUM_SINGLE(CS4349_VMI, 0,
 180                         ARRAY_SIZE(chan_mix_texts),
 181                         chan_mix_texts);
 182
 183 static const struct soc_enum fm_mode_enum =
 184         SOC_ENUM_SINGLE(CS4349_MODE, 0,
 185                         ARRAY_SIZE(fm_texts),
 186                         fm_texts);
 187
 188 static SOC_VALUE_ENUM_SINGLE_DECL(deemph_enum, CS4349_MODE, 0, DEM_MASK,
 189                                 deemph_texts, deemph_values);
 190
 191 static SOC_VALUE_ENUM_SINGLE_DECL(softr_zeroc_enum, CS4349_RMPFLT, 0,
 192                                 SR_ZC_MASK, softr_zeroc_texts,
 193                                 softr_zeroc_values);
 194
 195 static const struct snd_kcontrol_new cs4349_snd_controls[] = {
 196         SOC_DOUBLE_R_TLV("Master Playback Volume",
 197                          CS4349_VOLA, CS4349_VOLB, 0, 0xFF, 1, dig_tlv),
 198         SOC_ENUM("Functional Mode", fm_mode_enum),
 199         SOC_ENUM("De-Emphasis Control", deemph_enum),
 200         SOC_ENUM("Soft Ramp Zero Cross Control", softr_zeroc_enum),
 201         SOC_ENUM("Channel Mixer", chan_mix_enum),
 202         SOC_SINGLE("VolA = VolB Switch", CS4349_VMI, 7, 1, 0),
 203         SOC_SINGLE("InvertA Switch", CS4349_VMI, 6, 1, 0),
 204         SOC_SINGLE("InvertB Switch", CS4349_VMI, 5, 1, 0),
 205         SOC_SINGLE("Auto-Mute Switch", CS4349_MUTE, 7, 1, 0),
 206         SOC_SINGLE("MUTEC A = B Switch", CS4349_MUTE, 5, 1, 0),
 207         SOC_SINGLE("Soft Ramp Up Switch", CS4349_RMPFLT, 5, 1, 0),
 208         SOC_SINGLE("Soft Ramp Down Switch", CS4349_RMPFLT, 4, 1, 0),
 209         SOC_SINGLE("Slow Roll Off Filter Switch", CS4349_RMPFLT, 2, 1, 0),
 210         SOC_SINGLE("Freeze Switch", CS4349_MISC, 5, 1, 0),
 211         SOC_SINGLE("Popguard Switch", CS4349_MISC, 4, 1, 0),
 212 };
 213
 214 static const struct snd_soc_dapm_widget cs4349_dapm_widgets[] = {
 215         SND_SOC_DAPM_DAC("HiFi DAC", NULL, SND_SOC_NOPM, 0, 0),
 216
 217         SND_SOC_DAPM_OUTPUT("OutputA"),
 218         SND_SOC_DAPM_OUTPUT("OutputB"),
 219 };
 220
 221 static const struct snd_soc_dapm_route cs4349_routes[] = {
 222         {"DAC Playback", NULL, "OutputA"},
 223         {"DAC Playback", NULL, "OutputB"},
 224
 225         {"OutputA", NULL, "HiFi DAC"},
 226         {"OutputB", NULL, "HiFi DAC"},
 227 };
 228
 229 #define CS4349_PCM_FORMATS (SNDRV_PCM_FMTBIT_S8  | \
 230                         SNDRV_PCM_FMTBIT_S16_LE  | SNDRV_PCM_FMTBIT_S16_BE  | \
 231                         SNDRV_PCM_FMTBIT_S18_3LE | SNDRV_PCM_FMTBIT_S18_3BE | \
 232                         SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S20_3BE | \
 233                         SNDRV_PCM_FMTBIT_S24_3LE | SNDRV_PCM_FMTBIT_S24_3BE | \
 234                         SNDRV_PCM_FMTBIT_S24_LE  | SNDRV_PCM_FMTBIT_S24_BE  | \
 235                         SNDRV_PCM_FMTBIT_S32_LE)
 236
 237 #define CS4349_PCM_RATES SNDRV_PCM_RATE_8000_192000
 238
 239 static const struct snd_soc_dai_ops cs4349_dai_ops = {
 240         .hw_params      = cs4349_pcm_hw_params,
 241         .set_fmt        = cs4349_set_dai_fmt,
 242         .digital_mute   = cs4349_digital_mute,
 243 };
 244
 245 static struct snd_soc_dai_driver cs4349_dai = {
 246         .name = "cs4349_hifi",
 247         .playback = {
 248                 .stream_name    = "DAC Playback",
 249                 .channels_min   = 1,
 250                 .channels_max   = 2,
 251                 .rates          = CS4349_PCM_RATES,
 252                 .formats        = CS4349_PCM_FORMATS,
 253         },
 254         .ops = &cs4349_dai_ops,
 255         .symmetric_rates = 1,
 256 };
 257
 258 static struct snd_soc_codec_driver soc_codec_dev_cs4349 = {
 259         .controls               = cs4349_snd_controls,
 260         .num_controls           = ARRAY_SIZE(cs4349_snd_controls),
 261
 262         .dapm_widgets           = cs4349_dapm_widgets,
 263         .num_dapm_widgets       = ARRAY_SIZE(cs4349_dapm_widgets),
 264         .dapm_routes            = cs4349_routes,
 265         .num_dapm_routes        = ARRAY_SIZE(cs4349_routes),
 266 };
 267
 268 static const struct regmap_config cs4349_regmap = {
 269         .reg_bits               = 8,
 270         .val_bits               = 8,
 271
 272         .max_register           = CS4349_MISC,
 273         .reg_defaults           = cs4349_reg_defaults,
 274         .num_reg_defaults       = ARRAY_SIZE(cs4349_reg_defaults),
 275         .readable_reg           = cs4349_readable_register,
 276         .writeable_reg          = cs4349_writeable_register,
 277         .cache_type             = REGCACHE_RBTREE,
 278 };
 279
 280 static int cs4349_i2c_probe(struct i2c_client *client,
 281                                       const struct i2c_device_id *id)
 282 {
 283         struct cs4349_private *cs4349;
 284         int ret;
 285
 286         cs4349 = devm_kzalloc(&client->dev, sizeof(*cs4349), GFP_KERNEL);
 287         if (!cs4349)
 288                 return -ENOMEM;
 289
 290         cs4349->regmap = devm_regmap_init_i2c(client, &cs4349_regmap);
 291         if (IS_ERR(cs4349->regmap)) {
 292                 ret = PTR_ERR(cs4349->regmap);
 293                 dev_err(&client->dev, "regmap_init() failed: %d\n", ret);
 294                 return ret;
 295         }
 296
 297         /* Reset the Device */
 298         cs4349->reset_gpio = devm_gpiod_get_optional(&client->dev,
 299                 "reset", GPIOD_OUT_LOW);
 300         if (IS_ERR(cs4349->reset_gpio))
 301                 return PTR_ERR(cs4349->reset_gpio);
 302
 303         gpiod_set_value_cansleep(cs4349->reset_gpio, 1);
 304
 305         i2c_set_clientdata(client, cs4349);
 306
 307         return snd_soc_register_codec(&client->dev, &soc_codec_dev_cs4349,
 308                 &cs4349_dai, 1);
 309 }
 310
 311 static int cs4349_i2c_remove(struct i2c_client *client)
 312 {
 313         struct cs4349_private *cs4349 = i2c_get_clientdata(client);
 314
 315         snd_soc_unregister_codec(&client->dev);
 316
 317         /* Hold down reset */
 318         gpiod_set_value_cansleep(cs4349->reset_gpio, 0);
 319
 320         return 0;
 321 }
 322
 323 #ifdef CONFIG_PM
 324 static int cs4349_runtime_suspend(struct device *dev)
 325 {
 326         struct cs4349_private *cs4349 = dev_get_drvdata(dev);
 327         int ret;
 328
 329         ret = regmap_update_bits(cs4349->regmap, CS4349_MISC, PWR_DWN, PWR_DWN);
 330         if (ret < 0)
 331                 return ret;
 332
 333         regcache_cache_only(cs4349->regmap, true);
 334
 335         /* Hold down reset */
 336         gpiod_set_value_cansleep(cs4349->reset_gpio, 0);
 337
 338         return 0;
 339 }
 340
 341 static int cs4349_runtime_resume(struct device *dev)
 342 {
 343         struct cs4349_private *cs4349 = dev_get_drvdata(dev);
 344         int ret;
 345
 346         ret = regmap_update_bits(cs4349->regmap, CS4349_MISC, PWR_DWN, 0);
 347         if (ret < 0)
 348                 return ret;
 349
 350         gpiod_set_value_cansleep(cs4349->reset_gpio, 1);
 351
 352         regcache_cache_only(cs4349->regmap, false);
 353         regcache_sync(cs4349->regmap);
 354
 355         return 0;
 356 }
 357 #endif
 358
 359 static const struct dev_pm_ops cs4349_runtime_pm = {
 360         SET_RUNTIME_PM_OPS(cs4349_runtime_suspend, cs4349_runtime_resume,
 361                            NULL)
 362 };
 363
 364 static const struct of_device_id cs4349_of_match[] = {
 365         { .compatible = "cirrus,cs4349", },
 366         {},
 367 };
 368
 369 MODULE_DEVICE_TABLE(of, cs4349_of_match);
 370
 371 static const struct i2c_device_id cs4349_i2c_id[] = {
 372         {"cs4349", 0},
 373         {}
 374 };
 375
 376 MODULE_DEVICE_TABLE(i2c, cs4349_i2c_id);
 377
 378 static struct i2c_driver cs4349_i2c_driver = {
 379         .driver = {
 380                 .name           = "cs4349",
 381                 .of_match_table = cs4349_of_match,
 382         },
 383         .id_table       = cs4349_i2c_id,
 384         .probe          = cs4349_i2c_probe,
 385         .remove         = cs4349_i2c_remove,
 386 };
 387
 388 module_i2c_driver(cs4349_i2c_driver);
 389
 390 MODULE_AUTHOR("Tim Howe <tim.howe@cirrus.com>");
 391 MODULE_DESCRIPTION("Cirrus Logic CS4349 ALSA SoC Codec Driver");
 392 MODULE_LICENSE("GPL");