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 MPU401_IO(i) ((i) + 0)
93 #define MIDI_DATA_IO(i) ((i) + 0)
94 #define MIDI_CTRL_IO(i) ((i) + 1)
95 #define HOST_CTRL_IO(i) ((i) + 2)
96 #define HOST_DATA_IO(i) ((i) + 3)
97 #define ODIE_ADDR_IO(i) ((i) + 4)
98 #define ODIE_DATA_IO(i) ((i) + 5)
99 #define CODEC_IO(i) ((i) + 8)
104 #define RX_READY 0x01
105 #define TX_READY 0x02
108 #define CMD_SET_MIDI_VOL 0x84
109 #define CMD_GET_MIDI_VOL 0x85
110 #define CMD_XXX_MIDI_VOL 0x86
111 #define CMD_SET_EXTMIDI 0x8a
112 #define CMD_GET_EXTMIDI 0x8b
113 #define CMD_SET_MT32 0x8c
114 #define CMD_GET_MT32 0x8d
129 #define DMA_8BIT 0x80
145 struct resource *io_res;
146 struct resource *wss_res;
147 struct snd_wss *chip;
148 struct snd_mpu401 *mpu;
149 struct snd_hwdep *hw;
152 * The MIDI device won't work until we've loaded
153 * its firmware via a hardware-dependent device IOCTL
157 unsigned long midi_usage;
158 unsigned char midi_vol;
161 #define INVALID_IRQ ((unsigned)-1)
164 static inline struct soundscape *get_card_soundscape(struct snd_card *c)
166 return (struct soundscape *) (c->private_data);
169 static inline struct soundscape *get_mpu401_soundscape(struct snd_mpu401 * mpu)
171 return (struct soundscape *) (mpu->private_data);
174 static inline struct soundscape *get_hwdep_soundscape(struct snd_hwdep * hw)
176 return (struct soundscape *) (hw->private_data);
181 * Allocates some kernel memory that we can use for DMA.
182 * I think this means that the memory has to map to
183 * contiguous pages of physical memory.
185 static struct snd_dma_buffer *get_dmabuf(struct snd_dma_buffer *buf, unsigned long size)
188 if (snd_dma_alloc_pages_fallback(SNDRV_DMA_TYPE_DEV, snd_dma_isa_data(),
190 snd_printk(KERN_ERR "sscape: Failed to allocate %lu bytes for DMA\n", size);
199 * Release the DMA-able kernel memory ...
201 static void free_dmabuf(struct snd_dma_buffer *buf)
203 if (buf && buf->area)
204 snd_dma_free_pages(buf);
209 * This function writes to the SoundScape's control registers,
210 * but doesn't do any locking. It's up to the caller to do that.
211 * This is why this function is "unsafe" ...
213 static inline void sscape_write_unsafe(unsigned io_base, enum GA_REG reg, unsigned char val)
215 outb(reg, ODIE_ADDR_IO(io_base));
216 outb(val, ODIE_DATA_IO(io_base));
220 * Write to the SoundScape's control registers, and do the
221 * necessary locking ...
223 static void sscape_write(struct soundscape *s, enum GA_REG reg, unsigned char val)
227 spin_lock_irqsave(&s->lock, flags);
228 sscape_write_unsafe(s->io_base, reg, val);
229 spin_unlock_irqrestore(&s->lock, flags);
233 * Read from the SoundScape's control registers, but leave any
234 * locking to the caller. This is why the function is "unsafe" ...
236 static inline unsigned char sscape_read_unsafe(unsigned io_base, enum GA_REG reg)
238 outb(reg, ODIE_ADDR_IO(io_base));
239 return inb(ODIE_DATA_IO(io_base));
243 * Puts the SoundScape into "host" mode, as compared to "MIDI" mode
245 static inline void set_host_mode_unsafe(unsigned io_base)
247 outb(0x0, HOST_CTRL_IO(io_base));
251 * Puts the SoundScape into "MIDI" mode, as compared to "host" mode
253 static inline void set_midi_mode_unsafe(unsigned io_base)
255 outb(0x3, HOST_CTRL_IO(io_base));
259 * Read the SoundScape's host-mode control register, but leave
260 * any locking issues to the caller ...
262 static inline int host_read_unsafe(unsigned io_base)
265 if ((inb(HOST_CTRL_IO(io_base)) & RX_READY) != 0) {
266 data = inb(HOST_DATA_IO(io_base));
273 * Read the SoundScape's host-mode control register, performing
274 * a limited amount of busy-waiting if the register isn't ready.
275 * Also leaves all locking-issues to the caller ...
277 static int host_read_ctrl_unsafe(unsigned io_base, unsigned timeout)
281 while (((data = host_read_unsafe(io_base)) < 0) && (timeout != 0)) {
290 * Write to the SoundScape's host-mode control registers, but
291 * leave any locking issues to the caller ...
293 static inline int host_write_unsafe(unsigned io_base, unsigned char data)
295 if ((inb(HOST_CTRL_IO(io_base)) & TX_READY) != 0) {
296 outb(data, HOST_DATA_IO(io_base));
304 * Write to the SoundScape's host-mode control registers, performing
305 * a limited amount of busy-waiting if the register isn't ready.
306 * Also leaves all locking-issues to the caller ...
308 static int host_write_ctrl_unsafe(unsigned io_base, unsigned char data,
313 while (!(err = host_write_unsafe(io_base, data)) && (timeout != 0)) {
323 * Check that the MIDI subsystem is operational. If it isn't,
324 * then we will hang the computer if we try to use it ...
326 * NOTE: This check is based upon observation, not documentation.
328 static inline int verify_mpu401(const struct snd_mpu401 * mpu)
330 return ((inb(MIDI_CTRL_IO(mpu->port)) & 0xc0) == 0x80);
334 * This is apparently the standard way to initailise an MPU-401
336 static inline void initialise_mpu401(const struct snd_mpu401 * mpu)
338 outb(0, MIDI_DATA_IO(mpu->port));
342 * Tell the SoundScape to activate the AD1845 chip (I think).
343 * The AD1845 detection fails if we *don't* do this, so I
344 * think that this is a good idea ...
346 static inline void activate_ad1845_unsafe(unsigned io_base)
348 sscape_write_unsafe(io_base, GA_HMCTL_REG, (sscape_read_unsafe(io_base, GA_HMCTL_REG) & 0xcf) | 0x10);
349 sscape_write_unsafe(io_base, GA_CDCFG_REG, 0x80);
353 * Do the necessary ALSA-level cleanup to deallocate our driver ...
355 static void soundscape_free(struct snd_card *c)
357 struct soundscape *sscape = get_card_soundscape(c);
358 release_and_free_resource(sscape->io_res);
359 release_and_free_resource(sscape->wss_res);
360 free_dma(sscape->chip->dma1);
364 * Tell the SoundScape to begin a DMA tranfer using the given channel.
365 * All locking issues are left to the caller.
367 static inline void sscape_start_dma_unsafe(unsigned io_base, enum GA_REG reg)
369 sscape_write_unsafe(io_base, reg, sscape_read_unsafe(io_base, reg) | 0x01);
370 sscape_write_unsafe(io_base, reg, sscape_read_unsafe(io_base, reg) & 0xfe);
374 * Wait for a DMA transfer to complete. This is a "limited busy-wait",
375 * and all locking issues are left to the caller.
377 static int sscape_wait_dma_unsafe(unsigned io_base, enum GA_REG reg, unsigned timeout)
379 while (!(sscape_read_unsafe(io_base, reg) & 0x01) && (timeout != 0)) {
384 return (sscape_read_unsafe(io_base, reg) & 0x01);
388 * Wait for the On-Board Processor to return its start-up
389 * acknowledgement sequence. This wait is too long for
390 * us to perform "busy-waiting", and so we must sleep.
391 * This in turn means that we must not be holding any
392 * spinlocks when we call this function.
394 static int obp_startup_ack(struct soundscape *s, unsigned timeout)
396 while (timeout != 0) {
400 schedule_timeout_uninterruptible(1);
402 spin_lock_irqsave(&s->lock, flags);
403 x = inb(HOST_DATA_IO(s->io_base));
404 spin_unlock_irqrestore(&s->lock, flags);
405 if ((x & 0xfe) == 0xfe)
415 * Wait for the host to return its start-up acknowledgement
416 * sequence. This wait is too long for us to perform
417 * "busy-waiting", and so we must sleep. This in turn means
418 * that we must not be holding any spinlocks when we call
421 static int host_startup_ack(struct soundscape *s, unsigned timeout)
423 while (timeout != 0) {
427 schedule_timeout_uninterruptible(1);
429 spin_lock_irqsave(&s->lock, flags);
430 x = inb(HOST_DATA_IO(s->io_base));
431 spin_unlock_irqrestore(&s->lock, flags);
442 * Upload a byte-stream into the SoundScape using DMA channel A.
444 static int upload_dma_data(struct soundscape *s,
445 const unsigned char __user *data,
449 struct snd_dma_buffer dma;
452 if (!get_dmabuf(&dma, PAGE_ALIGN(size)))
455 spin_lock_irqsave(&s->lock, flags);
458 * Reset the board ...
460 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f);
463 * Enable the DMA channels and configure them ...
465 sscape_write_unsafe(s->io_base, GA_DMACFG_REG, 0x50);
466 sscape_write_unsafe(s->io_base, GA_DMAA_REG, (s->chip->dma1 << 4) | DMA_8BIT);
467 sscape_write_unsafe(s->io_base, GA_DMAB_REG, 0x20);
470 * Take the board out of reset ...
472 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) | 0x80);
475 * Upload the user's data (firmware?) to the SoundScape
476 * board through the DMA channel ...
482 * Apparently, copying to/from userspace can sleep.
483 * We are therefore forbidden from holding any
484 * spinlocks while we copy ...
486 spin_unlock_irqrestore(&s->lock, flags);
489 * Remember that the data that we want to DMA
490 * comes from USERSPACE. We have already verified
491 * the userspace pointer ...
493 len = min(size, dma.bytes);
494 len -= __copy_from_user(dma.area, data, len);
499 * Grab that spinlock again, now that we've
502 spin_lock_irqsave(&s->lock, flags);
504 snd_dma_program(s->chip->dma1, dma.addr, len, DMA_MODE_WRITE);
505 sscape_start_dma_unsafe(s->io_base, GA_DMAA_REG);
506 if (!sscape_wait_dma_unsafe(s->io_base, GA_DMAA_REG, 5000)) {
508 * Don't forget to release this spinlock we're holding ...
510 spin_unlock_irqrestore(&s->lock, flags);
512 snd_printk(KERN_ERR "sscape: DMA upload has timed out\n");
518 set_host_mode_unsafe(s->io_base);
521 * Boot the board ... (I think)
523 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) | 0x40);
524 spin_unlock_irqrestore(&s->lock, flags);
527 * If all has gone well, then the board should acknowledge
528 * the new upload and tell us that it has rebooted OK. We
529 * give it 5 seconds (max) ...
532 if (!obp_startup_ack(s, 5)) {
533 snd_printk(KERN_ERR "sscape: No response from on-board processor after upload\n");
535 } else if (!host_startup_ack(s, 5)) {
536 snd_printk(KERN_ERR "sscape: SoundScape failed to initialise\n");
542 * NOTE!!! We are NOT holding any spinlocks at this point !!!
544 sscape_write(s, GA_DMAA_REG, (s->ic_type == IC_ODIE ? 0x70 : 0x40));
551 * Upload the bootblock(?) into the SoundScape. The only
552 * purpose of this block of code seems to be to tell
553 * us which version of the microcode we should be using.
555 * NOTE: The boot-block data resides in USER-SPACE!!!
556 * However, we have already verified its memory
557 * addresses by the time we get here.
559 static int sscape_upload_bootblock(struct soundscape *sscape, struct sscape_bootblock __user *bb)
565 ret = upload_dma_data(sscape, bb->code, sizeof(bb->code));
567 spin_lock_irqsave(&sscape->lock, flags);
569 data = host_read_ctrl_unsafe(sscape->io_base, 100);
571 set_midi_mode_unsafe(sscape->io_base);
572 spin_unlock_irqrestore(&sscape->lock, flags);
576 snd_printk(KERN_ERR "sscape: timeout reading firmware version\n");
579 else if (__copy_to_user(&bb->version, &data, sizeof(bb->version))) {
588 * Upload the microcode into the SoundScape. The
589 * microcode is 64K of data, and if we try to copy
590 * it into a local variable then we will SMASH THE
591 * KERNEL'S STACK! We therefore leave it in USER
592 * SPACE, and save ourselves from copying it at all.
594 static int sscape_upload_microcode(struct soundscape *sscape,
595 const struct sscape_microcode __user *mc)
602 * We are going to have to copy this data into a special
603 * DMA-able buffer before we can upload it. We shall therefore
604 * just check that the data pointer is valid for now.
606 * NOTE: This buffer is 64K long! That's WAY too big to
607 * copy into a stack-temporary anyway.
609 if ( get_user(code, &mc->code) ||
610 !access_ok(VERIFY_READ, code, SSCAPE_MICROCODE_SIZE) )
613 if ((err = upload_dma_data(sscape, code, SSCAPE_MICROCODE_SIZE)) == 0) {
614 snd_printk(KERN_INFO "sscape: MIDI firmware loaded\n");
617 spin_lock_irqsave(&sscape->lock, flags);
618 set_midi_mode_unsafe(sscape->io_base);
619 spin_unlock_irqrestore(&sscape->lock, flags);
621 initialise_mpu401(sscape->mpu);
627 * Hardware-specific device functions, to implement special
628 * IOCTLs for the SoundScape card. This is how we upload
629 * the microcode into the card, for example, and so we
630 * must ensure that no two processes can open this device
631 * simultaneously, and that we can't open it at all if
632 * someone is using the MIDI device.
634 static int sscape_hw_open(struct snd_hwdep * hw, struct file *file)
636 register struct soundscape *sscape = get_hwdep_soundscape(hw);
640 spin_lock_irqsave(&sscape->fwlock, flags);
642 if ((sscape->midi_usage != 0) || sscape->hw_in_use) {
645 sscape->hw_in_use = 1;
649 spin_unlock_irqrestore(&sscape->fwlock, flags);
653 static int sscape_hw_release(struct snd_hwdep * hw, struct file *file)
655 register struct soundscape *sscape = get_hwdep_soundscape(hw);
658 spin_lock_irqsave(&sscape->fwlock, flags);
659 sscape->hw_in_use = 0;
660 spin_unlock_irqrestore(&sscape->fwlock, flags);
664 static int sscape_hw_ioctl(struct snd_hwdep * hw, struct file *file,
665 unsigned int cmd, unsigned long arg)
667 struct soundscape *sscape = get_hwdep_soundscape(hw);
671 case SND_SSCAPE_LOAD_BOOTB:
673 register struct sscape_bootblock __user *bb = (struct sscape_bootblock __user *) arg;
676 * We are going to have to copy this data into a special
677 * DMA-able buffer before we can upload it. We shall therefore
678 * just check that the data pointer is valid for now ...
680 if ( !access_ok(VERIFY_READ, bb->code, sizeof(bb->code)) )
684 * Now check that we can write the firmware version number too...
686 if ( !access_ok(VERIFY_WRITE, &bb->version, sizeof(bb->version)) )
689 err = sscape_upload_bootblock(sscape, bb);
693 case SND_SSCAPE_LOAD_MCODE:
695 register const struct sscape_microcode __user *mc = (const struct sscape_microcode __user *) arg;
697 err = sscape_upload_microcode(sscape, mc);
711 * Mixer control for the SoundScape's MIDI device.
713 static int sscape_midi_info(struct snd_kcontrol *ctl,
714 struct snd_ctl_elem_info *uinfo)
716 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
718 uinfo->value.integer.min = 0;
719 uinfo->value.integer.max = 127;
723 static int sscape_midi_get(struct snd_kcontrol *kctl,
724 struct snd_ctl_elem_value *uctl)
726 struct snd_wss *chip = snd_kcontrol_chip(kctl);
727 struct snd_card *card = chip->card;
728 register struct soundscape *s = get_card_soundscape(card);
731 spin_lock_irqsave(&s->lock, flags);
732 set_host_mode_unsafe(s->io_base);
734 if (host_write_ctrl_unsafe(s->io_base, CMD_GET_MIDI_VOL, 100)) {
735 uctl->value.integer.value[0] = host_read_ctrl_unsafe(s->io_base, 100);
738 set_midi_mode_unsafe(s->io_base);
739 spin_unlock_irqrestore(&s->lock, flags);
743 static int sscape_midi_put(struct snd_kcontrol *kctl,
744 struct snd_ctl_elem_value *uctl)
746 struct snd_wss *chip = snd_kcontrol_chip(kctl);
747 struct snd_card *card = chip->card;
748 register struct soundscape *s = get_card_soundscape(card);
752 spin_lock_irqsave(&s->lock, flags);
755 * We need to put the board into HOST mode before we
756 * can send any volume-changing HOST commands ...
758 set_host_mode_unsafe(s->io_base);
761 * To successfully change the MIDI volume setting, you seem to
762 * have to write a volume command, write the new volume value,
763 * and then perform another volume-related command. Perhaps the
764 * first command is an "open" and the second command is a "close"?
766 if (s->midi_vol == ((unsigned char) uctl->value.integer. value[0] & 127)) {
770 change = (host_write_ctrl_unsafe(s->io_base, CMD_SET_MIDI_VOL, 100)
771 && host_write_ctrl_unsafe(s->io_base, ((unsigned char) uctl->value.integer. value[0]) & 127, 100)
772 && host_write_ctrl_unsafe(s->io_base, CMD_XXX_MIDI_VOL, 100));
776 * Take the board out of HOST mode and back into MIDI mode ...
778 set_midi_mode_unsafe(s->io_base);
780 spin_unlock_irqrestore(&s->lock, flags);
784 static struct snd_kcontrol_new midi_mixer_ctl = {
785 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
787 .info = sscape_midi_info,
788 .get = sscape_midi_get,
789 .put = sscape_midi_put
793 * The SoundScape can use two IRQs from a possible set of four.
794 * These IRQs are encoded as bit patterns so that they can be
795 * written to the control registers.
797 static unsigned __devinit get_irq_config(int irq)
799 static const int valid_irq[] = { 9, 5, 7, 10 };
802 for (cfg = 0; cfg < ARRAY_SIZE(valid_irq); ++cfg) {
803 if (irq == valid_irq[cfg])
812 * Perform certain arcane port-checks to see whether there
813 * is a SoundScape board lurking behind the given ports.
815 static int __devinit detect_sscape(struct soundscape *s)
820 int codec = s->wss_base;
822 spin_lock_irqsave(&s->lock, flags);
825 * The following code is lifted from the original OSS driver,
826 * and as I don't have a datasheet I cannot really comment
827 * on what it is doing...
829 if ((inb(HOST_CTRL_IO(s->io_base)) & 0x78) != 0)
832 d = inb(ODIE_ADDR_IO(s->io_base)) & 0xf0;
838 s->ic_type = IC_ODIE;
839 } else if ((d & 0x60) != 0) {
841 s->ic_type = IC_OPUS;
845 outb(0xfa, ODIE_ADDR_IO(s->io_base));
846 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0a)
849 outb(0xfe, ODIE_ADDR_IO(s->io_base));
850 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0e)
853 outb(0xfe, ODIE_ADDR_IO(s->io_base));
854 d = inb(ODIE_DATA_IO(s->io_base));
855 if (s->type != SSCAPE_VIVO && (d & 0x9f) != 0x0e)
858 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f;
859 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
861 if (s->type == SSCAPE_VIVO)
863 /* wait for WSS codec */
864 for (d = 0; d < 500; d++) {
865 if ((inb(codec) & 0x80) == 0)
867 spin_unlock_irqrestore(&s->lock, flags);
869 spin_lock_irqsave(&s->lock, flags);
871 snd_printd(KERN_INFO "init delay = %d ms\n", d);
874 * SoundScape successfully detected!
879 spin_unlock_irqrestore(&s->lock, flags);
884 * ALSA callback function, called when attempting to open the MIDI device.
885 * Check that the MIDI firmware has been loaded, because we don't want
886 * to crash the machine. Also check that someone isn't using the hardware
889 static int mpu401_open(struct snd_mpu401 * mpu)
893 if (!verify_mpu401(mpu)) {
894 snd_printk(KERN_ERR "sscape: MIDI disabled, please load firmware\n");
897 register struct soundscape *sscape = get_mpu401_soundscape(mpu);
900 spin_lock_irqsave(&sscape->fwlock, flags);
902 if (sscape->hw_in_use || (sscape->midi_usage == ULONG_MAX)) {
905 ++(sscape->midi_usage);
909 spin_unlock_irqrestore(&sscape->fwlock, flags);
915 static void mpu401_close(struct snd_mpu401 * mpu)
917 register struct soundscape *sscape = get_mpu401_soundscape(mpu);
920 spin_lock_irqsave(&sscape->fwlock, flags);
921 --(sscape->midi_usage);
922 spin_unlock_irqrestore(&sscape->fwlock, flags);
926 * Initialse an MPU-401 subdevice for MIDI support on the SoundScape.
928 static int __devinit create_mpu401(struct snd_card *card, int devnum, unsigned long port, int irq)
930 struct soundscape *sscape = get_card_soundscape(card);
931 struct snd_rawmidi *rawmidi;
934 if ((err = snd_mpu401_uart_new(card, devnum,
936 port, MPU401_INFO_INTEGRATED,
939 struct snd_mpu401 *mpu = (struct snd_mpu401 *) rawmidi->private_data;
940 mpu->open_input = mpu401_open;
941 mpu->open_output = mpu401_open;
942 mpu->close_input = mpu401_close;
943 mpu->close_output = mpu401_close;
944 mpu->private_data = sscape;
947 initialise_mpu401(mpu);
955 * Create an AD1845 PCM subdevice on the SoundScape. The AD1845
956 * is very much like a CS4231, with a few extra bits. We will
957 * try to support at least some of the extra bits by overriding
958 * some of the CS4231 callback.
960 static int __devinit create_ad1845(struct snd_card *card, unsigned port,
961 int irq, int dma1, int dma2)
963 register struct soundscape *sscape = get_card_soundscape(card);
964 struct snd_wss *chip;
967 if (sscape->type == SSCAPE_VIVO)
973 err = snd_wss_create(card, port, -1, irq, dma1, dma2,
974 WSS_HW_DETECT, WSS_HWSHARE_DMA1, &chip);
980 * It turns out that the PLAYBACK_ENABLE bit is set
981 * by the lowlevel driver ...
983 #define AD1845_IFACE_CONFIG \
984 (CS4231_AUTOCALIB | CS4231_RECORD_ENABLE | CS4231_PLAYBACK_ENABLE)
985 snd_wss_mce_up(chip);
986 spin_lock_irqsave(&chip->reg_lock, flags);
987 snd_wss_out(chip, CS4231_IFACE_CTRL, AD1845_IFACE_CONFIG);
988 spin_unlock_irqrestore(&chip->reg_lock, flags);
989 snd_wss_mce_down(chip);
992 if (sscape->type != SSCAPE_VIVO) {
994 * The input clock frequency on the SoundScape must
995 * be 14.31818 MHz, because we must set this register
996 * to get the playback to sound correct ...
998 snd_wss_mce_up(chip);
999 spin_lock_irqsave(&chip->reg_lock, flags);
1000 snd_wss_out(chip, AD1845_CLOCK, 0x20);
1001 spin_unlock_irqrestore(&chip->reg_lock, flags);
1002 snd_wss_mce_down(chip);
1006 err = snd_wss_pcm(chip, 0, &pcm);
1008 snd_printk(KERN_ERR "sscape: No PCM device "
1009 "for AD1845 chip\n");
1013 err = snd_wss_mixer(chip);
1015 snd_printk(KERN_ERR "sscape: No mixer device "
1016 "for AD1845 chip\n");
1019 if (chip->hardware != WSS_HW_AD1848) {
1020 err = snd_wss_timer(chip, 0, NULL);
1022 snd_printk(KERN_ERR "sscape: No timer device "
1023 "for AD1845 chip\n");
1028 if (sscape->type != SSCAPE_VIVO) {
1029 err = snd_ctl_add(card,
1030 snd_ctl_new1(&midi_mixer_ctl, chip));
1032 snd_printk(KERN_ERR "sscape: Could not create "
1033 "MIDI mixer control\n");
1038 strcpy(card->driver, "SoundScape");
1039 strcpy(card->shortname, pcm->name);
1040 snprintf(card->longname, sizeof(card->longname),
1041 "%s at 0x%lx, IRQ %d, DMA1 %d, DMA2 %d\n",
1042 pcm->name, chip->port, chip->irq,
1043 chip->dma1, chip->dma2);
1045 sscape->chip = chip;
1054 * Create an ALSA soundcard entry for the SoundScape, using
1055 * the given list of port, IRQ and DMA resources.
1057 static int __devinit create_sscape(int dev, struct snd_card *card)
1059 struct soundscape *sscape = get_card_soundscape(card);
1062 unsigned mpu_irq_cfg;
1064 struct resource *io_res;
1065 struct resource *wss_res;
1066 unsigned long flags;
1070 * Check that the user didn't pass us garbage data ...
1072 irq_cfg = get_irq_config(irq[dev]);
1073 if (irq_cfg == INVALID_IRQ) {
1074 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", irq[dev]);
1078 mpu_irq_cfg = get_irq_config(mpu_irq[dev]);
1079 if (mpu_irq_cfg == INVALID_IRQ) {
1080 printk(KERN_ERR "sscape: Invalid IRQ %d\n", mpu_irq[dev]);
1086 * Grab IO ports that we will need to probe so that we
1087 * can detect and control this hardware ...
1089 io_res = request_region(xport, 8, "SoundScape");
1091 snd_printk(KERN_ERR "sscape: can't grab port 0x%x\n", xport);
1095 if (sscape->type == SSCAPE_VIVO) {
1096 wss_res = request_region(wss_port[dev], 4, "SoundScape");
1098 snd_printk(KERN_ERR "sscape: can't grab port 0x%lx\n",
1101 goto _release_region;
1106 * Grab one DMA channel ...
1108 err = request_dma(dma[dev], "SoundScape");
1110 snd_printk(KERN_ERR "sscape: can't grab DMA %d\n", dma[dev]);
1111 goto _release_region;
1114 spin_lock_init(&sscape->lock);
1115 spin_lock_init(&sscape->fwlock);
1116 sscape->io_res = io_res;
1117 sscape->wss_res = wss_res;
1118 sscape->io_base = xport;
1119 sscape->wss_base = wss_port[dev];
1121 if (!detect_sscape(sscape)) {
1122 printk(KERN_ERR "sscape: hardware not detected at 0x%x\n", sscape->io_base);
1127 printk(KERN_INFO "sscape: hardware detected at 0x%x, using IRQ %d, DMA %d\n",
1128 sscape->io_base, irq[dev], dma[dev]);
1130 if (sscape->type != SSCAPE_VIVO) {
1132 * Now create the hardware-specific device so that we can
1133 * load the microcode into the on-board processor.
1134 * We cannot use the MPU-401 MIDI system until this firmware
1135 * has been loaded into the card.
1137 err = snd_hwdep_new(card, "MC68EC000", 0, &(sscape->hw));
1139 printk(KERN_ERR "sscape: Failed to create "
1140 "firmware device\n");
1143 strlcpy(sscape->hw->name, "SoundScape M68K",
1144 sizeof(sscape->hw->name));
1145 sscape->hw->name[sizeof(sscape->hw->name) - 1] = '\0';
1146 sscape->hw->iface = SNDRV_HWDEP_IFACE_SSCAPE;
1147 sscape->hw->ops.open = sscape_hw_open;
1148 sscape->hw->ops.release = sscape_hw_release;
1149 sscape->hw->ops.ioctl = sscape_hw_ioctl;
1150 sscape->hw->private_data = sscape;
1154 * Tell the on-board devices where their resources are (I think -
1155 * I can't be sure without a datasheet ... So many magic values!)
1157 spin_lock_irqsave(&sscape->lock, flags);
1159 activate_ad1845_unsafe(sscape->io_base);
1161 sscape_write_unsafe(sscape->io_base, GA_INTENA_REG, 0x00); /* disable */
1162 sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2e);
1163 sscape_write_unsafe(sscape->io_base, GA_SMCFGB_REG, 0x00);
1166 * Enable and configure the DMA channels ...
1168 sscape_write_unsafe(sscape->io_base, GA_DMACFG_REG, 0x50);
1169 dma_cfg = (sscape->ic_type == IC_ODIE ? 0x70 : 0x40);
1170 sscape_write_unsafe(sscape->io_base, GA_DMAA_REG, dma_cfg);
1171 sscape_write_unsafe(sscape->io_base, GA_DMAB_REG, 0x20);
1173 sscape_write_unsafe(sscape->io_base,
1174 GA_INTCFG_REG, 0xf0 | (mpu_irq_cfg << 2) | mpu_irq_cfg);
1175 sscape_write_unsafe(sscape->io_base,
1176 GA_CDCFG_REG, 0x09 | DMA_8BIT
1177 | (dma[dev] << 4) | (irq_cfg << 1));
1179 spin_unlock_irqrestore(&sscape->lock, flags);
1182 * We have now enabled the codec chip, and so we should
1183 * detect the AD1845 device ...
1185 err = create_ad1845(card, wss_port[dev], irq[dev],
1186 dma[dev], dma2[dev]);
1188 printk(KERN_ERR "sscape: No AD1845 device at 0x%lx, IRQ %d\n",
1189 wss_port[dev], irq[dev]);
1192 #define MIDI_DEVNUM 0
1193 if (sscape->type != SSCAPE_VIVO) {
1194 err = create_mpu401(card, MIDI_DEVNUM,
1195 MPU401_IO(xport), mpu_irq[dev]);
1197 printk(KERN_ERR "sscape: Failed to create "
1198 "MPU-401 device at 0x%x\n",
1204 * Enable the master IRQ ...
1206 sscape_write(sscape, GA_INTENA_REG, 0x80);
1211 sscape->midi_vol = 0;
1212 host_write_ctrl_unsafe(sscape->io_base, CMD_SET_MIDI_VOL, 100);
1213 host_write_ctrl_unsafe(sscape->io_base, 0, 100);
1214 host_write_ctrl_unsafe(sscape->io_base, CMD_XXX_MIDI_VOL, 100);
1218 * Now that we have successfully created this sound card,
1219 * it is safe to store the pointer.
1220 * NOTE: we only register the sound card's "destructor"
1221 * function now that our "constructor" has completed.
1223 card->private_free = soundscape_free;
1231 release_and_free_resource(wss_res);
1232 release_and_free_resource(io_res);
1238 static int __devinit snd_sscape_match(struct device *pdev, unsigned int i)
1241 * Make sure we were given ALL of the other parameters.
1243 if (port[i] == SNDRV_AUTO_PORT)
1246 if (irq[i] == SNDRV_AUTO_IRQ ||
1247 mpu_irq[i] == SNDRV_AUTO_IRQ ||
1248 dma[i] == SNDRV_AUTO_DMA) {
1250 "sscape: insufficient parameters, need IO, IRQ, MPU-IRQ and DMA\n");
1257 static int __devinit snd_sscape_probe(struct device *pdev, unsigned int dev)
1259 struct snd_card *card;
1260 struct soundscape *sscape;
1263 card = snd_card_new(index[dev], id[dev], THIS_MODULE,
1264 sizeof(struct soundscape));
1268 sscape = get_card_soundscape(card);
1269 sscape->type = SSCAPE;
1272 ret = create_sscape(dev, card);
1276 snd_card_set_dev(card, pdev);
1277 if ((ret = snd_card_register(card)) < 0) {
1278 printk(KERN_ERR "sscape: Failed to register sound card\n");
1281 dev_set_drvdata(pdev, card);
1285 snd_card_free(card);
1289 static int __devexit snd_sscape_remove(struct device *devptr, unsigned int dev)
1291 snd_card_free(dev_get_drvdata(devptr));
1292 dev_set_drvdata(devptr, NULL);
1296 #define DEV_NAME "sscape"
1298 static struct isa_driver snd_sscape_driver = {
1299 .match = snd_sscape_match,
1300 .probe = snd_sscape_probe,
1301 .remove = __devexit_p(snd_sscape_remove),
1302 /* FIXME: suspend/resume */
1309 static inline int __devinit get_next_autoindex(int i)
1311 while (i < SNDRV_CARDS && port[i] != SNDRV_AUTO_PORT)
1317 static int __devinit sscape_pnp_detect(struct pnp_card_link *pcard,
1318 const struct pnp_card_device_id *pid)
1321 struct pnp_dev *dev;
1322 struct snd_card *card;
1323 struct soundscape *sscape;
1327 * Allow this function to fail *quietly* if all the ISA PnP
1328 * devices were configured using module parameters instead.
1330 if ((idx = get_next_autoindex(idx)) >= SNDRV_CARDS)
1334 * We have found a candidate ISA PnP card. Now we
1335 * have to check that it has the devices that we
1336 * expect it to have.
1338 * We will NOT try and autoconfigure all of the resources
1339 * needed and then activate the card as we are assuming that
1340 * has already been done at boot-time using /proc/isapnp.
1341 * We shall simply try to give each active card the resources
1342 * that it wants. This is a sensible strategy for a modular
1343 * system where unused modules are unloaded regularly.
1345 * This strategy is utterly useless if we compile the driver
1346 * into the kernel, of course.
1348 // printk(KERN_INFO "sscape: %s\n", card->name);
1351 * Check that we still have room for another sound card ...
1353 dev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
1357 if (!pnp_is_active(dev)) {
1358 if (pnp_activate_dev(dev) < 0) {
1359 printk(KERN_INFO "sscape: device is inactive\n");
1365 * Create a new ALSA sound card entry, in anticipation
1366 * of detecting our hardware ...
1368 card = snd_card_new(index[idx], id[idx], THIS_MODULE,
1369 sizeof(struct soundscape));
1373 sscape = get_card_soundscape(card);
1376 * Identify card model ...
1378 if (!strncmp("ENS4081", pid->id, 7))
1379 sscape->type = SSCAPE_VIVO;
1381 sscape->type = SSCAPE_PNP;
1384 * Read the correct parameters off the ISA PnP bus ...
1386 port[idx] = pnp_port_start(dev, 0);
1387 irq[idx] = pnp_irq(dev, 0);
1388 mpu_irq[idx] = pnp_irq(dev, 1);
1389 dma[idx] = pnp_dma(dev, 0) & 0x03;
1390 if (sscape->type == SSCAPE_PNP) {
1391 dma2[idx] = dma[idx];
1392 wss_port[idx] = CODEC_IO(port[idx]);
1394 wss_port[idx] = pnp_port_start(dev, 1);
1395 dma2[idx] = pnp_dma(dev, 1);
1398 ret = create_sscape(idx, card);
1402 snd_card_set_dev(card, &pcard->card->dev);
1403 if ((ret = snd_card_register(card)) < 0) {
1404 printk(KERN_ERR "sscape: Failed to register sound card\n");
1408 pnp_set_card_drvdata(pcard, card);
1413 snd_card_free(card);
1417 static void __devexit sscape_pnp_remove(struct pnp_card_link * pcard)
1419 snd_card_free(pnp_get_card_drvdata(pcard));
1420 pnp_set_card_drvdata(pcard, NULL);
1423 static struct pnp_card_driver sscape_pnpc_driver = {
1424 .flags = PNP_DRIVER_RES_DO_NOT_CHANGE,
1426 .id_table = sscape_pnpids,
1427 .probe = sscape_pnp_detect,
1428 .remove = __devexit_p(sscape_pnp_remove),
1431 #endif /* CONFIG_PNP */
1433 static int __init sscape_init(void)
1437 err = isa_register_driver(&snd_sscape_driver, SNDRV_CARDS);
1442 err = pnp_register_card_driver(&sscape_pnpc_driver);
1452 static void __exit sscape_exit(void)
1456 pnp_unregister_card_driver(&sscape_pnpc_driver);
1459 isa_unregister_driver(&snd_sscape_driver);
1462 module_init(sscape_init);
1463 module_exit(sscape_exit);