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>
27 #include <linux/isa.h>
28 #include <linux/delay.h>
29 #include <linux/firmware.h>
30 #include <linux/pnp.h>
31 #include <linux/spinlock.h>
32 #include <linux/module.h>
34 #include <sound/core.h>
35 #include <sound/wss.h>
36 #include <sound/mpu401.h>
37 #include <sound/initval.h>
40 MODULE_AUTHOR("Chris Rankin");
41 MODULE_DESCRIPTION("ENSONIQ SoundScape driver");
42 MODULE_LICENSE("GPL");
43 MODULE_FIRMWARE("sndscape.co0");
44 MODULE_FIRMWARE("sndscape.co1");
45 MODULE_FIRMWARE("sndscape.co2");
46 MODULE_FIRMWARE("sndscape.co3");
47 MODULE_FIRMWARE("sndscape.co4");
48 MODULE_FIRMWARE("scope.cod");
50 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
51 static char* id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
52 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
53 static long wss_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
54 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;
55 static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;
56 static int dma[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;
57 static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;
58 static bool joystick[SNDRV_CARDS];
60 module_param_array(index, int, NULL, 0444);
61 MODULE_PARM_DESC(index, "Index number for SoundScape soundcard");
63 module_param_array(id, charp, NULL, 0444);
64 MODULE_PARM_DESC(id, "Description for SoundScape card");
66 module_param_hw_array(port, long, ioport, NULL, 0444);
67 MODULE_PARM_DESC(port, "Port # for SoundScape driver.");
69 module_param_hw_array(wss_port, long, ioport, NULL, 0444);
70 MODULE_PARM_DESC(wss_port, "WSS Port # for SoundScape driver.");
72 module_param_hw_array(irq, int, irq, NULL, 0444);
73 MODULE_PARM_DESC(irq, "IRQ # for SoundScape driver.");
75 module_param_hw_array(mpu_irq, int, irq, NULL, 0444);
76 MODULE_PARM_DESC(mpu_irq, "MPU401 IRQ # for SoundScape driver.");
78 module_param_hw_array(dma, int, dma, NULL, 0444);
79 MODULE_PARM_DESC(dma, "DMA # for SoundScape driver.");
81 module_param_hw_array(dma2, int, dma, NULL, 0444);
82 MODULE_PARM_DESC(dma2, "DMA2 # for SoundScape driver.");
84 module_param_array(joystick, bool, NULL, 0444);
85 MODULE_PARM_DESC(joystick, "Enable gameport.");
88 static int isa_registered;
89 static int pnp_registered;
91 static const struct pnp_card_device_id sscape_pnpids[] = {
92 { .id = "ENS3081", .devs = { { "ENS0000" } } }, /* Soundscape PnP */
93 { .id = "ENS4081", .devs = { { "ENS1011" } } }, /* VIVO90 */
94 { .id = "" } /* end */
97 MODULE_DEVICE_TABLE(pnp_card, sscape_pnpids);
101 #define HOST_CTRL_IO(i) ((i) + 2)
102 #define HOST_DATA_IO(i) ((i) + 3)
103 #define ODIE_ADDR_IO(i) ((i) + 4)
104 #define ODIE_DATA_IO(i) ((i) + 5)
105 #define CODEC_IO(i) ((i) + 8)
110 #define RX_READY 0x01
111 #define TX_READY 0x02
114 #define CMD_SET_MIDI_VOL 0x84
115 #define CMD_GET_MIDI_VOL 0x85
116 #define CMD_XXX_MIDI_VOL 0x86
117 #define CMD_SET_EXTMIDI 0x8a
118 #define CMD_GET_EXTMIDI 0x8b
119 #define CMD_SET_MT32 0x8c
120 #define CMD_GET_MT32 0x8d
135 #define DMA_8BIT 0x80
139 MEDIA_FX, /* Sequoia S-1000 */
140 SSCAPE, /* Sequoia S-2000 */
150 struct resource *io_res;
151 struct resource *wss_res;
152 struct snd_wss *chip;
154 unsigned char midi_vol;
157 #define INVALID_IRQ ((unsigned)-1)
160 static inline struct soundscape *get_card_soundscape(struct snd_card *c)
162 return (struct soundscape *) (c->private_data);
166 * Allocates some kernel memory that we can use for DMA.
167 * I think this means that the memory has to map to
168 * contiguous pages of physical memory.
170 static struct snd_dma_buffer *get_dmabuf(struct soundscape *s,
171 struct snd_dma_buffer *buf,
175 if (snd_dma_alloc_pages_fallback(SNDRV_DMA_TYPE_DEV,
178 snd_printk(KERN_ERR "sscape: Failed to allocate "
179 "%lu bytes for DMA\n",
189 * Release the DMA-able kernel memory ...
191 static void free_dmabuf(struct snd_dma_buffer *buf)
193 if (buf && buf->area)
194 snd_dma_free_pages(buf);
198 * This function writes to the SoundScape's control registers,
199 * but doesn't do any locking. It's up to the caller to do that.
200 * This is why this function is "unsafe" ...
202 static inline void sscape_write_unsafe(unsigned io_base, enum GA_REG reg,
205 outb(reg, ODIE_ADDR_IO(io_base));
206 outb(val, ODIE_DATA_IO(io_base));
210 * Write to the SoundScape's control registers, and do the
211 * necessary locking ...
213 static void sscape_write(struct soundscape *s, enum GA_REG reg,
218 spin_lock_irqsave(&s->lock, flags);
219 sscape_write_unsafe(s->io_base, reg, val);
220 spin_unlock_irqrestore(&s->lock, flags);
224 * Read from the SoundScape's control registers, but leave any
225 * locking to the caller. This is why the function is "unsafe" ...
227 static inline unsigned char sscape_read_unsafe(unsigned io_base,
230 outb(reg, ODIE_ADDR_IO(io_base));
231 return inb(ODIE_DATA_IO(io_base));
235 * Puts the SoundScape into "host" mode, as compared to "MIDI" mode
237 static inline void set_host_mode_unsafe(unsigned io_base)
239 outb(0x0, HOST_CTRL_IO(io_base));
243 * Puts the SoundScape into "MIDI" mode, as compared to "host" mode
245 static inline void set_midi_mode_unsafe(unsigned io_base)
247 outb(0x3, HOST_CTRL_IO(io_base));
251 * Read the SoundScape's host-mode control register, but leave
252 * any locking issues to the caller ...
254 static inline int host_read_unsafe(unsigned io_base)
257 if ((inb(HOST_CTRL_IO(io_base)) & RX_READY) != 0)
258 data = inb(HOST_DATA_IO(io_base));
264 * Read the SoundScape's host-mode control register, performing
265 * a limited amount of busy-waiting if the register isn't ready.
266 * Also leaves all locking-issues to the caller ...
268 static int host_read_ctrl_unsafe(unsigned io_base, unsigned timeout)
272 while (((data = host_read_unsafe(io_base)) < 0) && (timeout != 0)) {
281 * Write to the SoundScape's host-mode control registers, but
282 * leave any locking issues to the caller ...
284 static inline int host_write_unsafe(unsigned io_base, unsigned char data)
286 if ((inb(HOST_CTRL_IO(io_base)) & TX_READY) != 0) {
287 outb(data, HOST_DATA_IO(io_base));
295 * Write to the SoundScape's host-mode control registers, performing
296 * a limited amount of busy-waiting if the register isn't ready.
297 * Also leaves all locking-issues to the caller ...
299 static int host_write_ctrl_unsafe(unsigned io_base, unsigned char data,
304 while (!(err = host_write_unsafe(io_base, data)) && (timeout != 0)) {
314 * Check that the MIDI subsystem is operational. If it isn't,
315 * then we will hang the computer if we try to use it ...
317 * NOTE: This check is based upon observation, not documentation.
319 static inline int verify_mpu401(const struct snd_mpu401 *mpu)
321 return ((inb(MPU401C(mpu)) & 0xc0) == 0x80);
325 * This is apparently the standard way to initailise an MPU-401
327 static inline void initialise_mpu401(const struct snd_mpu401 *mpu)
329 outb(0, MPU401D(mpu));
333 * Tell the SoundScape to activate the AD1845 chip (I think).
334 * The AD1845 detection fails if we *don't* do this, so I
335 * think that this is a good idea ...
337 static void activate_ad1845_unsafe(unsigned io_base)
339 unsigned char val = sscape_read_unsafe(io_base, GA_HMCTL_REG);
340 sscape_write_unsafe(io_base, GA_HMCTL_REG, (val & 0xcf) | 0x10);
341 sscape_write_unsafe(io_base, GA_CDCFG_REG, 0x80);
345 * Do the necessary ALSA-level cleanup to deallocate our driver ...
347 static void soundscape_free(struct snd_card *c)
349 struct soundscape *sscape = get_card_soundscape(c);
350 release_and_free_resource(sscape->io_res);
351 release_and_free_resource(sscape->wss_res);
352 free_dma(sscape->chip->dma1);
356 * Tell the SoundScape to begin a DMA tranfer using the given channel.
357 * All locking issues are left to the caller.
359 static void sscape_start_dma_unsafe(unsigned io_base, enum GA_REG reg)
361 sscape_write_unsafe(io_base, reg,
362 sscape_read_unsafe(io_base, reg) | 0x01);
363 sscape_write_unsafe(io_base, reg,
364 sscape_read_unsafe(io_base, reg) & 0xfe);
368 * Wait for a DMA transfer to complete. This is a "limited busy-wait",
369 * and all locking issues are left to the caller.
371 static int sscape_wait_dma_unsafe(unsigned io_base, enum GA_REG reg,
374 while (!(sscape_read_unsafe(io_base, reg) & 0x01) && (timeout != 0)) {
379 return sscape_read_unsafe(io_base, reg) & 0x01;
383 * Wait for the On-Board Processor to return its start-up
384 * acknowledgement sequence. This wait is too long for
385 * us to perform "busy-waiting", and so we must sleep.
386 * This in turn means that we must not be holding any
387 * spinlocks when we call this function.
389 static int obp_startup_ack(struct soundscape *s, unsigned timeout)
391 unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
397 spin_lock_irqsave(&s->lock, flags);
398 x = host_read_unsafe(s->io_base);
399 spin_unlock_irqrestore(&s->lock, flags);
400 if (x == 0xfe || x == 0xff)
404 } while (time_before(jiffies, end_time));
410 * Wait for the host to return its start-up acknowledgement
411 * sequence. This wait is too long for us to perform
412 * "busy-waiting", and so we must sleep. This in turn means
413 * that we must not be holding any spinlocks when we call
416 static int host_startup_ack(struct soundscape *s, unsigned timeout)
418 unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
424 spin_lock_irqsave(&s->lock, flags);
425 x = host_read_unsafe(s->io_base);
426 spin_unlock_irqrestore(&s->lock, flags);
431 } while (time_before(jiffies, end_time));
437 * Upload a byte-stream into the SoundScape using DMA channel A.
439 static int upload_dma_data(struct soundscape *s, const unsigned char *data,
443 struct snd_dma_buffer dma;
447 if (!get_dmabuf(s, &dma, PAGE_ALIGN(32 * 1024)))
450 spin_lock_irqsave(&s->lock, flags);
453 * Reset the board ...
455 val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
456 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val & 0x3f);
459 * Enable the DMA channels and configure them ...
461 val = (s->chip->dma1 << 4) | DMA_8BIT;
462 sscape_write_unsafe(s->io_base, GA_DMAA_REG, val);
463 sscape_write_unsafe(s->io_base, GA_DMAB_REG, 0x20);
466 * Take the board out of reset ...
468 val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
469 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val | 0x80);
472 * Upload the firmware to the SoundScape
473 * board through the DMA channel ...
478 len = min(size, dma.bytes);
479 memcpy(dma.area, data, len);
483 snd_dma_program(s->chip->dma1, dma.addr, len, DMA_MODE_WRITE);
484 sscape_start_dma_unsafe(s->io_base, GA_DMAA_REG);
485 if (!sscape_wait_dma_unsafe(s->io_base, GA_DMAA_REG, 5000)) {
487 * Don't forget to release this spinlock we're holding
489 spin_unlock_irqrestore(&s->lock, flags);
492 "sscape: DMA upload has timed out\n");
498 set_host_mode_unsafe(s->io_base);
499 outb(0x0, s->io_base);
502 * Boot the board ... (I think)
504 val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
505 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val | 0x40);
506 spin_unlock_irqrestore(&s->lock, flags);
509 * If all has gone well, then the board should acknowledge
510 * the new upload and tell us that it has rebooted OK. We
511 * give it 5 seconds (max) ...
514 if (!obp_startup_ack(s, 5000)) {
515 snd_printk(KERN_ERR "sscape: No response "
516 "from on-board processor after upload\n");
518 } else if (!host_startup_ack(s, 5000)) {
520 "sscape: SoundScape failed to initialise\n");
526 * NOTE!!! We are NOT holding any spinlocks at this point !!!
528 sscape_write(s, GA_DMAA_REG, (s->ic_type == IC_OPUS ? 0x40 : 0x70));
535 * Upload the bootblock(?) into the SoundScape. The only
536 * purpose of this block of code seems to be to tell
537 * us which version of the microcode we should be using.
539 static int sscape_upload_bootblock(struct snd_card *card)
541 struct soundscape *sscape = get_card_soundscape(card);
543 const struct firmware *init_fw = NULL;
547 ret = request_firmware(&init_fw, "scope.cod", card->dev);
549 snd_printk(KERN_ERR "sscape: Error loading scope.cod");
552 ret = upload_dma_data(sscape, init_fw->data, init_fw->size);
554 release_firmware(init_fw);
556 spin_lock_irqsave(&sscape->lock, flags);
558 data = host_read_ctrl_unsafe(sscape->io_base, 100);
561 sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2f);
563 spin_unlock_irqrestore(&sscape->lock, flags);
566 if (ret == 0 && data > 7) {
568 "sscape: timeout reading firmware version\n");
572 return (ret == 0) ? data : ret;
576 * Upload the microcode into the SoundScape.
578 static int sscape_upload_microcode(struct snd_card *card, int version)
580 struct soundscape *sscape = get_card_soundscape(card);
581 const struct firmware *init_fw = NULL;
585 snprintf(name, sizeof(name), "sndscape.co%d", version);
587 err = request_firmware(&init_fw, name, card->dev);
589 snd_printk(KERN_ERR "sscape: Error loading sndscape.co%d",
593 err = upload_dma_data(sscape, init_fw->data, init_fw->size);
595 snd_printk(KERN_INFO "sscape: MIDI firmware loaded %zu KBs\n",
596 init_fw->size >> 10);
598 release_firmware(init_fw);
604 * Mixer control for the SoundScape's MIDI device.
606 static int sscape_midi_info(struct snd_kcontrol *ctl,
607 struct snd_ctl_elem_info *uinfo)
609 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
611 uinfo->value.integer.min = 0;
612 uinfo->value.integer.max = 127;
616 static int sscape_midi_get(struct snd_kcontrol *kctl,
617 struct snd_ctl_elem_value *uctl)
619 struct snd_wss *chip = snd_kcontrol_chip(kctl);
620 struct snd_card *card = chip->card;
621 register struct soundscape *s = get_card_soundscape(card);
624 spin_lock_irqsave(&s->lock, flags);
625 uctl->value.integer.value[0] = s->midi_vol;
626 spin_unlock_irqrestore(&s->lock, flags);
630 static int sscape_midi_put(struct snd_kcontrol *kctl,
631 struct snd_ctl_elem_value *uctl)
633 struct snd_wss *chip = snd_kcontrol_chip(kctl);
634 struct snd_card *card = chip->card;
635 struct soundscape *s = get_card_soundscape(card);
638 unsigned char new_val;
640 spin_lock_irqsave(&s->lock, flags);
642 new_val = uctl->value.integer.value[0] & 127;
644 * We need to put the board into HOST mode before we
645 * can send any volume-changing HOST commands ...
647 set_host_mode_unsafe(s->io_base);
650 * To successfully change the MIDI volume setting, you seem to
651 * have to write a volume command, write the new volume value,
652 * and then perform another volume-related command. Perhaps the
653 * first command is an "open" and the second command is a "close"?
655 if (s->midi_vol == new_val) {
659 change = host_write_ctrl_unsafe(s->io_base, CMD_SET_MIDI_VOL, 100)
660 && host_write_ctrl_unsafe(s->io_base, new_val, 100)
661 && host_write_ctrl_unsafe(s->io_base, CMD_XXX_MIDI_VOL, 100)
662 && host_write_ctrl_unsafe(s->io_base, new_val, 100);
663 s->midi_vol = new_val;
667 * Take the board out of HOST mode and back into MIDI mode ...
669 set_midi_mode_unsafe(s->io_base);
671 spin_unlock_irqrestore(&s->lock, flags);
675 static const struct snd_kcontrol_new midi_mixer_ctl = {
676 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
678 .info = sscape_midi_info,
679 .get = sscape_midi_get,
680 .put = sscape_midi_put
684 * The SoundScape can use two IRQs from a possible set of four.
685 * These IRQs are encoded as bit patterns so that they can be
686 * written to the control registers.
688 static unsigned get_irq_config(int sscape_type, int irq)
690 static const int valid_irq[] = { 9, 5, 7, 10 };
691 static const int old_irq[] = { 9, 7, 5, 15 };
694 if (sscape_type == MEDIA_FX) {
695 for (cfg = 0; cfg < ARRAY_SIZE(old_irq); ++cfg)
696 if (irq == old_irq[cfg])
699 for (cfg = 0; cfg < ARRAY_SIZE(valid_irq); ++cfg)
700 if (irq == valid_irq[cfg])
708 * Perform certain arcane port-checks to see whether there
709 * is a SoundScape board lurking behind the given ports.
711 static int detect_sscape(struct soundscape *s, long wss_io)
717 spin_lock_irqsave(&s->lock, flags);
720 * The following code is lifted from the original OSS driver,
721 * and as I don't have a datasheet I cannot really comment
722 * on what it is doing...
724 if ((inb(HOST_CTRL_IO(s->io_base)) & 0x78) != 0)
727 d = inb(ODIE_ADDR_IO(s->io_base)) & 0xf0;
732 s->ic_type = IC_ODIE;
733 else if ((d & 0x60) != 0)
734 s->ic_type = IC_OPUS;
738 outb(0xfa, ODIE_ADDR_IO(s->io_base));
739 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0a)
742 outb(0xfe, ODIE_ADDR_IO(s->io_base));
743 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0e)
746 outb(0xfe, ODIE_ADDR_IO(s->io_base));
747 d = inb(ODIE_DATA_IO(s->io_base));
748 if (s->type != SSCAPE_VIVO && (d & 0x9f) != 0x0e)
751 if (s->ic_type == IC_OPUS)
752 activate_ad1845_unsafe(s->io_base);
754 if (s->type == SSCAPE_VIVO)
757 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
758 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
760 /* wait for WSS codec */
761 for (d = 0; d < 500; d++) {
762 if ((inb(wss_io) & 0x80) == 0)
764 spin_unlock_irqrestore(&s->lock, flags);
766 spin_lock_irqsave(&s->lock, flags);
769 if ((inb(wss_io) & 0x80) != 0)
772 if (inb(wss_io + 2) == 0xff)
775 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f;
776 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d);
778 if ((inb(wss_io) & 0x80) != 0)
781 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
782 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
783 /* wait for WSS codec */
784 for (d = 0; d < 500; d++) {
785 if ((inb(wss_io) & 0x80) == 0)
787 spin_unlock_irqrestore(&s->lock, flags);
789 spin_lock_irqsave(&s->lock, flags);
793 * SoundScape successfully detected!
798 spin_unlock_irqrestore(&s->lock, flags);
803 * ALSA callback function, called when attempting to open the MIDI device.
804 * Check that the MIDI firmware has been loaded, because we don't want
805 * to crash the machine. Also check that someone isn't using the hardware
808 static int mpu401_open(struct snd_mpu401 *mpu)
810 if (!verify_mpu401(mpu)) {
811 snd_printk(KERN_ERR "sscape: MIDI disabled, "
812 "please load firmware\n");
820 * Initialse an MPU-401 subdevice for MIDI support on the SoundScape.
822 static int create_mpu401(struct snd_card *card, int devnum,
823 unsigned long port, int irq)
825 struct soundscape *sscape = get_card_soundscape(card);
826 struct snd_rawmidi *rawmidi;
829 err = snd_mpu401_uart_new(card, devnum, MPU401_HW_MPU401, port,
830 MPU401_INFO_INTEGRATED, irq, &rawmidi);
832 struct snd_mpu401 *mpu = rawmidi->private_data;
833 mpu->open_input = mpu401_open;
834 mpu->open_output = mpu401_open;
835 mpu->private_data = sscape;
837 initialise_mpu401(mpu);
845 * Create an AD1845 PCM subdevice on the SoundScape. The AD1845
846 * is very much like a CS4231, with a few extra bits. We will
847 * try to support at least some of the extra bits by overriding
848 * some of the CS4231 callback.
850 static int create_ad1845(struct snd_card *card, unsigned port,
851 int irq, int dma1, int dma2)
853 register struct soundscape *sscape = get_card_soundscape(card);
854 struct snd_wss *chip;
856 int codec_type = WSS_HW_DETECT;
858 switch (sscape->type) {
862 * There are some freak examples of early Soundscape cards
863 * with CS4231 instead of AD1848/CS4248. Unfortunately, the
864 * CS4231 works only in CS4248 compatibility mode on
865 * these cards so force it.
867 if (sscape->ic_type != IC_OPUS)
868 codec_type = WSS_HW_AD1848;
878 err = snd_wss_create(card, port, -1, irq, dma1, dma2,
879 codec_type, WSS_HWSHARE_DMA1, &chip);
883 if (sscape->type != SSCAPE_VIVO) {
885 * The input clock frequency on the SoundScape must
886 * be 14.31818 MHz, because we must set this register
887 * to get the playback to sound correct ...
889 snd_wss_mce_up(chip);
890 spin_lock_irqsave(&chip->reg_lock, flags);
891 snd_wss_out(chip, AD1845_CLOCK, 0x20);
892 spin_unlock_irqrestore(&chip->reg_lock, flags);
893 snd_wss_mce_down(chip);
897 err = snd_wss_pcm(chip, 0);
899 snd_printk(KERN_ERR "sscape: No PCM device "
900 "for AD1845 chip\n");
904 err = snd_wss_mixer(chip);
906 snd_printk(KERN_ERR "sscape: No mixer device "
907 "for AD1845 chip\n");
910 if (chip->hardware != WSS_HW_AD1848) {
911 err = snd_wss_timer(chip, 0);
913 snd_printk(KERN_ERR "sscape: No timer device "
914 "for AD1845 chip\n");
919 if (sscape->type != SSCAPE_VIVO) {
920 err = snd_ctl_add(card,
921 snd_ctl_new1(&midi_mixer_ctl, chip));
923 snd_printk(KERN_ERR "sscape: Could not create "
924 "MIDI mixer control\n");
938 * Create an ALSA soundcard entry for the SoundScape, using
939 * the given list of port, IRQ and DMA resources.
941 static int create_sscape(int dev, struct snd_card *card)
943 struct soundscape *sscape = get_card_soundscape(card);
946 unsigned mpu_irq_cfg;
947 struct resource *io_res;
948 struct resource *wss_res;
955 * Grab IO ports that we will need to probe so that we
956 * can detect and control this hardware ...
958 io_res = request_region(port[dev], 8, "SoundScape");
961 "sscape: can't grab port 0x%lx\n", port[dev]);
965 if (sscape->type == SSCAPE_VIVO) {
966 wss_res = request_region(wss_port[dev], 4, "SoundScape");
968 snd_printk(KERN_ERR "sscape: can't grab port 0x%lx\n",
971 goto _release_region;
976 * Grab one DMA channel ...
978 err = request_dma(dma[dev], "SoundScape");
980 snd_printk(KERN_ERR "sscape: can't grab DMA %d\n", dma[dev]);
981 goto _release_region;
984 spin_lock_init(&sscape->lock);
985 sscape->io_res = io_res;
986 sscape->wss_res = wss_res;
987 sscape->io_base = port[dev];
989 if (!detect_sscape(sscape, wss_port[dev])) {
990 printk(KERN_ERR "sscape: hardware not detected at 0x%x\n",
996 switch (sscape->type) {
998 name = "MediaFX/SoundFX";
1001 name = "Soundscape";
1004 name = "Soundscape PnP";
1007 name = "Soundscape VIVO";
1010 name = "unknown Soundscape";
1014 printk(KERN_INFO "sscape: %s card detected at 0x%x, using IRQ %d, DMA %d\n",
1015 name, sscape->io_base, irq[dev], dma[dev]);
1018 * Check that the user didn't pass us garbage data ...
1020 irq_cfg = get_irq_config(sscape->type, irq[dev]);
1021 if (irq_cfg == INVALID_IRQ) {
1022 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", irq[dev]);
1027 mpu_irq_cfg = get_irq_config(sscape->type, mpu_irq[dev]);
1028 if (mpu_irq_cfg == INVALID_IRQ) {
1029 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", mpu_irq[dev]);
1035 * Tell the on-board devices where their resources are (I think -
1036 * I can't be sure without a datasheet ... So many magic values!)
1038 spin_lock_irqsave(&sscape->lock, flags);
1040 sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2e);
1041 sscape_write_unsafe(sscape->io_base, GA_SMCFGB_REG, 0x00);
1044 * Enable and configure the DMA channels ...
1046 sscape_write_unsafe(sscape->io_base, GA_DMACFG_REG, 0x50);
1047 dma_cfg = (sscape->ic_type == IC_OPUS ? 0x40 : 0x70);
1048 sscape_write_unsafe(sscape->io_base, GA_DMAA_REG, dma_cfg);
1049 sscape_write_unsafe(sscape->io_base, GA_DMAB_REG, 0x20);
1051 mpu_irq_cfg |= mpu_irq_cfg << 2;
1052 val = sscape_read_unsafe(sscape->io_base, GA_HMCTL_REG) & 0xF7;
1055 sscape_write_unsafe(sscape->io_base, GA_HMCTL_REG, val | 0x10);
1056 sscape_write_unsafe(sscape->io_base, GA_INTCFG_REG, 0xf0 | mpu_irq_cfg);
1057 sscape_write_unsafe(sscape->io_base,
1058 GA_CDCFG_REG, 0x09 | DMA_8BIT
1059 | (dma[dev] << 4) | (irq_cfg << 1));
1061 * Enable the master IRQ ...
1063 sscape_write_unsafe(sscape->io_base, GA_INTENA_REG, 0x80);
1065 spin_unlock_irqrestore(&sscape->lock, flags);
1068 * We have now enabled the codec chip, and so we should
1069 * detect the AD1845 device ...
1071 err = create_ad1845(card, wss_port[dev], irq[dev],
1072 dma[dev], dma2[dev]);
1075 "sscape: No AD1845 device at 0x%lx, IRQ %d\n",
1076 wss_port[dev], irq[dev]);
1079 strcpy(card->driver, "SoundScape");
1080 strcpy(card->shortname, name);
1081 snprintf(card->longname, sizeof(card->longname),
1082 "%s at 0x%lx, IRQ %d, DMA1 %d, DMA2 %d\n",
1083 name, sscape->chip->port, sscape->chip->irq,
1084 sscape->chip->dma1, sscape->chip->dma2);
1086 #define MIDI_DEVNUM 0
1087 if (sscape->type != SSCAPE_VIVO) {
1088 err = sscape_upload_bootblock(card);
1090 err = sscape_upload_microcode(card, err);
1093 err = create_mpu401(card, MIDI_DEVNUM, port[dev],
1096 snd_printk(KERN_ERR "sscape: Failed to create "
1097 "MPU-401 device at 0x%lx\n",
1105 spin_lock_irqsave(&sscape->lock, flags);
1106 sscape->midi_vol = 0;
1107 host_write_ctrl_unsafe(sscape->io_base,
1108 CMD_SET_MIDI_VOL, 100);
1109 host_write_ctrl_unsafe(sscape->io_base,
1110 sscape->midi_vol, 100);
1111 host_write_ctrl_unsafe(sscape->io_base,
1112 CMD_XXX_MIDI_VOL, 100);
1113 host_write_ctrl_unsafe(sscape->io_base,
1114 sscape->midi_vol, 100);
1115 host_write_ctrl_unsafe(sscape->io_base,
1116 CMD_SET_EXTMIDI, 100);
1117 host_write_ctrl_unsafe(sscape->io_base,
1119 host_write_ctrl_unsafe(sscape->io_base, CMD_ACK, 100);
1121 set_midi_mode_unsafe(sscape->io_base);
1122 spin_unlock_irqrestore(&sscape->lock, flags);
1127 * Now that we have successfully created this sound card,
1128 * it is safe to store the pointer.
1129 * NOTE: we only register the sound card's "destructor"
1130 * function now that our "constructor" has completed.
1132 card->private_free = soundscape_free;
1140 release_and_free_resource(wss_res);
1141 release_and_free_resource(io_res);
1147 static int snd_sscape_match(struct device *pdev, unsigned int i)
1150 * Make sure we were given ALL of the other parameters.
1152 if (port[i] == SNDRV_AUTO_PORT)
1155 if (irq[i] == SNDRV_AUTO_IRQ ||
1156 mpu_irq[i] == SNDRV_AUTO_IRQ ||
1157 dma[i] == SNDRV_AUTO_DMA) {
1159 "sscape: insufficient parameters, "
1160 "need IO, IRQ, MPU-IRQ and DMA\n");
1167 static int snd_sscape_probe(struct device *pdev, unsigned int dev)
1169 struct snd_card *card;
1170 struct soundscape *sscape;
1173 ret = snd_card_new(pdev, index[dev], id[dev], THIS_MODULE,
1174 sizeof(struct soundscape), &card);
1178 sscape = get_card_soundscape(card);
1179 sscape->type = SSCAPE;
1183 ret = create_sscape(dev, card);
1187 ret = snd_card_register(card);
1189 snd_printk(KERN_ERR "sscape: Failed to register sound card\n");
1192 dev_set_drvdata(pdev, card);
1196 snd_card_free(card);
1200 static int snd_sscape_remove(struct device *devptr, unsigned int dev)
1202 snd_card_free(dev_get_drvdata(devptr));
1206 #define DEV_NAME "sscape"
1208 static struct isa_driver snd_sscape_driver = {
1209 .match = snd_sscape_match,
1210 .probe = snd_sscape_probe,
1211 .remove = snd_sscape_remove,
1212 /* FIXME: suspend/resume */
1219 static inline int get_next_autoindex(int i)
1221 while (i < SNDRV_CARDS && port[i] != SNDRV_AUTO_PORT)
1227 static int sscape_pnp_detect(struct pnp_card_link *pcard,
1228 const struct pnp_card_device_id *pid)
1231 struct pnp_dev *dev;
1232 struct snd_card *card;
1233 struct soundscape *sscape;
1237 * Allow this function to fail *quietly* if all the ISA PnP
1238 * devices were configured using module parameters instead.
1240 idx = get_next_autoindex(idx);
1241 if (idx >= SNDRV_CARDS)
1245 * Check that we still have room for another sound card ...
1247 dev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
1251 if (!pnp_is_active(dev)) {
1252 if (pnp_activate_dev(dev) < 0) {
1253 snd_printk(KERN_INFO "sscape: device is inactive\n");
1259 * Create a new ALSA sound card entry, in anticipation
1260 * of detecting our hardware ...
1262 ret = snd_card_new(&pcard->card->dev,
1263 index[idx], id[idx], THIS_MODULE,
1264 sizeof(struct soundscape), &card);
1268 sscape = get_card_soundscape(card);
1271 * Identify card model ...
1273 if (!strncmp("ENS4081", pid->id, 7))
1274 sscape->type = SSCAPE_VIVO;
1276 sscape->type = SSCAPE_PNP;
1279 * Read the correct parameters off the ISA PnP bus ...
1281 port[idx] = pnp_port_start(dev, 0);
1282 irq[idx] = pnp_irq(dev, 0);
1283 mpu_irq[idx] = pnp_irq(dev, 1);
1284 dma[idx] = pnp_dma(dev, 0) & 0x03;
1285 if (sscape->type == SSCAPE_PNP) {
1286 dma2[idx] = dma[idx];
1287 wss_port[idx] = CODEC_IO(port[idx]);
1289 wss_port[idx] = pnp_port_start(dev, 1);
1290 dma2[idx] = pnp_dma(dev, 1);
1293 ret = create_sscape(idx, card);
1297 ret = snd_card_register(card);
1299 snd_printk(KERN_ERR "sscape: Failed to register sound card\n");
1303 pnp_set_card_drvdata(pcard, card);
1308 snd_card_free(card);
1312 static void sscape_pnp_remove(struct pnp_card_link *pcard)
1314 snd_card_free(pnp_get_card_drvdata(pcard));
1315 pnp_set_card_drvdata(pcard, NULL);
1318 static struct pnp_card_driver sscape_pnpc_driver = {
1319 .flags = PNP_DRIVER_RES_DO_NOT_CHANGE,
1321 .id_table = sscape_pnpids,
1322 .probe = sscape_pnp_detect,
1323 .remove = sscape_pnp_remove,
1326 #endif /* CONFIG_PNP */
1328 static int __init sscape_init(void)
1332 err = isa_register_driver(&snd_sscape_driver, SNDRV_CARDS);
1337 err = pnp_register_card_driver(&sscape_pnpc_driver);
1347 static void __exit sscape_exit(void)
1351 pnp_unregister_card_driver(&sscape_pnpc_driver);
1354 isa_unregister_driver(&snd_sscape_driver);
1357 module_init(sscape_init);
1358 module_exit(sscape_exit);