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 static int mad16_conf;
54 static int mad16_cdsel;
55 static struct gameport gameport;
56 static spinlock_t lock=SPIN_LOCK_UNLOCKED;
57 static int already_initialized;
68 * The MAD16 occupies I/O ports 0xf8d to 0xf93 (fixed locations).
69 * All ports are inactive by default. They can be activated by
70 * writing 0xE2 or 0xE3 to the password register. The password is valid
71 * only until the next I/O read or write.
73 * 82C930 uses 0xE4 as the password and indirect addressing to access
74 * the config registers.
77 #define MC0_PORT 0xf8c /* Dummy port */
78 #define MC1_PORT 0xf8d /* SB address, CD-ROM interface type, joystick */
79 #define MC2_PORT 0xf8e /* CD-ROM address, IRQ, DMA, plus OPL4 bit */
80 #define MC3_PORT 0xf8f
81 #define PASSWD_REG 0xf8f
82 #define MC4_PORT 0xf90
83 #define MC5_PORT 0xf91
84 #define MC6_PORT 0xf92
85 #define MC7_PORT 0xf93
86 #define MC8_PORT 0xf94
87 #define MC9_PORT 0xf95
88 #define MC10_PORT 0xf96
89 #define MC11_PORT 0xf97
90 #define MC12_PORT 0xf98
92 static int board_type = C928;
94 static int *mad16_osp;
95 static int c931_detected; /* minor differences from C930 */
96 static char c924pnp; /* " " " C924 */
97 static int debug; /* debugging output */
102 #define DDB(x) do {if (debug) x;} while (0)
104 static unsigned char mad_read(int port)
109 spin_lock_irqsave(&lock,flags);
111 switch (board_type) /* Output password */
115 outb((0xE2), PASSWD_REG);
119 outb((0xE3), PASSWD_REG);
123 /* outb(( 0xE4), PASSWD_REG); */
127 /* the c924 has its ports relocated by -128 if
128 PnP is enabled -aw */
130 outb((0xE5), PASSWD_REG); else
131 outb((0xE5), PASSWD_REG - 0x80);
135 if (board_type == C930)
137 outb((port - MC0_PORT), 0xe0e); /* Write to index reg */
138 tmp = inb(0xe0f); /* Read from data reg */
142 tmp = inb(port); else
143 tmp = inb(port-0x80);
144 spin_unlock_irqrestore(&lock,flags);
149 static void mad_write(int port, int value)
153 spin_lock_irqsave(&lock,flags);
155 switch (board_type) /* Output password */
159 outb((0xE2), PASSWD_REG);
163 outb((0xE3), PASSWD_REG);
167 /* outb(( 0xE4), PASSWD_REG); */
172 outb((0xE5), PASSWD_REG); else
173 outb((0xE5), PASSWD_REG - 0x80);
177 if (board_type == C930)
179 outb((port - MC0_PORT), 0xe0e); /* Write to index reg */
180 outb(((unsigned char) (value & 0xff)), 0xe0f);
184 outb(((unsigned char) (value & 0xff)), port); else
185 outb(((unsigned char) (value & 0xff)), port-0x80);
186 spin_unlock_irqrestore(&lock,flags);
189 static int __init detect_c930(void)
191 unsigned char tmp = mad_read(MC1_PORT);
193 if ((tmp & 0x06) != 0x06)
195 DDB(printk("Wrong C930 signature (%x)\n", tmp));
198 mad_write(MC1_PORT, 0);
200 if (mad_read(MC1_PORT) != 0x06)
202 DDB(printk("Wrong C930 signature2 (%x)\n", tmp));
205 mad_write(MC1_PORT, tmp); /* Restore bits */
207 mad_write(MC7_PORT, 0);
208 if ((tmp = mad_read(MC7_PORT)) != 0)
210 DDB(printk("MC7 not writable (%x)\n", tmp));
213 mad_write(MC7_PORT, 0xcb);
214 if ((tmp = mad_read(MC7_PORT)) != 0xcb)
216 DDB(printk("MC7 not writable2 (%x)\n", tmp));
220 tmp = mad_read(MC0_PORT+18);
221 if (tmp == 0xff || tmp == 0x00)
223 /* We probably have a C931 */
224 DDB(printk("Detected C931 config=0x%02x\n", tmp));
228 * We cannot configure the chip if it is in PnP mode.
229 * If we have a CSN assigned (bit 8 in MC13) we first try
230 * a software reset, then a software power off, finally
231 * Clearing PnP mode. The last option is not
234 if ((mad_read(MC0_PORT+13) & 0x80) == 0)
238 mad_write(MC9_PORT, 0x02);
239 mad_write(MC9_PORT, 0x00);
241 if ((mad_read(MC0_PORT+13) & 0x80) == 0)
244 /* Power off, and on again */
245 mad_write(MC9_PORT, 0xc2);
246 mad_write(MC9_PORT, 0xc0);
248 if ((mad_read(MC0_PORT+13) & 0x80) == 0)
252 /* Force off PnP mode. This is not recommended because
253 * the PnP bios will not recognize the chip on the next
254 * warm boot and may assignd different resources to other
257 mad_write(MC0_PORT+17, 0x04);
262 static int __init detect_mad16(void)
264 unsigned char tmp, tmp2, bit;
268 * Check that reading a register doesn't return bus float (0xff)
269 * when the card is accessed using password. This may fail in case
270 * the card is in low power mode. Normally at least the power saving
271 * mode bit should be 0.
274 if ((tmp = mad_read(MC1_PORT)) == 0xff)
276 DDB(printk("MC1_PORT returned 0xff\n"));
279 for (i = 0xf8d; i <= 0xf98; i++)
281 DDB(printk("Port %0x (init value) = %0x\n", i, mad_read(i)));
283 DDB(printk("Port %0x (init value) = %0x\n", i-0x80, mad_read(i)));
285 if (board_type == C930)
286 return detect_c930();
289 * Now check that the gate is closed on first I/O after writing
290 * the password. (This is how a MAD16 compatible card works).
293 if ((tmp2 = inb(MC1_PORT)) == tmp) /* It didn't close */
295 DDB(printk("MC1_PORT didn't close after read (0x%02x)\n", tmp2));
299 bit = (c924pnp) ? 0x20 : 0x80;
300 port = (c924pnp) ? MC2_PORT : MC1_PORT;
302 tmp = mad_read(port);
303 mad_write(port, tmp ^ bit); /* Toggle a bit */
304 if ((tmp2 = mad_read(port)) != (tmp ^ bit)) /* Compare the bit */
306 mad_write(port, tmp); /* Restore */
307 DDB(printk("Bit revert test failed (0x%02x, 0x%02x)\n", tmp, tmp2));
310 mad_write(port, tmp); /* Restore */
311 return 1; /* Bingo */
314 static int __init wss_init(struct address_info *hw_config)
319 * Verify the WSS parameters
322 if (check_region(hw_config->io_base, 8))
324 printk(KERN_ERR "MSS: I/O port conflict\n");
327 if (!ad1848_detect(hw_config->io_base + 4, &ad_flags, mad16_osp))
330 * Check if the IO port returns valid signature. The original MS Sound
331 * system returns 0x04 while some cards (AudioTrix Pro for example)
335 if ((inb(hw_config->io_base + 3) & 0x3f) != 0x04 &&
336 (inb(hw_config->io_base + 3) & 0x3f) != 0x00)
338 DDB(printk("No MSS signature detected on port 0x%x (0x%x)\n", hw_config->io_base, inb(hw_config->io_base + 3)));
341 if (hw_config->irq > 11)
343 printk(KERN_ERR "MSS: Bad IRQ %d\n", hw_config->irq);
346 if (hw_config->dma != 0 && hw_config->dma != 1 && hw_config->dma != 3)
348 printk(KERN_ERR "MSS: Bad DMA %d\n", hw_config->dma);
352 * Check that DMA0 is not in use with a 8 bit board.
355 if (hw_config->dma == 0 && inb(hw_config->io_base + 3) & 0x80)
357 printk("MSS: Can't use DMA0 with a 8 bit card/slot\n");
360 if (hw_config->irq > 7 && hw_config->irq != 9 && inb(hw_config->io_base + 3) & 0x80)
361 printk(KERN_ERR "MSS: Can't use IRQ%d with a 8 bit card/slot\n", hw_config->irq);
365 static int __init init_c930(struct address_info *hw_config)
367 unsigned char cfg = 0;
369 cfg |= (0x0f & mad16_conf);
373 /* Bit 0 has reversd meaning. Bits 1 and 2 sese
375 Support only IDE cdrom. IDE port programmed
377 cfg = (cfg & 0x09) ^ 0x07;
380 switch (hw_config->io_base)
395 printk(KERN_ERR "MAD16: Invalid codec port %x\n", hw_config->io_base);
398 mad_write(MC1_PORT, cfg);
400 /* MC2 is CD configuration. Don't touch it. */
402 mad_write(MC3_PORT, 0); /* Disable SB mode IRQ and DMA */
404 /* bit 2 of MC4 reverses it's meaning between the C930
406 cfg = c931_detected ? 0x04 : 0x00;
408 if(mad16_cdsel & 0x20)
409 mad_write(MC4_PORT, 0x62|cfg); /* opl4 */
411 mad_write(MC4_PORT, 0x52|cfg); /* opl3 */
413 mad_write(MC5_PORT, 0x3C); /* Init it into mode2 */
414 mad_write(MC6_PORT, 0x02); /* Enable WSS, Disable MPU and SB */
415 mad_write(MC7_PORT, 0xCB);
416 mad_write(MC10_PORT, 0x11);
418 return wss_init(hw_config);
421 static int __init chip_detect(void)
426 * Then try to detect with the old password
430 DDB(printk("Detect using password = 0xE5\n"));
432 if (detect_mad16()) {
438 DDB(printk("Detect using password = 0xE2\n"));
444 if (((model = mad_read(MC3_PORT)) & 0x03) == 0x03) {
445 DDB(printk("mad16.c: Mozart detected\n"));
448 DDB(printk("mad16.c: 82C928 detected???\n"));
456 DDB(printk("Detect using password = 0xE3\n"));
460 DDB(printk("mad16.c: 82C929 detected\n"));
464 if (inb(PASSWD_REG) != 0xff)
468 * First relocate MC# registers to 0xe0e/0xe0f, disable password
471 outb((0xE4), PASSWD_REG);
472 outb((0x80), PASSWD_REG);
476 DDB(printk("Detect using password = 0xE4\n"));
478 for (i = 0xf8d; i <= 0xf93; i++)
479 DDB(printk("port %03x = %02x\n", i, mad_read(i)));
482 DDB(printk("mad16.c: 82C930 detected\n"));
486 /* The C931 has the password reg at F8D */
489 DDB(printk("Detect using password = 0xE4 for C931\n"));
491 if (detect_mad16()) {
497 DDB(printk("Detect using password = 0xE5 (again), port offset -0x80\n"));
498 if (detect_mad16()) {
499 DDB(printk("mad16.c: 82C924 PnP detected\n"));
508 static int __init probe_mad16(struct address_info *hw_config)
511 static int valid_ports[] =
513 0x530, 0xe80, 0xf40, 0x604
516 unsigned char cs4231_mode = 0;
520 if (already_initialized)
523 mad16_osp = hw_config->osp;
526 * Check that all ports return 0xff (bus float) when no password
527 * is written to the password register.
530 DDB(printk("--- Detecting MAD16 / Mozart ---\n"));
534 if (board_type == C930)
535 return init_c930(hw_config);
538 for (i = 0xf8d; i <= 0xf93; i++) {
540 DDB(printk("port %03x = %02x\n", i, mad_read(i)));
542 DDB(printk("port %03x = %02x\n", i-0x80, mad_read(i)));
546 * Set the WSS address
549 tmp = (mad_read(MC1_PORT) & 0x0f) | 0x80; /* Enable WSS, Disable SB */
551 for (i = 0; i < 5; i++)
553 if (i > 3) /* Not a valid port */
555 printk(KERN_ERR "MAD16/Mozart: Bad WSS base address 0x%x\n", hw_config->io_base);
558 if (valid_ports[i] == hw_config->io_base)
560 tmp |= i << 4; /* WSS port select bits */
566 * Set optional CD-ROM and joystick settings.
570 tmp |= (mad16_conf & 0x0f); /* CD-ROM and joystick bits */
571 mad_write(MC1_PORT, tmp);
574 mad_write(MC2_PORT, tmp);
575 mad_write(MC3_PORT, 0xf0); /* Disable SB */
577 if (board_type == C924) /* Specific C924 init values */
579 mad_write(MC4_PORT, 0xA0);
580 mad_write(MC5_PORT, 0x05);
581 mad_write(MC6_PORT, 0x03);
583 if (!ad1848_detect(hw_config->io_base + 4, &ad_flags, mad16_osp))
586 if (ad_flags & (AD_F_CS4231 | AD_F_CS4248))
587 cs4231_mode = 0x02; /* CS4248/CS4231 sync delay switch */
589 if (board_type == C929)
591 mad_write(MC4_PORT, 0xa2);
592 mad_write(MC5_PORT, 0xA5 | cs4231_mode);
593 mad_write(MC6_PORT, 0x03); /* Disable MPU401 */
597 mad_write(MC4_PORT, 0x02);
598 mad_write(MC5_PORT, 0x30 | cs4231_mode);
601 for (i = 0xf8d; i <= 0xf93; i++) {
603 DDB(printk("port %03x after init = %02x\n", i, mad_read(i)));
605 DDB(printk("port %03x after init = %02x\n", i-0x80, mad_read(i)));
612 static void __init attach_mad16(struct address_info *hw_config)
615 static signed char interrupt_bits[12] = {
616 -1, -1, -1, -1, -1, -1, -1, 0x08, -1, 0x10, 0x18, 0x20
620 static char dma_bits[4] = {
624 int config_port = hw_config->io_base + 0, version_port = hw_config->io_base + 3;
625 int ad_flags = 0, dma = hw_config->dma, dma2 = hw_config->dma2;
626 unsigned char dma2_bit = 0;
628 already_initialized = 1;
630 if (!ad1848_detect(hw_config->io_base + 4, &ad_flags, mad16_osp))
634 * Set the IRQ and DMA addresses.
637 if (board_type == C930 || c924pnp)
638 interrupt_bits[5] = 0x28; /* Also IRQ5 is possible on C930 */
640 bits = interrupt_bits[hw_config->irq];
644 outb((bits | 0x40), config_port);
645 if ((inb(version_port) & 0x40) == 0)
646 printk(KERN_ERR "[IRQ Conflict?]\n");
649 * Handle the capture DMA channel
652 if (ad_flags & AD_F_CS4231 && dma2 != -1 && dma2 != dma)
654 if (!((dma == 0 && dma2 == 1) ||
655 (dma == 1 && dma2 == 0) ||
656 (dma == 3 && dma2 == 0)))
657 { /* Unsupported combination. Try to swap channels */
663 if ((dma == 0 && dma2 == 1) || (dma == 1 && dma2 == 0) ||
664 (dma == 3 && dma2 == 0))
666 dma2_bit = 0x04; /* Enable capture DMA */
670 printk("MAD16: Invalid capture DMA\n");
676 outb((bits | dma_bits[dma] | dma2_bit), config_port); /* Write IRQ+DMA setup */
678 hw_config->slots[0] = ad1848_init("mad16 WSS", hw_config->io_base + 4,
684 request_region(hw_config->io_base, 4, "mad16 WSS config");
687 static int __init probe_mad16_mpu(struct address_info *hw_config)
689 static int mpu_attached;
692 if (!already_initialized) /* The MSS port must be initialized first */
695 if (mpu_attached) /* Don't let them call this twice */
699 if (board_type < C929) /* Early chip. No MPU support. Just SB MIDI */
702 #ifdef CONFIG_MAD16_OLDCARD
704 tmp = mad_read(MC3_PORT);
707 * MAD16 SB base is defined by the WSS base. It cannot be changed
709 * Ignore configured I/O base. Use the active setting.
712 if (mad_read(MC1_PORT) & 0x20)
713 hw_config->io_base = 0x240;
715 hw_config->io_base = 0x220;
717 switch (hw_config->irq)
720 tmp = (tmp & 0x3f) | 0x80;
726 tmp = (tmp & 0x3f) | 0x40;
729 printk(KERN_ERR "mad16/Mozart: Invalid MIDI IRQ\n");
733 mad_write(MC3_PORT, tmp | 0x04);
734 hw_config->driver_use_1 = SB_MIDI_ONLY;
735 if (!sb_dsp_detect(hw_config, 0, 0, NULL))
738 if (mad_read(MC1_PORT) & 0x20)
739 hw_config->io_base = 0x240;
741 hw_config->io_base = 0x220;
743 hw_config->name = "Mad16/Mozart";
744 sb_dsp_init(hw_config, THIS_MODULE);
747 /* assuming all later Mozart cards are identified as
748 * either 82C928 or Mozart. If so, following code attempts
749 * to set MPU register. TODO - add probing
752 tmp = mad_read(MC8_PORT);
754 switch (hw_config->irq)
772 printk(KERN_ERR "mad16/MOZART: invalid mpu_irq\n");
776 switch (hw_config->io_base)
791 printk(KERN_ERR "mad16/MOZART: invalid mpu_io\n");
795 mad_write(MC8_PORT, tmp); /* write MPU port parameters */
799 tmp = mad_read(MC6_PORT) & 0x83;
800 tmp |= 0x80; /* MPU-401 enable */
802 /* Set the MPU base bits */
804 switch (hw_config->io_base)
819 printk(KERN_ERR "MAD16: Invalid MIDI port 0x%x\n", hw_config->io_base);
823 /* Set the MPU IRQ bits */
825 switch (hw_config->irq)
840 printk(KERN_ERR "MAD16: Invalid MIDI IRQ %d\n", hw_config->irq);
844 mad_write(MC6_PORT, tmp); /* Write MPU401 config */
846 #ifndef CONFIG_MAD16_OLDCARD
849 hw_config->driver_use_1 = SB_MIDI_ONLY;
850 hw_config->name = "Mad16/Mozart";
851 return probe_uart401(hw_config, THIS_MODULE);
854 static void __exit unload_mad16(struct address_info *hw_config)
856 ad1848_unload(hw_config->io_base + 4,
860 release_region(hw_config->io_base, 4);
861 sound_unload_audiodev(hw_config->slots[0]);
864 static void __exit unload_mad16_mpu(struct address_info *hw_config)
866 #ifdef CONFIG_MAD16_OLDCARD
867 if (board_type < C929) /* Early chip. No MPU support. Just SB MIDI */
869 sb_dsp_unload(hw_config, 0);
874 unload_uart401(hw_config);
877 static struct address_info cfg;
878 static struct address_info cfg_mpu;
880 static int found_mpu;
882 static int __initdata mpu_io = 0;
883 static int __initdata mpu_irq = 0;
884 static int __initdata io = -1;
885 static int __initdata dma = -1;
886 static int __initdata dma16 = -1; /* Set this for modules that need it */
887 static int __initdata irq = -1;
888 static int __initdata cdtype = 0;
889 static int __initdata cdirq = 0;
890 static int __initdata cdport = 0x340;
891 static int __initdata cddma = -1;
892 static int __initdata opl4 = 0;
893 static int __initdata joystick = 0;
895 MODULE_PARM(mpu_io, "i");
896 MODULE_PARM(mpu_irq, "i");
898 MODULE_PARM(dma,"i");
899 MODULE_PARM(dma16,"i");
900 MODULE_PARM(irq,"i");
901 MODULE_PARM(cdtype,"i");
902 MODULE_PARM(cdirq,"i");
903 MODULE_PARM(cdport,"i");
904 MODULE_PARM(cddma,"i");
905 MODULE_PARM(opl4,"i");
906 MODULE_PARM(joystick,"i");
907 MODULE_PARM(debug,"i");
909 static int __initdata dma_map[2][8] =
911 {0x03, -1, -1, -1, -1, 0x00, 0x01, 0x02},
912 {0x03, -1, 0x01, 0x00, -1, -1, -1, -1}
915 static int __initdata irq_map[16] =
919 -1, 0x10, 0x14, 0x18,
923 static int __init init_mad16(void)
927 printk(KERN_INFO "MAD16 audio driver Copyright (C) by Hannu Savolainen 1993-1996\n");
929 printk(KERN_INFO "CDROM ");
937 printk("Sony CDU31A");
939 if(cddma == -1) cddma = 3;
944 if(cddma == -1) cddma = 5;
947 printk("Panasonic Lasermate");
949 if(cddma == -1) cddma = 3;
952 printk("Secondary IDE");
954 if(cddma == -1) cddma = 5;
957 printk("Primary IDE");
959 if(cddma == -1) cddma = 5;
963 printk(KERN_ERR "Invalid CDROM type\n");
968 * Build the config words
971 mad16_conf = (joystick ^ 1) | cdtype;
977 if (cddma > 7 || cddma < 0 || dma_map[dmatype][cddma] == -1)
980 printk(KERN_ERR "Invalid CDROM DMA\n");
984 printk(", DMA %d", cddma);
990 else if (cdirq < 0 || cdirq > 15 || irq_map[cdirq] == -1)
992 printk(", invalid IRQ (disabling)");
995 else printk(", IRQ %d", cdirq);
997 mad16_cdsel |= dma_map[dmatype][cddma];
1004 mad16_cdsel |= 0x00;
1007 mad16_cdsel |= 0x40;
1010 mad16_cdsel |= 0x80;
1013 mad16_cdsel |= 0xC0;
1016 printk(KERN_ERR "Unknown CDROM I/O base %d\n", cdport);
1020 mad16_cdsel |= irq_map[cdirq];
1030 if (cfg.io_base == -1 || cfg.dma == -1 || cfg.irq == -1) {
1031 printk(KERN_ERR "I/O, DMA and irq are mandatory\n");
1035 if (!probe_mad16(&cfg))
1038 cfg_mpu.io_base = mpu_io;
1039 cfg_mpu.irq = mpu_irq;
1043 found_mpu = probe_mad16_mpu(&cfg_mpu);
1045 if (joystick == 1) {
1046 /* register gameport */
1047 if (!request_region(0x201, 1, "mad16 gameport"))
1048 printk(KERN_ERR "mad16: gameport address 0x201 already in use\n");
1050 printk(KERN_ERR "mad16: gameport enabled at 0x201\n");
1051 gameport.io = 0x201;
1052 gameport_register_port(&gameport);
1055 else printk(KERN_ERR "mad16: gameport disabled.\n");
1059 static void __exit cleanup_mad16(void)
1062 unload_mad16_mpu(&cfg_mpu);
1064 /* the gameport was initialized so we must free it up */
1065 gameport_unregister_port(&gameport);
1067 release_region(0x201, 1);
1072 module_init(init_mad16);
1073 module_exit(cleanup_mad16);
1076 static int __init setup_mad16(char *str)
1081 str = get_options(str, ARRAY_SIZE(ints), ints);
1094 __setup("mad16=", setup_mad16);
1096 MODULE_LICENSE("GPL");