linux/sound/soc/codecs/rt5514-spi.c
<<
>>
Prefs
   1/*
   2 * rt5514-spi.c  --  RT5514 SPI driver
   3 *
   4 * Copyright 2015 Realtek Semiconductor Corp.
   5 * Author: Oder Chiou <oder_chiou@realtek.com>
   6 *
   7 * This program is free software; you can redistribute it and/or modify
   8 * it under the terms of the GNU General Public License version 2 as
   9 * published by the Free Software Foundation.
  10 */
  11
  12#include <linux/module.h>
  13#include <linux/input.h>
  14#include <linux/spi/spi.h>
  15#include <linux/device.h>
  16#include <linux/init.h>
  17#include <linux/delay.h>
  18#include <linux/interrupt.h>
  19#include <linux/irq.h>
  20#include <linux/slab.h>
  21#include <linux/gpio.h>
  22#include <linux/sched.h>
  23#include <linux/uaccess.h>
  24#include <linux/regulator/consumer.h>
  25#include <linux/pm_qos.h>
  26#include <linux/sysfs.h>
  27#include <linux/clk.h>
  28#include <sound/core.h>
  29#include <sound/pcm.h>
  30#include <sound/pcm_params.h>
  31#include <sound/soc.h>
  32#include <sound/soc-dapm.h>
  33#include <sound/initval.h>
  34#include <sound/tlv.h>
  35
  36#include "rt5514-spi.h"
  37
  38static struct spi_device *rt5514_spi;
  39
  40struct rt5514_dsp {
  41        struct device *dev;
  42        struct delayed_work copy_work;
  43        struct mutex dma_lock;
  44        struct snd_pcm_substream *substream;
  45        unsigned int buf_base, buf_limit, buf_rp;
  46        size_t buf_size, get_size, dma_offset;
  47};
  48
  49static const struct snd_pcm_hardware rt5514_spi_pcm_hardware = {
  50        .info                   = SNDRV_PCM_INFO_MMAP |
  51                                  SNDRV_PCM_INFO_MMAP_VALID |
  52                                  SNDRV_PCM_INFO_INTERLEAVED,
  53        .formats                = SNDRV_PCM_FMTBIT_S16_LE,
  54        .period_bytes_min       = PAGE_SIZE,
  55        .period_bytes_max       = 0x20000 / 8,
  56        .periods_min            = 8,
  57        .periods_max            = 8,
  58        .channels_min           = 1,
  59        .channels_max           = 1,
  60        .buffer_bytes_max       = 0x20000,
  61};
  62
  63static struct snd_soc_dai_driver rt5514_spi_dai = {
  64        .name = "rt5514-dsp-cpu-dai",
  65        .id = 0,
  66        .capture = {
  67                .stream_name = "DSP Capture",
  68                .channels_min = 1,
  69                .channels_max = 1,
  70                .rates = SNDRV_PCM_RATE_16000,
  71                .formats = SNDRV_PCM_FMTBIT_S16_LE,
  72        },
  73};
  74
  75static void rt5514_spi_copy_work(struct work_struct *work)
  76{
  77        struct rt5514_dsp *rt5514_dsp =
  78                container_of(work, struct rt5514_dsp, copy_work.work);
  79        struct snd_pcm_runtime *runtime;
  80        size_t period_bytes, truncated_bytes = 0;
  81        unsigned int cur_wp, remain_data;
  82        u8 buf[8];
  83
  84        mutex_lock(&rt5514_dsp->dma_lock);
  85        if (!rt5514_dsp->substream) {
  86                dev_err(rt5514_dsp->dev, "No pcm substream\n");
  87                goto done;
  88        }
  89
  90        runtime = rt5514_dsp->substream->runtime;
  91        period_bytes = snd_pcm_lib_period_bytes(rt5514_dsp->substream);
  92
  93        if (rt5514_dsp->get_size >= rt5514_dsp->buf_size) {
  94                rt5514_spi_burst_read(RT5514_BUFFER_VOICE_WP, (u8 *)&buf,
  95                        sizeof(buf));
  96                cur_wp = buf[0] | buf[1] << 8 | buf[2] << 16 |
  97                                        buf[3] << 24;
  98
  99                if (cur_wp >= rt5514_dsp->buf_rp)
 100                        remain_data = (cur_wp - rt5514_dsp->buf_rp);
 101                else
 102                        remain_data =
 103                                (rt5514_dsp->buf_limit - rt5514_dsp->buf_rp) +
 104                                (cur_wp - rt5514_dsp->buf_base);
 105
 106                if (remain_data < period_bytes) {
 107                        schedule_delayed_work(&rt5514_dsp->copy_work, 5);
 108                        goto done;
 109                }
 110        }
 111
 112        if (rt5514_dsp->buf_rp + period_bytes <= rt5514_dsp->buf_limit) {
 113                rt5514_spi_burst_read(rt5514_dsp->buf_rp,
 114                        runtime->dma_area + rt5514_dsp->dma_offset,
 115                        period_bytes);
 116
 117                if (rt5514_dsp->buf_rp + period_bytes == rt5514_dsp->buf_limit)
 118                        rt5514_dsp->buf_rp = rt5514_dsp->buf_base;
 119                else
 120                        rt5514_dsp->buf_rp += period_bytes;
 121        } else {
 122                truncated_bytes = rt5514_dsp->buf_limit - rt5514_dsp->buf_rp;
 123                rt5514_spi_burst_read(rt5514_dsp->buf_rp,
 124                        runtime->dma_area + rt5514_dsp->dma_offset,
 125                        truncated_bytes);
 126
 127                rt5514_spi_burst_read(rt5514_dsp->buf_base,
 128                        runtime->dma_area + rt5514_dsp->dma_offset +
 129                        truncated_bytes, period_bytes - truncated_bytes);
 130
 131                rt5514_dsp->buf_rp = rt5514_dsp->buf_base + period_bytes -
 132                        truncated_bytes;
 133        }
 134
 135        rt5514_dsp->get_size += period_bytes;
 136        rt5514_dsp->dma_offset += period_bytes;
 137        if (rt5514_dsp->dma_offset >= runtime->dma_bytes)
 138                rt5514_dsp->dma_offset = 0;
 139
 140        snd_pcm_period_elapsed(rt5514_dsp->substream);
 141
 142        schedule_delayed_work(&rt5514_dsp->copy_work, 5);
 143
 144done:
 145        mutex_unlock(&rt5514_dsp->dma_lock);
 146}
 147
 148static void rt5514_schedule_copy(struct rt5514_dsp *rt5514_dsp)
 149{
 150        u8 buf[8];
 151
 152        rt5514_dsp->get_size = 0;
 153
 154        /**
 155         * The address area x1800XXXX is the register address, and it cannot
 156         * support spi burst read perfectly. So we use the spi burst read
 157         * individually to make sure the data correctly.
 158         */
 159        rt5514_spi_burst_read(RT5514_BUFFER_VOICE_BASE, (u8 *)&buf,
 160                sizeof(buf));
 161        rt5514_dsp->buf_base = buf[0] | buf[1] << 8 | buf[2] << 16 |
 162                                buf[3] << 24;
 163
 164        rt5514_spi_burst_read(RT5514_BUFFER_VOICE_LIMIT, (u8 *)&buf,
 165                sizeof(buf));
 166        rt5514_dsp->buf_limit = buf[0] | buf[1] << 8 | buf[2] << 16 |
 167                                buf[3] << 24;
 168
 169        rt5514_spi_burst_read(RT5514_BUFFER_VOICE_WP, (u8 *)&buf,
 170                sizeof(buf));
 171        rt5514_dsp->buf_rp = buf[0] | buf[1] << 8 | buf[2] << 16 |
 172                                buf[3] << 24;
 173
 174        if (rt5514_dsp->buf_rp % 8)
 175                rt5514_dsp->buf_rp = (rt5514_dsp->buf_rp / 8) * 8;
 176
 177        rt5514_dsp->buf_size = rt5514_dsp->buf_limit - rt5514_dsp->buf_base;
 178
 179        if (rt5514_dsp->buf_base && rt5514_dsp->buf_limit &&
 180                rt5514_dsp->buf_rp && rt5514_dsp->buf_size)
 181                schedule_delayed_work(&rt5514_dsp->copy_work, 0);
 182}
 183
 184static irqreturn_t rt5514_spi_irq(int irq, void *data)
 185{
 186        struct rt5514_dsp *rt5514_dsp = data;
 187
 188        rt5514_schedule_copy(rt5514_dsp);
 189
 190        return IRQ_HANDLED;
 191}
 192
 193/* PCM for streaming audio from the DSP buffer */
 194static int rt5514_spi_pcm_open(struct snd_pcm_substream *substream)
 195{
 196        snd_soc_set_runtime_hwparams(substream, &rt5514_spi_pcm_hardware);
 197
 198        return 0;
 199}
 200
 201static int rt5514_spi_hw_params(struct snd_pcm_substream *substream,
 202                               struct snd_pcm_hw_params *hw_params)
 203{
 204        struct snd_soc_pcm_runtime *rtd = substream->private_data;
 205        struct rt5514_dsp *rt5514_dsp =
 206                        snd_soc_platform_get_drvdata(rtd->platform);
 207        int ret;
 208        u8 buf[8];
 209
 210        mutex_lock(&rt5514_dsp->dma_lock);
 211        ret = snd_pcm_lib_alloc_vmalloc_buffer(substream,
 212                        params_buffer_bytes(hw_params));
 213        rt5514_dsp->substream = substream;
 214        rt5514_dsp->dma_offset = 0;
 215
 216        /* Read IRQ status and schedule copy accordingly. */
 217        rt5514_spi_burst_read(RT5514_IRQ_CTRL, (u8 *)&buf, sizeof(buf));
 218        if (buf[0] & RT5514_IRQ_STATUS_BIT)
 219                rt5514_schedule_copy(rt5514_dsp);
 220
 221        mutex_unlock(&rt5514_dsp->dma_lock);
 222
 223        return ret;
 224}
 225
 226static int rt5514_spi_hw_free(struct snd_pcm_substream *substream)
 227{
 228        struct snd_soc_pcm_runtime *rtd = substream->private_data;
 229        struct rt5514_dsp *rt5514_dsp =
 230                        snd_soc_platform_get_drvdata(rtd->platform);
 231
 232        mutex_lock(&rt5514_dsp->dma_lock);
 233        rt5514_dsp->substream = NULL;
 234        mutex_unlock(&rt5514_dsp->dma_lock);
 235
 236        cancel_delayed_work_sync(&rt5514_dsp->copy_work);
 237
 238        return snd_pcm_lib_free_vmalloc_buffer(substream);
 239}
 240
 241static snd_pcm_uframes_t rt5514_spi_pcm_pointer(
 242                struct snd_pcm_substream *substream)
 243{
 244        struct snd_pcm_runtime *runtime = substream->runtime;
 245        struct snd_soc_pcm_runtime *rtd = substream->private_data;
 246        struct rt5514_dsp *rt5514_dsp =
 247                snd_soc_platform_get_drvdata(rtd->platform);
 248
 249        return bytes_to_frames(runtime, rt5514_dsp->dma_offset);
 250}
 251
 252static const struct snd_pcm_ops rt5514_spi_pcm_ops = {
 253        .open           = rt5514_spi_pcm_open,
 254        .hw_params      = rt5514_spi_hw_params,
 255        .hw_free        = rt5514_spi_hw_free,
 256        .pointer        = rt5514_spi_pcm_pointer,
 257        .mmap           = snd_pcm_lib_mmap_vmalloc,
 258        .page           = snd_pcm_lib_get_vmalloc_page,
 259};
 260
 261static int rt5514_spi_pcm_probe(struct snd_soc_platform *platform)
 262{
 263        struct rt5514_dsp *rt5514_dsp;
 264        int ret;
 265
 266        rt5514_dsp = devm_kzalloc(platform->dev, sizeof(*rt5514_dsp),
 267                        GFP_KERNEL);
 268
 269        rt5514_dsp->dev = &rt5514_spi->dev;
 270        mutex_init(&rt5514_dsp->dma_lock);
 271        INIT_DELAYED_WORK(&rt5514_dsp->copy_work, rt5514_spi_copy_work);
 272        snd_soc_platform_set_drvdata(platform, rt5514_dsp);
 273
 274        if (rt5514_spi->irq) {
 275                ret = devm_request_threaded_irq(&rt5514_spi->dev,
 276                        rt5514_spi->irq, NULL, rt5514_spi_irq,
 277                        IRQF_TRIGGER_RISING | IRQF_ONESHOT, "rt5514-spi",
 278                        rt5514_dsp);
 279                if (ret)
 280                        dev_err(&rt5514_spi->dev,
 281                                "%s Failed to reguest IRQ: %d\n", __func__,
 282                                ret);
 283        }
 284
 285        return 0;
 286}
 287
 288static const struct snd_soc_platform_driver rt5514_spi_platform = {
 289        .probe = rt5514_spi_pcm_probe,
 290        .ops = &rt5514_spi_pcm_ops,
 291};
 292
 293static const struct snd_soc_component_driver rt5514_spi_dai_component = {
 294        .name           = "rt5514-spi-dai",
 295};
 296
 297/**
 298 * rt5514_spi_burst_read - Read data from SPI by rt5514 address.
 299 * @addr: Start address.
 300 * @rxbuf: Data Buffer for reading.
 301 * @len: Data length, it must be a multiple of 8.
 302 *
 303 *
 304 * Returns true for success.
 305 */
 306int rt5514_spi_burst_read(unsigned int addr, u8 *rxbuf, size_t len)
 307{
 308        u8 spi_cmd = RT5514_SPI_CMD_BURST_READ;
 309        int status;
 310        u8 write_buf[8];
 311        unsigned int i, end, offset = 0;
 312
 313        struct spi_message message;
 314        struct spi_transfer x[3];
 315
 316        while (offset < len) {
 317                if (offset + RT5514_SPI_BUF_LEN <= len)
 318                        end = RT5514_SPI_BUF_LEN;
 319                else
 320                        end = len % RT5514_SPI_BUF_LEN;
 321
 322                write_buf[0] = spi_cmd;
 323                write_buf[1] = ((addr + offset) & 0xff000000) >> 24;
 324                write_buf[2] = ((addr + offset) & 0x00ff0000) >> 16;
 325                write_buf[3] = ((addr + offset) & 0x0000ff00) >> 8;
 326                write_buf[4] = ((addr + offset) & 0x000000ff) >> 0;
 327
 328                spi_message_init(&message);
 329                memset(x, 0, sizeof(x));
 330
 331                x[0].len = 5;
 332                x[0].tx_buf = write_buf;
 333                spi_message_add_tail(&x[0], &message);
 334
 335                x[1].len = 4;
 336                x[1].tx_buf = write_buf;
 337                spi_message_add_tail(&x[1], &message);
 338
 339                x[2].len = end;
 340                x[2].rx_buf = rxbuf + offset;
 341                spi_message_add_tail(&x[2], &message);
 342
 343                status = spi_sync(rt5514_spi, &message);
 344
 345                if (status)
 346                        return false;
 347
 348                offset += RT5514_SPI_BUF_LEN;
 349        }
 350
 351        for (i = 0; i < len; i += 8) {
 352                write_buf[0] = rxbuf[i + 0];
 353                write_buf[1] = rxbuf[i + 1];
 354                write_buf[2] = rxbuf[i + 2];
 355                write_buf[3] = rxbuf[i + 3];
 356                write_buf[4] = rxbuf[i + 4];
 357                write_buf[5] = rxbuf[i + 5];
 358                write_buf[6] = rxbuf[i + 6];
 359                write_buf[7] = rxbuf[i + 7];
 360
 361                rxbuf[i + 0] = write_buf[7];
 362                rxbuf[i + 1] = write_buf[6];
 363                rxbuf[i + 2] = write_buf[5];
 364                rxbuf[i + 3] = write_buf[4];
 365                rxbuf[i + 4] = write_buf[3];
 366                rxbuf[i + 5] = write_buf[2];
 367                rxbuf[i + 6] = write_buf[1];
 368                rxbuf[i + 7] = write_buf[0];
 369        }
 370
 371        return true;
 372}
 373
 374/**
 375 * rt5514_spi_burst_write - Write data to SPI by rt5514 address.
 376 * @addr: Start address.
 377 * @txbuf: Data Buffer for writng.
 378 * @len: Data length, it must be a multiple of 8.
 379 *
 380 *
 381 * Returns true for success.
 382 */
 383int rt5514_spi_burst_write(u32 addr, const u8 *txbuf, size_t len)
 384{
 385        u8 spi_cmd = RT5514_SPI_CMD_BURST_WRITE;
 386        u8 *write_buf;
 387        unsigned int i, end, offset = 0;
 388
 389        write_buf = kmalloc(RT5514_SPI_BUF_LEN + 6, GFP_KERNEL);
 390
 391        if (write_buf == NULL)
 392                return -ENOMEM;
 393
 394        while (offset < len) {
 395                if (offset + RT5514_SPI_BUF_LEN <= len)
 396                        end = RT5514_SPI_BUF_LEN;
 397                else
 398                        end = len % RT5514_SPI_BUF_LEN;
 399
 400                write_buf[0] = spi_cmd;
 401                write_buf[1] = ((addr + offset) & 0xff000000) >> 24;
 402                write_buf[2] = ((addr + offset) & 0x00ff0000) >> 16;
 403                write_buf[3] = ((addr + offset) & 0x0000ff00) >> 8;
 404                write_buf[4] = ((addr + offset) & 0x000000ff) >> 0;
 405
 406                for (i = 0; i < end; i += 8) {
 407                        write_buf[i + 12] = txbuf[offset + i + 0];
 408                        write_buf[i + 11] = txbuf[offset + i + 1];
 409                        write_buf[i + 10] = txbuf[offset + i + 2];
 410                        write_buf[i +  9] = txbuf[offset + i + 3];
 411                        write_buf[i +  8] = txbuf[offset + i + 4];
 412                        write_buf[i +  7] = txbuf[offset + i + 5];
 413                        write_buf[i +  6] = txbuf[offset + i + 6];
 414                        write_buf[i +  5] = txbuf[offset + i + 7];
 415                }
 416
 417                write_buf[end + 5] = spi_cmd;
 418
 419                spi_write(rt5514_spi, write_buf, end + 6);
 420
 421                offset += RT5514_SPI_BUF_LEN;
 422        }
 423
 424        kfree(write_buf);
 425
 426        return 0;
 427}
 428EXPORT_SYMBOL_GPL(rt5514_spi_burst_write);
 429
 430static int rt5514_spi_probe(struct spi_device *spi)
 431{
 432        int ret;
 433
 434        rt5514_spi = spi;
 435
 436        ret = devm_snd_soc_register_platform(&spi->dev, &rt5514_spi_platform);
 437        if (ret < 0) {
 438                dev_err(&spi->dev, "Failed to register platform.\n");
 439                return ret;
 440        }
 441
 442        ret = devm_snd_soc_register_component(&spi->dev,
 443                                              &rt5514_spi_dai_component,
 444                                              &rt5514_spi_dai, 1);
 445        if (ret < 0) {
 446                dev_err(&spi->dev, "Failed to register component.\n");
 447                return ret;
 448        }
 449
 450        return 0;
 451}
 452
 453static const struct of_device_id rt5514_of_match[] = {
 454        { .compatible = "realtek,rt5514", },
 455        {},
 456};
 457MODULE_DEVICE_TABLE(of, rt5514_of_match);
 458
 459static struct spi_driver rt5514_spi_driver = {
 460        .driver = {
 461                .name = "rt5514",
 462                .of_match_table = of_match_ptr(rt5514_of_match),
 463        },
 464        .probe = rt5514_spi_probe,
 465};
 466module_spi_driver(rt5514_spi_driver);
 467
 468MODULE_DESCRIPTION("RT5514 SPI driver");
 469MODULE_AUTHOR("Oder Chiou <oder_chiou@realtek.com>");
 470MODULE_LICENSE("GPL v2");
 471