Merge branch 'i2c-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jdelvar...
[linux-2.6.git] / drivers / amba / bus.c
1 /*
2  *  linux/arch/arm/common/amba.c
3  *
4  *  Copyright (C) 2003 Deep Blue Solutions Ltd, All Rights Reserved.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  */
10 #include <linux/module.h>
11 #include <linux/init.h>
12 #include <linux/device.h>
13 #include <linux/string.h>
14 #include <linux/slab.h>
15 #include <linux/io.h>
16 #include <linux/pm.h>
17 #include <linux/pm_runtime.h>
18 #include <linux/amba/bus.h>
19
20 #include <asm/irq.h>
21 #include <asm/sizes.h>
22
23 #define to_amba_driver(d)       container_of(d, struct amba_driver, drv)
24
25 static const struct amba_id *
26 amba_lookup(const struct amba_id *table, struct amba_device *dev)
27 {
28         int ret = 0;
29
30         while (table->mask) {
31                 ret = (dev->periphid & table->mask) == table->id;
32                 if (ret)
33                         break;
34                 table++;
35         }
36
37         return ret ? table : NULL;
38 }
39
40 static int amba_match(struct device *dev, struct device_driver *drv)
41 {
42         struct amba_device *pcdev = to_amba_device(dev);
43         struct amba_driver *pcdrv = to_amba_driver(drv);
44
45         return amba_lookup(pcdrv->id_table, pcdev) != NULL;
46 }
47
48 #ifdef CONFIG_HOTPLUG
49 static int amba_uevent(struct device *dev, struct kobj_uevent_env *env)
50 {
51         struct amba_device *pcdev = to_amba_device(dev);
52         int retval = 0;
53
54         retval = add_uevent_var(env, "AMBA_ID=%08x", pcdev->periphid);
55         if (retval)
56                 return retval;
57
58         retval = add_uevent_var(env, "MODALIAS=amba:d%08X", pcdev->periphid);
59         return retval;
60 }
61 #else
62 #define amba_uevent NULL
63 #endif
64
65 #define amba_attr_func(name,fmt,arg...)                                 \
66 static ssize_t name##_show(struct device *_dev,                         \
67                            struct device_attribute *attr, char *buf)    \
68 {                                                                       \
69         struct amba_device *dev = to_amba_device(_dev);                 \
70         return sprintf(buf, fmt, arg);                                  \
71 }
72
73 #define amba_attr(name,fmt,arg...)      \
74 amba_attr_func(name,fmt,arg)            \
75 static DEVICE_ATTR(name, S_IRUGO, name##_show, NULL)
76
77 amba_attr_func(id, "%08x\n", dev->periphid);
78 amba_attr(irq0, "%u\n", dev->irq[0]);
79 amba_attr(irq1, "%u\n", dev->irq[1]);
80 amba_attr_func(resource, "\t%016llx\t%016llx\t%016lx\n",
81          (unsigned long long)dev->res.start, (unsigned long long)dev->res.end,
82          dev->res.flags);
83
84 static struct device_attribute amba_dev_attrs[] = {
85         __ATTR_RO(id),
86         __ATTR_RO(resource),
87         __ATTR_NULL,
88 };
89
90 #ifdef CONFIG_PM_SLEEP
91
92 static int amba_legacy_suspend(struct device *dev, pm_message_t mesg)
93 {
94         struct amba_driver *adrv = to_amba_driver(dev->driver);
95         struct amba_device *adev = to_amba_device(dev);
96         int ret = 0;
97
98         if (dev->driver && adrv->suspend)
99                 ret = adrv->suspend(adev, mesg);
100
101         return ret;
102 }
103
104 static int amba_legacy_resume(struct device *dev)
105 {
106         struct amba_driver *adrv = to_amba_driver(dev->driver);
107         struct amba_device *adev = to_amba_device(dev);
108         int ret = 0;
109
110         if (dev->driver && adrv->resume)
111                 ret = adrv->resume(adev);
112
113         return ret;
114 }
115
116 #endif /* CONFIG_PM_SLEEP */
117
118 #ifdef CONFIG_SUSPEND
119
120 static int amba_pm_suspend(struct device *dev)
121 {
122         struct device_driver *drv = dev->driver;
123         int ret = 0;
124
125         if (!drv)
126                 return 0;
127
128         if (drv->pm) {
129                 if (drv->pm->suspend)
130                         ret = drv->pm->suspend(dev);
131         } else {
132                 ret = amba_legacy_suspend(dev, PMSG_SUSPEND);
133         }
134
135         return ret;
136 }
137
138 static int amba_pm_resume(struct device *dev)
139 {
140         struct device_driver *drv = dev->driver;
141         int ret = 0;
142
143         if (!drv)
144                 return 0;
145
146         if (drv->pm) {
147                 if (drv->pm->resume)
148                         ret = drv->pm->resume(dev);
149         } else {
150                 ret = amba_legacy_resume(dev);
151         }
152
153         return ret;
154 }
155
156 #else /* !CONFIG_SUSPEND */
157
158 #define amba_pm_suspend         NULL
159 #define amba_pm_resume          NULL
160
161 #endif /* !CONFIG_SUSPEND */
162
163 #ifdef CONFIG_HIBERNATE_CALLBACKS
164
165 static int amba_pm_freeze(struct device *dev)
166 {
167         struct device_driver *drv = dev->driver;
168         int ret = 0;
169
170         if (!drv)
171                 return 0;
172
173         if (drv->pm) {
174                 if (drv->pm->freeze)
175                         ret = drv->pm->freeze(dev);
176         } else {
177                 ret = amba_legacy_suspend(dev, PMSG_FREEZE);
178         }
179
180         return ret;
181 }
182
183 static int amba_pm_thaw(struct device *dev)
184 {
185         struct device_driver *drv = dev->driver;
186         int ret = 0;
187
188         if (!drv)
189                 return 0;
190
191         if (drv->pm) {
192                 if (drv->pm->thaw)
193                         ret = drv->pm->thaw(dev);
194         } else {
195                 ret = amba_legacy_resume(dev);
196         }
197
198         return ret;
199 }
200
201 static int amba_pm_poweroff(struct device *dev)
202 {
203         struct device_driver *drv = dev->driver;
204         int ret = 0;
205
206         if (!drv)
207                 return 0;
208
209         if (drv->pm) {
210                 if (drv->pm->poweroff)
211                         ret = drv->pm->poweroff(dev);
212         } else {
213                 ret = amba_legacy_suspend(dev, PMSG_HIBERNATE);
214         }
215
216         return ret;
217 }
218
219 static int amba_pm_restore(struct device *dev)
220 {
221         struct device_driver *drv = dev->driver;
222         int ret = 0;
223
224         if (!drv)
225                 return 0;
226
227         if (drv->pm) {
228                 if (drv->pm->restore)
229                         ret = drv->pm->restore(dev);
230         } else {
231                 ret = amba_legacy_resume(dev);
232         }
233
234         return ret;
235 }
236
237 #else /* !CONFIG_HIBERNATE_CALLBACKS */
238
239 #define amba_pm_freeze          NULL
240 #define amba_pm_thaw            NULL
241 #define amba_pm_poweroff                NULL
242 #define amba_pm_restore         NULL
243
244 #endif /* !CONFIG_HIBERNATE_CALLBACKS */
245
246 #ifdef CONFIG_PM_RUNTIME
247 /*
248  * Hooks to provide runtime PM of the pclk (bus clock).  It is safe to
249  * enable/disable the bus clock at runtime PM suspend/resume as this
250  * does not result in loss of context.  However, disabling vcore power
251  * would do, so we leave that to the driver.
252  */
253 static int amba_pm_runtime_suspend(struct device *dev)
254 {
255         struct amba_device *pcdev = to_amba_device(dev);
256         int ret = pm_generic_runtime_suspend(dev);
257
258         if (ret == 0 && dev->driver)
259                 clk_disable(pcdev->pclk);
260
261         return ret;
262 }
263
264 static int amba_pm_runtime_resume(struct device *dev)
265 {
266         struct amba_device *pcdev = to_amba_device(dev);
267         int ret;
268
269         if (dev->driver) {
270                 ret = clk_enable(pcdev->pclk);
271                 /* Failure is probably fatal to the system, but... */
272                 if (ret)
273                         return ret;
274         }
275
276         return pm_generic_runtime_resume(dev);
277 }
278 #endif
279
280 #ifdef CONFIG_PM
281
282 static const struct dev_pm_ops amba_pm = {
283         .suspend        = amba_pm_suspend,
284         .resume         = amba_pm_resume,
285         .freeze         = amba_pm_freeze,
286         .thaw           = amba_pm_thaw,
287         .poweroff       = amba_pm_poweroff,
288         .restore        = amba_pm_restore,
289         SET_RUNTIME_PM_OPS(
290                 amba_pm_runtime_suspend,
291                 amba_pm_runtime_resume,
292                 pm_generic_runtime_idle
293         )
294 };
295
296 #define AMBA_PM (&amba_pm)
297
298 #else /* !CONFIG_PM */
299
300 #define AMBA_PM NULL
301
302 #endif /* !CONFIG_PM */
303
304 /*
305  * Primecells are part of the Advanced Microcontroller Bus Architecture,
306  * so we call the bus "amba".
307  */
308 struct bus_type amba_bustype = {
309         .name           = "amba",
310         .dev_attrs      = amba_dev_attrs,
311         .match          = amba_match,
312         .uevent         = amba_uevent,
313         .pm             = AMBA_PM,
314 };
315
316 static int __init amba_init(void)
317 {
318         return bus_register(&amba_bustype);
319 }
320
321 postcore_initcall(amba_init);
322
323 static int amba_get_enable_pclk(struct amba_device *pcdev)
324 {
325         struct clk *pclk = clk_get(&pcdev->dev, "apb_pclk");
326         int ret;
327
328         pcdev->pclk = pclk;
329
330         if (IS_ERR(pclk))
331                 return PTR_ERR(pclk);
332
333         ret = clk_prepare(pclk);
334         if (ret) {
335                 clk_put(pclk);
336                 return ret;
337         }
338
339         ret = clk_enable(pclk);
340         if (ret) {
341                 clk_unprepare(pclk);
342                 clk_put(pclk);
343         }
344
345         return ret;
346 }
347
348 static void amba_put_disable_pclk(struct amba_device *pcdev)
349 {
350         struct clk *pclk = pcdev->pclk;
351
352         clk_disable(pclk);
353         clk_unprepare(pclk);
354         clk_put(pclk);
355 }
356
357 static int amba_get_enable_vcore(struct amba_device *pcdev)
358 {
359         struct regulator *vcore = regulator_get(&pcdev->dev, "vcore");
360         int ret;
361
362         pcdev->vcore = vcore;
363
364         if (IS_ERR(vcore)) {
365                 /* It is OK not to supply a vcore regulator */
366                 if (PTR_ERR(vcore) == -ENODEV)
367                         return 0;
368                 return PTR_ERR(vcore);
369         }
370
371         ret = regulator_enable(vcore);
372         if (ret) {
373                 regulator_put(vcore);
374                 pcdev->vcore = ERR_PTR(-ENODEV);
375         }
376
377         return ret;
378 }
379
380 static void amba_put_disable_vcore(struct amba_device *pcdev)
381 {
382         struct regulator *vcore = pcdev->vcore;
383
384         if (!IS_ERR(vcore)) {
385                 regulator_disable(vcore);
386                 regulator_put(vcore);
387         }
388 }
389
390 /*
391  * These are the device model conversion veneers; they convert the
392  * device model structures to our more specific structures.
393  */
394 static int amba_probe(struct device *dev)
395 {
396         struct amba_device *pcdev = to_amba_device(dev);
397         struct amba_driver *pcdrv = to_amba_driver(dev->driver);
398         const struct amba_id *id = amba_lookup(pcdrv->id_table, pcdev);
399         int ret;
400
401         do {
402                 ret = amba_get_enable_vcore(pcdev);
403                 if (ret)
404                         break;
405
406                 ret = amba_get_enable_pclk(pcdev);
407                 if (ret)
408                         break;
409
410                 pm_runtime_get_noresume(dev);
411                 pm_runtime_set_active(dev);
412                 pm_runtime_enable(dev);
413
414                 ret = pcdrv->probe(pcdev, id);
415                 if (ret == 0)
416                         break;
417
418                 pm_runtime_disable(dev);
419                 pm_runtime_set_suspended(dev);
420                 pm_runtime_put_noidle(dev);
421
422                 amba_put_disable_pclk(pcdev);
423                 amba_put_disable_vcore(pcdev);
424         } while (0);
425
426         return ret;
427 }
428
429 static int amba_remove(struct device *dev)
430 {
431         struct amba_device *pcdev = to_amba_device(dev);
432         struct amba_driver *drv = to_amba_driver(dev->driver);
433         int ret;
434
435         pm_runtime_get_sync(dev);
436         ret = drv->remove(pcdev);
437         pm_runtime_put_noidle(dev);
438
439         /* Undo the runtime PM settings in amba_probe() */
440         pm_runtime_disable(dev);
441         pm_runtime_set_suspended(dev);
442         pm_runtime_put_noidle(dev);
443
444         amba_put_disable_pclk(pcdev);
445         amba_put_disable_vcore(pcdev);
446
447         return ret;
448 }
449
450 static void amba_shutdown(struct device *dev)
451 {
452         struct amba_driver *drv = to_amba_driver(dev->driver);
453         drv->shutdown(to_amba_device(dev));
454 }
455
456 /**
457  *      amba_driver_register - register an AMBA device driver
458  *      @drv: amba device driver structure
459  *
460  *      Register an AMBA device driver with the Linux device model
461  *      core.  If devices pre-exist, the drivers probe function will
462  *      be called.
463  */
464 int amba_driver_register(struct amba_driver *drv)
465 {
466         drv->drv.bus = &amba_bustype;
467
468 #define SETFN(fn)       if (drv->fn) drv->drv.fn = amba_##fn
469         SETFN(probe);
470         SETFN(remove);
471         SETFN(shutdown);
472
473         return driver_register(&drv->drv);
474 }
475
476 /**
477  *      amba_driver_unregister - remove an AMBA device driver
478  *      @drv: AMBA device driver structure to remove
479  *
480  *      Unregister an AMBA device driver from the Linux device
481  *      model.  The device model will call the drivers remove function
482  *      for each device the device driver is currently handling.
483  */
484 void amba_driver_unregister(struct amba_driver *drv)
485 {
486         driver_unregister(&drv->drv);
487 }
488
489
490 static void amba_device_release(struct device *dev)
491 {
492         struct amba_device *d = to_amba_device(dev);
493
494         if (d->res.parent)
495                 release_resource(&d->res);
496         kfree(d);
497 }
498
499 /**
500  *      amba_device_add - add a previously allocated AMBA device structure
501  *      @dev: AMBA device allocated by amba_device_alloc
502  *      @parent: resource parent for this devices resources
503  *
504  *      Claim the resource, and read the device cell ID if not already
505  *      initialized.  Register the AMBA device with the Linux device
506  *      manager.
507  */
508 int amba_device_add(struct amba_device *dev, struct resource *parent)
509 {
510         u32 size;
511         void __iomem *tmp;
512         int i, ret;
513
514         WARN_ON(dev->irq[0] == (unsigned int)-1);
515         WARN_ON(dev->irq[1] == (unsigned int)-1);
516
517         ret = request_resource(parent, &dev->res);
518         if (ret)
519                 goto err_out;
520
521         /* Hard-coded primecell ID instead of plug-n-play */
522         if (dev->periphid != 0)
523                 goto skip_probe;
524
525         /*
526          * Dynamically calculate the size of the resource
527          * and use this for iomap
528          */
529         size = resource_size(&dev->res);
530         tmp = ioremap(dev->res.start, size);
531         if (!tmp) {
532                 ret = -ENOMEM;
533                 goto err_release;
534         }
535
536         ret = amba_get_enable_pclk(dev);
537         if (ret == 0) {
538                 u32 pid, cid;
539
540                 /*
541                  * Read pid and cid based on size of resource
542                  * they are located at end of region
543                  */
544                 for (pid = 0, i = 0; i < 4; i++)
545                         pid |= (readl(tmp + size - 0x20 + 4 * i) & 255) <<
546                                 (i * 8);
547                 for (cid = 0, i = 0; i < 4; i++)
548                         cid |= (readl(tmp + size - 0x10 + 4 * i) & 255) <<
549                                 (i * 8);
550
551                 amba_put_disable_pclk(dev);
552
553                 if (cid == AMBA_CID)
554                         dev->periphid = pid;
555
556                 if (!dev->periphid)
557                         ret = -ENODEV;
558         }
559
560         iounmap(tmp);
561
562         if (ret)
563                 goto err_release;
564
565  skip_probe:
566         ret = device_add(&dev->dev);
567         if (ret)
568                 goto err_release;
569
570         if (dev->irq[0] && dev->irq[0] != NO_IRQ)
571                 ret = device_create_file(&dev->dev, &dev_attr_irq0);
572         if (ret == 0 && dev->irq[1] && dev->irq[1] != NO_IRQ)
573                 ret = device_create_file(&dev->dev, &dev_attr_irq1);
574         if (ret == 0)
575                 return ret;
576
577         device_unregister(&dev->dev);
578
579  err_release:
580         release_resource(&dev->res);
581  err_out:
582         return ret;
583 }
584 EXPORT_SYMBOL_GPL(amba_device_add);
585
586 static void amba_device_initialize(struct amba_device *dev, const char *name)
587 {
588         device_initialize(&dev->dev);
589         if (name)
590                 dev_set_name(&dev->dev, "%s", name);
591         dev->dev.release = amba_device_release;
592         dev->dev.bus = &amba_bustype;
593         dev->dev.dma_mask = &dev->dma_mask;
594         dev->res.name = dev_name(&dev->dev);
595 }
596
597 /**
598  *      amba_device_alloc - allocate an AMBA device
599  *      @name: sysfs name of the AMBA device
600  *      @base: base of AMBA device
601  *      @size: size of AMBA device
602  *
603  *      Allocate and initialize an AMBA device structure.  Returns %NULL
604  *      on failure.
605  */
606 struct amba_device *amba_device_alloc(const char *name, resource_size_t base,
607         size_t size)
608 {
609         struct amba_device *dev;
610
611         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
612         if (dev) {
613                 amba_device_initialize(dev, name);
614                 dev->res.start = base;
615                 dev->res.end = base + size - 1;
616                 dev->res.flags = IORESOURCE_MEM;
617         }
618
619         return dev;
620 }
621 EXPORT_SYMBOL_GPL(amba_device_alloc);
622
623 /**
624  *      amba_device_register - register an AMBA device
625  *      @dev: AMBA device to register
626  *      @parent: parent memory resource
627  *
628  *      Setup the AMBA device, reading the cell ID if present.
629  *      Claim the resource, and register the AMBA device with
630  *      the Linux device manager.
631  */
632 int amba_device_register(struct amba_device *dev, struct resource *parent)
633 {
634         amba_device_initialize(dev, dev->dev.init_name);
635         dev->dev.init_name = NULL;
636
637         if (!dev->dev.coherent_dma_mask && dev->dma_mask)
638                 dev_warn(&dev->dev, "coherent dma mask is unset\n");
639
640         return amba_device_add(dev, parent);
641 }
642
643 /**
644  *      amba_device_put - put an AMBA device
645  *      @dev: AMBA device to put
646  */
647 void amba_device_put(struct amba_device *dev)
648 {
649         put_device(&dev->dev);
650 }
651 EXPORT_SYMBOL_GPL(amba_device_put);
652
653 /**
654  *      amba_device_unregister - unregister an AMBA device
655  *      @dev: AMBA device to remove
656  *
657  *      Remove the specified AMBA device from the Linux device
658  *      manager.  All files associated with this object will be
659  *      destroyed, and device drivers notified that the device has
660  *      been removed.  The AMBA device's resources including
661  *      the amba_device structure will be freed once all
662  *      references to it have been dropped.
663  */
664 void amba_device_unregister(struct amba_device *dev)
665 {
666         device_unregister(&dev->dev);
667 }
668
669
670 struct find_data {
671         struct amba_device *dev;
672         struct device *parent;
673         const char *busid;
674         unsigned int id;
675         unsigned int mask;
676 };
677
678 static int amba_find_match(struct device *dev, void *data)
679 {
680         struct find_data *d = data;
681         struct amba_device *pcdev = to_amba_device(dev);
682         int r;
683
684         r = (pcdev->periphid & d->mask) == d->id;
685         if (d->parent)
686                 r &= d->parent == dev->parent;
687         if (d->busid)
688                 r &= strcmp(dev_name(dev), d->busid) == 0;
689
690         if (r) {
691                 get_device(dev);
692                 d->dev = pcdev;
693         }
694
695         return r;
696 }
697
698 /**
699  *      amba_find_device - locate an AMBA device given a bus id
700  *      @busid: bus id for device (or NULL)
701  *      @parent: parent device (or NULL)
702  *      @id: peripheral ID (or 0)
703  *      @mask: peripheral ID mask (or 0)
704  *
705  *      Return the AMBA device corresponding to the supplied parameters.
706  *      If no device matches, returns NULL.
707  *
708  *      NOTE: When a valid device is found, its refcount is
709  *      incremented, and must be decremented before the returned
710  *      reference.
711  */
712 struct amba_device *
713 amba_find_device(const char *busid, struct device *parent, unsigned int id,
714                  unsigned int mask)
715 {
716         struct find_data data;
717
718         data.dev = NULL;
719         data.parent = parent;
720         data.busid = busid;
721         data.id = id;
722         data.mask = mask;
723
724         bus_for_each_dev(&amba_bustype, NULL, &data, amba_find_match);
725
726         return data.dev;
727 }
728
729 /**
730  *      amba_request_regions - request all mem regions associated with device
731  *      @dev: amba_device structure for device
732  *      @name: name, or NULL to use driver name
733  */
734 int amba_request_regions(struct amba_device *dev, const char *name)
735 {
736         int ret = 0;
737         u32 size;
738
739         if (!name)
740                 name = dev->dev.driver->name;
741
742         size = resource_size(&dev->res);
743
744         if (!request_mem_region(dev->res.start, size, name))
745                 ret = -EBUSY;
746
747         return ret;
748 }
749
750 /**
751  *      amba_release_regions - release mem regions associated with device
752  *      @dev: amba_device structure for device
753  *
754  *      Release regions claimed by a successful call to amba_request_regions.
755  */
756 void amba_release_regions(struct amba_device *dev)
757 {
758         u32 size;
759
760         size = resource_size(&dev->res);
761         release_mem_region(dev->res.start, size);
762 }
763
764 EXPORT_SYMBOL(amba_driver_register);
765 EXPORT_SYMBOL(amba_driver_unregister);
766 EXPORT_SYMBOL(amba_device_register);
767 EXPORT_SYMBOL(amba_device_unregister);
768 EXPORT_SYMBOL(amba_find_device);
769 EXPORT_SYMBOL(amba_request_regions);
770 EXPORT_SYMBOL(amba_release_regions);