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, one for branch back, one for stop command */
  45         r->size = (numcmds + 3) * 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)
  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         const 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 = of_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 irq_handler_t ints[] = {
 169                 i2sbus_bus_intr,
 170                 i2sbus_tx_intr,
 171                 i2sbus_rx_intr
 172         };
 173
 174         if (strlen(np->name) != 5)
 175                 return 0;
 176         if (strncmp(np->name, "i2s-", 4))
 177                 return 0;
 178
 179         dev = kzalloc(sizeof(struct i2sbus_dev), GFP_KERNEL);
 180         if (!dev)
 181                 return 0;
 182
 183         i = 0;
 184         while ((child = of_get_next_child(np, child))) {
 185                 if (strcmp(child->name, "sound") == 0) {
 186                         i++;
 187                         sound = child;
 188                 }
 189         }
 190         if (i == 1) {
 191                 const u32 *layout_id =
 192                         of_get_property(sound, "layout-id", NULL);
 193                 if (layout_id) {
 194                         layout = *layout_id;
 195                         snprintf(dev->sound.modalias, 32,
 196                                  "sound-layout-%d", layout);
 197                         force = 1;
 198                 }
 199         }
 200         /* for the time being, until we can handle non-layout-id
 201          * things in some fabric, refuse to attach if there is no
 202          * layout-id property or we haven't been forced to attach.
 203          * When there are two i2s busses and only one has a layout-id,
 204          * then this depends on the order, but that isn't important
 205          * either as the second one in that case is just a modem. */
 206         if (!force) {
 207                 kfree(dev);
 208                 return -ENODEV;
 209         }
 210
 211         mutex_init(&dev->lock);
 212         spin_lock_init(&dev->low_lock);
 213         dev->sound.ofdev.node = np;
 214         dev->sound.ofdev.dma_mask = macio->ofdev.dma_mask;
 215         dev->sound.ofdev.dev.dma_mask = &dev->sound.ofdev.dma_mask;
 216         dev->sound.ofdev.dev.parent = &macio->ofdev.dev;
 217         dev->sound.ofdev.dev.release = i2sbus_release_dev;
 218         dev->sound.attach_codec = i2sbus_attach_codec;
 219         dev->sound.detach_codec = i2sbus_detach_codec;
 220         dev->sound.pcmid = -1;
 221         dev->macio = macio;
 222         dev->control = control;
 223         dev->bus_number = np->name[4] - 'a';
 224         INIT_LIST_HEAD(&dev->sound.codec_list);
 225
 226         for (i = aoa_resource_i2smmio; i <= aoa_resource_rxdbdma; i++) {
 227                 dev->interrupts[i] = -1;
 228                 snprintf(dev->rnames[i], sizeof(dev->rnames[i]),
 229                          rnames[i], np->name);
 230         }
 231         for (i = aoa_resource_i2smmio; i <= aoa_resource_rxdbdma; i++) {
 232                 int irq = irq_of_parse_and_map(np, i);
 233                 if (request_irq(irq, ints[i], 0, dev->rnames[i], dev))
 234                         goto err;
 235                 dev->interrupts[i] = irq;
 236         }
 237
 238
 239         /* Resource handling is problematic as some device-trees contain
 240          * useless crap (ugh ugh ugh). We work around that here by calling
 241          * specific functions for calculating the appropriate resources.
 242          *
 243          * This will all be moved to macio_asic.c at one point
 244          */
 245         for (i = aoa_resource_i2smmio; i <= aoa_resource_rxdbdma; i++) {
 246                 if (i2sbus_get_and_fixup_rsrc(np,i,layout,&dev->resources[i]))
 247                         goto err;
 248                 /* If only we could use our resource dev->resources[i]...
 249                  * but request_resource doesn't know about parents and
 250                  * contained resources...
 251                  */
 252                 dev->allocated_resource[i] =
 253                         request_mem_region(dev->resources[i].start,
 254                                            dev->resources[i].end -
 255                                            dev->resources[i].start + 1,
 256                                            dev->rnames[i]);
 257                 if (!dev->allocated_resource[i]) {
 258                         printk(KERN_ERR "i2sbus: failed to claim resource %d!\n", i);
 259                         goto err;
 260                 }
 261         }
 262
 263         r = &dev->resources[aoa_resource_i2smmio];
 264         rlen = r->end - r->start + 1;
 265         if (rlen < sizeof(struct i2s_interface_regs))
 266                 goto err;
 267         dev->intfregs = ioremap(r->start, rlen);
 268
 269         r = &dev->resources[aoa_resource_txdbdma];
 270         rlen = r->end - r->start + 1;
 271         if (rlen < sizeof(struct dbdma_regs))
 272                 goto err;
 273         dev->out.dbdma = ioremap(r->start, rlen);
 274
 275         r = &dev->resources[aoa_resource_rxdbdma];
 276         rlen = r->end - r->start + 1;
 277         if (rlen < sizeof(struct dbdma_regs))
 278                 goto err;
 279         dev->in.dbdma = ioremap(r->start, rlen);
 280
 281         if (!dev->intfregs || !dev->out.dbdma || !dev->in.dbdma)
 282                 goto err;
 283
 284         if (alloc_dbdma_descriptor_ring(dev, &dev->out.dbdma_ring,
 285                                         MAX_DBDMA_COMMANDS))
 286                 goto err;
 287         if (alloc_dbdma_descriptor_ring(dev, &dev->in.dbdma_ring,
 288                                         MAX_DBDMA_COMMANDS))
 289                 goto err;
 290
 291         if (i2sbus_control_add_dev(dev->control, dev)) {
 292                 printk(KERN_ERR "i2sbus: control layer didn't like bus\n");
 293                 goto err;
 294         }
 295
 296         if (soundbus_add_one(&dev->sound)) {
 297                 printk(KERN_DEBUG "i2sbus: device registration error!\n");
 298                 goto err;
 299         }
 300
 301         /* enable this cell */
 302         i2sbus_control_cell(dev->control, dev, 1);
 303         i2sbus_control_enable(dev->control, dev);
 304         i2sbus_control_clock(dev->control, dev, 1);
 305
 306         return 1;
 307  err:
 308         for (i=0;i<3;i++)
 309                 if (dev->interrupts[i] != -1)
 310                         free_irq(dev->interrupts[i], dev);
 311         free_dbdma_descriptor_ring(dev, &dev->out.dbdma_ring);
 312         free_dbdma_descriptor_ring(dev, &dev->in.dbdma_ring);
 313         if (dev->intfregs) iounmap(dev->intfregs);
 314         if (dev->out.dbdma) iounmap(dev->out.dbdma);
 315         if (dev->in.dbdma) iounmap(dev->in.dbdma);
 316         for (i=0;i<3;i++)
 317                 if (dev->allocated_resource[i])
 318                         release_and_free_resource(dev->allocated_resource[i]);
 319         mutex_destroy(&dev->lock);
 320         kfree(dev);
 321         return 0;
 322 }
 323
 324 static int i2sbus_probe(struct macio_dev* dev, const struct of_device_id *match)
 325 {
 326         struct device_node *np = NULL;
 327         int got = 0, err;
 328         struct i2sbus_control *control = NULL;
 329
 330         err = i2sbus_control_init(dev, &control);
 331         if (err)
 332                 return err;
 333         if (!control) {
 334                 printk(KERN_ERR "i2sbus_control_init API breakage\n");
 335                 return -ENODEV;
 336         }
 337
 338         while ((np = of_get_next_child(dev->ofdev.node, np))) {
 339                 if (of_device_is_compatible(np, "i2sbus") ||
 340                     of_device_is_compatible(np, "i2s-modem")) {
 341                         got += i2sbus_add_dev(dev, control, np);
 342                 }
 343         }
 344
 345         if (!got) {
 346                 /* found none, clean up */
 347                 i2sbus_control_destroy(control);
 348                 return -ENODEV;
 349         }
 350
 351         dev->ofdev.dev.driver_data = control;
 352
 353         return 0;
 354 }
 355
 356 static int i2sbus_remove(struct macio_dev* dev)
 357 {
 358         struct i2sbus_control *control = dev->ofdev.dev.driver_data;
 359         struct i2sbus_dev *i2sdev, *tmp;
 360
 361         list_for_each_entry_safe(i2sdev, tmp, &control->list, item)
 362                 soundbus_remove_one(&i2sdev->sound);
 363
 364         return 0;
 365 }
 366
 367 #ifdef CONFIG_PM
 368 static int i2sbus_suspend(struct macio_dev* dev, pm_message_t state)
 369 {
 370         struct i2sbus_control *control = dev->ofdev.dev.driver_data;
 371         struct codec_info_item *cii;
 372         struct i2sbus_dev* i2sdev;
 373         int err, ret = 0;
 374
 375         list_for_each_entry(i2sdev, &control->list, item) {
 376                 /* Notify Alsa */
 377                 if (i2sdev->sound.pcm) {
 378                         /* Suspend PCM streams */
 379                         snd_pcm_suspend_all(i2sdev->sound.pcm);
 380                 }
 381
 382                 /* Notify codecs */
 383                 list_for_each_entry(cii, &i2sdev->sound.codec_list, list) {
 384                         err = 0;
 385                         if (cii->codec->suspend)
 386                                 err = cii->codec->suspend(cii, state);
 387                         if (err)
 388                                 ret = err;
 389                 }
 390
 391                 /* wait until streams are stopped */
 392                 i2sbus_wait_for_stop_both(i2sdev);
 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                 /* reset i2s bus format etc. */
 407                 i2sbus_pcm_prepare_both(i2sdev);
 408
 409                 /* Notify codecs so they can re-initialize */
 410                 list_for_each_entry(cii, &i2sdev->sound.codec_list, list) {
 411                         err = 0;
 412                         if (cii->codec->resume)
 413                                 err = cii->codec->resume(cii);
 414                         if (err)
 415                                 ret = err;
 416                 }
 417         }
 418
 419         return ret;
 420 }
 421 #endif /* CONFIG_PM */
 422
 423 static int i2sbus_shutdown(struct macio_dev* dev)
 424 {
 425         return 0;
 426 }
 427
 428 static struct macio_driver i2sbus_drv = {
 429         .name = "soundbus-i2s",
 430         .owner = THIS_MODULE,
 431         .match_table = i2sbus_match,
 432         .probe = i2sbus_probe,
 433         .remove = i2sbus_remove,
 434 #ifdef CONFIG_PM
 435         .suspend = i2sbus_suspend,
 436         .resume = i2sbus_resume,
 437 #endif
 438         .shutdown = i2sbus_shutdown,
 439 };
 440
 441 static int __init soundbus_i2sbus_init(void)
 442 {
 443         return macio_register_driver(&i2sbus_drv);
 444 }
 445
 446 static void __exit soundbus_i2sbus_exit(void)
 447 {
 448         macio_unregister_driver(&i2sbus_drv);
 449 }
 450
 451 module_init(soundbus_i2sbus_init);
 452 module_exit(soundbus_i2sbus_exit);