kernel/include/linux/ssb/ssb.h

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