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