xref: /openbmc/linux/include/linux/bcma/bcma.h (revision a027237a)
18369ae33SRafał Miłecki #ifndef LINUX_BCMA_H_
28369ae33SRafał Miłecki #define LINUX_BCMA_H_
38369ae33SRafał Miłecki 
48369ae33SRafał Miłecki #include <linux/pci.h>
58369ae33SRafał Miłecki #include <linux/mod_devicetable.h>
68369ae33SRafał Miłecki 
78369ae33SRafał Miłecki #include <linux/bcma/bcma_driver_chipcommon.h>
88369ae33SRafał Miłecki #include <linux/bcma/bcma_driver_pci.h>
921e0534aSHauke Mehrtens #include <linux/bcma/bcma_driver_mips.h>
1027f18dc2SRafał Miłecki #include <linux/ssb/ssb.h> /* SPROM sharing */
118369ae33SRafał Miłecki 
128369ae33SRafał Miłecki #include "bcma_regs.h"
138369ae33SRafał Miłecki 
148369ae33SRafał Miłecki struct bcma_device;
158369ae33SRafał Miłecki struct bcma_bus;
168369ae33SRafał Miłecki 
178369ae33SRafał Miłecki enum bcma_hosttype {
188369ae33SRafał Miłecki 	BCMA_HOSTTYPE_PCI,
198369ae33SRafał Miłecki 	BCMA_HOSTTYPE_SDIO,
20ecd177c2SHauke Mehrtens 	BCMA_HOSTTYPE_SOC,
218369ae33SRafał Miłecki };
228369ae33SRafał Miłecki 
238369ae33SRafał Miłecki struct bcma_chipinfo {
248369ae33SRafał Miłecki 	u16 id;
258369ae33SRafał Miłecki 	u8 rev;
268369ae33SRafał Miłecki 	u8 pkg;
278369ae33SRafał Miłecki };
288369ae33SRafał Miłecki 
297424dd0dSRafał Miłecki enum bcma_clkmode {
307424dd0dSRafał Miłecki 	BCMA_CLKMODE_FAST,
317424dd0dSRafał Miłecki 	BCMA_CLKMODE_DYNAMIC,
327424dd0dSRafał Miłecki };
337424dd0dSRafał Miłecki 
348369ae33SRafał Miłecki struct bcma_host_ops {
358369ae33SRafał Miłecki 	u8 (*read8)(struct bcma_device *core, u16 offset);
368369ae33SRafał Miłecki 	u16 (*read16)(struct bcma_device *core, u16 offset);
378369ae33SRafał Miłecki 	u32 (*read32)(struct bcma_device *core, u16 offset);
388369ae33SRafał Miłecki 	void (*write8)(struct bcma_device *core, u16 offset, u8 value);
398369ae33SRafał Miłecki 	void (*write16)(struct bcma_device *core, u16 offset, u16 value);
408369ae33SRafał Miłecki 	void (*write32)(struct bcma_device *core, u16 offset, u32 value);
419d75ef0fSRafał Miłecki #ifdef CONFIG_BCMA_BLOCKIO
429d75ef0fSRafał Miłecki 	void (*block_read)(struct bcma_device *core, void *buffer,
439d75ef0fSRafał Miłecki 			   size_t count, u16 offset, u8 reg_width);
449d75ef0fSRafał Miłecki 	void (*block_write)(struct bcma_device *core, const void *buffer,
459d75ef0fSRafał Miłecki 			    size_t count, u16 offset, u8 reg_width);
469d75ef0fSRafał Miłecki #endif
478369ae33SRafał Miłecki 	/* Agent ops */
488369ae33SRafał Miłecki 	u32 (*aread32)(struct bcma_device *core, u16 offset);
498369ae33SRafał Miłecki 	void (*awrite32)(struct bcma_device *core, u16 offset, u32 value);
508369ae33SRafał Miłecki };
518369ae33SRafał Miłecki 
528369ae33SRafał Miłecki /* Core manufacturers */
538369ae33SRafał Miłecki #define BCMA_MANUF_ARM			0x43B
548369ae33SRafał Miłecki #define BCMA_MANUF_MIPS			0x4A7
558369ae33SRafał Miłecki #define BCMA_MANUF_BCM			0x4BF
568369ae33SRafał Miłecki 
578369ae33SRafał Miłecki /* Core class values. */
588369ae33SRafał Miłecki #define BCMA_CL_SIM			0x0
598369ae33SRafał Miłecki #define BCMA_CL_EROM			0x1
608369ae33SRafał Miłecki #define BCMA_CL_CORESIGHT		0x9
618369ae33SRafał Miłecki #define BCMA_CL_VERIF			0xB
628369ae33SRafał Miłecki #define BCMA_CL_OPTIMO			0xD
638369ae33SRafał Miłecki #define BCMA_CL_GEN			0xE
648369ae33SRafał Miłecki #define BCMA_CL_PRIMECELL		0xF
658369ae33SRafał Miłecki 
668369ae33SRafał Miłecki /* Core-ID values. */
678369ae33SRafał Miłecki #define BCMA_CORE_OOB_ROUTER		0x367	/* Out of band */
688369ae33SRafał Miłecki #define BCMA_CORE_INVALID		0x700
698369ae33SRafał Miłecki #define BCMA_CORE_CHIPCOMMON		0x800
708369ae33SRafał Miłecki #define BCMA_CORE_ILINE20		0x801
718369ae33SRafał Miłecki #define BCMA_CORE_SRAM			0x802
728369ae33SRafał Miłecki #define BCMA_CORE_SDRAM			0x803
738369ae33SRafał Miłecki #define BCMA_CORE_PCI			0x804
748369ae33SRafał Miłecki #define BCMA_CORE_MIPS			0x805
758369ae33SRafał Miłecki #define BCMA_CORE_ETHERNET		0x806
768369ae33SRafał Miłecki #define BCMA_CORE_V90			0x807
778369ae33SRafał Miłecki #define BCMA_CORE_USB11_HOSTDEV		0x808
788369ae33SRafał Miłecki #define BCMA_CORE_ADSL			0x809
798369ae33SRafał Miłecki #define BCMA_CORE_ILINE100		0x80A
808369ae33SRafał Miłecki #define BCMA_CORE_IPSEC			0x80B
818369ae33SRafał Miłecki #define BCMA_CORE_UTOPIA		0x80C
828369ae33SRafał Miłecki #define BCMA_CORE_PCMCIA		0x80D
838369ae33SRafał Miłecki #define BCMA_CORE_INTERNAL_MEM		0x80E
848369ae33SRafał Miłecki #define BCMA_CORE_MEMC_SDRAM		0x80F
858369ae33SRafał Miłecki #define BCMA_CORE_OFDM			0x810
868369ae33SRafał Miłecki #define BCMA_CORE_EXTIF			0x811
878369ae33SRafał Miłecki #define BCMA_CORE_80211			0x812
888369ae33SRafał Miłecki #define BCMA_CORE_PHY_A			0x813
898369ae33SRafał Miłecki #define BCMA_CORE_PHY_B			0x814
908369ae33SRafał Miłecki #define BCMA_CORE_PHY_G			0x815
918369ae33SRafał Miłecki #define BCMA_CORE_MIPS_3302		0x816
928369ae33SRafał Miłecki #define BCMA_CORE_USB11_HOST		0x817
938369ae33SRafał Miłecki #define BCMA_CORE_USB11_DEV		0x818
948369ae33SRafał Miłecki #define BCMA_CORE_USB20_HOST		0x819
958369ae33SRafał Miłecki #define BCMA_CORE_USB20_DEV		0x81A
968369ae33SRafał Miłecki #define BCMA_CORE_SDIO_HOST		0x81B
978369ae33SRafał Miłecki #define BCMA_CORE_ROBOSWITCH		0x81C
988369ae33SRafał Miłecki #define BCMA_CORE_PARA_ATA		0x81D
998369ae33SRafał Miłecki #define BCMA_CORE_SATA_XORDMA		0x81E
1008369ae33SRafał Miłecki #define BCMA_CORE_ETHERNET_GBIT		0x81F
1018369ae33SRafał Miłecki #define BCMA_CORE_PCIE			0x820
1028369ae33SRafał Miłecki #define BCMA_CORE_PHY_N			0x821
1038369ae33SRafał Miłecki #define BCMA_CORE_SRAM_CTL		0x822
1048369ae33SRafał Miłecki #define BCMA_CORE_MINI_MACPHY		0x823
1058369ae33SRafał Miłecki #define BCMA_CORE_ARM_1176		0x824
1068369ae33SRafał Miłecki #define BCMA_CORE_ARM_7TDMI		0x825
1078369ae33SRafał Miłecki #define BCMA_CORE_PHY_LP		0x826
1088369ae33SRafał Miłecki #define BCMA_CORE_PMU			0x827
1098369ae33SRafał Miłecki #define BCMA_CORE_PHY_SSN		0x828
1108369ae33SRafał Miłecki #define BCMA_CORE_SDIO_DEV		0x829
1118369ae33SRafał Miłecki #define BCMA_CORE_ARM_CM3		0x82A
1128369ae33SRafał Miłecki #define BCMA_CORE_PHY_HT		0x82B
1138369ae33SRafał Miłecki #define BCMA_CORE_MIPS_74K		0x82C
1148369ae33SRafał Miłecki #define BCMA_CORE_MAC_GBIT		0x82D
1158369ae33SRafał Miłecki #define BCMA_CORE_DDR12_MEM_CTL		0x82E
1168369ae33SRafał Miłecki #define BCMA_CORE_PCIE_RC		0x82F	/* PCIe Root Complex */
1178369ae33SRafał Miłecki #define BCMA_CORE_OCP_OCP_BRIDGE	0x830
1188369ae33SRafał Miłecki #define BCMA_CORE_SHARED_COMMON		0x831
1198369ae33SRafał Miłecki #define BCMA_CORE_OCP_AHB_BRIDGE	0x832
1208369ae33SRafał Miłecki #define BCMA_CORE_SPI_HOST		0x833
1218369ae33SRafał Miłecki #define BCMA_CORE_I2S			0x834
1228369ae33SRafał Miłecki #define BCMA_CORE_SDR_DDR1_MEM_CTL	0x835	/* SDR/DDR1 memory controller core */
1238369ae33SRafał Miłecki #define BCMA_CORE_SHIM			0x837	/* SHIM component in ubus/6362 */
1248369ae33SRafał Miłecki #define BCMA_CORE_DEFAULT		0xFFF
1258369ae33SRafał Miłecki 
1268369ae33SRafał Miłecki #define BCMA_MAX_NR_CORES		16
1278369ae33SRafał Miłecki 
1288369ae33SRafał Miłecki struct bcma_device {
1298369ae33SRafał Miłecki 	struct bcma_bus *bus;
1308369ae33SRafał Miłecki 	struct bcma_device_id id;
1318369ae33SRafał Miłecki 
1328369ae33SRafał Miłecki 	struct device dev;
1331bdcd095SRafał Miłecki 	struct device *dma_dev;
13421e0534aSHauke Mehrtens 
1351bdcd095SRafał Miłecki 	unsigned int irq;
1368369ae33SRafał Miłecki 	bool dev_registered;
1378369ae33SRafał Miłecki 
1388369ae33SRafał Miłecki 	u8 core_index;
1395f2d6171SHauke Mehrtens 	u8 core_unit;
1408369ae33SRafał Miłecki 
1418369ae33SRafał Miłecki 	u32 addr;
1428369ae33SRafał Miłecki 	u32 wrap;
1438369ae33SRafał Miłecki 
144ecd177c2SHauke Mehrtens 	void __iomem *io_addr;
145ecd177c2SHauke Mehrtens 	void __iomem *io_wrap;
146ecd177c2SHauke Mehrtens 
1478369ae33SRafał Miłecki 	void *drvdata;
1488369ae33SRafał Miłecki 	struct list_head list;
1498369ae33SRafał Miłecki };
1508369ae33SRafał Miłecki 
1518369ae33SRafał Miłecki static inline void *bcma_get_drvdata(struct bcma_device *core)
1528369ae33SRafał Miłecki {
1538369ae33SRafał Miłecki 	return core->drvdata;
1548369ae33SRafał Miłecki }
1558369ae33SRafał Miłecki static inline void bcma_set_drvdata(struct bcma_device *core, void *drvdata)
1568369ae33SRafał Miłecki {
1578369ae33SRafał Miłecki 	core->drvdata = drvdata;
1588369ae33SRafał Miłecki }
1598369ae33SRafał Miłecki 
1608369ae33SRafał Miłecki struct bcma_driver {
1618369ae33SRafał Miłecki 	const char *name;
1628369ae33SRafał Miłecki 	const struct bcma_device_id *id_table;
1638369ae33SRafał Miłecki 
1648369ae33SRafał Miłecki 	int (*probe)(struct bcma_device *dev);
1658369ae33SRafał Miłecki 	void (*remove)(struct bcma_device *dev);
1667d5869e7SLinus Torvalds 	int (*suspend)(struct bcma_device *dev);
1678369ae33SRafał Miłecki 	int (*resume)(struct bcma_device *dev);
1688369ae33SRafał Miłecki 	void (*shutdown)(struct bcma_device *dev);
1698369ae33SRafał Miłecki 
1708369ae33SRafał Miłecki 	struct device_driver drv;
1718369ae33SRafał Miłecki };
1728369ae33SRafał Miłecki extern
1738369ae33SRafał Miłecki int __bcma_driver_register(struct bcma_driver *drv, struct module *owner);
174eb5589a8SPaul Gortmaker #define bcma_driver_register(drv) \
175eb5589a8SPaul Gortmaker 	__bcma_driver_register(drv, THIS_MODULE)
176eb5589a8SPaul Gortmaker 
1778369ae33SRafał Miłecki extern void bcma_driver_unregister(struct bcma_driver *drv);
1788369ae33SRafał Miłecki 
179a027237aSHauke Mehrtens /* Set a fallback SPROM.
180a027237aSHauke Mehrtens  * See kdoc at the function definition for complete documentation. */
181a027237aSHauke Mehrtens extern int bcma_arch_register_fallback_sprom(
182a027237aSHauke Mehrtens 		int (*sprom_callback)(struct bcma_bus *bus,
183a027237aSHauke Mehrtens 		struct ssb_sprom *out));
184a027237aSHauke Mehrtens 
1858369ae33SRafał Miłecki struct bcma_bus {
1868369ae33SRafał Miłecki 	/* The MMIO area. */
1878369ae33SRafał Miłecki 	void __iomem *mmio;
1888369ae33SRafał Miłecki 
1898369ae33SRafał Miłecki 	const struct bcma_host_ops *ops;
1908369ae33SRafał Miłecki 
1918369ae33SRafał Miłecki 	enum bcma_hosttype hosttype;
1928369ae33SRafał Miłecki 	union {
1938369ae33SRafał Miłecki 		/* Pointer to the PCI bus (only for BCMA_HOSTTYPE_PCI) */
1948369ae33SRafał Miłecki 		struct pci_dev *host_pci;
1958369ae33SRafał Miłecki 		/* Pointer to the SDIO device (only for BCMA_HOSTTYPE_SDIO) */
1968369ae33SRafał Miłecki 		struct sdio_func *host_sdio;
1978369ae33SRafał Miłecki 	};
1988369ae33SRafał Miłecki 
1998369ae33SRafał Miłecki 	struct bcma_chipinfo chipinfo;
2008369ae33SRafał Miłecki 
2018369ae33SRafał Miłecki 	struct bcma_device *mapped_core;
2028369ae33SRafał Miłecki 	struct list_head cores;
2038369ae33SRafał Miłecki 	u8 nr_cores;
204517f43e5SHauke Mehrtens 	u8 init_done:1;
2058f9ada4fSHauke Mehrtens 	u8 num;
2068369ae33SRafał Miłecki 
2078369ae33SRafał Miłecki 	struct bcma_drv_cc drv_cc;
2088369ae33SRafał Miłecki 	struct bcma_drv_pci drv_pci;
20921e0534aSHauke Mehrtens 	struct bcma_drv_mips drv_mips;
21027f18dc2SRafał Miłecki 
21127f18dc2SRafał Miłecki 	/* We decided to share SPROM struct with SSB as long as we do not need
21227f18dc2SRafał Miłecki 	 * any hacks for BCMA. This simplifies drivers code. */
21327f18dc2SRafał Miłecki 	struct ssb_sprom sprom;
2148369ae33SRafał Miłecki };
2158369ae33SRafał Miłecki 
21608445552SArend van Spriel static inline u32 bcma_read8(struct bcma_device *core, u16 offset)
2178369ae33SRafał Miłecki {
2188369ae33SRafał Miłecki 	return core->bus->ops->read8(core, offset);
2198369ae33SRafał Miłecki }
22008445552SArend van Spriel static inline u32 bcma_read16(struct bcma_device *core, u16 offset)
2218369ae33SRafał Miłecki {
2228369ae33SRafał Miłecki 	return core->bus->ops->read16(core, offset);
2238369ae33SRafał Miłecki }
22408445552SArend van Spriel static inline u32 bcma_read32(struct bcma_device *core, u16 offset)
2258369ae33SRafał Miłecki {
2268369ae33SRafał Miłecki 	return core->bus->ops->read32(core, offset);
2278369ae33SRafał Miłecki }
22808445552SArend van Spriel static inline
2298369ae33SRafał Miłecki void bcma_write8(struct bcma_device *core, u16 offset, u32 value)
2308369ae33SRafał Miłecki {
2318369ae33SRafał Miłecki 	core->bus->ops->write8(core, offset, value);
2328369ae33SRafał Miłecki }
23308445552SArend van Spriel static inline
2348369ae33SRafał Miłecki void bcma_write16(struct bcma_device *core, u16 offset, u32 value)
2358369ae33SRafał Miłecki {
2368369ae33SRafał Miłecki 	core->bus->ops->write16(core, offset, value);
2378369ae33SRafał Miłecki }
23808445552SArend van Spriel static inline
2398369ae33SRafał Miłecki void bcma_write32(struct bcma_device *core, u16 offset, u32 value)
2408369ae33SRafał Miłecki {
2418369ae33SRafał Miłecki 	core->bus->ops->write32(core, offset, value);
2428369ae33SRafał Miłecki }
2439d75ef0fSRafał Miłecki #ifdef CONFIG_BCMA_BLOCKIO
24408445552SArend van Spriel static inline void bcma_block_read(struct bcma_device *core, void *buffer,
2459d75ef0fSRafał Miłecki 				   size_t count, u16 offset, u8 reg_width)
2469d75ef0fSRafał Miłecki {
2479d75ef0fSRafał Miłecki 	core->bus->ops->block_read(core, buffer, count, offset, reg_width);
2489d75ef0fSRafał Miłecki }
24908445552SArend van Spriel static inline void bcma_block_write(struct bcma_device *core,
25008445552SArend van Spriel 				    const void *buffer, size_t count,
25108445552SArend van Spriel 				    u16 offset, u8 reg_width)
2529d75ef0fSRafał Miłecki {
2539d75ef0fSRafał Miłecki 	core->bus->ops->block_write(core, buffer, count, offset, reg_width);
2549d75ef0fSRafał Miłecki }
2559d75ef0fSRafał Miłecki #endif
25608445552SArend van Spriel static inline u32 bcma_aread32(struct bcma_device *core, u16 offset)
2578369ae33SRafał Miłecki {
2588369ae33SRafał Miłecki 	return core->bus->ops->aread32(core, offset);
2598369ae33SRafał Miłecki }
26008445552SArend van Spriel static inline
2618369ae33SRafał Miłecki void bcma_awrite32(struct bcma_device *core, u16 offset, u32 value)
2628369ae33SRafał Miłecki {
2638369ae33SRafał Miłecki 	core->bus->ops->awrite32(core, offset, value);
2648369ae33SRafał Miłecki }
2658369ae33SRafał Miłecki 
2669d08f10dSArend van Spriel static inline void bcma_mask32(struct bcma_device *cc, u16 offset, u32 mask)
2679d08f10dSArend van Spriel {
2689d08f10dSArend van Spriel 	bcma_write32(cc, offset, bcma_read32(cc, offset) & mask);
2699d08f10dSArend van Spriel }
2709d08f10dSArend van Spriel static inline void bcma_set32(struct bcma_device *cc, u16 offset, u32 set)
2719d08f10dSArend van Spriel {
2729d08f10dSArend van Spriel 	bcma_write32(cc, offset, bcma_read32(cc, offset) | set);
2739d08f10dSArend van Spriel }
2749d08f10dSArend van Spriel static inline void bcma_maskset32(struct bcma_device *cc,
2759d08f10dSArend van Spriel 				  u16 offset, u32 mask, u32 set)
2769d08f10dSArend van Spriel {
2779d08f10dSArend van Spriel 	bcma_write32(cc, offset, (bcma_read32(cc, offset) & mask) | set);
2789d08f10dSArend van Spriel }
2799d08f10dSArend van Spriel static inline void bcma_mask16(struct bcma_device *cc, u16 offset, u16 mask)
2809d08f10dSArend van Spriel {
2819d08f10dSArend van Spriel 	bcma_write16(cc, offset, bcma_read16(cc, offset) & mask);
2829d08f10dSArend van Spriel }
2839d08f10dSArend van Spriel static inline void bcma_set16(struct bcma_device *cc, u16 offset, u16 set)
2849d08f10dSArend van Spriel {
2859d08f10dSArend van Spriel 	bcma_write16(cc, offset, bcma_read16(cc, offset) | set);
2869d08f10dSArend van Spriel }
2879d08f10dSArend van Spriel static inline void bcma_maskset16(struct bcma_device *cc,
2889d08f10dSArend van Spriel 				  u16 offset, u16 mask, u16 set)
2899d08f10dSArend van Spriel {
2909d08f10dSArend van Spriel 	bcma_write16(cc, offset, (bcma_read16(cc, offset) & mask) | set);
2919d08f10dSArend van Spriel }
2923de1a774SRafał Miłecki 
2931c9351cfSHauke Mehrtens extern struct bcma_device *bcma_find_core(struct bcma_bus *bus, u16 coreid);
2948369ae33SRafał Miłecki extern bool bcma_core_is_enabled(struct bcma_device *core);
295e3ae0cacSArend van Spriel extern void bcma_core_disable(struct bcma_device *core, u32 flags);
2968369ae33SRafał Miłecki extern int bcma_core_enable(struct bcma_device *core, u32 flags);
2977424dd0dSRafał Miłecki extern void bcma_core_set_clockmode(struct bcma_device *core,
2987424dd0dSRafał Miłecki 				    enum bcma_clkmode clkmode);
2996f53912fSRafał Miłecki extern void bcma_core_pll_ctl(struct bcma_device *core, u32 req, u32 status,
3006f53912fSRafał Miłecki 			      bool on);
30105aec233SRafał Miłecki #define BCMA_DMA_TRANSLATION_MASK	0xC0000000
30205aec233SRafał Miłecki #define  BCMA_DMA_TRANSLATION_NONE	0x00000000
30305aec233SRafał Miłecki #define  BCMA_DMA_TRANSLATION_DMA32_CMT	0x40000000 /* Client Mode Translation for 32-bit DMA */
30405aec233SRafał Miłecki #define  BCMA_DMA_TRANSLATION_DMA64_CMT	0x80000000 /* Client Mode Translation for 64-bit DMA */
30505aec233SRafał Miłecki extern u32 bcma_core_dma_translation(struct bcma_device *core);
3063de1a774SRafał Miłecki 
3078369ae33SRafał Miłecki #endif /* LINUX_BCMA_H_ */
308