[mirror_ubuntu-jammy-kernel.git] / sound / isa / gus / gusclassic.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 *  Driver for Gravis UltraSound Classic soundcard
 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
 */

#include <linux/init.h>
#include <linux/err.h>
#include <linux/isa.h>
#include <linux/delay.h>
#include <linux/time.h>
#include <linux/module.h>
#include <asm/dma.h>
#include <sound/core.h>
#include <sound/gus.h>
#define SNDRV_LEGACY_FIND_FREE_IRQ
#define SNDRV_LEGACY_FIND_FREE_DMA
#include <sound/initval.h>

#define CRD_NAME "Gravis UltraSound Classic"
#define DEV_NAME "gusclassic"

MODULE_DESCRIPTION(CRD_NAME);
MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
MODULE_LICENSE("GPL");
MODULE_SUPPORTED_DEVICE("{{Gravis,UltraSound Classic}}");

static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;	/* Index 0-MAX */
static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;	/* ID for this card */
static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE;	/* Enable this card */
static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;	/* 0x220,0x230,0x240,0x250,0x260 */
static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;	/* 3,5,9,11,12,15 */
static int dma1[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;	/* 1,3,5,6,7 */
static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;	/* 1,3,5,6,7 */
static int joystick_dac[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 29};
				/* 0 to 31, (0.59V-4.52V or 0.389V-2.98V) */
static int channels[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 24};
static int pcm_channels[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 2};

module_param_array(index, int, NULL, 0444);
MODULE_PARM_DESC(index, "Index value for " CRD_NAME " soundcard.");
module_param_array(id, charp, NULL, 0444);
MODULE_PARM_DESC(id, "ID string for " CRD_NAME " soundcard.");
module_param_array(enable, bool, NULL, 0444);
MODULE_PARM_DESC(enable, "Enable " CRD_NAME " soundcard.");
module_param_hw_array(port, long, ioport, NULL, 0444);
MODULE_PARM_DESC(port, "Port # for " CRD_NAME " driver.");
module_param_hw_array(irq, int, irq, NULL, 0444);
MODULE_PARM_DESC(irq, "IRQ # for " CRD_NAME " driver.");
module_param_hw_array(dma1, int, dma, NULL, 0444);
MODULE_PARM_DESC(dma1, "DMA1 # for " CRD_NAME " driver.");
module_param_hw_array(dma2, int, dma, NULL, 0444);
MODULE_PARM_DESC(dma2, "DMA2 # for " CRD_NAME " driver.");
module_param_array(joystick_dac, int, NULL, 0444);
MODULE_PARM_DESC(joystick_dac, "Joystick DAC level 0.59V-4.52V or 0.389V-2.98V for " CRD_NAME " driver.");
module_param_array(channels, int, NULL, 0444);
MODULE_PARM_DESC(channels, "GF1 channels for " CRD_NAME " driver.");
module_param_array(pcm_channels, int, NULL, 0444);
MODULE_PARM_DESC(pcm_channels, "Reserved PCM channels for " CRD_NAME " driver.");

static int snd_gusclassic_match(struct device *dev, unsigned int n)
{
	return enable[n];
}

static int snd_gusclassic_create(struct snd_card *card,
				 struct device *dev, unsigned int n,
				 struct snd_gus_card **rgus)
{
	static long possible_ports[] = {0x220, 0x230, 0x240, 0x250, 0x260};
	static int possible_irqs[] = {5, 11, 12, 9, 7, 15, 3, 4, -1};
	static int possible_dmas[] = {5, 6, 7, 1, 3, -1};

	int i, error;

	if (irq[n] == SNDRV_AUTO_IRQ) {
		irq[n] = snd_legacy_find_free_irq(possible_irqs);
		if (irq[n] < 0) {
			dev_err(dev, "unable to find a free IRQ\n");
			return -EBUSY;
		}
	}
	if (dma1[n] == SNDRV_AUTO_DMA) {
		dma1[n] = snd_legacy_find_free_dma(possible_dmas);
		if (dma1[n] < 0) {
			dev_err(dev, "unable to find a free DMA1\n");
			return -EBUSY;
		}
	}
	if (dma2[n] == SNDRV_AUTO_DMA) {
		dma2[n] = snd_legacy_find_free_dma(possible_dmas);
		if (dma2[n] < 0) {
			dev_err(dev, "unable to find a free DMA2\n");
			return -EBUSY;
		}
	}

	if (port[n] != SNDRV_AUTO_PORT)
		return snd_gus_create(card, port[n], irq[n], dma1[n], dma2[n],
				0, channels[n], pcm_channels[n], 0, rgus);

	i = 0;
	do {
		port[n] = possible_ports[i];
		error = snd_gus_create(card, port[n], irq[n], dma1[n], dma2[n],
				0, channels[n], pcm_channels[n], 0, rgus);
	} while (error < 0 && ++i < ARRAY_SIZE(possible_ports));

	return error;
}

static int snd_gusclassic_detect(struct snd_gus_card *gus)
{
	unsigned char d;

	snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 0);	/* reset GF1 */
	if (((d = snd_gf1_i_look8(gus, SNDRV_GF1_GB_RESET)) & 0x07) != 0) {
		snd_printdd("[0x%lx] check 1 failed - 0x%x\n", gus->gf1.port, d);
		return -ENODEV;
	}
	udelay(160);
	snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 1);	/* release reset */
	udelay(160);
	if (((d = snd_gf1_i_look8(gus, SNDRV_GF1_GB_RESET)) & 0x07) != 1) {
		snd_printdd("[0x%lx] check 2 failed - 0x%x\n", gus->gf1.port, d);
		return -ENODEV;
	}
	return 0;
}

static int snd_gusclassic_probe(struct device *dev, unsigned int n)
{
	struct snd_card *card;
	struct snd_gus_card *gus;
	int error;

	error = snd_card_new(dev, index[n], id[n], THIS_MODULE, 0, &card);
	if (error < 0)
		return error;

	if (pcm_channels[n] < 2)
		pcm_channels[n] = 2;

	error = snd_gusclassic_create(card, dev, n, &gus);
	if (error < 0)
		goto out;

	error = snd_gusclassic_detect(gus);
	if (error < 0)
		goto out;

	gus->joystick_dac = joystick_dac[n];

	error = snd_gus_initialize(gus);
	if (error < 0)
		goto out;

	error = -ENODEV;
	if (gus->max_flag || gus->ess_flag) {
		dev_err(dev, "GUS Classic or ACE soundcard was "
			"not detected at 0x%lx\n", gus->gf1.port);
		goto out;
	}

	error = snd_gf1_new_mixer(gus);
	if (error < 0)
		goto out;

	error = snd_gf1_pcm_new(gus, 0, 0);
	if (error < 0)
		goto out;

	if (!gus->ace_flag) {
		error = snd_gf1_rawmidi_new(gus, 0);
		if (error < 0)
			goto out;
	}

	sprintf(card->longname + strlen(card->longname),
		" at 0x%lx, irq %d, dma %d",
		gus->gf1.port, gus->gf1.irq, gus->gf1.dma1);

	if (gus->gf1.dma2 >= 0)
		sprintf(card->longname + strlen(card->longname),
			"&%d", gus->gf1.dma2);

	error = snd_card_register(card);
	if (error < 0)
		goto out;

	dev_set_drvdata(dev, card);
	return 0;

out:	snd_card_free(card);
	return error;
}

static int snd_gusclassic_remove(struct device *dev, unsigned int n)
{
	snd_card_free(dev_get_drvdata(dev));
	return 0;
}

static struct isa_driver snd_gusclassic_driver = {
	.match		= snd_gusclassic_match,
	.probe		= snd_gusclassic_probe,
	.remove		= snd_gusclassic_remove,
#if 0	/* FIXME */
	.suspend	= snd_gusclassic_suspend,
	.remove		= snd_gusclassic_remove,
#endif
	.driver		= {
		.name	= DEV_NAME
	}
};

module_isa_driver(snd_gusclassic_driver, SNDRV_CARDS);
Commit	Line	Data
1a59d1b8	1	// SPDX-License-Identifier: GPL-2.0-or-later
1da177e4 LT	2	/*
1da177e4 LT	3	* Driver for Gravis UltraSound Classic soundcard
c1017a4c	4	* Copyright (c) by Jaroslav Kysela <perex@perex.cz>
1da177e4 LT	5	*/
1da177e4 LT	6
1da177e4	7	#include <linux/init.h>
654aa661	8	#include <linux/err.h>
93f02c6e	9	#include <linux/isa.h>
1da177e4 LT	10	#include <linux/delay.h>
1da177e4 LT	11	#include <linux/time.h>
65a77217	12	#include <linux/module.h>
654aa661	13	#include <asm/dma.h>
1da177e4 LT	14	#include <sound/core.h>
1da177e4 LT	15	#include <sound/gus.h>
1da177e4 LT	16	#define SNDRV_LEGACY_FIND_FREE_IRQ
	17	#define SNDRV_LEGACY_FIND_FREE_DMA
	18	#include <sound/initval.h>
	19
93f02c6e RH	20	#define CRD_NAME "Gravis UltraSound Classic"
	21	#define DEV_NAME "gusclassic"
	22
	23	MODULE_DESCRIPTION(CRD_NAME);
c1017a4c	24	MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
1da177e4 LT	25	MODULE_LICENSE("GPL");
	26	MODULE_SUPPORTED_DEVICE("{{Gravis,UltraSound Classic}}");
	27
	28	static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
	29	static char id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; / ID for this card */
a67ff6a5	30	static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE; /* Enable this card */
1da177e4 LT	31	static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* 0x220,0x230,0x240,0x250,0x260 */
	32	static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ; /* 3,5,9,11,12,15 */
	33	static int dma1[SNDRV_CARDS] = SNDRV_DEFAULT_DMA; /* 1,3,5,6,7 */
	34	static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA; /* 1,3,5,6,7 */
	35	static int joystick_dac[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 29};
	36	/* 0 to 31, (0.59V-4.52V or 0.389V-2.98V) */
	37	static int channels[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 24};
	38	static int pcm_channels[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 2};
	39
	40	module_param_array(index, int, NULL, 0444);
93f02c6e	41	MODULE_PARM_DESC(index, "Index value for " CRD_NAME " soundcard.");
1da177e4	42	module_param_array(id, charp, NULL, 0444);
93f02c6e	43	MODULE_PARM_DESC(id, "ID string for " CRD_NAME " soundcard.");
1da177e4	44	module_param_array(enable, bool, NULL, 0444);
93f02c6e	45	MODULE_PARM_DESC(enable, "Enable " CRD_NAME " soundcard.");
e992ef57	46	module_param_hw_array(port, long, ioport, NULL, 0444);
93f02c6e	47	MODULE_PARM_DESC(port, "Port # for " CRD_NAME " driver.");
e992ef57	48	module_param_hw_array(irq, int, irq, NULL, 0444);
93f02c6e	49	MODULE_PARM_DESC(irq, "IRQ # for " CRD_NAME " driver.");
e992ef57	50	module_param_hw_array(dma1, int, dma, NULL, 0444);
93f02c6e	51	MODULE_PARM_DESC(dma1, "DMA1 # for " CRD_NAME " driver.");
e992ef57	52	module_param_hw_array(dma2, int, dma, NULL, 0444);
93f02c6e	53	MODULE_PARM_DESC(dma2, "DMA2 # for " CRD_NAME " driver.");
1da177e4	54	module_param_array(joystick_dac, int, NULL, 0444);
93f02c6e	55	MODULE_PARM_DESC(joystick_dac, "Joystick DAC level 0.59V-4.52V or 0.389V-2.98V for " CRD_NAME " driver.");
1da177e4	56	module_param_array(channels, int, NULL, 0444);
93f02c6e	57	MODULE_PARM_DESC(channels, "GF1 channels for " CRD_NAME " driver.");
1da177e4	58	module_param_array(pcm_channels, int, NULL, 0444);
93f02c6e RH	59	MODULE_PARM_DESC(pcm_channels, "Reserved PCM channels for " CRD_NAME " driver.");
93f02c6e RH	60
1bff292e	61	static int snd_gusclassic_match(struct device *dev, unsigned int n)
93f02c6e RH	62	{
	63	return enable[n];
	64	}
	65
1bff292e BP	66	static int snd_gusclassic_create(struct snd_card *card,
	67	struct device *dev, unsigned int n,
	68	struct snd_gus_card **rgus)
93f02c6e RH	69	{
	70	static long possible_ports[] = {0x220, 0x230, 0x240, 0x250, 0x260};
	71	static int possible_irqs[] = {5, 11, 12, 9, 7, 15, 3, 4, -1};
	72	static int possible_dmas[] = {5, 6, 7, 1, 3, -1};
	73
	74	int i, error;
	75
	76	if (irq[n] == SNDRV_AUTO_IRQ) {
	77	irq[n] = snd_legacy_find_free_irq(possible_irqs);
	78	if (irq[n] < 0) {
0418ff0c	79	dev_err(dev, "unable to find a free IRQ\n");
93f02c6e RH	80	return -EBUSY;
	81	}
	82	}
	83	if (dma1[n] == SNDRV_AUTO_DMA) {
	84	dma1[n] = snd_legacy_find_free_dma(possible_dmas);
	85	if (dma1[n] < 0) {
0418ff0c	86	dev_err(dev, "unable to find a free DMA1\n");
93f02c6e RH	87	return -EBUSY;
	88	}
	89	}
	90	if (dma2[n] == SNDRV_AUTO_DMA) {
	91	dma2[n] = snd_legacy_find_free_dma(possible_dmas);
	92	if (dma2[n] < 0) {
0418ff0c	93	dev_err(dev, "unable to find a free DMA2\n");
93f02c6e RH	94	return -EBUSY;
	95	}
	96	}
1da177e4	97
93f02c6e RH	98	if (port[n] != SNDRV_AUTO_PORT)
	99	return snd_gus_create(card, port[n], irq[n], dma1[n], dma2[n],
	100	0, channels[n], pcm_channels[n], 0, rgus);
f7a9275d	101
93f02c6e RH	102	i = 0;
	103	do {
	104	port[n] = possible_ports[i];
	105	error = snd_gus_create(card, port[n], irq[n], dma1[n], dma2[n],
	106	0, channels[n], pcm_channels[n], 0, rgus);
	107	} while (error < 0 && ++i < ARRAY_SIZE(possible_ports));
1da177e4	108
93f02c6e RH	109	return error;
93f02c6e RH	110	}
1da177e4	111
1bff292e	112	static int snd_gusclassic_detect(struct snd_gus_card *gus)
1da177e4	113	{
43bcd973	114	unsigned char d;
1da177e4	115
43bcd973 TI	116	snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 0); /* reset GF1 */
	117	if (((d = snd_gf1_i_look8(gus, SNDRV_GF1_GB_RESET)) & 0x07) != 0) {
	118	snd_printdd("[0x%lx] check 1 failed - 0x%x\n", gus->gf1.port, d);
1da177e4	119	return -ENODEV;
43bcd973	120	}
1da177e4 LT	121	udelay(160);
	122	snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 1); /* release reset */
	123	udelay(160);
43bcd973 TI	124	if (((d = snd_gf1_i_look8(gus, SNDRV_GF1_GB_RESET)) & 0x07) != 1) {
43bcd973 TI	125	snd_printdd("[0x%lx] check 2 failed - 0x%x\n", gus->gf1.port, d);
1da177e4	126	return -ENODEV;
43bcd973	127	}
1da177e4 LT	128	return 0;
	129	}
	130
1bff292e	131	static int snd_gusclassic_probe(struct device *dev, unsigned int n)
1da177e4	132	{
5e2da206	133	struct snd_card *card;
93f02c6e RH	134	struct snd_gus_card *gus;
93f02c6e RH	135	int error;
1da177e4	136
4323cc4d	137	error = snd_card_new(dev, index[n], id[n], THIS_MODULE, 0, &card);
c95eadd2 TI	138	if (error < 0)
c95eadd2 TI	139	return error;
43bcd973	140
93f02c6e RH	141	if (pcm_channels[n] < 2)
93f02c6e RH	142	pcm_channels[n] = 2;
43bcd973	143
93f02c6e RH	144	error = snd_gusclassic_create(card, dev, n, &gus);
	145	if (error < 0)
	146	goto out;
43bcd973	147
93f02c6e RH	148	error = snd_gusclassic_detect(gus);
	149	if (error < 0)
	150	goto out;
	151
	152	gus->joystick_dac = joystick_dac[n];
	153
	154	error = snd_gus_initialize(gus);
	155	if (error < 0)
	156	goto out;
	157
	158	error = -ENODEV;
1da177e4	159	if (gus->max_flag \|\| gus->ess_flag) {
0418ff0c TI	160	dev_err(dev, "GUS Classic or ACE soundcard was "
0418ff0c TI	161	"not detected at 0x%lx\n", gus->gf1.port);
93f02c6e	162	goto out;
1da177e4	163	}
43bcd973	164
93f02c6e RH	165	error = snd_gf1_new_mixer(gus);
	166	if (error < 0)
	167	goto out;
43bcd973	168
db5abb3c	169	error = snd_gf1_pcm_new(gus, 0, 0);
93f02c6e RH	170	if (error < 0)
93f02c6e RH	171	goto out;
43bcd973	172
1da177e4	173	if (!gus->ace_flag) {
db5abb3c	174	error = snd_gf1_rawmidi_new(gus, 0);
93f02c6e RH	175	if (error < 0)
93f02c6e RH	176	goto out;
1da177e4	177	}
43bcd973	178
93f02c6e RH	179	sprintf(card->longname + strlen(card->longname),
	180	" at 0x%lx, irq %d, dma %d",
	181	gus->gf1.port, gus->gf1.irq, gus->gf1.dma1);
43bcd973	182
93f02c6e RH	183	if (gus->gf1.dma2 >= 0)
	184	sprintf(card->longname + strlen(card->longname),
	185	"&%d", gus->gf1.dma2);
43bcd973	186
93f02c6e RH	187	error = snd_card_register(card);
	188	if (error < 0)
	189	goto out;
	190
	191	dev_set_drvdata(dev, card);
1da177e4	192	return 0;
43bcd973	193
93f02c6e RH	194	out: snd_card_free(card);
93f02c6e RH	195	return error;
1da177e4 LT	196	}
1da177e4 LT	197
1bff292e	198	static int snd_gusclassic_remove(struct device *dev, unsigned int n)
1da177e4	199	{
93f02c6e	200	snd_card_free(dev_get_drvdata(dev));
654aa661	201	return 0;
1da177e4 LT	202	}
1da177e4 LT	203
93f02c6e RH	204	static struct isa_driver snd_gusclassic_driver = {
93f02c6e RH	205	.match = snd_gusclassic_match,
654aa661	206	.probe = snd_gusclassic_probe,
1bff292e	207	.remove = snd_gusclassic_remove,
93f02c6e RH	208	#if 0 /* FIXME */
	209	.suspend = snd_gusclassic_suspend,
	210	.remove = snd_gusclassic_remove,
	211	#endif
654aa661	212	.driver = {
93f02c6e RH	213	.name = DEV_NAME
93f02c6e RH	214	}
654aa661 TI	215	};
654aa661 TI	216
a04236e2	217	module_isa_driver(snd_gusclassic_driver, SNDRV_CARDS);