Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
sscape.c
Go to the documentation of this file.
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/isa.h>
27 #include <linux/delay.h>
28 #include <linux/firmware.h>
29 #include <linux/pnp.h>
30 #include <linux/spinlock.h>
31 #include <linux/module.h>
32 #include <asm/dma.h>
33 #include <sound/core.h>
34 #include <sound/wss.h>
35 #include <sound/mpu401.h>
36 #include <sound/initval.h>
37 
38 
39 MODULE_AUTHOR("Chris Rankin");
40 MODULE_DESCRIPTION("ENSONIQ SoundScape driver");
41 MODULE_LICENSE("GPL");
42 MODULE_FIRMWARE("sndscape.co0");
43 MODULE_FIRMWARE("sndscape.co1");
44 MODULE_FIRMWARE("sndscape.co2");
45 MODULE_FIRMWARE("sndscape.co3");
46 MODULE_FIRMWARE("sndscape.co4");
47 MODULE_FIRMWARE("scope.cod");
48 
49 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
50 static char* id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
51 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
52 static long wss_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
53 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;
54 static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;
55 static int dma[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;
56 static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;
57 static bool joystick[SNDRV_CARDS];
58 
59 module_param_array(index, int, NULL, 0444);
60 MODULE_PARM_DESC(index, "Index number for SoundScape soundcard");
61 
62 module_param_array(id, charp, NULL, 0444);
63 MODULE_PARM_DESC(id, "Description for SoundScape card");
64 
65 module_param_array(port, long, NULL, 0444);
66 MODULE_PARM_DESC(port, "Port # for SoundScape driver.");
67 
68 module_param_array(wss_port, long, NULL, 0444);
69 MODULE_PARM_DESC(wss_port, "WSS Port # for SoundScape driver.");
70 
71 module_param_array(irq, int, NULL, 0444);
72 MODULE_PARM_DESC(irq, "IRQ # for SoundScape driver.");
73 
74 module_param_array(mpu_irq, int, NULL, 0444);
75 MODULE_PARM_DESC(mpu_irq, "MPU401 IRQ # for SoundScape driver.");
76 
77 module_param_array(dma, int, NULL, 0444);
78 MODULE_PARM_DESC(dma, "DMA # for SoundScape driver.");
79 
80 module_param_array(dma2, int, NULL, 0444);
81 MODULE_PARM_DESC(dma2, "DMA2 # for SoundScape driver.");
82 
83 module_param_array(joystick, bool, NULL, 0444);
84 MODULE_PARM_DESC(joystick, "Enable gameport.");
85 
86 #ifdef CONFIG_PNP
87 static int isa_registered;
88 static int pnp_registered;
89 
90 static struct pnp_card_device_id sscape_pnpids[] = {
91  { .id = "ENS3081", .devs = { { "ENS0000" } } }, /* Soundscape PnP */
92  { .id = "ENS4081", .devs = { { "ENS1011" } } }, /* VIVO90 */
93  { .id = "" } /* end */
94 };
95 
96 MODULE_DEVICE_TABLE(pnp_card, sscape_pnpids);
97 #endif
98 
99 
100 #define HOST_CTRL_IO(i) ((i) + 2)
101 #define HOST_DATA_IO(i) ((i) + 3)
102 #define ODIE_ADDR_IO(i) ((i) + 4)
103 #define ODIE_DATA_IO(i) ((i) + 5)
104 #define CODEC_IO(i) ((i) + 8)
105 
106 #define IC_ODIE 1
107 #define IC_OPUS 2
108 
109 #define RX_READY 0x01
110 #define TX_READY 0x02
111 
112 #define CMD_ACK 0x80
113 #define CMD_SET_MIDI_VOL 0x84
114 #define CMD_GET_MIDI_VOL 0x85
115 #define CMD_XXX_MIDI_VOL 0x86
116 #define CMD_SET_EXTMIDI 0x8a
117 #define CMD_GET_EXTMIDI 0x8b
118 #define CMD_SET_MT32 0x8c
119 #define CMD_GET_MT32 0x8d
120 
121 enum GA_REG {
132 };
133 
134 #define DMA_8BIT 0x80
135 
136 
137 enum card_type {
138  MEDIA_FX, /* Sequoia S-1000 */
139  SSCAPE, /* Sequoia S-2000 */
142 };
143 
144 struct soundscape {
146  unsigned io_base;
147  int ic_type;
149  struct resource *io_res;
150  struct resource *wss_res;
151  struct snd_wss *chip;
152 
153  unsigned char midi_vol;
154 };
155 
156 #define INVALID_IRQ ((unsigned)-1)
157 
158 
159 static inline struct soundscape *get_card_soundscape(struct snd_card *c)
160 {
161  return (struct soundscape *) (c->private_data);
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,
170  unsigned long size)
171 {
172  if (buf) {
175  size, buf) < 0) {
176  snd_printk(KERN_ERR "sscape: Failed to allocate "
177  "%lu bytes for DMA\n",
178  size);
179  return NULL;
180  }
181  }
182 
183  return buf;
184 }
185 
186 /*
187  * Release the DMA-able kernel memory ...
188  */
189 static void free_dmabuf(struct snd_dma_buffer *buf)
190 {
191  if (buf && buf->area)
192  snd_dma_free_pages(buf);
193 }
194 
195 /*
196  * This function writes to the SoundScape's control registers,
197  * but doesn't do any locking. It's up to the caller to do that.
198  * This is why this function is "unsafe" ...
199  */
200 static inline void sscape_write_unsafe(unsigned io_base, enum GA_REG reg,
201  unsigned char val)
202 {
203  outb(reg, ODIE_ADDR_IO(io_base));
204  outb(val, ODIE_DATA_IO(io_base));
205 }
206 
207 /*
208  * Write to the SoundScape's control registers, and do the
209  * necessary locking ...
210  */
211 static void sscape_write(struct soundscape *s, enum GA_REG reg,
212  unsigned char val)
213 {
214  unsigned long flags;
215 
216  spin_lock_irqsave(&s->lock, flags);
217  sscape_write_unsafe(s->io_base, reg, val);
218  spin_unlock_irqrestore(&s->lock, flags);
219 }
220 
221 /*
222  * Read from the SoundScape's control registers, but leave any
223  * locking to the caller. This is why the function is "unsafe" ...
224  */
225 static inline unsigned char sscape_read_unsafe(unsigned io_base,
226  enum GA_REG reg)
227 {
228  outb(reg, ODIE_ADDR_IO(io_base));
229  return inb(ODIE_DATA_IO(io_base));
230 }
231 
232 /*
233  * Puts the SoundScape into "host" mode, as compared to "MIDI" mode
234  */
235 static inline void set_host_mode_unsafe(unsigned io_base)
236 {
237  outb(0x0, HOST_CTRL_IO(io_base));
238 }
239 
240 /*
241  * Puts the SoundScape into "MIDI" mode, as compared to "host" mode
242  */
243 static inline void set_midi_mode_unsafe(unsigned io_base)
244 {
245  outb(0x3, HOST_CTRL_IO(io_base));
246 }
247 
248 /*
249  * Read the SoundScape's host-mode control register, but leave
250  * any locking issues to the caller ...
251  */
252 static inline int host_read_unsafe(unsigned io_base)
253 {
254  int data = -1;
255  if ((inb(HOST_CTRL_IO(io_base)) & RX_READY) != 0)
256  data = inb(HOST_DATA_IO(io_base));
257 
258  return data;
259 }
260 
261 /*
262  * Read the SoundScape's host-mode control register, performing
263  * a limited amount of busy-waiting if the register isn't ready.
264  * Also leaves all locking-issues to the caller ...
265  */
266 static int host_read_ctrl_unsafe(unsigned io_base, unsigned timeout)
267 {
268  int data;
269 
270  while (((data = host_read_unsafe(io_base)) < 0) && (timeout != 0)) {
271  udelay(100);
272  --timeout;
273  } /* while */
274 
275  return data;
276 }
277 
278 /*
279  * Write to the SoundScape's host-mode control registers, but
280  * leave any locking issues to the caller ...
281  */
282 static inline int host_write_unsafe(unsigned io_base, unsigned char data)
283 {
284  if ((inb(HOST_CTRL_IO(io_base)) & TX_READY) != 0) {
285  outb(data, HOST_DATA_IO(io_base));
286  return 1;
287  }
288 
289  return 0;
290 }
291 
292 /*
293  * Write to the SoundScape's host-mode control registers, performing
294  * a limited amount of busy-waiting if the register isn't ready.
295  * Also leaves all locking-issues to the caller ...
296  */
297 static int host_write_ctrl_unsafe(unsigned io_base, unsigned char data,
298  unsigned timeout)
299 {
300  int err;
301 
302  while (!(err = host_write_unsafe(io_base, data)) && (timeout != 0)) {
303  udelay(100);
304  --timeout;
305  } /* while */
306 
307  return err;
308 }
309 
310 
311 /*
312  * Check that the MIDI subsystem is operational. If it isn't,
313  * then we will hang the computer if we try to use it ...
314  *
315  * NOTE: This check is based upon observation, not documentation.
316  */
317 static inline int verify_mpu401(const struct snd_mpu401 *mpu)
318 {
319  return ((inb(MPU401C(mpu)) & 0xc0) == 0x80);
320 }
321 
322 /*
323  * This is apparently the standard way to initailise an MPU-401
324  */
325 static inline void initialise_mpu401(const struct snd_mpu401 *mpu)
326 {
327  outb(0, MPU401D(mpu));
328 }
329 
330 /*
331  * Tell the SoundScape to activate the AD1845 chip (I think).
332  * The AD1845 detection fails if we *don't* do this, so I
333  * think that this is a good idea ...
334  */
335 static void activate_ad1845_unsafe(unsigned io_base)
336 {
337  unsigned char val = sscape_read_unsafe(io_base, GA_HMCTL_REG);
338  sscape_write_unsafe(io_base, GA_HMCTL_REG, (val & 0xcf) | 0x10);
339  sscape_write_unsafe(io_base, GA_CDCFG_REG, 0x80);
340 }
341 
342 /*
343  * Do the necessary ALSA-level cleanup to deallocate our driver ...
344  */
345 static void soundscape_free(struct snd_card *c)
346 {
347  struct soundscape *sscape = get_card_soundscape(c);
350  free_dma(sscape->chip->dma1);
351 }
352 
353 /*
354  * Tell the SoundScape to begin a DMA tranfer using the given channel.
355  * All locking issues are left to the caller.
356  */
357 static void sscape_start_dma_unsafe(unsigned io_base, enum GA_REG reg)
358 {
359  sscape_write_unsafe(io_base, reg,
360  sscape_read_unsafe(io_base, reg) | 0x01);
361  sscape_write_unsafe(io_base, reg,
362  sscape_read_unsafe(io_base, reg) & 0xfe);
363 }
364 
365 /*
366  * Wait for a DMA transfer to complete. This is a "limited busy-wait",
367  * and all locking issues are left to the caller.
368  */
369 static int sscape_wait_dma_unsafe(unsigned io_base, enum GA_REG reg,
370  unsigned timeout)
371 {
372  while (!(sscape_read_unsafe(io_base, reg) & 0x01) && (timeout != 0)) {
373  udelay(100);
374  --timeout;
375  } /* while */
376 
377  return sscape_read_unsafe(io_base, reg) & 0x01;
378 }
379 
380 /*
381  * Wait for the On-Board Processor to return its start-up
382  * acknowledgement sequence. This wait is too long for
383  * us to perform "busy-waiting", and so we must sleep.
384  * This in turn means that we must not be holding any
385  * spinlocks when we call this function.
386  */
387 static int obp_startup_ack(struct soundscape *s, unsigned timeout)
388 {
389  unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
390 
391  do {
392  unsigned long flags;
393  int x;
394 
395  spin_lock_irqsave(&s->lock, flags);
396  x = host_read_unsafe(s->io_base);
397  spin_unlock_irqrestore(&s->lock, flags);
398  if (x == 0xfe || x == 0xff)
399  return 1;
400 
401  msleep(10);
402  } while (time_before(jiffies, end_time));
403 
404  return 0;
405 }
406 
407 /*
408  * Wait for the host to return its start-up acknowledgement
409  * sequence. This wait is too long for us to perform
410  * "busy-waiting", and so we must sleep. This in turn means
411  * that we must not be holding any spinlocks when we call
412  * this function.
413  */
414 static int host_startup_ack(struct soundscape *s, unsigned timeout)
415 {
416  unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
417 
418  do {
419  unsigned long flags;
420  int x;
421 
422  spin_lock_irqsave(&s->lock, flags);
423  x = host_read_unsafe(s->io_base);
424  spin_unlock_irqrestore(&s->lock, flags);
425  if (x == 0xfe)
426  return 1;
427 
428  msleep(10);
429  } while (time_before(jiffies, end_time));
430 
431  return 0;
432 }
433 
434 /*
435  * Upload a byte-stream into the SoundScape using DMA channel A.
436  */
437 static int upload_dma_data(struct soundscape *s, const unsigned char *data,
438  size_t size)
439 {
440  unsigned long flags;
441  struct snd_dma_buffer dma;
442  int ret;
443  unsigned char val;
444 
445  if (!get_dmabuf(&dma, PAGE_ALIGN(32 * 1024)))
446  return -ENOMEM;
447 
448  spin_lock_irqsave(&s->lock, flags);
449 
450  /*
451  * Reset the board ...
452  */
453  val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
454  sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val & 0x3f);
455 
456  /*
457  * Enable the DMA channels and configure them ...
458  */
459  val = (s->chip->dma1 << 4) | DMA_8BIT;
460  sscape_write_unsafe(s->io_base, GA_DMAA_REG, val);
461  sscape_write_unsafe(s->io_base, GA_DMAB_REG, 0x20);
462 
463  /*
464  * Take the board out of reset ...
465  */
466  val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
467  sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val | 0x80);
468 
469  /*
470  * Upload the firmware to the SoundScape
471  * board through the DMA channel ...
472  */
473  while (size != 0) {
474  unsigned long len;
475 
476  len = min(size, dma.bytes);
477  memcpy(dma.area, data, len);
478  data += len;
479  size -= len;
480 
481  snd_dma_program(s->chip->dma1, dma.addr, len, DMA_MODE_WRITE);
482  sscape_start_dma_unsafe(s->io_base, GA_DMAA_REG);
483  if (!sscape_wait_dma_unsafe(s->io_base, GA_DMAA_REG, 5000)) {
484  /*
485  * Don't forget to release this spinlock we're holding
486  */
487  spin_unlock_irqrestore(&s->lock, flags);
488 
490  "sscape: DMA upload has timed out\n");
491  ret = -EAGAIN;
492  goto _release_dma;
493  }
494  } /* while */
495 
496  set_host_mode_unsafe(s->io_base);
497  outb(0x0, s->io_base);
498 
499  /*
500  * Boot the board ... (I think)
501  */
502  val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
503  sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val | 0x40);
504  spin_unlock_irqrestore(&s->lock, flags);
505 
506  /*
507  * If all has gone well, then the board should acknowledge
508  * the new upload and tell us that it has rebooted OK. We
509  * give it 5 seconds (max) ...
510  */
511  ret = 0;
512  if (!obp_startup_ack(s, 5000)) {
513  snd_printk(KERN_ERR "sscape: No response "
514  "from on-board processor after upload\n");
515  ret = -EAGAIN;
516  } else if (!host_startup_ack(s, 5000)) {
518  "sscape: SoundScape failed to initialise\n");
519  ret = -EAGAIN;
520  }
521 
522 _release_dma:
523  /*
524  * NOTE!!! We are NOT holding any spinlocks at this point !!!
525  */
526  sscape_write(s, GA_DMAA_REG, (s->ic_type == IC_OPUS ? 0x40 : 0x70));
527  free_dmabuf(&dma);
528 
529  return ret;
530 }
531 
532 /*
533  * Upload the bootblock(?) into the SoundScape. The only
534  * purpose of this block of code seems to be to tell
535  * us which version of the microcode we should be using.
536  */
537 static int sscape_upload_bootblock(struct snd_card *card)
538 {
539  struct soundscape *sscape = get_card_soundscape(card);
540  unsigned long flags;
541  const struct firmware *init_fw = NULL;
542  int data = 0;
543  int ret;
544 
545  ret = request_firmware(&init_fw, "scope.cod", card->dev);
546  if (ret < 0) {
547  snd_printk(KERN_ERR "sscape: Error loading scope.cod");
548  return ret;
549  }
550  ret = upload_dma_data(sscape, init_fw->data, init_fw->size);
551 
552  release_firmware(init_fw);
553 
554  spin_lock_irqsave(&sscape->lock, flags);
555  if (ret == 0)
556  data = host_read_ctrl_unsafe(sscape->io_base, 100);
557 
558  if (data & 0x10)
559  sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2f);
560 
561  spin_unlock_irqrestore(&sscape->lock, flags);
562 
563  data &= 0xf;
564  if (ret == 0 && data > 7) {
566  "sscape: timeout reading firmware version\n");
567  ret = -EAGAIN;
568  }
569 
570  return (ret == 0) ? data : ret;
571 }
572 
573 /*
574  * Upload the microcode into the SoundScape.
575  */
576 static int sscape_upload_microcode(struct snd_card *card, int version)
577 {
578  struct soundscape *sscape = get_card_soundscape(card);
579  const struct firmware *init_fw = NULL;
580  char name[14];
581  int err;
582 
583  snprintf(name, sizeof(name), "sndscape.co%d", version);
584 
585  err = request_firmware(&init_fw, name, card->dev);
586  if (err < 0) {
587  snd_printk(KERN_ERR "sscape: Error loading sndscape.co%d",
588  version);
589  return err;
590  }
591  err = upload_dma_data(sscape, init_fw->data, init_fw->size);
592  if (err == 0)
593  snd_printk(KERN_INFO "sscape: MIDI firmware loaded %d KBs\n",
594  init_fw->size >> 10);
595 
596  release_firmware(init_fw);
597 
598  return err;
599 }
600 
601 /*
602  * Mixer control for the SoundScape's MIDI device.
603  */
604 static int sscape_midi_info(struct snd_kcontrol *ctl,
605  struct snd_ctl_elem_info *uinfo)
606 {
608  uinfo->count = 1;
609  uinfo->value.integer.min = 0;
610  uinfo->value.integer.max = 127;
611  return 0;
612 }
613 
614 static int sscape_midi_get(struct snd_kcontrol *kctl,
615  struct snd_ctl_elem_value *uctl)
616 {
617  struct snd_wss *chip = snd_kcontrol_chip(kctl);
618  struct snd_card *card = chip->card;
619  register struct soundscape *s = get_card_soundscape(card);
620  unsigned long flags;
621 
622  spin_lock_irqsave(&s->lock, flags);
623  uctl->value.integer.value[0] = s->midi_vol;
624  spin_unlock_irqrestore(&s->lock, flags);
625  return 0;
626 }
627 
628 static int sscape_midi_put(struct snd_kcontrol *kctl,
629  struct snd_ctl_elem_value *uctl)
630 {
631  struct snd_wss *chip = snd_kcontrol_chip(kctl);
632  struct snd_card *card = chip->card;
633  struct soundscape *s = get_card_soundscape(card);
634  unsigned long flags;
635  int change;
636  unsigned char new_val;
637 
638  spin_lock_irqsave(&s->lock, flags);
639 
640  new_val = uctl->value.integer.value[0] & 127;
641  /*
642  * We need to put the board into HOST mode before we
643  * can send any volume-changing HOST commands ...
644  */
645  set_host_mode_unsafe(s->io_base);
646 
647  /*
648  * To successfully change the MIDI volume setting, you seem to
649  * have to write a volume command, write the new volume value,
650  * and then perform another volume-related command. Perhaps the
651  * first command is an "open" and the second command is a "close"?
652  */
653  if (s->midi_vol == new_val) {
654  change = 0;
655  goto __skip_change;
656  }
657  change = host_write_ctrl_unsafe(s->io_base, CMD_SET_MIDI_VOL, 100)
658  && host_write_ctrl_unsafe(s->io_base, new_val, 100)
659  && host_write_ctrl_unsafe(s->io_base, CMD_XXX_MIDI_VOL, 100)
660  && host_write_ctrl_unsafe(s->io_base, new_val, 100);
661  s->midi_vol = new_val;
662 __skip_change:
663 
664  /*
665  * Take the board out of HOST mode and back into MIDI mode ...
666  */
667  set_midi_mode_unsafe(s->io_base);
668 
669  spin_unlock_irqrestore(&s->lock, flags);
670  return change;
671 }
672 
673 static struct snd_kcontrol_new midi_mixer_ctl = {
675  .name = "MIDI",
676  .info = sscape_midi_info,
677  .get = sscape_midi_get,
678  .put = sscape_midi_put
679 };
680 
681 /*
682  * The SoundScape can use two IRQs from a possible set of four.
683  * These IRQs are encoded as bit patterns so that they can be
684  * written to the control registers.
685  */
686 static unsigned __devinit get_irq_config(int sscape_type, int irq)
687 {
688  static const int valid_irq[] = { 9, 5, 7, 10 };
689  static const int old_irq[] = { 9, 7, 5, 15 };
690  unsigned cfg;
691 
692  if (sscape_type == MEDIA_FX) {
693  for (cfg = 0; cfg < ARRAY_SIZE(old_irq); ++cfg)
694  if (irq == old_irq[cfg])
695  return cfg;
696  } else {
697  for (cfg = 0; cfg < ARRAY_SIZE(valid_irq); ++cfg)
698  if (irq == valid_irq[cfg])
699  return cfg;
700  }
701 
702  return INVALID_IRQ;
703 }
704 
705 /*
706  * Perform certain arcane port-checks to see whether there
707  * is a SoundScape board lurking behind the given ports.
708  */
709 static int __devinit detect_sscape(struct soundscape *s, long wss_io)
710 {
711  unsigned long flags;
712  unsigned d;
713  int retval = 0;
714 
715  spin_lock_irqsave(&s->lock, flags);
716 
717  /*
718  * The following code is lifted from the original OSS driver,
719  * and as I don't have a datasheet I cannot really comment
720  * on what it is doing...
721  */
722  if ((inb(HOST_CTRL_IO(s->io_base)) & 0x78) != 0)
723  goto _done;
724 
725  d = inb(ODIE_ADDR_IO(s->io_base)) & 0xf0;
726  if ((d & 0x80) != 0)
727  goto _done;
728 
729  if (d == 0)
730  s->ic_type = IC_ODIE;
731  else if ((d & 0x60) != 0)
732  s->ic_type = IC_OPUS;
733  else
734  goto _done;
735 
736  outb(0xfa, ODIE_ADDR_IO(s->io_base));
737  if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0a)
738  goto _done;
739 
740  outb(0xfe, ODIE_ADDR_IO(s->io_base));
741  if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0e)
742  goto _done;
743 
744  outb(0xfe, ODIE_ADDR_IO(s->io_base));
745  d = inb(ODIE_DATA_IO(s->io_base));
746  if (s->type != SSCAPE_VIVO && (d & 0x9f) != 0x0e)
747  goto _done;
748 
749  if (s->ic_type == IC_OPUS)
750  activate_ad1845_unsafe(s->io_base);
751 
752  if (s->type == SSCAPE_VIVO)
753  wss_io += 4;
754 
755  d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
756  sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
757 
758  /* wait for WSS codec */
759  for (d = 0; d < 500; d++) {
760  if ((inb(wss_io) & 0x80) == 0)
761  break;
762  spin_unlock_irqrestore(&s->lock, flags);
763  msleep(1);
764  spin_lock_irqsave(&s->lock, flags);
765  }
766 
767  if ((inb(wss_io) & 0x80) != 0)
768  goto _done;
769 
770  if (inb(wss_io + 2) == 0xff)
771  goto _done;
772 
773  d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f;
774  sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d);
775 
776  if ((inb(wss_io) & 0x80) != 0)
777  s->type = MEDIA_FX;
778 
779  d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
780  sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
781  /* wait for WSS codec */
782  for (d = 0; d < 500; d++) {
783  if ((inb(wss_io) & 0x80) == 0)
784  break;
785  spin_unlock_irqrestore(&s->lock, flags);
786  msleep(1);
787  spin_lock_irqsave(&s->lock, flags);
788  }
789 
790  /*
791  * SoundScape successfully detected!
792  */
793  retval = 1;
794 
795 _done:
796  spin_unlock_irqrestore(&s->lock, flags);
797  return retval;
798 }
799 
800 /*
801  * ALSA callback function, called when attempting to open the MIDI device.
802  * Check that the MIDI firmware has been loaded, because we don't want
803  * to crash the machine. Also check that someone isn't using the hardware
804  * IOCTL device.
805  */
806 static int mpu401_open(struct snd_mpu401 *mpu)
807 {
808  if (!verify_mpu401(mpu)) {
809  snd_printk(KERN_ERR "sscape: MIDI disabled, "
810  "please load firmware\n");
811  return -ENODEV;
812  }
813 
814  return 0;
815 }
816 
817 /*
818  * Initialse an MPU-401 subdevice for MIDI support on the SoundScape.
819  */
820 static int __devinit create_mpu401(struct snd_card *card, int devnum,
821  unsigned long port, int irq)
822 {
823  struct soundscape *sscape = get_card_soundscape(card);
824  struct snd_rawmidi *rawmidi;
825  int err;
826 
827  err = snd_mpu401_uart_new(card, devnum, MPU401_HW_MPU401, port,
828  MPU401_INFO_INTEGRATED, irq, &rawmidi);
829  if (err == 0) {
830  struct snd_mpu401 *mpu = rawmidi->private_data;
831  mpu->open_input = mpu401_open;
832  mpu->open_output = mpu401_open;
833  mpu->private_data = sscape;
834 
835  initialise_mpu401(mpu);
836  }
837 
838  return err;
839 }
840 
841 
842 /*
843  * Create an AD1845 PCM subdevice on the SoundScape. The AD1845
844  * is very much like a CS4231, with a few extra bits. We will
845  * try to support at least some of the extra bits by overriding
846  * some of the CS4231 callback.
847  */
848 static int __devinit create_ad1845(struct snd_card *card, unsigned port,
849  int irq, int dma1, int dma2)
850 {
851  register struct soundscape *sscape = get_card_soundscape(card);
852  struct snd_wss *chip;
853  int err;
854  int codec_type = WSS_HW_DETECT;
855 
856  switch (sscape->type) {
857  case MEDIA_FX:
858  case SSCAPE:
859  /*
860  * There are some freak examples of early Soundscape cards
861  * with CS4231 instead of AD1848/CS4248. Unfortunately, the
862  * CS4231 works only in CS4248 compatibility mode on
863  * these cards so force it.
864  */
865  if (sscape->ic_type != IC_OPUS)
866  codec_type = WSS_HW_AD1848;
867  break;
868 
869  case SSCAPE_VIVO:
870  port += 4;
871  break;
872  default:
873  break;
874  }
875 
876  err = snd_wss_create(card, port, -1, irq, dma1, dma2,
877  codec_type, WSS_HWSHARE_DMA1, &chip);
878  if (!err) {
879  unsigned long flags;
880  struct snd_pcm *pcm;
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, &pcm);
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, NULL);
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 __devinit 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) {
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) {
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 __devinit 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) {
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 __devinit 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_create(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  snd_card_set_dev(card, pdev);
1182 
1183  ret = create_sscape(dev, card);
1184  if (ret < 0)
1185  goto _release_card;
1186 
1187  ret = snd_card_register(card);
1188  if (ret < 0) {
1189  snd_printk(KERN_ERR "sscape: Failed to register sound card\n");
1190  goto _release_card;
1191  }
1192  dev_set_drvdata(pdev, card);
1193  return 0;
1194 
1195 _release_card:
1196  snd_card_free(card);
1197  return ret;
1198 }
1199 
1200 static int __devexit snd_sscape_remove(struct device *devptr, unsigned int dev)
1201 {
1202  snd_card_free(dev_get_drvdata(devptr));
1203  dev_set_drvdata(devptr, NULL);
1204  return 0;
1205 }
1206 
1207 #define DEV_NAME "sscape"
1208 
1209 static struct isa_driver snd_sscape_driver = {
1210  .match = snd_sscape_match,
1211  .probe = snd_sscape_probe,
1212  .remove = __devexit_p(snd_sscape_remove),
1213  /* FIXME: suspend/resume */
1214  .driver = {
1215  .name = DEV_NAME
1216  },
1217 };
1218 
1219 #ifdef CONFIG_PNP
1220 static inline int __devinit get_next_autoindex(int i)
1221 {
1222  while (i < SNDRV_CARDS && port[i] != SNDRV_AUTO_PORT)
1223  ++i;
1224  return i;
1225 }
1226 
1227 
1228 static int __devinit sscape_pnp_detect(struct pnp_card_link *pcard,
1229  const struct pnp_card_device_id *pid)
1230 {
1231  static int idx = 0;
1232  struct pnp_dev *dev;
1233  struct snd_card *card;
1234  struct soundscape *sscape;
1235  int ret;
1236 
1237  /*
1238  * Allow this function to fail *quietly* if all the ISA PnP
1239  * devices were configured using module parameters instead.
1240  */
1241  idx = get_next_autoindex(idx);
1242  if (idx >= SNDRV_CARDS)
1243  return -ENOSPC;
1244 
1245  /*
1246  * Check that we still have room for another sound card ...
1247  */
1248  dev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
1249  if (!dev)
1250  return -ENODEV;
1251 
1252  if (!pnp_is_active(dev)) {
1253  if (pnp_activate_dev(dev) < 0) {
1254  snd_printk(KERN_INFO "sscape: device is inactive\n");
1255  return -EBUSY;
1256  }
1257  }
1258 
1259  /*
1260  * Create a new ALSA sound card entry, in anticipation
1261  * of detecting our hardware ...
1262  */
1263  ret = snd_card_create(index[idx], id[idx], THIS_MODULE,
1264  sizeof(struct soundscape), &card);
1265  if (ret < 0)
1266  return ret;
1267 
1268  sscape = get_card_soundscape(card);
1269 
1270  /*
1271  * Identify card model ...
1272  */
1273  if (!strncmp("ENS4081", pid->id, 7))
1274  sscape->type = SSCAPE_VIVO;
1275  else
1276  sscape->type = SSCAPE_PNP;
1277 
1278  /*
1279  * Read the correct parameters off the ISA PnP bus ...
1280  */
1281  port[idx] = pnp_port_start(dev, 0);
1282  irq[idx] = pnp_irq(dev, 0);
1283  mpu_irq[idx] = pnp_irq(dev, 1);
1284  dma[idx] = pnp_dma(dev, 0) & 0x03;
1285  if (sscape->type == SSCAPE_PNP) {
1286  dma2[idx] = dma[idx];
1287  wss_port[idx] = CODEC_IO(port[idx]);
1288  } else {
1289  wss_port[idx] = pnp_port_start(dev, 1);
1290  dma2[idx] = pnp_dma(dev, 1);
1291  }
1292  snd_card_set_dev(card, &pcard->card->dev);
1293 
1294  ret = create_sscape(idx, card);
1295  if (ret < 0)
1296  goto _release_card;
1297 
1298  ret = snd_card_register(card);
1299  if (ret < 0) {
1300  snd_printk(KERN_ERR "sscape: Failed to register sound card\n");
1301  goto _release_card;
1302  }
1303 
1304  pnp_set_card_drvdata(pcard, card);
1305  ++idx;
1306  return 0;
1307 
1308 _release_card:
1309  snd_card_free(card);
1310  return ret;
1311 }
1312 
1313 static void __devexit sscape_pnp_remove(struct pnp_card_link * pcard)
1314 {
1315  snd_card_free(pnp_get_card_drvdata(pcard));
1316  pnp_set_card_drvdata(pcard, NULL);
1317 }
1318 
1319 static struct pnp_card_driver sscape_pnpc_driver = {
1321  .name = "sscape",
1322  .id_table = sscape_pnpids,
1323  .probe = sscape_pnp_detect,
1324  .remove = __devexit_p(sscape_pnp_remove),
1325 };
1326 
1327 #endif /* CONFIG_PNP */
1328 
1329 static int __init sscape_init(void)
1330 {
1331  int err;
1332 
1333  err = isa_register_driver(&snd_sscape_driver, SNDRV_CARDS);
1334 #ifdef CONFIG_PNP
1335  if (!err)
1336  isa_registered = 1;
1337 
1338  err = pnp_register_card_driver(&sscape_pnpc_driver);
1339  if (!err)
1340  pnp_registered = 1;
1341 
1342  if (isa_registered)
1343  err = 0;
1344 #endif
1345  return err;
1346 }
1347 
1348 static void __exit sscape_exit(void)
1349 {
1350 #ifdef CONFIG_PNP
1351  if (pnp_registered)
1352  pnp_unregister_card_driver(&sscape_pnpc_driver);
1353  if (isa_registered)
1354 #endif
1355  isa_unregister_driver(&snd_sscape_driver);
1356 }
1357 
1358 module_init(sscape_init);
1359 module_exit(sscape_exit);