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
142 struct resource *io_res;
143 struct resource *wss_res;
144 struct snd_wss *chip;
145 struct snd_mpu401 *mpu;
146 struct snd_hwdep *hw;
149 * The MIDI device won't work until we've loaded
150 * its firmware via a hardware-dependent device IOCTL
154 unsigned long midi_usage;
155 unsigned char midi_vol;
158 #define INVALID_IRQ ((unsigned)-1)
161 static inline struct soundscape *get_card_soundscape(struct snd_card *c)
163 return (struct soundscape *) (c->private_data);
166 static inline struct soundscape *get_mpu401_soundscape(struct snd_mpu401 * mpu)
168 return (struct soundscape *) (mpu->private_data);
171 static inline struct soundscape *get_hwdep_soundscape(struct snd_hwdep * hw)
173 return (struct soundscape *) (hw->private_data);
178 * Allocates some kernel memory that we can use for DMA.
179 * I think this means that the memory has to map to
180 * contiguous pages of physical memory.
182 static struct snd_dma_buffer *get_dmabuf(struct snd_dma_buffer *buf, unsigned long size)
185 if (snd_dma_alloc_pages_fallback(SNDRV_DMA_TYPE_DEV, snd_dma_isa_data(),
187 snd_printk(KERN_ERR "sscape: Failed to allocate %lu bytes for DMA\n", size);
196 * Release the DMA-able kernel memory ...
198 static void free_dmabuf(struct snd_dma_buffer *buf)
200 if (buf && buf->area)
201 snd_dma_free_pages(buf);
206 * This function writes to the SoundScape's control registers,
207 * but doesn't do any locking. It's up to the caller to do that.
208 * This is why this function is "unsafe" ...
210 static inline void sscape_write_unsafe(unsigned io_base, enum GA_REG reg, unsigned char val)
212 outb(reg, ODIE_ADDR_IO(io_base));
213 outb(val, ODIE_DATA_IO(io_base));
217 * Write to the SoundScape's control registers, and do the
218 * necessary locking ...
220 static void sscape_write(struct soundscape *s, enum GA_REG reg, unsigned char val)
224 spin_lock_irqsave(&s->lock, flags);
225 sscape_write_unsafe(s->io_base, reg, val);
226 spin_unlock_irqrestore(&s->lock, flags);
230 * Read from the SoundScape's control registers, but leave any
231 * locking to the caller. This is why the function is "unsafe" ...
233 static inline unsigned char sscape_read_unsafe(unsigned io_base, enum GA_REG reg)
235 outb(reg, ODIE_ADDR_IO(io_base));
236 return inb(ODIE_DATA_IO(io_base));
240 * Puts the SoundScape into "host" mode, as compared to "MIDI" mode
242 static inline void set_host_mode_unsafe(unsigned io_base)
244 outb(0x0, HOST_CTRL_IO(io_base));
248 * Puts the SoundScape into "MIDI" mode, as compared to "host" mode
250 static inline void set_midi_mode_unsafe(unsigned io_base)
252 outb(0x3, HOST_CTRL_IO(io_base));
256 * Read the SoundScape's host-mode control register, but leave
257 * any locking issues to the caller ...
259 static inline int host_read_unsafe(unsigned io_base)
262 if ((inb(HOST_CTRL_IO(io_base)) & RX_READY) != 0) {
263 data = inb(HOST_DATA_IO(io_base));
270 * Read the SoundScape's host-mode control register, performing
271 * a limited amount of busy-waiting if the register isn't ready.
272 * Also leaves all locking-issues to the caller ...
274 static int host_read_ctrl_unsafe(unsigned io_base, unsigned timeout)
278 while (((data = host_read_unsafe(io_base)) < 0) && (timeout != 0)) {
287 * Write to the SoundScape's host-mode control registers, but
288 * leave any locking issues to the caller ...
290 static inline int host_write_unsafe(unsigned io_base, unsigned char data)
292 if ((inb(HOST_CTRL_IO(io_base)) & TX_READY) != 0) {
293 outb(data, HOST_DATA_IO(io_base));
301 * Write to the SoundScape's host-mode control registers, performing
302 * a limited amount of busy-waiting if the register isn't ready.
303 * Also leaves all locking-issues to the caller ...
305 static int host_write_ctrl_unsafe(unsigned io_base, unsigned char data,
310 while (!(err = host_write_unsafe(io_base, data)) && (timeout != 0)) {
320 * Check that the MIDI subsystem is operational. If it isn't,
321 * then we will hang the computer if we try to use it ...
323 * NOTE: This check is based upon observation, not documentation.
325 static inline int verify_mpu401(const struct snd_mpu401 * mpu)
327 return ((inb(MPU401C(mpu)) & 0xc0) == 0x80);
331 * This is apparently the standard way to initailise an MPU-401
333 static inline void initialise_mpu401(const struct snd_mpu401 * mpu)
335 outb(0, MPU401D(mpu));
339 * Tell the SoundScape to activate the AD1845 chip (I think).
340 * The AD1845 detection fails if we *don't* do this, so I
341 * think that this is a good idea ...
343 static inline void activate_ad1845_unsafe(unsigned io_base)
345 sscape_write_unsafe(io_base, GA_HMCTL_REG, (sscape_read_unsafe(io_base, GA_HMCTL_REG) & 0xcf) | 0x10);
346 sscape_write_unsafe(io_base, GA_CDCFG_REG, 0x80);
350 * Do the necessary ALSA-level cleanup to deallocate our driver ...
352 static void soundscape_free(struct snd_card *c)
354 struct soundscape *sscape = get_card_soundscape(c);
355 release_and_free_resource(sscape->io_res);
356 release_and_free_resource(sscape->wss_res);
357 free_dma(sscape->chip->dma1);
361 * Tell the SoundScape to begin a DMA tranfer using the given channel.
362 * All locking issues are left to the caller.
364 static inline void sscape_start_dma_unsafe(unsigned io_base, enum GA_REG reg)
366 sscape_write_unsafe(io_base, reg, sscape_read_unsafe(io_base, reg) | 0x01);
367 sscape_write_unsafe(io_base, reg, sscape_read_unsafe(io_base, reg) & 0xfe);
371 * Wait for a DMA transfer to complete. This is a "limited busy-wait",
372 * and all locking issues are left to the caller.
374 static int sscape_wait_dma_unsafe(unsigned io_base, enum GA_REG reg, unsigned timeout)
376 while (!(sscape_read_unsafe(io_base, reg) & 0x01) && (timeout != 0)) {
381 return (sscape_read_unsafe(io_base, reg) & 0x01);
385 * Wait for the On-Board Processor to return its start-up
386 * acknowledgement sequence. This wait is too long for
387 * us to perform "busy-waiting", and so we must sleep.
388 * This in turn means that we must not be holding any
389 * spinlocks when we call this function.
391 static int obp_startup_ack(struct soundscape *s, unsigned timeout)
393 unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
399 spin_lock_irqsave(&s->lock, flags);
400 x = inb(HOST_DATA_IO(s->io_base));
401 spin_unlock_irqrestore(&s->lock, flags);
402 if ((x & 0xfe) == 0xfe)
406 } while (time_before(jiffies, end_time));
412 * Wait for the host to return its start-up acknowledgement
413 * sequence. This wait is too long for us to perform
414 * "busy-waiting", and so we must sleep. This in turn means
415 * that we must not be holding any spinlocks when we call
418 static int host_startup_ack(struct soundscape *s, unsigned timeout)
420 unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
426 spin_lock_irqsave(&s->lock, flags);
427 x = inb(HOST_DATA_IO(s->io_base));
428 spin_unlock_irqrestore(&s->lock, flags);
433 } while (time_before(jiffies, end_time));
439 * Upload a byte-stream into the SoundScape using DMA channel A.
441 static int upload_dma_data(struct soundscape *s,
442 const unsigned char __user *data,
446 struct snd_dma_buffer dma;
449 if (!get_dmabuf(&dma, PAGE_ALIGN(size)))
452 spin_lock_irqsave(&s->lock, flags);
455 * Reset the board ...
457 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f);
460 * Enable the DMA channels and configure them ...
462 sscape_write_unsafe(s->io_base, GA_DMACFG_REG, 0x50);
463 sscape_write_unsafe(s->io_base, GA_DMAA_REG, (s->chip->dma1 << 4) | DMA_8BIT);
464 sscape_write_unsafe(s->io_base, GA_DMAB_REG, 0x20);
467 * Take the board out of reset ...
469 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) | 0x80);
472 * Upload the user's data (firmware?) to the SoundScape
473 * board through the DMA channel ...
479 * Apparently, copying to/from userspace can sleep.
480 * We are therefore forbidden from holding any
481 * spinlocks while we copy ...
483 spin_unlock_irqrestore(&s->lock, flags);
486 * Remember that the data that we want to DMA
487 * comes from USERSPACE. We have already verified
488 * the userspace pointer ...
490 len = min(size, dma.bytes);
491 len -= __copy_from_user(dma.area, data, len);
496 * Grab that spinlock again, now that we've
499 spin_lock_irqsave(&s->lock, flags);
501 snd_dma_program(s->chip->dma1, dma.addr, len, DMA_MODE_WRITE);
502 sscape_start_dma_unsafe(s->io_base, GA_DMAA_REG);
503 if (!sscape_wait_dma_unsafe(s->io_base, GA_DMAA_REG, 5000)) {
505 * Don't forget to release this spinlock we're holding ...
507 spin_unlock_irqrestore(&s->lock, flags);
509 snd_printk(KERN_ERR "sscape: DMA upload has timed out\n");
515 set_host_mode_unsafe(s->io_base);
518 * Boot the board ... (I think)
520 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) | 0x40);
521 spin_unlock_irqrestore(&s->lock, flags);
524 * If all has gone well, then the board should acknowledge
525 * the new upload and tell us that it has rebooted OK. We
526 * give it 5 seconds (max) ...
529 if (!obp_startup_ack(s, 5000)) {
530 snd_printk(KERN_ERR "sscape: No response from on-board processor after upload\n");
532 } else if (!host_startup_ack(s, 5000)) {
533 snd_printk(KERN_ERR "sscape: SoundScape failed to initialise\n");
539 * NOTE!!! We are NOT holding any spinlocks at this point !!!
541 sscape_write(s, GA_DMAA_REG, (s->ic_type == IC_ODIE ? 0x70 : 0x40));
548 * Upload the bootblock(?) into the SoundScape. The only
549 * purpose of this block of code seems to be to tell
550 * us which version of the microcode we should be using.
552 * NOTE: The boot-block data resides in USER-SPACE!!!
553 * However, we have already verified its memory
554 * addresses by the time we get here.
556 static int sscape_upload_bootblock(struct soundscape *sscape, struct sscape_bootblock __user *bb)
562 ret = upload_dma_data(sscape, bb->code, sizeof(bb->code));
564 spin_lock_irqsave(&sscape->lock, flags);
566 data = host_read_ctrl_unsafe(sscape->io_base, 100);
568 set_midi_mode_unsafe(sscape->io_base);
569 spin_unlock_irqrestore(&sscape->lock, flags);
573 snd_printk(KERN_ERR "sscape: timeout reading firmware version\n");
576 else if (__copy_to_user(&bb->version, &data, sizeof(bb->version))) {
585 * Upload the microcode into the SoundScape. The
586 * microcode is 64K of data, and if we try to copy
587 * it into a local variable then we will SMASH THE
588 * KERNEL'S STACK! We therefore leave it in USER
589 * SPACE, and save ourselves from copying it at all.
591 static int sscape_upload_microcode(struct soundscape *sscape,
592 const struct sscape_microcode __user *mc)
599 * We are going to have to copy this data into a special
600 * DMA-able buffer before we can upload it. We shall therefore
601 * just check that the data pointer is valid for now.
603 * NOTE: This buffer is 64K long! That's WAY too big to
604 * copy into a stack-temporary anyway.
606 if ( get_user(code, &mc->code) ||
607 !access_ok(VERIFY_READ, code, SSCAPE_MICROCODE_SIZE) )
610 if ((err = upload_dma_data(sscape, code, SSCAPE_MICROCODE_SIZE)) == 0) {
611 snd_printk(KERN_INFO "sscape: MIDI firmware loaded\n");
614 spin_lock_irqsave(&sscape->lock, flags);
615 set_midi_mode_unsafe(sscape->io_base);
616 spin_unlock_irqrestore(&sscape->lock, flags);
618 initialise_mpu401(sscape->mpu);
624 * Hardware-specific device functions, to implement special
625 * IOCTLs for the SoundScape card. This is how we upload
626 * the microcode into the card, for example, and so we
627 * must ensure that no two processes can open this device
628 * simultaneously, and that we can't open it at all if
629 * someone is using the MIDI device.
631 static int sscape_hw_open(struct snd_hwdep * hw, struct file *file)
633 register struct soundscape *sscape = get_hwdep_soundscape(hw);
637 spin_lock_irqsave(&sscape->fwlock, flags);
639 if ((sscape->midi_usage != 0) || sscape->hw_in_use) {
642 sscape->hw_in_use = 1;
646 spin_unlock_irqrestore(&sscape->fwlock, flags);
650 static int sscape_hw_release(struct snd_hwdep * hw, struct file *file)
652 register struct soundscape *sscape = get_hwdep_soundscape(hw);
655 spin_lock_irqsave(&sscape->fwlock, flags);
656 sscape->hw_in_use = 0;
657 spin_unlock_irqrestore(&sscape->fwlock, flags);
661 static int sscape_hw_ioctl(struct snd_hwdep * hw, struct file *file,
662 unsigned int cmd, unsigned long arg)
664 struct soundscape *sscape = get_hwdep_soundscape(hw);
668 case SND_SSCAPE_LOAD_BOOTB:
670 register struct sscape_bootblock __user *bb = (struct sscape_bootblock __user *) arg;
673 * We are going to have to copy this data into a special
674 * DMA-able buffer before we can upload it. We shall therefore
675 * just check that the data pointer is valid for now ...
677 if ( !access_ok(VERIFY_READ, bb->code, sizeof(bb->code)) )
681 * Now check that we can write the firmware version number too...
683 if ( !access_ok(VERIFY_WRITE, &bb->version, sizeof(bb->version)) )
686 err = sscape_upload_bootblock(sscape, bb);
690 case SND_SSCAPE_LOAD_MCODE:
692 register const struct sscape_microcode __user *mc = (const struct sscape_microcode __user *) arg;
694 err = sscape_upload_microcode(sscape, mc);
708 * Mixer control for the SoundScape's MIDI device.
710 static int sscape_midi_info(struct snd_kcontrol *ctl,
711 struct snd_ctl_elem_info *uinfo)
713 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
715 uinfo->value.integer.min = 0;
716 uinfo->value.integer.max = 127;
720 static int sscape_midi_get(struct snd_kcontrol *kctl,
721 struct snd_ctl_elem_value *uctl)
723 struct snd_wss *chip = snd_kcontrol_chip(kctl);
724 struct snd_card *card = chip->card;
725 register struct soundscape *s = get_card_soundscape(card);
728 spin_lock_irqsave(&s->lock, flags);
729 set_host_mode_unsafe(s->io_base);
731 if (host_write_ctrl_unsafe(s->io_base, CMD_GET_MIDI_VOL, 100)) {
732 uctl->value.integer.value[0] = host_read_ctrl_unsafe(s->io_base, 100);
735 set_midi_mode_unsafe(s->io_base);
736 spin_unlock_irqrestore(&s->lock, flags);
740 static int sscape_midi_put(struct snd_kcontrol *kctl,
741 struct snd_ctl_elem_value *uctl)
743 struct snd_wss *chip = snd_kcontrol_chip(kctl);
744 struct snd_card *card = chip->card;
745 register struct soundscape *s = get_card_soundscape(card);
749 spin_lock_irqsave(&s->lock, flags);
752 * We need to put the board into HOST mode before we
753 * can send any volume-changing HOST commands ...
755 set_host_mode_unsafe(s->io_base);
758 * To successfully change the MIDI volume setting, you seem to
759 * have to write a volume command, write the new volume value,
760 * and then perform another volume-related command. Perhaps the
761 * first command is an "open" and the second command is a "close"?
763 if (s->midi_vol == ((unsigned char) uctl->value.integer. value[0] & 127)) {
767 change = (host_write_ctrl_unsafe(s->io_base, CMD_SET_MIDI_VOL, 100)
768 && host_write_ctrl_unsafe(s->io_base, ((unsigned char) uctl->value.integer. value[0]) & 127, 100)
769 && host_write_ctrl_unsafe(s->io_base, CMD_XXX_MIDI_VOL, 100));
773 * Take the board out of HOST mode and back into MIDI mode ...
775 set_midi_mode_unsafe(s->io_base);
777 spin_unlock_irqrestore(&s->lock, flags);
781 static struct snd_kcontrol_new midi_mixer_ctl = {
782 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
784 .info = sscape_midi_info,
785 .get = sscape_midi_get,
786 .put = sscape_midi_put
790 * The SoundScape can use two IRQs from a possible set of four.
791 * These IRQs are encoded as bit patterns so that they can be
792 * written to the control registers.
794 static unsigned __devinit get_irq_config(int irq)
796 static const int valid_irq[] = { 9, 5, 7, 10 };
799 for (cfg = 0; cfg < ARRAY_SIZE(valid_irq); ++cfg) {
800 if (irq == valid_irq[cfg])
809 * Perform certain arcane port-checks to see whether there
810 * is a SoundScape board lurking behind the given ports.
812 static int __devinit detect_sscape(struct soundscape *s)
817 int codec = s->wss_base;
819 spin_lock_irqsave(&s->lock, flags);
822 * The following code is lifted from the original OSS driver,
823 * and as I don't have a datasheet I cannot really comment
824 * on what it is doing...
826 if ((inb(HOST_CTRL_IO(s->io_base)) & 0x78) != 0)
829 d = inb(ODIE_ADDR_IO(s->io_base)) & 0xf0;
835 s->ic_type = IC_ODIE;
836 } else if ((d & 0x60) != 0) {
838 s->ic_type = IC_OPUS;
842 outb(0xfa, ODIE_ADDR_IO(s->io_base));
843 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0a)
846 outb(0xfe, ODIE_ADDR_IO(s->io_base));
847 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0e)
850 outb(0xfe, ODIE_ADDR_IO(s->io_base));
851 d = inb(ODIE_DATA_IO(s->io_base));
852 if (s->type != SSCAPE_VIVO && (d & 0x9f) != 0x0e)
855 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f;
856 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
858 if (s->type == SSCAPE_VIVO)
860 /* wait for WSS codec */
861 for (d = 0; d < 500; d++) {
862 if ((inb(codec) & 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);
871 * SoundScape successfully detected!
876 spin_unlock_irqrestore(&s->lock, flags);
881 * ALSA callback function, called when attempting to open the MIDI device.
882 * Check that the MIDI firmware has been loaded, because we don't want
883 * to crash the machine. Also check that someone isn't using the hardware
886 static int mpu401_open(struct snd_mpu401 * mpu)
890 if (!verify_mpu401(mpu)) {
891 snd_printk(KERN_ERR "sscape: MIDI disabled, please load firmware\n");
894 register struct soundscape *sscape = get_mpu401_soundscape(mpu);
897 spin_lock_irqsave(&sscape->fwlock, flags);
899 if (sscape->hw_in_use || (sscape->midi_usage == ULONG_MAX)) {
902 ++(sscape->midi_usage);
906 spin_unlock_irqrestore(&sscape->fwlock, flags);
912 static void mpu401_close(struct snd_mpu401 * mpu)
914 register struct soundscape *sscape = get_mpu401_soundscape(mpu);
917 spin_lock_irqsave(&sscape->fwlock, flags);
918 --(sscape->midi_usage);
919 spin_unlock_irqrestore(&sscape->fwlock, flags);
923 * Initialse an MPU-401 subdevice for MIDI support on the SoundScape.
925 static int __devinit create_mpu401(struct snd_card *card, int devnum, unsigned long port, int irq)
927 struct soundscape *sscape = get_card_soundscape(card);
928 struct snd_rawmidi *rawmidi;
931 if ((err = snd_mpu401_uart_new(card, devnum,
933 port, MPU401_INFO_INTEGRATED,
936 struct snd_mpu401 *mpu = (struct snd_mpu401 *) rawmidi->private_data;
937 mpu->open_input = mpu401_open;
938 mpu->open_output = mpu401_open;
939 mpu->close_input = mpu401_close;
940 mpu->close_output = mpu401_close;
941 mpu->private_data = sscape;
944 initialise_mpu401(mpu);
952 * Create an AD1845 PCM subdevice on the SoundScape. The AD1845
953 * is very much like a CS4231, with a few extra bits. We will
954 * try to support at least some of the extra bits by overriding
955 * some of the CS4231 callback.
957 static int __devinit create_ad1845(struct snd_card *card, unsigned port,
958 int irq, int dma1, int dma2)
960 register struct soundscape *sscape = get_card_soundscape(card);
961 struct snd_wss *chip;
964 if (sscape->type == SSCAPE_VIVO)
970 err = snd_wss_create(card, port, -1, irq, dma1, dma2,
971 WSS_HW_DETECT, WSS_HWSHARE_DMA1, &chip);
977 * It turns out that the PLAYBACK_ENABLE bit is set
978 * by the lowlevel driver ...
980 #define AD1845_IFACE_CONFIG \
981 (CS4231_AUTOCALIB | CS4231_RECORD_ENABLE | CS4231_PLAYBACK_ENABLE)
982 snd_wss_mce_up(chip);
983 spin_lock_irqsave(&chip->reg_lock, flags);
984 snd_wss_out(chip, CS4231_IFACE_CTRL, AD1845_IFACE_CONFIG);
985 spin_unlock_irqrestore(&chip->reg_lock, flags);
986 snd_wss_mce_down(chip);
989 if (sscape->type != SSCAPE_VIVO) {
991 * The input clock frequency on the SoundScape must
992 * be 14.31818 MHz, because we must set this register
993 * to get the playback to sound correct ...
995 snd_wss_mce_up(chip);
996 spin_lock_irqsave(&chip->reg_lock, flags);
997 snd_wss_out(chip, AD1845_CLOCK, 0x20);
998 spin_unlock_irqrestore(&chip->reg_lock, flags);
999 snd_wss_mce_down(chip);
1003 err = snd_wss_pcm(chip, 0, &pcm);
1005 snd_printk(KERN_ERR "sscape: No PCM device "
1006 "for AD1845 chip\n");
1010 err = snd_wss_mixer(chip);
1012 snd_printk(KERN_ERR "sscape: No mixer device "
1013 "for AD1845 chip\n");
1016 if (chip->hardware != WSS_HW_AD1848) {
1017 err = snd_wss_timer(chip, 0, NULL);
1019 snd_printk(KERN_ERR "sscape: No timer device "
1020 "for AD1845 chip\n");
1025 if (sscape->type != SSCAPE_VIVO) {
1026 err = snd_ctl_add(card,
1027 snd_ctl_new1(&midi_mixer_ctl, chip));
1029 snd_printk(KERN_ERR "sscape: Could not create "
1030 "MIDI mixer control\n");
1035 strcpy(card->driver, "SoundScape");
1036 strcpy(card->shortname, pcm->name);
1037 snprintf(card->longname, sizeof(card->longname),
1038 "%s at 0x%lx, IRQ %d, DMA1 %d, DMA2 %d\n",
1039 pcm->name, chip->port, chip->irq,
1040 chip->dma1, chip->dma2);
1042 sscape->chip = chip;
1051 * Create an ALSA soundcard entry for the SoundScape, using
1052 * the given list of port, IRQ and DMA resources.
1054 static int __devinit create_sscape(int dev, struct snd_card *card)
1056 struct soundscape *sscape = get_card_soundscape(card);
1059 unsigned mpu_irq_cfg;
1061 struct resource *io_res;
1062 struct resource *wss_res;
1063 unsigned long flags;
1067 * Check that the user didn't pass us garbage data ...
1069 irq_cfg = get_irq_config(irq[dev]);
1070 if (irq_cfg == INVALID_IRQ) {
1071 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", irq[dev]);
1075 mpu_irq_cfg = get_irq_config(mpu_irq[dev]);
1076 if (mpu_irq_cfg == INVALID_IRQ) {
1077 printk(KERN_ERR "sscape: Invalid IRQ %d\n", mpu_irq[dev]);
1083 * Grab IO ports that we will need to probe so that we
1084 * can detect and control this hardware ...
1086 io_res = request_region(xport, 8, "SoundScape");
1088 snd_printk(KERN_ERR "sscape: can't grab port 0x%x\n", xport);
1092 if (sscape->type == SSCAPE_VIVO) {
1093 wss_res = request_region(wss_port[dev], 4, "SoundScape");
1095 snd_printk(KERN_ERR "sscape: can't grab port 0x%lx\n",
1098 goto _release_region;
1103 * Grab one DMA channel ...
1105 err = request_dma(dma[dev], "SoundScape");
1107 snd_printk(KERN_ERR "sscape: can't grab DMA %d\n", dma[dev]);
1108 goto _release_region;
1111 spin_lock_init(&sscape->lock);
1112 spin_lock_init(&sscape->fwlock);
1113 sscape->io_res = io_res;
1114 sscape->wss_res = wss_res;
1115 sscape->io_base = xport;
1116 sscape->wss_base = wss_port[dev];
1118 if (!detect_sscape(sscape)) {
1119 printk(KERN_ERR "sscape: hardware not detected at 0x%x\n", sscape->io_base);
1124 printk(KERN_INFO "sscape: hardware detected at 0x%x, using IRQ %d, DMA %d\n",
1125 sscape->io_base, irq[dev], dma[dev]);
1127 if (sscape->type != SSCAPE_VIVO) {
1129 * Now create the hardware-specific device so that we can
1130 * load the microcode into the on-board processor.
1131 * We cannot use the MPU-401 MIDI system until this firmware
1132 * has been loaded into the card.
1134 err = snd_hwdep_new(card, "MC68EC000", 0, &(sscape->hw));
1136 printk(KERN_ERR "sscape: Failed to create "
1137 "firmware device\n");
1140 strlcpy(sscape->hw->name, "SoundScape M68K",
1141 sizeof(sscape->hw->name));
1142 sscape->hw->name[sizeof(sscape->hw->name) - 1] = '\0';
1143 sscape->hw->iface = SNDRV_HWDEP_IFACE_SSCAPE;
1144 sscape->hw->ops.open = sscape_hw_open;
1145 sscape->hw->ops.release = sscape_hw_release;
1146 sscape->hw->ops.ioctl = sscape_hw_ioctl;
1147 sscape->hw->private_data = sscape;
1151 * Tell the on-board devices where their resources are (I think -
1152 * I can't be sure without a datasheet ... So many magic values!)
1154 spin_lock_irqsave(&sscape->lock, flags);
1156 activate_ad1845_unsafe(sscape->io_base);
1158 sscape_write_unsafe(sscape->io_base, GA_INTENA_REG, 0x00); /* disable */
1159 sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2e);
1160 sscape_write_unsafe(sscape->io_base, GA_SMCFGB_REG, 0x00);
1163 * Enable and configure the DMA channels ...
1165 sscape_write_unsafe(sscape->io_base, GA_DMACFG_REG, 0x50);
1166 dma_cfg = (sscape->ic_type == IC_ODIE ? 0x70 : 0x40);
1167 sscape_write_unsafe(sscape->io_base, GA_DMAA_REG, dma_cfg);
1168 sscape_write_unsafe(sscape->io_base, GA_DMAB_REG, 0x20);
1170 sscape_write_unsafe(sscape->io_base,
1171 GA_INTCFG_REG, 0xf0 | (mpu_irq_cfg << 2) | mpu_irq_cfg);
1172 sscape_write_unsafe(sscape->io_base,
1173 GA_CDCFG_REG, 0x09 | DMA_8BIT
1174 | (dma[dev] << 4) | (irq_cfg << 1));
1176 spin_unlock_irqrestore(&sscape->lock, flags);
1179 * We have now enabled the codec chip, and so we should
1180 * detect the AD1845 device ...
1182 err = create_ad1845(card, wss_port[dev], irq[dev],
1183 dma[dev], dma2[dev]);
1185 printk(KERN_ERR "sscape: No AD1845 device at 0x%lx, IRQ %d\n",
1186 wss_port[dev], irq[dev]);
1189 #define MIDI_DEVNUM 0
1190 if (sscape->type != SSCAPE_VIVO) {
1191 err = create_mpu401(card, MIDI_DEVNUM, xport, mpu_irq[dev]);
1193 printk(KERN_ERR "sscape: Failed to create "
1194 "MPU-401 device at 0x%x\n",
1200 * Enable the master IRQ ...
1202 sscape_write(sscape, GA_INTENA_REG, 0x80);
1207 sscape->midi_vol = 0;
1208 host_write_ctrl_unsafe(sscape->io_base, CMD_SET_MIDI_VOL, 100);
1209 host_write_ctrl_unsafe(sscape->io_base, 0, 100);
1210 host_write_ctrl_unsafe(sscape->io_base, CMD_XXX_MIDI_VOL, 100);
1214 * Now that we have successfully created this sound card,
1215 * it is safe to store the pointer.
1216 * NOTE: we only register the sound card's "destructor"
1217 * function now that our "constructor" has completed.
1219 card->private_free = soundscape_free;
1227 release_and_free_resource(wss_res);
1228 release_and_free_resource(io_res);
1234 static int __devinit snd_sscape_match(struct device *pdev, unsigned int i)
1237 * Make sure we were given ALL of the other parameters.
1239 if (port[i] == SNDRV_AUTO_PORT)
1242 if (irq[i] == SNDRV_AUTO_IRQ ||
1243 mpu_irq[i] == SNDRV_AUTO_IRQ ||
1244 dma[i] == SNDRV_AUTO_DMA) {
1246 "sscape: insufficient parameters, need IO, IRQ, MPU-IRQ and DMA\n");
1253 static int __devinit snd_sscape_probe(struct device *pdev, unsigned int dev)
1255 struct snd_card *card;
1256 struct soundscape *sscape;
1259 card = snd_card_new(index[dev], id[dev], THIS_MODULE,
1260 sizeof(struct soundscape));
1264 sscape = get_card_soundscape(card);
1265 sscape->type = SSCAPE;
1268 ret = create_sscape(dev, card);
1272 snd_card_set_dev(card, pdev);
1273 if ((ret = snd_card_register(card)) < 0) {
1274 printk(KERN_ERR "sscape: Failed to register sound card\n");
1277 dev_set_drvdata(pdev, card);
1281 snd_card_free(card);
1285 static int __devexit snd_sscape_remove(struct device *devptr, unsigned int dev)
1287 snd_card_free(dev_get_drvdata(devptr));
1288 dev_set_drvdata(devptr, NULL);
1292 #define DEV_NAME "sscape"
1294 static struct isa_driver snd_sscape_driver = {
1295 .match = snd_sscape_match,
1296 .probe = snd_sscape_probe,
1297 .remove = __devexit_p(snd_sscape_remove),
1298 /* FIXME: suspend/resume */
1305 static inline int __devinit get_next_autoindex(int i)
1307 while (i < SNDRV_CARDS && port[i] != SNDRV_AUTO_PORT)
1313 static int __devinit sscape_pnp_detect(struct pnp_card_link *pcard,
1314 const struct pnp_card_device_id *pid)
1317 struct pnp_dev *dev;
1318 struct snd_card *card;
1319 struct soundscape *sscape;
1323 * Allow this function to fail *quietly* if all the ISA PnP
1324 * devices were configured using module parameters instead.
1326 if ((idx = get_next_autoindex(idx)) >= SNDRV_CARDS)
1330 * We have found a candidate ISA PnP card. Now we
1331 * have to check that it has the devices that we
1332 * expect it to have.
1334 * We will NOT try and autoconfigure all of the resources
1335 * needed and then activate the card as we are assuming that
1336 * has already been done at boot-time using /proc/isapnp.
1337 * We shall simply try to give each active card the resources
1338 * that it wants. This is a sensible strategy for a modular
1339 * system where unused modules are unloaded regularly.
1341 * This strategy is utterly useless if we compile the driver
1342 * into the kernel, of course.
1344 // printk(KERN_INFO "sscape: %s\n", card->name);
1347 * Check that we still have room for another sound card ...
1349 dev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
1353 if (!pnp_is_active(dev)) {
1354 if (pnp_activate_dev(dev) < 0) {
1355 printk(KERN_INFO "sscape: device is inactive\n");
1361 * Create a new ALSA sound card entry, in anticipation
1362 * of detecting our hardware ...
1364 card = snd_card_new(index[idx], id[idx], THIS_MODULE,
1365 sizeof(struct soundscape));
1369 sscape = get_card_soundscape(card);
1372 * Identify card model ...
1374 if (!strncmp("ENS4081", pid->id, 7))
1375 sscape->type = SSCAPE_VIVO;
1377 sscape->type = SSCAPE_PNP;
1380 * Read the correct parameters off the ISA PnP bus ...
1382 port[idx] = pnp_port_start(dev, 0);
1383 irq[idx] = pnp_irq(dev, 0);
1384 mpu_irq[idx] = pnp_irq(dev, 1);
1385 dma[idx] = pnp_dma(dev, 0) & 0x03;
1386 if (sscape->type == SSCAPE_PNP) {
1387 dma2[idx] = dma[idx];
1388 wss_port[idx] = CODEC_IO(port[idx]);
1390 wss_port[idx] = pnp_port_start(dev, 1);
1391 dma2[idx] = pnp_dma(dev, 1);
1394 ret = create_sscape(idx, card);
1398 snd_card_set_dev(card, &pcard->card->dev);
1399 if ((ret = snd_card_register(card)) < 0) {
1400 printk(KERN_ERR "sscape: Failed to register sound card\n");
1404 pnp_set_card_drvdata(pcard, card);
1409 snd_card_free(card);
1413 static void __devexit sscape_pnp_remove(struct pnp_card_link * pcard)
1415 snd_card_free(pnp_get_card_drvdata(pcard));
1416 pnp_set_card_drvdata(pcard, NULL);
1419 static struct pnp_card_driver sscape_pnpc_driver = {
1420 .flags = PNP_DRIVER_RES_DO_NOT_CHANGE,
1422 .id_table = sscape_pnpids,
1423 .probe = sscape_pnp_detect,
1424 .remove = __devexit_p(sscape_pnp_remove),
1427 #endif /* CONFIG_PNP */
1429 static int __init sscape_init(void)
1433 err = isa_register_driver(&snd_sscape_driver, SNDRV_CARDS);
1438 err = pnp_register_card_driver(&sscape_pnpc_driver);
1448 static void __exit sscape_exit(void)
1452 pnp_unregister_card_driver(&sscape_pnpc_driver);
1455 isa_unregister_driver(&snd_sscape_driver);
1458 module_init(sscape_init);
1459 module_exit(sscape_exit);