sound/aoa/soundbus/i2sbus/i2sbus-core.c

   1 /*
   2  * i2sbus driver
   3  *
   4  * Copyright 2006 Johannes Berg <johannes@sipsolutions.net>
   5  *
   6  * GPL v2, can be found in COPYING.
   7  */
   8
   9 #include <linux/module.h>
  10 #include <linux/pci.h>
  11 #include <linux/interrupt.h>
  12 #include <linux/dma-mapping.h>
  13
  14 #include <sound/driver.h>
  15 #include <sound/core.h>
  16
  17 #include <asm/macio.h>
  18 #include <asm/dbdma.h>
  19
  20 #include "../soundbus.h"
  21 #include "i2sbus.h"
  22
  23 MODULE_LICENSE("GPL");
  24 MODULE_AUTHOR("Johannes Berg <johannes@sipsolutions.net>");
  25 MODULE_DESCRIPTION("Apple Soundbus: I2S support");
  26 /* for auto-loading, declare that we handle this weird
  27  * string that macio puts into the relevant device */
  28 MODULE_ALIAS("of:Ni2sTi2sC");
  29
  30 static int force;
  31 module_param(force, int, 0444);
  32 MODULE_PARM_DESC(force, "Force loading i2sbus even when"
  33                         " no layout-id property is present");
  34
  35 static struct of_device_id i2sbus_match[] = {
  36         { .name = "i2s" },
  37         { }
  38 };
  39
  40 static int alloc_dbdma_descriptor_ring(struct i2sbus_dev *i2sdev,
  41                                        struct dbdma_command_mem *r,
  42                                        int numcmds)
  43 {
  44         /* one more for rounding */
  45         r->size = (numcmds+1) * sizeof(struct dbdma_cmd);
  46         /* We use the PCI APIs for now until the generic one gets fixed
  47          * enough or until we get some macio-specific versions
  48          */
  49         r->space = dma_alloc_coherent(
  50                         &macio_get_pci_dev(i2sdev->macio)->dev,
  51                         r->size,
  52                         &r->bus_addr,
  53                         GFP_KERNEL);
  54
  55         if (!r->space) return -ENOMEM;
  56
  57         memset(r->space, 0, r->size);
  58         r->cmds = (void*)DBDMA_ALIGN(r->space);
  59         r->bus_cmd_start = r->bus_addr +
  60                            (dma_addr_t)((char*)r->cmds - (char*)r->space);
  61
  62         return 0;
  63 }
  64
  65 static void free_dbdma_descriptor_ring(struct i2sbus_dev *i2sdev,
  66                                        struct dbdma_command_mem *r)
  67 {
  68         if (!r->space) return;
  69
  70         dma_free_coherent(&macio_get_pci_dev(i2sdev->macio)->dev,
  71                             r->size, r->space, r->bus_addr);
  72 }
  73
  74 static void i2sbus_release_dev(struct device *dev)
  75 {
  76         struct i2sbus_dev *i2sdev;
  77         int i;
  78
  79         i2sdev = container_of(dev, struct i2sbus_dev, sound.ofdev.dev);
  80
  81         if (i2sdev->intfregs) iounmap(i2sdev->intfregs);
  82         if (i2sdev->out.dbdma) iounmap(i2sdev->out.dbdma);
  83         if (i2sdev->in.dbdma) iounmap(i2sdev->in.dbdma);
  84         for (i = aoa_resource_i2smmio; i <= aoa_resource_rxdbdma; i++)
  85                 if (i2sdev->allocated_resource[i])
  86                         release_and_free_resource(i2sdev->allocated_resource[i]);
  87         free_dbdma_descriptor_ring(i2sdev, &i2sdev->out.dbdma_ring);
  88         free_dbdma_descriptor_ring(i2sdev, &i2sdev->in.dbdma_ring);
  89         for (i = aoa_resource_i2smmio; i <= aoa_resource_rxdbdma; i++)
  90                 free_irq(i2sdev->interrupts[i], i2sdev);
  91         i2sbus_control_remove_dev(i2sdev->control, i2sdev);
  92         mutex_destroy(&i2sdev->lock);
  93         kfree(i2sdev);
  94 }
  95
  96 static irqreturn_t i2sbus_bus_intr(int irq, void *devid, struct pt_regs *regs)
  97 {
  98         struct i2sbus_dev *dev = devid;
  99         u32 intreg;
 100
 101         spin_lock(&dev->low_lock);
 102         intreg = in_le32(&dev->intfregs->intr_ctl);
 103
 104         /* acknowledge interrupt reasons */
 105         out_le32(&dev->intfregs->intr_ctl, intreg);
 106
 107         spin_unlock(&dev->low_lock);
 108
 109         return IRQ_HANDLED;
 110 }
 111
 112
 113 /*
 114  * XXX FIXME: We test the layout_id's here to get the proper way of
 115  * mapping in various registers, thanks to bugs in Apple device-trees.
 116  * We could instead key off the machine model and the name of the i2s
 117  * node (i2s-a). This we'll do when we move it all to macio_asic.c
 118  * and have that export items for each sub-node too.
 119  */
 120 static int i2sbus_get_and_fixup_rsrc(struct device_node *np, int index,
 121                                      int layout, struct resource *res)
 122 {
 123         struct device_node *parent;
 124         int pindex, rc = -ENXIO;
 125         u32 *reg;
 126
 127         /* Machines with layout 76 and 36 (K2 based) have a weird device
 128          * tree what we need to special case.
 129          * Normal machines just fetch the resource from the i2s-X node.
 130          * Darwin further divides normal machines into old and new layouts
 131          * with a subtely different code path but that doesn't seem necessary
 132          * in practice, they just bloated it. In addition, even on our K2
 133          * case the i2s-modem node, if we ever want to handle it, uses the
 134          * normal layout
 135          */
 136         if (layout != 76 && layout != 36)
 137                 return of_address_to_resource(np, index, res);
 138
 139         parent = of_get_parent(np);
 140         pindex = (index == aoa_resource_i2smmio) ? 0 : 1;
 141         rc = of_address_to_resource(parent, pindex, res);
 142         if (rc)
 143                 goto bail;
 144         reg = (u32 *)get_property(np, "reg", NULL);
 145         if (reg == NULL) {
 146                 rc = -ENXIO;
 147                 goto bail;
 148         }
 149         res->start += reg[index * 2];
 150         res->end = res->start + reg[index * 2 + 1] - 1;
 151  bail:
 152         of_node_put(parent);
 153         return rc;
 154 }
 155
 156 /* FIXME: look at device node refcounting */
 157 static int i2sbus_add_dev(struct macio_dev *macio,
 158                           struct i2sbus_control *control,
 159                           struct device_node *np)
 160 {
 161         struct i2sbus_dev *dev;
 162         struct device_node *child = NULL, *sound = NULL;
 163         struct resource *r;
 164         int i, layout = 0, rlen;
 165         static const char *rnames[] = { "i2sbus: %s (control)",
 166                                         "i2sbus: %s (tx)",
 167                                         "i2sbus: %s (rx)" };
 168         static irqreturn_t (*ints[])(int irq, void *devid,
 169                                      struct pt_regs *regs) = {
 170                 i2sbus_bus_intr,
 171                 i2sbus_tx_intr,
 172                 i2sbus_rx_intr
 173         };
 174
 175         if (strlen(np->name) != 5)
 176                 return 0;
 177         if (strncmp(np->name, "i2s-", 4))
 178                 return 0;
 179
 180         dev = kzalloc(sizeof(struct i2sbus_dev), GFP_KERNEL);
 181         if (!dev)
 182                 return 0;
 183
 184         i = 0;
 185         while ((child = of_get_next_child(np, child))) {
 186                 if (strcmp(child->name, "sound") == 0) {
 187                         i++;
 188                         sound = child;
 189                 }
 190         }
 191         if (i == 1) {
 192                 u32 *layout_id;
 193                 layout_id = (u32*) get_property(sound, "layout-id", NULL);
 194                 if (layout_id) {
 195                         layout = *layout_id;
 196                         snprintf(dev->sound.modalias, 32,
 197                                  "sound-layout-%d", layout);
 198                         force = 1;
 199                 }
 200         }
 201         /* for the time being, until we can handle non-layout-id
 202          * things in some fabric, refuse to attach if there is no
 203          * layout-id property or we haven't been forced to attach.
 204          * When there are two i2s busses and only one has a layout-id,
 205          * then this depends on the order, but that isn't important
 206          * either as the second one in that case is just a modem. */
 207         if (!force) {
 208                 kfree(dev);
 209                 return -ENODEV;
 210         }
 211
 212         mutex_init(&dev->lock);
 213         spin_lock_init(&dev->low_lock);
 214         dev->sound.ofdev.node = np;
 215         dev->sound.ofdev.dma_mask = macio->ofdev.dma_mask;
 216         dev->sound.ofdev.dev.dma_mask = &dev->sound.ofdev.dma_mask;
 217         dev->sound.ofdev.dev.parent = &macio->ofdev.dev;
 218         dev->sound.ofdev.dev.release = i2sbus_release_dev;
 219         dev->sound.attach_codec = i2sbus_attach_codec;
 220         dev->sound.detach_codec = i2sbus_detach_codec;
 221         dev->sound.pcmid = -1;
 222         dev->macio = macio;
 223         dev->control = control;
 224         dev->bus_number = np->name[4] - 'a';
 225         INIT_LIST_HEAD(&dev->sound.codec_list);
 226
 227         for (i = aoa_resource_i2smmio; i <= aoa_resource_rxdbdma; i++) {
 228                 dev->interrupts[i] = -1;
 229                 snprintf(dev->rnames[i], sizeof(dev->rnames[i]),
 230                          rnames[i], np->name);
 231         }
 232         for (i = aoa_resource_i2smmio; i <= aoa_resource_rxdbdma; i++) {
 233                 int irq = irq_of_parse_and_map(np, i);
 234                 if (request_irq(irq, ints[i], 0, dev->rnames[i], dev))
 235                         goto err;
 236                 dev->interrupts[i] = irq;
 237         }
 238
 239
 240         /* Resource handling is problematic as some device-trees contain
 241          * useless crap (ugh ugh ugh). We work around that here by calling
 242          * specific functions for calculating the appropriate resources.
 243          *
 244          * This will all be moved to macio_asic.c at one point
 245          */
 246         for (i = aoa_resource_i2smmio; i <= aoa_resource_rxdbdma; i++) {
 247                 if (i2sbus_get_and_fixup_rsrc(np,i,layout,&dev->resources[i]))
 248                         goto err;
 249                 /* If only we could use our resource dev->resources[i]...
 250                  * but request_resource doesn't know about parents and
 251                  * contained resources...
 252                  */
 253                 dev->allocated_resource[i] =
 254                         request_mem_region(dev->resources[i].start,
 255                                            dev->resources[i].end -
 256                                            dev->resources[i].start + 1,
 257                                            dev->rnames[i]);
 258                 if (!dev->allocated_resource[i]) {
 259                         printk(KERN_ERR "i2sbus: failed to claim resource %d!\n", i);
 260                         goto err;
 261                 }
 262         }
 263
 264         r = &dev->resources[aoa_resource_i2smmio];
 265         rlen = r->end - r->start + 1;
 266         if (rlen < sizeof(struct i2s_interface_regs))
 267                 goto err;
 268         dev->intfregs = ioremap(r->start, rlen);
 269
 270         r = &dev->resources[aoa_resource_txdbdma];
 271         rlen = r->end - r->start + 1;
 272         if (rlen < sizeof(struct dbdma_regs))
 273                 goto err;
 274         dev->out.dbdma = ioremap(r->start, rlen);
 275
 276         r = &dev->resources[aoa_resource_rxdbdma];
 277         rlen = r->end - r->start + 1;
 278         if (rlen < sizeof(struct dbdma_regs))
 279                 goto err;
 280         dev->in.dbdma = ioremap(r->start, rlen);
 281
 282         if (!dev->intfregs || !dev->out.dbdma || !dev->in.dbdma)
 283                 goto err;
 284
 285         if (alloc_dbdma_descriptor_ring(dev, &dev->out.dbdma_ring,
 286                                         MAX_DBDMA_COMMANDS))
 287                 goto err;
 288         if (alloc_dbdma_descriptor_ring(dev, &dev->in.dbdma_ring,
 289                                         MAX_DBDMA_COMMANDS))
 290                 goto err;
 291
 292         if (i2sbus_control_add_dev(dev->control, dev)) {
 293                 printk(KERN_ERR "i2sbus: control layer didn't like bus\n");
 294                 goto err;
 295         }
 296
 297         if (soundbus_add_one(&dev->sound)) {
 298                 printk(KERN_DEBUG "i2sbus: device registration error!\n");
 299                 goto err;
 300         }
 301
 302         /* enable this cell */
 303         i2sbus_control_cell(dev->control, dev, 1);
 304         i2sbus_control_enable(dev->control, dev);
 305         i2sbus_control_clock(dev->control, dev, 1);
 306
 307         return 1;
 308  err:
 309         for (i=0;i<3;i++)
 310                 if (dev->interrupts[i] != -1)
 311                         free_irq(dev->interrupts[i], dev);
 312         free_dbdma_descriptor_ring(dev, &dev->out.dbdma_ring);
 313         free_dbdma_descriptor_ring(dev, &dev->in.dbdma_ring);
 314         if (dev->intfregs) iounmap(dev->intfregs);
 315         if (dev->out.dbdma) iounmap(dev->out.dbdma);
 316         if (dev->in.dbdma) iounmap(dev->in.dbdma);
 317         for (i=0;i<3;i++)
 318                 if (dev->allocated_resource[i])
 319                         release_and_free_resource(dev->allocated_resource[i]);
 320         mutex_destroy(&dev->lock);
 321         kfree(dev);
 322         return 0;
 323 }
 324
 325 static int i2sbus_probe(struct macio_dev* dev, const struct of_device_id *match)
 326 {
 327         struct device_node *np = NULL;
 328         int got = 0, err;
 329         struct i2sbus_control *control = NULL;
 330
 331         err = i2sbus_control_init(dev, &control);
 332         if (err)
 333                 return err;
 334         if (!control) {
 335                 printk(KERN_ERR "i2sbus_control_init API breakage\n");
 336                 return -ENODEV;
 337         }
 338
 339         while ((np = of_get_next_child(dev->ofdev.node, np))) {
 340                 if (device_is_compatible(np, "i2sbus") ||
 341                     device_is_compatible(np, "i2s-modem")) {
 342                         got += i2sbus_add_dev(dev, control, np);
 343                 }
 344         }
 345
 346         if (!got) {
 347                 /* found none, clean up */
 348                 i2sbus_control_destroy(control);
 349                 return -ENODEV;
 350         }
 351
 352         dev->ofdev.dev.driver_data = control;
 353
 354         return 0;
 355 }
 356
 357 static int i2sbus_remove(struct macio_dev* dev)
 358 {
 359         struct i2sbus_control *control = dev->ofdev.dev.driver_data;
 360         struct i2sbus_dev *i2sdev, *tmp;
 361
 362         list_for_each_entry_safe(i2sdev, tmp, &control->list, item)
 363                 soundbus_remove_one(&i2sdev->sound);
 364
 365         return 0;
 366 }
 367
 368 #ifdef CONFIG_PM
 369 static int i2sbus_suspend(struct macio_dev* dev, pm_message_t state)
 370 {
 371         struct i2sbus_control *control = dev->ofdev.dev.driver_data;
 372         struct codec_info_item *cii;
 373         struct i2sbus_dev* i2sdev;
 374         int err, ret = 0;
 375
 376         list_for_each_entry(i2sdev, &control->list, item) {
 377                 /* Notify Alsa */
 378                 if (i2sdev->sound.pcm) {
 379                         /* Suspend PCM streams */
 380                         snd_pcm_suspend_all(i2sdev->sound.pcm);
 381                         /* Probably useless as we handle
 382                          * power transitions ourselves */
 383                         snd_power_change_state(i2sdev->sound.pcm->card,
 384                                                SNDRV_CTL_POWER_D3hot);
 385                 }
 386                 /* Notify codecs */
 387                 list_for_each_entry(cii, &i2sdev->sound.codec_list, list) {
 388                         err = 0;
 389                         if (cii->codec->suspend)
 390                                 err = cii->codec->suspend(cii, state);
 391                         if (err)
 392                                 ret = err;
 393                 }
 394         }
 395         return ret;
 396 }
 397
 398 static int i2sbus_resume(struct macio_dev* dev)
 399 {
 400         struct i2sbus_control *control = dev->ofdev.dev.driver_data;
 401         struct codec_info_item *cii;
 402         struct i2sbus_dev* i2sdev;
 403         int err, ret = 0;
 404
 405         list_for_each_entry(i2sdev, &control->list, item) {
 406                 /* Notify codecs so they can re-initialize */
 407                 list_for_each_entry(cii, &i2sdev->sound.codec_list, list) {
 408                         err = 0;
 409                         if (cii->codec->resume)
 410                                 err = cii->codec->resume(cii);
 411                         if (err)
 412                                 ret = err;
 413                 }
 414                 /* Notify Alsa */
 415                 if (i2sdev->sound.pcm) {
 416                         /* Same comment as above, probably useless */
 417                         snd_power_change_state(i2sdev->sound.pcm->card,
 418                                                SNDRV_CTL_POWER_D0);
 419                 }
 420         }
 421
 422         return ret;
 423 }
 424 #endif /* CONFIG_PM */
 425
 426 static int i2sbus_shutdown(struct macio_dev* dev)
 427 {
 428         return 0;
 429 }
 430
 431 static struct macio_driver i2sbus_drv = {
 432         .name = "soundbus-i2s",
 433         .owner = THIS_MODULE,
 434         .match_table = i2sbus_match,
 435         .probe = i2sbus_probe,
 436         .remove = i2sbus_remove,
 437 #ifdef CONFIG_PM
 438         .suspend = i2sbus_suspend,
 439         .resume = i2sbus_resume,
 440 #endif
 441         .shutdown = i2sbus_shutdown,
 442 };
 443
 444 static int __init soundbus_i2sbus_init(void)
 445 {
 446         return macio_register_driver(&i2sbus_drv);
 447 }
 448
 449 static void __exit soundbus_i2sbus_exit(void)
 450 {
 451         macio_unregister_driver(&i2sbus_drv);
 452 }
 453
 454 module_init(soundbus_i2sbus_init);
 455 module_exit(soundbus_i2sbus_exit);