[linux.git] / sound / isa / cmi8328.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Driver for C-Media CMI8328-based soundcards, such as AudioExcel AV500
 * Copyright (c) 2012 Ondrej Zary
 *
 * AudioExcel AV500 card consists of:
 *  - CMI8328 - main chip (SB Pro emulation, gameport, OPL3, MPU401, CD-ROM)
 *  - CS4231A - WSS codec
 *  - Dream SAM9233+GMS950400+RAM+ROM: Wavetable MIDI, connected to MPU401
 */

#include <linux/init.h>
#include <linux/isa.h>
#include <linux/module.h>
#include <linux/gameport.h>
#include <asm/dma.h>
#include <sound/core.h>
#include <sound/wss.h>
#include <sound/opl3.h>
#include <sound/mpu401.h>
#define SNDRV_LEGACY_FIND_FREE_IOPORT
#define SNDRV_LEGACY_FIND_FREE_IRQ
#define SNDRV_LEGACY_FIND_FREE_DMA
#include <sound/initval.h>

MODULE_AUTHOR("Ondrej Zary <[email protected]>");
MODULE_DESCRIPTION("C-Media CMI8328");
MODULE_LICENSE("GPL");

#if IS_ENABLED(CONFIG_GAMEPORT)
#define SUPPORT_JOYSTICK 1
#endif

/* I/O port is configured by jumpers on the card to one of these */
static const int cmi8328_ports[] = { 0x530, 0xe80, 0xf40, 0x604 };
#define CMI8328_MAX	ARRAY_SIZE(cmi8328_ports)

static int index[CMI8328_MAX] =     {[0 ... (CMI8328_MAX-1)] = -1};
static char *id[CMI8328_MAX] =      {[0 ... (CMI8328_MAX-1)] = NULL};
static long port[CMI8328_MAX] =     {[0 ... (CMI8328_MAX-1)] = SNDRV_AUTO_PORT};
static int irq[CMI8328_MAX] =       {[0 ... (CMI8328_MAX-1)] = SNDRV_AUTO_IRQ};
static int dma1[CMI8328_MAX] =      {[0 ... (CMI8328_MAX-1)] = SNDRV_AUTO_DMA};
static int dma2[CMI8328_MAX] =      {[0 ... (CMI8328_MAX-1)] = SNDRV_AUTO_DMA};
static long mpuport[CMI8328_MAX] =  {[0 ... (CMI8328_MAX-1)] = SNDRV_AUTO_PORT};
static int mpuirq[CMI8328_MAX] =    {[0 ... (CMI8328_MAX-1)] = SNDRV_AUTO_IRQ};
#ifdef SUPPORT_JOYSTICK
static bool gameport[CMI8328_MAX] = {[0 ... (CMI8328_MAX-1)] = true};
#endif

module_param_array(index, int, NULL, 0444);
MODULE_PARM_DESC(index, "Index value for CMI8328 soundcard.");
module_param_array(id, charp, NULL, 0444);
MODULE_PARM_DESC(id, "ID string for CMI8328 soundcard.");

module_param_hw_array(port, long, ioport, NULL, 0444);
MODULE_PARM_DESC(port, "Port # for CMI8328 driver.");
module_param_hw_array(irq, int, irq, NULL, 0444);
MODULE_PARM_DESC(irq, "IRQ # for CMI8328 driver.");
module_param_hw_array(dma1, int, dma, NULL, 0444);
MODULE_PARM_DESC(dma1, "DMA1 for CMI8328 driver.");
module_param_hw_array(dma2, int, dma, NULL, 0444);
MODULE_PARM_DESC(dma2, "DMA2 for CMI8328 driver.");

module_param_hw_array(mpuport, long, ioport, NULL, 0444);
MODULE_PARM_DESC(mpuport, "MPU-401 port # for CMI8328 driver.");
module_param_hw_array(mpuirq, int, irq, NULL, 0444);
MODULE_PARM_DESC(mpuirq, "IRQ # for CMI8328 MPU-401 port.");
#ifdef SUPPORT_JOYSTICK
module_param_array(gameport, bool, NULL, 0444);
MODULE_PARM_DESC(gameport, "Enable gameport.");
#endif

struct snd_cmi8328 {
	u16 port;
	u8 cfg[3];
	u8 wss_cfg;
	struct snd_card *card;
	struct snd_wss *wss;
#ifdef SUPPORT_JOYSTICK
	struct gameport *gameport;
#endif
};

/* CMI8328 configuration registers */
#define CFG1 0x61
#define CFG1_SB_DISABLE	(1 << 0)
#define CFG1_GAMEPORT	(1 << 1)
/*
 * bit 0:    SB: 0=enabled, 1=disabled
 * bit 1:    gameport: 0=disabled, 1=enabled
 * bits 2-4: SB IRQ: 001=3, 010=5, 011=7, 100=9, 101=10, 110=11
 * bits 5-6: SB DMA: 00=disabled (when SB disabled), 01=DMA0, 10=DMA1, 11=DMA3
 * bit 7:    SB port: 0=0x220, 1=0x240
 */
#define CFG2 0x62
#define CFG2_MPU_ENABLE (1 << 2)
/*
 * bits 0-1: CD-ROM mode: 00=disabled, 01=Panasonic, 10=Sony/Mitsumi/Wearnes,
			  11=IDE
 * bit 2:    MPU401: 0=disabled, 1=enabled
 * bits 3-4: MPU401 IRQ: 00=3, 01=5, 10=7, 11=9,
 * bits 5-7: MPU401 port: 000=0x300, 001=0x310, 010=0x320, 011=0x330, 100=0x332,
			  101=0x334, 110=0x336
 */
#define CFG3 0x63
/*
 * bits 0-2: CD-ROM IRQ: 000=disabled, 001=3, 010=5, 011=7, 100=9, 101=10,
			 110=11
 * bits 3-4: CD-ROM DMA: 00=disabled, 01=DMA0, 10=DMA1, 11=DMA3
 * bits 5-7: CD-ROM port: 000=0x300, 001=0x310, 010=0x320, 011=0x330, 100=0x340,
			  101=0x350, 110=0x360, 111=0x370
 */

static u8 snd_cmi8328_cfg_read(u16 port, u8 reg)
{
	outb(0x43, port + 3);
	outb(0x21, port + 3);
	outb(reg, port + 3);
	return inb(port);
}

static void snd_cmi8328_cfg_write(u16 port, u8 reg, u8 val)
{
	outb(0x43, port + 3);
	outb(0x21, port + 3);
	outb(reg, port + 3);
	outb(val, port + 3);	/* yes, value goes to the same port as index */
}

#ifdef CONFIG_PM
static void snd_cmi8328_cfg_save(u16 port, u8 cfg[])
{
	cfg[0] = snd_cmi8328_cfg_read(port, CFG1);
	cfg[1] = snd_cmi8328_cfg_read(port, CFG2);
	cfg[2] = snd_cmi8328_cfg_read(port, CFG3);
}

static void snd_cmi8328_cfg_restore(u16 port, u8 cfg[])
{
	snd_cmi8328_cfg_write(port, CFG1, cfg[0]);
	snd_cmi8328_cfg_write(port, CFG2, cfg[1]);
	snd_cmi8328_cfg_write(port, CFG3, cfg[2]);
}
#endif /* CONFIG_PM */

static int snd_cmi8328_mixer(struct snd_wss *chip)
{
	struct snd_card *card;
	struct snd_ctl_elem_id id1, id2;
	int err;

	card = chip->card;

	memset(&id1, 0, sizeof(id1));
	memset(&id2, 0, sizeof(id2));
	id1.iface = id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
	/* rename AUX0 switch to CD */
	strcpy(id1.name, "Aux Playback Switch");
	strcpy(id2.name, "CD Playback Switch");
	err = snd_ctl_rename_id(card, &id1, &id2);
	if (err < 0) {
		snd_printk(KERN_ERR "error renaming control\n");
		return err;
	}
	/* rename AUX0 volume to CD */
	strcpy(id1.name, "Aux Playback Volume");
	strcpy(id2.name, "CD Playback Volume");
	err = snd_ctl_rename_id(card, &id1, &id2);
	if (err < 0) {
		snd_printk(KERN_ERR "error renaming control\n");
		return err;
	}
	/* rename AUX1 switch to Synth */
	strcpy(id1.name, "Aux Playback Switch");
	id1.index = 1;
	strcpy(id2.name, "Synth Playback Switch");
	err = snd_ctl_rename_id(card, &id1, &id2);
	if (err < 0) {
		snd_printk(KERN_ERR "error renaming control\n");
		return err;
	}
	/* rename AUX1 volume to Synth */
	strcpy(id1.name, "Aux Playback Volume");
	id1.index = 1;
	strcpy(id2.name, "Synth Playback Volume");
	err = snd_ctl_rename_id(card, &id1, &id2);
	if (err < 0) {
		snd_printk(KERN_ERR "error renaming control\n");
		return err;
	}

	return 0;
}

/* find index of an item in "-1"-ended array */
static int array_find(const int array[], int item)
{
	int i;

	for (i = 0; array[i] != -1; i++)
		if (array[i] == item)
			return i;

	return -1;
}
/* the same for long */
static int array_find_l(const long array[], long item)
{
	int i;

	for (i = 0; array[i] != -1; i++)
		if (array[i] == item)
			return i;

	return -1;
}

static int snd_cmi8328_probe(struct device *pdev, unsigned int ndev)
{
	struct snd_card *card;
	struct snd_opl3 *opl3;
	struct snd_cmi8328 *cmi;
#ifdef SUPPORT_JOYSTICK
	struct resource *res;
#endif
	int err, pos;
	static const long mpu_ports[] = { 0x330, 0x300, 0x310, 0x320, 0x332, 0x334,
				   0x336, -1 };
	static const u8 mpu_port_bits[] = { 3, 0, 1, 2, 4, 5, 6 };
	static const int mpu_irqs[] = { 9, 7, 5, 3, -1 };
	static const u8 mpu_irq_bits[] = { 3, 2, 1, 0 };
	static const int irqs[] = { 9, 10, 11, 7, -1 };
	static const u8 irq_bits[] = { 2, 3, 4, 1 };
	static const int dma1s[] = { 3, 1, 0, -1 };
	static const u8 dma_bits[] = { 3, 2, 1 };
	static const int dma2s[][2] = { {1, -1}, {0, -1}, {-1, -1}, {0, -1} };
	u16 port = cmi8328_ports[ndev];
	u8 val;

	/* 0xff is invalid configuration (but settable - hope it isn't set) */
	if (snd_cmi8328_cfg_read(port, CFG1) == 0xff)
		return -ENODEV;
	/* the SB disable bit must NEVER EVER be cleared or the WSS dies */
	snd_cmi8328_cfg_write(port, CFG1, CFG1_SB_DISABLE);
	if (snd_cmi8328_cfg_read(port, CFG1) != CFG1_SB_DISABLE)
		return -ENODEV;
	/* disable everything first */
	snd_cmi8328_cfg_write(port, CFG2, 0);	/* disable CDROM and MPU401 */
	snd_cmi8328_cfg_write(port, CFG3, 0);	/* disable CDROM IRQ and DMA */

	if (irq[ndev] == SNDRV_AUTO_IRQ) {
		irq[ndev] = snd_legacy_find_free_irq(irqs);
		if (irq[ndev] < 0) {
			snd_printk(KERN_ERR "unable to find a free IRQ\n");
			return -EBUSY;
		}
	}
	if (dma1[ndev] == SNDRV_AUTO_DMA) {
		dma1[ndev] = snd_legacy_find_free_dma(dma1s);
		if (dma1[ndev] < 0) {
			snd_printk(KERN_ERR "unable to find a free DMA1\n");
			return -EBUSY;
		}
	}
	if (dma2[ndev] == SNDRV_AUTO_DMA) {
		dma2[ndev] = snd_legacy_find_free_dma(dma2s[dma1[ndev] % 4]);
		if (dma2[ndev] < 0) {
			snd_printk(KERN_WARNING "unable to find a free DMA2, full-duplex will not work\n");
			dma2[ndev] = -1;
		}
	}
	/* configure WSS IRQ... */
	pos = array_find(irqs, irq[ndev]);
	if (pos < 0) {
		snd_printk(KERN_ERR "invalid IRQ %d\n", irq[ndev]);
		return -EINVAL;
	}
	val = irq_bits[pos] << 3;
	/* ...and DMA... */
	pos = array_find(dma1s, dma1[ndev]);
	if (pos < 0) {
		snd_printk(KERN_ERR "invalid DMA1 %d\n", dma1[ndev]);
		return -EINVAL;
	}
	val |= dma_bits[pos];
	/* ...and DMA2 */
	if (dma2[ndev] >= 0 && dma1[ndev] != dma2[ndev]) {
		pos = array_find(dma2s[dma1[ndev]], dma2[ndev]);
		if (pos < 0) {
			snd_printk(KERN_ERR "invalid DMA2 %d\n", dma2[ndev]);
			return -EINVAL;
		}
		val |= 0x04; /* enable separate capture DMA */
	}
	outb(val, port);

	err = snd_card_new(pdev, index[ndev], id[ndev], THIS_MODULE,
			   sizeof(struct snd_cmi8328), &card);
	if (err < 0)
		return err;
	cmi = card->private_data;
	cmi->card = card;
	cmi->port = port;
	cmi->wss_cfg = val;

	err = snd_wss_create(card, port + 4, -1, irq[ndev], dma1[ndev],
			dma2[ndev], WSS_HW_DETECT, 0, &cmi->wss);
	if (err < 0)
		goto error;

	err = snd_wss_pcm(cmi->wss, 0);
	if (err < 0)
		goto error;

	err = snd_wss_mixer(cmi->wss);
	if (err < 0)
		goto error;
	err = snd_cmi8328_mixer(cmi->wss);
	if (err < 0)
		goto error;

	if (snd_wss_timer(cmi->wss, 0) < 0)
		snd_printk(KERN_WARNING "error initializing WSS timer\n");

	if (mpuport[ndev] == SNDRV_AUTO_PORT) {
		mpuport[ndev] = snd_legacy_find_free_ioport(mpu_ports, 2);
		if (mpuport[ndev] < 0)
			snd_printk(KERN_ERR "unable to find a free MPU401 port\n");
	}
	if (mpuirq[ndev] == SNDRV_AUTO_IRQ) {
		mpuirq[ndev] = snd_legacy_find_free_irq(mpu_irqs);
		if (mpuirq[ndev] < 0)
			snd_printk(KERN_ERR "unable to find a free MPU401 IRQ\n");
	}
	/* enable and configure MPU401 */
	if (mpuport[ndev] > 0 && mpuirq[ndev] > 0) {
		val = CFG2_MPU_ENABLE;
		pos = array_find_l(mpu_ports, mpuport[ndev]);
		if (pos < 0)
			snd_printk(KERN_WARNING "invalid MPU401 port 0x%lx\n",
								mpuport[ndev]);
		else {
			val |= mpu_port_bits[pos] << 5;
			pos = array_find(mpu_irqs, mpuirq[ndev]);
			if (pos < 0)
				snd_printk(KERN_WARNING "invalid MPU401 IRQ %d\n",
								mpuirq[ndev]);
			else {
				val |= mpu_irq_bits[pos] << 3;
				snd_cmi8328_cfg_write(port, CFG2, val);
				if (snd_mpu401_uart_new(card, 0,
						MPU401_HW_MPU401, mpuport[ndev],
						0, mpuirq[ndev], NULL) < 0)
					snd_printk(KERN_ERR "error initializing MPU401\n");
			}
		}
	}
	/* OPL3 is hardwired to 0x388 and cannot be disabled */
	if (snd_opl3_create(card, 0x388, 0x38a, OPL3_HW_AUTO, 0, &opl3) < 0)
		snd_printk(KERN_ERR "error initializing OPL3\n");
	else
		if (snd_opl3_hwdep_new(opl3, 0, 1, NULL) < 0)
			snd_printk(KERN_WARNING "error initializing OPL3 hwdep\n");

	strcpy(card->driver, "CMI8328");
	strcpy(card->shortname, "C-Media CMI8328");
	sprintf(card->longname, "%s at 0x%lx, irq %d, dma %d,%d",
		card->shortname, cmi->wss->port, irq[ndev], dma1[ndev],
		(dma2[ndev] >= 0) ? dma2[ndev] : dma1[ndev]);

	dev_set_drvdata(pdev, card);
	err = snd_card_register(card);
	if (err < 0)
		goto error;
#ifdef SUPPORT_JOYSTICK
	if (!gameport[ndev])
		return 0;
	/* gameport is hardwired to 0x200 */
	res = request_region(0x200, 8, "CMI8328 gameport");
	if (!res)
		snd_printk(KERN_WARNING "unable to allocate gameport I/O port\n");
	else {
		struct gameport *gp = cmi->gameport = gameport_allocate_port();
		if (!cmi->gameport)
			release_and_free_resource(res);
		else {
			gameport_set_name(gp, "CMI8328 Gameport");
			gameport_set_phys(gp, "%s/gameport0", dev_name(pdev));
			gameport_set_dev_parent(gp, pdev);
			gp->io = 0x200;
			gameport_set_port_data(gp, res);
			/* Enable gameport */
			snd_cmi8328_cfg_write(port, CFG1,
					CFG1_SB_DISABLE | CFG1_GAMEPORT);
			gameport_register_port(gp);
		}
	}
#endif
	return 0;
error:
	snd_card_free(card);

	return err;
}

static int snd_cmi8328_remove(struct device *pdev, unsigned int dev)
{
	struct snd_card *card = dev_get_drvdata(pdev);
	struct snd_cmi8328 *cmi = card->private_data;

#ifdef SUPPORT_JOYSTICK
	if (cmi->gameport) {
		struct resource *res = gameport_get_port_data(cmi->gameport);
		gameport_unregister_port(cmi->gameport);
		release_and_free_resource(res);
	}
#endif
	/* disable everything */
	snd_cmi8328_cfg_write(cmi->port, CFG1, CFG1_SB_DISABLE);
	snd_cmi8328_cfg_write(cmi->port, CFG2, 0);
	snd_cmi8328_cfg_write(cmi->port, CFG3, 0);
	snd_card_free(card);
	return 0;
}

#ifdef CONFIG_PM
static int snd_cmi8328_suspend(struct device *pdev, unsigned int n,
				pm_message_t state)
{
	struct snd_card *card = dev_get_drvdata(pdev);
	struct snd_cmi8328 *cmi;

	if (!card)	/* ignore absent devices */
		return 0;
	cmi = card->private_data;
	snd_cmi8328_cfg_save(cmi->port, cmi->cfg);
	snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
	cmi->wss->suspend(cmi->wss);

	return 0;
}

static int snd_cmi8328_resume(struct device *pdev, unsigned int n)
{
	struct snd_card *card = dev_get_drvdata(pdev);
	struct snd_cmi8328 *cmi;

	if (!card)	/* ignore absent devices */
		return 0;
	cmi = card->private_data;
	snd_cmi8328_cfg_restore(cmi->port, cmi->cfg);
	outb(cmi->wss_cfg, cmi->port);
	cmi->wss->resume(cmi->wss);
	snd_power_change_state(card, SNDRV_CTL_POWER_D0);

	return 0;
}
#endif

static struct isa_driver snd_cmi8328_driver = {
	.probe		= snd_cmi8328_probe,
	.remove		= snd_cmi8328_remove,
#ifdef CONFIG_PM
	.suspend	= snd_cmi8328_suspend,
	.resume		= snd_cmi8328_resume,
#endif
	.driver		= {
		.name	= "cmi8328"
	},
};

module_isa_driver(snd_cmi8328_driver, CMI8328_MAX);
Commit	Line	Data
09c434b8	1	// SPDX-License-Identifier: GPL-2.0-only
f9933487 OZ	2	/*
	3	* Driver for C-Media CMI8328-based soundcards, such as AudioExcel AV500
	4	* Copyright (c) 2012 Ondrej Zary
	5	*
	6	* AudioExcel AV500 card consists of:
	7	* - CMI8328 - main chip (SB Pro emulation, gameport, OPL3, MPU401, CD-ROM)
	8	* - CS4231A - WSS codec
	9	* - Dream SAM9233+GMS950400+RAM+ROM: Wavetable MIDI, connected to MPU401
	10	*/
	11
	12	#include <linux/init.h>
	13	#include <linux/isa.h>
	14	#include <linux/module.h>
	15	#include <linux/gameport.h>
	16	#include <asm/dma.h>
	17	#include <sound/core.h>
	18	#include <sound/wss.h>
	19	#include <sound/opl3.h>
	20	#include <sound/mpu401.h>
	21	#define SNDRV_LEGACY_FIND_FREE_IOPORT
	22	#define SNDRV_LEGACY_FIND_FREE_IRQ
	23	#define SNDRV_LEGACY_FIND_FREE_DMA
	24	#include <sound/initval.h>
	25
	26	MODULE_AUTHOR("Ondrej Zary <[email protected]>");
	27	MODULE_DESCRIPTION("C-Media CMI8328");
	28	MODULE_LICENSE("GPL");
	29
88faa384	30	#if IS_ENABLED(CONFIG_GAMEPORT)
f9933487 OZ	31	#define SUPPORT_JOYSTICK 1
	32	#endif
	33
	34	/* I/O port is configured by jumpers on the card to one of these */
f3c09169	35	static const int cmi8328_ports[] = { 0x530, 0xe80, 0xf40, 0x604 };
f9933487 OZ	36	#define CMI8328_MAX ARRAY_SIZE(cmi8328_ports)
	37
	38	static int index[CMI8328_MAX] = {[0 ... (CMI8328_MAX-1)] = -1};
	39	static char *id[CMI8328_MAX] = {[0 ... (CMI8328_MAX-1)] = NULL};
	40	static long port[CMI8328_MAX] = {[0 ... (CMI8328_MAX-1)] = SNDRV_AUTO_PORT};
	41	static int irq[CMI8328_MAX] = {[0 ... (CMI8328_MAX-1)] = SNDRV_AUTO_IRQ};
	42	static int dma1[CMI8328_MAX] = {[0 ... (CMI8328_MAX-1)] = SNDRV_AUTO_DMA};
	43	static int dma2[CMI8328_MAX] = {[0 ... (CMI8328_MAX-1)] = SNDRV_AUTO_DMA};
	44	static long mpuport[CMI8328_MAX] = {[0 ... (CMI8328_MAX-1)] = SNDRV_AUTO_PORT};
	45	static int mpuirq[CMI8328_MAX] = {[0 ... (CMI8328_MAX-1)] = SNDRV_AUTO_IRQ};
	46	#ifdef SUPPORT_JOYSTICK
	47	static bool gameport[CMI8328_MAX] = {[0 ... (CMI8328_MAX-1)] = true};
	48	#endif
	49
	50	module_param_array(index, int, NULL, 0444);
	51	MODULE_PARM_DESC(index, "Index value for CMI8328 soundcard.");
	52	module_param_array(id, charp, NULL, 0444);
	53	MODULE_PARM_DESC(id, "ID string for CMI8328 soundcard.");
	54
e992ef57	55	module_param_hw_array(port, long, ioport, NULL, 0444);
f9933487	56	MODULE_PARM_DESC(port, "Port # for CMI8328 driver.");
e992ef57	57	module_param_hw_array(irq, int, irq, NULL, 0444);
f9933487	58	MODULE_PARM_DESC(irq, "IRQ # for CMI8328 driver.");
e992ef57	59	module_param_hw_array(dma1, int, dma, NULL, 0444);
f9933487	60	MODULE_PARM_DESC(dma1, "DMA1 for CMI8328 driver.");
e992ef57	61	module_param_hw_array(dma2, int, dma, NULL, 0444);
f9933487 OZ	62	MODULE_PARM_DESC(dma2, "DMA2 for CMI8328 driver.");
f9933487 OZ	63
e992ef57	64	module_param_hw_array(mpuport, long, ioport, NULL, 0444);
f9933487	65	MODULE_PARM_DESC(mpuport, "MPU-401 port # for CMI8328 driver.");
e992ef57	66	module_param_hw_array(mpuirq, int, irq, NULL, 0444);
f9933487 OZ	67	MODULE_PARM_DESC(mpuirq, "IRQ # for CMI8328 MPU-401 port.");
	68	#ifdef SUPPORT_JOYSTICK
	69	module_param_array(gameport, bool, NULL, 0444);
	70	MODULE_PARM_DESC(gameport, "Enable gameport.");
	71	#endif
	72
	73	struct snd_cmi8328 {
	74	u16 port;
	75	u8 cfg[3];
	76	u8 wss_cfg;
	77	struct snd_card *card;
	78	struct snd_wss *wss;
	79	#ifdef SUPPORT_JOYSTICK
	80	struct gameport *gameport;
	81	#endif
	82	};
	83
	84	/* CMI8328 configuration registers */
	85	#define CFG1 0x61
	86	#define CFG1_SB_DISABLE (1 << 0)
	87	#define CFG1_GAMEPORT (1 << 1)
	88	/*
	89	* bit 0: SB: 0=enabled, 1=disabled
	90	* bit 1: gameport: 0=disabled, 1=enabled
	91	* bits 2-4: SB IRQ: 001=3, 010=5, 011=7, 100=9, 101=10, 110=11
	92	* bits 5-6: SB DMA: 00=disabled (when SB disabled), 01=DMA0, 10=DMA1, 11=DMA3
	93	* bit 7: SB port: 0=0x220, 1=0x240
	94	*/
	95	#define CFG2 0x62
	96	#define CFG2_MPU_ENABLE (1 << 2)
	97	/*
	98	* bits 0-1: CD-ROM mode: 00=disabled, 01=Panasonic, 10=Sony/Mitsumi/Wearnes,
	99	11=IDE
	100	* bit 2: MPU401: 0=disabled, 1=enabled
	101	* bits 3-4: MPU401 IRQ: 00=3, 01=5, 10=7, 11=9,
	102	* bits 5-7: MPU401 port: 000=0x300, 001=0x310, 010=0x320, 011=0x330, 100=0x332,
	103	101=0x334, 110=0x336
	104	*/
	105	#define CFG3 0x63
	106	/*
	107	* bits 0-2: CD-ROM IRQ: 000=disabled, 001=3, 010=5, 011=7, 100=9, 101=10,
	108	110=11
	109	* bits 3-4: CD-ROM DMA: 00=disabled, 01=DMA0, 10=DMA1, 11=DMA3
	110	* bits 5-7: CD-ROM port: 000=0x300, 001=0x310, 010=0x320, 011=0x330, 100=0x340,
	111	101=0x350, 110=0x360, 111=0x370
	112	*/
	113
	114	static u8 snd_cmi8328_cfg_read(u16 port, u8 reg)
	115	{
	116	outb(0x43, port + 3);
	117	outb(0x21, port + 3);
	118	outb(reg, port + 3);
	119	return inb(port);
	120	}
	121
	122	static void snd_cmi8328_cfg_write(u16 port, u8 reg, u8 val)
	123	{
	124	outb(0x43, port + 3);
	125	outb(0x21, port + 3);
	126	outb(reg, port + 3);
	127	outb(val, port + 3); /* yes, value goes to the same port as index */
	128	}
	129
77ed16cc	130	#ifdef CONFIG_PM
f9933487 OZ	131	static void snd_cmi8328_cfg_save(u16 port, u8 cfg[])
	132	{
	133	cfg[0] = snd_cmi8328_cfg_read(port, CFG1);
	134	cfg[1] = snd_cmi8328_cfg_read(port, CFG2);
	135	cfg[2] = snd_cmi8328_cfg_read(port, CFG3);
	136	}
	137
	138	static void snd_cmi8328_cfg_restore(u16 port, u8 cfg[])
	139	{
	140	snd_cmi8328_cfg_write(port, CFG1, cfg[0]);
	141	snd_cmi8328_cfg_write(port, CFG2, cfg[1]);
	142	snd_cmi8328_cfg_write(port, CFG3, cfg[2]);
	143	}
77ed16cc	144	#endif /* CONFIG_PM */
f9933487	145
1bff292e	146	static int snd_cmi8328_mixer(struct snd_wss *chip)
f9933487 OZ	147	{
	148	struct snd_card *card;
	149	struct snd_ctl_elem_id id1, id2;
	150	int err;
	151
	152	card = chip->card;
	153
	154	memset(&id1, 0, sizeof(id1));
	155	memset(&id2, 0, sizeof(id2));
	156	id1.iface = id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
	157	/* rename AUX0 switch to CD */
	158	strcpy(id1.name, "Aux Playback Switch");
	159	strcpy(id2.name, "CD Playback Switch");
	160	err = snd_ctl_rename_id(card, &id1, &id2);
	161	if (err < 0) {
	162	snd_printk(KERN_ERR "error renaming control\n");
	163	return err;
	164	}
	165	/* rename AUX0 volume to CD */
	166	strcpy(id1.name, "Aux Playback Volume");
	167	strcpy(id2.name, "CD Playback Volume");
	168	err = snd_ctl_rename_id(card, &id1, &id2);
	169	if (err < 0) {
	170	snd_printk(KERN_ERR "error renaming control\n");
	171	return err;
	172	}
	173	/* rename AUX1 switch to Synth */
	174	strcpy(id1.name, "Aux Playback Switch");
	175	id1.index = 1;
	176	strcpy(id2.name, "Synth Playback Switch");
	177	err = snd_ctl_rename_id(card, &id1, &id2);
	178	if (err < 0) {
	179	snd_printk(KERN_ERR "error renaming control\n");
	180	return err;
	181	}
	182	/* rename AUX1 volume to Synth */
	183	strcpy(id1.name, "Aux Playback Volume");
	184	id1.index = 1;
	185	strcpy(id2.name, "Synth Playback Volume");
	186	err = snd_ctl_rename_id(card, &id1, &id2);
	187	if (err < 0) {
	188	snd_printk(KERN_ERR "error renaming control\n");
	189	return err;
	190	}
	191
	192	return 0;
	193	}
	194
	195	/* find index of an item in "-1"-ended array */
f3c09169	196	static int array_find(const int array[], int item)
f9933487 OZ	197	{
	198	int i;
	199
	200	for (i = 0; array[i] != -1; i++)
	201	if (array[i] == item)
	202	return i;
	203
	204	return -1;
	205	}
	206	/* the same for long */
f3c09169	207	static int array_find_l(const long array[], long item)
f9933487 OZ	208	{
	209	int i;
	210
	211	for (i = 0; array[i] != -1; i++)
	212	if (array[i] == item)
	213	return i;
	214
	215	return -1;
	216	}
	217
1bff292e	218	static int snd_cmi8328_probe(struct device *pdev, unsigned int ndev)
f9933487 OZ	219	{
	220	struct snd_card *card;
	221	struct snd_opl3 *opl3;
	222	struct snd_cmi8328 *cmi;
	223	#ifdef SUPPORT_JOYSTICK
	224	struct resource *res;
	225	#endif
	226	int err, pos;
f3c09169	227	static const long mpu_ports[] = { 0x330, 0x300, 0x310, 0x320, 0x332, 0x334,
f9933487	228	0x336, -1 };
f3c09169 TI	229	static const u8 mpu_port_bits[] = { 3, 0, 1, 2, 4, 5, 6 };
	230	static const int mpu_irqs[] = { 9, 7, 5, 3, -1 };
	231	static const u8 mpu_irq_bits[] = { 3, 2, 1, 0 };
	232	static const int irqs[] = { 9, 10, 11, 7, -1 };
	233	static const u8 irq_bits[] = { 2, 3, 4, 1 };
	234	static const int dma1s[] = { 3, 1, 0, -1 };
	235	static const u8 dma_bits[] = { 3, 2, 1 };
	236	static const int dma2s[][2] = { {1, -1}, {0, -1}, {-1, -1}, {0, -1} };
f9933487 OZ	237	u16 port = cmi8328_ports[ndev];
	238	u8 val;
	239
	240	/* 0xff is invalid configuration (but settable - hope it isn't set) */
	241	if (snd_cmi8328_cfg_read(port, CFG1) == 0xff)
	242	return -ENODEV;
	243	/* the SB disable bit must NEVER EVER be cleared or the WSS dies */
	244	snd_cmi8328_cfg_write(port, CFG1, CFG1_SB_DISABLE);
	245	if (snd_cmi8328_cfg_read(port, CFG1) != CFG1_SB_DISABLE)
	246	return -ENODEV;
	247	/* disable everything first */
	248	snd_cmi8328_cfg_write(port, CFG2, 0); /* disable CDROM and MPU401 */
	249	snd_cmi8328_cfg_write(port, CFG3, 0); /* disable CDROM IRQ and DMA */
	250
	251	if (irq[ndev] == SNDRV_AUTO_IRQ) {
	252	irq[ndev] = snd_legacy_find_free_irq(irqs);
	253	if (irq[ndev] < 0) {
	254	snd_printk(KERN_ERR "unable to find a free IRQ\n");
	255	return -EBUSY;
	256	}
	257	}
	258	if (dma1[ndev] == SNDRV_AUTO_DMA) {
	259	dma1[ndev] = snd_legacy_find_free_dma(dma1s);
	260	if (dma1[ndev] < 0) {
	261	snd_printk(KERN_ERR "unable to find a free DMA1\n");
	262	return -EBUSY;
	263	}
	264	}
	265	if (dma2[ndev] == SNDRV_AUTO_DMA) {
	266	dma2[ndev] = snd_legacy_find_free_dma(dma2s[dma1[ndev] % 4]);
	267	if (dma2[ndev] < 0) {
	268	snd_printk(KERN_WARNING "unable to find a free DMA2, full-duplex will not work\n");
	269	dma2[ndev] = -1;
	270	}
	271	}
	272	/* configure WSS IRQ... */
	273	pos = array_find(irqs, irq[ndev]);
	274	if (pos < 0) {
	275	snd_printk(KERN_ERR "invalid IRQ %d\n", irq[ndev]);
	276	return -EINVAL;
	277	}
	278	val = irq_bits[pos] << 3;
	279	/* ...and DMA... */
	280	pos = array_find(dma1s, dma1[ndev]);
	281	if (pos < 0) {
	282	snd_printk(KERN_ERR "invalid DMA1 %d\n", dma1[ndev]);
	283	return -EINVAL;
	284	}
	285	val \|= dma_bits[pos];
	286	/* ...and DMA2 */
	287	if (dma2[ndev] >= 0 && dma1[ndev] != dma2[ndev]) {
	288	pos = array_find(dma2s[dma1[ndev]], dma2[ndev]);
	289	if (pos < 0) {
	290	snd_printk(KERN_ERR "invalid DMA2 %d\n", dma2[ndev]);
	291	return -EINVAL;
	292	}
	293	val \|= 0x04; /* enable separate capture DMA */
	294	}
	295	outb(val, port);
	296
4323cc4d TI	297	err = snd_card_new(pdev, index[ndev], id[ndev], THIS_MODULE,
4323cc4d TI	298	sizeof(struct snd_cmi8328), &card);
f9933487 OZ	299	if (err < 0)
	300	return err;
	301	cmi = card->private_data;
	302	cmi->card = card;
	303	cmi->port = port;
	304	cmi->wss_cfg = val;
f9933487 OZ	305
	306	err = snd_wss_create(card, port + 4, -1, irq[ndev], dma1[ndev],
	307	dma2[ndev], WSS_HW_DETECT, 0, &cmi->wss);
	308	if (err < 0)
	309	goto error;
	310
fa60c065	311	err = snd_wss_pcm(cmi->wss, 0);
f9933487 OZ	312	if (err < 0)
	313	goto error;
	314
	315	err = snd_wss_mixer(cmi->wss);
	316	if (err < 0)
	317	goto error;
	318	err = snd_cmi8328_mixer(cmi->wss);
	319	if (err < 0)
	320	goto error;
	321
fa60c065	322	if (snd_wss_timer(cmi->wss, 0) < 0)
f9933487 OZ	323	snd_printk(KERN_WARNING "error initializing WSS timer\n");
	324
	325	if (mpuport[ndev] == SNDRV_AUTO_PORT) {
	326	mpuport[ndev] = snd_legacy_find_free_ioport(mpu_ports, 2);
	327	if (mpuport[ndev] < 0)
	328	snd_printk(KERN_ERR "unable to find a free MPU401 port\n");
	329	}
	330	if (mpuirq[ndev] == SNDRV_AUTO_IRQ) {
	331	mpuirq[ndev] = snd_legacy_find_free_irq(mpu_irqs);
	332	if (mpuirq[ndev] < 0)
	333	snd_printk(KERN_ERR "unable to find a free MPU401 IRQ\n");
	334	}
	335	/* enable and configure MPU401 */
	336	if (mpuport[ndev] > 0 && mpuirq[ndev] > 0) {
	337	val = CFG2_MPU_ENABLE;
	338	pos = array_find_l(mpu_ports, mpuport[ndev]);
	339	if (pos < 0)
	340	snd_printk(KERN_WARNING "invalid MPU401 port 0x%lx\n",
	341	mpuport[ndev]);
	342	else {
	343	val \|= mpu_port_bits[pos] << 5;
	344	pos = array_find(mpu_irqs, mpuirq[ndev]);
	345	if (pos < 0)
	346	snd_printk(KERN_WARNING "invalid MPU401 IRQ %d\n",
	347	mpuirq[ndev]);
	348	else {
	349	val \|= mpu_irq_bits[pos] << 3;
	350	snd_cmi8328_cfg_write(port, CFG2, val);
	351	if (snd_mpu401_uart_new(card, 0,
	352	MPU401_HW_MPU401, mpuport[ndev],
	353	0, mpuirq[ndev], NULL) < 0)
	354	snd_printk(KERN_ERR "error initializing MPU401\n");
	355	}
	356	}
	357	}
	358	/* OPL3 is hardwired to 0x388 and cannot be disabled */
	359	if (snd_opl3_create(card, 0x388, 0x38a, OPL3_HW_AUTO, 0, &opl3) < 0)
	360	snd_printk(KERN_ERR "error initializing OPL3\n");
	361	else
	362	if (snd_opl3_hwdep_new(opl3, 0, 1, NULL) < 0)
	363	snd_printk(KERN_WARNING "error initializing OPL3 hwdep\n");
	364
	365	strcpy(card->driver, "CMI8328");
	366	strcpy(card->shortname, "C-Media CMI8328");
	367	sprintf(card->longname, "%s at 0x%lx, irq %d, dma %d,%d",
	368	card->shortname, cmi->wss->port, irq[ndev], dma1[ndev],
	369	(dma2[ndev] >= 0) ? dma2[ndev] : dma1[ndev]);
	370
	371	dev_set_drvdata(pdev, card);
	372	err = snd_card_register(card);
	373	if (err < 0)
	374	goto error;
	375	#ifdef SUPPORT_JOYSTICK
	376	if (!gameport[ndev])
	377	return 0;
	378	/* gameport is hardwired to 0x200 */
	379	res = request_region(0x200, 8, "CMI8328 gameport");
	380	if (!res)
	381	snd_printk(KERN_WARNING "unable to allocate gameport I/O port\n");
	382	else {
	383	struct gameport *gp = cmi->gameport = gameport_allocate_port();
	384	if (!cmi->gameport)
	385	release_and_free_resource(res);
	386	else {
387	gameport_set_name(gp, "CMI8328 Gameport");
388	gameport_set_phys(gp, "%s/gameport0", dev_name(pdev));
389	gameport_set_dev_parent(gp, pdev);
390	gp->io = 0x200;
391	gameport_set_port_data(gp, res);
392	/* Enable gameport */
393	snd_cmi8328_cfg_write(port, CFG1,
394	CFG1_SB_DISABLE \| CFG1_GAMEPORT);
395	gameport_register_port(gp);
396	}
397	}
398	#endif
399	return 0;
400	error:
401	snd_card_free(card);
402
403	return err;
404	}
405
1bff292e	406	static int snd_cmi8328_remove(struct device *pdev, unsigned int dev)
f9933487 OZ	407	{
f9933487 OZ	408	struct snd_card *card = dev_get_drvdata(pdev);
f9933487	409	struct snd_cmi8328 *cmi = card->private_data;
56244d08 TI	410
56244d08 TI	411	#ifdef SUPPORT_JOYSTICK
f9933487 OZ	412	if (cmi->gameport) {
	413	struct resource *res = gameport_get_port_data(cmi->gameport);
	414	gameport_unregister_port(cmi->gameport);
	415	release_and_free_resource(res);
	416	}
	417	#endif
	418	/* disable everything */
	419	snd_cmi8328_cfg_write(cmi->port, CFG1, CFG1_SB_DISABLE);
	420	snd_cmi8328_cfg_write(cmi->port, CFG2, 0);
	421	snd_cmi8328_cfg_write(cmi->port, CFG3, 0);
	422	snd_card_free(card);
f9933487 OZ	423	return 0;
	424	}
	425
	426	#ifdef CONFIG_PM
	427	static int snd_cmi8328_suspend(struct device *pdev, unsigned int n,
	428	pm_message_t state)
	429	{
	430	struct snd_card *card = dev_get_drvdata(pdev);
	431	struct snd_cmi8328 *cmi;
	432
	433	if (!card) /* ignore absent devices */
	434	return 0;
	435	cmi = card->private_data;
	436	snd_cmi8328_cfg_save(cmi->port, cmi->cfg);
	437	snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
f9933487 OZ	438	cmi->wss->suspend(cmi->wss);
	439
	440	return 0;
	441	}
	442
	443	static int snd_cmi8328_resume(struct device *pdev, unsigned int n)
	444	{
	445	struct snd_card *card = dev_get_drvdata(pdev);
	446	struct snd_cmi8328 *cmi;
	447
	448	if (!card) /* ignore absent devices */
	449	return 0;
	450	cmi = card->private_data;
	451	snd_cmi8328_cfg_restore(cmi->port, cmi->cfg);
	452	outb(cmi->wss_cfg, cmi->port);
	453	cmi->wss->resume(cmi->wss);
	454	snd_power_change_state(card, SNDRV_CTL_POWER_D0);
	455
	456	return 0;
	457	}
	458	#endif
	459
	460	static struct isa_driver snd_cmi8328_driver = {
	461	.probe = snd_cmi8328_probe,
1bff292e	462	.remove = snd_cmi8328_remove,
f9933487 OZ	463	#ifdef CONFIG_PM
	464	.suspend = snd_cmi8328_suspend,
	465	.resume = snd_cmi8328_resume,
	466	#endif
	467	.driver = {
	468	.name = "cmi8328"
	469	},
	470	};
	471
042c576c	472	module_isa_driver(snd_cmi8328_driver, CMI8328_MAX);