[deliverable/linux.git] / sound / soc / fsl / mpc5200_psc_i2s.c

/*
 * Freescale MPC5200 PSC in I2S mode
 * ALSA SoC Digital Audio Interface (DAI) driver
 *
 * Copyright (C) 2008 Secret Lab Technologies Ltd.
 * Copyright (C) 2009 Jon Smirl, Digispeaker
 */

#include <linux/module.h>
#include <linux/of_device.h>
#include <linux/of_platform.h>

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

#include <asm/mpc52xx_psc.h>

#include "mpc5200_psc_i2s.h"
#include "mpc5200_dma.h"

/**
 * PSC_I2S_RATES: sample rates supported by the I2S
 *
 * This driver currently only supports the PSC running in I2S slave mode,
 * which means the codec determines the sample rate.  Therefore, we tell
 * ALSA that we support all rates and let the codec driver decide what rates
 * are really supported.
 */
#define PSC_I2S_RATES (SNDRV_PCM_RATE_5512 | SNDRV_PCM_RATE_8000_192000 | \
			SNDRV_PCM_RATE_CONTINUOUS)

/**
 * PSC_I2S_FORMATS: audio formats supported by the PSC I2S mode
 */
#define PSC_I2S_FORMATS (SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_S16_BE | \
			 SNDRV_PCM_FMTBIT_S24_BE | SNDRV_PCM_FMTBIT_S32_BE)

static int psc_i2s_hw_params(struct snd_pcm_substream *substream,
				 struct snd_pcm_hw_params *params,
				 struct snd_soc_dai *dai)
{
	struct snd_soc_pcm_runtime *rtd = substream->private_data;
	struct psc_dma *psc_dma = rtd->dai->cpu_dai->private_data;
	u32 mode;

	dev_dbg(psc_dma->dev, "%s(substream=%p) p_size=%i p_bytes=%i"
		" periods=%i buffer_size=%i  buffer_bytes=%i\n",
		__func__, substream, params_period_size(params),
		params_period_bytes(params), params_periods(params),
		params_buffer_size(params), params_buffer_bytes(params));

	switch (params_format(params)) {
	case SNDRV_PCM_FORMAT_S8:
		mode = MPC52xx_PSC_SICR_SIM_CODEC_8;
		break;
	case SNDRV_PCM_FORMAT_S16_BE:
		mode = MPC52xx_PSC_SICR_SIM_CODEC_16;
		break;
	case SNDRV_PCM_FORMAT_S24_BE:
		mode = MPC52xx_PSC_SICR_SIM_CODEC_24;
		break;
	case SNDRV_PCM_FORMAT_S32_BE:
		mode = MPC52xx_PSC_SICR_SIM_CODEC_32;
		break;
	default:
		dev_dbg(psc_dma->dev, "invalid format\n");
		return -EINVAL;
	}
	out_be32(&psc_dma->psc_regs->sicr, psc_dma->sicr | mode);

	return 0;
}

/**
 * psc_i2s_set_sysclk: set the clock frequency and direction
 *
 * This function is called by the machine driver to tell us what the clock
 * frequency and direction are.
 *
 * Currently, we only support operating as a clock slave (SND_SOC_CLOCK_IN),
 * and we don't care about the frequency.  Return an error if the direction
 * is not SND_SOC_CLOCK_IN.
 *
 * @clk_id: reserved, should be zero
 * @freq: the frequency of the given clock ID, currently ignored
 * @dir: SND_SOC_CLOCK_IN (clock slave) or SND_SOC_CLOCK_OUT (clock master)
 */
static int psc_i2s_set_sysclk(struct snd_soc_dai *cpu_dai,
			      int clk_id, unsigned int freq, int dir)
{
	struct psc_dma *psc_dma = cpu_dai->private_data;
	dev_dbg(psc_dma->dev, "psc_i2s_set_sysclk(cpu_dai=%p, dir=%i)\n",
				cpu_dai, dir);
	return (dir == SND_SOC_CLOCK_IN) ? 0 : -EINVAL;
}

/**
 * psc_i2s_set_fmt: set the serial format.
 *
 * This function is called by the machine driver to tell us what serial
 * format to use.
 *
 * This driver only supports I2S mode.  Return an error if the format is
 * not SND_SOC_DAIFMT_I2S.
 *
 * @format: one of SND_SOC_DAIFMT_xxx
 */
static int psc_i2s_set_fmt(struct snd_soc_dai *cpu_dai, unsigned int format)
{
	struct psc_dma *psc_dma = cpu_dai->private_data;
	dev_dbg(psc_dma->dev, "psc_i2s_set_fmt(cpu_dai=%p, format=%i)\n",
				cpu_dai, format);
	return (format == SND_SOC_DAIFMT_I2S) ? 0 : -EINVAL;
}

/* ---------------------------------------------------------------------
 * ALSA SoC Bindings
 *
 * - Digital Audio Interface (DAI) template
 * - create/destroy dai hooks
 */

/**
 * psc_i2s_dai_template: template CPU Digital Audio Interface
 */
static struct snd_soc_dai_ops psc_i2s_dai_ops = {
	.hw_params	= psc_i2s_hw_params,
	.set_sysclk	= psc_i2s_set_sysclk,
	.set_fmt	= psc_i2s_set_fmt,
};

struct snd_soc_dai psc_i2s_dai[] = {{
	.name   = "I2S",
	.playback = {
		.channels_min = 2,
		.channels_max = 2,
		.rates = PSC_I2S_RATES,
		.formats = PSC_I2S_FORMATS,
	},
	.capture = {
		.channels_min = 2,
		.channels_max = 2,
		.rates = PSC_I2S_RATES,
		.formats = PSC_I2S_FORMATS,
	},
	.ops = &psc_i2s_dai_ops,
} };
EXPORT_SYMBOL_GPL(psc_i2s_dai);

/* ---------------------------------------------------------------------
 * OF platform bus binding code:
 * - Probe/remove operations
 * - OF device match table
 */
static int __devinit psc_i2s_of_probe(struct of_device *op,
				      const struct of_device_id *match)
{
	int rc;
	struct psc_dma *psc_dma;
	struct mpc52xx_psc __iomem *regs;

	rc = mpc5200_audio_dma_create(op);
	if (rc != 0)
		return rc;

	rc = snd_soc_register_dais(psc_i2s_dai, ARRAY_SIZE(psc_i2s_dai));
	if (rc != 0) {
		pr_err("Failed to register DAI\n");
		return 0;
	}

	psc_dma = dev_get_drvdata(&op->dev);
	regs = psc_dma->psc_regs;

	/* Configure the serial interface mode; defaulting to CODEC8 mode */
	psc_dma->sicr = MPC52xx_PSC_SICR_DTS1 | MPC52xx_PSC_SICR_I2S |
			MPC52xx_PSC_SICR_CLKPOL;
	out_be32(&psc_dma->psc_regs->sicr,
		 psc_dma->sicr | MPC52xx_PSC_SICR_SIM_CODEC_8);

	/* Check for the codec handle.  If it is not present then we
	 * are done */
	if (!of_get_property(op->node, "codec-handle", NULL))
		return 0;

	/* Due to errata in the dma mode; need to line up enabling
	 * the transmitter with a transition on the frame sync
	 * line */

	/* first make sure it is low */
	while ((in_8(&regs->ipcr_acr.ipcr) & 0x80) != 0)
		;
	/* then wait for the transition to high */
	while ((in_8(&regs->ipcr_acr.ipcr) & 0x80) == 0)
		;
	/* Finally, enable the PSC.
	 * Receiver must always be enabled; even when we only want
	 * transmit.  (see 15.3.2.3 of MPC5200B User's Guide) */

	/* Go */
	out_8(&psc_dma->psc_regs->command,
			MPC52xx_PSC_TX_ENABLE | MPC52xx_PSC_RX_ENABLE);

	return 0;

}

static int __devexit psc_i2s_of_remove(struct of_device *op)
{
	return mpc5200_audio_dma_destroy(op);
}

/* Match table for of_platform binding */
static struct of_device_id psc_i2s_match[] __devinitdata = {
	{ .compatible = "fsl,mpc5200-psc-i2s", },
	{ .compatible = "fsl,mpc5200b-psc-i2s", },
	{}
};
MODULE_DEVICE_TABLE(of, psc_i2s_match);

static struct of_platform_driver psc_i2s_driver = {
	.match_table = psc_i2s_match,
	.probe = psc_i2s_of_probe,
	.remove = __devexit_p(psc_i2s_of_remove),
	.driver = {
		.name = "mpc5200-psc-i2s",
		.owner = THIS_MODULE,
	},
};

/* ---------------------------------------------------------------------
 * Module setup and teardown; simply register the of_platform driver
 * for the PSC in I2S mode.
 */
static int __init psc_i2s_init(void)
{
	return of_register_platform_driver(&psc_i2s_driver);
}
module_init(psc_i2s_init);

static void __exit psc_i2s_exit(void)
{
	of_unregister_platform_driver(&psc_i2s_driver);
}
module_exit(psc_i2s_exit);

MODULE_AUTHOR("Grant Likely <grant.likely@secretlab.ca>");
MODULE_DESCRIPTION("Freescale MPC5200 PSC in I2S mode ASoC Driver");
MODULE_LICENSE("GPL");
Commit	Line	Data
dc641378 GL	1	/*
	2	* Freescale MPC5200 PSC in I2S mode
	3	* ALSA SoC Digital Audio Interface (DAI) driver
	4	*
	5	* Copyright (C) 2008 Secret Lab Technologies Ltd.
dbcc3475	6	* Copyright (C) 2009 Jon Smirl, Digispeaker
dc641378 GL	7	*/
dc641378 GL	8
dc641378	9	#include <linux/module.h>
dc641378 GL	10	#include <linux/of_device.h>
dc641378 GL	11	#include <linux/of_platform.h>
dc641378	12
dc641378 GL	13	#include <sound/pcm.h>
dc641378 GL	14	#include <sound/pcm_params.h>
dc641378	15	#include <sound/soc.h>
dc641378	16
dc641378 GL	17	#include <asm/mpc52xx_psc.h>
dc641378 GL	18
dbcc3475	19	#include "mpc5200_psc_i2s.h"
89dd0842 JS	20	#include "mpc5200_dma.h"
89dd0842 JS	21
dc641378 GL	22	/**
	23	* PSC_I2S_RATES: sample rates supported by the I2S
	24	*
	25	* This driver currently only supports the PSC running in I2S slave mode,
	26	* which means the codec determines the sample rate. Therefore, we tell
	27	* ALSA that we support all rates and let the codec driver decide what rates
	28	* are really supported.
	29	*/
	30	#define PSC_I2S_RATES (SNDRV_PCM_RATE_5512 \| SNDRV_PCM_RATE_8000_192000 \| \
	31	SNDRV_PCM_RATE_CONTINUOUS)
	32
	33	/**
	34	* PSC_I2S_FORMATS: audio formats supported by the PSC I2S mode
	35	*/
	36	#define PSC_I2S_FORMATS (SNDRV_PCM_FMTBIT_S8 \| SNDRV_PCM_FMTBIT_S16_BE \| \
dbcc3475	37	SNDRV_PCM_FMTBIT_S24_BE \| SNDRV_PCM_FMTBIT_S32_BE)
dc641378	38
dc641378	39	static int psc_i2s_hw_params(struct snd_pcm_substream *substream,
dee89c4d MB	40	struct snd_pcm_hw_params *params,
dee89c4d MB	41	struct snd_soc_dai *dai)
dc641378 GL	42	{
dc641378 GL	43	struct snd_soc_pcm_runtime *rtd = substream->private_data;
cebe7767	44	struct psc_dma *psc_dma = rtd->dai->cpu_dai->private_data;
dc641378 GL	45	u32 mode;
dc641378 GL	46
cebe7767	47	dev_dbg(psc_dma->dev, "%s(substream=%p) p_size=%i p_bytes=%i"
dc641378 GL	48	" periods=%i buffer_size=%i buffer_bytes=%i\n",
	49	__func__, substream, params_period_size(params),
	50	params_period_bytes(params), params_periods(params),
	51	params_buffer_size(params), params_buffer_bytes(params));
	52
	53	switch (params_format(params)) {
	54	case SNDRV_PCM_FORMAT_S8:
	55	mode = MPC52xx_PSC_SICR_SIM_CODEC_8;
	56	break;
	57	case SNDRV_PCM_FORMAT_S16_BE:
	58	mode = MPC52xx_PSC_SICR_SIM_CODEC_16;
	59	break;
	60	case SNDRV_PCM_FORMAT_S24_BE:
	61	mode = MPC52xx_PSC_SICR_SIM_CODEC_24;
	62	break;
	63	case SNDRV_PCM_FORMAT_S32_BE:
	64	mode = MPC52xx_PSC_SICR_SIM_CODEC_32;
	65	break;
	66	default:
cebe7767	67	dev_dbg(psc_dma->dev, "invalid format\n");
dc641378 GL	68	return -EINVAL;
dc641378 GL	69	}
cebe7767	70	out_be32(&psc_dma->psc_regs->sicr, psc_dma->sicr \| mode);
dc641378	71
dc641378 GL	72	return 0;
	73	}
	74
dc641378 GL	75	/**
	76	* psc_i2s_set_sysclk: set the clock frequency and direction
	77	*
	78	* This function is called by the machine driver to tell us what the clock
	79	* frequency and direction are.
	80	*
	81	* Currently, we only support operating as a clock slave (SND_SOC_CLOCK_IN),
	82	* and we don't care about the frequency. Return an error if the direction
	83	* is not SND_SOC_CLOCK_IN.
	84	*
	85	* @clk_id: reserved, should be zero
	86	* @freq: the frequency of the given clock ID, currently ignored
	87	* @dir: SND_SOC_CLOCK_IN (clock slave) or SND_SOC_CLOCK_OUT (clock master)
	88	*/
	89	static int psc_i2s_set_sysclk(struct snd_soc_dai *cpu_dai,
	90	int clk_id, unsigned int freq, int dir)
	91	{
cebe7767 JS	92	struct psc_dma *psc_dma = cpu_dai->private_data;
cebe7767 JS	93	dev_dbg(psc_dma->dev, "psc_i2s_set_sysclk(cpu_dai=%p, dir=%i)\n",
dc641378 GL	94	cpu_dai, dir);
	95	return (dir == SND_SOC_CLOCK_IN) ? 0 : -EINVAL;
	96	}
	97
	98	/**
	99	* psc_i2s_set_fmt: set the serial format.
	100	*
	101	* This function is called by the machine driver to tell us what serial
	102	* format to use.
	103	*
	104	* This driver only supports I2S mode. Return an error if the format is
	105	* not SND_SOC_DAIFMT_I2S.
	106	*
	107	* @format: one of SND_SOC_DAIFMT_xxx
	108	*/
	109	static int psc_i2s_set_fmt(struct snd_soc_dai *cpu_dai, unsigned int format)
	110	{
cebe7767 JS	111	struct psc_dma *psc_dma = cpu_dai->private_data;
cebe7767 JS	112	dev_dbg(psc_dma->dev, "psc_i2s_set_fmt(cpu_dai=%p, format=%i)\n",
dc641378 GL	113	cpu_dai, format);
	114	return (format == SND_SOC_DAIFMT_I2S) ? 0 : -EINVAL;
	115	}
	116
	117	/* ---------------------------------------------------------------------
	118	* ALSA SoC Bindings
	119	*
	120	* - Digital Audio Interface (DAI) template
	121	* - create/destroy dai hooks
	122	*/
	123
	124	/**
	125	* psc_i2s_dai_template: template CPU Digital Audio Interface
	126	*/
6335d055	127	static struct snd_soc_dai_ops psc_i2s_dai_ops = {
6335d055	128	.hw_params = psc_i2s_hw_params,
6335d055 EM	129	.set_sysclk = psc_i2s_set_sysclk,
	130	.set_fmt = psc_i2s_set_fmt,
	131	};
	132
dbcc3475 JS	133	struct snd_soc_dai psc_i2s_dai[] = {{
dbcc3475 JS	134	.name = "I2S",
dc641378 GL	135	.playback = {
	136	.channels_min = 2,
	137	.channels_max = 2,
	138	.rates = PSC_I2S_RATES,
	139	.formats = PSC_I2S_FORMATS,
	140	},
	141	.capture = {
	142	.channels_min = 2,
	143	.channels_max = 2,
	144	.rates = PSC_I2S_RATES,
	145	.formats = PSC_I2S_FORMATS,
	146	},
6335d055	147	.ops = &psc_i2s_dai_ops,
dbcc3475 JS	148	} };
dbcc3475 JS	149	EXPORT_SYMBOL_GPL(psc_i2s_dai);
dc641378 GL	150
	151	/* ---------------------------------------------------------------------
	152	* OF platform bus binding code:
	153	* - Probe/remove operations
	154	* - OF device match table
	155	*/
	156	static int __devinit psc_i2s_of_probe(struct of_device *op,
	157	const struct of_device_id *match)
	158	{
dbcc3475	159	int rc;
cebe7767	160	struct psc_dma *psc_dma;
dbcc3475	161	struct mpc52xx_psc __iomem *regs;
dc641378	162
dbcc3475 JS	163	rc = mpc5200_audio_dma_create(op);
	164	if (rc != 0)
	165	return rc;
	166
	167	rc = snd_soc_register_dais(psc_i2s_dai, ARRAY_SIZE(psc_i2s_dai));
	168	if (rc != 0) {
	169	pr_err("Failed to register DAI\n");
	170	return 0;
dc641378 GL	171	}
dc641378 GL	172
dbcc3475 JS	173	psc_dma = dev_get_drvdata(&op->dev);
dbcc3475 JS	174	regs = psc_dma->psc_regs;
dc641378 GL	175
dc641378 GL	176	/* Configure the serial interface mode; defaulting to CODEC8 mode */
cebe7767	177	psc_dma->sicr = MPC52xx_PSC_SICR_DTS1 \| MPC52xx_PSC_SICR_I2S \|
dc641378	178	MPC52xx_PSC_SICR_CLKPOL;
cebe7767 JS	179	out_be32(&psc_dma->psc_regs->sicr,
cebe7767 JS	180	psc_dma->sicr \| MPC52xx_PSC_SICR_SIM_CODEC_8);
dc641378 GL	181
	182	/* Check for the codec handle. If it is not present then we
	183	* are done */
	184	if (!of_get_property(op->node, "codec-handle", NULL))
	185	return 0;
	186
dbcc3475 JS	187	/* Due to errata in the dma mode; need to line up enabling
	188	* the transmitter with a transition on the frame sync
	189	* line */
	190
	191	/* first make sure it is low */
	192	while ((in_8(&regs->ipcr_acr.ipcr) & 0x80) != 0)
	193	;
	194	/* then wait for the transition to high */
	195	while ((in_8(&regs->ipcr_acr.ipcr) & 0x80) == 0)
	196	;
	197	/* Finally, enable the PSC.
	198	* Receiver must always be enabled; even when we only want
	199	* transmit. (see 15.3.2.3 of MPC5200B User's Guide) */
	200
	201	/* Go */
	202	out_8(&psc_dma->psc_regs->command,
	203	MPC52xx_PSC_TX_ENABLE \| MPC52xx_PSC_RX_ENABLE);
dc641378 GL	204
dc641378 GL	205	return 0;
dbcc3475	206
dc641378 GL	207	}
	208
	209	static int __devexit psc_i2s_of_remove(struct of_device *op)
	210	{
dbcc3475	211	return mpc5200_audio_dma_destroy(op);
dc641378 GL	212	}
	213
	214	/* Match table for of_platform binding */
	215	static struct of_device_id psc_i2s_match[] __devinitdata = {
	216	{ .compatible = "fsl,mpc5200-psc-i2s", },
dbcc3475	217	{ .compatible = "fsl,mpc5200b-psc-i2s", },
dc641378 GL	218	{}
	219	};
	220	MODULE_DEVICE_TABLE(of, psc_i2s_match);
	221
	222	static struct of_platform_driver psc_i2s_driver = {
	223	.match_table = psc_i2s_match,
	224	.probe = psc_i2s_of_probe,
	225	.remove = __devexit_p(psc_i2s_of_remove),
	226	.driver = {
	227	.name = "mpc5200-psc-i2s",
	228	.owner = THIS_MODULE,
	229	},
	230	};
	231
	232	/* ---------------------------------------------------------------------
	233	* Module setup and teardown; simply register the of_platform driver
	234	* for the PSC in I2S mode.
	235	*/
	236	static int __init psc_i2s_init(void)
	237	{
	238	return of_register_platform_driver(&psc_i2s_driver);
	239	}
	240	module_init(psc_i2s_init);
	241
	242	static void __exit psc_i2s_exit(void)
	243	{
	244	of_unregister_platform_driver(&psc_i2s_driver);
	245	}
	246	module_exit(psc_i2s_exit);
	247
dbcc3475 JS	248	MODULE_AUTHOR("Grant Likely <grant.likely@secretlab.ca>");
	249	MODULE_DESCRIPTION("Freescale MPC5200 PSC in I2S mode ASoC Driver");
	250	MODULE_LICENSE("GPL");
dc641378	251