ssb.h 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681
  1. #ifndef LINUX_SSB_H_
  2. #define LINUX_SSB_H_
  3. #include <linux/device.h>
  4. #include <linux/list.h>
  5. #include <linux/types.h>
  6. #include <linux/spinlock.h>
  7. #include <linux/pci.h>
  8. #include <linux/gpio.h>
  9. #include <linux/mod_devicetable.h>
  10. #include <linux/dma-mapping.h>
  11. #include <linux/platform_device.h>
  12. #include <linux/ssb/ssb_regs.h>
  13. struct pcmcia_device;
  14. struct ssb_bus;
  15. struct ssb_driver;
  16. struct ssb_sprom_core_pwr_info {
  17. u8 itssi_2g, itssi_5g;
  18. u8 maxpwr_2g, maxpwr_5gl, maxpwr_5g, maxpwr_5gh;
  19. u16 pa_2g[4], pa_5gl[4], pa_5g[4], pa_5gh[4];
  20. };
  21. struct ssb_sprom {
  22. u8 revision;
  23. u8 il0mac[6] __aligned(sizeof(u16)); /* MAC address for 802.11b/g */
  24. u8 et0mac[6] __aligned(sizeof(u16)); /* MAC address for Ethernet */
  25. u8 et1mac[6] __aligned(sizeof(u16)); /* MAC address for 802.11a */
  26. u8 et0phyaddr; /* MII address for enet0 */
  27. u8 et1phyaddr; /* MII address for enet1 */
  28. u8 et0mdcport; /* MDIO for enet0 */
  29. u8 et1mdcport; /* MDIO for enet1 */
  30. u16 dev_id; /* Device ID overriding e.g. PCI ID */
  31. u16 board_rev; /* Board revision number from SPROM. */
  32. u16 board_num; /* Board number from SPROM. */
  33. u16 board_type; /* Board type from SPROM. */
  34. u8 country_code; /* Country Code */
  35. char alpha2[2]; /* Country Code as two chars like EU or US */
  36. u8 leddc_on_time; /* LED Powersave Duty Cycle On Count */
  37. u8 leddc_off_time; /* LED Powersave Duty Cycle Off Count */
  38. u8 ant_available_a; /* 2GHz antenna available bits (up to 4) */
  39. u8 ant_available_bg; /* 5GHz antenna available bits (up to 4) */
  40. u16 pa0b0;
  41. u16 pa0b1;
  42. u16 pa0b2;
  43. u16 pa1b0;
  44. u16 pa1b1;
  45. u16 pa1b2;
  46. u16 pa1lob0;
  47. u16 pa1lob1;
  48. u16 pa1lob2;
  49. u16 pa1hib0;
  50. u16 pa1hib1;
  51. u16 pa1hib2;
  52. u8 gpio0; /* GPIO pin 0 */
  53. u8 gpio1; /* GPIO pin 1 */
  54. u8 gpio2; /* GPIO pin 2 */
  55. u8 gpio3; /* GPIO pin 3 */
  56. u8 maxpwr_bg; /* 2.4GHz Amplifier Max Power (in dBm Q5.2) */
  57. u8 maxpwr_al; /* 5.2GHz Amplifier Max Power (in dBm Q5.2) */
  58. u8 maxpwr_a; /* 5.3GHz Amplifier Max Power (in dBm Q5.2) */
  59. u8 maxpwr_ah; /* 5.8GHz Amplifier Max Power (in dBm Q5.2) */
  60. u8 itssi_a; /* Idle TSSI Target for A-PHY */
  61. u8 itssi_bg; /* Idle TSSI Target for B/G-PHY */
  62. u8 tri2g; /* 2.4GHz TX isolation */
  63. u8 tri5gl; /* 5.2GHz TX isolation */
  64. u8 tri5g; /* 5.3GHz TX isolation */
  65. u8 tri5gh; /* 5.8GHz TX isolation */
  66. u8 txpid2g[4]; /* 2GHz TX power index */
  67. u8 txpid5gl[4]; /* 4.9 - 5.1GHz TX power index */
  68. u8 txpid5g[4]; /* 5.1 - 5.5GHz TX power index */
  69. u8 txpid5gh[4]; /* 5.5 - ...GHz TX power index */
  70. s8 rxpo2g; /* 2GHz RX power offset */
  71. s8 rxpo5g; /* 5GHz RX power offset */
  72. u8 rssisav2g; /* 2GHz RSSI params */
  73. u8 rssismc2g;
  74. u8 rssismf2g;
  75. u8 bxa2g; /* 2GHz BX arch */
  76. u8 rssisav5g; /* 5GHz RSSI params */
  77. u8 rssismc5g;
  78. u8 rssismf5g;
  79. u8 bxa5g; /* 5GHz BX arch */
  80. u16 cck2gpo; /* CCK power offset */
  81. u32 ofdm2gpo; /* 2.4GHz OFDM power offset */
  82. u32 ofdm5glpo; /* 5.2GHz OFDM power offset */
  83. u32 ofdm5gpo; /* 5.3GHz OFDM power offset */
  84. u32 ofdm5ghpo; /* 5.8GHz OFDM power offset */
  85. u16 boardflags_lo; /* Board flags (bits 0-15) */
  86. u16 boardflags_hi; /* Board flags (bits 16-31) */
  87. u16 boardflags2_lo; /* Board flags (bits 32-47) */
  88. u16 boardflags2_hi; /* Board flags (bits 48-63) */
  89. /* TODO store board flags in a single u64 */
  90. struct ssb_sprom_core_pwr_info core_pwr_info[4];
  91. /* Antenna gain values for up to 4 antennas
  92. * on each band. Values in dBm/4 (Q5.2). Negative gain means the
  93. * loss in the connectors is bigger than the gain. */
  94. struct {
  95. s8 a0, a1, a2, a3;
  96. } antenna_gain;
  97. struct {
  98. struct {
  99. u8 tssipos, extpa_gain, pdet_range, tr_iso, antswlut;
  100. } ghz2;
  101. struct {
  102. u8 tssipos, extpa_gain, pdet_range, tr_iso, antswlut;
  103. } ghz5;
  104. } fem;
  105. u16 mcs2gpo[8];
  106. u16 mcs5gpo[8];
  107. u16 mcs5glpo[8];
  108. u16 mcs5ghpo[8];
  109. u8 opo;
  110. u8 rxgainerr2ga[3];
  111. u8 rxgainerr5gla[3];
  112. u8 rxgainerr5gma[3];
  113. u8 rxgainerr5gha[3];
  114. u8 rxgainerr5gua[3];
  115. u8 noiselvl2ga[3];
  116. u8 noiselvl5gla[3];
  117. u8 noiselvl5gma[3];
  118. u8 noiselvl5gha[3];
  119. u8 noiselvl5gua[3];
  120. u8 regrev;
  121. u8 txchain;
  122. u8 rxchain;
  123. u8 antswitch;
  124. u16 cddpo;
  125. u16 stbcpo;
  126. u16 bw40po;
  127. u16 bwduppo;
  128. u8 tempthresh;
  129. u8 tempoffset;
  130. u16 rawtempsense;
  131. u8 measpower;
  132. u8 tempsense_slope;
  133. u8 tempcorrx;
  134. u8 tempsense_option;
  135. u8 freqoffset_corr;
  136. u8 iqcal_swp_dis;
  137. u8 hw_iqcal_en;
  138. u8 elna2g;
  139. u8 elna5g;
  140. u8 phycal_tempdelta;
  141. u8 temps_period;
  142. u8 temps_hysteresis;
  143. u8 measpower1;
  144. u8 measpower2;
  145. u8 pcieingress_war;
  146. /* power per rate from sromrev 9 */
  147. u16 cckbw202gpo;
  148. u16 cckbw20ul2gpo;
  149. u32 legofdmbw202gpo;
  150. u32 legofdmbw20ul2gpo;
  151. u32 legofdmbw205glpo;
  152. u32 legofdmbw20ul5glpo;
  153. u32 legofdmbw205gmpo;
  154. u32 legofdmbw20ul5gmpo;
  155. u32 legofdmbw205ghpo;
  156. u32 legofdmbw20ul5ghpo;
  157. u32 mcsbw202gpo;
  158. u32 mcsbw20ul2gpo;
  159. u32 mcsbw402gpo;
  160. u32 mcsbw205glpo;
  161. u32 mcsbw20ul5glpo;
  162. u32 mcsbw405glpo;
  163. u32 mcsbw205gmpo;
  164. u32 mcsbw20ul5gmpo;
  165. u32 mcsbw405gmpo;
  166. u32 mcsbw205ghpo;
  167. u32 mcsbw20ul5ghpo;
  168. u32 mcsbw405ghpo;
  169. u16 mcs32po;
  170. u16 legofdm40duppo;
  171. u8 sar2g;
  172. u8 sar5g;
  173. };
  174. /* Information about the PCB the circuitry is soldered on. */
  175. struct ssb_boardinfo {
  176. u16 vendor;
  177. u16 type;
  178. };
  179. struct ssb_device;
  180. /* Lowlevel read/write operations on the device MMIO.
  181. * Internal, don't use that outside of ssb. */
  182. struct ssb_bus_ops {
  183. u8 (*read8)(struct ssb_device *dev, u16 offset);
  184. u16 (*read16)(struct ssb_device *dev, u16 offset);
  185. u32 (*read32)(struct ssb_device *dev, u16 offset);
  186. void (*write8)(struct ssb_device *dev, u16 offset, u8 value);
  187. void (*write16)(struct ssb_device *dev, u16 offset, u16 value);
  188. void (*write32)(struct ssb_device *dev, u16 offset, u32 value);
  189. #ifdef CONFIG_SSB_BLOCKIO
  190. void (*block_read)(struct ssb_device *dev, void *buffer,
  191. size_t count, u16 offset, u8 reg_width);
  192. void (*block_write)(struct ssb_device *dev, const void *buffer,
  193. size_t count, u16 offset, u8 reg_width);
  194. #endif
  195. };
  196. /* Core-ID values. */
  197. #define SSB_DEV_CHIPCOMMON 0x800
  198. #define SSB_DEV_ILINE20 0x801
  199. #define SSB_DEV_SDRAM 0x803
  200. #define SSB_DEV_PCI 0x804
  201. #define SSB_DEV_MIPS 0x805
  202. #define SSB_DEV_ETHERNET 0x806
  203. #define SSB_DEV_V90 0x807
  204. #define SSB_DEV_USB11_HOSTDEV 0x808
  205. #define SSB_DEV_ADSL 0x809
  206. #define SSB_DEV_ILINE100 0x80A
  207. #define SSB_DEV_IPSEC 0x80B
  208. #define SSB_DEV_PCMCIA 0x80D
  209. #define SSB_DEV_INTERNAL_MEM 0x80E
  210. #define SSB_DEV_MEMC_SDRAM 0x80F
  211. #define SSB_DEV_EXTIF 0x811
  212. #define SSB_DEV_80211 0x812
  213. #define SSB_DEV_MIPS_3302 0x816
  214. #define SSB_DEV_USB11_HOST 0x817
  215. #define SSB_DEV_USB11_DEV 0x818
  216. #define SSB_DEV_USB20_HOST 0x819
  217. #define SSB_DEV_USB20_DEV 0x81A
  218. #define SSB_DEV_SDIO_HOST 0x81B
  219. #define SSB_DEV_ROBOSWITCH 0x81C
  220. #define SSB_DEV_PARA_ATA 0x81D
  221. #define SSB_DEV_SATA_XORDMA 0x81E
  222. #define SSB_DEV_ETHERNET_GBIT 0x81F
  223. #define SSB_DEV_PCIE 0x820
  224. #define SSB_DEV_MIMO_PHY 0x821
  225. #define SSB_DEV_SRAM_CTRLR 0x822
  226. #define SSB_DEV_MINI_MACPHY 0x823
  227. #define SSB_DEV_ARM_1176 0x824
  228. #define SSB_DEV_ARM_7TDMI 0x825
  229. #define SSB_DEV_ARM_CM3 0x82A
  230. /* Vendor-ID values */
  231. #define SSB_VENDOR_BROADCOM 0x4243
  232. /* Some kernel subsystems poke with dev->drvdata, so we must use the
  233. * following ugly workaround to get from struct device to struct ssb_device */
  234. struct __ssb_dev_wrapper {
  235. struct device dev;
  236. struct ssb_device *sdev;
  237. };
  238. struct ssb_device {
  239. /* Having a copy of the ops pointer in each dev struct
  240. * is an optimization. */
  241. const struct ssb_bus_ops *ops;
  242. struct device *dev, *dma_dev;
  243. struct ssb_bus *bus;
  244. struct ssb_device_id id;
  245. u8 core_index;
  246. unsigned int irq;
  247. /* Internal-only stuff follows. */
  248. void *drvdata; /* Per-device data */
  249. void *devtypedata; /* Per-devicetype (eg 802.11) data */
  250. };
  251. /* Go from struct device to struct ssb_device. */
  252. static inline
  253. struct ssb_device * dev_to_ssb_dev(struct device *dev)
  254. {
  255. struct __ssb_dev_wrapper *wrap;
  256. wrap = container_of(dev, struct __ssb_dev_wrapper, dev);
  257. return wrap->sdev;
  258. }
  259. /* Device specific user data */
  260. static inline
  261. void ssb_set_drvdata(struct ssb_device *dev, void *data)
  262. {
  263. dev->drvdata = data;
  264. }
  265. static inline
  266. void * ssb_get_drvdata(struct ssb_device *dev)
  267. {
  268. return dev->drvdata;
  269. }
  270. /* Devicetype specific user data. This is per device-type (not per device) */
  271. void ssb_set_devtypedata(struct ssb_device *dev, void *data);
  272. static inline
  273. void * ssb_get_devtypedata(struct ssb_device *dev)
  274. {
  275. return dev->devtypedata;
  276. }
  277. struct ssb_driver {
  278. const char *name;
  279. const struct ssb_device_id *id_table;
  280. int (*probe)(struct ssb_device *dev, const struct ssb_device_id *id);
  281. void (*remove)(struct ssb_device *dev);
  282. int (*suspend)(struct ssb_device *dev, pm_message_t state);
  283. int (*resume)(struct ssb_device *dev);
  284. void (*shutdown)(struct ssb_device *dev);
  285. struct device_driver drv;
  286. };
  287. #define drv_to_ssb_drv(_drv) container_of(_drv, struct ssb_driver, drv)
  288. extern int __ssb_driver_register(struct ssb_driver *drv, struct module *owner);
  289. #define ssb_driver_register(drv) \
  290. __ssb_driver_register(drv, THIS_MODULE)
  291. extern void ssb_driver_unregister(struct ssb_driver *drv);
  292. enum ssb_bustype {
  293. SSB_BUSTYPE_SSB, /* This SSB bus is the system bus */
  294. SSB_BUSTYPE_PCI, /* SSB is connected to PCI bus */
  295. SSB_BUSTYPE_PCMCIA, /* SSB is connected to PCMCIA bus */
  296. SSB_BUSTYPE_SDIO, /* SSB is connected to SDIO bus */
  297. };
  298. /* board_vendor */
  299. #define SSB_BOARDVENDOR_BCM 0x14E4 /* Broadcom */
  300. #define SSB_BOARDVENDOR_DELL 0x1028 /* Dell */
  301. #define SSB_BOARDVENDOR_HP 0x0E11 /* HP */
  302. /* board_type */
  303. #define SSB_BOARD_BCM94301CB 0x0406
  304. #define SSB_BOARD_BCM94301MP 0x0407
  305. #define SSB_BOARD_BU4309 0x040A
  306. #define SSB_BOARD_BCM94309CB 0x040B
  307. #define SSB_BOARD_BCM4309MP 0x040C
  308. #define SSB_BOARD_BU4306 0x0416
  309. #define SSB_BOARD_BCM94306MP 0x0418
  310. #define SSB_BOARD_BCM4309G 0x0421
  311. #define SSB_BOARD_BCM4306CB 0x0417
  312. #define SSB_BOARD_BCM94306PC 0x0425 /* pcmcia 3.3v 4306 card */
  313. #define SSB_BOARD_BCM94306CBSG 0x042B /* with SiGe PA */
  314. #define SSB_BOARD_PCSG94306 0x042D /* with SiGe PA */
  315. #define SSB_BOARD_BU4704SD 0x042E /* with sdram */
  316. #define SSB_BOARD_BCM94704AGR 0x042F /* dual 11a/11g Router */
  317. #define SSB_BOARD_BCM94308MP 0x0430 /* 11a-only minipci */
  318. #define SSB_BOARD_BU4318 0x0447
  319. #define SSB_BOARD_CB4318 0x0448
  320. #define SSB_BOARD_MPG4318 0x0449
  321. #define SSB_BOARD_MP4318 0x044A
  322. #define SSB_BOARD_SD4318 0x044B
  323. #define SSB_BOARD_BCM94306P 0x044C /* with SiGe */
  324. #define SSB_BOARD_BCM94303MP 0x044E
  325. #define SSB_BOARD_BCM94306MPM 0x0450
  326. #define SSB_BOARD_BCM94306MPL 0x0453
  327. #define SSB_BOARD_PC4303 0x0454 /* pcmcia */
  328. #define SSB_BOARD_BCM94306MPLNA 0x0457
  329. #define SSB_BOARD_BCM94306MPH 0x045B
  330. #define SSB_BOARD_BCM94306PCIV 0x045C
  331. #define SSB_BOARD_BCM94318MPGH 0x0463
  332. #define SSB_BOARD_BU4311 0x0464
  333. #define SSB_BOARD_BCM94311MC 0x0465
  334. #define SSB_BOARD_BCM94311MCAG 0x0466
  335. /* 4321 boards */
  336. #define SSB_BOARD_BU4321 0x046B
  337. #define SSB_BOARD_BU4321E 0x047C
  338. #define SSB_BOARD_MP4321 0x046C
  339. #define SSB_BOARD_CB2_4321 0x046D
  340. #define SSB_BOARD_CB2_4321_AG 0x0066
  341. #define SSB_BOARD_MC4321 0x046E
  342. /* 4325 boards */
  343. #define SSB_BOARD_BCM94325DEVBU 0x0490
  344. #define SSB_BOARD_BCM94325BGABU 0x0491
  345. #define SSB_BOARD_BCM94325SDGWB 0x0492
  346. #define SSB_BOARD_BCM94325SDGMDL 0x04AA
  347. #define SSB_BOARD_BCM94325SDGMDL2 0x04C6
  348. #define SSB_BOARD_BCM94325SDGMDL3 0x04C9
  349. #define SSB_BOARD_BCM94325SDABGWBA 0x04E1
  350. /* 4322 boards */
  351. #define SSB_BOARD_BCM94322MC 0x04A4
  352. #define SSB_BOARD_BCM94322USB 0x04A8 /* dualband */
  353. #define SSB_BOARD_BCM94322HM 0x04B0
  354. #define SSB_BOARD_BCM94322USB2D 0x04Bf /* single band discrete front end */
  355. /* 4312 boards */
  356. #define SSB_BOARD_BU4312 0x048A
  357. #define SSB_BOARD_BCM4312MCGSG 0x04B5
  358. /* chip_package */
  359. #define SSB_CHIPPACK_BCM4712S 1 /* Small 200pin 4712 */
  360. #define SSB_CHIPPACK_BCM4712M 2 /* Medium 225pin 4712 */
  361. #define SSB_CHIPPACK_BCM4712L 0 /* Large 340pin 4712 */
  362. #include <linux/ssb/ssb_driver_chipcommon.h>
  363. #include <linux/ssb/ssb_driver_mips.h>
  364. #include <linux/ssb/ssb_driver_extif.h>
  365. #include <linux/ssb/ssb_driver_pci.h>
  366. struct ssb_bus {
  367. /* The MMIO area. */
  368. void __iomem *mmio;
  369. const struct ssb_bus_ops *ops;
  370. /* The core currently mapped into the MMIO window.
  371. * Not valid on all host-buses. So don't use outside of SSB. */
  372. struct ssb_device *mapped_device;
  373. union {
  374. /* Currently mapped PCMCIA segment. (bustype == SSB_BUSTYPE_PCMCIA only) */
  375. u8 mapped_pcmcia_seg;
  376. /* Current SSB base address window for SDIO. */
  377. u32 sdio_sbaddr;
  378. };
  379. /* Lock for core and segment switching.
  380. * On PCMCIA-host busses this is used to protect the whole MMIO access. */
  381. spinlock_t bar_lock;
  382. /* The host-bus this backplane is running on. */
  383. enum ssb_bustype bustype;
  384. /* Pointers to the host-bus. Check bustype before using any of these pointers. */
  385. union {
  386. /* Pointer to the PCI bus (only valid if bustype == SSB_BUSTYPE_PCI). */
  387. struct pci_dev *host_pci;
  388. /* Pointer to the PCMCIA device (only if bustype == SSB_BUSTYPE_PCMCIA). */
  389. struct pcmcia_device *host_pcmcia;
  390. /* Pointer to the SDIO device (only if bustype == SSB_BUSTYPE_SDIO). */
  391. struct sdio_func *host_sdio;
  392. };
  393. /* See enum ssb_quirks */
  394. unsigned int quirks;
  395. #ifdef CONFIG_SSB_SPROM
  396. /* Mutex to protect the SPROM writing. */
  397. struct mutex sprom_mutex;
  398. #endif
  399. /* ID information about the Chip. */
  400. u16 chip_id;
  401. u8 chip_rev;
  402. u16 sprom_offset;
  403. u16 sprom_size; /* number of words in sprom */
  404. u8 chip_package;
  405. /* List of devices (cores) on the backplane. */
  406. struct ssb_device devices[SSB_MAX_NR_CORES];
  407. u8 nr_devices;
  408. /* Software ID number for this bus. */
  409. unsigned int busnumber;
  410. /* The ChipCommon device (if available). */
  411. struct ssb_chipcommon chipco;
  412. /* The PCI-core device (if available). */
  413. struct ssb_pcicore pcicore;
  414. /* The MIPS-core device (if available). */
  415. struct ssb_mipscore mipscore;
  416. /* The EXTif-core device (if available). */
  417. struct ssb_extif extif;
  418. /* The following structure elements are not available in early
  419. * SSB initialization. Though, they are available for regular
  420. * registered drivers at any stage. So be careful when
  421. * using them in the ssb core code. */
  422. /* ID information about the PCB. */
  423. struct ssb_boardinfo boardinfo;
  424. /* Contents of the SPROM. */
  425. struct ssb_sprom sprom;
  426. /* If the board has a cardbus slot, this is set to true. */
  427. bool has_cardbus_slot;
  428. #ifdef CONFIG_SSB_EMBEDDED
  429. /* Lock for GPIO register access. */
  430. spinlock_t gpio_lock;
  431. struct platform_device *watchdog;
  432. #endif /* EMBEDDED */
  433. #ifdef CONFIG_SSB_DRIVER_GPIO
  434. struct gpio_chip gpio;
  435. struct irq_domain *irq_domain;
  436. #endif /* DRIVER_GPIO */
  437. /* Internal-only stuff follows. Do not touch. */
  438. struct list_head list;
  439. #ifdef CONFIG_SSB_DEBUG
  440. /* Is the bus already powered up? */
  441. bool powered_up;
  442. int power_warn_count;
  443. #endif /* DEBUG */
  444. };
  445. enum ssb_quirks {
  446. /* SDIO connected card requires performing a read after writing a 32-bit value */
  447. SSB_QUIRK_SDIO_READ_AFTER_WRITE32 = (1 << 0),
  448. };
  449. /* The initialization-invariants. */
  450. struct ssb_init_invariants {
  451. /* Versioning information about the PCB. */
  452. struct ssb_boardinfo boardinfo;
  453. /* The SPROM information. That's either stored in an
  454. * EEPROM or NVRAM on the board. */
  455. struct ssb_sprom sprom;
  456. /* If the board has a cardbus slot, this is set to true. */
  457. bool has_cardbus_slot;
  458. };
  459. /* Type of function to fetch the invariants. */
  460. typedef int (*ssb_invariants_func_t)(struct ssb_bus *bus,
  461. struct ssb_init_invariants *iv);
  462. /* Register a SSB system bus. get_invariants() is called after the
  463. * basic system devices are initialized.
  464. * The invariants are usually fetched from some NVRAM.
  465. * Put the invariants into the struct pointed to by iv. */
  466. extern int ssb_bus_ssbbus_register(struct ssb_bus *bus,
  467. unsigned long baseaddr,
  468. ssb_invariants_func_t get_invariants);
  469. #ifdef CONFIG_SSB_PCIHOST
  470. extern int ssb_bus_pcibus_register(struct ssb_bus *bus,
  471. struct pci_dev *host_pci);
  472. #endif /* CONFIG_SSB_PCIHOST */
  473. #ifdef CONFIG_SSB_PCMCIAHOST
  474. extern int ssb_bus_pcmciabus_register(struct ssb_bus *bus,
  475. struct pcmcia_device *pcmcia_dev,
  476. unsigned long baseaddr);
  477. #endif /* CONFIG_SSB_PCMCIAHOST */
  478. #ifdef CONFIG_SSB_SDIOHOST
  479. extern int ssb_bus_sdiobus_register(struct ssb_bus *bus,
  480. struct sdio_func *sdio_func,
  481. unsigned int quirks);
  482. #endif /* CONFIG_SSB_SDIOHOST */
  483. extern void ssb_bus_unregister(struct ssb_bus *bus);
  484. /* Does the device have an SPROM? */
  485. extern bool ssb_is_sprom_available(struct ssb_bus *bus);
  486. /* Set a fallback SPROM.
  487. * See kdoc at the function definition for complete documentation. */
  488. extern int ssb_arch_register_fallback_sprom(
  489. int (*sprom_callback)(struct ssb_bus *bus,
  490. struct ssb_sprom *out));
  491. /* Suspend a SSB bus.
  492. * Call this from the parent bus suspend routine. */
  493. extern int ssb_bus_suspend(struct ssb_bus *bus);
  494. /* Resume a SSB bus.
  495. * Call this from the parent bus resume routine. */
  496. extern int ssb_bus_resume(struct ssb_bus *bus);
  497. extern u32 ssb_clockspeed(struct ssb_bus *bus);
  498. /* Is the device enabled in hardware? */
  499. int ssb_device_is_enabled(struct ssb_device *dev);
  500. /* Enable a device and pass device-specific SSB_TMSLOW flags.
  501. * If no device-specific flags are available, use 0. */
  502. void ssb_device_enable(struct ssb_device *dev, u32 core_specific_flags);
  503. /* Disable a device in hardware and pass SSB_TMSLOW flags (if any). */
  504. void ssb_device_disable(struct ssb_device *dev, u32 core_specific_flags);
  505. /* Device MMIO register read/write functions. */
  506. static inline u8 ssb_read8(struct ssb_device *dev, u16 offset)
  507. {
  508. return dev->ops->read8(dev, offset);
  509. }
  510. static inline u16 ssb_read16(struct ssb_device *dev, u16 offset)
  511. {
  512. return dev->ops->read16(dev, offset);
  513. }
  514. static inline u32 ssb_read32(struct ssb_device *dev, u16 offset)
  515. {
  516. return dev->ops->read32(dev, offset);
  517. }
  518. static inline void ssb_write8(struct ssb_device *dev, u16 offset, u8 value)
  519. {
  520. dev->ops->write8(dev, offset, value);
  521. }
  522. static inline void ssb_write16(struct ssb_device *dev, u16 offset, u16 value)
  523. {
  524. dev->ops->write16(dev, offset, value);
  525. }
  526. static inline void ssb_write32(struct ssb_device *dev, u16 offset, u32 value)
  527. {
  528. dev->ops->write32(dev, offset, value);
  529. }
  530. #ifdef CONFIG_SSB_BLOCKIO
  531. static inline void ssb_block_read(struct ssb_device *dev, void *buffer,
  532. size_t count, u16 offset, u8 reg_width)
  533. {
  534. dev->ops->block_read(dev, buffer, count, offset, reg_width);
  535. }
  536. static inline void ssb_block_write(struct ssb_device *dev, const void *buffer,
  537. size_t count, u16 offset, u8 reg_width)
  538. {
  539. dev->ops->block_write(dev, buffer, count, offset, reg_width);
  540. }
  541. #endif /* CONFIG_SSB_BLOCKIO */
  542. /* The SSB DMA API. Use this API for any DMA operation on the device.
  543. * This API basically is a wrapper that calls the correct DMA API for
  544. * the host device type the SSB device is attached to. */
  545. /* Translation (routing) bits that need to be ORed to DMA
  546. * addresses before they are given to a device. */
  547. extern u32 ssb_dma_translation(struct ssb_device *dev);
  548. #define SSB_DMA_TRANSLATION_MASK 0xC0000000
  549. #define SSB_DMA_TRANSLATION_SHIFT 30
  550. static inline void __cold __ssb_dma_not_implemented(struct ssb_device *dev)
  551. {
  552. #ifdef CONFIG_SSB_DEBUG
  553. printk(KERN_ERR "SSB: BUG! Calling DMA API for "
  554. "unsupported bustype %d\n", dev->bus->bustype);
  555. #endif /* DEBUG */
  556. }
  557. #ifdef CONFIG_SSB_PCIHOST
  558. /* PCI-host wrapper driver */
  559. extern int ssb_pcihost_register(struct pci_driver *driver);
  560. static inline void ssb_pcihost_unregister(struct pci_driver *driver)
  561. {
  562. pci_unregister_driver(driver);
  563. }
  564. static inline
  565. void ssb_pcihost_set_power_state(struct ssb_device *sdev, pci_power_t state)
  566. {
  567. if (sdev->bus->bustype == SSB_BUSTYPE_PCI)
  568. pci_set_power_state(sdev->bus->host_pci, state);
  569. }
  570. #else
  571. static inline void ssb_pcihost_unregister(struct pci_driver *driver)
  572. {
  573. }
  574. static inline
  575. void ssb_pcihost_set_power_state(struct ssb_device *sdev, pci_power_t state)
  576. {
  577. }
  578. #endif /* CONFIG_SSB_PCIHOST */
  579. /* If a driver is shutdown or suspended, call this to signal
  580. * that the bus may be completely powered down. SSB will decide,
  581. * if it's really time to power down the bus, based on if there
  582. * are other devices that want to run. */
  583. extern int ssb_bus_may_powerdown(struct ssb_bus *bus);
  584. /* Before initializing and enabling a device, call this to power-up the bus.
  585. * If you want to allow use of dynamic-power-control, pass the flag.
  586. * Otherwise static always-on powercontrol will be used. */
  587. extern int ssb_bus_powerup(struct ssb_bus *bus, bool dynamic_pctl);
  588. extern void ssb_commit_settings(struct ssb_bus *bus);
  589. /* Various helper functions */
  590. extern u32 ssb_admatch_base(u32 adm);
  591. extern u32 ssb_admatch_size(u32 adm);
  592. /* PCI device mapping and fixup routines.
  593. * Called from the architecture pcibios init code.
  594. * These are only available on SSB_EMBEDDED configurations. */
  595. #ifdef CONFIG_SSB_EMBEDDED
  596. int ssb_pcibios_plat_dev_init(struct pci_dev *dev);
  597. int ssb_pcibios_map_irq(const struct pci_dev *dev, u8 slot, u8 pin);
  598. #endif /* CONFIG_SSB_EMBEDDED */
  599. #endif /* LINUX_SSB_H_ */