sound/isa/sgalaxy.c

   1 /*
   2  *  Driver for Aztech Sound Galaxy cards
   3  *  Copyright (c) by Christopher Butler <chrisb@sandy.force9.co.uk.
   4  *
   5  *  I don't have documentation for this card, I based this driver on the
   6  *  driver for OSS/Free included in the kernel source (drivers/sound/sgalaxy.c)
   7  *
   8  *   This program is free software; you can redistribute it and/or modify
   9  *   it under the terms of the GNU General Public License as published by
  10  *   the Free Software Foundation; either version 2 of the License, or
  11  *   (at your option) any later version.
  12  *
  13  *   This program is distributed in the hope that it will be useful,
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *   GNU General Public License for more details.
  17  *
  18  *   You should have received a copy of the GNU General Public License
  19  *   along with this program; if not, write to the Free Software
  20  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  21  *
  22  */
  23
  24 #include <linux/init.h>
  25 #include <linux/err.h>
  26 #include <linux/isa.h>
  27 #include <linux/delay.h>
  28 #include <linux/time.h>
  29 #include <linux/interrupt.h>
  30 #include <linux/moduleparam.h>
  31 #include <asm/dma.h>
  32 #include <sound/core.h>
  33 #include <sound/sb.h>
  34 #include <sound/ad1848.h>
  35 #include <sound/control.h>
  36 #define SNDRV_LEGACY_FIND_FREE_IRQ
  37 #define SNDRV_LEGACY_FIND_FREE_DMA
  38 #include <sound/initval.h>
  39
  40 MODULE_AUTHOR("Christopher Butler <chrisb@sandy.force9.co.uk>");
  41 MODULE_DESCRIPTION("Aztech Sound Galaxy");
  42 MODULE_LICENSE("GPL");
  43 MODULE_SUPPORTED_DEVICE("{{Aztech Systems,Sound Galaxy}}");
  44
  45 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;      /* Index 0-MAX */
  46 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;       /* ID for this card */
  47 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE;  /* Enable this card */
  48 static long sbport[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;   /* 0x220,0x240 */
  49 static long wssport[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;  /* 0x530,0xe80,0xf40,0x604 */
  50 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;        /* 7,9,10,11 */
  51 static int dma1[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;       /* 0,1,3 */
  52
  53 module_param_array(index, int, NULL, 0444);
  54 MODULE_PARM_DESC(index, "Index value for Sound Galaxy soundcard.");
  55 module_param_array(id, charp, NULL, 0444);
  56 MODULE_PARM_DESC(id, "ID string for Sound Galaxy soundcard.");
  57 module_param_array(sbport, long, NULL, 0444);
  58 MODULE_PARM_DESC(sbport, "Port # for Sound Galaxy SB driver.");
  59 module_param_array(wssport, long, NULL, 0444);
  60 MODULE_PARM_DESC(wssport, "Port # for Sound Galaxy WSS driver.");
  61 module_param_array(irq, int, NULL, 0444);
  62 MODULE_PARM_DESC(irq, "IRQ # for Sound Galaxy driver.");
  63 module_param_array(dma1, int, NULL, 0444);
  64 MODULE_PARM_DESC(dma1, "DMA1 # for Sound Galaxy driver.");
  65
  66 #define SGALAXY_AUXC_LEFT 18
  67 #define SGALAXY_AUXC_RIGHT 19
  68
  69 #define PFX     "sgalaxy: "
  70
  71 /*
  72
  73  */
  74
  75 #define AD1848P1( port, x ) ( port + c_d_c_AD1848##x )
  76
  77 /* from lowlevel/sb/sb.c - to avoid having to allocate a struct snd_sb for the */
  78 /* short time we actually need it.. */
  79
  80 static int snd_sgalaxy_sbdsp_reset(unsigned long port)
  81 {
  82         int i;
  83
  84         outb(1, SBP1(port, RESET));
  85         udelay(10);
  86         outb(0, SBP1(port, RESET));
  87         udelay(30);
  88         for (i = 0; i < 1000 && !(inb(SBP1(port, DATA_AVAIL)) & 0x80); i++);
  89         if (inb(SBP1(port, READ)) != 0xaa) {
  90                 snd_printd("sb_reset: failed at 0x%lx!!!\n", port);
  91                 return -ENODEV;
  92         }
  93         return 0;
  94 }
  95
  96 static int __devinit snd_sgalaxy_sbdsp_command(unsigned long port,
  97                                                unsigned char val)
  98 {
  99         int i;
 100
 101         for (i = 10000; i; i--)
 102                 if ((inb(SBP1(port, STATUS)) & 0x80) == 0) {
 103                         outb(val, SBP1(port, COMMAND));
 104                         return 1;
 105                 }
 106
 107         return 0;
 108 }
 109
 110 static irqreturn_t snd_sgalaxy_dummy_interrupt(int irq, void *dev_id)
 111 {
 112         return IRQ_NONE;
 113 }
 114
 115 static int __devinit snd_sgalaxy_setup_wss(unsigned long port, int irq, int dma)
 116 {
 117         static int interrupt_bits[] = {-1, -1, -1, -1, -1, -1, -1, 0x08, -1,
 118                                        0x10, 0x18, 0x20, -1, -1, -1, -1};
 119         static int dma_bits[] = {1, 2, 0, 3};
 120         int tmp, tmp1;
 121
 122         if ((tmp = inb(port + 3)) == 0xff)
 123         {
 124                 snd_printdd("I/O address dead (0x%lx)\n", port);
 125                 return 0;
 126         }
 127 #if 0
 128         snd_printdd("WSS signature = 0x%x\n", tmp);
 129 #endif
 130
 131         if ((tmp & 0x3f) != 0x04 &&
 132             (tmp & 0x3f) != 0x0f &&
 133             (tmp & 0x3f) != 0x00) {
 134                 snd_printdd("No WSS signature detected on port 0x%lx\n",
 135                             port + 3);
 136                 return 0;
 137         }
 138
 139 #if 0
 140         snd_printdd(PFX "setting up IRQ/DMA for WSS\n");
 141 #endif
 142
 143         /* initialize IRQ for WSS codec */
 144         tmp = interrupt_bits[irq % 16];
 145         if (tmp < 0)
 146                 return -EINVAL;
 147
 148         if (request_irq(irq, snd_sgalaxy_dummy_interrupt, IRQF_DISABLED, "sgalaxy", NULL)) {
 149                 snd_printk(KERN_ERR "sgalaxy: can't grab irq %d\n", irq);
 150                 return -EIO;
 151         }
 152
 153         outb(tmp | 0x40, port);
 154         tmp1 = dma_bits[dma % 4];
 155         outb(tmp | tmp1, port);
 156
 157         free_irq(irq, NULL);
 158
 159         return 0;
 160 }
 161
 162 static int __devinit snd_sgalaxy_detect(int dev, int irq, int dma)
 163 {
 164 #if 0
 165         snd_printdd(PFX "switching to WSS mode\n");
 166 #endif
 167
 168         /* switch to WSS mode */
 169         snd_sgalaxy_sbdsp_reset(sbport[dev]);
 170
 171         snd_sgalaxy_sbdsp_command(sbport[dev], 9);
 172         snd_sgalaxy_sbdsp_command(sbport[dev], 0);
 173
 174         udelay(400);
 175         return snd_sgalaxy_setup_wss(wssport[dev], irq, dma);
 176 }
 177
 178 static struct ad1848_mix_elem snd_sgalaxy_controls[] = {
 179 AD1848_DOUBLE("Aux Playback Switch", 0, SGALAXY_AUXC_LEFT, SGALAXY_AUXC_RIGHT, 7, 7, 1, 1),
 180 AD1848_DOUBLE("Aux Playback Volume", 0, SGALAXY_AUXC_LEFT, SGALAXY_AUXC_RIGHT, 0, 0, 31, 0)
 181 };
 182
 183 static int __devinit snd_sgalaxy_mixer(struct snd_ad1848 *chip)
 184 {
 185         struct snd_card *card = chip->card;
 186         struct snd_ctl_elem_id id1, id2;
 187         unsigned int idx;
 188         int err;
 189
 190         memset(&id1, 0, sizeof(id1));
 191         memset(&id2, 0, sizeof(id2));
 192         id1.iface = id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
 193         /* reassign AUX0 to LINE */
 194         strcpy(id1.name, "Aux Playback Switch");
 195         strcpy(id2.name, "Line Playback Switch");
 196         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
 197                 return err;
 198         strcpy(id1.name, "Aux Playback Volume");
 199         strcpy(id2.name, "Line Playback Volume");
 200         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
 201                 return err;
 202         /* reassign AUX1 to FM */
 203         strcpy(id1.name, "Aux Playback Switch"); id1.index = 1;
 204         strcpy(id2.name, "FM Playback Switch");
 205         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
 206                 return err;
 207         strcpy(id1.name, "Aux Playback Volume");
 208         strcpy(id2.name, "FM Playback Volume");
 209         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
 210                 return err;
 211         /* build AUX2 input */
 212         for (idx = 0; idx < ARRAY_SIZE(snd_sgalaxy_controls); idx++) {
 213                 if ((err = snd_ad1848_add_ctl_elem(chip, &snd_sgalaxy_controls[idx])) < 0)
 214                         return err;
 215         }
 216         return 0;
 217 }
 218
 219 static int __devinit snd_sgalaxy_match(struct device *devptr, unsigned int dev)
 220 {
 221         if (!enable[dev])
 222                 return 0;
 223         if (sbport[dev] == SNDRV_AUTO_PORT) {
 224                 snd_printk(KERN_ERR PFX "specify SB port\n");
 225                 return 0;
 226         }
 227         if (wssport[dev] == SNDRV_AUTO_PORT) {
 228                 snd_printk(KERN_ERR PFX "specify WSS port\n");
 229                 return 0;
 230         }
 231         return 1;
 232 }
 233
 234 static int __devinit snd_sgalaxy_probe(struct device *devptr, unsigned int dev)
 235 {
 236         static int possible_irqs[] = {7, 9, 10, 11, -1};
 237         static int possible_dmas[] = {1, 3, 0, -1};
 238         int err, xirq, xdma1;
 239         struct snd_card *card;
 240         struct snd_ad1848 *chip;
 241
 242         card = snd_card_new(index[dev], id[dev], THIS_MODULE, 0);
 243         if (card == NULL)
 244                 return -ENOMEM;
 245
 246         xirq = irq[dev];
 247         if (xirq == SNDRV_AUTO_IRQ) {
 248                 if ((xirq = snd_legacy_find_free_irq(possible_irqs)) < 0) {
 249                         snd_printk(KERN_ERR PFX "unable to find a free IRQ\n");
 250                         err = -EBUSY;
 251                         goto _err;
 252                 }
 253         }
 254         xdma1 = dma1[dev];
 255         if (xdma1 == SNDRV_AUTO_DMA) {
 256                 if ((xdma1 = snd_legacy_find_free_dma(possible_dmas)) < 0) {
 257                         snd_printk(KERN_ERR PFX "unable to find a free DMA\n");
 258                         err = -EBUSY;
 259                         goto _err;
 260                 }
 261         }
 262
 263         if ((err = snd_sgalaxy_detect(dev, xirq, xdma1)) < 0)
 264                 goto _err;
 265
 266         if ((err = snd_ad1848_create(card, wssport[dev] + 4,
 267                                      xirq, xdma1,
 268                                      AD1848_HW_DETECT, &chip)) < 0)
 269                 goto _err;
 270         card->private_data = chip;
 271
 272         if ((err = snd_ad1848_pcm(chip, 0, NULL)) < 0) {
 273                 snd_printdd(PFX "error creating new ad1848 PCM device\n");
 274                 goto _err;
 275         }
 276         if ((err = snd_ad1848_mixer(chip)) < 0) {
 277                 snd_printdd(PFX "error creating new ad1848 mixer\n");
 278                 goto _err;
 279         }
 280         if ((err = snd_sgalaxy_mixer(chip)) < 0) {
 281                 snd_printdd(PFX "the mixer rewrite failed\n");
 282                 goto _err;
 283         }
 284
 285         strcpy(card->driver, "Sound Galaxy");
 286         strcpy(card->shortname, "Sound Galaxy");
 287         sprintf(card->longname, "Sound Galaxy at 0x%lx, irq %d, dma %d",
 288                 wssport[dev], xirq, xdma1);
 289
 290         snd_card_set_dev(card, devptr);
 291
 292         if ((err = snd_card_register(card)) < 0)
 293                 goto _err;
 294
 295         dev_set_drvdata(devptr, card);
 296         return 0;
 297
 298  _err:
 299         snd_card_free(card);
 300         return err;
 301 }
 302
 303 static int __devexit snd_sgalaxy_remove(struct device *devptr, unsigned int dev)
 304 {
 305         snd_card_free(dev_get_drvdata(devptr));
 306         dev_set_drvdata(devptr, NULL);
 307         return 0;
 308 }
 309
 310 #ifdef CONFIG_PM
 311 static int snd_sgalaxy_suspend(struct device *pdev, unsigned int n,
 312                                pm_message_t state)
 313 {
 314         struct snd_card *card = dev_get_drvdata(pdev);
 315         struct snd_ad1848 *chip = card->private_data;
 316
 317         snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
 318         chip->suspend(chip);
 319         return 0;
 320 }
 321
 322 static int snd_sgalaxy_resume(struct device *pdev, unsigned int n)
 323 {
 324         struct snd_card *card = dev_get_drvdata(pdev);
 325         struct snd_ad1848 *chip = card->private_data;
 326
 327         chip->resume(chip);
 328         snd_ad1848_out(chip, SGALAXY_AUXC_LEFT, chip->image[SGALAXY_AUXC_LEFT]);
 329         snd_ad1848_out(chip, SGALAXY_AUXC_RIGHT, chip->image[SGALAXY_AUXC_RIGHT]);
 330
 331         snd_power_change_state(card, SNDRV_CTL_POWER_D0);
 332         return 0;
 333 }
 334 #endif
 335
 336 #define DEV_NAME "sgalaxy"
 337
 338 static struct isa_driver snd_sgalaxy_driver = {
 339         .match          = snd_sgalaxy_match,
 340         .probe          = snd_sgalaxy_probe,
 341         .remove         = __devexit_p(snd_sgalaxy_remove),
 342 #ifdef CONFIG_PM
 343         .suspend        = snd_sgalaxy_suspend,
 344         .resume         = snd_sgalaxy_resume,
 345 #endif
 346         .driver         = {
 347                 .name   = DEV_NAME
 348         },
 349 };
 350
 351 static int __init alsa_card_sgalaxy_init(void)
 352 {
 353         return isa_register_driver(&snd_sgalaxy_driver, SNDRV_CARDS);
 354 }
 355
 356 static void __exit alsa_card_sgalaxy_exit(void)
 357 {
 358         isa_unregister_driver(&snd_sgalaxy_driver);
 359 }
 360
 361 module_init(alsa_card_sgalaxy_init)
 362 module_exit(alsa_card_sgalaxy_exit)