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