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