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 <sound/driver.h>
25 #include <linux/init.h>
26 #include <linux/err.h>
27 #include <linux/isa.h>
28 #include <linux/delay.h>
29 #include <linux/pnp.h>
30 #include <linux/spinlock.h>
31 #include <linux/moduleparam.h>
33 #include <sound/core.h>
34 #include <sound/hwdep.h>
35 #include <sound/cs4231.h>
36 #include <sound/mpu401.h>
37 #include <sound/initval.h>
39 #include <sound/sscape_ioctl.h>
42 MODULE_AUTHOR("Chris Rankin");
43 MODULE_DESCRIPTION("ENSONIQ SoundScape PnP driver");
44 MODULE_LICENSE("GPL");
46 static int index[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_IDX;
47 static char* id[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_STR;
48 static long port[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_PORT;
49 static long wss_port[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_PORT;
50 static int irq[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_IRQ;
51 static int mpu_irq[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_IRQ;
52 static int dma[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_DMA;
53 static int dma2[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_DMA;
55 module_param_array(index, int, NULL, 0444);
56 MODULE_PARM_DESC(index, "Index number for SoundScape soundcard");
58 module_param_array(id, charp, NULL, 0444);
59 MODULE_PARM_DESC(id, "Description for SoundScape card");
61 module_param_array(port, long, NULL, 0444);
62 MODULE_PARM_DESC(port, "Port # for SoundScape driver.");
64 module_param_array(wss_port, long, NULL, 0444);
65 MODULE_PARM_DESC(wss_port, "WSS Port # for SoundScape driver.");
67 module_param_array(irq, int, NULL, 0444);
68 MODULE_PARM_DESC(irq, "IRQ # for SoundScape driver.");
70 module_param_array(mpu_irq, int, NULL, 0444);
71 MODULE_PARM_DESC(mpu_irq, "MPU401 IRQ # for SoundScape driver.");
73 module_param_array(dma, int, NULL, 0444);
74 MODULE_PARM_DESC(dma, "DMA # for SoundScape driver.");
76 module_param_array(dma2, int, NULL, 0444);
77 MODULE_PARM_DESC(dma2, "DMA2 # for SoundScape driver.");
80 static int isa_registered;
81 static int pnp_registered;
83 static struct pnp_card_device_id sscape_pnpids[] = {
84 { .id = "ENS3081", .devs = { { "ENS0000" } } }, /* Soundscape PnP */
85 { .id = "ENS4081", .devs = { { "ENS1011" } } }, /* VIVO90 */
86 { .id = "" } /* end */
89 MODULE_DEVICE_TABLE(pnp_card, sscape_pnpids);
93 #define MPU401_IO(i) ((i) + 0)
94 #define MIDI_DATA_IO(i) ((i) + 0)
95 #define MIDI_CTRL_IO(i) ((i) + 1)
96 #define HOST_CTRL_IO(i) ((i) + 2)
97 #define HOST_DATA_IO(i) ((i) + 3)
98 #define ODIE_ADDR_IO(i) ((i) + 4)
99 #define ODIE_DATA_IO(i) ((i) + 5)
100 #define CODEC_IO(i) ((i) + 8)
105 #define RX_READY 0x01
106 #define TX_READY 0x02
109 #define CMD_SET_MIDI_VOL 0x84
110 #define CMD_GET_MIDI_VOL 0x85
111 #define CMD_XXX_MIDI_VOL 0x86
112 #define CMD_SET_EXTMIDI 0x8a
113 #define CMD_GET_EXTMIDI 0x8b
114 #define CMD_SET_MT32 0x8c
115 #define CMD_GET_MT32 0x8d
130 #define DMA_8BIT 0x80
133 #define AD1845_FREQ_SEL_MSB 0x16
134 #define AD1845_FREQ_SEL_LSB 0x17
148 struct resource *io_res;
149 struct snd_cs4231 *chip;
150 struct snd_mpu401 *mpu;
151 struct snd_hwdep *hw;
154 * The MIDI device won't work until we've loaded
155 * its firmware via a hardware-dependent device IOCTL
159 unsigned long midi_usage;
160 unsigned char midi_vol;
163 #define INVALID_IRQ ((unsigned)-1)
166 static inline struct soundscape *get_card_soundscape(struct snd_card *c)
168 return (struct soundscape *) (c->private_data);
171 static inline struct soundscape *get_mpu401_soundscape(struct snd_mpu401 * mpu)
173 return (struct soundscape *) (mpu->private_data);
176 static inline struct soundscape *get_hwdep_soundscape(struct snd_hwdep * hw)
178 return (struct soundscape *) (hw->private_data);
183 * Allocates some kernel memory that we can use for DMA.
184 * I think this means that the memory has to map to
185 * contiguous pages of physical memory.
187 static struct snd_dma_buffer *get_dmabuf(struct snd_dma_buffer *buf, unsigned long size)
190 if (snd_dma_alloc_pages_fallback(SNDRV_DMA_TYPE_DEV, snd_dma_isa_data(),
192 snd_printk(KERN_ERR "sscape: Failed to allocate %lu bytes for DMA\n", size);
201 * Release the DMA-able kernel memory ...
203 static void free_dmabuf(struct snd_dma_buffer *buf)
205 if (buf && buf->area)
206 snd_dma_free_pages(buf);
211 * This function writes to the SoundScape's control registers,
212 * but doesn't do any locking. It's up to the caller to do that.
213 * This is why this function is "unsafe" ...
215 static inline void sscape_write_unsafe(unsigned io_base, enum GA_REG reg, unsigned char val)
217 outb(reg, ODIE_ADDR_IO(io_base));
218 outb(val, ODIE_DATA_IO(io_base));
222 * Write to the SoundScape's control registers, and do the
223 * necessary locking ...
225 static void sscape_write(struct soundscape *s, enum GA_REG reg, unsigned char val)
229 spin_lock_irqsave(&s->lock, flags);
230 sscape_write_unsafe(s->io_base, reg, val);
231 spin_unlock_irqrestore(&s->lock, flags);
235 * Read from the SoundScape's control registers, but leave any
236 * locking to the caller. This is why the function is "unsafe" ...
238 static inline unsigned char sscape_read_unsafe(unsigned io_base, enum GA_REG reg)
240 outb(reg, ODIE_ADDR_IO(io_base));
241 return inb(ODIE_DATA_IO(io_base));
245 * Puts the SoundScape into "host" mode, as compared to "MIDI" mode
247 static inline void set_host_mode_unsafe(unsigned io_base)
249 outb(0x0, HOST_CTRL_IO(io_base));
253 * Puts the SoundScape into "MIDI" mode, as compared to "host" mode
255 static inline void set_midi_mode_unsafe(unsigned io_base)
257 outb(0x3, HOST_CTRL_IO(io_base));
261 * Read the SoundScape's host-mode control register, but leave
262 * any locking issues to the caller ...
264 static inline int host_read_unsafe(unsigned io_base)
267 if ((inb(HOST_CTRL_IO(io_base)) & RX_READY) != 0) {
268 data = inb(HOST_DATA_IO(io_base));
275 * Read the SoundScape's host-mode control register, performing
276 * a limited amount of busy-waiting if the register isn't ready.
277 * Also leaves all locking-issues to the caller ...
279 static int host_read_ctrl_unsafe(unsigned io_base, unsigned timeout)
283 while (((data = host_read_unsafe(io_base)) < 0) && (timeout != 0)) {
292 * Write to the SoundScape's host-mode control registers, but
293 * leave any locking issues to the caller ...
295 static inline int host_write_unsafe(unsigned io_base, unsigned char data)
297 if ((inb(HOST_CTRL_IO(io_base)) & TX_READY) != 0) {
298 outb(data, HOST_DATA_IO(io_base));
306 * Write to the SoundScape's host-mode control registers, performing
307 * a limited amount of busy-waiting if the register isn't ready.
308 * Also leaves all locking-issues to the caller ...
310 static int host_write_ctrl_unsafe(unsigned io_base, unsigned char data,
315 while (!(err = host_write_unsafe(io_base, data)) && (timeout != 0)) {
325 * Check that the MIDI subsystem is operational. If it isn't,
326 * then we will hang the computer if we try to use it ...
328 * NOTE: This check is based upon observation, not documentation.
330 static inline int verify_mpu401(const struct snd_mpu401 * mpu)
332 return ((inb(MIDI_CTRL_IO(mpu->port)) & 0xc0) == 0x80);
336 * This is apparently the standard way to initailise an MPU-401
338 static inline void initialise_mpu401(const struct snd_mpu401 * mpu)
340 outb(0, MIDI_DATA_IO(mpu->port));
344 * Tell the SoundScape to activate the AD1845 chip (I think).
345 * The AD1845 detection fails if we *don't* do this, so I
346 * think that this is a good idea ...
348 static inline void activate_ad1845_unsafe(unsigned io_base)
350 sscape_write_unsafe(io_base, GA_HMCTL_REG, (sscape_read_unsafe(io_base, GA_HMCTL_REG) & 0xcf) | 0x10);
351 sscape_write_unsafe(io_base, GA_CDCFG_REG, 0x80);
355 * Do the necessary ALSA-level cleanup to deallocate our driver ...
357 static void soundscape_free(struct snd_card *c)
359 register struct soundscape *sscape = get_card_soundscape(c);
360 release_and_free_resource(sscape->io_res);
361 free_dma(sscape->chip->dma1);
365 * Tell the SoundScape to begin a DMA tranfer using the given channel.
366 * All locking issues are left to the caller.
368 static inline void sscape_start_dma_unsafe(unsigned io_base, enum GA_REG reg)
370 sscape_write_unsafe(io_base, reg, sscape_read_unsafe(io_base, reg) | 0x01);
371 sscape_write_unsafe(io_base, reg, sscape_read_unsafe(io_base, reg) & 0xfe);
375 * Wait for a DMA transfer to complete. This is a "limited busy-wait",
376 * and all locking issues are left to the caller.
378 static int sscape_wait_dma_unsafe(unsigned io_base, enum GA_REG reg, unsigned timeout)
380 while (!(sscape_read_unsafe(io_base, reg) & 0x01) && (timeout != 0)) {
385 return (sscape_read_unsafe(io_base, reg) & 0x01);
389 * Wait for the On-Board Processor to return its start-up
390 * acknowledgement sequence. This wait is too long for
391 * us to perform "busy-waiting", and so we must sleep.
392 * This in turn means that we must not be holding any
393 * spinlocks when we call this function.
395 static int obp_startup_ack(struct soundscape *s, unsigned timeout)
397 while (timeout != 0) {
403 spin_lock_irqsave(&s->lock, flags);
404 x = inb(HOST_DATA_IO(s->io_base));
405 spin_unlock_irqrestore(&s->lock, flags);
406 if ((x & 0xfe) == 0xfe)
416 * Wait for the host to return its start-up acknowledgement
417 * sequence. This wait is too long for us to perform
418 * "busy-waiting", and so we must sleep. This in turn means
419 * that we must not be holding any spinlocks when we call
422 static int host_startup_ack(struct soundscape *s, unsigned timeout)
424 while (timeout != 0) {
430 spin_lock_irqsave(&s->lock, flags);
431 x = inb(HOST_DATA_IO(s->io_base));
432 spin_unlock_irqrestore(&s->lock, flags);
443 * Upload a byte-stream into the SoundScape using DMA channel A.
445 static int upload_dma_data(struct soundscape *s,
446 const unsigned char __user *data,
450 struct snd_dma_buffer dma;
453 if (!get_dmabuf(&dma, PAGE_ALIGN(size)))
456 spin_lock_irqsave(&s->lock, flags);
459 * Reset the board ...
461 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f);
464 * Enable the DMA channels and configure them ...
466 sscape_write_unsafe(s->io_base, GA_DMACFG_REG, 0x50);
467 sscape_write_unsafe(s->io_base, GA_DMAA_REG, (s->chip->dma1 << 4) | DMA_8BIT);
468 sscape_write_unsafe(s->io_base, GA_DMAB_REG, 0x20);
471 * Take the board out of reset ...
473 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) | 0x80);
476 * Upload the user's data (firmware?) to the SoundScape
477 * board through the DMA channel ...
483 * Apparently, copying to/from userspace can sleep.
484 * We are therefore forbidden from holding any
485 * spinlocks while we copy ...
487 spin_unlock_irqrestore(&s->lock, flags);
490 * Remember that the data that we want to DMA
491 * comes from USERSPACE. We have already verified
492 * the userspace pointer ...
494 len = min(size, dma.bytes);
495 len -= __copy_from_user(dma.area, data, len);
500 * Grab that spinlock again, now that we've
503 spin_lock_irqsave(&s->lock, flags);
505 snd_dma_program(s->chip->dma1, dma.addr, len, DMA_MODE_WRITE);
506 sscape_start_dma_unsafe(s->io_base, GA_DMAA_REG);
507 if (!sscape_wait_dma_unsafe(s->io_base, GA_DMAA_REG, 5000)) {
509 * Don't forget to release this spinlock we're holding ...
511 spin_unlock_irqrestore(&s->lock, flags);
513 snd_printk(KERN_ERR "sscape: DMA upload has timed out\n");
519 set_host_mode_unsafe(s->io_base);
522 * Boot the board ... (I think)
524 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) | 0x40);
525 spin_unlock_irqrestore(&s->lock, flags);
528 * If all has gone well, then the board should acknowledge
529 * the new upload and tell us that it has rebooted OK. We
530 * give it 5 seconds (max) ...
533 if (!obp_startup_ack(s, 5)) {
534 snd_printk(KERN_ERR "sscape: No response from on-board processor after upload\n");
536 } else if (!host_startup_ack(s, 5)) {
537 snd_printk(KERN_ERR "sscape: SoundScape failed to initialise\n");
543 * NOTE!!! We are NOT holding any spinlocks at this point !!!
545 sscape_write(s, GA_DMAA_REG, (s->ic_type == IC_ODIE ? 0x70 : 0x40));
552 * Upload the bootblock(?) into the SoundScape. The only
553 * purpose of this block of code seems to be to tell
554 * us which version of the microcode we should be using.
556 * NOTE: The boot-block data resides in USER-SPACE!!!
557 * However, we have already verified its memory
558 * addresses by the time we get here.
560 static int sscape_upload_bootblock(struct soundscape *sscape, struct sscape_bootblock __user *bb)
566 ret = upload_dma_data(sscape, bb->code, sizeof(bb->code));
568 spin_lock_irqsave(&sscape->lock, flags);
570 data = host_read_ctrl_unsafe(sscape->io_base, 100);
572 set_midi_mode_unsafe(sscape->io_base);
573 spin_unlock_irqrestore(&sscape->lock, flags);
577 snd_printk(KERN_ERR "sscape: timeout reading firmware version\n");
580 else if (__copy_to_user(&bb->version, &data, sizeof(bb->version))) {
589 * Upload the microcode into the SoundScape. The
590 * microcode is 64K of data, and if we try to copy
591 * it into a local variable then we will SMASH THE
592 * KERNEL'S STACK! We therefore leave it in USER
593 * SPACE, and save ourselves from copying it at all.
595 static int sscape_upload_microcode(struct soundscape *sscape,
596 const struct sscape_microcode __user *mc)
603 * We are going to have to copy this data into a special
604 * DMA-able buffer before we can upload it. We shall therefore
605 * just check that the data pointer is valid for now.
607 * NOTE: This buffer is 64K long! That's WAY too big to
608 * copy into a stack-temporary anyway.
610 if ( get_user(code, &mc->code) ||
611 !access_ok(VERIFY_READ, code, SSCAPE_MICROCODE_SIZE) )
614 if ((err = upload_dma_data(sscape, code, SSCAPE_MICROCODE_SIZE)) == 0) {
615 snd_printk(KERN_INFO "sscape: MIDI firmware loaded\n");
618 spin_lock_irqsave(&sscape->lock, flags);
619 set_midi_mode_unsafe(sscape->io_base);
620 spin_unlock_irqrestore(&sscape->lock, flags);
622 initialise_mpu401(sscape->mpu);
628 * Hardware-specific device functions, to implement special
629 * IOCTLs for the SoundScape card. This is how we upload
630 * the microcode into the card, for example, and so we
631 * must ensure that no two processes can open this device
632 * simultaneously, and that we can't open it at all if
633 * someone is using the MIDI device.
635 static int sscape_hw_open(struct snd_hwdep * hw, struct file *file)
637 register struct soundscape *sscape = get_hwdep_soundscape(hw);
641 spin_lock_irqsave(&sscape->fwlock, flags);
643 if ((sscape->midi_usage != 0) || sscape->hw_in_use) {
646 sscape->hw_in_use = 1;
650 spin_unlock_irqrestore(&sscape->fwlock, flags);
654 static int sscape_hw_release(struct snd_hwdep * hw, struct file *file)
656 register struct soundscape *sscape = get_hwdep_soundscape(hw);
659 spin_lock_irqsave(&sscape->fwlock, flags);
660 sscape->hw_in_use = 0;
661 spin_unlock_irqrestore(&sscape->fwlock, flags);
665 static int sscape_hw_ioctl(struct snd_hwdep * hw, struct file *file,
666 unsigned int cmd, unsigned long arg)
668 struct soundscape *sscape = get_hwdep_soundscape(hw);
672 case SND_SSCAPE_LOAD_BOOTB:
674 register struct sscape_bootblock __user *bb = (struct sscape_bootblock __user *) arg;
677 * We are going to have to copy this data into a special
678 * DMA-able buffer before we can upload it. We shall therefore
679 * just check that the data pointer is valid for now ...
681 if ( !access_ok(VERIFY_READ, bb->code, sizeof(bb->code)) )
685 * Now check that we can write the firmware version number too...
687 if ( !access_ok(VERIFY_WRITE, &bb->version, sizeof(bb->version)) )
690 err = sscape_upload_bootblock(sscape, bb);
694 case SND_SSCAPE_LOAD_MCODE:
696 register const struct sscape_microcode __user *mc = (const struct sscape_microcode __user *) arg;
698 err = sscape_upload_microcode(sscape, mc);
712 * Mixer control for the SoundScape's MIDI device.
714 static int sscape_midi_info(struct snd_kcontrol *ctl,
715 struct snd_ctl_elem_info *uinfo)
717 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
719 uinfo->value.integer.min = 0;
720 uinfo->value.integer.max = 127;
724 static int sscape_midi_get(struct snd_kcontrol *kctl,
725 struct snd_ctl_elem_value *uctl)
727 struct snd_cs4231 *chip = snd_kcontrol_chip(kctl);
728 struct snd_card *card = chip->card;
729 register struct soundscape *s = get_card_soundscape(card);
732 spin_lock_irqsave(&s->lock, flags);
733 set_host_mode_unsafe(s->io_base);
735 if (host_write_ctrl_unsafe(s->io_base, CMD_GET_MIDI_VOL, 100)) {
736 uctl->value.integer.value[0] = host_read_ctrl_unsafe(s->io_base, 100);
739 set_midi_mode_unsafe(s->io_base);
740 spin_unlock_irqrestore(&s->lock, flags);
744 static int sscape_midi_put(struct snd_kcontrol *kctl,
745 struct snd_ctl_elem_value *uctl)
747 struct snd_cs4231 *chip = snd_kcontrol_chip(kctl);
748 struct snd_card *card = chip->card;
749 register struct soundscape *s = get_card_soundscape(card);
753 spin_lock_irqsave(&s->lock, flags);
756 * We need to put the board into HOST mode before we
757 * can send any volume-changing HOST commands ...
759 set_host_mode_unsafe(s->io_base);
762 * To successfully change the MIDI volume setting, you seem to
763 * have to write a volume command, write the new volume value,
764 * and then perform another volume-related command. Perhaps the
765 * first command is an "open" and the second command is a "close"?
767 if (s->midi_vol == ((unsigned char) uctl->value.integer. value[0] & 127)) {
771 change = (host_write_ctrl_unsafe(s->io_base, CMD_SET_MIDI_VOL, 100)
772 && host_write_ctrl_unsafe(s->io_base, ((unsigned char) uctl->value.integer. value[0]) & 127, 100)
773 && host_write_ctrl_unsafe(s->io_base, CMD_XXX_MIDI_VOL, 100));
777 * Take the board out of HOST mode and back into MIDI mode ...
779 set_midi_mode_unsafe(s->io_base);
781 spin_unlock_irqrestore(&s->lock, flags);
785 static struct snd_kcontrol_new midi_mixer_ctl = {
786 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
788 .info = sscape_midi_info,
789 .get = sscape_midi_get,
790 .put = sscape_midi_put
794 * The SoundScape can use two IRQs from a possible set of four.
795 * These IRQs are encoded as bit patterns so that they can be
796 * written to the control registers.
798 static unsigned __devinit get_irq_config(int irq)
800 static const int valid_irq[] = { 9, 5, 7, 10 };
803 for (cfg = 0; cfg < ARRAY_SIZE(valid_irq); ++cfg) {
804 if (irq == valid_irq[cfg])
813 * Perform certain arcane port-checks to see whether there
814 * is a SoundScape board lurking behind the given ports.
816 static int __devinit detect_sscape(struct soundscape *s)
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)
852 if ((inb(ODIE_DATA_IO(s->io_base)) & 0x9f) != 0x0e)
856 * SoundScape successfully detected!
861 spin_unlock_irqrestore(&s->lock, flags);
866 * ALSA callback function, called when attempting to open the MIDI device.
867 * Check that the MIDI firmware has been loaded, because we don't want
868 * to crash the machine. Also check that someone isn't using the hardware
871 static int mpu401_open(struct snd_mpu401 * mpu)
875 if (!verify_mpu401(mpu)) {
876 snd_printk(KERN_ERR "sscape: MIDI disabled, please load firmware\n");
879 register struct soundscape *sscape = get_mpu401_soundscape(mpu);
882 spin_lock_irqsave(&sscape->fwlock, flags);
884 if (sscape->hw_in_use || (sscape->midi_usage == ULONG_MAX)) {
887 ++(sscape->midi_usage);
891 spin_unlock_irqrestore(&sscape->fwlock, flags);
897 static void mpu401_close(struct snd_mpu401 * mpu)
899 register struct soundscape *sscape = get_mpu401_soundscape(mpu);
902 spin_lock_irqsave(&sscape->fwlock, flags);
903 --(sscape->midi_usage);
904 spin_unlock_irqrestore(&sscape->fwlock, flags);
908 * Initialse an MPU-401 subdevice for MIDI support on the SoundScape.
910 static int __devinit create_mpu401(struct snd_card *card, int devnum, unsigned long port, int irq)
912 struct soundscape *sscape = get_card_soundscape(card);
913 struct snd_rawmidi *rawmidi;
916 if ((err = snd_mpu401_uart_new(card, devnum,
918 port, MPU401_INFO_INTEGRATED,
921 struct snd_mpu401 *mpu = (struct snd_mpu401 *) rawmidi->private_data;
922 mpu->open_input = mpu401_open;
923 mpu->open_output = mpu401_open;
924 mpu->close_input = mpu401_close;
925 mpu->close_output = mpu401_close;
926 mpu->private_data = sscape;
929 initialise_mpu401(mpu);
937 * Override for the CS4231 playback format function.
938 * The AD1845 has much simpler format and rate selection.
940 static void ad1845_playback_format(struct snd_cs4231 * chip, struct snd_pcm_hw_params *params, unsigned char format)
943 unsigned rate = params_rate(params);
946 * The AD1845 can't handle sample frequencies
947 * outside of 4 kHZ to 50 kHZ
951 else if (rate < 4000)
954 spin_lock_irqsave(&chip->reg_lock, flags);
957 * Program the AD1845 correctly for the playback stream.
958 * Note that we do NOT need to toggle the MCE bit because
959 * the PLAYBACK_ENABLE bit of the Interface Configuration
962 * NOTE: We seem to need to write to the MSB before the LSB
963 * to get the correct sample frequency.
965 snd_cs4231_out(chip, CS4231_PLAYBK_FORMAT, (format & 0xf0));
966 snd_cs4231_out(chip, AD1845_FREQ_SEL_MSB, (unsigned char) (rate >> 8));
967 snd_cs4231_out(chip, AD1845_FREQ_SEL_LSB, (unsigned char) rate);
969 spin_unlock_irqrestore(&chip->reg_lock, flags);
973 * Override for the CS4231 capture format function.
974 * The AD1845 has much simpler format and rate selection.
976 static void ad1845_capture_format(struct snd_cs4231 * chip, struct snd_pcm_hw_params *params, unsigned char format)
979 unsigned rate = params_rate(params);
982 * The AD1845 can't handle sample frequencies
983 * outside of 4 kHZ to 50 kHZ
987 else if (rate < 4000)
990 spin_lock_irqsave(&chip->reg_lock, flags);
993 * Program the AD1845 correctly for the playback stream.
994 * Note that we do NOT need to toggle the MCE bit because
995 * the CAPTURE_ENABLE bit of the Interface Configuration
998 * NOTE: We seem to need to write to the MSB before the LSB
999 * to get the correct sample frequency.
1001 snd_cs4231_out(chip, CS4231_REC_FORMAT, (format & 0xf0));
1002 snd_cs4231_out(chip, AD1845_FREQ_SEL_MSB, (unsigned char) (rate >> 8));
1003 snd_cs4231_out(chip, AD1845_FREQ_SEL_LSB, (unsigned char) rate);
1005 spin_unlock_irqrestore(&chip->reg_lock, flags);
1009 * Create an AD1845 PCM subdevice on the SoundScape. The AD1845
1010 * is very much like a CS4231, with a few extra bits. We will
1011 * try to support at least some of the extra bits by overriding
1012 * some of the CS4231 callback.
1014 static int __devinit create_ad1845(struct snd_card *card, unsigned port,
1015 int irq, int dma1, int dma2)
1017 register struct soundscape *sscape = get_card_soundscape(card);
1018 struct snd_cs4231 *chip;
1024 err = snd_cs4231_create(card,
1025 port, -1, irq, dma1, dma2,
1026 CS4231_HW_DETECT, CS4231_HWSHARE_DMA1, &chip);
1028 unsigned long flags;
1029 struct snd_pcm *pcm;
1031 #define AD1845_FREQ_SEL_ENABLE 0x08
1033 #define AD1845_PWR_DOWN_CTRL 0x1b
1034 #define AD1845_CRYS_CLOCK_SEL 0x1d
1037 * It turns out that the PLAYBACK_ENABLE bit is set
1038 * by the lowlevel driver ...
1040 #define AD1845_IFACE_CONFIG \
1041 (CS4231_AUTOCALIB | CS4231_RECORD_ENABLE | CS4231_PLAYBACK_ENABLE)
1042 snd_cs4231_mce_up(chip);
1043 spin_lock_irqsave(&chip->reg_lock, flags);
1044 snd_cs4231_out(chip, CS4231_IFACE_CTRL, AD1845_IFACE_CONFIG);
1045 spin_unlock_irqrestore(&chip->reg_lock, flags);
1046 snd_cs4231_mce_down(chip);
1050 * The input clock frequency on the SoundScape must
1051 * be 14.31818 MHz, because we must set this register
1052 * to get the playback to sound correct ...
1054 snd_cs4231_mce_up(chip);
1055 spin_lock_irqsave(&chip->reg_lock, flags);
1056 snd_cs4231_out(chip, AD1845_CRYS_CLOCK_SEL, 0x20);
1057 spin_unlock_irqrestore(&chip->reg_lock, flags);
1058 snd_cs4231_mce_down(chip);
1061 * More custom configuration:
1062 * a) select "mode 2", and provide a current drive of 8 mA
1063 * b) enable frequency selection (for capture/playback)
1065 spin_lock_irqsave(&chip->reg_lock, flags);
1066 snd_cs4231_out(chip, CS4231_MISC_INFO, (CS4231_MODE2 | 0x10));
1067 snd_cs4231_out(chip, AD1845_PWR_DOWN_CTRL, snd_cs4231_in(chip, AD1845_PWR_DOWN_CTRL) | AD1845_FREQ_SEL_ENABLE);
1068 spin_unlock_irqrestore(&chip->reg_lock, flags);
1070 if ((err = snd_cs4231_pcm(chip, 0, &pcm)) < 0) {
1071 snd_printk(KERN_ERR "sscape: No PCM device for AD1845 chip\n");
1075 if ((err = snd_cs4231_mixer(chip)) < 0) {
1076 snd_printk(KERN_ERR "sscape: No mixer device for AD1845 chip\n");
1080 if ((err = snd_ctl_add(card, snd_ctl_new1(&midi_mixer_ctl, chip))) < 0) {
1081 snd_printk(KERN_ERR "sscape: Could not create MIDI mixer control\n");
1085 strcpy(card->driver, "SoundScape");
1086 strcpy(card->shortname, pcm->name);
1087 snprintf(card->longname, sizeof(card->longname),
1088 "%s at 0x%lx, IRQ %d, DMA1 %d, DMA2 %d\n",
1089 pcm->name, chip->port, chip->irq,
1090 chip->dma1, chip->dma2);
1091 chip->set_playback_format = ad1845_playback_format;
1092 chip->set_capture_format = ad1845_capture_format;
1093 sscape->chip = chip;
1102 * Create an ALSA soundcard entry for the SoundScape, using
1103 * the given list of port, IRQ and DMA resources.
1105 static int __devinit create_sscape(int dev, struct snd_card *card)
1107 register struct soundscape *sscape;
1108 register unsigned dma_cfg;
1110 unsigned mpu_irq_cfg;
1112 struct resource *io_res;
1113 unsigned long flags;
1117 * Check that the user didn't pass us garbage data ...
1119 irq_cfg = get_irq_config(irq[dev]);
1120 if (irq_cfg == INVALID_IRQ) {
1121 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", irq[dev]);
1125 mpu_irq_cfg = get_irq_config(mpu_irq[dev]);
1126 if (mpu_irq_cfg == INVALID_IRQ) {
1127 printk(KERN_ERR "sscape: Invalid IRQ %d\n", mpu_irq[dev]);
1133 * Grab IO ports that we will need to probe so that we
1134 * can detect and control this hardware ...
1136 if ((io_res = request_region(xport, 8, "SoundScape")) == NULL) {
1137 snd_printk(KERN_ERR "sscape: can't grab port 0x%x\n", xport);
1142 * Grab both DMA channels (OK, only one for now) ...
1144 err = request_dma(dma[dev], "SoundScape");
1146 snd_printk(KERN_ERR "sscape: can't grab DMA %d\n", dma[dev]);
1147 goto _release_region;
1150 sscape = get_card_soundscape(card);
1151 spin_lock_init(&sscape->lock);
1152 spin_lock_init(&sscape->fwlock);
1153 sscape->io_res = io_res;
1154 sscape->io_base = xport;
1156 if (!detect_sscape(sscape)) {
1157 printk(KERN_ERR "sscape: hardware not detected at 0x%x\n", sscape->io_base);
1162 printk(KERN_INFO "sscape: hardware detected at 0x%x, using IRQ %d, DMA %d\n",
1163 sscape->io_base, irq[dev], dma[dev]);
1166 * Now create the hardware-specific device so that we can
1167 * load the microcode into the on-board processor.
1168 * We cannot use the MPU-401 MIDI system until this firmware
1169 * has been loaded into the card.
1171 if ((err = snd_hwdep_new(card, "MC68EC000", 0, &(sscape->hw))) < 0) {
1172 printk(KERN_ERR "sscape: Failed to create firmware device\n");
1175 strlcpy(sscape->hw->name, "SoundScape M68K", sizeof(sscape->hw->name));
1176 sscape->hw->name[sizeof(sscape->hw->name) - 1] = '\0';
1177 sscape->hw->iface = SNDRV_HWDEP_IFACE_SSCAPE;
1178 sscape->hw->ops.open = sscape_hw_open;
1179 sscape->hw->ops.release = sscape_hw_release;
1180 sscape->hw->ops.ioctl = sscape_hw_ioctl;
1181 sscape->hw->private_data = sscape;
1184 * Tell the on-board devices where their resources are (I think -
1185 * I can't be sure without a datasheet ... So many magic values!)
1187 spin_lock_irqsave(&sscape->lock, flags);
1189 activate_ad1845_unsafe(sscape->io_base);
1191 sscape_write_unsafe(sscape->io_base, GA_INTENA_REG, 0x00); /* disable */
1192 sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2e);
1193 sscape_write_unsafe(sscape->io_base, GA_SMCFGB_REG, 0x00);
1196 * Enable and configure the DMA channels ...
1198 sscape_write_unsafe(sscape->io_base, GA_DMACFG_REG, 0x50);
1199 dma_cfg = (sscape->ic_type == IC_ODIE ? 0x70 : 0x40);
1200 sscape_write_unsafe(sscape->io_base, GA_DMAA_REG, dma_cfg);
1201 sscape_write_unsafe(sscape->io_base, GA_DMAB_REG, 0x20);
1203 sscape_write_unsafe(sscape->io_base,
1204 GA_INTCFG_REG, 0xf0 | (mpu_irq_cfg << 2) | mpu_irq_cfg);
1205 sscape_write_unsafe(sscape->io_base,
1206 GA_CDCFG_REG, 0x09 | DMA_8BIT
1207 | (dma[dev] << 4) | (irq_cfg << 1));
1209 spin_unlock_irqrestore(&sscape->lock, flags);
1212 * We have now enabled the codec chip, and so we should
1213 * detect the AD1845 device ...
1215 err = create_ad1845(card, wss_port[dev], irq[dev],
1216 dma[dev], dma2[dev]);
1218 printk(KERN_ERR "sscape: No AD1845 device at 0x%lx, IRQ %d\n",
1219 wss_port[dev], irq[dev]);
1222 #define MIDI_DEVNUM 0
1223 if ((err = create_mpu401(card, MIDI_DEVNUM, MPU401_IO(xport), mpu_irq[dev])) < 0) {
1224 printk(KERN_ERR "sscape: Failed to create MPU-401 device at 0x%x\n",
1230 * Enable the master IRQ ...
1232 sscape_write(sscape, GA_INTENA_REG, 0x80);
1237 sscape->midi_vol = 0;
1238 host_write_ctrl_unsafe(sscape->io_base, CMD_SET_MIDI_VOL, 100);
1239 host_write_ctrl_unsafe(sscape->io_base, 0, 100);
1240 host_write_ctrl_unsafe(sscape->io_base, CMD_XXX_MIDI_VOL, 100);
1243 * Now that we have successfully created this sound card,
1244 * it is safe to store the pointer.
1245 * NOTE: we only register the sound card's "destructor"
1246 * function now that our "constructor" has completed.
1248 card->private_free = soundscape_free;
1256 release_and_free_resource(io_res);
1262 static int __devinit snd_sscape_match(struct device *pdev, unsigned int i)
1265 * Make sure we were given ALL of the other parameters.
1267 if (port[i] == SNDRV_AUTO_PORT)
1270 if (irq[i] == SNDRV_AUTO_IRQ ||
1271 mpu_irq[i] == SNDRV_AUTO_IRQ ||
1272 dma[i] == SNDRV_AUTO_DMA) {
1274 "sscape: insufficient parameters, need IO, IRQ, MPU-IRQ and DMA\n");
1281 static int __devinit snd_sscape_probe(struct device *pdev, unsigned int dev)
1283 struct snd_card *card;
1284 struct soundscape *sscape;
1287 card = snd_card_new(index[dev], id[dev], THIS_MODULE,
1288 sizeof(struct soundscape));
1292 sscape = get_card_soundscape(card);
1293 sscape->type = SSCAPE;
1296 ret = create_sscape(dev, card);
1300 snd_card_set_dev(card, pdev);
1301 if ((ret = snd_card_register(card)) < 0) {
1302 printk(KERN_ERR "sscape: Failed to register sound card\n");
1305 dev_set_drvdata(pdev, card);
1309 snd_card_free(card);
1313 static int __devexit snd_sscape_remove(struct device *devptr, unsigned int dev)
1315 snd_card_free(dev_get_drvdata(devptr));
1316 dev_set_drvdata(devptr, NULL);
1320 #define DEV_NAME "sscape"
1322 static struct isa_driver snd_sscape_driver = {
1323 .match = snd_sscape_match,
1324 .probe = snd_sscape_probe,
1325 .remove = __devexit_p(snd_sscape_remove),
1326 /* FIXME: suspend/resume */
1333 static inline int __devinit get_next_autoindex(int i)
1335 while (i < SNDRV_CARDS && port[i] != SNDRV_AUTO_PORT)
1341 static int __devinit sscape_pnp_detect(struct pnp_card_link *pcard,
1342 const struct pnp_card_device_id *pid)
1345 struct pnp_dev *dev;
1346 struct snd_card *card;
1347 struct soundscape *sscape;
1351 * Allow this function to fail *quietly* if all the ISA PnP
1352 * devices were configured using module parameters instead.
1354 if ((idx = get_next_autoindex(idx)) >= SNDRV_CARDS)
1358 * We have found a candidate ISA PnP card. Now we
1359 * have to check that it has the devices that we
1360 * expect it to have.
1362 * We will NOT try and autoconfigure all of the resources
1363 * needed and then activate the card as we are assuming that
1364 * has already been done at boot-time using /proc/isapnp.
1365 * We shall simply try to give each active card the resources
1366 * that it wants. This is a sensible strategy for a modular
1367 * system where unused modules are unloaded regularly.
1369 * This strategy is utterly useless if we compile the driver
1370 * into the kernel, of course.
1372 // printk(KERN_INFO "sscape: %s\n", card->name);
1375 * Check that we still have room for another sound card ...
1377 dev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
1381 if (!pnp_is_active(dev)) {
1382 if (pnp_activate_dev(dev) < 0) {
1383 printk(KERN_INFO "sscape: device is inactive\n");
1389 * Create a new ALSA sound card entry, in anticipation
1390 * of detecting our hardware ...
1392 card = snd_card_new(index[idx], id[idx], THIS_MODULE,
1393 sizeof(struct soundscape));
1397 sscape = get_card_soundscape(card);
1400 * Identify card model ...
1402 if (!strncmp("ENS4081", pid->id, 7))
1403 sscape->type = SSCAPE_VIVO;
1405 sscape->type = SSCAPE_PNP;
1407 /* VIVO fails for now */
1408 if (sscape->type == SSCAPE_VIVO) {
1414 * Read the correct parameters off the ISA PnP bus ...
1416 port[idx] = pnp_port_start(dev, 0);
1417 irq[idx] = pnp_irq(dev, 0);
1418 mpu_irq[idx] = pnp_irq(dev, 1);
1419 dma[idx] = pnp_dma(dev, 0) & 0x03;
1420 dma2[idx] = dma[idx];
1421 wss_port[idx] = CODEC_IO(port[idx]);
1423 ret = create_sscape(idx, card);
1427 snd_card_set_dev(card, &pcard->card->dev);
1428 if ((ret = snd_card_register(card)) < 0) {
1429 printk(KERN_ERR "sscape: Failed to register sound card\n");
1433 pnp_set_card_drvdata(pcard, card);
1438 snd_card_free(card);
1442 static void __devexit sscape_pnp_remove(struct pnp_card_link * pcard)
1444 snd_card_free(pnp_get_card_drvdata(pcard));
1445 pnp_set_card_drvdata(pcard, NULL);
1448 static struct pnp_card_driver sscape_pnpc_driver = {
1449 .flags = PNP_DRIVER_RES_DO_NOT_CHANGE,
1451 .id_table = sscape_pnpids,
1452 .probe = sscape_pnp_detect,
1453 .remove = __devexit_p(sscape_pnp_remove),
1456 #endif /* CONFIG_PNP */
1458 static int __init sscape_init(void)
1462 err = isa_register_driver(&snd_sscape_driver, SNDRV_CARDS);
1467 err = pnp_register_card_driver(&sscape_pnpc_driver);
1477 static void __exit sscape_exit(void)
1481 pnp_unregister_card_driver(&sscape_pnpc_driver);
1484 isa_unregister_driver(&snd_sscape_driver);
1487 module_init(sscape_init);
1488 module_exit(sscape_exit);