2 * linux/include/amba/bus.h
4 * This device type deals with ARM PrimeCells and anything else that
5 * presents a proper CID (0xB105F00D) at the end of the I/O register
6 * region or that is derived from a PrimeCell.
8 * Copyright (C) 2003 Deep Blue Solutions Ltd, All Rights Reserved.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
17 #include <linux/clk.h>
18 #include <linux/device.h>
19 #include <linux/mod_devicetable.h>
20 #include <linux/err.h>
21 #include <linux/resource.h>
22 #include <linux/regulator/consumer.h>
24 #define AMBA_NR_IRQS 9
25 #define AMBA_CID 0xb105f00d
33 unsigned int periphid;
34 unsigned int irq[AMBA_NR_IRQS];
38 struct device_driver drv;
39 int (*probe)(struct amba_device *, const struct amba_id *);
40 int (*remove)(struct amba_device *);
41 void (*shutdown)(struct amba_device *);
42 int (*suspend)(struct amba_device *, pm_message_t);
43 int (*resume)(struct amba_device *);
44 const struct amba_id *id_table;
48 * Constants for the designer field of the Peripheral ID register. When bit 7
49 * is set to '1', bits [6:0] should be the JEP106 manufacturer identity code.
52 AMBA_VENDOR_ARM = 0x41,
53 AMBA_VENDOR_ST = 0x80,
54 AMBA_VENDOR_QCOM = 0x51,
55 AMBA_VENDOR_LSI = 0xb6,
58 extern struct bus_type amba_bustype;
60 #define to_amba_device(d) container_of(d, struct amba_device, dev)
62 #define amba_get_drvdata(d) dev_get_drvdata(&d->dev)
63 #define amba_set_drvdata(d,p) dev_set_drvdata(&d->dev, p)
65 int amba_driver_register(struct amba_driver *);
66 void amba_driver_unregister(struct amba_driver *);
67 struct amba_device *amba_device_alloc(const char *, resource_size_t, size_t);
68 void amba_device_put(struct amba_device *);
69 int amba_device_add(struct amba_device *, struct resource *);
70 int amba_device_register(struct amba_device *, struct resource *);
71 struct amba_device *amba_apb_device_add(struct device *parent, const char *name,
72 resource_size_t base, size_t size,
73 int irq1, int irq2, void *pdata,
74 unsigned int periphid);
75 struct amba_device *amba_ahb_device_add(struct device *parent, const char *name,
76 resource_size_t base, size_t size,
77 int irq1, int irq2, void *pdata,
78 unsigned int periphid);
80 amba_apb_device_add_res(struct device *parent, const char *name,
81 resource_size_t base, size_t size, int irq1,
82 int irq2, void *pdata, unsigned int periphid,
83 struct resource *resbase);
85 amba_ahb_device_add_res(struct device *parent, const char *name,
86 resource_size_t base, size_t size, int irq1,
87 int irq2, void *pdata, unsigned int periphid,
88 struct resource *resbase);
89 void amba_device_unregister(struct amba_device *);
90 struct amba_device *amba_find_device(const char *, struct device *, unsigned int, unsigned int);
91 int amba_request_regions(struct amba_device *, const char *);
92 void amba_release_regions(struct amba_device *);
94 #define amba_pclk_enable(d) \
95 (IS_ERR((d)->pclk) ? 0 : clk_enable((d)->pclk))
97 #define amba_pclk_disable(d) \
98 do { if (!IS_ERR((d)->pclk)) clk_disable((d)->pclk); } while (0)
100 /* Some drivers don't use the struct amba_device */
101 #define AMBA_CONFIG_BITS(a) (((a) >> 24) & 0xff)
102 #define AMBA_REV_BITS(a) (((a) >> 20) & 0x0f)
103 #define AMBA_MANF_BITS(a) (((a) >> 12) & 0xff)
104 #define AMBA_PART_BITS(a) ((a) & 0xfff)
106 #define amba_config(d) AMBA_CONFIG_BITS((d)->periphid)
107 #define amba_rev(d) AMBA_REV_BITS((d)->periphid)
108 #define amba_manf(d) AMBA_MANF_BITS((d)->periphid)
109 #define amba_part(d) AMBA_PART_BITS((d)->periphid)
111 #define __AMBA_DEV(busid, data, mask) \
113 .coherent_dma_mask = mask, \
114 .init_name = busid, \
115 .platform_data = data, \
119 * APB devices do not themselves have the ability to address memory,
120 * so DMA masks should be zero (much like USB peripheral devices.)
121 * The DMA controller DMA masks should be used instead (much like
122 * USB host controllers in conventional PCs.)
124 #define AMBA_APB_DEVICE(name, busid, id, base, irqs, data) \
125 struct amba_device name##_device = { \
126 .dev = __AMBA_DEV(busid, data, 0), \
127 .res = DEFINE_RES_MEM(base, SZ_4K), \
133 * AHB devices are DMA capable, so set their DMA masks
135 #define AMBA_AHB_DEVICE(name, busid, id, base, irqs, data) \
136 struct amba_device name##_device = { \
137 .dev = __AMBA_DEV(busid, data, ~0ULL), \
138 .res = DEFINE_RES_MEM(base, SZ_4K), \
144 * module_amba_driver() - Helper macro for drivers that don't do anything
145 * special in module init/exit. This eliminates a lot of boilerplate. Each
146 * module may only use this macro once, and calling it replaces module_init()
149 #define module_amba_driver(__amba_drv) \
150 module_driver(__amba_drv, amba_driver_register, amba_driver_unregister)