Merge branch 'old.dcache' into work.dcache
[sfrench/cifs-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/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
201 static int __init amba_init(void)
202 {
203         return bus_register(&amba_bustype);
204 }
205
206 postcore_initcall(amba_init);
207
208 static int amba_get_enable_pclk(struct amba_device *pcdev)
209 {
210         int ret;
211
212         pcdev->pclk = clk_get(&pcdev->dev, "apb_pclk");
213         if (IS_ERR(pcdev->pclk))
214                 return PTR_ERR(pcdev->pclk);
215
216         ret = clk_prepare_enable(pcdev->pclk);
217         if (ret)
218                 clk_put(pcdev->pclk);
219
220         return ret;
221 }
222
223 static void amba_put_disable_pclk(struct amba_device *pcdev)
224 {
225         clk_disable_unprepare(pcdev->pclk);
226         clk_put(pcdev->pclk);
227 }
228
229 /*
230  * These are the device model conversion veneers; they convert the
231  * device model structures to our more specific structures.
232  */
233 static int amba_probe(struct device *dev)
234 {
235         struct amba_device *pcdev = to_amba_device(dev);
236         struct amba_driver *pcdrv = to_amba_driver(dev->driver);
237         const struct amba_id *id = amba_lookup(pcdrv->id_table, pcdev);
238         int ret;
239
240         do {
241                 ret = of_clk_set_defaults(dev->of_node, false);
242                 if (ret < 0)
243                         break;
244
245                 ret = dev_pm_domain_attach(dev, true);
246                 if (ret == -EPROBE_DEFER)
247                         break;
248
249                 ret = amba_get_enable_pclk(pcdev);
250                 if (ret) {
251                         dev_pm_domain_detach(dev, true);
252                         break;
253                 }
254
255                 pm_runtime_get_noresume(dev);
256                 pm_runtime_set_active(dev);
257                 pm_runtime_enable(dev);
258
259                 ret = pcdrv->probe(pcdev, id);
260                 if (ret == 0)
261                         break;
262
263                 pm_runtime_disable(dev);
264                 pm_runtime_set_suspended(dev);
265                 pm_runtime_put_noidle(dev);
266
267                 amba_put_disable_pclk(pcdev);
268                 dev_pm_domain_detach(dev, true);
269         } while (0);
270
271         return ret;
272 }
273
274 static int amba_remove(struct device *dev)
275 {
276         struct amba_device *pcdev = to_amba_device(dev);
277         struct amba_driver *drv = to_amba_driver(dev->driver);
278         int ret;
279
280         pm_runtime_get_sync(dev);
281         ret = drv->remove(pcdev);
282         pm_runtime_put_noidle(dev);
283
284         /* Undo the runtime PM settings in amba_probe() */
285         pm_runtime_disable(dev);
286         pm_runtime_set_suspended(dev);
287         pm_runtime_put_noidle(dev);
288
289         amba_put_disable_pclk(pcdev);
290         dev_pm_domain_detach(dev, true);
291
292         return ret;
293 }
294
295 static void amba_shutdown(struct device *dev)
296 {
297         struct amba_driver *drv = to_amba_driver(dev->driver);
298         drv->shutdown(to_amba_device(dev));
299 }
300
301 /**
302  *      amba_driver_register - register an AMBA device driver
303  *      @drv: amba device driver structure
304  *
305  *      Register an AMBA device driver with the Linux device model
306  *      core.  If devices pre-exist, the drivers probe function will
307  *      be called.
308  */
309 int amba_driver_register(struct amba_driver *drv)
310 {
311         drv->drv.bus = &amba_bustype;
312
313 #define SETFN(fn)       if (drv->fn) drv->drv.fn = amba_##fn
314         SETFN(probe);
315         SETFN(remove);
316         SETFN(shutdown);
317
318         return driver_register(&drv->drv);
319 }
320
321 /**
322  *      amba_driver_unregister - remove an AMBA device driver
323  *      @drv: AMBA device driver structure to remove
324  *
325  *      Unregister an AMBA device driver from the Linux device
326  *      model.  The device model will call the drivers remove function
327  *      for each device the device driver is currently handling.
328  */
329 void amba_driver_unregister(struct amba_driver *drv)
330 {
331         driver_unregister(&drv->drv);
332 }
333
334
335 static void amba_device_release(struct device *dev)
336 {
337         struct amba_device *d = to_amba_device(dev);
338
339         if (d->res.parent)
340                 release_resource(&d->res);
341         kfree(d);
342 }
343
344 static int amba_device_try_add(struct amba_device *dev, struct resource *parent)
345 {
346         u32 size;
347         void __iomem *tmp;
348         int i, ret;
349
350         WARN_ON(dev->irq[0] == (unsigned int)-1);
351         WARN_ON(dev->irq[1] == (unsigned int)-1);
352
353         ret = request_resource(parent, &dev->res);
354         if (ret)
355                 goto err_out;
356
357         /* Hard-coded primecell ID instead of plug-n-play */
358         if (dev->periphid != 0)
359                 goto skip_probe;
360
361         /*
362          * Dynamically calculate the size of the resource
363          * and use this for iomap
364          */
365         size = resource_size(&dev->res);
366         tmp = ioremap(dev->res.start, size);
367         if (!tmp) {
368                 ret = -ENOMEM;
369                 goto err_release;
370         }
371
372         ret = dev_pm_domain_attach(&dev->dev, true);
373         if (ret == -EPROBE_DEFER) {
374                 iounmap(tmp);
375                 goto err_release;
376         }
377
378         ret = amba_get_enable_pclk(dev);
379         if (ret == 0) {
380                 u32 pid, cid;
381
382                 /*
383                  * Read pid and cid based on size of resource
384                  * they are located at end of region
385                  */
386                 for (pid = 0, i = 0; i < 4; i++)
387                         pid |= (readl(tmp + size - 0x20 + 4 * i) & 255) <<
388                                 (i * 8);
389                 for (cid = 0, i = 0; i < 4; i++)
390                         cid |= (readl(tmp + size - 0x10 + 4 * i) & 255) <<
391                                 (i * 8);
392
393                 amba_put_disable_pclk(dev);
394
395                 if (cid == AMBA_CID || cid == CORESIGHT_CID)
396                         dev->periphid = pid;
397
398                 if (!dev->periphid)
399                         ret = -ENODEV;
400         }
401
402         iounmap(tmp);
403         dev_pm_domain_detach(&dev->dev, true);
404
405         if (ret)
406                 goto err_release;
407
408  skip_probe:
409         ret = device_add(&dev->dev);
410         if (ret)
411                 goto err_release;
412
413         if (dev->irq[0])
414                 ret = device_create_file(&dev->dev, &dev_attr_irq0);
415         if (ret == 0 && dev->irq[1])
416                 ret = device_create_file(&dev->dev, &dev_attr_irq1);
417         if (ret == 0)
418                 return ret;
419
420         device_unregister(&dev->dev);
421
422  err_release:
423         release_resource(&dev->res);
424  err_out:
425         return ret;
426 }
427
428 /*
429  * Registration of AMBA device require reading its pid and cid registers.
430  * To do this, the device must be turned on (if it is a part of power domain)
431  * and have clocks enabled. However in some cases those resources might not be
432  * yet available. Returning EPROBE_DEFER is not a solution in such case,
433  * because callers don't handle this special error code. Instead such devices
434  * are added to the special list and their registration is retried from
435  * periodic worker, until all resources are available and registration succeeds.
436  */
437 struct deferred_device {
438         struct amba_device *dev;
439         struct resource *parent;
440         struct list_head node;
441 };
442
443 static LIST_HEAD(deferred_devices);
444 static DEFINE_MUTEX(deferred_devices_lock);
445
446 static void amba_deferred_retry_func(struct work_struct *dummy);
447 static DECLARE_DELAYED_WORK(deferred_retry_work, amba_deferred_retry_func);
448
449 #define DEFERRED_DEVICE_TIMEOUT (msecs_to_jiffies(5 * 1000))
450
451 static void amba_deferred_retry_func(struct work_struct *dummy)
452 {
453         struct deferred_device *ddev, *tmp;
454
455         mutex_lock(&deferred_devices_lock);
456
457         list_for_each_entry_safe(ddev, tmp, &deferred_devices, node) {
458                 int ret = amba_device_try_add(ddev->dev, ddev->parent);
459
460                 if (ret == -EPROBE_DEFER)
461                         continue;
462
463                 list_del_init(&ddev->node);
464                 kfree(ddev);
465         }
466
467         if (!list_empty(&deferred_devices))
468                 schedule_delayed_work(&deferred_retry_work,
469                                       DEFERRED_DEVICE_TIMEOUT);
470
471         mutex_unlock(&deferred_devices_lock);
472 }
473
474 /**
475  *      amba_device_add - add a previously allocated AMBA device structure
476  *      @dev: AMBA device allocated by amba_device_alloc
477  *      @parent: resource parent for this devices resources
478  *
479  *      Claim the resource, and read the device cell ID if not already
480  *      initialized.  Register the AMBA device with the Linux device
481  *      manager.
482  */
483 int amba_device_add(struct amba_device *dev, struct resource *parent)
484 {
485         int ret = amba_device_try_add(dev, parent);
486
487         if (ret == -EPROBE_DEFER) {
488                 struct deferred_device *ddev;
489
490                 ddev = kmalloc(sizeof(*ddev), GFP_KERNEL);
491                 if (!ddev)
492                         return -ENOMEM;
493
494                 ddev->dev = dev;
495                 ddev->parent = parent;
496                 ret = 0;
497
498                 mutex_lock(&deferred_devices_lock);
499
500                 if (list_empty(&deferred_devices))
501                         schedule_delayed_work(&deferred_retry_work,
502                                               DEFERRED_DEVICE_TIMEOUT);
503                 list_add_tail(&ddev->node, &deferred_devices);
504
505                 mutex_unlock(&deferred_devices_lock);
506         }
507         return ret;
508 }
509 EXPORT_SYMBOL_GPL(amba_device_add);
510
511 static struct amba_device *
512 amba_aphb_device_add(struct device *parent, const char *name,
513                      resource_size_t base, size_t size, int irq1, int irq2,
514                      void *pdata, unsigned int periphid, u64 dma_mask,
515                      struct resource *resbase)
516 {
517         struct amba_device *dev;
518         int ret;
519
520         dev = amba_device_alloc(name, base, size);
521         if (!dev)
522                 return ERR_PTR(-ENOMEM);
523
524         dev->dev.coherent_dma_mask = dma_mask;
525         dev->irq[0] = irq1;
526         dev->irq[1] = irq2;
527         dev->periphid = periphid;
528         dev->dev.platform_data = pdata;
529         dev->dev.parent = parent;
530
531         ret = amba_device_add(dev, resbase);
532         if (ret) {
533                 amba_device_put(dev);
534                 return ERR_PTR(ret);
535         }
536
537         return dev;
538 }
539
540 struct amba_device *
541 amba_apb_device_add(struct device *parent, const char *name,
542                     resource_size_t base, size_t size, int irq1, int irq2,
543                     void *pdata, unsigned int periphid)
544 {
545         return amba_aphb_device_add(parent, name, base, size, irq1, irq2, pdata,
546                                     periphid, 0, &iomem_resource);
547 }
548 EXPORT_SYMBOL_GPL(amba_apb_device_add);
549
550 struct amba_device *
551 amba_ahb_device_add(struct device *parent, const char *name,
552                     resource_size_t base, size_t size, int irq1, int irq2,
553                     void *pdata, unsigned int periphid)
554 {
555         return amba_aphb_device_add(parent, name, base, size, irq1, irq2, pdata,
556                                     periphid, ~0ULL, &iomem_resource);
557 }
558 EXPORT_SYMBOL_GPL(amba_ahb_device_add);
559
560 struct amba_device *
561 amba_apb_device_add_res(struct device *parent, const char *name,
562                         resource_size_t base, size_t size, int irq1,
563                         int irq2, void *pdata, unsigned int periphid,
564                         struct resource *resbase)
565 {
566         return amba_aphb_device_add(parent, name, base, size, irq1, irq2, pdata,
567                                     periphid, 0, resbase);
568 }
569 EXPORT_SYMBOL_GPL(amba_apb_device_add_res);
570
571 struct amba_device *
572 amba_ahb_device_add_res(struct device *parent, const char *name,
573                         resource_size_t base, size_t size, int irq1,
574                         int irq2, void *pdata, unsigned int periphid,
575                         struct resource *resbase)
576 {
577         return amba_aphb_device_add(parent, name, base, size, irq1, irq2, pdata,
578                                     periphid, ~0ULL, resbase);
579 }
580 EXPORT_SYMBOL_GPL(amba_ahb_device_add_res);
581
582
583 static void amba_device_initialize(struct amba_device *dev, const char *name)
584 {
585         device_initialize(&dev->dev);
586         if (name)
587                 dev_set_name(&dev->dev, "%s", name);
588         dev->dev.release = amba_device_release;
589         dev->dev.bus = &amba_bustype;
590         dev->dev.dma_mask = &dev->dev.coherent_dma_mask;
591         dev->res.name = dev_name(&dev->dev);
592 }
593
594 /**
595  *      amba_device_alloc - allocate an AMBA device
596  *      @name: sysfs name of the AMBA device
597  *      @base: base of AMBA device
598  *      @size: size of AMBA device
599  *
600  *      Allocate and initialize an AMBA device structure.  Returns %NULL
601  *      on failure.
602  */
603 struct amba_device *amba_device_alloc(const char *name, resource_size_t base,
604         size_t size)
605 {
606         struct amba_device *dev;
607
608         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
609         if (dev) {
610                 amba_device_initialize(dev, name);
611                 dev->res.start = base;
612                 dev->res.end = base + size - 1;
613                 dev->res.flags = IORESOURCE_MEM;
614         }
615
616         return dev;
617 }
618 EXPORT_SYMBOL_GPL(amba_device_alloc);
619
620 /**
621  *      amba_device_register - register an AMBA device
622  *      @dev: AMBA device to register
623  *      @parent: parent memory resource
624  *
625  *      Setup the AMBA device, reading the cell ID if present.
626  *      Claim the resource, and register the AMBA device with
627  *      the Linux device manager.
628  */
629 int amba_device_register(struct amba_device *dev, struct resource *parent)
630 {
631         amba_device_initialize(dev, dev->dev.init_name);
632         dev->dev.init_name = NULL;
633
634         return amba_device_add(dev, parent);
635 }
636
637 /**
638  *      amba_device_put - put an AMBA device
639  *      @dev: AMBA device to put
640  */
641 void amba_device_put(struct amba_device *dev)
642 {
643         put_device(&dev->dev);
644 }
645 EXPORT_SYMBOL_GPL(amba_device_put);
646
647 /**
648  *      amba_device_unregister - unregister an AMBA device
649  *      @dev: AMBA device to remove
650  *
651  *      Remove the specified AMBA device from the Linux device
652  *      manager.  All files associated with this object will be
653  *      destroyed, and device drivers notified that the device has
654  *      been removed.  The AMBA device's resources including
655  *      the amba_device structure will be freed once all
656  *      references to it have been dropped.
657  */
658 void amba_device_unregister(struct amba_device *dev)
659 {
660         device_unregister(&dev->dev);
661 }
662
663
664 struct find_data {
665         struct amba_device *dev;
666         struct device *parent;
667         const char *busid;
668         unsigned int id;
669         unsigned int mask;
670 };
671
672 static int amba_find_match(struct device *dev, void *data)
673 {
674         struct find_data *d = data;
675         struct amba_device *pcdev = to_amba_device(dev);
676         int r;
677
678         r = (pcdev->periphid & d->mask) == d->id;
679         if (d->parent)
680                 r &= d->parent == dev->parent;
681         if (d->busid)
682                 r &= strcmp(dev_name(dev), d->busid) == 0;
683
684         if (r) {
685                 get_device(dev);
686                 d->dev = pcdev;
687         }
688
689         return r;
690 }
691
692 /**
693  *      amba_find_device - locate an AMBA device given a bus id
694  *      @busid: bus id for device (or NULL)
695  *      @parent: parent device (or NULL)
696  *      @id: peripheral ID (or 0)
697  *      @mask: peripheral ID mask (or 0)
698  *
699  *      Return the AMBA device corresponding to the supplied parameters.
700  *      If no device matches, returns NULL.
701  *
702  *      NOTE: When a valid device is found, its refcount is
703  *      incremented, and must be decremented before the returned
704  *      reference.
705  */
706 struct amba_device *
707 amba_find_device(const char *busid, struct device *parent, unsigned int id,
708                  unsigned int mask)
709 {
710         struct find_data data;
711
712         data.dev = NULL;
713         data.parent = parent;
714         data.busid = busid;
715         data.id = id;
716         data.mask = mask;
717
718         bus_for_each_dev(&amba_bustype, NULL, &data, amba_find_match);
719
720         return data.dev;
721 }
722
723 /**
724  *      amba_request_regions - request all mem regions associated with device
725  *      @dev: amba_device structure for device
726  *      @name: name, or NULL to use driver name
727  */
728 int amba_request_regions(struct amba_device *dev, const char *name)
729 {
730         int ret = 0;
731         u32 size;
732
733         if (!name)
734                 name = dev->dev.driver->name;
735
736         size = resource_size(&dev->res);
737
738         if (!request_mem_region(dev->res.start, size, name))
739                 ret = -EBUSY;
740
741         return ret;
742 }
743
744 /**
745  *      amba_release_regions - release mem regions associated with device
746  *      @dev: amba_device structure for device
747  *
748  *      Release regions claimed by a successful call to amba_request_regions.
749  */
750 void amba_release_regions(struct amba_device *dev)
751 {
752         u32 size;
753
754         size = resource_size(&dev->res);
755         release_mem_region(dev->res.start, size);
756 }
757
758 EXPORT_SYMBOL(amba_driver_register);
759 EXPORT_SYMBOL(amba_driver_unregister);
760 EXPORT_SYMBOL(amba_device_register);
761 EXPORT_SYMBOL(amba_device_unregister);
762 EXPORT_SYMBOL(amba_find_device);
763 EXPORT_SYMBOL(amba_request_regions);
764 EXPORT_SYMBOL(amba_release_regions);