[mirror_ubuntu-bionic-kernel.git] / sound / isa / sb / sb_common.c

/*
 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
 *                   Uros Bizjak <uros@kss-loka.si>
 *
 *  Lowlevel routines for control of Sound Blaster cards
 *
 *   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/delay.h>
#include <linux/init.h>
#include <linux/interrupt.h>
#include <linux/slab.h>
#include <linux/ioport.h>
#include <linux/module.h>
#include <linux/io.h>
#include <sound/core.h>
#include <sound/sb.h>
#include <sound/initval.h>

#include <asm/dma.h>

MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
MODULE_DESCRIPTION("ALSA lowlevel driver for Sound Blaster cards");
MODULE_LICENSE("GPL");

#define BUSY_LOOPS 100000

#undef IO_DEBUG

int snd_sbdsp_command(struct snd_sb *chip, unsigned char val)
{
	int i;
#ifdef IO_DEBUG
	snd_printk(KERN_DEBUG "command 0x%x\n", val);
#endif
	for (i = BUSY_LOOPS; i; i--)
		if ((inb(SBP(chip, STATUS)) & 0x80) == 0) {
			outb(val, SBP(chip, COMMAND));
			return 1;
		}
	snd_printd("%s [0x%lx]: timeout (0x%x)\n", __func__, chip->port, val);
	return 0;
}

int snd_sbdsp_get_byte(struct snd_sb *chip)
{
	int val;
	int i;
	for (i = BUSY_LOOPS; i; i--) {
		if (inb(SBP(chip, DATA_AVAIL)) & 0x80) {
			val = inb(SBP(chip, READ));
#ifdef IO_DEBUG
			snd_printk(KERN_DEBUG "get_byte 0x%x\n", val);
#endif
			return val;
		}
	}
	snd_printd("%s [0x%lx]: timeout\n", __func__, chip->port);
	return -ENODEV;
}

int snd_sbdsp_reset(struct snd_sb *chip)
{
	int i;

	outb(1, SBP(chip, RESET));
	udelay(10);
	outb(0, SBP(chip, RESET));
	udelay(30);
	for (i = BUSY_LOOPS; i; i--)
		if (inb(SBP(chip, DATA_AVAIL)) & 0x80) {
			if (inb(SBP(chip, READ)) == 0xaa)
				return 0;
			else
				break;
		}
	snd_printdd("%s [0x%lx] failed...\n", __func__, chip->port);
	return -ENODEV;
}

static int snd_sbdsp_version(struct snd_sb * chip)
{
	unsigned int result = -ENODEV;

	snd_sbdsp_command(chip, SB_DSP_GET_VERSION);
	result = (short) snd_sbdsp_get_byte(chip) << 8;
	result |= (short) snd_sbdsp_get_byte(chip);
	return result;
}

static int snd_sbdsp_probe(struct snd_sb * chip)
{
	int version;
	int major, minor;
	char *str;
	unsigned long flags;

	/*
	 *  initialization sequence
	 */

	spin_lock_irqsave(&chip->reg_lock, flags);
	if (snd_sbdsp_reset(chip) < 0) {
		spin_unlock_irqrestore(&chip->reg_lock, flags);
		return -ENODEV;
	}
	version = snd_sbdsp_version(chip);
	if (version < 0) {
		spin_unlock_irqrestore(&chip->reg_lock, flags);
		return -ENODEV;
	}
	spin_unlock_irqrestore(&chip->reg_lock, flags);
	major = version >> 8;
	minor = version & 0xff;
	snd_printdd("SB [0x%lx]: DSP chip found, version = %i.%i\n",
		    chip->port, major, minor);

	switch (chip->hardware) {
	case SB_HW_AUTO:
		switch (major) {
		case 1:
			chip->hardware = SB_HW_10;
			str = "1.0";
			break;
		case 2:
			if (minor) {
				chip->hardware = SB_HW_201;
				str = "2.01+";
			} else {
				chip->hardware = SB_HW_20;
				str = "2.0";
			}
			break;
		case 3:
			chip->hardware = SB_HW_PRO;
			str = "Pro";
			break;
		case 4:
			chip->hardware = SB_HW_16;
			str = "16";
			break;
		default:
			snd_printk(KERN_INFO "SB [0x%lx]: unknown DSP chip version %i.%i\n",
				   chip->port, major, minor);
			return -ENODEV;
		}
		break;
	case SB_HW_ALS100:
		str = "16 (ALS-100)";
		break;
	case SB_HW_ALS4000:
		str = "16 (ALS-4000)";
		break;
	case SB_HW_DT019X:
		str = "(DT019X/ALS007)";
		break;
	case SB_HW_CS5530:
		str = "16 (CS5530)";
		break;
	case SB_HW_JAZZ16:
		str = "Pro (Jazz16)";
		break;
	default:
		return -ENODEV;
	}
	sprintf(chip->name, "Sound Blaster %s", str);
	chip->version = (major << 8) | minor;
	return 0;
}

static int snd_sbdsp_free(struct snd_sb *chip)
{
	release_and_free_resource(chip->res_port);
	if (chip->irq >= 0)
		free_irq(chip->irq, (void *) chip);
#ifdef CONFIG_ISA
	if (chip->dma8 >= 0) {
		disable_dma(chip->dma8);
		free_dma(chip->dma8);
	}
	if (chip->dma16 >= 0 && chip->dma16 != chip->dma8) {
		disable_dma(chip->dma16);
		free_dma(chip->dma16);
	}
#endif
	kfree(chip);
	return 0;
}

static int snd_sbdsp_dev_free(struct snd_device *device)
{
	struct snd_sb *chip = device->device_data;
	return snd_sbdsp_free(chip);
}

int snd_sbdsp_create(struct snd_card *card,
		     unsigned long port,
		     int irq,
		     irq_handler_t irq_handler,
		     int dma8,
		     int dma16,
		     unsigned short hardware,
		     struct snd_sb **r_chip)
{
	struct snd_sb *chip;
	int err;
	static struct snd_device_ops ops = {
		.dev_free =	snd_sbdsp_dev_free,
	};

	if (snd_BUG_ON(!r_chip))
		return -EINVAL;
	*r_chip = NULL;
	chip = kzalloc(sizeof(*chip), GFP_KERNEL);
	if (chip == NULL)
		return -ENOMEM;
	spin_lock_init(&chip->reg_lock);
	spin_lock_init(&chip->open_lock);
	spin_lock_init(&chip->midi_input_lock);
	spin_lock_init(&chip->mixer_lock);
	chip->irq = -1;
	chip->dma8 = -1;
	chip->dma16 = -1;
	chip->port = port;
	
	if (request_irq(irq, irq_handler,
			(hardware == SB_HW_ALS4000 ||
			 hardware == SB_HW_CS5530) ?
			IRQF_SHARED : 0,
			"SoundBlaster", (void *) chip)) {
		snd_printk(KERN_ERR "sb: can't grab irq %d\n", irq);
		snd_sbdsp_free(chip);
		return -EBUSY;
	}
	chip->irq = irq;

	if (hardware == SB_HW_ALS4000)
		goto __skip_allocation;
	
	if ((chip->res_port = request_region(port, 16, "SoundBlaster")) == NULL) {
		snd_printk(KERN_ERR "sb: can't grab port 0x%lx\n", port);
		snd_sbdsp_free(chip);
		return -EBUSY;
	}

#ifdef CONFIG_ISA
	if (dma8 >= 0 && request_dma(dma8, "SoundBlaster - 8bit")) {
		snd_printk(KERN_ERR "sb: can't grab DMA8 %d\n", dma8);
		snd_sbdsp_free(chip);
		return -EBUSY;
	}
	chip->dma8 = dma8;
	if (dma16 >= 0) {
		if (hardware != SB_HW_ALS100 && (dma16 < 5 || dma16 > 7)) {
			/* no duplex */
			dma16 = -1;
		} else if (request_dma(dma16, "SoundBlaster - 16bit")) {
			snd_printk(KERN_ERR "sb: can't grab DMA16 %d\n", dma16);
			snd_sbdsp_free(chip);
			return -EBUSY;
		}
	}
	chip->dma16 = dma16;
#endif

      __skip_allocation:
	chip->card = card;
	chip->hardware = hardware;
	if ((err = snd_sbdsp_probe(chip)) < 0) {
		snd_sbdsp_free(chip);
		return err;
	}
	if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
		snd_sbdsp_free(chip);
		return err;
	}
	*r_chip = chip;
	return 0;
}

EXPORT_SYMBOL(snd_sbdsp_command);
EXPORT_SYMBOL(snd_sbdsp_get_byte);
EXPORT_SYMBOL(snd_sbdsp_reset);
EXPORT_SYMBOL(snd_sbdsp_create);
/* sb_mixer.c */
EXPORT_SYMBOL(snd_sbmixer_write);
EXPORT_SYMBOL(snd_sbmixer_read);
EXPORT_SYMBOL(snd_sbmixer_new);
EXPORT_SYMBOL(snd_sbmixer_add_ctl);
#ifdef CONFIG_PM
EXPORT_SYMBOL(snd_sbmixer_suspend);
EXPORT_SYMBOL(snd_sbmixer_resume);
#endif

/*
 *  INIT part
 */

static int __init alsa_sb_common_init(void)
{
	return 0;
}

static void __exit alsa_sb_common_exit(void)
{
}

module_init(alsa_sb_common_init)
module_exit(alsa_sb_common_exit)
Commit	Line	Data
1da177e4	1	/*
c1017a4c	2	* Copyright (c) by Jaroslav Kysela <perex@perex.cz>
1da177e4 LT	3	* Uros Bizjak <uros@kss-loka.si>
	4	*
	5	* Lowlevel routines for control of Sound Blaster cards
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	20	*
	21	*/
	22
1da177e4 LT	23	#include <linux/delay.h>
	24	#include <linux/init.h>
	25	#include <linux/interrupt.h>
	26	#include <linux/slab.h>
	27	#include <linux/ioport.h>
da155d5b	28	#include <linux/module.h>
6cbbfe1c	29	#include <linux/io.h>
1da177e4 LT	30	#include <sound/core.h>
	31	#include <sound/sb.h>
	32	#include <sound/initval.h>
	33
1da177e4 LT	34	#include <asm/dma.h>
1da177e4 LT	35
c1017a4c	36	MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
1da177e4 LT	37	MODULE_DESCRIPTION("ALSA lowlevel driver for Sound Blaster cards");
	38	MODULE_LICENSE("GPL");
	39
	40	#define BUSY_LOOPS 100000
	41
	42	#undef IO_DEBUG
	43
029d64b0	44	int snd_sbdsp_command(struct snd_sb *chip, unsigned char val)
1da177e4 LT	45	{
	46	int i;
	47	#ifdef IO_DEBUG
99b359ba	48	snd_printk(KERN_DEBUG "command 0x%x\n", val);
1da177e4 LT	49	#endif
	50	for (i = BUSY_LOOPS; i; i--)
	51	if ((inb(SBP(chip, STATUS)) & 0x80) == 0) {
	52	outb(val, SBP(chip, COMMAND));
	53	return 1;
	54	}
9bf8e7dd	55	snd_printd("%s [0x%lx]: timeout (0x%x)\n", __func__, chip->port, val);
1da177e4 LT	56	return 0;
	57	}
	58
029d64b0	59	int snd_sbdsp_get_byte(struct snd_sb *chip)
1da177e4 LT	60	{
	61	int val;
	62	int i;
	63	for (i = BUSY_LOOPS; i; i--) {
	64	if (inb(SBP(chip, DATA_AVAIL)) & 0x80) {
	65	val = inb(SBP(chip, READ));
	66	#ifdef IO_DEBUG
99b359ba	67	snd_printk(KERN_DEBUG "get_byte 0x%x\n", val);
1da177e4 LT	68	#endif
	69	return val;
	70	}
	71	}
9bf8e7dd	72	snd_printd("%s [0x%lx]: timeout\n", __func__, chip->port);
1da177e4 LT	73	return -ENODEV;
	74	}
	75
029d64b0	76	int snd_sbdsp_reset(struct snd_sb *chip)
1da177e4 LT	77	{
	78	int i;
	79
	80	outb(1, SBP(chip, RESET));
	81	udelay(10);
	82	outb(0, SBP(chip, RESET));
	83	udelay(30);
	84	for (i = BUSY_LOOPS; i; i--)
	85	if (inb(SBP(chip, DATA_AVAIL)) & 0x80) {
	86	if (inb(SBP(chip, READ)) == 0xaa)
	87	return 0;
	88	else
	89	break;
	90	}
9bf8e7dd	91	snd_printdd("%s [0x%lx] failed...\n", __func__, chip->port);
1da177e4 LT	92	return -ENODEV;
	93	}
	94
029d64b0	95	static int snd_sbdsp_version(struct snd_sb * chip)
1da177e4 LT	96	{
	97	unsigned int result = -ENODEV;
	98
	99	snd_sbdsp_command(chip, SB_DSP_GET_VERSION);
	100	result = (short) snd_sbdsp_get_byte(chip) << 8;
	101	result \|= (short) snd_sbdsp_get_byte(chip);
	102	return result;
	103	}
	104
029d64b0	105	static int snd_sbdsp_probe(struct snd_sb * chip)
1da177e4 LT	106	{
	107	int version;
	108	int major, minor;
	109	char *str;
	110	unsigned long flags;
	111
	112	/*
	113	* initialization sequence
	114	*/
	115
	116	spin_lock_irqsave(&chip->reg_lock, flags);
	117	if (snd_sbdsp_reset(chip) < 0) {
	118	spin_unlock_irqrestore(&chip->reg_lock, flags);
	119	return -ENODEV;
	120	}
	121	version = snd_sbdsp_version(chip);
	122	if (version < 0) {
	123	spin_unlock_irqrestore(&chip->reg_lock, flags);
	124	return -ENODEV;
	125	}
	126	spin_unlock_irqrestore(&chip->reg_lock, flags);
	127	major = version >> 8;
	128	minor = version & 0xff;
	129	snd_printdd("SB [0x%lx]: DSP chip found, version = %i.%i\n",
	130	chip->port, major, minor);
621887ae	131
1da177e4 LT	132	switch (chip->hardware) {
	133	case SB_HW_AUTO:
	134	switch (major) {
	135	case 1:
	136	chip->hardware = SB_HW_10;
	137	str = "1.0";
	138	break;
	139	case 2:
	140	if (minor) {
	141	chip->hardware = SB_HW_201;
	142	str = "2.01+";
	143	} else {
	144	chip->hardware = SB_HW_20;
	145	str = "2.0";
	146	}
	147	break;
	148	case 3:
	149	chip->hardware = SB_HW_PRO;
	150	str = "Pro";
	151	break;
	152	case 4:
	153	chip->hardware = SB_HW_16;
	154	str = "16";
	155	break;
	156	default:
99b359ba	157	snd_printk(KERN_INFO "SB [0x%lx]: unknown DSP chip version %i.%i\n",
1da177e4 LT	158	chip->port, major, minor);
	159	return -ENODEV;
	160	}
	161	break;
	162	case SB_HW_ALS100:
	163	str = "16 (ALS-100)";
	164	break;
	165	case SB_HW_ALS4000:
	166	str = "16 (ALS-4000)";
	167	break;
	168	case SB_HW_DT019X:
	169	str = "(DT019X/ALS007)";
	170	break;
621887ae TI	171	case SB_HW_CS5530:
	172	str = "16 (CS5530)";
	173	break;
ad8decb7 KH	174	case SB_HW_JAZZ16:
	175	str = "Pro (Jazz16)";
	176	break;
1da177e4 LT	177	default:
	178	return -ENODEV;
	179	}
	180	sprintf(chip->name, "Sound Blaster %s", str);
	181	chip->version = (major << 8) \| minor;
	182	return 0;
	183	}
	184
029d64b0	185	static int snd_sbdsp_free(struct snd_sb *chip)
1da177e4	186	{
966b7bc9	187	release_and_free_resource(chip->res_port);
1da177e4 LT	188	if (chip->irq >= 0)
	189	free_irq(chip->irq, (void *) chip);
	190	#ifdef CONFIG_ISA
	191	if (chip->dma8 >= 0) {
	192	disable_dma(chip->dma8);
	193	free_dma(chip->dma8);
	194	}
	195	if (chip->dma16 >= 0 && chip->dma16 != chip->dma8) {
	196	disable_dma(chip->dma16);
	197	free_dma(chip->dma16);
	198	}
	199	#endif
	200	kfree(chip);
	201	return 0;
	202	}
	203
029d64b0	204	static int snd_sbdsp_dev_free(struct snd_device *device)
1da177e4	205	{
029d64b0	206	struct snd_sb *chip = device->device_data;
1da177e4 LT	207	return snd_sbdsp_free(chip);
	208	}
	209
029d64b0	210	int snd_sbdsp_create(struct snd_card *card,
1da177e4 LT	211	unsigned long port,
1da177e4 LT	212	int irq,
7d12e780	213	irq_handler_t irq_handler,
1da177e4 LT	214	int dma8,
	215	int dma16,
	216	unsigned short hardware,
029d64b0	217	struct snd_sb **r_chip)
1da177e4	218	{
029d64b0	219	struct snd_sb *chip;
1da177e4	220	int err;
029d64b0	221	static struct snd_device_ops ops = {
1da177e4 LT	222	.dev_free = snd_sbdsp_dev_free,
	223	};
	224
622207dc TI	225	if (snd_BUG_ON(!r_chip))
622207dc TI	226	return -EINVAL;
1da177e4	227	*r_chip = NULL;
9e76a76e	228	chip = kzalloc(sizeof(*chip), GFP_KERNEL);
1da177e4 LT	229	if (chip == NULL)
	230	return -ENOMEM;
	231	spin_lock_init(&chip->reg_lock);
	232	spin_lock_init(&chip->open_lock);
	233	spin_lock_init(&chip->midi_input_lock);
	234	spin_lock_init(&chip->mixer_lock);
	235	chip->irq = -1;
	236	chip->dma8 = -1;
	237	chip->dma16 = -1;
	238	chip->port = port;
	239
2d4a485b TI	240	if (request_irq(irq, irq_handler,
	241	(hardware == SB_HW_ALS4000 \|\|
	242	hardware == SB_HW_CS5530) ?
88e24c3a	243	IRQF_SHARED : 0,
1da177e4 LT	244	"SoundBlaster", (void *) chip)) {
	245	snd_printk(KERN_ERR "sb: can't grab irq %d\n", irq);
	246	snd_sbdsp_free(chip);
	247	return -EBUSY;
	248	}
	249	chip->irq = irq;
	250
	251	if (hardware == SB_HW_ALS4000)
	252	goto __skip_allocation;
	253
	254	if ((chip->res_port = request_region(port, 16, "SoundBlaster")) == NULL) {
	255	snd_printk(KERN_ERR "sb: can't grab port 0x%lx\n", port);
	256	snd_sbdsp_free(chip);
	257	return -EBUSY;
	258	}
	259
	260	#ifdef CONFIG_ISA
	261	if (dma8 >= 0 && request_dma(dma8, "SoundBlaster - 8bit")) {
	262	snd_printk(KERN_ERR "sb: can't grab DMA8 %d\n", dma8);
	263	snd_sbdsp_free(chip);
	264	return -EBUSY;
	265	}
	266	chip->dma8 = dma8;
	267	if (dma16 >= 0) {
	268	if (hardware != SB_HW_ALS100 && (dma16 < 5 \|\| dma16 > 7)) {
	269	/* no duplex */
	270	dma16 = -1;
	271	} else if (request_dma(dma16, "SoundBlaster - 16bit")) {
	272	snd_printk(KERN_ERR "sb: can't grab DMA16 %d\n", dma16);
	273	snd_sbdsp_free(chip);
	274	return -EBUSY;
	275	}
	276	}
	277	chip->dma16 = dma16;
	278	#endif
	279
	280	__skip_allocation:
	281	chip->card = card;
	282	chip->hardware = hardware;
	283	if ((err = snd_sbdsp_probe(chip)) < 0) {
	284	snd_sbdsp_free(chip);
	285	return err;
	286	}
	287	if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
	288	snd_sbdsp_free(chip);
	289	return err;
	290	}
	291	*r_chip = chip;
	292	return 0;
	293	}
	294
	295	EXPORT_SYMBOL(snd_sbdsp_command);
	296	EXPORT_SYMBOL(snd_sbdsp_get_byte);
	297	EXPORT_SYMBOL(snd_sbdsp_reset);
	298	EXPORT_SYMBOL(snd_sbdsp_create);
	299	/* sb_mixer.c */
	300	EXPORT_SYMBOL(snd_sbmixer_write);
	301	EXPORT_SYMBOL(snd_sbmixer_read);
	302	EXPORT_SYMBOL(snd_sbmixer_new);
	303	EXPORT_SYMBOL(snd_sbmixer_add_ctl);
5bdb6a16 TI	304	#ifdef CONFIG_PM
	305	EXPORT_SYMBOL(snd_sbmixer_suspend);
	306	EXPORT_SYMBOL(snd_sbmixer_resume);
	307	#endif
1da177e4 LT	308
	309	/*
	310	* INIT part
	311	*/
	312
	313	static int __init alsa_sb_common_init(void)
	314	{
	315	return 0;
	316	}
	317
	318	static void __exit alsa_sb_common_exit(void)
	319	{
	320	}
	321
	322	module_init(alsa_sb_common_init)
	323	module_exit(alsa_sb_common_exit)