[mirror_ubuntu-zesty-kernel.git] / sound / soc / soc-generic-dmaengine-pcm.c

/*
 *  Copyright (C) 2013, Analog Devices Inc.
 *	Author: Lars-Peter Clausen <lars@metafoo.de>
 *
 *  This program is free software; you can redistribute it and/or modify it
 *  under  the terms of the GNU General  Public License as published by the
 *  Free Software Foundation;  either version 2 of the License, or (at your
 *  option) any later version.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  675 Mass Ave, Cambridge, MA 02139, USA.
 *
 */
#include <linux/module.h>
#include <linux/init.h>
#include <linux/dmaengine.h>
#include <linux/slab.h>
#include <sound/pcm.h>
#include <sound/pcm_params.h>
#include <sound/soc.h>
#include <linux/dma-mapping.h>
#include <linux/of.h>

#include <sound/dmaengine_pcm.h>

struct dmaengine_pcm {
	struct dma_chan *chan[SNDRV_PCM_STREAM_LAST + 1];
	const struct snd_dmaengine_pcm_config *config;
	struct snd_soc_platform platform;
	unsigned int flags;
};

static struct dmaengine_pcm *soc_platform_to_pcm(struct snd_soc_platform *p)
{
	return container_of(p, struct dmaengine_pcm, platform);
}

static struct device *dmaengine_dma_dev(struct dmaengine_pcm *pcm,
	struct snd_pcm_substream *substream)
{
	if (!pcm->chan[substream->stream])
		return NULL;

	return pcm->chan[substream->stream]->device->dev;
}

/**
 * snd_dmaengine_pcm_prepare_slave_config() - Generic prepare_slave_config callback
 * @substream: PCM substream
 * @params: hw_params
 * @slave_config: DMA slave config to prepare
 *
 * This function can be used as a generic prepare_slave_config callback for
 * platforms which make use of the snd_dmaengine_dai_dma_data struct for their
 * DAI DMA data. Internally the function will first call
 * snd_hwparams_to_dma_slave_config to fill in the slave config based on the
 * hw_params, followed by snd_dmaengine_set_config_from_dai_data to fill in the
 * remaining fields based on the DAI DMA data.
 */
int snd_dmaengine_pcm_prepare_slave_config(struct snd_pcm_substream *substream,
	struct snd_pcm_hw_params *params, struct dma_slave_config *slave_config)
{
	struct snd_soc_pcm_runtime *rtd = substream->private_data;
	struct snd_dmaengine_dai_dma_data *dma_data;
	int ret;

	dma_data = snd_soc_dai_get_dma_data(rtd->cpu_dai, substream);

	ret = snd_hwparams_to_dma_slave_config(substream, params, slave_config);
	if (ret)
		return ret;

	snd_dmaengine_pcm_set_config_from_dai_data(substream, dma_data,
		slave_config);

	return 0;
}
EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_prepare_slave_config);

static int dmaengine_pcm_hw_params(struct snd_pcm_substream *substream,
	struct snd_pcm_hw_params *params)
{
	struct snd_soc_pcm_runtime *rtd = substream->private_data;
	struct dmaengine_pcm *pcm = soc_platform_to_pcm(rtd->platform);
	struct dma_chan *chan = snd_dmaengine_pcm_get_chan(substream);
	int (*prepare_slave_config)(struct snd_pcm_substream *substream,
			struct snd_pcm_hw_params *params,
			struct dma_slave_config *slave_config);
	struct dma_slave_config slave_config;
	int ret;

	memset(&slave_config, 0, sizeof(slave_config));

	if (!pcm->config)
		prepare_slave_config = snd_dmaengine_pcm_prepare_slave_config;
	else
		prepare_slave_config = pcm->config->prepare_slave_config;

	if (prepare_slave_config) {
		ret = prepare_slave_config(substream, params, &slave_config);
		if (ret)
			return ret;

		ret = dmaengine_slave_config(chan, &slave_config);
		if (ret)
			return ret;
	}

	return snd_pcm_lib_malloc_pages(substream, params_buffer_bytes(params));
}

static int dmaengine_pcm_set_runtime_hwparams(struct snd_pcm_substream *substream)
{
	struct snd_soc_pcm_runtime *rtd = substream->private_data;
	struct dmaengine_pcm *pcm = soc_platform_to_pcm(rtd->platform);
	struct device *dma_dev = dmaengine_dma_dev(pcm, substream);
	struct dma_chan *chan = pcm->chan[substream->stream];
	struct snd_dmaengine_dai_dma_data *dma_data;
	struct dma_slave_caps dma_caps;
	struct snd_pcm_hardware hw;
	u32 addr_widths = BIT(DMA_SLAVE_BUSWIDTH_1_BYTE) |
			  BIT(DMA_SLAVE_BUSWIDTH_2_BYTES) |
			  BIT(DMA_SLAVE_BUSWIDTH_4_BYTES);
	int i, ret;

	if (pcm->config && pcm->config->pcm_hardware)
		return snd_soc_set_runtime_hwparams(substream,
				pcm->config->pcm_hardware);

	dma_data = snd_soc_dai_get_dma_data(rtd->cpu_dai, substream);

	memset(&hw, 0, sizeof(hw));
	hw.info = SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_MMAP_VALID |
			SNDRV_PCM_INFO_INTERLEAVED;
	hw.periods_min = 2;
	hw.periods_max = UINT_MAX;
	hw.period_bytes_min = 256;
	hw.period_bytes_max = dma_get_max_seg_size(dma_dev);
	hw.buffer_bytes_max = SIZE_MAX;
	hw.fifo_size = dma_data->fifo_size;

	if (pcm->flags & SND_DMAENGINE_PCM_FLAG_NO_RESIDUE)
		hw.info |= SNDRV_PCM_INFO_BATCH;

	ret = dma_get_slave_caps(chan, &dma_caps);
	if (ret == 0) {
		if (dma_caps.cmd_pause)
			hw.info |= SNDRV_PCM_INFO_PAUSE | SNDRV_PCM_INFO_RESUME;
		if (dma_caps.residue_granularity <= DMA_RESIDUE_GRANULARITY_SEGMENT)
			hw.info |= SNDRV_PCM_INFO_BATCH;

		if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
			addr_widths = dma_caps.dstn_addr_widths;
		else
			addr_widths = dma_caps.src_addr_widths;
	}

	/*
	 * Prepare formats mask for valid/allowed sample types. If the dma does
	 * not have support for the given physical word size, it needs to be
	 * masked out so user space can not use the format which produces
	 * corrupted audio.
	 * In case the dma driver does not implement the slave_caps the default
	 * assumption is that it supports 1, 2 and 4 bytes widths.
	 */
	for (i = 0; i <= SNDRV_PCM_FORMAT_LAST; i++) {
		int bits = snd_pcm_format_physical_width(i);

		/* Enable only samples with DMA supported physical widths */
		switch (bits) {
		case 8:
		case 16:
		case 24:
		case 32:
		case 64:
			if (addr_widths & (1 << (bits / 8)))
				hw.formats |= (1LL << i);
			break;
		default:
			/* Unsupported types */
			break;
		}
	}

	return snd_soc_set_runtime_hwparams(substream, &hw);
}

static int dmaengine_pcm_open(struct snd_pcm_substream *substream)
{
	struct snd_soc_pcm_runtime *rtd = substream->private_data;
	struct dmaengine_pcm *pcm = soc_platform_to_pcm(rtd->platform);
	struct dma_chan *chan = pcm->chan[substream->stream];
	int ret;

	ret = dmaengine_pcm_set_runtime_hwparams(substream);
	if (ret)
		return ret;

	return snd_dmaengine_pcm_open(substream, chan);
}

static void dmaengine_pcm_free(struct snd_pcm *pcm)
{
	snd_pcm_lib_preallocate_free_for_all(pcm);
}

static struct dma_chan *dmaengine_pcm_compat_request_channel(
	struct snd_soc_pcm_runtime *rtd,
	struct snd_pcm_substream *substream)
{
	struct dmaengine_pcm *pcm = soc_platform_to_pcm(rtd->platform);
	struct snd_dmaengine_dai_dma_data *dma_data;
	dma_filter_fn fn = NULL;

	dma_data = snd_soc_dai_get_dma_data(rtd->cpu_dai, substream);

	if ((pcm->flags & SND_DMAENGINE_PCM_FLAG_HALF_DUPLEX) && pcm->chan[0])
		return pcm->chan[0];

	if (pcm->config && pcm->config->compat_request_channel)
		return pcm->config->compat_request_channel(rtd, substream);

	if (pcm->config)
		fn = pcm->config->compat_filter_fn;

	return snd_dmaengine_pcm_request_channel(fn, dma_data->filter_data);
}

static bool dmaengine_pcm_can_report_residue(struct dma_chan *chan)
{
	struct dma_slave_caps dma_caps;
	int ret;

	ret = dma_get_slave_caps(chan, &dma_caps);
	if (ret != 0)
		return true;

	if (dma_caps.residue_granularity == DMA_RESIDUE_GRANULARITY_DESCRIPTOR)
		return false;

	return true;
}

static int dmaengine_pcm_new(struct snd_soc_pcm_runtime *rtd)
{
	struct dmaengine_pcm *pcm = soc_platform_to_pcm(rtd->platform);
	const struct snd_dmaengine_pcm_config *config = pcm->config;
	struct device *dev = rtd->platform->dev;
	struct snd_dmaengine_dai_dma_data *dma_data;
	struct snd_pcm_substream *substream;
	size_t prealloc_buffer_size;
	size_t max_buffer_size;
	unsigned int i;
	int ret;

	if (config && config->prealloc_buffer_size) {
		prealloc_buffer_size = config->prealloc_buffer_size;
		max_buffer_size = config->pcm_hardware->buffer_bytes_max;
	} else {
		prealloc_buffer_size = 512 * 1024;
		max_buffer_size = SIZE_MAX;
	}


	for (i = SNDRV_PCM_STREAM_PLAYBACK; i <= SNDRV_PCM_STREAM_CAPTURE; i++) {
		substream = rtd->pcm->streams[i].substream;
		if (!substream)
			continue;

		dma_data = snd_soc_dai_get_dma_data(rtd->cpu_dai, substream);

		if (!pcm->chan[i] &&
		    (pcm->flags & SND_DMAENGINE_PCM_FLAG_CUSTOM_CHANNEL_NAME))
			pcm->chan[i] = dma_request_slave_channel(dev,
				dma_data->chan_name);

		if (!pcm->chan[i] && (pcm->flags & SND_DMAENGINE_PCM_FLAG_COMPAT)) {
			pcm->chan[i] = dmaengine_pcm_compat_request_channel(rtd,
				substream);
		}

		if (!pcm->chan[i]) {
			dev_err(rtd->platform->dev,
				"Missing dma channel for stream: %d\n", i);
			ret = -EINVAL;
			goto err_free;
		}

		ret = snd_pcm_lib_preallocate_pages(substream,
				SNDRV_DMA_TYPE_DEV_IRAM,
				dmaengine_dma_dev(pcm, substream),
				prealloc_buffer_size,
				max_buffer_size);
		if (ret)
			goto err_free;

		/*
		 * This will only return false if we know for sure that at least
		 * one channel does not support residue reporting. If the DMA
		 * driver does not implement the slave_caps API we rely having
		 * the NO_RESIDUE flag set manually in case residue reporting is
		 * not supported.
		 */
		if (!dmaengine_pcm_can_report_residue(pcm->chan[i]))
			pcm->flags |= SND_DMAENGINE_PCM_FLAG_NO_RESIDUE;
	}

	return 0;

err_free:
	dmaengine_pcm_free(rtd->pcm);
	return ret;
}

static snd_pcm_uframes_t dmaengine_pcm_pointer(
	struct snd_pcm_substream *substream)
{
	struct snd_soc_pcm_runtime *rtd = substream->private_data;
	struct dmaengine_pcm *pcm = soc_platform_to_pcm(rtd->platform);

	if (pcm->flags & SND_DMAENGINE_PCM_FLAG_NO_RESIDUE)
		return snd_dmaengine_pcm_pointer_no_residue(substream);
	else
		return snd_dmaengine_pcm_pointer(substream);
}

static const struct snd_pcm_ops dmaengine_pcm_ops = {
	.open		= dmaengine_pcm_open,
	.close		= snd_dmaengine_pcm_close,
	.ioctl		= snd_pcm_lib_ioctl,
	.hw_params	= dmaengine_pcm_hw_params,
	.hw_free	= snd_pcm_lib_free_pages,
	.trigger	= snd_dmaengine_pcm_trigger,
	.pointer	= dmaengine_pcm_pointer,
};

static const struct snd_soc_platform_driver dmaengine_pcm_platform = {
	.component_driver = {
		.probe_order = SND_SOC_COMP_ORDER_LATE,
	},
	.ops		= &dmaengine_pcm_ops,
	.pcm_new	= dmaengine_pcm_new,
	.pcm_free	= dmaengine_pcm_free,
};

static const char * const dmaengine_pcm_dma_channel_names[] = {
	[SNDRV_PCM_STREAM_PLAYBACK] = "tx",
	[SNDRV_PCM_STREAM_CAPTURE] = "rx",
};

static int dmaengine_pcm_request_chan_of(struct dmaengine_pcm *pcm,
	struct device *dev, const struct snd_dmaengine_pcm_config *config)
{
	unsigned int i;
	const char *name;
	struct dma_chan *chan;

	if ((pcm->flags & (SND_DMAENGINE_PCM_FLAG_NO_DT |
			   SND_DMAENGINE_PCM_FLAG_CUSTOM_CHANNEL_NAME)) ||
	    !dev->of_node)
		return 0;

	if (config && config->dma_dev) {
		/*
		 * If this warning is seen, it probably means that your Linux
		 * device structure does not match your HW device structure.
		 * It would be best to refactor the Linux device structure to
		 * correctly match the HW structure.
		 */
		dev_warn(dev, "DMA channels sourced from device %s",
			 dev_name(config->dma_dev));
		dev = config->dma_dev;
	}

	for (i = SNDRV_PCM_STREAM_PLAYBACK; i <= SNDRV_PCM_STREAM_CAPTURE;
	     i++) {
		if (pcm->flags & SND_DMAENGINE_PCM_FLAG_HALF_DUPLEX)
			name = "rx-tx";
		else
			name = dmaengine_pcm_dma_channel_names[i];
		if (config && config->chan_names[i])
			name = config->chan_names[i];
		chan = dma_request_slave_channel_reason(dev, name);
		if (IS_ERR(chan)) {
			if (PTR_ERR(chan) == -EPROBE_DEFER)
				return -EPROBE_DEFER;
			pcm->chan[i] = NULL;
		} else {
			pcm->chan[i] = chan;
		}
		if (pcm->flags & SND_DMAENGINE_PCM_FLAG_HALF_DUPLEX)
			break;
	}

	if (pcm->flags & SND_DMAENGINE_PCM_FLAG_HALF_DUPLEX)
		pcm->chan[1] = pcm->chan[0];

	return 0;
}

static void dmaengine_pcm_release_chan(struct dmaengine_pcm *pcm)
{
	unsigned int i;

	for (i = SNDRV_PCM_STREAM_PLAYBACK; i <= SNDRV_PCM_STREAM_CAPTURE;
	     i++) {
		if (!pcm->chan[i])
			continue;
		dma_release_channel(pcm->chan[i]);
		if (pcm->flags & SND_DMAENGINE_PCM_FLAG_HALF_DUPLEX)
			break;
	}
}

/**
 * snd_dmaengine_pcm_register - Register a dmaengine based PCM device
 * @dev: The parent device for the PCM device
 * @config: Platform specific PCM configuration
 * @flags: Platform specific quirks
 */
int snd_dmaengine_pcm_register(struct device *dev,
	const struct snd_dmaengine_pcm_config *config, unsigned int flags)
{
	struct dmaengine_pcm *pcm;
	int ret;

	pcm = kzalloc(sizeof(*pcm), GFP_KERNEL);
	if (!pcm)
		return -ENOMEM;

	pcm->config = config;
	pcm->flags = flags;

	ret = dmaengine_pcm_request_chan_of(pcm, dev, config);
	if (ret)
		goto err_free_dma;

	ret = snd_soc_add_platform(dev, &pcm->platform,
		&dmaengine_pcm_platform);
	if (ret)
		goto err_free_dma;

	return 0;

err_free_dma:
	dmaengine_pcm_release_chan(pcm);
	kfree(pcm);
	return ret;
}
EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_register);

/**
 * snd_dmaengine_pcm_unregister - Removes a dmaengine based PCM device
 * @dev: Parent device the PCM was register with
 *
 * Removes a dmaengine based PCM device previously registered with
 * snd_dmaengine_pcm_register.
 */
void snd_dmaengine_pcm_unregister(struct device *dev)
{
	struct snd_soc_platform *platform;
	struct dmaengine_pcm *pcm;

	platform = snd_soc_lookup_platform(dev);
	if (!platform)
		return;

	pcm = soc_platform_to_pcm(platform);

	snd_soc_remove_platform(platform);
	dmaengine_pcm_release_chan(pcm);
	kfree(pcm);
}
EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_unregister);

MODULE_LICENSE("GPL");
Commit	Line	Data
28c4468b LPC	1	/*
	2	* Copyright (C) 2013, Analog Devices Inc.
	3	* Author: Lars-Peter Clausen <lars@metafoo.de>
	4	*
	5	* This program is free software; you can redistribute it and/or modify it
	6	* under the terms of the GNU General Public License as published by the
	7	* Free Software Foundation; either version 2 of the License, or (at your
	8	* option) any later version.
	9	*
	10	* You should have received a copy of the GNU General Public License along
	11	* with this program; if not, write to the Free Software Foundation, Inc.,
	12	* 675 Mass Ave, Cambridge, MA 02139, USA.
	13	*
	14	*/
	15	#include <linux/module.h>
	16	#include <linux/init.h>
	17	#include <linux/dmaengine.h>
	18	#include <linux/slab.h>
	19	#include <sound/pcm.h>
	20	#include <sound/pcm_params.h>
	21	#include <sound/soc.h>
	22	#include <linux/dma-mapping.h>
	23	#include <linux/of.h>
28c4468b LPC	24
	25	#include <sound/dmaengine_pcm.h>
	26
	27	struct dmaengine_pcm {
f82bf8e2	28	struct dma_chan *chan[SNDRV_PCM_STREAM_LAST + 1];
28c4468b LPC	29	const struct snd_dmaengine_pcm_config *config;
28c4468b LPC	30	struct snd_soc_platform platform;
d1e1406c	31	unsigned int flags;
28c4468b LPC	32	};
	33
	34	static struct dmaengine_pcm soc_platform_to_pcm(struct snd_soc_platform p)
	35	{
	36	return container_of(p, struct dmaengine_pcm, platform);
	37	}
	38
c0de42bf LPC	39	static struct device dmaengine_dma_dev(struct dmaengine_pcm pcm,
	40	struct snd_pcm_substream *substream)
	41	{
	42	if (!pcm->chan[substream->stream])
	43	return NULL;
	44
	45	return pcm->chan[substream->stream]->device->dev;
	46	}
	47
28c4468b LPC	48	/**
	49	* snd_dmaengine_pcm_prepare_slave_config() - Generic prepare_slave_config callback
	50	* @substream: PCM substream
	51	* @params: hw_params
	52	* @slave_config: DMA slave config to prepare
	53	*
	54	* This function can be used as a generic prepare_slave_config callback for
	55	* platforms which make use of the snd_dmaengine_dai_dma_data struct for their
	56	* DAI DMA data. Internally the function will first call
	57	* snd_hwparams_to_dma_slave_config to fill in the slave config based on the
	58	* hw_params, followed by snd_dmaengine_set_config_from_dai_data to fill in the
	59	* remaining fields based on the DAI DMA data.
	60	*/
	61	int snd_dmaengine_pcm_prepare_slave_config(struct snd_pcm_substream *substream,
	62	struct snd_pcm_hw_params params, struct dma_slave_config slave_config)
	63	{
	64	struct snd_soc_pcm_runtime *rtd = substream->private_data;
	65	struct snd_dmaengine_dai_dma_data *dma_data;
	66	int ret;
	67
	68	dma_data = snd_soc_dai_get_dma_data(rtd->cpu_dai, substream);
	69
	70	ret = snd_hwparams_to_dma_slave_config(substream, params, slave_config);
	71	if (ret)
	72	return ret;
	73
	74	snd_dmaengine_pcm_set_config_from_dai_data(substream, dma_data,
	75	slave_config);
	76
	77	return 0;
	78	}
	79	EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_prepare_slave_config);
	80
	81	static int dmaengine_pcm_hw_params(struct snd_pcm_substream *substream,
	82	struct snd_pcm_hw_params *params)
	83	{
	84	struct snd_soc_pcm_runtime *rtd = substream->private_data;
	85	struct dmaengine_pcm *pcm = soc_platform_to_pcm(rtd->platform);
	86	struct dma_chan *chan = snd_dmaengine_pcm_get_chan(substream);
fa654e08 LPC	87	int (prepare_slave_config)(struct snd_pcm_substream substream,
	88	struct snd_pcm_hw_params *params,
	89	struct dma_slave_config *slave_config);
28c4468b LPC	90	struct dma_slave_config slave_config;
	91	int ret;
	92
a894bd7f LJ	93	memset(&slave_config, 0, sizeof(slave_config));
a894bd7f LJ	94
fa654e08 LPC	95	if (!pcm->config)
	96	prepare_slave_config = snd_dmaengine_pcm_prepare_slave_config;
	97	else
	98	prepare_slave_config = pcm->config->prepare_slave_config;
	99
	100	if (prepare_slave_config) {
	101	ret = prepare_slave_config(substream, params, &slave_config);
28c4468b LPC	102	if (ret)
	103	return ret;
	104
	105	ret = dmaengine_slave_config(chan, &slave_config);
	106	if (ret)
	107	return ret;
	108	}
	109
	110	return snd_pcm_lib_malloc_pages(substream, params_buffer_bytes(params));
	111	}
	112
c0de42bf	113	static int dmaengine_pcm_set_runtime_hwparams(struct snd_pcm_substream *substream)
28c4468b LPC	114	{
	115	struct snd_soc_pcm_runtime *rtd = substream->private_data;
	116	struct dmaengine_pcm *pcm = soc_platform_to_pcm(rtd->platform);
c0de42bf	117	struct device *dma_dev = dmaengine_dma_dev(pcm, substream);
28c4468b	118	struct dma_chan *chan = pcm->chan[substream->stream];
c0de42bf LPC	119	struct snd_dmaengine_dai_dma_data *dma_data;
	120	struct dma_slave_caps dma_caps;
	121	struct snd_pcm_hardware hw;
2d38df12 PU	122	u32 addr_widths = BIT(DMA_SLAVE_BUSWIDTH_1_BYTE) \|
	123	BIT(DMA_SLAVE_BUSWIDTH_2_BYTES) \|
	124	BIT(DMA_SLAVE_BUSWIDTH_4_BYTES);
	125	int i, ret;
28c4468b	126
fa654e08	127	if (pcm->config && pcm->config->pcm_hardware)
c0de42bf	128	return snd_soc_set_runtime_hwparams(substream,
28c4468b	129	pcm->config->pcm_hardware);
28c4468b	130
c0de42bf LPC	131	dma_data = snd_soc_dai_get_dma_data(rtd->cpu_dai, substream);
	132
	133	memset(&hw, 0, sizeof(hw));
	134	hw.info = SNDRV_PCM_INFO_MMAP \| SNDRV_PCM_INFO_MMAP_VALID \|
	135	SNDRV_PCM_INFO_INTERLEAVED;
	136	hw.periods_min = 2;
	137	hw.periods_max = UINT_MAX;
	138	hw.period_bytes_min = 256;
	139	hw.period_bytes_max = dma_get_max_seg_size(dma_dev);
	140	hw.buffer_bytes_max = SIZE_MAX;
	141	hw.fifo_size = dma_data->fifo_size;
	142
a22f33b0 LPC	143	if (pcm->flags & SND_DMAENGINE_PCM_FLAG_NO_RESIDUE)
	144	hw.info \|= SNDRV_PCM_INFO_BATCH;
	145
c0de42bf LPC	146	ret = dma_get_slave_caps(chan, &dma_caps);
	147	if (ret == 0) {
	148	if (dma_caps.cmd_pause)
	149	hw.info \|= SNDRV_PCM_INFO_PAUSE \| SNDRV_PCM_INFO_RESUME;
478028e0 LPC	150	if (dma_caps.residue_granularity <= DMA_RESIDUE_GRANULARITY_SEGMENT)
478028e0 LPC	151	hw.info \|= SNDRV_PCM_INFO_BATCH;
2d38df12 PU	152
	153	if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
	154	addr_widths = dma_caps.dstn_addr_widths;
	155	else
	156	addr_widths = dma_caps.src_addr_widths;
	157	}
	158
	159	/*
	160	* Prepare formats mask for valid/allowed sample types. If the dma does
	161	* not have support for the given physical word size, it needs to be
	162	* masked out so user space can not use the format which produces
	163	* corrupted audio.
	164	* In case the dma driver does not implement the slave_caps the default
	165	* assumption is that it supports 1, 2 and 4 bytes widths.
	166	*/
	167	for (i = 0; i <= SNDRV_PCM_FORMAT_LAST; i++) {
	168	int bits = snd_pcm_format_physical_width(i);
	169
	170	/* Enable only samples with DMA supported physical widths */
	171	switch (bits) {
	172	case 8:
	173	case 16:
	174	case 24:
	175	case 32:
	176	case 64:
	177	if (addr_widths & (1 << (bits / 8)))
	178	hw.formats \|= (1LL << i);
	179	break;
	180	default:
	181	/* Unsupported types */
	182	break;
	183	}
c0de42bf LPC	184	}
	185
	186	return snd_soc_set_runtime_hwparams(substream, &hw);
28c4468b LPC	187	}
28c4468b LPC	188
c0de42bf	189	static int dmaengine_pcm_open(struct snd_pcm_substream *substream)
28c4468b	190	{
c0de42bf LPC	191	struct snd_soc_pcm_runtime *rtd = substream->private_data;
	192	struct dmaengine_pcm *pcm = soc_platform_to_pcm(rtd->platform);
	193	struct dma_chan *chan = pcm->chan[substream->stream];
	194	int ret;
28c4468b	195
c0de42bf LPC	196	ret = dmaengine_pcm_set_runtime_hwparams(substream);
	197	if (ret)
	198	return ret;
	199
	200	return snd_dmaengine_pcm_open(substream, chan);
28c4468b LPC	201	}
	202
	203	static void dmaengine_pcm_free(struct snd_pcm *pcm)
	204	{
	205	snd_pcm_lib_preallocate_free_for_all(pcm);
	206	}
	207
c999836d LPC	208	static struct dma_chan *dmaengine_pcm_compat_request_channel(
	209	struct snd_soc_pcm_runtime *rtd,
	210	struct snd_pcm_substream *substream)
	211	{
	212	struct dmaengine_pcm *pcm = soc_platform_to_pcm(rtd->platform);
90130d2e	213	struct snd_dmaengine_dai_dma_data *dma_data;
ec4f2857	214	dma_filter_fn fn = NULL;
90130d2e MB	215
90130d2e MB	216	dma_data = snd_soc_dai_get_dma_data(rtd->cpu_dai, substream);
c999836d	217
d1e1406c LPC	218	if ((pcm->flags & SND_DMAENGINE_PCM_FLAG_HALF_DUPLEX) && pcm->chan[0])
	219	return pcm->chan[0];
	220
ec4f2857	221	if (pcm->config && pcm->config->compat_request_channel)
c999836d LPC	222	return pcm->config->compat_request_channel(rtd, substream);
c999836d LPC	223
ec4f2857 XL	224	if (pcm->config)
	225	fn = pcm->config->compat_filter_fn;
	226
	227	return snd_dmaengine_pcm_request_channel(fn, dma_data->filter_data);
c999836d LPC	228	}
c999836d LPC	229
478028e0 LPC	230	static bool dmaengine_pcm_can_report_residue(struct dma_chan *chan)
	231	{
	232	struct dma_slave_caps dma_caps;
	233	int ret;
	234
	235	ret = dma_get_slave_caps(chan, &dma_caps);
	236	if (ret != 0)
	237	return true;
	238
	239	if (dma_caps.residue_granularity == DMA_RESIDUE_GRANULARITY_DESCRIPTOR)
	240	return false;
	241
	242	return true;
	243	}
	244
28c4468b LPC	245	static int dmaengine_pcm_new(struct snd_soc_pcm_runtime *rtd)
	246	{
	247	struct dmaengine_pcm *pcm = soc_platform_to_pcm(rtd->platform);
	248	const struct snd_dmaengine_pcm_config *config = pcm->config;
ea73b7dd MB	249	struct device *dev = rtd->platform->dev;
ea73b7dd MB	250	struct snd_dmaengine_dai_dma_data *dma_data;
28c4468b	251	struct snd_pcm_substream *substream;
fa654e08 LPC	252	size_t prealloc_buffer_size;
fa654e08 LPC	253	size_t max_buffer_size;
28c4468b LPC	254	unsigned int i;
	255	int ret;
	256
fa654e08 LPC	257	if (config && config->prealloc_buffer_size) {
	258	prealloc_buffer_size = config->prealloc_buffer_size;
	259	max_buffer_size = config->pcm_hardware->buffer_bytes_max;
	260	} else {
	261	prealloc_buffer_size = 512 * 1024;
	262	max_buffer_size = SIZE_MAX;
	263	}
	264
	265
28c4468b LPC	266	for (i = SNDRV_PCM_STREAM_PLAYBACK; i <= SNDRV_PCM_STREAM_CAPTURE; i++) {
	267	substream = rtd->pcm->streams[i].substream;
	268	if (!substream)
	269	continue;
	270
ea73b7dd MB	271	dma_data = snd_soc_dai_get_dma_data(rtd->cpu_dai, substream);
	272
	273	if (!pcm->chan[i] &&
	274	(pcm->flags & SND_DMAENGINE_PCM_FLAG_CUSTOM_CHANNEL_NAME))
	275	pcm->chan[i] = dma_request_slave_channel(dev,
	276	dma_data->chan_name);
	277
d1e1406c	278	if (!pcm->chan[i] && (pcm->flags & SND_DMAENGINE_PCM_FLAG_COMPAT)) {
c999836d LPC	279	pcm->chan[i] = dmaengine_pcm_compat_request_channel(rtd,
	280	substream);
	281	}
	282
28c4468b LPC	283	if (!pcm->chan[i]) {
	284	dev_err(rtd->platform->dev,
	285	"Missing dma channel for stream: %d\n", i);
	286	ret = -EINVAL;
	287	goto err_free;
	288	}
	289
	290	ret = snd_pcm_lib_preallocate_pages(substream,
ca2b0295	291	SNDRV_DMA_TYPE_DEV_IRAM,
28c4468b	292	dmaengine_dma_dev(pcm, substream),
fa654e08 LPC	293	prealloc_buffer_size,
fa654e08 LPC	294	max_buffer_size);
28c4468b LPC	295	if (ret)
28c4468b LPC	296	goto err_free;
478028e0 LPC	297
	298	/*
	299	* This will only return false if we know for sure that at least
	300	* one channel does not support residue reporting. If the DMA
	301	* driver does not implement the slave_caps API we rely having
	302	* the NO_RESIDUE flag set manually in case residue reporting is
	303	* not supported.
	304	*/
	305	if (!dmaengine_pcm_can_report_residue(pcm->chan[i]))
	306	pcm->flags \|= SND_DMAENGINE_PCM_FLAG_NO_RESIDUE;
28c4468b LPC	307	}
	308
	309	return 0;
	310
	311	err_free:
	312	dmaengine_pcm_free(rtd->pcm);
	313	return ret;
	314	}
	315
93b943ed LPC	316	static snd_pcm_uframes_t dmaengine_pcm_pointer(
	317	struct snd_pcm_substream *substream)
	318	{
	319	struct snd_soc_pcm_runtime *rtd = substream->private_data;
	320	struct dmaengine_pcm *pcm = soc_platform_to_pcm(rtd->platform);
	321
	322	if (pcm->flags & SND_DMAENGINE_PCM_FLAG_NO_RESIDUE)
	323	return snd_dmaengine_pcm_pointer_no_residue(substream);
	324	else
	325	return snd_dmaengine_pcm_pointer(substream);
	326	}
	327
28c4468b LPC	328	static const struct snd_pcm_ops dmaengine_pcm_ops = {
	329	.open = dmaengine_pcm_open,
	330	.close = snd_dmaengine_pcm_close,
	331	.ioctl = snd_pcm_lib_ioctl,
	332	.hw_params = dmaengine_pcm_hw_params,
	333	.hw_free = snd_pcm_lib_free_pages,
	334	.trigger = snd_dmaengine_pcm_trigger,
93b943ed	335	.pointer = dmaengine_pcm_pointer,
28c4468b LPC	336	};
	337
	338	static const struct snd_soc_platform_driver dmaengine_pcm_platform = {
f1d45cc3 LPC	339	.component_driver = {
	340	.probe_order = SND_SOC_COMP_ORDER_LATE,
	341	},
28c4468b LPC	342	.ops = &dmaengine_pcm_ops,
	343	.pcm_new = dmaengine_pcm_new,
	344	.pcm_free = dmaengine_pcm_free,
	345	};
	346
	347	static const char * const dmaengine_pcm_dma_channel_names[] = {
	348	[SNDRV_PCM_STREAM_PLAYBACK] = "tx",
	349	[SNDRV_PCM_STREAM_CAPTURE] = "rx",
	350	};
	351
5eda87b8	352	static int dmaengine_pcm_request_chan_of(struct dmaengine_pcm *pcm,
194c7dea	353	struct device dev, const struct snd_dmaengine_pcm_config config)
d1e1406c LPC	354	{
d1e1406c LPC	355	unsigned int i;
11b3a7ad	356	const char *name;
5eda87b8	357	struct dma_chan *chan;
d1e1406c	358
ea73b7dd MB	359	if ((pcm->flags & (SND_DMAENGINE_PCM_FLAG_NO_DT \|
	360	SND_DMAENGINE_PCM_FLAG_CUSTOM_CHANNEL_NAME)) \|\|
	361	!dev->of_node)
5eda87b8	362	return 0;
d1e1406c	363
2b67f8ba	364	if (config && config->dma_dev) {
194c7dea SW	365	/*
	366	* If this warning is seen, it probably means that your Linux
	367	* device structure does not match your HW device structure.
	368	* It would be best to refactor the Linux device structure to
	369	* correctly match the HW structure.
	370	*/
	371	dev_warn(dev, "DMA channels sourced from device %s",
	372	dev_name(config->dma_dev));
	373	dev = config->dma_dev;
	374	}
	375
11b3a7ad SW	376	for (i = SNDRV_PCM_STREAM_PLAYBACK; i <= SNDRV_PCM_STREAM_CAPTURE;
	377	i++) {
	378	if (pcm->flags & SND_DMAENGINE_PCM_FLAG_HALF_DUPLEX)
	379	name = "rx-tx";
	380	else
	381	name = dmaengine_pcm_dma_channel_names[i];
2b67f8ba	382	if (config && config->chan_names[i])
194c7dea	383	name = config->chan_names[i];
5eda87b8 SW	384	chan = dma_request_slave_channel_reason(dev, name);
5eda87b8 SW	385	if (IS_ERR(chan)) {
e9036c2a	386	if (PTR_ERR(chan) == -EPROBE_DEFER)
5eda87b8 SW	387	return -EPROBE_DEFER;
	388	pcm->chan[i] = NULL;
	389	} else {
	390	pcm->chan[i] = chan;
	391	}
11b3a7ad SW	392	if (pcm->flags & SND_DMAENGINE_PCM_FLAG_HALF_DUPLEX)
11b3a7ad SW	393	break;
d1e1406c	394	}
11b3a7ad SW	395
	396	if (pcm->flags & SND_DMAENGINE_PCM_FLAG_HALF_DUPLEX)
	397	pcm->chan[1] = pcm->chan[0];
5eda87b8 SW	398
5eda87b8 SW	399	return 0;
d1e1406c LPC	400	}
d1e1406c LPC	401
6b9f3e65 SW	402	static void dmaengine_pcm_release_chan(struct dmaengine_pcm *pcm)
	403	{
	404	unsigned int i;
	405
	406	for (i = SNDRV_PCM_STREAM_PLAYBACK; i <= SNDRV_PCM_STREAM_CAPTURE;
	407	i++) {
	408	if (!pcm->chan[i])
	409	continue;
	410	dma_release_channel(pcm->chan[i]);
	411	if (pcm->flags & SND_DMAENGINE_PCM_FLAG_HALF_DUPLEX)
	412	break;
	413	}
	414	}
	415
28c4468b LPC	416	/**
	417	* snd_dmaengine_pcm_register - Register a dmaengine based PCM device
	418	* @dev: The parent device for the PCM device
	419	* @config: Platform specific PCM configuration
	420	* @flags: Platform specific quirks
	421	*/
	422	int snd_dmaengine_pcm_register(struct device *dev,
	423	const struct snd_dmaengine_pcm_config *config, unsigned int flags)
	424	{
	425	struct dmaengine_pcm *pcm;
6b9f3e65	426	int ret;
28c4468b	427
28c4468b LPC	428	pcm = kzalloc(sizeof(*pcm), GFP_KERNEL);
	429	if (!pcm)
	430	return -ENOMEM;
	431
	432	pcm->config = config;
d1e1406c	433	pcm->flags = flags;
28c4468b	434
5eda87b8 SW	435	ret = dmaengine_pcm_request_chan_of(pcm, dev, config);
	436	if (ret)
	437	goto err_free_dma;
28c4468b	438
93b943ed LPC	439	ret = snd_soc_add_platform(dev, &pcm->platform,
93b943ed LPC	440	&dmaengine_pcm_platform);
6b9f3e65 SW	441	if (ret)
	442	goto err_free_dma;
	443
	444	return 0;
	445
	446	err_free_dma:
	447	dmaengine_pcm_release_chan(pcm);
	448	kfree(pcm);
	449	return ret;
28c4468b LPC	450	}
	451	EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_register);
	452
	453	/**
	454	* snd_dmaengine_pcm_unregister - Removes a dmaengine based PCM device
	455	* @dev: Parent device the PCM was register with
	456	*
	457	* Removes a dmaengine based PCM device previously registered with
	458	* snd_dmaengine_pcm_register.
	459	*/
	460	void snd_dmaengine_pcm_unregister(struct device *dev)
	461	{
	462	struct snd_soc_platform *platform;
	463	struct dmaengine_pcm *pcm;
28c4468b LPC	464
	465	platform = snd_soc_lookup_platform(dev);
	466	if (!platform)
	467	return;
	468
	469	pcm = soc_platform_to_pcm(platform);
	470
28c4468b	471	snd_soc_remove_platform(platform);
6b9f3e65	472	dmaengine_pcm_release_chan(pcm);
28c4468b LPC	473	kfree(pcm);
	474	}
	475	EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_unregister);
	476
	477	MODULE_LICENSE("GPL");