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