drivers/staging/brcm80211/include/linux_osl.h

   1 /*
   2  * Copyright (c) 2010 Broadcom Corporation
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  11  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
  13  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  14  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 #ifndef _linux_osl_h_
  18 #define _linux_osl_h_
  19
  20
  21 extern struct osl_info *osl_attach(void *pdev, uint bustype);
  22 extern void osl_detach(struct osl_info *osh);
  23
  24 extern u32 g_assert_type;
  25
  26 #if defined(BCMDBG_ASSERT)
  27 #define ASSERT(exp) \
  28           do { if (!(exp)) osl_assert(#exp, __FILE__, __LINE__); } while (0)
  29 extern void osl_assert(char *exp, char *file, int line);
  30 #else
  31 #ifdef __GNUC__
  32 #define GCC_VERSION \
  33                         (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
  34 #if GCC_VERSION > 30100
  35 #define ASSERT(exp)     do {} while (0)
  36 #else
  37                         /* ASSERT could cause segmentation fault on GCC3.1, use empty instead */
  38 #define ASSERT(exp)
  39 #endif                          /* GCC_VERSION > 30100 */
  40 #endif                          /* __GNUC__ */
  41 #endif                          /* defined(BCMDBG_ASSERT) */
  42
  43 /* PCI device bus # and slot # */
  44 #define OSL_PCI_BUS(osh)        osl_pci_bus(osh)
  45 #define OSL_PCI_SLOT(osh)       osl_pci_slot(osh)
  46 extern uint osl_pci_bus(struct osl_info *osh);
  47 extern uint osl_pci_slot(struct osl_info *osh);
  48
  49 #define PKTFREESETCB(osh, _tx_fn, _tx_ctx)                      \
  50         do {                                                    \
  51                 ((struct osl_pubinfo *)osh)->tx_fn = _tx_fn;            \
  52                 ((struct osl_pubinfo *)osh)->tx_ctx = _tx_ctx;  \
  53         } while (0)
  54
  55 #define BUS_SWAP32(v)           (v)
  56
  57 extern void *osl_dma_alloc_consistent(struct osl_info *osh, uint size,
  58                                       u16 align, uint *tot, unsigned long *pap);
  59
  60 #ifdef BRCM_FULLMAC
  61 #define DMA_ALLOC_CONSISTENT(osh, size, pap, dmah, alignbits) \
  62         osl_dma_alloc_consistent((osh), (size), (0), (tot), (pap))
  63 #else
  64 #define DMA_ALLOC_CONSISTENT(osh, size, align, tot, pap, dmah) \
  65         osl_dma_alloc_consistent((osh), (size), (align), (tot), (pap))
  66 #endif /* BRCM_FULLMAC */
  67
  68 #define DMA_FREE_CONSISTENT(osh, va, size, pa, dmah) \
  69         osl_dma_free_consistent((osh), (void *)(va), (size), (pa))
  70 extern void osl_dma_free_consistent(struct osl_info *osh, void *va,
  71                                     uint size, unsigned long pa);
  72
  73 /* map/unmap direction */
  74 #define DMA_TX  1               /* TX direction for DMA */
  75 #define DMA_RX  2               /* RX direction for DMA */
  76
  77 /* map/unmap shared (dma-able) memory */
  78 #define DMA_MAP(osh, va, size, direction, p, dmah) \
  79         osl_dma_map((osh), (va), (size), (direction))
  80 #define DMA_UNMAP(osh, pa, size, direction, p, dmah) \
  81         osl_dma_unmap((osh), (pa), (size), (direction))
  82 extern uint osl_dma_map(struct osl_info *osh, void *va, uint size,
  83                         int direction);
  84 extern void osl_dma_unmap(struct osl_info *osh, uint pa, uint size,
  85                           int direction);
  86
  87 /* API for DMA addressing capability */
  88 #define OSL_DMADDRWIDTH(osh, addrwidth) do {} while (0)
  89
  90 /* register access macros */
  91 #if defined(BCMSDIO)
  92 #ifdef BRCM_FULLMAC
  93 #include <bcmsdh.h>
  94 #endif
  95 #define OSL_WRITE_REG(osh, r, v) (bcmsdh_reg_write(NULL, (unsigned long)(r), sizeof(*(r)), (v)))
  96 #define OSL_READ_REG(osh, r) (bcmsdh_reg_read(NULL, (unsigned long)(r), sizeof(*(r))))
  97 #endif
  98
  99 #if defined(BCMSDIO)
 100 #define SELECT_BUS_WRITE(osh, mmap_op, bus_op) \
 101         if (((struct osl_pubinfo *)(osh))->mmbus) \
 102                 mmap_op else bus_op
 103 #define SELECT_BUS_READ(osh, mmap_op, bus_op) \
 104         (((struct osl_pubinfo *)(osh))->mmbus) ?  mmap_op : bus_op
 105 #else
 106 #define SELECT_BUS_WRITE(osh, mmap_op, bus_op) mmap_op
 107 #define SELECT_BUS_READ(osh, mmap_op, bus_op) mmap_op
 108 #endif
 109
 110 /* the largest reasonable packet buffer driver uses for ethernet MTU in bytes */
 111 #define PKTBUFSZ        2048    /* largest reasonable packet buffer, driver uses for ethernet MTU */
 112
 113 #define OSL_SYSUPTIME()         ((u32)jiffies * (1000 / HZ))
 114 #define printf(fmt, args...)    printk(fmt , ## args)
 115 #ifdef BRCM_FULLMAC
 116 #include <linux/kernel.h>       /* for vsn/printf's */
 117 #include <linux/string.h>       /* for mem*, str* */
 118 #endif
 119 /* bcopy's: Linux kernel doesn't provide these (anymore) */
 120 #define bcopy(src, dst, len)    memcpy((dst), (src), (len))
 121 #define bcmp(b1, b2, len)       memcmp((b1), (b2), (len))
 122 #define bzero(b, len)           memset((b), '\0', (len))
 123
 124 /* register access macros */
 125 #if defined(OSLREGOPS)
 126 #else
 127 #ifndef IL_BIGENDIAN
 128 #ifndef __mips__
 129 #define R_REG(osh, r) (\
 130         SELECT_BUS_READ(osh, sizeof(*(r)) == sizeof(u8) ? readb((volatile u8*)(r)) : \
 131         sizeof(*(r)) == sizeof(u16) ? readw((volatile u16*)(r)) : \
 132         readl((volatile u32*)(r)), OSL_READ_REG(osh, r)) \
 133 )
 134 #else                           /* __mips__ */
 135 #define R_REG(osh, r) (\
 136         SELECT_BUS_READ(osh, \
 137                 ({ \
 138                         __typeof(*(r)) __osl_v; \
 139                         __asm__ __volatile__("sync"); \
 140                         switch (sizeof(*(r))) { \
 141                         case sizeof(u8): \
 142                                 __osl_v = readb((volatile u8*)(r)); \
 143                                 break; \
 144                         case sizeof(u16): \
 145                                 __osl_v = readw((volatile u16*)(r)); \
 146                                 break; \
 147                         case sizeof(u32): \
 148                                 __osl_v = \
 149                                 readl((volatile u32*)(r)); \
 150                                 break; \
 151                         } \
 152                         __asm__ __volatile__("sync"); \
 153                         __osl_v; \
 154                 }), \
 155                 ({ \
 156                         __typeof(*(r)) __osl_v; \
 157                         __asm__ __volatile__("sync"); \
 158                         __osl_v = OSL_READ_REG(osh, r); \
 159                         __asm__ __volatile__("sync"); \
 160                         __osl_v; \
 161                 })) \
 162 )
 163 #endif                          /* __mips__ */
 164
 165 #define W_REG(osh, r, v) do { \
 166         SELECT_BUS_WRITE(osh,  \
 167                 switch (sizeof(*(r))) { \
 168                 case sizeof(u8): \
 169                         writeb((u8)(v), (volatile u8*)(r)); break; \
 170                 case sizeof(u16): \
 171                         writew((u16)(v), (volatile u16*)(r)); break; \
 172                 case sizeof(u32): \
 173                         writel((u32)(v), (volatile u32*)(r)); break; \
 174                 }, \
 175                 (OSL_WRITE_REG(osh, r, v))); \
 176         } while (0)
 177 #else                           /* IL_BIGENDIAN */
 178 #define R_REG(osh, r) (\
 179         SELECT_BUS_READ(osh, \
 180                 ({ \
 181                         __typeof(*(r)) __osl_v; \
 182                         switch (sizeof(*(r))) { \
 183                         case sizeof(u8): \
 184                                 __osl_v = \
 185                                 readb((volatile u8*)((r)^3)); \
 186                                 break; \
 187                         case sizeof(u16): \
 188                                 __osl_v = \
 189                                 readw((volatile u16*)((r)^2)); \
 190                                 break; \
 191                         case sizeof(u32): \
 192                                 __osl_v = readl((volatile u32*)(r)); \
 193                                 break; \
 194                         } \
 195                         __osl_v; \
 196                 }), \
 197                 OSL_READ_REG(osh, r)) \
 198 )
 199 #define W_REG(osh, r, v) do { \
 200         SELECT_BUS_WRITE(osh,  \
 201                 switch (sizeof(*(r))) { \
 202                 case sizeof(u8):        \
 203                         writeb((u8)(v), \
 204                         (volatile u8*)((r)^3)); break; \
 205                 case sizeof(u16):       \
 206                         writew((u16)(v), \
 207                         (volatile u16*)((r)^2)); break; \
 208                 case sizeof(u32):       \
 209                         writel((u32)(v), \
 210                         (volatile u32*)(r)); break; \
 211                 }, \
 212                 (OSL_WRITE_REG(osh, r, v))); \
 213         } while (0)
 214 #endif                          /* IL_BIGENDIAN */
 215
 216 #endif                          /* OSLREGOPS */
 217
 218 #define AND_REG(osh, r, v)              W_REG(osh, (r), R_REG(osh, r) & (v))
 219 #define OR_REG(osh, r, v)               W_REG(osh, (r), R_REG(osh, r) | (v))
 220
 221 /* bcopy, bcmp, and bzero functions */
 222 #define bcopy(src, dst, len)    memcpy((dst), (src), (len))
 223 #define bcmp(b1, b2, len)       memcmp((b1), (b2), (len))
 224 #define bzero(b, len)           memset((b), '\0', (len))
 225
 226 /* uncached/cached virtual address */
 227 #ifdef __mips__
 228 #include <asm/addrspace.h>
 229 #define OSL_UNCACHED(va)        ((void *)KSEG1ADDR((va)))
 230 #define OSL_CACHED(va)          ((void *)KSEG0ADDR((va)))
 231 #else
 232 #define OSL_UNCACHED(va)        ((void *)va)
 233 #define OSL_CACHED(va)          ((void *)va)
 234 #endif                          /* mips */
 235
 236 /* map/unmap physical to virtual I/O */
 237 #if !defined(CONFIG_MMC_MSM7X00A)
 238 #define REG_MAP(pa, size)       ioremap_nocache((unsigned long)(pa), (unsigned long)(size))
 239 #else
 240 #define REG_MAP(pa, size)       (void *)(0)
 241 #endif                          /* !defined(CONFIG_MMC_MSM7X00A */
 242 #define REG_UNMAP(va)           iounmap((va))
 243
 244 #define R_SM(r)                 (*(r))
 245 #define W_SM(r, v)              (*(r) = (v))
 246 #define BZERO_SM(r, len)        memset((r), '\0', (len))
 247
 248 /* packet primitives */
 249 #define PKTGET(osh, len, send)  osl_pktget((osh), (len))
 250 #define PKTFREE(osh, skb, send) osl_pktfree((osh), (skb), (send))
 251 #define PKTHEADROOM(skb)        ((skb)->data - (skb)->head)
 252 #define PKTTAILROOM(skb)        ((skb)->end - (skb)->tail)
 253 #define PKTALLOCED(osh)         (((struct osl_pubinfo *)(osh))->pktalloced)
 254 extern void *osl_pktget(struct osl_info *osh, uint len);
 255 extern void osl_pktfree(struct osl_info *osh, void *skb, bool send);
 256
 257 #ifdef BRCM_FULLMAC
 258 static inline void *
 259 osl_pkt_frmnative(struct osl_pubinfo *osh, struct sk_buff *skb)
 260 {
 261         struct sk_buff *nskb;
 262
 263         for (nskb = skb; nskb; nskb = nskb->next)
 264                 osh->pktalloced++;
 265
 266         return (void *)skb;
 267 }
 268 #define PKTFRMNATIVE(osh, skb)  \
 269         osl_pkt_frmnative(((struct osl_pubinfo *)osh), (struct sk_buff*)(skb))
 270
 271 static inline struct sk_buff *
 272 osl_pkt_tonative(struct osl_pubinfo *osh, void *pkt)
 273 {
 274         struct sk_buff *nskb;
 275
 276         for (nskb = (struct sk_buff *)pkt; nskb; nskb = nskb->next)
 277                 osh->pktalloced--;
 278
 279         return (struct sk_buff *)pkt;
 280 }
 281 #define PKTTONATIVE(osh, pkt)   \
 282         osl_pkt_tonative((struct osl_pubinfo *)(osh), (pkt))
 283 #else /* !BRCM_FULLMAC */
 284 #define PKTUNALLOC(osh)         (((struct osl_pubinfo *)(osh))->pktalloced--)
 285
 286 #define PKTSETSKIPCT(osh, skb)
 287 #define PKTCLRSKIPCT(osh, skb)
 288 #define PKTSKIPCT(osh, skb)
 289 #endif  /* BRCM_FULLMAC */
 290
 291 #define PKTSUMNEEDED(skb)               (((struct sk_buff *)(skb))->ip_summed == CHECKSUM_PARTIAL)
 292 #define PKTSETSUMGOOD(skb, x)           (((struct sk_buff *)(skb))->ip_summed = \
 293                                                 ((x) ? CHECKSUM_UNNECESSARY : CHECKSUM_NONE))
 294 /* PKTSETSUMNEEDED and PKTSUMGOOD are not possible because skb->ip_summed is overloaded */
 295
 296 #endif                          /* _linux_osl_h_ */