2 * Copyright (C) by Hannu Savolainen 1993-1997
6 * Initialization code for OPTi MAD16 compatible audio chips. Including
8 * OPTi 82C928 MAD16 (replaced by C929)
10 * OAK OTI-605 Mozart (later version with MPU401 Midi)
11 * OPTi 82C929 MAD16 Pro
15 * These audio interface chips don't produce sound themselves. They just
16 * connect some other components (OPL-[234] and a WSS compatible codec)
17 * to the PC bus and perform I/O, DMA and IRQ address decoding. There is
18 * also a UART for the MPU-401 mode (not 82C928/Mozart).
19 * The Mozart chip appears to be compatible with the 82C928, although later
20 * issues of the card, using the OTI-605 chip, have an MPU-401 compatible Midi
21 * port. This port is configured differently to that of the OPTi audio chips.
25 * Alan Cox Clean up, added module selections.
27 * A. Wik Added support for Opti924 PnP.
28 * Improved debugging support. 16-May-1998
29 * Fixed bug. 16-Jun-1998
31 * Torsten Duwe Made Opti924 PnP support non-destructive
34 * Paul Grayson Added support for Midi on later Mozart cards.
36 * Christoph Hellwig Adapted to module_init/module_exit.
37 * Arnaldo C. de Melo got rid of attach_uart401 21-Sep-2000
39 * Pavel Rabel Clean up Nov-2000
42 #include <linux/config.h>
43 #include <linux/init.h>
44 #include <linux/module.h>
45 #include <linux/gameport.h>
46 #include <linux/spinlock.h>
47 #include "sound_config.h"
53 #if defined(CONFIG_GAMEPORT) || (defined(MODULE) && defined(CONFIG_GAMEPORT_MODULE))
54 #define SUPPORT_JOYSTICK 1
57 static int mad16_conf;
58 static int mad16_cdsel;
59 static DEFINE_SPINLOCK(lock);
70 * The MAD16 occupies I/O ports 0xf8d to 0xf93 (fixed locations).
71 * All ports are inactive by default. They can be activated by
72 * writing 0xE2 or 0xE3 to the password register. The password is valid
73 * only until the next I/O read or write.
75 * 82C930 uses 0xE4 as the password and indirect addressing to access
76 * the config registers.
79 #define MC0_PORT 0xf8c /* Dummy port */
80 #define MC1_PORT 0xf8d /* SB address, CD-ROM interface type, joystick */
81 #define MC2_PORT 0xf8e /* CD-ROM address, IRQ, DMA, plus OPL4 bit */
82 #define MC3_PORT 0xf8f
83 #define PASSWD_REG 0xf8f
84 #define MC4_PORT 0xf90
85 #define MC5_PORT 0xf91
86 #define MC6_PORT 0xf92
87 #define MC7_PORT 0xf93
88 #define MC8_PORT 0xf94
89 #define MC9_PORT 0xf95
90 #define MC10_PORT 0xf96
91 #define MC11_PORT 0xf97
92 #define MC12_PORT 0xf98
94 static int board_type = C928;
96 static int *mad16_osp;
97 static int c931_detected; /* minor differences from C930 */
98 static char c924pnp; /* " " " C924 */
99 static int debug; /* debugging output */
104 #define DDB(x) do {if (debug) x;} while (0)
106 static unsigned char mad_read(int port)
111 spin_lock_irqsave(&lock,flags);
113 switch (board_type) /* Output password */
117 outb((0xE2), PASSWD_REG);
121 outb((0xE3), PASSWD_REG);
125 /* outb(( 0xE4), PASSWD_REG); */
129 /* the c924 has its ports relocated by -128 if
130 PnP is enabled -aw */
132 outb((0xE5), PASSWD_REG); else
133 outb((0xE5), PASSWD_REG - 0x80);
137 if (board_type == C930)
139 outb((port - MC0_PORT), 0xe0e); /* Write to index reg */
140 tmp = inb(0xe0f); /* Read from data reg */
144 tmp = inb(port); else
145 tmp = inb(port-0x80);
146 spin_unlock_irqrestore(&lock,flags);
151 static void mad_write(int port, int value)
155 spin_lock_irqsave(&lock,flags);
157 switch (board_type) /* Output password */
161 outb((0xE2), PASSWD_REG);
165 outb((0xE3), PASSWD_REG);
169 /* outb(( 0xE4), PASSWD_REG); */
174 outb((0xE5), PASSWD_REG); else
175 outb((0xE5), PASSWD_REG - 0x80);
179 if (board_type == C930)
181 outb((port - MC0_PORT), 0xe0e); /* Write to index reg */
182 outb(((unsigned char) (value & 0xff)), 0xe0f);
186 outb(((unsigned char) (value & 0xff)), port); else
187 outb(((unsigned char) (value & 0xff)), port-0x80);
188 spin_unlock_irqrestore(&lock,flags);
191 static int __init detect_c930(void)
193 unsigned char tmp = mad_read(MC1_PORT);
195 if ((tmp & 0x06) != 0x06)
197 DDB(printk("Wrong C930 signature (%x)\n", tmp));
200 mad_write(MC1_PORT, 0);
202 if (mad_read(MC1_PORT) != 0x06)
204 DDB(printk("Wrong C930 signature2 (%x)\n", tmp));
207 mad_write(MC1_PORT, tmp); /* Restore bits */
209 mad_write(MC7_PORT, 0);
210 if ((tmp = mad_read(MC7_PORT)) != 0)
212 DDB(printk("MC7 not writable (%x)\n", tmp));
215 mad_write(MC7_PORT, 0xcb);
216 if ((tmp = mad_read(MC7_PORT)) != 0xcb)
218 DDB(printk("MC7 not writable2 (%x)\n", tmp));
222 tmp = mad_read(MC0_PORT+18);
223 if (tmp == 0xff || tmp == 0x00)
225 /* We probably have a C931 */
226 DDB(printk("Detected C931 config=0x%02x\n", tmp));
230 * We cannot configure the chip if it is in PnP mode.
231 * If we have a CSN assigned (bit 8 in MC13) we first try
232 * a software reset, then a software power off, finally
233 * Clearing PnP mode. The last option is not
236 if ((mad_read(MC0_PORT+13) & 0x80) == 0)
240 mad_write(MC9_PORT, 0x02);
241 mad_write(MC9_PORT, 0x00);
243 if ((mad_read(MC0_PORT+13) & 0x80) == 0)
246 /* Power off, and on again */
247 mad_write(MC9_PORT, 0xc2);
248 mad_write(MC9_PORT, 0xc0);
250 if ((mad_read(MC0_PORT+13) & 0x80) == 0)
254 /* Force off PnP mode. This is not recommended because
255 * the PnP bios will not recognize the chip on the next
256 * warm boot and may assignd different resources to other
259 mad_write(MC0_PORT+17, 0x04);
264 static int __init detect_mad16(void)
266 unsigned char tmp, tmp2, bit;
270 * Check that reading a register doesn't return bus float (0xff)
271 * when the card is accessed using password. This may fail in case
272 * the card is in low power mode. Normally at least the power saving
273 * mode bit should be 0.
276 if ((tmp = mad_read(MC1_PORT)) == 0xff)
278 DDB(printk("MC1_PORT returned 0xff\n"));
281 for (i = 0xf8d; i <= 0xf98; i++)
283 DDB(printk("Port %0x (init value) = %0x\n", i, mad_read(i)));
285 DDB(printk("Port %0x (init value) = %0x\n", i-0x80, mad_read(i)));
287 if (board_type == C930)
288 return detect_c930();
291 * Now check that the gate is closed on first I/O after writing
292 * the password. (This is how a MAD16 compatible card works).
295 if ((tmp2 = inb(MC1_PORT)) == tmp) /* It didn't close */
297 DDB(printk("MC1_PORT didn't close after read (0x%02x)\n", tmp2));
301 bit = (c924pnp) ? 0x20 : 0x80;
302 port = (c924pnp) ? MC2_PORT : MC1_PORT;
304 tmp = mad_read(port);
305 mad_write(port, tmp ^ bit); /* Toggle a bit */
306 if ((tmp2 = mad_read(port)) != (tmp ^ bit)) /* Compare the bit */
308 mad_write(port, tmp); /* Restore */
309 DDB(printk("Bit revert test failed (0x%02x, 0x%02x)\n", tmp, tmp2));
312 mad_write(port, tmp); /* Restore */
313 return 1; /* Bingo */
316 static int __init wss_init(struct address_info *hw_config)
319 * Check if the IO port returns valid signature. The original MS Sound
320 * system returns 0x04 while some cards (AudioTrix Pro for example)
324 if ((inb(hw_config->io_base + 3) & 0x3f) != 0x04 &&
325 (inb(hw_config->io_base + 3) & 0x3f) != 0x00)
327 DDB(printk("No MSS signature detected on port 0x%x (0x%x)\n", hw_config->io_base, inb(hw_config->io_base + 3)));
331 * Check that DMA0 is not in use with a 8 bit board.
333 if (hw_config->dma == 0 && inb(hw_config->io_base + 3) & 0x80)
335 printk("MSS: Can't use DMA0 with a 8 bit card/slot\n");
338 if (hw_config->irq > 9 && inb(hw_config->io_base + 3) & 0x80)
339 printk(KERN_ERR "MSS: Can't use IRQ%d with a 8 bit card/slot\n", hw_config->irq);
343 static void __init init_c930(struct address_info *hw_config, int base)
345 unsigned char cfg = 0;
347 cfg |= (0x0f & mad16_conf);
351 /* Bit 0 has reversd meaning. Bits 1 and 2 sese
353 Support only IDE cdrom. IDE port programmed
355 cfg = (cfg & 0x09) ^ 0x07;
358 mad_write(MC1_PORT, cfg);
360 /* MC2 is CD configuration. Don't touch it. */
362 mad_write(MC3_PORT, 0); /* Disable SB mode IRQ and DMA */
364 /* bit 2 of MC4 reverses it's meaning between the C930
366 cfg = c931_detected ? 0x04 : 0x00;
368 if(mad16_cdsel & 0x20)
369 mad_write(MC4_PORT, 0x62|cfg); /* opl4 */
371 mad_write(MC4_PORT, 0x52|cfg); /* opl3 */
373 mad_write(MC5_PORT, 0x3C); /* Init it into mode2 */
374 mad_write(MC6_PORT, 0x02); /* Enable WSS, Disable MPU and SB */
375 mad_write(MC7_PORT, 0xCB);
376 mad_write(MC10_PORT, 0x11);
379 static int __init chip_detect(void)
384 * Then try to detect with the old password
388 DDB(printk("Detect using password = 0xE5\n"));
390 if (detect_mad16()) {
396 DDB(printk("Detect using password = 0xE2\n"));
402 if (((model = mad_read(MC3_PORT)) & 0x03) == 0x03) {
403 DDB(printk("mad16.c: Mozart detected\n"));
406 DDB(printk("mad16.c: 82C928 detected???\n"));
414 DDB(printk("Detect using password = 0xE3\n"));
418 DDB(printk("mad16.c: 82C929 detected\n"));
422 if (inb(PASSWD_REG) != 0xff)
426 * First relocate MC# registers to 0xe0e/0xe0f, disable password
429 outb((0xE4), PASSWD_REG);
430 outb((0x80), PASSWD_REG);
434 DDB(printk("Detect using password = 0xE4\n"));
436 for (i = 0xf8d; i <= 0xf93; i++)
437 DDB(printk("port %03x = %02x\n", i, mad_read(i)));
440 DDB(printk("mad16.c: 82C930 detected\n"));
444 /* The C931 has the password reg at F8D */
447 DDB(printk("Detect using password = 0xE4 for C931\n"));
449 if (detect_mad16()) {
455 DDB(printk("Detect using password = 0xE5 (again), port offset -0x80\n"));
456 if (detect_mad16()) {
457 DDB(printk("mad16.c: 82C924 PnP detected\n"));
466 static int __init probe_mad16(struct address_info *hw_config)
470 unsigned char cs4231_mode = 0;
476 static char dma_bits[4] = {
480 int config_port = hw_config->io_base + 0, version_port = hw_config->io_base + 3;
481 int dma = hw_config->dma, dma2 = hw_config->dma2;
482 unsigned char dma2_bit = 0;
484 struct resource *ports;
486 mad16_osp = hw_config->osp;
488 switch (hw_config->io_base) {
502 printk(KERN_ERR "MAD16/Mozart: Bad WSS base address 0x%x\n", hw_config->io_base);
506 if (dma != 0 && dma != 1 && dma != 3) {
507 printk(KERN_ERR "MSS: Bad DMA %d\n", dma);
512 * Check that all ports return 0xff (bus float) when no password
513 * is written to the password register.
516 DDB(printk("--- Detecting MAD16 / Mozart ---\n"));
520 switch (hw_config->irq) {
533 case 5: /* Also IRQ5 is possible on C930 */
534 if (board_type == C930 || c924pnp) {
539 printk(KERN_ERR "MAD16/Mozart: Bad IRQ %d\n", hw_config->irq);
543 ports = request_region(hw_config->io_base + 4, 4, "ad1848");
545 printk(KERN_ERR "MSS: I/O port conflict\n");
548 if (!request_region(hw_config->io_base, 4, "mad16 WSS config")) {
549 release_region(hw_config->io_base + 4, 4);
550 printk(KERN_ERR "MSS: I/O port conflict\n");
554 if (board_type == C930) {
555 init_c930(hw_config, base);
559 for (i = 0xf8d; i <= 0xf93; i++) {
561 DDB(printk("port %03x = %02x\n", i, mad_read(i)));
563 DDB(printk("port %03x = %02x\n", i-0x80, mad_read(i)));
567 * Set the WSS address
570 tmp = (mad_read(MC1_PORT) & 0x0f) | 0x80; /* Enable WSS, Disable SB */
571 tmp |= base << 4; /* WSS port select bits */
574 * Set optional CD-ROM and joystick settings.
578 tmp |= (mad16_conf & 0x0f); /* CD-ROM and joystick bits */
579 mad_write(MC1_PORT, tmp);
582 mad_write(MC2_PORT, tmp);
583 mad_write(MC3_PORT, 0xf0); /* Disable SB */
585 if (board_type == C924) /* Specific C924 init values */
587 mad_write(MC4_PORT, 0xA0);
588 mad_write(MC5_PORT, 0x05);
589 mad_write(MC6_PORT, 0x03);
591 if (!ad1848_detect(ports, &ad_flags, mad16_osp))
594 if (ad_flags & (AD_F_CS4231 | AD_F_CS4248))
595 cs4231_mode = 0x02; /* CS4248/CS4231 sync delay switch */
597 if (board_type == C929)
599 mad_write(MC4_PORT, 0xa2);
600 mad_write(MC5_PORT, 0xA5 | cs4231_mode);
601 mad_write(MC6_PORT, 0x03); /* Disable MPU401 */
605 mad_write(MC4_PORT, 0x02);
606 mad_write(MC5_PORT, 0x30 | cs4231_mode);
609 for (i = 0xf8d; i <= 0xf93; i++) {
611 DDB(printk("port %03x after init = %02x\n", i, mad_read(i)));
613 DDB(printk("port %03x after init = %02x\n", i-0x80, mad_read(i)));
618 if (!ad1848_detect(ports, &ad_flags, mad16_osp))
621 if (!wss_init(hw_config))
625 * Set the IRQ and DMA addresses.
628 outb((bits | 0x40), config_port);
629 if ((inb(version_port) & 0x40) == 0)
630 printk(KERN_ERR "[IRQ Conflict?]\n");
633 * Handle the capture DMA channel
636 if (ad_flags & AD_F_CS4231 && dma2 != -1 && dma2 != dma)
638 if (!((dma == 0 && dma2 == 1) ||
639 (dma == 1 && dma2 == 0) ||
640 (dma == 3 && dma2 == 0)))
641 { /* Unsupported combination. Try to swap channels */
647 if ((dma == 0 && dma2 == 1) || (dma == 1 && dma2 == 0) ||
648 (dma == 3 && dma2 == 0))
650 dma2_bit = 0x04; /* Enable capture DMA */
654 printk("MAD16: Invalid capture DMA\n");
660 outb((bits | dma_bits[dma] | dma2_bit), config_port); /* Write IRQ+DMA setup */
662 hw_config->slots[0] = ad1848_init("mad16 WSS", ports,
671 release_region(hw_config->io_base + 4, 4);
672 release_region(hw_config->io_base, 4);
676 static int __init probe_mad16_mpu(struct address_info *hw_config)
680 if (board_type < C929) /* Early chip. No MPU support. Just SB MIDI */
683 #ifdef CONFIG_MAD16_OLDCARD
685 tmp = mad_read(MC3_PORT);
688 * MAD16 SB base is defined by the WSS base. It cannot be changed
690 * Ignore configured I/O base. Use the active setting.
693 if (mad_read(MC1_PORT) & 0x20)
694 hw_config->io_base = 0x240;
696 hw_config->io_base = 0x220;
698 switch (hw_config->irq)
701 tmp = (tmp & 0x3f) | 0x80;
707 tmp = (tmp & 0x3f) | 0x40;
710 printk(KERN_ERR "mad16/Mozart: Invalid MIDI IRQ\n");
714 mad_write(MC3_PORT, tmp | 0x04);
715 hw_config->driver_use_1 = SB_MIDI_ONLY;
716 if (!request_region(hw_config->io_base, 16, "soundblaster"))
718 if (!sb_dsp_detect(hw_config, 0, 0, NULL)) {
719 release_region(hw_config->io_base, 16);
723 if (mad_read(MC1_PORT) & 0x20)
724 hw_config->io_base = 0x240;
726 hw_config->io_base = 0x220;
728 hw_config->name = "Mad16/Mozart";
729 sb_dsp_init(hw_config, THIS_MODULE);
732 /* assuming all later Mozart cards are identified as
733 * either 82C928 or Mozart. If so, following code attempts
734 * to set MPU register. TODO - add probing
737 tmp = mad_read(MC8_PORT);
739 switch (hw_config->irq)
757 printk(KERN_ERR "mad16/MOZART: invalid mpu_irq\n");
761 switch (hw_config->io_base)
776 printk(KERN_ERR "mad16/MOZART: invalid mpu_io\n");
780 mad_write(MC8_PORT, tmp); /* write MPU port parameters */
784 tmp = mad_read(MC6_PORT) & 0x83;
785 tmp |= 0x80; /* MPU-401 enable */
787 /* Set the MPU base bits */
789 switch (hw_config->io_base)
804 printk(KERN_ERR "MAD16: Invalid MIDI port 0x%x\n", hw_config->io_base);
808 /* Set the MPU IRQ bits */
810 switch (hw_config->irq)
825 printk(KERN_ERR "MAD16: Invalid MIDI IRQ %d\n", hw_config->irq);
829 mad_write(MC6_PORT, tmp); /* Write MPU401 config */
831 #ifndef CONFIG_MAD16_OLDCARD
834 hw_config->driver_use_1 = SB_MIDI_ONLY;
835 hw_config->name = "Mad16/Mozart";
836 return probe_uart401(hw_config, THIS_MODULE);
839 static void __exit unload_mad16(struct address_info *hw_config)
841 ad1848_unload(hw_config->io_base + 4,
845 release_region(hw_config->io_base, 4);
846 sound_unload_audiodev(hw_config->slots[0]);
849 static void __exit unload_mad16_mpu(struct address_info *hw_config)
851 #ifdef CONFIG_MAD16_OLDCARD
852 if (board_type < C929) /* Early chip. No MPU support. Just SB MIDI */
854 sb_dsp_unload(hw_config, 0);
859 unload_uart401(hw_config);
862 static struct address_info cfg;
863 static struct address_info cfg_mpu;
865 static int found_mpu;
867 static int __initdata mpu_io = 0;
868 static int __initdata mpu_irq = 0;
869 static int __initdata io = -1;
870 static int __initdata dma = -1;
871 static int __initdata dma16 = -1; /* Set this for modules that need it */
872 static int __initdata irq = -1;
873 static int __initdata cdtype = 0;
874 static int __initdata cdirq = 0;
875 static int __initdata cdport = 0x340;
876 static int __initdata cddma = -1;
877 static int __initdata opl4 = 0;
878 static int __initdata joystick = 0;
880 module_param(mpu_io, int, 0);
881 module_param(mpu_irq, int, 0);
882 module_param(io, int, 0);
883 module_param(dma, int, 0);
884 module_param(dma16, int, 0);
885 module_param(irq, int, 0);
886 module_param(cdtype, int, 0);
887 module_param(cdirq, int, 0);
888 module_param(cdport, int, 0);
889 module_param(cddma, int, 0);
890 module_param(opl4, int, 0);
891 module_param(joystick, bool, 0);
892 module_param(debug, bool, 0644);
894 static int __initdata dma_map[2][8] =
896 {0x03, -1, -1, -1, -1, 0x00, 0x01, 0x02},
897 {0x03, -1, 0x01, 0x00, -1, -1, -1, -1}
900 static int __initdata irq_map[16] =
904 -1, 0x10, 0x14, 0x18,
908 #ifdef SUPPORT_JOYSTICK
910 static struct gameport *gameport;
912 static int __devinit mad16_register_gameport(int io_port)
914 if (!request_region(io_port, 1, "mad16 gameport")) {
915 printk(KERN_ERR "mad16: gameport address 0x%#x already in use\n", io_port);
919 gameport = gameport_allocate_port();
921 printk(KERN_ERR "mad16: can not allocate memory for gameport\n");
922 release_region(io_port, 1);
926 gameport_set_name(gameport, "MAD16 Gameport");
927 gameport_set_phys(gameport, "isa%04x/gameport0", io_port);
928 gameport->io = io_port;
930 gameport_register_port(gameport);
935 static inline void mad16_unregister_gameport(void)
938 /* the gameport was initialized so we must free it up */
939 gameport_unregister_port(gameport);
941 release_region(0x201, 1);
945 static inline int mad16_register_gameport(int io_port) { return -ENOSYS; }
946 static inline void mad16_unregister_gameport(void) { }
949 static int __devinit init_mad16(void)
953 printk(KERN_INFO "MAD16 audio driver Copyright (C) by Hannu Savolainen 1993-1996\n");
955 printk(KERN_INFO "CDROM ");
963 printk("Sony CDU31A");
965 if(cddma == -1) cddma = 3;
970 if(cddma == -1) cddma = 5;
973 printk("Panasonic Lasermate");
975 if(cddma == -1) cddma = 3;
978 printk("Secondary IDE");
980 if(cddma == -1) cddma = 5;
983 printk("Primary IDE");
985 if(cddma == -1) cddma = 5;
989 printk(KERN_ERR "Invalid CDROM type\n");
994 * Build the config words
997 mad16_conf = (joystick ^ 1) | cdtype;
1000 mad16_cdsel |= 0x20;
1003 if (cddma > 7 || cddma < 0 || dma_map[dmatype][cddma] == -1)
1006 printk(KERN_ERR "Invalid CDROM DMA\n");
1010 printk(", DMA %d", cddma);
1016 else if (cdirq < 0 || cdirq > 15 || irq_map[cdirq] == -1)
1018 printk(", invalid IRQ (disabling)");
1021 else printk(", IRQ %d", cdirq);
1023 mad16_cdsel |= dma_map[dmatype][cddma];
1030 mad16_cdsel |= 0x00;
1033 mad16_cdsel |= 0x40;
1036 mad16_cdsel |= 0x80;
1039 mad16_cdsel |= 0xC0;
1042 printk(KERN_ERR "Unknown CDROM I/O base %d\n", cdport);
1046 mad16_cdsel |= irq_map[cdirq];
1056 if (cfg.io_base == -1 || cfg.dma == -1 || cfg.irq == -1) {
1057 printk(KERN_ERR "I/O, DMA and irq are mandatory\n");
1061 if (!request_region(MC0_PORT, 12, "mad16"))
1064 if (!probe_mad16(&cfg)) {
1065 release_region(MC0_PORT, 12);
1069 cfg_mpu.io_base = mpu_io;
1070 cfg_mpu.irq = mpu_irq;
1072 found_mpu = probe_mad16_mpu(&cfg_mpu);
1075 mad16_register_gameport(0x201);
1080 static void __exit cleanup_mad16(void)
1083 unload_mad16_mpu(&cfg_mpu);
1084 mad16_unregister_gameport();
1086 release_region(MC0_PORT, 12);
1089 module_init(init_mad16);
1090 module_exit(cleanup_mad16);
1093 static int __init setup_mad16(char *str)
1098 str = get_options(str, ARRAY_SIZE(ints), ints);
1111 __setup("mad16=", setup_mad16);
1113 MODULE_LICENSE("GPL");