sound/pci/cs5535audio/cs5535audio.c

   1 /*
   2  * Driver for audio on multifunction CS5535/6 companion device
   3  * Copyright (C) Jaya Kumar
   4  *
   5  * Based on Jaroslav Kysela and Takashi Iwai's examples.
   6  * This work was sponsored by CIS(M) Sdn Bhd.
   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 <sound/driver.h>
  25 #include <linux/delay.h>
  26 #include <linux/interrupt.h>
  27 #include <linux/init.h>
  28 #include <linux/pci.h>
  29 #include <linux/slab.h>
  30 #include <linux/moduleparam.h>
  31 #include <asm/io.h>
  32 #include <sound/core.h>
  33 #include <sound/control.h>
  34 #include <sound/pcm.h>
  35 #include <sound/rawmidi.h>
  36 #include <sound/ac97_codec.h>
  37 #include <sound/initval.h>
  38 #include <sound/asoundef.h>
  39 #include "cs5535audio.h"
  40
  41 #define DRIVER_NAME "cs5535audio"
  42
  43 static char *ac97_quirk;
  44 module_param(ac97_quirk, charp, 0444);
  45 MODULE_PARM_DESC(ac97_quirk, "AC'97 board specific workarounds.");
  46
  47 static struct ac97_quirk ac97_quirks[] __devinitdata = {
  48 #if 0 /* Not yet confirmed if all 5536 boards are HP only */
  49         {
  50                 .subvendor = PCI_VENDOR_ID_AMD,
  51                 .subdevice = PCI_DEVICE_ID_AMD_CS5536_AUDIO,
  52                 .name = "AMD RDK",
  53                 .type = AC97_TUNE_HP_ONLY
  54         },
  55 #endif
  56         {}
  57 };
  58
  59 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
  60 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
  61 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;
  62
  63 module_param_array(index, int, NULL, 0444);
  64 MODULE_PARM_DESC(index, "Index value for " DRIVER_NAME);
  65 module_param_array(id, charp, NULL, 0444);
  66 MODULE_PARM_DESC(id, "ID string for " DRIVER_NAME);
  67 module_param_array(enable, bool, NULL, 0444);
  68 MODULE_PARM_DESC(enable, "Enable " DRIVER_NAME);
  69
  70 static struct pci_device_id snd_cs5535audio_ids[] = {
  71         { PCI_DEVICE(PCI_VENDOR_ID_NS, PCI_DEVICE_ID_NS_CS5535_AUDIO) },
  72         { PCI_DEVICE(PCI_VENDOR_ID_AMD, PCI_DEVICE_ID_AMD_CS5536_AUDIO) },
  73         {}
  74 };
  75
  76 MODULE_DEVICE_TABLE(pci, snd_cs5535audio_ids);
  77
  78 static void wait_till_cmd_acked(struct cs5535audio *cs5535au, unsigned long timeout)
  79 {
  80         unsigned int tmp;
  81         do {
  82                 tmp = cs_readl(cs5535au, ACC_CODEC_CNTL);
  83                 if (!(tmp & CMD_NEW))
  84                         break;
  85                 udelay(1);
  86         } while (--timeout);
  87         if (!timeout)
  88                 snd_printk(KERN_ERR "Failure writing to cs5535 codec\n");
  89 }
  90
  91 static unsigned short snd_cs5535audio_codec_read(struct cs5535audio *cs5535au,
  92                                                  unsigned short reg)
  93 {
  94         unsigned int regdata;
  95         unsigned int timeout;
  96         unsigned int val;
  97
  98         regdata = ((unsigned int) reg) << 24;
  99         regdata |= ACC_CODEC_CNTL_RD_CMD;
 100         regdata |= CMD_NEW;
 101
 102         cs_writel(cs5535au, ACC_CODEC_CNTL, regdata);
 103         wait_till_cmd_acked(cs5535au, 50);
 104
 105         timeout = 50;
 106         do {
 107                 val = cs_readl(cs5535au, ACC_CODEC_STATUS);
 108                 if ((val & STS_NEW) && reg == (val >> 24))
 109                         break;
 110                 udelay(1);
 111         } while (--timeout);
 112         if (!timeout)
 113                 snd_printk(KERN_ERR "Failure reading codec reg 0x%x,"
 114                                         "Last value=0x%x\n", reg, val);
 115
 116         return (unsigned short) val;
 117 }
 118
 119 static void snd_cs5535audio_codec_write(struct cs5535audio *cs5535au,
 120                                         unsigned short reg, unsigned short val)
 121 {
 122         unsigned int regdata;
 123
 124         regdata = ((unsigned int) reg) << 24;
 125         regdata |= val;
 126         regdata &= CMD_MASK;
 127         regdata |= CMD_NEW;
 128         regdata &= ACC_CODEC_CNTL_WR_CMD;
 129
 130         cs_writel(cs5535au, ACC_CODEC_CNTL, regdata);
 131         wait_till_cmd_acked(cs5535au, 50);
 132 }
 133
 134 static void snd_cs5535audio_ac97_codec_write(struct snd_ac97 *ac97,
 135                                              unsigned short reg, unsigned short val)
 136 {
 137         struct cs5535audio *cs5535au = ac97->private_data;
 138         snd_cs5535audio_codec_write(cs5535au, reg, val);
 139 }
 140
 141 static unsigned short snd_cs5535audio_ac97_codec_read(struct snd_ac97 *ac97,
 142                                                       unsigned short reg)
 143 {
 144         struct cs5535audio *cs5535au = ac97->private_data;
 145         return snd_cs5535audio_codec_read(cs5535au, reg);
 146 }
 147
 148 static int snd_cs5535audio_mixer(struct cs5535audio *cs5535au)
 149 {
 150         struct snd_card *card = cs5535au->card;
 151         struct snd_ac97_bus *pbus;
 152         struct snd_ac97_template ac97;
 153         int err;
 154         static struct snd_ac97_bus_ops ops = {
 155                 .write = snd_cs5535audio_ac97_codec_write,
 156                 .read = snd_cs5535audio_ac97_codec_read,
 157         };
 158
 159         if ((err = snd_ac97_bus(card, 0, &ops, NULL, &pbus)) < 0)
 160                 return err;
 161
 162         memset(&ac97, 0, sizeof(ac97));
 163         ac97.scaps = AC97_SCAP_AUDIO|AC97_SCAP_SKIP_MODEM;
 164         ac97.private_data = cs5535au;
 165         ac97.pci = cs5535au->pci;
 166
 167         if ((err = snd_ac97_mixer(pbus, &ac97, &cs5535au->ac97)) < 0) {
 168                 snd_printk(KERN_ERR "mixer failed\n");
 169                 return err;
 170         }
 171
 172         snd_ac97_tune_hardware(cs5535au->ac97, ac97_quirks, ac97_quirk);
 173
 174         return 0;
 175 }
 176
 177 static void process_bm0_irq(struct cs5535audio *cs5535au)
 178 {
 179         u8 bm_stat;
 180         spin_lock(&cs5535au->reg_lock);
 181         bm_stat = cs_readb(cs5535au, ACC_BM0_STATUS);
 182         spin_unlock(&cs5535au->reg_lock);
 183         if (bm_stat & EOP) {
 184                 struct cs5535audio_dma *dma;
 185                 dma = cs5535au->playback_substream->runtime->private_data;
 186                 snd_pcm_period_elapsed(cs5535au->playback_substream);
 187         } else {
 188                 snd_printk(KERN_ERR "unexpected bm0 irq src, bm_stat=%x\n",
 189                                         bm_stat);
 190         }
 191 }
 192
 193 static void process_bm1_irq(struct cs5535audio *cs5535au)
 194 {
 195         u8 bm_stat;
 196         spin_lock(&cs5535au->reg_lock);
 197         bm_stat = cs_readb(cs5535au, ACC_BM1_STATUS);
 198         spin_unlock(&cs5535au->reg_lock);
 199         if (bm_stat & EOP) {
 200                 struct cs5535audio_dma *dma;
 201                 dma = cs5535au->capture_substream->runtime->private_data;
 202                 snd_pcm_period_elapsed(cs5535au->capture_substream);
 203         }
 204 }
 205
 206 static irqreturn_t snd_cs5535audio_interrupt(int irq, void *dev_id)
 207 {
 208         u16 acc_irq_stat;
 209         unsigned char count;
 210         struct cs5535audio *cs5535au = dev_id;
 211
 212         if (cs5535au == NULL)
 213                 return IRQ_NONE;
 214
 215         acc_irq_stat = cs_readw(cs5535au, ACC_IRQ_STATUS);
 216
 217         if (!acc_irq_stat)
 218                 return IRQ_NONE;
 219         for (count = 0; count < 4; count++) {
 220                 if (acc_irq_stat & (1 << count)) {
 221                         switch (count) {
 222                         case IRQ_STS:
 223                                 cs_readl(cs5535au, ACC_GPIO_STATUS);
 224                                 break;
 225                         case WU_IRQ_STS:
 226                                 cs_readl(cs5535au, ACC_GPIO_STATUS);
 227                                 break;
 228                         case BM0_IRQ_STS:
 229                                 process_bm0_irq(cs5535au);
 230                                 break;
 231                         case BM1_IRQ_STS:
 232                                 process_bm1_irq(cs5535au);
 233                                 break;
 234                         default:
 235                                 snd_printk(KERN_ERR "Unexpected irq src: "
 236                                                 "0x%x\n", acc_irq_stat);
 237                                 break;
 238                         }
 239                 }
 240         }
 241         return IRQ_HANDLED;
 242 }
 243
 244 static int snd_cs5535audio_free(struct cs5535audio *cs5535au)
 245 {
 246         synchronize_irq(cs5535au->irq);
 247         pci_set_power_state(cs5535au->pci, 3);
 248
 249         if (cs5535au->irq >= 0)
 250                 free_irq(cs5535au->irq, cs5535au);
 251
 252         pci_release_regions(cs5535au->pci);
 253         pci_disable_device(cs5535au->pci);
 254         kfree(cs5535au);
 255         return 0;
 256 }
 257
 258 static int snd_cs5535audio_dev_free(struct snd_device *device)
 259 {
 260         struct cs5535audio *cs5535au = device->device_data;
 261         return snd_cs5535audio_free(cs5535au);
 262 }
 263
 264 static int __devinit snd_cs5535audio_create(struct snd_card *card,
 265                                             struct pci_dev *pci,
 266                                             struct cs5535audio **rcs5535au)
 267 {
 268         struct cs5535audio *cs5535au;
 269
 270         int err;
 271         static struct snd_device_ops ops = {
 272                 .dev_free =     snd_cs5535audio_dev_free,
 273         };
 274
 275         *rcs5535au = NULL;
 276         if ((err = pci_enable_device(pci)) < 0)
 277                 return err;
 278
 279         if (pci_set_dma_mask(pci, DMA_32BIT_MASK) < 0 ||
 280             pci_set_consistent_dma_mask(pci, DMA_32BIT_MASK) < 0) {
 281                 printk(KERN_WARNING "unable to get 32bit dma\n");
 282                 err = -ENXIO;
 283                 goto pcifail;
 284         }
 285
 286         cs5535au = kzalloc(sizeof(*cs5535au), GFP_KERNEL);
 287         if (cs5535au == NULL) {
 288                 err = -ENOMEM;
 289                 goto pcifail;
 290         }
 291
 292         spin_lock_init(&cs5535au->reg_lock);
 293         cs5535au->card = card;
 294         cs5535au->pci = pci;
 295         cs5535au->irq = -1;
 296
 297         if ((err = pci_request_regions(pci, "CS5535 Audio")) < 0) {
 298                 kfree(cs5535au);
 299                 goto pcifail;
 300         }
 301
 302         cs5535au->port = pci_resource_start(pci, 0);
 303
 304         if (request_irq(pci->irq, snd_cs5535audio_interrupt,
 305                         IRQF_SHARED, "CS5535 Audio", cs5535au)) {
 306                 snd_printk("unable to grab IRQ %d\n", pci->irq);
 307                 err = -EBUSY;
 308                 goto sndfail;
 309         }
 310
 311         cs5535au->irq = pci->irq;
 312         pci_set_master(pci);
 313
 314         if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL,
 315                                   cs5535au, &ops)) < 0)
 316                 goto sndfail;
 317
 318         snd_card_set_dev(card, &pci->dev);
 319
 320         *rcs5535au = cs5535au;
 321         return 0;
 322
 323 sndfail: /* leave the device alive, just kill the snd */
 324         snd_cs5535audio_free(cs5535au);
 325         return err;
 326
 327 pcifail:
 328         pci_disable_device(pci);
 329         return err;
 330 }
 331
 332 static int __devinit snd_cs5535audio_probe(struct pci_dev *pci,
 333                                            const struct pci_device_id *pci_id)
 334 {
 335         static int dev;
 336         struct snd_card *card;
 337         struct cs5535audio *cs5535au;
 338         int err;
 339
 340         if (dev >= SNDRV_CARDS)
 341                 return -ENODEV;
 342         if (!enable[dev]) {
 343                 dev++;
 344                 return -ENOENT;
 345         }
 346
 347         card = snd_card_new(index[dev], id[dev], THIS_MODULE, 0);
 348         if (card == NULL)
 349                 return -ENOMEM;
 350
 351         if ((err = snd_cs5535audio_create(card, pci, &cs5535au)) < 0)
 352                 goto probefail_out;
 353
 354         card->private_data = cs5535au;
 355
 356         if ((err = snd_cs5535audio_mixer(cs5535au)) < 0)
 357                 goto probefail_out;
 358
 359         if ((err = snd_cs5535audio_pcm(cs5535au)) < 0)
 360                 goto probefail_out;
 361
 362         strcpy(card->driver, DRIVER_NAME);
 363
 364         strcpy(card->shortname, "CS5535 Audio");
 365         sprintf(card->longname, "%s %s at 0x%lx, irq %i",
 366                 card->shortname, card->driver,
 367                 cs5535au->port, cs5535au->irq);
 368
 369         if ((err = snd_card_register(card)) < 0)
 370                 goto probefail_out;
 371
 372         pci_set_drvdata(pci, card);
 373         dev++;
 374         return 0;
 375
 376 probefail_out:
 377         snd_card_free(card);
 378         return err;
 379 }
 380
 381 static void __devexit snd_cs5535audio_remove(struct pci_dev *pci)
 382 {
 383         snd_card_free(pci_get_drvdata(pci));
 384         pci_set_drvdata(pci, NULL);
 385 }
 386
 387 static struct pci_driver driver = {
 388         .name = DRIVER_NAME,
 389         .id_table = snd_cs5535audio_ids,
 390         .probe = snd_cs5535audio_probe,
 391         .remove = __devexit_p(snd_cs5535audio_remove),
 392 #ifdef CONFIG_PM
 393         .suspend = snd_cs5535audio_suspend,
 394         .resume = snd_cs5535audio_resume,
 395 #endif
 396 };
 397
 398 static int __init alsa_card_cs5535audio_init(void)
 399 {
 400         return pci_register_driver(&driver);
 401 }
 402
 403 static void __exit alsa_card_cs5535audio_exit(void)
 404 {
 405         pci_unregister_driver(&driver);
 406 }
 407
 408 module_init(alsa_card_cs5535audio_init)
 409 module_exit(alsa_card_cs5535audio_exit)
 410
 411 MODULE_AUTHOR("Jaya Kumar");
 412 MODULE_LICENSE("GPL");
 413 MODULE_DESCRIPTION("CS5535 Audio");
 414 MODULE_SUPPORTED_DEVICE("CS5535 Audio");