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 static struct spi_device *rt5514_spi;
  39
  40 struct 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
  49 static 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
  63 static 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
  75 static 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
 144 done:
 145         mutex_unlock(&rt5514_dsp->dma_lock);
 146 }
 147
 148 static irqreturn_t rt5514_spi_irq(int irq, void *data)
 149 {
 150         struct rt5514_dsp *rt5514_dsp = data;
 151         u8 buf[8];
 152
 153         rt5514_dsp->get_size = 0;
 154
 155         /**
 156          * The address area x1800XXXX is the register address, and it cannot
 157          * support spi burst read perfectly. So we use the spi burst read
 158          * individually to make sure the data correctly.
 159          */
 160         rt5514_spi_burst_read(RT5514_BUFFER_VOICE_BASE, (u8 *)&buf,
 161                 sizeof(buf));
 162         rt5514_dsp->buf_base = buf[0] | buf[1] << 8 | buf[2] << 16 |
 163                                 buf[3] << 24;
 164
 165         rt5514_spi_burst_read(RT5514_BUFFER_VOICE_LIMIT, (u8 *)&buf,
 166                 sizeof(buf));
 167         rt5514_dsp->buf_limit = buf[0] | buf[1] << 8 | buf[2] << 16 |
 168                                 buf[3] << 24;
 169
 170         rt5514_spi_burst_read(RT5514_BUFFER_VOICE_WP, (u8 *)&buf,
 171                 sizeof(buf));
 172         rt5514_dsp->buf_rp = buf[0] | buf[1] << 8 | buf[2] << 16 |
 173                                 buf[3] << 24;
 174
 175         if (rt5514_dsp->buf_rp % 8)
 176                 rt5514_dsp->buf_rp = (rt5514_dsp->buf_rp / 8) * 8;
 177
 178         rt5514_dsp->buf_size = rt5514_dsp->buf_limit - rt5514_dsp->buf_base;
 179
 180         if (rt5514_dsp->buf_base && rt5514_dsp->buf_limit &&
 181                 rt5514_dsp->buf_rp && rt5514_dsp->buf_size)
 182                 schedule_delayed_work(&rt5514_dsp->copy_work, 0);
 183
 184         return IRQ_HANDLED;
 185 }
 186
 187 /* PCM for streaming audio from the DSP buffer */
 188 static int rt5514_spi_pcm_open(struct snd_pcm_substream *substream)
 189 {
 190         snd_soc_set_runtime_hwparams(substream, &rt5514_spi_pcm_hardware);
 191
 192         return 0;
 193 }
 194
 195 static int rt5514_spi_hw_params(struct snd_pcm_substream *substream,
 196                                struct snd_pcm_hw_params *hw_params)
 197 {
 198         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 199         struct rt5514_dsp *rt5514_dsp =
 200                         snd_soc_platform_get_drvdata(rtd->platform);
 201         int ret;
 202
 203         mutex_lock(&rt5514_dsp->dma_lock);
 204         ret = snd_pcm_lib_alloc_vmalloc_buffer(substream,
 205                         params_buffer_bytes(hw_params));
 206         rt5514_dsp->substream = substream;
 207         rt5514_dsp->dma_offset = 0;
 208         mutex_unlock(&rt5514_dsp->dma_lock);
 209
 210         return ret;
 211 }
 212
 213 static int rt5514_spi_hw_free(struct snd_pcm_substream *substream)
 214 {
 215         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 216         struct rt5514_dsp *rt5514_dsp =
 217                         snd_soc_platform_get_drvdata(rtd->platform);
 218
 219         mutex_lock(&rt5514_dsp->dma_lock);
 220         rt5514_dsp->substream = NULL;
 221         mutex_unlock(&rt5514_dsp->dma_lock);
 222
 223         cancel_delayed_work_sync(&rt5514_dsp->copy_work);
 224
 225         return snd_pcm_lib_free_vmalloc_buffer(substream);
 226 }
 227
 228 static snd_pcm_uframes_t rt5514_spi_pcm_pointer(
 229                 struct snd_pcm_substream *substream)
 230 {
 231         struct snd_pcm_runtime *runtime = substream->runtime;
 232         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 233         struct rt5514_dsp *rt5514_dsp =
 234                 snd_soc_platform_get_drvdata(rtd->platform);
 235
 236         return bytes_to_frames(runtime, rt5514_dsp->dma_offset);
 237 }
 238
 239 static const struct snd_pcm_ops rt5514_spi_pcm_ops = {
 240         .open           = rt5514_spi_pcm_open,
 241         .hw_params      = rt5514_spi_hw_params,
 242         .hw_free        = rt5514_spi_hw_free,
 243         .pointer        = rt5514_spi_pcm_pointer,
 244         .mmap           = snd_pcm_lib_mmap_vmalloc,
 245         .page           = snd_pcm_lib_get_vmalloc_page,
 246 };
 247
 248 static int rt5514_spi_pcm_probe(struct snd_soc_platform *platform)
 249 {
 250         struct rt5514_dsp *rt5514_dsp;
 251         int ret;
 252
 253         rt5514_dsp = devm_kzalloc(platform->dev, sizeof(*rt5514_dsp),
 254                         GFP_KERNEL);
 255
 256         rt5514_dsp->dev = &rt5514_spi->dev;
 257         mutex_init(&rt5514_dsp->dma_lock);
 258         INIT_DELAYED_WORK(&rt5514_dsp->copy_work, rt5514_spi_copy_work);
 259         snd_soc_platform_set_drvdata(platform, rt5514_dsp);
 260
 261         if (rt5514_spi->irq) {
 262                 ret = devm_request_threaded_irq(&rt5514_spi->dev,
 263                         rt5514_spi->irq, NULL, rt5514_spi_irq,
 264                         IRQF_TRIGGER_RISING | IRQF_ONESHOT, "rt5514-spi",
 265                         rt5514_dsp);
 266                 if (ret)
 267                         dev_err(&rt5514_spi->dev,
 268                                 "%s Failed to reguest IRQ: %d\n", __func__,
 269                                 ret);
 270         }
 271
 272         return 0;
 273 }
 274
 275 static const struct snd_soc_platform_driver rt5514_spi_platform = {
 276         .probe = rt5514_spi_pcm_probe,
 277         .ops = &rt5514_spi_pcm_ops,
 278 };
 279
 280 static const struct snd_soc_component_driver rt5514_spi_dai_component = {
 281         .name           = "rt5514-spi-dai",
 282 };
 283
 284 /**
 285  * rt5514_spi_burst_read - Read data from SPI by rt5514 address.
 286  * @addr: Start address.
 287  * @rxbuf: Data Buffer for reading.
 288  * @len: Data length, it must be a multiple of 8.
 289  *
 290  *
 291  * Returns true for success.
 292  */
 293 int rt5514_spi_burst_read(unsigned int addr, u8 *rxbuf, size_t len)
 294 {
 295         u8 spi_cmd = RT5514_SPI_CMD_BURST_READ;
 296         int status;
 297         u8 write_buf[8];
 298         unsigned int i, end, offset = 0;
 299
 300         struct spi_message message;
 301         struct spi_transfer x[3];
 302
 303         while (offset < len) {
 304                 if (offset + RT5514_SPI_BUF_LEN <= len)
 305                         end = RT5514_SPI_BUF_LEN;
 306                 else
 307                         end = len % RT5514_SPI_BUF_LEN;
 308
 309                 write_buf[0] = spi_cmd;
 310                 write_buf[1] = ((addr + offset) & 0xff000000) >> 24;
 311                 write_buf[2] = ((addr + offset) & 0x00ff0000) >> 16;
 312                 write_buf[3] = ((addr + offset) & 0x0000ff00) >> 8;
 313                 write_buf[4] = ((addr + offset) & 0x000000ff) >> 0;
 314
 315                 spi_message_init(&message);
 316                 memset(x, 0, sizeof(x));
 317
 318                 x[0].len = 5;
 319                 x[0].tx_buf = write_buf;
 320                 spi_message_add_tail(&x[0], &message);
 321
 322                 x[1].len = 4;
 323                 x[1].tx_buf = write_buf;
 324                 spi_message_add_tail(&x[1], &message);
 325
 326                 x[2].len = end;
 327                 x[2].rx_buf = rxbuf + offset;
 328                 spi_message_add_tail(&x[2], &message);
 329
 330                 status = spi_sync(rt5514_spi, &message);
 331
 332                 if (status)
 333                         return false;
 334
 335                 offset += RT5514_SPI_BUF_LEN;
 336         }
 337
 338         for (i = 0; i < len; i += 8) {
 339                 write_buf[0] = rxbuf[i + 0];
 340                 write_buf[1] = rxbuf[i + 1];
 341                 write_buf[2] = rxbuf[i + 2];
 342                 write_buf[3] = rxbuf[i + 3];
 343                 write_buf[4] = rxbuf[i + 4];
 344                 write_buf[5] = rxbuf[i + 5];
 345                 write_buf[6] = rxbuf[i + 6];
 346                 write_buf[7] = rxbuf[i + 7];
 347
 348                 rxbuf[i + 0] = write_buf[7];
 349                 rxbuf[i + 1] = write_buf[6];
 350                 rxbuf[i + 2] = write_buf[5];
 351                 rxbuf[i + 3] = write_buf[4];
 352                 rxbuf[i + 4] = write_buf[3];
 353                 rxbuf[i + 5] = write_buf[2];
 354                 rxbuf[i + 6] = write_buf[1];
 355                 rxbuf[i + 7] = write_buf[0];
 356         }
 357
 358         return true;
 359 }
 360
 361 /**
 362  * rt5514_spi_burst_write - Write data to SPI by rt5514 address.
 363  * @addr: Start address.
 364  * @txbuf: Data Buffer for writng.
 365  * @len: Data length, it must be a multiple of 8.
 366  *
 367  *
 368  * Returns true for success.
 369  */
 370 int rt5514_spi_burst_write(u32 addr, const u8 *txbuf, size_t len)
 371 {
 372         u8 spi_cmd = RT5514_SPI_CMD_BURST_WRITE;
 373         u8 *write_buf;
 374         unsigned int i, end, offset = 0;
 375
 376         write_buf = kmalloc(RT5514_SPI_BUF_LEN + 6, GFP_KERNEL);
 377
 378         if (write_buf == NULL)
 379                 return -ENOMEM;
 380
 381         while (offset < len) {
 382                 if (offset + RT5514_SPI_BUF_LEN <= len)
 383                         end = RT5514_SPI_BUF_LEN;
 384                 else
 385                         end = len % RT5514_SPI_BUF_LEN;
 386
 387                 write_buf[0] = spi_cmd;
 388                 write_buf[1] = ((addr + offset) & 0xff000000) >> 24;
 389                 write_buf[2] = ((addr + offset) & 0x00ff0000) >> 16;
 390                 write_buf[3] = ((addr + offset) & 0x0000ff00) >> 8;
 391                 write_buf[4] = ((addr + offset) & 0x000000ff) >> 0;
 392
 393                 for (i = 0; i < end; i += 8) {
 394                         write_buf[i + 12] = txbuf[offset + i + 0];
 395                         write_buf[i + 11] = txbuf[offset + i + 1];
 396                         write_buf[i + 10] = txbuf[offset + i + 2];
 397                         write_buf[i +  9] = txbuf[offset + i + 3];
 398                         write_buf[i +  8] = txbuf[offset + i + 4];
 399                         write_buf[i +  7] = txbuf[offset + i + 5];
 400                         write_buf[i +  6] = txbuf[offset + i + 6];
 401                         write_buf[i +  5] = txbuf[offset + i + 7];
 402                 }
 403
 404                 write_buf[end + 5] = spi_cmd;
 405
 406                 spi_write(rt5514_spi, write_buf, end + 6);
 407
 408                 offset += RT5514_SPI_BUF_LEN;
 409         }
 410
 411         kfree(write_buf);
 412
 413         return 0;
 414 }
 415 EXPORT_SYMBOL_GPL(rt5514_spi_burst_write);
 416
 417 static int rt5514_spi_probe(struct spi_device *spi)
 418 {
 419         int ret;
 420
 421         rt5514_spi = spi;
 422
 423         ret = devm_snd_soc_register_platform(&spi->dev, &rt5514_spi_platform);
 424         if (ret < 0) {
 425                 dev_err(&spi->dev, "Failed to register platform.\n");
 426                 return ret;
 427         }
 428
 429         ret = devm_snd_soc_register_component(&spi->dev,
 430                                               &rt5514_spi_dai_component,
 431                                               &rt5514_spi_dai, 1);
 432         if (ret < 0) {
 433                 dev_err(&spi->dev, "Failed to register component.\n");
 434                 return ret;
 435         }
 436
 437         return 0;
 438 }
 439
 440 static const struct of_device_id rt5514_of_match[] = {
 441         { .compatible = "realtek,rt5514", },
 442         {},
 443 };
 444 MODULE_DEVICE_TABLE(of, rt5514_of_match);
 445
 446 static struct spi_driver rt5514_spi_driver = {
 447         .driver = {
 448                 .name = "rt5514",
 449                 .of_match_table = of_match_ptr(rt5514_of_match),
 450         },
 451         .probe = rt5514_spi_probe,
 452 };
 453 module_spi_driver(rt5514_spi_driver);
 454
 455 MODULE_DESCRIPTION("RT5514 SPI driver");
 456 MODULE_AUTHOR("Oder Chiou <oder_chiou@realtek.com>");
 457 MODULE_LICENSE("GPL v2");