ieee1394: add hpsb_node_read() and hpsb_node_lock()
[linux-2.6/mini2440.git] / sound / oss / sscape.c
blob30c36d1f35d7a9641428ebb8b91bc5d02586cf28
1 /*
2 * sound/oss/sscape.c
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
11 * for more info.
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>
35 #include <asm/dma.h>
36 #include <asm/io.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/mm.h>
43 #include <linux/spinlock.h>
45 #include "coproc.h"
47 #include "ad1848.h"
48 #include "mpu401.h"
51 * I/O ports
53 #define MIDI_DATA 0
54 #define MIDI_CTRL 1
55 #define HOST_CTRL 2
56 #define TX_READY 0x02
57 #define RX_READY 0x01
58 #define HOST_DATA 3
59 #define ODIE_ADDR 4
60 #define ODIE_DATA 5
63 * Indirect registers
66 #define GA_INTSTAT_REG 0
67 #define GA_INTENA_REG 1
68 #define GA_DMAA_REG 2
69 #define GA_DMAB_REG 3
70 #define GA_INTCFG_REG 4
71 #define GA_DMACFG_REG 5
72 #define GA_CDCFG_REG 6
73 #define GA_SMCFGA_REG 7
74 #define GA_SMCFGB_REG 8
75 #define GA_HMCTL_REG 9
78 * DMA channel identifiers (A and B)
81 #define SSCAPE_DMA_A 0
82 #define SSCAPE_DMA_B 1
84 #define PORT(name) (devc->base+name)
87 * Host commands recognized by the OBP microcode
90 #define CMD_GEN_HOST_ACK 0x80
91 #define CMD_GEN_MPU_ACK 0x81
92 #define CMD_GET_BOARD_TYPE 0x82
93 #define CMD_SET_CONTROL 0x88 /* Old firmware only */
94 #define CMD_GET_CONTROL 0x89 /* Old firmware only */
95 #define CTL_MASTER_VOL 0
96 #define CTL_MIC_MODE 2
97 #define CTL_SYNTH_VOL 4
98 #define CTL_WAVE_VOL 7
99 #define CMD_SET_EXTMIDI 0x8a
100 #define CMD_GET_EXTMIDI 0x8b
101 #define CMD_SET_MT32 0x8c
102 #define CMD_GET_MT32 0x8d
104 #define CMD_ACK 0x80
106 #define IC_ODIE 1
107 #define IC_OPUS 2
109 typedef struct sscape_info
111 int base, irq, dma;
113 int codec, codec_irq; /* required to setup pnp cards*/
114 int codec_type;
115 int ic_type;
116 char* raw_buf;
117 unsigned long raw_buf_phys;
118 int buffsize; /* -------------------------- */
119 spinlock_t lock;
120 int ok; /* Properly detected */
121 int failed;
122 int dma_allocated;
123 int codec_audiodev;
124 int opened;
125 int *osp;
126 int my_audiodev;
127 } sscape_info;
129 static struct sscape_info adev_info = {
133 static struct sscape_info *devc = &adev_info;
134 static int sscape_mididev = -1;
136 /* Some older cards have assigned interrupt bits differently than new ones */
137 static char valid_interrupts_old[] = {
138 9, 7, 5, 15
141 static char valid_interrupts_new[] = {
142 9, 5, 7, 10
145 static char *valid_interrupts = valid_interrupts_new;
148 * See the bottom of the driver. This can be set by spea =0/1.
151 #ifdef REVEAL_SPEA
152 static char old_hardware = 1;
153 #else
154 static char old_hardware;
155 #endif
157 static void sleep(unsigned howlong)
159 current->state = TASK_INTERRUPTIBLE;
160 schedule_timeout(howlong);
163 static unsigned char sscape_read(struct sscape_info *devc, int reg)
165 unsigned long flags;
166 unsigned char val;
168 spin_lock_irqsave(&devc->lock,flags);
169 outb(reg, PORT(ODIE_ADDR));
170 val = inb(PORT(ODIE_DATA));
171 spin_unlock_irqrestore(&devc->lock,flags);
172 return val;
175 static void __sscape_write(int reg, int data)
177 outb(reg, PORT(ODIE_ADDR));
178 outb(data, PORT(ODIE_DATA));
181 static void sscape_write(struct sscape_info *devc, int reg, int data)
183 unsigned long flags;
185 spin_lock_irqsave(&devc->lock,flags);
186 __sscape_write(reg, data);
187 spin_unlock_irqrestore(&devc->lock,flags);
190 static unsigned char sscape_pnp_read_codec(sscape_info* devc, unsigned char reg)
192 unsigned char res;
193 unsigned long flags;
195 spin_lock_irqsave(&devc->lock,flags);
196 outb( reg, devc -> codec);
197 res = inb (devc -> codec + 1);
198 spin_unlock_irqrestore(&devc->lock,flags);
199 return res;
203 static void sscape_pnp_write_codec(sscape_info* devc, unsigned char reg, unsigned char data)
205 unsigned long flags;
207 spin_lock_irqsave(&devc->lock,flags);
208 outb( reg, devc -> codec);
209 outb( data, devc -> codec + 1);
210 spin_unlock_irqrestore(&devc->lock,flags);
213 static void host_open(struct sscape_info *devc)
215 outb((0x00), PORT(HOST_CTRL)); /* Put the board to the host mode */
218 static void host_close(struct sscape_info *devc)
220 outb((0x03), PORT(HOST_CTRL)); /* Put the board to the MIDI mode */
223 static int host_write(struct sscape_info *devc, unsigned char *data, int count)
225 unsigned long flags;
226 int i, timeout_val;
228 spin_lock_irqsave(&devc->lock,flags);
230 * Send the command and data bytes
233 for (i = 0; i < count; i++)
235 for (timeout_val = 10000; timeout_val > 0; timeout_val--)
236 if (inb(PORT(HOST_CTRL)) & TX_READY)
237 break;
239 if (timeout_val <= 0)
241 spin_unlock_irqrestore(&devc->lock,flags);
242 return 0;
244 outb(data[i], PORT(HOST_DATA));
246 spin_unlock_irqrestore(&devc->lock,flags);
247 return 1;
250 static int host_read(struct sscape_info *devc)
252 unsigned long flags;
253 int timeout_val;
254 unsigned char data;
256 spin_lock_irqsave(&devc->lock,flags);
258 * Read a byte
261 for (timeout_val = 10000; timeout_val > 0; timeout_val--)
262 if (inb(PORT(HOST_CTRL)) & RX_READY)
263 break;
265 if (timeout_val <= 0)
267 spin_unlock_irqrestore(&devc->lock,flags);
268 return -1;
270 data = inb(PORT(HOST_DATA));
271 spin_unlock_irqrestore(&devc->lock,flags);
272 return data;
275 #if 0 /* unused */
276 static int host_command1(struct sscape_info *devc, int cmd)
278 unsigned char buf[10];
279 buf[0] = (unsigned char) (cmd & 0xff);
280 return host_write(devc, buf, 1);
282 #endif /* unused */
285 static int host_command2(struct sscape_info *devc, int cmd, int parm1)
287 unsigned char buf[10];
289 buf[0] = (unsigned char) (cmd & 0xff);
290 buf[1] = (unsigned char) (parm1 & 0xff);
292 return host_write(devc, buf, 2);
295 static int host_command3(struct sscape_info *devc, int cmd, int parm1, int parm2)
297 unsigned char buf[10];
299 buf[0] = (unsigned char) (cmd & 0xff);
300 buf[1] = (unsigned char) (parm1 & 0xff);
301 buf[2] = (unsigned char) (parm2 & 0xff);
302 return host_write(devc, buf, 3);
305 static void set_mt32(struct sscape_info *devc, int value)
307 host_open(devc);
308 host_command2(devc, CMD_SET_MT32, value ? 1 : 0);
309 if (host_read(devc) != CMD_ACK)
311 /* printk( "SNDSCAPE: Setting MT32 mode failed\n"); */
313 host_close(devc);
316 static void set_control(struct sscape_info *devc, int ctrl, int value)
318 host_open(devc);
319 host_command3(devc, CMD_SET_CONTROL, ctrl, value);
320 if (host_read(devc) != CMD_ACK)
322 /* printk( "SNDSCAPE: Setting control (%d) failed\n", ctrl); */
324 host_close(devc);
327 static void do_dma(struct sscape_info *devc, int dma_chan, unsigned long buf, int blk_size, int mode)
329 unsigned char temp;
331 if (dma_chan != SSCAPE_DMA_A)
333 printk(KERN_WARNING "soundscape: Tried to use DMA channel != A. Why?\n");
334 return;
336 audio_devs[devc->codec_audiodev]->flags &= ~DMA_AUTOMODE;
337 DMAbuf_start_dma(devc->codec_audiodev, buf, blk_size, mode);
338 audio_devs[devc->codec_audiodev]->flags |= DMA_AUTOMODE;
340 temp = devc->dma << 4; /* Setup DMA channel select bits */
341 if (devc->dma <= 3)
342 temp |= 0x80; /* 8 bit DMA channel */
344 temp |= 1; /* Trigger DMA */
345 sscape_write(devc, GA_DMAA_REG, temp);
346 temp &= 0xfe; /* Clear DMA trigger */
347 sscape_write(devc, GA_DMAA_REG, temp);
350 static int verify_mpu(struct sscape_info *devc)
353 * The SoundScape board could be in three modes (MPU, 8250 and host).
354 * If the card is not in the MPU mode, enabling the MPU driver will
355 * cause infinite loop (the driver believes that there is always some
356 * received data in the buffer.
358 * Detect this by looking if there are more than 10 received MIDI bytes
359 * (0x00) in the buffer.
362 int i;
364 for (i = 0; i < 10; i++)
366 if (inb(devc->base + HOST_CTRL) & 0x80)
367 return 1;
369 if (inb(devc->base) != 0x00)
370 return 1;
372 printk(KERN_WARNING "SoundScape: The device is not in the MPU-401 mode\n");
373 return 0;
376 static int sscape_coproc_open(void *dev_info, int sub_device)
378 if (sub_device == COPR_MIDI)
380 set_mt32(devc, 0);
381 if (!verify_mpu(devc))
382 return -EIO;
384 return 0;
387 static void sscape_coproc_close(void *dev_info, int sub_device)
389 struct sscape_info *devc = dev_info;
390 unsigned long flags;
392 spin_lock_irqsave(&devc->lock,flags);
393 if (devc->dma_allocated)
395 __sscape_write(GA_DMAA_REG, 0x20); /* DMA channel disabled */
396 devc->dma_allocated = 0;
398 spin_unlock_irqrestore(&devc->lock,flags);
399 return;
402 static void sscape_coproc_reset(void *dev_info)
406 static int sscape_download_boot(struct sscape_info *devc, unsigned char *block, int size, int flag)
408 unsigned long flags;
409 unsigned char temp;
410 volatile int done, timeout_val;
411 static unsigned char codec_dma_bits;
413 if (flag & CPF_FIRST)
416 * First block. Have to allocate DMA and to reset the board
417 * before continuing.
420 spin_lock_irqsave(&devc->lock,flags);
421 codec_dma_bits = sscape_read(devc, GA_CDCFG_REG);
423 if (devc->dma_allocated == 0)
424 devc->dma_allocated = 1;
426 spin_unlock_irqrestore(&devc->lock,flags);
428 sscape_write(devc, GA_HMCTL_REG,
429 (temp = sscape_read(devc, GA_HMCTL_REG)) & 0x3f); /*Reset */
431 for (timeout_val = 10000; timeout_val > 0; timeout_val--)
432 sscape_read(devc, GA_HMCTL_REG); /* Delay */
434 /* Take board out of reset */
435 sscape_write(devc, GA_HMCTL_REG,
436 (temp = sscape_read(devc, GA_HMCTL_REG)) | 0x80);
439 * Transfer one code block using DMA
441 if (audio_devs[devc->codec_audiodev]->dmap_out->raw_buf == NULL)
443 printk(KERN_WARNING "soundscape: DMA buffer not available\n");
444 return 0;
446 memcpy(audio_devs[devc->codec_audiodev]->dmap_out->raw_buf, block, size);
448 spin_lock_irqsave(&devc->lock,flags);
450 /******** INTERRUPTS DISABLED NOW ********/
452 do_dma(devc, SSCAPE_DMA_A,
453 audio_devs[devc->codec_audiodev]->dmap_out->raw_buf_phys,
454 size, DMA_MODE_WRITE);
457 * Wait until transfer completes.
460 done = 0;
461 timeout_val = 30;
462 while (!done && timeout_val-- > 0)
464 int resid;
466 if (HZ / 50)
467 sleep(HZ / 50);
468 clear_dma_ff(devc->dma);
469 if ((resid = get_dma_residue(devc->dma)) == 0)
470 done = 1;
473 spin_unlock_irqrestore(&devc->lock,flags);
474 if (!done)
475 return 0;
477 if (flag & CPF_LAST)
480 * Take the board out of reset
482 outb((0x00), PORT(HOST_CTRL));
483 outb((0x00), PORT(MIDI_CTRL));
485 temp = sscape_read(devc, GA_HMCTL_REG);
486 temp |= 0x40;
487 sscape_write(devc, GA_HMCTL_REG, temp); /* Kickstart the board */
490 * Wait until the ODB wakes up
492 spin_lock_irqsave(&devc->lock,flags);
493 done = 0;
494 timeout_val = 5 * HZ;
495 while (!done && timeout_val-- > 0)
497 unsigned char x;
499 sleep(1);
500 x = inb(PORT(HOST_DATA));
501 if (x == 0xff || x == 0xfe) /* OBP startup acknowledge */
503 DDB(printk("Soundscape: Acknowledge = %x\n", x));
504 done = 1;
507 sscape_write(devc, GA_CDCFG_REG, codec_dma_bits);
509 spin_unlock_irqrestore(&devc->lock,flags);
510 if (!done)
512 printk(KERN_ERR "soundscape: The OBP didn't respond after code download\n");
513 return 0;
515 spin_lock_irqsave(&devc->lock,flags);
516 done = 0;
517 timeout_val = 5 * HZ;
518 while (!done && timeout_val-- > 0)
520 sleep(1);
521 if (inb(PORT(HOST_DATA)) == 0xfe) /* Host startup acknowledge */
522 done = 1;
524 spin_unlock_irqrestore(&devc->lock,flags);
525 if (!done)
527 printk(KERN_ERR "soundscape: OBP Initialization failed.\n");
528 return 0;
530 printk(KERN_INFO "SoundScape board initialized OK\n");
531 set_control(devc, CTL_MASTER_VOL, 100);
532 set_control(devc, CTL_SYNTH_VOL, 100);
534 #ifdef SSCAPE_DEBUG3
536 * Temporary debugging aid. Print contents of the registers after
537 * downloading the code.
540 int i;
542 for (i = 0; i < 13; i++)
543 printk("I%d = %02x (new value)\n", i, sscape_read(devc, i));
545 #endif
548 return 1;
551 static int download_boot_block(void *dev_info, copr_buffer * buf)
553 if (buf->len <= 0 || buf->len > sizeof(buf->data))
554 return -EINVAL;
556 if (!sscape_download_boot(devc, buf->data, buf->len, buf->flags))
558 printk(KERN_ERR "soundscape: Unable to load microcode block to the OBP.\n");
559 return -EIO;
561 return 0;
564 static int sscape_coproc_ioctl(void *dev_info, unsigned int cmd, void __user *arg, int local)
566 copr_buffer *buf;
567 int err;
569 switch (cmd)
571 case SNDCTL_COPR_RESET:
572 sscape_coproc_reset(dev_info);
573 return 0;
575 case SNDCTL_COPR_LOAD:
576 buf = (copr_buffer *) vmalloc(sizeof(copr_buffer));
577 if (buf == NULL)
578 return -ENOSPC;
579 if (copy_from_user(buf, arg, sizeof(copr_buffer)))
581 vfree(buf);
582 return -EFAULT;
584 err = download_boot_block(dev_info, buf);
585 vfree(buf);
586 return err;
588 default:
589 return -EINVAL;
593 static coproc_operations sscape_coproc_operations =
595 "SoundScape M68K",
596 THIS_MODULE,
597 sscape_coproc_open,
598 sscape_coproc_close,
599 sscape_coproc_ioctl,
600 sscape_coproc_reset,
601 &adev_info
604 static struct resource *sscape_ports;
605 static int sscape_is_pnp;
607 static void __init attach_sscape(struct address_info *hw_config)
609 #ifndef SSCAPE_REGS
611 * Config register values for Spea/V7 Media FX and Ensoniq S-2000.
612 * These values are card
613 * dependent. If you have another SoundScape based card, you have to
614 * find the correct values. Do the following:
615 * - Compile this driver with SSCAPE_DEBUG1 defined.
616 * - Shut down and power off your machine.
617 * - Boot with DOS so that the SSINIT.EXE program is run.
618 * - Warm boot to {Linux|SYSV|BSD} and write down the lines displayed
619 * when detecting the SoundScape.
620 * - Modify the following list to use the values printed during boot.
621 * Undefine the SSCAPE_DEBUG1
623 #define SSCAPE_REGS { \
624 /* I0 */ 0x00, \
625 /* I1 */ 0xf0, /* Note! Ignored. Set always to 0xf0 */ \
626 /* I2 */ 0x20, /* Note! Ignored. Set always to 0x20 */ \
627 /* I3 */ 0x20, /* Note! Ignored. Set always to 0x20 */ \
628 /* I4 */ 0xf5, /* Ignored */ \
629 /* I5 */ 0x10, \
630 /* I6 */ 0x00, \
631 /* I7 */ 0x2e, /* I7 MEM config A. Likely to vary between models */ \
632 /* I8 */ 0x00, /* I8 MEM config B. Likely to vary between models */ \
633 /* I9 */ 0x40 /* Ignored */ \
635 #endif
637 unsigned long flags;
638 static unsigned char regs[10] = SSCAPE_REGS;
640 int i, irq_bits = 0xff;
642 if (old_hardware)
644 valid_interrupts = valid_interrupts_old;
645 conf_printf("Ensoniq SoundScape (old)", hw_config);
647 else
648 conf_printf("Ensoniq SoundScape", hw_config);
650 for (i = 0; i < 4; i++)
652 if (hw_config->irq == valid_interrupts[i])
654 irq_bits = i;
655 break;
658 if (hw_config->irq > 15 || (regs[4] = irq_bits == 0xff))
660 printk(KERN_ERR "Invalid IRQ%d\n", hw_config->irq);
661 release_region(devc->base, 2);
662 release_region(devc->base + 2, 6);
663 if (sscape_is_pnp)
664 release_region(devc->codec, 2);
665 return;
668 if (!sscape_is_pnp) {
670 spin_lock_irqsave(&devc->lock,flags);
671 /* Host interrupt enable */
672 sscape_write(devc, 1, 0xf0); /* All interrupts enabled */
673 /* DMA A status/trigger register */
674 sscape_write(devc, 2, 0x20); /* DMA channel disabled */
675 /* DMA B status/trigger register */
676 sscape_write(devc, 3, 0x20); /* DMA channel disabled */
677 /* Host interrupt config reg */
678 sscape_write(devc, 4, 0xf0 | (irq_bits << 2) | irq_bits);
679 /* Don't destroy CD-ROM DMA config bits (0xc0) */
680 sscape_write(devc, 5, (regs[5] & 0x3f) | (sscape_read(devc, 5) & 0xc0));
681 /* CD-ROM config (WSS codec actually) */
682 sscape_write(devc, 6, regs[6]);
683 sscape_write(devc, 7, regs[7]);
684 sscape_write(devc, 8, regs[8]);
685 /* Master control reg. Don't modify CR-ROM bits. Disable SB emul */
686 sscape_write(devc, 9, (sscape_read(devc, 9) & 0xf0) | 0x08);
687 spin_unlock_irqrestore(&devc->lock,flags);
689 #ifdef SSCAPE_DEBUG2
691 * Temporary debugging aid. Print contents of the registers after
692 * changing them.
695 int i;
697 for (i = 0; i < 13; i++)
698 printk("I%d = %02x (new value)\n", i, sscape_read(devc, i));
700 #endif
702 if (probe_mpu401(hw_config, sscape_ports))
703 hw_config->always_detect = 1;
704 hw_config->name = "SoundScape";
706 hw_config->irq *= -1; /* Negative value signals IRQ sharing */
707 attach_mpu401(hw_config, THIS_MODULE);
708 hw_config->irq *= -1; /* Restore it */
710 if (hw_config->slots[1] != -1) /* The MPU driver installed itself */
712 sscape_mididev = hw_config->slots[1];
713 midi_devs[hw_config->slots[1]]->coproc = &sscape_coproc_operations;
715 sscape_write(devc, GA_INTENA_REG, 0x80); /* Master IRQ enable */
716 devc->ok = 1;
717 devc->failed = 0;
720 static int detect_ga(sscape_info * devc)
722 unsigned char save;
724 DDB(printk("Entered Soundscape detect_ga(%x)\n", devc->base));
727 * First check that the address register of "ODIE" is
728 * there and that it has exactly 4 writable bits.
729 * First 4 bits
732 if ((save = inb(PORT(ODIE_ADDR))) & 0xf0)
734 DDB(printk("soundscape: Detect error A\n"));
735 return 0;
737 outb((0x00), PORT(ODIE_ADDR));
738 if (inb(PORT(ODIE_ADDR)) != 0x00)
740 DDB(printk("soundscape: Detect error B\n"));
741 return 0;
743 outb((0xff), PORT(ODIE_ADDR));
744 if (inb(PORT(ODIE_ADDR)) != 0x0f)
746 DDB(printk("soundscape: Detect error C\n"));
747 return 0;
749 outb((save), PORT(ODIE_ADDR));
752 * Now verify that some indirect registers return zero on some bits.
753 * This may break the driver with some future revisions of "ODIE" but...
756 if (sscape_read(devc, 0) & 0x0c)
758 DDB(printk("soundscape: Detect error D (%x)\n", sscape_read(devc, 0)));
759 return 0;
761 if (sscape_read(devc, 1) & 0x0f)
763 DDB(printk("soundscape: Detect error E\n"));
764 return 0;
766 if (sscape_read(devc, 5) & 0x0f)
768 DDB(printk("soundscape: Detect error F\n"));
769 return 0;
771 return 1;
774 static int sscape_read_host_ctrl(sscape_info* devc)
776 return host_read(devc);
779 static void sscape_write_host_ctrl2(sscape_info *devc, int a, int b)
781 host_command2(devc, a, b);
784 static int sscape_alloc_dma(sscape_info *devc)
786 char *start_addr, *end_addr;
787 int dma_pagesize;
788 int sz, size;
789 struct page *page;
791 if (devc->raw_buf != NULL) return 0; /* Already done */
792 dma_pagesize = (devc->dma < 4) ? (64 * 1024) : (128 * 1024);
793 devc->raw_buf = NULL;
794 devc->buffsize = 8192*4;
795 if (devc->buffsize > dma_pagesize) devc->buffsize = dma_pagesize;
796 start_addr = NULL;
798 * Now loop until we get a free buffer. Try to get smaller buffer if
799 * it fails. Don't accept smaller than 8k buffer for performance
800 * reasons.
802 while (start_addr == NULL && devc->buffsize > PAGE_SIZE) {
803 for (sz = 0, size = PAGE_SIZE; size < devc->buffsize; sz++, size <<= 1);
804 devc->buffsize = PAGE_SIZE * (1 << sz);
805 start_addr = (char *) __get_free_pages(GFP_ATOMIC|GFP_DMA, sz);
806 if (start_addr == NULL) devc->buffsize /= 2;
809 if (start_addr == NULL) {
810 printk(KERN_ERR "sscape pnp init error: Couldn't allocate DMA buffer\n");
811 return 0;
812 } else {
813 /* make some checks */
814 end_addr = start_addr + devc->buffsize - 1;
815 /* now check if it fits into the same dma-pagesize */
817 if (((long) start_addr & ~(dma_pagesize - 1)) != ((long) end_addr & ~(dma_pagesize - 1))
818 || end_addr >= (char *) (MAX_DMA_ADDRESS)) {
819 printk(KERN_ERR "sscape pnp: Got invalid address 0x%lx for %db DMA-buffer\n", (long) start_addr, devc->buffsize);
820 return 0;
823 devc->raw_buf = start_addr;
824 devc->raw_buf_phys = virt_to_bus(start_addr);
826 for (page = virt_to_page(start_addr); page <= virt_to_page(end_addr); page++)
827 SetPageReserved(page);
828 return 1;
831 static void sscape_free_dma(sscape_info *devc)
833 int sz, size;
834 unsigned long start_addr, end_addr;
835 struct page *page;
837 if (devc->raw_buf == NULL) return;
838 for (sz = 0, size = PAGE_SIZE; size < devc->buffsize; sz++, size <<= 1);
839 start_addr = (unsigned long) devc->raw_buf;
840 end_addr = start_addr + devc->buffsize;
842 for (page = virt_to_page(start_addr); page <= virt_to_page(end_addr); page++)
843 ClearPageReserved(page);
845 free_pages((unsigned long) devc->raw_buf, sz);
846 devc->raw_buf = NULL;
849 /* Intel version !!!!!!!!! */
851 static int sscape_start_dma(int chan, unsigned long physaddr, int count, int dma_mode)
853 unsigned long flags;
855 flags = claim_dma_lock();
856 disable_dma(chan);
857 clear_dma_ff(chan);
858 set_dma_mode(chan, dma_mode);
859 set_dma_addr(chan, physaddr);
860 set_dma_count(chan, count);
861 enable_dma(chan);
862 release_dma_lock(flags);
863 return 0;
866 static void sscape_pnp_start_dma(sscape_info* devc, int arg )
868 int reg;
869 if (arg == 0) reg = 2;
870 else reg = 3;
872 sscape_write(devc, reg, sscape_read( devc, reg) | 0x01);
873 sscape_write(devc, reg, sscape_read( devc, reg) & 0xFE);
876 static int sscape_pnp_wait_dma (sscape_info* devc, int arg )
878 int reg;
879 unsigned long i;
880 unsigned char d;
882 if (arg == 0) reg = 2;
883 else reg = 3;
885 sleep ( 1 );
886 i = 0;
887 do {
888 d = sscape_read(devc, reg) & 1;
889 if ( d == 1) break;
890 i++;
891 } while (i < 500000);
892 d = sscape_read(devc, reg) & 1;
893 return d;
896 static int sscape_pnp_alloc_dma(sscape_info* devc)
898 /* printk(KERN_INFO "sscape: requesting dma\n"); */
899 if (request_dma(devc -> dma, "sscape")) return 0;
900 /* printk(KERN_INFO "sscape: dma channel allocated\n"); */
901 if (!sscape_alloc_dma(devc)) {
902 free_dma(devc -> dma);
903 return 0;
905 return 1;
908 static void sscape_pnp_free_dma(sscape_info* devc)
910 sscape_free_dma( devc);
911 free_dma(devc -> dma );
912 /* printk(KERN_INFO "sscape: dma released\n"); */
915 static int sscape_pnp_upload_file(sscape_info* devc, char* fn)
917 int done = 0;
918 int timeout_val;
919 char* data,*dt;
920 int len,l;
921 unsigned long flags;
923 sscape_write( devc, 9, sscape_read(devc, 9 ) & 0x3F );
924 sscape_write( devc, 2, (devc -> dma << 4) | 0x80 );
925 sscape_write( devc, 3, 0x20 );
926 sscape_write( devc, 9, sscape_read( devc, 9 ) | 0x80 );
928 len = mod_firmware_load(fn, &data);
929 if (len == 0) {
930 printk(KERN_ERR "sscape: file not found: %s\n", fn);
931 return 0;
933 dt = data;
934 spin_lock_irqsave(&devc->lock,flags);
935 while ( len > 0 ) {
936 if (len > devc -> buffsize) l = devc->buffsize;
937 else l = len;
938 len -= l;
939 memcpy(devc->raw_buf, dt, l); dt += l;
940 sscape_start_dma(devc->dma, devc->raw_buf_phys, l, 0x48);
941 sscape_pnp_start_dma ( devc, 0 );
942 if (sscape_pnp_wait_dma ( devc, 0 ) == 0) {
943 spin_unlock_irqrestore(&devc->lock,flags);
944 return 0;
948 spin_unlock_irqrestore(&devc->lock,flags);
949 vfree(data);
951 outb(0, devc -> base + 2);
952 outb(0, devc -> base);
954 sscape_write ( devc, 9, sscape_read( devc, 9 ) | 0x40);
956 timeout_val = 5 * HZ;
957 while (!done && timeout_val-- > 0)
959 unsigned char x;
960 sleep(1);
961 x = inb( devc -> base + 3);
962 if (x == 0xff || x == 0xfe) /* OBP startup acknowledge */
964 //printk(KERN_ERR "Soundscape: Acknowledge = %x\n", x);
965 done = 1;
968 timeout_val = 5 * HZ;
969 done = 0;
970 while (!done && timeout_val-- > 0)
972 unsigned char x;
973 sleep(1);
974 x = inb( devc -> base + 3);
975 if (x == 0xfe) /* OBP startup acknowledge */
977 //printk(KERN_ERR "Soundscape: Acknowledge = %x\n", x);
978 done = 1;
982 if ( !done ) printk(KERN_ERR "soundscape: OBP Initialization failed.\n");
984 sscape_write( devc, 2, devc->ic_type == IC_ODIE ? 0x70 : 0x40);
985 sscape_write( devc, 3, (devc -> dma << 4) + 0x80);
986 return 1;
989 static void __init sscape_pnp_init_hw(sscape_info* devc)
991 unsigned char midi_irq = 0, sb_irq = 0;
992 unsigned i;
993 static char code_file_name[23] = "/sndscape/sndscape.cox";
995 int sscape_joystic_enable = 0x7f;
996 int sscape_mic_enable = 0;
997 int sscape_ext_midi = 0;
999 if ( !sscape_pnp_alloc_dma(devc) ) {
1000 printk(KERN_ERR "sscape: faild to allocate dma\n");
1001 return;
1004 for (i = 0; i < 4; i++) {
1005 if ( devc -> irq == valid_interrupts[i] )
1006 midi_irq = i;
1007 if ( devc -> codec_irq == valid_interrupts[i] )
1008 sb_irq = i;
1011 sscape_write( devc, 5, 0x50);
1012 sscape_write( devc, 7, 0x2e);
1013 sscape_write( devc, 8, 0x00);
1015 sscape_write( devc, 2, devc->ic_type == IC_ODIE ? 0x70 : 0x40);
1016 sscape_write( devc, 3, ( devc -> dma << 4) | 0x80);
1018 sscape_write (devc, 4, 0xF0 | (midi_irq<<2) | midi_irq);
1020 i = 0x10; //sscape_read(devc, 9) & (devc->ic_type == IC_ODIE ? 0xf0 : 0xc0);
1021 if (sscape_joystic_enable) i |= 8;
1023 sscape_write (devc, 9, i);
1024 sscape_write (devc, 6, 0x80);
1025 sscape_write (devc, 1, 0x80);
1027 if (devc -> codec_type == 2) {
1028 sscape_pnp_write_codec( devc, 0x0C, 0x50);
1029 sscape_pnp_write_codec( devc, 0x10, sscape_pnp_read_codec( devc, 0x10) & 0x3F);
1030 sscape_pnp_write_codec( devc, 0x11, sscape_pnp_read_codec( devc, 0x11) | 0xC0);
1031 sscape_pnp_write_codec( devc, 29, 0x20);
1034 if (sscape_pnp_upload_file(devc, "/sndscape/scope.cod") == 0 ) {
1035 printk(KERN_ERR "sscape: faild to upload file /sndscape/scope.cod\n");
1036 sscape_pnp_free_dma(devc);
1037 return;
1040 i = sscape_read_host_ctrl( devc );
1042 if ( (i & 0x0F) > 7 ) {
1043 printk(KERN_ERR "sscape: scope.cod faild\n");
1044 sscape_pnp_free_dma(devc);
1045 return;
1047 if ( i & 0x10 ) sscape_write( devc, 7, 0x2F);
1048 code_file_name[21] = (char) ( i & 0x0F) + 0x30;
1049 if (sscape_pnp_upload_file( devc, code_file_name) == 0) {
1050 printk(KERN_ERR "sscape: faild to upload file %s\n", code_file_name);
1051 sscape_pnp_free_dma(devc);
1052 return;
1055 if (devc->ic_type != IC_ODIE) {
1056 sscape_pnp_write_codec( devc, 10, (sscape_pnp_read_codec(devc, 10) & 0x7f) |
1057 ( sscape_mic_enable == 0 ? 0x00 : 0x80) );
1059 sscape_write_host_ctrl2( devc, 0x84, 0x64 ); /* MIDI volume */
1060 sscape_write_host_ctrl2( devc, 0x86, 0x64 ); /* MIDI volume?? */
1061 sscape_write_host_ctrl2( devc, 0x8A, sscape_ext_midi);
1063 sscape_pnp_write_codec ( devc, 6, 0x3f ); //WAV_VOL
1064 sscape_pnp_write_codec ( devc, 7, 0x3f ); //WAV_VOL
1065 sscape_pnp_write_codec ( devc, 2, 0x1F ); //WD_CDXVOLL
1066 sscape_pnp_write_codec ( devc, 3, 0x1F ); //WD_CDXVOLR
1068 if (devc -> codec_type == 1) {
1069 sscape_pnp_write_codec ( devc, 4, 0x1F );
1070 sscape_pnp_write_codec ( devc, 5, 0x1F );
1071 sscape_write_host_ctrl2( devc, 0x88, sscape_mic_enable);
1072 } else {
1073 int t;
1074 sscape_pnp_write_codec ( devc, 0x10, 0x1F << 1);
1075 sscape_pnp_write_codec ( devc, 0x11, 0xC0 | (0x1F << 1));
1077 t = sscape_pnp_read_codec( devc, 0x00) & 0xDF;
1078 if ( (sscape_mic_enable == 0)) t |= 0;
1079 else t |= 0x20;
1080 sscape_pnp_write_codec ( devc, 0x00, t);
1081 t = sscape_pnp_read_codec( devc, 0x01) & 0xDF;
1082 if ( (sscape_mic_enable == 0) ) t |= 0;
1083 else t |= 0x20;
1084 sscape_pnp_write_codec ( devc, 0x01, t);
1085 sscape_pnp_write_codec ( devc, 0x40 | 29 , 0x20);
1086 outb(0, devc -> codec);
1088 if (devc -> ic_type == IC_OPUS ) {
1089 int i = sscape_read( devc, 9 );
1090 sscape_write( devc, 9, i | 3 );
1091 sscape_write( devc, 3, 0x40);
1093 if (request_region(0x228, 1, "sscape setup junk")) {
1094 outb(0, 0x228);
1095 release_region(0x228,1);
1097 sscape_write( devc, 3, (devc -> dma << 4) | 0x80);
1098 sscape_write( devc, 9, i );
1101 host_close ( devc );
1102 sscape_pnp_free_dma(devc);
1105 static int __init detect_sscape_pnp(sscape_info* devc)
1107 long i, irq_bits = 0xff;
1108 unsigned int d;
1110 DDB(printk("Entered detect_sscape_pnp(%x)\n", devc->base));
1112 if (!request_region(devc->codec, 2, "sscape codec")) {
1113 printk(KERN_ERR "detect_sscape_pnp: port %x is not free\n", devc->codec);
1114 return 0;
1117 if ((inb(devc->base + 2) & 0x78) != 0)
1118 goto fail;
1120 d = inb ( devc -> base + 4) & 0xF0;
1121 if (d & 0x80)
1122 goto fail;
1124 if (d == 0) {
1125 devc->codec_type = 1;
1126 devc->ic_type = IC_ODIE;
1127 } else if ( (d & 0x60) != 0) {
1128 devc->codec_type = 2;
1129 devc->ic_type = IC_OPUS;
1130 } else if ( (d & 0x40) != 0) { /* WTF? */
1131 devc->codec_type = 2;
1132 devc->ic_type = IC_ODIE;
1133 } else
1134 goto fail;
1136 sscape_is_pnp = 1;
1138 outb(0xFA, devc -> base+4);
1139 if ((inb( devc -> base+4) & 0x9F) != 0x0A)
1140 goto fail;
1141 outb(0xFE, devc -> base+4);
1142 if ( (inb(devc -> base+4) & 0x9F) != 0x0E)
1143 goto fail;
1144 if ( (inb(devc -> base+5) & 0x9F) != 0x0E)
1145 goto fail;
1147 if (devc->codec_type == 2) {
1148 if (devc->codec != devc->base + 8) {
1149 printk("soundscape warning: incorrect codec port specified\n");
1150 goto fail;
1152 d = 0x10 | (sscape_read(devc, 9) & 0xCF);
1153 sscape_write(devc, 9, d);
1154 sscape_write(devc, 6, 0x80);
1155 } else {
1156 //todo: check codec is not base + 8
1159 d = (sscape_read(devc, 9) & 0x3F) | 0xC0;
1160 sscape_write(devc, 9, d);
1162 for (i = 0; i < 550000; i++)
1163 if ( !(inb(devc -> codec) & 0x80) ) break;
1165 d = inb(devc -> codec);
1166 if (d & 0x80)
1167 goto fail;
1168 if ( inb(devc -> codec + 2) == 0xFF)
1169 goto fail;
1171 sscape_write(devc, 9, sscape_read(devc, 9) & 0x3F );
1173 d = inb(devc -> codec) & 0x80;
1174 if ( d == 0) {
1175 printk(KERN_INFO "soundscape: hardware detected\n");
1176 valid_interrupts = valid_interrupts_new;
1177 } else {
1178 printk(KERN_INFO "soundscape: board looks like media fx\n");
1179 valid_interrupts = valid_interrupts_old;
1180 old_hardware = 1;
1183 sscape_write( devc, 9, 0xC0 | (sscape_read(devc, 9) & 0x3F) );
1185 for (i = 0; i < 550000; i++)
1186 if ( !(inb(devc -> codec) & 0x80))
1187 break;
1189 sscape_pnp_init_hw(devc);
1191 for (i = 0; i < 4; i++)
1193 if (devc->codec_irq == valid_interrupts[i]) {
1194 irq_bits = i;
1195 break;
1198 sscape_write(devc, GA_INTENA_REG, 0x00);
1199 sscape_write(devc, GA_DMACFG_REG, 0x50);
1200 sscape_write(devc, GA_DMAA_REG, 0x70);
1201 sscape_write(devc, GA_DMAB_REG, 0x20);
1202 sscape_write(devc, GA_INTCFG_REG, 0xf0);
1203 sscape_write(devc, GA_CDCFG_REG, 0x89 | (devc->dma << 4) | (irq_bits << 1));
1205 sscape_pnp_write_codec( devc, 0, sscape_pnp_read_codec( devc, 0) | 0x20);
1206 sscape_pnp_write_codec( devc, 0, sscape_pnp_read_codec( devc, 1) | 0x20);
1208 return 1;
1209 fail:
1210 release_region(devc->codec, 2);
1211 return 0;
1214 static int __init probe_sscape(struct address_info *hw_config)
1216 devc->base = hw_config->io_base;
1217 devc->irq = hw_config->irq;
1218 devc->dma = hw_config->dma;
1219 devc->osp = hw_config->osp;
1221 #ifdef SSCAPE_DEBUG1
1223 * Temporary debugging aid. Print contents of the registers before
1224 * changing them.
1227 int i;
1229 for (i = 0; i < 13; i++)
1230 printk("I%d = %02x (old value)\n", i, sscape_read(devc, i));
1232 #endif
1233 devc->failed = 1;
1235 sscape_ports = request_region(devc->base, 2, "mpu401");
1236 if (!sscape_ports)
1237 return 0;
1239 if (!request_region(devc->base + 2, 6, "SoundScape")) {
1240 release_region(devc->base, 2);
1241 return 0;
1244 if (!detect_ga(devc)) {
1245 if (detect_sscape_pnp(devc))
1246 return 1;
1247 release_region(devc->base, 2);
1248 release_region(devc->base + 2, 6);
1249 return 0;
1252 if (old_hardware) /* Check that it's really an old Spea/Reveal card. */
1254 unsigned char tmp;
1255 int cc;
1257 if (!((tmp = sscape_read(devc, GA_HMCTL_REG)) & 0xc0))
1259 sscape_write(devc, GA_HMCTL_REG, tmp | 0x80);
1260 for (cc = 0; cc < 200000; ++cc)
1261 inb(devc->base + ODIE_ADDR);
1264 return 1;
1267 static int __init init_ss_ms_sound(struct address_info *hw_config)
1269 int i, irq_bits = 0xff;
1270 int ad_flags = 0;
1271 struct resource *ports;
1273 if (devc->failed)
1275 printk(KERN_ERR "soundscape: Card not detected\n");
1276 return 0;
1278 if (devc->ok == 0)
1280 printk(KERN_ERR "soundscape: Invalid initialization order.\n");
1281 return 0;
1283 for (i = 0; i < 4; i++)
1285 if (hw_config->irq == valid_interrupts[i])
1287 irq_bits = i;
1288 break;
1291 if (irq_bits == 0xff) {
1292 printk(KERN_ERR "soundscape: Invalid MSS IRQ%d\n", hw_config->irq);
1293 return 0;
1296 if (old_hardware)
1297 ad_flags = 0x12345677; /* Tell that we may have a CS4248 chip (Spea-V7 Media FX) */
1298 else if (sscape_is_pnp)
1299 ad_flags = 0x87654321; /* Tell that we have a soundscape pnp with 1845 chip */
1301 ports = request_region(hw_config->io_base, 4, "ad1848");
1302 if (!ports) {
1303 printk(KERN_ERR "soundscape: ports busy\n");
1304 return 0;
1307 if (!ad1848_detect(ports, &ad_flags, hw_config->osp)) {
1308 release_region(hw_config->io_base, 4);
1309 return 0;
1312 if (!sscape_is_pnp) /*pnp is already setup*/
1315 * Setup the DMA polarity.
1317 sscape_write(devc, GA_DMACFG_REG, 0x50);
1320 * Take the gate-array off of the DMA channel.
1322 sscape_write(devc, GA_DMAB_REG, 0x20);
1325 * Init the AD1848 (CD-ROM) config reg.
1327 sscape_write(devc, GA_CDCFG_REG, 0x89 | (hw_config->dma << 4) | (irq_bits << 1));
1330 if (hw_config->irq == devc->irq)
1331 printk(KERN_WARNING "soundscape: Warning! The WSS mode can't share IRQ with MIDI\n");
1333 hw_config->slots[0] = ad1848_init(
1334 sscape_is_pnp ? "SoundScape" : "SoundScape PNP",
1335 ports,
1336 hw_config->irq,
1337 hw_config->dma,
1338 hw_config->dma,
1340 devc->osp,
1341 THIS_MODULE);
1344 if (hw_config->slots[0] != -1) /* The AD1848 driver installed itself */
1346 audio_devs[hw_config->slots[0]]->coproc = &sscape_coproc_operations;
1347 devc->codec_audiodev = hw_config->slots[0];
1348 devc->my_audiodev = hw_config->slots[0];
1350 /* Set proper routings here (what are they) */
1351 AD1848_REROUTE(SOUND_MIXER_LINE1, SOUND_MIXER_LINE);
1354 #ifdef SSCAPE_DEBUG5
1356 * Temporary debugging aid. Print contents of the registers
1357 * after the AD1848 device has been initialized.
1360 int i;
1362 for (i = 0; i < 13; i++)
1363 printk("I%d = %02x\n", i, sscape_read(devc, i));
1365 #endif
1366 return 1;
1369 static void __exit unload_sscape(struct address_info *hw_config)
1371 release_region(devc->base + 2, 6);
1372 unload_mpu401(hw_config);
1373 if (sscape_is_pnp)
1374 release_region(devc->codec, 2);
1377 static void __exit unload_ss_ms_sound(struct address_info *hw_config)
1379 ad1848_unload(hw_config->io_base,
1380 hw_config->irq,
1381 devc->dma,
1382 devc->dma,
1384 sound_unload_audiodev(hw_config->slots[0]);
1387 static struct address_info cfg;
1388 static struct address_info cfg_mpu;
1390 static int __initdata spea = -1;
1391 static int mss = 0;
1392 static int __initdata dma = -1;
1393 static int __initdata irq = -1;
1394 static int __initdata io = -1;
1395 static int __initdata mpu_irq = -1;
1396 static int __initdata mpu_io = -1;
1398 module_param(dma, int, 0);
1399 module_param(irq, int, 0);
1400 module_param(io, int, 0);
1401 module_param(spea, int, 0); /* spea=0/1 set the old_hardware */
1402 module_param(mpu_irq, int, 0);
1403 module_param(mpu_io, int, 0);
1404 module_param(mss, int, 0);
1406 static int __init init_sscape(void)
1408 printk(KERN_INFO "Soundscape driver Copyright (C) by Hannu Savolainen 1993-1996\n");
1410 cfg.irq = irq;
1411 cfg.dma = dma;
1412 cfg.io_base = io;
1414 cfg_mpu.irq = mpu_irq;
1415 cfg_mpu.io_base = mpu_io;
1416 /* WEH - Try to get right dma channel */
1417 cfg_mpu.dma = dma;
1419 devc->codec = cfg.io_base;
1420 devc->codec_irq = cfg.irq;
1421 devc->codec_type = 0;
1422 devc->ic_type = 0;
1423 devc->raw_buf = NULL;
1424 spin_lock_init(&devc->lock);
1426 if (cfg.dma == -1 || cfg.irq == -1 || cfg.io_base == -1) {
1427 printk(KERN_ERR "DMA, IRQ, and IO port must be specified.\n");
1428 return -EINVAL;
1431 if (cfg_mpu.irq == -1 && cfg_mpu.io_base != -1) {
1432 printk(KERN_ERR "MPU_IRQ must be specified if MPU_IO is set.\n");
1433 return -EINVAL;
1436 if(spea != -1) {
1437 old_hardware = spea;
1438 printk(KERN_INFO "Forcing %s hardware support.\n",
1439 spea?"new":"old");
1441 if (probe_sscape(&cfg_mpu) == 0)
1442 return -ENODEV;
1444 attach_sscape(&cfg_mpu);
1446 mss = init_ss_ms_sound(&cfg);
1448 return 0;
1451 static void __exit cleanup_sscape(void)
1453 if (mss)
1454 unload_ss_ms_sound(&cfg);
1455 unload_sscape(&cfg_mpu);
1458 module_init(init_sscape);
1459 module_exit(cleanup_sscape);
1461 #ifndef MODULE
1462 static int __init setup_sscape(char *str)
1464 /* io, irq, dma, mpu_io, mpu_irq */
1465 int ints[6];
1467 str = get_options(str, ARRAY_SIZE(ints), ints);
1469 io = ints[1];
1470 irq = ints[2];
1471 dma = ints[3];
1472 mpu_io = ints[4];
1473 mpu_irq = ints[5];
1475 return 1;
1478 __setup("sscape=", setup_sscape);
1479 #endif
1480 MODULE_LICENSE("GPL");