[mirror_ubuntu-jammy-kernel.git] / sound / soc / atmel / atmel-pcm-dma.c

/*
 * atmel-pcm-dma.c  --  ALSA PCM DMA support for the Atmel SoC.
 *
 *  Copyright (C) 2012 Atmel
 *
 * Author: Bo Shen <voice.shen@atmel.com>
 *
 * Based on atmel-pcm by:
 * Sedji Gaouaou <sedji.gaouaou@atmel.com>
 * Copyright 2008 Atmel
 *
 * 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.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#include <linux/module.h>
#include <linux/init.h>
#include <linux/platform_device.h>
#include <linux/slab.h>
#include <linux/dma-mapping.h>
#include <linux/dmaengine.h>
#include <linux/atmel-ssc.h>
#include <linux/platform_data/dma-atmel.h>

#include <sound/core.h>
#include <sound/pcm.h>
#include <sound/pcm_params.h>
#include <sound/soc.h>
#include <sound/dmaengine_pcm.h>

#include "atmel-pcm.h"

/*--------------------------------------------------------------------------*\
 * Hardware definition
\*--------------------------------------------------------------------------*/
static const struct snd_pcm_hardware atmel_pcm_dma_hardware = {
	.info			= SNDRV_PCM_INFO_MMAP |
				  SNDRV_PCM_INFO_MMAP_VALID |
				  SNDRV_PCM_INFO_INTERLEAVED |
				  SNDRV_PCM_INFO_RESUME |
				  SNDRV_PCM_INFO_PAUSE,
	.formats		= SNDRV_PCM_FMTBIT_S16_LE,
	.period_bytes_min	= 256,		/* lighting DMA overhead */
	.period_bytes_max	= 2 * 0xffff,	/* if 2 bytes format */
	.periods_min		= 8,
	.periods_max		= 1024,		/* no limit */
	.buffer_bytes_max	= ATMEL_SSC_DMABUF_SIZE,
};

/**
 * atmel_pcm_dma_irq: SSC interrupt handler for DMAENGINE enabled SSC
 *
 * We use DMAENGINE to send/receive data to/from SSC so this ISR is only to
 * check if any overrun occured.
 */
static void atmel_pcm_dma_irq(u32 ssc_sr,
	struct snd_pcm_substream *substream)
{
	struct snd_soc_pcm_runtime *rtd = substream->private_data;
	struct atmel_pcm_dma_params *prtd;

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

	if (ssc_sr & prtd->mask->ssc_error) {
		if (snd_pcm_running(substream))
			pr_warn("atmel-pcm: buffer %s on %s (SSC_SR=%#x)\n",
				substream->stream == SNDRV_PCM_STREAM_PLAYBACK
				? "underrun" : "overrun", prtd->name,
				ssc_sr);

		/* stop RX and capture: will be enabled again at restart */
		ssc_writex(prtd->ssc->regs, SSC_CR, prtd->mask->ssc_disable);
		snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);

		/* now drain RHR and read status to remove xrun condition */
		ssc_readx(prtd->ssc->regs, SSC_RHR);
		ssc_readx(prtd->ssc->regs, SSC_SR);
	}
}

/*--------------------------------------------------------------------------*\
 * DMAENGINE operations
\*--------------------------------------------------------------------------*/
static bool filter(struct dma_chan *chan, void *slave)
{
	struct at_dma_slave *sl = slave;

	if (sl->dma_dev == chan->device->dev) {
		chan->private = sl;
		return true;
	} else {
		return false;
	}
}

static int atmel_pcm_configure_dma(struct snd_pcm_substream *substream,
	struct snd_pcm_hw_params *params, struct atmel_pcm_dma_params *prtd)
{
	struct ssc_device *ssc;
	struct dma_chan *dma_chan;
	struct dma_slave_config slave_config;
	int ret;

	ssc = prtd->ssc;

	ret = snd_hwparams_to_dma_slave_config(substream, params,
			&slave_config);
	if (ret) {
		pr_err("atmel-pcm: hwparams to dma slave configure failed\n");
		return ret;
	}

	if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
		slave_config.dst_addr = (dma_addr_t)ssc->phybase + SSC_THR;
		slave_config.dst_maxburst = 1;
	} else {
		slave_config.src_addr = (dma_addr_t)ssc->phybase + SSC_RHR;
		slave_config.src_maxburst = 1;
	}

	dma_chan = snd_dmaengine_pcm_get_chan(substream);
	if (dmaengine_slave_config(dma_chan, &slave_config)) {
		pr_err("atmel-pcm: failed to configure dma channel\n");
		ret = -EBUSY;
		return ret;
	}

	return 0;
}

static int atmel_pcm_hw_params(struct snd_pcm_substream *substream,
	struct snd_pcm_hw_params *params)
{
	struct snd_soc_pcm_runtime *rtd = substream->private_data;
	struct atmel_pcm_dma_params *prtd;
	struct ssc_device *ssc;
	struct at_dma_slave *sdata = NULL;
	int ret;

	snd_pcm_set_runtime_buffer(substream, &substream->dma_buffer);

	prtd = snd_soc_dai_get_dma_data(rtd->cpu_dai, substream);
	ssc = prtd->ssc;
	if (ssc->pdev)
		sdata = ssc->pdev->dev.platform_data;

	ret = snd_dmaengine_pcm_open_request_chan(substream, filter, sdata);
	if (ret) {
		pr_err("atmel-pcm: dmaengine pcm open failed\n");
		return -EINVAL;
	}

	ret = atmel_pcm_configure_dma(substream, params, prtd);
	if (ret) {
		pr_err("atmel-pcm: failed to configure dmai\n");
		goto err;
	}

	prtd->dma_intr_handler = atmel_pcm_dma_irq;

	return 0;
err:
	snd_dmaengine_pcm_close_release_chan(substream);
	return ret;
}

static int atmel_pcm_open(struct snd_pcm_substream *substream)
{
	snd_soc_set_runtime_hwparams(substream, &atmel_pcm_dma_hardware);

	return 0;
}

static struct snd_pcm_ops atmel_pcm_ops = {
	.open		= atmel_pcm_open,
	.close		= snd_dmaengine_pcm_close_release_chan,
	.ioctl		= snd_pcm_lib_ioctl,
	.hw_params	= atmel_pcm_hw_params,
	.trigger	= snd_dmaengine_pcm_trigger,
	.pointer	= snd_dmaengine_pcm_pointer_no_residue,
	.mmap		= atmel_pcm_mmap,
};

static struct snd_soc_platform_driver atmel_soc_platform = {
	.ops		= &atmel_pcm_ops,
	.pcm_new	= atmel_pcm_new,
	.pcm_free	= atmel_pcm_free,
};

int atmel_pcm_dma_platform_register(struct device *dev)
{
	return snd_soc_register_platform(dev, &atmel_soc_platform);
}
EXPORT_SYMBOL(atmel_pcm_dma_platform_register);

void atmel_pcm_dma_platform_unregister(struct device *dev)
{
	snd_soc_unregister_platform(dev);
}
EXPORT_SYMBOL(atmel_pcm_dma_platform_unregister);

MODULE_AUTHOR("Bo Shen <voice.shen@atmel.com>");
MODULE_DESCRIPTION("Atmel DMA based PCM module");
MODULE_LICENSE("GPL");
Commit	Line	Data
3951e4aa BS	1	/*
	2	* atmel-pcm-dma.c -- ALSA PCM DMA support for the Atmel SoC.
	3	*
	4	* Copyright (C) 2012 Atmel
	5	*
	6	* Author: Bo Shen <voice.shen@atmel.com>
	7	*
	8	* Based on atmel-pcm by:
	9	* Sedji Gaouaou <sedji.gaouaou@atmel.com>
	10	* Copyright 2008 Atmel
	11	*
	12	* This program is free software; you can redistribute it and/or modify
	13	* it under the terms of the GNU General Public License as published by
	14	* the Free Software Foundation; either version 2 of the License, or
	15	* (at your option) any later version.
	16	*
	17	* This program is distributed in the hope that it will be useful,
	18	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	19	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	20	* GNU General Public License for more details.
	21	*
	22	* You should have received a copy of the GNU General Public License
	23	* along with this program; if not, write to the Free Software
	24	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	25	*/
	26
	27	#include <linux/module.h>
	28	#include <linux/init.h>
	29	#include <linux/platform_device.h>
	30	#include <linux/slab.h>
	31	#include <linux/dma-mapping.h>
	32	#include <linux/dmaengine.h>
	33	#include <linux/atmel-ssc.h>
	34	#include <linux/platform_data/dma-atmel.h>
	35
	36	#include <sound/core.h>
	37	#include <sound/pcm.h>
	38	#include <sound/pcm_params.h>
	39	#include <sound/soc.h>
	40	#include <sound/dmaengine_pcm.h>
	41
	42	#include "atmel-pcm.h"
	43
	44	/--------------------------------------------------------------------------\
	45	* Hardware definition
	46	\--------------------------------------------------------------------------/
	47	static const struct snd_pcm_hardware atmel_pcm_dma_hardware = {
	48	.info = SNDRV_PCM_INFO_MMAP \|
	49	SNDRV_PCM_INFO_MMAP_VALID \|
	50	SNDRV_PCM_INFO_INTERLEAVED \|
	51	SNDRV_PCM_INFO_RESUME \|
	52	SNDRV_PCM_INFO_PAUSE,
	53	.formats = SNDRV_PCM_FMTBIT_S16_LE,
	54	.period_bytes_min = 256, /* lighting DMA overhead */
	55	.period_bytes_max = 2 * 0xffff, /* if 2 bytes format */
	56	.periods_min = 8,
	57	.periods_max = 1024, /* no limit */
	58	.buffer_bytes_max = ATMEL_SSC_DMABUF_SIZE,
	59	};
	60
	61	/**
	62	* atmel_pcm_dma_irq: SSC interrupt handler for DMAENGINE enabled SSC
	63	*
	64	* We use DMAENGINE to send/receive data to/from SSC so this ISR is only to
65	* check if any overrun occured.
66	*/
67	static void atmel_pcm_dma_irq(u32 ssc_sr,
68	struct snd_pcm_substream *substream)
69	{
5fe668a1	70	struct snd_soc_pcm_runtime *rtd = substream->private_data;
3951e4aa BS	71	struct atmel_pcm_dma_params *prtd;
3951e4aa BS	72
5fe668a1	73	prtd = snd_soc_dai_get_dma_data(rtd->cpu_dai, substream);
3951e4aa BS	74
	75	if (ssc_sr & prtd->mask->ssc_error) {
	76	if (snd_pcm_running(substream))
	77	pr_warn("atmel-pcm: buffer %s on %s (SSC_SR=%#x)\n",
	78	substream->stream == SNDRV_PCM_STREAM_PLAYBACK
	79	? "underrun" : "overrun", prtd->name,
	80	ssc_sr);
	81
	82	/* stop RX and capture: will be enabled again at restart */
	83	ssc_writex(prtd->ssc->regs, SSC_CR, prtd->mask->ssc_disable);
	84	snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
	85
	86	/* now drain RHR and read status to remove xrun condition */
	87	ssc_readx(prtd->ssc->regs, SSC_RHR);
	88	ssc_readx(prtd->ssc->regs, SSC_SR);
	89	}
	90	}
	91
	92	/--------------------------------------------------------------------------\
	93	* DMAENGINE operations
	94	\--------------------------------------------------------------------------/
	95	static bool filter(struct dma_chan chan, void slave)
	96	{
	97	struct at_dma_slave *sl = slave;
	98
	99	if (sl->dma_dev == chan->device->dev) {
	100	chan->private = sl;
	101	return true;
	102	} else {
	103	return false;
	104	}
	105	}
	106
	107	static int atmel_pcm_configure_dma(struct snd_pcm_substream *substream,
5fe668a1	108	struct snd_pcm_hw_params params, struct atmel_pcm_dma_params prtd)
3951e4aa	109	{
3951e4aa BS	110	struct ssc_device *ssc;
	111	struct dma_chan *dma_chan;
	112	struct dma_slave_config slave_config;
	113	int ret;
	114
3951e4aa BS	115	ssc = prtd->ssc;
	116
	117	ret = snd_hwparams_to_dma_slave_config(substream, params,
	118	&slave_config);
	119	if (ret) {
	120	pr_err("atmel-pcm: hwparams to dma slave configure failed\n");
	121	return ret;
	122	}
	123
	124	if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
	125	slave_config.dst_addr = (dma_addr_t)ssc->phybase + SSC_THR;
	126	slave_config.dst_maxburst = 1;
	127	} else {
	128	slave_config.src_addr = (dma_addr_t)ssc->phybase + SSC_RHR;
	129	slave_config.src_maxburst = 1;
	130	}
	131
3951e4aa BS	132	dma_chan = snd_dmaengine_pcm_get_chan(substream);
	133	if (dmaengine_slave_config(dma_chan, &slave_config)) {
	134	pr_err("atmel-pcm: failed to configure dma channel\n");
	135	ret = -EBUSY;
	136	return ret;
	137	}
	138
	139	return 0;
	140	}
	141
	142	static int atmel_pcm_hw_params(struct snd_pcm_substream *substream,
	143	struct snd_pcm_hw_params *params)
	144	{
	145	struct snd_soc_pcm_runtime *rtd = substream->private_data;
	146	struct atmel_pcm_dma_params *prtd;
	147	struct ssc_device *ssc;
	148	struct at_dma_slave *sdata = NULL;
	149	int ret;
	150
	151	snd_pcm_set_runtime_buffer(substream, &substream->dma_buffer);
	152
	153	prtd = snd_soc_dai_get_dma_data(rtd->cpu_dai, substream);
	154	ssc = prtd->ssc;
	155	if (ssc->pdev)
	156	sdata = ssc->pdev->dev.platform_data;
	157
7c1c1d4a	158	ret = snd_dmaengine_pcm_open_request_chan(substream, filter, sdata);
3951e4aa BS	159	if (ret) {
	160	pr_err("atmel-pcm: dmaengine pcm open failed\n");
	161	return -EINVAL;
	162	}
	163
5fe668a1	164	ret = atmel_pcm_configure_dma(substream, params, prtd);
3951e4aa BS	165	if (ret) {
	166	pr_err("atmel-pcm: failed to configure dmai\n");
	167	goto err;
	168	}
	169
	170	prtd->dma_intr_handler = atmel_pcm_dma_irq;
	171
	172	return 0;
	173	err:
7c1c1d4a	174	snd_dmaengine_pcm_close_release_chan(substream);
3951e4aa BS	175	return ret;
	176	}
	177
3951e4aa BS	178	static int atmel_pcm_open(struct snd_pcm_substream *substream)
	179	{
	180	snd_soc_set_runtime_hwparams(substream, &atmel_pcm_dma_hardware);
	181
	182	return 0;
	183	}
	184
3951e4aa BS	185	static struct snd_pcm_ops atmel_pcm_ops = {
3951e4aa BS	186	.open = atmel_pcm_open,
7c1c1d4a	187	.close = snd_dmaengine_pcm_close_release_chan,
3951e4aa BS	188	.ioctl = snd_pcm_lib_ioctl,
3951e4aa BS	189	.hw_params = atmel_pcm_hw_params,
3951e4aa BS	190	.trigger = snd_dmaengine_pcm_trigger,
	191	.pointer = snd_dmaengine_pcm_pointer_no_residue,
	192	.mmap = atmel_pcm_mmap,
	193	};
	194
	195	static struct snd_soc_platform_driver atmel_soc_platform = {
	196	.ops = &atmel_pcm_ops,
	197	.pcm_new = atmel_pcm_new,
	198	.pcm_free = atmel_pcm_free,
	199	};
	200
	201	int atmel_pcm_dma_platform_register(struct device *dev)
	202	{
	203	return snd_soc_register_platform(dev, &atmel_soc_platform);
	204	}
	205	EXPORT_SYMBOL(atmel_pcm_dma_platform_register);
	206
	207	void atmel_pcm_dma_platform_unregister(struct device *dev)
	208	{
	209	snd_soc_unregister_platform(dev);
	210	}
	211	EXPORT_SYMBOL(atmel_pcm_dma_platform_unregister);
	212
	213	MODULE_AUTHOR("Bo Shen <voice.shen@atmel.com>");
	214	MODULE_DESCRIPTION("Atmel DMA based PCM module");
	215	MODULE_LICENSE("GPL");