Add linux-next specific files for 20110716
[linux-2.6/next.git] / sound / isa / sscape.c
blobe2d5d2d3ed96472c30a09c302e4a65442624d4f6
1 /*
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>
32 #include <asm/dma.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] = SNDRV_DEFAULT_IDX;
50 static char* id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
51 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
52 static long wss_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
53 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;
54 static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;
55 static int dma[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;
56 static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;
57 static bool joystick[SNDRV_CARDS];
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.");
86 #ifdef CONFIG_PNP
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);
97 #endif
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)
106 #define IC_ODIE 1
107 #define IC_OPUS 2
109 #define RX_READY 0x01
110 #define TX_READY 0x02
112 #define CMD_ACK 0x80
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
121 enum GA_REG {
122 GA_INTSTAT_REG = 0,
123 GA_INTENA_REG,
124 GA_DMAA_REG,
125 GA_DMAB_REG,
126 GA_INTCFG_REG,
127 GA_DMACFG_REG,
128 GA_CDCFG_REG,
129 GA_SMCFGA_REG,
130 GA_SMCFGB_REG,
131 GA_HMCTL_REG
134 #define DMA_8BIT 0x80
137 enum card_type {
138 MEDIA_FX, /* Sequoia S-1000 */
139 SSCAPE, /* Sequoia S-2000 */
140 SSCAPE_PNP,
141 SSCAPE_VIVO,
144 struct soundscape {
145 spinlock_t lock;
146 unsigned io_base;
147 int ic_type;
148 enum card_type type;
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,
170 unsigned long size)
172 if (buf) {
173 if (snd_dma_alloc_pages_fallback(SNDRV_DMA_TYPE_DEV,
174 snd_dma_isa_data(),
175 size, buf) < 0) {
176 snd_printk(KERN_ERR "sscape: Failed to allocate "
177 "%lu bytes for DMA\n",
178 size);
179 return NULL;
183 return buf;
187 * Release the DMA-able kernel memory ...
189 static void free_dmabuf(struct snd_dma_buffer *buf)
191 if (buf && buf->area)
192 snd_dma_free_pages(buf);
196 * This function writes to the SoundScape's control registers,
197 * but doesn't do any locking. It's up to the caller to do that.
198 * This is why this function is "unsafe" ...
200 static inline void sscape_write_unsafe(unsigned io_base, enum GA_REG reg,
201 unsigned char val)
203 outb(reg, ODIE_ADDR_IO(io_base));
204 outb(val, ODIE_DATA_IO(io_base));
208 * Write to the SoundScape's control registers, and do the
209 * necessary locking ...
211 static void sscape_write(struct soundscape *s, enum GA_REG reg,
212 unsigned char val)
214 unsigned long flags;
216 spin_lock_irqsave(&s->lock, flags);
217 sscape_write_unsafe(s->io_base, reg, val);
218 spin_unlock_irqrestore(&s->lock, flags);
222 * Read from the SoundScape's control registers, but leave any
223 * locking to the caller. This is why the function is "unsafe" ...
225 static inline unsigned char sscape_read_unsafe(unsigned io_base,
226 enum GA_REG reg)
228 outb(reg, ODIE_ADDR_IO(io_base));
229 return inb(ODIE_DATA_IO(io_base));
233 * Puts the SoundScape into "host" mode, as compared to "MIDI" mode
235 static inline void set_host_mode_unsafe(unsigned io_base)
237 outb(0x0, HOST_CTRL_IO(io_base));
241 * Puts the SoundScape into "MIDI" mode, as compared to "host" mode
243 static inline void set_midi_mode_unsafe(unsigned io_base)
245 outb(0x3, HOST_CTRL_IO(io_base));
249 * Read the SoundScape's host-mode control register, but leave
250 * any locking issues to the caller ...
252 static inline int host_read_unsafe(unsigned io_base)
254 int data = -1;
255 if ((inb(HOST_CTRL_IO(io_base)) & RX_READY) != 0)
256 data = inb(HOST_DATA_IO(io_base));
258 return data;
262 * Read the SoundScape's host-mode control register, performing
263 * a limited amount of busy-waiting if the register isn't ready.
264 * Also leaves all locking-issues to the caller ...
266 static int host_read_ctrl_unsafe(unsigned io_base, unsigned timeout)
268 int data;
270 while (((data = host_read_unsafe(io_base)) < 0) && (timeout != 0)) {
271 udelay(100);
272 --timeout;
273 } /* while */
275 return data;
279 * Write to the SoundScape's host-mode control registers, but
280 * leave any locking issues to the caller ...
282 static inline int host_write_unsafe(unsigned io_base, unsigned char data)
284 if ((inb(HOST_CTRL_IO(io_base)) & TX_READY) != 0) {
285 outb(data, HOST_DATA_IO(io_base));
286 return 1;
289 return 0;
293 * Write to the SoundScape's host-mode control registers, performing
294 * a limited amount of busy-waiting if the register isn't ready.
295 * Also leaves all locking-issues to the caller ...
297 static int host_write_ctrl_unsafe(unsigned io_base, unsigned char data,
298 unsigned timeout)
300 int err;
302 while (!(err = host_write_unsafe(io_base, data)) && (timeout != 0)) {
303 udelay(100);
304 --timeout;
305 } /* while */
307 return err;
312 * Check that the MIDI subsystem is operational. If it isn't,
313 * then we will hang the computer if we try to use it ...
315 * NOTE: This check is based upon observation, not documentation.
317 static inline int verify_mpu401(const struct snd_mpu401 *mpu)
319 return ((inb(MPU401C(mpu)) & 0xc0) == 0x80);
323 * This is apparently the standard way to initailise an MPU-401
325 static inline void initialise_mpu401(const struct snd_mpu401 *mpu)
327 outb(0, MPU401D(mpu));
331 * Tell the SoundScape to activate the AD1845 chip (I think).
332 * The AD1845 detection fails if we *don't* do this, so I
333 * think that this is a good idea ...
335 static void activate_ad1845_unsafe(unsigned io_base)
337 unsigned char val = sscape_read_unsafe(io_base, GA_HMCTL_REG);
338 sscape_write_unsafe(io_base, GA_HMCTL_REG, (val & 0xcf) | 0x10);
339 sscape_write_unsafe(io_base, GA_CDCFG_REG, 0x80);
343 * Do the necessary ALSA-level cleanup to deallocate our driver ...
345 static void soundscape_free(struct snd_card *c)
347 struct soundscape *sscape = get_card_soundscape(c);
348 release_and_free_resource(sscape->io_res);
349 release_and_free_resource(sscape->wss_res);
350 free_dma(sscape->chip->dma1);
354 * Tell the SoundScape to begin a DMA tranfer using the given channel.
355 * All locking issues are left to the caller.
357 static void sscape_start_dma_unsafe(unsigned io_base, enum GA_REG reg)
359 sscape_write_unsafe(io_base, reg,
360 sscape_read_unsafe(io_base, reg) | 0x01);
361 sscape_write_unsafe(io_base, reg,
362 sscape_read_unsafe(io_base, reg) & 0xfe);
366 * Wait for a DMA transfer to complete. This is a "limited busy-wait",
367 * and all locking issues are left to the caller.
369 static int sscape_wait_dma_unsafe(unsigned io_base, enum GA_REG reg,
370 unsigned timeout)
372 while (!(sscape_read_unsafe(io_base, reg) & 0x01) && (timeout != 0)) {
373 udelay(100);
374 --timeout;
375 } /* while */
377 return sscape_read_unsafe(io_base, reg) & 0x01;
381 * Wait for the On-Board Processor to return its start-up
382 * acknowledgement sequence. This wait is too long for
383 * us to perform "busy-waiting", and so we must sleep.
384 * This in turn means that we must not be holding any
385 * spinlocks when we call this function.
387 static int obp_startup_ack(struct soundscape *s, unsigned timeout)
389 unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
391 do {
392 unsigned long flags;
393 int x;
395 spin_lock_irqsave(&s->lock, flags);
396 x = host_read_unsafe(s->io_base);
397 spin_unlock_irqrestore(&s->lock, flags);
398 if (x == 0xfe || x == 0xff)
399 return 1;
401 msleep(10);
402 } while (time_before(jiffies, end_time));
404 return 0;
408 * Wait for the host to return its start-up acknowledgement
409 * sequence. This wait is too long for us to perform
410 * "busy-waiting", and so we must sleep. This in turn means
411 * that we must not be holding any spinlocks when we call
412 * this function.
414 static int host_startup_ack(struct soundscape *s, unsigned timeout)
416 unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
418 do {
419 unsigned long flags;
420 int x;
422 spin_lock_irqsave(&s->lock, flags);
423 x = host_read_unsafe(s->io_base);
424 spin_unlock_irqrestore(&s->lock, flags);
425 if (x == 0xfe)
426 return 1;
428 msleep(10);
429 } while (time_before(jiffies, end_time));
431 return 0;
435 * Upload a byte-stream into the SoundScape using DMA channel A.
437 static int upload_dma_data(struct soundscape *s, const unsigned char *data,
438 size_t size)
440 unsigned long flags;
441 struct snd_dma_buffer dma;
442 int ret;
443 unsigned char val;
445 if (!get_dmabuf(&dma, PAGE_ALIGN(32 * 1024)))
446 return -ENOMEM;
448 spin_lock_irqsave(&s->lock, flags);
451 * Reset the board ...
453 val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
454 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val & 0x3f);
457 * Enable the DMA channels and configure them ...
459 val = (s->chip->dma1 << 4) | DMA_8BIT;
460 sscape_write_unsafe(s->io_base, GA_DMAA_REG, val);
461 sscape_write_unsafe(s->io_base, GA_DMAB_REG, 0x20);
464 * Take the board out of reset ...
466 val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
467 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val | 0x80);
470 * Upload the firmware to the SoundScape
471 * board through the DMA channel ...
473 while (size != 0) {
474 unsigned long len;
476 len = min(size, dma.bytes);
477 memcpy(dma.area, data, len);
478 data += len;
479 size -= len;
481 snd_dma_program(s->chip->dma1, dma.addr, len, DMA_MODE_WRITE);
482 sscape_start_dma_unsafe(s->io_base, GA_DMAA_REG);
483 if (!sscape_wait_dma_unsafe(s->io_base, GA_DMAA_REG, 5000)) {
485 * Don't forget to release this spinlock we're holding
487 spin_unlock_irqrestore(&s->lock, flags);
489 snd_printk(KERN_ERR
490 "sscape: DMA upload has timed out\n");
491 ret = -EAGAIN;
492 goto _release_dma;
494 } /* while */
496 set_host_mode_unsafe(s->io_base);
497 outb(0x0, s->io_base);
500 * Boot the board ... (I think)
502 val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
503 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val | 0x40);
504 spin_unlock_irqrestore(&s->lock, flags);
507 * If all has gone well, then the board should acknowledge
508 * the new upload and tell us that it has rebooted OK. We
509 * give it 5 seconds (max) ...
511 ret = 0;
512 if (!obp_startup_ack(s, 5000)) {
513 snd_printk(KERN_ERR "sscape: No response "
514 "from on-board processor after upload\n");
515 ret = -EAGAIN;
516 } else if (!host_startup_ack(s, 5000)) {
517 snd_printk(KERN_ERR
518 "sscape: SoundScape failed to initialise\n");
519 ret = -EAGAIN;
522 _release_dma:
524 * NOTE!!! We are NOT holding any spinlocks at this point !!!
526 sscape_write(s, GA_DMAA_REG, (s->ic_type == IC_OPUS ? 0x40 : 0x70));
527 free_dmabuf(&dma);
529 return ret;
533 * Upload the bootblock(?) into the SoundScape. The only
534 * purpose of this block of code seems to be to tell
535 * us which version of the microcode we should be using.
537 static int sscape_upload_bootblock(struct snd_card *card)
539 struct soundscape *sscape = get_card_soundscape(card);
540 unsigned long flags;
541 const struct firmware *init_fw = NULL;
542 int data = 0;
543 int ret;
545 ret = request_firmware(&init_fw, "scope.cod", card->dev);
546 if (ret < 0) {
547 snd_printk(KERN_ERR "sscape: Error loading scope.cod");
548 return ret;
550 ret = upload_dma_data(sscape, init_fw->data, init_fw->size);
552 release_firmware(init_fw);
554 spin_lock_irqsave(&sscape->lock, flags);
555 if (ret == 0)
556 data = host_read_ctrl_unsafe(sscape->io_base, 100);
558 if (data & 0x10)
559 sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2f);
561 spin_unlock_irqrestore(&sscape->lock, flags);
563 data &= 0xf;
564 if (ret == 0 && data > 7) {
565 snd_printk(KERN_ERR
566 "sscape: timeout reading firmware version\n");
567 ret = -EAGAIN;
570 return (ret == 0) ? data : ret;
574 * Upload the microcode into the SoundScape.
576 static int sscape_upload_microcode(struct snd_card *card, int version)
578 struct soundscape *sscape = get_card_soundscape(card);
579 const struct firmware *init_fw = NULL;
580 char name[14];
581 int err;
583 snprintf(name, sizeof(name), "sndscape.co%d", version);
585 err = request_firmware(&init_fw, name, card->dev);
586 if (err < 0) {
587 snd_printk(KERN_ERR "sscape: Error loading sndscape.co%d",
588 version);
589 return err;
591 err = upload_dma_data(sscape, init_fw->data, init_fw->size);
592 if (err == 0)
593 snd_printk(KERN_INFO "sscape: MIDI firmware loaded %d KBs\n",
594 init_fw->size >> 10);
596 release_firmware(init_fw);
598 return err;
602 * Mixer control for the SoundScape's MIDI device.
604 static int sscape_midi_info(struct snd_kcontrol *ctl,
605 struct snd_ctl_elem_info *uinfo)
607 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
608 uinfo->count = 1;
609 uinfo->value.integer.min = 0;
610 uinfo->value.integer.max = 127;
611 return 0;
614 static int sscape_midi_get(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);
620 unsigned long flags;
622 spin_lock_irqsave(&s->lock, flags);
623 uctl->value.integer.value[0] = s->midi_vol;
624 spin_unlock_irqrestore(&s->lock, flags);
625 return 0;
628 static int sscape_midi_put(struct snd_kcontrol *kctl,
629 struct snd_ctl_elem_value *uctl)
631 struct snd_wss *chip = snd_kcontrol_chip(kctl);
632 struct snd_card *card = chip->card;
633 struct soundscape *s = get_card_soundscape(card);
634 unsigned long flags;
635 int change;
636 unsigned char new_val;
638 spin_lock_irqsave(&s->lock, flags);
640 new_val = uctl->value.integer.value[0] & 127;
642 * We need to put the board into HOST mode before we
643 * can send any volume-changing HOST commands ...
645 set_host_mode_unsafe(s->io_base);
648 * To successfully change the MIDI volume setting, you seem to
649 * have to write a volume command, write the new volume value,
650 * and then perform another volume-related command. Perhaps the
651 * first command is an "open" and the second command is a "close"?
653 if (s->midi_vol == new_val) {
654 change = 0;
655 goto __skip_change;
657 change = host_write_ctrl_unsafe(s->io_base, CMD_SET_MIDI_VOL, 100)
658 && host_write_ctrl_unsafe(s->io_base, new_val, 100)
659 && host_write_ctrl_unsafe(s->io_base, CMD_XXX_MIDI_VOL, 100)
660 && host_write_ctrl_unsafe(s->io_base, new_val, 100);
661 s->midi_vol = new_val;
662 __skip_change:
665 * Take the board out of HOST mode and back into MIDI mode ...
667 set_midi_mode_unsafe(s->io_base);
669 spin_unlock_irqrestore(&s->lock, flags);
670 return change;
673 static struct snd_kcontrol_new midi_mixer_ctl = {
674 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
675 .name = "MIDI",
676 .info = sscape_midi_info,
677 .get = sscape_midi_get,
678 .put = sscape_midi_put
682 * The SoundScape can use two IRQs from a possible set of four.
683 * These IRQs are encoded as bit patterns so that they can be
684 * written to the control registers.
686 static unsigned __devinit get_irq_config(int sscape_type, int irq)
688 static const int valid_irq[] = { 9, 5, 7, 10 };
689 static const int old_irq[] = { 9, 7, 5, 15 };
690 unsigned cfg;
692 if (sscape_type == MEDIA_FX) {
693 for (cfg = 0; cfg < ARRAY_SIZE(old_irq); ++cfg)
694 if (irq == old_irq[cfg])
695 return cfg;
696 } else {
697 for (cfg = 0; cfg < ARRAY_SIZE(valid_irq); ++cfg)
698 if (irq == valid_irq[cfg])
699 return cfg;
702 return INVALID_IRQ;
706 * Perform certain arcane port-checks to see whether there
707 * is a SoundScape board lurking behind the given ports.
709 static int __devinit detect_sscape(struct soundscape *s, long wss_io)
711 unsigned long flags;
712 unsigned d;
713 int retval = 0;
715 spin_lock_irqsave(&s->lock, flags);
718 * The following code is lifted from the original OSS driver,
719 * and as I don't have a datasheet I cannot really comment
720 * on what it is doing...
722 if ((inb(HOST_CTRL_IO(s->io_base)) & 0x78) != 0)
723 goto _done;
725 d = inb(ODIE_ADDR_IO(s->io_base)) & 0xf0;
726 if ((d & 0x80) != 0)
727 goto _done;
729 if (d == 0)
730 s->ic_type = IC_ODIE;
731 else if ((d & 0x60) != 0)
732 s->ic_type = IC_OPUS;
733 else
734 goto _done;
736 outb(0xfa, ODIE_ADDR_IO(s->io_base));
737 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0a)
738 goto _done;
740 outb(0xfe, ODIE_ADDR_IO(s->io_base));
741 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0e)
742 goto _done;
744 outb(0xfe, ODIE_ADDR_IO(s->io_base));
745 d = inb(ODIE_DATA_IO(s->io_base));
746 if (s->type != SSCAPE_VIVO && (d & 0x9f) != 0x0e)
747 goto _done;
749 if (s->ic_type == IC_OPUS)
750 activate_ad1845_unsafe(s->io_base);
752 if (s->type == SSCAPE_VIVO)
753 wss_io += 4;
755 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
756 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
758 /* wait for WSS codec */
759 for (d = 0; d < 500; d++) {
760 if ((inb(wss_io) & 0x80) == 0)
761 break;
762 spin_unlock_irqrestore(&s->lock, flags);
763 msleep(1);
764 spin_lock_irqsave(&s->lock, flags);
767 if ((inb(wss_io) & 0x80) != 0)
768 goto _done;
770 if (inb(wss_io + 2) == 0xff)
771 goto _done;
773 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f;
774 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d);
776 if ((inb(wss_io) & 0x80) != 0)
777 s->type = MEDIA_FX;
779 d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
780 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
781 /* wait for WSS codec */
782 for (d = 0; d < 500; d++) {
783 if ((inb(wss_io) & 0x80) == 0)
784 break;
785 spin_unlock_irqrestore(&s->lock, flags);
786 msleep(1);
787 spin_lock_irqsave(&s->lock, flags);
791 * SoundScape successfully detected!
793 retval = 1;
795 _done:
796 spin_unlock_irqrestore(&s->lock, flags);
797 return retval;
801 * ALSA callback function, called when attempting to open the MIDI device.
802 * Check that the MIDI firmware has been loaded, because we don't want
803 * to crash the machine. Also check that someone isn't using the hardware
804 * IOCTL device.
806 static int mpu401_open(struct snd_mpu401 *mpu)
808 if (!verify_mpu401(mpu)) {
809 snd_printk(KERN_ERR "sscape: MIDI disabled, "
810 "please load firmware\n");
811 return -ENODEV;
814 return 0;
818 * Initialse an MPU-401 subdevice for MIDI support on the SoundScape.
820 static int __devinit create_mpu401(struct snd_card *card, int devnum,
821 unsigned long port, int irq)
823 struct soundscape *sscape = get_card_soundscape(card);
824 struct snd_rawmidi *rawmidi;
825 int err;
827 err = snd_mpu401_uart_new(card, devnum, MPU401_HW_MPU401, port,
828 MPU401_INFO_INTEGRATED, irq, IRQF_DISABLED,
829 &rawmidi);
830 if (err == 0) {
831 struct snd_mpu401 *mpu = rawmidi->private_data;
832 mpu->open_input = mpu401_open;
833 mpu->open_output = mpu401_open;
834 mpu->private_data = sscape;
836 initialise_mpu401(mpu);
839 return err;
844 * Create an AD1845 PCM subdevice on the SoundScape. The AD1845
845 * is very much like a CS4231, with a few extra bits. We will
846 * try to support at least some of the extra bits by overriding
847 * some of the CS4231 callback.
849 static int __devinit create_ad1845(struct snd_card *card, unsigned port,
850 int irq, int dma1, int dma2)
852 register struct soundscape *sscape = get_card_soundscape(card);
853 struct snd_wss *chip;
854 int err;
855 int codec_type = WSS_HW_DETECT;
857 switch (sscape->type) {
858 case MEDIA_FX:
859 case SSCAPE:
861 * There are some freak examples of early Soundscape cards
862 * with CS4231 instead of AD1848/CS4248. Unfortunately, the
863 * CS4231 works only in CS4248 compatibility mode on
864 * these cards so force it.
866 if (sscape->ic_type != IC_OPUS)
867 codec_type = WSS_HW_AD1848;
868 break;
870 case SSCAPE_VIVO:
871 port += 4;
872 break;
873 default:
874 break;
877 err = snd_wss_create(card, port, -1, irq, dma1, dma2,
878 codec_type, WSS_HWSHARE_DMA1, &chip);
879 if (!err) {
880 unsigned long flags;
881 struct snd_pcm *pcm;
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, &pcm);
898 if (err < 0) {
899 snd_printk(KERN_ERR "sscape: No PCM device "
900 "for AD1845 chip\n");
901 goto _error;
904 err = snd_wss_mixer(chip);
905 if (err < 0) {
906 snd_printk(KERN_ERR "sscape: No mixer device "
907 "for AD1845 chip\n");
908 goto _error;
910 if (chip->hardware != WSS_HW_AD1848) {
911 err = snd_wss_timer(chip, 0, NULL);
912 if (err < 0) {
913 snd_printk(KERN_ERR "sscape: No timer device "
914 "for AD1845 chip\n");
915 goto _error;
919 if (sscape->type != SSCAPE_VIVO) {
920 err = snd_ctl_add(card,
921 snd_ctl_new1(&midi_mixer_ctl, chip));
922 if (err < 0) {
923 snd_printk(KERN_ERR "sscape: Could not create "
924 "MIDI mixer control\n");
925 goto _error;
929 sscape->chip = chip;
932 _error:
933 return err;
938 * Create an ALSA soundcard entry for the SoundScape, using
939 * the given list of port, IRQ and DMA resources.
941 static int __devinit create_sscape(int dev, struct snd_card *card)
943 struct soundscape *sscape = get_card_soundscape(card);
944 unsigned dma_cfg;
945 unsigned irq_cfg;
946 unsigned mpu_irq_cfg;
947 struct resource *io_res;
948 struct resource *wss_res;
949 unsigned long flags;
950 int err;
951 int val;
952 const char *name;
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");
959 if (!io_res) {
960 snd_printk(KERN_ERR
961 "sscape: can't grab port 0x%lx\n", port[dev]);
962 return -EBUSY;
964 wss_res = NULL;
965 if (sscape->type == SSCAPE_VIVO) {
966 wss_res = request_region(wss_port[dev], 4, "SoundScape");
967 if (!wss_res) {
968 snd_printk(KERN_ERR "sscape: can't grab port 0x%lx\n",
969 wss_port[dev]);
970 err = -EBUSY;
971 goto _release_region;
976 * Grab one DMA channel ...
978 err = request_dma(dma[dev], "SoundScape");
979 if (err < 0) {
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",
991 sscape->io_base);
992 err = -ENODEV;
993 goto _release_dma;
996 switch (sscape->type) {
997 case MEDIA_FX:
998 name = "MediaFX/SoundFX";
999 break;
1000 case SSCAPE:
1001 name = "Soundscape";
1002 break;
1003 case SSCAPE_PNP:
1004 name = "Soundscape PnP";
1005 break;
1006 case SSCAPE_VIVO:
1007 name = "Soundscape VIVO";
1008 break;
1009 default:
1010 name = "unknown Soundscape";
1011 break;
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]);
1023 return -ENXIO;
1026 mpu_irq_cfg = get_irq_config(sscape->type, mpu_irq[dev]);
1027 if (mpu_irq_cfg == INVALID_IRQ) {
1028 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", mpu_irq[dev]);
1029 return -ENXIO;
1033 * Tell the on-board devices where their resources are (I think -
1034 * I can't be sure without a datasheet ... So many magic values!)
1036 spin_lock_irqsave(&sscape->lock, flags);
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;
1051 if (joystick[dev])
1052 val |= 8;
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 * Enable the master IRQ ...
1061 sscape_write_unsafe(sscape->io_base, GA_INTENA_REG, 0x80);
1063 spin_unlock_irqrestore(&sscape->lock, flags);
1066 * We have now enabled the codec chip, and so we should
1067 * detect the AD1845 device ...
1069 err = create_ad1845(card, wss_port[dev], irq[dev],
1070 dma[dev], dma2[dev]);
1071 if (err < 0) {
1072 snd_printk(KERN_ERR
1073 "sscape: No AD1845 device at 0x%lx, IRQ %d\n",
1074 wss_port[dev], irq[dev]);
1075 goto _release_dma;
1077 strcpy(card->driver, "SoundScape");
1078 strcpy(card->shortname, name);
1079 snprintf(card->longname, sizeof(card->longname),
1080 "%s at 0x%lx, IRQ %d, DMA1 %d, DMA2 %d\n",
1081 name, sscape->chip->port, sscape->chip->irq,
1082 sscape->chip->dma1, sscape->chip->dma2);
1084 #define MIDI_DEVNUM 0
1085 if (sscape->type != SSCAPE_VIVO) {
1086 err = sscape_upload_bootblock(card);
1087 if (err >= 0)
1088 err = sscape_upload_microcode(card, err);
1090 if (err == 0) {
1091 err = create_mpu401(card, MIDI_DEVNUM, port[dev],
1092 mpu_irq[dev]);
1093 if (err < 0) {
1094 snd_printk(KERN_ERR "sscape: Failed to create "
1095 "MPU-401 device at 0x%lx\n",
1096 port[dev]);
1097 goto _release_dma;
1101 * Initialize mixer
1103 spin_lock_irqsave(&sscape->lock, flags);
1104 sscape->midi_vol = 0;
1105 host_write_ctrl_unsafe(sscape->io_base,
1106 CMD_SET_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_XXX_MIDI_VOL, 100);
1111 host_write_ctrl_unsafe(sscape->io_base,
1112 sscape->midi_vol, 100);
1113 host_write_ctrl_unsafe(sscape->io_base,
1114 CMD_SET_EXTMIDI, 100);
1115 host_write_ctrl_unsafe(sscape->io_base,
1116 0, 100);
1117 host_write_ctrl_unsafe(sscape->io_base, CMD_ACK, 100);
1119 set_midi_mode_unsafe(sscape->io_base);
1120 spin_unlock_irqrestore(&sscape->lock, flags);
1125 * Now that we have successfully created this sound card,
1126 * it is safe to store the pointer.
1127 * NOTE: we only register the sound card's "destructor"
1128 * function now that our "constructor" has completed.
1130 card->private_free = soundscape_free;
1132 return 0;
1134 _release_dma:
1135 free_dma(dma[dev]);
1137 _release_region:
1138 release_and_free_resource(wss_res);
1139 release_and_free_resource(io_res);
1141 return err;
1145 static int __devinit snd_sscape_match(struct device *pdev, unsigned int i)
1148 * Make sure we were given ALL of the other parameters.
1150 if (port[i] == SNDRV_AUTO_PORT)
1151 return 0;
1153 if (irq[i] == SNDRV_AUTO_IRQ ||
1154 mpu_irq[i] == SNDRV_AUTO_IRQ ||
1155 dma[i] == SNDRV_AUTO_DMA) {
1156 printk(KERN_INFO
1157 "sscape: insufficient parameters, "
1158 "need IO, IRQ, MPU-IRQ and DMA\n");
1159 return 0;
1162 return 1;
1165 static int __devinit snd_sscape_probe(struct device *pdev, unsigned int dev)
1167 struct snd_card *card;
1168 struct soundscape *sscape;
1169 int ret;
1171 ret = snd_card_create(index[dev], id[dev], THIS_MODULE,
1172 sizeof(struct soundscape), &card);
1173 if (ret < 0)
1174 return ret;
1176 sscape = get_card_soundscape(card);
1177 sscape->type = SSCAPE;
1179 dma[dev] &= 0x03;
1180 snd_card_set_dev(card, pdev);
1182 ret = create_sscape(dev, card);
1183 if (ret < 0)
1184 goto _release_card;
1186 ret = snd_card_register(card);
1187 if (ret < 0) {
1188 snd_printk(KERN_ERR "sscape: Failed to register sound card\n");
1189 goto _release_card;
1191 dev_set_drvdata(pdev, card);
1192 return 0;
1194 _release_card:
1195 snd_card_free(card);
1196 return ret;
1199 static int __devexit snd_sscape_remove(struct device *devptr, unsigned int dev)
1201 snd_card_free(dev_get_drvdata(devptr));
1202 dev_set_drvdata(devptr, NULL);
1203 return 0;
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 = __devexit_p(snd_sscape_remove),
1212 /* FIXME: suspend/resume */
1213 .driver = {
1214 .name = DEV_NAME
1218 #ifdef CONFIG_PNP
1219 static inline int __devinit get_next_autoindex(int i)
1221 while (i < SNDRV_CARDS && port[i] != SNDRV_AUTO_PORT)
1222 ++i;
1223 return i;
1227 static int __devinit sscape_pnp_detect(struct pnp_card_link *pcard,
1228 const struct pnp_card_device_id *pid)
1230 static int idx = 0;
1231 struct pnp_dev *dev;
1232 struct snd_card *card;
1233 struct soundscape *sscape;
1234 int ret;
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)
1242 return -ENOSPC;
1245 * Check that we still have room for another sound card ...
1247 dev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
1248 if (!dev)
1249 return -ENODEV;
1251 if (!pnp_is_active(dev)) {
1252 if (pnp_activate_dev(dev) < 0) {
1253 snd_printk(KERN_INFO "sscape: device is inactive\n");
1254 return -EBUSY;
1259 * Create a new ALSA sound card entry, in anticipation
1260 * of detecting our hardware ...
1262 ret = snd_card_create(index[idx], id[idx], THIS_MODULE,
1263 sizeof(struct soundscape), &card);
1264 if (ret < 0)
1265 return ret;
1267 sscape = get_card_soundscape(card);
1270 * Identify card model ...
1272 if (!strncmp("ENS4081", pid->id, 7))
1273 sscape->type = SSCAPE_VIVO;
1274 else
1275 sscape->type = SSCAPE_PNP;
1278 * Read the correct parameters off the ISA PnP bus ...
1280 port[idx] = pnp_port_start(dev, 0);
1281 irq[idx] = pnp_irq(dev, 0);
1282 mpu_irq[idx] = pnp_irq(dev, 1);
1283 dma[idx] = pnp_dma(dev, 0) & 0x03;
1284 if (sscape->type == SSCAPE_PNP) {
1285 dma2[idx] = dma[idx];
1286 wss_port[idx] = CODEC_IO(port[idx]);
1287 } else {
1288 wss_port[idx] = pnp_port_start(dev, 1);
1289 dma2[idx] = pnp_dma(dev, 1);
1291 snd_card_set_dev(card, &pcard->card->dev);
1293 ret = create_sscape(idx, card);
1294 if (ret < 0)
1295 goto _release_card;
1297 ret = snd_card_register(card);
1298 if (ret < 0) {
1299 snd_printk(KERN_ERR "sscape: Failed to register sound card\n");
1300 goto _release_card;
1303 pnp_set_card_drvdata(pcard, card);
1304 ++idx;
1305 return 0;
1307 _release_card:
1308 snd_card_free(card);
1309 return ret;
1312 static void __devexit 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,
1320 .name = "sscape",
1321 .id_table = sscape_pnpids,
1322 .probe = sscape_pnp_detect,
1323 .remove = __devexit_p(sscape_pnp_remove),
1326 #endif /* CONFIG_PNP */
1328 static int __init sscape_init(void)
1330 int err;
1332 err = isa_register_driver(&snd_sscape_driver, SNDRV_CARDS);
1333 #ifdef CONFIG_PNP
1334 if (!err)
1335 isa_registered = 1;
1337 err = pnp_register_card_driver(&sscape_pnpc_driver);
1338 if (!err)
1339 pnp_registered = 1;
1341 if (isa_registered)
1342 err = 0;
1343 #endif
1344 return err;
1347 static void __exit sscape_exit(void)
1349 #ifdef CONFIG_PNP
1350 if (pnp_registered)
1351 pnp_unregister_card_driver(&sscape_pnpc_driver);
1352 if (isa_registered)
1353 #endif
1354 isa_unregister_driver(&snd_sscape_driver);
1357 module_init(sscape_init);
1358 module_exit(sscape_exit);