Merge remote-tracking branches 'asoc/topic/wm8753', 'asoc/topic/wm8770', 'asoc/topic...
[linux-block.git] / sound / soc / codecs / rt5514-spi.c
CommitLineData
6eebf35b
OC
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>
6eebf35b 23#include <linux/uaccess.h>
6eebf35b
OC
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
9fe3b2ba
KM
38#define DRV_NAME "rt5514-spi"
39
6eebf35b
OC
40static struct spi_device *rt5514_spi;
41
42struct 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;
173f4612 48 size_t buf_size, get_size, dma_offset;
6eebf35b
OC
49};
50
51static 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
65static 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
77static 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);
b63d4d13 81 struct snd_pcm_runtime *runtime;
6eebf35b 82 size_t period_bytes, truncated_bytes = 0;
173f4612 83 unsigned int cur_wp, remain_data;
84 u8 buf[8];
6eebf35b
OC
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
b63d4d13 92 runtime = rt5514_dsp->substream->runtime;
6eebf35b
OC
93 period_bytes = snd_pcm_lib_period_bytes(rt5514_dsp->substream);
94
173f4612 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 }
6eebf35b
OC
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
173f4612 133 rt5514_dsp->buf_rp = rt5514_dsp->buf_base + period_bytes -
134 truncated_bytes;
6eebf35b
OC
135 }
136
173f4612 137 rt5514_dsp->get_size += period_bytes;
6eebf35b
OC
138 rt5514_dsp->dma_offset += period_bytes;
139 if (rt5514_dsp->dma_offset >= runtime->dma_bytes)
140 rt5514_dsp->dma_offset = 0;
141
6eebf35b
OC
142 snd_pcm_period_elapsed(rt5514_dsp->substream);
143
173f4612 144 schedule_delayed_work(&rt5514_dsp->copy_work, 5);
145
6eebf35b
OC
146done:
147 mutex_unlock(&rt5514_dsp->dma_lock);
148}
149
659178f5 150static void rt5514_schedule_copy(struct rt5514_dsp *rt5514_dsp)
173f4612 151{
c4a71ff7 152 size_t period_bytes;
173f4612 153 u8 buf[8];
154
c4a71ff7
OC
155 if (!rt5514_dsp->substream)
156 return;
157
158 period_bytes = snd_pcm_lib_period_bytes(rt5514_dsp->substream);
173f4612 159 rt5514_dsp->get_size = 0;
173f4612 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
818010da 181 if (rt5514_dsp->buf_rp % 8)
182 rt5514_dsp->buf_rp = (rt5514_dsp->buf_rp / 8) * 8;
183
173f4612 184 rt5514_dsp->buf_size = rt5514_dsp->buf_limit - rt5514_dsp->buf_base;
185
c4a71ff7
OC
186 if (rt5514_dsp->buf_size % period_bytes)
187 rt5514_dsp->buf_size = (rt5514_dsp->buf_size / period_bytes) *
188 period_bytes;
189
818010da 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);
659178f5
HYC
193}
194
195static irqreturn_t rt5514_spi_irq(int irq, void *data)
196{
197 struct rt5514_dsp *rt5514_dsp = data;
198
199 rt5514_schedule_copy(rt5514_dsp);
173f4612 200
201 return IRQ_HANDLED;
202}
203
6eebf35b
OC
204/* PCM for streaming audio from the DSP buffer */
205static 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
212static 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;
9fe3b2ba 216 struct snd_soc_component *component = snd_soc_rtdcom_lookup(rtd, DRV_NAME);
6eebf35b 217 struct rt5514_dsp *rt5514_dsp =
9fe3b2ba 218 snd_soc_component_get_drvdata(component);
6eebf35b 219 int ret;
659178f5 220 u8 buf[8];
6eebf35b
OC
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;
b56bff43 226 rt5514_dsp->dma_offset = 0;
659178f5
HYC
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
6eebf35b
OC
233 mutex_unlock(&rt5514_dsp->dma_lock);
234
235 return ret;
236}
237
238static int rt5514_spi_hw_free(struct snd_pcm_substream *substream)
239{
240 struct snd_soc_pcm_runtime *rtd = substream->private_data;
9fe3b2ba 241 struct snd_soc_component *component = snd_soc_rtdcom_lookup(rtd, DRV_NAME);
6eebf35b 242 struct rt5514_dsp *rt5514_dsp =
9fe3b2ba 243 snd_soc_component_get_drvdata(component);
6eebf35b
OC
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
6eebf35b
OC
254static 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;
9fe3b2ba 259 struct snd_soc_component *component = snd_soc_rtdcom_lookup(rtd, DRV_NAME);
6eebf35b 260 struct rt5514_dsp *rt5514_dsp =
9fe3b2ba 261 snd_soc_component_get_drvdata(component);
6eebf35b
OC
262
263 return bytes_to_frames(runtime, rt5514_dsp->dma_offset);
264}
265
115c7254 266static const struct snd_pcm_ops rt5514_spi_pcm_ops = {
6eebf35b
OC
267 .open = rt5514_spi_pcm_open,
268 .hw_params = rt5514_spi_hw_params,
269 .hw_free = rt5514_spi_hw_free,
6eebf35b
OC
270 .pointer = rt5514_spi_pcm_pointer,
271 .mmap = snd_pcm_lib_mmap_vmalloc,
272 .page = snd_pcm_lib_get_vmalloc_page,
273};
274
9fe3b2ba 275static int rt5514_spi_pcm_probe(struct snd_soc_component *component)
6eebf35b
OC
276{
277 struct rt5514_dsp *rt5514_dsp;
173f4612 278 int ret;
6eebf35b 279
9fe3b2ba 280 rt5514_dsp = devm_kzalloc(component->dev, sizeof(*rt5514_dsp),
6eebf35b
OC
281 GFP_KERNEL);
282
283 rt5514_dsp->dev = &rt5514_spi->dev;
284 mutex_init(&rt5514_dsp->dma_lock);
285 INIT_DELAYED_WORK(&rt5514_dsp->copy_work, rt5514_spi_copy_work);
9fe3b2ba 286 snd_soc_component_set_drvdata(component, rt5514_dsp);
6eebf35b 287
173f4612 288 if (rt5514_spi->irq) {
289 ret = devm_request_threaded_irq(&rt5514_spi->dev,
290 rt5514_spi->irq, NULL, rt5514_spi_irq,
291 IRQF_TRIGGER_RISING | IRQF_ONESHOT, "rt5514-spi",
292 rt5514_dsp);
293 if (ret)
294 dev_err(&rt5514_spi->dev,
295 "%s Failed to reguest IRQ: %d\n", __func__,
296 ret);
20220945
BN
297 else
298 device_init_wakeup(rt5514_dsp->dev, true);
173f4612 299 }
300
6eebf35b
OC
301 return 0;
302}
303
9fe3b2ba
KM
304static const struct snd_soc_component_driver rt5514_spi_component = {
305 .name = DRV_NAME,
6eebf35b
OC
306 .probe = rt5514_spi_pcm_probe,
307 .ops = &rt5514_spi_pcm_ops,
308};
309
6eebf35b
OC
310/**
311 * rt5514_spi_burst_read - Read data from SPI by rt5514 address.
312 * @addr: Start address.
313 * @rxbuf: Data Buffer for reading.
314 * @len: Data length, it must be a multiple of 8.
315 *
316 *
317 * Returns true for success.
318 */
319int rt5514_spi_burst_read(unsigned int addr, u8 *rxbuf, size_t len)
320{
321 u8 spi_cmd = RT5514_SPI_CMD_BURST_READ;
322 int status;
323 u8 write_buf[8];
324 unsigned int i, end, offset = 0;
325
326 struct spi_message message;
327 struct spi_transfer x[3];
328
329 while (offset < len) {
330 if (offset + RT5514_SPI_BUF_LEN <= len)
331 end = RT5514_SPI_BUF_LEN;
332 else
333 end = len % RT5514_SPI_BUF_LEN;
334
335 write_buf[0] = spi_cmd;
336 write_buf[1] = ((addr + offset) & 0xff000000) >> 24;
337 write_buf[2] = ((addr + offset) & 0x00ff0000) >> 16;
338 write_buf[3] = ((addr + offset) & 0x0000ff00) >> 8;
339 write_buf[4] = ((addr + offset) & 0x000000ff) >> 0;
340
341 spi_message_init(&message);
342 memset(x, 0, sizeof(x));
343
344 x[0].len = 5;
345 x[0].tx_buf = write_buf;
346 spi_message_add_tail(&x[0], &message);
347
348 x[1].len = 4;
349 x[1].tx_buf = write_buf;
350 spi_message_add_tail(&x[1], &message);
351
352 x[2].len = end;
353 x[2].rx_buf = rxbuf + offset;
354 spi_message_add_tail(&x[2], &message);
355
356 status = spi_sync(rt5514_spi, &message);
357
358 if (status)
359 return false;
360
361 offset += RT5514_SPI_BUF_LEN;
362 }
363
364 for (i = 0; i < len; i += 8) {
365 write_buf[0] = rxbuf[i + 0];
366 write_buf[1] = rxbuf[i + 1];
367 write_buf[2] = rxbuf[i + 2];
368 write_buf[3] = rxbuf[i + 3];
369 write_buf[4] = rxbuf[i + 4];
370 write_buf[5] = rxbuf[i + 5];
371 write_buf[6] = rxbuf[i + 6];
372 write_buf[7] = rxbuf[i + 7];
373
374 rxbuf[i + 0] = write_buf[7];
375 rxbuf[i + 1] = write_buf[6];
376 rxbuf[i + 2] = write_buf[5];
377 rxbuf[i + 3] = write_buf[4];
378 rxbuf[i + 4] = write_buf[3];
379 rxbuf[i + 5] = write_buf[2];
380 rxbuf[i + 6] = write_buf[1];
381 rxbuf[i + 7] = write_buf[0];
382 }
383
384 return true;
385}
fc9cab05 386EXPORT_SYMBOL_GPL(rt5514_spi_burst_read);
6eebf35b
OC
387
388/**
389 * rt5514_spi_burst_write - Write data to SPI by rt5514 address.
390 * @addr: Start address.
391 * @txbuf: Data Buffer for writng.
392 * @len: Data length, it must be a multiple of 8.
393 *
394 *
395 * Returns true for success.
396 */
397int rt5514_spi_burst_write(u32 addr, const u8 *txbuf, size_t len)
398{
399 u8 spi_cmd = RT5514_SPI_CMD_BURST_WRITE;
400 u8 *write_buf;
401 unsigned int i, end, offset = 0;
402
403 write_buf = kmalloc(RT5514_SPI_BUF_LEN + 6, GFP_KERNEL);
404
405 if (write_buf == NULL)
406 return -ENOMEM;
407
408 while (offset < len) {
409 if (offset + RT5514_SPI_BUF_LEN <= len)
410 end = RT5514_SPI_BUF_LEN;
411 else
412 end = len % RT5514_SPI_BUF_LEN;
413
414 write_buf[0] = spi_cmd;
415 write_buf[1] = ((addr + offset) & 0xff000000) >> 24;
416 write_buf[2] = ((addr + offset) & 0x00ff0000) >> 16;
417 write_buf[3] = ((addr + offset) & 0x0000ff00) >> 8;
418 write_buf[4] = ((addr + offset) & 0x000000ff) >> 0;
419
420 for (i = 0; i < end; i += 8) {
421 write_buf[i + 12] = txbuf[offset + i + 0];
422 write_buf[i + 11] = txbuf[offset + i + 1];
423 write_buf[i + 10] = txbuf[offset + i + 2];
424 write_buf[i + 9] = txbuf[offset + i + 3];
425 write_buf[i + 8] = txbuf[offset + i + 4];
426 write_buf[i + 7] = txbuf[offset + i + 5];
427 write_buf[i + 6] = txbuf[offset + i + 6];
428 write_buf[i + 5] = txbuf[offset + i + 7];
429 }
430
431 write_buf[end + 5] = spi_cmd;
432
433 spi_write(rt5514_spi, write_buf, end + 6);
434
435 offset += RT5514_SPI_BUF_LEN;
436 }
437
438 kfree(write_buf);
439
440 return 0;
441}
442EXPORT_SYMBOL_GPL(rt5514_spi_burst_write);
443
444static int rt5514_spi_probe(struct spi_device *spi)
445{
446 int ret;
447
448 rt5514_spi = spi;
449
e9802c57 450 ret = devm_snd_soc_register_component(&spi->dev,
9fe3b2ba 451 &rt5514_spi_component,
e9802c57 452 &rt5514_spi_dai, 1);
6eebf35b
OC
453 if (ret < 0) {
454 dev_err(&spi->dev, "Failed to register component.\n");
e9802c57 455 return ret;
6eebf35b
OC
456 }
457
58f1c07d 458 return 0;
459}
460
7e6358ec 461static int __maybe_unused rt5514_suspend(struct device *dev)
58f1c07d 462{
463 int irq = to_spi_device(dev)->irq;
464
465 if (device_may_wakeup(dev))
466 enable_irq_wake(irq);
467
6eebf35b
OC
468 return 0;
469}
470
7e6358ec 471static int __maybe_unused rt5514_resume(struct device *dev)
58f1c07d 472{
04e8262a 473 struct snd_soc_component *component = snd_soc_lookup_component(dev, DRV_NAME);
e9c50aa6 474 struct rt5514_dsp *rt5514_dsp =
04e8262a 475 snd_soc_component_get_drvdata(component);
58f1c07d 476 int irq = to_spi_device(dev)->irq;
e9c50aa6 477 u8 buf[8];
58f1c07d 478
479 if (device_may_wakeup(dev))
480 disable_irq_wake(irq);
481
346cccf8 482 if (rt5514_dsp) {
483 if (rt5514_dsp->substream) {
484 rt5514_spi_burst_read(RT5514_IRQ_CTRL, (u8 *)&buf,
485 sizeof(buf));
486 if (buf[0] & RT5514_IRQ_STATUS_BIT)
487 rt5514_schedule_copy(rt5514_dsp);
488 }
e9c50aa6 489 }
490
58f1c07d 491 return 0;
492}
493
494static const struct dev_pm_ops rt5514_pm_ops = {
495 SET_SYSTEM_SLEEP_PM_OPS(rt5514_suspend, rt5514_resume)
496};
497
6eebf35b
OC
498static const struct of_device_id rt5514_of_match[] = {
499 { .compatible = "realtek,rt5514", },
500 {},
501};
502MODULE_DEVICE_TABLE(of, rt5514_of_match);
503
504static struct spi_driver rt5514_spi_driver = {
505 .driver = {
506 .name = "rt5514",
58f1c07d 507 .pm = &rt5514_pm_ops,
6eebf35b
OC
508 .of_match_table = of_match_ptr(rt5514_of_match),
509 },
510 .probe = rt5514_spi_probe,
6eebf35b
OC
511};
512module_spi_driver(rt5514_spi_driver);
513
514MODULE_DESCRIPTION("RT5514 SPI driver");
515MODULE_AUTHOR("Oder Chiou <oder_chiou@realtek.com>");
516MODULE_LICENSE("GPL v2");