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.
6 * Copyright (C) 2007 Krzysztof Helt <krzysztof.h1@wp.pl>
8 * I don't have documentation for this card. I used the driver
9 * for OSS/Free included in the kernel source as reference.
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 #include <sound/driver.h>
27 #include <linux/module.h>
28 #include <linux/isa.h>
31 #include <sound/core.h>
32 #include <sound/ad1848.h>
33 #include <sound/opl3.h>
34 #include <sound/mpu401.h>
35 #include <sound/control.h>
36 #define SNDRV_LEGACY_FIND_FREE_IRQ
37 #define SNDRV_LEGACY_FIND_FREE_DMA
38 #include <sound/initval.h>
40 MODULE_AUTHOR("Krzysztof Helt");
41 MODULE_DESCRIPTION("Gallant SC-6000");
42 MODULE_LICENSE("GPL");
43 MODULE_SUPPORTED_DEVICE("{{Gallant, SC-6000},"
44 "{AudioExcel, Audio Excel DSP 16},"
47 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-MAX */
48 static char *id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* ID for this card */
49 static int enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE
; /* Enable this card */
50 static long port
[SNDRV_CARDS
] = SNDRV_DEFAULT_PORT
; /* 0x220, 0x240 */
51 static int irq
[SNDRV_CARDS
] = SNDRV_DEFAULT_IRQ
; /* 5, 7, 9, 10, 11 */
52 static long mss_port
[SNDRV_CARDS
] = SNDRV_DEFAULT_PORT
; /* 0x530, 0xe80 */
53 static long mpu_port
[SNDRV_CARDS
] = SNDRV_DEFAULT_PORT
;
54 /* 0x300, 0x310, 0x320, 0x330 */
55 static int mpu_irq
[SNDRV_CARDS
] = SNDRV_DEFAULT_IRQ
; /* 5, 7, 9, 10, 0 */
56 static int dma
[SNDRV_CARDS
] = SNDRV_DEFAULT_DMA
; /* 0, 1, 3 */
58 module_param_array(index
, int, NULL
, 0444);
59 MODULE_PARM_DESC(index
, "Index value for sc-6000 based soundcard.");
60 module_param_array(id
, charp
, NULL
, 0444);
61 MODULE_PARM_DESC(id
, "ID string for sc-6000 based soundcard.");
62 module_param_array(enable
, bool, NULL
, 0444);
63 MODULE_PARM_DESC(enable
, "Enable sc-6000 based soundcard.");
64 module_param_array(port
, long, NULL
, 0444);
65 MODULE_PARM_DESC(port
, "Port # for sc-6000 driver.");
66 module_param_array(mss_port
, long, NULL
, 0444);
67 MODULE_PARM_DESC(mss_port
, "MSS Port # for sc-6000 driver.");
68 module_param_array(mpu_port
, long, NULL
, 0444);
69 MODULE_PARM_DESC(mpu_port
, "MPU-401 port # for sc-6000 driver.");
70 module_param_array(irq
, int, NULL
, 0444);
71 MODULE_PARM_DESC(irq
, "IRQ # for sc-6000 driver.");
72 module_param_array(mpu_irq
, int, NULL
, 0444);
73 MODULE_PARM_DESC(mpu_irq
, "MPU-401 IRQ # for sc-6000 driver.");
74 module_param_array(dma
, int, NULL
, 0444);
75 MODULE_PARM_DESC(dma
, "DMA # for sc-6000 driver.");
78 * Commands of SC6000's DSP (SBPRO+special).
79 * Some of them are COMMAND_xx, in the future they may change.
81 #define WRITE_MDIRQ_CFG 0x50 /* Set M&I&DRQ mask (the real config) */
82 #define COMMAND_52 0x52 /* */
83 #define READ_HARD_CFG 0x58 /* Read Hardware Config (I/O base etc) */
84 #define COMMAND_5C 0x5c /* */
85 #define COMMAND_60 0x60 /* */
86 #define COMMAND_66 0x66 /* */
87 #define COMMAND_6C 0x6c /* */
88 #define COMMAND_6E 0x6e /* */
89 #define COMMAND_88 0x88 /* Unknown command */
90 #define DSP_INIT_MSS 0x8c /* Enable Microsoft Sound System mode */
91 #define COMMAND_C5 0xc5 /* */
92 #define GET_DSP_VERSION 0xe1 /* Get DSP Version */
93 #define GET_DSP_COPYRIGHT 0xe3 /* Get DSP Copyright */
96 * Offsets of SC6000 DSP I/O ports. The offset is added to base I/O port
97 * to have the actual I/O port.
98 * Register permissions are:
104 #define DSP_RESET 0x06 /* offset of DSP RESET (wo) */
105 #define DSP_READ 0x0a /* offset of DSP READ (ro) */
106 #define DSP_WRITE 0x0c /* offset of DSP WRITE (w-) */
107 #define DSP_COMMAND 0x0c /* offset of DSP COMMAND (w-) */
108 #define DSP_STATUS 0x0c /* offset of DSP STATUS (r-) */
109 #define DSP_DATAVAIL 0x0e /* offset of DSP DATA AVAILABLE (ro) */
111 #define PFX "sc6000: "
112 #define DRV_NAME "SC-6000"
114 /* hardware dependent functions */
117 * sc6000_irq_to_softcfg - Decode irq number into cfg code.
119 static __devinit
unsigned char sc6000_irq_to_softcfg(int irq
)
121 unsigned char val
= 0;
146 * sc6000_dma_to_softcfg - Decode dma number into cfg code.
148 static __devinit
unsigned char sc6000_dma_to_softcfg(int dma
)
150 unsigned char val
= 0;
169 * sc6000_mpu_irq_to_softcfg - Decode MPU-401 irq number into cfg code.
171 static __devinit
unsigned char sc6000_mpu_irq_to_softcfg(int mpu_irq
)
173 unsigned char val
= 0;
194 static __devinit
int sc6000_wait_data(char __iomem
*vport
)
197 unsigned char val
= 0;
200 val
= ioread8(vport
+ DSP_DATAVAIL
);
209 static __devinit
int sc6000_read(char __iomem
*vport
)
211 if (sc6000_wait_data(vport
))
214 return ioread8(vport
+ DSP_READ
);
218 static __devinit
int sc6000_write(char __iomem
*vport
, int cmd
)
224 val
= ioread8(vport
+ DSP_STATUS
);
226 * DSP ready to receive data if bit 7 of val == 0
229 iowrite8(cmd
, vport
+ DSP_COMMAND
);
235 snd_printk(KERN_ERR
"DSP Command (0x%x) timeout.\n", cmd
);
240 static int __devinit
sc6000_dsp_get_answer(char __iomem
*vport
, int command
,
241 char *data
, int data_len
)
245 if (sc6000_write(vport
, command
)) {
246 snd_printk(KERN_ERR
"CMD 0x%x: failed!\n", command
);
251 int val
= sc6000_read(vport
);
258 } while (len
< data_len
);
261 * If no more data available, return to the caller, no error if len>0.
262 * We have no other way to know when the string is finished.
264 return len
? len
: -EIO
;
267 static int __devinit
sc6000_dsp_reset(char __iomem
*vport
)
269 iowrite8(1, vport
+ DSP_RESET
);
271 iowrite8(0, vport
+ DSP_RESET
);
273 if (sc6000_read(vport
) == 0xaa)
278 /* detection and initialization */
279 static int __devinit
sc6000_cfg_write(char __iomem
*vport
,
280 unsigned char softcfg
)
283 if (sc6000_write(vport
, WRITE_MDIRQ_CFG
)) {
284 snd_printk(KERN_ERR
"CMD 0x%x: failed!\n", WRITE_MDIRQ_CFG
);
287 if (sc6000_write(vport
, softcfg
)) {
288 snd_printk(KERN_ERR
"sc6000_cfg_write: failed!\n");
294 static int __devinit
sc6000_setup_board(char __iomem
*vport
, int config
)
299 if (sc6000_write(vport
, COMMAND_88
)) {
300 snd_printk(KERN_ERR
"CMD 0x%x: failed!\n",
304 } while ((sc6000_wait_data(vport
) < 0) && loop
--);
306 if (sc6000_read(vport
) < 0) {
307 snd_printk(KERN_ERR
"sc6000_read after CMD 0x%x: failed\n",
312 if (sc6000_cfg_write(vport
, config
))
318 static int __devinit
sc6000_init_mss(char __iomem
*vport
, int config
,
319 char __iomem
*vmss_port
, int mss_config
)
321 if (sc6000_write(vport
, DSP_INIT_MSS
)) {
322 snd_printk(KERN_ERR
"sc6000_init_mss [0x%x]: failed!\n",
329 if (sc6000_cfg_write(vport
, config
))
332 iowrite8(mss_config
, vmss_port
);
337 static int __devinit
sc6000_init_board(char __iomem
*vport
, int irq
, int dma
,
338 char __iomem
*vmss_port
, int mpu_irq
)
342 int mss_config
= sc6000_irq_to_softcfg(irq
) |
343 sc6000_dma_to_softcfg(dma
);
344 int config
= mss_config
|
345 sc6000_mpu_irq_to_softcfg(mpu_irq
);
348 err
= sc6000_dsp_reset(vport
);
350 snd_printk(KERN_ERR
"sc6000_dsp_reset: failed!\n");
354 err
= sc6000_dsp_get_answer(vport
, GET_DSP_COPYRIGHT
, answer
, 15);
356 snd_printk(KERN_ERR
"sc6000_dsp_copyright: failed!\n");
360 * My SC-6000 card return "SC-6000" in DSPCopyright, so
361 * if we have something different, we have to be warned.
362 * Mine returns "SC-6000A " - KH
364 if (strncmp("SC-6000", answer
, 7))
365 snd_printk(KERN_WARNING
"Warning: non SC-6000 audio card!\n");
367 if (sc6000_dsp_get_answer(vport
, GET_DSP_VERSION
, version
, 2) < 2) {
368 snd_printk(KERN_ERR
"sc6000_dsp_version: failed!\n");
371 printk(KERN_INFO PFX
"Detected model: %s, DSP version %d.%d\n",
372 answer
, version
[0], version
[1]);
375 * 0x0A == (IRQ 7, DMA 1, MIRQ 0)
377 err
= sc6000_cfg_write(vport
, 0x0a);
379 snd_printk(KERN_ERR
"sc6000_cfg_write: failed!\n");
383 err
= sc6000_setup_board(vport
, config
);
385 snd_printk(KERN_ERR
"sc6000_setup_board: failed!\n");
389 err
= sc6000_init_mss(vport
, config
, vmss_port
, mss_config
);
391 snd_printk(KERN_ERR
"Can not initialize"
392 "Microsoft Sound System mode.\n");
399 static int __devinit
snd_sc6000_mixer(struct snd_ad1848
*chip
)
401 struct snd_card
*card
= chip
->card
;
402 struct snd_ctl_elem_id id1
, id2
;
405 memset(&id1
, 0, sizeof(id1
));
406 memset(&id2
, 0, sizeof(id2
));
407 id1
.iface
= SNDRV_CTL_ELEM_IFACE_MIXER
;
408 id2
.iface
= SNDRV_CTL_ELEM_IFACE_MIXER
;
409 /* reassign AUX0 to FM */
410 strcpy(id1
.name
, "Aux Playback Switch");
411 strcpy(id2
.name
, "FM Playback Switch");
412 err
= snd_ctl_rename_id(card
, &id1
, &id2
);
415 strcpy(id1
.name
, "Aux Playback Volume");
416 strcpy(id2
.name
, "FM Playback Volume");
417 err
= snd_ctl_rename_id(card
, &id1
, &id2
);
420 /* reassign AUX1 to CD */
421 strcpy(id1
.name
, "Aux Playback Switch"); id1
.index
= 1;
422 strcpy(id2
.name
, "CD Playback Switch");
423 err
= snd_ctl_rename_id(card
, &id1
, &id2
);
426 strcpy(id1
.name
, "Aux Playback Volume");
427 strcpy(id2
.name
, "CD Playback Volume");
428 err
= snd_ctl_rename_id(card
, &id1
, &id2
);
434 static int __devinit
snd_sc6000_match(struct device
*devptr
, unsigned int dev
)
438 if (port
[dev
] == SNDRV_AUTO_PORT
) {
439 printk(KERN_ERR PFX
"specify IO port\n");
442 if (mss_port
[dev
] == SNDRV_AUTO_PORT
) {
443 printk(KERN_ERR PFX
"specify MSS port\n");
446 if (port
[dev
] != 0x220 && port
[dev
] != 0x240) {
447 printk(KERN_ERR PFX
"Port must be 0x220 or 0x240\n");
450 if (mss_port
[dev
] != 0x530 && mss_port
[dev
] != 0xe80) {
451 printk(KERN_ERR PFX
"MSS port must be 0x530 or 0xe80\n");
454 if (irq
[dev
] != SNDRV_AUTO_IRQ
&& !sc6000_irq_to_softcfg(irq
[dev
])) {
455 printk(KERN_ERR PFX
"invalid IRQ %d\n", irq
[dev
]);
458 if (dma
[dev
] != SNDRV_AUTO_DMA
&& !sc6000_dma_to_softcfg(dma
[dev
])) {
459 printk(KERN_ERR PFX
"invalid DMA %d\n", dma
[dev
]);
462 if (mpu_port
[dev
] != SNDRV_AUTO_PORT
&&
463 (mpu_port
[dev
] & ~0x30L
) != 0x300) {
464 printk(KERN_ERR PFX
"invalid MPU-401 port %lx\n",
468 if (mpu_port
[dev
] != SNDRV_AUTO_PORT
&&
469 mpu_irq
[dev
] != SNDRV_AUTO_IRQ
&& mpu_irq
[dev
] != 0 &&
470 !sc6000_mpu_irq_to_softcfg(mpu_irq
[dev
])) {
471 printk(KERN_ERR PFX
"invalid MPU-401 IRQ %d\n", mpu_irq
[dev
]);
477 static int __devinit
snd_sc6000_probe(struct device
*devptr
, unsigned int dev
)
479 static int possible_irqs
[] = { 5, 7, 9, 10, 11, -1 };
480 static int possible_dmas
[] = { 1, 3, 0, -1 };
484 struct snd_card
*card
;
485 struct snd_ad1848
*chip
;
486 struct snd_opl3
*opl3
;
488 char __iomem
*vmss_port
;
491 card
= snd_card_new(index
[dev
], id
[dev
], THIS_MODULE
, 0);
495 if (xirq
== SNDRV_AUTO_IRQ
) {
496 xirq
= snd_legacy_find_free_irq(possible_irqs
);
498 snd_printk(KERN_ERR PFX
"unable to find a free IRQ\n");
504 if (xdma
== SNDRV_AUTO_DMA
) {
505 xdma
= snd_legacy_find_free_dma(possible_dmas
);
507 snd_printk(KERN_ERR PFX
"unable to find a free DMA\n");
513 if (!request_region(port
[dev
], 0x10, DRV_NAME
)) {
514 snd_printk(KERN_ERR PFX
515 "I/O port region is already in use.\n");
519 vport
= devm_ioport_map(devptr
, port
[dev
], 0x10);
521 snd_printk(KERN_ERR PFX
522 "I/O port cannot be iomaped.\n");
527 /* to make it marked as used */
528 if (!request_region(mss_port
[dev
], 4, DRV_NAME
)) {
529 snd_printk(KERN_ERR PFX
530 "SC-6000 port I/O port region is already in use.\n");
534 vmss_port
= devm_ioport_map(devptr
, mss_port
[dev
], 4);
536 snd_printk(KERN_ERR PFX
537 "MSS port I/O cannot be iomaped.\n");
542 snd_printd("Initializing BASE[0x%lx] IRQ[%d] DMA[%d] MIRQ[%d]\n",
543 port
[dev
], xirq
, xdma
,
544 mpu_irq
[dev
] == SNDRV_AUTO_IRQ
? 0 : mpu_irq
[dev
]);
546 err
= sc6000_init_board(vport
, xirq
, xdma
, vmss_port
, mpu_irq
[dev
]);
550 err
= snd_ad1848_create(card
, mss_port
[dev
] + 4, xirq
, xdma
,
551 AD1848_HW_DETECT
, &chip
);
554 card
->private_data
= chip
;
556 err
= snd_ad1848_pcm(chip
, 0, NULL
);
558 snd_printk(KERN_ERR PFX
559 "error creating new ad1848 PCM device\n");
562 err
= snd_ad1848_mixer(chip
);
564 snd_printk(KERN_ERR PFX
"error creating new ad1848 mixer\n");
567 err
= snd_sc6000_mixer(chip
);
569 snd_printk(KERN_ERR PFX
"the mixer rewrite failed\n");
572 if (snd_opl3_create(card
,
574 OPL3_HW_AUTO
, 0, &opl3
) < 0) {
575 snd_printk(KERN_ERR PFX
"no OPL device at 0x%x-0x%x ?\n",
578 err
= snd_opl3_timer_new(opl3
, 0, 1);
582 err
= snd_opl3_hwdep_new(opl3
, 0, 1, NULL
);
587 if (mpu_port
[dev
] != SNDRV_AUTO_PORT
) {
588 if (mpu_irq
[dev
] == SNDRV_AUTO_IRQ
)
590 if (snd_mpu401_uart_new(card
, 0,
593 mpu_irq
[dev
], IRQF_DISABLED
,
595 snd_printk(KERN_ERR
"no MPU-401 device at 0x%lx ?\n",
599 strcpy(card
->driver
, DRV_NAME
);
600 strcpy(card
->shortname
, "SC-6000");
601 sprintf(card
->longname
, "Gallant SC-6000 at 0x%lx, irq %d, dma %d",
602 mss_port
[dev
], xirq
, xdma
);
604 snd_card_set_dev(card
, devptr
);
606 err
= snd_card_register(card
);
610 dev_set_drvdata(devptr
, card
);
614 release_region(mss_port
[dev
], 4);
616 release_region(port
[dev
], 0x10);
622 static int __devexit
snd_sc6000_remove(struct device
*devptr
, unsigned int dev
)
624 release_region(port
[dev
], 0x10);
625 release_region(mss_port
[dev
], 4);
627 snd_card_free(dev_get_drvdata(devptr
));
628 dev_set_drvdata(devptr
, NULL
);
632 static struct isa_driver snd_sc6000_driver
= {
633 .match
= snd_sc6000_match
,
634 .probe
= snd_sc6000_probe
,
635 .remove
= __devexit_p(snd_sc6000_remove
),
636 /* FIXME: suspend/resume */
643 static int __init
alsa_card_sc6000_init(void)
645 return isa_register_driver(&snd_sc6000_driver
, SNDRV_CARDS
);
648 static void __exit
alsa_card_sc6000_exit(void)
650 isa_unregister_driver(&snd_sc6000_driver
);
653 module_init(alsa_card_sc6000_init
)
654 module_exit(alsa_card_sc6000_exit
)