162306a36Sopenharmony_ci// SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause)
262306a36Sopenharmony_ci//
362306a36Sopenharmony_ci// This file is provided under a dual BSD/GPLv2 license.  When using or
462306a36Sopenharmony_ci// redistributing this file, you may do so under either license.
562306a36Sopenharmony_ci//
662306a36Sopenharmony_ci// Copyright(c) 2018 Intel Corporation. All rights reserved.
762306a36Sopenharmony_ci//
862306a36Sopenharmony_ci// Authors: Liam Girdwood <liam.r.girdwood@linux.intel.com>
962306a36Sopenharmony_ci//	    Ranjani Sridharan <ranjani.sridharan@linux.intel.com>
1062306a36Sopenharmony_ci//	    Rander Wang <rander.wang@intel.com>
1162306a36Sopenharmony_ci//          Keyon Jie <yang.jie@linux.intel.com>
1262306a36Sopenharmony_ci//
1362306a36Sopenharmony_ci
1462306a36Sopenharmony_ci/*
1562306a36Sopenharmony_ci * Hardware interface for generic Intel audio DSP HDA IP
1662306a36Sopenharmony_ci */
1762306a36Sopenharmony_ci
1862306a36Sopenharmony_ci#include <linux/moduleparam.h>
1962306a36Sopenharmony_ci#include <sound/hda_register.h>
2062306a36Sopenharmony_ci#include <sound/pcm_params.h>
2162306a36Sopenharmony_ci#include <trace/events/sof_intel.h>
2262306a36Sopenharmony_ci#include "../sof-audio.h"
2362306a36Sopenharmony_ci#include "../ops.h"
2462306a36Sopenharmony_ci#include "hda.h"
2562306a36Sopenharmony_ci
2662306a36Sopenharmony_ci#define SDnFMT_BASE(x)	((x) << 14)
2762306a36Sopenharmony_ci#define SDnFMT_MULT(x)	(((x) - 1) << 11)
2862306a36Sopenharmony_ci#define SDnFMT_DIV(x)	(((x) - 1) << 8)
2962306a36Sopenharmony_ci#define SDnFMT_BITS(x)	((x) << 4)
3062306a36Sopenharmony_ci#define SDnFMT_CHAN(x)	((x) << 0)
3162306a36Sopenharmony_ci
3262306a36Sopenharmony_cistatic bool hda_always_enable_dmi_l1;
3362306a36Sopenharmony_cimodule_param_named(always_enable_dmi_l1, hda_always_enable_dmi_l1, bool, 0444);
3462306a36Sopenharmony_ciMODULE_PARM_DESC(always_enable_dmi_l1, "SOF HDA always enable DMI l1");
3562306a36Sopenharmony_ci
3662306a36Sopenharmony_cistatic bool hda_disable_rewinds;
3762306a36Sopenharmony_cimodule_param_named(disable_rewinds, hda_disable_rewinds, bool, 0444);
3862306a36Sopenharmony_ciMODULE_PARM_DESC(disable_rewinds, "SOF HDA disable rewinds");
3962306a36Sopenharmony_ci
4062306a36Sopenharmony_ciu32 hda_dsp_get_mult_div(struct snd_sof_dev *sdev, int rate)
4162306a36Sopenharmony_ci{
4262306a36Sopenharmony_ci	switch (rate) {
4362306a36Sopenharmony_ci	case 8000:
4462306a36Sopenharmony_ci		return SDnFMT_DIV(6);
4562306a36Sopenharmony_ci	case 9600:
4662306a36Sopenharmony_ci		return SDnFMT_DIV(5);
4762306a36Sopenharmony_ci	case 11025:
4862306a36Sopenharmony_ci		return SDnFMT_BASE(1) | SDnFMT_DIV(4);
4962306a36Sopenharmony_ci	case 16000:
5062306a36Sopenharmony_ci		return SDnFMT_DIV(3);
5162306a36Sopenharmony_ci	case 22050:
5262306a36Sopenharmony_ci		return SDnFMT_BASE(1) | SDnFMT_DIV(2);
5362306a36Sopenharmony_ci	case 32000:
5462306a36Sopenharmony_ci		return SDnFMT_DIV(3) | SDnFMT_MULT(2);
5562306a36Sopenharmony_ci	case 44100:
5662306a36Sopenharmony_ci		return SDnFMT_BASE(1);
5762306a36Sopenharmony_ci	case 48000:
5862306a36Sopenharmony_ci		return 0;
5962306a36Sopenharmony_ci	case 88200:
6062306a36Sopenharmony_ci		return SDnFMT_BASE(1) | SDnFMT_MULT(2);
6162306a36Sopenharmony_ci	case 96000:
6262306a36Sopenharmony_ci		return SDnFMT_MULT(2);
6362306a36Sopenharmony_ci	case 176400:
6462306a36Sopenharmony_ci		return SDnFMT_BASE(1) | SDnFMT_MULT(4);
6562306a36Sopenharmony_ci	case 192000:
6662306a36Sopenharmony_ci		return SDnFMT_MULT(4);
6762306a36Sopenharmony_ci	default:
6862306a36Sopenharmony_ci		dev_warn(sdev->dev, "can't find div rate %d using 48kHz\n",
6962306a36Sopenharmony_ci			 rate);
7062306a36Sopenharmony_ci		return 0; /* use 48KHz if not found */
7162306a36Sopenharmony_ci	}
7262306a36Sopenharmony_ci};
7362306a36Sopenharmony_ci
7462306a36Sopenharmony_ciu32 hda_dsp_get_bits(struct snd_sof_dev *sdev, int sample_bits)
7562306a36Sopenharmony_ci{
7662306a36Sopenharmony_ci	switch (sample_bits) {
7762306a36Sopenharmony_ci	case 8:
7862306a36Sopenharmony_ci		return SDnFMT_BITS(0);
7962306a36Sopenharmony_ci	case 16:
8062306a36Sopenharmony_ci		return SDnFMT_BITS(1);
8162306a36Sopenharmony_ci	case 20:
8262306a36Sopenharmony_ci		return SDnFMT_BITS(2);
8362306a36Sopenharmony_ci	case 24:
8462306a36Sopenharmony_ci		return SDnFMT_BITS(3);
8562306a36Sopenharmony_ci	case 32:
8662306a36Sopenharmony_ci		return SDnFMT_BITS(4);
8762306a36Sopenharmony_ci	default:
8862306a36Sopenharmony_ci		dev_warn(sdev->dev, "can't find %d bits using 16bit\n",
8962306a36Sopenharmony_ci			 sample_bits);
9062306a36Sopenharmony_ci		return SDnFMT_BITS(1); /* use 16bits format if not found */
9162306a36Sopenharmony_ci	}
9262306a36Sopenharmony_ci};
9362306a36Sopenharmony_ci
9462306a36Sopenharmony_ciint hda_dsp_pcm_hw_params(struct snd_sof_dev *sdev,
9562306a36Sopenharmony_ci			  struct snd_pcm_substream *substream,
9662306a36Sopenharmony_ci			  struct snd_pcm_hw_params *params,
9762306a36Sopenharmony_ci			  struct snd_sof_platform_stream_params *platform_params)
9862306a36Sopenharmony_ci{
9962306a36Sopenharmony_ci	struct hdac_stream *hstream = substream->runtime->private_data;
10062306a36Sopenharmony_ci	struct hdac_ext_stream *hext_stream = stream_to_hdac_ext_stream(hstream);
10162306a36Sopenharmony_ci	struct sof_intel_hda_dev *hda = sdev->pdata->hw_pdata;
10262306a36Sopenharmony_ci	struct snd_dma_buffer *dmab;
10362306a36Sopenharmony_ci	int ret;
10462306a36Sopenharmony_ci
10562306a36Sopenharmony_ci	hstream->substream = substream;
10662306a36Sopenharmony_ci
10762306a36Sopenharmony_ci	dmab = substream->runtime->dma_buffer_p;
10862306a36Sopenharmony_ci
10962306a36Sopenharmony_ci	/*
11062306a36Sopenharmony_ci	 * Use the codec required format val (which is link_bps adjusted) when
11162306a36Sopenharmony_ci	 * the DSP is not in use
11262306a36Sopenharmony_ci	 */
11362306a36Sopenharmony_ci	if (!sdev->dspless_mode_selected) {
11462306a36Sopenharmony_ci		u32 rate = hda_dsp_get_mult_div(sdev, params_rate(params));
11562306a36Sopenharmony_ci		u32 bits = hda_dsp_get_bits(sdev, params_width(params));
11662306a36Sopenharmony_ci
11762306a36Sopenharmony_ci		hstream->format_val = rate | bits | (params_channels(params) - 1);
11862306a36Sopenharmony_ci	}
11962306a36Sopenharmony_ci
12062306a36Sopenharmony_ci	hstream->bufsize = params_buffer_bytes(params);
12162306a36Sopenharmony_ci	hstream->period_bytes = params_period_bytes(params);
12262306a36Sopenharmony_ci	hstream->no_period_wakeup  =
12362306a36Sopenharmony_ci			(params->info & SNDRV_PCM_INFO_NO_PERIOD_WAKEUP) &&
12462306a36Sopenharmony_ci			(params->flags & SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP);
12562306a36Sopenharmony_ci
12662306a36Sopenharmony_ci	ret = hda_dsp_stream_hw_params(sdev, hext_stream, dmab, params);
12762306a36Sopenharmony_ci	if (ret < 0) {
12862306a36Sopenharmony_ci		dev_err(sdev->dev, "error: hdac prepare failed: %d\n", ret);
12962306a36Sopenharmony_ci		return ret;
13062306a36Sopenharmony_ci	}
13162306a36Sopenharmony_ci
13262306a36Sopenharmony_ci	/* enable SPIB when rewinds are disabled */
13362306a36Sopenharmony_ci	if (hda_disable_rewinds)
13462306a36Sopenharmony_ci		hda_dsp_stream_spib_config(sdev, hext_stream, HDA_DSP_SPIB_ENABLE, 0);
13562306a36Sopenharmony_ci	else
13662306a36Sopenharmony_ci		hda_dsp_stream_spib_config(sdev, hext_stream, HDA_DSP_SPIB_DISABLE, 0);
13762306a36Sopenharmony_ci
13862306a36Sopenharmony_ci	if (hda)
13962306a36Sopenharmony_ci		platform_params->no_ipc_position = hda->no_ipc_position;
14062306a36Sopenharmony_ci
14162306a36Sopenharmony_ci	platform_params->stream_tag = hstream->stream_tag;
14262306a36Sopenharmony_ci
14362306a36Sopenharmony_ci	return 0;
14462306a36Sopenharmony_ci}
14562306a36Sopenharmony_ci
14662306a36Sopenharmony_ci/* update SPIB register with appl position */
14762306a36Sopenharmony_ciint hda_dsp_pcm_ack(struct snd_sof_dev *sdev, struct snd_pcm_substream *substream)
14862306a36Sopenharmony_ci{
14962306a36Sopenharmony_ci	struct hdac_stream *hstream = substream->runtime->private_data;
15062306a36Sopenharmony_ci	struct snd_pcm_runtime *runtime = substream->runtime;
15162306a36Sopenharmony_ci	ssize_t appl_pos, buf_size;
15262306a36Sopenharmony_ci	u32 spib;
15362306a36Sopenharmony_ci
15462306a36Sopenharmony_ci	appl_pos = frames_to_bytes(runtime, runtime->control->appl_ptr);
15562306a36Sopenharmony_ci	buf_size = frames_to_bytes(runtime, runtime->buffer_size);
15662306a36Sopenharmony_ci
15762306a36Sopenharmony_ci	spib = appl_pos % buf_size;
15862306a36Sopenharmony_ci
15962306a36Sopenharmony_ci	/* Allowable value for SPIB is 1 byte to max buffer size */
16062306a36Sopenharmony_ci	if (!spib)
16162306a36Sopenharmony_ci		spib = buf_size;
16262306a36Sopenharmony_ci
16362306a36Sopenharmony_ci	sof_io_write(sdev, hstream->spib_addr, spib);
16462306a36Sopenharmony_ci
16562306a36Sopenharmony_ci	return 0;
16662306a36Sopenharmony_ci}
16762306a36Sopenharmony_ci
16862306a36Sopenharmony_ciint hda_dsp_pcm_trigger(struct snd_sof_dev *sdev,
16962306a36Sopenharmony_ci			struct snd_pcm_substream *substream, int cmd)
17062306a36Sopenharmony_ci{
17162306a36Sopenharmony_ci	struct hdac_stream *hstream = substream->runtime->private_data;
17262306a36Sopenharmony_ci	struct hdac_ext_stream *hext_stream = stream_to_hdac_ext_stream(hstream);
17362306a36Sopenharmony_ci
17462306a36Sopenharmony_ci	return hda_dsp_stream_trigger(sdev, hext_stream, cmd);
17562306a36Sopenharmony_ci}
17662306a36Sopenharmony_ci
17762306a36Sopenharmony_cisnd_pcm_uframes_t hda_dsp_pcm_pointer(struct snd_sof_dev *sdev,
17862306a36Sopenharmony_ci				      struct snd_pcm_substream *substream)
17962306a36Sopenharmony_ci{
18062306a36Sopenharmony_ci	struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
18162306a36Sopenharmony_ci	struct snd_soc_component *scomp = sdev->component;
18262306a36Sopenharmony_ci	struct hdac_stream *hstream = substream->runtime->private_data;
18362306a36Sopenharmony_ci	struct sof_intel_hda_dev *hda = sdev->pdata->hw_pdata;
18462306a36Sopenharmony_ci	struct snd_sof_pcm *spcm;
18562306a36Sopenharmony_ci	snd_pcm_uframes_t pos;
18662306a36Sopenharmony_ci
18762306a36Sopenharmony_ci	spcm = snd_sof_find_spcm_dai(scomp, rtd);
18862306a36Sopenharmony_ci	if (!spcm) {
18962306a36Sopenharmony_ci		dev_warn_ratelimited(sdev->dev, "warn: can't find PCM with DAI ID %d\n",
19062306a36Sopenharmony_ci				     rtd->dai_link->id);
19162306a36Sopenharmony_ci		return 0;
19262306a36Sopenharmony_ci	}
19362306a36Sopenharmony_ci
19462306a36Sopenharmony_ci	if (hda && !hda->no_ipc_position) {
19562306a36Sopenharmony_ci		/* read position from IPC position */
19662306a36Sopenharmony_ci		pos = spcm->stream[substream->stream].posn.host_posn;
19762306a36Sopenharmony_ci		goto found;
19862306a36Sopenharmony_ci	}
19962306a36Sopenharmony_ci
20062306a36Sopenharmony_ci	pos = hda_dsp_stream_get_position(hstream, substream->stream, true);
20162306a36Sopenharmony_cifound:
20262306a36Sopenharmony_ci	pos = bytes_to_frames(substream->runtime, pos);
20362306a36Sopenharmony_ci
20462306a36Sopenharmony_ci	trace_sof_intel_hda_dsp_pcm(sdev, hstream, substream, pos);
20562306a36Sopenharmony_ci	return pos;
20662306a36Sopenharmony_ci}
20762306a36Sopenharmony_ci
20862306a36Sopenharmony_ciint hda_dsp_pcm_open(struct snd_sof_dev *sdev,
20962306a36Sopenharmony_ci		     struct snd_pcm_substream *substream)
21062306a36Sopenharmony_ci{
21162306a36Sopenharmony_ci	struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
21262306a36Sopenharmony_ci	struct snd_pcm_runtime *runtime = substream->runtime;
21362306a36Sopenharmony_ci	struct snd_soc_component *scomp = sdev->component;
21462306a36Sopenharmony_ci	struct hdac_ext_stream *dsp_stream;
21562306a36Sopenharmony_ci	struct snd_sof_pcm *spcm;
21662306a36Sopenharmony_ci	int direction = substream->stream;
21762306a36Sopenharmony_ci	u32 flags = 0;
21862306a36Sopenharmony_ci
21962306a36Sopenharmony_ci	spcm = snd_sof_find_spcm_dai(scomp, rtd);
22062306a36Sopenharmony_ci	if (!spcm) {
22162306a36Sopenharmony_ci		dev_err(sdev->dev, "error: can't find PCM with DAI ID %d\n", rtd->dai_link->id);
22262306a36Sopenharmony_ci		return -EINVAL;
22362306a36Sopenharmony_ci	}
22462306a36Sopenharmony_ci
22562306a36Sopenharmony_ci	/*
22662306a36Sopenharmony_ci	 * if we want the .ack to work, we need to prevent the control from being mapped.
22762306a36Sopenharmony_ci	 * The status can still be mapped.
22862306a36Sopenharmony_ci	 */
22962306a36Sopenharmony_ci	if (hda_disable_rewinds)
23062306a36Sopenharmony_ci		runtime->hw.info |= SNDRV_PCM_INFO_NO_REWINDS | SNDRV_PCM_INFO_SYNC_APPLPTR;
23162306a36Sopenharmony_ci
23262306a36Sopenharmony_ci	/*
23362306a36Sopenharmony_ci	 * All playback streams are DMI L1 capable, capture streams need
23462306a36Sopenharmony_ci	 * pause push/release to be disabled
23562306a36Sopenharmony_ci	 */
23662306a36Sopenharmony_ci	if (hda_always_enable_dmi_l1 && direction == SNDRV_PCM_STREAM_CAPTURE)
23762306a36Sopenharmony_ci		runtime->hw.info &= ~SNDRV_PCM_INFO_PAUSE;
23862306a36Sopenharmony_ci
23962306a36Sopenharmony_ci	if (hda_always_enable_dmi_l1 ||
24062306a36Sopenharmony_ci	    direction == SNDRV_PCM_STREAM_PLAYBACK ||
24162306a36Sopenharmony_ci	    spcm->stream[substream->stream].d0i3_compatible)
24262306a36Sopenharmony_ci		flags |= SOF_HDA_STREAM_DMI_L1_COMPATIBLE;
24362306a36Sopenharmony_ci
24462306a36Sopenharmony_ci	dsp_stream = hda_dsp_stream_get(sdev, direction, flags);
24562306a36Sopenharmony_ci	if (!dsp_stream) {
24662306a36Sopenharmony_ci		dev_err(sdev->dev, "error: no stream available\n");
24762306a36Sopenharmony_ci		return -ENODEV;
24862306a36Sopenharmony_ci	}
24962306a36Sopenharmony_ci
25062306a36Sopenharmony_ci	/* minimum as per HDA spec */
25162306a36Sopenharmony_ci	snd_pcm_hw_constraint_step(substream->runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_BYTES, 4);
25262306a36Sopenharmony_ci
25362306a36Sopenharmony_ci	/* avoid circular buffer wrap in middle of period */
25462306a36Sopenharmony_ci	snd_pcm_hw_constraint_integer(substream->runtime,
25562306a36Sopenharmony_ci				      SNDRV_PCM_HW_PARAM_PERIODS);
25662306a36Sopenharmony_ci
25762306a36Sopenharmony_ci	/* Only S16 and S32 supported by HDA hardware when used without DSP */
25862306a36Sopenharmony_ci	if (sdev->dspless_mode_selected)
25962306a36Sopenharmony_ci		snd_pcm_hw_constraint_mask64(substream->runtime, SNDRV_PCM_HW_PARAM_FORMAT,
26062306a36Sopenharmony_ci					     SNDRV_PCM_FMTBIT_S16 | SNDRV_PCM_FMTBIT_S32);
26162306a36Sopenharmony_ci
26262306a36Sopenharmony_ci	/* binding pcm substream to hda stream */
26362306a36Sopenharmony_ci	substream->runtime->private_data = &dsp_stream->hstream;
26462306a36Sopenharmony_ci	return 0;
26562306a36Sopenharmony_ci}
26662306a36Sopenharmony_ci
26762306a36Sopenharmony_ciint hda_dsp_pcm_close(struct snd_sof_dev *sdev,
26862306a36Sopenharmony_ci		      struct snd_pcm_substream *substream)
26962306a36Sopenharmony_ci{
27062306a36Sopenharmony_ci	struct hdac_stream *hstream = substream->runtime->private_data;
27162306a36Sopenharmony_ci	int direction = substream->stream;
27262306a36Sopenharmony_ci	int ret;
27362306a36Sopenharmony_ci
27462306a36Sopenharmony_ci	ret = hda_dsp_stream_put(sdev, direction, hstream->stream_tag);
27562306a36Sopenharmony_ci
27662306a36Sopenharmony_ci	if (ret) {
27762306a36Sopenharmony_ci		dev_dbg(sdev->dev, "stream %s not opened!\n", substream->name);
27862306a36Sopenharmony_ci		return -ENODEV;
27962306a36Sopenharmony_ci	}
28062306a36Sopenharmony_ci
28162306a36Sopenharmony_ci	/* unbinding pcm substream to hda stream */
28262306a36Sopenharmony_ci	substream->runtime->private_data = NULL;
28362306a36Sopenharmony_ci	return 0;
28462306a36Sopenharmony_ci}
285