[linux-2.6-block.git] / sound / soc / fsl / mpc5200_psc_i2s.c

// SPDX-License-Identifier: GPL-2.0-only
//
// 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_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[] = {{
	.name = "mpc5200-psc-i2s.0",
	.playback = {
		.stream_name = "I2S Playback",
		.channels_min = 2,
		.channels_max = 2,
		.rates = PSC_I2S_RATES,
		.formats = PSC_I2S_FORMATS,
	},
	.capture = {
		.stream_name = "I2S Capture",
		.channels_min = 2,
		.channels_max = 2,
		.rates = PSC_I2S_RATES,
		.formats = PSC_I2S_FORMATS,
	},
	.ops = &psc_i2s_dai_ops,
} };

static const struct snd_soc_component_driver psc_i2s_component = {
	.name		= "mpc5200-i2s",
};

/* ---------------------------------------------------------------------
 * OF platform bus binding code:
 * - Probe/remove operations
 * - OF device match table
 */
static int psc_i2s_of_probe(struct platform_device *op)
{
	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_component(&op->dev, &psc_i2s_component,
					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 psc_i2s_of_remove(struct platform_device *op)
{
	mpc5200_audio_dma_destroy(op);
	snd_soc_unregister_component(&op->dev);
	return 0;
}

/* Match table for of_platform binding */
static const struct of_device_id psc_i2s_match[] = {
	{ .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 = psc_i2s_of_remove,
	.driver = {
		.name = "mpc5200-psc-i2s",
		.of_match_table = psc_i2s_match,
	},
};

module_platform_driver(psc_i2s_driver);

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