blob: ee90e32a0607bf7a5e92bcd8f2da54496cbdfd24 [file] [log] [blame]
Michael Buesch61e115a2007-09-18 15:12:50 -04001#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>
Hauke Mehrtensec43b082012-11-20 22:24:33 +00009#include <linux/gpio.h>
Michael Buesch61e115a2007-09-18 15:12:50 -040010#include <linux/mod_devicetable.h>
Michael Buesch9c0c7a42008-07-09 15:48:45 +020011#include <linux/dma-mapping.h>
Hauke Mehrtensbde327e2012-12-05 18:46:08 +010012#include <linux/platform_device.h>
Michael Buesch61e115a2007-09-18 15:12:50 -040013
14#include <linux/ssb/ssb_regs.h>
15
16
17struct pcmcia_device;
18struct ssb_bus;
19struct ssb_driver;
20
Rafał Miłeckib0f70292012-01-02 08:41:23 +010021struct ssb_sprom_core_pwr_info {
22 u8 itssi_2g, itssi_5g;
23 u8 maxpwr_2g, maxpwr_5gl, maxpwr_5g, maxpwr_5gh;
Hauke Mehrtens3b64e6f2012-02-28 00:56:06 +010024 u16 pa_2g[4], pa_5gl[4], pa_5g[4], pa_5gh[4];
Rafał Miłeckib0f70292012-01-02 08:41:23 +010025};
26
Michael Buesch61e115a2007-09-18 15:12:50 -040027struct ssb_sprom {
28 u8 revision;
Hauke Mehrtens85249822013-02-18 21:47:45 +010029 u8 il0mac[6] __aligned(sizeof(u16)); /* MAC address for 802.11b/g */
30 u8 et0mac[6] __aligned(sizeof(u16)); /* MAC address for Ethernet */
31 u8 et1mac[6] __aligned(sizeof(u16)); /* MAC address for 802.11a */
Larry Fingerac82fab2007-11-09 16:54:45 -060032 u8 et0phyaddr; /* MII address for enet0 */
33 u8 et1phyaddr; /* MII address for enet1 */
Michael Buesche861b982007-12-22 21:51:30 +010034 u8 et0mdcport; /* MDIO for enet0 */
35 u8 et1mdcport; /* MDIO for enet1 */
Rafał Miłecki4f4aa2e2014-05-18 00:22:38 +020036 u16 dev_id; /* Device ID overriding e.g. PCI ID */
Rafał Miłeckie2d646c2011-08-28 18:47:22 +020037 u16 board_rev; /* Board revision number from SPROM. */
Hauke Mehrtens52aa63f2012-02-28 00:56:08 +010038 u16 board_num; /* Board number from SPROM. */
39 u16 board_type; /* Board type from SPROM. */
Larry Fingerac82fab2007-11-09 16:54:45 -060040 u8 country_code; /* Country Code */
Hauke Mehrtens03a56422012-02-28 00:56:07 +010041 char alpha2[2]; /* Country Code as two chars like EU or US */
Hauke Mehrtensedd8d902012-02-28 00:56:04 +010042 u8 leddc_on_time; /* LED Powersave Duty Cycle On Count */
43 u8 leddc_off_time; /* LED Powersave Duty Cycle Off Count */
Gábor Stefanikf6790562009-08-10 21:23:08 +020044 u8 ant_available_a; /* 2GHz antenna available bits (up to 4) */
45 u8 ant_available_bg; /* 5GHz antenna available bits (up to 4) */
Larry Fingerac82fab2007-11-09 16:54:45 -060046 u16 pa0b0;
47 u16 pa0b1;
48 u16 pa0b2;
49 u16 pa1b0;
50 u16 pa1b1;
51 u16 pa1b2;
Gábor Stefanikf6790562009-08-10 21:23:08 +020052 u16 pa1lob0;
53 u16 pa1lob1;
54 u16 pa1lob2;
55 u16 pa1hib0;
56 u16 pa1hib1;
57 u16 pa1hib2;
Larry Fingerac82fab2007-11-09 16:54:45 -060058 u8 gpio0; /* GPIO pin 0 */
59 u8 gpio1; /* GPIO pin 1 */
60 u8 gpio2; /* GPIO pin 2 */
61 u8 gpio3; /* GPIO pin 3 */
Hauke Mehrtensedd8d902012-02-28 00:56:04 +010062 u8 maxpwr_bg; /* 2.4GHz Amplifier Max Power (in dBm Q5.2) */
63 u8 maxpwr_al; /* 5.2GHz Amplifier Max Power (in dBm Q5.2) */
64 u8 maxpwr_a; /* 5.3GHz Amplifier Max Power (in dBm Q5.2) */
65 u8 maxpwr_ah; /* 5.8GHz Amplifier Max Power (in dBm Q5.2) */
Larry Fingerac82fab2007-11-09 16:54:45 -060066 u8 itssi_a; /* Idle TSSI Target for A-PHY */
67 u8 itssi_bg; /* Idle TSSI Target for B/G-PHY */
Gábor Stefanikf6790562009-08-10 21:23:08 +020068 u8 tri2g; /* 2.4GHz TX isolation */
69 u8 tri5gl; /* 5.2GHz TX isolation */
70 u8 tri5g; /* 5.3GHz TX isolation */
71 u8 tri5gh; /* 5.8GHz TX isolation */
Rafał Miłecki172c69a2010-11-28 10:39:35 +010072 u8 txpid2g[4]; /* 2GHz TX power index */
73 u8 txpid5gl[4]; /* 4.9 - 5.1GHz TX power index */
74 u8 txpid5g[4]; /* 5.1 - 5.5GHz TX power index */
75 u8 txpid5gh[4]; /* 5.5 - ...GHz TX power index */
Hauke Mehrtensedd8d902012-02-28 00:56:04 +010076 s8 rxpo2g; /* 2GHz RX power offset */
77 s8 rxpo5g; /* 5GHz RX power offset */
Gábor Stefanikf6790562009-08-10 21:23:08 +020078 u8 rssisav2g; /* 2GHz RSSI params */
79 u8 rssismc2g;
80 u8 rssismf2g;
81 u8 bxa2g; /* 2GHz BX arch */
82 u8 rssisav5g; /* 5GHz RSSI params */
83 u8 rssismc5g;
84 u8 rssismf5g;
85 u8 bxa5g; /* 5GHz BX arch */
86 u16 cck2gpo; /* CCK power offset */
87 u32 ofdm2gpo; /* 2.4GHz OFDM power offset */
88 u32 ofdm5glpo; /* 5.2GHz OFDM power offset */
89 u32 ofdm5gpo; /* 5.3GHz OFDM power offset */
90 u32 ofdm5ghpo; /* 5.8GHz OFDM power offset */
Rafał Miłecki1387fe72015-05-12 11:31:02 +020091 u32 boardflags;
92 u32 boardflags2;
93 u32 boardflags3;
94 /* TODO: Switch all drivers to new u32 fields and drop below ones */
Gábor Stefanikf6790562009-08-10 21:23:08 +020095 u16 boardflags_lo; /* Board flags (bits 0-15) */
96 u16 boardflags_hi; /* Board flags (bits 16-31) */
97 u16 boardflags2_lo; /* Board flags (bits 32-47) */
98 u16 boardflags2_hi; /* Board flags (bits 48-63) */
Michael Buesche861b982007-12-22 21:51:30 +010099
Rafał Miłeckib0f70292012-01-02 08:41:23 +0100100 struct ssb_sprom_core_pwr_info core_pwr_info[4];
101
Michael Buesche861b982007-12-22 21:51:30 +0100102 /* Antenna gain values for up to 4 antennas
103 * on each band. Values in dBm/4 (Q5.2). Negative gain means the
104 * loss in the connectors is bigger than the gain. */
105 struct {
Hauke Mehrtensf8f8a662012-02-28 00:56:05 +0100106 s8 a0, a1, a2, a3;
Michael Buesche861b982007-12-22 21:51:30 +0100107 } antenna_gain;
Larry Fingerac82fab2007-11-09 16:54:45 -0600108
Rafał Miłecki8a5ac6e2011-12-08 18:02:21 +0100109 struct {
110 struct {
111 u8 tssipos, extpa_gain, pdet_range, tr_iso, antswlut;
112 } ghz2;
113 struct {
114 u8 tssipos, extpa_gain, pdet_range, tr_iso, antswlut;
115 } ghz5;
116 } fem;
117
Hauke Mehrtens52aa63f2012-02-28 00:56:08 +0100118 u16 mcs2gpo[8];
119 u16 mcs5gpo[8];
120 u16 mcs5glpo[8];
121 u16 mcs5ghpo[8];
122 u8 opo;
123
124 u8 rxgainerr2ga[3];
125 u8 rxgainerr5gla[3];
126 u8 rxgainerr5gma[3];
127 u8 rxgainerr5gha[3];
128 u8 rxgainerr5gua[3];
129
130 u8 noiselvl2ga[3];
131 u8 noiselvl5gla[3];
132 u8 noiselvl5gma[3];
133 u8 noiselvl5gha[3];
134 u8 noiselvl5gua[3];
135
136 u8 regrev;
137 u8 txchain;
138 u8 rxchain;
139 u8 antswitch;
140 u16 cddpo;
141 u16 stbcpo;
142 u16 bw40po;
143 u16 bwduppo;
144
145 u8 tempthresh;
146 u8 tempoffset;
147 u16 rawtempsense;
148 u8 measpower;
149 u8 tempsense_slope;
150 u8 tempcorrx;
151 u8 tempsense_option;
152 u8 freqoffset_corr;
153 u8 iqcal_swp_dis;
154 u8 hw_iqcal_en;
155 u8 elna2g;
156 u8 elna5g;
157 u8 phycal_tempdelta;
158 u8 temps_period;
159 u8 temps_hysteresis;
160 u8 measpower1;
161 u8 measpower2;
162 u8 pcieingress_war;
163
164 /* power per rate from sromrev 9 */
165 u16 cckbw202gpo;
166 u16 cckbw20ul2gpo;
167 u32 legofdmbw202gpo;
168 u32 legofdmbw20ul2gpo;
169 u32 legofdmbw205glpo;
170 u32 legofdmbw20ul5glpo;
171 u32 legofdmbw205gmpo;
172 u32 legofdmbw20ul5gmpo;
173 u32 legofdmbw205ghpo;
174 u32 legofdmbw20ul5ghpo;
175 u32 mcsbw202gpo;
176 u32 mcsbw20ul2gpo;
177 u32 mcsbw402gpo;
178 u32 mcsbw205glpo;
179 u32 mcsbw20ul5glpo;
180 u32 mcsbw405glpo;
181 u32 mcsbw205gmpo;
182 u32 mcsbw20ul5gmpo;
183 u32 mcsbw405gmpo;
184 u32 mcsbw205ghpo;
185 u32 mcsbw20ul5ghpo;
186 u32 mcsbw405ghpo;
187 u16 mcs32po;
188 u16 legofdm40duppo;
189 u8 sar2g;
190 u8 sar5g;
Michael Buesch61e115a2007-09-18 15:12:50 -0400191};
192
193/* Information about the PCB the circuitry is soldered on. */
194struct ssb_boardinfo {
195 u16 vendor;
196 u16 type;
Michael Buesch61e115a2007-09-18 15:12:50 -0400197};
198
199
200struct ssb_device;
201/* Lowlevel read/write operations on the device MMIO.
202 * Internal, don't use that outside of ssb. */
203struct ssb_bus_ops {
Michael Bueschffc76892008-02-20 19:08:10 +0100204 u8 (*read8)(struct ssb_device *dev, u16 offset);
Michael Buesch61e115a2007-09-18 15:12:50 -0400205 u16 (*read16)(struct ssb_device *dev, u16 offset);
206 u32 (*read32)(struct ssb_device *dev, u16 offset);
Michael Bueschffc76892008-02-20 19:08:10 +0100207 void (*write8)(struct ssb_device *dev, u16 offset, u8 value);
Michael Buesch61e115a2007-09-18 15:12:50 -0400208 void (*write16)(struct ssb_device *dev, u16 offset, u16 value);
209 void (*write32)(struct ssb_device *dev, u16 offset, u32 value);
Michael Bueschd625a292008-04-02 19:46:56 +0200210#ifdef CONFIG_SSB_BLOCKIO
211 void (*block_read)(struct ssb_device *dev, void *buffer,
212 size_t count, u16 offset, u8 reg_width);
213 void (*block_write)(struct ssb_device *dev, const void *buffer,
214 size_t count, u16 offset, u8 reg_width);
215#endif
Michael Buesch61e115a2007-09-18 15:12:50 -0400216};
217
218
219/* Core-ID values. */
220#define SSB_DEV_CHIPCOMMON 0x800
221#define SSB_DEV_ILINE20 0x801
222#define SSB_DEV_SDRAM 0x803
223#define SSB_DEV_PCI 0x804
224#define SSB_DEV_MIPS 0x805
225#define SSB_DEV_ETHERNET 0x806
226#define SSB_DEV_V90 0x807
227#define SSB_DEV_USB11_HOSTDEV 0x808
228#define SSB_DEV_ADSL 0x809
229#define SSB_DEV_ILINE100 0x80A
230#define SSB_DEV_IPSEC 0x80B
231#define SSB_DEV_PCMCIA 0x80D
232#define SSB_DEV_INTERNAL_MEM 0x80E
233#define SSB_DEV_MEMC_SDRAM 0x80F
234#define SSB_DEV_EXTIF 0x811
235#define SSB_DEV_80211 0x812
236#define SSB_DEV_MIPS_3302 0x816
237#define SSB_DEV_USB11_HOST 0x817
238#define SSB_DEV_USB11_DEV 0x818
239#define SSB_DEV_USB20_HOST 0x819
240#define SSB_DEV_USB20_DEV 0x81A
241#define SSB_DEV_SDIO_HOST 0x81B
242#define SSB_DEV_ROBOSWITCH 0x81C
243#define SSB_DEV_PARA_ATA 0x81D
244#define SSB_DEV_SATA_XORDMA 0x81E
245#define SSB_DEV_ETHERNET_GBIT 0x81F
246#define SSB_DEV_PCIE 0x820
247#define SSB_DEV_MIMO_PHY 0x821
248#define SSB_DEV_SRAM_CTRLR 0x822
249#define SSB_DEV_MINI_MACPHY 0x823
250#define SSB_DEV_ARM_1176 0x824
251#define SSB_DEV_ARM_7TDMI 0x825
Hauke Mehrtensccaf8c32012-05-31 22:38:22 +0200252#define SSB_DEV_ARM_CM3 0x82A
Michael Buesch61e115a2007-09-18 15:12:50 -0400253
254/* Vendor-ID values */
255#define SSB_VENDOR_BROADCOM 0x4243
256
257/* Some kernel subsystems poke with dev->drvdata, so we must use the
258 * following ugly workaround to get from struct device to struct ssb_device */
259struct __ssb_dev_wrapper {
260 struct device dev;
261 struct ssb_device *sdev;
262};
263
264struct ssb_device {
265 /* Having a copy of the ops pointer in each dev struct
266 * is an optimization. */
267 const struct ssb_bus_ops *ops;
268
FUJITA Tomonori14f92952010-06-03 19:37:27 -0700269 struct device *dev, *dma_dev;
Michael Buesch4ac58462008-04-11 11:59:00 +0200270
Michael Buesch61e115a2007-09-18 15:12:50 -0400271 struct ssb_bus *bus;
272 struct ssb_device_id id;
273
274 u8 core_index;
275 unsigned int irq;
276
277 /* Internal-only stuff follows. */
278 void *drvdata; /* Per-device data */
279 void *devtypedata; /* Per-devicetype (eg 802.11) data */
280};
281
282/* Go from struct device to struct ssb_device. */
283static inline
284struct ssb_device * dev_to_ssb_dev(struct device *dev)
285{
286 struct __ssb_dev_wrapper *wrap;
287 wrap = container_of(dev, struct __ssb_dev_wrapper, dev);
288 return wrap->sdev;
289}
290
291/* Device specific user data */
292static inline
293void ssb_set_drvdata(struct ssb_device *dev, void *data)
294{
295 dev->drvdata = data;
296}
297static inline
298void * ssb_get_drvdata(struct ssb_device *dev)
299{
300 return dev->drvdata;
301}
302
303/* Devicetype specific user data. This is per device-type (not per device) */
304void ssb_set_devtypedata(struct ssb_device *dev, void *data);
305static inline
306void * ssb_get_devtypedata(struct ssb_device *dev)
307{
308 return dev->devtypedata;
309}
310
311
312struct ssb_driver {
313 const char *name;
314 const struct ssb_device_id *id_table;
315
316 int (*probe)(struct ssb_device *dev, const struct ssb_device_id *id);
317 void (*remove)(struct ssb_device *dev);
318 int (*suspend)(struct ssb_device *dev, pm_message_t state);
319 int (*resume)(struct ssb_device *dev);
320 void (*shutdown)(struct ssb_device *dev);
321
322 struct device_driver drv;
323};
324#define drv_to_ssb_drv(_drv) container_of(_drv, struct ssb_driver, drv)
325
326extern int __ssb_driver_register(struct ssb_driver *drv, struct module *owner);
Paul Gortmakereb5589a2011-05-27 09:02:11 -0400327#define ssb_driver_register(drv) \
328 __ssb_driver_register(drv, THIS_MODULE)
329
Michael Buesch61e115a2007-09-18 15:12:50 -0400330extern void ssb_driver_unregister(struct ssb_driver *drv);
331
332
333
334
335enum ssb_bustype {
336 SSB_BUSTYPE_SSB, /* This SSB bus is the system bus */
337 SSB_BUSTYPE_PCI, /* SSB is connected to PCI bus */
338 SSB_BUSTYPE_PCMCIA, /* SSB is connected to PCMCIA bus */
Albert Herranz24ea6022009-09-08 19:30:12 +0200339 SSB_BUSTYPE_SDIO, /* SSB is connected to SDIO bus */
Michael Buesch61e115a2007-09-18 15:12:50 -0400340};
341
342/* board_vendor */
343#define SSB_BOARDVENDOR_BCM 0x14E4 /* Broadcom */
344#define SSB_BOARDVENDOR_DELL 0x1028 /* Dell */
345#define SSB_BOARDVENDOR_HP 0x0E11 /* HP */
346/* board_type */
Rafał Miłeckic5116e92013-03-19 16:58:58 +0100347#define SSB_BOARD_BCM94301CB 0x0406
348#define SSB_BOARD_BCM94301MP 0x0407
349#define SSB_BOARD_BU4309 0x040A
350#define SSB_BOARD_BCM94309CB 0x040B
351#define SSB_BOARD_BCM4309MP 0x040C
352#define SSB_BOARD_BU4306 0x0416
Michael Buesch61e115a2007-09-18 15:12:50 -0400353#define SSB_BOARD_BCM94306MP 0x0418
354#define SSB_BOARD_BCM4309G 0x0421
355#define SSB_BOARD_BCM4306CB 0x0417
Rafał Miłeckic5116e92013-03-19 16:58:58 +0100356#define SSB_BOARD_BCM94306PC 0x0425 /* pcmcia 3.3v 4306 card */
357#define SSB_BOARD_BCM94306CBSG 0x042B /* with SiGe PA */
358#define SSB_BOARD_PCSG94306 0x042D /* with SiGe PA */
359#define SSB_BOARD_BU4704SD 0x042E /* with sdram */
360#define SSB_BOARD_BCM94704AGR 0x042F /* dual 11a/11g Router */
361#define SSB_BOARD_BCM94308MP 0x0430 /* 11a-only minipci */
362#define SSB_BOARD_BU4318 0x0447
363#define SSB_BOARD_CB4318 0x0448
364#define SSB_BOARD_MPG4318 0x0449
Michael Buesch61e115a2007-09-18 15:12:50 -0400365#define SSB_BOARD_MP4318 0x044A
Rafał Miłeckic5116e92013-03-19 16:58:58 +0100366#define SSB_BOARD_SD4318 0x044B
367#define SSB_BOARD_BCM94306P 0x044C /* with SiGe */
368#define SSB_BOARD_BCM94303MP 0x044E
369#define SSB_BOARD_BCM94306MPM 0x0450
370#define SSB_BOARD_BCM94306MPL 0x0453
371#define SSB_BOARD_PC4303 0x0454 /* pcmcia */
372#define SSB_BOARD_BCM94306MPLNA 0x0457
373#define SSB_BOARD_BCM94306MPH 0x045B
374#define SSB_BOARD_BCM94306PCIV 0x045C
375#define SSB_BOARD_BCM94318MPGH 0x0463
376#define SSB_BOARD_BU4311 0x0464
377#define SSB_BOARD_BCM94311MC 0x0465
378#define SSB_BOARD_BCM94311MCAG 0x0466
379/* 4321 boards */
380#define SSB_BOARD_BU4321 0x046B
381#define SSB_BOARD_BU4321E 0x047C
382#define SSB_BOARD_MP4321 0x046C
383#define SSB_BOARD_CB2_4321 0x046D
384#define SSB_BOARD_CB2_4321_AG 0x0066
385#define SSB_BOARD_MC4321 0x046E
386/* 4325 boards */
387#define SSB_BOARD_BCM94325DEVBU 0x0490
388#define SSB_BOARD_BCM94325BGABU 0x0491
389#define SSB_BOARD_BCM94325SDGWB 0x0492
390#define SSB_BOARD_BCM94325SDGMDL 0x04AA
391#define SSB_BOARD_BCM94325SDGMDL2 0x04C6
392#define SSB_BOARD_BCM94325SDGMDL3 0x04C9
393#define SSB_BOARD_BCM94325SDABGWBA 0x04E1
394/* 4322 boards */
395#define SSB_BOARD_BCM94322MC 0x04A4
396#define SSB_BOARD_BCM94322USB 0x04A8 /* dualband */
397#define SSB_BOARD_BCM94322HM 0x04B0
398#define SSB_BOARD_BCM94322USB2D 0x04Bf /* single band discrete front end */
399/* 4312 boards */
400#define SSB_BOARD_BU4312 0x048A
401#define SSB_BOARD_BCM4312MCGSG 0x04B5
Michael Buesch61e115a2007-09-18 15:12:50 -0400402/* chip_package */
403#define SSB_CHIPPACK_BCM4712S 1 /* Small 200pin 4712 */
404#define SSB_CHIPPACK_BCM4712M 2 /* Medium 225pin 4712 */
405#define SSB_CHIPPACK_BCM4712L 0 /* Large 340pin 4712 */
406
407#include <linux/ssb/ssb_driver_chipcommon.h>
408#include <linux/ssb/ssb_driver_mips.h>
409#include <linux/ssb/ssb_driver_extif.h>
410#include <linux/ssb/ssb_driver_pci.h>
411
412struct ssb_bus {
413 /* The MMIO area. */
414 void __iomem *mmio;
415
416 const struct ssb_bus_ops *ops;
417
Michael Buesch8b454992009-10-09 20:32:10 +0200418 /* The core currently mapped into the MMIO window.
419 * Not valid on all host-buses. So don't use outside of SSB. */
Michael Buesch61e115a2007-09-18 15:12:50 -0400420 struct ssb_device *mapped_device;
Albert Herranz24ea6022009-09-08 19:30:12 +0200421 union {
422 /* Currently mapped PCMCIA segment. (bustype == SSB_BUSTYPE_PCMCIA only) */
423 u8 mapped_pcmcia_seg;
424 /* Current SSB base address window for SDIO. */
425 u32 sdio_sbaddr;
426 };
Michael Buesch993e1c72007-12-22 22:01:36 +0100427 /* Lock for core and segment switching.
428 * On PCMCIA-host busses this is used to protect the whole MMIO access. */
Michael Buesch61e115a2007-09-18 15:12:50 -0400429 spinlock_t bar_lock;
430
Michael Buesch8b454992009-10-09 20:32:10 +0200431 /* The host-bus this backplane is running on. */
Michael Buesch61e115a2007-09-18 15:12:50 -0400432 enum ssb_bustype bustype;
Michael Buesch8b454992009-10-09 20:32:10 +0200433 /* Pointers to the host-bus. Check bustype before using any of these pointers. */
434 union {
435 /* Pointer to the PCI bus (only valid if bustype == SSB_BUSTYPE_PCI). */
436 struct pci_dev *host_pci;
437 /* Pointer to the PCMCIA device (only if bustype == SSB_BUSTYPE_PCMCIA). */
438 struct pcmcia_device *host_pcmcia;
439 /* Pointer to the SDIO device (only if bustype == SSB_BUSTYPE_SDIO). */
440 struct sdio_func *host_sdio;
441 };
Albert Herranz24ea6022009-09-08 19:30:12 +0200442
443 /* See enum ssb_quirks */
444 unsigned int quirks;
Michael Buesch61e115a2007-09-18 15:12:50 -0400445
Michael Buesche7ec2e32008-03-10 17:26:32 +0100446#ifdef CONFIG_SSB_SPROM
Michael Buesch61e115a2007-09-18 15:12:50 -0400447 /* Mutex to protect the SPROM writing. */
Michael Buesche7ec2e32008-03-10 17:26:32 +0100448 struct mutex sprom_mutex;
Michael Buesch61e115a2007-09-18 15:12:50 -0400449#endif
450
451 /* ID information about the Chip. */
452 u16 chip_id;
Rafał Miłeckice57d9e62011-04-01 12:06:48 +0200453 u8 chip_rev;
Rafał Miłeckiea2db492010-03-31 21:59:21 +0200454 u16 sprom_offset;
Larry Fingerc272ef42007-11-09 16:56:25 -0600455 u16 sprom_size; /* number of words in sprom */
Michael Buesch61e115a2007-09-18 15:12:50 -0400456 u8 chip_package;
457
458 /* List of devices (cores) on the backplane. */
459 struct ssb_device devices[SSB_MAX_NR_CORES];
460 u8 nr_devices;
461
Michael Buesch61e115a2007-09-18 15:12:50 -0400462 /* Software ID number for this bus. */
463 unsigned int busnumber;
464
465 /* The ChipCommon device (if available). */
466 struct ssb_chipcommon chipco;
467 /* The PCI-core device (if available). */
468 struct ssb_pcicore pcicore;
469 /* The MIPS-core device (if available). */
470 struct ssb_mipscore mipscore;
471 /* The EXTif-core device (if available). */
472 struct ssb_extif extif;
473
474 /* The following structure elements are not available in early
475 * SSB initialization. Though, they are available for regular
476 * registered drivers at any stage. So be careful when
477 * using them in the ssb core code. */
478
479 /* ID information about the PCB. */
480 struct ssb_boardinfo boardinfo;
481 /* Contents of the SPROM. */
482 struct ssb_sprom sprom;
Michael Buesch7cb44612008-02-19 17:46:48 +0100483 /* If the board has a cardbus slot, this is set to true. */
484 bool has_cardbus_slot;
Michael Buesch61e115a2007-09-18 15:12:50 -0400485
Michael Buesch53521d82008-02-19 16:22:50 +0100486#ifdef CONFIG_SSB_EMBEDDED
487 /* Lock for GPIO register access. */
488 spinlock_t gpio_lock;
Hauke Mehrtensbde327e2012-12-05 18:46:08 +0100489 struct platform_device *watchdog;
Michael Buesch53521d82008-02-19 16:22:50 +0100490#endif /* EMBEDDED */
Hauke Mehrtensec43b082012-11-20 22:24:33 +0000491#ifdef CONFIG_SSB_DRIVER_GPIO
492 struct gpio_chip gpio;
Rafał Miłecki7c1bc0d2014-01-13 19:56:08 +0100493 struct irq_domain *irq_domain;
Hauke Mehrtensec43b082012-11-20 22:24:33 +0000494#endif /* DRIVER_GPIO */
Michael Buesch53521d82008-02-19 16:22:50 +0100495
Michael Buesch61e115a2007-09-18 15:12:50 -0400496 /* Internal-only stuff follows. Do not touch. */
497 struct list_head list;
498#ifdef CONFIG_SSB_DEBUG
499 /* Is the bus already powered up? */
500 bool powered_up;
501 int power_warn_count;
502#endif /* DEBUG */
503};
504
Albert Herranz24ea6022009-09-08 19:30:12 +0200505enum ssb_quirks {
506 /* SDIO connected card requires performing a read after writing a 32-bit value */
507 SSB_QUIRK_SDIO_READ_AFTER_WRITE32 = (1 << 0),
508};
509
Michael Buesch61e115a2007-09-18 15:12:50 -0400510/* The initialization-invariants. */
511struct ssb_init_invariants {
Michael Buesch7cb44612008-02-19 17:46:48 +0100512 /* Versioning information about the PCB. */
Michael Buesch61e115a2007-09-18 15:12:50 -0400513 struct ssb_boardinfo boardinfo;
Michael Buesch7cb44612008-02-19 17:46:48 +0100514 /* The SPROM information. That's either stored in an
515 * EEPROM or NVRAM on the board. */
Michael Buesch61e115a2007-09-18 15:12:50 -0400516 struct ssb_sprom sprom;
Michael Buesch7cb44612008-02-19 17:46:48 +0100517 /* If the board has a cardbus slot, this is set to true. */
518 bool has_cardbus_slot;
Michael Buesch61e115a2007-09-18 15:12:50 -0400519};
520/* Type of function to fetch the invariants. */
521typedef int (*ssb_invariants_func_t)(struct ssb_bus *bus,
522 struct ssb_init_invariants *iv);
523
524/* Register a SSB system bus. get_invariants() is called after the
525 * basic system devices are initialized.
526 * The invariants are usually fetched from some NVRAM.
527 * Put the invariants into the struct pointed to by iv. */
528extern int ssb_bus_ssbbus_register(struct ssb_bus *bus,
529 unsigned long baseaddr,
530 ssb_invariants_func_t get_invariants);
531#ifdef CONFIG_SSB_PCIHOST
532extern int ssb_bus_pcibus_register(struct ssb_bus *bus,
533 struct pci_dev *host_pci);
534#endif /* CONFIG_SSB_PCIHOST */
535#ifdef CONFIG_SSB_PCMCIAHOST
536extern int ssb_bus_pcmciabus_register(struct ssb_bus *bus,
537 struct pcmcia_device *pcmcia_dev,
538 unsigned long baseaddr);
539#endif /* CONFIG_SSB_PCMCIAHOST */
Albert Herranz24ea6022009-09-08 19:30:12 +0200540#ifdef CONFIG_SSB_SDIOHOST
541extern int ssb_bus_sdiobus_register(struct ssb_bus *bus,
542 struct sdio_func *sdio_func,
543 unsigned int quirks);
544#endif /* CONFIG_SSB_SDIOHOST */
545
Michael Buesch61e115a2007-09-18 15:12:50 -0400546
547extern void ssb_bus_unregister(struct ssb_bus *bus);
548
John W. Linvilled53cdbb2010-03-31 21:39:35 +0200549/* Does the device have an SPROM? */
550extern bool ssb_is_sprom_available(struct ssb_bus *bus);
551
Michael Buesche79c1ba2009-02-27 16:59:05 +0100552/* Set a fallback SPROM.
553 * See kdoc at the function definition for complete documentation. */
Hauke Mehrtensb3ae52b2011-05-10 23:31:30 +0200554extern int ssb_arch_register_fallback_sprom(
555 int (*sprom_callback)(struct ssb_bus *bus,
556 struct ssb_sprom *out));
Michael Buesche79c1ba2009-02-27 16:59:05 +0100557
Michael Buesch8fe2b652008-03-30 00:10:50 +0100558/* Suspend a SSB bus.
559 * Call this from the parent bus suspend routine. */
560extern int ssb_bus_suspend(struct ssb_bus *bus);
561/* Resume a SSB bus.
562 * Call this from the parent bus resume routine. */
563extern int ssb_bus_resume(struct ssb_bus *bus);
564
Michael Buesch61e115a2007-09-18 15:12:50 -0400565extern u32 ssb_clockspeed(struct ssb_bus *bus);
566
567/* Is the device enabled in hardware? */
568int ssb_device_is_enabled(struct ssb_device *dev);
569/* Enable a device and pass device-specific SSB_TMSLOW flags.
570 * If no device-specific flags are available, use 0. */
571void ssb_device_enable(struct ssb_device *dev, u32 core_specific_flags);
572/* Disable a device in hardware and pass SSB_TMSLOW flags (if any). */
573void ssb_device_disable(struct ssb_device *dev, u32 core_specific_flags);
574
575
576/* Device MMIO register read/write functions. */
Michael Bueschffc76892008-02-20 19:08:10 +0100577static inline u8 ssb_read8(struct ssb_device *dev, u16 offset)
578{
579 return dev->ops->read8(dev, offset);
580}
Michael Buesch61e115a2007-09-18 15:12:50 -0400581static inline u16 ssb_read16(struct ssb_device *dev, u16 offset)
582{
583 return dev->ops->read16(dev, offset);
584}
585static inline u32 ssb_read32(struct ssb_device *dev, u16 offset)
586{
587 return dev->ops->read32(dev, offset);
588}
Michael Bueschffc76892008-02-20 19:08:10 +0100589static inline void ssb_write8(struct ssb_device *dev, u16 offset, u8 value)
590{
591 dev->ops->write8(dev, offset, value);
592}
Michael Buesch61e115a2007-09-18 15:12:50 -0400593static inline void ssb_write16(struct ssb_device *dev, u16 offset, u16 value)
594{
595 dev->ops->write16(dev, offset, value);
596}
597static inline void ssb_write32(struct ssb_device *dev, u16 offset, u32 value)
598{
599 dev->ops->write32(dev, offset, value);
600}
Michael Bueschd625a292008-04-02 19:46:56 +0200601#ifdef CONFIG_SSB_BLOCKIO
602static inline void ssb_block_read(struct ssb_device *dev, void *buffer,
603 size_t count, u16 offset, u8 reg_width)
604{
605 dev->ops->block_read(dev, buffer, count, offset, reg_width);
606}
607
608static inline void ssb_block_write(struct ssb_device *dev, const void *buffer,
609 size_t count, u16 offset, u8 reg_width)
610{
611 dev->ops->block_write(dev, buffer, count, offset, reg_width);
612}
613#endif /* CONFIG_SSB_BLOCKIO */
Michael Buesch61e115a2007-09-18 15:12:50 -0400614
615
Michael Bueschf2257632008-06-20 11:50:29 +0200616/* The SSB DMA API. Use this API for any DMA operation on the device.
617 * This API basically is a wrapper that calls the correct DMA API for
618 * the host device type the SSB device is attached to. */
619
Michael Buesch61e115a2007-09-18 15:12:50 -0400620/* Translation (routing) bits that need to be ORed to DMA
621 * addresses before they are given to a device. */
622extern u32 ssb_dma_translation(struct ssb_device *dev);
623#define SSB_DMA_TRANSLATION_MASK 0xC0000000
624#define SSB_DMA_TRANSLATION_SHIFT 30
625
Michael Bueschf2257632008-06-20 11:50:29 +0200626static inline void __cold __ssb_dma_not_implemented(struct ssb_device *dev)
627{
628#ifdef CONFIG_SSB_DEBUG
629 printk(KERN_ERR "SSB: BUG! Calling DMA API for "
630 "unsupported bustype %d\n", dev->bus->bustype);
631#endif /* DEBUG */
632}
633
Michael Buesch61e115a2007-09-18 15:12:50 -0400634#ifdef CONFIG_SSB_PCIHOST
635/* PCI-host wrapper driver */
636extern int ssb_pcihost_register(struct pci_driver *driver);
637static inline void ssb_pcihost_unregister(struct pci_driver *driver)
638{
639 pci_unregister_driver(driver);
640}
Miguel Botón961d57c2008-01-01 01:16:46 +0100641
642static inline
643void ssb_pcihost_set_power_state(struct ssb_device *sdev, pci_power_t state)
644{
645 if (sdev->bus->bustype == SSB_BUSTYPE_PCI)
646 pci_set_power_state(sdev->bus->host_pci, state);
647}
Andrew Morton532031d2008-02-04 23:58:42 -0800648#else
649static inline void ssb_pcihost_unregister(struct pci_driver *driver)
650{
651}
652
653static inline
654void ssb_pcihost_set_power_state(struct ssb_device *sdev, pci_power_t state)
655{
656}
Michael Buesch61e115a2007-09-18 15:12:50 -0400657#endif /* CONFIG_SSB_PCIHOST */
658
659
660/* If a driver is shutdown or suspended, call this to signal
661 * that the bus may be completely powered down. SSB will decide,
662 * if it's really time to power down the bus, based on if there
663 * are other devices that want to run. */
664extern int ssb_bus_may_powerdown(struct ssb_bus *bus);
665/* Before initializing and enabling a device, call this to power-up the bus.
666 * If you want to allow use of dynamic-power-control, pass the flag.
667 * Otherwise static always-on powercontrol will be used. */
668extern int ssb_bus_powerup(struct ssb_bus *bus, bool dynamic_pctl);
669
Rafał Miłecki8576f812011-05-11 02:10:58 +0200670extern void ssb_commit_settings(struct ssb_bus *bus);
Michael Buesch61e115a2007-09-18 15:12:50 -0400671
672/* Various helper functions */
673extern u32 ssb_admatch_base(u32 adm);
674extern u32 ssb_admatch_size(u32 adm);
675
Michael Bueschaab547c2008-02-29 11:36:12 +0100676/* PCI device mapping and fixup routines.
677 * Called from the architecture pcibios init code.
678 * These are only available on SSB_EMBEDDED configurations. */
679#ifdef CONFIG_SSB_EMBEDDED
680int ssb_pcibios_plat_dev_init(struct pci_dev *dev);
681int ssb_pcibios_map_irq(const struct pci_dev *dev, u8 slot, u8 pin);
682#endif /* CONFIG_SSB_EMBEDDED */
Michael Buesch61e115a2007-09-18 15:12:50 -0400683
684#endif /* LINUX_SSB_H_ */