]> Pileus Git - ~andy/linux/blob - include/linux/bcma/bcma.h
Merge branches 'for-3.12/devm', 'for-3.12/i2c-hid', 'for-3.12/i2c-hid-dt', 'for-3...
[~andy/linux] / 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_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_PHY_AC                0x83B
138 #define BCMA_CORE_PCIE2                 0x83C   /* PCI Express Gen2 */
139 #define BCMA_CORE_USB30_DEV             0x83D
140 #define BCMA_CORE_ARM_CR4               0x83E
141 #define BCMA_CORE_DEFAULT               0xFFF
142
143 #define BCMA_MAX_NR_CORES               16
144
145 /* Chip IDs of PCIe devices */
146 #define BCMA_CHIP_ID_BCM4313    0x4313
147 #define BCMA_CHIP_ID_BCM43142   43142
148 #define BCMA_CHIP_ID_BCM43224   43224
149 #define  BCMA_PKG_ID_BCM43224_FAB_CSM   0x8
150 #define  BCMA_PKG_ID_BCM43224_FAB_SMIC  0xa
151 #define BCMA_CHIP_ID_BCM43225   43225
152 #define BCMA_CHIP_ID_BCM43227   43227
153 #define BCMA_CHIP_ID_BCM43228   43228
154 #define BCMA_CHIP_ID_BCM43421   43421
155 #define BCMA_CHIP_ID_BCM43428   43428
156 #define BCMA_CHIP_ID_BCM43431   43431
157 #define BCMA_CHIP_ID_BCM43460   43460
158 #define BCMA_CHIP_ID_BCM4331    0x4331
159 #define BCMA_CHIP_ID_BCM6362    0x6362
160 #define BCMA_CHIP_ID_BCM4360    0x4360
161 #define BCMA_CHIP_ID_BCM4352    0x4352
162
163 /* Chip IDs of SoCs */
164 #define BCMA_CHIP_ID_BCM4706    0x5300
165 #define  BCMA_PKG_ID_BCM4706L   1
166 #define BCMA_CHIP_ID_BCM4716    0x4716
167 #define  BCMA_PKG_ID_BCM4716    8
168 #define  BCMA_PKG_ID_BCM4717    9
169 #define  BCMA_PKG_ID_BCM4718    10
170 #define BCMA_CHIP_ID_BCM47162   47162
171 #define BCMA_CHIP_ID_BCM4748    0x4748
172 #define BCMA_CHIP_ID_BCM4749    0x4749
173 #define BCMA_CHIP_ID_BCM5356    0x5356
174 #define BCMA_CHIP_ID_BCM5357    0x5357
175 #define  BCMA_PKG_ID_BCM5358    9
176 #define  BCMA_PKG_ID_BCM47186   10
177 #define  BCMA_PKG_ID_BCM5357    11
178 #define BCMA_CHIP_ID_BCM53572   53572
179 #define  BCMA_PKG_ID_BCM47188   9
180
181 /* Board types (on PCI usually equals to the subsystem dev id) */
182 /* BCM4313 */
183 #define BCMA_BOARD_TYPE_BCM94313BU      0X050F
184 #define BCMA_BOARD_TYPE_BCM94313HM      0X0510
185 #define BCMA_BOARD_TYPE_BCM94313EPA     0X0511
186 #define BCMA_BOARD_TYPE_BCM94313HMG     0X051C
187 /* BCM4716 */
188 #define BCMA_BOARD_TYPE_BCM94716NR2     0X04CD
189 /* BCM43224 */
190 #define BCMA_BOARD_TYPE_BCM943224X21    0X056E
191 #define BCMA_BOARD_TYPE_BCM943224X21_FCC        0X00D1
192 #define BCMA_BOARD_TYPE_BCM943224X21B   0X00E9
193 #define BCMA_BOARD_TYPE_BCM943224M93    0X008B
194 #define BCMA_BOARD_TYPE_BCM943224M93A   0X0090
195 #define BCMA_BOARD_TYPE_BCM943224X16    0X0093
196 #define BCMA_BOARD_TYPE_BCM94322X9      0X008D
197 #define BCMA_BOARD_TYPE_BCM94322M35E    0X008E
198 /* BCM43228 */
199 #define BCMA_BOARD_TYPE_BCM943228BU8    0X0540
200 #define BCMA_BOARD_TYPE_BCM943228BU9    0X0541
201 #define BCMA_BOARD_TYPE_BCM943228BU     0X0542
202 #define BCMA_BOARD_TYPE_BCM943227HM4L   0X0543
203 #define BCMA_BOARD_TYPE_BCM943227HMB    0X0544
204 #define BCMA_BOARD_TYPE_BCM943228HM4L   0X0545
205 #define BCMA_BOARD_TYPE_BCM943228SD     0X0573
206 /* BCM4331 */
207 #define BCMA_BOARD_TYPE_BCM94331X19     0X00D6
208 #define BCMA_BOARD_TYPE_BCM94331X28     0X00E4
209 #define BCMA_BOARD_TYPE_BCM94331X28B    0X010E
210 #define BCMA_BOARD_TYPE_BCM94331PCIEBT3AX       0X00E4
211 #define BCMA_BOARD_TYPE_BCM94331X12_2G  0X00EC
212 #define BCMA_BOARD_TYPE_BCM94331X12_5G  0X00ED
213 #define BCMA_BOARD_TYPE_BCM94331X29B    0X00EF
214 #define BCMA_BOARD_TYPE_BCM94331CSAX    0X00EF
215 #define BCMA_BOARD_TYPE_BCM94331X19C    0X00F5
216 #define BCMA_BOARD_TYPE_BCM94331X33     0X00F4
217 #define BCMA_BOARD_TYPE_BCM94331BU      0X0523
218 #define BCMA_BOARD_TYPE_BCM94331S9BU    0X0524
219 #define BCMA_BOARD_TYPE_BCM94331MC      0X0525
220 #define BCMA_BOARD_TYPE_BCM94331MCI     0X0526
221 #define BCMA_BOARD_TYPE_BCM94331PCIEBT4 0X0527
222 #define BCMA_BOARD_TYPE_BCM94331HM      0X0574
223 #define BCMA_BOARD_TYPE_BCM94331PCIEDUAL        0X059B
224 #define BCMA_BOARD_TYPE_BCM94331MCH5    0X05A9
225 #define BCMA_BOARD_TYPE_BCM94331CS      0X05C6
226 #define BCMA_BOARD_TYPE_BCM94331CD      0X05DA
227 /* BCM53572 */
228 #define BCMA_BOARD_TYPE_BCM953572BU     0X058D
229 #define BCMA_BOARD_TYPE_BCM953572NR2    0X058E
230 #define BCMA_BOARD_TYPE_BCM947188NR2    0X058F
231 #define BCMA_BOARD_TYPE_BCM953572SDRNR2 0X0590
232 /* BCM43142 */
233 #define BCMA_BOARD_TYPE_BCM943142HM     0X05E0
234
235 struct bcma_device {
236         struct bcma_bus *bus;
237         struct bcma_device_id id;
238
239         struct device dev;
240         struct device *dma_dev;
241
242         unsigned int irq;
243         bool dev_registered;
244
245         u8 core_index;
246         u8 core_unit;
247
248         u32 addr;
249         u32 addr1;
250         u32 wrap;
251
252         void __iomem *io_addr;
253         void __iomem *io_wrap;
254
255         void *drvdata;
256         struct list_head list;
257 };
258
259 static inline void *bcma_get_drvdata(struct bcma_device *core)
260 {
261         return core->drvdata;
262 }
263 static inline void bcma_set_drvdata(struct bcma_device *core, void *drvdata)
264 {
265         core->drvdata = drvdata;
266 }
267
268 struct bcma_driver {
269         const char *name;
270         const struct bcma_device_id *id_table;
271
272         int (*probe)(struct bcma_device *dev);
273         void (*remove)(struct bcma_device *dev);
274         int (*suspend)(struct bcma_device *dev);
275         int (*resume)(struct bcma_device *dev);
276         void (*shutdown)(struct bcma_device *dev);
277
278         struct device_driver drv;
279 };
280 extern
281 int __bcma_driver_register(struct bcma_driver *drv, struct module *owner);
282 #define bcma_driver_register(drv) \
283         __bcma_driver_register(drv, THIS_MODULE)
284
285 extern void bcma_driver_unregister(struct bcma_driver *drv);
286
287 /* Set a fallback SPROM.
288  * See kdoc at the function definition for complete documentation. */
289 extern int bcma_arch_register_fallback_sprom(
290                 int (*sprom_callback)(struct bcma_bus *bus,
291                 struct ssb_sprom *out));
292
293 struct bcma_bus {
294         /* The MMIO area. */
295         void __iomem *mmio;
296
297         const struct bcma_host_ops *ops;
298
299         enum bcma_hosttype hosttype;
300         union {
301                 /* Pointer to the PCI bus (only for BCMA_HOSTTYPE_PCI) */
302                 struct pci_dev *host_pci;
303                 /* Pointer to the SDIO device (only for BCMA_HOSTTYPE_SDIO) */
304                 struct sdio_func *host_sdio;
305         };
306
307         struct bcma_chipinfo chipinfo;
308
309         struct bcma_boardinfo boardinfo;
310
311         struct bcma_device *mapped_core;
312         struct list_head cores;
313         u8 nr_cores;
314         u8 init_done:1;
315         u8 num;
316
317         struct bcma_drv_cc drv_cc;
318         struct bcma_drv_pci drv_pci[2];
319         struct bcma_drv_mips drv_mips;
320         struct bcma_drv_gmac_cmn drv_gmac_cmn;
321
322         /* We decided to share SPROM struct with SSB as long as we do not need
323          * any hacks for BCMA. This simplifies drivers code. */
324         struct ssb_sprom sprom;
325 };
326
327 static inline u32 bcma_read8(struct bcma_device *core, u16 offset)
328 {
329         return core->bus->ops->read8(core, offset);
330 }
331 static inline u32 bcma_read16(struct bcma_device *core, u16 offset)
332 {
333         return core->bus->ops->read16(core, offset);
334 }
335 static inline u32 bcma_read32(struct bcma_device *core, u16 offset)
336 {
337         return core->bus->ops->read32(core, offset);
338 }
339 static inline
340 void bcma_write8(struct bcma_device *core, u16 offset, u32 value)
341 {
342         core->bus->ops->write8(core, offset, value);
343 }
344 static inline
345 void bcma_write16(struct bcma_device *core, u16 offset, u32 value)
346 {
347         core->bus->ops->write16(core, offset, value);
348 }
349 static inline
350 void bcma_write32(struct bcma_device *core, u16 offset, u32 value)
351 {
352         core->bus->ops->write32(core, offset, value);
353 }
354 #ifdef CONFIG_BCMA_BLOCKIO
355 static inline void bcma_block_read(struct bcma_device *core, void *buffer,
356                                    size_t count, u16 offset, u8 reg_width)
357 {
358         core->bus->ops->block_read(core, buffer, count, offset, reg_width);
359 }
360 static inline void bcma_block_write(struct bcma_device *core,
361                                     const void *buffer, size_t count,
362                                     u16 offset, u8 reg_width)
363 {
364         core->bus->ops->block_write(core, buffer, count, offset, reg_width);
365 }
366 #endif
367 static inline u32 bcma_aread32(struct bcma_device *core, u16 offset)
368 {
369         return core->bus->ops->aread32(core, offset);
370 }
371 static inline
372 void bcma_awrite32(struct bcma_device *core, u16 offset, u32 value)
373 {
374         core->bus->ops->awrite32(core, offset, value);
375 }
376
377 static inline void bcma_mask32(struct bcma_device *cc, u16 offset, u32 mask)
378 {
379         bcma_write32(cc, offset, bcma_read32(cc, offset) & mask);
380 }
381 static inline void bcma_set32(struct bcma_device *cc, u16 offset, u32 set)
382 {
383         bcma_write32(cc, offset, bcma_read32(cc, offset) | set);
384 }
385 static inline void bcma_maskset32(struct bcma_device *cc,
386                                   u16 offset, u32 mask, u32 set)
387 {
388         bcma_write32(cc, offset, (bcma_read32(cc, offset) & mask) | set);
389 }
390 static inline void bcma_mask16(struct bcma_device *cc, u16 offset, u16 mask)
391 {
392         bcma_write16(cc, offset, bcma_read16(cc, offset) & mask);
393 }
394 static inline void bcma_set16(struct bcma_device *cc, u16 offset, u16 set)
395 {
396         bcma_write16(cc, offset, bcma_read16(cc, offset) | set);
397 }
398 static inline void bcma_maskset16(struct bcma_device *cc,
399                                   u16 offset, u16 mask, u16 set)
400 {
401         bcma_write16(cc, offset, (bcma_read16(cc, offset) & mask) | set);
402 }
403
404 extern struct bcma_device *bcma_find_core(struct bcma_bus *bus, u16 coreid);
405 extern bool bcma_core_is_enabled(struct bcma_device *core);
406 extern void bcma_core_disable(struct bcma_device *core, u32 flags);
407 extern int bcma_core_enable(struct bcma_device *core, u32 flags);
408 extern void bcma_core_set_clockmode(struct bcma_device *core,
409                                     enum bcma_clkmode clkmode);
410 extern void bcma_core_pll_ctl(struct bcma_device *core, u32 req, u32 status,
411                               bool on);
412 extern u32 bcma_chipco_pll_read(struct bcma_drv_cc *cc, u32 offset);
413 #define BCMA_DMA_TRANSLATION_MASK       0xC0000000
414 #define  BCMA_DMA_TRANSLATION_NONE      0x00000000
415 #define  BCMA_DMA_TRANSLATION_DMA32_CMT 0x40000000 /* Client Mode Translation for 32-bit DMA */
416 #define  BCMA_DMA_TRANSLATION_DMA64_CMT 0x80000000 /* Client Mode Translation for 64-bit DMA */
417 extern u32 bcma_core_dma_translation(struct bcma_device *core);
418
419 #endif /* LINUX_BCMA_H_ */