[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_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 = snd_soc_dai_get_drvdata(rtd->cpu_dai);
	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 = snd_soc_dai_get_drvdata(cpu_dai);
	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 = snd_soc_dai_get_drvdata(cpu_dai);
	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 const 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,
};

static struct snd_soc_dai_driver psc_i2s_dai[] = {{
	.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,
} };

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

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

	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->dev.of_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 platform_device *op)
{
	snd_soc_unregister_dais(&op->dev, ARRAY_SIZE(psc_i2s_dai));
	return 0;
}

/* 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 platform_driver psc_i2s_driver = {
	.probe = psc_i2s_of_probe,
	.remove = __devexit_p(psc_i2s_of_remove),
	.driver = {
		.name = "mpc5200-psc-i2s",
		.owner = THIS_MODULE,
		.of_match_table = psc_i2s_match,
	},
};

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

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