/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/ssb/ssb.h> /* SPROM sharing */
 11
 12#include "bcma_regs.h"
 13
 14struct bcma_device;
 15struct bcma_bus;
 16
 17enum bcma_hosttype {
 18	BCMA_HOSTTYPE_PCI,
 19	BCMA_HOSTTYPE_SDIO,
 20	BCMA_HOSTTYPE_SOC,
 21};
 22
 23struct bcma_chipinfo {
 24	u16 id;
 25	u8 rev;
 26	u8 pkg;
 27};
 28
 29enum bcma_clkmode {
 30	BCMA_CLKMODE_FAST,
 31	BCMA_CLKMODE_DYNAMIC,
 32};
 33
 34struct bcma_host_ops {
 35	u8 (*read8)(struct bcma_device *core, u16 offset);
 36	u16 (*read16)(struct bcma_device *core, u16 offset);
 37	u32 (*read32)(struct bcma_device *core, u16 offset);
 38	void (*write8)(struct bcma_device *core, u16 offset, u8 value);
 39	void (*write16)(struct bcma_device *core, u16 offset, u16 value);
 40	void (*write32)(struct bcma_device *core, u16 offset, u32 value);
 41#ifdef CONFIG_BCMA_BLOCKIO
 42	void (*block_read)(struct bcma_device *core, void *buffer,
 43			   size_t count, u16 offset, u8 reg_width);
 44	void (*block_write)(struct bcma_device *core, const void *buffer,
 45			    size_t count, u16 offset, u8 reg_width);
 46#endif
 47	/* Agent ops */
 48	u32 (*aread32)(struct bcma_device *core, u16 offset);
 49	void (*awrite32)(struct bcma_device *core, u16 offset, u32 value);
 50};
 51
 52/* Core manufacturers */
 53#define BCMA_MANUF_ARM			0x43B
 54#define BCMA_MANUF_MIPS			0x4A7
 55#define BCMA_MANUF_BCM			0x4BF
 56
 57/* Core class values. */
 58#define BCMA_CL_SIM			0x0
 59#define BCMA_CL_EROM			0x1
 60#define BCMA_CL_CORESIGHT		0x9
 61#define BCMA_CL_VERIF			0xB
 62#define BCMA_CL_OPTIMO			0xD
 63#define BCMA_CL_GEN			0xE
 64#define BCMA_CL_PRIMECELL		0xF
 65
 66/* Core-ID values. */
 67#define BCMA_CORE_OOB_ROUTER		0x367	/* Out of band */
 68#define BCMA_CORE_INVALID		0x700
 69#define BCMA_CORE_CHIPCOMMON		0x800
 70#define BCMA_CORE_ILINE20		0x801
 71#define BCMA_CORE_SRAM			0x802
 72#define BCMA_CORE_SDRAM			0x803
 73#define BCMA_CORE_PCI			0x804
 74#define BCMA_CORE_MIPS			0x805
 75#define BCMA_CORE_ETHERNET		0x806
 76#define BCMA_CORE_V90			0x807
 77#define BCMA_CORE_USB11_HOSTDEV		0x808
 78#define BCMA_CORE_ADSL			0x809
 79#define BCMA_CORE_ILINE100		0x80A
 80#define BCMA_CORE_IPSEC			0x80B
 81#define BCMA_CORE_UTOPIA		0x80C
 82#define BCMA_CORE_PCMCIA		0x80D
 83#define BCMA_CORE_INTERNAL_MEM		0x80E
 84#define BCMA_CORE_MEMC_SDRAM		0x80F
 85#define BCMA_CORE_OFDM			0x810
 86#define BCMA_CORE_EXTIF			0x811
 87#define BCMA_CORE_80211			0x812
 88#define BCMA_CORE_PHY_A			0x813
 89#define BCMA_CORE_PHY_B			0x814
 90#define BCMA_CORE_PHY_G			0x815
 91#define BCMA_CORE_MIPS_3302		0x816
 92#define BCMA_CORE_USB11_HOST		0x817
 93#define BCMA_CORE_USB11_DEV		0x818
 94#define BCMA_CORE_USB20_HOST		0x819
 95#define BCMA_CORE_USB20_DEV		0x81A
 96#define BCMA_CORE_SDIO_HOST		0x81B
 97#define BCMA_CORE_ROBOSWITCH		0x81C
 98#define BCMA_CORE_PARA_ATA		0x81D
 99#define BCMA_CORE_SATA_XORDMA		0x81E
100#define BCMA_CORE_ETHERNET_GBIT		0x81F
101#define BCMA_CORE_PCIE			0x820
102#define BCMA_CORE_PHY_N			0x821
103#define BCMA_CORE_SRAM_CTL		0x822
104#define BCMA_CORE_MINI_MACPHY		0x823
105#define BCMA_CORE_ARM_1176		0x824
106#define BCMA_CORE_ARM_7TDMI		0x825
107#define BCMA_CORE_PHY_LP		0x826
108#define BCMA_CORE_PMU			0x827
109#define BCMA_CORE_PHY_SSN		0x828
110#define BCMA_CORE_SDIO_DEV		0x829
111#define BCMA_CORE_ARM_CM3		0x82A
112#define BCMA_CORE_PHY_HT		0x82B
113#define BCMA_CORE_MIPS_74K		0x82C
114#define BCMA_CORE_MAC_GBIT		0x82D
115#define BCMA_CORE_DDR12_MEM_CTL		0x82E
116#define BCMA_CORE_PCIE_RC		0x82F	/* PCIe Root Complex */
117#define BCMA_CORE_OCP_OCP_BRIDGE	0x830
118#define BCMA_CORE_SHARED_COMMON		0x831
119#define BCMA_CORE_OCP_AHB_BRIDGE	0x832
120#define BCMA_CORE_SPI_HOST		0x833
121#define BCMA_CORE_I2S			0x834
122#define BCMA_CORE_SDR_DDR1_MEM_CTL	0x835	/* SDR/DDR1 memory controller core */
123#define BCMA_CORE_SHIM			0x837	/* SHIM component in ubus/6362 */
124#define BCMA_CORE_DEFAULT		0xFFF
125
126#define BCMA_MAX_NR_CORES		16
127
128struct bcma_device {
129	struct bcma_bus *bus;
130	struct bcma_device_id id;
131
132	struct device dev;
133	struct device *dma_dev;
134
135	unsigned int irq;
136	bool dev_registered;
137
138	u8 core_index;
139	u8 core_unit;
140
141	u32 addr;
142	u32 wrap;
143
144	void __iomem *io_addr;
145	void __iomem *io_wrap;
146
147	void *drvdata;
148	struct list_head list;
149};
150
151static inline void *bcma_get_drvdata(struct bcma_device *core)
152{
153	return core->drvdata;
154}
155static inline void bcma_set_drvdata(struct bcma_device *core, void *drvdata)
156{
157	core->drvdata = drvdata;
158}
159
160struct bcma_driver {
161	const char *name;
162	const struct bcma_device_id *id_table;
163
164	int (*probe)(struct bcma_device *dev);
165	void (*remove)(struct bcma_device *dev);
166	int (*suspend)(struct bcma_device *dev);
167	int (*resume)(struct bcma_device *dev);
168	void (*shutdown)(struct bcma_device *dev);
169
170	struct device_driver drv;
171};
172extern
173int __bcma_driver_register(struct bcma_driver *drv, struct module *owner);
174#define bcma_driver_register(drv) \
175	__bcma_driver_register(drv, THIS_MODULE)
176
177extern void bcma_driver_unregister(struct bcma_driver *drv);
178
179/* Set a fallback SPROM.
180 * See kdoc at the function definition for complete documentation. */
181extern int bcma_arch_register_fallback_sprom(
182		int (*sprom_callback)(struct bcma_bus *bus,
183		struct ssb_sprom *out));
184
185struct bcma_bus {
186	/* The MMIO area. */
187	void __iomem *mmio;
188
189	const struct bcma_host_ops *ops;
190
191	enum bcma_hosttype hosttype;
192	union {
193		/* Pointer to the PCI bus (only for BCMA_HOSTTYPE_PCI) */
194		struct pci_dev *host_pci;
195		/* Pointer to the SDIO device (only for BCMA_HOSTTYPE_SDIO) */
196		struct sdio_func *host_sdio;
197	};
198
199	struct bcma_chipinfo chipinfo;
200
201	struct bcma_device *mapped_core;
202	struct list_head cores;
203	u8 nr_cores;
204	u8 init_done:1;
205	u8 num;
206
207	struct bcma_drv_cc drv_cc;
208	struct bcma_drv_pci drv_pci;
209	struct bcma_drv_mips drv_mips;
210
211	/* We decided to share SPROM struct with SSB as long as we do not need
212	 * any hacks for BCMA. This simplifies drivers code. */
213	struct ssb_sprom sprom;
214};
215
216static inline u32 bcma_read8(struct bcma_device *core, u16 offset)
217{
218	return core->bus->ops->read8(core, offset);
219}
220static inline u32 bcma_read16(struct bcma_device *core, u16 offset)
221{
222	return core->bus->ops->read16(core, offset);
223}
224static inline u32 bcma_read32(struct bcma_device *core, u16 offset)
225{
226	return core->bus->ops->read32(core, offset);
227}
228static inline
229void bcma_write8(struct bcma_device *core, u16 offset, u32 value)
230{
231	core->bus->ops->write8(core, offset, value);
232}
233static inline
234void bcma_write16(struct bcma_device *core, u16 offset, u32 value)
235{
236	core->bus->ops->write16(core, offset, value);
237}
238static inline
239void bcma_write32(struct bcma_device *core, u16 offset, u32 value)
240{
241	core->bus->ops->write32(core, offset, value);
242}
243#ifdef CONFIG_BCMA_BLOCKIO
244static inline void bcma_block_read(struct bcma_device *core, void *buffer,
245				   size_t count, u16 offset, u8 reg_width)
246{
247	core->bus->ops->block_read(core, buffer, count, offset, reg_width);
248}
249static inline void bcma_block_write(struct bcma_device *core,
250				    const void *buffer, size_t count,
251				    u16 offset, u8 reg_width)
252{
253	core->bus->ops->block_write(core, buffer, count, offset, reg_width);
254}
255#endif
256static inline u32 bcma_aread32(struct bcma_device *core, u16 offset)
257{
258	return core->bus->ops->aread32(core, offset);
259}
260static inline
261void bcma_awrite32(struct bcma_device *core, u16 offset, u32 value)
262{
263	core->bus->ops->awrite32(core, offset, value);
264}
265
266static inline void bcma_mask32(struct bcma_device *cc, u16 offset, u32 mask)
267{
268	bcma_write32(cc, offset, bcma_read32(cc, offset) & mask);
269}
270static inline void bcma_set32(struct bcma_device *cc, u16 offset, u32 set)
271{
272	bcma_write32(cc, offset, bcma_read32(cc, offset) | set);
273}
274static inline void bcma_maskset32(struct bcma_device *cc,
275				  u16 offset, u32 mask, u32 set)
276{
277	bcma_write32(cc, offset, (bcma_read32(cc, offset) & mask) | set);
278}
279static inline void bcma_mask16(struct bcma_device *cc, u16 offset, u16 mask)
280{
281	bcma_write16(cc, offset, bcma_read16(cc, offset) & mask);
282}
283static inline void bcma_set16(struct bcma_device *cc, u16 offset, u16 set)
284{
285	bcma_write16(cc, offset, bcma_read16(cc, offset) | set);
286}
287static inline void bcma_maskset16(struct bcma_device *cc,
288				  u16 offset, u16 mask, u16 set)
289{
290	bcma_write16(cc, offset, (bcma_read16(cc, offset) & mask) | set);
291}
292
293extern struct bcma_device *bcma_find_core(struct bcma_bus *bus, u16 coreid);
294extern bool bcma_core_is_enabled(struct bcma_device *core);
295extern void bcma_core_disable(struct bcma_device *core, u32 flags);
296extern int bcma_core_enable(struct bcma_device *core, u32 flags);
297extern void bcma_core_set_clockmode(struct bcma_device *core,
298				    enum bcma_clkmode clkmode);
299extern void bcma_core_pll_ctl(struct bcma_device *core, u32 req, u32 status,
300			      bool on);
301#define BCMA_DMA_TRANSLATION_MASK	0xC0000000
302#define  BCMA_DMA_TRANSLATION_NONE	0x00000000
303#define  BCMA_DMA_TRANSLATION_DMA32_CMT	0x40000000 /* Client Mode Translation for 32-bit DMA */
304#define  BCMA_DMA_TRANSLATION_DMA64_CMT	0x80000000 /* Client Mode Translation for 64-bit DMA */
305extern u32 bcma_core_dma_translation(struct bcma_device *core);
306
307#endif /* LINUX_BCMA_H_ */