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

#ifndef LINUX_SSB_H_
#define LINUX_SSB_H_

#include <linux/device.h>
#include <linux/list.h>
#include <linux/types.h>
#include <linux/spinlock.h>
#include <linux/pci.h>
#include <linux/mod_devicetable.h>

#include <linux/ssb/ssb_regs.h>


struct pcmcia_device;
struct ssb_bus;
struct ssb_driver;

struct ssb_sprom {
	u8 revision;
	u8 il0mac[6];		/* MAC address for 802.11b/g */
	u8 et0mac[6];		/* MAC address for Ethernet */
	u8 et1mac[6];		/* MAC address for 802.11a */
	u8 et0phyaddr;		/* MII address for enet0 */
	u8 et1phyaddr;		/* MII address for enet1 */
	u8 et0mdcport;		/* MDIO for enet0 */
	u8 et1mdcport;		/* MDIO for enet1 */
	u8 board_rev;		/* Board revision number from SPROM. */
	u8 country_code;	/* Country Code */
	u8 ant_available_a;	/* A-PHY antenna available bits (up to 4) */
	u8 ant_available_bg;	/* B/G-PHY antenna available bits (up to 4) */
	u16 pa0b0;
	u16 pa0b1;
	u16 pa0b2;
	u16 pa1b0;
	u16 pa1b1;
	u16 pa1b2;
	u8 gpio0;		/* GPIO pin 0 */
	u8 gpio1;		/* GPIO pin 1 */
	u8 gpio2;		/* GPIO pin 2 */
	u8 gpio3;		/* GPIO pin 3 */
	u16 maxpwr_a;		/* A-PHY Amplifier Max Power (in dBm Q5.2) */
	u16 maxpwr_bg;		/* B/G-PHY Amplifier Max Power (in dBm Q5.2) */
	u8 itssi_a;		/* Idle TSSI Target for A-PHY */
	u8 itssi_bg;		/* Idle TSSI Target for B/G-PHY */
	u16 boardflags_lo;	/* Boardflags (low 16 bits) */
	u16 boardflags_hi;	/* Boardflags (high 16 bits) */

	/* Antenna gain values for up to 4 antennas
	 * on each band. Values in dBm/4 (Q5.2). Negative gain means the
	 * loss in the connectors is bigger than the gain. */
	struct {
		struct {
			s8 a0, a1, a2, a3;
		} ghz24;	/* 2.4GHz band */
		struct {
			s8 a0, a1, a2, a3;
		} ghz5;		/* 5GHz band */
	} antenna_gain;

	/* TODO - add any parameters needed from rev 2, 3, or 4 SPROMs */
};

/* Information about the PCB the circuitry is soldered on. */
struct ssb_boardinfo {
	u16 vendor;
	u16 type;
	u16 rev;
};


struct ssb_device;
/* Lowlevel read/write operations on the device MMIO.
 * Internal, don't use that outside of ssb. */
struct ssb_bus_ops {
	u8 (*read8)(struct ssb_device *dev, u16 offset);
	u16 (*read16)(struct ssb_device *dev, u16 offset);
	u32 (*read32)(struct ssb_device *dev, u16 offset);
	void (*write8)(struct ssb_device *dev, u16 offset, u8 value);
	void (*write16)(struct ssb_device *dev, u16 offset, u16 value);
	void (*write32)(struct ssb_device *dev, u16 offset, u32 value);
};


/* Core-ID values. */
#define SSB_DEV_CHIPCOMMON	0x800
#define SSB_DEV_ILINE20		0x801
#define SSB_DEV_SDRAM		0x803
#define SSB_DEV_PCI		0x804
#define SSB_DEV_MIPS		0x805
#define SSB_DEV_ETHERNET	0x806
#define SSB_DEV_V90		0x807
#define SSB_DEV_USB11_HOSTDEV	0x808
#define SSB_DEV_ADSL		0x809
#define SSB_DEV_ILINE100	0x80A
#define SSB_DEV_IPSEC		0x80B
#define SSB_DEV_PCMCIA		0x80D
#define SSB_DEV_INTERNAL_MEM	0x80E
#define SSB_DEV_MEMC_SDRAM	0x80F
#define SSB_DEV_EXTIF		0x811
#define SSB_DEV_80211		0x812
#define SSB_DEV_MIPS_3302	0x816
#define SSB_DEV_USB11_HOST	0x817
#define SSB_DEV_USB11_DEV	0x818
#define SSB_DEV_USB20_HOST	0x819
#define SSB_DEV_USB20_DEV	0x81A
#define SSB_DEV_SDIO_HOST	0x81B
#define SSB_DEV_ROBOSWITCH	0x81C
#define SSB_DEV_PARA_ATA	0x81D
#define SSB_DEV_SATA_XORDMA	0x81E
#define SSB_DEV_ETHERNET_GBIT	0x81F
#define SSB_DEV_PCIE		0x820
#define SSB_DEV_MIMO_PHY	0x821
#define SSB_DEV_SRAM_CTRLR	0x822
#define SSB_DEV_MINI_MACPHY	0x823
#define SSB_DEV_ARM_1176	0x824
#define SSB_DEV_ARM_7TDMI	0x825

/* Vendor-ID values */
#define SSB_VENDOR_BROADCOM	0x4243

/* Some kernel subsystems poke with dev->drvdata, so we must use the
 * following ugly workaround to get from struct device to struct ssb_device */
struct __ssb_dev_wrapper {
	struct device dev;
	struct ssb_device *sdev;
};

struct ssb_device {
	/* Having a copy of the ops pointer in each dev struct
	 * is an optimization. */
	const struct ssb_bus_ops *ops;

	struct device *dev;
	struct ssb_bus *bus;
	struct ssb_device_id id;

	u8 core_index;
	unsigned int irq;

	/* Internal-only stuff follows. */
	void *drvdata;		/* Per-device data */
	void *devtypedata;	/* Per-devicetype (eg 802.11) data */
};

/* Go from struct device to struct ssb_device. */
static inline
struct ssb_device * dev_to_ssb_dev(struct device *dev)
{
	struct __ssb_dev_wrapper *wrap;
	wrap = container_of(dev, struct __ssb_dev_wrapper, dev);
	return wrap->sdev;
}

/* Device specific user data */
static inline
void ssb_set_drvdata(struct ssb_device *dev, void *data)
{
	dev->drvdata = data;
}
static inline
void * ssb_get_drvdata(struct ssb_device *dev)
{
	return dev->drvdata;
}

/* Devicetype specific user data. This is per device-type (not per device) */
void ssb_set_devtypedata(struct ssb_device *dev, void *data);
static inline
void * ssb_get_devtypedata(struct ssb_device *dev)
{
	return dev->devtypedata;
}


struct ssb_driver {
	const char *name;
	const struct ssb_device_id *id_table;

	int (*probe)(struct ssb_device *dev, const struct ssb_device_id *id);
	void (*remove)(struct ssb_device *dev);
	int (*suspend)(struct ssb_device *dev, pm_message_t state);
	int (*resume)(struct ssb_device *dev);
	void (*shutdown)(struct ssb_device *dev);

	struct device_driver drv;
};
#define drv_to_ssb_drv(_drv) container_of(_drv, struct ssb_driver, drv)

extern int __ssb_driver_register(struct ssb_driver *drv, struct module *owner);
static inline int ssb_driver_register(struct ssb_driver *drv)
{
	return __ssb_driver_register(drv, THIS_MODULE);
}
extern void ssb_driver_unregister(struct ssb_driver *drv);


enum ssb_bustype {
	SSB_BUSTYPE_SSB,	/* This SSB bus is the system bus */
	SSB_BUSTYPE_PCI,	/* SSB is connected to PCI bus */
	SSB_BUSTYPE_PCMCIA,	/* SSB is connected to PCMCIA bus */
};

/* board_vendor */
#define SSB_BOARDVENDOR_BCM	0x14E4	/* Broadcom */
#define SSB_BOARDVENDOR_DELL	0x1028	/* Dell */
#define SSB_BOARDVENDOR_HP	0x0E11	/* HP */
/* board_type */
#define SSB_BOARD_BCM94306MP	0x0418
#define SSB_BOARD_BCM4309G	0x0421
#define SSB_BOARD_BCM4306CB	0x0417
#define SSB_BOARD_BCM4309MP	0x040C
#define SSB_BOARD_MP4318	0x044A
#define SSB_BOARD_BU4306	0x0416
#define SSB_BOARD_BU4309	0x040A
/* chip_package */
#define SSB_CHIPPACK_BCM4712S	1	/* Small 200pin 4712 */
#define SSB_CHIPPACK_BCM4712M	2	/* Medium 225pin 4712 */
#define SSB_CHIPPACK_BCM4712L	0	/* Large 340pin 4712 */

#include <linux/ssb/ssb_driver_chipcommon.h>
#include <linux/ssb/ssb_driver_mips.h>
#include <linux/ssb/ssb_driver_extif.h>
#include <linux/ssb/ssb_driver_pci.h>

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

	const struct ssb_bus_ops *ops;

	/* The core in the basic address register window. (PCI bus only) */
	struct ssb_device *mapped_device;
	/* Currently mapped PCMCIA segment. (bustype == SSB_BUSTYPE_PCMCIA only) */
	u8 mapped_pcmcia_seg;
	/* Lock for core and segment switching.
	 * On PCMCIA-host busses this is used to protect the whole MMIO access. */
	spinlock_t bar_lock;

	/* The bus this backplane is running on. */
	enum ssb_bustype bustype;
	/* Pointer to the PCI bus (only valid if bustype == SSB_BUSTYPE_PCI). */
	struct pci_dev *host_pci;
	/* Pointer to the PCMCIA device (only if bustype == SSB_BUSTYPE_PCMCIA). */
	struct pcmcia_device *host_pcmcia;

#ifdef CONFIG_SSB_SPROM
	/* Mutex to protect the SPROM writing. */
	struct mutex sprom_mutex;
#endif

	/* ID information about the Chip. */
	u16 chip_id;
	u16 chip_rev;
	u16 sprom_size;		/* number of words in sprom */
	u8 chip_package;

	/* List of devices (cores) on the backplane. */
	struct ssb_device devices[SSB_MAX_NR_CORES];
	u8 nr_devices;

	/* Software ID number for this bus. */
	unsigned int busnumber;

	/* The ChipCommon device (if available). */
	struct ssb_chipcommon chipco;
	/* The PCI-core device (if available). */
	struct ssb_pcicore pcicore;
	/* The MIPS-core device (if available). */
	struct ssb_mipscore mipscore;
	/* The EXTif-core device (if available). */
	struct ssb_extif extif;

	/* The following structure elements are not available in early
	 * SSB initialization. Though, they are available for regular
	 * registered drivers at any stage. So be careful when
	 * using them in the ssb core code. */

	/* ID information about the PCB. */
	struct ssb_boardinfo boardinfo;
	/* Contents of the SPROM. */
	struct ssb_sprom sprom;
	/* If the board has a cardbus slot, this is set to true. */
	bool has_cardbus_slot;

#ifdef CONFIG_SSB_EMBEDDED
	/* Lock for GPIO register access. */
	spinlock_t gpio_lock;
#endif /* EMBEDDED */

	/* Internal-only stuff follows. Do not touch. */
	struct list_head list;
#ifdef CONFIG_SSB_DEBUG
	/* Is the bus already powered up? */
	bool powered_up;
	int power_warn_count;
#endif /* DEBUG */
};

/* The initialization-invariants. */
struct ssb_init_invariants {
	/* Versioning information about the PCB. */
	struct ssb_boardinfo boardinfo;
	/* The SPROM information. That's either stored in an
	 * EEPROM or NVRAM on the board. */
	struct ssb_sprom sprom;
	/* If the board has a cardbus slot, this is set to true. */
	bool has_cardbus_slot;
};
/* Type of function to fetch the invariants. */
typedef int (*ssb_invariants_func_t)(struct ssb_bus *bus,
				     struct ssb_init_invariants *iv);

/* Register a SSB system bus. get_invariants() is called after the
 * basic system devices are initialized.
 * The invariants are usually fetched from some NVRAM.
 * Put the invariants into the struct pointed to by iv. */
extern int ssb_bus_ssbbus_register(struct ssb_bus *bus,
				   unsigned long baseaddr,
				   ssb_invariants_func_t get_invariants);
#ifdef CONFIG_SSB_PCIHOST
extern int ssb_bus_pcibus_register(struct ssb_bus *bus,
				   struct pci_dev *host_pci);
#endif /* CONFIG_SSB_PCIHOST */
#ifdef CONFIG_SSB_PCMCIAHOST
extern int ssb_bus_pcmciabus_register(struct ssb_bus *bus,
				      struct pcmcia_device *pcmcia_dev,
				      unsigned long baseaddr);
#endif /* CONFIG_SSB_PCMCIAHOST */

extern void ssb_bus_unregister(struct ssb_bus *bus);

/* Suspend a SSB bus.
 * Call this from the parent bus suspend routine. */
extern int ssb_bus_suspend(struct ssb_bus *bus);
/* Resume a SSB bus.
 * Call this from the parent bus resume routine. */
extern int ssb_bus_resume(struct ssb_bus *bus);

extern u32 ssb_clockspeed(struct ssb_bus *bus);

/* Is the device enabled in hardware? */
int ssb_device_is_enabled(struct ssb_device *dev);
/* Enable a device and pass device-specific SSB_TMSLOW flags.
 * If no device-specific flags are available, use 0. */
void ssb_device_enable(struct ssb_device *dev, u32 core_specific_flags);
/* Disable a device in hardware and pass SSB_TMSLOW flags (if any). */
void ssb_device_disable(struct ssb_device *dev, u32 core_specific_flags);


/* Device MMIO register read/write functions. */
static inline u8 ssb_read8(struct ssb_device *dev, u16 offset)
{
	return dev->ops->read8(dev, offset);
}
static inline u16 ssb_read16(struct ssb_device *dev, u16 offset)
{
	return dev->ops->read16(dev, offset);
}
static inline u32 ssb_read32(struct ssb_device *dev, u16 offset)
{
	return dev->ops->read32(dev, offset);
}
static inline void ssb_write8(struct ssb_device *dev, u16 offset, u8 value)
{
	dev->ops->write8(dev, offset, value);
}
static inline void ssb_write16(struct ssb_device *dev, u16 offset, u16 value)
{
	dev->ops->write16(dev, offset, value);
}
static inline void ssb_write32(struct ssb_device *dev, u16 offset, u32 value)
{
	dev->ops->write32(dev, offset, value);
}


/* Translation (routing) bits that need to be ORed to DMA
 * addresses before they are given to a device. */
extern u32 ssb_dma_translation(struct ssb_device *dev);
#define SSB_DMA_TRANSLATION_MASK	0xC0000000
#define SSB_DMA_TRANSLATION_SHIFT	30

extern int ssb_dma_set_mask(struct ssb_device *ssb_dev, u64 mask);


#ifdef CONFIG_SSB_PCIHOST
/* PCI-host wrapper driver */
extern int ssb_pcihost_register(struct pci_driver *driver);
static inline void ssb_pcihost_unregister(struct pci_driver *driver)
{
	pci_unregister_driver(driver);
}

static inline
void ssb_pcihost_set_power_state(struct ssb_device *sdev, pci_power_t state)
{
	if (sdev->bus->bustype == SSB_BUSTYPE_PCI)
		pci_set_power_state(sdev->bus->host_pci, state);
}
#else
static inline void ssb_pcihost_unregister(struct pci_driver *driver)
{
}

static inline
void ssb_pcihost_set_power_state(struct ssb_device *sdev, pci_power_t state)
{
}
#endif /* CONFIG_SSB_PCIHOST */


/* If a driver is shutdown or suspended, call this to signal
 * that the bus may be completely powered down. SSB will decide,
 * if it's really time to power down the bus, based on if there
 * are other devices that want to run. */
extern int ssb_bus_may_powerdown(struct ssb_bus *bus);
/* Before initializing and enabling a device, call this to power-up the bus.
 * If you want to allow use of dynamic-power-control, pass the flag.
 * Otherwise static always-on powercontrol will be used. */
extern int ssb_bus_powerup(struct ssb_bus *bus, bool dynamic_pctl);


/* Various helper functions */
extern u32 ssb_admatch_base(u32 adm);
extern u32 ssb_admatch_size(u32 adm);

/* PCI device mapping and fixup routines.
 * Called from the architecture pcibios init code.
 * These are only available on SSB_EMBEDDED configurations. */
#ifdef CONFIG_SSB_EMBEDDED
int ssb_pcibios_plat_dev_init(struct pci_dev *dev);
int ssb_pcibios_map_irq(const struct pci_dev *dev, u8 slot, u8 pin);
#endif /* CONFIG_SSB_EMBEDDED */

#endif /* LINUX_SSB_H_ */
Commit	Line	Data
61e115a5 MB	1	#ifndef LINUX_SSB_H_
	2	#define LINUX_SSB_H_
	3
	4	#include <linux/device.h>
	5	#include <linux/list.h>
	6	#include <linux/types.h>
	7	#include <linux/spinlock.h>
	8	#include <linux/pci.h>
	9	#include <linux/mod_devicetable.h>
	10
	11	#include <linux/ssb/ssb_regs.h>
	12
	13
	14	struct pcmcia_device;
	15	struct ssb_bus;
	16	struct ssb_driver;
	17
61e115a5 MB	18	struct ssb_sprom {
61e115a5 MB	19	u8 revision;
ac82fab4 LF	20	u8 il0mac[6]; /* MAC address for 802.11b/g */
	21	u8 et0mac[6]; /* MAC address for Ethernet */
	22	u8 et1mac[6]; /* MAC address for 802.11a */
	23	u8 et0phyaddr; /* MII address for enet0 */
	24	u8 et1phyaddr; /* MII address for enet1 */
e861b98d MB	25	u8 et0mdcport; /* MDIO for enet0 */
	26	u8 et1mdcport; /* MDIO for enet1 */
	27	u8 board_rev; /* Board revision number from SPROM. */
ac82fab4	28	u8 country_code; /* Country Code */
e861b98d MB	29	u8 ant_available_a; /* A-PHY antenna available bits (up to 4) */
e861b98d MB	30	u8 ant_available_bg; /* B/G-PHY antenna available bits (up to 4) */
ac82fab4 LF	31	u16 pa0b0;
	32	u16 pa0b1;
	33	u16 pa0b2;
	34	u16 pa1b0;
	35	u16 pa1b1;
	36	u16 pa1b2;
	37	u8 gpio0; /* GPIO pin 0 */
	38	u8 gpio1; /* GPIO pin 1 */
	39	u8 gpio2; /* GPIO pin 2 */
	40	u8 gpio3; /* GPIO pin 3 */
	41	u16 maxpwr_a; /* A-PHY Amplifier Max Power (in dBm Q5.2) */
	42	u16 maxpwr_bg; /* B/G-PHY Amplifier Max Power (in dBm Q5.2) */
	43	u8 itssi_a; /* Idle TSSI Target for A-PHY */
	44	u8 itssi_bg; /* Idle TSSI Target for B/G-PHY */
	45	u16 boardflags_lo; /* Boardflags (low 16 bits) */
af4b7450	46	u16 boardflags_hi; /* Boardflags (high 16 bits) */
e861b98d MB	47
	48	/* Antenna gain values for up to 4 antennas
	49	* on each band. Values in dBm/4 (Q5.2). Negative gain means the
	50	* loss in the connectors is bigger than the gain. */
	51	struct {
	52	struct {
	53	s8 a0, a1, a2, a3;
	54	} ghz24; /* 2.4GHz band */
	55	struct {
	56	s8 a0, a1, a2, a3;
	57	} ghz5; /* 5GHz band */
	58	} antenna_gain;
ac82fab4 LF	59
ac82fab4 LF	60	/* TODO - add any parameters needed from rev 2, 3, or 4 SPROMs */
61e115a5 MB	61	};
	62
	63	/* Information about the PCB the circuitry is soldered on. */
	64	struct ssb_boardinfo {
	65	u16 vendor;
	66	u16 type;
	67	u16 rev;
	68	};
	69
	70
	71	struct ssb_device;
	72	/* Lowlevel read/write operations on the device MMIO.
	73	* Internal, don't use that outside of ssb. */
	74	struct ssb_bus_ops {
ffc7689d	75	u8 (read8)(struct ssb_device dev, u16 offset);
61e115a5 MB	76	u16 (read16)(struct ssb_device dev, u16 offset);
61e115a5 MB	77	u32 (read32)(struct ssb_device dev, u16 offset);
ffc7689d	78	void (write8)(struct ssb_device dev, u16 offset, u8 value);
61e115a5 MB	79	void (write16)(struct ssb_device dev, u16 offset, u16 value);
	80	void (write32)(struct ssb_device dev, u16 offset, u32 value);
	81	};
	82
	83
	84	/* Core-ID values. */
	85	#define SSB_DEV_CHIPCOMMON 0x800
	86	#define SSB_DEV_ILINE20 0x801
	87	#define SSB_DEV_SDRAM 0x803
	88	#define SSB_DEV_PCI 0x804
	89	#define SSB_DEV_MIPS 0x805
	90	#define SSB_DEV_ETHERNET 0x806
	91	#define SSB_DEV_V90 0x807
	92	#define SSB_DEV_USB11_HOSTDEV 0x808
	93	#define SSB_DEV_ADSL 0x809
	94	#define SSB_DEV_ILINE100 0x80A
	95	#define SSB_DEV_IPSEC 0x80B
	96	#define SSB_DEV_PCMCIA 0x80D
	97	#define SSB_DEV_INTERNAL_MEM 0x80E
	98	#define SSB_DEV_MEMC_SDRAM 0x80F
	99	#define SSB_DEV_EXTIF 0x811
	100	#define SSB_DEV_80211 0x812
	101	#define SSB_DEV_MIPS_3302 0x816
	102	#define SSB_DEV_USB11_HOST 0x817
	103	#define SSB_DEV_USB11_DEV 0x818
	104	#define SSB_DEV_USB20_HOST 0x819
	105	#define SSB_DEV_USB20_DEV 0x81A
	106	#define SSB_DEV_SDIO_HOST 0x81B
	107	#define SSB_DEV_ROBOSWITCH 0x81C
	108	#define SSB_DEV_PARA_ATA 0x81D
	109	#define SSB_DEV_SATA_XORDMA 0x81E
	110	#define SSB_DEV_ETHERNET_GBIT 0x81F
	111	#define SSB_DEV_PCIE 0x820
	112	#define SSB_DEV_MIMO_PHY 0x821
	113	#define SSB_DEV_SRAM_CTRLR 0x822
	114	#define SSB_DEV_MINI_MACPHY 0x823
	115	#define SSB_DEV_ARM_1176 0x824
	116	#define SSB_DEV_ARM_7TDMI 0x825
	117
	118	/* Vendor-ID values */
	119	#define SSB_VENDOR_BROADCOM 0x4243
	120
	121	/* Some kernel subsystems poke with dev->drvdata, so we must use the
	122	* following ugly workaround to get from struct device to struct ssb_device */
	123	struct __ssb_dev_wrapper {
	124	struct device dev;
	125	struct ssb_device *sdev;
	126	};
	127
	128	struct ssb_device {
	129	/* Having a copy of the ops pointer in each dev struct
	130	* is an optimization. */
	131	const struct ssb_bus_ops *ops;
	132
	133	struct device *dev;
	134	struct ssb_bus *bus;
	135	struct ssb_device_id id;
	136
	137	u8 core_index;
	138	unsigned int irq;
	139
	140	/* Internal-only stuff follows. */
	141	void drvdata; / Per-device data */
	142	void devtypedata; / Per-devicetype (eg 802.11) data */
143	};
144
145	/* Go from struct device to struct ssb_device. */
146	static inline
147	struct ssb_device * dev_to_ssb_dev(struct device *dev)
148	{
149	struct __ssb_dev_wrapper *wrap;
150	wrap = container_of(dev, struct __ssb_dev_wrapper, dev);
151	return wrap->sdev;
152	}
153
154	/* Device specific user data */
155	static inline
156	void ssb_set_drvdata(struct ssb_device dev, void data)
157	{
158	dev->drvdata = data;
159	}
160	static inline
161	void * ssb_get_drvdata(struct ssb_device *dev)
162	{
163	return dev->drvdata;
164	}
165
166	/* Devicetype specific user data. This is per device-type (not per device) */
167	void ssb_set_devtypedata(struct ssb_device dev, void data);
168	static inline
169	void * ssb_get_devtypedata(struct ssb_device *dev)
170	{
171	return dev->devtypedata;
172	}
173
174
175	struct ssb_driver {
176	const char *name;
177	const struct ssb_device_id *id_table;
178
179	int (probe)(struct ssb_device dev, const struct ssb_device_id *id);
180	void (remove)(struct ssb_device dev);
181	int (suspend)(struct ssb_device dev, pm_message_t state);
182	int (resume)(struct ssb_device dev);
183	void (shutdown)(struct ssb_device dev);
184
185	struct device_driver drv;
186	};
187	#define drv_to_ssb_drv(_drv) container_of(_drv, struct ssb_driver, drv)
188
189	extern int __ssb_driver_register(struct ssb_driver drv, struct module owner);
190	static inline int ssb_driver_register(struct ssb_driver *drv)
191	{
192	return __ssb_driver_register(drv, THIS_MODULE);
193	}
194	extern void ssb_driver_unregister(struct ssb_driver *drv);
195
196
197
198
199	enum ssb_bustype {
200	SSB_BUSTYPE_SSB, /* This SSB bus is the system bus */
201	SSB_BUSTYPE_PCI, /* SSB is connected to PCI bus */
202	SSB_BUSTYPE_PCMCIA, /* SSB is connected to PCMCIA bus */
203	};
204
205	/* board_vendor */
206	#define SSB_BOARDVENDOR_BCM 0x14E4 /* Broadcom */
207	#define SSB_BOARDVENDOR_DELL 0x1028 /* Dell */
208	#define SSB_BOARDVENDOR_HP 0x0E11 /* HP */
209	/* board_type */
210	#define SSB_BOARD_BCM94306MP 0x0418
211	#define SSB_BOARD_BCM4309G 0x0421
212	#define SSB_BOARD_BCM4306CB 0x0417
213	#define SSB_BOARD_BCM4309MP 0x040C
214	#define SSB_BOARD_MP4318 0x044A
215	#define SSB_BOARD_BU4306 0x0416
216	#define SSB_BOARD_BU4309 0x040A
217	/* chip_package */
218	#define SSB_CHIPPACK_BCM4712S 1 /* Small 200pin 4712 */
219	#define SSB_CHIPPACK_BCM4712M 2 /* Medium 225pin 4712 */
220	#define SSB_CHIPPACK_BCM4712L 0 /* Large 340pin 4712 */
221
222	#include <linux/ssb/ssb_driver_chipcommon.h>
223	#include <linux/ssb/ssb_driver_mips.h>
224	#include <linux/ssb/ssb_driver_extif.h>
225	#include <linux/ssb/ssb_driver_pci.h>
226
227	struct ssb_bus {
228	/* The MMIO area. */
229	void __iomem *mmio;
230
231	const struct ssb_bus_ops *ops;
232
233	/* The core in the basic address register window. (PCI bus only) */
234	struct ssb_device *mapped_device;
235	/* Currently mapped PCMCIA segment. (bustype == SSB_BUSTYPE_PCMCIA only) */
236	u8 mapped_pcmcia_seg;
993e1c78 MB	237	/* Lock for core and segment switching.
993e1c78 MB	238	* On PCMCIA-host busses this is used to protect the whole MMIO access. */
61e115a5 MB	239	spinlock_t bar_lock;
	240
	241	/* The bus this backplane is running on. */
	242	enum ssb_bustype bustype;
	243	/* Pointer to the PCI bus (only valid if bustype == SSB_BUSTYPE_PCI). */
	244	struct pci_dev *host_pci;
	245	/* Pointer to the PCMCIA device (only if bustype == SSB_BUSTYPE_PCMCIA). */
	246	struct pcmcia_device *host_pcmcia;
	247
e7ec2e32	248	#ifdef CONFIG_SSB_SPROM
61e115a5	249	/* Mutex to protect the SPROM writing. */
e7ec2e32	250	struct mutex sprom_mutex;
61e115a5 MB	251	#endif
	252
	253	/* ID information about the Chip. */
	254	u16 chip_id;
	255	u16 chip_rev;
c272ef44	256	u16 sprom_size; /* number of words in sprom */
61e115a5 MB	257	u8 chip_package;
	258
	259	/* List of devices (cores) on the backplane. */
	260	struct ssb_device devices[SSB_MAX_NR_CORES];
	261	u8 nr_devices;
	262
61e115a5 MB	263	/* Software ID number for this bus. */
	264	unsigned int busnumber;
	265
	266	/* The ChipCommon device (if available). */
	267	struct ssb_chipcommon chipco;
	268	/* The PCI-core device (if available). */
	269	struct ssb_pcicore pcicore;
	270	/* The MIPS-core device (if available). */
	271	struct ssb_mipscore mipscore;
	272	/* The EXTif-core device (if available). */
	273	struct ssb_extif extif;
	274
	275	/* The following structure elements are not available in early
	276	* SSB initialization. Though, they are available for regular
	277	* registered drivers at any stage. So be careful when
	278	* using them in the ssb core code. */
	279
	280	/* ID information about the PCB. */
	281	struct ssb_boardinfo boardinfo;
	282	/* Contents of the SPROM. */
	283	struct ssb_sprom sprom;
7cb44615 MB	284	/* If the board has a cardbus slot, this is set to true. */
7cb44615 MB	285	bool has_cardbus_slot;
61e115a5	286
53521d8c MB	287	#ifdef CONFIG_SSB_EMBEDDED
	288	/* Lock for GPIO register access. */
	289	spinlock_t gpio_lock;
	290	#endif /* EMBEDDED */
	291
61e115a5 MB	292	/* Internal-only stuff follows. Do not touch. */
	293	struct list_head list;
	294	#ifdef CONFIG_SSB_DEBUG
	295	/* Is the bus already powered up? */
	296	bool powered_up;
	297	int power_warn_count;
	298	#endif /* DEBUG */
	299	};
	300
	301	/* The initialization-invariants. */
	302	struct ssb_init_invariants {
7cb44615	303	/* Versioning information about the PCB. */
61e115a5	304	struct ssb_boardinfo boardinfo;
7cb44615 MB	305	/* The SPROM information. That's either stored in an
7cb44615 MB	306	* EEPROM or NVRAM on the board. */
61e115a5	307	struct ssb_sprom sprom;
7cb44615 MB	308	/* If the board has a cardbus slot, this is set to true. */
7cb44615 MB	309	bool has_cardbus_slot;
61e115a5 MB	310	};
	311	/* Type of function to fetch the invariants. */
	312	typedef int (ssb_invariants_func_t)(struct ssb_bus bus,
	313	struct ssb_init_invariants *iv);
	314
	315	/* Register a SSB system bus. get_invariants() is called after the
	316	* basic system devices are initialized.
	317	* The invariants are usually fetched from some NVRAM.
	318	* Put the invariants into the struct pointed to by iv. */
	319	extern int ssb_bus_ssbbus_register(struct ssb_bus *bus,
	320	unsigned long baseaddr,
	321	ssb_invariants_func_t get_invariants);
	322	#ifdef CONFIG_SSB_PCIHOST
	323	extern int ssb_bus_pcibus_register(struct ssb_bus *bus,
	324	struct pci_dev *host_pci);
	325	#endif /* CONFIG_SSB_PCIHOST */
	326	#ifdef CONFIG_SSB_PCMCIAHOST
	327	extern int ssb_bus_pcmciabus_register(struct ssb_bus *bus,
	328	struct pcmcia_device *pcmcia_dev,
	329	unsigned long baseaddr);
	330	#endif /* CONFIG_SSB_PCMCIAHOST */
	331
	332	extern void ssb_bus_unregister(struct ssb_bus *bus);
	333
8fe2b65a MB	334	/* Suspend a SSB bus.
	335	* Call this from the parent bus suspend routine. */
	336	extern int ssb_bus_suspend(struct ssb_bus *bus);
	337	/* Resume a SSB bus.
	338	* Call this from the parent bus resume routine. */
	339	extern int ssb_bus_resume(struct ssb_bus *bus);
	340
61e115a5 MB	341	extern u32 ssb_clockspeed(struct ssb_bus *bus);
	342
	343	/* Is the device enabled in hardware? */
	344	int ssb_device_is_enabled(struct ssb_device *dev);
	345	/* Enable a device and pass device-specific SSB_TMSLOW flags.
	346	* If no device-specific flags are available, use 0. */
	347	void ssb_device_enable(struct ssb_device *dev, u32 core_specific_flags);
	348	/* Disable a device in hardware and pass SSB_TMSLOW flags (if any). */
	349	void ssb_device_disable(struct ssb_device *dev, u32 core_specific_flags);
	350
	351
	352	/* Device MMIO register read/write functions. */
ffc7689d MB	353	static inline u8 ssb_read8(struct ssb_device *dev, u16 offset)
	354	{
	355	return dev->ops->read8(dev, offset);
	356	}
61e115a5 MB	357	static inline u16 ssb_read16(struct ssb_device *dev, u16 offset)
	358	{
	359	return dev->ops->read16(dev, offset);
	360	}
	361	static inline u32 ssb_read32(struct ssb_device *dev, u16 offset)
	362	{
	363	return dev->ops->read32(dev, offset);
	364	}
ffc7689d MB	365	static inline void ssb_write8(struct ssb_device *dev, u16 offset, u8 value)
	366	{
	367	dev->ops->write8(dev, offset, value);
	368	}
61e115a5 MB	369	static inline void ssb_write16(struct ssb_device *dev, u16 offset, u16 value)
	370	{
	371	dev->ops->write16(dev, offset, value);
	372	}
	373	static inline void ssb_write32(struct ssb_device *dev, u16 offset, u32 value)
	374	{
	375	dev->ops->write32(dev, offset, value);
	376	}
	377
	378
	379	/* Translation (routing) bits that need to be ORed to DMA
	380	* addresses before they are given to a device. */
	381	extern u32 ssb_dma_translation(struct ssb_device *dev);
	382	#define SSB_DMA_TRANSLATION_MASK 0xC0000000
	383	#define SSB_DMA_TRANSLATION_SHIFT 30
	384
	385	extern int ssb_dma_set_mask(struct ssb_device *ssb_dev, u64 mask);
	386
	387
	388	#ifdef CONFIG_SSB_PCIHOST
	389	/* PCI-host wrapper driver */
	390	extern int ssb_pcihost_register(struct pci_driver *driver);
	391	static inline void ssb_pcihost_unregister(struct pci_driver *driver)
	392	{
	393	pci_unregister_driver(driver);
	394	}
961d57c8 MB	395
	396	static inline
	397	void ssb_pcihost_set_power_state(struct ssb_device *sdev, pci_power_t state)
	398	{
	399	if (sdev->bus->bustype == SSB_BUSTYPE_PCI)
	400	pci_set_power_state(sdev->bus->host_pci, state);
	401	}
532031d7 AM	402	#else
	403	static inline void ssb_pcihost_unregister(struct pci_driver *driver)
	404	{
	405	}
	406
	407	static inline
	408	void ssb_pcihost_set_power_state(struct ssb_device *sdev, pci_power_t state)
	409	{
	410	}
61e115a5 MB	411	#endif /* CONFIG_SSB_PCIHOST */
	412
	413
	414	/* If a driver is shutdown or suspended, call this to signal
	415	* that the bus may be completely powered down. SSB will decide,
	416	* if it's really time to power down the bus, based on if there
	417	* are other devices that want to run. */
	418	extern int ssb_bus_may_powerdown(struct ssb_bus *bus);
	419	/* Before initializing and enabling a device, call this to power-up the bus.
	420	* If you want to allow use of dynamic-power-control, pass the flag.
	421	* Otherwise static always-on powercontrol will be used. */
	422	extern int ssb_bus_powerup(struct ssb_bus *bus, bool dynamic_pctl);
	423
	424
	425	/* Various helper functions */
	426	extern u32 ssb_admatch_base(u32 adm);
	427	extern u32 ssb_admatch_size(u32 adm);
	428
aab547ce MB	429	/* PCI device mapping and fixup routines.
	430	* Called from the architecture pcibios init code.
	431	* These are only available on SSB_EMBEDDED configurations. */
	432	#ifdef CONFIG_SSB_EMBEDDED
	433	int ssb_pcibios_plat_dev_init(struct pci_dev *dev);
	434	int ssb_pcibios_map_irq(const struct pci_dev *dev, u8 slot, u8 pin);
	435	#endif /* CONFIG_SSB_EMBEDDED */
61e115a5 MB	436
61e115a5 MB	437	#endif /* LINUX_SSB_H_ */