Version:  2.0.40 2.2.26 2.4.37 3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13 3.14 3.15 3.16 3.17 3.18 3.19 4.0

Linux/sound/isa/sscape.c

  1 /*
  2  *   Low-level ALSA driver for the ENSONIQ SoundScape
  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 <linux/init.h>
 25 #include <linux/err.h>
 26 #include <linux/io.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>
 33 #include <asm/dma.h>
 34 #include <sound/core.h>
 35 #include <sound/wss.h>
 36 #include <sound/mpu401.h>
 37 #include <sound/initval.h>
 38 
 39 
 40 MODULE_AUTHOR("Chris Rankin");
 41 MODULE_DESCRIPTION("ENSONIQ SoundScape driver");
 42 MODULE_LICENSE("GPL");
 43 MODULE_FIRMWARE("sndscape.co0");
 44 MODULE_FIRMWARE("sndscape.co1");
 45 MODULE_FIRMWARE("sndscape.co2");
 46 MODULE_FIRMWARE("sndscape.co3");
 47 MODULE_FIRMWARE("sndscape.co4");
 48 MODULE_FIRMWARE("scope.cod");
 49 
 50 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
 51 static char* id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
 52 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
 53 static long wss_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
 54 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;
 55 static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;
 56 static int dma[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;
 57 static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;
 58 static bool joystick[SNDRV_CARDS];
 59 
 60 module_param_array(index, int, NULL, 0444);
 61 MODULE_PARM_DESC(index, "Index number for SoundScape soundcard");
 62 
 63 module_param_array(id, charp, NULL, 0444);
 64 MODULE_PARM_DESC(id, "Description for SoundScape card");
 65 
 66 module_param_array(port, long, NULL, 0444);
 67 MODULE_PARM_DESC(port, "Port # for SoundScape driver.");
 68 
 69 module_param_array(wss_port, long, NULL, 0444);
 70 MODULE_PARM_DESC(wss_port, "WSS Port # for SoundScape driver.");
 71 
 72 module_param_array(irq, int, NULL, 0444);
 73 MODULE_PARM_DESC(irq, "IRQ # for SoundScape driver.");
 74 
 75 module_param_array(mpu_irq, int, NULL, 0444);
 76 MODULE_PARM_DESC(mpu_irq, "MPU401 IRQ # for SoundScape driver.");
 77 
 78 module_param_array(dma, int, NULL, 0444);
 79 MODULE_PARM_DESC(dma, "DMA # for SoundScape driver.");
 80 
 81 module_param_array(dma2, int, NULL, 0444);
 82 MODULE_PARM_DESC(dma2, "DMA2 # for SoundScape driver.");
 83 
 84 module_param_array(joystick, bool, NULL, 0444);
 85 MODULE_PARM_DESC(joystick, "Enable gameport.");
 86 
 87 #ifdef CONFIG_PNP
 88 static int isa_registered;
 89 static int pnp_registered;
 90 
 91 static struct pnp_card_device_id sscape_pnpids[] = {
 92         { .id = "ENS3081", .devs = { { "ENS0000" } } }, /* Soundscape PnP */
 93         { .id = "ENS4081", .devs = { { "ENS1011" } } }, /* VIVO90 */
 94         { .id = "" }    /* end */
 95 };
 96 
 97 MODULE_DEVICE_TABLE(pnp_card, sscape_pnpids);
 98 #endif
 99 
100 
101 #define HOST_CTRL_IO(i)  ((i) + 2)
102 #define HOST_DATA_IO(i)  ((i) + 3)
103 #define ODIE_ADDR_IO(i)  ((i) + 4)
104 #define ODIE_DATA_IO(i)  ((i) + 5)
105 #define CODEC_IO(i)      ((i) + 8)
106 
107 #define IC_ODIE  1
108 #define IC_OPUS  2
109 
110 #define RX_READY 0x01
111 #define TX_READY 0x02
112 
113 #define CMD_ACK                 0x80
114 #define CMD_SET_MIDI_VOL        0x84
115 #define CMD_GET_MIDI_VOL        0x85
116 #define CMD_XXX_MIDI_VOL        0x86
117 #define CMD_SET_EXTMIDI         0x8a
118 #define CMD_GET_EXTMIDI         0x8b
119 #define CMD_SET_MT32            0x8c
120 #define CMD_GET_MT32            0x8d
121 
122 enum GA_REG {
123         GA_INTSTAT_REG = 0,
124         GA_INTENA_REG,
125         GA_DMAA_REG,
126         GA_DMAB_REG,
127         GA_INTCFG_REG,
128         GA_DMACFG_REG,
129         GA_CDCFG_REG,
130         GA_SMCFGA_REG,
131         GA_SMCFGB_REG,
132         GA_HMCTL_REG
133 };
134 
135 #define DMA_8BIT  0x80
136 
137 
138 enum card_type {
139         MEDIA_FX,       /* Sequoia S-1000 */
140         SSCAPE,         /* Sequoia S-2000 */
141         SSCAPE_PNP,
142         SSCAPE_VIVO,
143 };
144 
145 struct soundscape {
146         spinlock_t lock;
147         unsigned io_base;
148         int ic_type;
149         enum card_type type;
150         struct resource *io_res;
151         struct resource *wss_res;
152         struct snd_wss *chip;
153 
154         unsigned char midi_vol;
155 };
156 
157 #define INVALID_IRQ  ((unsigned)-1)
158 
159 
160 static inline struct soundscape *get_card_soundscape(struct snd_card *c)
161 {
162         return (struct soundscape *) (c->private_data);
163 }
164 
165 /*
166  * Allocates some kernel memory that we can use for DMA.
167  * I think this means that the memory has to map to
168  * contiguous pages of physical memory.
169  */
170 static struct snd_dma_buffer *get_dmabuf(struct snd_dma_buffer *buf,
171                                          unsigned long size)
172 {
173         if (buf) {
174                 if (snd_dma_alloc_pages_fallback(SNDRV_DMA_TYPE_DEV,
175                                                  snd_dma_isa_data(),
176                                                  size, buf) < 0) {
177                         snd_printk(KERN_ERR "sscape: Failed to allocate "
178                                             "%lu bytes for DMA\n",
179                                             size);
180                         return NULL;
181                 }
182         }
183 
184         return buf;
185 }
186 
187 /*
188  * Release the DMA-able kernel memory ...
189  */
190 static void free_dmabuf(struct snd_dma_buffer *buf)
191 {
192         if (buf && buf->area)
193                 snd_dma_free_pages(buf);
194 }
195 
196 /*
197  * This function writes to the SoundScape's control registers,
198  * but doesn't do any locking. It's up to the caller to do that.
199  * This is why this function is "unsafe" ...
200  */
201 static inline void sscape_write_unsafe(unsigned io_base, enum GA_REG reg,
202                                        unsigned char val)
203 {
204         outb(reg, ODIE_ADDR_IO(io_base));
205         outb(val, ODIE_DATA_IO(io_base));
206 }
207 
208 /*
209  * Write to the SoundScape's control registers, and do the
210  * necessary locking ...
211  */
212 static void sscape_write(struct soundscape *s, enum GA_REG reg,
213                          unsigned char val)
214 {
215         unsigned long flags;
216 
217         spin_lock_irqsave(&s->lock, flags);
218         sscape_write_unsafe(s->io_base, reg, val);
219         spin_unlock_irqrestore(&s->lock, flags);
220 }
221 
222 /*
223  * Read from the SoundScape's control registers, but leave any
224  * locking to the caller. This is why the function is "unsafe" ...
225  */
226 static inline unsigned char sscape_read_unsafe(unsigned io_base,
227                                                enum GA_REG reg)
228 {
229         outb(reg, ODIE_ADDR_IO(io_base));
230         return inb(ODIE_DATA_IO(io_base));
231 }
232 
233 /*
234  * Puts the SoundScape into "host" mode, as compared to "MIDI" mode
235  */
236 static inline void set_host_mode_unsafe(unsigned io_base)
237 {
238         outb(0x0, HOST_CTRL_IO(io_base));
239 }
240 
241 /*
242  * Puts the SoundScape into "MIDI" mode, as compared to "host" mode
243  */
244 static inline void set_midi_mode_unsafe(unsigned io_base)
245 {
246         outb(0x3, HOST_CTRL_IO(io_base));
247 }
248 
249 /*
250  * Read the SoundScape's host-mode control register, but leave
251  * any locking issues to the caller ...
252  */
253 static inline int host_read_unsafe(unsigned io_base)
254 {
255         int data = -1;
256         if ((inb(HOST_CTRL_IO(io_base)) & RX_READY) != 0)
257                 data = inb(HOST_DATA_IO(io_base));
258 
259         return data;
260 }
261 
262 /*
263  * Read the SoundScape's host-mode control register, performing
264  * a limited amount of busy-waiting if the register isn't ready.
265  * Also leaves all locking-issues to the caller ...
266  */
267 static int host_read_ctrl_unsafe(unsigned io_base, unsigned timeout)
268 {
269         int data;
270 
271         while (((data = host_read_unsafe(io_base)) < 0) && (timeout != 0)) {
272                 udelay(100);
273                 --timeout;
274         } /* while */
275 
276         return data;
277 }
278 
279 /*
280  * Write to the SoundScape's host-mode control registers, but
281  * leave any locking issues to the caller ...
282  */
283 static inline int host_write_unsafe(unsigned io_base, unsigned char data)
284 {
285         if ((inb(HOST_CTRL_IO(io_base)) & TX_READY) != 0) {
286                 outb(data, HOST_DATA_IO(io_base));
287                 return 1;
288         }
289 
290         return 0;
291 }
292 
293 /*
294  * Write to the SoundScape's host-mode control registers, performing
295  * a limited amount of busy-waiting if the register isn't ready.
296  * Also leaves all locking-issues to the caller ...
297  */
298 static int host_write_ctrl_unsafe(unsigned io_base, unsigned char data,
299                                   unsigned timeout)
300 {
301         int err;
302 
303         while (!(err = host_write_unsafe(io_base, data)) && (timeout != 0)) {
304                 udelay(100);
305                 --timeout;
306         } /* while */
307 
308         return err;
309 }
310 
311 
312 /*
313  * Check that the MIDI subsystem is operational. If it isn't,
314  * then we will hang the computer if we try to use it ...
315  *
316  * NOTE: This check is based upon observation, not documentation.
317  */
318 static inline int verify_mpu401(const struct snd_mpu401 *mpu)
319 {
320         return ((inb(MPU401C(mpu)) & 0xc0) == 0x80);
321 }
322 
323 /*
324  * This is apparently the standard way to initailise an MPU-401
325  */
326 static inline void initialise_mpu401(const struct snd_mpu401 *mpu)
327 {
328         outb(0, MPU401D(mpu));
329 }
330 
331 /*
332  * Tell the SoundScape to activate the AD1845 chip (I think).
333  * The AD1845 detection fails if we *don't* do this, so I
334  * think that this is a good idea ...
335  */
336 static void activate_ad1845_unsafe(unsigned io_base)
337 {
338         unsigned char val = sscape_read_unsafe(io_base, GA_HMCTL_REG);
339         sscape_write_unsafe(io_base, GA_HMCTL_REG, (val & 0xcf) | 0x10);
340         sscape_write_unsafe(io_base, GA_CDCFG_REG, 0x80);
341 }
342 
343 /*
344  * Do the necessary ALSA-level cleanup to deallocate our driver ...
345  */
346 static void soundscape_free(struct snd_card *c)
347 {
348         struct soundscape *sscape = get_card_soundscape(c);
349         release_and_free_resource(sscape->io_res);
350         release_and_free_resource(sscape->wss_res);
351         free_dma(sscape->chip->dma1);
352 }
353 
354 /*
355  * Tell the SoundScape to begin a DMA tranfer using the given channel.
356  * All locking issues are left to the caller.
357  */
358 static void sscape_start_dma_unsafe(unsigned io_base, enum GA_REG reg)
359 {
360         sscape_write_unsafe(io_base, reg,
361                             sscape_read_unsafe(io_base, reg) | 0x01);
362         sscape_write_unsafe(io_base, reg,
363                             sscape_read_unsafe(io_base, reg) & 0xfe);
364 }
365 
366 /*
367  * Wait for a DMA transfer to complete. This is a "limited busy-wait",
368  * and all locking issues are left to the caller.
369  */
370 static int sscape_wait_dma_unsafe(unsigned io_base, enum GA_REG reg,
371                                   unsigned timeout)
372 {
373         while (!(sscape_read_unsafe(io_base, reg) & 0x01) && (timeout != 0)) {
374                 udelay(100);
375                 --timeout;
376         } /* while */
377 
378         return sscape_read_unsafe(io_base, reg) & 0x01;
379 }
380 
381 /*
382  * Wait for the On-Board Processor to return its start-up
383  * acknowledgement sequence. This wait is too long for
384  * us to perform "busy-waiting", and so we must sleep.
385  * This in turn means that we must not be holding any
386  * spinlocks when we call this function.
387  */
388 static int obp_startup_ack(struct soundscape *s, unsigned timeout)
389 {
390         unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
391 
392         do {
393                 unsigned long flags;
394                 int x;
395 
396                 spin_lock_irqsave(&s->lock, flags);
397                 x = host_read_unsafe(s->io_base);
398                 spin_unlock_irqrestore(&s->lock, flags);
399                 if (x == 0xfe || x == 0xff)
400                         return 1;
401 
402                 msleep(10);
403         } while (time_before(jiffies, end_time));
404 
405         return 0;
406 }
407 
408 /*
409  * Wait for the host to return its start-up acknowledgement
410  * sequence. This wait is too long for us to perform
411  * "busy-waiting", and so we must sleep. This in turn means
412  * that we must not be holding any spinlocks when we call
413  * this function.
414  */
415 static int host_startup_ack(struct soundscape *s, unsigned timeout)
416 {
417         unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
418 
419         do {
420                 unsigned long flags;
421                 int x;
422 
423                 spin_lock_irqsave(&s->lock, flags);
424                 x = host_read_unsafe(s->io_base);
425                 spin_unlock_irqrestore(&s->lock, flags);
426                 if (x == 0xfe)
427                         return 1;
428 
429                 msleep(10);
430         } while (time_before(jiffies, end_time));
431 
432         return 0;
433 }
434 
435 /*
436  * Upload a byte-stream into the SoundScape using DMA channel A.
437  */
438 static int upload_dma_data(struct soundscape *s, const unsigned char *data,
439                            size_t size)
440 {
441         unsigned long flags;
442         struct snd_dma_buffer dma;
443         int ret;
444         unsigned char val;
445 
446         if (!get_dmabuf(&dma, PAGE_ALIGN(32 * 1024)))
447                 return -ENOMEM;
448 
449         spin_lock_irqsave(&s->lock, flags);
450 
451         /*
452          * Reset the board ...
453          */
454         val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
455         sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val & 0x3f);
456 
457         /*
458          * Enable the DMA channels and configure them ...
459          */
460         val = (s->chip->dma1 << 4) | DMA_8BIT;
461         sscape_write_unsafe(s->io_base, GA_DMAA_REG, val);
462         sscape_write_unsafe(s->io_base, GA_DMAB_REG, 0x20);
463 
464         /*
465          * Take the board out of reset ...
466          */
467         val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
468         sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val | 0x80);
469 
470         /*
471          * Upload the firmware to the SoundScape
472          * board through the DMA channel ...
473          */
474         while (size != 0) {
475                 unsigned long len;
476 
477                 len = min(size, dma.bytes);
478                 memcpy(dma.area, data, len);
479                 data += len;
480                 size -= len;
481 
482                 snd_dma_program(s->chip->dma1, dma.addr, len, DMA_MODE_WRITE);
483                 sscape_start_dma_unsafe(s->io_base, GA_DMAA_REG);
484                 if (!sscape_wait_dma_unsafe(s->io_base, GA_DMAA_REG, 5000)) {
485                         /*
486                          * Don't forget to release this spinlock we're holding
487                          */
488                         spin_unlock_irqrestore(&s->lock, flags);
489 
490                         snd_printk(KERN_ERR
491                                         "sscape: DMA upload has timed out\n");
492                         ret = -EAGAIN;
493                         goto _release_dma;
494                 }
495         } /* while */
496 
497         set_host_mode_unsafe(s->io_base);
498         outb(0x0, s->io_base);
499 
500         /*
501          * Boot the board ... (I think)
502          */
503         val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
504         sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val | 0x40);
505         spin_unlock_irqrestore(&s->lock, flags);
506 
507         /*
508          * If all has gone well, then the board should acknowledge
509          * the new upload and tell us that it has rebooted OK. We
510          * give it 5 seconds (max) ...
511          */
512         ret = 0;
513         if (!obp_startup_ack(s, 5000)) {
514                 snd_printk(KERN_ERR "sscape: No response "
515                                     "from on-board processor after upload\n");
516                 ret = -EAGAIN;
517         } else if (!host_startup_ack(s, 5000)) {
518                 snd_printk(KERN_ERR
519                                 "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_OPUS ? 0x40 : 0x70));
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 static int sscape_upload_bootblock(struct snd_card *card)
539 {
540         struct soundscape *sscape = get_card_soundscape(card);
541         unsigned long flags;
542         const struct firmware *init_fw = NULL;
543         int data = 0;
544         int ret;
545 
546         ret = request_firmware(&init_fw, "scope.cod", card->dev);
547         if (ret < 0) {
548                 snd_printk(KERN_ERR "sscape: Error loading scope.cod");
549                 return ret;
550         }
551         ret = upload_dma_data(sscape, init_fw->data, init_fw->size);
552 
553         release_firmware(init_fw);
554 
555         spin_lock_irqsave(&sscape->lock, flags);
556         if (ret == 0)
557                 data = host_read_ctrl_unsafe(sscape->io_base, 100);
558 
559         if (data & 0x10)
560                 sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2f);
561 
562         spin_unlock_irqrestore(&sscape->lock, flags);
563 
564         data &= 0xf;
565         if (ret == 0 && data > 7) {
566                 snd_printk(KERN_ERR
567                                 "sscape: timeout reading firmware version\n");
568                 ret = -EAGAIN;
569         }
570 
571         return (ret == 0) ? data : ret;
572 }
573 
574 /*
575  * Upload the microcode into the SoundScape.
576  */
577 static int sscape_upload_microcode(struct snd_card *card, int version)
578 {
579         struct soundscape *sscape = get_card_soundscape(card);
580         const struct firmware *init_fw = NULL;
581         char name[14];
582         int err;
583 
584         snprintf(name, sizeof(name), "sndscape.co%d", version);
585 
586         err = request_firmware(&init_fw, name, card->dev);
587         if (err < 0) {
588                 snd_printk(KERN_ERR "sscape: Error loading sndscape.co%d",
589                                 version);
590                 return err;
591         }
592         err = upload_dma_data(sscape, init_fw->data, init_fw->size);
593         if (err == 0)
594                 snd_printk(KERN_INFO "sscape: MIDI firmware loaded %d KBs\n",
595                                 init_fw->size >> 10);
596 
597         release_firmware(init_fw);
598 
599         return err;
600 }
601 
602 /*
603  * Mixer control for the SoundScape's MIDI device.
604  */
605 static int sscape_midi_info(struct snd_kcontrol *ctl,
606                             struct snd_ctl_elem_info *uinfo)
607 {
608         uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
609         uinfo->count = 1;
610         uinfo->value.integer.min = 0;
611         uinfo->value.integer.max = 127;
612         return 0;
613 }
614 
615 static int sscape_midi_get(struct snd_kcontrol *kctl,
616                            struct snd_ctl_elem_value *uctl)
617 {
618         struct snd_wss *chip = snd_kcontrol_chip(kctl);
619         struct snd_card *card = chip->card;
620         register struct soundscape *s = get_card_soundscape(card);
621         unsigned long flags;
622 
623         spin_lock_irqsave(&s->lock, flags);
624         uctl->value.integer.value[0] = s->midi_vol;
625         spin_unlock_irqrestore(&s->lock, flags);
626         return 0;
627 }
628 
629 static int sscape_midi_put(struct snd_kcontrol *kctl,
630                            struct snd_ctl_elem_value *uctl)
631 {
632         struct snd_wss *chip = snd_kcontrol_chip(kctl);
633         struct snd_card *card = chip->card;
634         struct soundscape *s = get_card_soundscape(card);
635         unsigned long flags;
636         int change;
637         unsigned char new_val;
638 
639         spin_lock_irqsave(&s->lock, flags);
640 
641         new_val = uctl->value.integer.value[0] & 127;
642         /*
643          * We need to put the board into HOST mode before we
644          * can send any volume-changing HOST commands ...
645          */
646         set_host_mode_unsafe(s->io_base);
647 
648         /*
649          * To successfully change the MIDI volume setting, you seem to
650          * have to write a volume command, write the new volume value,
651          * and then perform another volume-related command. Perhaps the
652          * first command is an "open" and the second command is a "close"?
653          */
654         if (s->midi_vol == new_val) {
655                 change = 0;
656                 goto __skip_change;
657         }
658         change = host_write_ctrl_unsafe(s->io_base, CMD_SET_MIDI_VOL, 100)
659                  && host_write_ctrl_unsafe(s->io_base, new_val, 100)
660                  && host_write_ctrl_unsafe(s->io_base, CMD_XXX_MIDI_VOL, 100)
661                  && host_write_ctrl_unsafe(s->io_base, new_val, 100);
662         s->midi_vol = new_val;
663 __skip_change:
664 
665         /*
666          * Take the board out of HOST mode and back into MIDI mode ...
667          */
668         set_midi_mode_unsafe(s->io_base);
669 
670         spin_unlock_irqrestore(&s->lock, flags);
671         return change;
672 }
673 
674 static struct snd_kcontrol_new midi_mixer_ctl = {
675         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
676         .name = "MIDI",
677         .info = sscape_midi_info,
678         .get = sscape_midi_get,
679         .put = sscape_midi_put
680 };
681 
682 /*
683  * The SoundScape can use two IRQs from a possible set of four.
684  * These IRQs are encoded as bit patterns so that they can be
685  * written to the control registers.
686  */
687 static unsigned get_irq_config(int sscape_type, int irq)
688 {
689         static const int valid_irq[] = { 9, 5, 7, 10 };
690         static const int old_irq[] = { 9, 7, 5, 15 };
691         unsigned cfg;
692 
693         if (sscape_type == MEDIA_FX) {
694                 for (cfg = 0; cfg < ARRAY_SIZE(old_irq); ++cfg)
695                         if (irq == old_irq[cfg])
696                                 return cfg;
697         } else {
698                 for (cfg = 0; cfg < ARRAY_SIZE(valid_irq); ++cfg)
699                         if (irq == valid_irq[cfg])
700                                 return cfg;
701         }
702 
703         return INVALID_IRQ;
704 }
705 
706 /*
707  * Perform certain arcane port-checks to see whether there
708  * is a SoundScape board lurking behind the given ports.
709  */
710 static int detect_sscape(struct soundscape *s, long wss_io)
711 {
712         unsigned long flags;
713         unsigned d;
714         int retval = 0;
715 
716         spin_lock_irqsave(&s->lock, flags);
717 
718         /*
719          * The following code is lifted from the original OSS driver,
720          * and as I don't have a datasheet I cannot really comment
721          * on what it is doing...
722          */
723         if ((inb(HOST_CTRL_IO(s->io_base)) & 0x78) != 0)
724                 goto _done;
725 
726         d = inb(ODIE_ADDR_IO(s->io_base)) & 0xf0;
727         if ((d & 0x80) != 0)
728                 goto _done;
729 
730         if (d == 0)
731                 s->ic_type = IC_ODIE;
732         else if ((d & 0x60) != 0)
733                 s->ic_type = IC_OPUS;
734         else
735                 goto _done;
736 
737         outb(0xfa, ODIE_ADDR_IO(s->io_base));
738         if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0a)
739                 goto _done;
740 
741         outb(0xfe, ODIE_ADDR_IO(s->io_base));
742         if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0e)
743                 goto _done;
744 
745         outb(0xfe, ODIE_ADDR_IO(s->io_base));
746         d = inb(ODIE_DATA_IO(s->io_base));
747         if (s->type != SSCAPE_VIVO && (d & 0x9f) != 0x0e)
748                 goto _done;
749 
750         if (s->ic_type == IC_OPUS)
751                 activate_ad1845_unsafe(s->io_base);
752 
753         if (s->type == SSCAPE_VIVO)
754                 wss_io += 4;
755 
756         d  = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
757         sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
758 
759         /* wait for WSS codec */
760         for (d = 0; d < 500; d++) {
761                 if ((inb(wss_io) & 0x80) == 0)
762                         break;
763                 spin_unlock_irqrestore(&s->lock, flags);
764                 msleep(1);
765                 spin_lock_irqsave(&s->lock, flags);
766         }
767 
768         if ((inb(wss_io) & 0x80) != 0)
769                 goto _done;
770 
771         if (inb(wss_io + 2) == 0xff)
772                 goto _done;
773 
774         d  = sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f;
775         sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d);
776 
777         if ((inb(wss_io) & 0x80) != 0)
778                 s->type = MEDIA_FX;
779 
780         d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
781         sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
782         /* wait for WSS codec */
783         for (d = 0; d < 500; d++) {
784                 if ((inb(wss_io) & 0x80) == 0)
785                         break;
786                 spin_unlock_irqrestore(&s->lock, flags);
787                 msleep(1);
788                 spin_lock_irqsave(&s->lock, flags);
789         }
790 
791         /*
792          * SoundScape successfully detected!
793          */
794         retval = 1;
795 
796 _done:
797         spin_unlock_irqrestore(&s->lock, flags);
798         return retval;
799 }
800 
801 /*
802  * ALSA callback function, called when attempting to open the MIDI device.
803  * Check that the MIDI firmware has been loaded, because we don't want
804  * to crash the machine. Also check that someone isn't using the hardware
805  * IOCTL device.
806  */
807 static int mpu401_open(struct snd_mpu401 *mpu)
808 {
809         if (!verify_mpu401(mpu)) {
810                 snd_printk(KERN_ERR "sscape: MIDI disabled, "
811                                     "please load firmware\n");
812                 return -ENODEV;
813         }
814 
815         return 0;
816 }
817 
818 /*
819  * Initialse an MPU-401 subdevice for MIDI support on the SoundScape.
820  */
821 static int create_mpu401(struct snd_card *card, int devnum,
822                          unsigned long port, int irq)
823 {
824         struct soundscape *sscape = get_card_soundscape(card);
825         struct snd_rawmidi *rawmidi;
826         int err;
827 
828         err = snd_mpu401_uart_new(card, devnum, MPU401_HW_MPU401, port,
829                                   MPU401_INFO_INTEGRATED, irq, &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;
835 
836                 initialise_mpu401(mpu);
837         }
838 
839         return err;
840 }
841 
842 
843 /*
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.
848  */
849 static int create_ad1845(struct snd_card *card, unsigned port,
850                          int irq, int dma1, int dma2)
851 {
852         register struct soundscape *sscape = get_card_soundscape(card);
853         struct snd_wss *chip;
854         int err;
855         int codec_type = WSS_HW_DETECT;
856 
857         switch (sscape->type) {
858         case MEDIA_FX:
859         case SSCAPE:
860                 /*
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.
865                  */
866                 if (sscape->ic_type != IC_OPUS)
867                         codec_type = WSS_HW_AD1848;
868                 break;
869 
870         case SSCAPE_VIVO:
871                 port += 4;
872                 break;
873         default:
874                 break;
875         }
876 
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 
882                 if (sscape->type != SSCAPE_VIVO) {
883                         /*
884                          * The input clock frequency on the SoundScape must
885                          * be 14.31818 MHz, because we must set this register
886                          * to get the playback to sound correct ...
887                          */
888                         snd_wss_mce_up(chip);
889                         spin_lock_irqsave(&chip->reg_lock, flags);
890                         snd_wss_out(chip, AD1845_CLOCK, 0x20);
891                         spin_unlock_irqrestore(&chip->reg_lock, flags);
892                         snd_wss_mce_down(chip);
893 
894                 }
895 
896                 err = snd_wss_pcm(chip, 0);
897                 if (err < 0) {
898                         snd_printk(KERN_ERR "sscape: No PCM device "
899                                             "for AD1845 chip\n");
900                         goto _error;
901                 }
902 
903                 err = snd_wss_mixer(chip);
904                 if (err < 0) {
905                         snd_printk(KERN_ERR "sscape: No mixer device "
906                                             "for AD1845 chip\n");
907                         goto _error;
908                 }
909                 if (chip->hardware != WSS_HW_AD1848) {
910                         err = snd_wss_timer(chip, 0);
911                         if (err < 0) {
912                                 snd_printk(KERN_ERR "sscape: No timer device "
913                                                     "for AD1845 chip\n");
914                                 goto _error;
915                         }
916                 }
917 
918                 if (sscape->type != SSCAPE_VIVO) {
919                         err = snd_ctl_add(card,
920                                           snd_ctl_new1(&midi_mixer_ctl, chip));
921                         if (err < 0) {
922                                 snd_printk(KERN_ERR "sscape: Could not create "
923                                                     "MIDI mixer control\n");
924                                 goto _error;
925                         }
926                 }
927 
928                 sscape->chip = chip;
929         }
930 
931 _error:
932         return err;
933 }
934 
935 
936 /*
937  * Create an ALSA soundcard entry for the SoundScape, using
938  * the given list of port, IRQ and DMA resources.
939  */
940 static int create_sscape(int dev, struct snd_card *card)
941 {
942         struct soundscape *sscape = get_card_soundscape(card);
943         unsigned dma_cfg;
944         unsigned irq_cfg;
945         unsigned mpu_irq_cfg;
946         struct resource *io_res;
947         struct resource *wss_res;
948         unsigned long flags;
949         int err;
950         int val;
951         const char *name;
952 
953         /*
954          * Grab IO ports that we will need to probe so that we
955          * can detect and control this hardware ...
956          */
957         io_res = request_region(port[dev], 8, "SoundScape");
958         if (!io_res) {
959                 snd_printk(KERN_ERR
960                            "sscape: can't grab port 0x%lx\n", port[dev]);
961                 return -EBUSY;
962         }
963         wss_res = NULL;
964         if (sscape->type == SSCAPE_VIVO) {
965                 wss_res = request_region(wss_port[dev], 4, "SoundScape");
966                 if (!wss_res) {
967                         snd_printk(KERN_ERR "sscape: can't grab port 0x%lx\n",
968                                             wss_port[dev]);
969                         err = -EBUSY;
970                         goto _release_region;
971                 }
972         }
973 
974         /*
975          * Grab one DMA channel ...
976          */
977         err = request_dma(dma[dev], "SoundScape");
978         if (err < 0) {
979                 snd_printk(KERN_ERR "sscape: can't grab DMA %d\n", dma[dev]);
980                 goto _release_region;
981         }
982 
983         spin_lock_init(&sscape->lock);
984         sscape->io_res = io_res;
985         sscape->wss_res = wss_res;
986         sscape->io_base = port[dev];
987 
988         if (!detect_sscape(sscape, wss_port[dev])) {
989                 printk(KERN_ERR "sscape: hardware not detected at 0x%x\n",
990                         sscape->io_base);
991                 err = -ENODEV;
992                 goto _release_dma;
993         }
994 
995         switch (sscape->type) {
996         case MEDIA_FX:
997                 name = "MediaFX/SoundFX";
998                 break;
999         case SSCAPE:
1000                 name = "Soundscape";
1001                 break;
1002         case SSCAPE_PNP:
1003                 name = "Soundscape PnP";
1004                 break;
1005         case SSCAPE_VIVO:
1006                 name = "Soundscape VIVO";
1007                 break;
1008         default:
1009                 name = "unknown Soundscape";
1010                 break;
1011         }
1012 
1013         printk(KERN_INFO "sscape: %s card detected at 0x%x, using IRQ %d, DMA %d\n",
1014                          name, sscape->io_base, irq[dev], dma[dev]);
1015 
1016         /*
1017          * Check that the user didn't pass us garbage data ...
1018          */
1019         irq_cfg = get_irq_config(sscape->type, irq[dev]);
1020         if (irq_cfg == INVALID_IRQ) {
1021                 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", irq[dev]);
1022                 err = -ENXIO;
1023                 goto _release_dma;
1024         }
1025 
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                 err = -ENXIO;
1030                 goto _release_dma;
1031         }
1032 
1033         /*
1034          * Tell the on-board devices where their resources are (I think -
1035          * I can't be sure without a datasheet ... So many magic values!)
1036          */
1037         spin_lock_irqsave(&sscape->lock, flags);
1038 
1039         sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2e);
1040         sscape_write_unsafe(sscape->io_base, GA_SMCFGB_REG, 0x00);
1041 
1042         /*
1043          * Enable and configure the DMA channels ...
1044          */
1045         sscape_write_unsafe(sscape->io_base, GA_DMACFG_REG, 0x50);
1046         dma_cfg = (sscape->ic_type == IC_OPUS ? 0x40 : 0x70);
1047         sscape_write_unsafe(sscape->io_base, GA_DMAA_REG, dma_cfg);
1048         sscape_write_unsafe(sscape->io_base, GA_DMAB_REG, 0x20);
1049 
1050         mpu_irq_cfg |= mpu_irq_cfg << 2;
1051         val = sscape_read_unsafe(sscape->io_base, GA_HMCTL_REG) & 0xF7;
1052         if (joystick[dev])
1053                 val |= 8;
1054         sscape_write_unsafe(sscape->io_base, GA_HMCTL_REG, val | 0x10);
1055         sscape_write_unsafe(sscape->io_base, GA_INTCFG_REG, 0xf0 | mpu_irq_cfg);
1056         sscape_write_unsafe(sscape->io_base,
1057                             GA_CDCFG_REG, 0x09 | DMA_8BIT
1058                             | (dma[dev] << 4) | (irq_cfg << 1));
1059         /*
1060          * Enable the master IRQ ...
1061          */
1062         sscape_write_unsafe(sscape->io_base, GA_INTENA_REG, 0x80);
1063 
1064         spin_unlock_irqrestore(&sscape->lock, flags);
1065 
1066         /*
1067          * We have now enabled the codec chip, and so we should
1068          * detect the AD1845 device ...
1069          */
1070         err = create_ad1845(card, wss_port[dev], irq[dev],
1071                             dma[dev], dma2[dev]);
1072         if (err < 0) {
1073                 snd_printk(KERN_ERR
1074                                 "sscape: No AD1845 device at 0x%lx, IRQ %d\n",
1075                                 wss_port[dev], irq[dev]);
1076                 goto _release_dma;
1077         }
1078         strcpy(card->driver, "SoundScape");
1079         strcpy(card->shortname, name);
1080         snprintf(card->longname, sizeof(card->longname),
1081                  "%s at 0x%lx, IRQ %d, DMA1 %d, DMA2 %d\n",
1082                  name, sscape->chip->port, sscape->chip->irq,
1083                  sscape->chip->dma1, sscape->chip->dma2);
1084 
1085 #define MIDI_DEVNUM  0
1086         if (sscape->type != SSCAPE_VIVO) {
1087                 err = sscape_upload_bootblock(card);
1088                 if (err >= 0)
1089                         err = sscape_upload_microcode(card, err);
1090 
1091                 if (err == 0) {
1092                         err = create_mpu401(card, MIDI_DEVNUM, port[dev],
1093                                             mpu_irq[dev]);
1094                         if (err < 0) {
1095                                 snd_printk(KERN_ERR "sscape: Failed to create "
1096                                                 "MPU-401 device at 0x%lx\n",
1097                                                 port[dev]);
1098                                 goto _release_dma;
1099                         }
1100 
1101                         /*
1102                          * Initialize mixer
1103                          */
1104                         spin_lock_irqsave(&sscape->lock, flags);
1105                         sscape->midi_vol = 0;
1106                         host_write_ctrl_unsafe(sscape->io_base,
1107                                                 CMD_SET_MIDI_VOL, 100);
1108                         host_write_ctrl_unsafe(sscape->io_base,
1109                                                 sscape->midi_vol, 100);
1110                         host_write_ctrl_unsafe(sscape->io_base,
1111                                                 CMD_XXX_MIDI_VOL, 100);
1112                         host_write_ctrl_unsafe(sscape->io_base,
1113                                                 sscape->midi_vol, 100);
1114                         host_write_ctrl_unsafe(sscape->io_base,
1115                                                 CMD_SET_EXTMIDI, 100);
1116                         host_write_ctrl_unsafe(sscape->io_base,
1117                                                 0, 100);
1118                         host_write_ctrl_unsafe(sscape->io_base, CMD_ACK, 100);
1119 
1120                         set_midi_mode_unsafe(sscape->io_base);
1121                         spin_unlock_irqrestore(&sscape->lock, flags);
1122                 }
1123         }
1124 
1125         /*
1126          * Now that we have successfully created this sound card,
1127          * it is safe to store the pointer.
1128          * NOTE: we only register the sound card's "destructor"
1129          *       function now that our "constructor" has completed.
1130          */
1131         card->private_free = soundscape_free;
1132 
1133         return 0;
1134 
1135 _release_dma:
1136         free_dma(dma[dev]);
1137 
1138 _release_region:
1139         release_and_free_resource(wss_res);
1140         release_and_free_resource(io_res);
1141 
1142         return err;
1143 }
1144 
1145 
1146 static int snd_sscape_match(struct device *pdev, unsigned int i)
1147 {
1148         /*
1149          * Make sure we were given ALL of the other parameters.
1150          */
1151         if (port[i] == SNDRV_AUTO_PORT)
1152                 return 0;
1153 
1154         if (irq[i] == SNDRV_AUTO_IRQ ||
1155             mpu_irq[i] == SNDRV_AUTO_IRQ ||
1156             dma[i] == SNDRV_AUTO_DMA) {
1157                 printk(KERN_INFO
1158                        "sscape: insufficient parameters, "
1159                        "need IO, IRQ, MPU-IRQ and DMA\n");
1160                 return 0;
1161         }
1162 
1163         return 1;
1164 }
1165 
1166 static int snd_sscape_probe(struct device *pdev, unsigned int dev)
1167 {
1168         struct snd_card *card;
1169         struct soundscape *sscape;
1170         int ret;
1171 
1172         ret = snd_card_new(pdev, index[dev], id[dev], THIS_MODULE,
1173                            sizeof(struct soundscape), &card);
1174         if (ret < 0)
1175                 return ret;
1176 
1177         sscape = get_card_soundscape(card);
1178         sscape->type = SSCAPE;
1179 
1180         dma[dev] &= 0x03;
1181 
1182         ret = create_sscape(dev, card);
1183         if (ret < 0)
1184                 goto _release_card;
1185 
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;
1190         }
1191         dev_set_drvdata(pdev, card);
1192         return 0;
1193 
1194 _release_card:
1195         snd_card_free(card);
1196         return ret;
1197 }
1198 
1199 static int snd_sscape_remove(struct device *devptr, unsigned int dev)
1200 {
1201         snd_card_free(dev_get_drvdata(devptr));
1202         return 0;
1203 }
1204 
1205 #define DEV_NAME "sscape"
1206 
1207 static struct isa_driver snd_sscape_driver = {
1208         .match          = snd_sscape_match,
1209         .probe          = snd_sscape_probe,
1210         .remove         = snd_sscape_remove,
1211         /* FIXME: suspend/resume */
1212         .driver         = {
1213                 .name   = DEV_NAME
1214         },
1215 };
1216 
1217 #ifdef CONFIG_PNP
1218 static inline int get_next_autoindex(int i)
1219 {
1220         while (i < SNDRV_CARDS && port[i] != SNDRV_AUTO_PORT)
1221                 ++i;
1222         return i;
1223 }
1224 
1225 
1226 static int sscape_pnp_detect(struct pnp_card_link *pcard,
1227                              const struct pnp_card_device_id *pid)
1228 {
1229         static int idx = 0;
1230         struct pnp_dev *dev;
1231         struct snd_card *card;
1232         struct soundscape *sscape;
1233         int ret;
1234 
1235         /*
1236          * Allow this function to fail *quietly* if all the ISA PnP
1237          * devices were configured using module parameters instead.
1238          */
1239         idx = get_next_autoindex(idx);
1240         if (idx >= SNDRV_CARDS)
1241                 return -ENOSPC;
1242 
1243         /*
1244          * Check that we still have room for another sound card ...
1245          */
1246         dev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
1247         if (!dev)
1248                 return -ENODEV;
1249 
1250         if (!pnp_is_active(dev)) {
1251                 if (pnp_activate_dev(dev) < 0) {
1252                         snd_printk(KERN_INFO "sscape: device is inactive\n");
1253                         return -EBUSY;
1254                 }
1255         }
1256 
1257         /*
1258          * Create a new ALSA sound card entry, in anticipation
1259          * of detecting our hardware ...
1260          */
1261         ret = snd_card_new(&pcard->card->dev,
1262                            index[idx], id[idx], THIS_MODULE,
1263                            sizeof(struct soundscape), &card);
1264         if (ret < 0)
1265                 return ret;
1266 
1267         sscape = get_card_soundscape(card);
1268 
1269         /*
1270          * Identify card model ...
1271          */
1272         if (!strncmp("ENS4081", pid->id, 7))
1273                 sscape->type = SSCAPE_VIVO;
1274         else
1275                 sscape->type = SSCAPE_PNP;
1276 
1277         /*
1278          * Read the correct parameters off the ISA PnP bus ...
1279          */
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);
1290         }
1291 
1292         ret = create_sscape(idx, card);
1293         if (ret < 0)
1294                 goto _release_card;
1295 
1296         ret = snd_card_register(card);
1297         if (ret < 0) {
1298                 snd_printk(KERN_ERR "sscape: Failed to register sound card\n");
1299                 goto _release_card;
1300         }
1301 
1302         pnp_set_card_drvdata(pcard, card);
1303         ++idx;
1304         return 0;
1305 
1306 _release_card:
1307         snd_card_free(card);
1308         return ret;
1309 }
1310 
1311 static void sscape_pnp_remove(struct pnp_card_link *pcard)
1312 {
1313         snd_card_free(pnp_get_card_drvdata(pcard));
1314         pnp_set_card_drvdata(pcard, NULL);
1315 }
1316 
1317 static struct pnp_card_driver sscape_pnpc_driver = {
1318         .flags = PNP_DRIVER_RES_DO_NOT_CHANGE,
1319         .name = "sscape",
1320         .id_table = sscape_pnpids,
1321         .probe = sscape_pnp_detect,
1322         .remove = sscape_pnp_remove,
1323 };
1324 
1325 #endif /* CONFIG_PNP */
1326 
1327 static int __init sscape_init(void)
1328 {
1329         int err;
1330 
1331         err = isa_register_driver(&snd_sscape_driver, SNDRV_CARDS);
1332 #ifdef CONFIG_PNP
1333         if (!err)
1334                 isa_registered = 1;
1335 
1336         err = pnp_register_card_driver(&sscape_pnpc_driver);
1337         if (!err)
1338                 pnp_registered = 1;
1339 
1340         if (isa_registered)
1341                 err = 0;
1342 #endif
1343         return err;
1344 }
1345 
1346 static void __exit sscape_exit(void)
1347 {
1348 #ifdef CONFIG_PNP
1349         if (pnp_registered)
1350                 pnp_unregister_card_driver(&sscape_pnpc_driver);
1351         if (isa_registered)
1352 #endif
1353                 isa_unregister_driver(&snd_sscape_driver);
1354 }
1355 
1356 module_init(sscape_init);
1357 module_exit(sscape_exit);
1358 

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us