[ALSA] isa_bus device/driver naming
[linux-2.6.git] / sound / isa / sscape.c
1 /*
2  *   Low-level ALSA driver for the ENSONIQ SoundScape PnP
3  *   Copyright (c) by Chris Rankin
4  *
5  *   This driver was written in part using information obtained from
6  *   the OSS/Free SoundScape driver, written by Hannu Savolainen.
7  *
8  *
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.
13  *
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.
18  *
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
22  */
23
24 #include <sound/driver.h>
25 #include <linux/init.h>
26 #include <linux/err.h>
27 #include <linux/isa.h>
28 #include <linux/delay.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/hwdep.h>
35 #include <sound/cs4231.h>
36 #include <sound/mpu401.h>
37 #include <sound/initval.h>
38
39 #include <sound/sscape_ioctl.h>
40
41
42 MODULE_AUTHOR("Chris Rankin");
43 MODULE_DESCRIPTION("ENSONIQ SoundScape PnP driver");
44 MODULE_LICENSE("GPL");
45
46 static int index[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_IDX;
47 static char* id[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_STR;
48 static long port[SNDRV_CARDS] __devinitdata = { [0 ... (SNDRV_CARDS-1)] = SNDRV_AUTO_PORT };
49 static int irq[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_IRQ;
50 static int mpu_irq[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_IRQ;
51 static int dma[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_DMA;
52
53 module_param_array(index, int, NULL, 0444);
54 MODULE_PARM_DESC(index, "Index number for SoundScape soundcard");
55
56 module_param_array(id, charp, NULL, 0444);
57 MODULE_PARM_DESC(id, "Description for SoundScape card");
58
59 module_param_array(port, long, NULL, 0444);
60 MODULE_PARM_DESC(port, "Port # for SoundScape driver.");
61
62 module_param_array(irq, int, NULL, 0444);
63 MODULE_PARM_DESC(irq, "IRQ # for SoundScape driver.");
64
65 module_param_array(mpu_irq, int, NULL, 0444);
66 MODULE_PARM_DESC(mpu_irq, "MPU401 IRQ # for SoundScape driver.");
67
68 module_param_array(dma, int, NULL, 0444);
69 MODULE_PARM_DESC(dma, "DMA # for SoundScape driver.");
70
71 #ifdef CONFIG_PNP
72 static int pnp_registered;
73 static struct pnp_card_device_id sscape_pnpids[] = {
74         { .id = "ENS3081", .devs = { { "ENS0000" } } },
75         { .id = "" }    /* end */
76 };
77
78 MODULE_DEVICE_TABLE(pnp_card, sscape_pnpids);
79 #endif
80
81
82 #define MPU401_IO(i)     ((i) + 0)
83 #define MIDI_DATA_IO(i)  ((i) + 0)
84 #define MIDI_CTRL_IO(i)  ((i) + 1)
85 #define HOST_CTRL_IO(i)  ((i) + 2)
86 #define HOST_DATA_IO(i)  ((i) + 3)
87 #define ODIE_ADDR_IO(i)  ((i) + 4)
88 #define ODIE_DATA_IO(i)  ((i) + 5)
89 #define CODEC_IO(i)      ((i) + 8)
90
91 #define IC_ODIE  1
92 #define IC_OPUS  2
93
94 #define RX_READY 0x01
95 #define TX_READY 0x02
96
97 #define CMD_ACK           0x80
98 #define CMD_SET_MIDI_VOL  0x84
99 #define CMD_GET_MIDI_VOL  0x85
100 #define CMD_XXX_MIDI_VOL  0x86
101 #define CMD_SET_EXTMIDI   0x8a
102 #define CMD_GET_EXTMIDI   0x8b
103 #define CMD_SET_MT32      0x8c
104 #define CMD_GET_MT32      0x8d
105
106 enum GA_REG {
107         GA_INTSTAT_REG = 0,
108         GA_INTENA_REG,
109         GA_DMAA_REG,
110         GA_DMAB_REG,
111         GA_INTCFG_REG,
112         GA_DMACFG_REG,
113         GA_CDCFG_REG,
114         GA_SMCFGA_REG,
115         GA_SMCFGB_REG,
116         GA_HMCTL_REG
117 };
118
119 #define DMA_8BIT  0x80
120
121
122 #define AD1845_FREQ_SEL_MSB    0x16
123 #define AD1845_FREQ_SEL_LSB    0x17
124
125 struct soundscape {
126         spinlock_t lock;
127         unsigned io_base;
128         int codec_type;
129         int ic_type;
130         struct resource *io_res;
131         struct snd_cs4231 *chip;
132         struct snd_mpu401 *mpu;
133         struct snd_hwdep *hw;
134
135         /*
136          * The MIDI device won't work until we've loaded
137          * its firmware via a hardware-dependent device IOCTL
138          */
139         spinlock_t fwlock;
140         int hw_in_use;
141         unsigned long midi_usage;
142         unsigned char midi_vol;
143 };
144
145 #define INVALID_IRQ  ((unsigned)-1)
146
147
148 static inline struct soundscape *get_card_soundscape(struct snd_card *c)
149 {
150         return (struct soundscape *) (c->private_data);
151 }
152
153 static inline struct soundscape *get_mpu401_soundscape(struct snd_mpu401 * mpu)
154 {
155         return (struct soundscape *) (mpu->private_data);
156 }
157
158 static inline struct soundscape *get_hwdep_soundscape(struct snd_hwdep * hw)
159 {
160         return (struct soundscape *) (hw->private_data);
161 }
162
163
164 /*
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.
168  */
169 static struct snd_dma_buffer *get_dmabuf(struct snd_dma_buffer *buf, unsigned long size)
170 {
171         if (buf) {
172                 if (snd_dma_alloc_pages_fallback(SNDRV_DMA_TYPE_DEV, snd_dma_isa_data(),
173                                                  size, buf) < 0) {
174                         snd_printk(KERN_ERR "sscape: Failed to allocate %lu bytes for DMA\n", size);
175                         return NULL;
176                 }
177         }
178
179         return buf;
180 }
181
182 /*
183  * Release the DMA-able kernel memory ...
184  */
185 static void free_dmabuf(struct snd_dma_buffer *buf)
186 {
187         if (buf && buf->area)
188                 snd_dma_free_pages(buf);
189 }
190
191
192 /*
193  * This function writes to the SoundScape's control registers,
194  * but doesn't do any locking. It's up to the caller to do that.
195  * This is why this function is "unsafe" ...
196  */
197 static inline void sscape_write_unsafe(unsigned io_base, enum GA_REG reg, unsigned char val)
198 {
199         outb(reg, ODIE_ADDR_IO(io_base));
200         outb(val, ODIE_DATA_IO(io_base));
201 }
202
203 /*
204  * Write to the SoundScape's control registers, and do the
205  * necessary locking ...
206  */
207 static void sscape_write(struct soundscape *s, enum GA_REG reg, unsigned char val)
208 {
209         unsigned long flags;
210
211         spin_lock_irqsave(&s->lock, flags);
212         sscape_write_unsafe(s->io_base, reg, val);
213         spin_unlock_irqrestore(&s->lock, flags);
214 }
215
216 /*
217  * Read from the SoundScape's control registers, but leave any
218  * locking to the caller. This is why the function is "unsafe" ...
219  */
220 static inline unsigned char sscape_read_unsafe(unsigned io_base, enum GA_REG reg)
221 {
222         outb(reg, ODIE_ADDR_IO(io_base));
223         return inb(ODIE_DATA_IO(io_base));
224 }
225
226 /*
227  * Puts the SoundScape into "host" mode, as compared to "MIDI" mode
228  */
229 static inline void set_host_mode_unsafe(unsigned io_base)
230 {
231         outb(0x0, HOST_CTRL_IO(io_base));
232 }
233
234 /*
235  * Puts the SoundScape into "MIDI" mode, as compared to "host" mode
236  */
237 static inline void set_midi_mode_unsafe(unsigned io_base)
238 {
239         outb(0x3, HOST_CTRL_IO(io_base));
240 }
241
242 /*
243  * Read the SoundScape's host-mode control register, but leave
244  * any locking issues to the caller ...
245  */
246 static inline int host_read_unsafe(unsigned io_base)
247 {
248         int data = -1;
249         if ((inb(HOST_CTRL_IO(io_base)) & RX_READY) != 0) {
250                 data = inb(HOST_DATA_IO(io_base));
251         }
252
253         return data;
254 }
255
256 /*
257  * Read the SoundScape's host-mode control register, performing
258  * a limited amount of busy-waiting if the register isn't ready.
259  * Also leaves all locking-issues to the caller ...
260  */
261 static int host_read_ctrl_unsafe(unsigned io_base, unsigned timeout)
262 {
263         int data;
264
265         while (((data = host_read_unsafe(io_base)) < 0) && (timeout != 0)) {
266                 udelay(100);
267                 --timeout;
268         } /* while */
269
270         return data;
271 }
272
273 /*
274  * Write to the SoundScape's host-mode control registers, but
275  * leave any locking issues to the caller ...
276  */
277 static inline int host_write_unsafe(unsigned io_base, unsigned char data)
278 {
279         if ((inb(HOST_CTRL_IO(io_base)) & TX_READY) != 0) {
280                 outb(data, HOST_DATA_IO(io_base));
281                 return 1;
282         }
283
284         return 0;
285 }
286
287 /*
288  * Write to the SoundScape's host-mode control registers, performing
289  * a limited amount of busy-waiting if the register isn't ready.
290  * Also leaves all locking-issues to the caller ...
291  */
292 static int host_write_ctrl_unsafe(unsigned io_base, unsigned char data,
293                                   unsigned timeout)
294 {
295         int err;
296
297         while (!(err = host_write_unsafe(io_base, data)) && (timeout != 0)) {
298                 udelay(100);
299                 --timeout;
300         } /* while */
301
302         return err;
303 }
304
305
306 /*
307  * Check that the MIDI subsystem is operational. If it isn't,
308  * then we will hang the computer if we try to use it ...
309  *
310  * NOTE: This check is based upon observation, not documentation.
311  */
312 static inline int verify_mpu401(const struct snd_mpu401 * mpu)
313 {
314         return ((inb(MIDI_CTRL_IO(mpu->port)) & 0xc0) == 0x80);
315 }
316
317 /*
318  * This is apparently the standard way to initailise an MPU-401
319  */
320 static inline void initialise_mpu401(const struct snd_mpu401 * mpu)
321 {
322         outb(0, MIDI_DATA_IO(mpu->port));
323 }
324
325 /*
326  * Tell the SoundScape to activate the AD1845 chip (I think).
327  * The AD1845 detection fails if we *don't* do this, so I
328  * think that this is a good idea ...
329  */
330 static inline void activate_ad1845_unsafe(unsigned io_base)
331 {
332         sscape_write_unsafe(io_base, GA_HMCTL_REG, (sscape_read_unsafe(io_base, GA_HMCTL_REG) & 0xcf) | 0x10);
333         sscape_write_unsafe(io_base, GA_CDCFG_REG, 0x80);
334 }
335
336 /*
337  * Do the necessary ALSA-level cleanup to deallocate our driver ...
338  */
339 static void soundscape_free(struct snd_card *c)
340 {
341         register struct soundscape *sscape = get_card_soundscape(c);
342         release_and_free_resource(sscape->io_res);
343         free_dma(sscape->chip->dma1);
344 }
345
346 /*
347  * Tell the SoundScape to begin a DMA tranfer using the given channel.
348  * All locking issues are left to the caller.
349  */
350 static inline void sscape_start_dma_unsafe(unsigned io_base, enum GA_REG reg)
351 {
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);
354 }
355
356 /*
357  * Wait for a DMA transfer to complete. This is a "limited busy-wait",
358  * and all locking issues are left to the caller.
359  */
360 static int sscape_wait_dma_unsafe(unsigned io_base, enum GA_REG reg, unsigned timeout)
361 {
362         while (!(sscape_read_unsafe(io_base, reg) & 0x01) && (timeout != 0)) {
363                 udelay(100);
364                 --timeout;
365         } /* while */
366
367         return (sscape_read_unsafe(io_base, reg) & 0x01);
368 }
369
370 /*
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.
376  */
377 static int obp_startup_ack(struct soundscape *s, unsigned timeout)
378 {
379         while (timeout != 0) {
380                 unsigned long flags;
381                 unsigned char x;
382
383                 schedule_timeout_interruptible(1);
384
385                 spin_lock_irqsave(&s->lock, flags);
386                 x = inb(HOST_DATA_IO(s->io_base));
387                 spin_unlock_irqrestore(&s->lock, flags);
388                 if ((x & 0xfe) == 0xfe)
389                         return 1;
390
391                 --timeout;
392         } /* while */
393
394         return 0;
395 }
396
397 /*
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
402  * this function.
403  */
404 static int host_startup_ack(struct soundscape *s, unsigned timeout)
405 {
406         while (timeout != 0) {
407                 unsigned long flags;
408                 unsigned char x;
409
410                 schedule_timeout_interruptible(1);
411
412                 spin_lock_irqsave(&s->lock, flags);
413                 x = inb(HOST_DATA_IO(s->io_base));
414                 spin_unlock_irqrestore(&s->lock, flags);
415                 if (x == 0xfe)
416                         return 1;
417
418                 --timeout;
419         } /* while */
420
421         return 0;
422 }
423
424 /*
425  * Upload a byte-stream into the SoundScape using DMA channel A.
426  */
427 static int upload_dma_data(struct soundscape *s,
428                            const unsigned char __user *data,
429                            size_t size)
430 {
431         unsigned long flags;
432         struct snd_dma_buffer dma;
433         int ret;
434
435         if (!get_dmabuf(&dma, PAGE_ALIGN(size)))
436                 return -ENOMEM;
437
438         spin_lock_irqsave(&s->lock, flags);
439
440         /*
441          * Reset the board ...
442          */
443         sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f);
444
445         /*
446          * Enable the DMA channels and configure them ...
447          */
448         sscape_write_unsafe(s->io_base, GA_DMACFG_REG, 0x50);
449         sscape_write_unsafe(s->io_base, GA_DMAA_REG, (s->chip->dma1 << 4) | DMA_8BIT);
450         sscape_write_unsafe(s->io_base, GA_DMAB_REG, 0x20);
451
452         /*
453          * Take the board out of reset ...
454          */
455         sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) | 0x80);
456
457         /*
458          * Upload the user's data (firmware?) to the SoundScape
459          * board through the DMA channel ...
460          */
461         while (size != 0) {
462                 unsigned long len;
463
464                 /*
465                  * Apparently, copying to/from userspace can sleep.
466                  * We are therefore forbidden from holding any
467                  * spinlocks while we copy ...
468                  */
469                 spin_unlock_irqrestore(&s->lock, flags);
470
471                 /*
472                  * Remember that the data that we want to DMA
473                  * comes from USERSPACE. We have already verified
474                  * the userspace pointer ...
475                  */
476                 len = min(size, dma.bytes);
477                 len -= __copy_from_user(dma.area, data, len);
478                 data += len;
479                 size -= len;
480
481                 /*
482                  * Grab that spinlock again, now that we've
483                  * finished copying!
484                  */
485                 spin_lock_irqsave(&s->lock, flags);
486
487                 snd_dma_program(s->chip->dma1, dma.addr, len, DMA_MODE_WRITE);
488                 sscape_start_dma_unsafe(s->io_base, GA_DMAA_REG);
489                 if (!sscape_wait_dma_unsafe(s->io_base, GA_DMAA_REG, 5000)) {
490                         /*
491                          * Don't forget to release this spinlock we're holding ...
492                          */
493                         spin_unlock_irqrestore(&s->lock, flags);
494
495                         snd_printk(KERN_ERR "sscape: DMA upload has timed out\n");
496                         ret = -EAGAIN;
497                         goto _release_dma;
498                 }
499         } /* while */
500
501         set_host_mode_unsafe(s->io_base);
502
503         /*
504          * Boot the board ... (I think)
505          */
506         sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) | 0x40);
507         spin_unlock_irqrestore(&s->lock, flags);
508
509         /*
510          * If all has gone well, then the board should acknowledge
511          * the new upload and tell us that it has rebooted OK. We
512          * give it 5 seconds (max) ...
513          */
514         ret = 0;
515         if (!obp_startup_ack(s, 5)) {
516                 snd_printk(KERN_ERR "sscape: No response from on-board processor after upload\n");
517                 ret = -EAGAIN;
518         } else if (!host_startup_ack(s, 5)) {
519                 snd_printk(KERN_ERR "sscape: SoundScape failed to initialise\n");
520                 ret = -EAGAIN;
521         }
522
523         _release_dma:
524         /*
525          * NOTE!!! We are NOT holding any spinlocks at this point !!!
526          */
527         sscape_write(s, GA_DMAA_REG, (s->ic_type == IC_ODIE ? 0x70 : 0x40));
528         free_dmabuf(&dma);
529
530         return ret;
531 }
532
533 /*
534  * Upload the bootblock(?) into the SoundScape. The only
535  * purpose of this block of code seems to be to tell
536  * us which version of the microcode we should be using.
537  *
538  * NOTE: The boot-block data resides in USER-SPACE!!!
539  *       However, we have already verified its memory
540  *       addresses by the time we get here.
541  */
542 static int sscape_upload_bootblock(struct soundscape *sscape, struct sscape_bootblock __user *bb)
543 {
544         unsigned long flags;
545         int data = 0;
546         int ret;
547
548         ret = upload_dma_data(sscape, bb->code, sizeof(bb->code));
549
550         spin_lock_irqsave(&sscape->lock, flags);
551         if (ret == 0) {
552                 data = host_read_ctrl_unsafe(sscape->io_base, 100);
553         }
554         set_midi_mode_unsafe(sscape->io_base);
555         spin_unlock_irqrestore(&sscape->lock, flags);
556
557         if (ret == 0) {
558                 if (data < 0) {
559                         snd_printk(KERN_ERR "sscape: timeout reading firmware version\n");
560                         ret = -EAGAIN;
561                 }
562                 else if (__copy_to_user(&bb->version, &data, sizeof(bb->version))) {
563                         ret = -EFAULT;
564                 }
565         }
566
567         return ret;
568 }
569
570 /*
571  * Upload the microcode into the SoundScape. The
572  * microcode is 64K of data, and if we try to copy
573  * it into a local variable then we will SMASH THE
574  * KERNEL'S STACK! We therefore leave it in USER
575  * SPACE, and save ourselves from copying it at all.
576  */
577 static int sscape_upload_microcode(struct soundscape *sscape,
578                                    const struct sscape_microcode __user *mc)
579 {
580         unsigned long flags;
581         char __user *code;
582         int err;
583
584         /*
585          * We are going to have to copy this data into a special
586          * DMA-able buffer before we can upload it. We shall therefore
587          * just check that the data pointer is valid for now.
588          *
589          * NOTE: This buffer is 64K long! That's WAY too big to
590          *       copy into a stack-temporary anyway.
591          */
592         if ( get_user(code, &mc->code) ||
593              !access_ok(VERIFY_READ, code, SSCAPE_MICROCODE_SIZE) )
594                 return -EFAULT;
595
596         if ((err = upload_dma_data(sscape, code, SSCAPE_MICROCODE_SIZE)) == 0) {
597                 snd_printk(KERN_INFO "sscape: MIDI firmware loaded\n");
598         }
599
600         spin_lock_irqsave(&sscape->lock, flags);
601         set_midi_mode_unsafe(sscape->io_base);
602         spin_unlock_irqrestore(&sscape->lock, flags);
603
604         initialise_mpu401(sscape->mpu);
605
606         return err;
607 }
608
609 /*
610  * Hardware-specific device functions, to implement special
611  * IOCTLs for the SoundScape card. This is how we upload
612  * the microcode into the card, for example, and so we
613  * must ensure that no two processes can open this device
614  * simultaneously, and that we can't open it at all if
615  * someone is using the MIDI device.
616  */
617 static int sscape_hw_open(struct snd_hwdep * hw, struct file *file)
618 {
619         register struct soundscape *sscape = get_hwdep_soundscape(hw);
620         unsigned long flags;
621         int err;
622
623         spin_lock_irqsave(&sscape->fwlock, flags);
624
625         if ((sscape->midi_usage != 0) || sscape->hw_in_use) {
626                 err = -EBUSY;
627         } else {
628                 sscape->hw_in_use = 1;
629                 err = 0;
630         }
631
632         spin_unlock_irqrestore(&sscape->fwlock, flags);
633         return err;
634 }
635
636 static int sscape_hw_release(struct snd_hwdep * hw, struct file *file)
637 {
638         register struct soundscape *sscape = get_hwdep_soundscape(hw);
639         unsigned long flags;
640
641         spin_lock_irqsave(&sscape->fwlock, flags);
642         sscape->hw_in_use = 0;
643         spin_unlock_irqrestore(&sscape->fwlock, flags);
644         return 0;
645 }
646
647 static int sscape_hw_ioctl(struct snd_hwdep * hw, struct file *file,
648                            unsigned int cmd, unsigned long arg)
649 {
650         struct soundscape *sscape = get_hwdep_soundscape(hw);
651         int err = -EBUSY;
652
653         switch (cmd) {
654         case SND_SSCAPE_LOAD_BOOTB:
655                 {
656                         register struct sscape_bootblock __user *bb = (struct sscape_bootblock __user *) arg;
657
658                         /*
659                          * We are going to have to copy this data into a special
660                          * DMA-able buffer before we can upload it. We shall therefore
661                          * just check that the data pointer is valid for now ...
662                          */
663                         if ( !access_ok(VERIFY_READ, bb->code, sizeof(bb->code)) )
664                                 return -EFAULT;
665
666                         /*
667                          * Now check that we can write the firmware version number too...
668                          */
669                         if ( !access_ok(VERIFY_WRITE, &bb->version, sizeof(bb->version)) )
670                                 return -EFAULT;
671
672                         err = sscape_upload_bootblock(sscape, bb);
673                 }
674                 break;
675
676         case SND_SSCAPE_LOAD_MCODE:
677                 {
678                         register const struct sscape_microcode __user *mc = (const struct sscape_microcode __user *) arg;
679
680                         err = sscape_upload_microcode(sscape, mc);
681                 }
682                 break;
683
684         default:
685                 err = -EINVAL;
686                 break;
687         } /* switch */
688
689         return err;
690 }
691
692
693 /*
694  * Mixer control for the SoundScape's MIDI device.
695  */
696 static int sscape_midi_info(struct snd_kcontrol *ctl,
697                             struct snd_ctl_elem_info *uinfo)
698 {
699         uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
700         uinfo->count = 1;
701         uinfo->value.integer.min = 0;
702         uinfo->value.integer.max = 127;
703         return 0;
704 }
705
706 static int sscape_midi_get(struct snd_kcontrol *kctl,
707                            struct snd_ctl_elem_value *uctl)
708 {
709         struct snd_cs4231 *chip = snd_kcontrol_chip(kctl);
710         struct snd_card *card = chip->card;
711         register struct soundscape *s = get_card_soundscape(card);
712         unsigned long flags;
713
714         spin_lock_irqsave(&s->lock, flags);
715         set_host_mode_unsafe(s->io_base);
716
717         if (host_write_ctrl_unsafe(s->io_base, CMD_GET_MIDI_VOL, 100)) {
718                 uctl->value.integer.value[0] = host_read_ctrl_unsafe(s->io_base, 100);
719         }
720
721         set_midi_mode_unsafe(s->io_base);
722         spin_unlock_irqrestore(&s->lock, flags);
723         return 0;
724 }
725
726 static int sscape_midi_put(struct snd_kcontrol *kctl,
727                            struct snd_ctl_elem_value *uctl)
728 {
729         struct snd_cs4231 *chip = snd_kcontrol_chip(kctl);
730         struct snd_card *card = chip->card;
731         register struct soundscape *s = get_card_soundscape(card);
732         unsigned long flags;
733         int change;
734
735         spin_lock_irqsave(&s->lock, flags);
736
737         /*
738          * We need to put the board into HOST mode before we
739          * can send any volume-changing HOST commands ...
740          */
741         set_host_mode_unsafe(s->io_base);
742
743         /*
744          * To successfully change the MIDI volume setting, you seem to
745          * have to write a volume command, write the new volume value,
746          * and then perform another volume-related command. Perhaps the
747          * first command is an "open" and the second command is a "close"?
748          */
749         if (s->midi_vol == ((unsigned char) uctl->value.integer. value[0] & 127)) {
750                 change = 0;
751                 goto __skip_change;
752         }
753         change = (host_write_ctrl_unsafe(s->io_base, CMD_SET_MIDI_VOL, 100)
754                   && host_write_ctrl_unsafe(s->io_base, ((unsigned char) uctl->value.integer. value[0]) & 127, 100)
755                   && host_write_ctrl_unsafe(s->io_base, CMD_XXX_MIDI_VOL, 100));
756       __skip_change:
757
758         /*
759          * Take the board out of HOST mode and back into MIDI mode ...
760          */
761         set_midi_mode_unsafe(s->io_base);
762
763         spin_unlock_irqrestore(&s->lock, flags);
764         return change;
765 }
766
767 static struct snd_kcontrol_new midi_mixer_ctl = {
768         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
769         .name = "MIDI",
770         .info = sscape_midi_info,
771         .get = sscape_midi_get,
772         .put = sscape_midi_put
773 };
774
775 /*
776  * The SoundScape can use two IRQs from a possible set of four.
777  * These IRQs are encoded as bit patterns so that they can be
778  * written to the control registers.
779  */
780 static unsigned __devinit get_irq_config(int irq)
781 {
782         static const int valid_irq[] = { 9, 5, 7, 10 };
783         unsigned cfg;
784
785         for (cfg = 0; cfg < ARRAY_SIZE(valid_irq); ++cfg) {
786                 if (irq == valid_irq[cfg])
787                         return cfg;
788         } /* for */
789
790         return INVALID_IRQ;
791 }
792
793
794 /*
795  * Perform certain arcane port-checks to see whether there
796  * is a SoundScape board lurking behind the given ports.
797  */
798 static int __devinit detect_sscape(struct soundscape *s)
799 {
800         unsigned long flags;
801         unsigned d;
802         int retval = 0;
803
804         spin_lock_irqsave(&s->lock, flags);
805
806         /*
807          * The following code is lifted from the original OSS driver,
808          * and as I don't have a datasheet I cannot really comment
809          * on what it is doing...
810          */
811         if ((inb(HOST_CTRL_IO(s->io_base)) & 0x78) != 0)
812                 goto _done;
813
814         d = inb(ODIE_ADDR_IO(s->io_base)) & 0xf0;
815         if ((d & 0x80) != 0)
816                 goto _done;
817
818         if (d == 0) {
819                 s->codec_type = 1;
820                 s->ic_type = IC_ODIE;
821         } else if ((d & 0x60) != 0) {
822                 s->codec_type = 2;
823                 s->ic_type = IC_OPUS;
824         } else
825                 goto _done;
826
827         outb(0xfa, ODIE_ADDR_IO(s->io_base));
828         if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0a)
829                 goto _done;
830
831         outb(0xfe, ODIE_ADDR_IO(s->io_base));
832         if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0e)
833                 goto _done;
834         if ((inb(ODIE_DATA_IO(s->io_base)) & 0x9f) != 0x0e)
835                 goto _done;
836
837         /*
838          * SoundScape successfully detected!
839          */
840         retval = 1;
841
842         _done:
843         spin_unlock_irqrestore(&s->lock, flags);
844         return retval;
845 }
846
847 /*
848  * ALSA callback function, called when attempting to open the MIDI device.
849  * Check that the MIDI firmware has been loaded, because we don't want
850  * to crash the machine. Also check that someone isn't using the hardware
851  * IOCTL device.
852  */
853 static int mpu401_open(struct snd_mpu401 * mpu)
854 {
855         int err;
856
857         if (!verify_mpu401(mpu)) {
858                 snd_printk(KERN_ERR "sscape: MIDI disabled, please load firmware\n");
859                 err = -ENODEV;
860         } else {
861                 register struct soundscape *sscape = get_mpu401_soundscape(mpu);
862                 unsigned long flags;
863
864                 spin_lock_irqsave(&sscape->fwlock, flags);
865
866                 if (sscape->hw_in_use || (sscape->midi_usage == ULONG_MAX)) {
867                         err = -EBUSY;
868                 } else {
869                         ++(sscape->midi_usage);
870                         err = 0;
871                 }
872
873                 spin_unlock_irqrestore(&sscape->fwlock, flags);
874         }
875
876         return err;
877 }
878
879 static void mpu401_close(struct snd_mpu401 * mpu)
880 {
881         register struct soundscape *sscape = get_mpu401_soundscape(mpu);
882         unsigned long flags;
883
884         spin_lock_irqsave(&sscape->fwlock, flags);
885         --(sscape->midi_usage);
886         spin_unlock_irqrestore(&sscape->fwlock, flags);
887 }
888
889 /*
890  * Initialse an MPU-401 subdevice for MIDI support on the SoundScape.
891  */
892 static int __devinit create_mpu401(struct snd_card *card, int devnum, unsigned long port, int irq)
893 {
894         struct soundscape *sscape = get_card_soundscape(card);
895         struct snd_rawmidi *rawmidi;
896         int err;
897
898         if ((err = snd_mpu401_uart_new(card, devnum,
899                                        MPU401_HW_MPU401,
900                                        port, MPU401_INFO_INTEGRATED,
901                                        irq, IRQF_DISABLED,
902                                        &rawmidi)) == 0) {
903                 struct snd_mpu401 *mpu = (struct snd_mpu401 *) rawmidi->private_data;
904                 mpu->open_input = mpu401_open;
905                 mpu->open_output = mpu401_open;
906                 mpu->close_input = mpu401_close;
907                 mpu->close_output = mpu401_close;
908                 mpu->private_data = sscape;
909                 sscape->mpu = mpu;
910
911                 initialise_mpu401(mpu);
912         }
913
914         return err;
915 }
916
917
918 /*
919  * Override for the CS4231 playback format function.
920  * The AD1845 has much simpler format and rate selection.
921  */
922 static void ad1845_playback_format(struct snd_cs4231 * chip, struct snd_pcm_hw_params *params, unsigned char format)
923 {
924         unsigned long flags;
925         unsigned rate = params_rate(params);
926
927         /*
928          * The AD1845 can't handle sample frequencies
929          * outside of 4 kHZ to 50 kHZ
930          */
931         if (rate > 50000)
932                 rate = 50000;
933         else if (rate < 4000)
934                 rate = 4000;
935
936         spin_lock_irqsave(&chip->reg_lock, flags);
937
938         /*
939          * Program the AD1845 correctly for the playback stream.
940          * Note that we do NOT need to toggle the MCE bit because
941          * the PLAYBACK_ENABLE bit of the Interface Configuration
942          * register is set.
943          * 
944          * NOTE: We seem to need to write to the MSB before the LSB
945          *       to get the correct sample frequency.
946          */
947         snd_cs4231_out(chip, CS4231_PLAYBK_FORMAT, (format & 0xf0));
948         snd_cs4231_out(chip, AD1845_FREQ_SEL_MSB, (unsigned char) (rate >> 8));
949         snd_cs4231_out(chip, AD1845_FREQ_SEL_LSB, (unsigned char) rate);
950
951         spin_unlock_irqrestore(&chip->reg_lock, flags);
952 }
953
954 /*
955  * Override for the CS4231 capture format function. 
956  * The AD1845 has much simpler format and rate selection.
957  */
958 static void ad1845_capture_format(struct snd_cs4231 * chip, struct snd_pcm_hw_params *params, unsigned char format)
959 {
960         unsigned long flags;
961         unsigned rate = params_rate(params);
962
963         /*
964          * The AD1845 can't handle sample frequencies 
965          * outside of 4 kHZ to 50 kHZ
966          */
967         if (rate > 50000)
968                 rate = 50000;
969         else if (rate < 4000)
970                 rate = 4000;
971
972         spin_lock_irqsave(&chip->reg_lock, flags);
973
974         /*
975          * Program the AD1845 correctly for the playback stream.
976          * Note that we do NOT need to toggle the MCE bit because
977          * the CAPTURE_ENABLE bit of the Interface Configuration
978          * register is set.
979          *
980          * NOTE: We seem to need to write to the MSB before the LSB
981          *       to get the correct sample frequency.
982          */
983         snd_cs4231_out(chip, CS4231_REC_FORMAT, (format & 0xf0));
984         snd_cs4231_out(chip, AD1845_FREQ_SEL_MSB, (unsigned char) (rate >> 8));
985         snd_cs4231_out(chip, AD1845_FREQ_SEL_LSB, (unsigned char) rate);
986
987         spin_unlock_irqrestore(&chip->reg_lock, flags);
988 }
989
990 /*
991  * Create an AD1845 PCM subdevice on the SoundScape. The AD1845
992  * is very much like a CS4231, with a few extra bits. We will
993  * try to support at least some of the extra bits by overriding
994  * some of the CS4231 callback.
995  */
996 static int __devinit create_ad1845(struct snd_card *card, unsigned port, int irq, int dma1)
997 {
998         register struct soundscape *sscape = get_card_soundscape(card);
999         struct snd_cs4231 *chip;
1000         int err;
1001
1002 #define CS4231_SHARE_HARDWARE  (CS4231_HWSHARE_DMA1 | CS4231_HWSHARE_DMA2)
1003         /*
1004          * The AD1845 PCM device is only half-duplex, and so
1005          * we only give it one DMA channel ...
1006          */
1007         if ((err = snd_cs4231_create(card,
1008                                      port, -1, irq, dma1, dma1,
1009                                      CS4231_HW_DETECT,
1010                                      CS4231_HWSHARE_DMA1, &chip)) == 0) {
1011                 unsigned long flags;
1012                 struct snd_pcm *pcm;
1013
1014 #define AD1845_FREQ_SEL_ENABLE  0x08
1015
1016 #define AD1845_PWR_DOWN_CTRL   0x1b
1017 #define AD1845_CRYS_CLOCK_SEL  0x1d
1018
1019 /*
1020  * It turns out that the PLAYBACK_ENABLE bit is set
1021  * by the lowlevel driver ...
1022  *
1023 #define AD1845_IFACE_CONFIG  \
1024            (CS4231_AUTOCALIB | CS4231_RECORD_ENABLE | CS4231_PLAYBACK_ENABLE)
1025     snd_cs4231_mce_up(chip);
1026     spin_lock_irqsave(&chip->reg_lock, flags);
1027     snd_cs4231_out(chip, CS4231_IFACE_CTRL, AD1845_IFACE_CONFIG);
1028     spin_unlock_irqrestore(&chip->reg_lock, flags);
1029     snd_cs4231_mce_down(chip);
1030  */
1031
1032                 /*
1033                  * The input clock frequency on the SoundScape must
1034                  * be 14.31818 MHz, because we must set this register
1035                  * to get the playback to sound correct ...
1036                  */
1037                 snd_cs4231_mce_up(chip);
1038                 spin_lock_irqsave(&chip->reg_lock, flags);
1039                 snd_cs4231_out(chip, AD1845_CRYS_CLOCK_SEL, 0x20);
1040                 spin_unlock_irqrestore(&chip->reg_lock, flags);
1041                 snd_cs4231_mce_down(chip);
1042
1043                 /*
1044                  * More custom configuration:
1045                  * a) select "mode 2", and provide a current drive of 8 mA
1046                  * b) enable frequency selection (for capture/playback)
1047                  */
1048                 spin_lock_irqsave(&chip->reg_lock, flags);
1049                 snd_cs4231_out(chip, CS4231_MISC_INFO, (CS4231_MODE2 | 0x10));
1050                 snd_cs4231_out(chip, AD1845_PWR_DOWN_CTRL, snd_cs4231_in(chip, AD1845_PWR_DOWN_CTRL) | AD1845_FREQ_SEL_ENABLE);
1051                 spin_unlock_irqrestore(&chip->reg_lock, flags);
1052
1053                 if ((err = snd_cs4231_pcm(chip, 0, &pcm)) < 0) {
1054                         snd_printk(KERN_ERR "sscape: No PCM device for AD1845 chip\n");
1055                         goto _error;
1056                 }
1057
1058                 if ((err = snd_cs4231_mixer(chip)) < 0) {
1059                         snd_printk(KERN_ERR "sscape: No mixer device for AD1845 chip\n");
1060                         goto _error;
1061                 }
1062
1063                 if ((err = snd_ctl_add(card, snd_ctl_new1(&midi_mixer_ctl, chip))) < 0) {
1064                         snd_printk(KERN_ERR "sscape: Could not create MIDI mixer control\n");
1065                         goto _error;
1066                 }
1067
1068                 strcpy(card->driver, "SoundScape");
1069                 strcpy(card->shortname, pcm->name);
1070                 snprintf(card->longname, sizeof(card->longname),
1071                          "%s at 0x%lx, IRQ %d, DMA %d\n",
1072                          pcm->name, chip->port, chip->irq, chip->dma1);
1073                 chip->set_playback_format = ad1845_playback_format;
1074                 chip->set_capture_format = ad1845_capture_format;
1075                 sscape->chip = chip;
1076         }
1077
1078         _error:
1079         return err;
1080 }
1081
1082
1083 /*
1084  * Create an ALSA soundcard entry for the SoundScape, using
1085  * the given list of port, IRQ and DMA resources.
1086  */
1087 static int __devinit create_sscape(int dev, struct snd_card **rcardp)
1088 {
1089         struct snd_card *card;
1090         register struct soundscape *sscape;
1091         register unsigned dma_cfg;
1092         unsigned irq_cfg;
1093         unsigned mpu_irq_cfg;
1094         unsigned xport;
1095         struct resource *io_res;
1096         unsigned long flags;
1097         int err;
1098
1099         /*
1100          * Check that the user didn't pass us garbage data ...
1101          */
1102         irq_cfg = get_irq_config(irq[dev]);
1103         if (irq_cfg == INVALID_IRQ) {
1104                 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", irq[dev]);
1105                 return -ENXIO;
1106         }
1107
1108         mpu_irq_cfg = get_irq_config(mpu_irq[dev]);
1109         if (mpu_irq_cfg == INVALID_IRQ) {
1110                 printk(KERN_ERR "sscape: Invalid IRQ %d\n", mpu_irq[dev]);
1111                 return -ENXIO;
1112         }
1113         xport = port[dev];
1114
1115         /*
1116          * Grab IO ports that we will need to probe so that we
1117          * can detect and control this hardware ...
1118          */
1119         if ((io_res = request_region(xport, 8, "SoundScape")) == NULL) {
1120                 snd_printk(KERN_ERR "sscape: can't grab port 0x%x\n", xport);
1121                 return -EBUSY;
1122         }
1123
1124         /*
1125          * Grab both DMA channels (OK, only one for now) ...
1126          */
1127         if ((err = request_dma(dma[dev], "SoundScape")) < 0) {
1128                 snd_printk(KERN_ERR "sscape: can't grab DMA %d\n", dma[dev]);
1129                 goto _release_region;
1130         }
1131
1132         /*
1133          * Create a new ALSA sound card entry, in anticipation
1134          * of detecting our hardware ...
1135          */
1136         if ((card = snd_card_new(index[dev], id[dev], THIS_MODULE,
1137                                  sizeof(struct soundscape))) == NULL) {
1138                 err = -ENOMEM;
1139                 goto _release_dma;
1140         }
1141
1142         sscape = get_card_soundscape(card);
1143         spin_lock_init(&sscape->lock);
1144         spin_lock_init(&sscape->fwlock);
1145         sscape->io_res = io_res;
1146         sscape->io_base = xport;
1147
1148         if (!detect_sscape(sscape)) {
1149                 printk(KERN_ERR "sscape: hardware not detected at 0x%x\n", sscape->io_base);
1150                 err = -ENODEV;
1151                 goto _release_card;
1152         }
1153
1154         printk(KERN_INFO "sscape: hardware detected at 0x%x, using IRQ %d, DMA %d\n",
1155                          sscape->io_base, irq[dev], dma[dev]);
1156
1157         /*
1158          * Now create the hardware-specific device so that we can
1159          * load the microcode into the on-board processor.
1160          * We cannot use the MPU-401 MIDI system until this firmware
1161          * has been loaded into the card.
1162          */
1163         if ((err = snd_hwdep_new(card, "MC68EC000", 0, &(sscape->hw))) < 0) {
1164                 printk(KERN_ERR "sscape: Failed to create firmware device\n");
1165                 goto _release_card;
1166         }
1167         strlcpy(sscape->hw->name, "SoundScape M68K", sizeof(sscape->hw->name));
1168         sscape->hw->name[sizeof(sscape->hw->name) - 1] = '\0';
1169         sscape->hw->iface = SNDRV_HWDEP_IFACE_SSCAPE;
1170         sscape->hw->ops.open = sscape_hw_open;
1171         sscape->hw->ops.release = sscape_hw_release;
1172         sscape->hw->ops.ioctl = sscape_hw_ioctl;
1173         sscape->hw->private_data = sscape;
1174
1175         /*
1176          * Tell the on-board devices where their resources are (I think -
1177          * I can't be sure without a datasheet ... So many magic values!)
1178          */
1179         spin_lock_irqsave(&sscape->lock, flags);
1180
1181         activate_ad1845_unsafe(sscape->io_base);
1182
1183         sscape_write_unsafe(sscape->io_base, GA_INTENA_REG, 0x00); /* disable */
1184         sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2e);
1185         sscape_write_unsafe(sscape->io_base, GA_SMCFGB_REG, 0x00);
1186
1187         /*
1188          * Enable and configure the DMA channels ...
1189          */
1190         sscape_write_unsafe(sscape->io_base, GA_DMACFG_REG, 0x50);
1191         dma_cfg = (sscape->ic_type == IC_ODIE ? 0x70 : 0x40);
1192         sscape_write_unsafe(sscape->io_base, GA_DMAA_REG, dma_cfg);
1193         sscape_write_unsafe(sscape->io_base, GA_DMAB_REG, 0x20);
1194
1195         sscape_write_unsafe(sscape->io_base,
1196                             GA_INTCFG_REG, 0xf0 | (mpu_irq_cfg << 2) | mpu_irq_cfg);
1197         sscape_write_unsafe(sscape->io_base,
1198                             GA_CDCFG_REG, 0x09 | DMA_8BIT | (dma[dev] << 4) | (irq_cfg << 1));
1199
1200         spin_unlock_irqrestore(&sscape->lock, flags);
1201
1202         /*
1203          * We have now enabled the codec chip, and so we should
1204          * detect the AD1845 device ...
1205          */
1206         if ((err = create_ad1845(card, CODEC_IO(xport), irq[dev], dma[dev])) < 0) {
1207                 printk(KERN_ERR "sscape: No AD1845 device at 0x%x, IRQ %d\n",
1208                                 CODEC_IO(xport), irq[dev]);
1209                 goto _release_card;
1210         }
1211 #define MIDI_DEVNUM  0
1212         if ((err = create_mpu401(card, MIDI_DEVNUM, MPU401_IO(xport), mpu_irq[dev])) < 0) {
1213                 printk(KERN_ERR "sscape: Failed to create MPU-401 device at 0x%x\n",
1214                                 MPU401_IO(xport));
1215                 goto _release_card;
1216         }
1217
1218         /*
1219          * Enable the master IRQ ...
1220          */
1221         sscape_write(sscape, GA_INTENA_REG, 0x80);
1222
1223         /*
1224          * Initialize mixer
1225          */
1226         sscape->midi_vol = 0;
1227         host_write_ctrl_unsafe(sscape->io_base, CMD_SET_MIDI_VOL, 100);
1228         host_write_ctrl_unsafe(sscape->io_base, 0, 100);
1229         host_write_ctrl_unsafe(sscape->io_base, CMD_XXX_MIDI_VOL, 100);
1230
1231         /*
1232          * Now that we have successfully created this sound card,
1233          * it is safe to store the pointer.
1234          * NOTE: we only register the sound card's "destructor"
1235          *       function now that our "constructor" has completed.
1236          */
1237         card->private_free = soundscape_free;
1238         *rcardp = card;
1239
1240         return 0;
1241
1242         _release_card:
1243         snd_card_free(card);
1244
1245         _release_dma:
1246         free_dma(dma[dev]);
1247
1248         _release_region:
1249         release_and_free_resource(io_res);
1250
1251         return err;
1252 }
1253
1254
1255 static int __devinit snd_sscape_match(struct device *pdev, unsigned int i)
1256 {
1257         /*
1258          * Make sure we were given ALL of the other parameters.
1259          */
1260         if (port[i] == SNDRV_AUTO_PORT)
1261                 return 0;
1262
1263         if (irq[i] == SNDRV_AUTO_IRQ ||
1264             mpu_irq[i] == SNDRV_AUTO_IRQ ||
1265             dma[i] == SNDRV_AUTO_DMA) {
1266                 printk(KERN_INFO
1267                        "sscape: insufficient parameters, need IO, IRQ, MPU-IRQ and DMA\n");
1268                 return 0;
1269         }
1270
1271         return 1;
1272 }
1273
1274 static int __devinit snd_sscape_probe(struct device *pdev, unsigned int dev)
1275 {
1276         struct snd_card *card;
1277         int ret;
1278
1279         dma[dev] &= 0x03;
1280         ret = create_sscape(dev, &card);
1281         if (ret < 0)
1282                 return ret;
1283         snd_card_set_dev(card, pdev);
1284         if ((ret = snd_card_register(card)) < 0) {
1285                 printk(KERN_ERR "sscape: Failed to register sound card\n");
1286                 return ret;
1287         }
1288         dev_set_drvdata(pdev, card);
1289         return 0;
1290 }
1291
1292 static int __devexit snd_sscape_remove(struct device *devptr, unsigned int dev)
1293 {
1294         snd_card_free(dev_get_drvdata(devptr));
1295         dev_set_drvdata(devptr, NULL);
1296         return 0;
1297 }
1298
1299 #define DEV_NAME "sscape"
1300
1301 static struct isa_driver snd_sscape_driver = {
1302         .match          = snd_sscape_match,
1303         .probe          = snd_sscape_probe,
1304         .remove         = __devexit_p(snd_sscape_remove),
1305         /* FIXME: suspend/resume */
1306         .driver         = {
1307                 .name   = DEV_NAME
1308         },
1309 };
1310
1311 #ifdef CONFIG_PNP
1312 static inline int __devinit get_next_autoindex(int i)
1313 {
1314         while (i < SNDRV_CARDS && port[i] != SNDRV_AUTO_PORT)
1315                 ++i;
1316         return i;
1317 }
1318
1319
1320 static int __devinit sscape_pnp_detect(struct pnp_card_link *pcard,
1321                                        const struct pnp_card_device_id *pid)
1322 {
1323         static int idx = 0;
1324         struct pnp_dev *dev;
1325         struct snd_card *card;
1326         int ret;
1327
1328         /*
1329          * Allow this function to fail *quietly* if all the ISA PnP
1330          * devices were configured using module parameters instead.
1331          */
1332         if ((idx = get_next_autoindex(idx)) >= SNDRV_CARDS)
1333                 return -ENOSPC;
1334
1335         /*
1336          * We have found a candidate ISA PnP card. Now we
1337          * have to check that it has the devices that we
1338          * expect it to have.
1339          *
1340          * We will NOT try and autoconfigure all of the resources
1341          * needed and then activate the card as we are assuming that
1342          * has already been done at boot-time using /proc/isapnp.
1343          * We shall simply try to give each active card the resources
1344          * that it wants. This is a sensible strategy for a modular
1345          * system where unused modules are unloaded regularly.
1346          *
1347          * This strategy is utterly useless if we compile the driver
1348          * into the kernel, of course.
1349          */
1350         // printk(KERN_INFO "sscape: %s\n", card->name);
1351
1352         /*
1353          * Check that we still have room for another sound card ...
1354          */
1355         dev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
1356         if (! dev)
1357                 return -ENODEV;
1358
1359         if (!pnp_is_active(dev)) {
1360                 if (pnp_activate_dev(dev) < 0) {
1361                         printk(KERN_INFO "sscape: device is inactive\n");
1362                         return -EBUSY;
1363                 }
1364         }
1365
1366         /*
1367          * Read the correct parameters off the ISA PnP bus ...
1368          */
1369         port[idx] = pnp_port_start(dev, 0);
1370         irq[idx] = pnp_irq(dev, 0);
1371         mpu_irq[idx] = pnp_irq(dev, 1);
1372         dma[idx] = pnp_dma(dev, 0) & 0x03;
1373
1374         ret = create_sscape(idx, &card);
1375         if (ret < 0)
1376                 return ret;
1377         snd_card_set_dev(card, &pcard->card->dev);
1378         if ((ret = snd_card_register(card)) < 0) {
1379                 printk(KERN_ERR "sscape: Failed to register sound card\n");
1380                 snd_card_free(card);
1381                 return ret;
1382         }
1383
1384         pnp_set_card_drvdata(pcard, card);
1385         ++idx;
1386
1387         return ret;
1388 }
1389
1390 static void __devexit sscape_pnp_remove(struct pnp_card_link * pcard)
1391 {
1392         snd_card_free(pnp_get_card_drvdata(pcard));
1393         pnp_set_card_drvdata(pcard, NULL);
1394 }
1395
1396 static struct pnp_card_driver sscape_pnpc_driver = {
1397         .flags = PNP_DRIVER_RES_DO_NOT_CHANGE,
1398         .name = "sscape",
1399         .id_table = sscape_pnpids,
1400         .probe = sscape_pnp_detect,
1401         .remove = __devexit_p(sscape_pnp_remove),
1402 };
1403
1404 #endif /* CONFIG_PNP */
1405
1406 static int __init sscape_init(void)
1407 {
1408         int ret;
1409
1410         /*
1411          * First check whether we were passed any parameters.
1412          * These MUST take precedence over ANY automatic way
1413          * of allocating cards, because the operator is
1414          * S-P-E-L-L-I-N-G it out for us...
1415          */
1416         ret = isa_register_driver(&snd_sscape_driver, SNDRV_CARDS);
1417         if (ret < 0)
1418                 return ret;
1419 #ifdef CONFIG_PNP
1420         if (pnp_register_card_driver(&sscape_pnpc_driver) == 0)
1421                 pnp_registered = 1;
1422 #endif
1423         return 0;
1424 }
1425
1426 static void __exit sscape_exit(void)
1427 {
1428 #ifdef CONFIG_PNP
1429         if (pnp_registered)
1430                 pnp_unregister_card_driver(&sscape_pnpc_driver);
1431 #endif
1432         isa_unregister_driver(&snd_sscape_driver);
1433 }
1434
1435 module_init(sscape_init);
1436 module_exit(sscape_exit);