[linux-block.git] / sound / isa / sb / sb_common.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
 *                   Uros Bizjak <uros@kss-loka.si>
 *
 *  Lowlevel routines for control of Sound Blaster cards
 */

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