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 struct mutex periphid_lock;
72 unsigned int cid;
73 struct amba_cs_uci_id uci;
74 unsigned int irq[AMBA_NR_IRQS];
75 /*
76 * Driver name to force a match. Do not set directly, because core
77 * frees it. Use driver_set_override() to set or clear it.
78 */
79 const char *driver_override;
80
81 ANDROID_KABI_RESERVE(1);
82 };
83
84 struct amba_driver {
85 struct device_driver drv;
86 int (*probe)(struct amba_device *, const struct amba_id *);
87 void (*remove)(struct amba_device *);
88 void (*shutdown)(struct amba_device *);
89 const struct amba_id *id_table;
90 /*
91 * For most device drivers, no need to care about this flag as long as
92 * all DMAs are handled through the kernel DMA API. For some special
93 * ones, for example VFIO drivers, they know how to manage the DMA
94 * themselves and set this flag so that the IOMMU layer will allow them
95 * to setup and manage their own I/O address space.
96 */
97 bool driver_managed_dma;
98
99 ANDROID_KABI_RESERVE(1);
100 };
101
102 /*
103 * Constants for the designer field of the Peripheral ID register. When bit 7
104 * is set to '1', bits [6:0] should be the JEP106 manufacturer identity code.
105 */
106 enum amba_vendor {
107 AMBA_VENDOR_ARM = 0x41,
108 AMBA_VENDOR_ST = 0x80,
109 AMBA_VENDOR_QCOM = 0x51,
110 AMBA_VENDOR_LSI = 0xb6,
111 };
112
113 extern struct bus_type amba_bustype;
114
115 #define to_amba_device(d) container_of_const(d, struct amba_device, dev)
116
117 #define amba_get_drvdata(d) dev_get_drvdata(&d->dev)
118 #define amba_set_drvdata(d,p) dev_set_drvdata(&d->dev, p)
119
120 #ifdef CONFIG_ARM_AMBA
121 int amba_driver_register(struct amba_driver *);
122 void amba_driver_unregister(struct amba_driver *);
123 #else
amba_driver_register(struct amba_driver * drv)124 static inline int amba_driver_register(struct amba_driver *drv)
125 {
126 return -EINVAL;
127 }
amba_driver_unregister(struct amba_driver * drv)128 static inline void amba_driver_unregister(struct amba_driver *drv)
129 {
130 }
131 #endif
132
133 struct amba_device *amba_device_alloc(const char *, resource_size_t, size_t);
134 void amba_device_put(struct amba_device *);
135 int amba_device_add(struct amba_device *, struct resource *);
136 int amba_device_register(struct amba_device *, struct resource *);
137 void amba_device_unregister(struct amba_device *);
138 int amba_request_regions(struct amba_device *, const char *);
139 void amba_release_regions(struct amba_device *);
140
141 /* Some drivers don't use the struct amba_device */
142 #define AMBA_CONFIG_BITS(a) (((a) >> 24) & 0xff)
143 #define AMBA_REV_BITS(a) (((a) >> 20) & 0x0f)
144 #define AMBA_MANF_BITS(a) (((a) >> 12) & 0xff)
145 #define AMBA_PART_BITS(a) ((a) & 0xfff)
146
147 #define amba_config(d) AMBA_CONFIG_BITS((d)->periphid)
148 #define amba_rev(d) AMBA_REV_BITS((d)->periphid)
149 #define amba_manf(d) AMBA_MANF_BITS((d)->periphid)
150 #define amba_part(d) AMBA_PART_BITS((d)->periphid)
151
152 #define __AMBA_DEV(busid, data, mask) \
153 { \
154 .coherent_dma_mask = mask, \
155 .init_name = busid, \
156 .platform_data = data, \
157 }
158
159 /*
160 * APB devices do not themselves have the ability to address memory,
161 * so DMA masks should be zero (much like USB peripheral devices.)
162 * The DMA controller DMA masks should be used instead (much like
163 * USB host controllers in conventional PCs.)
164 */
165 #define AMBA_APB_DEVICE(name, busid, id, base, irqs, data) \
166 struct amba_device name##_device = { \
167 .dev = __AMBA_DEV(busid, data, 0), \
168 .res = DEFINE_RES_MEM(base, SZ_4K), \
169 .irq = irqs, \
170 .periphid = id, \
171 }
172
173 /*
174 * AHB devices are DMA capable, so set their DMA masks
175 */
176 #define AMBA_AHB_DEVICE(name, busid, id, base, irqs, data) \
177 struct amba_device name##_device = { \
178 .dev = __AMBA_DEV(busid, data, ~0ULL), \
179 .res = DEFINE_RES_MEM(base, SZ_4K), \
180 .irq = irqs, \
181 .periphid = id, \
182 }
183
184 /*
185 * module_amba_driver() - Helper macro for drivers that don't do anything
186 * special in module init/exit. This eliminates a lot of boilerplate. Each
187 * module may only use this macro once, and calling it replaces module_init()
188 * and module_exit()
189 */
190 #define module_amba_driver(__amba_drv) \
191 module_driver(__amba_drv, amba_driver_register, amba_driver_unregister)
192
193 /*
194 * builtin_amba_driver() - Helper macro for drivers that don't do anything
195 * special in driver initcall. This eliminates a lot of boilerplate. Each
196 * driver may only use this macro once, and calling it replaces the instance
197 * device_initcall().
198 */
199 #define builtin_amba_driver(__amba_drv) \
200 builtin_driver(__amba_drv, amba_driver_register)
201
202 #endif
203