sound/isa/sscape.c

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