2 * Low-level ALSA driver for the ENSONIQ SoundScape
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/firmware.h>
29 #include <linux/pnp.h>
30 #include <linux/spinlock.h>
31 #include <linux/moduleparam.h>
33 #include <sound/core.h>
34 #include <sound/wss.h>
35 #include <sound/mpu401.h>
36 #include <sound/initval.h>
39 MODULE_AUTHOR("Chris Rankin");
40 MODULE_DESCRIPTION("ENSONIQ SoundScape driver");
41 MODULE_LICENSE("GPL");
42 MODULE_FIRMWARE("sndscape.co0");
43 MODULE_FIRMWARE("sndscape.co1");
44 MODULE_FIRMWARE("sndscape.co2");
45 MODULE_FIRMWARE("sndscape.co3");
46 MODULE_FIRMWARE("sndscape.co4");
47 MODULE_FIRMWARE("scope.cod");
49 static int index[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_IDX;
50 static char* id[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_STR;
51 static long port[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_PORT;
52 static long wss_port[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_PORT;
53 static int irq[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_IRQ;
54 static int mpu_irq[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_IRQ;
55 static int dma[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_DMA;
56 static int dma2[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_DMA;
57 static bool joystick[SNDRV_CARDS] __devinitdata;
59 module_param_array(index, int, NULL, 0444);
60 MODULE_PARM_DESC(index, "Index number for SoundScape soundcard");
62 module_param_array(id, charp, NULL, 0444);
63 MODULE_PARM_DESC(id, "Description for SoundScape card");
65 module_param_array(port, long, NULL, 0444);
66 MODULE_PARM_DESC(port, "Port # for SoundScape driver.");
68 module_param_array(wss_port, long, NULL, 0444);
69 MODULE_PARM_DESC(wss_port, "WSS Port # for SoundScape driver.");
71 module_param_array(irq, int, NULL, 0444);
72 MODULE_PARM_DESC(irq, "IRQ # for SoundScape driver.");
74 module_param_array(mpu_irq, int, NULL, 0444);
75 MODULE_PARM_DESC(mpu_irq, "MPU401 IRQ # for SoundScape driver.");
77 module_param_array(dma, int, NULL, 0444);
78 MODULE_PARM_DESC(dma, "DMA # for SoundScape driver.");
80 module_param_array(dma2, int, NULL, 0444);
81 MODULE_PARM_DESC(dma2, "DMA2 # for SoundScape driver.");
83 module_param_array(joystick, bool, NULL, 0444);
84 MODULE_PARM_DESC(joystick, "Enable gameport.");
87 static int isa_registered;
88 static int pnp_registered;
90 static struct pnp_card_device_id sscape_pnpids[] = {
91 { .id = "ENS3081", .devs = { { "ENS0000" } } }, /* Soundscape PnP */
92 { .id = "ENS4081", .devs = { { "ENS1011" } } }, /* VIVO90 */
93 { .id = "" } /* end */
96 MODULE_DEVICE_TABLE(pnp_card, sscape_pnpids);
100 #define HOST_CTRL_IO(i) ((i) + 2)
101 #define HOST_DATA_IO(i) ((i) + 3)
102 #define ODIE_ADDR_IO(i) ((i) + 4)
103 #define ODIE_DATA_IO(i) ((i) + 5)
104 #define CODEC_IO(i) ((i) + 8)
109 #define RX_READY 0x01
110 #define TX_READY 0x02
113 #define CMD_SET_MIDI_VOL 0x84
114 #define CMD_GET_MIDI_VOL 0x85
115 #define CMD_XXX_MIDI_VOL 0x86
116 #define CMD_SET_EXTMIDI 0x8a
117 #define CMD_GET_EXTMIDI 0x8b
118 #define CMD_SET_MT32 0x8c
119 #define CMD_GET_MT32 0x8d
134 #define DMA_8BIT 0x80
138 MEDIA_FX, /* Sequoia S-1000 */
139 SSCAPE, /* Sequoia S-2000 */
149 struct resource *io_res;
150 struct resource *wss_res;
151 struct snd_wss *chip;
153 unsigned char midi_vol;
156 #define INVALID_IRQ ((unsigned)-1)
159 static inline struct soundscape *get_card_soundscape(struct snd_card *c)
161 return (struct soundscape *) (c->private_data);
165 * Allocates some kernel memory that we can use for DMA.
166 * I think this means that the memory has to map to
167 * contiguous pages of physical memory.
169 static struct snd_dma_buffer *get_dmabuf(struct snd_dma_buffer *buf, unsigned long size)
172 if (snd_dma_alloc_pages_fallback(SNDRV_DMA_TYPE_DEV, snd_dma_isa_data(),
174 snd_printk(KERN_ERR "sscape: Failed to allocate "
175 "%lu bytes for DMA\n",
185 * Release the DMA-able kernel memory ...
187 static void free_dmabuf(struct snd_dma_buffer *buf)
189 if (buf && buf->area)
190 snd_dma_free_pages(buf);
195 * This function writes to the SoundScape's control registers,
196 * but doesn't do any locking. It's up to the caller to do that.
197 * This is why this function is "unsafe" ...
199 static inline void sscape_write_unsafe(unsigned io_base, enum GA_REG reg, unsigned char val)
201 outb(reg, ODIE_ADDR_IO(io_base));
202 outb(val, ODIE_DATA_IO(io_base));
206 * Write to the SoundScape's control registers, and do the
207 * necessary locking ...
209 static void sscape_write(struct soundscape *s, enum GA_REG reg, unsigned char val)
213 spin_lock_irqsave(&s->lock, flags);
214 sscape_write_unsafe(s->io_base, reg, val);
215 spin_unlock_irqrestore(&s->lock, flags);
219 * Read from the SoundScape's control registers, but leave any
220 * locking to the caller. This is why the function is "unsafe" ...
222 static inline unsigned char sscape_read_unsafe(unsigned io_base, enum GA_REG reg)
224 outb(reg, ODIE_ADDR_IO(io_base));
225 return inb(ODIE_DATA_IO(io_base));
229 * Puts the SoundScape into "host" mode, as compared to "MIDI" mode
231 static inline void set_host_mode_unsafe(unsigned io_base)
233 outb(0x0, HOST_CTRL_IO(io_base));
237 * Puts the SoundScape into "MIDI" mode, as compared to "host" mode
239 static inline void set_midi_mode_unsafe(unsigned io_base)
241 outb(0x3, HOST_CTRL_IO(io_base));
245 * Read the SoundScape's host-mode control register, but leave
246 * any locking issues to the caller ...
248 static inline int host_read_unsafe(unsigned io_base)
251 if ((inb(HOST_CTRL_IO(io_base)) & RX_READY) != 0) {
252 data = inb(HOST_DATA_IO(io_base));
259 * Read the SoundScape's host-mode control register, performing
260 * a limited amount of busy-waiting if the register isn't ready.
261 * Also leaves all locking-issues to the caller ...
263 static int host_read_ctrl_unsafe(unsigned io_base, unsigned timeout)
267 while (((data = host_read_unsafe(io_base)) < 0) && (timeout != 0)) {
276 * Write to the SoundScape's host-mode control registers, but
277 * leave any locking issues to the caller ...
279 static inline int host_write_unsafe(unsigned io_base, unsigned char data)
281 if ((inb(HOST_CTRL_IO(io_base)) & TX_READY) != 0) {
282 outb(data, HOST_DATA_IO(io_base));
290 * Write to the SoundScape's host-mode control registers, performing
291 * a limited amount of busy-waiting if the register isn't ready.
292 * Also leaves all locking-issues to the caller ...
294 static int host_write_ctrl_unsafe(unsigned io_base, unsigned char data,
299 while (!(err = host_write_unsafe(io_base, data)) && (timeout != 0)) {
309 * Check that the MIDI subsystem is operational. If it isn't,
310 * then we will hang the computer if we try to use it ...
312 * NOTE: This check is based upon observation, not documentation.
314 static inline int verify_mpu401(const struct snd_mpu401 * mpu)
316 return ((inb(MPU401C(mpu)) & 0xc0) == 0x80);
320 * This is apparently the standard way to initailise an MPU-401
322 static inline void initialise_mpu401(const struct snd_mpu401 * mpu)
324 outb(0, MPU401D(mpu));
328 * Tell the SoundScape to activate the AD1845 chip (I think).
329 * The AD1845 detection fails if we *don't* do this, so I
330 * think that this is a good idea ...
332 static inline void activate_ad1845_unsafe(unsigned io_base)
334 sscape_write_unsafe(io_base, GA_HMCTL_REG, (sscape_read_unsafe(io_base, GA_HMCTL_REG) & 0xcf) | 0x10);
335 sscape_write_unsafe(io_base, GA_CDCFG_REG, 0x80);
339 * Do the necessary ALSA-level cleanup to deallocate our driver ...
341 static void soundscape_free(struct snd_card *c)
343 struct soundscape *sscape = get_card_soundscape(c);
344 release_and_free_resource(sscape->io_res);
345 release_and_free_resource(sscape->wss_res);
346 free_dma(sscape->chip->dma1);
350 * Tell the SoundScape to begin a DMA tranfer using the given channel.
351 * All locking issues are left to the caller.
353 static inline void sscape_start_dma_unsafe(unsigned io_base, enum GA_REG reg)
355 sscape_write_unsafe(io_base, reg, sscape_read_unsafe(io_base, reg) | 0x01);
356 sscape_write_unsafe(io_base, reg, sscape_read_unsafe(io_base, reg) & 0xfe);
360 * Wait for a DMA transfer to complete. This is a "limited busy-wait",
361 * and all locking issues are left to the caller.
363 static int sscape_wait_dma_unsafe(unsigned io_base, enum GA_REG reg, unsigned timeout)
365 while (!(sscape_read_unsafe(io_base, reg) & 0x01) && (timeout != 0)) {
370 return (sscape_read_unsafe(io_base, reg) & 0x01);
374 * Wait for the On-Board Processor to return its start-up
375 * acknowledgement sequence. This wait is too long for
376 * us to perform "busy-waiting", and so we must sleep.
377 * This in turn means that we must not be holding any
378 * spinlocks when we call this function.
380 static int obp_startup_ack(struct soundscape *s, unsigned timeout)
382 unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
388 spin_lock_irqsave(&s->lock, flags);
389 x = host_read_unsafe(s->io_base);
390 spin_unlock_irqrestore(&s->lock, flags);
391 if (x == 0xfe || x == 0xff)
395 } while (time_before(jiffies, end_time));
401 * Wait for the host to return its start-up acknowledgement
402 * sequence. This wait is too long for us to perform
403 * "busy-waiting", and so we must sleep. This in turn means
404 * that we must not be holding any spinlocks when we call
407 static int host_startup_ack(struct soundscape *s, unsigned timeout)
409 unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
415 spin_lock_irqsave(&s->lock, flags);
416 x = host_read_unsafe(s->io_base);
417 spin_unlock_irqrestore(&s->lock, flags);
422 } while (time_before(jiffies, end_time));
428 * Upload a byte-stream into the SoundScape using DMA channel A.
430 static int upload_dma_data(struct soundscape *s,
431 const unsigned char *data,
435 struct snd_dma_buffer dma;
438 if (!get_dmabuf(&dma, PAGE_ALIGN(32 * 1024)))
441 spin_lock_irqsave(&s->lock, flags);
444 * Reset the board ...
446 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f);
449 * Enable the DMA channels and configure them ...
451 sscape_write_unsafe(s->io_base, GA_DMAA_REG, (s->chip->dma1 << 4) | DMA_8BIT);
452 sscape_write_unsafe(s->io_base, GA_DMAB_REG, 0x20);
455 * Take the board out of reset ...
457 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) | 0x80);
460 * Upload the firmware to the SoundScape
461 * board through the DMA channel ...
466 len = min(size, dma.bytes);
467 memcpy(dma.area, data, len);
471 snd_dma_program(s->chip->dma1, dma.addr, len, DMA_MODE_WRITE);
472 sscape_start_dma_unsafe(s->io_base, GA_DMAA_REG);
473 if (!sscape_wait_dma_unsafe(s->io_base, GA_DMAA_REG, 5000)) {
475 * Don't forget to release this spinlock we're holding ...
477 spin_unlock_irqrestore(&s->lock, flags);
480 "sscape: DMA upload has timed out\n");
486 set_host_mode_unsafe(s->io_base);
487 outb(0x0, s->io_base);
490 * Boot the board ... (I think)
492 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) | 0x40);
493 spin_unlock_irqrestore(&s->lock, flags);
496 * If all has gone well, then the board should acknowledge
497 * the new upload and tell us that it has rebooted OK. We
498 * give it 5 seconds (max) ...
501 if (!obp_startup_ack(s, 5000)) {
502 snd_printk(KERN_ERR "sscape: No response "
503 "from on-board processor after upload\n");
505 } else if (!host_startup_ack(s, 5000)) {
507 "sscape: SoundScape failed to initialise\n");
513 * NOTE!!! We are NOT holding any spinlocks at this point !!!
515 sscape_write(s, GA_DMAA_REG, (s->ic_type == IC_OPUS ? 0x40 : 0x70));
522 * Upload the bootblock(?) into the SoundScape. The only
523 * purpose of this block of code seems to be to tell
524 * us which version of the microcode we should be using.
526 static int sscape_upload_bootblock(struct snd_card *card)
528 struct soundscape *sscape = get_card_soundscape(card);
530 const struct firmware *init_fw = NULL;
534 ret = request_firmware(&init_fw, "scope.cod", card->dev);
536 snd_printk(KERN_ERR "sscape: Error loading scope.cod");
539 ret = upload_dma_data(sscape, init_fw->data, init_fw->size);
541 release_firmware(init_fw);
543 spin_lock_irqsave(&sscape->lock, flags);
545 data = host_read_ctrl_unsafe(sscape->io_base, 100);
548 sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2f);
550 spin_unlock_irqrestore(&sscape->lock, flags);
553 if (ret == 0 && data > 7) {
555 "sscape: timeout reading firmware version\n");
559 return (ret == 0) ? data : ret;
563 * Upload the microcode into the SoundScape.
565 static int sscape_upload_microcode(struct snd_card *card, int version)
567 struct soundscape *sscape = get_card_soundscape(card);
568 const struct firmware *init_fw = NULL;
572 snprintf(name, sizeof(name), "sndscape.co%d", version);
574 err = request_firmware(&init_fw, name, card->dev);
576 snd_printk(KERN_ERR "sscape: Error loading sndscape.co%d",
580 err = upload_dma_data(sscape, init_fw->data, init_fw->size);
582 snd_printk(KERN_INFO "sscape: MIDI firmware loaded %d KBs\n",
583 init_fw->size >> 10);
585 release_firmware(init_fw);
591 * Mixer control for the SoundScape's MIDI device.
593 static int sscape_midi_info(struct snd_kcontrol *ctl,
594 struct snd_ctl_elem_info *uinfo)
596 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
598 uinfo->value.integer.min = 0;
599 uinfo->value.integer.max = 127;
603 static int sscape_midi_get(struct snd_kcontrol *kctl,
604 struct snd_ctl_elem_value *uctl)
606 struct snd_wss *chip = snd_kcontrol_chip(kctl);
607 struct snd_card *card = chip->card;
608 register struct soundscape *s = get_card_soundscape(card);
611 spin_lock_irqsave(&s->lock, flags);
612 uctl->value.integer.value[0] = s->midi_vol;
613 spin_unlock_irqrestore(&s->lock, flags);
617 static int sscape_midi_put(struct snd_kcontrol *kctl,
618 struct snd_ctl_elem_value *uctl)
620 struct snd_wss *chip = snd_kcontrol_chip(kctl);
621 struct snd_card *card = chip->card;
622 register struct soundscape *s = get_card_soundscape(card);
626 spin_lock_irqsave(&s->lock, flags);
629 * We need to put the board into HOST mode before we
630 * can send any volume-changing HOST commands ...
632 set_host_mode_unsafe(s->io_base);
635 * To successfully change the MIDI volume setting, you seem to
636 * have to write a volume command, write the new volume value,
637 * and then perform another volume-related command. Perhaps the
638 * first command is an "open" and the second command is a "close"?
640 if (s->midi_vol == ((unsigned char) uctl->value.integer. value[0] & 127)) {
644 change = (host_write_ctrl_unsafe(s->io_base, CMD_SET_MIDI_VOL, 100)
645 && host_write_ctrl_unsafe(s->io_base, ((unsigned char) uctl->value.integer. value[0]) & 127, 100)
646 && host_write_ctrl_unsafe(s->io_base, CMD_XXX_MIDI_VOL, 100));
647 s->midi_vol = (unsigned char) uctl->value.integer.value[0] & 127;
651 * Take the board out of HOST mode and back into MIDI mode ...
653 set_midi_mode_unsafe(s->io_base);
655 spin_unlock_irqrestore(&s->lock, flags);
659 static struct snd_kcontrol_new midi_mixer_ctl = {
660 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
662 .info = sscape_midi_info,
663 .get = sscape_midi_get,
664 .put = sscape_midi_put
668 * The SoundScape can use two IRQs from a possible set of four.
669 * These IRQs are encoded as bit patterns so that they can be
670 * written to the control registers.
672 static unsigned __devinit get_irq_config(int sscape_type, int irq)
674 static const int valid_irq[] = { 9, 5, 7, 10 };
675 static const int old_irq[] = { 9, 7, 5, 15 };
678 if (sscape_type == MEDIA_FX) {
679 for (cfg = 0; cfg < ARRAY_SIZE(old_irq); ++cfg)
680 if (irq == old_irq[cfg])
683 for (cfg = 0; cfg < ARRAY_SIZE(valid_irq); ++cfg)
684 if (irq == valid_irq[cfg])
692 * Perform certain arcane port-checks to see whether there
693 * is a SoundScape board lurking behind the given ports.
695 static int __devinit detect_sscape(struct soundscape *s, long wss_io)
701 spin_lock_irqsave(&s->lock, flags);
704 * The following code is lifted from the original OSS driver,
705 * and as I don't have a datasheet I cannot really comment
706 * on what it is doing...
708 if ((inb(HOST_CTRL_IO(s->io_base)) & 0x78) != 0)
711 d = inb(ODIE_ADDR_IO(s->io_base)) & 0xf0;
716 s->ic_type = IC_ODIE;
717 else if ((d & 0x60) != 0)
718 s->ic_type = IC_OPUS;
722 outb(0xfa, ODIE_ADDR_IO(s->io_base));
723 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0a)
726 outb(0xfe, ODIE_ADDR_IO(s->io_base));
727 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0e)
730 outb(0xfe, ODIE_ADDR_IO(s->io_base));
731 d = inb(ODIE_DATA_IO(s->io_base));
732 if (s->type != SSCAPE_VIVO && (d & 0x9f) != 0x0e)
735 if (s->ic_type == IC_OPUS)
736 activate_ad1845_unsafe(s->io_base);
738 if (s->type == SSCAPE_VIVO)
741 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f;
742 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
744 /* wait for WSS codec */
745 for (d = 0; d < 500; d++) {
746 if ((inb(wss_io) & 0x80) == 0)
748 spin_unlock_irqrestore(&s->lock, flags);
750 spin_lock_irqsave(&s->lock, flags);
753 if ((inb(wss_io) & 0x80) != 0)
756 if (inb(wss_io + 2) == 0xff)
759 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f;
760 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d);
762 if ((inb(wss_io) & 0x80) != 0)
765 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f;
766 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
767 /* wait for WSS codec */
768 for (d = 0; d < 500; d++) {
769 if ((inb(wss_io) & 0x80) == 0)
771 spin_unlock_irqrestore(&s->lock, flags);
773 spin_lock_irqsave(&s->lock, flags);
777 * SoundScape successfully detected!
782 spin_unlock_irqrestore(&s->lock, flags);
787 * ALSA callback function, called when attempting to open the MIDI device.
788 * Check that the MIDI firmware has been loaded, because we don't want
789 * to crash the machine. Also check that someone isn't using the hardware
792 static int mpu401_open(struct snd_mpu401 * mpu)
794 if (!verify_mpu401(mpu)) {
795 snd_printk(KERN_ERR "sscape: MIDI disabled, "
796 "please load firmware\n");
804 * Initialse an MPU-401 subdevice for MIDI support on the SoundScape.
806 static int __devinit create_mpu401(struct snd_card *card, int devnum, unsigned long port, int irq)
808 struct soundscape *sscape = get_card_soundscape(card);
809 struct snd_rawmidi *rawmidi;
812 if ((err = snd_mpu401_uart_new(card, devnum,
814 port, MPU401_INFO_INTEGRATED,
817 struct snd_mpu401 *mpu = (struct snd_mpu401 *) rawmidi->private_data;
818 mpu->open_input = mpu401_open;
819 mpu->open_output = mpu401_open;
820 mpu->private_data = sscape;
822 initialise_mpu401(mpu);
830 * Create an AD1845 PCM subdevice on the SoundScape. The AD1845
831 * is very much like a CS4231, with a few extra bits. We will
832 * try to support at least some of the extra bits by overriding
833 * some of the CS4231 callback.
835 static int __devinit create_ad1845(struct snd_card *card, unsigned port,
836 int irq, int dma1, int dma2)
838 register struct soundscape *sscape = get_card_soundscape(card);
839 struct snd_wss *chip;
841 int codec_type = WSS_HW_DETECT;
843 switch (sscape->type) {
847 * There are some freak examples of early Soundscape cards
848 * with CS4231 instead of AD1848/CS4248. Unfortunately, the
849 * CS4231 works only in CS4248 compatibility mode on
850 * these cards so force it.
852 if (sscape->ic_type != IC_OPUS)
853 codec_type = WSS_HW_AD1848;
863 err = snd_wss_create(card, port, -1, irq, dma1, dma2,
864 codec_type, WSS_HWSHARE_DMA1, &chip);
870 * It turns out that the PLAYBACK_ENABLE bit is set
871 * by the lowlevel driver ...
873 #define AD1845_IFACE_CONFIG \
874 (CS4231_AUTOCALIB | CS4231_RECORD_ENABLE | CS4231_PLAYBACK_ENABLE)
875 snd_wss_mce_up(chip);
876 spin_lock_irqsave(&chip->reg_lock, flags);
877 snd_wss_out(chip, CS4231_IFACE_CTRL, AD1845_IFACE_CONFIG);
878 spin_unlock_irqrestore(&chip->reg_lock, flags);
879 snd_wss_mce_down(chip);
882 if (sscape->type != SSCAPE_VIVO) {
884 * The input clock frequency on the SoundScape must
885 * be 14.31818 MHz, because we must set this register
886 * to get the playback to sound correct ...
888 snd_wss_mce_up(chip);
889 spin_lock_irqsave(&chip->reg_lock, flags);
890 snd_wss_out(chip, AD1845_CLOCK, 0x20);
891 spin_unlock_irqrestore(&chip->reg_lock, flags);
892 snd_wss_mce_down(chip);
896 err = snd_wss_pcm(chip, 0, &pcm);
898 snd_printk(KERN_ERR "sscape: No PCM device "
899 "for AD1845 chip\n");
903 err = snd_wss_mixer(chip);
905 snd_printk(KERN_ERR "sscape: No mixer device "
906 "for AD1845 chip\n");
909 if (chip->hardware != WSS_HW_AD1848) {
910 err = snd_wss_timer(chip, 0, NULL);
912 snd_printk(KERN_ERR "sscape: No timer device "
913 "for AD1845 chip\n");
918 if (sscape->type != SSCAPE_VIVO) {
919 err = snd_ctl_add(card,
920 snd_ctl_new1(&midi_mixer_ctl, chip));
922 snd_printk(KERN_ERR "sscape: Could not create "
923 "MIDI mixer control\n");
937 * Create an ALSA soundcard entry for the SoundScape, using
938 * the given list of port, IRQ and DMA resources.
940 static int __devinit create_sscape(int dev, struct snd_card *card)
942 struct soundscape *sscape = get_card_soundscape(card);
945 unsigned mpu_irq_cfg;
946 struct resource *io_res;
947 struct resource *wss_res;
954 * Grab IO ports that we will need to probe so that we
955 * can detect and control this hardware ...
957 io_res = request_region(port[dev], 8, "SoundScape");
960 "sscape: can't grab port 0x%lx\n", port[dev]);
964 if (sscape->type == SSCAPE_VIVO) {
965 wss_res = request_region(wss_port[dev], 4, "SoundScape");
967 snd_printk(KERN_ERR "sscape: can't grab port 0x%lx\n",
970 goto _release_region;
975 * Grab one DMA channel ...
977 err = request_dma(dma[dev], "SoundScape");
979 snd_printk(KERN_ERR "sscape: can't grab DMA %d\n", dma[dev]);
980 goto _release_region;
983 spin_lock_init(&sscape->lock);
984 sscape->io_res = io_res;
985 sscape->wss_res = wss_res;
986 sscape->io_base = port[dev];
988 if (!detect_sscape(sscape, wss_port[dev])) {
989 printk(KERN_ERR "sscape: hardware not detected at 0x%x\n",
995 switch (sscape->type) {
997 name = "MediaFX/SoundFX";
1000 name = "Soundscape";
1003 name = "Soundscape PnP";
1006 name = "Soundscape VIVO";
1009 name = "unknown Soundscape";
1013 printk(KERN_INFO "sscape: %s card detected at 0x%x, using IRQ %d, DMA %d\n",
1014 name, sscape->io_base, irq[dev], dma[dev]);
1017 * Check that the user didn't pass us garbage data ...
1019 irq_cfg = get_irq_config(sscape->type, irq[dev]);
1020 if (irq_cfg == INVALID_IRQ) {
1021 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", irq[dev]);
1025 mpu_irq_cfg = get_irq_config(sscape->type, mpu_irq[dev]);
1026 if (mpu_irq_cfg == INVALID_IRQ) {
1027 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", mpu_irq[dev]);
1032 * Tell the on-board devices where their resources are (I think -
1033 * I can't be sure without a datasheet ... So many magic values!)
1035 spin_lock_irqsave(&sscape->lock, flags);
1037 sscape_write_unsafe(sscape->io_base, GA_INTENA_REG, 0x00); /* disable */
1038 sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2e);
1039 sscape_write_unsafe(sscape->io_base, GA_SMCFGB_REG, 0x00);
1042 * Enable and configure the DMA channels ...
1044 sscape_write_unsafe(sscape->io_base, GA_DMACFG_REG, 0x50);
1045 dma_cfg = (sscape->ic_type == IC_OPUS ? 0x40 : 0x70);
1046 sscape_write_unsafe(sscape->io_base, GA_DMAA_REG, dma_cfg);
1047 sscape_write_unsafe(sscape->io_base, GA_DMAB_REG, 0x20);
1049 mpu_irq_cfg |= mpu_irq_cfg << 2;
1050 val = sscape_read_unsafe(sscape->io_base, GA_HMCTL_REG) & 0xF7;
1053 sscape_write_unsafe(sscape->io_base, GA_HMCTL_REG, val | 0x10);
1054 sscape_write_unsafe(sscape->io_base, GA_INTCFG_REG, 0xf0 | mpu_irq_cfg);
1055 sscape_write_unsafe(sscape->io_base,
1056 GA_CDCFG_REG, 0x09 | DMA_8BIT
1057 | (dma[dev] << 4) | (irq_cfg << 1));
1059 spin_unlock_irqrestore(&sscape->lock, flags);
1062 * We have now enabled the codec chip, and so we should
1063 * detect the AD1845 device ...
1065 err = create_ad1845(card, wss_port[dev], irq[dev],
1066 dma[dev], dma2[dev]);
1069 "sscape: No AD1845 device at 0x%lx, IRQ %d\n",
1070 wss_port[dev], irq[dev]);
1073 strcpy(card->driver, "SoundScape");
1074 strcpy(card->shortname, name);
1075 snprintf(card->longname, sizeof(card->longname),
1076 "%s at 0x%lx, IRQ %d, DMA1 %d, DMA2 %d\n",
1077 name, sscape->chip->port, sscape->chip->irq,
1078 sscape->chip->dma1, sscape->chip->dma2);
1080 #define MIDI_DEVNUM 0
1081 if (sscape->type != SSCAPE_VIVO) {
1082 err = sscape_upload_bootblock(card);
1084 err = sscape_upload_microcode(card, err);
1087 err = create_mpu401(card, MIDI_DEVNUM, port[dev],
1090 snd_printk(KERN_ERR "sscape: Failed to create "
1091 "MPU-401 device at 0x%lx\n",
1097 * Enable the master IRQ ...
1099 sscape_write(sscape, GA_INTENA_REG, 0x80);
1104 spin_lock_irqsave(&sscape->lock, flags);
1105 sscape->midi_vol = 0;
1106 host_write_ctrl_unsafe(sscape->io_base,
1107 CMD_SET_MIDI_VOL, 100);
1108 host_write_ctrl_unsafe(sscape->io_base,
1109 sscape->midi_vol, 100);
1110 host_write_ctrl_unsafe(sscape->io_base,
1111 CMD_XXX_MIDI_VOL, 100);
1112 host_write_ctrl_unsafe(sscape->io_base,
1113 sscape->midi_vol, 100);
1114 host_write_ctrl_unsafe(sscape->io_base,
1115 CMD_SET_EXTMIDI, 100);
1116 host_write_ctrl_unsafe(sscape->io_base,
1118 host_write_ctrl_unsafe(sscape->io_base, CMD_ACK, 100);
1120 set_midi_mode_unsafe(sscape->io_base);
1121 spin_unlock_irqrestore(&sscape->lock, flags);
1126 * Now that we have successfully created this sound card,
1127 * it is safe to store the pointer.
1128 * NOTE: we only register the sound card's "destructor"
1129 * function now that our "constructor" has completed.
1131 card->private_free = soundscape_free;
1139 release_and_free_resource(wss_res);
1140 release_and_free_resource(io_res);
1146 static int __devinit snd_sscape_match(struct device *pdev, unsigned int i)
1149 * Make sure we were given ALL of the other parameters.
1151 if (port[i] == SNDRV_AUTO_PORT)
1154 if (irq[i] == SNDRV_AUTO_IRQ ||
1155 mpu_irq[i] == SNDRV_AUTO_IRQ ||
1156 dma[i] == SNDRV_AUTO_DMA) {
1158 "sscape: insufficient parameters, need IO, IRQ, MPU-IRQ and DMA\n");
1165 static int __devinit snd_sscape_probe(struct device *pdev, unsigned int dev)
1167 struct snd_card *card;
1168 struct soundscape *sscape;
1171 ret = snd_card_create(index[dev], id[dev], THIS_MODULE,
1172 sizeof(struct soundscape), &card);
1176 sscape = get_card_soundscape(card);
1177 sscape->type = SSCAPE;
1180 snd_card_set_dev(card, pdev);
1182 ret = create_sscape(dev, card);
1186 if ((ret = snd_card_register(card)) < 0) {
1187 snd_printk(KERN_ERR "sscape: Failed to register sound card\n");
1190 dev_set_drvdata(pdev, card);
1194 snd_card_free(card);
1198 static int __devexit snd_sscape_remove(struct device *devptr, unsigned int dev)
1200 snd_card_free(dev_get_drvdata(devptr));
1201 dev_set_drvdata(devptr, NULL);
1205 #define DEV_NAME "sscape"
1207 static struct isa_driver snd_sscape_driver = {
1208 .match = snd_sscape_match,
1209 .probe = snd_sscape_probe,
1210 .remove = __devexit_p(snd_sscape_remove),
1211 /* FIXME: suspend/resume */
1218 static inline int __devinit get_next_autoindex(int i)
1220 while (i < SNDRV_CARDS && port[i] != SNDRV_AUTO_PORT)
1226 static int __devinit sscape_pnp_detect(struct pnp_card_link *pcard,
1227 const struct pnp_card_device_id *pid)
1230 struct pnp_dev *dev;
1231 struct snd_card *card;
1232 struct soundscape *sscape;
1236 * Allow this function to fail *quietly* if all the ISA PnP
1237 * devices were configured using module parameters instead.
1239 if ((idx = get_next_autoindex(idx)) >= SNDRV_CARDS)
1243 * We have found a candidate ISA PnP card. Now we
1244 * have to check that it has the devices that we
1245 * expect it to have.
1249 * Check that we still have room for another sound card ...
1251 dev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
1255 if (!pnp_is_active(dev)) {
1256 if (pnp_activate_dev(dev) < 0) {
1257 snd_printk(KERN_INFO "sscape: device is inactive\n");
1263 * Create a new ALSA sound card entry, in anticipation
1264 * of detecting our hardware ...
1266 ret = snd_card_create(index[idx], id[idx], THIS_MODULE,
1267 sizeof(struct soundscape), &card);
1271 sscape = get_card_soundscape(card);
1274 * Identify card model ...
1276 if (!strncmp("ENS4081", pid->id, 7))
1277 sscape->type = SSCAPE_VIVO;
1279 sscape->type = SSCAPE_PNP;
1282 * Read the correct parameters off the ISA PnP bus ...
1284 port[idx] = pnp_port_start(dev, 0);
1285 irq[idx] = pnp_irq(dev, 0);
1286 mpu_irq[idx] = pnp_irq(dev, 1);
1287 dma[idx] = pnp_dma(dev, 0) & 0x03;
1288 if (sscape->type == SSCAPE_PNP) {
1289 dma2[idx] = dma[idx];
1290 wss_port[idx] = CODEC_IO(port[idx]);
1292 wss_port[idx] = pnp_port_start(dev, 1);
1293 dma2[idx] = pnp_dma(dev, 1);
1295 snd_card_set_dev(card, &pcard->card->dev);
1297 ret = create_sscape(idx, card);
1301 if ((ret = snd_card_register(card)) < 0) {
1302 snd_printk(KERN_ERR "sscape: Failed to register sound card\n");
1306 pnp_set_card_drvdata(pcard, card);
1311 snd_card_free(card);
1315 static void __devexit sscape_pnp_remove(struct pnp_card_link * pcard)
1317 snd_card_free(pnp_get_card_drvdata(pcard));
1318 pnp_set_card_drvdata(pcard, NULL);
1321 static struct pnp_card_driver sscape_pnpc_driver = {
1322 .flags = PNP_DRIVER_RES_DO_NOT_CHANGE,
1324 .id_table = sscape_pnpids,
1325 .probe = sscape_pnp_detect,
1326 .remove = __devexit_p(sscape_pnp_remove),
1329 #endif /* CONFIG_PNP */
1331 static int __init sscape_init(void)
1335 err = isa_register_driver(&snd_sscape_driver, SNDRV_CARDS);
1340 err = pnp_register_card_driver(&sscape_pnpc_driver);
1350 static void __exit sscape_exit(void)
1354 pnp_unregister_card_driver(&sscape_pnpc_driver);
1357 isa_unregister_driver(&snd_sscape_driver);
1360 module_init(sscape_init);
1361 module_exit(sscape_exit);