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