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;
58 module_param_array(index, int, NULL, 0444);
59 MODULE_PARM_DESC(index, "Index number for SoundScape soundcard");
61 module_param_array(id, charp, NULL, 0444);
62 MODULE_PARM_DESC(id, "Description for SoundScape card");
64 module_param_array(port, long, NULL, 0444);
65 MODULE_PARM_DESC(port, "Port # for SoundScape driver.");
67 module_param_array(wss_port, long, NULL, 0444);
68 MODULE_PARM_DESC(wss_port, "WSS Port # for SoundScape driver.");
70 module_param_array(irq, int, NULL, 0444);
71 MODULE_PARM_DESC(irq, "IRQ # for SoundScape driver.");
73 module_param_array(mpu_irq, int, NULL, 0444);
74 MODULE_PARM_DESC(mpu_irq, "MPU401 IRQ # for SoundScape driver.");
76 module_param_array(dma, int, NULL, 0444);
77 MODULE_PARM_DESC(dma, "DMA # for SoundScape driver.");
79 module_param_array(dma2, int, NULL, 0444);
80 MODULE_PARM_DESC(dma2, "DMA2 # for SoundScape driver.");
83 static int isa_registered;
84 static int pnp_registered;
86 static struct pnp_card_device_id sscape_pnpids[] = {
87 { .id = "ENS3081", .devs = { { "ENS0000" } } }, /* Soundscape PnP */
88 { .id = "ENS4081", .devs = { { "ENS1011" } } }, /* VIVO90 */
89 { .id = "" } /* end */
92 MODULE_DEVICE_TABLE(pnp_card, sscape_pnpids);
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
134 MEDIA_FX, /* Sequoia S-1000 */
135 SSCAPE, /* Sequoia S-2000 */
145 struct resource *io_res;
146 struct resource *wss_res;
147 struct snd_wss *chip;
148 struct snd_mpu401 *mpu;
150 unsigned char midi_vol;
153 #define INVALID_IRQ ((unsigned)-1)
156 static inline struct soundscape *get_card_soundscape(struct snd_card *c)
158 return (struct soundscape *) (c->private_data);
162 * Allocates some kernel memory that we can use for DMA.
163 * I think this means that the memory has to map to
164 * contiguous pages of physical memory.
166 static struct snd_dma_buffer *get_dmabuf(struct snd_dma_buffer *buf, unsigned long size)
169 if (snd_dma_alloc_pages_fallback(SNDRV_DMA_TYPE_DEV, snd_dma_isa_data(),
171 snd_printk(KERN_ERR "sscape: Failed to allocate "
172 "%lu bytes for DMA\n",
182 * Release the DMA-able kernel memory ...
184 static void free_dmabuf(struct snd_dma_buffer *buf)
186 if (buf && buf->area)
187 snd_dma_free_pages(buf);
192 * This function writes to the SoundScape's control registers,
193 * but doesn't do any locking. It's up to the caller to do that.
194 * This is why this function is "unsafe" ...
196 static inline void sscape_write_unsafe(unsigned io_base, enum GA_REG reg, unsigned char val)
198 outb(reg, ODIE_ADDR_IO(io_base));
199 outb(val, ODIE_DATA_IO(io_base));
203 * Write to the SoundScape's control registers, and do the
204 * necessary locking ...
206 static void sscape_write(struct soundscape *s, enum GA_REG reg, unsigned char val)
210 spin_lock_irqsave(&s->lock, flags);
211 sscape_write_unsafe(s->io_base, reg, val);
212 spin_unlock_irqrestore(&s->lock, flags);
216 * Read from the SoundScape's control registers, but leave any
217 * locking to the caller. This is why the function is "unsafe" ...
219 static inline unsigned char sscape_read_unsafe(unsigned io_base, enum GA_REG reg)
221 outb(reg, ODIE_ADDR_IO(io_base));
222 return inb(ODIE_DATA_IO(io_base));
226 * Puts the SoundScape into "host" mode, as compared to "MIDI" mode
228 static inline void set_host_mode_unsafe(unsigned io_base)
230 outb(0x0, HOST_CTRL_IO(io_base));
234 * Puts the SoundScape into "MIDI" mode, as compared to "host" mode
236 static inline void set_midi_mode_unsafe(unsigned io_base)
238 outb(0x3, HOST_CTRL_IO(io_base));
242 * Read the SoundScape's host-mode control register, but leave
243 * any locking issues to the caller ...
245 static inline int host_read_unsafe(unsigned io_base)
248 if ((inb(HOST_CTRL_IO(io_base)) & RX_READY) != 0) {
249 data = inb(HOST_DATA_IO(io_base));
256 * Read the SoundScape's host-mode control register, performing
257 * a limited amount of busy-waiting if the register isn't ready.
258 * Also leaves all locking-issues to the caller ...
260 static int host_read_ctrl_unsafe(unsigned io_base, unsigned timeout)
264 while (((data = host_read_unsafe(io_base)) < 0) && (timeout != 0)) {
273 * Write to the SoundScape's host-mode control registers, but
274 * leave any locking issues to the caller ...
276 static inline int host_write_unsafe(unsigned io_base, unsigned char data)
278 if ((inb(HOST_CTRL_IO(io_base)) & TX_READY) != 0) {
279 outb(data, HOST_DATA_IO(io_base));
287 * Write to the SoundScape's host-mode control registers, performing
288 * a limited amount of busy-waiting if the register isn't ready.
289 * Also leaves all locking-issues to the caller ...
291 static int host_write_ctrl_unsafe(unsigned io_base, unsigned char data,
296 while (!(err = host_write_unsafe(io_base, data)) && (timeout != 0)) {
306 * Check that the MIDI subsystem is operational. If it isn't,
307 * then we will hang the computer if we try to use it ...
309 * NOTE: This check is based upon observation, not documentation.
311 static inline int verify_mpu401(const struct snd_mpu401 * mpu)
313 return ((inb(MPU401C(mpu)) & 0xc0) == 0x80);
317 * This is apparently the standard way to initailise an MPU-401
319 static inline void initialise_mpu401(const struct snd_mpu401 * mpu)
321 outb(0, MPU401D(mpu));
325 * Tell the SoundScape to activate the AD1845 chip (I think).
326 * The AD1845 detection fails if we *don't* do this, so I
327 * think that this is a good idea ...
329 static inline void activate_ad1845_unsafe(unsigned io_base)
331 sscape_write_unsafe(io_base, GA_HMCTL_REG, (sscape_read_unsafe(io_base, GA_HMCTL_REG) & 0xcf) | 0x10);
332 sscape_write_unsafe(io_base, GA_CDCFG_REG, 0x80);
336 * Do the necessary ALSA-level cleanup to deallocate our driver ...
338 static void soundscape_free(struct snd_card *c)
340 struct soundscape *sscape = get_card_soundscape(c);
341 release_and_free_resource(sscape->io_res);
342 release_and_free_resource(sscape->wss_res);
343 free_dma(sscape->chip->dma1);
347 * Tell the SoundScape to begin a DMA tranfer using the given channel.
348 * All locking issues are left to the caller.
350 static inline void sscape_start_dma_unsafe(unsigned io_base, enum GA_REG reg)
352 sscape_write_unsafe(io_base, reg, sscape_read_unsafe(io_base, reg) | 0x01);
353 sscape_write_unsafe(io_base, reg, sscape_read_unsafe(io_base, reg) & 0xfe);
357 * Wait for a DMA transfer to complete. This is a "limited busy-wait",
358 * and all locking issues are left to the caller.
360 static int sscape_wait_dma_unsafe(unsigned io_base, enum GA_REG reg, unsigned timeout)
362 while (!(sscape_read_unsafe(io_base, reg) & 0x01) && (timeout != 0)) {
367 return (sscape_read_unsafe(io_base, reg) & 0x01);
371 * Wait for the On-Board Processor to return its start-up
372 * acknowledgement sequence. This wait is too long for
373 * us to perform "busy-waiting", and so we must sleep.
374 * This in turn means that we must not be holding any
375 * spinlocks when we call this function.
377 static int obp_startup_ack(struct soundscape *s, unsigned timeout)
379 unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
385 spin_lock_irqsave(&s->lock, flags);
386 x = host_read_unsafe(s->io_base);
387 spin_unlock_irqrestore(&s->lock, flags);
388 if (x == 0xfe || x == 0xff)
392 } while (time_before(jiffies, end_time));
398 * Wait for the host to return its start-up acknowledgement
399 * sequence. This wait is too long for us to perform
400 * "busy-waiting", and so we must sleep. This in turn means
401 * that we must not be holding any spinlocks when we call
404 static int host_startup_ack(struct soundscape *s, unsigned timeout)
406 unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
412 spin_lock_irqsave(&s->lock, flags);
413 x = host_read_unsafe(s->io_base);
414 spin_unlock_irqrestore(&s->lock, flags);
419 } while (time_before(jiffies, end_time));
425 * Upload a byte-stream into the SoundScape using DMA channel A.
427 static int upload_dma_data(struct soundscape *s,
428 const unsigned char *data,
432 struct snd_dma_buffer dma;
435 if (!get_dmabuf(&dma, PAGE_ALIGN(32 * 1024)))
438 spin_lock_irqsave(&s->lock, flags);
441 * Reset the board ...
443 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f);
446 * Enable the DMA channels and configure them ...
448 sscape_write_unsafe(s->io_base, GA_DMAA_REG, (s->chip->dma1 << 4) | DMA_8BIT);
449 sscape_write_unsafe(s->io_base, GA_DMAB_REG, 0x20);
452 * Take the board out of reset ...
454 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) | 0x80);
457 * Upload the firmware to the SoundScape
458 * board through the DMA channel ...
463 len = min(size, dma.bytes);
464 memcpy(dma.area, data, len);
468 snd_dma_program(s->chip->dma1, dma.addr, len, DMA_MODE_WRITE);
469 sscape_start_dma_unsafe(s->io_base, GA_DMAA_REG);
470 if (!sscape_wait_dma_unsafe(s->io_base, GA_DMAA_REG, 5000)) {
472 * Don't forget to release this spinlock we're holding ...
474 spin_unlock_irqrestore(&s->lock, flags);
477 "sscape: DMA upload has timed out\n");
483 set_host_mode_unsafe(s->io_base);
484 outb(0x0, s->io_base);
487 * Boot the board ... (I think)
489 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) | 0x40);
490 spin_unlock_irqrestore(&s->lock, flags);
493 * If all has gone well, then the board should acknowledge
494 * the new upload and tell us that it has rebooted OK. We
495 * give it 5 seconds (max) ...
498 if (!obp_startup_ack(s, 5000)) {
499 snd_printk(KERN_ERR "sscape: No response "
500 "from on-board processor after upload\n");
502 } else if (!host_startup_ack(s, 5000)) {
504 "sscape: SoundScape failed to initialise\n");
510 * NOTE!!! We are NOT holding any spinlocks at this point !!!
512 sscape_write(s, GA_DMAA_REG, (s->ic_type == IC_OPUS ? 0x40 : 0x70));
519 * Upload the bootblock(?) into the SoundScape. The only
520 * purpose of this block of code seems to be to tell
521 * us which version of the microcode we should be using.
523 static int sscape_upload_bootblock(struct snd_card *card)
525 struct soundscape *sscape = get_card_soundscape(card);
527 const struct firmware *init_fw = NULL;
531 ret = request_firmware(&init_fw, "scope.cod", card->dev);
533 snd_printk(KERN_ERR "sscape: Error loading scope.cod");
536 ret = upload_dma_data(sscape, init_fw->data, init_fw->size);
538 release_firmware(init_fw);
540 spin_lock_irqsave(&sscape->lock, flags);
542 data = host_read_ctrl_unsafe(sscape->io_base, 100);
545 sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2f);
547 spin_unlock_irqrestore(&sscape->lock, flags);
550 if (ret == 0 && data > 7) {
552 "sscape: timeout reading firmware version\n");
556 return (ret == 0) ? data : ret;
560 * Upload the microcode into the SoundScape.
562 static int sscape_upload_microcode(struct snd_card *card, int version)
564 struct soundscape *sscape = get_card_soundscape(card);
565 const struct firmware *init_fw = NULL;
569 snprintf(name, sizeof(name), "sndscape.co%d", version);
571 err = request_firmware(&init_fw, name, card->dev);
573 snd_printk(KERN_ERR "sscape: Error loading sndscape.co%d",
577 err = upload_dma_data(sscape, init_fw->data, init_fw->size);
579 snd_printk(KERN_INFO "sscape: MIDI firmware loaded %d KBs\n",
580 init_fw->size >> 10);
582 release_firmware(init_fw);
588 * Mixer control for the SoundScape's MIDI device.
590 static int sscape_midi_info(struct snd_kcontrol *ctl,
591 struct snd_ctl_elem_info *uinfo)
593 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
595 uinfo->value.integer.min = 0;
596 uinfo->value.integer.max = 127;
600 static int sscape_midi_get(struct snd_kcontrol *kctl,
601 struct snd_ctl_elem_value *uctl)
603 struct snd_wss *chip = snd_kcontrol_chip(kctl);
604 struct snd_card *card = chip->card;
605 register struct soundscape *s = get_card_soundscape(card);
608 spin_lock_irqsave(&s->lock, flags);
609 uctl->value.integer.value[0] = s->midi_vol;
610 spin_unlock_irqrestore(&s->lock, flags);
614 static int sscape_midi_put(struct snd_kcontrol *kctl,
615 struct snd_ctl_elem_value *uctl)
617 struct snd_wss *chip = snd_kcontrol_chip(kctl);
618 struct snd_card *card = chip->card;
619 register struct soundscape *s = get_card_soundscape(card);
623 spin_lock_irqsave(&s->lock, flags);
626 * We need to put the board into HOST mode before we
627 * can send any volume-changing HOST commands ...
629 set_host_mode_unsafe(s->io_base);
632 * To successfully change the MIDI volume setting, you seem to
633 * have to write a volume command, write the new volume value,
634 * and then perform another volume-related command. Perhaps the
635 * first command is an "open" and the second command is a "close"?
637 if (s->midi_vol == ((unsigned char) uctl->value.integer. value[0] & 127)) {
641 change = (host_write_ctrl_unsafe(s->io_base, CMD_SET_MIDI_VOL, 100)
642 && host_write_ctrl_unsafe(s->io_base, ((unsigned char) uctl->value.integer. value[0]) & 127, 100)
643 && host_write_ctrl_unsafe(s->io_base, CMD_XXX_MIDI_VOL, 100));
644 s->midi_vol = (unsigned char) uctl->value.integer.value[0] & 127;
648 * Take the board out of HOST mode and back into MIDI mode ...
650 set_midi_mode_unsafe(s->io_base);
652 spin_unlock_irqrestore(&s->lock, flags);
656 static struct snd_kcontrol_new midi_mixer_ctl = {
657 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
659 .info = sscape_midi_info,
660 .get = sscape_midi_get,
661 .put = sscape_midi_put
665 * The SoundScape can use two IRQs from a possible set of four.
666 * These IRQs are encoded as bit patterns so that they can be
667 * written to the control registers.
669 static unsigned __devinit get_irq_config(int sscape_type, int irq)
671 static const int valid_irq[] = { 9, 5, 7, 10 };
672 static const int old_irq[] = { 9, 7, 5, 15 };
675 if (sscape_type == MEDIA_FX) {
676 for (cfg = 0; cfg < ARRAY_SIZE(old_irq); ++cfg)
677 if (irq == old_irq[cfg])
680 for (cfg = 0; cfg < ARRAY_SIZE(valid_irq); ++cfg)
681 if (irq == valid_irq[cfg])
689 * Perform certain arcane port-checks to see whether there
690 * is a SoundScape board lurking behind the given ports.
692 static int __devinit detect_sscape(struct soundscape *s, long wss_io)
698 spin_lock_irqsave(&s->lock, flags);
701 * The following code is lifted from the original OSS driver,
702 * and as I don't have a datasheet I cannot really comment
703 * on what it is doing...
705 if ((inb(HOST_CTRL_IO(s->io_base)) & 0x78) != 0)
708 d = inb(ODIE_ADDR_IO(s->io_base)) & 0xf0;
713 s->ic_type = IC_ODIE;
714 else if ((d & 0x60) != 0)
715 s->ic_type = IC_OPUS;
719 outb(0xfa, ODIE_ADDR_IO(s->io_base));
720 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0a)
723 outb(0xfe, ODIE_ADDR_IO(s->io_base));
724 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0e)
727 outb(0xfe, ODIE_ADDR_IO(s->io_base));
728 d = inb(ODIE_DATA_IO(s->io_base));
729 if (s->type != SSCAPE_VIVO && (d & 0x9f) != 0x0e)
732 if (s->ic_type == IC_OPUS)
733 activate_ad1845_unsafe(s->io_base);
735 if (s->type == SSCAPE_VIVO)
738 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f;
739 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
741 /* wait for WSS codec */
742 for (d = 0; d < 500; d++) {
743 if ((inb(wss_io) & 0x80) == 0)
745 spin_unlock_irqrestore(&s->lock, flags);
747 spin_lock_irqsave(&s->lock, flags);
750 if ((inb(wss_io) & 0x80) != 0)
753 if (inb(wss_io + 2) == 0xff)
756 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f;
757 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d);
759 if ((inb(wss_io) & 0x80) != 0)
762 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f;
763 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
764 /* wait for WSS codec */
765 for (d = 0; d < 500; d++) {
766 if ((inb(wss_io) & 0x80) == 0)
768 spin_unlock_irqrestore(&s->lock, flags);
770 spin_lock_irqsave(&s->lock, flags);
774 * SoundScape successfully detected!
779 spin_unlock_irqrestore(&s->lock, flags);
784 * ALSA callback function, called when attempting to open the MIDI device.
785 * Check that the MIDI firmware has been loaded, because we don't want
786 * to crash the machine. Also check that someone isn't using the hardware
789 static int mpu401_open(struct snd_mpu401 * mpu)
791 if (!verify_mpu401(mpu)) {
792 snd_printk(KERN_ERR "sscape: MIDI disabled, "
793 "please load firmware\n");
801 * Initialse an MPU-401 subdevice for MIDI support on the SoundScape.
803 static int __devinit create_mpu401(struct snd_card *card, int devnum, unsigned long port, int irq)
805 struct soundscape *sscape = get_card_soundscape(card);
806 struct snd_rawmidi *rawmidi;
809 if ((err = snd_mpu401_uart_new(card, devnum,
811 port, MPU401_INFO_INTEGRATED,
814 struct snd_mpu401 *mpu = (struct snd_mpu401 *) rawmidi->private_data;
815 mpu->open_input = mpu401_open;
816 mpu->open_output = mpu401_open;
817 mpu->private_data = sscape;
820 initialise_mpu401(mpu);
828 * Create an AD1845 PCM subdevice on the SoundScape. The AD1845
829 * is very much like a CS4231, with a few extra bits. We will
830 * try to support at least some of the extra bits by overriding
831 * some of the CS4231 callback.
833 static int __devinit create_ad1845(struct snd_card *card, unsigned port,
834 int irq, int dma1, int dma2)
836 register struct soundscape *sscape = get_card_soundscape(card);
837 struct snd_wss *chip;
840 if (sscape->type == SSCAPE_VIVO)
843 err = snd_wss_create(card, port, -1, irq, dma1, dma2,
844 WSS_HW_DETECT, WSS_HWSHARE_DMA1, &chip);
850 * It turns out that the PLAYBACK_ENABLE bit is set
851 * by the lowlevel driver ...
853 #define AD1845_IFACE_CONFIG \
854 (CS4231_AUTOCALIB | CS4231_RECORD_ENABLE | CS4231_PLAYBACK_ENABLE)
855 snd_wss_mce_up(chip);
856 spin_lock_irqsave(&chip->reg_lock, flags);
857 snd_wss_out(chip, CS4231_IFACE_CTRL, AD1845_IFACE_CONFIG);
858 spin_unlock_irqrestore(&chip->reg_lock, flags);
859 snd_wss_mce_down(chip);
862 if (sscape->type != SSCAPE_VIVO) {
864 * The input clock frequency on the SoundScape must
865 * be 14.31818 MHz, because we must set this register
866 * to get the playback to sound correct ...
868 snd_wss_mce_up(chip);
869 spin_lock_irqsave(&chip->reg_lock, flags);
870 snd_wss_out(chip, AD1845_CLOCK, 0x20);
871 spin_unlock_irqrestore(&chip->reg_lock, flags);
872 snd_wss_mce_down(chip);
876 err = snd_wss_pcm(chip, 0, &pcm);
878 snd_printk(KERN_ERR "sscape: No PCM device "
879 "for AD1845 chip\n");
883 err = snd_wss_mixer(chip);
885 snd_printk(KERN_ERR "sscape: No mixer device "
886 "for AD1845 chip\n");
889 if (chip->hardware != WSS_HW_AD1848) {
890 err = snd_wss_timer(chip, 0, NULL);
892 snd_printk(KERN_ERR "sscape: No timer device "
893 "for AD1845 chip\n");
898 if (sscape->type != SSCAPE_VIVO) {
899 err = snd_ctl_add(card,
900 snd_ctl_new1(&midi_mixer_ctl, chip));
902 snd_printk(KERN_ERR "sscape: Could not create "
903 "MIDI mixer control\n");
917 * Create an ALSA soundcard entry for the SoundScape, using
918 * the given list of port, IRQ and DMA resources.
920 static int __devinit create_sscape(int dev, struct snd_card *card)
922 struct soundscape *sscape = get_card_soundscape(card);
925 unsigned mpu_irq_cfg;
926 struct resource *io_res;
927 struct resource *wss_res;
933 * Grab IO ports that we will need to probe so that we
934 * can detect and control this hardware ...
936 io_res = request_region(port[dev], 8, "SoundScape");
939 "sscape: can't grab port 0x%lx\n", port[dev]);
943 if (sscape->type == SSCAPE_VIVO) {
944 wss_res = request_region(wss_port[dev], 4, "SoundScape");
946 snd_printk(KERN_ERR "sscape: can't grab port 0x%lx\n",
949 goto _release_region;
954 * Grab one DMA channel ...
956 err = request_dma(dma[dev], "SoundScape");
958 snd_printk(KERN_ERR "sscape: can't grab DMA %d\n", dma[dev]);
959 goto _release_region;
962 spin_lock_init(&sscape->lock);
963 sscape->io_res = io_res;
964 sscape->wss_res = wss_res;
965 sscape->io_base = port[dev];
967 if (!detect_sscape(sscape, wss_port[dev])) {
968 printk(KERN_ERR "sscape: hardware not detected at 0x%x\n",
974 switch (sscape->type) {
976 name = "MediaFX/SoundFX";
982 name = "Soundscape PnP";
985 name = "Soundscape VIVO";
988 name = "unknown Soundscape";
992 printk(KERN_INFO "sscape: %s card detected at 0x%x, using IRQ %d, DMA %d\n",
993 name, sscape->io_base, irq[dev], dma[dev]);
996 * Check that the user didn't pass us garbage data ...
998 irq_cfg = get_irq_config(sscape->type, irq[dev]);
999 if (irq_cfg == INVALID_IRQ) {
1000 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", irq[dev]);
1004 mpu_irq_cfg = get_irq_config(sscape->type, mpu_irq[dev]);
1005 if (mpu_irq_cfg == INVALID_IRQ) {
1006 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", mpu_irq[dev]);
1011 * Tell the on-board devices where their resources are (I think -
1012 * I can't be sure without a datasheet ... So many magic values!)
1014 spin_lock_irqsave(&sscape->lock, flags);
1016 sscape_write_unsafe(sscape->io_base, GA_INTENA_REG, 0x00); /* disable */
1017 sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2e);
1018 sscape_write_unsafe(sscape->io_base, GA_SMCFGB_REG, 0x00);
1021 * Enable and configure the DMA channels ...
1023 sscape_write_unsafe(sscape->io_base, GA_DMACFG_REG, 0x50);
1024 dma_cfg = (sscape->ic_type == IC_OPUS ? 0x40 : 0x70);
1025 sscape_write_unsafe(sscape->io_base, GA_DMAA_REG, dma_cfg);
1026 sscape_write_unsafe(sscape->io_base, GA_DMAB_REG, 0x20);
1028 mpu_irq_cfg |= mpu_irq_cfg << 2;
1029 sscape_write_unsafe(sscape->io_base, GA_INTCFG_REG, 0xf0 | mpu_irq_cfg);
1030 sscape_write_unsafe(sscape->io_base,
1031 GA_CDCFG_REG, 0x09 | DMA_8BIT
1032 | (dma[dev] << 4) | (irq_cfg << 1));
1034 spin_unlock_irqrestore(&sscape->lock, flags);
1037 * We have now enabled the codec chip, and so we should
1038 * detect the AD1845 device ...
1040 err = create_ad1845(card, wss_port[dev], irq[dev],
1041 dma[dev], dma2[dev]);
1044 "sscape: No AD1845 device at 0x%lx, IRQ %d\n",
1045 wss_port[dev], irq[dev]);
1048 strcpy(card->driver, "SoundScape");
1049 strcpy(card->shortname, name);
1050 snprintf(card->longname, sizeof(card->longname),
1051 "%s at 0x%lx, IRQ %d, DMA1 %d, DMA2 %d\n",
1052 name, sscape->chip->port, sscape->chip->irq,
1053 sscape->chip->dma1, sscape->chip->dma2);
1055 #define MIDI_DEVNUM 0
1056 if (sscape->type != SSCAPE_VIVO) {
1057 err = sscape_upload_bootblock(card);
1059 err = sscape_upload_microcode(card, err);
1062 err = create_mpu401(card, MIDI_DEVNUM, port[dev],
1065 snd_printk(KERN_ERR "sscape: Failed to create "
1066 "MPU-401 device at 0x%lx\n",
1072 * Enable the master IRQ ...
1074 sscape_write(sscape, GA_INTENA_REG, 0x80);
1079 spin_lock_irqsave(&sscape->lock, flags);
1080 sscape->midi_vol = 0;
1081 host_write_ctrl_unsafe(sscape->io_base,
1082 CMD_SET_MIDI_VOL, 100);
1083 host_write_ctrl_unsafe(sscape->io_base,
1084 sscape->midi_vol, 100);
1085 host_write_ctrl_unsafe(sscape->io_base,
1086 CMD_XXX_MIDI_VOL, 100);
1087 host_write_ctrl_unsafe(sscape->io_base,
1088 sscape->midi_vol, 100);
1089 host_write_ctrl_unsafe(sscape->io_base,
1090 CMD_SET_EXTMIDI, 100);
1091 host_write_ctrl_unsafe(sscape->io_base,
1093 host_write_ctrl_unsafe(sscape->io_base, CMD_ACK, 100);
1095 set_midi_mode_unsafe(sscape->io_base);
1096 spin_unlock_irqrestore(&sscape->lock, flags);
1101 * Now that we have successfully created this sound card,
1102 * it is safe to store the pointer.
1103 * NOTE: we only register the sound card's "destructor"
1104 * function now that our "constructor" has completed.
1106 card->private_free = soundscape_free;
1114 release_and_free_resource(wss_res);
1115 release_and_free_resource(io_res);
1121 static int __devinit snd_sscape_match(struct device *pdev, unsigned int i)
1124 * Make sure we were given ALL of the other parameters.
1126 if (port[i] == SNDRV_AUTO_PORT)
1129 if (irq[i] == SNDRV_AUTO_IRQ ||
1130 mpu_irq[i] == SNDRV_AUTO_IRQ ||
1131 dma[i] == SNDRV_AUTO_DMA) {
1133 "sscape: insufficient parameters, need IO, IRQ, MPU-IRQ and DMA\n");
1140 static int __devinit snd_sscape_probe(struct device *pdev, unsigned int dev)
1142 struct snd_card *card;
1143 struct soundscape *sscape;
1146 ret = snd_card_create(index[dev], id[dev], THIS_MODULE,
1147 sizeof(struct soundscape), &card);
1151 sscape = get_card_soundscape(card);
1152 sscape->type = SSCAPE;
1155 snd_card_set_dev(card, pdev);
1157 ret = create_sscape(dev, card);
1161 if ((ret = snd_card_register(card)) < 0) {
1162 snd_printk(KERN_ERR "sscape: Failed to register sound card\n");
1165 dev_set_drvdata(pdev, card);
1169 snd_card_free(card);
1173 static int __devexit snd_sscape_remove(struct device *devptr, unsigned int dev)
1175 snd_card_free(dev_get_drvdata(devptr));
1176 dev_set_drvdata(devptr, NULL);
1180 #define DEV_NAME "sscape"
1182 static struct isa_driver snd_sscape_driver = {
1183 .match = snd_sscape_match,
1184 .probe = snd_sscape_probe,
1185 .remove = __devexit_p(snd_sscape_remove),
1186 /* FIXME: suspend/resume */
1193 static inline int __devinit get_next_autoindex(int i)
1195 while (i < SNDRV_CARDS && port[i] != SNDRV_AUTO_PORT)
1201 static int __devinit sscape_pnp_detect(struct pnp_card_link *pcard,
1202 const struct pnp_card_device_id *pid)
1205 struct pnp_dev *dev;
1206 struct snd_card *card;
1207 struct soundscape *sscape;
1211 * Allow this function to fail *quietly* if all the ISA PnP
1212 * devices were configured using module parameters instead.
1214 if ((idx = get_next_autoindex(idx)) >= SNDRV_CARDS)
1218 * We have found a candidate ISA PnP card. Now we
1219 * have to check that it has the devices that we
1220 * expect it to have.
1224 * Check that we still have room for another sound card ...
1226 dev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
1230 if (!pnp_is_active(dev)) {
1231 if (pnp_activate_dev(dev) < 0) {
1232 snd_printk(KERN_INFO "sscape: device is inactive\n");
1238 * Create a new ALSA sound card entry, in anticipation
1239 * of detecting our hardware ...
1241 ret = snd_card_create(index[idx], id[idx], THIS_MODULE,
1242 sizeof(struct soundscape), &card);
1246 sscape = get_card_soundscape(card);
1249 * Identify card model ...
1251 if (!strncmp("ENS4081", pid->id, 7))
1252 sscape->type = SSCAPE_VIVO;
1254 sscape->type = SSCAPE_PNP;
1257 * Read the correct parameters off the ISA PnP bus ...
1259 port[idx] = pnp_port_start(dev, 0);
1260 irq[idx] = pnp_irq(dev, 0);
1261 mpu_irq[idx] = pnp_irq(dev, 1);
1262 dma[idx] = pnp_dma(dev, 0) & 0x03;
1263 if (sscape->type == SSCAPE_PNP) {
1264 dma2[idx] = dma[idx];
1265 wss_port[idx] = CODEC_IO(port[idx]);
1267 wss_port[idx] = pnp_port_start(dev, 1);
1268 dma2[idx] = pnp_dma(dev, 1);
1270 snd_card_set_dev(card, &pcard->card->dev);
1272 ret = create_sscape(idx, card);
1276 if ((ret = snd_card_register(card)) < 0) {
1277 snd_printk(KERN_ERR "sscape: Failed to register sound card\n");
1281 pnp_set_card_drvdata(pcard, card);
1286 snd_card_free(card);
1290 static void __devexit sscape_pnp_remove(struct pnp_card_link * pcard)
1292 snd_card_free(pnp_get_card_drvdata(pcard));
1293 pnp_set_card_drvdata(pcard, NULL);
1296 static struct pnp_card_driver sscape_pnpc_driver = {
1297 .flags = PNP_DRIVER_RES_DO_NOT_CHANGE,
1299 .id_table = sscape_pnpids,
1300 .probe = sscape_pnp_detect,
1301 .remove = __devexit_p(sscape_pnp_remove),
1304 #endif /* CONFIG_PNP */
1306 static int __init sscape_init(void)
1310 err = isa_register_driver(&snd_sscape_driver, SNDRV_CARDS);
1315 err = pnp_register_card_driver(&sscape_pnpc_driver);
1325 static void __exit sscape_exit(void)
1329 pnp_unregister_card_driver(&sscape_pnpc_driver);
1332 isa_unregister_driver(&snd_sscape_driver);
1335 module_init(sscape_init);
1336 module_exit(sscape_exit);