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");
45 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
46 static char* id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
47 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
48 static long wss_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
49 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;
50 static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;
51 static int dma[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;
52 static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;
53 static bool joystick[SNDRV_CARDS];
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.");
79 module_param_array(joystick, bool, NULL, 0444);
80 MODULE_PARM_DESC(joystick, "Enable gameport.");
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;
149 unsigned char midi_vol;
152 #define INVALID_IRQ ((unsigned)-1)
155 static inline struct soundscape *get_card_soundscape(struct snd_card *c)
157 return (struct soundscape *) (c->private_data);
161 * Allocates some kernel memory that we can use for DMA.
162 * I think this means that the memory has to map to
163 * contiguous pages of physical memory.
165 static struct snd_dma_buffer *get_dmabuf(struct snd_dma_buffer *buf,
169 if (snd_dma_alloc_pages_fallback(SNDRV_DMA_TYPE_DEV,
172 snd_printk(KERN_ERR "sscape: Failed to allocate "
173 "%lu bytes for DMA\n",
183 * Release the DMA-able kernel memory ...
185 static void free_dmabuf(struct snd_dma_buffer *buf)
187 if (buf && buf->area)
188 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,
199 outb(reg, ODIE_ADDR_IO(io_base));
200 outb(val, ODIE_DATA_IO(io_base));
204 * Write to the SoundScape's control registers, and do the
205 * necessary locking ...
207 static void sscape_write(struct soundscape *s, enum GA_REG reg,
212 spin_lock_irqsave(&s->lock, flags);
213 sscape_write_unsafe(s->io_base, reg, val);
214 spin_unlock_irqrestore(&s->lock, flags);
218 * Read from the SoundScape's control registers, but leave any
219 * locking to the caller. This is why the function is "unsafe" ...
221 static inline unsigned char sscape_read_unsafe(unsigned io_base,
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));
258 * Read the SoundScape's host-mode control register, performing
259 * a limited amount of busy-waiting if the register isn't ready.
260 * Also leaves all locking-issues to the caller ...
262 static int host_read_ctrl_unsafe(unsigned io_base, unsigned timeout)
266 while (((data = host_read_unsafe(io_base)) < 0) && (timeout != 0)) {
275 * Write to the SoundScape's host-mode control registers, but
276 * leave any locking issues to the caller ...
278 static inline int host_write_unsafe(unsigned io_base, unsigned char data)
280 if ((inb(HOST_CTRL_IO(io_base)) & TX_READY) != 0) {
281 outb(data, HOST_DATA_IO(io_base));
289 * Write to the SoundScape's host-mode control registers, performing
290 * a limited amount of busy-waiting if the register isn't ready.
291 * Also leaves all locking-issues to the caller ...
293 static int host_write_ctrl_unsafe(unsigned io_base, unsigned char data,
298 while (!(err = host_write_unsafe(io_base, data)) && (timeout != 0)) {
308 * Check that the MIDI subsystem is operational. If it isn't,
309 * then we will hang the computer if we try to use it ...
311 * NOTE: This check is based upon observation, not documentation.
313 static inline int verify_mpu401(const struct snd_mpu401 *mpu)
315 return ((inb(MPU401C(mpu)) & 0xc0) == 0x80);
319 * This is apparently the standard way to initailise an MPU-401
321 static inline void initialise_mpu401(const struct snd_mpu401 *mpu)
323 outb(0, MPU401D(mpu));
327 * Tell the SoundScape to activate the AD1845 chip (I think).
328 * The AD1845 detection fails if we *don't* do this, so I
329 * think that this is a good idea ...
331 static void activate_ad1845_unsafe(unsigned io_base)
333 unsigned char val = sscape_read_unsafe(io_base, GA_HMCTL_REG);
334 sscape_write_unsafe(io_base, GA_HMCTL_REG, (val & 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 void sscape_start_dma_unsafe(unsigned io_base, enum GA_REG reg)
355 sscape_write_unsafe(io_base, reg,
356 sscape_read_unsafe(io_base, reg) | 0x01);
357 sscape_write_unsafe(io_base, reg,
358 sscape_read_unsafe(io_base, reg) & 0xfe);
362 * Wait for a DMA transfer to complete. This is a "limited busy-wait",
363 * and all locking issues are left to the caller.
365 static int sscape_wait_dma_unsafe(unsigned io_base, enum GA_REG reg,
368 while (!(sscape_read_unsafe(io_base, reg) & 0x01) && (timeout != 0)) {
373 return sscape_read_unsafe(io_base, reg) & 0x01;
377 * Wait for the On-Board Processor to return its start-up
378 * acknowledgement sequence. This wait is too long for
379 * us to perform "busy-waiting", and so we must sleep.
380 * This in turn means that we must not be holding any
381 * spinlocks when we call this function.
383 static int obp_startup_ack(struct soundscape *s, unsigned timeout)
385 unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
391 spin_lock_irqsave(&s->lock, flags);
392 x = host_read_unsafe(s->io_base);
393 spin_unlock_irqrestore(&s->lock, flags);
394 if (x == 0xfe || x == 0xff)
398 } while (time_before(jiffies, end_time));
404 * Wait for the host to return its start-up acknowledgement
405 * sequence. This wait is too long for us to perform
406 * "busy-waiting", and so we must sleep. This in turn means
407 * that we must not be holding any spinlocks when we call
410 static int host_startup_ack(struct soundscape *s, unsigned timeout)
412 unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
418 spin_lock_irqsave(&s->lock, flags);
419 x = host_read_unsafe(s->io_base);
420 spin_unlock_irqrestore(&s->lock, flags);
425 } while (time_before(jiffies, end_time));
431 * Upload a byte-stream into the SoundScape using DMA channel A.
433 static int upload_dma_data(struct soundscape *s, const unsigned char *data,
437 struct snd_dma_buffer dma;
441 if (!get_dmabuf(&dma, PAGE_ALIGN(32 * 1024)))
444 spin_lock_irqsave(&s->lock, flags);
447 * Reset the board ...
449 val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
450 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val & 0x3f);
453 * Enable the DMA channels and configure them ...
455 val = (s->chip->dma1 << 4) | DMA_8BIT;
456 sscape_write_unsafe(s->io_base, GA_DMAA_REG, val);
457 sscape_write_unsafe(s->io_base, GA_DMAB_REG, 0x20);
460 * Take the board out of reset ...
462 val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
463 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val | 0x80);
466 * Upload the firmware to the SoundScape
467 * board through the DMA channel ...
472 len = min(size, dma.bytes);
473 memcpy(dma.area, data, len);
477 snd_dma_program(s->chip->dma1, dma.addr, len, DMA_MODE_WRITE);
478 sscape_start_dma_unsafe(s->io_base, GA_DMAA_REG);
479 if (!sscape_wait_dma_unsafe(s->io_base, GA_DMAA_REG, 5000)) {
481 * Don't forget to release this spinlock we're holding
483 spin_unlock_irqrestore(&s->lock, flags);
486 "sscape: DMA upload has timed out\n");
492 set_host_mode_unsafe(s->io_base);
493 outb(0x0, s->io_base);
496 * Boot the board ... (I think)
498 val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
499 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val | 0x40);
500 spin_unlock_irqrestore(&s->lock, flags);
503 * If all has gone well, then the board should acknowledge
504 * the new upload and tell us that it has rebooted OK. We
505 * give it 5 seconds (max) ...
508 if (!obp_startup_ack(s, 5000)) {
509 snd_printk(KERN_ERR "sscape: No response "
510 "from on-board processor after upload\n");
512 } else if (!host_startup_ack(s, 5000)) {
514 "sscape: SoundScape failed to initialise\n");
520 * NOTE!!! We are NOT holding any spinlocks at this point !!!
522 sscape_write(s, GA_DMAA_REG, (s->ic_type == IC_OPUS ? 0x40 : 0x70));
529 * Upload the bootblock(?) into the SoundScape. The only
530 * purpose of this block of code seems to be to tell
531 * us which version of the microcode we should be using.
533 static int sscape_upload_bootblock(struct snd_card *card)
535 struct soundscape *sscape = get_card_soundscape(card);
537 const struct firmware *init_fw = NULL;
541 ret = reject_firmware(&init_fw, "/*(DEBLOBBED)*/", card->dev);
543 snd_printk(KERN_ERR "sscape: Error loading /*(DEBLOBBED)*/");
546 ret = upload_dma_data(sscape, init_fw->data, init_fw->size);
548 release_firmware(init_fw);
550 spin_lock_irqsave(&sscape->lock, flags);
552 data = host_read_ctrl_unsafe(sscape->io_base, 100);
555 sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2f);
557 spin_unlock_irqrestore(&sscape->lock, flags);
560 if (ret == 0 && data > 7) {
562 "sscape: timeout reading firmware version\n");
566 return (ret == 0) ? data : ret;
570 * Upload the microcode into the SoundScape.
572 static int sscape_upload_microcode(struct snd_card *card, int version)
574 struct soundscape *sscape = get_card_soundscape(card);
575 const struct firmware *init_fw = NULL;
579 snprintf(name, sizeof(name), "/*(DEBLOBBED)*/", version);
581 err = reject_firmware(&init_fw, name, card->dev);
583 snd_printk(KERN_ERR "sscape: Error loading /*(DEBLOBBED)*/",
587 err = upload_dma_data(sscape, init_fw->data, init_fw->size);
589 snd_printk(KERN_INFO "sscape: MIDI firmware loaded %zu KBs\n",
590 init_fw->size >> 10);
592 release_firmware(init_fw);
598 * Mixer control for the SoundScape's MIDI device.
600 static int sscape_midi_info(struct snd_kcontrol *ctl,
601 struct snd_ctl_elem_info *uinfo)
603 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
605 uinfo->value.integer.min = 0;
606 uinfo->value.integer.max = 127;
610 static int sscape_midi_get(struct snd_kcontrol *kctl,
611 struct snd_ctl_elem_value *uctl)
613 struct snd_wss *chip = snd_kcontrol_chip(kctl);
614 struct snd_card *card = chip->card;
615 register struct soundscape *s = get_card_soundscape(card);
618 spin_lock_irqsave(&s->lock, flags);
619 uctl->value.integer.value[0] = s->midi_vol;
620 spin_unlock_irqrestore(&s->lock, flags);
624 static int sscape_midi_put(struct snd_kcontrol *kctl,
625 struct snd_ctl_elem_value *uctl)
627 struct snd_wss *chip = snd_kcontrol_chip(kctl);
628 struct snd_card *card = chip->card;
629 struct soundscape *s = get_card_soundscape(card);
632 unsigned char new_val;
634 spin_lock_irqsave(&s->lock, flags);
636 new_val = uctl->value.integer.value[0] & 127;
638 * We need to put the board into HOST mode before we
639 * can send any volume-changing HOST commands ...
641 set_host_mode_unsafe(s->io_base);
644 * To successfully change the MIDI volume setting, you seem to
645 * have to write a volume command, write the new volume value,
646 * and then perform another volume-related command. Perhaps the
647 * first command is an "open" and the second command is a "close"?
649 if (s->midi_vol == new_val) {
653 change = host_write_ctrl_unsafe(s->io_base, CMD_SET_MIDI_VOL, 100)
654 && host_write_ctrl_unsafe(s->io_base, new_val, 100)
655 && host_write_ctrl_unsafe(s->io_base, CMD_XXX_MIDI_VOL, 100)
656 && host_write_ctrl_unsafe(s->io_base, new_val, 100);
657 s->midi_vol = new_val;
661 * Take the board out of HOST mode and back into MIDI mode ...
663 set_midi_mode_unsafe(s->io_base);
665 spin_unlock_irqrestore(&s->lock, flags);
669 static struct snd_kcontrol_new midi_mixer_ctl = {
670 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
672 .info = sscape_midi_info,
673 .get = sscape_midi_get,
674 .put = sscape_midi_put
678 * The SoundScape can use two IRQs from a possible set of four.
679 * These IRQs are encoded as bit patterns so that they can be
680 * written to the control registers.
682 static unsigned get_irq_config(int sscape_type, int irq)
684 static const int valid_irq[] = { 9, 5, 7, 10 };
685 static const int old_irq[] = { 9, 7, 5, 15 };
688 if (sscape_type == MEDIA_FX) {
689 for (cfg = 0; cfg < ARRAY_SIZE(old_irq); ++cfg)
690 if (irq == old_irq[cfg])
693 for (cfg = 0; cfg < ARRAY_SIZE(valid_irq); ++cfg)
694 if (irq == valid_irq[cfg])
702 * Perform certain arcane port-checks to see whether there
703 * is a SoundScape board lurking behind the given ports.
705 static int detect_sscape(struct soundscape *s, long wss_io)
711 spin_lock_irqsave(&s->lock, flags);
714 * The following code is lifted from the original OSS driver,
715 * and as I don't have a datasheet I cannot really comment
716 * on what it is doing...
718 if ((inb(HOST_CTRL_IO(s->io_base)) & 0x78) != 0)
721 d = inb(ODIE_ADDR_IO(s->io_base)) & 0xf0;
726 s->ic_type = IC_ODIE;
727 else if ((d & 0x60) != 0)
728 s->ic_type = IC_OPUS;
732 outb(0xfa, ODIE_ADDR_IO(s->io_base));
733 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0a)
736 outb(0xfe, ODIE_ADDR_IO(s->io_base));
737 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0e)
740 outb(0xfe, ODIE_ADDR_IO(s->io_base));
741 d = inb(ODIE_DATA_IO(s->io_base));
742 if (s->type != SSCAPE_VIVO && (d & 0x9f) != 0x0e)
745 if (s->ic_type == IC_OPUS)
746 activate_ad1845_unsafe(s->io_base);
748 if (s->type == SSCAPE_VIVO)
751 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
752 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
754 /* wait for WSS codec */
755 for (d = 0; d < 500; d++) {
756 if ((inb(wss_io) & 0x80) == 0)
758 spin_unlock_irqrestore(&s->lock, flags);
760 spin_lock_irqsave(&s->lock, flags);
763 if ((inb(wss_io) & 0x80) != 0)
766 if (inb(wss_io + 2) == 0xff)
769 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f;
770 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d);
772 if ((inb(wss_io) & 0x80) != 0)
775 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
776 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
777 /* wait for WSS codec */
778 for (d = 0; d < 500; d++) {
779 if ((inb(wss_io) & 0x80) == 0)
781 spin_unlock_irqrestore(&s->lock, flags);
783 spin_lock_irqsave(&s->lock, flags);
787 * SoundScape successfully detected!
792 spin_unlock_irqrestore(&s->lock, flags);
797 * ALSA callback function, called when attempting to open the MIDI device.
798 * Check that the MIDI firmware has been loaded, because we don't want
799 * to crash the machine. Also check that someone isn't using the hardware
802 static int mpu401_open(struct snd_mpu401 *mpu)
804 if (!verify_mpu401(mpu)) {
805 snd_printk(KERN_ERR "sscape: MIDI disabled, "
806 "please load firmware\n");
814 * Initialse an MPU-401 subdevice for MIDI support on the SoundScape.
816 static int create_mpu401(struct snd_card *card, int devnum,
817 unsigned long port, int irq)
819 struct soundscape *sscape = get_card_soundscape(card);
820 struct snd_rawmidi *rawmidi;
823 err = snd_mpu401_uart_new(card, devnum, MPU401_HW_MPU401, port,
824 MPU401_INFO_INTEGRATED, irq, &rawmidi);
826 struct snd_mpu401 *mpu = rawmidi->private_data;
827 mpu->open_input = mpu401_open;
828 mpu->open_output = mpu401_open;
829 mpu->private_data = sscape;
831 initialise_mpu401(mpu);
839 * Create an AD1845 PCM subdevice on the SoundScape. The AD1845
840 * is very much like a CS4231, with a few extra bits. We will
841 * try to support at least some of the extra bits by overriding
842 * some of the CS4231 callback.
844 static int create_ad1845(struct snd_card *card, unsigned port,
845 int irq, int dma1, int dma2)
847 register struct soundscape *sscape = get_card_soundscape(card);
848 struct snd_wss *chip;
850 int codec_type = WSS_HW_DETECT;
852 switch (sscape->type) {
856 * There are some freak examples of early Soundscape cards
857 * with CS4231 instead of AD1848/CS4248. Unfortunately, the
858 * CS4231 works only in CS4248 compatibility mode on
859 * these cards so force it.
861 if (sscape->ic_type != IC_OPUS)
862 codec_type = WSS_HW_AD1848;
872 err = snd_wss_create(card, port, -1, irq, dma1, dma2,
873 codec_type, WSS_HWSHARE_DMA1, &chip);
877 if (sscape->type != SSCAPE_VIVO) {
879 * The input clock frequency on the SoundScape must
880 * be 14.31818 MHz, because we must set this register
881 * to get the playback to sound correct ...
883 snd_wss_mce_up(chip);
884 spin_lock_irqsave(&chip->reg_lock, flags);
885 snd_wss_out(chip, AD1845_CLOCK, 0x20);
886 spin_unlock_irqrestore(&chip->reg_lock, flags);
887 snd_wss_mce_down(chip);
891 err = snd_wss_pcm(chip, 0);
893 snd_printk(KERN_ERR "sscape: No PCM device "
894 "for AD1845 chip\n");
898 err = snd_wss_mixer(chip);
900 snd_printk(KERN_ERR "sscape: No mixer device "
901 "for AD1845 chip\n");
904 if (chip->hardware != WSS_HW_AD1848) {
905 err = snd_wss_timer(chip, 0);
907 snd_printk(KERN_ERR "sscape: No timer device "
908 "for AD1845 chip\n");
913 if (sscape->type != SSCAPE_VIVO) {
914 err = snd_ctl_add(card,
915 snd_ctl_new1(&midi_mixer_ctl, chip));
917 snd_printk(KERN_ERR "sscape: Could not create "
918 "MIDI mixer control\n");
932 * Create an ALSA soundcard entry for the SoundScape, using
933 * the given list of port, IRQ and DMA resources.
935 static int create_sscape(int dev, struct snd_card *card)
937 struct soundscape *sscape = get_card_soundscape(card);
940 unsigned mpu_irq_cfg;
941 struct resource *io_res;
942 struct resource *wss_res;
949 * Grab IO ports that we will need to probe so that we
950 * can detect and control this hardware ...
952 io_res = request_region(port[dev], 8, "SoundScape");
955 "sscape: can't grab port 0x%lx\n", port[dev]);
959 if (sscape->type == SSCAPE_VIVO) {
960 wss_res = request_region(wss_port[dev], 4, "SoundScape");
962 snd_printk(KERN_ERR "sscape: can't grab port 0x%lx\n",
965 goto _release_region;
970 * Grab one DMA channel ...
972 err = request_dma(dma[dev], "SoundScape");
974 snd_printk(KERN_ERR "sscape: can't grab DMA %d\n", dma[dev]);
975 goto _release_region;
978 spin_lock_init(&sscape->lock);
979 sscape->io_res = io_res;
980 sscape->wss_res = wss_res;
981 sscape->io_base = port[dev];
983 if (!detect_sscape(sscape, wss_port[dev])) {
984 printk(KERN_ERR "sscape: hardware not detected at 0x%x\n",
990 switch (sscape->type) {
992 name = "MediaFX/SoundFX";
998 name = "Soundscape PnP";
1001 name = "Soundscape VIVO";
1004 name = "unknown Soundscape";
1008 printk(KERN_INFO "sscape: %s card detected at 0x%x, using IRQ %d, DMA %d\n",
1009 name, sscape->io_base, irq[dev], dma[dev]);
1012 * Check that the user didn't pass us garbage data ...
1014 irq_cfg = get_irq_config(sscape->type, irq[dev]);
1015 if (irq_cfg == INVALID_IRQ) {
1016 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", irq[dev]);
1021 mpu_irq_cfg = get_irq_config(sscape->type, mpu_irq[dev]);
1022 if (mpu_irq_cfg == INVALID_IRQ) {
1023 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", mpu_irq[dev]);
1029 * Tell the on-board devices where their resources are (I think -
1030 * I can't be sure without a datasheet ... So many magic values!)
1032 spin_lock_irqsave(&sscape->lock, flags);
1034 sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2e);
1035 sscape_write_unsafe(sscape->io_base, GA_SMCFGB_REG, 0x00);
1038 * Enable and configure the DMA channels ...
1040 sscape_write_unsafe(sscape->io_base, GA_DMACFG_REG, 0x50);
1041 dma_cfg = (sscape->ic_type == IC_OPUS ? 0x40 : 0x70);
1042 sscape_write_unsafe(sscape->io_base, GA_DMAA_REG, dma_cfg);
1043 sscape_write_unsafe(sscape->io_base, GA_DMAB_REG, 0x20);
1045 mpu_irq_cfg |= mpu_irq_cfg << 2;
1046 val = sscape_read_unsafe(sscape->io_base, GA_HMCTL_REG) & 0xF7;
1049 sscape_write_unsafe(sscape->io_base, GA_HMCTL_REG, val | 0x10);
1050 sscape_write_unsafe(sscape->io_base, GA_INTCFG_REG, 0xf0 | mpu_irq_cfg);
1051 sscape_write_unsafe(sscape->io_base,
1052 GA_CDCFG_REG, 0x09 | DMA_8BIT
1053 | (dma[dev] << 4) | (irq_cfg << 1));
1055 * Enable the master IRQ ...
1057 sscape_write_unsafe(sscape->io_base, GA_INTENA_REG, 0x80);
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",
1099 spin_lock_irqsave(&sscape->lock, flags);
1100 sscape->midi_vol = 0;
1101 host_write_ctrl_unsafe(sscape->io_base,
1102 CMD_SET_MIDI_VOL, 100);
1103 host_write_ctrl_unsafe(sscape->io_base,
1104 sscape->midi_vol, 100);
1105 host_write_ctrl_unsafe(sscape->io_base,
1106 CMD_XXX_MIDI_VOL, 100);
1107 host_write_ctrl_unsafe(sscape->io_base,
1108 sscape->midi_vol, 100);
1109 host_write_ctrl_unsafe(sscape->io_base,
1110 CMD_SET_EXTMIDI, 100);
1111 host_write_ctrl_unsafe(sscape->io_base,
1113 host_write_ctrl_unsafe(sscape->io_base, CMD_ACK, 100);
1115 set_midi_mode_unsafe(sscape->io_base);
1116 spin_unlock_irqrestore(&sscape->lock, flags);
1121 * Now that we have successfully created this sound card,
1122 * it is safe to store the pointer.
1123 * NOTE: we only register the sound card's "destructor"
1124 * function now that our "constructor" has completed.
1126 card->private_free = soundscape_free;
1134 release_and_free_resource(wss_res);
1135 release_and_free_resource(io_res);
1141 static int snd_sscape_match(struct device *pdev, unsigned int i)
1144 * Make sure we were given ALL of the other parameters.
1146 if (port[i] == SNDRV_AUTO_PORT)
1149 if (irq[i] == SNDRV_AUTO_IRQ ||
1150 mpu_irq[i] == SNDRV_AUTO_IRQ ||
1151 dma[i] == SNDRV_AUTO_DMA) {
1153 "sscape: insufficient parameters, "
1154 "need IO, IRQ, MPU-IRQ and DMA\n");
1161 static int snd_sscape_probe(struct device *pdev, unsigned int dev)
1163 struct snd_card *card;
1164 struct soundscape *sscape;
1167 ret = snd_card_new(pdev, index[dev], id[dev], THIS_MODULE,
1168 sizeof(struct soundscape), &card);
1172 sscape = get_card_soundscape(card);
1173 sscape->type = SSCAPE;
1177 ret = create_sscape(dev, card);
1181 ret = snd_card_register(card);
1183 snd_printk(KERN_ERR "sscape: Failed to register sound card\n");
1186 dev_set_drvdata(pdev, card);
1190 snd_card_free(card);
1194 static int snd_sscape_remove(struct device *devptr, unsigned int dev)
1196 snd_card_free(dev_get_drvdata(devptr));
1200 #define DEV_NAME "sscape"
1202 static struct isa_driver snd_sscape_driver = {
1203 .match = snd_sscape_match,
1204 .probe = snd_sscape_probe,
1205 .remove = snd_sscape_remove,
1206 /* FIXME: suspend/resume */
1213 static inline int get_next_autoindex(int i)
1215 while (i < SNDRV_CARDS && port[i] != SNDRV_AUTO_PORT)
1221 static int sscape_pnp_detect(struct pnp_card_link *pcard,
1222 const struct pnp_card_device_id *pid)
1225 struct pnp_dev *dev;
1226 struct snd_card *card;
1227 struct soundscape *sscape;
1231 * Allow this function to fail *quietly* if all the ISA PnP
1232 * devices were configured using module parameters instead.
1234 idx = get_next_autoindex(idx);
1235 if (idx >= SNDRV_CARDS)
1239 * Check that we still have room for another sound card ...
1241 dev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
1245 if (!pnp_is_active(dev)) {
1246 if (pnp_activate_dev(dev) < 0) {
1247 snd_printk(KERN_INFO "sscape: device is inactive\n");
1253 * Create a new ALSA sound card entry, in anticipation
1254 * of detecting our hardware ...
1256 ret = snd_card_new(&pcard->card->dev,
1257 index[idx], id[idx], THIS_MODULE,
1258 sizeof(struct soundscape), &card);
1262 sscape = get_card_soundscape(card);
1265 * Identify card model ...
1267 if (!strncmp("ENS4081", pid->id, 7))
1268 sscape->type = SSCAPE_VIVO;
1270 sscape->type = SSCAPE_PNP;
1273 * Read the correct parameters off the ISA PnP bus ...
1275 port[idx] = pnp_port_start(dev, 0);
1276 irq[idx] = pnp_irq(dev, 0);
1277 mpu_irq[idx] = pnp_irq(dev, 1);
1278 dma[idx] = pnp_dma(dev, 0) & 0x03;
1279 if (sscape->type == SSCAPE_PNP) {
1280 dma2[idx] = dma[idx];
1281 wss_port[idx] = CODEC_IO(port[idx]);
1283 wss_port[idx] = pnp_port_start(dev, 1);
1284 dma2[idx] = pnp_dma(dev, 1);
1287 ret = create_sscape(idx, card);
1291 ret = snd_card_register(card);
1293 snd_printk(KERN_ERR "sscape: Failed to register sound card\n");
1297 pnp_set_card_drvdata(pcard, card);
1302 snd_card_free(card);
1306 static void sscape_pnp_remove(struct pnp_card_link *pcard)
1308 snd_card_free(pnp_get_card_drvdata(pcard));
1309 pnp_set_card_drvdata(pcard, NULL);
1312 static struct pnp_card_driver sscape_pnpc_driver = {
1313 .flags = PNP_DRIVER_RES_DO_NOT_CHANGE,
1315 .id_table = sscape_pnpids,
1316 .probe = sscape_pnp_detect,
1317 .remove = sscape_pnp_remove,
1320 #endif /* CONFIG_PNP */
1322 static int __init sscape_init(void)
1326 err = isa_register_driver(&snd_sscape_driver, SNDRV_CARDS);
1331 err = pnp_register_card_driver(&sscape_pnpc_driver);
1341 static void __exit sscape_exit(void)
1345 pnp_unregister_card_driver(&sscape_pnpc_driver);
1348 isa_unregister_driver(&snd_sscape_driver);
1351 module_init(sscape_init);
1352 module_exit(sscape_exit);