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