4 #include <linux/device.h>
5 #include <linux/list.h>
6 #include <linux/types.h>
7 #include <linux/spinlock.h>
9 #include <linux/mod_devicetable.h>
10 #include <linux/dma-mapping.h>
12 #include <linux/ssb/ssb_regs.h>
19 struct ssb_sprom_core_pwr_info {
20 u8 itssi_2g, itssi_5g;
21 u8 maxpwr_2g, maxpwr_5gl, maxpwr_5g, maxpwr_5gh;
22 u16 pa_2g[4], pa_5gl[4], pa_5g[4], pa_5gh[4];
27 u8 il0mac[6]; /* MAC address for 802.11b/g */
28 u8 et0mac[6]; /* MAC address for Ethernet */
29 u8 et1mac[6]; /* MAC address for 802.11a */
30 u8 et0phyaddr; /* MII address for enet0 */
31 u8 et1phyaddr; /* MII address for enet1 */
32 u8 et0mdcport; /* MDIO for enet0 */
33 u8 et1mdcport; /* MDIO for enet1 */
34 u16 board_rev; /* Board revision number from SPROM. */
35 u16 board_num; /* Board number from SPROM. */
36 u16 board_type; /* Board type from SPROM. */
37 u8 country_code; /* Country Code */
38 char alpha2[2]; /* Country Code as two chars like EU or US */
39 u8 leddc_on_time; /* LED Powersave Duty Cycle On Count */
40 u8 leddc_off_time; /* LED Powersave Duty Cycle Off Count */
41 u8 ant_available_a; /* 2GHz antenna available bits (up to 4) */
42 u8 ant_available_bg; /* 5GHz antenna available bits (up to 4) */
55 u8 gpio0; /* GPIO pin 0 */
56 u8 gpio1; /* GPIO pin 1 */
57 u8 gpio2; /* GPIO pin 2 */
58 u8 gpio3; /* GPIO pin 3 */
59 u8 maxpwr_bg; /* 2.4GHz Amplifier Max Power (in dBm Q5.2) */
60 u8 maxpwr_al; /* 5.2GHz Amplifier Max Power (in dBm Q5.2) */
61 u8 maxpwr_a; /* 5.3GHz Amplifier Max Power (in dBm Q5.2) */
62 u8 maxpwr_ah; /* 5.8GHz Amplifier Max Power (in dBm Q5.2) */
63 u8 itssi_a; /* Idle TSSI Target for A-PHY */
64 u8 itssi_bg; /* Idle TSSI Target for B/G-PHY */
65 u8 tri2g; /* 2.4GHz TX isolation */
66 u8 tri5gl; /* 5.2GHz TX isolation */
67 u8 tri5g; /* 5.3GHz TX isolation */
68 u8 tri5gh; /* 5.8GHz TX isolation */
69 u8 txpid2g[4]; /* 2GHz TX power index */
70 u8 txpid5gl[4]; /* 4.9 - 5.1GHz TX power index */
71 u8 txpid5g[4]; /* 5.1 - 5.5GHz TX power index */
72 u8 txpid5gh[4]; /* 5.5 - ...GHz TX power index */
73 s8 rxpo2g; /* 2GHz RX power offset */
74 s8 rxpo5g; /* 5GHz RX power offset */
75 u8 rssisav2g; /* 2GHz RSSI params */
78 u8 bxa2g; /* 2GHz BX arch */
79 u8 rssisav5g; /* 5GHz RSSI params */
82 u8 bxa5g; /* 5GHz BX arch */
83 u16 cck2gpo; /* CCK power offset */
84 u32 ofdm2gpo; /* 2.4GHz OFDM power offset */
85 u32 ofdm5glpo; /* 5.2GHz OFDM power offset */
86 u32 ofdm5gpo; /* 5.3GHz OFDM power offset */
87 u32 ofdm5ghpo; /* 5.8GHz OFDM power offset */
88 u16 boardflags_lo; /* Board flags (bits 0-15) */
89 u16 boardflags_hi; /* Board flags (bits 16-31) */
90 u16 boardflags2_lo; /* Board flags (bits 32-47) */
91 u16 boardflags2_hi; /* Board flags (bits 48-63) */
92 /* TODO store board flags in a single u64 */
94 struct ssb_sprom_core_pwr_info core_pwr_info[4];
96 /* Antenna gain values for up to 4 antennas
97 * on each band. Values in dBm/4 (Q5.2). Negative gain means the
98 * loss in the connectors is bigger than the gain. */
105 u8 tssipos, extpa_gain, pdet_range, tr_iso, antswlut;
108 u8 tssipos, extpa_gain, pdet_range, tr_iso, antswlut;
158 /* power per rate from sromrev 9 */
162 u32 legofdmbw20ul2gpo;
163 u32 legofdmbw205glpo;
164 u32 legofdmbw20ul5glpo;
165 u32 legofdmbw205gmpo;
166 u32 legofdmbw20ul5gmpo;
167 u32 legofdmbw205ghpo;
168 u32 legofdmbw20ul5ghpo;
187 /* Information about the PCB the circuitry is soldered on. */
188 struct ssb_boardinfo {
195 /* Lowlevel read/write operations on the device MMIO.
196 * Internal, don't use that outside of ssb. */
198 u8 (*read8)(struct ssb_device *dev, u16 offset);
199 u16 (*read16)(struct ssb_device *dev, u16 offset);
200 u32 (*read32)(struct ssb_device *dev, u16 offset);
201 void (*write8)(struct ssb_device *dev, u16 offset, u8 value);
202 void (*write16)(struct ssb_device *dev, u16 offset, u16 value);
203 void (*write32)(struct ssb_device *dev, u16 offset, u32 value);
204 #ifdef CONFIG_SSB_BLOCKIO
205 void (*block_read)(struct ssb_device *dev, void *buffer,
206 size_t count, u16 offset, u8 reg_width);
207 void (*block_write)(struct ssb_device *dev, const void *buffer,
208 size_t count, u16 offset, u8 reg_width);
213 /* Core-ID values. */
214 #define SSB_DEV_CHIPCOMMON 0x800
215 #define SSB_DEV_ILINE20 0x801
216 #define SSB_DEV_SDRAM 0x803
217 #define SSB_DEV_PCI 0x804
218 #define SSB_DEV_MIPS 0x805
219 #define SSB_DEV_ETHERNET 0x806
220 #define SSB_DEV_V90 0x807
221 #define SSB_DEV_USB11_HOSTDEV 0x808
222 #define SSB_DEV_ADSL 0x809
223 #define SSB_DEV_ILINE100 0x80A
224 #define SSB_DEV_IPSEC 0x80B
225 #define SSB_DEV_PCMCIA 0x80D
226 #define SSB_DEV_INTERNAL_MEM 0x80E
227 #define SSB_DEV_MEMC_SDRAM 0x80F
228 #define SSB_DEV_EXTIF 0x811
229 #define SSB_DEV_80211 0x812
230 #define SSB_DEV_MIPS_3302 0x816
231 #define SSB_DEV_USB11_HOST 0x817
232 #define SSB_DEV_USB11_DEV 0x818
233 #define SSB_DEV_USB20_HOST 0x819
234 #define SSB_DEV_USB20_DEV 0x81A
235 #define SSB_DEV_SDIO_HOST 0x81B
236 #define SSB_DEV_ROBOSWITCH 0x81C
237 #define SSB_DEV_PARA_ATA 0x81D
238 #define SSB_DEV_SATA_XORDMA 0x81E
239 #define SSB_DEV_ETHERNET_GBIT 0x81F
240 #define SSB_DEV_PCIE 0x820
241 #define SSB_DEV_MIMO_PHY 0x821
242 #define SSB_DEV_SRAM_CTRLR 0x822
243 #define SSB_DEV_MINI_MACPHY 0x823
244 #define SSB_DEV_ARM_1176 0x824
245 #define SSB_DEV_ARM_7TDMI 0x825
246 #define SSB_DEV_ARM_CM3 0x82A
248 /* Vendor-ID values */
249 #define SSB_VENDOR_BROADCOM 0x4243
251 /* Some kernel subsystems poke with dev->drvdata, so we must use the
252 * following ugly workaround to get from struct device to struct ssb_device */
253 struct __ssb_dev_wrapper {
255 struct ssb_device *sdev;
259 /* Having a copy of the ops pointer in each dev struct
260 * is an optimization. */
261 const struct ssb_bus_ops *ops;
263 struct device *dev, *dma_dev;
266 struct ssb_device_id id;
271 /* Internal-only stuff follows. */
272 void *drvdata; /* Per-device data */
273 void *devtypedata; /* Per-devicetype (eg 802.11) data */
276 /* Go from struct device to struct ssb_device. */
278 struct ssb_device * dev_to_ssb_dev(struct device *dev)
280 struct __ssb_dev_wrapper *wrap;
281 wrap = container_of(dev, struct __ssb_dev_wrapper, dev);
285 /* Device specific user data */
287 void ssb_set_drvdata(struct ssb_device *dev, void *data)
292 void * ssb_get_drvdata(struct ssb_device *dev)
297 /* Devicetype specific user data. This is per device-type (not per device) */
298 void ssb_set_devtypedata(struct ssb_device *dev, void *data);
300 void * ssb_get_devtypedata(struct ssb_device *dev)
302 return dev->devtypedata;
308 const struct ssb_device_id *id_table;
310 int (*probe)(struct ssb_device *dev, const struct ssb_device_id *id);
311 void (*remove)(struct ssb_device *dev);
312 int (*suspend)(struct ssb_device *dev, pm_message_t state);
313 int (*resume)(struct ssb_device *dev);
314 void (*shutdown)(struct ssb_device *dev);
316 struct device_driver drv;
318 #define drv_to_ssb_drv(_drv) container_of(_drv, struct ssb_driver, drv)
320 extern int __ssb_driver_register(struct ssb_driver *drv, struct module *owner);
321 #define ssb_driver_register(drv) \
322 __ssb_driver_register(drv, THIS_MODULE)
324 extern void ssb_driver_unregister(struct ssb_driver *drv);
330 SSB_BUSTYPE_SSB, /* This SSB bus is the system bus */
331 SSB_BUSTYPE_PCI, /* SSB is connected to PCI bus */
332 SSB_BUSTYPE_PCMCIA, /* SSB is connected to PCMCIA bus */
333 SSB_BUSTYPE_SDIO, /* SSB is connected to SDIO bus */
337 #define SSB_BOARDVENDOR_BCM 0x14E4 /* Broadcom */
338 #define SSB_BOARDVENDOR_DELL 0x1028 /* Dell */
339 #define SSB_BOARDVENDOR_HP 0x0E11 /* HP */
341 #define SSB_BOARD_BCM94306MP 0x0418
342 #define SSB_BOARD_BCM4309G 0x0421
343 #define SSB_BOARD_BCM4306CB 0x0417
344 #define SSB_BOARD_BCM4309MP 0x040C
345 #define SSB_BOARD_MP4318 0x044A
346 #define SSB_BOARD_BU4306 0x0416
347 #define SSB_BOARD_BU4309 0x040A
349 #define SSB_CHIPPACK_BCM4712S 1 /* Small 200pin 4712 */
350 #define SSB_CHIPPACK_BCM4712M 2 /* Medium 225pin 4712 */
351 #define SSB_CHIPPACK_BCM4712L 0 /* Large 340pin 4712 */
353 #include <linux/ssb/ssb_driver_chipcommon.h>
354 #include <linux/ssb/ssb_driver_mips.h>
355 #include <linux/ssb/ssb_driver_extif.h>
356 #include <linux/ssb/ssb_driver_pci.h>
362 const struct ssb_bus_ops *ops;
364 /* The core currently mapped into the MMIO window.
365 * Not valid on all host-buses. So don't use outside of SSB. */
366 struct ssb_device *mapped_device;
368 /* Currently mapped PCMCIA segment. (bustype == SSB_BUSTYPE_PCMCIA only) */
369 u8 mapped_pcmcia_seg;
370 /* Current SSB base address window for SDIO. */
373 /* Lock for core and segment switching.
374 * On PCMCIA-host busses this is used to protect the whole MMIO access. */
377 /* The host-bus this backplane is running on. */
378 enum ssb_bustype bustype;
379 /* Pointers to the host-bus. Check bustype before using any of these pointers. */
381 /* Pointer to the PCI bus (only valid if bustype == SSB_BUSTYPE_PCI). */
382 struct pci_dev *host_pci;
383 /* Pointer to the PCMCIA device (only if bustype == SSB_BUSTYPE_PCMCIA). */
384 struct pcmcia_device *host_pcmcia;
385 /* Pointer to the SDIO device (only if bustype == SSB_BUSTYPE_SDIO). */
386 struct sdio_func *host_sdio;
389 /* See enum ssb_quirks */
392 #ifdef CONFIG_SSB_SPROM
393 /* Mutex to protect the SPROM writing. */
394 struct mutex sprom_mutex;
397 /* ID information about the Chip. */
401 u16 sprom_size; /* number of words in sprom */
404 /* List of devices (cores) on the backplane. */
405 struct ssb_device devices[SSB_MAX_NR_CORES];
408 /* Software ID number for this bus. */
409 unsigned int busnumber;
411 /* The ChipCommon device (if available). */
412 struct ssb_chipcommon chipco;
413 /* The PCI-core device (if available). */
414 struct ssb_pcicore pcicore;
415 /* The MIPS-core device (if available). */
416 struct ssb_mipscore mipscore;
417 /* The EXTif-core device (if available). */
418 struct ssb_extif extif;
420 /* The following structure elements are not available in early
421 * SSB initialization. Though, they are available for regular
422 * registered drivers at any stage. So be careful when
423 * using them in the ssb core code. */
425 /* ID information about the PCB. */
426 struct ssb_boardinfo boardinfo;
427 /* Contents of the SPROM. */
428 struct ssb_sprom sprom;
429 /* If the board has a cardbus slot, this is set to true. */
430 bool has_cardbus_slot;
432 #ifdef CONFIG_SSB_EMBEDDED
433 /* Lock for GPIO register access. */
434 spinlock_t gpio_lock;
435 #endif /* EMBEDDED */
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? */
442 int power_warn_count;
447 /* SDIO connected card requires performing a read after writing a 32-bit value */
448 SSB_QUIRK_SDIO_READ_AFTER_WRITE32 = (1 << 0),
451 /* The initialization-invariants. */
452 struct ssb_init_invariants {
453 /* Versioning information about the PCB. */
454 struct ssb_boardinfo boardinfo;
455 /* The SPROM information. That's either stored in an
456 * EEPROM or NVRAM on the board. */
457 struct ssb_sprom sprom;
458 /* If the board has a cardbus slot, this is set to true. */
459 bool has_cardbus_slot;
461 /* Type of function to fetch the invariants. */
462 typedef int (*ssb_invariants_func_t)(struct ssb_bus *bus,
463 struct ssb_init_invariants *iv);
465 /* Register a SSB system bus. get_invariants() is called after the
466 * basic system devices are initialized.
467 * The invariants are usually fetched from some NVRAM.
468 * Put the invariants into the struct pointed to by iv. */
469 extern int ssb_bus_ssbbus_register(struct ssb_bus *bus,
470 unsigned long baseaddr,
471 ssb_invariants_func_t get_invariants);
472 #ifdef CONFIG_SSB_PCIHOST
473 extern int ssb_bus_pcibus_register(struct ssb_bus *bus,
474 struct pci_dev *host_pci);
475 #endif /* CONFIG_SSB_PCIHOST */
476 #ifdef CONFIG_SSB_PCMCIAHOST
477 extern int ssb_bus_pcmciabus_register(struct ssb_bus *bus,
478 struct pcmcia_device *pcmcia_dev,
479 unsigned long baseaddr);
480 #endif /* CONFIG_SSB_PCMCIAHOST */
481 #ifdef CONFIG_SSB_SDIOHOST
482 extern int ssb_bus_sdiobus_register(struct ssb_bus *bus,
483 struct sdio_func *sdio_func,
484 unsigned int quirks);
485 #endif /* CONFIG_SSB_SDIOHOST */
488 extern void ssb_bus_unregister(struct ssb_bus *bus);
490 /* Does the device have an SPROM? */
491 extern bool ssb_is_sprom_available(struct ssb_bus *bus);
493 /* Set a fallback SPROM.
494 * See kdoc at the function definition for complete documentation. */
495 extern int ssb_arch_register_fallback_sprom(
496 int (*sprom_callback)(struct ssb_bus *bus,
497 struct ssb_sprom *out));
499 /* Suspend a SSB bus.
500 * Call this from the parent bus suspend routine. */
501 extern int ssb_bus_suspend(struct ssb_bus *bus);
503 * Call this from the parent bus resume routine. */
504 extern int ssb_bus_resume(struct ssb_bus *bus);
506 extern u32 ssb_clockspeed(struct ssb_bus *bus);
508 /* Is the device enabled in hardware? */
509 int ssb_device_is_enabled(struct ssb_device *dev);
510 /* Enable a device and pass device-specific SSB_TMSLOW flags.
511 * If no device-specific flags are available, use 0. */
512 void ssb_device_enable(struct ssb_device *dev, u32 core_specific_flags);
513 /* Disable a device in hardware and pass SSB_TMSLOW flags (if any). */
514 void ssb_device_disable(struct ssb_device *dev, u32 core_specific_flags);
517 /* Device MMIO register read/write functions. */
518 static inline u8 ssb_read8(struct ssb_device *dev, u16 offset)
520 return dev->ops->read8(dev, offset);
522 static inline u16 ssb_read16(struct ssb_device *dev, u16 offset)
524 return dev->ops->read16(dev, offset);
526 static inline u32 ssb_read32(struct ssb_device *dev, u16 offset)
528 return dev->ops->read32(dev, offset);
530 static inline void ssb_write8(struct ssb_device *dev, u16 offset, u8 value)
532 dev->ops->write8(dev, offset, value);
534 static inline void ssb_write16(struct ssb_device *dev, u16 offset, u16 value)
536 dev->ops->write16(dev, offset, value);
538 static inline void ssb_write32(struct ssb_device *dev, u16 offset, u32 value)
540 dev->ops->write32(dev, offset, value);
542 #ifdef CONFIG_SSB_BLOCKIO
543 static inline void ssb_block_read(struct ssb_device *dev, void *buffer,
544 size_t count, u16 offset, u8 reg_width)
546 dev->ops->block_read(dev, buffer, count, offset, reg_width);
549 static inline void ssb_block_write(struct ssb_device *dev, const void *buffer,
550 size_t count, u16 offset, u8 reg_width)
552 dev->ops->block_write(dev, buffer, count, offset, reg_width);
554 #endif /* CONFIG_SSB_BLOCKIO */
557 /* The SSB DMA API. Use this API for any DMA operation on the device.
558 * This API basically is a wrapper that calls the correct DMA API for
559 * the host device type the SSB device is attached to. */
561 /* Translation (routing) bits that need to be ORed to DMA
562 * addresses before they are given to a device. */
563 extern u32 ssb_dma_translation(struct ssb_device *dev);
564 #define SSB_DMA_TRANSLATION_MASK 0xC0000000
565 #define SSB_DMA_TRANSLATION_SHIFT 30
567 static inline void __cold __ssb_dma_not_implemented(struct ssb_device *dev)
569 #ifdef CONFIG_SSB_DEBUG
570 printk(KERN_ERR "SSB: BUG! Calling DMA API for "
571 "unsupported bustype %d\n", dev->bus->bustype);
575 #ifdef CONFIG_SSB_PCIHOST
576 /* PCI-host wrapper driver */
577 extern int ssb_pcihost_register(struct pci_driver *driver);
578 static inline void ssb_pcihost_unregister(struct pci_driver *driver)
580 pci_unregister_driver(driver);
584 void ssb_pcihost_set_power_state(struct ssb_device *sdev, pci_power_t state)
586 if (sdev->bus->bustype == SSB_BUSTYPE_PCI)
587 pci_set_power_state(sdev->bus->host_pci, state);
590 static inline void ssb_pcihost_unregister(struct pci_driver *driver)
595 void ssb_pcihost_set_power_state(struct ssb_device *sdev, pci_power_t state)
598 #endif /* CONFIG_SSB_PCIHOST */
601 /* If a driver is shutdown or suspended, call this to signal
602 * that the bus may be completely powered down. SSB will decide,
603 * if it's really time to power down the bus, based on if there
604 * are other devices that want to run. */
605 extern int ssb_bus_may_powerdown(struct ssb_bus *bus);
606 /* Before initializing and enabling a device, call this to power-up the bus.
607 * If you want to allow use of dynamic-power-control, pass the flag.
608 * Otherwise static always-on powercontrol will be used. */
609 extern int ssb_bus_powerup(struct ssb_bus *bus, bool dynamic_pctl);
611 extern void ssb_commit_settings(struct ssb_bus *bus);
613 /* Various helper functions */
614 extern u32 ssb_admatch_base(u32 adm);
615 extern u32 ssb_admatch_size(u32 adm);
617 /* PCI device mapping and fixup routines.
618 * Called from the architecture pcibios init code.
619 * These are only available on SSB_EMBEDDED configurations. */
620 #ifdef CONFIG_SSB_EMBEDDED
621 int ssb_pcibios_plat_dev_init(struct pci_dev *dev);
622 int ssb_pcibios_map_irq(const struct pci_dev *dev, u8 slot, u8 pin);
623 #endif /* CONFIG_SSB_EMBEDDED */
625 #endif /* LINUX_SSB_H_ */