drivers/sound/cs4232.c

   1 /*
   2  * Copyright (C) by Hannu Savolainen 1993-1997
   3  *
   4  *      cs4232.c
   5  *
   6  * The low level driver for Crystal CS4232 based cards. The CS4232 is
   7  * a PnP compatible chip which contains a CS4231A codec, SB emulation,
   8  * a MPU401 compatible MIDI port, joystick and synthesizer and IDE CD-ROM
   9  * interfaces. This is just a temporary driver until full PnP support
  10  * gets implemented. Just the WSS codec, FM synth and the MIDI ports are
  11  * supported. Other interfaces are left uninitialized.
  12  *
  13  * ifdef ...WAVEFRONT...
  14  *
  15  *   Support is provided for initializing the WaveFront synth
  16  *   interface as well, which is logical device #4. Note that if
  17  *   you have a Tropez+ card, you probably don't need to setup
  18  *   the CS4232-supported MIDI interface, since it corresponds to
  19  *   the internal 26-pin header that's hard to access. Using this
  20  *   requires an additional IRQ, a resource none too plentiful in
  21  *   this environment. Just don't set module parameters mpuio and
  22  *   mpuirq, and the MIDI port will be left uninitialized. You can
  23  *   still use the ICS2115 hosted MIDI interface which corresponds
  24  *   to the 9-pin D connector on the back of the card.
  25  *
  26  * endif  ...WAVEFRONT...
  27  *
  28  * Supported chips are:
  29  *      CS4232
  30  *      CS4236
  31  *      CS4236B
  32  *
  33  * Note: You will need a PnP config setup to initialise some CS4232 boards
  34  * anyway.
  35  *
  36  * Changes
  37  *      Alan Cox                Modularisation, Basic cleanups.
  38  *      Paul Barton-Davis       Separated MPU configuration, added
  39  *                                       Tropez+ (WaveFront) support
  40  *      Christoph Hellwig       Adapted to module_init/module_exit,
  41  *                                      simple cleanups
  42  */
  43
  44 #include <linux/config.h>
  45 #include <linux/module.h>
  46 #include <linux/init.h>
  47
  48 #include "sound_config.h"
  49 #include "soundmodule.h"
  50
  51 #include "cs4232.h"
  52 #include "ad1848.h"
  53 #include "mpu401.h"
  54
  55 #define KEY_PORT        0x279   /* Same as LPT1 status port */
  56 #define CSN_NUM         0x99    /* Just a random number */
  57
  58 static void CS_OUT(unsigned char a)
  59 {
  60         outb(a, KEY_PORT);
  61 }
  62
  63 #define CS_OUT2(a, b)           {CS_OUT(a);CS_OUT(b);}
  64 #define CS_OUT3(a, b, c)        {CS_OUT(a);CS_OUT(b);CS_OUT(c);}
  65
  66 static int mpu_base = 0, mpu_irq = 0;
  67 static int synth_base = 0, synth_irq = 0;
  68 static int mpu_detected = 0;
  69
  70 int probe_cs4232_mpu(struct address_info *hw_config)
  71 {
  72         /*
  73          *      Just write down the config values.
  74          */
  75
  76         mpu_base = hw_config->io_base;
  77         mpu_irq = hw_config->irq;
  78
  79         return 1;
  80 }
  81
  82 static unsigned char crystal_key[] =    /* A 32 byte magic key sequence */
  83 {
  84         0x96, 0x35, 0x9a, 0xcd, 0xe6, 0xf3, 0x79, 0xbc,
  85         0x5e, 0xaf, 0x57, 0x2b, 0x15, 0x8a, 0xc5, 0xe2,
  86         0xf1, 0xf8, 0x7c, 0x3e, 0x9f, 0x4f, 0x27, 0x13,
  87         0x09, 0x84, 0x42, 0xa1, 0xd0, 0x68, 0x34, 0x1a
  88 };
  89
  90 static void sleep(unsigned howlong)
  91 {
  92         current->state = TASK_INTERRUPTIBLE;
  93         schedule_timeout(howlong);
  94 }
  95
  96 int probe_cs4232(struct address_info *hw_config)
  97 {
  98         int i, n;
  99         int base = hw_config->io_base, irq = hw_config->irq;
 100         int dma1 = hw_config->dma, dma2 = hw_config->dma2;
 101
 102         /*
 103          * Verify that the I/O port range is free.
 104          */
 105
 106         if (check_region(base, 4))
 107         {
 108                 printk(KERN_ERR "cs4232.c: I/O port 0x%03x not free\n", base);
 109                 return 0;
 110         }
 111         if (ad1848_detect(hw_config->io_base, NULL, hw_config->osp))
 112                 return 1;       /* The card is already active */
 113
 114         /*
 115          * This version of the driver doesn't use the PnP method when configuring
 116          * the card but a simplified method defined by Crystal. This means that
 117          * just one CS4232 compatible device can exist on the system. Also this
 118          * method conflicts with possible PnP support in the OS. For this reason
 119          * driver is just a temporary kludge.
 120          *
 121          * Also the Cirrus/Crystal method doesnt always work. Try ISA PnP first ;)
 122          */
 123
 124         /*
 125          * Repeat initialization few times since it doesn't always succeed in
 126          * first time.
 127          */
 128
 129         for (n = 0; n < 4; n++)
 130         {
 131                 /*
 132                  *      Wake up the card by sending a 32 byte Crystal key to the key port.
 133                  */
 134
 135                 for (i = 0; i < 32; i++)
 136                         CS_OUT(crystal_key[i]);
 137
 138                 sleep(HZ / 10);
 139
 140                 /*
 141                  *      Now set the CSN (Card Select Number).
 142                  */
 143
 144                 CS_OUT2(0x06, CSN_NUM);
 145
 146                 /*
 147                  *      Then set some config bytes. First logical device 0
 148                  */
 149
 150                 CS_OUT2(0x15, 0x00);    /* Select logical device 0 (WSS/SB/FM) */
 151                 CS_OUT3(0x47, (base >> 8) & 0xff, base & 0xff); /* WSS base */
 152
 153                 if (check_region(0x388, 4))     /* Not free */
 154                         CS_OUT3(0x48, 0x00, 0x00)       /* FM base off */
 155                 else
 156                         CS_OUT3(0x48, 0x03, 0x88);      /* FM base 0x388 */
 157
 158                 CS_OUT3(0x42, 0x00, 0x00);      /* SB base off */
 159                 CS_OUT2(0x22, irq);             /* SB+WSS IRQ */
 160                 CS_OUT2(0x2a, dma1);            /* SB+WSS DMA */
 161
 162                 if (dma2 != -1)
 163                         CS_OUT2(0x25, dma2)     /* WSS DMA2 */
 164                 else
 165                         CS_OUT2(0x25, 4);       /* No WSS DMA2 */
 166
 167                 CS_OUT2(0x33, 0x01);    /* Activate logical dev 0 */
 168
 169                 sleep(HZ / 10);
 170
 171                 /*
 172                  * Initialize logical device 3 (MPU)
 173                  */
 174
 175                 if (mpu_base != 0 && mpu_irq != 0)
 176                 {
 177                         CS_OUT2(0x15, 0x03);    /* Select logical device 3 (MPU) */
 178                         CS_OUT3(0x47, (mpu_base >> 8) & 0xff, mpu_base & 0xff); /* MPU base */
 179                         CS_OUT2(0x22, mpu_irq); /* MPU IRQ */
 180                         CS_OUT2(0x33, 0x01);    /* Activate logical dev 3 */
 181                 }
 182
 183                 if(synth_base != 0)
 184                 {
 185                     CS_OUT2 (0x15, 0x04);               /* logical device 4 (WaveFront) */
 186                     CS_OUT3 (0x47, (synth_base >> 8) & 0xff,
 187                              synth_base & 0xff);        /* base */
 188                     CS_OUT2 (0x22, synth_irq);          /* IRQ */
 189                     CS_OUT2 (0x33, 0x01);               /* Activate logical dev 4 */
 190                 }
 191
 192                 /*
 193                  * Finally activate the chip
 194                  */
 195
 196                 CS_OUT(0x79);
 197
 198                 sleep(HZ / 5);
 199
 200                 /*
 201                  * Then try to detect the codec part of the chip
 202                  */
 203
 204                 if (ad1848_detect(hw_config->io_base, NULL, hw_config->osp))
 205                         return 1;
 206
 207                 sleep(HZ);
 208         }
 209         return 0;
 210 }
 211
 212 void attach_cs4232(struct address_info *hw_config)
 213 {
 214         int base = hw_config->io_base,
 215                 irq = hw_config->irq,
 216                 dma1 = hw_config->dma,
 217                 dma2 = hw_config->dma2;
 218
 219         if (base == -1 || irq == -1 || dma1 == -1) {
 220                 printk(KERN_ERR "cs4232: dma, irq and io must be set.\n");
 221                 return;
 222         }
 223
 224         if (dma2 == -1)
 225                 dma2 = dma1;
 226
 227         hw_config->slots[0] = ad1848_init("Crystal audio controller", base,
 228                                           irq,
 229                                           dma1,         /* Playback DMA */
 230                                           dma2,         /* Capture DMA */
 231                                           0,
 232                                           hw_config->osp);
 233
 234         if (hw_config->slots[0] != -1 &&
 235                 audio_devs[hw_config->slots[0]]->mixer_dev!=-1)
 236         {
 237                 /* Assume the mixer map is as suggested in the CS4232 databook */
 238                 AD1848_REROUTE(SOUND_MIXER_LINE1, SOUND_MIXER_LINE);
 239                 AD1848_REROUTE(SOUND_MIXER_LINE2, SOUND_MIXER_CD);
 240                 AD1848_REROUTE(SOUND_MIXER_LINE3, SOUND_MIXER_SYNTH);           /* FM synth */
 241         }
 242         if (mpu_base != 0 && mpu_irq != 0)
 243         {
 244                 static struct address_info hw_config2 = {
 245                         0
 246                 };              /* Ensure it's initialized */
 247
 248                 hw_config2.io_base = mpu_base;
 249                 hw_config2.irq = mpu_irq;
 250                 hw_config2.dma = -1;
 251                 hw_config2.dma2 = -1;
 252                 hw_config2.always_detect = 0;
 253                 hw_config2.name = NULL;
 254                 hw_config2.driver_use_1 = 0;
 255                 hw_config2.driver_use_2 = 0;
 256                 hw_config2.card_subtype = 0;
 257
 258                 if (probe_uart401(&hw_config2))
 259                 {
 260                         mpu_detected = 1;
 261                         attach_uart401(&hw_config2);
 262                 }
 263                 else
 264                 {
 265                         mpu_base = mpu_irq = 0;
 266                 }
 267                 hw_config->slots[1] = hw_config2.slots[1];
 268         }
 269         SOUND_LOCK;
 270 }
 271
 272 void unload_cs4232(struct address_info *hw_config)
 273 {
 274         int base = hw_config->io_base, irq = hw_config->irq;
 275         int dma1 = hw_config->dma, dma2 = hw_config->dma2;
 276
 277         if (dma2 == -1)
 278                 dma2 = dma1;
 279
 280         ad1848_unload(base,
 281                       irq,
 282                       dma1,     /* Playback DMA */
 283                       dma2,     /* Capture DMA */
 284                       0);
 285
 286         sound_unload_audiodev(hw_config->slots[0]);
 287         if (mpu_base != 0 && mpu_irq != 0 && mpu_detected)
 288         {
 289                 static struct address_info hw_config2 =
 290                 {
 291                         0
 292                 };              /* Ensure it's initialized */
 293
 294                 hw_config2.io_base = mpu_base;
 295                 hw_config2.irq = mpu_irq;
 296                 hw_config2.dma = -1;
 297                 hw_config2.dma2 = -1;
 298                 hw_config2.always_detect = 0;
 299                 hw_config2.name = NULL;
 300                 hw_config2.driver_use_1 = 0;
 301                 hw_config2.driver_use_2 = 0;
 302                 hw_config2.card_subtype = 0;
 303                 hw_config2.slots[1] = hw_config->slots[1];
 304
 305                 unload_uart401(&hw_config2);
 306         }
 307 }
 308
 309 static struct address_info cfg;
 310 static struct address_info cfg_mpu;
 311
 312 static int __initdata io        = -1;
 313 static int __initdata irq       = -1;
 314 static int __initdata dma       = -1;
 315 static int __initdata dma2      = -1;
 316 static int __initdata mpuio     = -1;
 317 static int __initdata mpuirq    = -1;
 318 static int __initdata synthio   = -1;
 319 static int __initdata synthirq  = -1;
 320
 321
 322 MODULE_PARM(io,"i");
 323 MODULE_PARM(irq,"i");
 324 MODULE_PARM(dma,"i");
 325 MODULE_PARM(dma2,"i");
 326 MODULE_PARM(mpuio,"i");
 327 MODULE_PARM(mpuirq,"i");
 328 MODULE_PARM(synthio,"i");
 329 MODULE_PARM(synthirq,"i");
 330
 331 /*
 332  *      Install a CS4232 based card. Need to have ad1848 and mpu401
 333  *      loaded ready.
 334  */
 335
 336 static int __init init_cs4232(void)
 337 {
 338 #ifdef CONFIG_SOUND_WAVEFRONT_MODULE
 339         if(synthio == -1)
 340                 printk(KERN_WARNING "cs4232: set synthio and synthirq to use the wavefront facilities.\n");
 341         else {
 342                 synth_base = synthio;
 343                 synth_irq =  synthirq;
 344         }
 345 #else
 346         if(synthio != -1)
 347                 printk(KERN_WARNING "cs4232: wavefront support not enabled in this driver.\n");
 348 #endif
 349         if(io==-1||irq==-1||dma==-1)
 350         {
 351                 printk(KERN_ERR "cs4232: Must set io, irq and dma.\n");
 352                 return -ENODEV;
 353         }
 354
 355         cfg.io_base = io;
 356         cfg.irq = irq;
 357         cfg.dma = dma;
 358         cfg.dma2 = dma2;
 359
 360         cfg_mpu.io_base = -1;
 361         cfg_mpu.irq = -1;
 362
 363         if (mpuio != -1 && mpuirq != -1) {
 364                 cfg_mpu.io_base = mpuio;
 365                 cfg_mpu.irq = mpuirq;
 366                 probe_cs4232_mpu(&cfg_mpu); /* Bug always returns 0 not OK -- AC */
 367         }
 368
 369         if (probe_cs4232(&cfg) == 0)
 370                 return -ENODEV;
 371         attach_cs4232(&cfg);
 372
 373         return 0;
 374 }
 375
 376 static void __exit cleanup_cs4232(void)
 377 {
 378         unload_cs4232(&cfg); /* unloads MPU as well, if needed */
 379         SOUND_LOCK_END;
 380 }
 381
 382 module_init(init_cs4232);
 383 module_exit(cleanup_cs4232);
 384
 385 #ifndef MODULE
 386 static int __init setup_cs4232(char *str)
 387 {
 388         /* io, irq, dma, dma2 mpuio, mpuirq*/
 389         int ints[7];
 390
 391         str = get_options(str, ARRAY_SIZE(ints), ints);
 392
 393         io      = ints[1];
 394         irq     = ints[2];
 395         dma     = ints[3];
 396         dma2    = ints[4];
 397         mpuio   = ints[5];
 398         mpuirq  = ints[6];
 399
 400         return 1;
 401 }
 402
 403 __setup("cs4232=", setup_cs4232);
 404 #endif