xref: /linux-6.15/include/linux/bcma/bcma.h (revision ca79522c)
1 #ifndef LINUX_BCMA_H_
2 #define LINUX_BCMA_H_
3 
4 #include <linux/pci.h>
5 #include <linux/mod_devicetable.h>
6 
7 #include <linux/bcma/bcma_driver_chipcommon.h>
8 #include <linux/bcma/bcma_driver_pci.h>
9 #include <linux/bcma/bcma_driver_mips.h>
10 #include <linux/bcma/bcma_driver_gmac_cmn.h>
11 #include <linux/ssb/ssb.h> /* SPROM sharing */
12 
13 #include <linux/bcma/bcma_regs.h>
14 
15 struct bcma_device;
16 struct bcma_bus;
17 
18 enum bcma_hosttype {
19 	BCMA_HOSTTYPE_PCI,
20 	BCMA_HOSTTYPE_SDIO,
21 	BCMA_HOSTTYPE_SOC,
22 };
23 
24 struct bcma_chipinfo {
25 	u16 id;
26 	u8 rev;
27 	u8 pkg;
28 };
29 
30 struct bcma_boardinfo {
31 	u16 vendor;
32 	u16 type;
33 };
34 
35 enum bcma_clkmode {
36 	BCMA_CLKMODE_FAST,
37 	BCMA_CLKMODE_DYNAMIC,
38 };
39 
40 struct bcma_host_ops {
41 	u8 (*read8)(struct bcma_device *core, u16 offset);
42 	u16 (*read16)(struct bcma_device *core, u16 offset);
43 	u32 (*read32)(struct bcma_device *core, u16 offset);
44 	void (*write8)(struct bcma_device *core, u16 offset, u8 value);
45 	void (*write16)(struct bcma_device *core, u16 offset, u16 value);
46 	void (*write32)(struct bcma_device *core, u16 offset, u32 value);
47 #ifdef CONFIG_BCMA_BLOCKIO
48 	void (*block_read)(struct bcma_device *core, void *buffer,
49 			   size_t count, u16 offset, u8 reg_width);
50 	void (*block_write)(struct bcma_device *core, const void *buffer,
51 			    size_t count, u16 offset, u8 reg_width);
52 #endif
53 	/* Agent ops */
54 	u32 (*aread32)(struct bcma_device *core, u16 offset);
55 	void (*awrite32)(struct bcma_device *core, u16 offset, u32 value);
56 };
57 
58 /* Core manufacturers */
59 #define BCMA_MANUF_ARM			0x43B
60 #define BCMA_MANUF_MIPS			0x4A7
61 #define BCMA_MANUF_BCM			0x4BF
62 
63 /* Core class values. */
64 #define BCMA_CL_SIM			0x0
65 #define BCMA_CL_EROM			0x1
66 #define BCMA_CL_CORESIGHT		0x9
67 #define BCMA_CL_VERIF			0xB
68 #define BCMA_CL_OPTIMO			0xD
69 #define BCMA_CL_GEN			0xE
70 #define BCMA_CL_PRIMECELL		0xF
71 
72 /* Core-ID values. */
73 #define BCMA_CORE_OOB_ROUTER		0x367	/* Out of band */
74 #define BCMA_CORE_4706_CHIPCOMMON	0x500
75 #define BCMA_CORE_4706_SOC_RAM		0x50E
76 #define BCMA_CORE_4706_MAC_GBIT		0x52D
77 #define BCMA_CORE_AMEMC			0x52E	/* DDR1/2 memory controller core */
78 #define BCMA_CORE_ALTA			0x534	/* I2S core */
79 #define BCMA_CORE_4706_MAC_GBIT_COMMON	0x5DC
80 #define BCMA_CORE_DDR23_PHY		0x5DD
81 #define BCMA_CORE_INVALID		0x700
82 #define BCMA_CORE_CHIPCOMMON		0x800
83 #define BCMA_CORE_ILINE20		0x801
84 #define BCMA_CORE_SRAM			0x802
85 #define BCMA_CORE_SDRAM			0x803
86 #define BCMA_CORE_PCI			0x804
87 #define BCMA_CORE_MIPS			0x805
88 #define BCMA_CORE_ETHERNET		0x806
89 #define BCMA_CORE_V90			0x807
90 #define BCMA_CORE_USB11_HOSTDEV		0x808
91 #define BCMA_CORE_ADSL			0x809
92 #define BCMA_CORE_ILINE100		0x80A
93 #define BCMA_CORE_IPSEC			0x80B
94 #define BCMA_CORE_UTOPIA		0x80C
95 #define BCMA_CORE_PCMCIA		0x80D
96 #define BCMA_CORE_INTERNAL_MEM		0x80E
97 #define BCMA_CORE_MEMC_SDRAM		0x80F
98 #define BCMA_CORE_OFDM			0x810
99 #define BCMA_CORE_EXTIF			0x811
100 #define BCMA_CORE_80211			0x812
101 #define BCMA_CORE_PHY_A			0x813
102 #define BCMA_CORE_PHY_B			0x814
103 #define BCMA_CORE_PHY_G			0x815
104 #define BCMA_CORE_MIPS_3302		0x816
105 #define BCMA_CORE_USB11_HOST		0x817
106 #define BCMA_CORE_USB11_DEV		0x818
107 #define BCMA_CORE_USB20_HOST		0x819
108 #define BCMA_CORE_USB20_DEV		0x81A
109 #define BCMA_CORE_SDIO_HOST		0x81B
110 #define BCMA_CORE_ROBOSWITCH		0x81C
111 #define BCMA_CORE_PARA_ATA		0x81D
112 #define BCMA_CORE_SATA_XORDMA		0x81E
113 #define BCMA_CORE_ETHERNET_GBIT		0x81F
114 #define BCMA_CORE_PCIE			0x820
115 #define BCMA_CORE_PHY_N			0x821
116 #define BCMA_CORE_SRAM_CTL		0x822
117 #define BCMA_CORE_MINI_MACPHY		0x823
118 #define BCMA_CORE_ARM_1176		0x824
119 #define BCMA_CORE_ARM_7TDMI		0x825
120 #define BCMA_CORE_PHY_LP		0x826
121 #define BCMA_CORE_PMU			0x827
122 #define BCMA_CORE_PHY_SSN		0x828
123 #define BCMA_CORE_SDIO_DEV		0x829
124 #define BCMA_CORE_ARM_CM3		0x82A
125 #define BCMA_CORE_PHY_HT		0x82B
126 #define BCMA_CORE_MIPS_74K		0x82C
127 #define BCMA_CORE_MAC_GBIT		0x82D
128 #define BCMA_CORE_DDR12_MEM_CTL		0x82E
129 #define BCMA_CORE_PCIE_RC		0x82F	/* PCIe Root Complex */
130 #define BCMA_CORE_OCP_OCP_BRIDGE	0x830
131 #define BCMA_CORE_SHARED_COMMON		0x831
132 #define BCMA_CORE_OCP_AHB_BRIDGE	0x832
133 #define BCMA_CORE_SPI_HOST		0x833
134 #define BCMA_CORE_I2S			0x834
135 #define BCMA_CORE_SDR_DDR1_MEM_CTL	0x835	/* SDR/DDR1 memory controller core */
136 #define BCMA_CORE_SHIM			0x837	/* SHIM component in ubus/6362 */
137 #define BCMA_CORE_ARM_CR4		0x83e
138 #define BCMA_CORE_DEFAULT		0xFFF
139 
140 #define BCMA_MAX_NR_CORES		16
141 
142 /* Chip IDs of PCIe devices */
143 #define BCMA_CHIP_ID_BCM4313	0x4313
144 #define BCMA_CHIP_ID_BCM43224	43224
145 #define  BCMA_PKG_ID_BCM43224_FAB_CSM	0x8
146 #define  BCMA_PKG_ID_BCM43224_FAB_SMIC	0xa
147 #define BCMA_CHIP_ID_BCM43225	43225
148 #define BCMA_CHIP_ID_BCM43227	43227
149 #define BCMA_CHIP_ID_BCM43228	43228
150 #define BCMA_CHIP_ID_BCM43421	43421
151 #define BCMA_CHIP_ID_BCM43428	43428
152 #define BCMA_CHIP_ID_BCM43431	43431
153 #define BCMA_CHIP_ID_BCM43460	43460
154 #define BCMA_CHIP_ID_BCM4331	0x4331
155 #define BCMA_CHIP_ID_BCM6362	0x6362
156 #define BCMA_CHIP_ID_BCM4360	0x4360
157 #define BCMA_CHIP_ID_BCM4352	0x4352
158 
159 /* Chip IDs of SoCs */
160 #define BCMA_CHIP_ID_BCM4706	0x5300
161 #define  BCMA_PKG_ID_BCM4706L	1
162 #define BCMA_CHIP_ID_BCM4716	0x4716
163 #define  BCMA_PKG_ID_BCM4716	8
164 #define  BCMA_PKG_ID_BCM4717	9
165 #define  BCMA_PKG_ID_BCM4718	10
166 #define BCMA_CHIP_ID_BCM47162	47162
167 #define BCMA_CHIP_ID_BCM4748	0x4748
168 #define BCMA_CHIP_ID_BCM4749	0x4749
169 #define BCMA_CHIP_ID_BCM5356	0x5356
170 #define BCMA_CHIP_ID_BCM5357	0x5357
171 #define  BCMA_PKG_ID_BCM5358	9
172 #define  BCMA_PKG_ID_BCM47186	10
173 #define  BCMA_PKG_ID_BCM5357	11
174 #define BCMA_CHIP_ID_BCM53572	53572
175 #define  BCMA_PKG_ID_BCM47188	9
176 
177 /* Board types (on PCI usually equals to the subsystem dev id) */
178 /* BCM4313 */
179 #define BCMA_BOARD_TYPE_BCM94313BU	0X050F
180 #define BCMA_BOARD_TYPE_BCM94313HM	0X0510
181 #define BCMA_BOARD_TYPE_BCM94313EPA	0X0511
182 #define BCMA_BOARD_TYPE_BCM94313HMG	0X051C
183 /* BCM4716 */
184 #define BCMA_BOARD_TYPE_BCM94716NR2	0X04CD
185 /* BCM43224 */
186 #define BCMA_BOARD_TYPE_BCM943224X21	0X056E
187 #define BCMA_BOARD_TYPE_BCM943224X21_FCC	0X00D1
188 #define BCMA_BOARD_TYPE_BCM943224X21B	0X00E9
189 #define BCMA_BOARD_TYPE_BCM943224M93	0X008B
190 #define BCMA_BOARD_TYPE_BCM943224M93A	0X0090
191 #define BCMA_BOARD_TYPE_BCM943224X16	0X0093
192 #define BCMA_BOARD_TYPE_BCM94322X9	0X008D
193 #define BCMA_BOARD_TYPE_BCM94322M35E	0X008E
194 /* BCM43228 */
195 #define BCMA_BOARD_TYPE_BCM943228BU8	0X0540
196 #define BCMA_BOARD_TYPE_BCM943228BU9	0X0541
197 #define BCMA_BOARD_TYPE_BCM943228BU	0X0542
198 #define BCMA_BOARD_TYPE_BCM943227HM4L	0X0543
199 #define BCMA_BOARD_TYPE_BCM943227HMB	0X0544
200 #define BCMA_BOARD_TYPE_BCM943228HM4L	0X0545
201 #define BCMA_BOARD_TYPE_BCM943228SD	0X0573
202 /* BCM4331 */
203 #define BCMA_BOARD_TYPE_BCM94331X19	0X00D6
204 #define BCMA_BOARD_TYPE_BCM94331X28	0X00E4
205 #define BCMA_BOARD_TYPE_BCM94331X28B	0X010E
206 #define BCMA_BOARD_TYPE_BCM94331PCIEBT3AX	0X00E4
207 #define BCMA_BOARD_TYPE_BCM94331X12_2G	0X00EC
208 #define BCMA_BOARD_TYPE_BCM94331X12_5G	0X00ED
209 #define BCMA_BOARD_TYPE_BCM94331X29B	0X00EF
210 #define BCMA_BOARD_TYPE_BCM94331CSAX	0X00EF
211 #define BCMA_BOARD_TYPE_BCM94331X19C	0X00F5
212 #define BCMA_BOARD_TYPE_BCM94331X33	0X00F4
213 #define BCMA_BOARD_TYPE_BCM94331BU	0X0523
214 #define BCMA_BOARD_TYPE_BCM94331S9BU	0X0524
215 #define BCMA_BOARD_TYPE_BCM94331MC	0X0525
216 #define BCMA_BOARD_TYPE_BCM94331MCI	0X0526
217 #define BCMA_BOARD_TYPE_BCM94331PCIEBT4	0X0527
218 #define BCMA_BOARD_TYPE_BCM94331HM	0X0574
219 #define BCMA_BOARD_TYPE_BCM94331PCIEDUAL	0X059B
220 #define BCMA_BOARD_TYPE_BCM94331MCH5	0X05A9
221 #define BCMA_BOARD_TYPE_BCM94331CS	0X05C6
222 #define BCMA_BOARD_TYPE_BCM94331CD	0X05DA
223 /* BCM53572 */
224 #define BCMA_BOARD_TYPE_BCM953572BU	0X058D
225 #define BCMA_BOARD_TYPE_BCM953572NR2	0X058E
226 #define BCMA_BOARD_TYPE_BCM947188NR2	0X058F
227 #define BCMA_BOARD_TYPE_BCM953572SDRNR2	0X0590
228 /* BCM43142 */
229 #define BCMA_BOARD_TYPE_BCM943142HM	0X05E0
230 
231 struct bcma_device {
232 	struct bcma_bus *bus;
233 	struct bcma_device_id id;
234 
235 	struct device dev;
236 	struct device *dma_dev;
237 
238 	unsigned int irq;
239 	bool dev_registered;
240 
241 	u8 core_index;
242 	u8 core_unit;
243 
244 	u32 addr;
245 	u32 addr1;
246 	u32 wrap;
247 
248 	void __iomem *io_addr;
249 	void __iomem *io_wrap;
250 
251 	void *drvdata;
252 	struct list_head list;
253 };
254 
255 static inline void *bcma_get_drvdata(struct bcma_device *core)
256 {
257 	return core->drvdata;
258 }
259 static inline void bcma_set_drvdata(struct bcma_device *core, void *drvdata)
260 {
261 	core->drvdata = drvdata;
262 }
263 
264 struct bcma_driver {
265 	const char *name;
266 	const struct bcma_device_id *id_table;
267 
268 	int (*probe)(struct bcma_device *dev);
269 	void (*remove)(struct bcma_device *dev);
270 	int (*suspend)(struct bcma_device *dev);
271 	int (*resume)(struct bcma_device *dev);
272 	void (*shutdown)(struct bcma_device *dev);
273 
274 	struct device_driver drv;
275 };
276 extern
277 int __bcma_driver_register(struct bcma_driver *drv, struct module *owner);
278 #define bcma_driver_register(drv) \
279 	__bcma_driver_register(drv, THIS_MODULE)
280 
281 extern void bcma_driver_unregister(struct bcma_driver *drv);
282 
283 /* Set a fallback SPROM.
284  * See kdoc at the function definition for complete documentation. */
285 extern int bcma_arch_register_fallback_sprom(
286 		int (*sprom_callback)(struct bcma_bus *bus,
287 		struct ssb_sprom *out));
288 
289 struct bcma_bus {
290 	/* The MMIO area. */
291 	void __iomem *mmio;
292 
293 	const struct bcma_host_ops *ops;
294 
295 	enum bcma_hosttype hosttype;
296 	union {
297 		/* Pointer to the PCI bus (only for BCMA_HOSTTYPE_PCI) */
298 		struct pci_dev *host_pci;
299 		/* Pointer to the SDIO device (only for BCMA_HOSTTYPE_SDIO) */
300 		struct sdio_func *host_sdio;
301 	};
302 
303 	struct bcma_chipinfo chipinfo;
304 
305 	struct bcma_boardinfo boardinfo;
306 
307 	struct bcma_device *mapped_core;
308 	struct list_head cores;
309 	u8 nr_cores;
310 	u8 init_done:1;
311 	u8 num;
312 
313 	struct bcma_drv_cc drv_cc;
314 	struct bcma_drv_pci drv_pci[2];
315 	struct bcma_drv_mips drv_mips;
316 	struct bcma_drv_gmac_cmn drv_gmac_cmn;
317 
318 	/* We decided to share SPROM struct with SSB as long as we do not need
319 	 * any hacks for BCMA. This simplifies drivers code. */
320 	struct ssb_sprom sprom;
321 };
322 
323 static inline u32 bcma_read8(struct bcma_device *core, u16 offset)
324 {
325 	return core->bus->ops->read8(core, offset);
326 }
327 static inline u32 bcma_read16(struct bcma_device *core, u16 offset)
328 {
329 	return core->bus->ops->read16(core, offset);
330 }
331 static inline u32 bcma_read32(struct bcma_device *core, u16 offset)
332 {
333 	return core->bus->ops->read32(core, offset);
334 }
335 static inline
336 void bcma_write8(struct bcma_device *core, u16 offset, u32 value)
337 {
338 	core->bus->ops->write8(core, offset, value);
339 }
340 static inline
341 void bcma_write16(struct bcma_device *core, u16 offset, u32 value)
342 {
343 	core->bus->ops->write16(core, offset, value);
344 }
345 static inline
346 void bcma_write32(struct bcma_device *core, u16 offset, u32 value)
347 {
348 	core->bus->ops->write32(core, offset, value);
349 }
350 #ifdef CONFIG_BCMA_BLOCKIO
351 static inline void bcma_block_read(struct bcma_device *core, void *buffer,
352 				   size_t count, u16 offset, u8 reg_width)
353 {
354 	core->bus->ops->block_read(core, buffer, count, offset, reg_width);
355 }
356 static inline void bcma_block_write(struct bcma_device *core,
357 				    const void *buffer, size_t count,
358 				    u16 offset, u8 reg_width)
359 {
360 	core->bus->ops->block_write(core, buffer, count, offset, reg_width);
361 }
362 #endif
363 static inline u32 bcma_aread32(struct bcma_device *core, u16 offset)
364 {
365 	return core->bus->ops->aread32(core, offset);
366 }
367 static inline
368 void bcma_awrite32(struct bcma_device *core, u16 offset, u32 value)
369 {
370 	core->bus->ops->awrite32(core, offset, value);
371 }
372 
373 static inline void bcma_mask32(struct bcma_device *cc, u16 offset, u32 mask)
374 {
375 	bcma_write32(cc, offset, bcma_read32(cc, offset) & mask);
376 }
377 static inline void bcma_set32(struct bcma_device *cc, u16 offset, u32 set)
378 {
379 	bcma_write32(cc, offset, bcma_read32(cc, offset) | set);
380 }
381 static inline void bcma_maskset32(struct bcma_device *cc,
382 				  u16 offset, u32 mask, u32 set)
383 {
384 	bcma_write32(cc, offset, (bcma_read32(cc, offset) & mask) | set);
385 }
386 static inline void bcma_mask16(struct bcma_device *cc, u16 offset, u16 mask)
387 {
388 	bcma_write16(cc, offset, bcma_read16(cc, offset) & mask);
389 }
390 static inline void bcma_set16(struct bcma_device *cc, u16 offset, u16 set)
391 {
392 	bcma_write16(cc, offset, bcma_read16(cc, offset) | set);
393 }
394 static inline void bcma_maskset16(struct bcma_device *cc,
395 				  u16 offset, u16 mask, u16 set)
396 {
397 	bcma_write16(cc, offset, (bcma_read16(cc, offset) & mask) | set);
398 }
399 
400 extern struct bcma_device *bcma_find_core(struct bcma_bus *bus, u16 coreid);
401 extern bool bcma_core_is_enabled(struct bcma_device *core);
402 extern void bcma_core_disable(struct bcma_device *core, u32 flags);
403 extern int bcma_core_enable(struct bcma_device *core, u32 flags);
404 extern void bcma_core_set_clockmode(struct bcma_device *core,
405 				    enum bcma_clkmode clkmode);
406 extern void bcma_core_pll_ctl(struct bcma_device *core, u32 req, u32 status,
407 			      bool on);
408 extern u32 bcma_chipco_pll_read(struct bcma_drv_cc *cc, u32 offset);
409 #define BCMA_DMA_TRANSLATION_MASK	0xC0000000
410 #define  BCMA_DMA_TRANSLATION_NONE	0x00000000
411 #define  BCMA_DMA_TRANSLATION_DMA32_CMT	0x40000000 /* Client Mode Translation for 32-bit DMA */
412 #define  BCMA_DMA_TRANSLATION_DMA64_CMT	0x80000000 /* Client Mode Translation for 64-bit DMA */
413 extern u32 bcma_core_dma_translation(struct bcma_device *core);
414 
415 #endif /* LINUX_BCMA_H_ */
416