2 * Driver for Gallant SC-6000 soundcard. This card is also known as
3 * Audio Excel DSP 16 or Zoltrix AV302.
4 * These cards use CompuMedia ASC-9308 chip + AD1848 codec.
5 * SC-6600 and SC-7000 cards are also supported. They are based on
6 * CompuMedia ASC-9408 chip and CS4231 codec.
8 * Copyright (C) 2007 Krzysztof Helt <krzysztof.h1@wp.pl>
10 * I don't have documentation for this card. I used the driver
11 * for OSS/Free included in the kernel source as reference.
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #include <linux/module.h>
29 #include <linux/delay.h>
30 #include <linux/isa.h>
33 #include <sound/core.h>
34 #include <sound/wss.h>
35 #include <sound/opl3.h>
36 #include <sound/mpu401.h>
37 #include <sound/control.h>
38 #define SNDRV_LEGACY_FIND_FREE_IRQ
39 #define SNDRV_LEGACY_FIND_FREE_DMA
40 #include <sound/initval.h>
42 MODULE_AUTHOR("Krzysztof Helt");
43 MODULE_DESCRIPTION("Gallant SC-6000");
44 MODULE_LICENSE("GPL");
45 MODULE_SUPPORTED_DEVICE("{{Gallant, SC-6000},"
46 "{AudioExcel, Audio Excel DSP 16},"
49 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
50 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
51 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE; /* Enable this card */
52 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* 0x220, 0x240 */
53 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ; /* 5, 7, 9, 10, 11 */
54 static long mss_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* 0x530, 0xe80 */
55 static long mpu_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
56 /* 0x300, 0x310, 0x320, 0x330 */
57 static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ; /* 5, 7, 9, 10, 0 */
58 static int dma[SNDRV_CARDS] = SNDRV_DEFAULT_DMA; /* 0, 1, 3 */
59 static bool joystick[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = false };
61 module_param_array(index, int, NULL, 0444);
62 MODULE_PARM_DESC(index, "Index value for sc-6000 based soundcard.");
63 module_param_array(id, charp, NULL, 0444);
64 MODULE_PARM_DESC(id, "ID string for sc-6000 based soundcard.");
65 module_param_array(enable, bool, NULL, 0444);
66 MODULE_PARM_DESC(enable, "Enable sc-6000 based soundcard.");
67 module_param_array(port, long, NULL, 0444);
68 MODULE_PARM_DESC(port, "Port # for sc-6000 driver.");
69 module_param_array(mss_port, long, NULL, 0444);
70 MODULE_PARM_DESC(mss_port, "MSS Port # for sc-6000 driver.");
71 module_param_array(mpu_port, long, NULL, 0444);
72 MODULE_PARM_DESC(mpu_port, "MPU-401 port # for sc-6000 driver.");
73 module_param_array(irq, int, NULL, 0444);
74 MODULE_PARM_DESC(irq, "IRQ # for sc-6000 driver.");
75 module_param_array(mpu_irq, int, NULL, 0444);
76 MODULE_PARM_DESC(mpu_irq, "MPU-401 IRQ # for sc-6000 driver.");
77 module_param_array(dma, int, NULL, 0444);
78 MODULE_PARM_DESC(dma, "DMA # for sc-6000 driver.");
79 module_param_array(joystick, bool, NULL, 0444);
80 MODULE_PARM_DESC(joystick, "Enable gameport.");
83 * Commands of SC6000's DSP (SBPRO+special).
84 * Some of them are COMMAND_xx, in the future they may change.
86 #define WRITE_MDIRQ_CFG 0x50 /* Set M&I&DRQ mask (the real config) */
87 #define COMMAND_52 0x52 /* */
88 #define READ_HARD_CFG 0x58 /* Read Hardware Config (I/O base etc) */
89 #define COMMAND_5C 0x5c /* */
90 #define COMMAND_60 0x60 /* */
91 #define COMMAND_66 0x66 /* */
92 #define COMMAND_6C 0x6c /* */
93 #define COMMAND_6E 0x6e /* */
94 #define COMMAND_88 0x88 /* Unknown command */
95 #define DSP_INIT_MSS 0x8c /* Enable Microsoft Sound System mode */
96 #define COMMAND_C5 0xc5 /* */
97 #define GET_DSP_VERSION 0xe1 /* Get DSP Version */
98 #define GET_DSP_COPYRIGHT 0xe3 /* Get DSP Copyright */
101 * Offsets of SC6000 DSP I/O ports. The offset is added to base I/O port
102 * to have the actual I/O port.
103 * Register permissions are:
109 #define DSP_RESET 0x06 /* offset of DSP RESET (wo) */
110 #define DSP_READ 0x0a /* offset of DSP READ (ro) */
111 #define DSP_WRITE 0x0c /* offset of DSP WRITE (w-) */
112 #define DSP_COMMAND 0x0c /* offset of DSP COMMAND (w-) */
113 #define DSP_STATUS 0x0c /* offset of DSP STATUS (r-) */
114 #define DSP_DATAVAIL 0x0e /* offset of DSP DATA AVAILABLE (ro) */
116 #define PFX "sc6000: "
117 #define DRV_NAME "SC-6000"
119 /* hardware dependent functions */
122 * sc6000_irq_to_softcfg - Decode irq number into cfg code.
124 static unsigned char sc6000_irq_to_softcfg(int irq)
126 unsigned char val = 0;
151 * sc6000_dma_to_softcfg - Decode dma number into cfg code.
153 static unsigned char sc6000_dma_to_softcfg(int dma)
155 unsigned char val = 0;
174 * sc6000_mpu_irq_to_softcfg - Decode MPU-401 irq number into cfg code.
176 static unsigned char sc6000_mpu_irq_to_softcfg(int mpu_irq)
178 unsigned char val = 0;
199 static int sc6000_wait_data(char __iomem *vport)
202 unsigned char val = 0;
205 val = ioread8(vport + DSP_DATAVAIL);
214 static int sc6000_read(char __iomem *vport)
216 if (sc6000_wait_data(vport))
219 return ioread8(vport + DSP_READ);
223 static int sc6000_write(char __iomem *vport, int cmd)
229 val = ioread8(vport + DSP_STATUS);
231 * DSP ready to receive data if bit 7 of val == 0
234 iowrite8(cmd, vport + DSP_COMMAND);
240 snd_printk(KERN_ERR "DSP Command (0x%x) timeout.\n", cmd);
245 static int sc6000_dsp_get_answer(char __iomem *vport, int command,
246 char *data, int data_len)
250 if (sc6000_write(vport, command)) {
251 snd_printk(KERN_ERR "CMD 0x%x: failed!\n", command);
256 int val = sc6000_read(vport);
263 } while (len < data_len);
266 * If no more data available, return to the caller, no error if len>0.
267 * We have no other way to know when the string is finished.
269 return len ? len : -EIO;
272 static int sc6000_dsp_reset(char __iomem *vport)
274 iowrite8(1, vport + DSP_RESET);
276 iowrite8(0, vport + DSP_RESET);
278 if (sc6000_read(vport) == 0xaa)
283 /* detection and initialization */
284 static int sc6000_hw_cfg_write(char __iomem *vport, const int *cfg)
286 if (sc6000_write(vport, COMMAND_6C) < 0) {
287 snd_printk(KERN_WARNING "CMD 0x%x: failed!\n", COMMAND_6C);
290 if (sc6000_write(vport, COMMAND_5C) < 0) {
291 snd_printk(KERN_ERR "CMD 0x%x: failed!\n", COMMAND_5C);
294 if (sc6000_write(vport, cfg[0]) < 0) {
295 snd_printk(KERN_ERR "DATA 0x%x: failed!\n", cfg[0]);
298 if (sc6000_write(vport, cfg[1]) < 0) {
299 snd_printk(KERN_ERR "DATA 0x%x: failed!\n", cfg[1]);
302 if (sc6000_write(vport, COMMAND_C5) < 0) {
303 snd_printk(KERN_ERR "CMD 0x%x: failed!\n", COMMAND_C5);
310 static int sc6000_cfg_write(char __iomem *vport, unsigned char softcfg)
313 if (sc6000_write(vport, WRITE_MDIRQ_CFG)) {
314 snd_printk(KERN_ERR "CMD 0x%x: failed!\n", WRITE_MDIRQ_CFG);
317 if (sc6000_write(vport, softcfg)) {
318 snd_printk(KERN_ERR "sc6000_cfg_write: failed!\n");
324 static int sc6000_setup_board(char __iomem *vport, int config)
329 if (sc6000_write(vport, COMMAND_88)) {
330 snd_printk(KERN_ERR "CMD 0x%x: failed!\n",
334 } while ((sc6000_wait_data(vport) < 0) && loop--);
336 if (sc6000_read(vport) < 0) {
337 snd_printk(KERN_ERR "sc6000_read after CMD 0x%x: failed\n",
342 if (sc6000_cfg_write(vport, config))
348 static int sc6000_init_mss(char __iomem *vport, int config,
349 char __iomem *vmss_port, int mss_config)
351 if (sc6000_write(vport, DSP_INIT_MSS)) {
352 snd_printk(KERN_ERR "sc6000_init_mss [0x%x]: failed!\n",
359 if (sc6000_cfg_write(vport, config))
362 iowrite8(mss_config, vmss_port);
367 static void sc6000_hw_cfg_encode(char __iomem *vport, int *cfg,
368 long xport, long xmpu,
369 long xmss_port, int joystick)
375 if (xmpu != SNDRV_AUTO_PORT) {
376 cfg[0] |= (xmpu & 0x30) >> 2;
379 if (xmss_port == 0xe80)
381 cfg[0] |= 0x40; /* always set */
384 cfg[1] |= 0x80; /* enable WSS system */
385 cfg[1] &= ~0x40; /* disable IDE */
386 snd_printd("hw cfg %x, %x\n", cfg[0], cfg[1]);
389 static int sc6000_init_board(char __iomem *vport,
390 char __iomem *vmss_port, int dev)
394 int mss_config = sc6000_irq_to_softcfg(irq[dev]) |
395 sc6000_dma_to_softcfg(dma[dev]);
396 int config = mss_config |
397 sc6000_mpu_irq_to_softcfg(mpu_irq[dev]);
401 err = sc6000_dsp_reset(vport);
403 snd_printk(KERN_ERR "sc6000_dsp_reset: failed!\n");
407 memset(answer, 0, sizeof(answer));
408 err = sc6000_dsp_get_answer(vport, GET_DSP_COPYRIGHT, answer, 15);
410 snd_printk(KERN_ERR "sc6000_dsp_copyright: failed!\n");
414 * My SC-6000 card return "SC-6000" in DSPCopyright, so
415 * if we have something different, we have to be warned.
417 if (strncmp("SC-6000", answer, 7))
418 snd_printk(KERN_WARNING "Warning: non SC-6000 audio card!\n");
420 if (sc6000_dsp_get_answer(vport, GET_DSP_VERSION, version, 2) < 2) {
421 snd_printk(KERN_ERR "sc6000_dsp_version: failed!\n");
424 printk(KERN_INFO PFX "Detected model: %s, DSP version %d.%d\n",
425 answer, version[0], version[1]);
427 /* set configuration */
428 sc6000_write(vport, COMMAND_5C);
429 if (sc6000_read(vport) < 0)
434 sc6000_hw_cfg_encode(vport, &cfg[0], port[dev], mpu_port[dev],
435 mss_port[dev], joystick[dev]);
436 if (sc6000_hw_cfg_write(vport, cfg) < 0) {
437 snd_printk(KERN_ERR "sc6000_hw_cfg_write: failed!\n");
441 err = sc6000_setup_board(vport, config);
443 snd_printk(KERN_ERR "sc6000_setup_board: failed!\n");
447 sc6000_dsp_reset(vport);
450 sc6000_write(vport, COMMAND_60);
451 sc6000_write(vport, 0x02);
452 sc6000_dsp_reset(vport);
455 err = sc6000_setup_board(vport, config);
457 snd_printk(KERN_ERR "sc6000_setup_board: failed!\n");
460 err = sc6000_init_mss(vport, config, vmss_port, mss_config);
462 snd_printk(KERN_ERR "Cannot initialize "
463 "Microsoft Sound System mode.\n");
470 static int snd_sc6000_mixer(struct snd_wss *chip)
472 struct snd_card *card = chip->card;
473 struct snd_ctl_elem_id id1, id2;
476 memset(&id1, 0, sizeof(id1));
477 memset(&id2, 0, sizeof(id2));
478 id1.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
479 id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
480 /* reassign AUX0 to FM */
481 strcpy(id1.name, "Aux Playback Switch");
482 strcpy(id2.name, "FM Playback Switch");
483 err = snd_ctl_rename_id(card, &id1, &id2);
486 strcpy(id1.name, "Aux Playback Volume");
487 strcpy(id2.name, "FM Playback Volume");
488 err = snd_ctl_rename_id(card, &id1, &id2);
491 /* reassign AUX1 to CD */
492 strcpy(id1.name, "Aux Playback Switch"); id1.index = 1;
493 strcpy(id2.name, "CD Playback Switch");
494 err = snd_ctl_rename_id(card, &id1, &id2);
497 strcpy(id1.name, "Aux Playback Volume");
498 strcpy(id2.name, "CD Playback Volume");
499 err = snd_ctl_rename_id(card, &id1, &id2);
505 static int snd_sc6000_match(struct device *devptr, unsigned int dev)
509 if (port[dev] == SNDRV_AUTO_PORT) {
510 printk(KERN_ERR PFX "specify IO port\n");
513 if (mss_port[dev] == SNDRV_AUTO_PORT) {
514 printk(KERN_ERR PFX "specify MSS port\n");
517 if (port[dev] != 0x220 && port[dev] != 0x240) {
518 printk(KERN_ERR PFX "Port must be 0x220 or 0x240\n");
521 if (mss_port[dev] != 0x530 && mss_port[dev] != 0xe80) {
522 printk(KERN_ERR PFX "MSS port must be 0x530 or 0xe80\n");
525 if (irq[dev] != SNDRV_AUTO_IRQ && !sc6000_irq_to_softcfg(irq[dev])) {
526 printk(KERN_ERR PFX "invalid IRQ %d\n", irq[dev]);
529 if (dma[dev] != SNDRV_AUTO_DMA && !sc6000_dma_to_softcfg(dma[dev])) {
530 printk(KERN_ERR PFX "invalid DMA %d\n", dma[dev]);
533 if (mpu_port[dev] != SNDRV_AUTO_PORT &&
534 (mpu_port[dev] & ~0x30L) != 0x300) {
535 printk(KERN_ERR PFX "invalid MPU-401 port %lx\n",
539 if (mpu_port[dev] != SNDRV_AUTO_PORT &&
540 mpu_irq[dev] != SNDRV_AUTO_IRQ && mpu_irq[dev] != 0 &&
541 !sc6000_mpu_irq_to_softcfg(mpu_irq[dev])) {
542 printk(KERN_ERR PFX "invalid MPU-401 IRQ %d\n", mpu_irq[dev]);
548 static int snd_sc6000_probe(struct device *devptr, unsigned int dev)
550 static int possible_irqs[] = { 5, 7, 9, 10, 11, -1 };
551 static int possible_dmas[] = { 1, 3, 0, -1 };
555 struct snd_card *card;
556 struct snd_wss *chip;
557 struct snd_opl3 *opl3;
558 char __iomem **vport;
559 char __iomem *vmss_port;
562 err = snd_card_new(devptr, index[dev], id[dev], THIS_MODULE,
563 sizeof(vport), &card);
567 vport = card->private_data;
568 if (xirq == SNDRV_AUTO_IRQ) {
569 xirq = snd_legacy_find_free_irq(possible_irqs);
571 snd_printk(KERN_ERR PFX "unable to find a free IRQ\n");
577 if (xdma == SNDRV_AUTO_DMA) {
578 xdma = snd_legacy_find_free_dma(possible_dmas);
580 snd_printk(KERN_ERR PFX "unable to find a free DMA\n");
586 if (!request_region(port[dev], 0x10, DRV_NAME)) {
587 snd_printk(KERN_ERR PFX
588 "I/O port region is already in use.\n");
592 *vport = devm_ioport_map(devptr, port[dev], 0x10);
593 if (*vport == NULL) {
594 snd_printk(KERN_ERR PFX
595 "I/O port cannot be iomaped.\n");
600 /* to make it marked as used */
601 if (!request_region(mss_port[dev], 4, DRV_NAME)) {
602 snd_printk(KERN_ERR PFX
603 "SC-6000 port I/O port region is already in use.\n");
607 vmss_port = devm_ioport_map(devptr, mss_port[dev], 4);
609 snd_printk(KERN_ERR PFX
610 "MSS port I/O cannot be iomaped.\n");
615 snd_printd("Initializing BASE[0x%lx] IRQ[%d] DMA[%d] MIRQ[%d]\n",
616 port[dev], xirq, xdma,
617 mpu_irq[dev] == SNDRV_AUTO_IRQ ? 0 : mpu_irq[dev]);
619 err = sc6000_init_board(*vport, vmss_port, dev);
623 err = snd_wss_create(card, mss_port[dev] + 4, -1, xirq, xdma, -1,
624 WSS_HW_DETECT, 0, &chip);
628 err = snd_wss_pcm(chip, 0);
630 snd_printk(KERN_ERR PFX
631 "error creating new WSS PCM device\n");
634 err = snd_wss_mixer(chip);
636 snd_printk(KERN_ERR PFX "error creating new WSS mixer\n");
639 err = snd_sc6000_mixer(chip);
641 snd_printk(KERN_ERR PFX "the mixer rewrite failed\n");
644 if (snd_opl3_create(card,
646 OPL3_HW_AUTO, 0, &opl3) < 0) {
647 snd_printk(KERN_ERR PFX "no OPL device at 0x%x-0x%x ?\n",
650 err = snd_opl3_hwdep_new(opl3, 0, 1, NULL);
655 if (mpu_port[dev] != SNDRV_AUTO_PORT) {
656 if (mpu_irq[dev] == SNDRV_AUTO_IRQ)
658 if (snd_mpu401_uart_new(card, 0,
661 mpu_irq[dev], NULL) < 0)
662 snd_printk(KERN_ERR "no MPU-401 device at 0x%lx ?\n",
666 strcpy(card->driver, DRV_NAME);
667 strcpy(card->shortname, "SC-6000");
668 sprintf(card->longname, "Gallant SC-6000 at 0x%lx, irq %d, dma %d",
669 mss_port[dev], xirq, xdma);
671 err = snd_card_register(card);
675 dev_set_drvdata(devptr, card);
679 sc6000_setup_board(*vport, 0);
680 release_region(mss_port[dev], 4);
682 release_region(port[dev], 0x10);
688 static int snd_sc6000_remove(struct device *devptr, unsigned int dev)
690 struct snd_card *card = dev_get_drvdata(devptr);
691 char __iomem **vport = card->private_data;
693 if (sc6000_setup_board(*vport, 0) < 0)
694 snd_printk(KERN_WARNING "sc6000_setup_board failed on exit!\n");
696 release_region(port[dev], 0x10);
697 release_region(mss_port[dev], 4);
703 static struct isa_driver snd_sc6000_driver = {
704 .match = snd_sc6000_match,
705 .probe = snd_sc6000_probe,
706 .remove = snd_sc6000_remove,
707 /* FIXME: suspend/resume */
714 static int __init alsa_card_sc6000_init(void)
716 return isa_register_driver(&snd_sc6000_driver, SNDRV_CARDS);
719 static void __exit alsa_card_sc6000_exit(void)
721 isa_unregister_driver(&snd_sc6000_driver);
724 module_init(alsa_card_sc6000_init)
725 module_exit(alsa_card_sc6000_exit)