sound/soc/codecs/rt5514-spi.c

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