1 // SPDX-License-Identifier: GPL-2.0-only
3 * Intel SST Haswell/Broadwell PCM Support
5 * Copyright (C) 2013, Intel Corporation. All rights reserved.
8 #include <linux/module.h>
9 #include <linux/dma-mapping.h>
10 #include <linux/slab.h>
11 #include <linux/delay.h>
12 #include <linux/pm_runtime.h>
14 #include <asm/pgtable.h>
15 #include <sound/core.h>
16 #include <sound/pcm.h>
17 #include <sound/pcm_params.h>
18 #include <sound/dmaengine_pcm.h>
19 #include <sound/soc.h>
20 #include <sound/tlv.h>
21 #include <sound/compress_driver.h>
23 #include "../haswell/sst-haswell-ipc.h"
24 #include "../common/sst-dsp-priv.h"
25 #include "../common/sst-dsp.h"
27 #define HSW_PCM_COUNT 6
28 #define HSW_VOLUME_MAX 0x7FFFFFFF /* 0dB */
30 #define SST_OLD_POSITION(d, r, o) ((d) + \
31 frames_to_bytes(r, o))
32 #define SST_SAMPLES(r, x) (bytes_to_samples(r, \
33 frames_to_bytes(r, (x))))
35 /* simple volume table */
36 static const u32 volume_map[] = {
70 #define HSW_PCM_PERIODS_MAX 64
71 #define HSW_PCM_PERIODS_MIN 2
73 #define HSW_PCM_DAI_ID_SYSTEM 0
74 #define HSW_PCM_DAI_ID_OFFLOAD0 1
75 #define HSW_PCM_DAI_ID_OFFLOAD1 2
76 #define HSW_PCM_DAI_ID_LOOPBACK 3
79 static const struct snd_pcm_hardware hsw_pcm_hardware = {
80 .info = SNDRV_PCM_INFO_MMAP |
81 SNDRV_PCM_INFO_MMAP_VALID |
82 SNDRV_PCM_INFO_INTERLEAVED |
83 SNDRV_PCM_INFO_PAUSE |
84 SNDRV_PCM_INFO_RESUME |
85 SNDRV_PCM_INFO_NO_PERIOD_WAKEUP |
86 SNDRV_PCM_INFO_DRAIN_TRIGGER,
87 .formats = SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S24_LE |
88 SNDRV_PCM_FMTBIT_S32_LE,
89 .period_bytes_min = PAGE_SIZE,
90 .period_bytes_max = (HSW_PCM_PERIODS_MAX / HSW_PCM_PERIODS_MIN) * PAGE_SIZE,
91 .periods_min = HSW_PCM_PERIODS_MIN,
92 .periods_max = HSW_PCM_PERIODS_MAX,
93 .buffer_bytes_max = HSW_PCM_PERIODS_MAX * PAGE_SIZE,
96 struct hsw_pcm_module_map {
99 enum sst_hsw_module_id mod_id;
102 /* private data for each PCM DSP stream */
103 struct hsw_pcm_data {
105 struct sst_hsw_stream *stream;
106 struct sst_module_runtime *runtime;
107 struct sst_module_runtime_context context;
108 struct snd_pcm *hsw_pcm;
110 struct snd_pcm_substream *substream;
111 struct snd_compr_stream *cstream;
115 int persistent_offset;
120 HSW_PM_STATE_RTD3 = 1,
124 /* private data for the driver */
125 struct hsw_priv_data {
129 enum hsw_pm_state pm_state;
130 struct snd_soc_card *soc_card;
131 struct sst_module_runtime *runtime_waves; /* sound effect module */
134 struct snd_dma_buffer dmab[HSW_PCM_COUNT][2];
137 struct hsw_pcm_data pcm[HSW_PCM_COUNT][2];
141 /* static mappings between PCMs and modules - may be dynamic in future */
142 static struct hsw_pcm_module_map mod_map[] = {
143 {HSW_PCM_DAI_ID_SYSTEM, 0, SST_HSW_MODULE_PCM_SYSTEM},
144 {HSW_PCM_DAI_ID_OFFLOAD0, 0, SST_HSW_MODULE_PCM},
145 {HSW_PCM_DAI_ID_OFFLOAD1, 0, SST_HSW_MODULE_PCM},
146 {HSW_PCM_DAI_ID_LOOPBACK, 1, SST_HSW_MODULE_PCM_REFERENCE},
147 {HSW_PCM_DAI_ID_SYSTEM, 1, SST_HSW_MODULE_PCM_CAPTURE},
150 static u32 hsw_notify_pointer(struct sst_hsw_stream *stream, void *data);
152 static inline u32 hsw_mixer_to_ipc(unsigned int value)
154 if (value >= ARRAY_SIZE(volume_map))
155 return volume_map[0];
157 return volume_map[value];
160 static inline unsigned int hsw_ipc_to_mixer(u32 value)
164 for (i = 0; i < ARRAY_SIZE(volume_map); i++) {
165 if (volume_map[i] >= value)
172 static int hsw_stream_volume_put(struct snd_kcontrol *kcontrol,
173 struct snd_ctl_elem_value *ucontrol)
175 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
176 struct soc_mixer_control *mc =
177 (struct soc_mixer_control *)kcontrol->private_value;
178 struct hsw_priv_data *pdata =
179 snd_soc_component_get_drvdata(component);
180 struct hsw_pcm_data *pcm_data;
181 struct sst_hsw *hsw = pdata->hsw;
185 dai = mod_map[mc->reg].dai_id;
186 stream = mod_map[mc->reg].stream;
187 pcm_data = &pdata->pcm[dai][stream];
189 mutex_lock(&pcm_data->mutex);
190 pm_runtime_get_sync(pdata->dev);
192 if (!pcm_data->stream) {
193 pcm_data->volume[0] =
194 hsw_mixer_to_ipc(ucontrol->value.integer.value[0]);
195 pcm_data->volume[1] =
196 hsw_mixer_to_ipc(ucontrol->value.integer.value[1]);
197 pm_runtime_mark_last_busy(pdata->dev);
198 pm_runtime_put_autosuspend(pdata->dev);
199 mutex_unlock(&pcm_data->mutex);
203 if (ucontrol->value.integer.value[0] ==
204 ucontrol->value.integer.value[1]) {
205 volume = hsw_mixer_to_ipc(ucontrol->value.integer.value[0]);
206 /* apply volume value to all channels */
207 sst_hsw_stream_set_volume(hsw, pcm_data->stream, 0, SST_HSW_CHANNELS_ALL, volume);
209 volume = hsw_mixer_to_ipc(ucontrol->value.integer.value[0]);
210 sst_hsw_stream_set_volume(hsw, pcm_data->stream, 0, 0, volume);
211 volume = hsw_mixer_to_ipc(ucontrol->value.integer.value[1]);
212 sst_hsw_stream_set_volume(hsw, pcm_data->stream, 0, 1, volume);
215 pm_runtime_mark_last_busy(pdata->dev);
216 pm_runtime_put_autosuspend(pdata->dev);
217 mutex_unlock(&pcm_data->mutex);
221 static int hsw_stream_volume_get(struct snd_kcontrol *kcontrol,
222 struct snd_ctl_elem_value *ucontrol)
224 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
225 struct soc_mixer_control *mc =
226 (struct soc_mixer_control *)kcontrol->private_value;
227 struct hsw_priv_data *pdata =
228 snd_soc_component_get_drvdata(component);
229 struct hsw_pcm_data *pcm_data;
230 struct sst_hsw *hsw = pdata->hsw;
234 dai = mod_map[mc->reg].dai_id;
235 stream = mod_map[mc->reg].stream;
236 pcm_data = &pdata->pcm[dai][stream];
238 mutex_lock(&pcm_data->mutex);
239 pm_runtime_get_sync(pdata->dev);
241 if (!pcm_data->stream) {
242 ucontrol->value.integer.value[0] =
243 hsw_ipc_to_mixer(pcm_data->volume[0]);
244 ucontrol->value.integer.value[1] =
245 hsw_ipc_to_mixer(pcm_data->volume[1]);
246 pm_runtime_mark_last_busy(pdata->dev);
247 pm_runtime_put_autosuspend(pdata->dev);
248 mutex_unlock(&pcm_data->mutex);
252 sst_hsw_stream_get_volume(hsw, pcm_data->stream, 0, 0, &volume);
253 ucontrol->value.integer.value[0] = hsw_ipc_to_mixer(volume);
254 sst_hsw_stream_get_volume(hsw, pcm_data->stream, 0, 1, &volume);
255 ucontrol->value.integer.value[1] = hsw_ipc_to_mixer(volume);
257 pm_runtime_mark_last_busy(pdata->dev);
258 pm_runtime_put_autosuspend(pdata->dev);
259 mutex_unlock(&pcm_data->mutex);
264 static int hsw_volume_put(struct snd_kcontrol *kcontrol,
265 struct snd_ctl_elem_value *ucontrol)
267 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
268 struct hsw_priv_data *pdata = snd_soc_component_get_drvdata(component);
269 struct sst_hsw *hsw = pdata->hsw;
272 pm_runtime_get_sync(pdata->dev);
274 if (ucontrol->value.integer.value[0] ==
275 ucontrol->value.integer.value[1]) {
277 volume = hsw_mixer_to_ipc(ucontrol->value.integer.value[0]);
278 sst_hsw_mixer_set_volume(hsw, 0, SST_HSW_CHANNELS_ALL, volume);
281 volume = hsw_mixer_to_ipc(ucontrol->value.integer.value[0]);
282 sst_hsw_mixer_set_volume(hsw, 0, 0, volume);
284 volume = hsw_mixer_to_ipc(ucontrol->value.integer.value[1]);
285 sst_hsw_mixer_set_volume(hsw, 0, 1, volume);
288 pm_runtime_mark_last_busy(pdata->dev);
289 pm_runtime_put_autosuspend(pdata->dev);
293 static int hsw_volume_get(struct snd_kcontrol *kcontrol,
294 struct snd_ctl_elem_value *ucontrol)
296 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
297 struct hsw_priv_data *pdata = snd_soc_component_get_drvdata(component);
298 struct sst_hsw *hsw = pdata->hsw;
299 unsigned int volume = 0;
301 pm_runtime_get_sync(pdata->dev);
302 sst_hsw_mixer_get_volume(hsw, 0, 0, &volume);
303 ucontrol->value.integer.value[0] = hsw_ipc_to_mixer(volume);
305 sst_hsw_mixer_get_volume(hsw, 0, 1, &volume);
306 ucontrol->value.integer.value[1] = hsw_ipc_to_mixer(volume);
308 pm_runtime_mark_last_busy(pdata->dev);
309 pm_runtime_put_autosuspend(pdata->dev);
313 static int hsw_waves_switch_get(struct snd_kcontrol *kcontrol,
314 struct snd_ctl_elem_value *ucontrol)
316 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
317 struct hsw_priv_data *pdata = snd_soc_component_get_drvdata(component);
318 struct sst_hsw *hsw = pdata->hsw;
319 enum sst_hsw_module_id id = SST_HSW_MODULE_WAVES;
321 ucontrol->value.integer.value[0] =
322 (sst_hsw_is_module_active(hsw, id) ||
323 sst_hsw_is_module_enabled_rtd3(hsw, id));
327 static int hsw_waves_switch_put(struct snd_kcontrol *kcontrol,
328 struct snd_ctl_elem_value *ucontrol)
330 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
331 struct hsw_priv_data *pdata = snd_soc_component_get_drvdata(component);
332 struct sst_hsw *hsw = pdata->hsw;
334 enum sst_hsw_module_id id = SST_HSW_MODULE_WAVES;
335 bool switch_on = (bool)ucontrol->value.integer.value[0];
337 /* if module is in RAM on the DSP, apply user settings to module through
338 * ipc. If module is not in RAM on the DSP, store user setting for
340 if (sst_hsw_is_module_loaded(hsw, id)) {
341 if (switch_on == sst_hsw_is_module_active(hsw, id))
345 ret = sst_hsw_module_enable(hsw, id, 0);
347 ret = sst_hsw_module_disable(hsw, id, 0);
349 if (switch_on == sst_hsw_is_module_enabled_rtd3(hsw, id))
353 sst_hsw_set_module_enabled_rtd3(hsw, id);
355 sst_hsw_set_module_disabled_rtd3(hsw, id);
361 static int hsw_waves_param_get(struct snd_kcontrol *kcontrol,
362 struct snd_ctl_elem_value *ucontrol)
364 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
365 struct hsw_priv_data *pdata = snd_soc_component_get_drvdata(component);
366 struct sst_hsw *hsw = pdata->hsw;
368 /* return a matching line from param buffer */
369 return sst_hsw_load_param_line(hsw, ucontrol->value.bytes.data);
372 static int hsw_waves_param_put(struct snd_kcontrol *kcontrol,
373 struct snd_ctl_elem_value *ucontrol)
375 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
376 struct hsw_priv_data *pdata = snd_soc_component_get_drvdata(component);
377 struct sst_hsw *hsw = pdata->hsw;
379 enum sst_hsw_module_id id = SST_HSW_MODULE_WAVES;
380 int param_id = ucontrol->value.bytes.data[0];
381 int param_size = WAVES_PARAM_COUNT;
383 /* clear param buffer and reset buffer index */
384 if (param_id == 0xFF) {
385 sst_hsw_reset_param_buf(hsw);
389 /* store params into buffer */
390 ret = sst_hsw_store_param_line(hsw, ucontrol->value.bytes.data);
394 if (sst_hsw_is_module_active(hsw, id))
395 ret = sst_hsw_module_set_param(hsw, id, 0, param_id,
396 param_size, ucontrol->value.bytes.data);
400 /* TLV used by both global and stream volumes */
401 static const DECLARE_TLV_DB_SCALE(hsw_vol_tlv, -9000, 300, 1);
403 /* System Pin has no volume control */
404 static const struct snd_kcontrol_new hsw_volume_controls[] = {
405 /* Global DSP volume */
406 SOC_DOUBLE_EXT_TLV("Master Playback Volume", 0, 0, 8,
407 ARRAY_SIZE(volume_map) - 1, 0,
408 hsw_volume_get, hsw_volume_put, hsw_vol_tlv),
409 /* Offload 0 volume */
410 SOC_DOUBLE_EXT_TLV("Media0 Playback Volume", 1, 0, 8,
411 ARRAY_SIZE(volume_map) - 1, 0,
412 hsw_stream_volume_get, hsw_stream_volume_put, hsw_vol_tlv),
413 /* Offload 1 volume */
414 SOC_DOUBLE_EXT_TLV("Media1 Playback Volume", 2, 0, 8,
415 ARRAY_SIZE(volume_map) - 1, 0,
416 hsw_stream_volume_get, hsw_stream_volume_put, hsw_vol_tlv),
417 /* Mic Capture volume */
418 SOC_DOUBLE_EXT_TLV("Mic Capture Volume", 4, 0, 8,
419 ARRAY_SIZE(volume_map) - 1, 0,
420 hsw_stream_volume_get, hsw_stream_volume_put, hsw_vol_tlv),
421 /* enable/disable module waves */
422 SOC_SINGLE_BOOL_EXT("Waves Switch", 0,
423 hsw_waves_switch_get, hsw_waves_switch_put),
424 /* set parameters to module waves */
425 SND_SOC_BYTES_EXT("Waves Set Param", WAVES_PARAM_COUNT,
426 hsw_waves_param_get, hsw_waves_param_put),
429 /* Create DMA buffer page table for DSP */
430 static int create_adsp_page_table(struct snd_pcm_substream *substream,
431 struct hsw_priv_data *pdata, struct snd_soc_pcm_runtime *rtd,
432 unsigned char *dma_area, size_t size, int pcm)
434 struct snd_dma_buffer *dmab = snd_pcm_get_dma_buf(substream);
435 int i, pages, stream = substream->stream;
437 pages = snd_sgbuf_aligned_pages(size);
439 dev_dbg(rtd->dev, "generating page table for %p size 0x%zx pages %d\n",
440 dma_area, size, pages);
442 for (i = 0; i < pages; i++) {
443 u32 idx = (((i << 2) + i)) >> 1;
444 u32 pfn = snd_sgbuf_get_addr(dmab, i * PAGE_SIZE) >> PAGE_SHIFT;
447 dev_dbg(rtd->dev, "pfn i %i idx %d pfn %x\n", i, idx, pfn);
449 pg_table = (u32 *)(pdata->dmab[pcm][stream].area + idx);
452 *pg_table |= (pfn << 4);
460 /* this may get called several times by oss emulation */
461 static int hsw_pcm_hw_params(struct snd_pcm_substream *substream,
462 struct snd_pcm_hw_params *params)
464 struct snd_soc_pcm_runtime *rtd = substream->private_data;
465 struct snd_pcm_runtime *runtime = substream->runtime;
466 struct snd_soc_component *component = snd_soc_rtdcom_lookup(rtd, DRV_NAME);
467 struct hsw_priv_data *pdata = snd_soc_component_get_drvdata(component);
468 struct hsw_pcm_data *pcm_data;
469 struct sst_hsw *hsw = pdata->hsw;
470 struct sst_module *module_data;
472 struct snd_dma_buffer *dmab;
473 enum sst_hsw_stream_type stream_type;
474 enum sst_hsw_stream_path_id path_id;
475 u32 rate, bits, map, pages, module_id;
479 dai = mod_map[rtd->cpu_dai->id].dai_id;
480 pcm_data = &pdata->pcm[dai][substream->stream];
482 /* check if we are being called a subsequent time */
483 if (pcm_data->allocated) {
484 ret = sst_hsw_stream_reset(hsw, pcm_data->stream);
486 dev_dbg(rtd->dev, "error: reset stream failed %d\n",
489 ret = sst_hsw_stream_free(hsw, pcm_data->stream);
491 dev_dbg(rtd->dev, "error: free stream failed %d\n",
495 pcm_data->allocated = false;
497 pcm_data->stream = sst_hsw_stream_new(hsw, rtd->cpu_dai->id,
498 hsw_notify_pointer, pcm_data);
499 if (pcm_data->stream == NULL) {
500 dev_err(rtd->dev, "error: failed to create stream\n");
505 /* stream direction */
506 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
507 path_id = SST_HSW_STREAM_PATH_SSP0_OUT;
509 path_id = SST_HSW_STREAM_PATH_SSP0_IN;
511 /* DSP stream type depends on DAI ID */
512 switch (rtd->cpu_dai->id) {
514 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
515 stream_type = SST_HSW_STREAM_TYPE_SYSTEM;
516 module_id = SST_HSW_MODULE_PCM_SYSTEM;
519 stream_type = SST_HSW_STREAM_TYPE_CAPTURE;
520 module_id = SST_HSW_MODULE_PCM_CAPTURE;
525 stream_type = SST_HSW_STREAM_TYPE_RENDER;
526 module_id = SST_HSW_MODULE_PCM;
529 /* path ID needs to be OUT for loopback */
530 stream_type = SST_HSW_STREAM_TYPE_LOOPBACK;
531 path_id = SST_HSW_STREAM_PATH_SSP0_OUT;
532 module_id = SST_HSW_MODULE_PCM_REFERENCE;
535 dev_err(rtd->dev, "error: invalid DAI ID %d\n",
540 ret = sst_hsw_stream_format(hsw, pcm_data->stream,
541 path_id, stream_type, SST_HSW_STREAM_FORMAT_PCM_FORMAT);
543 dev_err(rtd->dev, "error: failed to set format %d\n", ret);
547 rate = params_rate(params);
548 ret = sst_hsw_stream_set_rate(hsw, pcm_data->stream, rate);
550 dev_err(rtd->dev, "error: could not set rate %d\n", rate);
554 switch (params_format(params)) {
555 case SNDRV_PCM_FORMAT_S16_LE:
556 bits = SST_HSW_DEPTH_16BIT;
557 sst_hsw_stream_set_valid(hsw, pcm_data->stream, 16);
559 case SNDRV_PCM_FORMAT_S24_LE:
560 bits = SST_HSW_DEPTH_32BIT;
561 sst_hsw_stream_set_valid(hsw, pcm_data->stream, 24);
563 case SNDRV_PCM_FORMAT_S8:
564 bits = SST_HSW_DEPTH_8BIT;
565 sst_hsw_stream_set_valid(hsw, pcm_data->stream, 8);
567 case SNDRV_PCM_FORMAT_S32_LE:
568 bits = SST_HSW_DEPTH_32BIT;
569 sst_hsw_stream_set_valid(hsw, pcm_data->stream, 32);
572 dev_err(rtd->dev, "error: invalid format %d\n",
573 params_format(params));
577 ret = sst_hsw_stream_set_bits(hsw, pcm_data->stream, bits);
579 dev_err(rtd->dev, "error: could not set bits %d\n", bits);
583 channels = params_channels(params);
584 map = create_channel_map(SST_HSW_CHANNEL_CONFIG_STEREO);
585 sst_hsw_stream_set_map_config(hsw, pcm_data->stream,
586 map, SST_HSW_CHANNEL_CONFIG_STEREO);
588 ret = sst_hsw_stream_set_channels(hsw, pcm_data->stream, channels);
590 dev_err(rtd->dev, "error: could not set channels %d\n",
595 ret = snd_pcm_lib_malloc_pages(substream, params_buffer_bytes(params));
597 dev_err(rtd->dev, "error: could not allocate %d bytes for PCM %d\n",
598 params_buffer_bytes(params), ret);
602 dmab = snd_pcm_get_dma_buf(substream);
604 ret = create_adsp_page_table(substream, pdata, rtd, runtime->dma_area,
605 runtime->dma_bytes, rtd->cpu_dai->id);
609 sst_hsw_stream_set_style(hsw, pcm_data->stream,
610 SST_HSW_INTERLEAVING_PER_CHANNEL);
612 if (runtime->dma_bytes % PAGE_SIZE)
613 pages = (runtime->dma_bytes / PAGE_SIZE) + 1;
615 pages = runtime->dma_bytes / PAGE_SIZE;
617 ret = sst_hsw_stream_buffer(hsw, pcm_data->stream,
618 pdata->dmab[rtd->cpu_dai->id][substream->stream].addr,
619 pages, runtime->dma_bytes, 0,
620 snd_sgbuf_get_addr(dmab, 0) >> PAGE_SHIFT);
622 dev_err(rtd->dev, "error: failed to set DMA buffer %d\n", ret);
626 dsp = sst_hsw_get_dsp(hsw);
628 module_data = sst_module_get_from_id(dsp, module_id);
629 if (module_data == NULL) {
630 dev_err(rtd->dev, "error: failed to get module config\n");
634 sst_hsw_stream_set_module_info(hsw, pcm_data->stream,
637 ret = sst_hsw_stream_commit(hsw, pcm_data->stream);
639 dev_err(rtd->dev, "error: failed to commit stream %d\n", ret);
643 if (!pcm_data->allocated) {
644 /* Set previous saved volume */
645 sst_hsw_stream_set_volume(hsw, pcm_data->stream, 0,
646 0, pcm_data->volume[0]);
647 sst_hsw_stream_set_volume(hsw, pcm_data->stream, 0,
648 1, pcm_data->volume[1]);
649 pcm_data->allocated = true;
652 ret = sst_hsw_stream_pause(hsw, pcm_data->stream, 1);
654 dev_err(rtd->dev, "error: failed to pause %d\n", ret);
659 static int hsw_pcm_hw_free(struct snd_pcm_substream *substream)
661 snd_pcm_lib_free_pages(substream);
665 static int hsw_pcm_trigger(struct snd_pcm_substream *substream, int cmd)
667 struct snd_soc_pcm_runtime *rtd = substream->private_data;
668 struct snd_soc_component *component = snd_soc_rtdcom_lookup(rtd, DRV_NAME);
669 struct hsw_priv_data *pdata = snd_soc_component_get_drvdata(component);
670 struct hsw_pcm_data *pcm_data;
671 struct sst_hsw_stream *sst_stream;
672 struct sst_hsw *hsw = pdata->hsw;
673 struct snd_pcm_runtime *runtime = substream->runtime;
674 snd_pcm_uframes_t pos;
677 dai = mod_map[rtd->cpu_dai->id].dai_id;
678 pcm_data = &pdata->pcm[dai][substream->stream];
679 sst_stream = pcm_data->stream;
682 case SNDRV_PCM_TRIGGER_START:
683 case SNDRV_PCM_TRIGGER_RESUME:
684 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
685 sst_hsw_stream_set_silence_start(hsw, sst_stream, false);
686 sst_hsw_stream_resume(hsw, pcm_data->stream, 0);
688 case SNDRV_PCM_TRIGGER_STOP:
689 case SNDRV_PCM_TRIGGER_SUSPEND:
690 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
691 sst_hsw_stream_set_silence_start(hsw, sst_stream, false);
692 sst_hsw_stream_pause(hsw, pcm_data->stream, 0);
694 case SNDRV_PCM_TRIGGER_DRAIN:
695 pos = runtime->control->appl_ptr % runtime->buffer_size;
696 sst_hsw_stream_set_old_position(hsw, pcm_data->stream, pos);
697 sst_hsw_stream_set_silence_start(hsw, sst_stream, true);
706 static u32 hsw_notify_pointer(struct sst_hsw_stream *stream, void *data)
708 struct hsw_pcm_data *pcm_data = data;
709 struct snd_pcm_substream *substream = pcm_data->substream;
710 struct snd_pcm_runtime *runtime = substream->runtime;
711 struct snd_soc_pcm_runtime *rtd = substream->private_data;
712 struct snd_soc_component *component = snd_soc_rtdcom_lookup(rtd, DRV_NAME);
713 struct hsw_priv_data *pdata = snd_soc_component_get_drvdata(component);
714 struct sst_hsw *hsw = pdata->hsw;
716 snd_pcm_uframes_t position = bytes_to_frames(runtime,
717 sst_hsw_get_dsp_position(hsw, pcm_data->stream));
718 unsigned char *dma_area = runtime->dma_area;
719 snd_pcm_uframes_t dma_frames =
720 bytes_to_frames(runtime, runtime->dma_bytes);
721 snd_pcm_uframes_t old_position;
724 pos = frames_to_bytes(runtime,
725 (runtime->control->appl_ptr % runtime->buffer_size));
727 dev_vdbg(rtd->dev, "PCM: App pointer %d bytes\n", pos);
729 /* SST fw don't know where to stop dma
730 * So, SST driver need to clean the data which has been consumed
732 if (dma_area == NULL || dma_frames <= 0
733 || (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
734 || !sst_hsw_stream_get_silence_start(hsw, stream)) {
735 snd_pcm_period_elapsed(substream);
739 old_position = sst_hsw_stream_get_old_position(hsw, stream);
740 if (position > old_position) {
741 if (position < dma_frames) {
742 samples = SST_SAMPLES(runtime, position - old_position);
743 snd_pcm_format_set_silence(runtime->format,
744 SST_OLD_POSITION(dma_area,
745 runtime, old_position),
748 dev_err(rtd->dev, "PCM: position is wrong\n");
750 if (old_position < dma_frames) {
751 samples = SST_SAMPLES(runtime,
752 dma_frames - old_position);
753 snd_pcm_format_set_silence(runtime->format,
754 SST_OLD_POSITION(dma_area,
755 runtime, old_position),
758 dev_err(rtd->dev, "PCM: dma_bytes is wrong\n");
759 if (position < dma_frames) {
760 samples = SST_SAMPLES(runtime, position);
761 snd_pcm_format_set_silence(runtime->format,
764 dev_err(rtd->dev, "PCM: position is wrong\n");
766 sst_hsw_stream_set_old_position(hsw, stream, position);
768 /* let alsa know we have play a period */
769 snd_pcm_period_elapsed(substream);
773 static snd_pcm_uframes_t hsw_pcm_pointer(struct snd_pcm_substream *substream)
775 struct snd_soc_pcm_runtime *rtd = substream->private_data;
776 struct snd_pcm_runtime *runtime = substream->runtime;
777 struct snd_soc_component *component = snd_soc_rtdcom_lookup(rtd, DRV_NAME);
778 struct hsw_priv_data *pdata = snd_soc_component_get_drvdata(component);
779 struct hsw_pcm_data *pcm_data;
780 struct sst_hsw *hsw = pdata->hsw;
781 snd_pcm_uframes_t offset;
786 dai = mod_map[rtd->cpu_dai->id].dai_id;
787 pcm_data = &pdata->pcm[dai][substream->stream];
788 position = sst_hsw_get_dsp_position(hsw, pcm_data->stream);
790 offset = bytes_to_frames(runtime, position);
791 ppos = sst_hsw_get_dsp_presentation_position(hsw, pcm_data->stream);
793 dev_vdbg(rtd->dev, "PCM: DMA pointer %du bytes, pos %llu\n",
798 static int hsw_pcm_open(struct snd_pcm_substream *substream)
800 struct snd_soc_pcm_runtime *rtd = substream->private_data;
801 struct snd_soc_component *component = snd_soc_rtdcom_lookup(rtd, DRV_NAME);
802 struct hsw_priv_data *pdata = snd_soc_component_get_drvdata(component);
803 struct hsw_pcm_data *pcm_data;
804 struct sst_hsw *hsw = pdata->hsw;
807 dai = mod_map[rtd->cpu_dai->id].dai_id;
808 pcm_data = &pdata->pcm[dai][substream->stream];
810 mutex_lock(&pcm_data->mutex);
811 pm_runtime_get_sync(pdata->dev);
813 pcm_data->substream = substream;
815 snd_soc_set_runtime_hwparams(substream, &hsw_pcm_hardware);
817 pcm_data->stream = sst_hsw_stream_new(hsw, rtd->cpu_dai->id,
818 hsw_notify_pointer, pcm_data);
819 if (pcm_data->stream == NULL) {
820 dev_err(rtd->dev, "error: failed to create stream\n");
821 pm_runtime_mark_last_busy(pdata->dev);
822 pm_runtime_put_autosuspend(pdata->dev);
823 mutex_unlock(&pcm_data->mutex);
827 mutex_unlock(&pcm_data->mutex);
831 static int hsw_pcm_close(struct snd_pcm_substream *substream)
833 struct snd_soc_pcm_runtime *rtd = substream->private_data;
834 struct snd_soc_component *component = snd_soc_rtdcom_lookup(rtd, DRV_NAME);
835 struct hsw_priv_data *pdata = snd_soc_component_get_drvdata(component);
836 struct hsw_pcm_data *pcm_data;
837 struct sst_hsw *hsw = pdata->hsw;
840 dai = mod_map[rtd->cpu_dai->id].dai_id;
841 pcm_data = &pdata->pcm[dai][substream->stream];
843 mutex_lock(&pcm_data->mutex);
844 ret = sst_hsw_stream_reset(hsw, pcm_data->stream);
846 dev_dbg(rtd->dev, "error: reset stream failed %d\n", ret);
850 ret = sst_hsw_stream_free(hsw, pcm_data->stream);
852 dev_dbg(rtd->dev, "error: free stream failed %d\n", ret);
855 pcm_data->allocated = false;
856 pcm_data->stream = NULL;
859 pm_runtime_mark_last_busy(pdata->dev);
860 pm_runtime_put_autosuspend(pdata->dev);
861 mutex_unlock(&pcm_data->mutex);
865 static const struct snd_pcm_ops hsw_pcm_ops = {
866 .open = hsw_pcm_open,
867 .close = hsw_pcm_close,
868 .ioctl = snd_pcm_lib_ioctl,
869 .hw_params = hsw_pcm_hw_params,
870 .hw_free = hsw_pcm_hw_free,
871 .trigger = hsw_pcm_trigger,
872 .pointer = hsw_pcm_pointer,
873 .page = snd_pcm_sgbuf_ops_page,
876 static int hsw_pcm_create_modules(struct hsw_priv_data *pdata)
878 struct sst_hsw *hsw = pdata->hsw;
879 struct hsw_pcm_data *pcm_data;
882 for (i = 0; i < ARRAY_SIZE(mod_map); i++) {
883 pcm_data = &pdata->pcm[mod_map[i].dai_id][mod_map[i].stream];
885 /* create new runtime module, use same offset if recreated */
886 pcm_data->runtime = sst_hsw_runtime_module_create(hsw,
887 mod_map[i].mod_id, pcm_data->persistent_offset);
888 if (pcm_data->runtime == NULL)
890 pcm_data->persistent_offset =
891 pcm_data->runtime->persistent_offset;
894 /* create runtime blocks for module waves */
895 if (sst_hsw_is_module_loaded(hsw, SST_HSW_MODULE_WAVES)) {
896 pdata->runtime_waves = sst_hsw_runtime_module_create(hsw,
897 SST_HSW_MODULE_WAVES, 0);
898 if (pdata->runtime_waves == NULL)
905 for (--i; i >= 0; i--) {
906 pcm_data = &pdata->pcm[mod_map[i].dai_id][mod_map[i].stream];
907 sst_hsw_runtime_module_free(pcm_data->runtime);
913 static void hsw_pcm_free_modules(struct hsw_priv_data *pdata)
915 struct sst_hsw *hsw = pdata->hsw;
916 struct hsw_pcm_data *pcm_data;
919 for (i = 0; i < ARRAY_SIZE(mod_map); i++) {
920 pcm_data = &pdata->pcm[mod_map[i].dai_id][mod_map[i].stream];
921 if (pcm_data->runtime){
922 sst_hsw_runtime_module_free(pcm_data->runtime);
923 pcm_data->runtime = NULL;
926 if (sst_hsw_is_module_loaded(hsw, SST_HSW_MODULE_WAVES) &&
927 pdata->runtime_waves) {
928 sst_hsw_runtime_module_free(pdata->runtime_waves);
929 pdata->runtime_waves = NULL;
933 static int hsw_pcm_new(struct snd_soc_pcm_runtime *rtd)
935 struct snd_pcm *pcm = rtd->pcm;
936 struct snd_soc_component *component = snd_soc_rtdcom_lookup(rtd, DRV_NAME);
937 struct sst_pdata *pdata = dev_get_platdata(component->dev);
938 struct hsw_priv_data *priv_data = dev_get_drvdata(component->dev);
939 struct device *dev = pdata->dma_dev;
941 if (pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream ||
942 pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream) {
943 snd_pcm_lib_preallocate_pages_for_all(pcm,
944 SNDRV_DMA_TYPE_DEV_SG,
946 hsw_pcm_hardware.buffer_bytes_max,
947 hsw_pcm_hardware.buffer_bytes_max);
949 if (pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream)
950 priv_data->pcm[rtd->cpu_dai->id][SNDRV_PCM_STREAM_PLAYBACK].hsw_pcm = pcm;
951 if (pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream)
952 priv_data->pcm[rtd->cpu_dai->id][SNDRV_PCM_STREAM_CAPTURE].hsw_pcm = pcm;
957 #define HSW_FORMATS \
958 (SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S16_LE)
960 static struct snd_soc_dai_driver hsw_dais[] = {
962 .name = "System Pin",
963 .id = HSW_PCM_DAI_ID_SYSTEM,
965 .stream_name = "System Playback",
968 .rates = SNDRV_PCM_RATE_48000,
969 .formats = SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S16_LE,
972 .stream_name = "Analog Capture",
975 .rates = SNDRV_PCM_RATE_48000,
976 .formats = SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S16_LE,
981 .name = "Offload0 Pin",
982 .id = HSW_PCM_DAI_ID_OFFLOAD0,
984 .stream_name = "Offload0 Playback",
987 .rates = SNDRV_PCM_RATE_8000_192000,
988 .formats = HSW_FORMATS,
993 .name = "Offload1 Pin",
994 .id = HSW_PCM_DAI_ID_OFFLOAD1,
996 .stream_name = "Offload1 Playback",
999 .rates = SNDRV_PCM_RATE_8000_192000,
1000 .formats = HSW_FORMATS,
1004 .name = "Loopback Pin",
1005 .id = HSW_PCM_DAI_ID_LOOPBACK,
1007 .stream_name = "Loopback Capture",
1010 .rates = SNDRV_PCM_RATE_48000,
1011 .formats = SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S16_LE,
1016 static const struct snd_soc_dapm_widget widgets[] = {
1019 SND_SOC_DAPM_AIF_IN("SSP0 CODEC IN", NULL, 0, SND_SOC_NOPM, 0, 0),
1020 SND_SOC_DAPM_AIF_OUT("SSP0 CODEC OUT", NULL, 0, SND_SOC_NOPM, 0, 0),
1021 SND_SOC_DAPM_AIF_IN("SSP1 BT IN", NULL, 0, SND_SOC_NOPM, 0, 0),
1022 SND_SOC_DAPM_AIF_OUT("SSP1 BT OUT", NULL, 0, SND_SOC_NOPM, 0, 0),
1024 /* Global Playback Mixer */
1025 SND_SOC_DAPM_MIXER("Playback VMixer", SND_SOC_NOPM, 0, 0, NULL, 0),
1028 static const struct snd_soc_dapm_route graph[] = {
1030 /* Playback Mixer */
1031 {"Playback VMixer", NULL, "System Playback"},
1032 {"Playback VMixer", NULL, "Offload0 Playback"},
1033 {"Playback VMixer", NULL, "Offload1 Playback"},
1035 {"SSP0 CODEC OUT", NULL, "Playback VMixer"},
1037 {"Analog Capture", NULL, "SSP0 CODEC IN"},
1040 static int hsw_pcm_probe(struct snd_soc_component *component)
1042 struct hsw_priv_data *priv_data = snd_soc_component_get_drvdata(component);
1043 struct sst_pdata *pdata = dev_get_platdata(component->dev);
1044 struct device *dma_dev, *dev;
1050 dev = component->dev;
1051 dma_dev = pdata->dma_dev;
1053 priv_data->hsw = pdata->dsp;
1054 priv_data->dev = dev;
1055 priv_data->pm_state = HSW_PM_STATE_D0;
1056 priv_data->soc_card = component->card;
1058 /* allocate DSP buffer page tables */
1059 for (i = 0; i < ARRAY_SIZE(hsw_dais); i++) {
1062 if (hsw_dais[i].playback.channels_min) {
1063 mutex_init(&priv_data->pcm[i][SNDRV_PCM_STREAM_PLAYBACK].mutex);
1064 ret = snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, dma_dev,
1065 PAGE_SIZE, &priv_data->dmab[i][0]);
1071 if (hsw_dais[i].capture.channels_min) {
1072 mutex_init(&priv_data->pcm[i][SNDRV_PCM_STREAM_CAPTURE].mutex);
1073 ret = snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, dma_dev,
1074 PAGE_SIZE, &priv_data->dmab[i][1]);
1080 /* allocate runtime modules */
1081 ret = hsw_pcm_create_modules(priv_data);
1085 /* enable runtime PM with auto suspend */
1086 pm_runtime_set_autosuspend_delay(dev, SST_RUNTIME_SUSPEND_DELAY);
1087 pm_runtime_use_autosuspend(dev);
1088 pm_runtime_enable(dev);
1089 pm_runtime_idle(dev);
1094 for (--i; i >= 0; i--) {
1095 if (hsw_dais[i].playback.channels_min)
1096 snd_dma_free_pages(&priv_data->dmab[i][0]);
1097 if (hsw_dais[i].capture.channels_min)
1098 snd_dma_free_pages(&priv_data->dmab[i][1]);
1103 static void hsw_pcm_remove(struct snd_soc_component *component)
1105 struct hsw_priv_data *priv_data =
1106 snd_soc_component_get_drvdata(component);
1109 pm_runtime_disable(component->dev);
1110 hsw_pcm_free_modules(priv_data);
1112 for (i = 0; i < ARRAY_SIZE(hsw_dais); i++) {
1113 if (hsw_dais[i].playback.channels_min)
1114 snd_dma_free_pages(&priv_data->dmab[i][0]);
1115 if (hsw_dais[i].capture.channels_min)
1116 snd_dma_free_pages(&priv_data->dmab[i][1]);
1120 static const struct snd_soc_component_driver hsw_dai_component = {
1122 .probe = hsw_pcm_probe,
1123 .remove = hsw_pcm_remove,
1124 .ops = &hsw_pcm_ops,
1125 .pcm_new = hsw_pcm_new,
1126 .controls = hsw_volume_controls,
1127 .num_controls = ARRAY_SIZE(hsw_volume_controls),
1128 .dapm_widgets = widgets,
1129 .num_dapm_widgets = ARRAY_SIZE(widgets),
1130 .dapm_routes = graph,
1131 .num_dapm_routes = ARRAY_SIZE(graph),
1134 static int hsw_pcm_dev_probe(struct platform_device *pdev)
1136 struct sst_pdata *sst_pdata = dev_get_platdata(&pdev->dev);
1137 struct hsw_priv_data *priv_data;
1143 priv_data = devm_kzalloc(&pdev->dev, sizeof(*priv_data), GFP_KERNEL);
1147 ret = sst_hsw_dsp_init(&pdev->dev, sst_pdata);
1151 priv_data->hsw = sst_pdata->dsp;
1152 platform_set_drvdata(pdev, priv_data);
1154 ret = devm_snd_soc_register_component(&pdev->dev, &hsw_dai_component,
1155 hsw_dais, ARRAY_SIZE(hsw_dais));
1162 sst_hsw_dsp_free(&pdev->dev, sst_pdata);
1166 static int hsw_pcm_dev_remove(struct platform_device *pdev)
1168 struct sst_pdata *sst_pdata = dev_get_platdata(&pdev->dev);
1170 sst_hsw_dsp_free(&pdev->dev, sst_pdata);
1177 static int hsw_pcm_runtime_idle(struct device *dev)
1182 static int hsw_pcm_suspend(struct device *dev)
1184 struct hsw_priv_data *pdata = dev_get_drvdata(dev);
1185 struct sst_hsw *hsw = pdata->hsw;
1187 /* enter D3 state and stall */
1188 sst_hsw_dsp_runtime_suspend(hsw);
1189 /* free all runtime modules */
1190 hsw_pcm_free_modules(pdata);
1191 /* put the DSP to sleep, fw unloaded after runtime modules freed */
1192 sst_hsw_dsp_runtime_sleep(hsw);
1196 static int hsw_pcm_runtime_suspend(struct device *dev)
1198 struct hsw_priv_data *pdata = dev_get_drvdata(dev);
1199 struct sst_hsw *hsw = pdata->hsw;
1202 if (pdata->pm_state >= HSW_PM_STATE_RTD3)
1205 /* fw modules will be unloaded on RTD3, set flag to track */
1206 if (sst_hsw_is_module_active(hsw, SST_HSW_MODULE_WAVES)) {
1207 ret = sst_hsw_module_disable(hsw, SST_HSW_MODULE_WAVES, 0);
1210 sst_hsw_set_module_enabled_rtd3(hsw, SST_HSW_MODULE_WAVES);
1212 hsw_pcm_suspend(dev);
1213 pdata->pm_state = HSW_PM_STATE_RTD3;
1218 static int hsw_pcm_runtime_resume(struct device *dev)
1220 struct hsw_priv_data *pdata = dev_get_drvdata(dev);
1221 struct sst_hsw *hsw = pdata->hsw;
1224 if (pdata->pm_state != HSW_PM_STATE_RTD3)
1227 ret = sst_hsw_dsp_load(hsw);
1229 dev_err(dev, "failed to reload %d\n", ret);
1233 ret = hsw_pcm_create_modules(pdata);
1235 dev_err(dev, "failed to create modules %d\n", ret);
1239 ret = sst_hsw_dsp_runtime_resume(hsw);
1242 else if (ret == 1) /* no action required */
1245 /* check flag when resume */
1246 if (sst_hsw_is_module_enabled_rtd3(hsw, SST_HSW_MODULE_WAVES)) {
1247 ret = sst_hsw_module_enable(hsw, SST_HSW_MODULE_WAVES, 0);
1250 /* put parameters from buffer to dsp */
1251 ret = sst_hsw_launch_param_buf(hsw);
1255 sst_hsw_set_module_disabled_rtd3(hsw, SST_HSW_MODULE_WAVES);
1258 pdata->pm_state = HSW_PM_STATE_D0;
1263 #define hsw_pcm_runtime_idle NULL
1264 #define hsw_pcm_runtime_suspend NULL
1265 #define hsw_pcm_runtime_resume NULL
1270 static void hsw_pcm_complete(struct device *dev)
1272 struct hsw_priv_data *pdata = dev_get_drvdata(dev);
1273 struct sst_hsw *hsw = pdata->hsw;
1274 struct hsw_pcm_data *pcm_data;
1277 if (pdata->pm_state != HSW_PM_STATE_D3)
1280 err = sst_hsw_dsp_load(hsw);
1282 dev_err(dev, "failed to reload %d\n", err);
1286 err = hsw_pcm_create_modules(pdata);
1288 dev_err(dev, "failed to create modules %d\n", err);
1292 for (i = 0; i < ARRAY_SIZE(mod_map); i++) {
1293 pcm_data = &pdata->pcm[mod_map[i].dai_id][mod_map[i].stream];
1295 if (!pcm_data->substream)
1298 err = sst_module_runtime_restore(pcm_data->runtime,
1299 &pcm_data->context);
1301 dev_err(dev, "failed to restore context for PCM %d\n", i);
1304 snd_soc_resume(pdata->soc_card->dev);
1306 err = sst_hsw_dsp_runtime_resume(hsw);
1309 else if (err == 1) /* no action required */
1312 pdata->pm_state = HSW_PM_STATE_D0;
1316 static int hsw_pcm_prepare(struct device *dev)
1318 struct hsw_priv_data *pdata = dev_get_drvdata(dev);
1319 struct hsw_pcm_data *pcm_data;
1322 if (pdata->pm_state == HSW_PM_STATE_D3)
1324 else if (pdata->pm_state == HSW_PM_STATE_D0) {
1325 /* suspend all active streams */
1326 for (i = 0; i < ARRAY_SIZE(mod_map); i++) {
1327 pcm_data = &pdata->pcm[mod_map[i].dai_id][mod_map[i].stream];
1329 if (!pcm_data->substream)
1331 dev_dbg(dev, "suspending pcm %d\n", i);
1332 snd_pcm_suspend_all(pcm_data->hsw_pcm);
1334 /* We need to wait until the DSP FW stops the streams */
1338 /* preserve persistent memory */
1339 for (i = 0; i < ARRAY_SIZE(mod_map); i++) {
1340 pcm_data = &pdata->pcm[mod_map[i].dai_id][mod_map[i].stream];
1342 if (!pcm_data->substream)
1345 dev_dbg(dev, "saving context pcm %d\n", i);
1346 err = sst_module_runtime_save(pcm_data->runtime,
1347 &pcm_data->context);
1349 dev_err(dev, "failed to save context for PCM %d\n", i);
1351 hsw_pcm_suspend(dev);
1354 snd_soc_suspend(pdata->soc_card->dev);
1355 snd_soc_poweroff(pdata->soc_card->dev);
1357 pdata->pm_state = HSW_PM_STATE_D3;
1363 #define hsw_pcm_prepare NULL
1364 #define hsw_pcm_complete NULL
1367 static const struct dev_pm_ops hsw_pcm_pm = {
1368 .runtime_idle = hsw_pcm_runtime_idle,
1369 .runtime_suspend = hsw_pcm_runtime_suspend,
1370 .runtime_resume = hsw_pcm_runtime_resume,
1371 .prepare = hsw_pcm_prepare,
1372 .complete = hsw_pcm_complete,
1375 static struct platform_driver hsw_pcm_driver = {
1377 .name = "haswell-pcm-audio",
1381 .probe = hsw_pcm_dev_probe,
1382 .remove = hsw_pcm_dev_remove,
1384 module_platform_driver(hsw_pcm_driver);
1386 MODULE_AUTHOR("Liam Girdwood, Xingchao Wang");
1387 MODULE_DESCRIPTION("Haswell/Lynxpoint + Broadwell/Wildcatpoint PCM");
1388 MODULE_LICENSE("GPL v2");
1389 MODULE_ALIAS("platform:haswell-pcm-audio");