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[] __devinitdata = {
  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 cs5535 codec\n");
 114
 115         return (unsigned short) val;
 116 }
 117
 118 static void snd_cs5535audio_codec_write(struct cs5535audio *cs5535au,
 119                                         unsigned short reg, unsigned short val)
 120 {
 121         unsigned int regdata;
 122
 123         regdata = ((unsigned int) reg) << 24;
 124         regdata |= val;
 125         regdata &= CMD_MASK;
 126         regdata |= CMD_NEW;
 127         regdata &= ACC_CODEC_CNTL_WR_CMD;
 128
 129         cs_writel(cs5535au, ACC_CODEC_CNTL, regdata);
 130         wait_till_cmd_acked(cs5535au, 50);
 131 }
 132
 133 static void snd_cs5535audio_ac97_codec_write(struct snd_ac97 *ac97,
 134                                              unsigned short reg, unsigned short val)
 135 {
 136         struct cs5535audio *cs5535au = ac97->private_data;
 137         snd_cs5535audio_codec_write(cs5535au, reg, val);
 138 }
 139
 140 static unsigned short snd_cs5535audio_ac97_codec_read(struct snd_ac97 *ac97,
 141                                                       unsigned short reg)
 142 {
 143         struct cs5535audio *cs5535au = ac97->private_data;
 144         return snd_cs5535audio_codec_read(cs5535au, reg);
 145 }
 146
 147 static int snd_cs5535audio_mixer(struct cs5535audio *cs5535au)
 148 {
 149         struct snd_card *card = cs5535au->card;
 150         struct snd_ac97_bus *pbus;
 151         struct snd_ac97_template ac97;
 152         int err;
 153         static struct snd_ac97_bus_ops ops = {
 154                 .write = snd_cs5535audio_ac97_codec_write,
 155                 .read = snd_cs5535audio_ac97_codec_read,
 156         };
 157
 158         if ((err = snd_ac97_bus(card, 0, &ops, NULL, &pbus)) < 0)
 159                 return err;
 160
 161         memset(&ac97, 0, sizeof(ac97));
 162         ac97.scaps = AC97_SCAP_AUDIO|AC97_SCAP_SKIP_MODEM;
 163         ac97.private_data = cs5535au;
 164         ac97.pci = cs5535au->pci;
 165
 166         if ((err = snd_ac97_mixer(pbus, &ac97, &cs5535au->ac97)) < 0) {
 167                 snd_printk(KERN_ERR "mixer failed\n");
 168                 return err;
 169         }
 170
 171         snd_ac97_tune_hardware(cs5535au->ac97, ac97_quirks, ac97_quirk);
 172
 173         return 0;
 174 }
 175
 176 static void process_bm0_irq(struct cs5535audio *cs5535au)
 177 {
 178         u8 bm_stat;
 179         spin_lock(&cs5535au->reg_lock);
 180         bm_stat = cs_readb(cs5535au, ACC_BM0_STATUS);
 181         spin_unlock(&cs5535au->reg_lock);
 182         if (bm_stat & EOP) {
 183                 struct cs5535audio_dma *dma;
 184                 dma = cs5535au->playback_substream->runtime->private_data;
 185                 snd_pcm_period_elapsed(cs5535au->playback_substream);
 186         } else {
 187                 snd_printk(KERN_ERR "unexpected bm0 irq src, bm_stat=%x\n",
 188                                         bm_stat);
 189         }
 190 }
 191
 192 static void process_bm1_irq(struct cs5535audio *cs5535au)
 193 {
 194         u8 bm_stat;
 195         spin_lock(&cs5535au->reg_lock);
 196         bm_stat = cs_readb(cs5535au, ACC_BM1_STATUS);
 197         spin_unlock(&cs5535au->reg_lock);
 198         if (bm_stat & EOP) {
 199                 struct cs5535audio_dma *dma;
 200                 dma = cs5535au->capture_substream->runtime->private_data;
 201                 snd_pcm_period_elapsed(cs5535au->capture_substream);
 202         }
 203 }
 204
 205 static irqreturn_t snd_cs5535audio_interrupt(int irq, void *dev_id,
 206                                              struct pt_regs *regs)
 207 {
 208         u16 acc_irq_stat;
 209         u8 bm_stat;
 210         unsigned char count;
 211         struct cs5535audio *cs5535au = dev_id;
 212
 213         if (cs5535au == NULL)
 214                 return IRQ_NONE;
 215
 216         acc_irq_stat = cs_readw(cs5535au, ACC_IRQ_STATUS);
 217
 218         if (!acc_irq_stat)
 219                 return IRQ_NONE;
 220         for (count = 0; count < 10; count++) {
 221                 if (acc_irq_stat & (1 << count)) {
 222                         switch (count) {
 223                         case IRQ_STS:
 224                                 cs_readl(cs5535au, ACC_GPIO_STATUS);
 225                                 break;
 226                         case WU_IRQ_STS:
 227                                 cs_readl(cs5535au, ACC_GPIO_STATUS);
 228                                 break;
 229                         case BM0_IRQ_STS:
 230                                 process_bm0_irq(cs5535au);
 231                                 break;
 232                         case BM1_IRQ_STS:
 233                                 process_bm1_irq(cs5535au);
 234                                 break;
 235                         case BM2_IRQ_STS:
 236                                 bm_stat = cs_readb(cs5535au, ACC_BM2_STATUS);
 237                                 break;
 238                         case BM3_IRQ_STS:
 239                                 bm_stat = cs_readb(cs5535au, ACC_BM3_STATUS);
 240                                 break;
 241                         case BM4_IRQ_STS:
 242                                 bm_stat = cs_readb(cs5535au, ACC_BM4_STATUS);
 243                                 break;
 244                         case BM5_IRQ_STS:
 245                                 bm_stat = cs_readb(cs5535au, ACC_BM5_STATUS);
 246                                 break;
 247                         case BM6_IRQ_STS:
 248                                 bm_stat = cs_readb(cs5535au, ACC_BM6_STATUS);
 249                                 break;
 250                         case BM7_IRQ_STS:
 251                                 bm_stat = cs_readb(cs5535au, ACC_BM7_STATUS);
 252                                 break;
 253                         default:
 254                                 snd_printk(KERN_ERR "Unexpected irq src\n");
 255                                 break;
 256                         }
 257                 }
 258         }
 259         return IRQ_HANDLED;
 260 }
 261
 262 static int snd_cs5535audio_free(struct cs5535audio *cs5535au)
 263 {
 264         synchronize_irq(cs5535au->irq);
 265         pci_set_power_state(cs5535au->pci, 3);
 266
 267         if (cs5535au->irq >= 0)
 268                 free_irq(cs5535au->irq, cs5535au);
 269
 270         pci_release_regions(cs5535au->pci);
 271         pci_disable_device(cs5535au->pci);
 272         kfree(cs5535au);
 273         return 0;
 274 }
 275
 276 static int snd_cs5535audio_dev_free(struct snd_device *device)
 277 {
 278         struct cs5535audio *cs5535au = device->device_data;
 279         return snd_cs5535audio_free(cs5535au);
 280 }
 281
 282 static int __devinit snd_cs5535audio_create(struct snd_card *card,
 283                                             struct pci_dev *pci,
 284                                             struct cs5535audio **rcs5535au)
 285 {
 286         struct cs5535audio *cs5535au;
 287
 288         int err;
 289         static struct snd_device_ops ops = {
 290                 .dev_free =     snd_cs5535audio_dev_free,
 291         };
 292
 293         *rcs5535au = NULL;
 294         if ((err = pci_enable_device(pci)) < 0)
 295                 return err;
 296
 297         if (pci_set_dma_mask(pci, DMA_32BIT_MASK) < 0 ||
 298             pci_set_consistent_dma_mask(pci, DMA_32BIT_MASK) < 0) {
 299                 printk(KERN_WARNING "unable to get 32bit dma\n");
 300                 err = -ENXIO;
 301                 goto pcifail;
 302         }
 303
 304         cs5535au = kzalloc(sizeof(*cs5535au), GFP_KERNEL);
 305         if (cs5535au == NULL) {
 306                 err = -ENOMEM;
 307                 goto pcifail;
 308         }
 309
 310         spin_lock_init(&cs5535au->reg_lock);
 311         cs5535au->card = card;
 312         cs5535au->pci = pci;
 313         cs5535au->irq = -1;
 314
 315         if ((err = pci_request_regions(pci, "CS5535 Audio")) < 0) {
 316                 kfree(cs5535au);
 317                 goto pcifail;
 318         }
 319
 320         cs5535au->port = pci_resource_start(pci, 0);
 321
 322         if (request_irq(pci->irq, snd_cs5535audio_interrupt,
 323                         SA_INTERRUPT|SA_SHIRQ, "CS5535 Audio", cs5535au)) {
 324                 snd_printk("unable to grab IRQ %d\n", pci->irq);
 325                 err = -EBUSY;
 326                 goto sndfail;
 327         }
 328
 329         cs5535au->irq = pci->irq;
 330         pci_set_master(pci);
 331
 332         if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL,
 333                                   cs5535au, &ops)) < 0)
 334                 goto sndfail;
 335
 336         snd_card_set_dev(card, &pci->dev);
 337
 338         *rcs5535au = cs5535au;
 339         return 0;
 340
 341 sndfail: /* leave the device alive, just kill the snd */
 342         snd_cs5535audio_free(cs5535au);
 343         return err;
 344
 345 pcifail:
 346         pci_disable_device(pci);
 347         return err;
 348 }
 349
 350 static int __devinit snd_cs5535audio_probe(struct pci_dev *pci,
 351                                            const struct pci_device_id *pci_id)
 352 {
 353         static int dev;
 354         struct snd_card *card;
 355         struct cs5535audio *cs5535au;
 356         int err;
 357
 358         if (dev >= SNDRV_CARDS)
 359                 return -ENODEV;
 360         if (!enable[dev]) {
 361                 dev++;
 362                 return -ENOENT;
 363         }
 364
 365         card = snd_card_new(index[dev], id[dev], THIS_MODULE, 0);
 366         if (card == NULL)
 367                 return -ENOMEM;
 368
 369         if ((err = snd_cs5535audio_create(card, pci, &cs5535au)) < 0)
 370                 goto probefail_out;
 371
 372         card->private_data = cs5535au;
 373
 374         if ((err = snd_cs5535audio_mixer(cs5535au)) < 0)
 375                 goto probefail_out;
 376
 377         if ((err = snd_cs5535audio_pcm(cs5535au)) < 0)
 378                 goto probefail_out;
 379
 380         strcpy(card->driver, DRIVER_NAME);
 381
 382         strcpy(card->shortname, "CS5535 Audio");
 383         sprintf(card->longname, "%s %s at 0x%lx, irq %i",
 384                 card->shortname, card->driver,
 385                 cs5535au->port, cs5535au->irq);
 386
 387         if ((err = snd_card_register(card)) < 0)
 388                 goto probefail_out;
 389
 390         pci_set_drvdata(pci, card);
 391         dev++;
 392         return 0;
 393
 394 probefail_out:
 395         snd_card_free(card);
 396         return err;
 397 }
 398
 399 static void __devexit snd_cs5535audio_remove(struct pci_dev *pci)
 400 {
 401         snd_card_free(pci_get_drvdata(pci));
 402         pci_set_drvdata(pci, NULL);
 403 }
 404
 405 static struct pci_driver driver = {
 406         .name = DRIVER_NAME,
 407         .id_table = snd_cs5535audio_ids,
 408         .probe = snd_cs5535audio_probe,
 409         .remove = __devexit_p(snd_cs5535audio_remove),
 410 #ifdef CONFIG_PM
 411         .suspend = snd_cs5535audio_suspend,
 412         .resume = snd_cs5535audio_resume,
 413 #endif
 414 };
 415
 416 static int __init alsa_card_cs5535audio_init(void)
 417 {
 418         return pci_register_driver(&driver);
 419 }
 420
 421 static void __exit alsa_card_cs5535audio_exit(void)
 422 {
 423         pci_unregister_driver(&driver);
 424 }
 425
 426 module_init(alsa_card_cs5535audio_init)
 427 module_exit(alsa_card_cs5535audio_exit)
 428
 429 MODULE_AUTHOR("Jaya Kumar");
 430 MODULE_LICENSE("GPL");
 431 MODULE_DESCRIPTION("CS5535 Audio");
 432 MODULE_SUPPORTED_DEVICE("CS5535 Audio");