2
* siu_dai.c - ALSA SoC driver for Renesas SH7343, SH7722 SIU peripheral.
4
* Copyright (C) 2009-2010 Guennadi Liakhovetski <g.liakhovetski@gmx.de>
5
* Copyright (C) 2006 Carlos Munoz <carlos@kenati.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 as published by
9
* the Free Software Foundation; either version 2 of the License, or
10
* (at your option) any later version.
12
* This program is distributed in the hope that it will be useful,
13
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15
* GNU General Public License for more details.
17
* You should have received a copy of the GNU General Public License
18
* along with this program; if not, write to the Free Software
19
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22
#include <linux/delay.h>
23
#include <linux/firmware.h>
24
#include <linux/pm_runtime.h>
25
#include <linux/slab.h>
26
#include <linux/module.h>
28
#include <asm/clock.h>
31
#include <sound/control.h>
32
#include <sound/soc.h>
37
#if defined(CONFIG_CPU_SUBTYPE_SH7722)
38
# define SIU_MAX_VOLUME 0x1000
40
# define SIU_MAX_VOLUME 0x7fff
43
#define PRAM_SIZE 0x2000
44
#define XRAM_SIZE 0x800
45
#define YRAM_SIZE 0x800
47
#define XRAM_OFFSET 0x4000
48
#define YRAM_OFFSET 0x6000
49
#define REG_OFFSET 0xc000
51
#define PLAYBACK_ENABLED 1
52
#define CAPTURE_ENABLED 2
54
#define VOLUME_CAPTURE 0
55
#define VOLUME_PLAYBACK 1
56
#define DFLT_VOLUME_LEVEL 0x08000800
59
* SPDIF is only available on port A and on some SIU implementations it is only
60
* available for input. Due to the lack of hardware to test it, SPDIF is left
61
* disabled in this driver version
71
struct format_flag playback;
72
struct format_flag capture;
75
struct siu_info *siu_i2s_data;
77
static struct port_flag siu_flags[SIU_PORT_NUM] = {
82
.spdif = 0x80000000, /* not on all SIU versions */
96
.spdif = 0, /* impossible - turn off */
102
.spdif = 0, /* impossible - turn off */
108
static void siu_dai_start(struct siu_port *port_info)
110
struct siu_info *info = siu_i2s_data;
111
u32 __iomem *base = info->reg;
113
dev_dbg(port_info->pcm->card->dev, "%s\n", __func__);
115
/* Turn on SIU clock */
116
pm_runtime_get_sync(info->dev);
118
/* Issue software reset to siu */
119
siu_write32(base + SIU_SRCTL, 0);
121
/* Wait for the reset to take effect */
124
port_info->stfifo = 0;
125
port_info->trdat = 0;
127
/* portA, portB, SIU operate */
128
siu_write32(base + SIU_SRCTL, 0x301);
130
/* portA=256fs, portB=256fs */
131
siu_write32(base + SIU_CKCTL, 0x40400000);
133
/* portA's BRG does not divide SIUCKA */
134
siu_write32(base + SIU_BRGASEL, 0);
135
siu_write32(base + SIU_BRRA, 0);
137
/* portB's BRG divides SIUCKB by half */
138
siu_write32(base + SIU_BRGBSEL, 1);
139
siu_write32(base + SIU_BRRB, 0);
141
siu_write32(base + SIU_IFCTL, 0x44440000);
143
/* portA: 32 bit/fs, master; portB: 32 bit/fs, master */
144
siu_write32(base + SIU_SFORM, 0x0c0c0000);
147
* Volume levels: looks like the DSP firmware implements volume controls
148
* differently from what's described in the datasheet
150
siu_write32(base + SIU_SBDVCA, port_info->playback.volume);
151
siu_write32(base + SIU_SBDVCB, port_info->capture.volume);
154
static void siu_dai_stop(struct siu_port *port_info)
156
struct siu_info *info = siu_i2s_data;
157
u32 __iomem *base = info->reg;
159
/* SIU software reset */
160
siu_write32(base + SIU_SRCTL, 0);
162
/* Turn off SIU clock */
163
pm_runtime_put_sync(info->dev);
166
static void siu_dai_spbAselect(struct siu_port *port_info)
168
struct siu_info *info = siu_i2s_data;
169
struct siu_firmware *fw = &info->fw;
170
u32 *ydef = fw->yram0;
179
ydef[0] = (fw->spbpar[idx].ab1a << 16) |
180
(fw->spbpar[idx].ab0a << 8) |
181
(fw->spbpar[idx].dir << 7) | 3;
182
ydef[1] = fw->yram0[1]; /* 0x03000300 */
183
ydef[2] = (16 / 2) << 24;
184
ydef[3] = fw->yram0[3]; /* 0 */
185
ydef[4] = fw->yram0[4]; /* 0 */
186
ydef[7] = fw->spbpar[idx].event;
187
port_info->stfifo |= fw->spbpar[idx].stfifo;
188
port_info->trdat |= fw->spbpar[idx].trdat;
191
static void siu_dai_spbBselect(struct siu_port *port_info)
193
struct siu_info *info = siu_i2s_data;
194
struct siu_firmware *fw = &info->fw;
195
u32 *ydef = fw->yram0;
204
ydef[5] = (fw->spbpar[idx].ab1a << 16) |
205
(fw->spbpar[idx].ab0a << 8) | 1;
206
ydef[6] = fw->spbpar[idx].event;
207
port_info->stfifo |= fw->spbpar[idx].stfifo;
208
port_info->trdat |= fw->spbpar[idx].trdat;
211
static void siu_dai_open(struct siu_stream *siu_stream)
213
struct siu_info *info = siu_i2s_data;
214
u32 __iomem *base = info->reg;
217
srctl = siu_read32(base + SIU_SRCTL);
218
ifctl = siu_read32(base + SIU_IFCTL);
220
switch (info->port_id) {
233
siu_write32(base + SIU_SRCTL, srctl);
234
/* Unmute and configure portA */
235
siu_write32(base + SIU_IFCTL, ifctl);
239
* At the moment only fixed Left-upper, Left-lower, Right-upper, Right-lower
240
* packing is supported
242
static void siu_dai_pcmdatapack(struct siu_stream *siu_stream)
244
struct siu_info *info = siu_i2s_data;
245
u32 __iomem *base = info->reg;
248
dpak = siu_read32(base + SIU_DPAK);
250
switch (info->port_id) {
259
siu_write32(base + SIU_DPAK, dpak);
262
static int siu_dai_spbstart(struct siu_port *port_info)
264
struct siu_info *info = siu_i2s_data;
265
u32 __iomem *base = info->reg;
266
struct siu_firmware *fw = &info->fw;
267
u32 *ydef = fw->yram0;
272
/* Load SPB Program in PRAM */
275
for (cnt = 0; cnt < PRAM0_SIZE; cnt++, add++, ptr++)
276
siu_write32(add, *ptr);
279
add = info->pram + (0x0100 / sizeof(u32));
280
for (cnt = 0; cnt < PRAM1_SIZE; cnt++, add++, ptr++)
281
siu_write32(add, *ptr);
283
/* XRAM initialization */
285
for (cnt = 0; cnt < XRAM0_SIZE + XRAM1_SIZE + XRAM2_SIZE; cnt++, add++)
288
/* YRAM variable area initialization */
290
for (cnt = 0; cnt < YRAM_DEF_SIZE; cnt++, add++)
291
siu_write32(add, ydef[cnt]);
293
/* YRAM FIR coefficient area initialization */
294
add = info->yram + (0x0200 / sizeof(u32));
295
for (cnt = 0; cnt < YRAM_FIR_SIZE; cnt++, add++)
296
siu_write32(add, fw->yram_fir_coeff[cnt]);
298
/* YRAM IIR coefficient area initialization */
299
add = info->yram + (0x0600 / sizeof(u32));
300
for (cnt = 0; cnt < YRAM_IIR_SIZE; cnt++, add++)
303
siu_write32(base + SIU_TRDAT, port_info->trdat);
304
port_info->trdat = 0x0;
307
/* SPB start condition: software */
308
siu_write32(base + SIU_SBACTIV, 0);
310
siu_write32(base + SIU_SBCTL, 0xc0000000);
311
/* Wait for program to halt */
313
while (--cnt && siu_read32(base + SIU_SBCTL) != 0x80000000)
319
/* SPB program start address setting */
320
siu_write32(base + SIU_SBPSET, 0x00400000);
321
/* SPB hardware start(FIFOCTL source) */
322
siu_write32(base + SIU_SBACTIV, 0xc0000000);
327
static void siu_dai_spbstop(struct siu_port *port_info)
329
struct siu_info *info = siu_i2s_data;
330
u32 __iomem *base = info->reg;
332
siu_write32(base + SIU_SBACTIV, 0);
334
siu_write32(base + SIU_SBCTL, 0);
336
port_info->stfifo = 0;
341
/* Playback and capture hardware properties are identical */
342
static struct snd_pcm_hardware siu_dai_pcm_hw = {
343
.info = SNDRV_PCM_INFO_INTERLEAVED,
344
.formats = SNDRV_PCM_FMTBIT_S16,
345
.rates = SNDRV_PCM_RATE_8000_48000,
350
.buffer_bytes_max = SIU_BUFFER_BYTES_MAX,
351
.period_bytes_min = SIU_PERIOD_BYTES_MIN,
352
.period_bytes_max = SIU_PERIOD_BYTES_MAX,
353
.periods_min = SIU_PERIODS_MIN,
354
.periods_max = SIU_PERIODS_MAX,
357
static int siu_dai_info_volume(struct snd_kcontrol *kctrl,
358
struct snd_ctl_elem_info *uinfo)
360
struct siu_port *port_info = snd_kcontrol_chip(kctrl);
362
dev_dbg(port_info->pcm->card->dev, "%s\n", __func__);
364
uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
366
uinfo->value.integer.min = 0;
367
uinfo->value.integer.max = SIU_MAX_VOLUME;
372
static int siu_dai_get_volume(struct snd_kcontrol *kctrl,
373
struct snd_ctl_elem_value *ucontrol)
375
struct siu_port *port_info = snd_kcontrol_chip(kctrl);
376
struct device *dev = port_info->pcm->card->dev;
379
dev_dbg(dev, "%s\n", __func__);
381
switch (kctrl->private_value) {
382
case VOLUME_PLAYBACK:
383
/* Playback is always on port 0 */
384
vol = port_info->playback.volume;
385
ucontrol->value.integer.value[0] = vol & 0xffff;
386
ucontrol->value.integer.value[1] = vol >> 16 & 0xffff;
389
/* Capture is always on port 1 */
390
vol = port_info->capture.volume;
391
ucontrol->value.integer.value[0] = vol & 0xffff;
392
ucontrol->value.integer.value[1] = vol >> 16 & 0xffff;
395
dev_err(dev, "%s() invalid private_value=%ld\n",
396
__func__, kctrl->private_value);
403
static int siu_dai_put_volume(struct snd_kcontrol *kctrl,
404
struct snd_ctl_elem_value *ucontrol)
406
struct siu_port *port_info = snd_kcontrol_chip(kctrl);
407
struct device *dev = port_info->pcm->card->dev;
408
struct siu_info *info = siu_i2s_data;
409
u32 __iomem *base = info->reg;
413
dev_dbg(dev, "%s\n", __func__);
415
if (ucontrol->value.integer.value[0] < 0 ||
416
ucontrol->value.integer.value[0] > SIU_MAX_VOLUME ||
417
ucontrol->value.integer.value[1] < 0 ||
418
ucontrol->value.integer.value[1] > SIU_MAX_VOLUME)
421
new_vol = ucontrol->value.integer.value[0] |
422
ucontrol->value.integer.value[1] << 16;
424
/* See comment above - DSP firmware implementation */
425
switch (kctrl->private_value) {
426
case VOLUME_PLAYBACK:
427
/* Playback is always on port 0 */
428
cur_vol = port_info->playback.volume;
429
siu_write32(base + SIU_SBDVCA, new_vol);
430
port_info->playback.volume = new_vol;
433
/* Capture is always on port 1 */
434
cur_vol = port_info->capture.volume;
435
siu_write32(base + SIU_SBDVCB, new_vol);
436
port_info->capture.volume = new_vol;
439
dev_err(dev, "%s() invalid private_value=%ld\n",
440
__func__, kctrl->private_value);
444
if (cur_vol != new_vol)
450
static struct snd_kcontrol_new playback_controls = {
451
.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
452
.name = "PCM Playback Volume",
454
.info = siu_dai_info_volume,
455
.get = siu_dai_get_volume,
456
.put = siu_dai_put_volume,
457
.private_value = VOLUME_PLAYBACK,
460
static struct snd_kcontrol_new capture_controls = {
461
.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
462
.name = "PCM Capture Volume",
464
.info = siu_dai_info_volume,
465
.get = siu_dai_get_volume,
466
.put = siu_dai_put_volume,
467
.private_value = VOLUME_CAPTURE,
470
int siu_init_port(int port, struct siu_port **port_info, struct snd_card *card)
472
struct device *dev = card->dev;
473
struct snd_kcontrol *kctrl;
476
*port_info = kzalloc(sizeof(**port_info), GFP_KERNEL);
480
dev_dbg(dev, "%s: port #%d@%p\n", __func__, port, *port_info);
482
(*port_info)->playback.volume = DFLT_VOLUME_LEVEL;
483
(*port_info)->capture.volume = DFLT_VOLUME_LEVEL;
486
* Add mixer support. The SPB is used to change the volume. Both
487
* ports use the same SPB. Therefore, we only register one
488
* control instance since it will be used by both channels.
489
* In error case we continue without controls.
491
kctrl = snd_ctl_new1(&playback_controls, *port_info);
492
ret = snd_ctl_add(card, kctrl);
495
"failed to add playback controls %p port=%d err=%d\n",
498
kctrl = snd_ctl_new1(&capture_controls, *port_info);
499
ret = snd_ctl_add(card, kctrl);
502
"failed to add capture controls %p port=%d err=%d\n",
508
void siu_free_port(struct siu_port *port_info)
513
static int siu_dai_startup(struct snd_pcm_substream *substream,
514
struct snd_soc_dai *dai)
516
struct siu_info *info = snd_soc_dai_get_drvdata(dai);
517
struct snd_pcm_runtime *rt = substream->runtime;
518
struct siu_port *port_info = siu_port_info(substream);
521
dev_dbg(substream->pcm->card->dev, "%s: port=%d@%p\n", __func__,
522
info->port_id, port_info);
524
snd_soc_set_runtime_hwparams(substream, &siu_dai_pcm_hw);
526
ret = snd_pcm_hw_constraint_integer(rt, SNDRV_PCM_HW_PARAM_PERIODS);
527
if (unlikely(ret < 0))
530
siu_dai_start(port_info);
535
static void siu_dai_shutdown(struct snd_pcm_substream *substream,
536
struct snd_soc_dai *dai)
538
struct siu_info *info = snd_soc_dai_get_drvdata(dai);
539
struct siu_port *port_info = siu_port_info(substream);
541
dev_dbg(substream->pcm->card->dev, "%s: port=%d@%p\n", __func__,
542
info->port_id, port_info);
544
if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
545
port_info->play_cap &= ~PLAYBACK_ENABLED;
547
port_info->play_cap &= ~CAPTURE_ENABLED;
549
/* Stop the siu if the other stream is not using it */
550
if (!port_info->play_cap) {
551
/* during stmread or stmwrite ? */
552
BUG_ON(port_info->playback.rw_flg || port_info->capture.rw_flg);
553
siu_dai_spbstop(port_info);
554
siu_dai_stop(port_info);
558
/* PCM part of siu_dai_playback_prepare() / siu_dai_capture_prepare() */
559
static int siu_dai_prepare(struct snd_pcm_substream *substream,
560
struct snd_soc_dai *dai)
562
struct siu_info *info = snd_soc_dai_get_drvdata(dai);
563
struct snd_pcm_runtime *rt = substream->runtime;
564
struct siu_port *port_info = siu_port_info(substream);
565
struct siu_stream *siu_stream;
568
dev_dbg(substream->pcm->card->dev,
569
"%s: port %d, active streams %lx, %d channels\n",
570
__func__, info->port_id, port_info->play_cap, rt->channels);
572
if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
573
self = PLAYBACK_ENABLED;
574
siu_stream = &port_info->playback;
576
self = CAPTURE_ENABLED;
577
siu_stream = &port_info->capture;
580
/* Set up the siu if not already done */
581
if (!port_info->play_cap) {
582
siu_stream->rw_flg = 0; /* stream-data transfer flag */
584
siu_dai_spbAselect(port_info);
585
siu_dai_spbBselect(port_info);
587
siu_dai_open(siu_stream);
589
siu_dai_pcmdatapack(siu_stream);
591
ret = siu_dai_spbstart(port_info);
598
port_info->play_cap |= self;
605
* SIU can set bus format to I2S / PCM / SPDIF independently for playback and
606
* capture, however, the current API sets the bus format globally for a DAI.
608
static int siu_dai_set_fmt(struct snd_soc_dai *dai,
611
struct siu_info *info = snd_soc_dai_get_drvdata(dai);
612
u32 __iomem *base = info->reg;
615
dev_dbg(dai->dev, "%s: fmt 0x%x on port %d\n",
616
__func__, fmt, info->port_id);
618
if (info->port_id < 0)
621
/* Here select between I2S / PCM / SPDIF */
622
switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
623
case SND_SOC_DAIFMT_I2S:
624
ifctl = siu_flags[info->port_id].playback.i2s |
625
siu_flags[info->port_id].capture.i2s;
627
case SND_SOC_DAIFMT_LEFT_J:
628
ifctl = siu_flags[info->port_id].playback.pcm |
629
siu_flags[info->port_id].capture.pcm;
631
/* SPDIF disabled - see comment at the top */
636
ifctl |= ~(siu_flags[info->port_id].playback.mask |
637
siu_flags[info->port_id].capture.mask) &
638
siu_read32(base + SIU_IFCTL);
639
siu_write32(base + SIU_IFCTL, ifctl);
644
static int siu_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
645
unsigned int freq, int dir)
647
struct clk *siu_clk, *parent_clk;
648
char *siu_name, *parent_name;
651
if (dir != SND_SOC_CLOCK_IN)
654
dev_dbg(dai->dev, "%s: using clock %d\n", __func__, clk_id);
658
siu_name = "siua_clk";
659
parent_name = "pll_clk";
662
siu_name = "siua_clk";
663
parent_name = "siumcka_clk";
666
siu_name = "siub_clk";
667
parent_name = "pll_clk";
670
siu_name = "siub_clk";
671
parent_name = "siumckb_clk";
677
siu_clk = clk_get(dai->dev, siu_name);
678
if (IS_ERR(siu_clk)) {
679
dev_err(dai->dev, "%s: cannot get a SIU clock: %ld\n", __func__,
681
return PTR_ERR(siu_clk);
684
parent_clk = clk_get(dai->dev, parent_name);
685
if (IS_ERR(parent_clk)) {
686
ret = PTR_ERR(parent_clk);
687
dev_err(dai->dev, "cannot get a SIU clock parent: %d\n", ret);
691
ret = clk_set_parent(siu_clk, parent_clk);
693
dev_err(dai->dev, "cannot reparent the SIU clock: %d\n", ret);
697
ret = clk_set_rate(siu_clk, freq);
699
dev_err(dai->dev, "cannot set SIU clock rate: %d\n", ret);
701
/* TODO: when clkdev gets reference counting we'll move these to siu_dai_shutdown() */
710
static struct snd_soc_dai_ops siu_dai_ops = {
711
.startup = siu_dai_startup,
712
.shutdown = siu_dai_shutdown,
713
.prepare = siu_dai_prepare,
714
.set_sysclk = siu_dai_set_sysclk,
715
.set_fmt = siu_dai_set_fmt,
718
static struct snd_soc_dai_driver siu_i2s_dai = {
719
.name = "siu-i2s-dai",
723
.formats = SNDRV_PCM_FMTBIT_S16,
724
.rates = SNDRV_PCM_RATE_8000_48000,
729
.formats = SNDRV_PCM_FMTBIT_S16,
730
.rates = SNDRV_PCM_RATE_8000_48000,
735
static int __devinit siu_probe(struct platform_device *pdev)
737
const struct firmware *fw_entry;
738
struct resource *res, *region;
739
struct siu_info *info;
742
info = kmalloc(sizeof(*info), GFP_KERNEL);
746
info->dev = &pdev->dev;
748
ret = request_firmware(&fw_entry, "siu_spb.bin", &pdev->dev);
753
* Loaded firmware is "const" - read only, but we have to modify it in
754
* snd_siu_sh7343_spbAselect() and snd_siu_sh7343_spbBselect()
756
memcpy(&info->fw, fw_entry->data, fw_entry->size);
758
release_firmware(fw_entry);
760
res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
766
region = request_mem_region(res->start, resource_size(res),
769
dev_err(&pdev->dev, "SIU region already claimed\n");
775
info->pram = ioremap(res->start, PRAM_SIZE);
778
info->xram = ioremap(res->start + XRAM_OFFSET, XRAM_SIZE);
781
info->yram = ioremap(res->start + YRAM_OFFSET, YRAM_SIZE);
784
info->reg = ioremap(res->start + REG_OFFSET, resource_size(res) -
789
dev_set_drvdata(&pdev->dev, info);
791
/* register using ARRAY version so we can keep dai name */
792
ret = snd_soc_register_dais(&pdev->dev, &siu_i2s_dai, 1);
796
ret = snd_soc_register_platform(&pdev->dev, &siu_platform);
800
pm_runtime_enable(&pdev->dev);
805
snd_soc_unregister_dai(&pdev->dev);
815
release_mem_region(res->start, resource_size(res));
824
static int __devexit siu_remove(struct platform_device *pdev)
826
struct siu_info *info = dev_get_drvdata(&pdev->dev);
827
struct resource *res;
829
pm_runtime_disable(&pdev->dev);
831
snd_soc_unregister_platform(&pdev->dev);
832
snd_soc_unregister_dai(&pdev->dev);
838
res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
840
release_mem_region(res->start, resource_size(res));
846
static struct platform_driver siu_driver = {
848
.owner = THIS_MODULE,
849
.name = "siu-pcm-audio",
852
.remove = __devexit_p(siu_remove),
855
static int __init siu_init(void)
857
return platform_driver_register(&siu_driver);
860
static void __exit siu_exit(void)
862
platform_driver_unregister(&siu_driver);
865
module_init(siu_init)
866
module_exit(siu_exit)
868
MODULE_AUTHOR("Carlos Munoz <carlos@kenati.com>");
869
MODULE_DESCRIPTION("ALSA SoC SH7722 SIU driver");
870
MODULE_LICENSE("GPL");