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