sound/soc/codecs/cs4270.c

   1 /*
   2  * CS4270 ALSA SoC (ASoC) codec driver
   3  *
   4  * Author: Timur Tabi <timur@freescale.com>
   5  *
   6  * Copyright 2007-2009 Freescale Semiconductor, Inc.  This file is licensed
   7  * under the terms of the GNU General Public License version 2.  This
   8  * program is licensed "as is" without any warranty of any kind, whether
   9  * express or implied.
  10  *
  11  * This is an ASoC device driver for the Cirrus Logic CS4270 codec.
  12  *
  13  * Current features/limitations:
  14  *
  15  * - Software mode is supported.  Stand-alone mode is not supported.
  16  * - Only I2C is supported, not SPI
  17  * - Support for master and slave mode
  18  * - The machine driver's 'startup' function must call
  19  *   cs4270_set_dai_sysclk() with the value of MCLK.
  20  * - Only I2S and left-justified modes are supported
  21  * - Power management is supported
  22  */
  23
  24 #include <linux/module.h>
  25 #include <linux/slab.h>
  26 #include <sound/core.h>
  27 #include <sound/soc.h>
  28 #include <sound/initval.h>
  29 #include <linux/i2c.h>
  30 #include <linux/delay.h>
  31 #include <linux/regulator/consumer.h>
  32 #include <linux/of_device.h>
  33 #include <linux/of_gpio.h>
  34
  35 /*
  36  * The codec isn't really big-endian or little-endian, since the I2S
  37  * interface requires data to be sent serially with the MSbit first.
  38  * However, to support BE and LE I2S devices, we specify both here.  That
  39  * way, ALSA will always match the bit patterns.
  40  */
  41 #define CS4270_FORMATS (SNDRV_PCM_FMTBIT_S8      | \
  42                         SNDRV_PCM_FMTBIT_S16_LE  | SNDRV_PCM_FMTBIT_S16_BE  | \
  43                         SNDRV_PCM_FMTBIT_S18_3LE | SNDRV_PCM_FMTBIT_S18_3BE | \
  44                         SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S20_3BE | \
  45                         SNDRV_PCM_FMTBIT_S24_3LE | SNDRV_PCM_FMTBIT_S24_3BE | \
  46                         SNDRV_PCM_FMTBIT_S24_LE  | SNDRV_PCM_FMTBIT_S24_BE)
  47
  48 /* CS4270 registers addresses */
  49 #define CS4270_CHIPID   0x01    /* Chip ID */
  50 #define CS4270_PWRCTL   0x02    /* Power Control */
  51 #define CS4270_MODE     0x03    /* Mode Control */
  52 #define CS4270_FORMAT   0x04    /* Serial Format, ADC/DAC Control */
  53 #define CS4270_TRANS    0x05    /* Transition Control */
  54 #define CS4270_MUTE     0x06    /* Mute Control */
  55 #define CS4270_VOLA     0x07    /* DAC Channel A Volume Control */
  56 #define CS4270_VOLB     0x08    /* DAC Channel B Volume Control */
  57
  58 #define CS4270_FIRSTREG 0x01
  59 #define CS4270_LASTREG  0x08
  60 #define CS4270_NUMREGS  (CS4270_LASTREG - CS4270_FIRSTREG + 1)
  61 #define CS4270_I2C_INCR 0x80
  62
  63 /* Bit masks for the CS4270 registers */
  64 #define CS4270_CHIPID_ID        0xF0
  65 #define CS4270_CHIPID_REV       0x0F
  66 #define CS4270_PWRCTL_FREEZE    0x80
  67 #define CS4270_PWRCTL_PDN_ADC   0x20
  68 #define CS4270_PWRCTL_PDN_DAC   0x02
  69 #define CS4270_PWRCTL_PDN       0x01
  70 #define CS4270_PWRCTL_PDN_ALL   \
  71         (CS4270_PWRCTL_PDN_ADC | CS4270_PWRCTL_PDN_DAC | CS4270_PWRCTL_PDN)
  72 #define CS4270_MODE_SPEED_MASK  0x30
  73 #define CS4270_MODE_1X          0x00
  74 #define CS4270_MODE_2X          0x10
  75 #define CS4270_MODE_4X          0x20
  76 #define CS4270_MODE_SLAVE       0x30
  77 #define CS4270_MODE_DIV_MASK    0x0E
  78 #define CS4270_MODE_DIV1        0x00
  79 #define CS4270_MODE_DIV15       0x02
  80 #define CS4270_MODE_DIV2        0x04
  81 #define CS4270_MODE_DIV3        0x06
  82 #define CS4270_MODE_DIV4        0x08
  83 #define CS4270_MODE_POPGUARD    0x01
  84 #define CS4270_FORMAT_FREEZE_A  0x80
  85 #define CS4270_FORMAT_FREEZE_B  0x40
  86 #define CS4270_FORMAT_LOOPBACK  0x20
  87 #define CS4270_FORMAT_DAC_MASK  0x18
  88 #define CS4270_FORMAT_DAC_LJ    0x00
  89 #define CS4270_FORMAT_DAC_I2S   0x08
  90 #define CS4270_FORMAT_DAC_RJ16  0x18
  91 #define CS4270_FORMAT_DAC_RJ24  0x10
  92 #define CS4270_FORMAT_ADC_MASK  0x01
  93 #define CS4270_FORMAT_ADC_LJ    0x00
  94 #define CS4270_FORMAT_ADC_I2S   0x01
  95 #define CS4270_TRANS_ONE_VOL    0x80
  96 #define CS4270_TRANS_SOFT       0x40
  97 #define CS4270_TRANS_ZERO       0x20
  98 #define CS4270_TRANS_INV_ADC_A  0x08
  99 #define CS4270_TRANS_INV_ADC_B  0x10
 100 #define CS4270_TRANS_INV_DAC_A  0x02
 101 #define CS4270_TRANS_INV_DAC_B  0x04
 102 #define CS4270_TRANS_DEEMPH     0x01
 103 #define CS4270_MUTE_AUTO        0x20
 104 #define CS4270_MUTE_ADC_A       0x08
 105 #define CS4270_MUTE_ADC_B       0x10
 106 #define CS4270_MUTE_POLARITY    0x04
 107 #define CS4270_MUTE_DAC_A       0x01
 108 #define CS4270_MUTE_DAC_B       0x02
 109
 110 /* Power-on default values for the registers
 111  *
 112  * This array contains the power-on default values of the registers, with the
 113  * exception of the "CHIPID" register (01h).  The lower four bits of that
 114  * register contain the hardware revision, so it is treated as volatile.
 115  *
 116  * Also note that on the CS4270, the first readable register is 1, but ASoC
 117  * assumes the first register is 0.  Therfore, the array must have an entry for
 118  * register 0, but we use cs4270_reg_is_readable() to tell ASoC that it can't
 119  * be read.
 120  */
 121 static const u8 cs4270_default_reg_cache[CS4270_LASTREG + 1] = {
 122         0x00, 0x00, 0x00, 0x30, 0x00, 0x60, 0x20, 0x00, 0x00
 123 };
 124
 125 static const char *supply_names[] = {
 126         "va", "vd", "vlc"
 127 };
 128
 129 /* Private data for the CS4270 */
 130 struct cs4270_private {
 131         enum snd_soc_control_type control_type;
 132         unsigned int mclk; /* Input frequency of the MCLK pin */
 133         unsigned int mode; /* The mode (I2S or left-justified) */
 134         unsigned int slave_mode;
 135         unsigned int manual_mute;
 136
 137         /* power domain regulators */
 138         struct regulator_bulk_data supplies[ARRAY_SIZE(supply_names)];
 139 };
 140
 141 /**
 142  * struct cs4270_mode_ratios - clock ratio tables
 143  * @ratio: the ratio of MCLK to the sample rate
 144  * @speed_mode: the Speed Mode bits to set in the Mode Control register for
 145  *              this ratio
 146  * @mclk: the Ratio Select bits to set in the Mode Control register for this
 147  *        ratio
 148  *
 149  * The data for this chart is taken from Table 5 of the CS4270 reference
 150  * manual.
 151  *
 152  * This table is used to determine how to program the Mode Control register.
 153  * It is also used by cs4270_set_dai_sysclk() to tell ALSA which sampling
 154  * rates the CS4270 currently supports.
 155  *
 156  * @speed_mode is the corresponding bit pattern to be written to the
 157  * MODE bits of the Mode Control Register
 158  *
 159  * @mclk is the corresponding bit pattern to be wirten to the MCLK bits of
 160  * the Mode Control Register.
 161  *
 162  * In situations where a single ratio is represented by multiple speed
 163  * modes, we favor the slowest speed.  E.g, for a ratio of 128, we pick
 164  * double-speed instead of quad-speed.  However, the CS4270 errata states
 165  * that divide-By-1.5 can cause failures, so we avoid that mode where
 166  * possible.
 167  *
 168  * Errata: There is an errata for the CS4270 where divide-by-1.5 does not
 169  * work if Vd is 3.3V.  If this effects you, select the
 170  * CONFIG_SND_SOC_CS4270_VD33_ERRATA Kconfig option, and the driver will
 171  * never select any sample rates that require divide-by-1.5.
 172  */
 173 struct cs4270_mode_ratios {
 174         unsigned int ratio;
 175         u8 speed_mode;
 176         u8 mclk;
 177 };
 178
 179 static struct cs4270_mode_ratios cs4270_mode_ratios[] = {
 180         {64, CS4270_MODE_4X, CS4270_MODE_DIV1},
 181 #ifndef CONFIG_SND_SOC_CS4270_VD33_ERRATA
 182         {96, CS4270_MODE_4X, CS4270_MODE_DIV15},
 183 #endif
 184         {128, CS4270_MODE_2X, CS4270_MODE_DIV1},
 185         {192, CS4270_MODE_4X, CS4270_MODE_DIV3},
 186         {256, CS4270_MODE_1X, CS4270_MODE_DIV1},
 187         {384, CS4270_MODE_2X, CS4270_MODE_DIV3},
 188         {512, CS4270_MODE_1X, CS4270_MODE_DIV2},
 189         {768, CS4270_MODE_1X, CS4270_MODE_DIV3},
 190         {1024, CS4270_MODE_1X, CS4270_MODE_DIV4}
 191 };
 192
 193 /* The number of MCLK/LRCK ratios supported by the CS4270 */
 194 #define NUM_MCLK_RATIOS         ARRAY_SIZE(cs4270_mode_ratios)
 195
 196 static int cs4270_reg_is_readable(struct snd_soc_codec *codec, unsigned int reg)
 197 {
 198         return (reg >= CS4270_FIRSTREG) && (reg <= CS4270_LASTREG);
 199 }
 200
 201 static int cs4270_reg_is_volatile(struct snd_soc_codec *codec, unsigned int reg)
 202 {
 203         /* Unreadable registers are considered volatile */
 204         if ((reg < CS4270_FIRSTREG) || (reg > CS4270_LASTREG))
 205                 return 1;
 206
 207         return reg == CS4270_CHIPID;
 208 }
 209
 210 /**
 211  * cs4270_set_dai_sysclk - determine the CS4270 samples rates.
 212  * @codec_dai: the codec DAI
 213  * @clk_id: the clock ID (ignored)
 214  * @freq: the MCLK input frequency
 215  * @dir: the clock direction (ignored)
 216  *
 217  * This function is used to tell the codec driver what the input MCLK
 218  * frequency is.
 219  *
 220  * The value of MCLK is used to determine which sample rates are supported
 221  * by the CS4270.  The ratio of MCLK / Fs must be equal to one of nine
 222  * supported values - 64, 96, 128, 192, 256, 384, 512, 768, and 1024.
 223  *
 224  * This function calculates the nine ratios and determines which ones match
 225  * a standard sample rate.  If there's a match, then it is added to the list
 226  * of supported sample rates.
 227  *
 228  * This function must be called by the machine driver's 'startup' function,
 229  * otherwise the list of supported sample rates will not be available in
 230  * time for ALSA.
 231  *
 232  * For setups with variable MCLKs, pass 0 as 'freq' argument. This will cause
 233  * theoretically possible sample rates to be enabled. Call it again with a
 234  * proper value set one the external clock is set (most probably you would do
 235  * that from a machine's driver 'hw_param' hook.
 236  */
 237 static int cs4270_set_dai_sysclk(struct snd_soc_dai *codec_dai,
 238                                  int clk_id, unsigned int freq, int dir)
 239 {
 240         struct snd_soc_codec *codec = codec_dai->codec;
 241         struct cs4270_private *cs4270 = snd_soc_codec_get_drvdata(codec);
 242
 243         cs4270->mclk = freq;
 244         return 0;
 245 }
 246
 247 /**
 248  * cs4270_set_dai_fmt - configure the codec for the selected audio format
 249  * @codec_dai: the codec DAI
 250  * @format: a SND_SOC_DAIFMT_x value indicating the data format
 251  *
 252  * This function takes a bitmask of SND_SOC_DAIFMT_x bits and programs the
 253  * codec accordingly.
 254  *
 255  * Currently, this function only supports SND_SOC_DAIFMT_I2S and
 256  * SND_SOC_DAIFMT_LEFT_J.  The CS4270 codec also supports right-justified
 257  * data for playback only, but ASoC currently does not support different
 258  * formats for playback vs. record.
 259  */
 260 static int cs4270_set_dai_fmt(struct snd_soc_dai *codec_dai,
 261                               unsigned int format)
 262 {
 263         struct snd_soc_codec *codec = codec_dai->codec;
 264         struct cs4270_private *cs4270 = snd_soc_codec_get_drvdata(codec);
 265
 266         /* set DAI format */
 267         switch (format & SND_SOC_DAIFMT_FORMAT_MASK) {
 268         case SND_SOC_DAIFMT_I2S:
 269         case SND_SOC_DAIFMT_LEFT_J:
 270                 cs4270->mode = format & SND_SOC_DAIFMT_FORMAT_MASK;
 271                 break;
 272         default:
 273                 dev_err(codec->dev, "invalid dai format\n");
 274                 return -EINVAL;
 275         }
 276
 277         /* set master/slave audio interface */
 278         switch (format & SND_SOC_DAIFMT_MASTER_MASK) {
 279         case SND_SOC_DAIFMT_CBS_CFS:
 280                 cs4270->slave_mode = 1;
 281                 break;
 282         case SND_SOC_DAIFMT_CBM_CFM:
 283                 cs4270->slave_mode = 0;
 284                 break;
 285         default:
 286                 /* all other modes are unsupported by the hardware */
 287                 dev_err(codec->dev, "Unknown master/slave configuration\n");
 288                 return -EINVAL;
 289         }
 290
 291         return 0;
 292 }
 293
 294 /**
 295  * cs4270_hw_params - program the CS4270 with the given hardware parameters.
 296  * @substream: the audio stream
 297  * @params: the hardware parameters to set
 298  * @dai: the SOC DAI (ignored)
 299  *
 300  * This function programs the hardware with the values provided.
 301  * Specifically, the sample rate and the data format.
 302  *
 303  * The .ops functions are used to provide board-specific data, like input
 304  * frequencies, to this driver.  This function takes that information,
 305  * combines it with the hardware parameters provided, and programs the
 306  * hardware accordingly.
 307  */
 308 static int cs4270_hw_params(struct snd_pcm_substream *substream,
 309                             struct snd_pcm_hw_params *params,
 310                             struct snd_soc_dai *dai)
 311 {
 312         struct snd_soc_codec *codec = dai->codec;
 313         struct cs4270_private *cs4270 = snd_soc_codec_get_drvdata(codec);
 314         int ret;
 315         unsigned int i;
 316         unsigned int rate;
 317         unsigned int ratio;
 318         int reg;
 319
 320         /* Figure out which MCLK/LRCK ratio to use */
 321
 322         rate = params_rate(params);     /* Sampling rate, in Hz */
 323         ratio = cs4270->mclk / rate;    /* MCLK/LRCK ratio */
 324
 325         for (i = 0; i < NUM_MCLK_RATIOS; i++) {
 326                 if (cs4270_mode_ratios[i].ratio == ratio)
 327                         break;
 328         }
 329
 330         if (i == NUM_MCLK_RATIOS) {
 331                 /* We did not find a matching ratio */
 332                 dev_err(codec->dev, "could not find matching ratio\n");
 333                 return -EINVAL;
 334         }
 335
 336         /* Set the sample rate */
 337
 338         reg = snd_soc_read(codec, CS4270_MODE);
 339         reg &= ~(CS4270_MODE_SPEED_MASK | CS4270_MODE_DIV_MASK);
 340         reg |= cs4270_mode_ratios[i].mclk;
 341
 342         if (cs4270->slave_mode)
 343                 reg |= CS4270_MODE_SLAVE;
 344         else
 345                 reg |= cs4270_mode_ratios[i].speed_mode;
 346
 347         ret = snd_soc_write(codec, CS4270_MODE, reg);
 348         if (ret < 0) {
 349                 dev_err(codec->dev, "i2c write failed\n");
 350                 return ret;
 351         }
 352
 353         /* Set the DAI format */
 354
 355         reg = snd_soc_read(codec, CS4270_FORMAT);
 356         reg &= ~(CS4270_FORMAT_DAC_MASK | CS4270_FORMAT_ADC_MASK);
 357
 358         switch (cs4270->mode) {
 359         case SND_SOC_DAIFMT_I2S:
 360                 reg |= CS4270_FORMAT_DAC_I2S | CS4270_FORMAT_ADC_I2S;
 361                 break;
 362         case SND_SOC_DAIFMT_LEFT_J:
 363                 reg |= CS4270_FORMAT_DAC_LJ | CS4270_FORMAT_ADC_LJ;
 364                 break;
 365         default:
 366                 dev_err(codec->dev, "unknown dai format\n");
 367                 return -EINVAL;
 368         }
 369
 370         ret = snd_soc_write(codec, CS4270_FORMAT, reg);
 371         if (ret < 0) {
 372                 dev_err(codec->dev, "i2c write failed\n");
 373                 return ret;
 374         }
 375
 376         return ret;
 377 }
 378
 379 /**
 380  * cs4270_dai_mute - enable/disable the CS4270 external mute
 381  * @dai: the SOC DAI
 382  * @mute: 0 = disable mute, 1 = enable mute
 383  *
 384  * This function toggles the mute bits in the MUTE register.  The CS4270's
 385  * mute capability is intended for external muting circuitry, so if the
 386  * board does not have the MUTEA or MUTEB pins connected to such circuitry,
 387  * then this function will do nothing.
 388  */
 389 static int cs4270_dai_mute(struct snd_soc_dai *dai, int mute)
 390 {
 391         struct snd_soc_codec *codec = dai->codec;
 392         struct cs4270_private *cs4270 = snd_soc_codec_get_drvdata(codec);
 393         int reg6;
 394
 395         reg6 = snd_soc_read(codec, CS4270_MUTE);
 396
 397         if (mute)
 398                 reg6 |= CS4270_MUTE_DAC_A | CS4270_MUTE_DAC_B;
 399         else {
 400                 reg6 &= ~(CS4270_MUTE_DAC_A | CS4270_MUTE_DAC_B);
 401                 reg6 |= cs4270->manual_mute;
 402         }
 403
 404         return snd_soc_write(codec, CS4270_MUTE, reg6);
 405 }
 406
 407 /**
 408  * cs4270_soc_put_mute - put callback for the 'Master Playback switch'
 409  *                       alsa control.
 410  * @kcontrol: mixer control
 411  * @ucontrol: control element information
 412  *
 413  * This function basically passes the arguments on to the generic
 414  * snd_soc_put_volsw() function and saves the mute information in
 415  * our private data structure. This is because we want to prevent
 416  * cs4270_dai_mute() neglecting the user's decision to manually
 417  * mute the codec's output.
 418  *
 419  * Returns 0 for success.
 420  */
 421 static int cs4270_soc_put_mute(struct snd_kcontrol *kcontrol,
 422                                 struct snd_ctl_elem_value *ucontrol)
 423 {
 424         struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol);
 425         struct cs4270_private *cs4270 = snd_soc_codec_get_drvdata(codec);
 426         int left = !ucontrol->value.integer.value[0];
 427         int right = !ucontrol->value.integer.value[1];
 428
 429         cs4270->manual_mute = (left ? CS4270_MUTE_DAC_A : 0) |
 430                               (right ? CS4270_MUTE_DAC_B : 0);
 431
 432         return snd_soc_put_volsw(kcontrol, ucontrol);
 433 }
 434
 435 /* A list of non-DAPM controls that the CS4270 supports */
 436 static const struct snd_kcontrol_new cs4270_snd_controls[] = {
 437         SOC_DOUBLE_R("Master Playback Volume",
 438                 CS4270_VOLA, CS4270_VOLB, 0, 0xFF, 1),
 439         SOC_SINGLE("Digital Sidetone Switch", CS4270_FORMAT, 5, 1, 0),
 440         SOC_SINGLE("Soft Ramp Switch", CS4270_TRANS, 6, 1, 0),
 441         SOC_SINGLE("Zero Cross Switch", CS4270_TRANS, 5, 1, 0),
 442         SOC_SINGLE("De-emphasis filter", CS4270_TRANS, 0, 1, 0),
 443         SOC_SINGLE("Popguard Switch", CS4270_MODE, 0, 1, 1),
 444         SOC_SINGLE("Auto-Mute Switch", CS4270_MUTE, 5, 1, 0),
 445         SOC_DOUBLE("Master Capture Switch", CS4270_MUTE, 3, 4, 1, 1),
 446         SOC_DOUBLE_EXT("Master Playback Switch", CS4270_MUTE, 0, 1, 1, 1,
 447                 snd_soc_get_volsw, cs4270_soc_put_mute),
 448 };
 449
 450 static const struct snd_soc_dai_ops cs4270_dai_ops = {
 451         .hw_params      = cs4270_hw_params,
 452         .set_sysclk     = cs4270_set_dai_sysclk,
 453         .set_fmt        = cs4270_set_dai_fmt,
 454         .digital_mute   = cs4270_dai_mute,
 455 };
 456
 457 static struct snd_soc_dai_driver cs4270_dai = {
 458         .name = "cs4270-hifi",
 459         .playback = {
 460                 .stream_name = "Playback",
 461                 .channels_min = 1,
 462                 .channels_max = 2,
 463                 .rates = SNDRV_PCM_RATE_CONTINUOUS,
 464                 .rate_min = 4000,
 465                 .rate_max = 216000,
 466                 .formats = CS4270_FORMATS,
 467         },
 468         .capture = {
 469                 .stream_name = "Capture",
 470                 .channels_min = 1,
 471                 .channels_max = 2,
 472                 .rates = SNDRV_PCM_RATE_CONTINUOUS,
 473                 .rate_min = 4000,
 474                 .rate_max = 216000,
 475                 .formats = CS4270_FORMATS,
 476         },
 477         .ops = &cs4270_dai_ops,
 478 };
 479
 480 /**
 481  * cs4270_probe - ASoC probe function
 482  * @pdev: platform device
 483  *
 484  * This function is called when ASoC has all the pieces it needs to
 485  * instantiate a sound driver.
 486  */
 487 static int cs4270_probe(struct snd_soc_codec *codec)
 488 {
 489         struct cs4270_private *cs4270 = snd_soc_codec_get_drvdata(codec);
 490         int i, ret;
 491
 492         /* Tell ASoC what kind of I/O to use to read the registers.  ASoC will
 493          * then do the I2C transactions itself.
 494          */
 495         ret = snd_soc_codec_set_cache_io(codec, 8, 8, cs4270->control_type);
 496         if (ret < 0) {
 497                 dev_err(codec->dev, "failed to set cache I/O (ret=%i)\n", ret);
 498                 return ret;
 499         }
 500
 501         /* Disable auto-mute.  This feature appears to be buggy.  In some
 502          * situations, auto-mute will not deactivate when it should, so we want
 503          * this feature disabled by default.  An application (e.g. alsactl) can
 504          * re-enabled it by using the controls.
 505          */
 506         ret = snd_soc_update_bits(codec, CS4270_MUTE, CS4270_MUTE_AUTO, 0);
 507         if (ret < 0) {
 508                 dev_err(codec->dev, "i2c write failed\n");
 509                 return ret;
 510         }
 511
 512         /* Disable automatic volume control.  The hardware enables, and it
 513          * causes volume change commands to be delayed, sometimes until after
 514          * playback has started.  An application (e.g. alsactl) can
 515          * re-enabled it by using the controls.
 516          */
 517         ret = snd_soc_update_bits(codec, CS4270_TRANS,
 518                 CS4270_TRANS_SOFT | CS4270_TRANS_ZERO, 0);
 519         if (ret < 0) {
 520                 dev_err(codec->dev, "i2c write failed\n");
 521                 return ret;
 522         }
 523
 524         /* Add the non-DAPM controls */
 525         ret = snd_soc_add_codec_controls(codec, cs4270_snd_controls,
 526                                 ARRAY_SIZE(cs4270_snd_controls));
 527         if (ret < 0) {
 528                 dev_err(codec->dev, "failed to add controls\n");
 529                 return ret;
 530         }
 531
 532         /* get the power supply regulators */
 533         for (i = 0; i < ARRAY_SIZE(supply_names); i++)
 534                 cs4270->supplies[i].supply = supply_names[i];
 535
 536         ret = regulator_bulk_get(codec->dev, ARRAY_SIZE(cs4270->supplies),
 537                                  cs4270->supplies);
 538         if (ret < 0)
 539                 return ret;
 540
 541         ret = regulator_bulk_enable(ARRAY_SIZE(cs4270->supplies),
 542                                     cs4270->supplies);
 543         if (ret < 0)
 544                 goto error_free_regulators;
 545
 546         return 0;
 547
 548 error_free_regulators:
 549         regulator_bulk_free(ARRAY_SIZE(cs4270->supplies),
 550                             cs4270->supplies);
 551
 552         return ret;
 553 }
 554
 555 /**
 556  * cs4270_remove - ASoC remove function
 557  * @pdev: platform device
 558  *
 559  * This function is the counterpart to cs4270_probe().
 560  */
 561 static int cs4270_remove(struct snd_soc_codec *codec)
 562 {
 563         struct cs4270_private *cs4270 = snd_soc_codec_get_drvdata(codec);
 564
 565         regulator_bulk_disable(ARRAY_SIZE(cs4270->supplies), cs4270->supplies);
 566         regulator_bulk_free(ARRAY_SIZE(cs4270->supplies), cs4270->supplies);
 567
 568         return 0;
 569 };
 570
 571 #ifdef CONFIG_PM
 572
 573 /* This suspend/resume implementation can handle both - a simple standby
 574  * where the codec remains powered, and a full suspend, where the voltage
 575  * domain the codec is connected to is teared down and/or any other hardware
 576  * reset condition is asserted.
 577  *
 578  * The codec's own power saving features are enabled in the suspend callback,
 579  * and all registers are written back to the hardware when resuming.
 580  */
 581
 582 static int cs4270_soc_suspend(struct snd_soc_codec *codec)
 583 {
 584         struct cs4270_private *cs4270 = snd_soc_codec_get_drvdata(codec);
 585         int reg, ret;
 586
 587         reg = snd_soc_read(codec, CS4270_PWRCTL) | CS4270_PWRCTL_PDN_ALL;
 588         if (reg < 0)
 589                 return reg;
 590
 591         ret = snd_soc_write(codec, CS4270_PWRCTL, reg);
 592         if (ret < 0)
 593                 return ret;
 594
 595         regulator_bulk_disable(ARRAY_SIZE(cs4270->supplies),
 596                                cs4270->supplies);
 597
 598         return 0;
 599 }
 600
 601 static int cs4270_soc_resume(struct snd_soc_codec *codec)
 602 {
 603         struct cs4270_private *cs4270 = snd_soc_codec_get_drvdata(codec);
 604         int reg, ret;
 605
 606         ret = regulator_bulk_enable(ARRAY_SIZE(cs4270->supplies),
 607                                     cs4270->supplies);
 608         if (ret != 0)
 609                 return ret;
 610
 611         /* In case the device was put to hard reset during sleep, we need to
 612          * wait 500ns here before any I2C communication. */
 613         ndelay(500);
 614
 615         /* first restore the entire register cache ... */
 616         snd_soc_cache_sync(codec);
 617
 618         /* ... then disable the power-down bits */
 619         reg = snd_soc_read(codec, CS4270_PWRCTL);
 620         reg &= ~CS4270_PWRCTL_PDN_ALL;
 621
 622         return snd_soc_write(codec, CS4270_PWRCTL, reg);
 623 }
 624 #else
 625 #define cs4270_soc_suspend      NULL
 626 #define cs4270_soc_resume       NULL
 627 #endif /* CONFIG_PM */
 628
 629 /*
 630  * ASoC codec driver structure
 631  */
 632 static const struct snd_soc_codec_driver soc_codec_device_cs4270 = {
 633         .probe =                cs4270_probe,
 634         .remove =               cs4270_remove,
 635         .suspend =              cs4270_soc_suspend,
 636         .resume =               cs4270_soc_resume,
 637         .volatile_register =    cs4270_reg_is_volatile,
 638         .readable_register =    cs4270_reg_is_readable,
 639         .reg_cache_size =       CS4270_LASTREG + 1,
 640         .reg_word_size =        sizeof(u8),
 641         .reg_cache_default =    cs4270_default_reg_cache,
 642 };
 643
 644 /*
 645  * cs4270_of_match - the device tree bindings
 646  */
 647 static const struct of_device_id cs4270_of_match[] = {
 648         { .compatible = "cirrus,cs4270", },
 649         { }
 650 };
 651 MODULE_DEVICE_TABLE(of, cs4270_of_match);
 652
 653 /**
 654  * cs4270_i2c_probe - initialize the I2C interface of the CS4270
 655  * @i2c_client: the I2C client object
 656  * @id: the I2C device ID (ignored)
 657  *
 658  * This function is called whenever the I2C subsystem finds a device that
 659  * matches the device ID given via a prior call to i2c_add_driver().
 660  */
 661 static int cs4270_i2c_probe(struct i2c_client *i2c_client,
 662         const struct i2c_device_id *id)
 663 {
 664         struct device_node *np = i2c_client->dev.of_node;
 665         struct cs4270_private *cs4270;
 666         int ret;
 667
 668         /* See if we have a way to bring the codec out of reset */
 669         if (np) {
 670                 enum of_gpio_flags flags;
 671                 int gpio = of_get_named_gpio_flags(np, "reset-gpio", 0, &flags);
 672
 673                 if (gpio_is_valid(gpio)) {
 674                         ret = devm_gpio_request_one(&i2c_client->dev, gpio,
 675                                      flags & OF_GPIO_ACTIVE_LOW ?
 676                                         GPIOF_OUT_INIT_LOW : GPIOF_OUT_INIT_HIGH,
 677                                      "cs4270 reset");
 678                         if (ret < 0)
 679                                 return ret;
 680                 }
 681         }
 682
 683         /* Verify that we have a CS4270 */
 684
 685         ret = i2c_smbus_read_byte_data(i2c_client, CS4270_CHIPID);
 686         if (ret < 0) {
 687                 dev_err(&i2c_client->dev, "failed to read i2c at addr %X\n",
 688                        i2c_client->addr);
 689                 return ret;
 690         }
 691         /* The top four bits of the chip ID should be 1100. */
 692         if ((ret & 0xF0) != 0xC0) {
 693                 dev_err(&i2c_client->dev, "device at addr %X is not a CS4270\n",
 694                        i2c_client->addr);
 695                 return -ENODEV;
 696         }
 697
 698         dev_info(&i2c_client->dev, "found device at i2c address %X\n",
 699                 i2c_client->addr);
 700         dev_info(&i2c_client->dev, "hardware revision %X\n", ret & 0xF);
 701
 702         cs4270 = devm_kzalloc(&i2c_client->dev, sizeof(struct cs4270_private),
 703                               GFP_KERNEL);
 704         if (!cs4270) {
 705                 dev_err(&i2c_client->dev, "could not allocate codec\n");
 706                 return -ENOMEM;
 707         }
 708
 709         i2c_set_clientdata(i2c_client, cs4270);
 710         cs4270->control_type = SND_SOC_I2C;
 711
 712         ret = snd_soc_register_codec(&i2c_client->dev,
 713                         &soc_codec_device_cs4270, &cs4270_dai, 1);
 714         return ret;
 715 }
 716
 717 /**
 718  * cs4270_i2c_remove - remove an I2C device
 719  * @i2c_client: the I2C client object
 720  *
 721  * This function is the counterpart to cs4270_i2c_probe().
 722  */
 723 static int cs4270_i2c_remove(struct i2c_client *i2c_client)
 724 {
 725         snd_soc_unregister_codec(&i2c_client->dev);
 726         return 0;
 727 }
 728
 729 /*
 730  * cs4270_id - I2C device IDs supported by this driver
 731  */
 732 static const struct i2c_device_id cs4270_id[] = {
 733         {"cs4270", 0},
 734         {}
 735 };
 736 MODULE_DEVICE_TABLE(i2c, cs4270_id);
 737
 738 /*
 739  * cs4270_i2c_driver - I2C device identification
 740  *
 741  * This structure tells the I2C subsystem how to identify and support a
 742  * given I2C device type.
 743  */
 744 static struct i2c_driver cs4270_i2c_driver = {
 745         .driver = {
 746                 .name = "cs4270",
 747                 .owner = THIS_MODULE,
 748                 .of_match_table = cs4270_of_match,
 749         },
 750         .id_table = cs4270_id,
 751         .probe = cs4270_i2c_probe,
 752         .remove = cs4270_i2c_remove,
 753 };
 754
 755 static int __init cs4270_init(void)
 756 {
 757         return i2c_add_driver(&cs4270_i2c_driver);
 758 }
 759 module_init(cs4270_init);
 760
 761 static void __exit cs4270_exit(void)
 762 {
 763         i2c_del_driver(&cs4270_i2c_driver);
 764 }
 765 module_exit(cs4270_exit);
 766
 767 MODULE_AUTHOR("Timur Tabi <timur@freescale.com>");
 768 MODULE_DESCRIPTION("Cirrus Logic CS4270 ALSA SoC Codec Driver");
 769 MODULE_LICENSE("GPL");