4 * Low level driver for Ensoniq SoundScape
7 * Copyright (C) by Hannu Savolainen 1993-1997
9 * OSS/Free for Linux is distributed under the GNU GENERAL PUBLIC LICENSE (GPL)
10 * Version 2 (June 1991). See the "COPYING" file distributed with this software
14 * Thomas Sailer : ioctl code reworked (vmalloc/vfree removed)
15 * Sergey Smitienko : ensoniq p'n'p support
16 * Christoph Hellwig : adapted to module_init/module_exit
17 * Bartlomiej Zolnierkiewicz : added __init to attach_sscape()
18 * Chris Rankin : Specify that this module owns the coprocessor
19 * Arnaldo C. de Melo : added missing restore_flags in sscape_pnp_upload_file
22 #include <linux/init.h>
23 #include <linux/module.h>
25 #include "sound_config.h"
26 #include "sound_firmware.h"
28 #include <linux/types.h>
29 #include <linux/errno.h>
30 #include <linux/signal.h>
31 #include <linux/fcntl.h>
32 #include <linux/ctype.h>
33 #include <linux/stddef.h>
34 #include <linux/kmod.h>
37 #include <linux/wait.h>
38 #include <linux/slab.h>
39 #include <linux/ioport.h>
40 #include <linux/delay.h>
41 #include <linux/proc_fs.h>
42 #include <linux/spinlock.h>
65 #define GA_INTSTAT_REG 0
66 #define GA_INTENA_REG 1
69 #define GA_INTCFG_REG 4
70 #define GA_DMACFG_REG 5
71 #define GA_CDCFG_REG 6
72 #define GA_SMCFGA_REG 7
73 #define GA_SMCFGB_REG 8
74 #define GA_HMCTL_REG 9
77 * DMA channel identifiers (A and B)
80 #define SSCAPE_DMA_A 0
81 #define SSCAPE_DMA_B 1
83 #define PORT(name) (devc->base+name)
86 * Host commands recognized by the OBP microcode
89 #define CMD_GEN_HOST_ACK 0x80
90 #define CMD_GEN_MPU_ACK 0x81
91 #define CMD_GET_BOARD_TYPE 0x82
92 #define CMD_SET_CONTROL 0x88 /* Old firmware only */
93 #define CMD_GET_CONTROL 0x89 /* Old firmware only */
94 #define CTL_MASTER_VOL 0
95 #define CTL_MIC_MODE 2
96 #define CTL_SYNTH_VOL 4
97 #define CTL_WAVE_VOL 7
98 #define CMD_SET_EXTMIDI 0x8a
99 #define CMD_GET_EXTMIDI 0x8b
100 #define CMD_SET_MT32 0x8c
101 #define CMD_GET_MT32 0x8d
108 typedef struct sscape_info
112 int codec, codec_irq; /* required to setup pnp cards*/
116 unsigned long raw_buf_phys;
117 int buffsize; /* -------------------------- */
119 int ok; /* Properly detected */
128 static struct sscape_info adev_info = {
132 static struct sscape_info *devc = &adev_info;
133 static int sscape_mididev = -1;
135 /* Some older cards have assigned interrupt bits differently than new ones */
136 static char valid_interrupts_old[] = {
140 static char valid_interrupts_new[] = {
144 static char *valid_interrupts = valid_interrupts_new;
147 * See the bottom of the driver. This can be set by spea =0/1.
151 static char old_hardware = 1;
153 static char old_hardware;
156 static void sleep(unsigned howlong)
158 current->state = TASK_INTERRUPTIBLE;
159 schedule_timeout(howlong);
162 static unsigned char sscape_read(struct sscape_info *devc, int reg)
167 spin_lock_irqsave(&devc->lock,flags);
168 outb(reg, PORT(ODIE_ADDR));
169 val = inb(PORT(ODIE_DATA));
170 spin_unlock_irqrestore(&devc->lock,flags);
174 static void sscape_write(struct sscape_info *devc, int reg, int data)
178 spin_lock_irqsave(&devc->lock,flags);
179 outb(reg, PORT(ODIE_ADDR));
180 outb(data, PORT(ODIE_DATA));
181 spin_unlock_irqrestore(&devc->lock,flags);
184 static unsigned char sscape_pnp_read_codec(sscape_info* devc, unsigned char reg)
189 spin_lock_irqsave(&devc->lock,flags);
190 outb( reg, devc -> codec);
191 res = inb (devc -> codec + 1);
192 spin_unlock_irqrestore(&devc->lock,flags);
197 static void sscape_pnp_write_codec(sscape_info* devc, unsigned char reg, unsigned char data)
201 spin_lock_irqsave(&devc->lock,flags);
202 outb( reg, devc -> codec);
203 outb( data, devc -> codec + 1);
204 spin_unlock_irqrestore(&devc->lock,flags);
207 static void host_open(struct sscape_info *devc)
209 outb((0x00), PORT(HOST_CTRL)); /* Put the board to the host mode */
212 static void host_close(struct sscape_info *devc)
214 outb((0x03), PORT(HOST_CTRL)); /* Put the board to the MIDI mode */
217 static int host_write(struct sscape_info *devc, unsigned char *data, int count)
222 spin_lock_irqsave(&devc->lock,flags);
224 * Send the command and data bytes
227 for (i = 0; i < count; i++)
229 for (timeout_val = 10000; timeout_val > 0; timeout_val--)
230 if (inb(PORT(HOST_CTRL)) & TX_READY)
233 if (timeout_val <= 0)
235 spin_unlock_irqrestore(&devc->lock,flags);
238 outb(data[i], PORT(HOST_DATA));
240 spin_unlock_irqrestore(&devc->lock,flags);
244 static int host_read(struct sscape_info *devc)
250 spin_lock_irqsave(&devc->lock,flags);
255 for (timeout_val = 10000; timeout_val > 0; timeout_val--)
256 if (inb(PORT(HOST_CTRL)) & RX_READY)
259 if (timeout_val <= 0)
261 spin_unlock_irqrestore(&devc->lock,flags);
264 data = inb(PORT(HOST_DATA));
265 spin_unlock_irqrestore(&devc->lock,flags);
270 static int host_command1(struct sscape_info *devc, int cmd)
272 unsigned char buf[10];
273 buf[0] = (unsigned char) (cmd & 0xff);
274 return host_write(devc, buf, 1);
279 static int host_command2(struct sscape_info *devc, int cmd, int parm1)
281 unsigned char buf[10];
283 buf[0] = (unsigned char) (cmd & 0xff);
284 buf[1] = (unsigned char) (parm1 & 0xff);
286 return host_write(devc, buf, 2);
289 static int host_command3(struct sscape_info *devc, int cmd, int parm1, int parm2)
291 unsigned char buf[10];
293 buf[0] = (unsigned char) (cmd & 0xff);
294 buf[1] = (unsigned char) (parm1 & 0xff);
295 buf[2] = (unsigned char) (parm2 & 0xff);
296 return host_write(devc, buf, 3);
299 static void set_mt32(struct sscape_info *devc, int value)
302 host_command2(devc, CMD_SET_MT32, value ? 1 : 0);
303 if (host_read(devc) != CMD_ACK)
305 /* printk( "SNDSCAPE: Setting MT32 mode failed\n"); */
310 static void set_control(struct sscape_info *devc, int ctrl, int value)
313 host_command3(devc, CMD_SET_CONTROL, ctrl, value);
314 if (host_read(devc) != CMD_ACK)
316 /* printk( "SNDSCAPE: Setting control (%d) failed\n", ctrl); */
321 static void do_dma(struct sscape_info *devc, int dma_chan, unsigned long buf, int blk_size, int mode)
325 if (dma_chan != SSCAPE_DMA_A)
327 printk(KERN_WARNING "soundscape: Tried to use DMA channel != A. Why?\n");
330 audio_devs[devc->codec_audiodev]->flags &= ~DMA_AUTOMODE;
331 DMAbuf_start_dma(devc->codec_audiodev, buf, blk_size, mode);
332 audio_devs[devc->codec_audiodev]->flags |= DMA_AUTOMODE;
334 temp = devc->dma << 4; /* Setup DMA channel select bits */
336 temp |= 0x80; /* 8 bit DMA channel */
338 temp |= 1; /* Trigger DMA */
339 sscape_write(devc, GA_DMAA_REG, temp);
340 temp &= 0xfe; /* Clear DMA trigger */
341 sscape_write(devc, GA_DMAA_REG, temp);
344 static int verify_mpu(struct sscape_info *devc)
347 * The SoundScape board could be in three modes (MPU, 8250 and host).
348 * If the card is not in the MPU mode, enabling the MPU driver will
349 * cause infinite loop (the driver believes that there is always some
350 * received data in the buffer.
352 * Detect this by looking if there are more than 10 received MIDI bytes
353 * (0x00) in the buffer.
358 for (i = 0; i < 10; i++)
360 if (inb(devc->base + HOST_CTRL) & 0x80)
363 if (inb(devc->base) != 0x00)
366 printk(KERN_WARNING "SoundScape: The device is not in the MPU-401 mode\n");
370 static int sscape_coproc_open(void *dev_info, int sub_device)
372 if (sub_device == COPR_MIDI)
375 if (!verify_mpu(devc))
381 static void sscape_coproc_close(void *dev_info, int sub_device)
383 struct sscape_info *devc = dev_info;
386 spin_lock_irqsave(&devc->lock,flags);
387 if (devc->dma_allocated)
389 sscape_write(devc, GA_DMAA_REG, 0x20); /* DMA channel disabled */
390 devc->dma_allocated = 0;
392 spin_unlock_irqrestore(&devc->lock,flags);
396 static void sscape_coproc_reset(void *dev_info)
400 static int sscape_download_boot(struct sscape_info *devc, unsigned char *block, int size, int flag)
404 volatile int done, timeout_val;
405 static unsigned char codec_dma_bits;
407 if (flag & CPF_FIRST)
410 * First block. Have to allocate DMA and to reset the board
414 spin_lock_irqsave(&devc->lock,flags);
415 codec_dma_bits = sscape_read(devc, GA_CDCFG_REG);
417 if (devc->dma_allocated == 0)
418 devc->dma_allocated = 1;
420 spin_unlock_irqrestore(&devc->lock,flags);
422 sscape_write(devc, GA_HMCTL_REG,
423 (temp = sscape_read(devc, GA_HMCTL_REG)) & 0x3f); /*Reset */
425 for (timeout_val = 10000; timeout_val > 0; timeout_val--)
426 sscape_read(devc, GA_HMCTL_REG); /* Delay */
428 /* Take board out of reset */
429 sscape_write(devc, GA_HMCTL_REG,
430 (temp = sscape_read(devc, GA_HMCTL_REG)) | 0x80);
433 * Transfer one code block using DMA
435 if (audio_devs[devc->codec_audiodev]->dmap_out->raw_buf == NULL)
437 printk(KERN_WARNING "soundscape: DMA buffer not available\n");
440 memcpy(audio_devs[devc->codec_audiodev]->dmap_out->raw_buf, block, size);
442 spin_lock_irqsave(&devc->lock,flags);
444 /******** INTERRUPTS DISABLED NOW ********/
446 do_dma(devc, SSCAPE_DMA_A,
447 audio_devs[devc->codec_audiodev]->dmap_out->raw_buf_phys,
448 size, DMA_MODE_WRITE);
451 * Wait until transfer completes.
456 while (!done && timeout_val-- > 0)
462 clear_dma_ff(devc->dma);
463 if ((resid = get_dma_residue(devc->dma)) == 0)
467 spin_unlock_irqrestore(&devc->lock,flags);
474 * Take the board out of reset
476 outb((0x00), PORT(HOST_CTRL));
477 outb((0x00), PORT(MIDI_CTRL));
479 temp = sscape_read(devc, GA_HMCTL_REG);
481 sscape_write(devc, GA_HMCTL_REG, temp); /* Kickstart the board */
484 * Wait until the ODB wakes up
486 spin_lock_irqsave(&devc->lock,flags);
488 timeout_val = 5 * HZ;
489 while (!done && timeout_val-- > 0)
494 x = inb(PORT(HOST_DATA));
495 if (x == 0xff || x == 0xfe) /* OBP startup acknowledge */
497 DDB(printk("Soundscape: Acknowledge = %x\n", x));
501 sscape_write(devc, GA_CDCFG_REG, codec_dma_bits);
503 spin_unlock_irqrestore(&devc->lock,flags);
506 printk(KERN_ERR "soundscape: The OBP didn't respond after code download\n");
509 spin_lock_irqsave(&devc->lock,flags);
511 timeout_val = 5 * HZ;
512 while (!done && timeout_val-- > 0)
515 if (inb(PORT(HOST_DATA)) == 0xfe) /* Host startup acknowledge */
518 spin_unlock_irqrestore(&devc->lock,flags);
521 printk(KERN_ERR "soundscape: OBP Initialization failed.\n");
524 printk(KERN_INFO "SoundScape board initialized OK\n");
525 set_control(devc, CTL_MASTER_VOL, 100);
526 set_control(devc, CTL_SYNTH_VOL, 100);
530 * Temporary debugging aid. Print contents of the registers after
531 * downloading the code.
536 for (i = 0; i < 13; i++)
537 printk("I%d = %02x (new value)\n", i, sscape_read(devc, i));
545 static int download_boot_block(void *dev_info, copr_buffer * buf)
547 if (buf->len <= 0 || buf->len > sizeof(buf->data))
550 if (!sscape_download_boot(devc, buf->data, buf->len, buf->flags))
552 printk(KERN_ERR "soundscape: Unable to load microcode block to the OBP.\n");
558 static int sscape_coproc_ioctl(void *dev_info, unsigned int cmd, caddr_t arg, int local)
565 case SNDCTL_COPR_RESET:
566 sscape_coproc_reset(dev_info);
569 case SNDCTL_COPR_LOAD:
570 buf = (copr_buffer *) vmalloc(sizeof(copr_buffer));
573 if (copy_from_user(buf, arg, sizeof(copr_buffer)))
578 err = download_boot_block(dev_info, buf);
587 static coproc_operations sscape_coproc_operations =
598 static int sscape_detected;
599 static int sscape_is_pnp;
601 void __init attach_sscape(struct address_info *hw_config)
605 * Config register values for Spea/V7 Media FX and Ensoniq S-2000.
606 * These values are card
607 * dependent. If you have another SoundScape based card, you have to
608 * find the correct values. Do the following:
609 * - Compile this driver with SSCAPE_DEBUG1 defined.
610 * - Shut down and power off your machine.
611 * - Boot with DOS so that the SSINIT.EXE program is run.
612 * - Warm boot to {Linux|SYSV|BSD} and write down the lines displayed
613 * when detecting the SoundScape.
614 * - Modify the following list to use the values printed during boot.
615 * Undefine the SSCAPE_DEBUG1
617 #define SSCAPE_REGS { \
619 /* I1 */ 0xf0, /* Note! Ignored. Set always to 0xf0 */ \
620 /* I2 */ 0x20, /* Note! Ignored. Set always to 0x20 */ \
621 /* I3 */ 0x20, /* Note! Ignored. Set always to 0x20 */ \
622 /* I4 */ 0xf5, /* Ignored */ \
625 /* I7 */ 0x2e, /* I7 MEM config A. Likely to vary between models */ \
626 /* I8 */ 0x00, /* I8 MEM config B. Likely to vary between models */ \
627 /* I9 */ 0x40 /* Ignored */ \
632 static unsigned char regs[10] = SSCAPE_REGS;
634 int i, irq_bits = 0xff;
636 if (sscape_detected != hw_config->io_base)
639 request_region(devc->base + 2, 6, "SoundScape");
642 valid_interrupts = valid_interrupts_old;
643 conf_printf("Ensoniq SoundScape (old)", hw_config);
646 conf_printf("Ensoniq SoundScape", hw_config);
648 for (i = 0; i < sizeof(valid_interrupts); i++)
650 if (hw_config->irq == valid_interrupts[i])
656 if (hw_config->irq > 15 || (regs[4] = irq_bits == 0xff))
658 printk(KERN_ERR "Invalid IRQ%d\n", hw_config->irq);
662 if (!sscape_is_pnp) {
664 spin_lock_irqsave(&devc->lock,flags);
665 for (i = 1; i < 10; i++)
669 case 1: /* Host interrupt enable */
670 sscape_write(devc, i, 0xf0); /* All interrupts enabled */
673 case 2: /* DMA A status/trigger register */
674 case 3: /* DMA B status/trigger register */
675 sscape_write(devc, i, 0x20); /* DMA channel disabled */
678 case 4: /* Host interrupt config reg */
679 sscape_write(devc, i, 0xf0 | (irq_bits << 2) | irq_bits);
682 case 5: /* Don't destroy CD-ROM DMA config bits (0xc0) */
683 sscape_write(devc, i, (regs[i] & 0x3f) | (sscape_read(devc, i) & 0xc0));
686 case 6: /* CD-ROM config (WSS codec actually) */
687 sscape_write(devc, i, regs[i]);
690 case 9: /* Master control reg. Don't modify CR-ROM bits. Disable SB emul */
691 sscape_write(devc, i, (sscape_read(devc, i) & 0xf0) | 0x08);
695 sscape_write(devc, i, regs[i]);
698 spin_unlock_irqrestore(&devc->lock,flags);
702 * Temporary debugging aid. Print contents of the registers after
708 for (i = 0; i < 13; i++)
709 printk("I%d = %02x (new value)\n", i, sscape_read(devc, i));
713 if (probe_mpu401(hw_config))
714 hw_config->always_detect = 1;
715 hw_config->name = "SoundScape";
717 hw_config->irq *= -1; /* Negative value signals IRQ sharing */
718 attach_mpu401(hw_config, THIS_MODULE);
719 hw_config->irq *= -1; /* Restore it */
721 if (hw_config->slots[1] != -1) /* The MPU driver installed itself */
723 sscape_mididev = hw_config->slots[1];
724 midi_devs[hw_config->slots[1]]->coproc = &sscape_coproc_operations;
726 sscape_write(devc, GA_INTENA_REG, 0x80); /* Master IRQ enable */
731 static int detect_ga(sscape_info * devc)
735 DDB(printk("Entered Soundscape detect_ga(%x)\n", devc->base));
737 if (check_region(devc->base, 8))
741 * First check that the address register of "ODIE" is
742 * there and that it has exactly 4 writable bits.
746 if ((save = inb(PORT(ODIE_ADDR))) & 0xf0)
748 DDB(printk("soundscape: Detect error A\n"));
751 outb((0x00), PORT(ODIE_ADDR));
752 if (inb(PORT(ODIE_ADDR)) != 0x00)
754 DDB(printk("soundscape: Detect error B\n"));
757 outb((0xff), PORT(ODIE_ADDR));
758 if (inb(PORT(ODIE_ADDR)) != 0x0f)
760 DDB(printk("soundscape: Detect error C\n"));
763 outb((save), PORT(ODIE_ADDR));
766 * Now verify that some indirect registers return zero on some bits.
767 * This may break the driver with some future revisions of "ODIE" but...
770 if (sscape_read(devc, 0) & 0x0c)
772 DDB(printk("soundscape: Detect error D (%x)\n", sscape_read(devc, 0)));
775 if (sscape_read(devc, 1) & 0x0f)
777 DDB(printk("soundscape: Detect error E\n"));
780 if (sscape_read(devc, 5) & 0x0f)
782 DDB(printk("soundscape: Detect error F\n"));
788 static int sscape_read_host_ctrl(sscape_info* devc)
790 return host_read(devc);
793 static void sscape_write_host_ctrl2(sscape_info *devc, int a, int b)
795 host_command2(devc, a, b);
798 static int sscape_alloc_dma(sscape_info *devc)
800 char *start_addr, *end_addr;
805 if (devc->raw_buf != NULL) return 0; /* Already done */
806 dma_pagesize = (devc->dma < 4) ? (64 * 1024) : (128 * 1024);
807 devc->raw_buf = NULL;
808 devc->buffsize = 8192*4;
809 if (devc->buffsize > dma_pagesize) devc->buffsize = dma_pagesize;
812 * Now loop until we get a free buffer. Try to get smaller buffer if
813 * it fails. Don't accept smaller than 8k buffer for performance
816 while (start_addr == NULL && devc->buffsize > PAGE_SIZE) {
817 for (sz = 0, size = PAGE_SIZE; size < devc->buffsize; sz++, size <<= 1);
818 devc->buffsize = PAGE_SIZE * (1 << sz);
819 start_addr = (char *) __get_free_pages(GFP_ATOMIC|GFP_DMA, sz);
820 if (start_addr == NULL) devc->buffsize /= 2;
823 if (start_addr == NULL) {
824 printk(KERN_ERR "sscape pnp init error: Couldn't allocate DMA buffer\n");
827 /* make some checks */
828 end_addr = start_addr + devc->buffsize - 1;
829 /* now check if it fits into the same dma-pagesize */
831 if (((long) start_addr & ~(dma_pagesize - 1)) != ((long) end_addr & ~(dma_pagesize - 1))
832 || end_addr >= (char *) (MAX_DMA_ADDRESS)) {
833 printk(KERN_ERR "sscape pnp: Got invalid address 0x%lx for %db DMA-buffer\n", (long) start_addr, devc->buffsize);
837 devc->raw_buf = start_addr;
838 devc->raw_buf_phys = virt_to_bus(start_addr);
840 for (page = virt_to_page(start_addr); page <= virt_to_page(end_addr); page++)
841 SetPageReserved(page);
845 static void sscape_free_dma(sscape_info *devc)
848 unsigned long start_addr, end_addr;
851 if (devc->raw_buf == NULL) return;
852 for (sz = 0, size = PAGE_SIZE; size < devc->buffsize; sz++, size <<= 1);
853 start_addr = (unsigned long) devc->raw_buf;
854 end_addr = start_addr + devc->buffsize;
856 for (page = virt_to_page(start_addr); page <= virt_to_page(end_addr); page++)
857 ClearPageReserved(page);
859 free_pages((unsigned long) devc->raw_buf, sz);
860 devc->raw_buf = NULL;
863 /* Intel version !!!!!!!!! */
865 static int sscape_start_dma(int chan, unsigned long physaddr, int count, int dma_mode)
869 flags = claim_dma_lock();
872 set_dma_mode(chan, dma_mode);
873 set_dma_addr(chan, physaddr);
874 set_dma_count(chan, count);
876 release_dma_lock(flags);
880 static void sscape_pnp_start_dma(sscape_info* devc, int arg )
883 if (arg == 0) reg = 2;
886 sscape_write(devc, reg, sscape_read( devc, reg) | 0x01);
887 sscape_write(devc, reg, sscape_read( devc, reg) & 0xFE);
890 static int sscape_pnp_wait_dma (sscape_info* devc, int arg )
896 if (arg == 0) reg = 2;
902 d = sscape_read(devc, reg) & 1;
905 } while (i < 500000);
906 d = sscape_read(devc, reg) & 1;
910 static int sscape_pnp_alloc_dma(sscape_info* devc)
912 /* printk(KERN_INFO "sscape: requesting dma\n"); */
913 if (request_dma(devc -> dma, "sscape")) return 0;
914 /* printk(KERN_INFO "sscape: dma channel allocated\n"); */
915 if (!sscape_alloc_dma(devc)) {
916 free_dma(devc -> dma);
922 static void sscape_pnp_free_dma(sscape_info* devc)
924 sscape_free_dma( devc);
925 free_dma(devc -> dma );
926 /* printk(KERN_INFO "sscape: dma released\n"); */
929 static int sscape_pnp_upload_file(sscape_info* devc, char* fn)
937 sscape_write( devc, 9, sscape_read(devc, 9 ) & 0x3F );
938 sscape_write( devc, 2, (devc -> dma << 4) | 0x80 );
939 sscape_write( devc, 3, 0x20 );
940 sscape_write( devc, 9, sscape_read( devc, 9 ) | 0x80 );
942 len = mod_firmware_load(fn, &data);
944 printk(KERN_ERR "sscape: file not found: %s\n", fn);
948 spin_lock_irqsave(&devc->lock,flags);
950 if (len > devc -> buffsize) l = devc->buffsize;
953 memcpy(devc->raw_buf, dt, l); dt += l;
954 sscape_start_dma(devc->dma, devc->raw_buf_phys, l, 0x48);
955 sscape_pnp_start_dma ( devc, 0 );
956 if (sscape_pnp_wait_dma ( devc, 0 ) == 0) {
957 spin_unlock_irqrestore(&devc->lock,flags);
962 spin_unlock_irqrestore(&devc->lock,flags);
965 outb(0, devc -> base + 2);
966 outb(0, devc -> base);
968 sscape_write ( devc, 9, sscape_read( devc, 9 ) | 0x40);
970 timeout_val = 5 * HZ;
971 while (!done && timeout_val-- > 0)
975 x = inb( devc -> base + 3);
976 if (x == 0xff || x == 0xfe) /* OBP startup acknowledge */
978 //printk(KERN_ERR "Soundscape: Acknowledge = %x\n", x);
982 timeout_val = 5 * HZ;
984 while (!done && timeout_val-- > 0)
988 x = inb( devc -> base + 3);
989 if (x == 0xfe) /* OBP startup acknowledge */
991 //printk(KERN_ERR "Soundscape: Acknowledge = %x\n", x);
996 if ( !done ) printk(KERN_ERR "soundscape: OBP Initialization failed.\n");
998 sscape_write( devc, 2, devc->ic_type == IC_ODIE ? 0x70 : 0x40);
999 sscape_write( devc, 3, (devc -> dma << 4) + 0x80);
1003 static void __init sscape_pnp_init_hw(sscape_info* devc)
1005 unsigned char midi_irq = 0, sb_irq = 0;
1007 static char code_file_name[23] = "/sndscape/sndscape.cox";
1009 int sscape_sb_enable = 0;
1010 int sscape_joystic_enable = 0x7f;
1011 int sscape_mic_enable = 0;
1012 int sscape_ext_midi = 0;
1014 if ( !sscape_pnp_alloc_dma(devc) ) {
1015 printk(KERN_ERR "sscape: faild to allocate dma\n");
1019 for (i = 0; i < 4; i++) {
1020 if ( devc -> irq == valid_interrupts[i] )
1022 if ( devc -> codec_irq == valid_interrupts[i] )
1026 sscape_write( devc, 5, 0x50);
1027 sscape_write( devc, 7, 0x2e);
1028 sscape_write( devc, 8, 0x00);
1030 sscape_write( devc, 2, devc->ic_type == IC_ODIE ? 0x70 : 0x40);
1031 sscape_write( devc, 3, ( devc -> dma << 4) | 0x80);
1033 if ( sscape_sb_enable )
1034 sscape_write (devc, 4, 0xF0 | (sb_irq << 2) | midi_irq);
1036 sscape_write (devc, 4, 0xF0 | (midi_irq<<2) | midi_irq);
1038 i = 0x10; //sscape_read(devc, 9) & (devc->ic_type == IC_ODIE ? 0xf0 : 0xc0);
1039 if ( sscape_sb_enable )
1040 i |= devc->ic_type == IC_ODIE ? 0x05 : 0x07;
1041 if (sscape_joystic_enable) i |= 8;
1043 sscape_write (devc, 9, i);
1044 sscape_write (devc, 6, 0x80);
1045 sscape_write (devc, 1, 0x80);
1047 if (devc -> codec_type == 2) {
1048 sscape_pnp_write_codec( devc, 0x0C, 0x50);
1049 sscape_pnp_write_codec( devc, 0x10, sscape_pnp_read_codec( devc, 0x10) & 0x3F);
1050 sscape_pnp_write_codec( devc, 0x11, sscape_pnp_read_codec( devc, 0x11) | 0xC0);
1051 sscape_pnp_write_codec( devc, 29, 0x20);
1054 if (sscape_pnp_upload_file(devc, "/sndscape/scope.cod") == 0 ) {
1055 printk(KERN_ERR "sscape: faild to upload file /sndscape/scope.cod\n");
1056 sscape_pnp_free_dma(devc);
1060 i = sscape_read_host_ctrl( devc );
1062 if ( (i & 0x0F) > 7 ) {
1063 printk(KERN_ERR "sscape: scope.cod faild\n");
1064 sscape_pnp_free_dma(devc);
1067 if ( i & 0x10 ) sscape_write( devc, 7, 0x2F);
1068 code_file_name[21] = (char) ( i & 0x0F) + 0x30;
1069 if (sscape_pnp_upload_file( devc, code_file_name) == 0) {
1070 printk(KERN_ERR "sscape: faild to upload file %s\n", code_file_name);
1071 sscape_pnp_free_dma(devc);
1075 if (devc->ic_type != IC_ODIE) {
1076 sscape_pnp_write_codec( devc, 10, (sscape_pnp_read_codec(devc, 10) & 0x7f) |
1077 ( sscape_mic_enable == 0 ? 0x00 : 0x80) );
1079 sscape_write_host_ctrl2( devc, 0x84, 0x64 ); /* MIDI volume */
1080 sscape_write_host_ctrl2( devc, 0x86, 0x64 ); /* MIDI volume?? */
1081 sscape_write_host_ctrl2( devc, 0x8A, sscape_ext_midi);
1083 sscape_pnp_write_codec ( devc, 6, 0x3f ); //WAV_VOL
1084 sscape_pnp_write_codec ( devc, 7, 0x3f ); //WAV_VOL
1085 sscape_pnp_write_codec ( devc, 2, 0x1F ); //WD_CDXVOLL
1086 sscape_pnp_write_codec ( devc, 3, 0x1F ); //WD_CDXVOLR
1088 if (devc -> codec_type == 1) {
1089 sscape_pnp_write_codec ( devc, 4, 0x1F );
1090 sscape_pnp_write_codec ( devc, 5, 0x1F );
1091 sscape_write_host_ctrl2( devc, 0x88, sscape_mic_enable);
1094 sscape_pnp_write_codec ( devc, 0x10, 0x1F << 1);
1095 sscape_pnp_write_codec ( devc, 0x11, 0xC0 | (0x1F << 1));
1097 t = sscape_pnp_read_codec( devc, 0x00) & 0xDF;
1098 if ( (sscape_mic_enable == 0)) t |= 0;
1100 sscape_pnp_write_codec ( devc, 0x00, t);
1101 t = sscape_pnp_read_codec( devc, 0x01) & 0xDF;
1102 if ( (sscape_mic_enable == 0) ) t |= 0;
1104 sscape_pnp_write_codec ( devc, 0x01, t);
1105 sscape_pnp_write_codec ( devc, 0x40 | 29 , 0x20);
1106 outb(0, devc -> codec);
1108 if (devc -> ic_type == IC_OPUS ) {
1109 int i = sscape_read( devc, 9 );
1110 sscape_write( devc, 9, i | 3 );
1111 sscape_write( devc, 3, 0x40);
1113 if (check_region(0x228, 1)) {
1115 release_region(0x228,1);
1117 sscape_write( devc, 3, (devc -> dma << 4) | 0x80);
1118 sscape_write( devc, 9, i );
1121 host_close ( devc );
1122 sscape_pnp_free_dma(devc);
1125 static int __init detect_sscape_pnp(sscape_info* devc)
1127 long i, irq_bits = 0xff;
1130 DDB(printk("Entered detect_sscape_pnp(%x)\n", devc->base));
1132 if (check_region(devc->base, 8)) {
1133 printk(KERN_ERR "detect_sscape_pnp: port %x is not free\n", devc->base);
1137 if (check_region(devc->codec, 2)) {
1138 printk(KERN_ERR "detect_sscape_pnp: port %x is not free\n", devc->codec);
1142 if ( (inb( devc -> base + 2) & 0x78) != 0) return 0;
1144 d = inb ( devc -> base + 4) & 0xF0;
1145 if ( (d & 0x80) != 0) return 0;
1148 devc->codec_type = 1;
1149 devc->ic_type = IC_ODIE;
1151 else if ( (d & 0x60) != 0) {
1152 devc->codec_type = 2;
1153 devc->ic_type = IC_OPUS;
1155 else if ( (d & 0x40) != 0) {
1156 devc->codec_type = 2;
1157 devc->ic_type = IC_ODIE;
1163 outb(0xFA, devc -> base+4);
1164 if ((inb( devc -> base+4) & 0x9F) != 0x0A)
1166 outb(0xFE, devc -> base+4);
1167 if ( (inb(devc -> base+4) & 0x9F) != 0x0E)
1169 if ( (inb(devc -> base+5) & 0x9F) != 0x0E)
1172 if (devc->codec_type == 2) {
1173 if (devc -> codec != devc -> base + 8)
1174 printk("soundscape warning: incorrect codec port specified\n");
1175 devc -> codec = devc -> base + 8;
1176 d = 0x10 | (sscape_read(devc, 9) & 0xCF);
1177 sscape_write(devc, 9, d);
1178 sscape_write(devc, 6, 0x80);
1180 //todo: check codec is not base + 8
1183 d = (sscape_read(devc, 9) & 0x3F) | 0xC0;
1184 sscape_write(devc, 9, d);
1186 for (i = 0; i < 550000; i++)
1187 if ( !(inb(devc -> codec) & 0x80) ) break;
1189 d = inb(devc -> codec);
1192 if ( inb(devc -> codec + 2) == 0xFF)
1195 sscape_write(devc, 9, sscape_read(devc, 9) & 0x3F );
1197 d = inb(devc -> codec) & 0x80;
1199 printk(KERN_INFO "soundscape: hardware detected\n");
1200 valid_interrupts = valid_interrupts_new;
1202 printk(KERN_INFO "soundscape: board looks like media fx\n");
1203 valid_interrupts = valid_interrupts_old;
1207 sscape_write( devc, 9, 0xC0 | (sscape_read(devc, 9) & 0x3F) );
1209 for (i = 0; i < 550000; i++)
1210 if ( !(inb(devc -> codec) & 0x80))
1213 sscape_pnp_init_hw(devc);
1215 for (i = 0; i < sizeof(valid_interrupts); i++)
1217 if (devc->codec_irq == valid_interrupts[i]) {
1222 sscape_write(devc, GA_INTENA_REG, 0x00);
1223 sscape_write(devc, GA_DMACFG_REG, 0x50);
1224 sscape_write(devc, GA_DMAA_REG, 0x70);
1225 sscape_write(devc, GA_DMAB_REG, 0x20);
1226 sscape_write(devc, GA_INTCFG_REG, 0xf0);
1227 sscape_write(devc, GA_CDCFG_REG, 0x89 | (devc->dma << 4) | (irq_bits << 1));
1229 sscape_pnp_write_codec( devc, 0, sscape_pnp_read_codec( devc, 0) | 0x20);
1230 sscape_pnp_write_codec( devc, 0, sscape_pnp_read_codec( devc, 1) | 0x20);
1235 static int __init probe_sscape(struct address_info *hw_config)
1238 if (sscape_detected != 0 && sscape_detected != hw_config->io_base)
1241 devc->base = hw_config->io_base;
1242 devc->irq = hw_config->irq;
1243 devc->dma = hw_config->dma;
1244 devc->osp = hw_config->osp;
1246 #ifdef SSCAPE_DEBUG1
1248 * Temporary debugging aid. Print contents of the registers before
1254 for (i = 0; i < 13; i++)
1255 printk("I%d = %02x (old value)\n", i, sscape_read(devc, i));
1260 if (!detect_ga(devc)) {
1261 if (detect_sscape_pnp(devc)) {
1262 sscape_detected = hw_config->io_base;
1268 if (old_hardware) /* Check that it's really an old Spea/Reveal card. */
1273 if (!((tmp = sscape_read(devc, GA_HMCTL_REG)) & 0xc0))
1275 sscape_write(devc, GA_HMCTL_REG, tmp | 0x80);
1276 for (cc = 0; cc < 200000; ++cc)
1277 inb(devc->base + ODIE_ADDR);
1280 sscape_detected = hw_config->io_base;
1284 static int __init probe_ss_ms_sound(struct address_info *hw_config)
1286 int i, irq_bits = 0xff;
1291 printk(KERN_ERR "soundscape: Card not detected\n");
1296 printk(KERN_ERR "soundscape: Invalid initialization order.\n");
1299 for (i = 0; i < sizeof(valid_interrupts); i++)
1301 if (hw_config->irq == valid_interrupts[i])
1307 if (hw_config->irq > 15 || irq_bits == 0xff)
1309 printk(KERN_ERR "soundscape: Invalid MSS IRQ%d\n", hw_config->irq);
1313 if (!sscape_is_pnp) {
1315 ad_flags = 0x12345677; /* Tell that we may have a CS4248 chip (Spea-V7 Media FX) */
1316 return ad1848_detect(hw_config->io_base, &ad_flags, hw_config->osp);
1320 ad_flags = 0x12345677; /* Tell that we may have a CS4248 chip (Spea-V7 Media FX) */
1322 ad_flags = 0x87654321; /* Tell that we have a soundscape pnp with 1845 chip */
1323 return ad1848_detect(hw_config->io_base, &ad_flags, hw_config->osp);
1327 static void __init attach_ss_ms_sound(struct address_info *hw_config)
1330 * This routine configures the SoundScape card for use with the
1331 * Win Sound System driver. The AD1848 codec interface uses the CD-ROM
1332 * config registers of the "ODIE".
1335 int i, irq_bits = 0xff;
1338 if (!sscape_is_pnp) /*pnp is already setup*/
1341 * Setup the DMA polarity.
1343 sscape_write(devc, GA_DMACFG_REG, 0x50);
1346 * Take the gate-array off of the DMA channel.
1348 sscape_write(devc, GA_DMAB_REG, 0x20);
1351 * Init the AD1848 (CD-ROM) config reg.
1353 for (i = 0; i < sizeof(valid_interrupts); i++)
1355 if (hw_config->irq == valid_interrupts[i])
1361 sscape_write(devc, GA_CDCFG_REG, 0x89 | (hw_config->dma << 4) | (irq_bits << 1));
1364 if (hw_config->irq == devc->irq)
1365 printk(KERN_WARNING "soundscape: Warning! The WSS mode can't share IRQ with MIDI\n");
1367 hw_config->slots[0] = ad1848_init(
1368 sscape_is_pnp ? "SoundScape" : "SoundScape PNP",
1378 if (hw_config->slots[0] != -1) /* The AD1848 driver installed itself */
1380 audio_devs[hw_config->slots[0]]->coproc = &sscape_coproc_operations;
1381 devc->codec_audiodev = hw_config->slots[0];
1382 devc->my_audiodev = hw_config->slots[0];
1384 /* Set proper routings here (what are they) */
1385 AD1848_REROUTE(SOUND_MIXER_LINE1, SOUND_MIXER_LINE);
1388 #ifdef SSCAPE_DEBUG5
1390 * Temporary debugging aid. Print contents of the registers
1391 * after the AD1848 device has been initialized.
1396 for (i = 0; i < 13; i++)
1397 printk("I%d = %02x\n", i, sscape_read(devc, i));
1403 static void __exit unload_sscape(struct address_info *hw_config)
1405 release_region(devc->base + 2, 6);
1406 unload_mpu401(hw_config);
1409 static void __exit unload_ss_ms_sound(struct address_info *hw_config)
1411 ad1848_unload(hw_config->io_base,
1416 sound_unload_audiodev(hw_config->slots[0]);
1419 static struct address_info cfg;
1420 static struct address_info cfg_mpu;
1422 static int __initdata spea = -1;
1423 static int __initdata mss = 0;
1424 static int __initdata dma = -1;
1425 static int __initdata irq = -1;
1426 static int __initdata io = -1;
1427 static int __initdata mpu_irq = -1;
1428 static int __initdata mpu_io = -1;
1430 MODULE_PARM(dma, "i");
1431 MODULE_PARM(irq, "i");
1432 MODULE_PARM(io, "i");
1433 MODULE_PARM(spea, "i"); /* spea=0/1 set the old_hardware */
1434 MODULE_PARM(mpu_irq, "i");
1435 MODULE_PARM(mpu_io, "i");
1436 MODULE_PARM(mss, "i");
1438 static int __init init_sscape(void)
1440 printk(KERN_INFO "Soundscape driver Copyright (C) by Hannu Savolainen 1993-1996\n");
1446 cfg_mpu.irq = mpu_irq;
1447 cfg_mpu.io_base = mpu_io;
1448 /* WEH - Try to get right dma channel */
1451 devc->codec = cfg.io_base;
1452 devc->codec_irq = cfg.irq;
1453 devc->codec_type = 0;
1455 devc->raw_buf = NULL;
1456 spin_lock_init(&devc->lock);
1458 if (cfg.dma == -1 || cfg.irq == -1 || cfg.io_base == -1) {
1459 printk(KERN_ERR "DMA, IRQ, and IO port must be specified.\n");
1463 if (cfg_mpu.irq == -1 && cfg_mpu.io_base != -1) {
1464 printk(KERN_ERR "MPU_IRQ must be specified if MPU_IO is set.\n");
1469 old_hardware = spea;
1470 printk(KERN_INFO "Forcing %s hardware support.\n",
1473 if (probe_sscape(&cfg_mpu) == 0)
1476 attach_sscape(&cfg_mpu);
1478 mss = probe_ss_ms_sound(&cfg);
1481 attach_ss_ms_sound(&cfg);
1486 static void __exit cleanup_sscape(void)
1489 unload_ss_ms_sound(&cfg);
1490 unload_sscape(&cfg_mpu);
1493 module_init(init_sscape);
1494 module_exit(cleanup_sscape);
1497 static int __init setup_sscape(char *str)
1499 /* io, irq, dma, mpu_io, mpu_irq */
1502 str = get_options(str, ARRAY_SIZE(ints), ints);
1513 __setup("sscape=", setup_sscape);
1515 MODULE_LICENSE("GPL");