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