2 * linux/arch/arm/common/amba.c
4 * Copyright (C) 2003 Deep Blue Solutions Ltd, All Rights Reserved.
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.
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>
17 #include <linux/pm_runtime.h>
18 #include <linux/amba/bus.h>
21 #include <asm/sizes.h>
23 #define to_amba_driver(d) container_of(d, struct amba_driver, drv)
25 static const struct amba_id
*
26 amba_lookup(const struct amba_id
*table
, struct amba_device
*dev
)
31 ret
= (dev
->periphid
& table
->mask
) == table
->id
;
37 return ret
? table
: NULL
;
40 static int amba_match(struct device
*dev
, struct device_driver
*drv
)
42 struct amba_device
*pcdev
= to_amba_device(dev
);
43 struct amba_driver
*pcdrv
= to_amba_driver(drv
);
45 return amba_lookup(pcdrv
->id_table
, pcdev
) != NULL
;
49 static int amba_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
51 struct amba_device
*pcdev
= to_amba_device(dev
);
54 retval
= add_uevent_var(env
, "AMBA_ID=%08x", pcdev
->periphid
);
58 retval
= add_uevent_var(env
, "MODALIAS=amba:d%08X", pcdev
->periphid
);
62 #define amba_uevent NULL
65 #define amba_attr_func(name,fmt,arg...) \
66 static ssize_t name##_show(struct device *_dev, \
67 struct device_attribute *attr, char *buf) \
69 struct amba_device *dev = to_amba_device(_dev); \
70 return sprintf(buf, fmt, arg); \
73 #define amba_attr(name,fmt,arg...) \
74 amba_attr_func(name,fmt,arg) \
75 static DEVICE_ATTR(name, S_IRUGO, name##_show, NULL)
77 amba_attr_func(id
, "%08x\n", dev
->periphid
);
78 amba_attr(irq0
, "%u\n", dev
->irq
[0]);
79 amba_attr(irq1
, "%u\n", dev
->irq
[1]);
80 amba_attr_func(resource
, "\t%016llx\t%016llx\t%016lx\n",
81 (unsigned long long)dev
->res
.start
, (unsigned long long)dev
->res
.end
,
84 static struct device_attribute amba_dev_attrs
[] = {
90 #ifdef CONFIG_PM_SLEEP
92 static int amba_legacy_suspend(struct device
*dev
, pm_message_t mesg
)
94 struct amba_driver
*adrv
= to_amba_driver(dev
->driver
);
95 struct amba_device
*adev
= to_amba_device(dev
);
98 if (dev
->driver
&& adrv
->suspend
)
99 ret
= adrv
->suspend(adev
, mesg
);
104 static int amba_legacy_resume(struct device
*dev
)
106 struct amba_driver
*adrv
= to_amba_driver(dev
->driver
);
107 struct amba_device
*adev
= to_amba_device(dev
);
110 if (dev
->driver
&& adrv
->resume
)
111 ret
= adrv
->resume(adev
);
116 #endif /* CONFIG_PM_SLEEP */
118 #ifdef CONFIG_SUSPEND
120 static int amba_pm_suspend(struct device
*dev
)
122 struct device_driver
*drv
= dev
->driver
;
129 if (drv
->pm
->suspend
)
130 ret
= drv
->pm
->suspend(dev
);
132 ret
= amba_legacy_suspend(dev
, PMSG_SUSPEND
);
138 static int amba_pm_resume(struct device
*dev
)
140 struct device_driver
*drv
= dev
->driver
;
148 ret
= drv
->pm
->resume(dev
);
150 ret
= amba_legacy_resume(dev
);
156 #else /* !CONFIG_SUSPEND */
158 #define amba_pm_suspend NULL
159 #define amba_pm_resume NULL
161 #endif /* !CONFIG_SUSPEND */
163 #ifdef CONFIG_HIBERNATE_CALLBACKS
165 static int amba_pm_freeze(struct device
*dev
)
167 struct device_driver
*drv
= dev
->driver
;
175 ret
= drv
->pm
->freeze(dev
);
177 ret
= amba_legacy_suspend(dev
, PMSG_FREEZE
);
183 static int amba_pm_thaw(struct device
*dev
)
185 struct device_driver
*drv
= dev
->driver
;
193 ret
= drv
->pm
->thaw(dev
);
195 ret
= amba_legacy_resume(dev
);
201 static int amba_pm_poweroff(struct device
*dev
)
203 struct device_driver
*drv
= dev
->driver
;
210 if (drv
->pm
->poweroff
)
211 ret
= drv
->pm
->poweroff(dev
);
213 ret
= amba_legacy_suspend(dev
, PMSG_HIBERNATE
);
219 static int amba_pm_restore(struct device
*dev
)
221 struct device_driver
*drv
= dev
->driver
;
228 if (drv
->pm
->restore
)
229 ret
= drv
->pm
->restore(dev
);
231 ret
= amba_legacy_resume(dev
);
237 #else /* !CONFIG_HIBERNATE_CALLBACKS */
239 #define amba_pm_freeze NULL
240 #define amba_pm_thaw NULL
241 #define amba_pm_poweroff NULL
242 #define amba_pm_restore NULL
244 #endif /* !CONFIG_HIBERNATE_CALLBACKS */
246 #ifdef CONFIG_PM_RUNTIME
248 * Hooks to provide runtime PM of the pclk (bus clock). It is safe to
249 * enable/disable the bus clock at runtime PM suspend/resume as this
250 * does not result in loss of context. However, disabling vcore power
251 * would do, so we leave that to the driver.
253 static int amba_pm_runtime_suspend(struct device
*dev
)
255 struct amba_device
*pcdev
= to_amba_device(dev
);
256 int ret
= pm_generic_runtime_suspend(dev
);
258 if (ret
== 0 && dev
->driver
)
259 clk_disable(pcdev
->pclk
);
264 static int amba_pm_runtime_resume(struct device
*dev
)
266 struct amba_device
*pcdev
= to_amba_device(dev
);
270 ret
= clk_enable(pcdev
->pclk
);
271 /* Failure is probably fatal to the system, but... */
276 return pm_generic_runtime_resume(dev
);
282 static const struct dev_pm_ops amba_pm
= {
283 .suspend
= amba_pm_suspend
,
284 .resume
= amba_pm_resume
,
285 .freeze
= amba_pm_freeze
,
286 .thaw
= amba_pm_thaw
,
287 .poweroff
= amba_pm_poweroff
,
288 .restore
= amba_pm_restore
,
290 amba_pm_runtime_suspend
,
291 amba_pm_runtime_resume
,
292 pm_generic_runtime_idle
296 #define AMBA_PM (&amba_pm)
298 #else /* !CONFIG_PM */
302 #endif /* !CONFIG_PM */
305 * Primecells are part of the Advanced Microcontroller Bus Architecture,
306 * so we call the bus "amba".
308 struct bus_type amba_bustype
= {
310 .dev_attrs
= amba_dev_attrs
,
312 .uevent
= amba_uevent
,
316 static int __init
amba_init(void)
318 return bus_register(&amba_bustype
);
321 postcore_initcall(amba_init
);
323 static int amba_get_enable_pclk(struct amba_device
*pcdev
)
325 struct clk
*pclk
= clk_get(&pcdev
->dev
, "apb_pclk");
331 return PTR_ERR(pclk
);
333 ret
= clk_prepare(pclk
);
339 ret
= clk_enable(pclk
);
348 static void amba_put_disable_pclk(struct amba_device
*pcdev
)
350 struct clk
*pclk
= pcdev
->pclk
;
357 static int amba_get_enable_vcore(struct amba_device
*pcdev
)
359 struct regulator
*vcore
= regulator_get(&pcdev
->dev
, "vcore");
362 pcdev
->vcore
= vcore
;
365 /* It is OK not to supply a vcore regulator */
366 if (PTR_ERR(vcore
) == -ENODEV
)
368 return PTR_ERR(vcore
);
371 ret
= regulator_enable(vcore
);
373 regulator_put(vcore
);
374 pcdev
->vcore
= ERR_PTR(-ENODEV
);
380 static void amba_put_disable_vcore(struct amba_device
*pcdev
)
382 struct regulator
*vcore
= pcdev
->vcore
;
384 if (!IS_ERR(vcore
)) {
385 regulator_disable(vcore
);
386 regulator_put(vcore
);
391 * These are the device model conversion veneers; they convert the
392 * device model structures to our more specific structures.
394 static int amba_probe(struct device
*dev
)
396 struct amba_device
*pcdev
= to_amba_device(dev
);
397 struct amba_driver
*pcdrv
= to_amba_driver(dev
->driver
);
398 const struct amba_id
*id
= amba_lookup(pcdrv
->id_table
, pcdev
);
402 ret
= amba_get_enable_vcore(pcdev
);
406 ret
= amba_get_enable_pclk(pcdev
);
410 pm_runtime_get_noresume(dev
);
411 pm_runtime_set_active(dev
);
412 pm_runtime_enable(dev
);
414 ret
= pcdrv
->probe(pcdev
, id
);
418 pm_runtime_disable(dev
);
419 pm_runtime_set_suspended(dev
);
420 pm_runtime_put_noidle(dev
);
422 amba_put_disable_pclk(pcdev
);
423 amba_put_disable_vcore(pcdev
);
429 static int amba_remove(struct device
*dev
)
431 struct amba_device
*pcdev
= to_amba_device(dev
);
432 struct amba_driver
*drv
= to_amba_driver(dev
->driver
);
435 pm_runtime_get_sync(dev
);
436 ret
= drv
->remove(pcdev
);
437 pm_runtime_put_noidle(dev
);
439 /* Undo the runtime PM settings in amba_probe() */
440 pm_runtime_disable(dev
);
441 pm_runtime_set_suspended(dev
);
442 pm_runtime_put_noidle(dev
);
444 amba_put_disable_pclk(pcdev
);
445 amba_put_disable_vcore(pcdev
);
450 static void amba_shutdown(struct device
*dev
)
452 struct amba_driver
*drv
= to_amba_driver(dev
->driver
);
453 drv
->shutdown(to_amba_device(dev
));
457 * amba_driver_register - register an AMBA device driver
458 * @drv: amba device driver structure
460 * Register an AMBA device driver with the Linux device model
461 * core. If devices pre-exist, the drivers probe function will
464 int amba_driver_register(struct amba_driver
*drv
)
466 drv
->drv
.bus
= &amba_bustype
;
468 #define SETFN(fn) if (drv->fn) drv->drv.fn = amba_##fn
473 return driver_register(&drv
->drv
);
477 * amba_driver_unregister - remove an AMBA device driver
478 * @drv: AMBA device driver structure to remove
480 * Unregister an AMBA device driver from the Linux device
481 * model. The device model will call the drivers remove function
482 * for each device the device driver is currently handling.
484 void amba_driver_unregister(struct amba_driver
*drv
)
486 driver_unregister(&drv
->drv
);
490 static void amba_device_release(struct device
*dev
)
492 struct amba_device
*d
= to_amba_device(dev
);
495 release_resource(&d
->res
);
500 * amba_device_add - add a previously allocated AMBA device structure
501 * @dev: AMBA device allocated by amba_device_alloc
502 * @parent: resource parent for this devices resources
504 * Claim the resource, and read the device cell ID if not already
505 * initialized. Register the AMBA device with the Linux device
508 int amba_device_add(struct amba_device
*dev
, struct resource
*parent
)
514 WARN_ON(dev
->irq
[0] == (unsigned int)-1);
515 WARN_ON(dev
->irq
[1] == (unsigned int)-1);
517 ret
= request_resource(parent
, &dev
->res
);
521 /* Hard-coded primecell ID instead of plug-n-play */
522 if (dev
->periphid
!= 0)
526 * Dynamically calculate the size of the resource
527 * and use this for iomap
529 size
= resource_size(&dev
->res
);
530 tmp
= ioremap(dev
->res
.start
, size
);
536 ret
= amba_get_enable_pclk(dev
);
541 * Read pid and cid based on size of resource
542 * they are located at end of region
544 for (pid
= 0, i
= 0; i
< 4; i
++)
545 pid
|= (readl(tmp
+ size
- 0x20 + 4 * i
) & 255) <<
547 for (cid
= 0, i
= 0; i
< 4; i
++)
548 cid
|= (readl(tmp
+ size
- 0x10 + 4 * i
) & 255) <<
551 amba_put_disable_pclk(dev
);
566 ret
= device_add(&dev
->dev
);
570 if (dev
->irq
[0] && dev
->irq
[0] != NO_IRQ
)
571 ret
= device_create_file(&dev
->dev
, &dev_attr_irq0
);
572 if (ret
== 0 && dev
->irq
[1] && dev
->irq
[1] != NO_IRQ
)
573 ret
= device_create_file(&dev
->dev
, &dev_attr_irq1
);
577 device_unregister(&dev
->dev
);
580 release_resource(&dev
->res
);
584 EXPORT_SYMBOL_GPL(amba_device_add
);
586 static void amba_device_initialize(struct amba_device
*dev
, const char *name
)
588 device_initialize(&dev
->dev
);
590 dev_set_name(&dev
->dev
, "%s", name
);
591 dev
->dev
.release
= amba_device_release
;
592 dev
->dev
.bus
= &amba_bustype
;
593 dev
->dev
.dma_mask
= &dev
->dma_mask
;
594 dev
->res
.name
= dev_name(&dev
->dev
);
598 * amba_device_alloc - allocate an AMBA device
599 * @name: sysfs name of the AMBA device
600 * @base: base of AMBA device
601 * @size: size of AMBA device
603 * Allocate and initialize an AMBA device structure. Returns %NULL
606 struct amba_device
*amba_device_alloc(const char *name
, resource_size_t base
,
609 struct amba_device
*dev
;
611 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
613 amba_device_initialize(dev
, name
);
614 dev
->res
.start
= base
;
615 dev
->res
.end
= base
+ size
- 1;
616 dev
->res
.flags
= IORESOURCE_MEM
;
621 EXPORT_SYMBOL_GPL(amba_device_alloc
);
624 * amba_device_register - register an AMBA device
625 * @dev: AMBA device to register
626 * @parent: parent memory resource
628 * Setup the AMBA device, reading the cell ID if present.
629 * Claim the resource, and register the AMBA device with
630 * the Linux device manager.
632 int amba_device_register(struct amba_device
*dev
, struct resource
*parent
)
634 amba_device_initialize(dev
, dev
->dev
.init_name
);
635 dev
->dev
.init_name
= NULL
;
637 if (!dev
->dev
.coherent_dma_mask
&& dev
->dma_mask
)
638 dev_warn(&dev
->dev
, "coherent dma mask is unset\n");
640 return amba_device_add(dev
, parent
);
644 * amba_device_put - put an AMBA device
645 * @dev: AMBA device to put
647 void amba_device_put(struct amba_device
*dev
)
649 put_device(&dev
->dev
);
651 EXPORT_SYMBOL_GPL(amba_device_put
);
654 * amba_device_unregister - unregister an AMBA device
655 * @dev: AMBA device to remove
657 * Remove the specified AMBA device from the Linux device
658 * manager. All files associated with this object will be
659 * destroyed, and device drivers notified that the device has
660 * been removed. The AMBA device's resources including
661 * the amba_device structure will be freed once all
662 * references to it have been dropped.
664 void amba_device_unregister(struct amba_device
*dev
)
666 device_unregister(&dev
->dev
);
671 struct amba_device
*dev
;
672 struct device
*parent
;
678 static int amba_find_match(struct device
*dev
, void *data
)
680 struct find_data
*d
= data
;
681 struct amba_device
*pcdev
= to_amba_device(dev
);
684 r
= (pcdev
->periphid
& d
->mask
) == d
->id
;
686 r
&= d
->parent
== dev
->parent
;
688 r
&= strcmp(dev_name(dev
), d
->busid
) == 0;
699 * amba_find_device - locate an AMBA device given a bus id
700 * @busid: bus id for device (or NULL)
701 * @parent: parent device (or NULL)
702 * @id: peripheral ID (or 0)
703 * @mask: peripheral ID mask (or 0)
705 * Return the AMBA device corresponding to the supplied parameters.
706 * If no device matches, returns NULL.
708 * NOTE: When a valid device is found, its refcount is
709 * incremented, and must be decremented before the returned
713 amba_find_device(const char *busid
, struct device
*parent
, unsigned int id
,
716 struct find_data data
;
719 data
.parent
= parent
;
724 bus_for_each_dev(&amba_bustype
, NULL
, &data
, amba_find_match
);
730 * amba_request_regions - request all mem regions associated with device
731 * @dev: amba_device structure for device
732 * @name: name, or NULL to use driver name
734 int amba_request_regions(struct amba_device
*dev
, const char *name
)
740 name
= dev
->dev
.driver
->name
;
742 size
= resource_size(&dev
->res
);
744 if (!request_mem_region(dev
->res
.start
, size
, name
))
751 * amba_release_regions - release mem regions associated with device
752 * @dev: amba_device structure for device
754 * Release regions claimed by a successful call to amba_request_regions.
756 void amba_release_regions(struct amba_device
*dev
)
760 size
= resource_size(&dev
->res
);
761 release_mem_region(dev
->res
.start
, size
);
764 EXPORT_SYMBOL(amba_driver_register
);
765 EXPORT_SYMBOL(amba_driver_unregister
);
766 EXPORT_SYMBOL(amba_device_register
);
767 EXPORT_SYMBOL(amba_device_unregister
);
768 EXPORT_SYMBOL(amba_find_device
);
769 EXPORT_SYMBOL(amba_request_regions
);
770 EXPORT_SYMBOL(amba_release_regions
);