2 * rt5514-spi.c -- RT5514 SPI driver
4 * Copyright 2015 Realtek Semiconductor Corp.
5 * Author: Oder Chiou <oder_chiou@realtek.com>
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.
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>
36 #include "rt5514-spi.h"
38 static struct spi_device *rt5514_spi;
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;
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,
60 .buffer_bytes_max = 0x20000,
63 static struct snd_soc_dai_driver rt5514_spi_dai = {
64 .name = "rt5514-dsp-cpu-dai",
67 .stream_name = "DSP Capture",
70 .rates = SNDRV_PCM_RATE_16000,
71 .formats = SNDRV_PCM_FMTBIT_S16_LE,
75 static void rt5514_spi_copy_work(struct work_struct *work)
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;
84 mutex_lock(&rt5514_dsp->dma_lock);
85 if (!rt5514_dsp->substream) {
86 dev_err(rt5514_dsp->dev, "No pcm substream\n");
90 runtime = rt5514_dsp->substream->runtime;
91 period_bytes = snd_pcm_lib_period_bytes(rt5514_dsp->substream);
93 if (rt5514_dsp->get_size >= rt5514_dsp->buf_size) {
94 rt5514_spi_burst_read(RT5514_BUFFER_VOICE_WP, (u8 *)&buf,
96 cur_wp = buf[0] | buf[1] << 8 | buf[2] << 16 |
99 if (cur_wp >= rt5514_dsp->buf_rp)
100 remain_data = (cur_wp - rt5514_dsp->buf_rp);
103 (rt5514_dsp->buf_limit - rt5514_dsp->buf_rp) +
104 (cur_wp - rt5514_dsp->buf_base);
106 if (remain_data < period_bytes) {
107 schedule_delayed_work(&rt5514_dsp->copy_work, 5);
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,
117 if (rt5514_dsp->buf_rp + period_bytes == rt5514_dsp->buf_limit)
118 rt5514_dsp->buf_rp = rt5514_dsp->buf_base;
120 rt5514_dsp->buf_rp += period_bytes;
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,
127 rt5514_spi_burst_read(rt5514_dsp->buf_base,
128 runtime->dma_area + rt5514_dsp->dma_offset +
129 truncated_bytes, period_bytes - truncated_bytes);
131 rt5514_dsp->buf_rp = rt5514_dsp->buf_base + period_bytes -
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;
140 snd_pcm_period_elapsed(rt5514_dsp->substream);
142 schedule_delayed_work(&rt5514_dsp->copy_work, 5);
145 mutex_unlock(&rt5514_dsp->dma_lock);
148 static void rt5514_schedule_copy(struct rt5514_dsp *rt5514_dsp)
152 rt5514_dsp->get_size = 0;
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.
159 rt5514_spi_burst_read(RT5514_BUFFER_VOICE_BASE, (u8 *)&buf,
161 rt5514_dsp->buf_base = buf[0] | buf[1] << 8 | buf[2] << 16 |
164 rt5514_spi_burst_read(RT5514_BUFFER_VOICE_LIMIT, (u8 *)&buf,
166 rt5514_dsp->buf_limit = buf[0] | buf[1] << 8 | buf[2] << 16 |
169 rt5514_spi_burst_read(RT5514_BUFFER_VOICE_WP, (u8 *)&buf,
171 rt5514_dsp->buf_rp = buf[0] | buf[1] << 8 | buf[2] << 16 |
174 if (rt5514_dsp->buf_rp % 8)
175 rt5514_dsp->buf_rp = (rt5514_dsp->buf_rp / 8) * 8;
177 rt5514_dsp->buf_size = rt5514_dsp->buf_limit - rt5514_dsp->buf_base;
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);
184 static irqreturn_t rt5514_spi_irq(int irq, void *data)
186 struct rt5514_dsp *rt5514_dsp = data;
188 rt5514_schedule_copy(rt5514_dsp);
193 /* PCM for streaming audio from the DSP buffer */
194 static int rt5514_spi_pcm_open(struct snd_pcm_substream *substream)
196 snd_soc_set_runtime_hwparams(substream, &rt5514_spi_pcm_hardware);
201 static int rt5514_spi_hw_params(struct snd_pcm_substream *substream,
202 struct snd_pcm_hw_params *hw_params)
204 struct snd_soc_pcm_runtime *rtd = substream->private_data;
205 struct rt5514_dsp *rt5514_dsp =
206 snd_soc_platform_get_drvdata(rtd->platform);
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;
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);
221 mutex_unlock(&rt5514_dsp->dma_lock);
226 static int rt5514_spi_hw_free(struct snd_pcm_substream *substream)
228 struct snd_soc_pcm_runtime *rtd = substream->private_data;
229 struct rt5514_dsp *rt5514_dsp =
230 snd_soc_platform_get_drvdata(rtd->platform);
232 mutex_lock(&rt5514_dsp->dma_lock);
233 rt5514_dsp->substream = NULL;
234 mutex_unlock(&rt5514_dsp->dma_lock);
236 cancel_delayed_work_sync(&rt5514_dsp->copy_work);
238 return snd_pcm_lib_free_vmalloc_buffer(substream);
241 static snd_pcm_uframes_t rt5514_spi_pcm_pointer(
242 struct snd_pcm_substream *substream)
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);
249 return bytes_to_frames(runtime, rt5514_dsp->dma_offset);
252 static 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,
261 static int rt5514_spi_pcm_probe(struct snd_soc_platform *platform)
263 struct rt5514_dsp *rt5514_dsp;
266 rt5514_dsp = devm_kzalloc(platform->dev, sizeof(*rt5514_dsp),
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);
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",
280 dev_err(&rt5514_spi->dev,
281 "%s Failed to reguest IRQ: %d\n", __func__,
288 static const struct snd_soc_platform_driver rt5514_spi_platform = {
289 .probe = rt5514_spi_pcm_probe,
290 .ops = &rt5514_spi_pcm_ops,
293 static const struct snd_soc_component_driver rt5514_spi_dai_component = {
294 .name = "rt5514-spi-dai",
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.
304 * Returns true for success.
306 int rt5514_spi_burst_read(unsigned int addr, u8 *rxbuf, size_t len)
308 u8 spi_cmd = RT5514_SPI_CMD_BURST_READ;
311 unsigned int i, end, offset = 0;
313 struct spi_message message;
314 struct spi_transfer x[3];
316 while (offset < len) {
317 if (offset + RT5514_SPI_BUF_LEN <= len)
318 end = RT5514_SPI_BUF_LEN;
320 end = len % RT5514_SPI_BUF_LEN;
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;
328 spi_message_init(&message);
329 memset(x, 0, sizeof(x));
332 x[0].tx_buf = write_buf;
333 spi_message_add_tail(&x[0], &message);
336 x[1].tx_buf = write_buf;
337 spi_message_add_tail(&x[1], &message);
340 x[2].rx_buf = rxbuf + offset;
341 spi_message_add_tail(&x[2], &message);
343 status = spi_sync(rt5514_spi, &message);
348 offset += RT5514_SPI_BUF_LEN;
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];
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];
373 EXPORT_SYMBOL_GPL(rt5514_spi_burst_read);
376 * rt5514_spi_burst_write - Write data to SPI by rt5514 address.
377 * @addr: Start address.
378 * @txbuf: Data Buffer for writng.
379 * @len: Data length, it must be a multiple of 8.
382 * Returns true for success.
384 int rt5514_spi_burst_write(u32 addr, const u8 *txbuf, size_t len)
386 u8 spi_cmd = RT5514_SPI_CMD_BURST_WRITE;
388 unsigned int i, end, offset = 0;
390 write_buf = kmalloc(RT5514_SPI_BUF_LEN + 6, GFP_KERNEL);
392 if (write_buf == NULL)
395 while (offset < len) {
396 if (offset + RT5514_SPI_BUF_LEN <= len)
397 end = RT5514_SPI_BUF_LEN;
399 end = len % RT5514_SPI_BUF_LEN;
401 write_buf[0] = spi_cmd;
402 write_buf[1] = ((addr + offset) & 0xff000000) >> 24;
403 write_buf[2] = ((addr + offset) & 0x00ff0000) >> 16;
404 write_buf[3] = ((addr + offset) & 0x0000ff00) >> 8;
405 write_buf[4] = ((addr + offset) & 0x000000ff) >> 0;
407 for (i = 0; i < end; i += 8) {
408 write_buf[i + 12] = txbuf[offset + i + 0];
409 write_buf[i + 11] = txbuf[offset + i + 1];
410 write_buf[i + 10] = txbuf[offset + i + 2];
411 write_buf[i + 9] = txbuf[offset + i + 3];
412 write_buf[i + 8] = txbuf[offset + i + 4];
413 write_buf[i + 7] = txbuf[offset + i + 5];
414 write_buf[i + 6] = txbuf[offset + i + 6];
415 write_buf[i + 5] = txbuf[offset + i + 7];
418 write_buf[end + 5] = spi_cmd;
420 spi_write(rt5514_spi, write_buf, end + 6);
422 offset += RT5514_SPI_BUF_LEN;
429 EXPORT_SYMBOL_GPL(rt5514_spi_burst_write);
431 static int rt5514_spi_probe(struct spi_device *spi)
437 ret = devm_snd_soc_register_platform(&spi->dev, &rt5514_spi_platform);
439 dev_err(&spi->dev, "Failed to register platform.\n");
443 ret = devm_snd_soc_register_component(&spi->dev,
444 &rt5514_spi_dai_component,
447 dev_err(&spi->dev, "Failed to register component.\n");
454 static const struct of_device_id rt5514_of_match[] = {
455 { .compatible = "realtek,rt5514", },
458 MODULE_DEVICE_TABLE(of, rt5514_of_match);
460 static struct spi_driver rt5514_spi_driver = {
463 .of_match_table = of_match_ptr(rt5514_of_match),
465 .probe = rt5514_spi_probe,
467 module_spi_driver(rt5514_spi_driver);
469 MODULE_DESCRIPTION("RT5514 SPI driver");
470 MODULE_AUTHOR("Oder Chiou <oder_chiou@realtek.com>");
471 MODULE_LICENSE("GPL v2");