1 // SPDX-License-Identifier: GPL-2.0-only
3 * sst_drv_interface.c - Intel SST Driver for audio engine
5 * Copyright (C) 2008-14 Intel Corp
9 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13 #include <linux/delay.h>
14 #include <linux/pci.h>
16 #include <linux/firmware.h>
17 #include <linux/pm_runtime.h>
18 #include <linux/pm_qos.h>
19 #include <linux/math64.h>
20 #include <sound/core.h>
21 #include <sound/pcm.h>
22 #include <sound/soc.h>
23 #include <sound/compress_driver.h>
24 #include <asm/platform_sst_audio.h>
25 #include "../sst-mfld-platform.h"
29 #define MIN_FRAGMENT 2
30 #define MAX_FRAGMENT 4
31 #define MIN_FRAGMENT_SIZE (50 * 1024)
32 #define MAX_FRAGMENT_SIZE (1024 * 1024)
33 #define SST_GET_BYTES_PER_SAMPLE(pcm_wd_sz) (((pcm_wd_sz + 15) >> 4) << 1)
35 #define GET_USAGE_COUNT(dev) (atomic_read(&dev->power.usage_count))
37 #define GET_USAGE_COUNT(dev) 1
40 int free_stream_context(struct intel_sst_drv *ctx, unsigned int str_id)
42 struct stream_info *stream;
45 stream = get_stream_info(ctx, str_id);
47 /* str_id is valid, so stream is alloacted */
48 ret = sst_free_stream(ctx, str_id);
50 sst_clean_stream(&ctx->streams[str_id]);
53 dev_err(ctx->dev, "we tried to free stream context %d which was freed!!!\n", str_id);
58 int sst_get_stream_allocated(struct intel_sst_drv *ctx,
59 struct snd_sst_params *str_param,
60 struct snd_sst_lib_download **lib_dnld)
64 retval = ctx->ops->alloc_stream(ctx, str_param);
66 dev_dbg(ctx->dev, "Stream allocated %d\n", retval);
72 * sst_get_sfreq - this function returns the frequency of the stream
74 * @str_param : stream params
76 int sst_get_sfreq(struct snd_sst_params *str_param)
78 switch (str_param->codec) {
79 case SST_CODEC_TYPE_PCM:
80 return str_param->sparams.uc.pcm_params.sfreq;
81 case SST_CODEC_TYPE_AAC:
82 return str_param->sparams.uc.aac_params.externalsr;
83 case SST_CODEC_TYPE_MP3:
91 * sst_get_num_channel - get number of channels for the stream
93 * @str_param : stream params
95 int sst_get_num_channel(struct snd_sst_params *str_param)
97 switch (str_param->codec) {
98 case SST_CODEC_TYPE_PCM:
99 return str_param->sparams.uc.pcm_params.num_chan;
100 case SST_CODEC_TYPE_MP3:
101 return str_param->sparams.uc.mp3_params.num_chan;
102 case SST_CODEC_TYPE_AAC:
103 return str_param->sparams.uc.aac_params.num_chan;
110 * sst_get_stream - this function prepares for stream allocation
112 * @str_param : stream param
114 int sst_get_stream(struct intel_sst_drv *ctx,
115 struct snd_sst_params *str_param)
118 struct stream_info *str_info;
120 /* stream is not allocated, we are allocating */
121 retval = ctx->ops->alloc_stream(ctx, str_param);
125 /* store sampling freq */
126 str_info = &ctx->streams[retval];
127 str_info->sfreq = sst_get_sfreq(str_param);
132 static int sst_power_control(struct device *dev, bool state)
134 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
139 ret = pm_runtime_resume_and_get(dev);
140 usage_count = GET_USAGE_COUNT(dev);
141 dev_dbg(ctx->dev, "Enable: pm usage count: %d\n", usage_count);
143 dev_err(ctx->dev, "Runtime get failed with err: %d\n", ret);
146 if ((ctx->sst_state == SST_RESET) && (usage_count == 1)) {
147 ret = sst_load_fw(ctx);
149 dev_err(dev, "FW download fail %d\n", ret);
150 sst_set_fw_state_locked(ctx, SST_RESET);
151 ret = sst_pm_runtime_put(ctx);
155 usage_count = GET_USAGE_COUNT(dev);
156 dev_dbg(ctx->dev, "Disable: pm usage count: %d\n", usage_count);
157 return sst_pm_runtime_put(ctx);
163 * sst_open_pcm_stream - Open PCM interface
165 * @str_param: parameters of pcm stream
167 * This function is called by MID sound card driver to open
168 * a new pcm interface
170 static int sst_open_pcm_stream(struct device *dev,
171 struct snd_sst_params *str_param)
174 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
179 retval = sst_get_stream(ctx, str_param);
183 dev_err(ctx->dev, "sst_get_stream returned err %d\n", retval);
188 static int sst_cdev_open(struct device *dev,
189 struct snd_sst_params *str_params, struct sst_compress_cb *cb)
192 struct stream_info *stream;
193 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
195 retval = pm_runtime_resume_and_get(ctx->dev);
199 str_id = sst_get_stream(ctx, str_params);
201 dev_dbg(dev, "stream allocated in sst_cdev_open %d\n", str_id);
202 stream = &ctx->streams[str_id];
203 stream->compr_cb = cb->compr_cb;
204 stream->compr_cb_param = cb->param;
205 stream->drain_notify = cb->drain_notify;
206 stream->drain_cb_param = cb->drain_cb_param;
208 dev_err(dev, "stream encountered error during alloc %d\n", str_id);
210 sst_pm_runtime_put(ctx);
215 static int sst_cdev_close(struct device *dev, unsigned int str_id)
218 struct stream_info *stream;
219 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
221 stream = get_stream_info(ctx, str_id);
223 dev_err(dev, "stream info is NULL for str %d!!!\n", str_id);
227 retval = sst_free_stream(ctx, str_id);
228 stream->compr_cb_param = NULL;
229 stream->compr_cb = NULL;
232 dev_err(dev, "free stream returned err %d\n", retval);
234 dev_dbg(dev, "End\n");
238 static int sst_cdev_ack(struct device *dev, unsigned int str_id,
241 struct stream_info *stream;
242 struct snd_sst_tstamp fw_tstamp = {0,};
245 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
247 stream = get_stream_info(ctx, str_id);
251 /* update bytes sent */
252 stream->cumm_bytes += bytes;
253 dev_dbg(dev, "bytes copied %d inc by %ld\n", stream->cumm_bytes, bytes);
255 addr = ((void __iomem *)(ctx->mailbox + ctx->tstamp)) +
256 (str_id * sizeof(fw_tstamp));
258 memcpy_fromio(&fw_tstamp, addr, sizeof(fw_tstamp));
260 fw_tstamp.bytes_copied = stream->cumm_bytes;
261 dev_dbg(dev, "bytes sent to fw %llu inc by %ld\n",
262 fw_tstamp.bytes_copied, bytes);
264 offset = offsetof(struct snd_sst_tstamp, bytes_copied);
265 sst_shim_write(addr, offset, fw_tstamp.bytes_copied);
269 static int sst_cdev_set_metadata(struct device *dev,
270 unsigned int str_id, struct snd_compr_metadata *metadata)
273 struct stream_info *str_info;
274 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
276 dev_dbg(dev, "set metadata for stream %d\n", str_id);
278 str_info = get_stream_info(ctx, str_id);
282 dev_dbg(dev, "pipe id = %d\n", str_info->pipe_id);
283 retval = sst_prepare_and_post_msg(ctx, str_info->task_id, IPC_CMD,
284 IPC_IA_SET_STREAM_PARAMS_MRFLD, str_info->pipe_id,
285 sizeof(*metadata), metadata, NULL,
286 true, true, true, false);
291 static int sst_cdev_stream_pause(struct device *dev, unsigned int str_id)
293 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
295 return sst_pause_stream(ctx, str_id);
298 static int sst_cdev_stream_pause_release(struct device *dev,
301 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
303 return sst_resume_stream(ctx, str_id);
306 static int sst_cdev_stream_start(struct device *dev, unsigned int str_id)
308 struct stream_info *str_info;
309 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
311 str_info = get_stream_info(ctx, str_id);
314 str_info->prev = str_info->status;
315 str_info->status = STREAM_RUNNING;
316 return sst_start_stream(ctx, str_id);
319 static int sst_cdev_stream_drop(struct device *dev, unsigned int str_id)
321 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
323 return sst_drop_stream(ctx, str_id);
326 static int sst_cdev_stream_drain(struct device *dev, unsigned int str_id)
328 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
330 return sst_drain_stream(ctx, str_id, false);
333 static int sst_cdev_stream_partial_drain(struct device *dev,
336 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
338 return sst_drain_stream(ctx, str_id, true);
341 static int sst_cdev_tstamp(struct device *dev, unsigned int str_id,
342 struct snd_compr_tstamp *tstamp)
344 struct snd_sst_tstamp fw_tstamp = {0,};
345 struct stream_info *stream;
346 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
349 addr = (void __iomem *)(ctx->mailbox + ctx->tstamp) +
350 (str_id * sizeof(fw_tstamp));
352 memcpy_fromio(&fw_tstamp, addr, sizeof(fw_tstamp));
354 stream = get_stream_info(ctx, str_id);
357 dev_dbg(dev, "rb_counter %llu in bytes\n", fw_tstamp.ring_buffer_counter);
359 tstamp->copied_total = fw_tstamp.ring_buffer_counter;
360 tstamp->pcm_frames = fw_tstamp.frames_decoded;
361 tstamp->pcm_io_frames = div_u64(fw_tstamp.hardware_counter,
362 (u64)stream->num_ch * SST_GET_BYTES_PER_SAMPLE(24));
363 tstamp->sampling_rate = fw_tstamp.sampling_frequency;
365 dev_dbg(dev, "PCM = %u\n", tstamp->pcm_io_frames);
366 dev_dbg(dev, "Ptr Query on strid = %d copied_total %d, decodec %d\n",
367 str_id, tstamp->copied_total, tstamp->pcm_frames);
368 dev_dbg(dev, "rendered %d\n", tstamp->pcm_io_frames);
373 static int sst_cdev_caps(struct snd_compr_caps *caps)
375 caps->num_codecs = NUM_CODEC;
376 caps->min_fragment_size = MIN_FRAGMENT_SIZE; /* 50KB */
377 caps->max_fragment_size = MAX_FRAGMENT_SIZE; /* 1024KB */
378 caps->min_fragments = MIN_FRAGMENT;
379 caps->max_fragments = MAX_FRAGMENT;
380 caps->codecs[0] = SND_AUDIOCODEC_MP3;
381 caps->codecs[1] = SND_AUDIOCODEC_AAC;
385 static const struct snd_compr_codec_caps caps_mp3 = {
386 .num_descriptors = 1,
387 .descriptor[0].max_ch = 2,
388 .descriptor[0].sample_rates[0] = 48000,
389 .descriptor[0].sample_rates[1] = 44100,
390 .descriptor[0].sample_rates[2] = 32000,
391 .descriptor[0].sample_rates[3] = 16000,
392 .descriptor[0].sample_rates[4] = 8000,
393 .descriptor[0].num_sample_rates = 5,
394 .descriptor[0].bit_rate[0] = 320,
395 .descriptor[0].bit_rate[1] = 192,
396 .descriptor[0].num_bitrates = 2,
397 .descriptor[0].profiles = 0,
398 .descriptor[0].modes = SND_AUDIOCHANMODE_MP3_STEREO,
399 .descriptor[0].formats = 0,
402 static const struct snd_compr_codec_caps caps_aac = {
403 .num_descriptors = 2,
404 .descriptor[1].max_ch = 2,
405 .descriptor[0].sample_rates[0] = 48000,
406 .descriptor[0].sample_rates[1] = 44100,
407 .descriptor[0].sample_rates[2] = 32000,
408 .descriptor[0].sample_rates[3] = 16000,
409 .descriptor[0].sample_rates[4] = 8000,
410 .descriptor[0].num_sample_rates = 5,
411 .descriptor[1].bit_rate[0] = 320,
412 .descriptor[1].bit_rate[1] = 192,
413 .descriptor[1].num_bitrates = 2,
414 .descriptor[1].profiles = 0,
415 .descriptor[1].modes = 0,
416 .descriptor[1].formats =
417 (SND_AUDIOSTREAMFORMAT_MP4ADTS |
418 SND_AUDIOSTREAMFORMAT_RAW),
421 static int sst_cdev_codec_caps(struct snd_compr_codec_caps *codec)
423 if (codec->codec == SND_AUDIOCODEC_MP3)
425 else if (codec->codec == SND_AUDIOCODEC_AAC)
433 void sst_cdev_fragment_elapsed(struct intel_sst_drv *ctx, int str_id)
435 struct stream_info *stream;
437 dev_dbg(ctx->dev, "fragment elapsed from firmware for str_id %d\n",
439 stream = &ctx->streams[str_id];
440 if (stream->compr_cb)
441 stream->compr_cb(stream->compr_cb_param);
445 * sst_close_pcm_stream - Close PCM interface
447 * @str_id: stream id to be closed
449 * This function is called by MID sound card driver to close
450 * an existing pcm interface
452 static int sst_close_pcm_stream(struct device *dev, unsigned int str_id)
454 struct stream_info *stream;
456 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
458 stream = get_stream_info(ctx, str_id);
460 dev_err(ctx->dev, "stream info is NULL for str %d!!!\n", str_id);
464 retval = free_stream_context(ctx, str_id);
465 stream->pcm_substream = NULL;
466 stream->status = STREAM_UN_INIT;
467 stream->period_elapsed = NULL;
471 dev_err(ctx->dev, "free stream returned err %d\n", retval);
473 dev_dbg(ctx->dev, "Exit\n");
477 static inline int sst_calc_tstamp(struct intel_sst_drv *ctx,
478 struct pcm_stream_info *info,
479 struct snd_pcm_substream *substream,
480 struct snd_sst_tstamp *fw_tstamp)
482 size_t delay_bytes, delay_frames;
484 u32 pointer_bytes, pointer_samples;
486 dev_dbg(ctx->dev, "mrfld ring_buffer_counter %llu in bytes\n",
487 fw_tstamp->ring_buffer_counter);
488 dev_dbg(ctx->dev, "mrfld hardware_counter %llu in bytes\n",
489 fw_tstamp->hardware_counter);
490 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
491 delay_bytes = (size_t) (fw_tstamp->ring_buffer_counter -
492 fw_tstamp->hardware_counter);
494 delay_bytes = (size_t) (fw_tstamp->hardware_counter -
495 fw_tstamp->ring_buffer_counter);
496 delay_frames = bytes_to_frames(substream->runtime, delay_bytes);
497 buffer_sz = snd_pcm_lib_buffer_bytes(substream);
498 div_u64_rem(fw_tstamp->ring_buffer_counter, buffer_sz, &pointer_bytes);
499 pointer_samples = bytes_to_samples(substream->runtime, pointer_bytes);
501 dev_dbg(ctx->dev, "pcm delay %zu in bytes\n", delay_bytes);
503 info->buffer_ptr = pointer_samples / substream->runtime->channels;
505 info->pcm_delay = delay_frames;
506 dev_dbg(ctx->dev, "buffer ptr %llu pcm_delay rep: %llu\n",
507 info->buffer_ptr, info->pcm_delay);
511 static int sst_read_timestamp(struct device *dev, struct pcm_stream_info *info)
513 struct stream_info *stream;
514 struct snd_pcm_substream *substream;
515 struct snd_sst_tstamp fw_tstamp;
517 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
520 str_id = info->str_id;
521 stream = get_stream_info(ctx, str_id);
525 if (!stream->pcm_substream)
527 substream = stream->pcm_substream;
529 addr = (void __iomem *)(ctx->mailbox + ctx->tstamp) +
530 (str_id * sizeof(fw_tstamp));
532 memcpy_fromio(&fw_tstamp, addr, sizeof(fw_tstamp));
534 return sst_calc_tstamp(ctx, info, substream, &fw_tstamp);
537 static int sst_stream_start(struct device *dev, int str_id)
539 struct stream_info *str_info;
540 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
542 if (ctx->sst_state != SST_FW_RUNNING)
544 str_info = get_stream_info(ctx, str_id);
547 str_info->prev = str_info->status;
548 str_info->status = STREAM_RUNNING;
549 sst_start_stream(ctx, str_id);
554 static int sst_stream_drop(struct device *dev, int str_id)
556 struct stream_info *str_info;
557 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
559 if (ctx->sst_state != SST_FW_RUNNING)
562 str_info = get_stream_info(ctx, str_id);
565 str_info->prev = STREAM_UN_INIT;
566 str_info->status = STREAM_INIT;
567 return sst_drop_stream(ctx, str_id);
570 static int sst_stream_pause(struct device *dev, int str_id)
572 struct stream_info *str_info;
573 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
575 if (ctx->sst_state != SST_FW_RUNNING)
578 str_info = get_stream_info(ctx, str_id);
582 return sst_pause_stream(ctx, str_id);
585 static int sst_stream_resume(struct device *dev, int str_id)
587 struct stream_info *str_info;
588 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
590 if (ctx->sst_state != SST_FW_RUNNING)
593 str_info = get_stream_info(ctx, str_id);
596 return sst_resume_stream(ctx, str_id);
599 static int sst_stream_init(struct device *dev, struct pcm_stream_info *str_info)
602 struct stream_info *stream;
603 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
605 str_id = str_info->str_id;
607 if (ctx->sst_state != SST_FW_RUNNING)
610 stream = get_stream_info(ctx, str_id);
614 dev_dbg(ctx->dev, "setting the period ptrs\n");
615 stream->pcm_substream = str_info->arg;
616 stream->period_elapsed = str_info->period_elapsed;
617 stream->sfreq = str_info->sfreq;
618 stream->prev = stream->status;
619 stream->status = STREAM_INIT;
621 "pcm_substream %p, period_elapsed %p, sfreq %d, status %d\n",
622 stream->pcm_substream, stream->period_elapsed,
623 stream->sfreq, stream->status);
629 * sst_set_byte_stream - Set generic params
631 * @cmd: control cmd to be set
632 * @arg: command argument
634 * This function is called by MID sound card driver to configure
635 * SST runtime params.
637 static int sst_send_byte_stream(struct device *dev,
638 struct snd_sst_bytes_v2 *bytes)
641 struct intel_sst_drv *ctx = dev_get_drvdata(dev);
645 ret_val = pm_runtime_resume_and_get(ctx->dev);
649 ret_val = sst_send_byte_stream_mrfld(ctx, bytes);
650 sst_pm_runtime_put(ctx);
655 static struct sst_ops pcm_ops = {
656 .open = sst_open_pcm_stream,
657 .stream_init = sst_stream_init,
658 .stream_start = sst_stream_start,
659 .stream_drop = sst_stream_drop,
660 .stream_pause = sst_stream_pause,
661 .stream_pause_release = sst_stream_resume,
662 .stream_read_tstamp = sst_read_timestamp,
663 .send_byte_stream = sst_send_byte_stream,
664 .close = sst_close_pcm_stream,
665 .power = sst_power_control,
668 static struct compress_sst_ops compr_ops = {
669 .open = sst_cdev_open,
670 .close = sst_cdev_close,
671 .stream_pause = sst_cdev_stream_pause,
672 .stream_pause_release = sst_cdev_stream_pause_release,
673 .stream_start = sst_cdev_stream_start,
674 .stream_drop = sst_cdev_stream_drop,
675 .stream_drain = sst_cdev_stream_drain,
676 .stream_partial_drain = sst_cdev_stream_partial_drain,
677 .tstamp = sst_cdev_tstamp,
679 .get_caps = sst_cdev_caps,
680 .get_codec_caps = sst_cdev_codec_caps,
681 .set_metadata = sst_cdev_set_metadata,
682 .power = sst_power_control,
685 static struct sst_device sst_dsp_device = {
686 .name = "Intel(R) SST LPE",
689 .compr_ops = &compr_ops,
693 * sst_register - function to register DSP
695 * This functions registers DSP with the platform driver
697 int sst_register(struct device *dev)
701 sst_dsp_device.dev = dev;
702 ret_val = sst_register_dsp(&sst_dsp_device);
704 dev_err(dev, "Unable to register DSP with platform driver\n");
709 int sst_unregister(struct device *dev)
711 return sst_unregister_dsp(&sst_dsp_device);