1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * linux/include/amba/bus.h
4 *
5 * This device type deals with ARM PrimeCells and anything else that
6 * presents a proper CID (0xB105F00D) at the end of the I/O register
7 * region or that is derived from a PrimeCell.
8 *
9 * Copyright (C) 2003 Deep Blue Solutions Ltd, All Rights Reserved.
10 */
11 #ifndef ASMARM_AMBA_H
12 #define ASMARM_AMBA_H
13
14 #include <linux/clk.h>
15 #include <linux/device.h>
16 #include <linux/mod_devicetable.h>
17 #include <linux/err.h>
18 #include <linux/resource.h>
19 #include <linux/regulator/consumer.h>
20
21 #define AMBA_NR_IRQS 9
22 #define AMBA_CID 0xb105f00d
23 #define CORESIGHT_CID 0xb105900d
24
25 /*
26 * CoreSight Architecture specification updates the ID specification
27 * for components on the AMBA bus. (ARM IHI 0029E)
28 *
29 * Bits 15:12 of the CID are the device class.
30 *
31 * Class 0xF remains for PrimeCell and legacy components. (AMBA_CID above)
32 * Class 0x9 defines the component as CoreSight (CORESIGHT_CID above)
33 * Class 0x0, 0x1, 0xB, 0xE define components that do not have driver support
34 * at present.
35 * Class 0x2-0x8,0xA and 0xD-0xD are presently reserved.
36 *
37 * Remaining CID bits stay as 0xb105-00d
38 */
39
40 /**
41 * Class 0x9 components use additional values to form a Unique Component
42 * Identifier (UCI), where peripheral ID values are identical for different
43 * components. Passed to the amba bus code from the component driver via
44 * the amba_id->data pointer.
45 * @devarch : coresight devarch register value
46 * @devarch_mask: mask bits used for matching. 0 indicates UCI not used.
47 * @devtype : coresight device type value
48 * @data : additional driver data. As we have usurped the original
49 * pointer some devices may still need additional data
50 */
51 struct amba_cs_uci_id {
52 unsigned int devarch;
53 unsigned int devarch_mask;
54 unsigned int devtype;
55 void *data;
56 };
57
58 /* define offsets for registers used by UCI */
59 #define UCI_REG_DEVTYPE_OFFSET 0xFCC
60 #define UCI_REG_DEVARCH_OFFSET 0xFBC
61
62 struct clk;
63
64 struct amba_device {
65 struct device dev;
66 struct resource res;
67 struct clk *pclk;
68 struct device_dma_parameters dma_parms;
69 unsigned int periphid;
70 unsigned int cid;
71 struct amba_cs_uci_id uci;
72 unsigned int irq[AMBA_NR_IRQS];
73 char *driver_override;
74 };
75
76 struct amba_driver {
77 struct device_driver drv;
78 int (*probe)(struct amba_device *, const struct amba_id *);
79 int (*remove)(struct amba_device *);
80 void (*shutdown)(struct amba_device *);
81 const struct amba_id *id_table;
82 };
83
84 /*
85 * Constants for the designer field of the Peripheral ID register. When bit 7
86 * is set to '1', bits [6:0] should be the JEP106 manufacturer identity code.
87 */
88 enum amba_vendor {
89 AMBA_VENDOR_ARM = 0x41,
90 AMBA_VENDOR_ST = 0x80,
91 AMBA_VENDOR_QCOM = 0x51,
92 AMBA_VENDOR_LSI = 0xb6,
93 AMBA_VENDOR_LINUX = 0xfe, /* This value is not official */
94 };
95
96 /* This is used to generate pseudo-ID for AMBA device */
97 #define AMBA_LINUX_ID(conf, rev, part) \
98 (((conf) & 0xff) << 24 | ((rev) & 0xf) << 20 | \
99 AMBA_VENDOR_LINUX << 12 | ((part) & 0xfff))
100
101 extern struct bus_type amba_bustype;
102
103 #define to_amba_device(d) container_of(d, struct amba_device, dev)
104
105 #define amba_get_drvdata(d) dev_get_drvdata(&d->dev)
106 #define amba_set_drvdata(d,p) dev_set_drvdata(&d->dev, p)
107
108 int amba_driver_register(struct amba_driver *);
109 void amba_driver_unregister(struct amba_driver *);
110 struct amba_device *amba_device_alloc(const char *, resource_size_t, size_t);
111 void amba_device_put(struct amba_device *);
112 int amba_device_add(struct amba_device *, struct resource *);
113 int amba_device_register(struct amba_device *, struct resource *);
114 struct amba_device *amba_apb_device_add(struct device *parent, const char *name,
115 resource_size_t base, size_t size,
116 int irq1, int irq2, void *pdata,
117 unsigned int periphid);
118 struct amba_device *amba_ahb_device_add(struct device *parent, const char *name,
119 resource_size_t base, size_t size,
120 int irq1, int irq2, void *pdata,
121 unsigned int periphid);
122 struct amba_device *
123 amba_apb_device_add_res(struct device *parent, const char *name,
124 resource_size_t base, size_t size, int irq1,
125 int irq2, void *pdata, unsigned int periphid,
126 struct resource *resbase);
127 struct amba_device *
128 amba_ahb_device_add_res(struct device *parent, const char *name,
129 resource_size_t base, size_t size, int irq1,
130 int irq2, void *pdata, unsigned int periphid,
131 struct resource *resbase);
132 void amba_device_unregister(struct amba_device *);
133 struct amba_device *amba_find_device(const char *, struct device *, unsigned int, unsigned int);
134 int amba_request_regions(struct amba_device *, const char *);
135 void amba_release_regions(struct amba_device *);
136
amba_pclk_enable(struct amba_device * dev)137 static inline int amba_pclk_enable(struct amba_device *dev)
138 {
139 return clk_enable(dev->pclk);
140 }
141
amba_pclk_disable(struct amba_device * dev)142 static inline void amba_pclk_disable(struct amba_device *dev)
143 {
144 clk_disable(dev->pclk);
145 }
146
amba_pclk_prepare(struct amba_device * dev)147 static inline int amba_pclk_prepare(struct amba_device *dev)
148 {
149 return clk_prepare(dev->pclk);
150 }
151
amba_pclk_unprepare(struct amba_device * dev)152 static inline void amba_pclk_unprepare(struct amba_device *dev)
153 {
154 clk_unprepare(dev->pclk);
155 }
156
157 /* Some drivers don't use the struct amba_device */
158 #define AMBA_CONFIG_BITS(a) (((a) >> 24) & 0xff)
159 #define AMBA_REV_BITS(a) (((a) >> 20) & 0x0f)
160 #define AMBA_MANF_BITS(a) (((a) >> 12) & 0xff)
161 #define AMBA_PART_BITS(a) ((a) & 0xfff)
162
163 #define amba_config(d) AMBA_CONFIG_BITS((d)->periphid)
164 #define amba_rev(d) AMBA_REV_BITS((d)->periphid)
165 #define amba_manf(d) AMBA_MANF_BITS((d)->periphid)
166 #define amba_part(d) AMBA_PART_BITS((d)->periphid)
167
168 #define __AMBA_DEV(busid, data, mask) \
169 { \
170 .coherent_dma_mask = mask, \
171 .init_name = busid, \
172 .platform_data = data, \
173 }
174
175 /*
176 * APB devices do not themselves have the ability to address memory,
177 * so DMA masks should be zero (much like USB peripheral devices.)
178 * The DMA controller DMA masks should be used instead (much like
179 * USB host controllers in conventional PCs.)
180 */
181 #define AMBA_APB_DEVICE(name, busid, id, base, irqs, data) \
182 struct amba_device name##_device = { \
183 .dev = __AMBA_DEV(busid, data, 0), \
184 .res = DEFINE_RES_MEM(base, SZ_4K), \
185 .irq = irqs, \
186 .periphid = id, \
187 }
188
189 /*
190 * AHB devices are DMA capable, so set their DMA masks
191 */
192 #define AMBA_AHB_DEVICE(name, busid, id, base, irqs, data) \
193 struct amba_device name##_device = { \
194 .dev = __AMBA_DEV(busid, data, ~0ULL), \
195 .res = DEFINE_RES_MEM(base, SZ_4K), \
196 .irq = irqs, \
197 .periphid = id, \
198 }
199
200 /*
201 * module_amba_driver() - Helper macro for drivers that don't do anything
202 * special in module init/exit. This eliminates a lot of boilerplate. Each
203 * module may only use this macro once, and calling it replaces module_init()
204 * and module_exit()
205 */
206 #define module_amba_driver(__amba_drv) \
207 module_driver(__amba_drv, amba_driver_register, amba_driver_unregister)
208
209 /*
210 * builtin_amba_driver() - Helper macro for drivers that don't do anything
211 * special in driver initcall. This eliminates a lot of boilerplate. Each
212 * driver may only use this macro once, and calling it replaces the instance
213 * device_initcall().
214 */
215 #define builtin_amba_driver(__amba_drv) \
216 builtin_driver(__amba_drv, amba_driver_register)
217
218 #endif
219