1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Driver for Gallant SC-6000 soundcard. This card is also known as
4 * Audio Excel DSP 16 or Zoltrix AV302.
5 * These cards use CompuMedia ASC-9308 chip + AD1848 codec.
6 * SC-6600 and SC-7000 cards are also supported. They are based on
7 * CompuMedia ASC-9408 chip and CS4231 codec.
9 * Copyright (C) 2007 Krzysztof Helt <krzysztof.h1@wp.pl>
11 * I don't have documentation for this card. I used the driver
12 * for OSS/Free included in the kernel source as reference.
15 #include <linux/module.h>
16 #include <linux/delay.h>
17 #include <linux/isa.h>
20 #include <sound/core.h>
21 #include <sound/wss.h>
22 #include <sound/opl3.h>
23 #include <sound/mpu401.h>
24 #include <sound/control.h>
25 #define SNDRV_LEGACY_FIND_FREE_IRQ
26 #define SNDRV_LEGACY_FIND_FREE_DMA
27 #include <sound/initval.h>
29 MODULE_AUTHOR("Krzysztof Helt");
30 MODULE_DESCRIPTION("Gallant SC-6000");
31 MODULE_LICENSE("GPL");
33 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-MAX */
34 static char *id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* ID for this card */
35 static bool enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE
; /* Enable this card */
36 static long port
[SNDRV_CARDS
] = SNDRV_DEFAULT_PORT
; /* 0x220, 0x240 */
37 static int irq
[SNDRV_CARDS
] = SNDRV_DEFAULT_IRQ
; /* 5, 7, 9, 10, 11 */
38 static long mss_port
[SNDRV_CARDS
] = SNDRV_DEFAULT_PORT
; /* 0x530, 0xe80 */
39 static long mpu_port
[SNDRV_CARDS
] = SNDRV_DEFAULT_PORT
;
40 /* 0x300, 0x310, 0x320, 0x330 */
41 static int mpu_irq
[SNDRV_CARDS
] = SNDRV_DEFAULT_IRQ
; /* 5, 7, 9, 10, 0 */
42 static int dma
[SNDRV_CARDS
] = SNDRV_DEFAULT_DMA
; /* 0, 1, 3 */
43 static bool joystick
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = false };
45 module_param_array(index
, int, NULL
, 0444);
46 MODULE_PARM_DESC(index
, "Index value for sc-6000 based soundcard.");
47 module_param_array(id
, charp
, NULL
, 0444);
48 MODULE_PARM_DESC(id
, "ID string for sc-6000 based soundcard.");
49 module_param_array(enable
, bool, NULL
, 0444);
50 MODULE_PARM_DESC(enable
, "Enable sc-6000 based soundcard.");
51 module_param_hw_array(port
, long, ioport
, NULL
, 0444);
52 MODULE_PARM_DESC(port
, "Port # for sc-6000 driver.");
53 module_param_hw_array(mss_port
, long, ioport
, NULL
, 0444);
54 MODULE_PARM_DESC(mss_port
, "MSS Port # for sc-6000 driver.");
55 module_param_hw_array(mpu_port
, long, ioport
, NULL
, 0444);
56 MODULE_PARM_DESC(mpu_port
, "MPU-401 port # for sc-6000 driver.");
57 module_param_hw_array(irq
, int, irq
, NULL
, 0444);
58 MODULE_PARM_DESC(irq
, "IRQ # for sc-6000 driver.");
59 module_param_hw_array(mpu_irq
, int, irq
, NULL
, 0444);
60 MODULE_PARM_DESC(mpu_irq
, "MPU-401 IRQ # for sc-6000 driver.");
61 module_param_hw_array(dma
, int, dma
, NULL
, 0444);
62 MODULE_PARM_DESC(dma
, "DMA # for sc-6000 driver.");
63 module_param_array(joystick
, bool, NULL
, 0444);
64 MODULE_PARM_DESC(joystick
, "Enable gameport.");
67 * Commands of SC6000's DSP (SBPRO+special).
68 * Some of them are COMMAND_xx, in the future they may change.
70 #define WRITE_MDIRQ_CFG 0x50 /* Set M&I&DRQ mask (the real config) */
71 #define COMMAND_52 0x52 /* */
72 #define READ_HARD_CFG 0x58 /* Read Hardware Config (I/O base etc) */
73 #define COMMAND_5C 0x5c /* */
74 #define COMMAND_60 0x60 /* */
75 #define COMMAND_66 0x66 /* */
76 #define COMMAND_6C 0x6c /* */
77 #define COMMAND_6E 0x6e /* */
78 #define COMMAND_88 0x88 /* Unknown command */
79 #define DSP_INIT_MSS 0x8c /* Enable Microsoft Sound System mode */
80 #define COMMAND_C5 0xc5 /* */
81 #define GET_DSP_VERSION 0xe1 /* Get DSP Version */
82 #define GET_DSP_COPYRIGHT 0xe3 /* Get DSP Copyright */
85 * Offsets of SC6000 DSP I/O ports. The offset is added to base I/O port
86 * to have the actual I/O port.
87 * Register permissions are:
93 #define DSP_RESET 0x06 /* offset of DSP RESET (wo) */
94 #define DSP_READ 0x0a /* offset of DSP READ (ro) */
95 #define DSP_WRITE 0x0c /* offset of DSP WRITE (w-) */
96 #define DSP_COMMAND 0x0c /* offset of DSP COMMAND (w-) */
97 #define DSP_STATUS 0x0c /* offset of DSP STATUS (r-) */
98 #define DSP_DATAVAIL 0x0e /* offset of DSP DATA AVAILABLE (ro) */
100 #define PFX "sc6000: "
101 #define DRV_NAME "SC-6000"
103 /* hardware dependent functions */
106 * sc6000_irq_to_softcfg - Decode irq number into cfg code.
108 static unsigned char sc6000_irq_to_softcfg(int irq
)
110 unsigned char val
= 0;
135 * sc6000_dma_to_softcfg - Decode dma number into cfg code.
137 static unsigned char sc6000_dma_to_softcfg(int dma
)
139 unsigned char val
= 0;
158 * sc6000_mpu_irq_to_softcfg - Decode MPU-401 irq number into cfg code.
160 static unsigned char sc6000_mpu_irq_to_softcfg(int mpu_irq
)
162 unsigned char val
= 0;
183 static int sc6000_wait_data(char __iomem
*vport
)
186 unsigned char val
= 0;
189 val
= ioread8(vport
+ DSP_DATAVAIL
);
198 static int sc6000_read(char __iomem
*vport
)
200 if (sc6000_wait_data(vport
))
203 return ioread8(vport
+ DSP_READ
);
207 static int sc6000_write(char __iomem
*vport
, int cmd
)
213 val
= ioread8(vport
+ DSP_STATUS
);
215 * DSP ready to receive data if bit 7 of val == 0
218 iowrite8(cmd
, vport
+ DSP_COMMAND
);
224 snd_printk(KERN_ERR
"DSP Command (0x%x) timeout.\n", cmd
);
229 static int sc6000_dsp_get_answer(char __iomem
*vport
, int command
,
230 char *data
, int data_len
)
234 if (sc6000_write(vport
, command
)) {
235 snd_printk(KERN_ERR
"CMD 0x%x: failed!\n", command
);
240 int val
= sc6000_read(vport
);
247 } while (len
< data_len
);
250 * If no more data available, return to the caller, no error if len>0.
251 * We have no other way to know when the string is finished.
253 return len
? len
: -EIO
;
256 static int sc6000_dsp_reset(char __iomem
*vport
)
258 iowrite8(1, vport
+ DSP_RESET
);
260 iowrite8(0, vport
+ DSP_RESET
);
262 if (sc6000_read(vport
) == 0xaa)
267 /* detection and initialization */
268 static int sc6000_hw_cfg_write(char __iomem
*vport
, const int *cfg
)
270 if (sc6000_write(vport
, COMMAND_6C
) < 0) {
271 snd_printk(KERN_WARNING
"CMD 0x%x: failed!\n", COMMAND_6C
);
274 if (sc6000_write(vport
, COMMAND_5C
) < 0) {
275 snd_printk(KERN_ERR
"CMD 0x%x: failed!\n", COMMAND_5C
);
278 if (sc6000_write(vport
, cfg
[0]) < 0) {
279 snd_printk(KERN_ERR
"DATA 0x%x: failed!\n", cfg
[0]);
282 if (sc6000_write(vport
, cfg
[1]) < 0) {
283 snd_printk(KERN_ERR
"DATA 0x%x: failed!\n", cfg
[1]);
286 if (sc6000_write(vport
, COMMAND_C5
) < 0) {
287 snd_printk(KERN_ERR
"CMD 0x%x: failed!\n", COMMAND_C5
);
294 static int sc6000_cfg_write(char __iomem
*vport
, unsigned char softcfg
)
297 if (sc6000_write(vport
, WRITE_MDIRQ_CFG
)) {
298 snd_printk(KERN_ERR
"CMD 0x%x: failed!\n", WRITE_MDIRQ_CFG
);
301 if (sc6000_write(vport
, softcfg
)) {
302 snd_printk(KERN_ERR
"sc6000_cfg_write: failed!\n");
308 static int sc6000_setup_board(char __iomem
*vport
, int config
)
313 if (sc6000_write(vport
, COMMAND_88
)) {
314 snd_printk(KERN_ERR
"CMD 0x%x: failed!\n",
318 } while ((sc6000_wait_data(vport
) < 0) && loop
--);
320 if (sc6000_read(vport
) < 0) {
321 snd_printk(KERN_ERR
"sc6000_read after CMD 0x%x: failed\n",
326 if (sc6000_cfg_write(vport
, config
))
332 static int sc6000_init_mss(char __iomem
*vport
, int config
,
333 char __iomem
*vmss_port
, int mss_config
)
335 if (sc6000_write(vport
, DSP_INIT_MSS
)) {
336 snd_printk(KERN_ERR
"sc6000_init_mss [0x%x]: failed!\n",
343 if (sc6000_cfg_write(vport
, config
))
346 iowrite8(mss_config
, vmss_port
);
351 static void sc6000_hw_cfg_encode(char __iomem
*vport
, int *cfg
,
352 long xport
, long xmpu
,
353 long xmss_port
, int joystick
)
359 if (xmpu
!= SNDRV_AUTO_PORT
) {
360 cfg
[0] |= (xmpu
& 0x30) >> 2;
363 if (xmss_port
== 0xe80)
365 cfg
[0] |= 0x40; /* always set */
368 cfg
[1] |= 0x80; /* enable WSS system */
369 cfg
[1] &= ~0x40; /* disable IDE */
370 snd_printd("hw cfg %x, %x\n", cfg
[0], cfg
[1]);
373 static int sc6000_init_board(char __iomem
*vport
,
374 char __iomem
*vmss_port
, int dev
)
378 int mss_config
= sc6000_irq_to_softcfg(irq
[dev
]) |
379 sc6000_dma_to_softcfg(dma
[dev
]);
380 int config
= mss_config
|
381 sc6000_mpu_irq_to_softcfg(mpu_irq
[dev
]);
385 err
= sc6000_dsp_reset(vport
);
387 snd_printk(KERN_ERR
"sc6000_dsp_reset: failed!\n");
391 memset(answer
, 0, sizeof(answer
));
392 err
= sc6000_dsp_get_answer(vport
, GET_DSP_COPYRIGHT
, answer
, 15);
394 snd_printk(KERN_ERR
"sc6000_dsp_copyright: failed!\n");
398 * My SC-6000 card return "SC-6000" in DSPCopyright, so
399 * if we have something different, we have to be warned.
401 if (strncmp("SC-6000", answer
, 7))
402 snd_printk(KERN_WARNING
"Warning: non SC-6000 audio card!\n");
404 if (sc6000_dsp_get_answer(vport
, GET_DSP_VERSION
, version
, 2) < 2) {
405 snd_printk(KERN_ERR
"sc6000_dsp_version: failed!\n");
408 printk(KERN_INFO PFX
"Detected model: %s, DSP version %d.%d\n",
409 answer
, version
[0], version
[1]);
411 /* set configuration */
412 sc6000_write(vport
, COMMAND_5C
);
413 if (sc6000_read(vport
) < 0)
418 sc6000_hw_cfg_encode(vport
, &cfg
[0], port
[dev
], mpu_port
[dev
],
419 mss_port
[dev
], joystick
[dev
]);
420 if (sc6000_hw_cfg_write(vport
, cfg
) < 0) {
421 snd_printk(KERN_ERR
"sc6000_hw_cfg_write: failed!\n");
425 err
= sc6000_setup_board(vport
, config
);
427 snd_printk(KERN_ERR
"sc6000_setup_board: failed!\n");
431 sc6000_dsp_reset(vport
);
434 sc6000_write(vport
, COMMAND_60
);
435 sc6000_write(vport
, 0x02);
436 sc6000_dsp_reset(vport
);
439 err
= sc6000_setup_board(vport
, config
);
441 snd_printk(KERN_ERR
"sc6000_setup_board: failed!\n");
444 err
= sc6000_init_mss(vport
, config
, vmss_port
, mss_config
);
446 snd_printk(KERN_ERR
"Cannot initialize "
447 "Microsoft Sound System mode.\n");
454 static int snd_sc6000_mixer(struct snd_wss
*chip
)
456 struct snd_card
*card
= chip
->card
;
457 struct snd_ctl_elem_id id1
, id2
;
460 memset(&id1
, 0, sizeof(id1
));
461 memset(&id2
, 0, sizeof(id2
));
462 id1
.iface
= SNDRV_CTL_ELEM_IFACE_MIXER
;
463 id2
.iface
= SNDRV_CTL_ELEM_IFACE_MIXER
;
464 /* reassign AUX0 to FM */
465 strcpy(id1
.name
, "Aux Playback Switch");
466 strcpy(id2
.name
, "FM Playback Switch");
467 err
= snd_ctl_rename_id(card
, &id1
, &id2
);
470 strcpy(id1
.name
, "Aux Playback Volume");
471 strcpy(id2
.name
, "FM Playback Volume");
472 err
= snd_ctl_rename_id(card
, &id1
, &id2
);
475 /* reassign AUX1 to CD */
476 strcpy(id1
.name
, "Aux Playback Switch"); id1
.index
= 1;
477 strcpy(id2
.name
, "CD Playback Switch");
478 err
= snd_ctl_rename_id(card
, &id1
, &id2
);
481 strcpy(id1
.name
, "Aux Playback Volume");
482 strcpy(id2
.name
, "CD Playback Volume");
483 err
= snd_ctl_rename_id(card
, &id1
, &id2
);
489 static int snd_sc6000_match(struct device
*devptr
, unsigned int dev
)
493 if (port
[dev
] == SNDRV_AUTO_PORT
) {
494 printk(KERN_ERR PFX
"specify IO port\n");
497 if (mss_port
[dev
] == SNDRV_AUTO_PORT
) {
498 printk(KERN_ERR PFX
"specify MSS port\n");
501 if (port
[dev
] != 0x220 && port
[dev
] != 0x240) {
502 printk(KERN_ERR PFX
"Port must be 0x220 or 0x240\n");
505 if (mss_port
[dev
] != 0x530 && mss_port
[dev
] != 0xe80) {
506 printk(KERN_ERR PFX
"MSS port must be 0x530 or 0xe80\n");
509 if (irq
[dev
] != SNDRV_AUTO_IRQ
&& !sc6000_irq_to_softcfg(irq
[dev
])) {
510 printk(KERN_ERR PFX
"invalid IRQ %d\n", irq
[dev
]);
513 if (dma
[dev
] != SNDRV_AUTO_DMA
&& !sc6000_dma_to_softcfg(dma
[dev
])) {
514 printk(KERN_ERR PFX
"invalid DMA %d\n", dma
[dev
]);
517 if (mpu_port
[dev
] != SNDRV_AUTO_PORT
&&
518 (mpu_port
[dev
] & ~0x30L
) != 0x300) {
519 printk(KERN_ERR PFX
"invalid MPU-401 port %lx\n",
523 if (mpu_port
[dev
] != SNDRV_AUTO_PORT
&&
524 mpu_irq
[dev
] != SNDRV_AUTO_IRQ
&& mpu_irq
[dev
] != 0 &&
525 !sc6000_mpu_irq_to_softcfg(mpu_irq
[dev
])) {
526 printk(KERN_ERR PFX
"invalid MPU-401 IRQ %d\n", mpu_irq
[dev
]);
532 static int snd_sc6000_probe(struct device
*devptr
, unsigned int dev
)
534 static const int possible_irqs
[] = { 5, 7, 9, 10, 11, -1 };
535 static const int possible_dmas
[] = { 1, 3, 0, -1 };
539 struct snd_card
*card
;
540 struct snd_wss
*chip
;
541 struct snd_opl3
*opl3
;
542 char __iomem
**vport
;
543 char __iomem
*vmss_port
;
546 err
= snd_card_new(devptr
, index
[dev
], id
[dev
], THIS_MODULE
,
547 sizeof(vport
), &card
);
551 vport
= card
->private_data
;
552 if (xirq
== SNDRV_AUTO_IRQ
) {
553 xirq
= snd_legacy_find_free_irq(possible_irqs
);
555 snd_printk(KERN_ERR PFX
"unable to find a free IRQ\n");
561 if (xdma
== SNDRV_AUTO_DMA
) {
562 xdma
= snd_legacy_find_free_dma(possible_dmas
);
564 snd_printk(KERN_ERR PFX
"unable to find a free DMA\n");
570 if (!request_region(port
[dev
], 0x10, DRV_NAME
)) {
571 snd_printk(KERN_ERR PFX
572 "I/O port region is already in use.\n");
576 *vport
= devm_ioport_map(devptr
, port
[dev
], 0x10);
577 if (*vport
== NULL
) {
578 snd_printk(KERN_ERR PFX
579 "I/O port cannot be iomapped.\n");
584 /* to make it marked as used */
585 if (!request_region(mss_port
[dev
], 4, DRV_NAME
)) {
586 snd_printk(KERN_ERR PFX
587 "SC-6000 port I/O port region is already in use.\n");
591 vmss_port
= devm_ioport_map(devptr
, mss_port
[dev
], 4);
593 snd_printk(KERN_ERR PFX
594 "MSS port I/O cannot be iomapped.\n");
599 snd_printd("Initializing BASE[0x%lx] IRQ[%d] DMA[%d] MIRQ[%d]\n",
600 port
[dev
], xirq
, xdma
,
601 mpu_irq
[dev
] == SNDRV_AUTO_IRQ
? 0 : mpu_irq
[dev
]);
603 err
= sc6000_init_board(*vport
, vmss_port
, dev
);
607 err
= snd_wss_create(card
, mss_port
[dev
] + 4, -1, xirq
, xdma
, -1,
608 WSS_HW_DETECT
, 0, &chip
);
612 err
= snd_wss_pcm(chip
, 0);
614 snd_printk(KERN_ERR PFX
615 "error creating new WSS PCM device\n");
618 err
= snd_wss_mixer(chip
);
620 snd_printk(KERN_ERR PFX
"error creating new WSS mixer\n");
623 err
= snd_sc6000_mixer(chip
);
625 snd_printk(KERN_ERR PFX
"the mixer rewrite failed\n");
628 if (snd_opl3_create(card
,
630 OPL3_HW_AUTO
, 0, &opl3
) < 0) {
631 snd_printk(KERN_ERR PFX
"no OPL device at 0x%x-0x%x ?\n",
634 err
= snd_opl3_hwdep_new(opl3
, 0, 1, NULL
);
639 if (mpu_port
[dev
] != SNDRV_AUTO_PORT
) {
640 if (mpu_irq
[dev
] == SNDRV_AUTO_IRQ
)
642 if (snd_mpu401_uart_new(card
, 0,
645 mpu_irq
[dev
], NULL
) < 0)
646 snd_printk(KERN_ERR
"no MPU-401 device at 0x%lx ?\n",
650 strcpy(card
->driver
, DRV_NAME
);
651 strcpy(card
->shortname
, "SC-6000");
652 sprintf(card
->longname
, "Gallant SC-6000 at 0x%lx, irq %d, dma %d",
653 mss_port
[dev
], xirq
, xdma
);
655 err
= snd_card_register(card
);
659 dev_set_drvdata(devptr
, card
);
663 sc6000_setup_board(*vport
, 0);
664 release_region(mss_port
[dev
], 4);
666 release_region(port
[dev
], 0x10);
672 static void snd_sc6000_remove(struct device
*devptr
, unsigned int dev
)
674 struct snd_card
*card
= dev_get_drvdata(devptr
);
675 char __iomem
**vport
= card
->private_data
;
677 if (sc6000_setup_board(*vport
, 0) < 0)
678 snd_printk(KERN_WARNING
"sc6000_setup_board failed on exit!\n");
680 release_region(port
[dev
], 0x10);
681 release_region(mss_port
[dev
], 4);
686 static struct isa_driver snd_sc6000_driver
= {
687 .match
= snd_sc6000_match
,
688 .probe
= snd_sc6000_probe
,
689 .remove
= snd_sc6000_remove
,
690 /* FIXME: suspend/resume */
697 module_isa_driver(snd_sc6000_driver
, SNDRV_CARDS
);