Upgrade to 4.4.50-rt62
[kvmfornfv.git] / kernel / include / linux / bcma / bcma.h
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
16 struct bcma_device;
17 struct bcma_bus;
18
19 enum bcma_hosttype {
20         BCMA_HOSTTYPE_PCI,
21         BCMA_HOSTTYPE_SDIO,
22         BCMA_HOSTTYPE_SOC,
23 };
24
25 struct bcma_chipinfo {
26         u16 id;
27         u8 rev;
28         u8 pkg;
29 };
30
31 struct bcma_boardinfo {
32         u16 vendor;
33         u16 type;
34 };
35
36 enum bcma_clkmode {
37         BCMA_CLKMODE_FAST,
38         BCMA_CLKMODE_DYNAMIC,
39 };
40
41 struct 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_ARM_CA7               0x847
155 #define BCMA_CORE_SYS_MEM               0x849
156 #define BCMA_CORE_DEFAULT               0xFFF
157
158 #define BCMA_MAX_NR_CORES               16
159 #define BCMA_CORE_SIZE                  0x1000
160
161 /* Chip IDs of PCIe devices */
162 #define BCMA_CHIP_ID_BCM4313    0x4313
163 #define BCMA_CHIP_ID_BCM43142   43142
164 #define BCMA_CHIP_ID_BCM43131   43131
165 #define BCMA_CHIP_ID_BCM43217   43217
166 #define BCMA_CHIP_ID_BCM43222   43222
167 #define BCMA_CHIP_ID_BCM43224   43224
168 #define  BCMA_PKG_ID_BCM43224_FAB_CSM   0x8
169 #define  BCMA_PKG_ID_BCM43224_FAB_SMIC  0xa
170 #define BCMA_CHIP_ID_BCM43225   43225
171 #define BCMA_CHIP_ID_BCM43227   43227
172 #define BCMA_CHIP_ID_BCM43228   43228
173 #define BCMA_CHIP_ID_BCM43421   43421
174 #define BCMA_CHIP_ID_BCM43428   43428
175 #define BCMA_CHIP_ID_BCM43431   43431
176 #define BCMA_CHIP_ID_BCM43460   43460
177 #define BCMA_CHIP_ID_BCM4331    0x4331
178 #define BCMA_CHIP_ID_BCM6362    0x6362
179 #define BCMA_CHIP_ID_BCM4360    0x4360
180 #define BCMA_CHIP_ID_BCM4352    0x4352
181
182 /* Chip IDs of SoCs */
183 #define BCMA_CHIP_ID_BCM4706    0x5300
184 #define  BCMA_PKG_ID_BCM4706L   1
185 #define BCMA_CHIP_ID_BCM4716    0x4716
186 #define  BCMA_PKG_ID_BCM4716    8
187 #define  BCMA_PKG_ID_BCM4717    9
188 #define  BCMA_PKG_ID_BCM4718    10
189 #define BCMA_CHIP_ID_BCM47162   47162
190 #define BCMA_CHIP_ID_BCM4748    0x4748
191 #define BCMA_CHIP_ID_BCM4749    0x4749
192 #define BCMA_CHIP_ID_BCM5356    0x5356
193 #define BCMA_CHIP_ID_BCM5357    0x5357
194 #define  BCMA_PKG_ID_BCM5358    9
195 #define  BCMA_PKG_ID_BCM47186   10
196 #define  BCMA_PKG_ID_BCM5357    11
197 #define BCMA_CHIP_ID_BCM53572   53572
198 #define  BCMA_PKG_ID_BCM47188   9
199 #define BCMA_CHIP_ID_BCM4707    53010
200 #define  BCMA_PKG_ID_BCM4707    1
201 #define  BCMA_PKG_ID_BCM4708    2
202 #define  BCMA_PKG_ID_BCM4709    0
203 #define BCMA_CHIP_ID_BCM53018   53018
204
205 /* Board types (on PCI usually equals to the subsystem dev id) */
206 /* BCM4313 */
207 #define BCMA_BOARD_TYPE_BCM94313BU      0X050F
208 #define BCMA_BOARD_TYPE_BCM94313HM      0X0510
209 #define BCMA_BOARD_TYPE_BCM94313EPA     0X0511
210 #define BCMA_BOARD_TYPE_BCM94313HMG     0X051C
211 /* BCM4716 */
212 #define BCMA_BOARD_TYPE_BCM94716NR2     0X04CD
213 /* BCM43224 */
214 #define BCMA_BOARD_TYPE_BCM943224X21    0X056E
215 #define BCMA_BOARD_TYPE_BCM943224X21_FCC        0X00D1
216 #define BCMA_BOARD_TYPE_BCM943224X21B   0X00E9
217 #define BCMA_BOARD_TYPE_BCM943224M93    0X008B
218 #define BCMA_BOARD_TYPE_BCM943224M93A   0X0090
219 #define BCMA_BOARD_TYPE_BCM943224X16    0X0093
220 #define BCMA_BOARD_TYPE_BCM94322X9      0X008D
221 #define BCMA_BOARD_TYPE_BCM94322M35E    0X008E
222 /* BCM43228 */
223 #define BCMA_BOARD_TYPE_BCM943228BU8    0X0540
224 #define BCMA_BOARD_TYPE_BCM943228BU9    0X0541
225 #define BCMA_BOARD_TYPE_BCM943228BU     0X0542
226 #define BCMA_BOARD_TYPE_BCM943227HM4L   0X0543
227 #define BCMA_BOARD_TYPE_BCM943227HMB    0X0544
228 #define BCMA_BOARD_TYPE_BCM943228HM4L   0X0545
229 #define BCMA_BOARD_TYPE_BCM943228SD     0X0573
230 /* BCM4331 */
231 #define BCMA_BOARD_TYPE_BCM94331X19     0X00D6
232 #define BCMA_BOARD_TYPE_BCM94331X28     0X00E4
233 #define BCMA_BOARD_TYPE_BCM94331X28B    0X010E
234 #define BCMA_BOARD_TYPE_BCM94331PCIEBT3AX       0X00E4
235 #define BCMA_BOARD_TYPE_BCM94331X12_2G  0X00EC
236 #define BCMA_BOARD_TYPE_BCM94331X12_5G  0X00ED
237 #define BCMA_BOARD_TYPE_BCM94331X29B    0X00EF
238 #define BCMA_BOARD_TYPE_BCM94331CSAX    0X00EF
239 #define BCMA_BOARD_TYPE_BCM94331X19C    0X00F5
240 #define BCMA_BOARD_TYPE_BCM94331X33     0X00F4
241 #define BCMA_BOARD_TYPE_BCM94331BU      0X0523
242 #define BCMA_BOARD_TYPE_BCM94331S9BU    0X0524
243 #define BCMA_BOARD_TYPE_BCM94331MC      0X0525
244 #define BCMA_BOARD_TYPE_BCM94331MCI     0X0526
245 #define BCMA_BOARD_TYPE_BCM94331PCIEBT4 0X0527
246 #define BCMA_BOARD_TYPE_BCM94331HM      0X0574
247 #define BCMA_BOARD_TYPE_BCM94331PCIEDUAL        0X059B
248 #define BCMA_BOARD_TYPE_BCM94331MCH5    0X05A9
249 #define BCMA_BOARD_TYPE_BCM94331CS      0X05C6
250 #define BCMA_BOARD_TYPE_BCM94331CD      0X05DA
251 /* BCM53572 */
252 #define BCMA_BOARD_TYPE_BCM953572BU     0X058D
253 #define BCMA_BOARD_TYPE_BCM953572NR2    0X058E
254 #define BCMA_BOARD_TYPE_BCM947188NR2    0X058F
255 #define BCMA_BOARD_TYPE_BCM953572SDRNR2 0X0590
256 /* BCM43142 */
257 #define BCMA_BOARD_TYPE_BCM943142HM     0X05E0
258
259 struct bcma_device {
260         struct bcma_bus *bus;
261         struct bcma_device_id id;
262
263         struct device dev;
264         struct device *dma_dev;
265
266         unsigned int irq;
267         bool dev_registered;
268
269         u8 core_index;
270         u8 core_unit;
271
272         u32 addr;
273         u32 addr_s[8];
274         u32 wrap;
275
276         void __iomem *io_addr;
277         void __iomem *io_wrap;
278
279         void *drvdata;
280         struct list_head list;
281 };
282
283 static inline void *bcma_get_drvdata(struct bcma_device *core)
284 {
285         return core->drvdata;
286 }
287 static inline void bcma_set_drvdata(struct bcma_device *core, void *drvdata)
288 {
289         core->drvdata = drvdata;
290 }
291
292 struct bcma_driver {
293         const char *name;
294         const struct bcma_device_id *id_table;
295
296         int (*probe)(struct bcma_device *dev);
297         void (*remove)(struct bcma_device *dev);
298         int (*suspend)(struct bcma_device *dev);
299         int (*resume)(struct bcma_device *dev);
300         void (*shutdown)(struct bcma_device *dev);
301
302         struct device_driver drv;
303 };
304 extern
305 int __bcma_driver_register(struct bcma_driver *drv, struct module *owner);
306 #define bcma_driver_register(drv) \
307         __bcma_driver_register(drv, THIS_MODULE)
308
309 extern void bcma_driver_unregister(struct bcma_driver *drv);
310
311 /* module_bcma_driver() - Helper macro for drivers that don't do
312  * anything special in module init/exit.  This eliminates a lot of
313  * boilerplate.  Each module may only use this macro once, and
314  * calling it replaces module_init() and module_exit()
315  */
316 #define module_bcma_driver(__bcma_driver) \
317         module_driver(__bcma_driver, bcma_driver_register, \
318                         bcma_driver_unregister)
319
320 /* Set a fallback SPROM.
321  * See kdoc at the function definition for complete documentation. */
322 extern int bcma_arch_register_fallback_sprom(
323                 int (*sprom_callback)(struct bcma_bus *bus,
324                 struct ssb_sprom *out));
325
326 struct bcma_bus {
327         /* The MMIO area. */
328         void __iomem *mmio;
329
330         const struct bcma_host_ops *ops;
331
332         enum bcma_hosttype hosttype;
333         bool host_is_pcie2; /* Used for BCMA_HOSTTYPE_PCI only */
334         union {
335                 /* Pointer to the PCI bus (only for BCMA_HOSTTYPE_PCI) */
336                 struct pci_dev *host_pci;
337                 /* Pointer to the SDIO device (only for BCMA_HOSTTYPE_SDIO) */
338                 struct sdio_func *host_sdio;
339                 /* Pointer to platform device (only for BCMA_HOSTTYPE_SOC) */
340                 struct platform_device *host_pdev;
341         };
342
343         struct bcma_chipinfo chipinfo;
344
345         struct bcma_boardinfo boardinfo;
346
347         struct bcma_device *mapped_core;
348         struct list_head cores;
349         u8 nr_cores;
350         u8 num;
351
352         struct bcma_drv_cc drv_cc;
353         struct bcma_drv_cc_b drv_cc_b;
354         struct bcma_drv_pci drv_pci[2];
355         struct bcma_drv_pcie2 drv_pcie2;
356         struct bcma_drv_mips drv_mips;
357         struct bcma_drv_gmac_cmn drv_gmac_cmn;
358
359         /* We decided to share SPROM struct with SSB as long as we do not need
360          * any hacks for BCMA. This simplifies drivers code. */
361         struct ssb_sprom sprom;
362 };
363
364 static inline u32 bcma_read8(struct bcma_device *core, u16 offset)
365 {
366         return core->bus->ops->read8(core, offset);
367 }
368 static inline u32 bcma_read16(struct bcma_device *core, u16 offset)
369 {
370         return core->bus->ops->read16(core, offset);
371 }
372 static inline u32 bcma_read32(struct bcma_device *core, u16 offset)
373 {
374         return core->bus->ops->read32(core, offset);
375 }
376 static inline
377 void bcma_write8(struct bcma_device *core, u16 offset, u32 value)
378 {
379         core->bus->ops->write8(core, offset, value);
380 }
381 static inline
382 void bcma_write16(struct bcma_device *core, u16 offset, u32 value)
383 {
384         core->bus->ops->write16(core, offset, value);
385 }
386 static inline
387 void bcma_write32(struct bcma_device *core, u16 offset, u32 value)
388 {
389         core->bus->ops->write32(core, offset, value);
390 }
391 #ifdef CONFIG_BCMA_BLOCKIO
392 static inline void bcma_block_read(struct bcma_device *core, void *buffer,
393                                    size_t count, u16 offset, u8 reg_width)
394 {
395         core->bus->ops->block_read(core, buffer, count, offset, reg_width);
396 }
397 static inline void bcma_block_write(struct bcma_device *core,
398                                     const void *buffer, size_t count,
399                                     u16 offset, u8 reg_width)
400 {
401         core->bus->ops->block_write(core, buffer, count, offset, reg_width);
402 }
403 #endif
404 static inline u32 bcma_aread32(struct bcma_device *core, u16 offset)
405 {
406         return core->bus->ops->aread32(core, offset);
407 }
408 static inline
409 void bcma_awrite32(struct bcma_device *core, u16 offset, u32 value)
410 {
411         core->bus->ops->awrite32(core, offset, value);
412 }
413
414 static inline void bcma_mask32(struct bcma_device *cc, u16 offset, u32 mask)
415 {
416         bcma_write32(cc, offset, bcma_read32(cc, offset) & mask);
417 }
418 static inline void bcma_set32(struct bcma_device *cc, u16 offset, u32 set)
419 {
420         bcma_write32(cc, offset, bcma_read32(cc, offset) | set);
421 }
422 static inline void bcma_maskset32(struct bcma_device *cc,
423                                   u16 offset, u32 mask, u32 set)
424 {
425         bcma_write32(cc, offset, (bcma_read32(cc, offset) & mask) | set);
426 }
427 static inline void bcma_mask16(struct bcma_device *cc, u16 offset, u16 mask)
428 {
429         bcma_write16(cc, offset, bcma_read16(cc, offset) & mask);
430 }
431 static inline void bcma_set16(struct bcma_device *cc, u16 offset, u16 set)
432 {
433         bcma_write16(cc, offset, bcma_read16(cc, offset) | set);
434 }
435 static inline void bcma_maskset16(struct bcma_device *cc,
436                                   u16 offset, u16 mask, u16 set)
437 {
438         bcma_write16(cc, offset, (bcma_read16(cc, offset) & mask) | set);
439 }
440
441 extern struct bcma_device *bcma_find_core_unit(struct bcma_bus *bus, u16 coreid,
442                                                u8 unit);
443 static inline struct bcma_device *bcma_find_core(struct bcma_bus *bus,
444                                                  u16 coreid)
445 {
446         return bcma_find_core_unit(bus, coreid, 0);
447 }
448
449 #ifdef CONFIG_BCMA_HOST_PCI
450 extern void bcma_host_pci_up(struct bcma_bus *bus);
451 extern void bcma_host_pci_down(struct bcma_bus *bus);
452 extern int bcma_host_pci_irq_ctl(struct bcma_bus *bus,
453                                  struct bcma_device *core, bool enable);
454 #else
455 static inline void bcma_host_pci_up(struct bcma_bus *bus)
456 {
457 }
458 static inline void bcma_host_pci_down(struct bcma_bus *bus)
459 {
460 }
461 static inline int bcma_host_pci_irq_ctl(struct bcma_bus *bus,
462                                         struct bcma_device *core, bool enable)
463 {
464         if (bus->hosttype == BCMA_HOSTTYPE_PCI)
465                 return -ENOTSUPP;
466         return 0;
467 }
468 #endif
469
470 extern bool bcma_core_is_enabled(struct bcma_device *core);
471 extern void bcma_core_disable(struct bcma_device *core, u32 flags);
472 extern int bcma_core_enable(struct bcma_device *core, u32 flags);
473 extern void bcma_core_set_clockmode(struct bcma_device *core,
474                                     enum bcma_clkmode clkmode);
475 extern void bcma_core_pll_ctl(struct bcma_device *core, u32 req, u32 status,
476                               bool on);
477 extern u32 bcma_chipco_pll_read(struct bcma_drv_cc *cc, u32 offset);
478 #define BCMA_DMA_TRANSLATION_MASK       0xC0000000
479 #define  BCMA_DMA_TRANSLATION_NONE      0x00000000
480 #define  BCMA_DMA_TRANSLATION_DMA32_CMT 0x40000000 /* Client Mode Translation for 32-bit DMA */
481 #define  BCMA_DMA_TRANSLATION_DMA64_CMT 0x80000000 /* Client Mode Translation for 64-bit DMA */
482 extern u32 bcma_core_dma_translation(struct bcma_device *core);
483
484 extern unsigned int bcma_core_irq(struct bcma_device *core, int num);
485
486 #endif /* LINUX_BCMA_H_ */