xref: /linux/include/linux/ssb/ssb.h (revision f679056b2fdd4e9b7c8eb42ba447cd9646236305)
161e115a5SMichael Buesch #ifndef LINUX_SSB_H_
261e115a5SMichael Buesch #define LINUX_SSB_H_
361e115a5SMichael Buesch 
461e115a5SMichael Buesch #include <linux/device.h>
561e115a5SMichael Buesch #include <linux/list.h>
661e115a5SMichael Buesch #include <linux/types.h>
761e115a5SMichael Buesch #include <linux/spinlock.h>
861e115a5SMichael Buesch #include <linux/pci.h>
961e115a5SMichael Buesch #include <linux/mod_devicetable.h>
109c0c7a42SMichael Buesch #include <linux/dma-mapping.h>
1161e115a5SMichael Buesch 
1261e115a5SMichael Buesch #include <linux/ssb/ssb_regs.h>
1361e115a5SMichael Buesch 
1461e115a5SMichael Buesch 
1561e115a5SMichael Buesch struct pcmcia_device;
1661e115a5SMichael Buesch struct ssb_bus;
1761e115a5SMichael Buesch struct ssb_driver;
1861e115a5SMichael Buesch 
1961e115a5SMichael Buesch struct ssb_sprom {
2061e115a5SMichael Buesch 	u8 revision;
21ac82fab4SLarry Finger 	u8 il0mac[6];		/* MAC address for 802.11b/g */
22ac82fab4SLarry Finger 	u8 et0mac[6];		/* MAC address for Ethernet */
23ac82fab4SLarry Finger 	u8 et1mac[6];		/* MAC address for 802.11a */
24ac82fab4SLarry Finger 	u8 et0phyaddr;		/* MII address for enet0 */
25ac82fab4SLarry Finger 	u8 et1phyaddr;		/* MII address for enet1 */
26e861b98dSMichael Buesch 	u8 et0mdcport;		/* MDIO for enet0 */
27e861b98dSMichael Buesch 	u8 et1mdcport;		/* MDIO for enet1 */
28e861b98dSMichael Buesch 	u8 board_rev;		/* Board revision number from SPROM. */
29ac82fab4SLarry Finger 	u8 country_code;	/* Country Code */
30*f679056bSGábor Stefanik 	u8 ant_available_a;	/* 2GHz antenna available bits (up to 4) */
31*f679056bSGábor Stefanik 	u8 ant_available_bg;	/* 5GHz antenna available bits (up to 4) */
32ac82fab4SLarry Finger 	u16 pa0b0;
33ac82fab4SLarry Finger 	u16 pa0b1;
34ac82fab4SLarry Finger 	u16 pa0b2;
35ac82fab4SLarry Finger 	u16 pa1b0;
36ac82fab4SLarry Finger 	u16 pa1b1;
37ac82fab4SLarry Finger 	u16 pa1b2;
38*f679056bSGábor Stefanik 	u16 pa1lob0;
39*f679056bSGábor Stefanik 	u16 pa1lob1;
40*f679056bSGábor Stefanik 	u16 pa1lob2;
41*f679056bSGábor Stefanik 	u16 pa1hib0;
42*f679056bSGábor Stefanik 	u16 pa1hib1;
43*f679056bSGábor Stefanik 	u16 pa1hib2;
44ac82fab4SLarry Finger 	u8 gpio0;		/* GPIO pin 0 */
45ac82fab4SLarry Finger 	u8 gpio1;		/* GPIO pin 1 */
46ac82fab4SLarry Finger 	u8 gpio2;		/* GPIO pin 2 */
47ac82fab4SLarry Finger 	u8 gpio3;		/* GPIO pin 3 */
48*f679056bSGábor Stefanik 	u16 maxpwr_bg;		/* 2.4GHz Amplifier Max Power (in dBm Q5.2) */
49*f679056bSGábor Stefanik 	u16 maxpwr_al;		/* 5.2GHz Amplifier Max Power (in dBm Q5.2) */
50*f679056bSGábor Stefanik 	u16 maxpwr_a;		/* 5.3GHz Amplifier Max Power (in dBm Q5.2) */
51*f679056bSGábor Stefanik 	u16 maxpwr_ah;		/* 5.8GHz Amplifier Max Power (in dBm Q5.2) */
52ac82fab4SLarry Finger 	u8 itssi_a;		/* Idle TSSI Target for A-PHY */
53ac82fab4SLarry Finger 	u8 itssi_bg;		/* Idle TSSI Target for B/G-PHY */
54*f679056bSGábor Stefanik 	u8 tri2g;		/* 2.4GHz TX isolation */
55*f679056bSGábor Stefanik 	u8 tri5gl;		/* 5.2GHz TX isolation */
56*f679056bSGábor Stefanik 	u8 tri5g;		/* 5.3GHz TX isolation */
57*f679056bSGábor Stefanik 	u8 tri5gh;		/* 5.8GHz TX isolation */
58*f679056bSGábor Stefanik 	u8 rxpo2g;		/* 2GHz RX power offset */
59*f679056bSGábor Stefanik 	u8 rxpo5g;		/* 5GHz RX power offset */
60*f679056bSGábor Stefanik 	u8 rssisav2g;		/* 2GHz RSSI params */
61*f679056bSGábor Stefanik 	u8 rssismc2g;
62*f679056bSGábor Stefanik 	u8 rssismf2g;
63*f679056bSGábor Stefanik 	u8 bxa2g;		/* 2GHz BX arch */
64*f679056bSGábor Stefanik 	u8 rssisav5g;		/* 5GHz RSSI params */
65*f679056bSGábor Stefanik 	u8 rssismc5g;
66*f679056bSGábor Stefanik 	u8 rssismf5g;
67*f679056bSGábor Stefanik 	u8 bxa5g;		/* 5GHz BX arch */
68*f679056bSGábor Stefanik 	u16 cck2gpo;		/* CCK power offset */
69*f679056bSGábor Stefanik 	u32 ofdm2gpo;		/* 2.4GHz OFDM power offset */
70*f679056bSGábor Stefanik 	u32 ofdm5glpo;		/* 5.2GHz OFDM power offset */
71*f679056bSGábor Stefanik 	u32 ofdm5gpo;		/* 5.3GHz OFDM power offset */
72*f679056bSGábor Stefanik 	u32 ofdm5ghpo;		/* 5.8GHz OFDM power offset */
73*f679056bSGábor Stefanik 	u16 boardflags_lo;	/* Board flags (bits 0-15) */
74*f679056bSGábor Stefanik 	u16 boardflags_hi;	/* Board flags (bits 16-31) */
75*f679056bSGábor Stefanik 	u16 boardflags2_lo;	/* Board flags (bits 32-47) */
76*f679056bSGábor Stefanik 	u16 boardflags2_hi;	/* Board flags (bits 48-63) */
77*f679056bSGábor Stefanik 	/* TODO store board flags in a single u64 */
78e861b98dSMichael Buesch 
79e861b98dSMichael Buesch 	/* Antenna gain values for up to 4 antennas
80e861b98dSMichael Buesch 	 * on each band. Values in dBm/4 (Q5.2). Negative gain means the
81e861b98dSMichael Buesch 	 * loss in the connectors is bigger than the gain. */
82e861b98dSMichael Buesch 	struct {
83e861b98dSMichael Buesch 		struct {
84e861b98dSMichael Buesch 			s8 a0, a1, a2, a3;
85e861b98dSMichael Buesch 		} ghz24;	/* 2.4GHz band */
86e861b98dSMichael Buesch 		struct {
87e861b98dSMichael Buesch 			s8 a0, a1, a2, a3;
88e861b98dSMichael Buesch 		} ghz5;		/* 5GHz band */
89e861b98dSMichael Buesch 	} antenna_gain;
90ac82fab4SLarry Finger 
91*f679056bSGábor Stefanik 	/* TODO - add any parameters needed from rev 2, 3, 4, 5 or 8 SPROMs */
9261e115a5SMichael Buesch };
9361e115a5SMichael Buesch 
9461e115a5SMichael Buesch /* Information about the PCB the circuitry is soldered on. */
9561e115a5SMichael Buesch struct ssb_boardinfo {
9661e115a5SMichael Buesch 	u16 vendor;
9761e115a5SMichael Buesch 	u16 type;
9861e115a5SMichael Buesch 	u16 rev;
9961e115a5SMichael Buesch };
10061e115a5SMichael Buesch 
10161e115a5SMichael Buesch 
10261e115a5SMichael Buesch struct ssb_device;
10361e115a5SMichael Buesch /* Lowlevel read/write operations on the device MMIO.
10461e115a5SMichael Buesch  * Internal, don't use that outside of ssb. */
10561e115a5SMichael Buesch struct ssb_bus_ops {
106ffc7689dSMichael Buesch 	u8 (*read8)(struct ssb_device *dev, u16 offset);
10761e115a5SMichael Buesch 	u16 (*read16)(struct ssb_device *dev, u16 offset);
10861e115a5SMichael Buesch 	u32 (*read32)(struct ssb_device *dev, u16 offset);
109ffc7689dSMichael Buesch 	void (*write8)(struct ssb_device *dev, u16 offset, u8 value);
11061e115a5SMichael Buesch 	void (*write16)(struct ssb_device *dev, u16 offset, u16 value);
11161e115a5SMichael Buesch 	void (*write32)(struct ssb_device *dev, u16 offset, u32 value);
112d625a29bSMichael Buesch #ifdef CONFIG_SSB_BLOCKIO
113d625a29bSMichael Buesch 	void (*block_read)(struct ssb_device *dev, void *buffer,
114d625a29bSMichael Buesch 			   size_t count, u16 offset, u8 reg_width);
115d625a29bSMichael Buesch 	void (*block_write)(struct ssb_device *dev, const void *buffer,
116d625a29bSMichael Buesch 			    size_t count, u16 offset, u8 reg_width);
117d625a29bSMichael Buesch #endif
11861e115a5SMichael Buesch };
11961e115a5SMichael Buesch 
12061e115a5SMichael Buesch 
12161e115a5SMichael Buesch /* Core-ID values. */
12261e115a5SMichael Buesch #define SSB_DEV_CHIPCOMMON	0x800
12361e115a5SMichael Buesch #define SSB_DEV_ILINE20		0x801
12461e115a5SMichael Buesch #define SSB_DEV_SDRAM		0x803
12561e115a5SMichael Buesch #define SSB_DEV_PCI		0x804
12661e115a5SMichael Buesch #define SSB_DEV_MIPS		0x805
12761e115a5SMichael Buesch #define SSB_DEV_ETHERNET	0x806
12861e115a5SMichael Buesch #define SSB_DEV_V90		0x807
12961e115a5SMichael Buesch #define SSB_DEV_USB11_HOSTDEV	0x808
13061e115a5SMichael Buesch #define SSB_DEV_ADSL		0x809
13161e115a5SMichael Buesch #define SSB_DEV_ILINE100	0x80A
13261e115a5SMichael Buesch #define SSB_DEV_IPSEC		0x80B
13361e115a5SMichael Buesch #define SSB_DEV_PCMCIA		0x80D
13461e115a5SMichael Buesch #define SSB_DEV_INTERNAL_MEM	0x80E
13561e115a5SMichael Buesch #define SSB_DEV_MEMC_SDRAM	0x80F
13661e115a5SMichael Buesch #define SSB_DEV_EXTIF		0x811
13761e115a5SMichael Buesch #define SSB_DEV_80211		0x812
13861e115a5SMichael Buesch #define SSB_DEV_MIPS_3302	0x816
13961e115a5SMichael Buesch #define SSB_DEV_USB11_HOST	0x817
14061e115a5SMichael Buesch #define SSB_DEV_USB11_DEV	0x818
14161e115a5SMichael Buesch #define SSB_DEV_USB20_HOST	0x819
14261e115a5SMichael Buesch #define SSB_DEV_USB20_DEV	0x81A
14361e115a5SMichael Buesch #define SSB_DEV_SDIO_HOST	0x81B
14461e115a5SMichael Buesch #define SSB_DEV_ROBOSWITCH	0x81C
14561e115a5SMichael Buesch #define SSB_DEV_PARA_ATA	0x81D
14661e115a5SMichael Buesch #define SSB_DEV_SATA_XORDMA	0x81E
14761e115a5SMichael Buesch #define SSB_DEV_ETHERNET_GBIT	0x81F
14861e115a5SMichael Buesch #define SSB_DEV_PCIE		0x820
14961e115a5SMichael Buesch #define SSB_DEV_MIMO_PHY	0x821
15061e115a5SMichael Buesch #define SSB_DEV_SRAM_CTRLR	0x822
15161e115a5SMichael Buesch #define SSB_DEV_MINI_MACPHY	0x823
15261e115a5SMichael Buesch #define SSB_DEV_ARM_1176	0x824
15361e115a5SMichael Buesch #define SSB_DEV_ARM_7TDMI	0x825
15461e115a5SMichael Buesch 
15561e115a5SMichael Buesch /* Vendor-ID values */
15661e115a5SMichael Buesch #define SSB_VENDOR_BROADCOM	0x4243
15761e115a5SMichael Buesch 
15861e115a5SMichael Buesch /* Some kernel subsystems poke with dev->drvdata, so we must use the
15961e115a5SMichael Buesch  * following ugly workaround to get from struct device to struct ssb_device */
16061e115a5SMichael Buesch struct __ssb_dev_wrapper {
16161e115a5SMichael Buesch 	struct device dev;
16261e115a5SMichael Buesch 	struct ssb_device *sdev;
16361e115a5SMichael Buesch };
16461e115a5SMichael Buesch 
16561e115a5SMichael Buesch struct ssb_device {
16661e115a5SMichael Buesch 	/* Having a copy of the ops pointer in each dev struct
16761e115a5SMichael Buesch 	 * is an optimization. */
16861e115a5SMichael Buesch 	const struct ssb_bus_ops *ops;
16961e115a5SMichael Buesch 
17061e115a5SMichael Buesch 	struct device *dev;
1714ac58469SMichael Buesch 
17261e115a5SMichael Buesch 	struct ssb_bus *bus;
17361e115a5SMichael Buesch 	struct ssb_device_id id;
17461e115a5SMichael Buesch 
17561e115a5SMichael Buesch 	u8 core_index;
17661e115a5SMichael Buesch 	unsigned int irq;
17761e115a5SMichael Buesch 
17861e115a5SMichael Buesch 	/* Internal-only stuff follows. */
17961e115a5SMichael Buesch 	void *drvdata;		/* Per-device data */
18061e115a5SMichael Buesch 	void *devtypedata;	/* Per-devicetype (eg 802.11) data */
18161e115a5SMichael Buesch };
18261e115a5SMichael Buesch 
18361e115a5SMichael Buesch /* Go from struct device to struct ssb_device. */
18461e115a5SMichael Buesch static inline
18561e115a5SMichael Buesch struct ssb_device * dev_to_ssb_dev(struct device *dev)
18661e115a5SMichael Buesch {
18761e115a5SMichael Buesch 	struct __ssb_dev_wrapper *wrap;
18861e115a5SMichael Buesch 	wrap = container_of(dev, struct __ssb_dev_wrapper, dev);
18961e115a5SMichael Buesch 	return wrap->sdev;
19061e115a5SMichael Buesch }
19161e115a5SMichael Buesch 
19261e115a5SMichael Buesch /* Device specific user data */
19361e115a5SMichael Buesch static inline
19461e115a5SMichael Buesch void ssb_set_drvdata(struct ssb_device *dev, void *data)
19561e115a5SMichael Buesch {
19661e115a5SMichael Buesch 	dev->drvdata = data;
19761e115a5SMichael Buesch }
19861e115a5SMichael Buesch static inline
19961e115a5SMichael Buesch void * ssb_get_drvdata(struct ssb_device *dev)
20061e115a5SMichael Buesch {
20161e115a5SMichael Buesch 	return dev->drvdata;
20261e115a5SMichael Buesch }
20361e115a5SMichael Buesch 
20461e115a5SMichael Buesch /* Devicetype specific user data. This is per device-type (not per device) */
20561e115a5SMichael Buesch void ssb_set_devtypedata(struct ssb_device *dev, void *data);
20661e115a5SMichael Buesch static inline
20761e115a5SMichael Buesch void * ssb_get_devtypedata(struct ssb_device *dev)
20861e115a5SMichael Buesch {
20961e115a5SMichael Buesch 	return dev->devtypedata;
21061e115a5SMichael Buesch }
21161e115a5SMichael Buesch 
21261e115a5SMichael Buesch 
21361e115a5SMichael Buesch struct ssb_driver {
21461e115a5SMichael Buesch 	const char *name;
21561e115a5SMichael Buesch 	const struct ssb_device_id *id_table;
21661e115a5SMichael Buesch 
21761e115a5SMichael Buesch 	int (*probe)(struct ssb_device *dev, const struct ssb_device_id *id);
21861e115a5SMichael Buesch 	void (*remove)(struct ssb_device *dev);
21961e115a5SMichael Buesch 	int (*suspend)(struct ssb_device *dev, pm_message_t state);
22061e115a5SMichael Buesch 	int (*resume)(struct ssb_device *dev);
22161e115a5SMichael Buesch 	void (*shutdown)(struct ssb_device *dev);
22261e115a5SMichael Buesch 
22361e115a5SMichael Buesch 	struct device_driver drv;
22461e115a5SMichael Buesch };
22561e115a5SMichael Buesch #define drv_to_ssb_drv(_drv) container_of(_drv, struct ssb_driver, drv)
22661e115a5SMichael Buesch 
22761e115a5SMichael Buesch extern int __ssb_driver_register(struct ssb_driver *drv, struct module *owner);
22861e115a5SMichael Buesch static inline int ssb_driver_register(struct ssb_driver *drv)
22961e115a5SMichael Buesch {
23061e115a5SMichael Buesch 	return __ssb_driver_register(drv, THIS_MODULE);
23161e115a5SMichael Buesch }
23261e115a5SMichael Buesch extern void ssb_driver_unregister(struct ssb_driver *drv);
23361e115a5SMichael Buesch 
23461e115a5SMichael Buesch 
23561e115a5SMichael Buesch 
23661e115a5SMichael Buesch 
23761e115a5SMichael Buesch enum ssb_bustype {
23861e115a5SMichael Buesch 	SSB_BUSTYPE_SSB,	/* This SSB bus is the system bus */
23961e115a5SMichael Buesch 	SSB_BUSTYPE_PCI,	/* SSB is connected to PCI bus */
24061e115a5SMichael Buesch 	SSB_BUSTYPE_PCMCIA,	/* SSB is connected to PCMCIA bus */
24161e115a5SMichael Buesch };
24261e115a5SMichael Buesch 
24361e115a5SMichael Buesch /* board_vendor */
24461e115a5SMichael Buesch #define SSB_BOARDVENDOR_BCM	0x14E4	/* Broadcom */
24561e115a5SMichael Buesch #define SSB_BOARDVENDOR_DELL	0x1028	/* Dell */
24661e115a5SMichael Buesch #define SSB_BOARDVENDOR_HP	0x0E11	/* HP */
24761e115a5SMichael Buesch /* board_type */
24861e115a5SMichael Buesch #define SSB_BOARD_BCM94306MP	0x0418
24961e115a5SMichael Buesch #define SSB_BOARD_BCM4309G	0x0421
25061e115a5SMichael Buesch #define SSB_BOARD_BCM4306CB	0x0417
25161e115a5SMichael Buesch #define SSB_BOARD_BCM4309MP	0x040C
25261e115a5SMichael Buesch #define SSB_BOARD_MP4318	0x044A
25361e115a5SMichael Buesch #define SSB_BOARD_BU4306	0x0416
25461e115a5SMichael Buesch #define SSB_BOARD_BU4309	0x040A
25561e115a5SMichael Buesch /* chip_package */
25661e115a5SMichael Buesch #define SSB_CHIPPACK_BCM4712S	1	/* Small 200pin 4712 */
25761e115a5SMichael Buesch #define SSB_CHIPPACK_BCM4712M	2	/* Medium 225pin 4712 */
25861e115a5SMichael Buesch #define SSB_CHIPPACK_BCM4712L	0	/* Large 340pin 4712 */
25961e115a5SMichael Buesch 
26061e115a5SMichael Buesch #include <linux/ssb/ssb_driver_chipcommon.h>
26161e115a5SMichael Buesch #include <linux/ssb/ssb_driver_mips.h>
26261e115a5SMichael Buesch #include <linux/ssb/ssb_driver_extif.h>
26361e115a5SMichael Buesch #include <linux/ssb/ssb_driver_pci.h>
26461e115a5SMichael Buesch 
26561e115a5SMichael Buesch struct ssb_bus {
26661e115a5SMichael Buesch 	/* The MMIO area. */
26761e115a5SMichael Buesch 	void __iomem *mmio;
26861e115a5SMichael Buesch 
26961e115a5SMichael Buesch 	const struct ssb_bus_ops *ops;
27061e115a5SMichael Buesch 
27161e115a5SMichael Buesch 	/* The core in the basic address register window. (PCI bus only) */
27261e115a5SMichael Buesch 	struct ssb_device *mapped_device;
27361e115a5SMichael Buesch 	/* Currently mapped PCMCIA segment. (bustype == SSB_BUSTYPE_PCMCIA only) */
27461e115a5SMichael Buesch 	u8 mapped_pcmcia_seg;
275993e1c78SMichael Buesch 	/* Lock for core and segment switching.
276993e1c78SMichael Buesch 	 * On PCMCIA-host busses this is used to protect the whole MMIO access. */
27761e115a5SMichael Buesch 	spinlock_t bar_lock;
27861e115a5SMichael Buesch 
27961e115a5SMichael Buesch 	/* The bus this backplane is running on. */
28061e115a5SMichael Buesch 	enum ssb_bustype bustype;
28161e115a5SMichael Buesch 	/* Pointer to the PCI bus (only valid if bustype == SSB_BUSTYPE_PCI). */
28261e115a5SMichael Buesch 	struct pci_dev *host_pci;
28361e115a5SMichael Buesch 	/* Pointer to the PCMCIA device (only if bustype == SSB_BUSTYPE_PCMCIA). */
28461e115a5SMichael Buesch 	struct pcmcia_device *host_pcmcia;
28561e115a5SMichael Buesch 
286e7ec2e32SMichael Buesch #ifdef CONFIG_SSB_SPROM
28761e115a5SMichael Buesch 	/* Mutex to protect the SPROM writing. */
288e7ec2e32SMichael Buesch 	struct mutex sprom_mutex;
28961e115a5SMichael Buesch #endif
29061e115a5SMichael Buesch 
29161e115a5SMichael Buesch 	/* ID information about the Chip. */
29261e115a5SMichael Buesch 	u16 chip_id;
29361e115a5SMichael Buesch 	u16 chip_rev;
294c272ef44SLarry Finger 	u16 sprom_size;		/* number of words in sprom */
29561e115a5SMichael Buesch 	u8 chip_package;
29661e115a5SMichael Buesch 
29761e115a5SMichael Buesch 	/* List of devices (cores) on the backplane. */
29861e115a5SMichael Buesch 	struct ssb_device devices[SSB_MAX_NR_CORES];
29961e115a5SMichael Buesch 	u8 nr_devices;
30061e115a5SMichael Buesch 
30161e115a5SMichael Buesch 	/* Software ID number for this bus. */
30261e115a5SMichael Buesch 	unsigned int busnumber;
30361e115a5SMichael Buesch 
30461e115a5SMichael Buesch 	/* The ChipCommon device (if available). */
30561e115a5SMichael Buesch 	struct ssb_chipcommon chipco;
30661e115a5SMichael Buesch 	/* The PCI-core device (if available). */
30761e115a5SMichael Buesch 	struct ssb_pcicore pcicore;
30861e115a5SMichael Buesch 	/* The MIPS-core device (if available). */
30961e115a5SMichael Buesch 	struct ssb_mipscore mipscore;
31061e115a5SMichael Buesch 	/* The EXTif-core device (if available). */
31161e115a5SMichael Buesch 	struct ssb_extif extif;
31261e115a5SMichael Buesch 
31361e115a5SMichael Buesch 	/* The following structure elements are not available in early
31461e115a5SMichael Buesch 	 * SSB initialization. Though, they are available for regular
31561e115a5SMichael Buesch 	 * registered drivers at any stage. So be careful when
31661e115a5SMichael Buesch 	 * using them in the ssb core code. */
31761e115a5SMichael Buesch 
31861e115a5SMichael Buesch 	/* ID information about the PCB. */
31961e115a5SMichael Buesch 	struct ssb_boardinfo boardinfo;
32061e115a5SMichael Buesch 	/* Contents of the SPROM. */
32161e115a5SMichael Buesch 	struct ssb_sprom sprom;
3227cb44615SMichael Buesch 	/* If the board has a cardbus slot, this is set to true. */
3237cb44615SMichael Buesch 	bool has_cardbus_slot;
32461e115a5SMichael Buesch 
32553521d8cSMichael Buesch #ifdef CONFIG_SSB_EMBEDDED
32653521d8cSMichael Buesch 	/* Lock for GPIO register access. */
32753521d8cSMichael Buesch 	spinlock_t gpio_lock;
32853521d8cSMichael Buesch #endif /* EMBEDDED */
32953521d8cSMichael Buesch 
33061e115a5SMichael Buesch 	/* Internal-only stuff follows. Do not touch. */
33161e115a5SMichael Buesch 	struct list_head list;
33261e115a5SMichael Buesch #ifdef CONFIG_SSB_DEBUG
33361e115a5SMichael Buesch 	/* Is the bus already powered up? */
33461e115a5SMichael Buesch 	bool powered_up;
33561e115a5SMichael Buesch 	int power_warn_count;
33661e115a5SMichael Buesch #endif /* DEBUG */
33761e115a5SMichael Buesch };
33861e115a5SMichael Buesch 
33961e115a5SMichael Buesch /* The initialization-invariants. */
34061e115a5SMichael Buesch struct ssb_init_invariants {
3417cb44615SMichael Buesch 	/* Versioning information about the PCB. */
34261e115a5SMichael Buesch 	struct ssb_boardinfo boardinfo;
3437cb44615SMichael Buesch 	/* The SPROM information. That's either stored in an
3447cb44615SMichael Buesch 	 * EEPROM or NVRAM on the board. */
34561e115a5SMichael Buesch 	struct ssb_sprom sprom;
3467cb44615SMichael Buesch 	/* If the board has a cardbus slot, this is set to true. */
3477cb44615SMichael Buesch 	bool has_cardbus_slot;
34861e115a5SMichael Buesch };
34961e115a5SMichael Buesch /* Type of function to fetch the invariants. */
35061e115a5SMichael Buesch typedef int (*ssb_invariants_func_t)(struct ssb_bus *bus,
35161e115a5SMichael Buesch 				     struct ssb_init_invariants *iv);
35261e115a5SMichael Buesch 
35361e115a5SMichael Buesch /* Register a SSB system bus. get_invariants() is called after the
35461e115a5SMichael Buesch  * basic system devices are initialized.
35561e115a5SMichael Buesch  * The invariants are usually fetched from some NVRAM.
35661e115a5SMichael Buesch  * Put the invariants into the struct pointed to by iv. */
35761e115a5SMichael Buesch extern int ssb_bus_ssbbus_register(struct ssb_bus *bus,
35861e115a5SMichael Buesch 				   unsigned long baseaddr,
35961e115a5SMichael Buesch 				   ssb_invariants_func_t get_invariants);
36061e115a5SMichael Buesch #ifdef CONFIG_SSB_PCIHOST
36161e115a5SMichael Buesch extern int ssb_bus_pcibus_register(struct ssb_bus *bus,
36261e115a5SMichael Buesch 				   struct pci_dev *host_pci);
36361e115a5SMichael Buesch #endif /* CONFIG_SSB_PCIHOST */
36461e115a5SMichael Buesch #ifdef CONFIG_SSB_PCMCIAHOST
36561e115a5SMichael Buesch extern int ssb_bus_pcmciabus_register(struct ssb_bus *bus,
36661e115a5SMichael Buesch 				      struct pcmcia_device *pcmcia_dev,
36761e115a5SMichael Buesch 				      unsigned long baseaddr);
36861e115a5SMichael Buesch #endif /* CONFIG_SSB_PCMCIAHOST */
36961e115a5SMichael Buesch 
37061e115a5SMichael Buesch extern void ssb_bus_unregister(struct ssb_bus *bus);
37161e115a5SMichael Buesch 
372e79c1ba8SMichael Buesch /* Set a fallback SPROM.
373e79c1ba8SMichael Buesch  * See kdoc at the function definition for complete documentation. */
374e79c1ba8SMichael Buesch extern int ssb_arch_set_fallback_sprom(const struct ssb_sprom *sprom);
375e79c1ba8SMichael Buesch 
3768fe2b65aSMichael Buesch /* Suspend a SSB bus.
3778fe2b65aSMichael Buesch  * Call this from the parent bus suspend routine. */
3788fe2b65aSMichael Buesch extern int ssb_bus_suspend(struct ssb_bus *bus);
3798fe2b65aSMichael Buesch /* Resume a SSB bus.
3808fe2b65aSMichael Buesch  * Call this from the parent bus resume routine. */
3818fe2b65aSMichael Buesch extern int ssb_bus_resume(struct ssb_bus *bus);
3828fe2b65aSMichael Buesch 
38361e115a5SMichael Buesch extern u32 ssb_clockspeed(struct ssb_bus *bus);
38461e115a5SMichael Buesch 
38561e115a5SMichael Buesch /* Is the device enabled in hardware? */
38661e115a5SMichael Buesch int ssb_device_is_enabled(struct ssb_device *dev);
38761e115a5SMichael Buesch /* Enable a device and pass device-specific SSB_TMSLOW flags.
38861e115a5SMichael Buesch  * If no device-specific flags are available, use 0. */
38961e115a5SMichael Buesch void ssb_device_enable(struct ssb_device *dev, u32 core_specific_flags);
39061e115a5SMichael Buesch /* Disable a device in hardware and pass SSB_TMSLOW flags (if any). */
39161e115a5SMichael Buesch void ssb_device_disable(struct ssb_device *dev, u32 core_specific_flags);
39261e115a5SMichael Buesch 
39361e115a5SMichael Buesch 
39461e115a5SMichael Buesch /* Device MMIO register read/write functions. */
395ffc7689dSMichael Buesch static inline u8 ssb_read8(struct ssb_device *dev, u16 offset)
396ffc7689dSMichael Buesch {
397ffc7689dSMichael Buesch 	return dev->ops->read8(dev, offset);
398ffc7689dSMichael Buesch }
39961e115a5SMichael Buesch static inline u16 ssb_read16(struct ssb_device *dev, u16 offset)
40061e115a5SMichael Buesch {
40161e115a5SMichael Buesch 	return dev->ops->read16(dev, offset);
40261e115a5SMichael Buesch }
40361e115a5SMichael Buesch static inline u32 ssb_read32(struct ssb_device *dev, u16 offset)
40461e115a5SMichael Buesch {
40561e115a5SMichael Buesch 	return dev->ops->read32(dev, offset);
40661e115a5SMichael Buesch }
407ffc7689dSMichael Buesch static inline void ssb_write8(struct ssb_device *dev, u16 offset, u8 value)
408ffc7689dSMichael Buesch {
409ffc7689dSMichael Buesch 	dev->ops->write8(dev, offset, value);
410ffc7689dSMichael Buesch }
41161e115a5SMichael Buesch static inline void ssb_write16(struct ssb_device *dev, u16 offset, u16 value)
41261e115a5SMichael Buesch {
41361e115a5SMichael Buesch 	dev->ops->write16(dev, offset, value);
41461e115a5SMichael Buesch }
41561e115a5SMichael Buesch static inline void ssb_write32(struct ssb_device *dev, u16 offset, u32 value)
41661e115a5SMichael Buesch {
41761e115a5SMichael Buesch 	dev->ops->write32(dev, offset, value);
41861e115a5SMichael Buesch }
419d625a29bSMichael Buesch #ifdef CONFIG_SSB_BLOCKIO
420d625a29bSMichael Buesch static inline void ssb_block_read(struct ssb_device *dev, void *buffer,
421d625a29bSMichael Buesch 				  size_t count, u16 offset, u8 reg_width)
422d625a29bSMichael Buesch {
423d625a29bSMichael Buesch 	dev->ops->block_read(dev, buffer, count, offset, reg_width);
424d625a29bSMichael Buesch }
425d625a29bSMichael Buesch 
426d625a29bSMichael Buesch static inline void ssb_block_write(struct ssb_device *dev, const void *buffer,
427d625a29bSMichael Buesch 				   size_t count, u16 offset, u8 reg_width)
428d625a29bSMichael Buesch {
429d625a29bSMichael Buesch 	dev->ops->block_write(dev, buffer, count, offset, reg_width);
430d625a29bSMichael Buesch }
431d625a29bSMichael Buesch #endif /* CONFIG_SSB_BLOCKIO */
43261e115a5SMichael Buesch 
43361e115a5SMichael Buesch 
434f225763aSMichael Buesch /* The SSB DMA API. Use this API for any DMA operation on the device.
435f225763aSMichael Buesch  * This API basically is a wrapper that calls the correct DMA API for
436f225763aSMichael Buesch  * the host device type the SSB device is attached to. */
437f225763aSMichael Buesch 
43861e115a5SMichael Buesch /* Translation (routing) bits that need to be ORed to DMA
43961e115a5SMichael Buesch  * addresses before they are given to a device. */
44061e115a5SMichael Buesch extern u32 ssb_dma_translation(struct ssb_device *dev);
44161e115a5SMichael Buesch #define SSB_DMA_TRANSLATION_MASK	0xC0000000
44261e115a5SMichael Buesch #define SSB_DMA_TRANSLATION_SHIFT	30
44361e115a5SMichael Buesch 
444f225763aSMichael Buesch extern int ssb_dma_set_mask(struct ssb_device *dev, u64 mask);
445f225763aSMichael Buesch 
446f225763aSMichael Buesch extern void * ssb_dma_alloc_consistent(struct ssb_device *dev, size_t size,
447f225763aSMichael Buesch 				       dma_addr_t *dma_handle, gfp_t gfp_flags);
448f225763aSMichael Buesch extern void ssb_dma_free_consistent(struct ssb_device *dev, size_t size,
449f225763aSMichael Buesch 				    void *vaddr, dma_addr_t dma_handle,
450f225763aSMichael Buesch 				    gfp_t gfp_flags);
451f225763aSMichael Buesch 
452f225763aSMichael Buesch static inline void __cold __ssb_dma_not_implemented(struct ssb_device *dev)
453f225763aSMichael Buesch {
454f225763aSMichael Buesch #ifdef CONFIG_SSB_DEBUG
455f225763aSMichael Buesch 	printk(KERN_ERR "SSB: BUG! Calling DMA API for "
456f225763aSMichael Buesch 	       "unsupported bustype %d\n", dev->bus->bustype);
457f225763aSMichael Buesch #endif /* DEBUG */
458f225763aSMichael Buesch }
459f225763aSMichael Buesch 
460f225763aSMichael Buesch static inline int ssb_dma_mapping_error(struct ssb_device *dev, dma_addr_t addr)
461f225763aSMichael Buesch {
462f225763aSMichael Buesch 	switch (dev->bus->bustype) {
463f225763aSMichael Buesch 	case SSB_BUSTYPE_PCI:
464fd0fcf5cSMichael Buesch #ifdef CONFIG_SSB_PCIHOST
4658d8bb39bSFUJITA Tomonori 		return pci_dma_mapping_error(dev->bus->host_pci, addr);
466fd0fcf5cSMichael Buesch #endif
467fd0fcf5cSMichael Buesch 		break;
468f225763aSMichael Buesch 	case SSB_BUSTYPE_SSB:
4698d8bb39bSFUJITA Tomonori 		return dma_mapping_error(dev->dev, addr);
470f225763aSMichael Buesch 	default:
471fd0fcf5cSMichael Buesch 		break;
472f225763aSMichael Buesch 	}
473fd0fcf5cSMichael Buesch 	__ssb_dma_not_implemented(dev);
474f225763aSMichael Buesch 	return -ENOSYS;
475f225763aSMichael Buesch }
476f225763aSMichael Buesch 
477f225763aSMichael Buesch static inline dma_addr_t ssb_dma_map_single(struct ssb_device *dev, void *p,
478f225763aSMichael Buesch 					    size_t size, enum dma_data_direction dir)
479f225763aSMichael Buesch {
480f225763aSMichael Buesch 	switch (dev->bus->bustype) {
481f225763aSMichael Buesch 	case SSB_BUSTYPE_PCI:
482fd0fcf5cSMichael Buesch #ifdef CONFIG_SSB_PCIHOST
483f225763aSMichael Buesch 		return pci_map_single(dev->bus->host_pci, p, size, dir);
484fd0fcf5cSMichael Buesch #endif
485fd0fcf5cSMichael Buesch 		break;
486f225763aSMichael Buesch 	case SSB_BUSTYPE_SSB:
487f225763aSMichael Buesch 		return dma_map_single(dev->dev, p, size, dir);
488f225763aSMichael Buesch 	default:
489fd0fcf5cSMichael Buesch 		break;
490f225763aSMichael Buesch 	}
491fd0fcf5cSMichael Buesch 	__ssb_dma_not_implemented(dev);
492f225763aSMichael Buesch 	return 0;
493f225763aSMichael Buesch }
494f225763aSMichael Buesch 
495f225763aSMichael Buesch static inline void ssb_dma_unmap_single(struct ssb_device *dev, dma_addr_t dma_addr,
496f225763aSMichael Buesch 					size_t size, enum dma_data_direction dir)
497f225763aSMichael Buesch {
498f225763aSMichael Buesch 	switch (dev->bus->bustype) {
499f225763aSMichael Buesch 	case SSB_BUSTYPE_PCI:
500fd0fcf5cSMichael Buesch #ifdef CONFIG_SSB_PCIHOST
501f225763aSMichael Buesch 		pci_unmap_single(dev->bus->host_pci, dma_addr, size, dir);
502f225763aSMichael Buesch 		return;
503fd0fcf5cSMichael Buesch #endif
504fd0fcf5cSMichael Buesch 		break;
505f225763aSMichael Buesch 	case SSB_BUSTYPE_SSB:
506f225763aSMichael Buesch 		dma_unmap_single(dev->dev, dma_addr, size, dir);
507f225763aSMichael Buesch 		return;
508f225763aSMichael Buesch 	default:
509fd0fcf5cSMichael Buesch 		break;
510f225763aSMichael Buesch 	}
511fd0fcf5cSMichael Buesch 	__ssb_dma_not_implemented(dev);
512f225763aSMichael Buesch }
513f225763aSMichael Buesch 
514f225763aSMichael Buesch static inline void ssb_dma_sync_single_for_cpu(struct ssb_device *dev,
515f225763aSMichael Buesch 					       dma_addr_t dma_addr,
516f225763aSMichael Buesch 					       size_t size,
517f225763aSMichael Buesch 					       enum dma_data_direction dir)
518f225763aSMichael Buesch {
519f225763aSMichael Buesch 	switch (dev->bus->bustype) {
520f225763aSMichael Buesch 	case SSB_BUSTYPE_PCI:
521fd0fcf5cSMichael Buesch #ifdef CONFIG_SSB_PCIHOST
522f225763aSMichael Buesch 		pci_dma_sync_single_for_cpu(dev->bus->host_pci, dma_addr,
523f225763aSMichael Buesch 					    size, dir);
524f225763aSMichael Buesch 		return;
525fd0fcf5cSMichael Buesch #endif
526fd0fcf5cSMichael Buesch 		break;
527f225763aSMichael Buesch 	case SSB_BUSTYPE_SSB:
528f225763aSMichael Buesch 		dma_sync_single_for_cpu(dev->dev, dma_addr, size, dir);
529f225763aSMichael Buesch 		return;
530f225763aSMichael Buesch 	default:
531fd0fcf5cSMichael Buesch 		break;
532f225763aSMichael Buesch 	}
533fd0fcf5cSMichael Buesch 	__ssb_dma_not_implemented(dev);
534f225763aSMichael Buesch }
535f225763aSMichael Buesch 
536f225763aSMichael Buesch static inline void ssb_dma_sync_single_for_device(struct ssb_device *dev,
537f225763aSMichael Buesch 						  dma_addr_t dma_addr,
538f225763aSMichael Buesch 						  size_t size,
539f225763aSMichael Buesch 						  enum dma_data_direction dir)
540f225763aSMichael Buesch {
541f225763aSMichael Buesch 	switch (dev->bus->bustype) {
542f225763aSMichael Buesch 	case SSB_BUSTYPE_PCI:
543fd0fcf5cSMichael Buesch #ifdef CONFIG_SSB_PCIHOST
544f225763aSMichael Buesch 		pci_dma_sync_single_for_device(dev->bus->host_pci, dma_addr,
545f225763aSMichael Buesch 					       size, dir);
546f225763aSMichael Buesch 		return;
547fd0fcf5cSMichael Buesch #endif
548fd0fcf5cSMichael Buesch 		break;
549f225763aSMichael Buesch 	case SSB_BUSTYPE_SSB:
550f225763aSMichael Buesch 		dma_sync_single_for_device(dev->dev, dma_addr, size, dir);
551f225763aSMichael Buesch 		return;
552f225763aSMichael Buesch 	default:
553fd0fcf5cSMichael Buesch 		break;
554f225763aSMichael Buesch 	}
555fd0fcf5cSMichael Buesch 	__ssb_dma_not_implemented(dev);
556f225763aSMichael Buesch }
557f225763aSMichael Buesch 
558f225763aSMichael Buesch static inline void ssb_dma_sync_single_range_for_cpu(struct ssb_device *dev,
559f225763aSMichael Buesch 						     dma_addr_t dma_addr,
560f225763aSMichael Buesch 						     unsigned long offset,
561f225763aSMichael Buesch 						     size_t size,
562f225763aSMichael Buesch 						     enum dma_data_direction dir)
563f225763aSMichael Buesch {
564f225763aSMichael Buesch 	switch (dev->bus->bustype) {
565f225763aSMichael Buesch 	case SSB_BUSTYPE_PCI:
566fd0fcf5cSMichael Buesch #ifdef CONFIG_SSB_PCIHOST
567f225763aSMichael Buesch 		/* Just sync everything. That's all the PCI API can do. */
568f225763aSMichael Buesch 		pci_dma_sync_single_for_cpu(dev->bus->host_pci, dma_addr,
569f225763aSMichael Buesch 					    offset + size, dir);
570f225763aSMichael Buesch 		return;
571fd0fcf5cSMichael Buesch #endif
572fd0fcf5cSMichael Buesch 		break;
573f225763aSMichael Buesch 	case SSB_BUSTYPE_SSB:
574f225763aSMichael Buesch 		dma_sync_single_range_for_cpu(dev->dev, dma_addr, offset,
575f225763aSMichael Buesch 					      size, dir);
576f225763aSMichael Buesch 		return;
577f225763aSMichael Buesch 	default:
578fd0fcf5cSMichael Buesch 		break;
579f225763aSMichael Buesch 	}
580fd0fcf5cSMichael Buesch 	__ssb_dma_not_implemented(dev);
581f225763aSMichael Buesch }
582f225763aSMichael Buesch 
583f225763aSMichael Buesch static inline void ssb_dma_sync_single_range_for_device(struct ssb_device *dev,
584f225763aSMichael Buesch 							dma_addr_t dma_addr,
585f225763aSMichael Buesch 							unsigned long offset,
586f225763aSMichael Buesch 							size_t size,
587f225763aSMichael Buesch 							enum dma_data_direction dir)
588f225763aSMichael Buesch {
589f225763aSMichael Buesch 	switch (dev->bus->bustype) {
590f225763aSMichael Buesch 	case SSB_BUSTYPE_PCI:
591fd0fcf5cSMichael Buesch #ifdef CONFIG_SSB_PCIHOST
592f225763aSMichael Buesch 		/* Just sync everything. That's all the PCI API can do. */
593f225763aSMichael Buesch 		pci_dma_sync_single_for_device(dev->bus->host_pci, dma_addr,
594f225763aSMichael Buesch 					       offset + size, dir);
595f225763aSMichael Buesch 		return;
596fd0fcf5cSMichael Buesch #endif
597fd0fcf5cSMichael Buesch 		break;
598f225763aSMichael Buesch 	case SSB_BUSTYPE_SSB:
599f225763aSMichael Buesch 		dma_sync_single_range_for_device(dev->dev, dma_addr, offset,
600f225763aSMichael Buesch 						 size, dir);
601f225763aSMichael Buesch 		return;
602f225763aSMichael Buesch 	default:
603fd0fcf5cSMichael Buesch 		break;
604f225763aSMichael Buesch 	}
605fd0fcf5cSMichael Buesch 	__ssb_dma_not_implemented(dev);
606f225763aSMichael Buesch }
60761e115a5SMichael Buesch 
60861e115a5SMichael Buesch 
60961e115a5SMichael Buesch #ifdef CONFIG_SSB_PCIHOST
61061e115a5SMichael Buesch /* PCI-host wrapper driver */
61161e115a5SMichael Buesch extern int ssb_pcihost_register(struct pci_driver *driver);
61261e115a5SMichael Buesch static inline void ssb_pcihost_unregister(struct pci_driver *driver)
61361e115a5SMichael Buesch {
61461e115a5SMichael Buesch 	pci_unregister_driver(driver);
61561e115a5SMichael Buesch }
616961d57c8SMiguel Botón 
617961d57c8SMiguel Botón static inline
618961d57c8SMiguel Botón void ssb_pcihost_set_power_state(struct ssb_device *sdev, pci_power_t state)
619961d57c8SMiguel Botón {
620961d57c8SMiguel Botón 	if (sdev->bus->bustype == SSB_BUSTYPE_PCI)
621961d57c8SMiguel Botón 		pci_set_power_state(sdev->bus->host_pci, state);
622961d57c8SMiguel Botón }
623532031d7SAndrew Morton #else
624532031d7SAndrew Morton static inline void ssb_pcihost_unregister(struct pci_driver *driver)
625532031d7SAndrew Morton {
626532031d7SAndrew Morton }
627532031d7SAndrew Morton 
628532031d7SAndrew Morton static inline
629532031d7SAndrew Morton void ssb_pcihost_set_power_state(struct ssb_device *sdev, pci_power_t state)
630532031d7SAndrew Morton {
631532031d7SAndrew Morton }
63261e115a5SMichael Buesch #endif /* CONFIG_SSB_PCIHOST */
63361e115a5SMichael Buesch 
63461e115a5SMichael Buesch 
63561e115a5SMichael Buesch /* If a driver is shutdown or suspended, call this to signal
63661e115a5SMichael Buesch  * that the bus may be completely powered down. SSB will decide,
63761e115a5SMichael Buesch  * if it's really time to power down the bus, based on if there
63861e115a5SMichael Buesch  * are other devices that want to run. */
63961e115a5SMichael Buesch extern int ssb_bus_may_powerdown(struct ssb_bus *bus);
64061e115a5SMichael Buesch /* Before initializing and enabling a device, call this to power-up the bus.
64161e115a5SMichael Buesch  * If you want to allow use of dynamic-power-control, pass the flag.
64261e115a5SMichael Buesch  * Otherwise static always-on powercontrol will be used. */
64361e115a5SMichael Buesch extern int ssb_bus_powerup(struct ssb_bus *bus, bool dynamic_pctl);
64461e115a5SMichael Buesch 
64561e115a5SMichael Buesch 
64661e115a5SMichael Buesch /* Various helper functions */
64761e115a5SMichael Buesch extern u32 ssb_admatch_base(u32 adm);
64861e115a5SMichael Buesch extern u32 ssb_admatch_size(u32 adm);
64961e115a5SMichael Buesch 
650aab547ceSMichael Buesch /* PCI device mapping and fixup routines.
651aab547ceSMichael Buesch  * Called from the architecture pcibios init code.
652aab547ceSMichael Buesch  * These are only available on SSB_EMBEDDED configurations. */
653aab547ceSMichael Buesch #ifdef CONFIG_SSB_EMBEDDED
654aab547ceSMichael Buesch int ssb_pcibios_plat_dev_init(struct pci_dev *dev);
655aab547ceSMichael Buesch int ssb_pcibios_map_irq(const struct pci_dev *dev, u8 slot, u8 pin);
656aab547ceSMichael Buesch #endif /* CONFIG_SSB_EMBEDDED */
65761e115a5SMichael Buesch 
65861e115a5SMichael Buesch #endif /* LINUX_SSB_H_ */
659