2 * Low-level ALSA driver for the ENSONIQ SoundScape PnP
3 * Copyright (c) by Chris Rankin
5 * This driver was written in part using information obtained from
6 * the OSS/Free SoundScape driver, written by Hannu Savolainen.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include <linux/init.h>
25 #include <linux/err.h>
26 #include <linux/isa.h>
27 #include <linux/delay.h>
28 #include <linux/pnp.h>
29 #include <linux/spinlock.h>
30 #include <linux/moduleparam.h>
32 #include <sound/core.h>
33 #include <sound/hwdep.h>
34 #include <sound/wss.h>
35 #include <sound/mpu401.h>
36 #include <sound/initval.h>
38 #include <sound/sscape_ioctl.h>
41 MODULE_AUTHOR("Chris Rankin");
42 MODULE_DESCRIPTION("ENSONIQ SoundScape PnP driver");
43 MODULE_LICENSE("GPL");
45 static int index[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_IDX;
46 static char* id[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_STR;
47 static long port[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_PORT;
48 static long wss_port[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_PORT;
49 static int irq[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_IRQ;
50 static int mpu_irq[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_IRQ;
51 static int dma[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_DMA;
52 static int dma2[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_DMA;
54 module_param_array(index, int, NULL, 0444);
55 MODULE_PARM_DESC(index, "Index number for SoundScape soundcard");
57 module_param_array(id, charp, NULL, 0444);
58 MODULE_PARM_DESC(id, "Description for SoundScape card");
60 module_param_array(port, long, NULL, 0444);
61 MODULE_PARM_DESC(port, "Port # for SoundScape driver.");
63 module_param_array(wss_port, long, NULL, 0444);
64 MODULE_PARM_DESC(wss_port, "WSS Port # for SoundScape driver.");
66 module_param_array(irq, int, NULL, 0444);
67 MODULE_PARM_DESC(irq, "IRQ # for SoundScape driver.");
69 module_param_array(mpu_irq, int, NULL, 0444);
70 MODULE_PARM_DESC(mpu_irq, "MPU401 IRQ # for SoundScape driver.");
72 module_param_array(dma, int, NULL, 0444);
73 MODULE_PARM_DESC(dma, "DMA # for SoundScape driver.");
75 module_param_array(dma2, int, NULL, 0444);
76 MODULE_PARM_DESC(dma2, "DMA2 # for SoundScape driver.");
79 static int isa_registered;
80 static int pnp_registered;
82 static struct pnp_card_device_id sscape_pnpids[] = {
83 { .id = "ENS3081", .devs = { { "ENS0000" } } }, /* Soundscape PnP */
84 { .id = "ENS4081", .devs = { { "ENS1011" } } }, /* VIVO90 */
85 { .id = "" } /* end */
88 MODULE_DEVICE_TABLE(pnp_card, sscape_pnpids);
92 #define HOST_CTRL_IO(i) ((i) + 2)
93 #define HOST_DATA_IO(i) ((i) + 3)
94 #define ODIE_ADDR_IO(i) ((i) + 4)
95 #define ODIE_DATA_IO(i) ((i) + 5)
96 #define CODEC_IO(i) ((i) + 8)
101 #define RX_READY 0x01
102 #define TX_READY 0x02
105 #define CMD_SET_MIDI_VOL 0x84
106 #define CMD_GET_MIDI_VOL 0x85
107 #define CMD_XXX_MIDI_VOL 0x86
108 #define CMD_SET_EXTMIDI 0x8a
109 #define CMD_GET_EXTMIDI 0x8b
110 #define CMD_SET_MT32 0x8c
111 #define CMD_GET_MT32 0x8d
126 #define DMA_8BIT 0x80
130 MEDIA_FX, /* Sequoia S-1000 */
131 SSCAPE, /* Sequoia S-2000 */
141 struct resource *io_res;
142 struct resource *wss_res;
143 struct snd_wss *chip;
144 struct snd_mpu401 *mpu;
145 struct snd_hwdep *hw;
148 * The MIDI device won't work until we've loaded
149 * its firmware via a hardware-dependent device IOCTL
153 unsigned long midi_usage;
154 unsigned char midi_vol;
157 #define INVALID_IRQ ((unsigned)-1)
160 static inline struct soundscape *get_card_soundscape(struct snd_card *c)
162 return (struct soundscape *) (c->private_data);
165 static inline struct soundscape *get_mpu401_soundscape(struct snd_mpu401 * mpu)
167 return (struct soundscape *) (mpu->private_data);
170 static inline struct soundscape *get_hwdep_soundscape(struct snd_hwdep * hw)
172 return (struct soundscape *) (hw->private_data);
177 * Allocates some kernel memory that we can use for DMA.
178 * I think this means that the memory has to map to
179 * contiguous pages of physical memory.
181 static struct snd_dma_buffer *get_dmabuf(struct snd_dma_buffer *buf, unsigned long size)
184 if (snd_dma_alloc_pages_fallback(SNDRV_DMA_TYPE_DEV, snd_dma_isa_data(),
186 snd_printk(KERN_ERR "sscape: Failed to allocate %lu bytes for DMA\n", size);
195 * Release the DMA-able kernel memory ...
197 static void free_dmabuf(struct snd_dma_buffer *buf)
199 if (buf && buf->area)
200 snd_dma_free_pages(buf);
205 * This function writes to the SoundScape's control registers,
206 * but doesn't do any locking. It's up to the caller to do that.
207 * This is why this function is "unsafe" ...
209 static inline void sscape_write_unsafe(unsigned io_base, enum GA_REG reg, unsigned char val)
211 outb(reg, ODIE_ADDR_IO(io_base));
212 outb(val, ODIE_DATA_IO(io_base));
216 * Write to the SoundScape's control registers, and do the
217 * necessary locking ...
219 static void sscape_write(struct soundscape *s, enum GA_REG reg, unsigned char val)
223 spin_lock_irqsave(&s->lock, flags);
224 sscape_write_unsafe(s->io_base, reg, val);
225 spin_unlock_irqrestore(&s->lock, flags);
229 * Read from the SoundScape's control registers, but leave any
230 * locking to the caller. This is why the function is "unsafe" ...
232 static inline unsigned char sscape_read_unsafe(unsigned io_base, enum GA_REG reg)
234 outb(reg, ODIE_ADDR_IO(io_base));
235 return inb(ODIE_DATA_IO(io_base));
239 * Puts the SoundScape into "host" mode, as compared to "MIDI" mode
241 static inline void set_host_mode_unsafe(unsigned io_base)
243 outb(0x0, HOST_CTRL_IO(io_base));
247 * Puts the SoundScape into "MIDI" mode, as compared to "host" mode
249 static inline void set_midi_mode_unsafe(unsigned io_base)
251 outb(0x3, HOST_CTRL_IO(io_base));
255 * Read the SoundScape's host-mode control register, but leave
256 * any locking issues to the caller ...
258 static inline int host_read_unsafe(unsigned io_base)
261 if ((inb(HOST_CTRL_IO(io_base)) & RX_READY) != 0) {
262 data = inb(HOST_DATA_IO(io_base));
269 * Read the SoundScape's host-mode control register, performing
270 * a limited amount of busy-waiting if the register isn't ready.
271 * Also leaves all locking-issues to the caller ...
273 static int host_read_ctrl_unsafe(unsigned io_base, unsigned timeout)
277 while (((data = host_read_unsafe(io_base)) < 0) && (timeout != 0)) {
286 * Write to the SoundScape's host-mode control registers, but
287 * leave any locking issues to the caller ...
289 static inline int host_write_unsafe(unsigned io_base, unsigned char data)
291 if ((inb(HOST_CTRL_IO(io_base)) & TX_READY) != 0) {
292 outb(data, HOST_DATA_IO(io_base));
300 * Write to the SoundScape's host-mode control registers, performing
301 * a limited amount of busy-waiting if the register isn't ready.
302 * Also leaves all locking-issues to the caller ...
304 static int host_write_ctrl_unsafe(unsigned io_base, unsigned char data,
309 while (!(err = host_write_unsafe(io_base, data)) && (timeout != 0)) {
319 * Check that the MIDI subsystem is operational. If it isn't,
320 * then we will hang the computer if we try to use it ...
322 * NOTE: This check is based upon observation, not documentation.
324 static inline int verify_mpu401(const struct snd_mpu401 * mpu)
326 return ((inb(MPU401C(mpu)) & 0xc0) == 0x80);
330 * This is apparently the standard way to initailise an MPU-401
332 static inline void initialise_mpu401(const struct snd_mpu401 * mpu)
334 outb(0, MPU401D(mpu));
338 * Tell the SoundScape to activate the AD1845 chip (I think).
339 * The AD1845 detection fails if we *don't* do this, so I
340 * think that this is a good idea ...
342 static inline void activate_ad1845_unsafe(unsigned io_base)
344 sscape_write_unsafe(io_base, GA_HMCTL_REG, (sscape_read_unsafe(io_base, GA_HMCTL_REG) & 0xcf) | 0x10);
345 sscape_write_unsafe(io_base, GA_CDCFG_REG, 0x80);
349 * Do the necessary ALSA-level cleanup to deallocate our driver ...
351 static void soundscape_free(struct snd_card *c)
353 struct soundscape *sscape = get_card_soundscape(c);
354 release_and_free_resource(sscape->io_res);
355 release_and_free_resource(sscape->wss_res);
356 free_dma(sscape->chip->dma1);
360 * Tell the SoundScape to begin a DMA tranfer using the given channel.
361 * All locking issues are left to the caller.
363 static inline void sscape_start_dma_unsafe(unsigned io_base, enum GA_REG reg)
365 sscape_write_unsafe(io_base, reg, sscape_read_unsafe(io_base, reg) | 0x01);
366 sscape_write_unsafe(io_base, reg, sscape_read_unsafe(io_base, reg) & 0xfe);
370 * Wait for a DMA transfer to complete. This is a "limited busy-wait",
371 * and all locking issues are left to the caller.
373 static int sscape_wait_dma_unsafe(unsigned io_base, enum GA_REG reg, unsigned timeout)
375 while (!(sscape_read_unsafe(io_base, reg) & 0x01) && (timeout != 0)) {
380 return (sscape_read_unsafe(io_base, reg) & 0x01);
384 * Wait for the On-Board Processor to return its start-up
385 * acknowledgement sequence. This wait is too long for
386 * us to perform "busy-waiting", and so we must sleep.
387 * This in turn means that we must not be holding any
388 * spinlocks when we call this function.
390 static int obp_startup_ack(struct soundscape *s, unsigned timeout)
392 unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
398 spin_lock_irqsave(&s->lock, flags);
399 x = inb(HOST_DATA_IO(s->io_base));
400 spin_unlock_irqrestore(&s->lock, flags);
401 if ((x & 0xfe) == 0xfe)
405 } while (time_before(jiffies, end_time));
411 * Wait for the host to return its start-up acknowledgement
412 * sequence. This wait is too long for us to perform
413 * "busy-waiting", and so we must sleep. This in turn means
414 * that we must not be holding any spinlocks when we call
417 static int host_startup_ack(struct soundscape *s, unsigned timeout)
419 unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
425 spin_lock_irqsave(&s->lock, flags);
426 x = inb(HOST_DATA_IO(s->io_base));
427 spin_unlock_irqrestore(&s->lock, flags);
432 } while (time_before(jiffies, end_time));
438 * Upload a byte-stream into the SoundScape using DMA channel A.
440 static int upload_dma_data(struct soundscape *s,
441 const unsigned char __user *data,
445 struct snd_dma_buffer dma;
448 if (!get_dmabuf(&dma, PAGE_ALIGN(size)))
451 spin_lock_irqsave(&s->lock, flags);
454 * Reset the board ...
456 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f);
459 * Enable the DMA channels and configure them ...
461 sscape_write_unsafe(s->io_base, GA_DMACFG_REG, 0x50);
462 sscape_write_unsafe(s->io_base, GA_DMAA_REG, (s->chip->dma1 << 4) | DMA_8BIT);
463 sscape_write_unsafe(s->io_base, GA_DMAB_REG, 0x20);
466 * Take the board out of reset ...
468 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) | 0x80);
471 * Upload the user's data (firmware?) to the SoundScape
472 * board through the DMA channel ...
478 * Apparently, copying to/from userspace can sleep.
479 * We are therefore forbidden from holding any
480 * spinlocks while we copy ...
482 spin_unlock_irqrestore(&s->lock, flags);
485 * Remember that the data that we want to DMA
486 * comes from USERSPACE. We have already verified
487 * the userspace pointer ...
489 len = min(size, dma.bytes);
490 len -= __copy_from_user(dma.area, data, len);
495 * Grab that spinlock again, now that we've
498 spin_lock_irqsave(&s->lock, flags);
500 snd_dma_program(s->chip->dma1, dma.addr, len, DMA_MODE_WRITE);
501 sscape_start_dma_unsafe(s->io_base, GA_DMAA_REG);
502 if (!sscape_wait_dma_unsafe(s->io_base, GA_DMAA_REG, 5000)) {
504 * Don't forget to release this spinlock we're holding ...
506 spin_unlock_irqrestore(&s->lock, flags);
508 snd_printk(KERN_ERR "sscape: DMA upload has timed out\n");
514 set_host_mode_unsafe(s->io_base);
517 * Boot the board ... (I think)
519 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) | 0x40);
520 spin_unlock_irqrestore(&s->lock, flags);
523 * If all has gone well, then the board should acknowledge
524 * the new upload and tell us that it has rebooted OK. We
525 * give it 5 seconds (max) ...
528 if (!obp_startup_ack(s, 5000)) {
529 snd_printk(KERN_ERR "sscape: No response from on-board processor after upload\n");
531 } else if (!host_startup_ack(s, 5000)) {
532 snd_printk(KERN_ERR "sscape: SoundScape failed to initialise\n");
538 * NOTE!!! We are NOT holding any spinlocks at this point !!!
540 sscape_write(s, GA_DMAA_REG, (s->ic_type == IC_ODIE ? 0x70 : 0x40));
547 * Upload the bootblock(?) into the SoundScape. The only
548 * purpose of this block of code seems to be to tell
549 * us which version of the microcode we should be using.
551 * NOTE: The boot-block data resides in USER-SPACE!!!
552 * However, we have already verified its memory
553 * addresses by the time we get here.
555 static int sscape_upload_bootblock(struct soundscape *sscape, struct sscape_bootblock __user *bb)
561 ret = upload_dma_data(sscape, bb->code, sizeof(bb->code));
563 spin_lock_irqsave(&sscape->lock, flags);
565 data = host_read_ctrl_unsafe(sscape->io_base, 100);
567 set_midi_mode_unsafe(sscape->io_base);
568 spin_unlock_irqrestore(&sscape->lock, flags);
572 snd_printk(KERN_ERR "sscape: timeout reading firmware version\n");
575 else if (__copy_to_user(&bb->version, &data, sizeof(bb->version))) {
584 * Upload the microcode into the SoundScape. The
585 * microcode is 64K of data, and if we try to copy
586 * it into a local variable then we will SMASH THE
587 * KERNEL'S STACK! We therefore leave it in USER
588 * SPACE, and save ourselves from copying it at all.
590 static int sscape_upload_microcode(struct soundscape *sscape,
591 const struct sscape_microcode __user *mc)
598 * We are going to have to copy this data into a special
599 * DMA-able buffer before we can upload it. We shall therefore
600 * just check that the data pointer is valid for now.
602 * NOTE: This buffer is 64K long! That's WAY too big to
603 * copy into a stack-temporary anyway.
605 if ( get_user(code, &mc->code) ||
606 !access_ok(VERIFY_READ, code, SSCAPE_MICROCODE_SIZE) )
609 if ((err = upload_dma_data(sscape, code, SSCAPE_MICROCODE_SIZE)) == 0) {
610 snd_printk(KERN_INFO "sscape: MIDI firmware loaded\n");
613 spin_lock_irqsave(&sscape->lock, flags);
614 set_midi_mode_unsafe(sscape->io_base);
615 spin_unlock_irqrestore(&sscape->lock, flags);
617 initialise_mpu401(sscape->mpu);
623 * Hardware-specific device functions, to implement special
624 * IOCTLs for the SoundScape card. This is how we upload
625 * the microcode into the card, for example, and so we
626 * must ensure that no two processes can open this device
627 * simultaneously, and that we can't open it at all if
628 * someone is using the MIDI device.
630 static int sscape_hw_open(struct snd_hwdep * hw, struct file *file)
632 register struct soundscape *sscape = get_hwdep_soundscape(hw);
636 spin_lock_irqsave(&sscape->fwlock, flags);
638 if ((sscape->midi_usage != 0) || sscape->hw_in_use) {
641 sscape->hw_in_use = 1;
645 spin_unlock_irqrestore(&sscape->fwlock, flags);
649 static int sscape_hw_release(struct snd_hwdep * hw, struct file *file)
651 register struct soundscape *sscape = get_hwdep_soundscape(hw);
654 spin_lock_irqsave(&sscape->fwlock, flags);
655 sscape->hw_in_use = 0;
656 spin_unlock_irqrestore(&sscape->fwlock, flags);
660 static int sscape_hw_ioctl(struct snd_hwdep * hw, struct file *file,
661 unsigned int cmd, unsigned long arg)
663 struct soundscape *sscape = get_hwdep_soundscape(hw);
667 case SND_SSCAPE_LOAD_BOOTB:
669 register struct sscape_bootblock __user *bb = (struct sscape_bootblock __user *) arg;
672 * We are going to have to copy this data into a special
673 * DMA-able buffer before we can upload it. We shall therefore
674 * just check that the data pointer is valid for now ...
676 if ( !access_ok(VERIFY_READ, bb->code, sizeof(bb->code)) )
680 * Now check that we can write the firmware version number too...
682 if ( !access_ok(VERIFY_WRITE, &bb->version, sizeof(bb->version)) )
685 err = sscape_upload_bootblock(sscape, bb);
689 case SND_SSCAPE_LOAD_MCODE:
691 register const struct sscape_microcode __user *mc = (const struct sscape_microcode __user *) arg;
693 err = sscape_upload_microcode(sscape, mc);
707 * Mixer control for the SoundScape's MIDI device.
709 static int sscape_midi_info(struct snd_kcontrol *ctl,
710 struct snd_ctl_elem_info *uinfo)
712 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
714 uinfo->value.integer.min = 0;
715 uinfo->value.integer.max = 127;
719 static int sscape_midi_get(struct snd_kcontrol *kctl,
720 struct snd_ctl_elem_value *uctl)
722 struct snd_wss *chip = snd_kcontrol_chip(kctl);
723 struct snd_card *card = chip->card;
724 register struct soundscape *s = get_card_soundscape(card);
727 spin_lock_irqsave(&s->lock, flags);
728 uctl->value.integer.value[0] = s->midi_vol;
729 spin_unlock_irqrestore(&s->lock, flags);
733 static int sscape_midi_put(struct snd_kcontrol *kctl,
734 struct snd_ctl_elem_value *uctl)
736 struct snd_wss *chip = snd_kcontrol_chip(kctl);
737 struct snd_card *card = chip->card;
738 register struct soundscape *s = get_card_soundscape(card);
742 spin_lock_irqsave(&s->lock, flags);
745 * We need to put the board into HOST mode before we
746 * can send any volume-changing HOST commands ...
748 set_host_mode_unsafe(s->io_base);
751 * To successfully change the MIDI volume setting, you seem to
752 * have to write a volume command, write the new volume value,
753 * and then perform another volume-related command. Perhaps the
754 * first command is an "open" and the second command is a "close"?
756 if (s->midi_vol == ((unsigned char) uctl->value.integer. value[0] & 127)) {
760 change = (host_write_ctrl_unsafe(s->io_base, CMD_SET_MIDI_VOL, 100)
761 && host_write_ctrl_unsafe(s->io_base, ((unsigned char) uctl->value.integer. value[0]) & 127, 100)
762 && host_write_ctrl_unsafe(s->io_base, CMD_XXX_MIDI_VOL, 100));
763 s->midi_vol = (unsigned char) uctl->value.integer.value[0] & 127;
767 * Take the board out of HOST mode and back into MIDI mode ...
769 set_midi_mode_unsafe(s->io_base);
771 spin_unlock_irqrestore(&s->lock, flags);
775 static struct snd_kcontrol_new midi_mixer_ctl = {
776 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
778 .info = sscape_midi_info,
779 .get = sscape_midi_get,
780 .put = sscape_midi_put
784 * The SoundScape can use two IRQs from a possible set of four.
785 * These IRQs are encoded as bit patterns so that they can be
786 * written to the control registers.
788 static unsigned __devinit get_irq_config(int sscape_type, int irq)
790 static const int valid_irq[] = { 9, 5, 7, 10 };
791 static const int old_irq[] = { 9, 7, 5, 15 };
794 if (sscape_type == MEDIA_FX) {
795 for (cfg = 0; cfg < ARRAY_SIZE(old_irq); ++cfg)
796 if (irq == old_irq[cfg])
799 for (cfg = 0; cfg < ARRAY_SIZE(valid_irq); ++cfg)
800 if (irq == valid_irq[cfg])
808 * Perform certain arcane port-checks to see whether there
809 * is a SoundScape board lurking behind the given ports.
811 static int __devinit detect_sscape(struct soundscape *s, long wss_io)
817 spin_lock_irqsave(&s->lock, flags);
820 * The following code is lifted from the original OSS driver,
821 * and as I don't have a datasheet I cannot really comment
822 * on what it is doing...
824 if ((inb(HOST_CTRL_IO(s->io_base)) & 0x78) != 0)
827 d = inb(ODIE_ADDR_IO(s->io_base)) & 0xf0;
832 s->ic_type = IC_ODIE;
833 else if ((d & 0x60) != 0)
834 s->ic_type = IC_OPUS;
838 outb(0xfa, ODIE_ADDR_IO(s->io_base));
839 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0a)
842 outb(0xfe, ODIE_ADDR_IO(s->io_base));
843 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0e)
846 outb(0xfe, ODIE_ADDR_IO(s->io_base));
847 d = inb(ODIE_DATA_IO(s->io_base));
848 if (s->type != SSCAPE_VIVO && (d & 0x9f) != 0x0e)
851 if (s->ic_type == IC_OPUS)
852 activate_ad1845_unsafe(s->io_base);
854 if (s->type == SSCAPE_VIVO)
857 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f;
858 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
860 /* wait for WSS codec */
861 for (d = 0; d < 500; d++) {
862 if ((inb(wss_io) & 0x80) == 0)
864 spin_unlock_irqrestore(&s->lock, flags);
866 spin_lock_irqsave(&s->lock, flags);
868 snd_printd(KERN_INFO "init delay = %d ms\n", d);
870 if ((inb(wss_io) & 0x80) != 0)
873 if (inb(wss_io + 2) == 0xff)
876 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f;
877 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d);
879 if ((inb(wss_io) & 0x80) != 0)
882 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f;
883 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
884 /* wait for WSS codec */
885 for (d = 0; d < 500; d++) {
886 if ((inb(wss_io) & 0x80) == 0)
888 spin_unlock_irqrestore(&s->lock, flags);
890 spin_lock_irqsave(&s->lock, flags);
892 snd_printd(KERN_INFO "init delay = %d ms\n", d);
895 * SoundScape successfully detected!
900 spin_unlock_irqrestore(&s->lock, flags);
905 * ALSA callback function, called when attempting to open the MIDI device.
906 * Check that the MIDI firmware has been loaded, because we don't want
907 * to crash the machine. Also check that someone isn't using the hardware
910 static int mpu401_open(struct snd_mpu401 * mpu)
914 if (!verify_mpu401(mpu)) {
915 snd_printk(KERN_ERR "sscape: MIDI disabled, please load firmware\n");
918 register struct soundscape *sscape = get_mpu401_soundscape(mpu);
921 spin_lock_irqsave(&sscape->fwlock, flags);
923 if (sscape->hw_in_use || (sscape->midi_usage == ULONG_MAX)) {
926 ++(sscape->midi_usage);
930 spin_unlock_irqrestore(&sscape->fwlock, flags);
936 static void mpu401_close(struct snd_mpu401 * mpu)
938 register struct soundscape *sscape = get_mpu401_soundscape(mpu);
941 spin_lock_irqsave(&sscape->fwlock, flags);
942 --(sscape->midi_usage);
943 spin_unlock_irqrestore(&sscape->fwlock, flags);
947 * Initialse an MPU-401 subdevice for MIDI support on the SoundScape.
949 static int __devinit create_mpu401(struct snd_card *card, int devnum, unsigned long port, int irq)
951 struct soundscape *sscape = get_card_soundscape(card);
952 struct snd_rawmidi *rawmidi;
955 if ((err = snd_mpu401_uart_new(card, devnum,
957 port, MPU401_INFO_INTEGRATED,
960 struct snd_mpu401 *mpu = (struct snd_mpu401 *) rawmidi->private_data;
961 mpu->open_input = mpu401_open;
962 mpu->open_output = mpu401_open;
963 mpu->close_input = mpu401_close;
964 mpu->close_output = mpu401_close;
965 mpu->private_data = sscape;
968 initialise_mpu401(mpu);
976 * Create an AD1845 PCM subdevice on the SoundScape. The AD1845
977 * is very much like a CS4231, with a few extra bits. We will
978 * try to support at least some of the extra bits by overriding
979 * some of the CS4231 callback.
981 static int __devinit create_ad1845(struct snd_card *card, unsigned port,
982 int irq, int dma1, int dma2)
984 register struct soundscape *sscape = get_card_soundscape(card);
985 struct snd_wss *chip;
988 if (sscape->type == SSCAPE_VIVO)
991 err = snd_wss_create(card, port, -1, irq, dma1, dma2,
992 WSS_HW_DETECT, WSS_HWSHARE_DMA1, &chip);
998 * It turns out that the PLAYBACK_ENABLE bit is set
999 * by the lowlevel driver ...
1001 #define AD1845_IFACE_CONFIG \
1002 (CS4231_AUTOCALIB | CS4231_RECORD_ENABLE | CS4231_PLAYBACK_ENABLE)
1003 snd_wss_mce_up(chip);
1004 spin_lock_irqsave(&chip->reg_lock, flags);
1005 snd_wss_out(chip, CS4231_IFACE_CTRL, AD1845_IFACE_CONFIG);
1006 spin_unlock_irqrestore(&chip->reg_lock, flags);
1007 snd_wss_mce_down(chip);
1010 if (sscape->type != SSCAPE_VIVO) {
1012 * The input clock frequency on the SoundScape must
1013 * be 14.31818 MHz, because we must set this register
1014 * to get the playback to sound correct ...
1016 snd_wss_mce_up(chip);
1017 spin_lock_irqsave(&chip->reg_lock, flags);
1018 snd_wss_out(chip, AD1845_CLOCK, 0x20);
1019 spin_unlock_irqrestore(&chip->reg_lock, flags);
1020 snd_wss_mce_down(chip);
1024 err = snd_wss_pcm(chip, 0, &pcm);
1026 snd_printk(KERN_ERR "sscape: No PCM device "
1027 "for AD1845 chip\n");
1031 err = snd_wss_mixer(chip);
1033 snd_printk(KERN_ERR "sscape: No mixer device "
1034 "for AD1845 chip\n");
1037 if (chip->hardware != WSS_HW_AD1848) {
1038 err = snd_wss_timer(chip, 0, NULL);
1040 snd_printk(KERN_ERR "sscape: No timer device "
1041 "for AD1845 chip\n");
1046 if (sscape->type != SSCAPE_VIVO) {
1047 err = snd_ctl_add(card,
1048 snd_ctl_new1(&midi_mixer_ctl, chip));
1050 snd_printk(KERN_ERR "sscape: Could not create "
1051 "MIDI mixer control\n");
1056 strcpy(card->driver, "SoundScape");
1057 strcpy(card->shortname, pcm->name);
1058 snprintf(card->longname, sizeof(card->longname),
1059 "%s at 0x%lx, IRQ %d, DMA1 %d, DMA2 %d\n",
1060 pcm->name, chip->port, chip->irq,
1061 chip->dma1, chip->dma2);
1063 sscape->chip = chip;
1072 * Create an ALSA soundcard entry for the SoundScape, using
1073 * the given list of port, IRQ and DMA resources.
1075 static int __devinit create_sscape(int dev, struct snd_card *card)
1077 struct soundscape *sscape = get_card_soundscape(card);
1080 unsigned mpu_irq_cfg;
1081 struct resource *io_res;
1082 struct resource *wss_res;
1083 unsigned long flags;
1088 * Grab IO ports that we will need to probe so that we
1089 * can detect and control this hardware ...
1091 io_res = request_region(port[dev], 8, "SoundScape");
1094 "sscape: can't grab port 0x%lx\n", port[dev]);
1098 if (sscape->type == SSCAPE_VIVO) {
1099 wss_res = request_region(wss_port[dev], 4, "SoundScape");
1101 snd_printk(KERN_ERR "sscape: can't grab port 0x%lx\n",
1104 goto _release_region;
1109 * Grab one DMA channel ...
1111 err = request_dma(dma[dev], "SoundScape");
1113 snd_printk(KERN_ERR "sscape: can't grab DMA %d\n", dma[dev]);
1114 goto _release_region;
1117 spin_lock_init(&sscape->lock);
1118 spin_lock_init(&sscape->fwlock);
1119 sscape->io_res = io_res;
1120 sscape->wss_res = wss_res;
1121 sscape->io_base = port[dev];
1123 if (!detect_sscape(sscape, wss_port[dev])) {
1124 printk(KERN_ERR "sscape: hardware not detected at 0x%x\n", sscape->io_base);
1129 switch (sscape->type) {
1131 name = "MediaFX/SoundFX";
1134 name = "Soundscape";
1137 name = "Soundscape PnP";
1140 name = "Soundscape VIVO";
1143 name = "unknown Soundscape";
1147 printk(KERN_INFO "sscape: %s card detected at 0x%x, using IRQ %d, DMA %d\n",
1148 name, sscape->io_base, irq[dev], dma[dev]);
1151 * Check that the user didn't pass us garbage data ...
1153 irq_cfg = get_irq_config(sscape->type, irq[dev]);
1154 if (irq_cfg == INVALID_IRQ) {
1155 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", irq[dev]);
1159 mpu_irq_cfg = get_irq_config(sscape->type, mpu_irq[dev]);
1160 if (mpu_irq_cfg == INVALID_IRQ) {
1161 printk(KERN_ERR "sscape: Invalid IRQ %d\n", mpu_irq[dev]);
1165 if (sscape->type != SSCAPE_VIVO) {
1167 * Now create the hardware-specific device so that we can
1168 * load the microcode into the on-board processor.
1169 * We cannot use the MPU-401 MIDI system until this firmware
1170 * has been loaded into the card.
1172 err = snd_hwdep_new(card, "MC68EC000", 0, &(sscape->hw));
1174 printk(KERN_ERR "sscape: Failed to create "
1175 "firmware device\n");
1178 strlcpy(sscape->hw->name, "SoundScape M68K",
1179 sizeof(sscape->hw->name));
1180 sscape->hw->name[sizeof(sscape->hw->name) - 1] = '\0';
1181 sscape->hw->iface = SNDRV_HWDEP_IFACE_SSCAPE;
1182 sscape->hw->ops.open = sscape_hw_open;
1183 sscape->hw->ops.release = sscape_hw_release;
1184 sscape->hw->ops.ioctl = sscape_hw_ioctl;
1185 sscape->hw->private_data = sscape;
1189 * Tell the on-board devices where their resources are (I think -
1190 * I can't be sure without a datasheet ... So many magic values!)
1192 spin_lock_irqsave(&sscape->lock, flags);
1194 sscape_write_unsafe(sscape->io_base, GA_INTENA_REG, 0x00); /* disable */
1195 sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2e);
1196 sscape_write_unsafe(sscape->io_base, GA_SMCFGB_REG, 0x00);
1199 * Enable and configure the DMA channels ...
1201 sscape_write_unsafe(sscape->io_base, GA_DMACFG_REG, 0x50);
1202 dma_cfg = (sscape->ic_type == IC_OPUS ? 0x40 : 0x70);
1203 sscape_write_unsafe(sscape->io_base, GA_DMAA_REG, dma_cfg);
1204 sscape_write_unsafe(sscape->io_base, GA_DMAB_REG, 0x20);
1206 mpu_irq_cfg |= mpu_irq_cfg << 2;
1207 sscape_write_unsafe(sscape->io_base, GA_INTCFG_REG, 0xf0 | mpu_irq_cfg);
1208 sscape_write_unsafe(sscape->io_base,
1209 GA_CDCFG_REG, 0x09 | DMA_8BIT
1210 | (dma[dev] << 4) | (irq_cfg << 1));
1212 spin_unlock_irqrestore(&sscape->lock, flags);
1215 * We have now enabled the codec chip, and so we should
1216 * detect the AD1845 device ...
1218 err = create_ad1845(card, wss_port[dev], irq[dev],
1219 dma[dev], dma2[dev]);
1221 printk(KERN_ERR "sscape: No AD1845 device at 0x%lx, IRQ %d\n",
1222 wss_port[dev], irq[dev]);
1225 #define MIDI_DEVNUM 0
1226 if (sscape->type != SSCAPE_VIVO) {
1227 err = create_mpu401(card, MIDI_DEVNUM, port[dev], mpu_irq[dev]);
1229 printk(KERN_ERR "sscape: Failed to create "
1230 "MPU-401 device at 0x%lx\n",
1236 * Enable the master IRQ ...
1238 sscape_write(sscape, GA_INTENA_REG, 0x80);
1243 sscape->midi_vol = 0;
1244 host_write_ctrl_unsafe(sscape->io_base, CMD_SET_MIDI_VOL, 100);
1245 host_write_ctrl_unsafe(sscape->io_base, 0, 100);
1246 host_write_ctrl_unsafe(sscape->io_base, CMD_XXX_MIDI_VOL, 100);
1250 * Now that we have successfully created this sound card,
1251 * it is safe to store the pointer.
1252 * NOTE: we only register the sound card's "destructor"
1253 * function now that our "constructor" has completed.
1255 card->private_free = soundscape_free;
1263 release_and_free_resource(wss_res);
1264 release_and_free_resource(io_res);
1270 static int __devinit snd_sscape_match(struct device *pdev, unsigned int i)
1273 * Make sure we were given ALL of the other parameters.
1275 if (port[i] == SNDRV_AUTO_PORT)
1278 if (irq[i] == SNDRV_AUTO_IRQ ||
1279 mpu_irq[i] == SNDRV_AUTO_IRQ ||
1280 dma[i] == SNDRV_AUTO_DMA) {
1282 "sscape: insufficient parameters, need IO, IRQ, MPU-IRQ and DMA\n");
1289 static int __devinit snd_sscape_probe(struct device *pdev, unsigned int dev)
1291 struct snd_card *card;
1292 struct soundscape *sscape;
1295 ret = snd_card_create(index[dev], id[dev], THIS_MODULE,
1296 sizeof(struct soundscape), &card);
1300 sscape = get_card_soundscape(card);
1301 sscape->type = SSCAPE;
1304 ret = create_sscape(dev, card);
1308 snd_card_set_dev(card, pdev);
1309 if ((ret = snd_card_register(card)) < 0) {
1310 printk(KERN_ERR "sscape: Failed to register sound card\n");
1313 dev_set_drvdata(pdev, card);
1317 snd_card_free(card);
1321 static int __devexit snd_sscape_remove(struct device *devptr, unsigned int dev)
1323 snd_card_free(dev_get_drvdata(devptr));
1324 dev_set_drvdata(devptr, NULL);
1328 #define DEV_NAME "sscape"
1330 static struct isa_driver snd_sscape_driver = {
1331 .match = snd_sscape_match,
1332 .probe = snd_sscape_probe,
1333 .remove = __devexit_p(snd_sscape_remove),
1334 /* FIXME: suspend/resume */
1341 static inline int __devinit get_next_autoindex(int i)
1343 while (i < SNDRV_CARDS && port[i] != SNDRV_AUTO_PORT)
1349 static int __devinit sscape_pnp_detect(struct pnp_card_link *pcard,
1350 const struct pnp_card_device_id *pid)
1353 struct pnp_dev *dev;
1354 struct snd_card *card;
1355 struct soundscape *sscape;
1359 * Allow this function to fail *quietly* if all the ISA PnP
1360 * devices were configured using module parameters instead.
1362 if ((idx = get_next_autoindex(idx)) >= SNDRV_CARDS)
1366 * We have found a candidate ISA PnP card. Now we
1367 * have to check that it has the devices that we
1368 * expect it to have.
1370 * We will NOT try and autoconfigure all of the resources
1371 * needed and then activate the card as we are assuming that
1372 * has already been done at boot-time using /proc/isapnp.
1373 * We shall simply try to give each active card the resources
1374 * that it wants. This is a sensible strategy for a modular
1375 * system where unused modules are unloaded regularly.
1377 * This strategy is utterly useless if we compile the driver
1378 * into the kernel, of course.
1380 // printk(KERN_INFO "sscape: %s\n", card->name);
1383 * Check that we still have room for another sound card ...
1385 dev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
1389 if (!pnp_is_active(dev)) {
1390 if (pnp_activate_dev(dev) < 0) {
1391 printk(KERN_INFO "sscape: device is inactive\n");
1397 * Create a new ALSA sound card entry, in anticipation
1398 * of detecting our hardware ...
1400 ret = snd_card_create(index[idx], id[idx], THIS_MODULE,
1401 sizeof(struct soundscape), &card);
1405 sscape = get_card_soundscape(card);
1408 * Identify card model ...
1410 if (!strncmp("ENS4081", pid->id, 7))
1411 sscape->type = SSCAPE_VIVO;
1413 sscape->type = SSCAPE_PNP;
1416 * Read the correct parameters off the ISA PnP bus ...
1418 port[idx] = pnp_port_start(dev, 0);
1419 irq[idx] = pnp_irq(dev, 0);
1420 mpu_irq[idx] = pnp_irq(dev, 1);
1421 dma[idx] = pnp_dma(dev, 0) & 0x03;
1422 if (sscape->type == SSCAPE_PNP) {
1423 dma2[idx] = dma[idx];
1424 wss_port[idx] = CODEC_IO(port[idx]);
1426 wss_port[idx] = pnp_port_start(dev, 1);
1427 dma2[idx] = pnp_dma(dev, 1);
1430 ret = create_sscape(idx, card);
1434 snd_card_set_dev(card, &pcard->card->dev);
1435 if ((ret = snd_card_register(card)) < 0) {
1436 printk(KERN_ERR "sscape: Failed to register sound card\n");
1440 pnp_set_card_drvdata(pcard, card);
1445 snd_card_free(card);
1449 static void __devexit sscape_pnp_remove(struct pnp_card_link * pcard)
1451 snd_card_free(pnp_get_card_drvdata(pcard));
1452 pnp_set_card_drvdata(pcard, NULL);
1455 static struct pnp_card_driver sscape_pnpc_driver = {
1456 .flags = PNP_DRIVER_RES_DO_NOT_CHANGE,
1458 .id_table = sscape_pnpids,
1459 .probe = sscape_pnp_detect,
1460 .remove = __devexit_p(sscape_pnp_remove),
1463 #endif /* CONFIG_PNP */
1465 static int __init sscape_init(void)
1469 err = isa_register_driver(&snd_sscape_driver, SNDRV_CARDS);
1474 err = pnp_register_card_driver(&sscape_pnpc_driver);
1484 static void __exit sscape_exit(void)
1488 pnp_unregister_card_driver(&sscape_pnpc_driver);
1491 isa_unregister_driver(&snd_sscape_driver);
1494 module_init(sscape_init);
1495 module_exit(sscape_exit);