[linux-2.6-block.git] / include / linux / bcma / bcma.h

#ifndef LINUX_BCMA_H_
#define LINUX_BCMA_H_

#include <linux/pci.h>
#include <linux/mod_devicetable.h>

#include <linux/bcma/bcma_driver_chipcommon.h>
#include <linux/bcma/bcma_driver_pci.h>
#include <linux/bcma/bcma_driver_pcie2.h>
#include <linux/bcma/bcma_driver_mips.h>
#include <linux/bcma/bcma_driver_gmac_cmn.h>
#include <linux/ssb/ssb.h> /* SPROM sharing */

#include <linux/bcma/bcma_regs.h>

struct bcma_device;
struct bcma_bus;

enum bcma_hosttype {
	BCMA_HOSTTYPE_PCI,
	BCMA_HOSTTYPE_SDIO,
	BCMA_HOSTTYPE_SOC,
};

struct bcma_chipinfo {
	u16 id;
	u8 rev;
	u8 pkg;
};

struct bcma_boardinfo {
	u16 vendor;
	u16 type;
};

enum bcma_clkmode {
	BCMA_CLKMODE_FAST,
	BCMA_CLKMODE_DYNAMIC,
};

struct bcma_host_ops {
	u8 (*read8)(struct bcma_device *core, u16 offset);
	u16 (*read16)(struct bcma_device *core, u16 offset);
	u32 (*read32)(struct bcma_device *core, u16 offset);
	void (*write8)(struct bcma_device *core, u16 offset, u8 value);
	void (*write16)(struct bcma_device *core, u16 offset, u16 value);
	void (*write32)(struct bcma_device *core, u16 offset, u32 value);
#ifdef CONFIG_BCMA_BLOCKIO
	void (*block_read)(struct bcma_device *core, void *buffer,
			   size_t count, u16 offset, u8 reg_width);
	void (*block_write)(struct bcma_device *core, const void *buffer,
			    size_t count, u16 offset, u8 reg_width);
#endif
	/* Agent ops */
	u32 (*aread32)(struct bcma_device *core, u16 offset);
	void (*awrite32)(struct bcma_device *core, u16 offset, u32 value);
};

/* Core manufacturers */
#define BCMA_MANUF_ARM			0x43B
#define BCMA_MANUF_MIPS			0x4A7
#define BCMA_MANUF_BCM			0x4BF

/* Core class values. */
#define BCMA_CL_SIM			0x0
#define BCMA_CL_EROM			0x1
#define BCMA_CL_CORESIGHT		0x9
#define BCMA_CL_VERIF			0xB
#define BCMA_CL_OPTIMO			0xD
#define BCMA_CL_GEN			0xE
#define BCMA_CL_PRIMECELL		0xF

/* Core-ID values. */
#define BCMA_CORE_OOB_ROUTER		0x367	/* Out of band */
#define BCMA_CORE_4706_CHIPCOMMON	0x500
#define BCMA_CORE_NS_PCIEG2		0x501
#define BCMA_CORE_NS_DMA		0x502
#define BCMA_CORE_NS_SDIO3		0x503
#define BCMA_CORE_NS_USB20		0x504
#define BCMA_CORE_NS_USB30		0x505
#define BCMA_CORE_NS_A9JTAG		0x506
#define BCMA_CORE_NS_DDR23		0x507
#define BCMA_CORE_NS_ROM		0x508
#define BCMA_CORE_NS_NAND		0x509
#define BCMA_CORE_NS_QSPI		0x50A
#define BCMA_CORE_NS_CHIPCOMMON_B	0x50B
#define BCMA_CORE_4706_SOC_RAM		0x50E
#define BCMA_CORE_ARMCA9		0x510
#define BCMA_CORE_4706_MAC_GBIT		0x52D
#define BCMA_CORE_AMEMC			0x52E	/* DDR1/2 memory controller core */
#define BCMA_CORE_ALTA			0x534	/* I2S core */
#define BCMA_CORE_4706_MAC_GBIT_COMMON	0x5DC
#define BCMA_CORE_DDR23_PHY		0x5DD
#define BCMA_CORE_INVALID		0x700
#define BCMA_CORE_CHIPCOMMON		0x800
#define BCMA_CORE_ILINE20		0x801
#define BCMA_CORE_SRAM			0x802
#define BCMA_CORE_SDRAM			0x803
#define BCMA_CORE_PCI			0x804
#define BCMA_CORE_MIPS			0x805
#define BCMA_CORE_ETHERNET		0x806
#define BCMA_CORE_V90			0x807
#define BCMA_CORE_USB11_HOSTDEV		0x808
#define BCMA_CORE_ADSL			0x809
#define BCMA_CORE_ILINE100		0x80A
#define BCMA_CORE_IPSEC			0x80B
#define BCMA_CORE_UTOPIA		0x80C
#define BCMA_CORE_PCMCIA		0x80D
#define BCMA_CORE_INTERNAL_MEM		0x80E
#define BCMA_CORE_MEMC_SDRAM		0x80F
#define BCMA_CORE_OFDM			0x810
#define BCMA_CORE_EXTIF			0x811
#define BCMA_CORE_80211			0x812
#define BCMA_CORE_PHY_A			0x813
#define BCMA_CORE_PHY_B			0x814
#define BCMA_CORE_PHY_G			0x815
#define BCMA_CORE_MIPS_3302		0x816
#define BCMA_CORE_USB11_HOST		0x817
#define BCMA_CORE_USB11_DEV		0x818
#define BCMA_CORE_USB20_HOST		0x819
#define BCMA_CORE_USB20_DEV		0x81A
#define BCMA_CORE_SDIO_HOST		0x81B
#define BCMA_CORE_ROBOSWITCH		0x81C
#define BCMA_CORE_PARA_ATA		0x81D
#define BCMA_CORE_SATA_XORDMA		0x81E
#define BCMA_CORE_ETHERNET_GBIT		0x81F
#define BCMA_CORE_PCIE			0x820
#define BCMA_CORE_PHY_N			0x821
#define BCMA_CORE_SRAM_CTL		0x822
#define BCMA_CORE_MINI_MACPHY		0x823
#define BCMA_CORE_ARM_1176		0x824
#define BCMA_CORE_ARM_7TDMI		0x825
#define BCMA_CORE_PHY_LP		0x826
#define BCMA_CORE_PMU			0x827
#define BCMA_CORE_PHY_SSN		0x828
#define BCMA_CORE_SDIO_DEV		0x829
#define BCMA_CORE_ARM_CM3		0x82A
#define BCMA_CORE_PHY_HT		0x82B
#define BCMA_CORE_MIPS_74K		0x82C
#define BCMA_CORE_MAC_GBIT		0x82D
#define BCMA_CORE_DDR12_MEM_CTL		0x82E
#define BCMA_CORE_PCIE_RC		0x82F	/* PCIe Root Complex */
#define BCMA_CORE_OCP_OCP_BRIDGE	0x830
#define BCMA_CORE_SHARED_COMMON		0x831
#define BCMA_CORE_OCP_AHB_BRIDGE	0x832
#define BCMA_CORE_SPI_HOST		0x833
#define BCMA_CORE_I2S			0x834
#define BCMA_CORE_SDR_DDR1_MEM_CTL	0x835	/* SDR/DDR1 memory controller core */
#define BCMA_CORE_SHIM			0x837	/* SHIM component in ubus/6362 */
#define BCMA_CORE_PHY_AC		0x83B
#define BCMA_CORE_PCIE2			0x83C	/* PCI Express Gen2 */
#define BCMA_CORE_USB30_DEV		0x83D
#define BCMA_CORE_ARM_CR4		0x83E
#define BCMA_CORE_GCI			0x840
#define BCMA_CORE_CMEM			0x846	/* CNDS DDR2/3 memory controller */
#define BCMA_CORE_ARM_CA7		0x847
#define BCMA_CORE_SYS_MEM		0x849
#define BCMA_CORE_DEFAULT		0xFFF

#define BCMA_MAX_NR_CORES		16

/* Chip IDs of PCIe devices */
#define BCMA_CHIP_ID_BCM4313	0x4313
#define BCMA_CHIP_ID_BCM43142	43142
#define BCMA_CHIP_ID_BCM43131	43131
#define BCMA_CHIP_ID_BCM43217	43217
#define BCMA_CHIP_ID_BCM43222	43222
#define BCMA_CHIP_ID_BCM43224	43224
#define  BCMA_PKG_ID_BCM43224_FAB_CSM	0x8
#define  BCMA_PKG_ID_BCM43224_FAB_SMIC	0xa
#define BCMA_CHIP_ID_BCM43225	43225
#define BCMA_CHIP_ID_BCM43227	43227
#define BCMA_CHIP_ID_BCM43228	43228
#define BCMA_CHIP_ID_BCM43421	43421
#define BCMA_CHIP_ID_BCM43428	43428
#define BCMA_CHIP_ID_BCM43431	43431
#define BCMA_CHIP_ID_BCM43460	43460
#define BCMA_CHIP_ID_BCM4331	0x4331
#define BCMA_CHIP_ID_BCM6362	0x6362
#define BCMA_CHIP_ID_BCM4360	0x4360
#define BCMA_CHIP_ID_BCM4352	0x4352

/* Chip IDs of SoCs */
#define BCMA_CHIP_ID_BCM4706	0x5300
#define  BCMA_PKG_ID_BCM4706L	1
#define BCMA_CHIP_ID_BCM4716	0x4716
#define  BCMA_PKG_ID_BCM4716	8
#define  BCMA_PKG_ID_BCM4717	9
#define  BCMA_PKG_ID_BCM4718	10
#define BCMA_CHIP_ID_BCM47162	47162
#define BCMA_CHIP_ID_BCM4748	0x4748
#define BCMA_CHIP_ID_BCM4749	0x4749
#define BCMA_CHIP_ID_BCM5356	0x5356
#define BCMA_CHIP_ID_BCM5357	0x5357
#define  BCMA_PKG_ID_BCM5358	9
#define  BCMA_PKG_ID_BCM47186	10
#define  BCMA_PKG_ID_BCM5357	11
#define BCMA_CHIP_ID_BCM53572	53572
#define  BCMA_PKG_ID_BCM47188	9
#define BCMA_CHIP_ID_BCM4707	53010
#define  BCMA_PKG_ID_BCM4707	1
#define  BCMA_PKG_ID_BCM4708	2
#define  BCMA_PKG_ID_BCM4709	0
#define BCMA_CHIP_ID_BCM53018	53018

/* Board types (on PCI usually equals to the subsystem dev id) */
/* BCM4313 */
#define BCMA_BOARD_TYPE_BCM94313BU	0X050F
#define BCMA_BOARD_TYPE_BCM94313HM	0X0510
#define BCMA_BOARD_TYPE_BCM94313EPA	0X0511
#define BCMA_BOARD_TYPE_BCM94313HMG	0X051C
/* BCM4716 */
#define BCMA_BOARD_TYPE_BCM94716NR2	0X04CD
/* BCM43224 */
#define BCMA_BOARD_TYPE_BCM943224X21	0X056E
#define BCMA_BOARD_TYPE_BCM943224X21_FCC	0X00D1
#define BCMA_BOARD_TYPE_BCM943224X21B	0X00E9
#define BCMA_BOARD_TYPE_BCM943224M93	0X008B
#define BCMA_BOARD_TYPE_BCM943224M93A	0X0090
#define BCMA_BOARD_TYPE_BCM943224X16	0X0093
#define BCMA_BOARD_TYPE_BCM94322X9	0X008D
#define BCMA_BOARD_TYPE_BCM94322M35E	0X008E
/* BCM43228 */
#define BCMA_BOARD_TYPE_BCM943228BU8	0X0540
#define BCMA_BOARD_TYPE_BCM943228BU9	0X0541
#define BCMA_BOARD_TYPE_BCM943228BU	0X0542
#define BCMA_BOARD_TYPE_BCM943227HM4L	0X0543
#define BCMA_BOARD_TYPE_BCM943227HMB	0X0544
#define BCMA_BOARD_TYPE_BCM943228HM4L	0X0545
#define BCMA_BOARD_TYPE_BCM943228SD	0X0573
/* BCM4331 */
#define BCMA_BOARD_TYPE_BCM94331X19	0X00D6
#define BCMA_BOARD_TYPE_BCM94331X28	0X00E4
#define BCMA_BOARD_TYPE_BCM94331X28B	0X010E
#define BCMA_BOARD_TYPE_BCM94331PCIEBT3AX	0X00E4
#define BCMA_BOARD_TYPE_BCM94331X12_2G	0X00EC
#define BCMA_BOARD_TYPE_BCM94331X12_5G	0X00ED
#define BCMA_BOARD_TYPE_BCM94331X29B	0X00EF
#define BCMA_BOARD_TYPE_BCM94331CSAX	0X00EF
#define BCMA_BOARD_TYPE_BCM94331X19C	0X00F5
#define BCMA_BOARD_TYPE_BCM94331X33	0X00F4
#define BCMA_BOARD_TYPE_BCM94331BU	0X0523
#define BCMA_BOARD_TYPE_BCM94331S9BU	0X0524
#define BCMA_BOARD_TYPE_BCM94331MC	0X0525
#define BCMA_BOARD_TYPE_BCM94331MCI	0X0526
#define BCMA_BOARD_TYPE_BCM94331PCIEBT4	0X0527
#define BCMA_BOARD_TYPE_BCM94331HM	0X0574
#define BCMA_BOARD_TYPE_BCM94331PCIEDUAL	0X059B
#define BCMA_BOARD_TYPE_BCM94331MCH5	0X05A9
#define BCMA_BOARD_TYPE_BCM94331CS	0X05C6
#define BCMA_BOARD_TYPE_BCM94331CD	0X05DA
/* BCM53572 */
#define BCMA_BOARD_TYPE_BCM953572BU	0X058D
#define BCMA_BOARD_TYPE_BCM953572NR2	0X058E
#define BCMA_BOARD_TYPE_BCM947188NR2	0X058F
#define BCMA_BOARD_TYPE_BCM953572SDRNR2	0X0590
/* BCM43142 */
#define BCMA_BOARD_TYPE_BCM943142HM	0X05E0

struct bcma_device {
	struct bcma_bus *bus;
	struct bcma_device_id id;

	struct device dev;
	struct device *dma_dev;

	unsigned int irq;
	bool dev_registered;

	u8 core_index;
	u8 core_unit;

	u32 addr;
	u32 addr_s[8];
	u32 wrap;

	void __iomem *io_addr;
	void __iomem *io_wrap;

	void *drvdata;
	struct list_head list;
};

static inline void *bcma_get_drvdata(struct bcma_device *core)
{
	return core->drvdata;
}
static inline void bcma_set_drvdata(struct bcma_device *core, void *drvdata)
{
	core->drvdata = drvdata;
}

struct bcma_driver {
	const char *name;
	const struct bcma_device_id *id_table;

	int (*probe)(struct bcma_device *dev);
	void (*remove)(struct bcma_device *dev);
	int (*suspend)(struct bcma_device *dev);
	int (*resume)(struct bcma_device *dev);
	void (*shutdown)(struct bcma_device *dev);

	struct device_driver drv;
};
extern
int __bcma_driver_register(struct bcma_driver *drv, struct module *owner);
#define bcma_driver_register(drv) \
	__bcma_driver_register(drv, THIS_MODULE)

extern void bcma_driver_unregister(struct bcma_driver *drv);

/* module_bcma_driver() - Helper macro for drivers that don't do
 * anything special in module init/exit.  This eliminates a lot of
 * boilerplate.  Each module may only use this macro once, and
 * calling it replaces module_init() and module_exit()
 */
#define module_bcma_driver(__bcma_driver) \
	module_driver(__bcma_driver, bcma_driver_register, \
			bcma_driver_unregister)

/* Set a fallback SPROM.
 * See kdoc at the function definition for complete documentation. */
extern int bcma_arch_register_fallback_sprom(
		int (*sprom_callback)(struct bcma_bus *bus,
		struct ssb_sprom *out));

struct bcma_bus {
	/* The MMIO area. */
	void __iomem *mmio;

	const struct bcma_host_ops *ops;

	enum bcma_hosttype hosttype;
	bool host_is_pcie2; /* Used for BCMA_HOSTTYPE_PCI only */
	union {
		/* Pointer to the PCI bus (only for BCMA_HOSTTYPE_PCI) */
		struct pci_dev *host_pci;
		/* Pointer to the SDIO device (only for BCMA_HOSTTYPE_SDIO) */
		struct sdio_func *host_sdio;
		/* Pointer to platform device (only for BCMA_HOSTTYPE_SOC) */
		struct platform_device *host_pdev;
	};

	struct bcma_chipinfo chipinfo;

	struct bcma_boardinfo boardinfo;

	struct bcma_device *mapped_core;
	struct list_head cores;
	u8 nr_cores;
	u8 num;

	struct bcma_drv_cc drv_cc;
	struct bcma_drv_cc_b drv_cc_b;
	struct bcma_drv_pci drv_pci[2];
	struct bcma_drv_pcie2 drv_pcie2;
	struct bcma_drv_mips drv_mips;
	struct bcma_drv_gmac_cmn drv_gmac_cmn;

	/* We decided to share SPROM struct with SSB as long as we do not need
	 * any hacks for BCMA. This simplifies drivers code. */
	struct ssb_sprom sprom;
};

static inline u32 bcma_read8(struct bcma_device *core, u16 offset)
{
	return core->bus->ops->read8(core, offset);
}
static inline u32 bcma_read16(struct bcma_device *core, u16 offset)
{
	return core->bus->ops->read16(core, offset);
}
static inline u32 bcma_read32(struct bcma_device *core, u16 offset)
{
	return core->bus->ops->read32(core, offset);
}
static inline
void bcma_write8(struct bcma_device *core, u16 offset, u32 value)
{
	core->bus->ops->write8(core, offset, value);
}
static inline
void bcma_write16(struct bcma_device *core, u16 offset, u32 value)
{
	core->bus->ops->write16(core, offset, value);
}
static inline
void bcma_write32(struct bcma_device *core, u16 offset, u32 value)
{
	core->bus->ops->write32(core, offset, value);
}
#ifdef CONFIG_BCMA_BLOCKIO
static inline void bcma_block_read(struct bcma_device *core, void *buffer,
				   size_t count, u16 offset, u8 reg_width)
{
	core->bus->ops->block_read(core, buffer, count, offset, reg_width);
}
static inline void bcma_block_write(struct bcma_device *core,
				    const void *buffer, size_t count,
				    u16 offset, u8 reg_width)
{
	core->bus->ops->block_write(core, buffer, count, offset, reg_width);
}
#endif
static inline u32 bcma_aread32(struct bcma_device *core, u16 offset)
{
	return core->bus->ops->aread32(core, offset);
}
static inline
void bcma_awrite32(struct bcma_device *core, u16 offset, u32 value)
{
	core->bus->ops->awrite32(core, offset, value);
}

static inline void bcma_mask32(struct bcma_device *cc, u16 offset, u32 mask)
{
	bcma_write32(cc, offset, bcma_read32(cc, offset) & mask);
}
static inline void bcma_set32(struct bcma_device *cc, u16 offset, u32 set)
{
	bcma_write32(cc, offset, bcma_read32(cc, offset) | set);
}
static inline void bcma_maskset32(struct bcma_device *cc,
				  u16 offset, u32 mask, u32 set)
{
	bcma_write32(cc, offset, (bcma_read32(cc, offset) & mask) | set);
}
static inline void bcma_mask16(struct bcma_device *cc, u16 offset, u16 mask)
{
	bcma_write16(cc, offset, bcma_read16(cc, offset) & mask);
}
static inline void bcma_set16(struct bcma_device *cc, u16 offset, u16 set)
{
	bcma_write16(cc, offset, bcma_read16(cc, offset) | set);
}
static inline void bcma_maskset16(struct bcma_device *cc,
				  u16 offset, u16 mask, u16 set)
{
	bcma_write16(cc, offset, (bcma_read16(cc, offset) & mask) | set);
}

extern struct bcma_device *bcma_find_core_unit(struct bcma_bus *bus, u16 coreid,
					       u8 unit);
static inline struct bcma_device *bcma_find_core(struct bcma_bus *bus,
						 u16 coreid)
{
	return bcma_find_core_unit(bus, coreid, 0);
}

#ifdef CONFIG_BCMA_HOST_PCI
extern void bcma_host_pci_up(struct bcma_bus *bus);
extern void bcma_host_pci_down(struct bcma_bus *bus);
extern int bcma_host_pci_irq_ctl(struct bcma_bus *bus,
				 struct bcma_device *core, bool enable);
#else
static inline void bcma_host_pci_up(struct bcma_bus *bus)
{
}
static inline void bcma_host_pci_down(struct bcma_bus *bus)
{
}
static inline int bcma_host_pci_irq_ctl(struct bcma_bus *bus,
					struct bcma_device *core, bool enable)
{
	if (bus->hosttype == BCMA_HOSTTYPE_PCI)
		return -ENOTSUPP;
	return 0;
}
#endif

extern bool bcma_core_is_enabled(struct bcma_device *core);
extern void bcma_core_disable(struct bcma_device *core, u32 flags);
extern int bcma_core_enable(struct bcma_device *core, u32 flags);
extern void bcma_core_set_clockmode(struct bcma_device *core,
				    enum bcma_clkmode clkmode);
extern void bcma_core_pll_ctl(struct bcma_device *core, u32 req, u32 status,
			      bool on);
extern u32 bcma_chipco_pll_read(struct bcma_drv_cc *cc, u32 offset);
#define BCMA_DMA_TRANSLATION_MASK	0xC0000000
#define  BCMA_DMA_TRANSLATION_NONE	0x00000000
#define  BCMA_DMA_TRANSLATION_DMA32_CMT	0x40000000 /* Client Mode Translation for 32-bit DMA */
#define  BCMA_DMA_TRANSLATION_DMA64_CMT	0x80000000 /* Client Mode Translation for 64-bit DMA */
extern u32 bcma_core_dma_translation(struct bcma_device *core);

extern unsigned int bcma_core_irq(struct bcma_device *core, int num);

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