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/pm_domain.h>
19 #include <linux/amba/bus.h>
20 #include <linux/sizes.h>
21 #include <linux/limits.h>
25 #define to_amba_driver(d) container_of(d, struct amba_driver, drv)
27 static const struct amba_id
*
28 amba_lookup(const struct amba_id
*table
, struct amba_device
*dev
)
33 ret
= (dev
->periphid
& table
->mask
) == table
->id
;
39 return ret
? table
: NULL
;
42 static int amba_match(struct device
*dev
, struct device_driver
*drv
)
44 struct amba_device
*pcdev
= to_amba_device(dev
);
45 struct amba_driver
*pcdrv
= to_amba_driver(drv
);
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
);
51 return amba_lookup(pcdrv
->id_table
, pcdev
) != NULL
;
54 static int amba_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
56 struct amba_device
*pcdev
= to_amba_device(dev
);
59 retval
= add_uevent_var(env
, "AMBA_ID=%08x", pcdev
->periphid
);
63 retval
= add_uevent_var(env
, "MODALIAS=amba:d%08X", pcdev
->periphid
);
67 static ssize_t
driver_override_show(struct device
*_dev
,
68 struct device_attribute
*attr
, char *buf
)
70 struct amba_device
*dev
= to_amba_device(_dev
);
72 if (!dev
->driver_override
)
75 return sprintf(buf
, "%s\n", dev
->driver_override
);
78 static ssize_t
driver_override_store(struct device
*_dev
,
79 struct device_attribute
*attr
,
80 const char *buf
, size_t count
)
82 struct amba_device
*dev
= to_amba_device(_dev
);
83 char *driver_override
, *old
= dev
->driver_override
, *cp
;
88 driver_override
= kstrndup(buf
, count
, GFP_KERNEL
);
92 cp
= strchr(driver_override
, '\n');
96 if (strlen(driver_override
)) {
97 dev
->driver_override
= driver_override
;
99 kfree(driver_override
);
100 dev
->driver_override
= NULL
;
108 #define amba_attr_func(name,fmt,arg...) \
109 static ssize_t name##_show(struct device *_dev, \
110 struct device_attribute *attr, char *buf) \
112 struct amba_device *dev = to_amba_device(_dev); \
113 return sprintf(buf, fmt, arg); \
116 #define amba_attr(name,fmt,arg...) \
117 amba_attr_func(name,fmt,arg) \
118 static DEVICE_ATTR(name, S_IRUGO, name##_show, NULL)
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
,
127 static struct device_attribute amba_dev_attrs
[] = {
130 __ATTR_RW(driver_override
),
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.
140 static int amba_pm_runtime_suspend(struct device
*dev
)
142 struct amba_device
*pcdev
= to_amba_device(dev
);
143 int ret
= pm_generic_runtime_suspend(dev
);
145 if (ret
== 0 && dev
->driver
) {
146 if (pm_runtime_is_irq_safe(dev
))
147 clk_disable(pcdev
->pclk
);
149 clk_disable_unprepare(pcdev
->pclk
);
155 static int amba_pm_runtime_resume(struct device
*dev
)
157 struct amba_device
*pcdev
= to_amba_device(dev
);
161 if (pm_runtime_is_irq_safe(dev
))
162 ret
= clk_enable(pcdev
->pclk
);
164 ret
= clk_prepare_enable(pcdev
->pclk
);
165 /* Failure is probably fatal to the system, but... */
170 return pm_generic_runtime_resume(dev
);
172 #endif /* CONFIG_PM */
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
,
182 amba_pm_runtime_suspend
,
183 amba_pm_runtime_resume
,
189 * Primecells are part of the Advanced Microcontroller Bus Architecture,
190 * so we call the bus "amba".
192 struct bus_type amba_bustype
= {
194 .dev_attrs
= amba_dev_attrs
,
196 .uevent
= amba_uevent
,
200 static int __init
amba_init(void)
202 return bus_register(&amba_bustype
);
205 postcore_initcall(amba_init
);
207 static int amba_get_enable_pclk(struct amba_device
*pcdev
)
211 pcdev
->pclk
= clk_get(&pcdev
->dev
, "apb_pclk");
212 if (IS_ERR(pcdev
->pclk
))
213 return PTR_ERR(pcdev
->pclk
);
215 ret
= clk_prepare_enable(pcdev
->pclk
);
217 clk_put(pcdev
->pclk
);
222 static void amba_put_disable_pclk(struct amba_device
*pcdev
)
224 clk_disable_unprepare(pcdev
->pclk
);
225 clk_put(pcdev
->pclk
);
229 * These are the device model conversion veneers; they convert the
230 * device model structures to our more specific structures.
232 static int amba_probe(struct device
*dev
)
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
);
240 ret
= dev_pm_domain_attach(dev
, true);
241 if (ret
== -EPROBE_DEFER
)
244 ret
= amba_get_enable_pclk(pcdev
);
246 dev_pm_domain_detach(dev
, true);
250 pm_runtime_get_noresume(dev
);
251 pm_runtime_set_active(dev
);
252 pm_runtime_enable(dev
);
254 ret
= pcdrv
->probe(pcdev
, id
);
258 pm_runtime_disable(dev
);
259 pm_runtime_set_suspended(dev
);
260 pm_runtime_put_noidle(dev
);
262 amba_put_disable_pclk(pcdev
);
263 dev_pm_domain_detach(dev
, true);
269 static int amba_remove(struct device
*dev
)
271 struct amba_device
*pcdev
= to_amba_device(dev
);
272 struct amba_driver
*drv
= to_amba_driver(dev
->driver
);
275 pm_runtime_get_sync(dev
);
276 ret
= drv
->remove(pcdev
);
277 pm_runtime_put_noidle(dev
);
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
);
284 amba_put_disable_pclk(pcdev
);
285 dev_pm_domain_detach(dev
, true);
290 static void amba_shutdown(struct device
*dev
)
292 struct amba_driver
*drv
= to_amba_driver(dev
->driver
);
293 drv
->shutdown(to_amba_device(dev
));
297 * amba_driver_register - register an AMBA device driver
298 * @drv: amba device driver structure
300 * Register an AMBA device driver with the Linux device model
301 * core. If devices pre-exist, the drivers probe function will
304 int amba_driver_register(struct amba_driver
*drv
)
306 drv
->drv
.bus
= &amba_bustype
;
308 #define SETFN(fn) if (drv->fn) drv->drv.fn = amba_##fn
313 return driver_register(&drv
->drv
);
317 * amba_driver_unregister - remove an AMBA device driver
318 * @drv: AMBA device driver structure to remove
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.
324 void amba_driver_unregister(struct amba_driver
*drv
)
326 driver_unregister(&drv
->drv
);
330 static void amba_device_release(struct device
*dev
)
332 struct amba_device
*d
= to_amba_device(dev
);
335 release_resource(&d
->res
);
340 * amba_device_add - add a previously allocated AMBA device structure
341 * @dev: AMBA device allocated by amba_device_alloc
342 * @parent: resource parent for this devices resources
344 * Claim the resource, and read the device cell ID if not already
345 * initialized. Register the AMBA device with the Linux device
348 int amba_device_add(struct amba_device
*dev
, struct resource
*parent
)
354 WARN_ON(dev
->irq
[0] == (unsigned int)-1);
355 WARN_ON(dev
->irq
[1] == (unsigned int)-1);
357 ret
= request_resource(parent
, &dev
->res
);
361 /* Hard-coded primecell ID instead of plug-n-play */
362 if (dev
->periphid
!= 0)
366 * Dynamically calculate the size of the resource
367 * and use this for iomap
369 size
= resource_size(&dev
->res
);
370 tmp
= ioremap(dev
->res
.start
, size
);
376 ret
= amba_get_enable_pclk(dev
);
381 * Read pid and cid based on size of resource
382 * they are located at end of region
384 for (pid
= 0, i
= 0; i
< 4; i
++)
385 pid
|= (readl(tmp
+ size
- 0x20 + 4 * i
) & 255) <<
387 for (cid
= 0, i
= 0; i
< 4; i
++)
388 cid
|= (readl(tmp
+ size
- 0x10 + 4 * i
) & 255) <<
391 amba_put_disable_pclk(dev
);
393 if (cid
== AMBA_CID
|| cid
== CORESIGHT_CID
)
406 ret
= device_add(&dev
->dev
);
411 ret
= device_create_file(&dev
->dev
, &dev_attr_irq0
);
412 if (ret
== 0 && dev
->irq
[1])
413 ret
= device_create_file(&dev
->dev
, &dev_attr_irq1
);
417 device_unregister(&dev
->dev
);
420 release_resource(&dev
->res
);
424 EXPORT_SYMBOL_GPL(amba_device_add
);
426 static struct amba_device
*
427 amba_aphb_device_add(struct device
*parent
, const char *name
,
428 resource_size_t base
, size_t size
, int irq1
, int irq2
,
429 void *pdata
, unsigned int periphid
, u64 dma_mask
,
430 struct resource
*resbase
)
432 struct amba_device
*dev
;
435 dev
= amba_device_alloc(name
, base
, size
);
437 return ERR_PTR(-ENOMEM
);
439 dev
->dev
.coherent_dma_mask
= dma_mask
;
442 dev
->periphid
= periphid
;
443 dev
->dev
.platform_data
= pdata
;
444 dev
->dev
.parent
= parent
;
446 ret
= amba_device_add(dev
, resbase
);
448 amba_device_put(dev
);
456 amba_apb_device_add(struct device
*parent
, const char *name
,
457 resource_size_t base
, size_t size
, int irq1
, int irq2
,
458 void *pdata
, unsigned int periphid
)
460 return amba_aphb_device_add(parent
, name
, base
, size
, irq1
, irq2
, pdata
,
461 periphid
, 0, &iomem_resource
);
463 EXPORT_SYMBOL_GPL(amba_apb_device_add
);
466 amba_ahb_device_add(struct device
*parent
, const char *name
,
467 resource_size_t base
, size_t size
, int irq1
, int irq2
,
468 void *pdata
, unsigned int periphid
)
470 return amba_aphb_device_add(parent
, name
, base
, size
, irq1
, irq2
, pdata
,
471 periphid
, ~0ULL, &iomem_resource
);
473 EXPORT_SYMBOL_GPL(amba_ahb_device_add
);
476 amba_apb_device_add_res(struct device
*parent
, const char *name
,
477 resource_size_t base
, size_t size
, int irq1
,
478 int irq2
, void *pdata
, unsigned int periphid
,
479 struct resource
*resbase
)
481 return amba_aphb_device_add(parent
, name
, base
, size
, irq1
, irq2
, pdata
,
482 periphid
, 0, resbase
);
484 EXPORT_SYMBOL_GPL(amba_apb_device_add_res
);
487 amba_ahb_device_add_res(struct device
*parent
, const char *name
,
488 resource_size_t base
, size_t size
, int irq1
,
489 int irq2
, void *pdata
, unsigned int periphid
,
490 struct resource
*resbase
)
492 return amba_aphb_device_add(parent
, name
, base
, size
, irq1
, irq2
, pdata
,
493 periphid
, ~0ULL, resbase
);
495 EXPORT_SYMBOL_GPL(amba_ahb_device_add_res
);
498 static void amba_device_initialize(struct amba_device
*dev
, const char *name
)
500 device_initialize(&dev
->dev
);
502 dev_set_name(&dev
->dev
, "%s", name
);
503 dev
->dev
.release
= amba_device_release
;
504 dev
->dev
.bus
= &amba_bustype
;
505 dev
->dev
.dma_mask
= &dev
->dev
.coherent_dma_mask
;
506 dev
->res
.name
= dev_name(&dev
->dev
);
510 * amba_device_alloc - allocate an AMBA device
511 * @name: sysfs name of the AMBA device
512 * @base: base of AMBA device
513 * @size: size of AMBA device
515 * Allocate and initialize an AMBA device structure. Returns %NULL
518 struct amba_device
*amba_device_alloc(const char *name
, resource_size_t base
,
521 struct amba_device
*dev
;
523 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
525 amba_device_initialize(dev
, name
);
526 dev
->res
.start
= base
;
527 dev
->res
.end
= base
+ size
- 1;
528 dev
->res
.flags
= IORESOURCE_MEM
;
533 EXPORT_SYMBOL_GPL(amba_device_alloc
);
536 * amba_device_register - register an AMBA device
537 * @dev: AMBA device to register
538 * @parent: parent memory resource
540 * Setup the AMBA device, reading the cell ID if present.
541 * Claim the resource, and register the AMBA device with
542 * the Linux device manager.
544 int amba_device_register(struct amba_device
*dev
, struct resource
*parent
)
546 amba_device_initialize(dev
, dev
->dev
.init_name
);
547 dev
->dev
.init_name
= NULL
;
549 return amba_device_add(dev
, parent
);
553 * amba_device_put - put an AMBA device
554 * @dev: AMBA device to put
556 void amba_device_put(struct amba_device
*dev
)
558 put_device(&dev
->dev
);
560 EXPORT_SYMBOL_GPL(amba_device_put
);
563 * amba_device_unregister - unregister an AMBA device
564 * @dev: AMBA device to remove
566 * Remove the specified AMBA device from the Linux device
567 * manager. All files associated with this object will be
568 * destroyed, and device drivers notified that the device has
569 * been removed. The AMBA device's resources including
570 * the amba_device structure will be freed once all
571 * references to it have been dropped.
573 void amba_device_unregister(struct amba_device
*dev
)
575 device_unregister(&dev
->dev
);
580 struct amba_device
*dev
;
581 struct device
*parent
;
587 static int amba_find_match(struct device
*dev
, void *data
)
589 struct find_data
*d
= data
;
590 struct amba_device
*pcdev
= to_amba_device(dev
);
593 r
= (pcdev
->periphid
& d
->mask
) == d
->id
;
595 r
&= d
->parent
== dev
->parent
;
597 r
&= strcmp(dev_name(dev
), d
->busid
) == 0;
608 * amba_find_device - locate an AMBA device given a bus id
609 * @busid: bus id for device (or NULL)
610 * @parent: parent device (or NULL)
611 * @id: peripheral ID (or 0)
612 * @mask: peripheral ID mask (or 0)
614 * Return the AMBA device corresponding to the supplied parameters.
615 * If no device matches, returns NULL.
617 * NOTE: When a valid device is found, its refcount is
618 * incremented, and must be decremented before the returned
622 amba_find_device(const char *busid
, struct device
*parent
, unsigned int id
,
625 struct find_data data
;
628 data
.parent
= parent
;
633 bus_for_each_dev(&amba_bustype
, NULL
, &data
, amba_find_match
);
639 * amba_request_regions - request all mem regions associated with device
640 * @dev: amba_device structure for device
641 * @name: name, or NULL to use driver name
643 int amba_request_regions(struct amba_device
*dev
, const char *name
)
649 name
= dev
->dev
.driver
->name
;
651 size
= resource_size(&dev
->res
);
653 if (!request_mem_region(dev
->res
.start
, size
, name
))
660 * amba_release_regions - release mem regions associated with device
661 * @dev: amba_device structure for device
663 * Release regions claimed by a successful call to amba_request_regions.
665 void amba_release_regions(struct amba_device
*dev
)
669 size
= resource_size(&dev
->res
);
670 release_mem_region(dev
->res
.start
, size
);
673 EXPORT_SYMBOL(amba_driver_register
);
674 EXPORT_SYMBOL(amba_driver_unregister
);
675 EXPORT_SYMBOL(amba_device_register
);
676 EXPORT_SYMBOL(amba_device_unregister
);
677 EXPORT_SYMBOL(amba_find_device
);
678 EXPORT_SYMBOL(amba_request_regions
);
679 EXPORT_SYMBOL(amba_release_regions
);