[linux-2.6-block.git] / sound / soc / sh / hac.c

/*
 * Hitachi Audio Controller (AC97) support for SH7760/SH7780
 *
 * Copyright (c) 2007 Manuel Lauss <mano@roarinelk.homelinux.net>
 *  licensed under the terms outlined in the file COPYING at the root
 *  of the linux kernel sources.
 *
 * dont forget to set IPSEL/OMSEL register bits (in your board code) to
 * enable HAC output pins!
 */

/* BIG FAT FIXME: although the SH7760 has 2 independent AC97 units, only
 * the FIRST can be used since ASoC does not pass any information to the
 * ac97_read/write() functions regarding WHICH unit to use.  You'll have
 * to edit the code a bit to use the other AC97 unit.		--mlau
 */

#include <linux/init.h>
#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/interrupt.h>
#include <linux/wait.h>
#include <linux/delay.h>
#include <sound/core.h>
#include <sound/pcm.h>
#include <sound/ac97_codec.h>
#include <sound/initval.h>
#include <sound/soc.h>

/* regs and bits */
#define HACCR		0x08
#define HACCSAR		0x20
#define HACCSDR		0x24
#define HACPCML		0x28
#define HACPCMR		0x2C
#define HACTIER		0x50
#define	HACTSR		0x54
#define HACRIER		0x58
#define HACRSR		0x5C
#define HACACR		0x60

#define CR_CR		(1 << 15)	/* "codec-ready" indicator */
#define CR_CDRT		(1 << 11)	/* cold reset */
#define CR_WMRT		(1 << 10)	/* warm reset */
#define CR_B9		(1 << 9)	/* the mysterious "bit 9" */
#define CR_ST		(1 << 5)	/* AC97 link start bit */

#define CSAR_RD		(1 << 19)	/* AC97 data read bit */
#define CSAR_WR		(0)

#define TSR_CMDAMT	(1 << 31)
#define TSR_CMDDMT	(1 << 30)

#define RSR_STARY	(1 << 22)
#define RSR_STDRY	(1 << 21)

#define ACR_DMARX16	(1 << 30)
#define ACR_DMATX16	(1 << 29)
#define ACR_TX12ATOM	(1 << 26)
#define ACR_DMARX20	((1 << 24) | (1 << 22))
#define ACR_DMATX20	((1 << 23) | (1 << 21))

#define CSDR_SHIFT	4
#define CSDR_MASK	(0xffff << CSDR_SHIFT)
#define CSAR_SHIFT	12
#define CSAR_MASK	(0x7f << CSAR_SHIFT)

#define AC97_WRITE_RETRY	1
#define AC97_READ_RETRY		5

/* manual-suggested AC97 codec access timeouts (us) */
#define TMO_E1	500	/* 21 < E1 < 1000 */
#define TMO_E2	13	/* 13 < E2 */
#define TMO_E3	21	/* 21 < E3 */
#define TMO_E4	500	/* 21 < E4 < 1000 */

struct hac_priv {
	unsigned long mmio;	/* HAC base address */
} hac_cpu_data[] = {
#if defined(CONFIG_CPU_SUBTYPE_SH7760)
	{
		.mmio	= 0xFE240000,
	},
	{
		.mmio	= 0xFE250000,
	},
#elif defined(CONFIG_CPU_SUBTYPE_SH7780)
	{
		.mmio	= 0xFFE40000,
	},
#else
#error "Unsupported SuperH SoC"
#endif
};

#define HACREG(reg)	(*(unsigned long *)(hac->mmio + (reg)))

/*
 * AC97 read/write flow as outlined in the SH7760 manual (pages 903-906)
 */
static int hac_get_codec_data(struct hac_priv *hac, unsigned short r,
			      unsigned short *v)
{
	unsigned int to1, to2, i;
	unsigned short adr;

	for (i = AC97_READ_RETRY; i; i--) {
		*v = 0;
		/* wait for HAC to receive something from the codec */
		for (to1 = TMO_E4;
		     to1 && !(HACREG(HACRSR) & RSR_STARY);
		     --to1)
			udelay(1);
		for (to2 = TMO_E4; 
		     to2 && !(HACREG(HACRSR) & RSR_STDRY);
		     --to2)
			udelay(1);

		if (!to1 && !to2)
			return 0;	/* codec comm is down */

		adr = ((HACREG(HACCSAR) & CSAR_MASK) >> CSAR_SHIFT);
		*v  = ((HACREG(HACCSDR) & CSDR_MASK) >> CSDR_SHIFT);

		HACREG(HACRSR) &= ~(RSR_STDRY | RSR_STARY);

		if (r == adr)
			break;

		/* manual says: wait at least 21 usec before retrying */
		udelay(21);
	}
	HACREG(HACRSR) &= ~(RSR_STDRY | RSR_STARY);
	return i;
}

static unsigned short hac_read_codec_aux(struct hac_priv *hac,
					 unsigned short reg)
{
	unsigned short val;
	unsigned int i, to;

	for (i = AC97_READ_RETRY; i; i--) {
		/* send_read_request */
		local_irq_disable();
		HACREG(HACTSR) &= ~(TSR_CMDAMT);
		HACREG(HACCSAR) = (reg << CSAR_SHIFT) | CSAR_RD;
		local_irq_enable();

		for (to = TMO_E3;
		     to && !(HACREG(HACTSR) & TSR_CMDAMT);
		     --to)
			udelay(1);

		HACREG(HACTSR) &= ~TSR_CMDAMT;
		val = 0;
		if (hac_get_codec_data(hac, reg, &val) != 0)
			break;
	}

	return i ? val : ~0;
}

static void hac_ac97_write(struct snd_ac97 *ac97, unsigned short reg,
			   unsigned short val)
{
	int unit_id = 0 /* ac97->private_data */;
	struct hac_priv *hac = &hac_cpu_data[unit_id];
	unsigned int i, to;
	/* write_codec_aux */
	for (i = AC97_WRITE_RETRY; i; i--) {
		/* send_write_request */
		local_irq_disable();
		HACREG(HACTSR) &= ~(TSR_CMDDMT | TSR_CMDAMT);
		HACREG(HACCSDR) = (val << CSDR_SHIFT);
		HACREG(HACCSAR) = (reg << CSAR_SHIFT) & (~CSAR_RD);
		local_irq_enable();

		/* poll-wait for CMDAMT and CMDDMT */
		for (to = TMO_E1;
		     to && !(HACREG(HACTSR) & (TSR_CMDAMT|TSR_CMDDMT));
		     --to)
			udelay(1);

		HACREG(HACTSR) &= ~(TSR_CMDAMT | TSR_CMDDMT);
		if (to)
			break;
		/* timeout, try again */
	}
}

static unsigned short hac_ac97_read(struct snd_ac97 *ac97,
				    unsigned short reg)
{
	int unit_id = 0 /* ac97->private_data */;
	struct hac_priv *hac = &hac_cpu_data[unit_id];
	return hac_read_codec_aux(hac, reg);
}

static void hac_ac97_warmrst(struct snd_ac97 *ac97)
{
	int unit_id = 0 /* ac97->private_data */;
	struct hac_priv *hac = &hac_cpu_data[unit_id];
	unsigned int tmo;

	HACREG(HACCR) = CR_WMRT | CR_ST | CR_B9;
	msleep(10);
	HACREG(HACCR) = CR_ST | CR_B9;
	for (tmo = 1000; (tmo > 0) && !(HACREG(HACCR) & CR_CR); tmo--)
		udelay(1);

	if (!tmo)
		printk(KERN_INFO "hac: reset: AC97 link down!\n");
	/* settings this bit lets us have a conversation with codec */
	HACREG(HACACR) |= ACR_TX12ATOM;
}

static void hac_ac97_coldrst(struct snd_ac97 *ac97)
{
	int unit_id = 0 /* ac97->private_data */;
	struct hac_priv *hac;
	hac = &hac_cpu_data[unit_id];

	HACREG(HACCR) = 0;
	HACREG(HACCR) = CR_CDRT | CR_ST | CR_B9;
	msleep(10);
	hac_ac97_warmrst(ac97);
}

struct snd_ac97_bus_ops soc_ac97_ops = {
	.read	= hac_ac97_read,
	.write	= hac_ac97_write,
	.reset	= hac_ac97_coldrst,
	.warm_reset = hac_ac97_warmrst,
};
EXPORT_SYMBOL_GPL(soc_ac97_ops);

static int hac_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 hac_priv *hac = &hac_cpu_data[rtd->dai->cpu_dai->id];
	int d = substream->stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1;

	switch (params->msbits) {
	case 16:
		HACREG(HACACR) |= d ?  ACR_DMARX16 :  ACR_DMATX16;
		HACREG(HACACR) &= d ? ~ACR_DMARX20 : ~ACR_DMATX20;
		break;
	case 20:
		HACREG(HACACR) &= d ? ~ACR_DMARX16 : ~ACR_DMATX16;
		HACREG(HACACR) |= d ?  ACR_DMARX20 :  ACR_DMATX20;
		break;
	default:
		pr_debug("hac: invalid depth %d bit\n", params->msbits);
		return -EINVAL;
		break;
	}

	return 0;
}

#define AC97_RATES	\
	SNDRV_PCM_RATE_8000_192000

#define AC97_FMTS	\
	SNDRV_PCM_FMTBIT_S16_LE

struct snd_soc_dai sh4_hac_dai[] = {
{
	.name			= "HAC0",
	.id			= 0,
	.ac97_control		= 1,
	.playback = {
		.rates		= AC97_RATES,
		.formats	= AC97_FMTS,
		.channels_min	= 2,
		.channels_max	= 2,
	},
	.capture = {
		.rates		= AC97_RATES,
		.formats	= AC97_FMTS,
		.channels_min	= 2,
		.channels_max	= 2,
	},
	.ops = {
		.hw_params	= hac_hw_params,
	},
},
#ifdef CONFIG_CPU_SUBTYPE_SH7760
{
	.name			= "HAC1",
	.ac97_control		= 1,
	.id			= 1,
	.playback = {
		.rates		= AC97_RATES,
		.formats	= AC97_FMTS,
		.channels_min	= 2,
		.channels_max	= 2,
	},
	.capture = {
		.rates		= AC97_RATES,
		.formats	= AC97_FMTS,
		.channels_min	= 2,
		.channels_max	= 2,
	},
	.ops = {
		.hw_params	= hac_hw_params,
	},

},
#endif
};
EXPORT_SYMBOL_GPL(sh4_hac_dai);

static int __devinit sh4_hac_init(void)
{
	return snd_soc_register_dais(sh4_hac_dai, ARRAY_SIZE(sh4_hac_dai));
}
module_init(sh4_hac_init);

static void __exit sh4_hac_exit(void)
{
	snd_soc_unregister_dais(sh4_hac_dai, ARRAY_SIZE(sh4_hac_dai));
}
module_exit(sh4_hac_exit);

MODULE_LICENSE("GPL");
MODULE_DESCRIPTION("SuperH onchip HAC (AC97) audio driver");
MODULE_AUTHOR("Manuel Lauss <mano@roarinelk.homelinux.net>");
Commit	Line	Data
aef3b06a ML	1	/*
	2	* Hitachi Audio Controller (AC97) support for SH7760/SH7780
	3	*
	4	* Copyright (c) 2007 Manuel Lauss <mano@roarinelk.homelinux.net>
	5	* licensed under the terms outlined in the file COPYING at the root
	6	* of the linux kernel sources.
	7	*
	8	* dont forget to set IPSEL/OMSEL register bits (in your board code) to
	9	* enable HAC output pins!
	10	*/
	11
	12	/* BIG FAT FIXME: although the SH7760 has 2 independent AC97 units, only
	13	* the FIRST can be used since ASoC does not pass any information to the
	14	* ac97_read/write() functions regarding WHICH unit to use. You'll have
	15	* to edit the code a bit to use the other AC97 unit. --mlau
	16	*/
	17
	18	#include <linux/init.h>
	19	#include <linux/module.h>
	20	#include <linux/platform_device.h>
	21	#include <linux/interrupt.h>
	22	#include <linux/wait.h>
	23	#include <linux/delay.h>
aef3b06a ML	24	#include <sound/core.h>
	25	#include <sound/pcm.h>
	26	#include <sound/ac97_codec.h>
	27	#include <sound/initval.h>
	28	#include <sound/soc.h>
	29
	30	/* regs and bits */
	31	#define HACCR 0x08
	32	#define HACCSAR 0x20
	33	#define HACCSDR 0x24
	34	#define HACPCML 0x28
	35	#define HACPCMR 0x2C
	36	#define HACTIER 0x50
	37	#define HACTSR 0x54
	38	#define HACRIER 0x58
	39	#define HACRSR 0x5C
	40	#define HACACR 0x60
	41
	42	#define CR_CR (1 << 15) /* "codec-ready" indicator */
	43	#define CR_CDRT (1 << 11) /* cold reset */
	44	#define CR_WMRT (1 << 10) /* warm reset */
	45	#define CR_B9 (1 << 9) /* the mysterious "bit 9" */
	46	#define CR_ST (1 << 5) /* AC97 link start bit */
	47
	48	#define CSAR_RD (1 << 19) /* AC97 data read bit */
	49	#define CSAR_WR (0)
	50
	51	#define TSR_CMDAMT (1 << 31)
	52	#define TSR_CMDDMT (1 << 30)
	53
	54	#define RSR_STARY (1 << 22)
	55	#define RSR_STDRY (1 << 21)
	56
	57	#define ACR_DMARX16 (1 << 30)
	58	#define ACR_DMATX16 (1 << 29)
	59	#define ACR_TX12ATOM (1 << 26)
	60	#define ACR_DMARX20 ((1 << 24) \| (1 << 22))
	61	#define ACR_DMATX20 ((1 << 23) \| (1 << 21))
	62
	63	#define CSDR_SHIFT 4
	64	#define CSDR_MASK (0xffff << CSDR_SHIFT)
	65	#define CSAR_SHIFT 12
	66	#define CSAR_MASK (0x7f << CSAR_SHIFT)
	67
	68	#define AC97_WRITE_RETRY 1
	69	#define AC97_READ_RETRY 5
	70
	71	/* manual-suggested AC97 codec access timeouts (us) */
	72	#define TMO_E1 500 /* 21 < E1 < 1000 */
	73	#define TMO_E2 13 /* 13 < E2 */
	74	#define TMO_E3 21 /* 21 < E3 */
	75	#define TMO_E4 500 /* 21 < E4 < 1000 */
	76
	77	struct hac_priv {
	78	unsigned long mmio; /* HAC base address */
	79	} hac_cpu_data[] = {
	80	#if defined(CONFIG_CPU_SUBTYPE_SH7760)
	81	{
	82	.mmio = 0xFE240000,
	83	},
	84	{
	85	.mmio = 0xFE250000,
	86	},
	87	#elif defined(CONFIG_CPU_SUBTYPE_SH7780)
88	{
89	.mmio = 0xFFE40000,
90	},
91	#else
92	#error "Unsupported SuperH SoC"
93	#endif
94	};
95
96	#define HACREG(reg) ((unsigned long )(hac->mmio + (reg)))
97
98	/*
99	* AC97 read/write flow as outlined in the SH7760 manual (pages 903-906)
100	*/
101	static int hac_get_codec_data(struct hac_priv *hac, unsigned short r,
102	unsigned short *v)
103	{
104	unsigned int to1, to2, i;
105	unsigned short adr;
106
690eceb5	107	for (i = AC97_READ_RETRY; i; i--) {
aef3b06a ML	108	*v = 0;
	109	/* wait for HAC to receive something from the codec */
	110	for (to1 = TMO_E4;
	111	to1 && !(HACREG(HACRSR) & RSR_STARY);
	112	--to1)
	113	udelay(1);
	114	for (to2 = TMO_E4;
	115	to2 && !(HACREG(HACRSR) & RSR_STDRY);
	116	--to2)
	117	udelay(1);
	118
	119	if (!to1 && !to2)
	120	return 0; /* codec comm is down */
	121
	122	adr = ((HACREG(HACCSAR) & CSAR_MASK) >> CSAR_SHIFT);
	123	*v = ((HACREG(HACCSDR) & CSDR_MASK) >> CSDR_SHIFT);
	124
	125	HACREG(HACRSR) &= ~(RSR_STDRY \| RSR_STARY);
	126
	127	if (r == adr)
	128	break;
	129
	130	/* manual says: wait at least 21 usec before retrying */
	131	udelay(21);
	132	}
	133	HACREG(HACRSR) &= ~(RSR_STDRY \| RSR_STARY);
690eceb5	134	return i;
aef3b06a ML	135	}
	136
	137	static unsigned short hac_read_codec_aux(struct hac_priv *hac,
	138	unsigned short reg)
	139	{
	140	unsigned short val;
	141	unsigned int i, to;
	142
690eceb5	143	for (i = AC97_READ_RETRY; i; i--) {
aef3b06a ML	144	/* send_read_request */
	145	local_irq_disable();
	146	HACREG(HACTSR) &= ~(TSR_CMDAMT);
	147	HACREG(HACCSAR) = (reg << CSAR_SHIFT) \| CSAR_RD;
	148	local_irq_enable();
	149
	150	for (to = TMO_E3;
	151	to && !(HACREG(HACTSR) & TSR_CMDAMT);
	152	--to)
	153	udelay(1);
	154
	155	HACREG(HACTSR) &= ~TSR_CMDAMT;
	156	val = 0;
	157	if (hac_get_codec_data(hac, reg, &val) != 0)
	158	break;
	159	}
	160
690eceb5	161	return i ? val : ~0;
aef3b06a ML	162	}
	163
	164	static void hac_ac97_write(struct snd_ac97 *ac97, unsigned short reg,
	165	unsigned short val)
	166	{
	167	int unit_id = 0 /* ac97->private_data */;
	168	struct hac_priv *hac = &hac_cpu_data[unit_id];
	169	unsigned int i, to;
	170	/* write_codec_aux */
690eceb5	171	for (i = AC97_WRITE_RETRY; i; i--) {
aef3b06a ML	172	/* send_write_request */
	173	local_irq_disable();
	174	HACREG(HACTSR) &= ~(TSR_CMDDMT \| TSR_CMDAMT);
	175	HACREG(HACCSDR) = (val << CSDR_SHIFT);
	176	HACREG(HACCSAR) = (reg << CSAR_SHIFT) & (~CSAR_RD);
	177	local_irq_enable();
	178
	179	/* poll-wait for CMDAMT and CMDDMT */
	180	for (to = TMO_E1;
	181	to && !(HACREG(HACTSR) & (TSR_CMDAMT\|TSR_CMDDMT));
	182	--to)
	183	udelay(1);
	184
	185	HACREG(HACTSR) &= ~(TSR_CMDAMT \| TSR_CMDDMT);
	186	if (to)
	187	break;
	188	/* timeout, try again */
	189	}
	190	}
	191
	192	static unsigned short hac_ac97_read(struct snd_ac97 *ac97,
	193	unsigned short reg)
	194	{
	195	int unit_id = 0 /* ac97->private_data */;
	196	struct hac_priv *hac = &hac_cpu_data[unit_id];
	197	return hac_read_codec_aux(hac, reg);
	198	}
	199
	200	static void hac_ac97_warmrst(struct snd_ac97 *ac97)
	201	{
	202	int unit_id = 0 /* ac97->private_data */;
	203	struct hac_priv *hac = &hac_cpu_data[unit_id];
	204	unsigned int tmo;
	205
	206	HACREG(HACCR) = CR_WMRT \| CR_ST \| CR_B9;
	207	msleep(10);
	208	HACREG(HACCR) = CR_ST \| CR_B9;
	209	for (tmo = 1000; (tmo > 0) && !(HACREG(HACCR) & CR_CR); tmo--)
	210	udelay(1);
	211
	212	if (!tmo)
	213	printk(KERN_INFO "hac: reset: AC97 link down!\n");
	214	/* settings this bit lets us have a conversation with codec */
	215	HACREG(HACACR) \|= ACR_TX12ATOM;
	216	}
	217
	218	static void hac_ac97_coldrst(struct snd_ac97 *ac97)
	219	{
	220	int unit_id = 0 /* ac97->private_data */;
	221	struct hac_priv *hac;
	222	hac = &hac_cpu_data[unit_id];
	223
	224	HACREG(HACCR) = 0;
	225	HACREG(HACCR) = CR_CDRT \| CR_ST \| CR_B9;
	226	msleep(10);
	227	hac_ac97_warmrst(ac97);
	228	}
	229
	230	struct snd_ac97_bus_ops soc_ac97_ops = {
	231	.read = hac_ac97_read,
	232	.write = hac_ac97_write,
	233	.reset = hac_ac97_coldrst,
	234	.warm_reset = hac_ac97_warmrst,
	235	};
236	EXPORT_SYMBOL_GPL(soc_ac97_ops);
237
238	static int hac_hw_params(struct snd_pcm_substream *substream,
dee89c4d MB	239	struct snd_pcm_hw_params *params,
dee89c4d MB	240	struct snd_soc_dai *dai)
aef3b06a ML	241	{
	242	struct snd_soc_pcm_runtime *rtd = substream->private_data;
	243	struct hac_priv *hac = &hac_cpu_data[rtd->dai->cpu_dai->id];
	244	int d = substream->stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1;
	245
	246	switch (params->msbits) {
	247	case 16:
	248	HACREG(HACACR) \|= d ? ACR_DMARX16 : ACR_DMATX16;
	249	HACREG(HACACR) &= d ? ~ACR_DMARX20 : ~ACR_DMATX20;
	250	break;
	251	case 20:
	252	HACREG(HACACR) &= d ? ~ACR_DMARX16 : ~ACR_DMATX16;
	253	HACREG(HACACR) \|= d ? ACR_DMARX20 : ACR_DMATX20;
	254	break;
	255	default:
	256	pr_debug("hac: invalid depth %d bit\n", params->msbits);
	257	return -EINVAL;
	258	break;
	259	}
	260
	261	return 0;
	262	}
	263
	264	#define AC97_RATES \
	265	SNDRV_PCM_RATE_8000_192000
	266
	267	#define AC97_FMTS \
	268	SNDRV_PCM_FMTBIT_S16_LE
	269
53640650	270	struct snd_soc_dai sh4_hac_dai[] = {
aef3b06a ML	271	{
	272	.name = "HAC0",
	273	.id = 0,
3ba9e10a	274	.ac97_control = 1,
aef3b06a ML	275	.playback = {
	276	.rates = AC97_RATES,
	277	.formats = AC97_FMTS,
	278	.channels_min = 2,
	279	.channels_max = 2,
	280	},
	281	.capture = {
	282	.rates = AC97_RATES,
	283	.formats = AC97_FMTS,
	284	.channels_min = 2,
	285	.channels_max = 2,
	286	},
	287	.ops = {
	288	.hw_params = hac_hw_params,
	289	},
	290	},
	291	#ifdef CONFIG_CPU_SUBTYPE_SH7760
	292	{
	293	.name = "HAC1",
3ba9e10a	294	.ac97_control = 1,
aef3b06a	295	.id = 1,
aef3b06a ML	296	.playback = {
	297	.rates = AC97_RATES,
	298	.formats = AC97_FMTS,
	299	.channels_min = 2,
	300	.channels_max = 2,
	301	},
	302	.capture = {
	303	.rates = AC97_RATES,
	304	.formats = AC97_FMTS,
	305	.channels_min = 2,
	306	.channels_max = 2,
	307	},
	308	.ops = {
	309	.hw_params = hac_hw_params,
	310	},
	311
	312	},
	313	#endif
	314	};
	315	EXPORT_SYMBOL_GPL(sh4_hac_dai);
	316
3f4b783c MB	317	static int __devinit sh4_hac_init(void)
	318	{
	319	return snd_soc_register_dais(sh4_hac_dai, ARRAY_SIZE(sh4_hac_dai));
	320	}
	321	module_init(sh4_hac_init);
	322
	323	static void __exit sh4_hac_exit(void)
	324	{
	325	snd_soc_unregister_dais(sh4_hac_dai, ARRAY_SIZE(sh4_hac_dai));
	326	}
	327	module_exit(sh4_hac_exit);
	328
aef3b06a ML	329	MODULE_LICENSE("GPL");
	330	MODULE_DESCRIPTION("SuperH onchip HAC (AC97) audio driver");
	331	MODULE_AUTHOR("Manuel Lauss <mano@roarinelk.homelinux.net>");