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