linux/sound/soc/codecs/tlv320aic26.c
<<
>>
Prefs
   1// SPDX-License-Identifier: GPL-2.0-only
   2/*
   3 * Texas Instruments TLV320AIC26 low power audio CODEC
   4 * ALSA SoC CODEC driver
   5 *
   6 * Copyright (C) 2008 Secret Lab Technologies Ltd.
   7 */
   8
   9#include <linux/module.h>
  10#include <linux/moduleparam.h>
  11#include <linux/init.h>
  12#include <linux/delay.h>
  13#include <linux/pm.h>
  14#include <linux/device.h>
  15#include <linux/sysfs.h>
  16#include <linux/spi/spi.h>
  17#include <linux/slab.h>
  18#include <sound/core.h>
  19#include <sound/pcm.h>
  20#include <sound/pcm_params.h>
  21#include <sound/soc.h>
  22#include <sound/initval.h>
  23
  24#include "tlv320aic26.h"
  25
  26MODULE_DESCRIPTION("ASoC TLV320AIC26 codec driver");
  27MODULE_AUTHOR("Grant Likely <grant.likely@secretlab.ca>");
  28MODULE_LICENSE("GPL");
  29
  30/* AIC26 driver private data */
  31struct aic26 {
  32        struct spi_device *spi;
  33        struct regmap *regmap;
  34        struct snd_soc_component *component;
  35        int master;
  36        int datfm;
  37        int mclk;
  38
  39        /* Keyclick parameters */
  40        int keyclick_amplitude;
  41        int keyclick_freq;
  42        int keyclick_len;
  43};
  44
  45static const struct snd_soc_dapm_widget tlv320aic26_dapm_widgets[] = {
  46SND_SOC_DAPM_INPUT("MICIN"),
  47SND_SOC_DAPM_INPUT("AUX"),
  48
  49SND_SOC_DAPM_OUTPUT("HPL"),
  50SND_SOC_DAPM_OUTPUT("HPR"),
  51};
  52
  53static const struct snd_soc_dapm_route tlv320aic26_dapm_routes[] = {
  54        { "Capture", NULL, "MICIN" },
  55        { "Capture", NULL, "AUX" },
  56
  57        { "HPL", NULL, "Playback" },
  58        { "HPR", NULL, "Playback" },
  59};
  60
  61/* ---------------------------------------------------------------------
  62 * Digital Audio Interface Operations
  63 */
  64static int aic26_hw_params(struct snd_pcm_substream *substream,
  65                           struct snd_pcm_hw_params *params,
  66                           struct snd_soc_dai *dai)
  67{
  68        struct snd_soc_component *component = dai->component;
  69        struct aic26 *aic26 = snd_soc_component_get_drvdata(component);
  70        int fsref, divisor, wlen, pval, jval, dval, qval;
  71        u16 reg;
  72
  73        dev_dbg(&aic26->spi->dev, "aic26_hw_params(substream=%p, params=%p)\n",
  74                substream, params);
  75        dev_dbg(&aic26->spi->dev, "rate=%i width=%d\n", params_rate(params),
  76                params_width(params));
  77
  78        switch (params_rate(params)) {
  79        case 8000:  fsref = 48000; divisor = AIC26_DIV_6; break;
  80        case 11025: fsref = 44100; divisor = AIC26_DIV_4; break;
  81        case 12000: fsref = 48000; divisor = AIC26_DIV_4; break;
  82        case 16000: fsref = 48000; divisor = AIC26_DIV_3; break;
  83        case 22050: fsref = 44100; divisor = AIC26_DIV_2; break;
  84        case 24000: fsref = 48000; divisor = AIC26_DIV_2; break;
  85        case 32000: fsref = 48000; divisor = AIC26_DIV_1_5; break;
  86        case 44100: fsref = 44100; divisor = AIC26_DIV_1; break;
  87        case 48000: fsref = 48000; divisor = AIC26_DIV_1; break;
  88        default:
  89                dev_dbg(&aic26->spi->dev, "bad rate\n"); return -EINVAL;
  90        }
  91
  92        /* select data word length */
  93        switch (params_width(params)) {
  94        case 8:  wlen = AIC26_WLEN_16; break;
  95        case 16: wlen = AIC26_WLEN_16; break;
  96        case 24: wlen = AIC26_WLEN_24; break;
  97        case 32: wlen = AIC26_WLEN_32; break;
  98        default:
  99                dev_dbg(&aic26->spi->dev, "bad format\n"); return -EINVAL;
 100        }
 101
 102        /**
 103         * Configure PLL
 104         * fsref = (mclk * PLLM) / 2048
 105         * where PLLM = J.DDDD (DDDD register ranges from 0 to 9999, decimal)
 106         */
 107        pval = 1;
 108        /* compute J portion of multiplier */
 109        jval = fsref / (aic26->mclk / 2048);
 110        /* compute fractional DDDD component of multiplier */
 111        dval = fsref - (jval * (aic26->mclk / 2048));
 112        dval = (10000 * dval) / (aic26->mclk / 2048);
 113        dev_dbg(&aic26->spi->dev, "Setting PLLM to %d.%04d\n", jval, dval);
 114        qval = 0;
 115        reg = 0x8000 | qval << 11 | pval << 8 | jval << 2;
 116        snd_soc_component_write(component, AIC26_REG_PLL_PROG1, reg);
 117        reg = dval << 2;
 118        snd_soc_component_write(component, AIC26_REG_PLL_PROG2, reg);
 119
 120        /* Audio Control 3 (master mode, fsref rate) */
 121        if (aic26->master)
 122                reg = 0x0800;
 123        if (fsref == 48000)
 124                reg = 0x2000;
 125        snd_soc_component_update_bits(component, AIC26_REG_AUDIO_CTRL3, 0xf800, reg);
 126
 127        /* Audio Control 1 (FSref divisor) */
 128        reg = wlen | aic26->datfm | (divisor << 3) | divisor;
 129        snd_soc_component_update_bits(component, AIC26_REG_AUDIO_CTRL1, 0xfff, reg);
 130
 131        return 0;
 132}
 133
 134/**
 135 * aic26_mute - Mute control to reduce noise when changing audio format
 136 */
 137static int aic26_mute(struct snd_soc_dai *dai, int mute)
 138{
 139        struct snd_soc_component *component = dai->component;
 140        struct aic26 *aic26 = snd_soc_component_get_drvdata(component);
 141        u16 reg;
 142
 143        dev_dbg(&aic26->spi->dev, "aic26_mute(dai=%p, mute=%i)\n",
 144                dai, mute);
 145
 146        if (mute)
 147                reg = 0x8080;
 148        else
 149                reg = 0;
 150        snd_soc_component_update_bits(component, AIC26_REG_DAC_GAIN, 0x8000, reg);
 151
 152        return 0;
 153}
 154
 155static int aic26_set_sysclk(struct snd_soc_dai *codec_dai,
 156                            int clk_id, unsigned int freq, int dir)
 157{
 158        struct snd_soc_component *component = codec_dai->component;
 159        struct aic26 *aic26 = snd_soc_component_get_drvdata(component);
 160
 161        dev_dbg(&aic26->spi->dev, "aic26_set_sysclk(dai=%p, clk_id==%i,"
 162                " freq=%i, dir=%i)\n",
 163                codec_dai, clk_id, freq, dir);
 164
 165        /* MCLK needs to fall between 2MHz and 50 MHz */
 166        if ((freq < 2000000) || (freq > 50000000))
 167                return -EINVAL;
 168
 169        aic26->mclk = freq;
 170        return 0;
 171}
 172
 173static int aic26_set_fmt(struct snd_soc_dai *codec_dai, unsigned int fmt)
 174{
 175        struct snd_soc_component *component = codec_dai->component;
 176        struct aic26 *aic26 = snd_soc_component_get_drvdata(component);
 177
 178        dev_dbg(&aic26->spi->dev, "aic26_set_fmt(dai=%p, fmt==%i)\n",
 179                codec_dai, fmt);
 180
 181        /* set master/slave audio interface */
 182        switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
 183        case SND_SOC_DAIFMT_CBM_CFM: aic26->master = 1; break;
 184        case SND_SOC_DAIFMT_CBS_CFS: aic26->master = 0; break;
 185        default:
 186                dev_dbg(&aic26->spi->dev, "bad master\n"); return -EINVAL;
 187        }
 188
 189        /* interface format */
 190        switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
 191        case SND_SOC_DAIFMT_I2S:     aic26->datfm = AIC26_DATFM_I2S; break;
 192        case SND_SOC_DAIFMT_DSP_A:   aic26->datfm = AIC26_DATFM_DSP; break;
 193        case SND_SOC_DAIFMT_RIGHT_J: aic26->datfm = AIC26_DATFM_RIGHTJ; break;
 194        case SND_SOC_DAIFMT_LEFT_J:  aic26->datfm = AIC26_DATFM_LEFTJ; break;
 195        default:
 196                dev_dbg(&aic26->spi->dev, "bad format\n"); return -EINVAL;
 197        }
 198
 199        return 0;
 200}
 201
 202/* ---------------------------------------------------------------------
 203 * Digital Audio Interface Definition
 204 */
 205#define AIC26_RATES     (SNDRV_PCM_RATE_8000  | SNDRV_PCM_RATE_11025 |\
 206                         SNDRV_PCM_RATE_16000 | SNDRV_PCM_RATE_22050 |\
 207                         SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\
 208                         SNDRV_PCM_RATE_48000)
 209#define AIC26_FORMATS   (SNDRV_PCM_FMTBIT_S8     | SNDRV_PCM_FMTBIT_S16_BE |\
 210                         SNDRV_PCM_FMTBIT_S24_BE | SNDRV_PCM_FMTBIT_S32_BE)
 211
 212static const struct snd_soc_dai_ops aic26_dai_ops = {
 213        .hw_params      = aic26_hw_params,
 214        .digital_mute   = aic26_mute,
 215        .set_sysclk     = aic26_set_sysclk,
 216        .set_fmt        = aic26_set_fmt,
 217};
 218
 219static struct snd_soc_dai_driver aic26_dai = {
 220        .name = "tlv320aic26-hifi",
 221        .playback = {
 222                .stream_name = "Playback",
 223                .channels_min = 2,
 224                .channels_max = 2,
 225                .rates = AIC26_RATES,
 226                .formats = AIC26_FORMATS,
 227        },
 228        .capture = {
 229                .stream_name = "Capture",
 230                .channels_min = 2,
 231                .channels_max = 2,
 232                .rates = AIC26_RATES,
 233                .formats = AIC26_FORMATS,
 234        },
 235        .ops = &aic26_dai_ops,
 236};
 237
 238/* ---------------------------------------------------------------------
 239 * ALSA controls
 240 */
 241static const char *aic26_capture_src_text[] = {"Mic", "Aux"};
 242static SOC_ENUM_SINGLE_DECL(aic26_capture_src_enum,
 243                            AIC26_REG_AUDIO_CTRL1, 12,
 244                            aic26_capture_src_text);
 245
 246static const struct snd_kcontrol_new aic26_snd_controls[] = {
 247        /* Output */
 248        SOC_DOUBLE("PCM Playback Volume", AIC26_REG_DAC_GAIN, 8, 0, 0x7f, 1),
 249        SOC_DOUBLE("PCM Playback Switch", AIC26_REG_DAC_GAIN, 15, 7, 1, 1),
 250        SOC_SINGLE("PCM Capture Volume", AIC26_REG_ADC_GAIN, 8, 0x7f, 0),
 251        SOC_SINGLE("PCM Capture Mute", AIC26_REG_ADC_GAIN, 15, 1, 1),
 252        SOC_SINGLE("Keyclick activate", AIC26_REG_AUDIO_CTRL2, 15, 0x1, 0),
 253        SOC_SINGLE("Keyclick amplitude", AIC26_REG_AUDIO_CTRL2, 12, 0x7, 0),
 254        SOC_SINGLE("Keyclick frequency", AIC26_REG_AUDIO_CTRL2, 8, 0x7, 0),
 255        SOC_SINGLE("Keyclick period", AIC26_REG_AUDIO_CTRL2, 4, 0xf, 0),
 256        SOC_ENUM("Capture Source", aic26_capture_src_enum),
 257};
 258
 259/* ---------------------------------------------------------------------
 260 * SPI device portion of driver: sysfs files for debugging
 261 */
 262
 263static ssize_t aic26_keyclick_show(struct device *dev,
 264                                   struct device_attribute *attr, char *buf)
 265{
 266        struct aic26 *aic26 = dev_get_drvdata(dev);
 267        int val, amp, freq, len;
 268
 269        val = snd_soc_component_read32(aic26->component, AIC26_REG_AUDIO_CTRL2);
 270        amp = (val >> 12) & 0x7;
 271        freq = (125 << ((val >> 8) & 0x7)) >> 1;
 272        len = 2 * (1 + ((val >> 4) & 0xf));
 273
 274        return sprintf(buf, "amp=%x freq=%iHz len=%iclks\n", amp, freq, len);
 275}
 276
 277/* Any write to the keyclick attribute will trigger the keyclick event */
 278static ssize_t aic26_keyclick_set(struct device *dev,
 279                                  struct device_attribute *attr,
 280                                  const char *buf, size_t count)
 281{
 282        struct aic26 *aic26 = dev_get_drvdata(dev);
 283
 284        snd_soc_component_update_bits(aic26->component, AIC26_REG_AUDIO_CTRL2,
 285                            0x8000, 0x800);
 286
 287        return count;
 288}
 289
 290static DEVICE_ATTR(keyclick, 0644, aic26_keyclick_show, aic26_keyclick_set);
 291
 292/* ---------------------------------------------------------------------
 293 * SoC CODEC portion of driver: probe and release routines
 294 */
 295static int aic26_probe(struct snd_soc_component *component)
 296{
 297        struct aic26 *aic26 = dev_get_drvdata(component->dev);
 298        int ret, reg;
 299
 300        aic26->component = component;
 301
 302        /* Reset the codec to power on defaults */
 303        snd_soc_component_write(component, AIC26_REG_RESET, 0xBB00);
 304
 305        /* Power up CODEC */
 306        snd_soc_component_write(component, AIC26_REG_POWER_CTRL, 0);
 307
 308        /* Audio Control 3 (master mode, fsref rate) */
 309        reg = snd_soc_component_read32(component, AIC26_REG_AUDIO_CTRL3);
 310        reg &= ~0xf800;
 311        reg |= 0x0800; /* set master mode */
 312        snd_soc_component_write(component, AIC26_REG_AUDIO_CTRL3, reg);
 313
 314        /* Register the sysfs files for debugging */
 315        /* Create SysFS files */
 316        ret = device_create_file(component->dev, &dev_attr_keyclick);
 317        if (ret)
 318                dev_info(component->dev, "error creating sysfs files\n");
 319
 320        return 0;
 321}
 322
 323static const struct snd_soc_component_driver aic26_soc_component_dev = {
 324        .probe                  = aic26_probe,
 325        .controls               = aic26_snd_controls,
 326        .num_controls           = ARRAY_SIZE(aic26_snd_controls),
 327        .dapm_widgets           = tlv320aic26_dapm_widgets,
 328        .num_dapm_widgets       = ARRAY_SIZE(tlv320aic26_dapm_widgets),
 329        .dapm_routes            = tlv320aic26_dapm_routes,
 330        .num_dapm_routes        = ARRAY_SIZE(tlv320aic26_dapm_routes),
 331        .idle_bias_on           = 1,
 332        .use_pmdown_time        = 1,
 333        .endianness             = 1,
 334        .non_legacy_dai_naming  = 1,
 335};
 336
 337static const struct regmap_config aic26_regmap = {
 338        .reg_bits = 16,
 339        .val_bits = 16,
 340};
 341
 342/* ---------------------------------------------------------------------
 343 * SPI device portion of driver: probe and release routines and SPI
 344 *                               driver registration.
 345 */
 346static int aic26_spi_probe(struct spi_device *spi)
 347{
 348        struct aic26 *aic26;
 349        int ret;
 350
 351        dev_dbg(&spi->dev, "probing tlv320aic26 spi device\n");
 352
 353        /* Allocate driver data */
 354        aic26 = devm_kzalloc(&spi->dev, sizeof *aic26, GFP_KERNEL);
 355        if (!aic26)
 356                return -ENOMEM;
 357
 358        aic26->regmap = devm_regmap_init_spi(spi, &aic26_regmap);
 359        if (IS_ERR(aic26->regmap))
 360                return PTR_ERR(aic26->regmap);
 361
 362        /* Initialize the driver data */
 363        aic26->spi = spi;
 364        dev_set_drvdata(&spi->dev, aic26);
 365        aic26->master = 1;
 366
 367        ret = devm_snd_soc_register_component(&spi->dev,
 368                        &aic26_soc_component_dev, &aic26_dai, 1);
 369        return ret;
 370}
 371
 372static struct spi_driver aic26_spi = {
 373        .driver = {
 374                .name = "tlv320aic26-codec",
 375        },
 376        .probe = aic26_spi_probe,
 377};
 378
 379module_spi_driver(aic26_spi);
 380