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