Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 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> |
Michael Buesch | 9c0c7a4 | 2008-07-09 15:48:45 +0200 | [diff] [blame] | 10 | #include <linux/dma-mapping.h> |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 11 | |
| 12 | #include <linux/ssb/ssb_regs.h> |
| 13 | |
| 14 | |
| 15 | struct pcmcia_device; |
| 16 | struct ssb_bus; |
| 17 | struct ssb_driver; |
| 18 | |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 19 | struct ssb_sprom { |
| 20 | u8 revision; |
Larry Finger | ac82fab | 2007-11-09 16:54:45 -0600 | [diff] [blame] | 21 | u8 il0mac[6]; /* MAC address for 802.11b/g */ |
| 22 | u8 et0mac[6]; /* MAC address for Ethernet */ |
| 23 | u8 et1mac[6]; /* MAC address for 802.11a */ |
| 24 | u8 et0phyaddr; /* MII address for enet0 */ |
| 25 | u8 et1phyaddr; /* MII address for enet1 */ |
Michael Buesch | e861b98 | 2007-12-22 21:51:30 +0100 | [diff] [blame] | 26 | u8 et0mdcport; /* MDIO for enet0 */ |
| 27 | u8 et1mdcport; /* MDIO for enet1 */ |
| 28 | u8 board_rev; /* Board revision number from SPROM. */ |
Larry Finger | ac82fab | 2007-11-09 16:54:45 -0600 | [diff] [blame] | 29 | u8 country_code; /* Country Code */ |
Gábor Stefanik | f679056 | 2009-08-10 21:23:08 +0200 | [diff] [blame] | 30 | u8 ant_available_a; /* 2GHz antenna available bits (up to 4) */ |
| 31 | u8 ant_available_bg; /* 5GHz antenna available bits (up to 4) */ |
Larry Finger | ac82fab | 2007-11-09 16:54:45 -0600 | [diff] [blame] | 32 | u16 pa0b0; |
| 33 | u16 pa0b1; |
| 34 | u16 pa0b2; |
| 35 | u16 pa1b0; |
| 36 | u16 pa1b1; |
| 37 | u16 pa1b2; |
Gábor Stefanik | f679056 | 2009-08-10 21:23:08 +0200 | [diff] [blame] | 38 | u16 pa1lob0; |
| 39 | u16 pa1lob1; |
| 40 | u16 pa1lob2; |
| 41 | u16 pa1hib0; |
| 42 | u16 pa1hib1; |
| 43 | u16 pa1hib2; |
Larry Finger | ac82fab | 2007-11-09 16:54:45 -0600 | [diff] [blame] | 44 | u8 gpio0; /* GPIO pin 0 */ |
| 45 | u8 gpio1; /* GPIO pin 1 */ |
| 46 | u8 gpio2; /* GPIO pin 2 */ |
| 47 | u8 gpio3; /* GPIO pin 3 */ |
Gábor Stefanik | f679056 | 2009-08-10 21:23:08 +0200 | [diff] [blame] | 48 | u16 maxpwr_bg; /* 2.4GHz Amplifier Max Power (in dBm Q5.2) */ |
| 49 | u16 maxpwr_al; /* 5.2GHz Amplifier Max Power (in dBm Q5.2) */ |
| 50 | u16 maxpwr_a; /* 5.3GHz Amplifier Max Power (in dBm Q5.2) */ |
| 51 | u16 maxpwr_ah; /* 5.8GHz Amplifier Max Power (in dBm Q5.2) */ |
Larry Finger | ac82fab | 2007-11-09 16:54:45 -0600 | [diff] [blame] | 52 | u8 itssi_a; /* Idle TSSI Target for A-PHY */ |
| 53 | u8 itssi_bg; /* Idle TSSI Target for B/G-PHY */ |
Gábor Stefanik | f679056 | 2009-08-10 21:23:08 +0200 | [diff] [blame] | 54 | u8 tri2g; /* 2.4GHz TX isolation */ |
| 55 | u8 tri5gl; /* 5.2GHz TX isolation */ |
| 56 | u8 tri5g; /* 5.3GHz TX isolation */ |
| 57 | u8 tri5gh; /* 5.8GHz TX isolation */ |
| 58 | u8 rxpo2g; /* 2GHz RX power offset */ |
| 59 | u8 rxpo5g; /* 5GHz RX power offset */ |
| 60 | u8 rssisav2g; /* 2GHz RSSI params */ |
| 61 | u8 rssismc2g; |
| 62 | u8 rssismf2g; |
| 63 | u8 bxa2g; /* 2GHz BX arch */ |
| 64 | u8 rssisav5g; /* 5GHz RSSI params */ |
| 65 | u8 rssismc5g; |
| 66 | u8 rssismf5g; |
| 67 | u8 bxa5g; /* 5GHz BX arch */ |
| 68 | u16 cck2gpo; /* CCK power offset */ |
| 69 | u32 ofdm2gpo; /* 2.4GHz OFDM power offset */ |
| 70 | u32 ofdm5glpo; /* 5.2GHz OFDM power offset */ |
| 71 | u32 ofdm5gpo; /* 5.3GHz OFDM power offset */ |
| 72 | u32 ofdm5ghpo; /* 5.8GHz OFDM power offset */ |
| 73 | u16 boardflags_lo; /* Board flags (bits 0-15) */ |
| 74 | u16 boardflags_hi; /* Board flags (bits 16-31) */ |
| 75 | u16 boardflags2_lo; /* Board flags (bits 32-47) */ |
| 76 | u16 boardflags2_hi; /* Board flags (bits 48-63) */ |
| 77 | /* TODO store board flags in a single u64 */ |
Michael Buesch | e861b98 | 2007-12-22 21:51:30 +0100 | [diff] [blame] | 78 | |
| 79 | /* Antenna gain values for up to 4 antennas |
| 80 | * on each band. Values in dBm/4 (Q5.2). Negative gain means the |
| 81 | * loss in the connectors is bigger than the gain. */ |
| 82 | struct { |
| 83 | struct { |
| 84 | s8 a0, a1, a2, a3; |
| 85 | } ghz24; /* 2.4GHz band */ |
| 86 | struct { |
| 87 | s8 a0, a1, a2, a3; |
| 88 | } ghz5; /* 5GHz band */ |
| 89 | } antenna_gain; |
Larry Finger | ac82fab | 2007-11-09 16:54:45 -0600 | [diff] [blame] | 90 | |
Gábor Stefanik | f679056 | 2009-08-10 21:23:08 +0200 | [diff] [blame] | 91 | /* TODO - add any parameters needed from rev 2, 3, 4, 5 or 8 SPROMs */ |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 92 | }; |
| 93 | |
| 94 | /* Information about the PCB the circuitry is soldered on. */ |
| 95 | struct ssb_boardinfo { |
| 96 | u16 vendor; |
| 97 | u16 type; |
| 98 | u16 rev; |
| 99 | }; |
| 100 | |
| 101 | |
| 102 | struct ssb_device; |
| 103 | /* Lowlevel read/write operations on the device MMIO. |
| 104 | * Internal, don't use that outside of ssb. */ |
| 105 | struct ssb_bus_ops { |
Michael Buesch | ffc7689 | 2008-02-20 19:08:10 +0100 | [diff] [blame] | 106 | u8 (*read8)(struct ssb_device *dev, u16 offset); |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 107 | u16 (*read16)(struct ssb_device *dev, u16 offset); |
| 108 | u32 (*read32)(struct ssb_device *dev, u16 offset); |
Michael Buesch | ffc7689 | 2008-02-20 19:08:10 +0100 | [diff] [blame] | 109 | void (*write8)(struct ssb_device *dev, u16 offset, u8 value); |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 110 | void (*write16)(struct ssb_device *dev, u16 offset, u16 value); |
| 111 | void (*write32)(struct ssb_device *dev, u16 offset, u32 value); |
Michael Buesch | d625a29 | 2008-04-02 19:46:56 +0200 | [diff] [blame] | 112 | #ifdef CONFIG_SSB_BLOCKIO |
| 113 | void (*block_read)(struct ssb_device *dev, void *buffer, |
| 114 | size_t count, u16 offset, u8 reg_width); |
| 115 | void (*block_write)(struct ssb_device *dev, const void *buffer, |
| 116 | size_t count, u16 offset, u8 reg_width); |
| 117 | #endif |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 118 | }; |
| 119 | |
| 120 | |
| 121 | /* Core-ID values. */ |
| 122 | #define SSB_DEV_CHIPCOMMON 0x800 |
| 123 | #define SSB_DEV_ILINE20 0x801 |
| 124 | #define SSB_DEV_SDRAM 0x803 |
| 125 | #define SSB_DEV_PCI 0x804 |
| 126 | #define SSB_DEV_MIPS 0x805 |
| 127 | #define SSB_DEV_ETHERNET 0x806 |
| 128 | #define SSB_DEV_V90 0x807 |
| 129 | #define SSB_DEV_USB11_HOSTDEV 0x808 |
| 130 | #define SSB_DEV_ADSL 0x809 |
| 131 | #define SSB_DEV_ILINE100 0x80A |
| 132 | #define SSB_DEV_IPSEC 0x80B |
| 133 | #define SSB_DEV_PCMCIA 0x80D |
| 134 | #define SSB_DEV_INTERNAL_MEM 0x80E |
| 135 | #define SSB_DEV_MEMC_SDRAM 0x80F |
| 136 | #define SSB_DEV_EXTIF 0x811 |
| 137 | #define SSB_DEV_80211 0x812 |
| 138 | #define SSB_DEV_MIPS_3302 0x816 |
| 139 | #define SSB_DEV_USB11_HOST 0x817 |
| 140 | #define SSB_DEV_USB11_DEV 0x818 |
| 141 | #define SSB_DEV_USB20_HOST 0x819 |
| 142 | #define SSB_DEV_USB20_DEV 0x81A |
| 143 | #define SSB_DEV_SDIO_HOST 0x81B |
| 144 | #define SSB_DEV_ROBOSWITCH 0x81C |
| 145 | #define SSB_DEV_PARA_ATA 0x81D |
| 146 | #define SSB_DEV_SATA_XORDMA 0x81E |
| 147 | #define SSB_DEV_ETHERNET_GBIT 0x81F |
| 148 | #define SSB_DEV_PCIE 0x820 |
| 149 | #define SSB_DEV_MIMO_PHY 0x821 |
| 150 | #define SSB_DEV_SRAM_CTRLR 0x822 |
| 151 | #define SSB_DEV_MINI_MACPHY 0x823 |
| 152 | #define SSB_DEV_ARM_1176 0x824 |
| 153 | #define SSB_DEV_ARM_7TDMI 0x825 |
| 154 | |
| 155 | /* Vendor-ID values */ |
| 156 | #define SSB_VENDOR_BROADCOM 0x4243 |
| 157 | |
| 158 | /* Some kernel subsystems poke with dev->drvdata, so we must use the |
| 159 | * following ugly workaround to get from struct device to struct ssb_device */ |
| 160 | struct __ssb_dev_wrapper { |
| 161 | struct device dev; |
| 162 | struct ssb_device *sdev; |
| 163 | }; |
| 164 | |
| 165 | struct ssb_device { |
| 166 | /* Having a copy of the ops pointer in each dev struct |
| 167 | * is an optimization. */ |
| 168 | const struct ssb_bus_ops *ops; |
| 169 | |
| 170 | struct device *dev; |
Michael Buesch | 4ac5846 | 2008-04-11 11:59:00 +0200 | [diff] [blame] | 171 | |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 172 | struct ssb_bus *bus; |
| 173 | struct ssb_device_id id; |
| 174 | |
| 175 | u8 core_index; |
| 176 | unsigned int irq; |
| 177 | |
| 178 | /* Internal-only stuff follows. */ |
| 179 | void *drvdata; /* Per-device data */ |
| 180 | void *devtypedata; /* Per-devicetype (eg 802.11) data */ |
| 181 | }; |
| 182 | |
| 183 | /* Go from struct device to struct ssb_device. */ |
| 184 | static inline |
| 185 | struct ssb_device * dev_to_ssb_dev(struct device *dev) |
| 186 | { |
| 187 | struct __ssb_dev_wrapper *wrap; |
| 188 | wrap = container_of(dev, struct __ssb_dev_wrapper, dev); |
| 189 | return wrap->sdev; |
| 190 | } |
| 191 | |
| 192 | /* Device specific user data */ |
| 193 | static inline |
| 194 | void ssb_set_drvdata(struct ssb_device *dev, void *data) |
| 195 | { |
| 196 | dev->drvdata = data; |
| 197 | } |
| 198 | static inline |
| 199 | void * ssb_get_drvdata(struct ssb_device *dev) |
| 200 | { |
| 201 | return dev->drvdata; |
| 202 | } |
| 203 | |
| 204 | /* Devicetype specific user data. This is per device-type (not per device) */ |
| 205 | void ssb_set_devtypedata(struct ssb_device *dev, void *data); |
| 206 | static inline |
| 207 | void * ssb_get_devtypedata(struct ssb_device *dev) |
| 208 | { |
| 209 | return dev->devtypedata; |
| 210 | } |
| 211 | |
| 212 | |
| 213 | struct ssb_driver { |
| 214 | const char *name; |
| 215 | const struct ssb_device_id *id_table; |
| 216 | |
| 217 | int (*probe)(struct ssb_device *dev, const struct ssb_device_id *id); |
| 218 | void (*remove)(struct ssb_device *dev); |
| 219 | int (*suspend)(struct ssb_device *dev, pm_message_t state); |
| 220 | int (*resume)(struct ssb_device *dev); |
| 221 | void (*shutdown)(struct ssb_device *dev); |
| 222 | |
| 223 | struct device_driver drv; |
| 224 | }; |
| 225 | #define drv_to_ssb_drv(_drv) container_of(_drv, struct ssb_driver, drv) |
| 226 | |
| 227 | extern int __ssb_driver_register(struct ssb_driver *drv, struct module *owner); |
| 228 | static inline int ssb_driver_register(struct ssb_driver *drv) |
| 229 | { |
| 230 | return __ssb_driver_register(drv, THIS_MODULE); |
| 231 | } |
| 232 | extern void ssb_driver_unregister(struct ssb_driver *drv); |
| 233 | |
| 234 | |
| 235 | |
| 236 | |
| 237 | enum ssb_bustype { |
| 238 | SSB_BUSTYPE_SSB, /* This SSB bus is the system bus */ |
| 239 | SSB_BUSTYPE_PCI, /* SSB is connected to PCI bus */ |
| 240 | SSB_BUSTYPE_PCMCIA, /* SSB is connected to PCMCIA bus */ |
Albert Herranz | 24ea602 | 2009-09-08 19:30:12 +0200 | [diff] [blame] | 241 | SSB_BUSTYPE_SDIO, /* SSB is connected to SDIO bus */ |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 242 | }; |
| 243 | |
| 244 | /* board_vendor */ |
| 245 | #define SSB_BOARDVENDOR_BCM 0x14E4 /* Broadcom */ |
| 246 | #define SSB_BOARDVENDOR_DELL 0x1028 /* Dell */ |
| 247 | #define SSB_BOARDVENDOR_HP 0x0E11 /* HP */ |
| 248 | /* board_type */ |
| 249 | #define SSB_BOARD_BCM94306MP 0x0418 |
| 250 | #define SSB_BOARD_BCM4309G 0x0421 |
| 251 | #define SSB_BOARD_BCM4306CB 0x0417 |
| 252 | #define SSB_BOARD_BCM4309MP 0x040C |
| 253 | #define SSB_BOARD_MP4318 0x044A |
| 254 | #define SSB_BOARD_BU4306 0x0416 |
| 255 | #define SSB_BOARD_BU4309 0x040A |
| 256 | /* chip_package */ |
| 257 | #define SSB_CHIPPACK_BCM4712S 1 /* Small 200pin 4712 */ |
| 258 | #define SSB_CHIPPACK_BCM4712M 2 /* Medium 225pin 4712 */ |
| 259 | #define SSB_CHIPPACK_BCM4712L 0 /* Large 340pin 4712 */ |
| 260 | |
| 261 | #include <linux/ssb/ssb_driver_chipcommon.h> |
| 262 | #include <linux/ssb/ssb_driver_mips.h> |
| 263 | #include <linux/ssb/ssb_driver_extif.h> |
| 264 | #include <linux/ssb/ssb_driver_pci.h> |
| 265 | |
| 266 | struct ssb_bus { |
| 267 | /* The MMIO area. */ |
| 268 | void __iomem *mmio; |
| 269 | |
| 270 | const struct ssb_bus_ops *ops; |
| 271 | |
Michael Buesch | 8b45499 | 2009-10-09 20:32:10 +0200 | [diff] [blame] | 272 | /* The core currently mapped into the MMIO window. |
| 273 | * Not valid on all host-buses. So don't use outside of SSB. */ |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 274 | struct ssb_device *mapped_device; |
Albert Herranz | 24ea602 | 2009-09-08 19:30:12 +0200 | [diff] [blame] | 275 | union { |
| 276 | /* Currently mapped PCMCIA segment. (bustype == SSB_BUSTYPE_PCMCIA only) */ |
| 277 | u8 mapped_pcmcia_seg; |
| 278 | /* Current SSB base address window for SDIO. */ |
| 279 | u32 sdio_sbaddr; |
| 280 | }; |
Michael Buesch | 993e1c7 | 2007-12-22 22:01:36 +0100 | [diff] [blame] | 281 | /* Lock for core and segment switching. |
| 282 | * On PCMCIA-host busses this is used to protect the whole MMIO access. */ |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 283 | spinlock_t bar_lock; |
| 284 | |
Michael Buesch | 8b45499 | 2009-10-09 20:32:10 +0200 | [diff] [blame] | 285 | /* The host-bus this backplane is running on. */ |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 286 | enum ssb_bustype bustype; |
Michael Buesch | 8b45499 | 2009-10-09 20:32:10 +0200 | [diff] [blame] | 287 | /* Pointers to the host-bus. Check bustype before using any of these pointers. */ |
| 288 | union { |
| 289 | /* Pointer to the PCI bus (only valid if bustype == SSB_BUSTYPE_PCI). */ |
| 290 | struct pci_dev *host_pci; |
| 291 | /* Pointer to the PCMCIA device (only if bustype == SSB_BUSTYPE_PCMCIA). */ |
| 292 | struct pcmcia_device *host_pcmcia; |
| 293 | /* Pointer to the SDIO device (only if bustype == SSB_BUSTYPE_SDIO). */ |
| 294 | struct sdio_func *host_sdio; |
| 295 | }; |
Albert Herranz | 24ea602 | 2009-09-08 19:30:12 +0200 | [diff] [blame] | 296 | |
| 297 | /* See enum ssb_quirks */ |
| 298 | unsigned int quirks; |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 299 | |
Michael Buesch | e7ec2e3 | 2008-03-10 17:26:32 +0100 | [diff] [blame] | 300 | #ifdef CONFIG_SSB_SPROM |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 301 | /* Mutex to protect the SPROM writing. */ |
Michael Buesch | e7ec2e3 | 2008-03-10 17:26:32 +0100 | [diff] [blame] | 302 | struct mutex sprom_mutex; |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 303 | #endif |
| 304 | |
| 305 | /* ID information about the Chip. */ |
| 306 | u16 chip_id; |
| 307 | u16 chip_rev; |
Larry Finger | c272ef4 | 2007-11-09 16:56:25 -0600 | [diff] [blame] | 308 | u16 sprom_size; /* number of words in sprom */ |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 309 | u8 chip_package; |
| 310 | |
| 311 | /* List of devices (cores) on the backplane. */ |
| 312 | struct ssb_device devices[SSB_MAX_NR_CORES]; |
| 313 | u8 nr_devices; |
| 314 | |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 315 | /* Software ID number for this bus. */ |
| 316 | unsigned int busnumber; |
| 317 | |
| 318 | /* The ChipCommon device (if available). */ |
| 319 | struct ssb_chipcommon chipco; |
| 320 | /* The PCI-core device (if available). */ |
| 321 | struct ssb_pcicore pcicore; |
| 322 | /* The MIPS-core device (if available). */ |
| 323 | struct ssb_mipscore mipscore; |
| 324 | /* The EXTif-core device (if available). */ |
| 325 | struct ssb_extif extif; |
| 326 | |
| 327 | /* The following structure elements are not available in early |
| 328 | * SSB initialization. Though, they are available for regular |
| 329 | * registered drivers at any stage. So be careful when |
| 330 | * using them in the ssb core code. */ |
| 331 | |
| 332 | /* ID information about the PCB. */ |
| 333 | struct ssb_boardinfo boardinfo; |
| 334 | /* Contents of the SPROM. */ |
| 335 | struct ssb_sprom sprom; |
Michael Buesch | 7cb4461 | 2008-02-19 17:46:48 +0100 | [diff] [blame] | 336 | /* If the board has a cardbus slot, this is set to true. */ |
| 337 | bool has_cardbus_slot; |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 338 | |
Michael Buesch | 53521d8 | 2008-02-19 16:22:50 +0100 | [diff] [blame] | 339 | #ifdef CONFIG_SSB_EMBEDDED |
| 340 | /* Lock for GPIO register access. */ |
| 341 | spinlock_t gpio_lock; |
| 342 | #endif /* EMBEDDED */ |
| 343 | |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 344 | /* Internal-only stuff follows. Do not touch. */ |
| 345 | struct list_head list; |
| 346 | #ifdef CONFIG_SSB_DEBUG |
| 347 | /* Is the bus already powered up? */ |
| 348 | bool powered_up; |
| 349 | int power_warn_count; |
| 350 | #endif /* DEBUG */ |
| 351 | }; |
| 352 | |
Albert Herranz | 24ea602 | 2009-09-08 19:30:12 +0200 | [diff] [blame] | 353 | enum ssb_quirks { |
| 354 | /* SDIO connected card requires performing a read after writing a 32-bit value */ |
| 355 | SSB_QUIRK_SDIO_READ_AFTER_WRITE32 = (1 << 0), |
| 356 | }; |
| 357 | |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 358 | /* The initialization-invariants. */ |
| 359 | struct ssb_init_invariants { |
Michael Buesch | 7cb4461 | 2008-02-19 17:46:48 +0100 | [diff] [blame] | 360 | /* Versioning information about the PCB. */ |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 361 | struct ssb_boardinfo boardinfo; |
Michael Buesch | 7cb4461 | 2008-02-19 17:46:48 +0100 | [diff] [blame] | 362 | /* The SPROM information. That's either stored in an |
| 363 | * EEPROM or NVRAM on the board. */ |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 364 | struct ssb_sprom sprom; |
Michael Buesch | 7cb4461 | 2008-02-19 17:46:48 +0100 | [diff] [blame] | 365 | /* If the board has a cardbus slot, this is set to true. */ |
| 366 | bool has_cardbus_slot; |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 367 | }; |
| 368 | /* Type of function to fetch the invariants. */ |
| 369 | typedef int (*ssb_invariants_func_t)(struct ssb_bus *bus, |
| 370 | struct ssb_init_invariants *iv); |
| 371 | |
| 372 | /* Register a SSB system bus. get_invariants() is called after the |
| 373 | * basic system devices are initialized. |
| 374 | * The invariants are usually fetched from some NVRAM. |
| 375 | * Put the invariants into the struct pointed to by iv. */ |
| 376 | extern int ssb_bus_ssbbus_register(struct ssb_bus *bus, |
| 377 | unsigned long baseaddr, |
| 378 | ssb_invariants_func_t get_invariants); |
| 379 | #ifdef CONFIG_SSB_PCIHOST |
| 380 | extern int ssb_bus_pcibus_register(struct ssb_bus *bus, |
| 381 | struct pci_dev *host_pci); |
| 382 | #endif /* CONFIG_SSB_PCIHOST */ |
| 383 | #ifdef CONFIG_SSB_PCMCIAHOST |
| 384 | extern int ssb_bus_pcmciabus_register(struct ssb_bus *bus, |
| 385 | struct pcmcia_device *pcmcia_dev, |
| 386 | unsigned long baseaddr); |
| 387 | #endif /* CONFIG_SSB_PCMCIAHOST */ |
Albert Herranz | 24ea602 | 2009-09-08 19:30:12 +0200 | [diff] [blame] | 388 | #ifdef CONFIG_SSB_SDIOHOST |
| 389 | extern int ssb_bus_sdiobus_register(struct ssb_bus *bus, |
| 390 | struct sdio_func *sdio_func, |
| 391 | unsigned int quirks); |
| 392 | #endif /* CONFIG_SSB_SDIOHOST */ |
| 393 | |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 394 | |
| 395 | extern void ssb_bus_unregister(struct ssb_bus *bus); |
| 396 | |
John W. Linville | d53cdbb | 2010-03-31 21:39:35 +0200 | [diff] [blame^] | 397 | /* Does the device have an SPROM? */ |
| 398 | extern bool ssb_is_sprom_available(struct ssb_bus *bus); |
| 399 | |
Michael Buesch | e79c1ba | 2009-02-27 16:59:05 +0100 | [diff] [blame] | 400 | /* Set a fallback SPROM. |
| 401 | * See kdoc at the function definition for complete documentation. */ |
| 402 | extern int ssb_arch_set_fallback_sprom(const struct ssb_sprom *sprom); |
| 403 | |
Michael Buesch | 8fe2b65 | 2008-03-30 00:10:50 +0100 | [diff] [blame] | 404 | /* Suspend a SSB bus. |
| 405 | * Call this from the parent bus suspend routine. */ |
| 406 | extern int ssb_bus_suspend(struct ssb_bus *bus); |
| 407 | /* Resume a SSB bus. |
| 408 | * Call this from the parent bus resume routine. */ |
| 409 | extern int ssb_bus_resume(struct ssb_bus *bus); |
| 410 | |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 411 | extern u32 ssb_clockspeed(struct ssb_bus *bus); |
| 412 | |
| 413 | /* Is the device enabled in hardware? */ |
| 414 | int ssb_device_is_enabled(struct ssb_device *dev); |
| 415 | /* Enable a device and pass device-specific SSB_TMSLOW flags. |
| 416 | * If no device-specific flags are available, use 0. */ |
| 417 | void ssb_device_enable(struct ssb_device *dev, u32 core_specific_flags); |
| 418 | /* Disable a device in hardware and pass SSB_TMSLOW flags (if any). */ |
| 419 | void ssb_device_disable(struct ssb_device *dev, u32 core_specific_flags); |
| 420 | |
| 421 | |
| 422 | /* Device MMIO register read/write functions. */ |
Michael Buesch | ffc7689 | 2008-02-20 19:08:10 +0100 | [diff] [blame] | 423 | static inline u8 ssb_read8(struct ssb_device *dev, u16 offset) |
| 424 | { |
| 425 | return dev->ops->read8(dev, offset); |
| 426 | } |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 427 | static inline u16 ssb_read16(struct ssb_device *dev, u16 offset) |
| 428 | { |
| 429 | return dev->ops->read16(dev, offset); |
| 430 | } |
| 431 | static inline u32 ssb_read32(struct ssb_device *dev, u16 offset) |
| 432 | { |
| 433 | return dev->ops->read32(dev, offset); |
| 434 | } |
Michael Buesch | ffc7689 | 2008-02-20 19:08:10 +0100 | [diff] [blame] | 435 | static inline void ssb_write8(struct ssb_device *dev, u16 offset, u8 value) |
| 436 | { |
| 437 | dev->ops->write8(dev, offset, value); |
| 438 | } |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 439 | static inline void ssb_write16(struct ssb_device *dev, u16 offset, u16 value) |
| 440 | { |
| 441 | dev->ops->write16(dev, offset, value); |
| 442 | } |
| 443 | static inline void ssb_write32(struct ssb_device *dev, u16 offset, u32 value) |
| 444 | { |
| 445 | dev->ops->write32(dev, offset, value); |
| 446 | } |
Michael Buesch | d625a29 | 2008-04-02 19:46:56 +0200 | [diff] [blame] | 447 | #ifdef CONFIG_SSB_BLOCKIO |
| 448 | static inline void ssb_block_read(struct ssb_device *dev, void *buffer, |
| 449 | size_t count, u16 offset, u8 reg_width) |
| 450 | { |
| 451 | dev->ops->block_read(dev, buffer, count, offset, reg_width); |
| 452 | } |
| 453 | |
| 454 | static inline void ssb_block_write(struct ssb_device *dev, const void *buffer, |
| 455 | size_t count, u16 offset, u8 reg_width) |
| 456 | { |
| 457 | dev->ops->block_write(dev, buffer, count, offset, reg_width); |
| 458 | } |
| 459 | #endif /* CONFIG_SSB_BLOCKIO */ |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 460 | |
| 461 | |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 462 | /* The SSB DMA API. Use this API for any DMA operation on the device. |
| 463 | * This API basically is a wrapper that calls the correct DMA API for |
| 464 | * the host device type the SSB device is attached to. */ |
| 465 | |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 466 | /* Translation (routing) bits that need to be ORed to DMA |
| 467 | * addresses before they are given to a device. */ |
| 468 | extern u32 ssb_dma_translation(struct ssb_device *dev); |
| 469 | #define SSB_DMA_TRANSLATION_MASK 0xC0000000 |
| 470 | #define SSB_DMA_TRANSLATION_SHIFT 30 |
| 471 | |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 472 | extern int ssb_dma_set_mask(struct ssb_device *dev, u64 mask); |
| 473 | |
| 474 | extern void * ssb_dma_alloc_consistent(struct ssb_device *dev, size_t size, |
| 475 | dma_addr_t *dma_handle, gfp_t gfp_flags); |
| 476 | extern void ssb_dma_free_consistent(struct ssb_device *dev, size_t size, |
| 477 | void *vaddr, dma_addr_t dma_handle, |
| 478 | gfp_t gfp_flags); |
| 479 | |
| 480 | static inline void __cold __ssb_dma_not_implemented(struct ssb_device *dev) |
| 481 | { |
| 482 | #ifdef CONFIG_SSB_DEBUG |
| 483 | printk(KERN_ERR "SSB: BUG! Calling DMA API for " |
| 484 | "unsupported bustype %d\n", dev->bus->bustype); |
| 485 | #endif /* DEBUG */ |
| 486 | } |
| 487 | |
| 488 | static inline int ssb_dma_mapping_error(struct ssb_device *dev, dma_addr_t addr) |
| 489 | { |
| 490 | switch (dev->bus->bustype) { |
| 491 | case SSB_BUSTYPE_PCI: |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 492 | #ifdef CONFIG_SSB_PCIHOST |
FUJITA Tomonori | 8d8bb39 | 2008-07-25 19:44:49 -0700 | [diff] [blame] | 493 | return pci_dma_mapping_error(dev->bus->host_pci, addr); |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 494 | #endif |
| 495 | break; |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 496 | case SSB_BUSTYPE_SSB: |
FUJITA Tomonori | 8d8bb39 | 2008-07-25 19:44:49 -0700 | [diff] [blame] | 497 | return dma_mapping_error(dev->dev, addr); |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 498 | default: |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 499 | break; |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 500 | } |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 501 | __ssb_dma_not_implemented(dev); |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 502 | return -ENOSYS; |
| 503 | } |
| 504 | |
| 505 | static inline dma_addr_t ssb_dma_map_single(struct ssb_device *dev, void *p, |
| 506 | size_t size, enum dma_data_direction dir) |
| 507 | { |
| 508 | switch (dev->bus->bustype) { |
| 509 | case SSB_BUSTYPE_PCI: |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 510 | #ifdef CONFIG_SSB_PCIHOST |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 511 | return pci_map_single(dev->bus->host_pci, p, size, dir); |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 512 | #endif |
| 513 | break; |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 514 | case SSB_BUSTYPE_SSB: |
| 515 | return dma_map_single(dev->dev, p, size, dir); |
| 516 | default: |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 517 | break; |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 518 | } |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 519 | __ssb_dma_not_implemented(dev); |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 520 | return 0; |
| 521 | } |
| 522 | |
| 523 | static inline void ssb_dma_unmap_single(struct ssb_device *dev, dma_addr_t dma_addr, |
| 524 | size_t size, enum dma_data_direction dir) |
| 525 | { |
| 526 | switch (dev->bus->bustype) { |
| 527 | case SSB_BUSTYPE_PCI: |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 528 | #ifdef CONFIG_SSB_PCIHOST |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 529 | pci_unmap_single(dev->bus->host_pci, dma_addr, size, dir); |
| 530 | return; |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 531 | #endif |
| 532 | break; |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 533 | case SSB_BUSTYPE_SSB: |
| 534 | dma_unmap_single(dev->dev, dma_addr, size, dir); |
| 535 | return; |
| 536 | default: |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 537 | break; |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 538 | } |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 539 | __ssb_dma_not_implemented(dev); |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 540 | } |
| 541 | |
| 542 | static inline void ssb_dma_sync_single_for_cpu(struct ssb_device *dev, |
| 543 | dma_addr_t dma_addr, |
| 544 | size_t size, |
| 545 | enum dma_data_direction dir) |
| 546 | { |
| 547 | switch (dev->bus->bustype) { |
| 548 | case SSB_BUSTYPE_PCI: |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 549 | #ifdef CONFIG_SSB_PCIHOST |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 550 | pci_dma_sync_single_for_cpu(dev->bus->host_pci, dma_addr, |
| 551 | size, dir); |
| 552 | return; |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 553 | #endif |
| 554 | break; |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 555 | case SSB_BUSTYPE_SSB: |
| 556 | dma_sync_single_for_cpu(dev->dev, dma_addr, size, dir); |
| 557 | return; |
| 558 | default: |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 559 | break; |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 560 | } |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 561 | __ssb_dma_not_implemented(dev); |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 562 | } |
| 563 | |
| 564 | static inline void ssb_dma_sync_single_for_device(struct ssb_device *dev, |
| 565 | dma_addr_t dma_addr, |
| 566 | size_t size, |
| 567 | enum dma_data_direction dir) |
| 568 | { |
| 569 | switch (dev->bus->bustype) { |
| 570 | case SSB_BUSTYPE_PCI: |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 571 | #ifdef CONFIG_SSB_PCIHOST |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 572 | pci_dma_sync_single_for_device(dev->bus->host_pci, dma_addr, |
| 573 | size, dir); |
| 574 | return; |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 575 | #endif |
| 576 | break; |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 577 | case SSB_BUSTYPE_SSB: |
| 578 | dma_sync_single_for_device(dev->dev, dma_addr, size, dir); |
| 579 | return; |
| 580 | default: |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 581 | break; |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 582 | } |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 583 | __ssb_dma_not_implemented(dev); |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 584 | } |
| 585 | |
| 586 | static inline void ssb_dma_sync_single_range_for_cpu(struct ssb_device *dev, |
| 587 | dma_addr_t dma_addr, |
| 588 | unsigned long offset, |
| 589 | size_t size, |
| 590 | enum dma_data_direction dir) |
| 591 | { |
| 592 | switch (dev->bus->bustype) { |
| 593 | case SSB_BUSTYPE_PCI: |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 594 | #ifdef CONFIG_SSB_PCIHOST |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 595 | /* Just sync everything. That's all the PCI API can do. */ |
| 596 | pci_dma_sync_single_for_cpu(dev->bus->host_pci, dma_addr, |
| 597 | offset + size, dir); |
| 598 | return; |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 599 | #endif |
| 600 | break; |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 601 | case SSB_BUSTYPE_SSB: |
| 602 | dma_sync_single_range_for_cpu(dev->dev, dma_addr, offset, |
| 603 | size, dir); |
| 604 | return; |
| 605 | default: |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 606 | break; |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 607 | } |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 608 | __ssb_dma_not_implemented(dev); |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 609 | } |
| 610 | |
| 611 | static inline void ssb_dma_sync_single_range_for_device(struct ssb_device *dev, |
| 612 | dma_addr_t dma_addr, |
| 613 | unsigned long offset, |
| 614 | size_t size, |
| 615 | enum dma_data_direction dir) |
| 616 | { |
| 617 | switch (dev->bus->bustype) { |
| 618 | case SSB_BUSTYPE_PCI: |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 619 | #ifdef CONFIG_SSB_PCIHOST |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 620 | /* Just sync everything. That's all the PCI API can do. */ |
| 621 | pci_dma_sync_single_for_device(dev->bus->host_pci, dma_addr, |
| 622 | offset + size, dir); |
| 623 | return; |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 624 | #endif |
| 625 | break; |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 626 | case SSB_BUSTYPE_SSB: |
| 627 | dma_sync_single_range_for_device(dev->dev, dma_addr, offset, |
| 628 | size, dir); |
| 629 | return; |
| 630 | default: |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 631 | break; |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 632 | } |
Michael Buesch | fd0fcf5 | 2008-11-06 10:49:21 +0000 | [diff] [blame] | 633 | __ssb_dma_not_implemented(dev); |
Michael Buesch | f225763 | 2008-06-20 11:50:29 +0200 | [diff] [blame] | 634 | } |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 635 | |
| 636 | |
| 637 | #ifdef CONFIG_SSB_PCIHOST |
| 638 | /* PCI-host wrapper driver */ |
| 639 | extern int ssb_pcihost_register(struct pci_driver *driver); |
| 640 | static inline void ssb_pcihost_unregister(struct pci_driver *driver) |
| 641 | { |
| 642 | pci_unregister_driver(driver); |
| 643 | } |
Miguel Botón | 961d57c | 2008-01-01 01:16:46 +0100 | [diff] [blame] | 644 | |
| 645 | static inline |
| 646 | void ssb_pcihost_set_power_state(struct ssb_device *sdev, pci_power_t state) |
| 647 | { |
| 648 | if (sdev->bus->bustype == SSB_BUSTYPE_PCI) |
| 649 | pci_set_power_state(sdev->bus->host_pci, state); |
| 650 | } |
Andrew Morton | 532031d | 2008-02-04 23:58:42 -0800 | [diff] [blame] | 651 | #else |
| 652 | static inline void ssb_pcihost_unregister(struct pci_driver *driver) |
| 653 | { |
| 654 | } |
| 655 | |
| 656 | static inline |
| 657 | void ssb_pcihost_set_power_state(struct ssb_device *sdev, pci_power_t state) |
| 658 | { |
| 659 | } |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 660 | #endif /* CONFIG_SSB_PCIHOST */ |
| 661 | |
| 662 | |
| 663 | /* If a driver is shutdown or suspended, call this to signal |
| 664 | * that the bus may be completely powered down. SSB will decide, |
| 665 | * if it's really time to power down the bus, based on if there |
| 666 | * are other devices that want to run. */ |
| 667 | extern int ssb_bus_may_powerdown(struct ssb_bus *bus); |
| 668 | /* Before initializing and enabling a device, call this to power-up the bus. |
| 669 | * If you want to allow use of dynamic-power-control, pass the flag. |
| 670 | * Otherwise static always-on powercontrol will be used. */ |
| 671 | extern int ssb_bus_powerup(struct ssb_bus *bus, bool dynamic_pctl); |
| 672 | |
| 673 | |
| 674 | /* Various helper functions */ |
| 675 | extern u32 ssb_admatch_base(u32 adm); |
| 676 | extern u32 ssb_admatch_size(u32 adm); |
| 677 | |
Michael Buesch | aab547c | 2008-02-29 11:36:12 +0100 | [diff] [blame] | 678 | /* PCI device mapping and fixup routines. |
| 679 | * Called from the architecture pcibios init code. |
| 680 | * These are only available on SSB_EMBEDDED configurations. */ |
| 681 | #ifdef CONFIG_SSB_EMBEDDED |
| 682 | int ssb_pcibios_plat_dev_init(struct pci_dev *dev); |
| 683 | int ssb_pcibios_map_irq(const struct pci_dev *dev, u8 slot, u8 pin); |
| 684 | #endif /* CONFIG_SSB_EMBEDDED */ |
Michael Buesch | 61e115a | 2007-09-18 15:12:50 -0400 | [diff] [blame] | 685 | |
| 686 | #endif /* LINUX_SSB_H_ */ |