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 osl_t *osl_attach(void *pdev, uint bustype);
  22 extern void osl_detach(osl_t *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 configuration space access macros */
  44 #define OSL_PCI_READ_CONFIG(osh, offset, size) \
  45         osl_pci_read_config((osh), (offset), (size))
  46 #define OSL_PCI_WRITE_CONFIG(osh, offset, size, val) \
  47         osl_pci_write_config((osh), (offset), (size), (val))
  48 extern u32 osl_pci_read_config(osl_t *osh, uint offset, uint size);
  49 extern void osl_pci_write_config(osl_t *osh, uint offset, uint size, uint val);
  50
  51 /* PCI device bus # and slot # */
  52 #define OSL_PCI_BUS(osh)        osl_pci_bus(osh)
  53 #define OSL_PCI_SLOT(osh)       osl_pci_slot(osh)
  54 extern uint osl_pci_bus(osl_t *osh);
  55 extern uint osl_pci_slot(osl_t *osh);
  56
  57 /* Pkttag flag should be part of public information */
  58 typedef struct {
  59         uint pktalloced;        /* Number of allocated packet buffers */
  60         bool mmbus;             /* Bus supports memory-mapped register accesses */
  61         pktfree_cb_fn_t tx_fn;  /* Callback function for PKTFREE */
  62         void *tx_ctx;           /* Context to the callback function */
  63 #if defined(BCMSDIO) && !defined(BRCM_FULLMAC)
  64         osl_rreg_fn_t rreg_fn;  /* Read Register function */
  65         osl_wreg_fn_t wreg_fn;  /* Write Register function */
  66         void *reg_ctx;          /* Context to the reg callback functions */
  67 #endif
  68 } osl_pubinfo_t;
  69
  70 #define PKTFREESETCB(osh, _tx_fn, _tx_ctx)                      \
  71         do {                                                    \
  72                 ((osl_pubinfo_t *)osh)->tx_fn = _tx_fn;         \
  73                 ((osl_pubinfo_t *)osh)->tx_ctx = _tx_ctx;       \
  74         } while (0)
  75
  76 #if defined(BCMSDIO) && !defined(BRCM_FULLMAC)
  77 #define REGOPSSET(osh, rreg, wreg, ctx)                 \
  78         do {                                            \
  79                 ((osl_pubinfo_t *)osh)->rreg_fn = rreg; \
  80                 ((osl_pubinfo_t *)osh)->wreg_fn = wreg; \
  81                 ((osl_pubinfo_t *)osh)->reg_ctx = ctx;  \
  82         } while (0)
  83 #endif
  84
  85 #define BUS_SWAP32(v)           (v)
  86
  87 extern void *osl_dma_alloc_consistent(osl_t *osh, uint size, u16 align,
  88                                       uint *tot, unsigned long *pap);
  89
  90 #ifdef BRCM_FULLMAC
  91 #define DMA_ALLOC_CONSISTENT(osh, size, pap, dmah, alignbits) \
  92         osl_dma_alloc_consistent((osh), (size), (0), (tot), (pap))
  93 #else
  94 #define DMA_ALLOC_CONSISTENT(osh, size, align, tot, pap, dmah) \
  95         osl_dma_alloc_consistent((osh), (size), (align), (tot), (pap))
  96 #endif /* BRCM_FULLMAC */
  97
  98 #define DMA_FREE_CONSISTENT(osh, va, size, pa, dmah) \
  99         osl_dma_free_consistent((osh), (void *)(va), (size), (pa))
 100 extern void osl_dma_free_consistent(osl_t *osh, void *va, uint size, unsigned long pa);
 101
 102 /* map/unmap direction */
 103 #define DMA_TX  1               /* TX direction for DMA */
 104 #define DMA_RX  2               /* RX direction for DMA */
 105
 106 /* map/unmap shared (dma-able) memory */
 107 #define DMA_MAP(osh, va, size, direction, p, dmah) \
 108         osl_dma_map((osh), (va), (size), (direction))
 109 #define DMA_UNMAP(osh, pa, size, direction, p, dmah) \
 110         osl_dma_unmap((osh), (pa), (size), (direction))
 111 extern uint osl_dma_map(osl_t *osh, void *va, uint size, int direction);
 112 extern void osl_dma_unmap(osl_t *osh, uint pa, uint size, int direction);
 113
 114 /* API for DMA addressing capability */
 115 #define OSL_DMADDRWIDTH(osh, addrwidth) do {} while (0)
 116
 117 /* register access macros */
 118 #if defined(BCMSDIO)
 119 #ifdef BRCM_FULLMAC
 120 #include <bcmsdh.h>
 121 #endif
 122 #define OSL_WRITE_REG(osh, r, v) (bcmsdh_reg_write(NULL, (unsigned long)(r), sizeof(*(r)), (v)))
 123 #define OSL_READ_REG(osh, r) (bcmsdh_reg_read(NULL, (unsigned long)(r), sizeof(*(r))))
 124 #endif
 125
 126 #if defined(BCMSDIO)
 127 #define SELECT_BUS_WRITE(osh, mmap_op, bus_op) if (((osl_pubinfo_t *)(osh))->mmbus) \
 128                 mmap_op else bus_op
 129 #define SELECT_BUS_READ(osh, mmap_op, bus_op) (((osl_pubinfo_t *)(osh))->mmbus) ? \
 130                 mmap_op : bus_op
 131 #else
 132 #define SELECT_BUS_WRITE(osh, mmap_op, bus_op) mmap_op
 133 #define SELECT_BUS_READ(osh, mmap_op, bus_op) mmap_op
 134 #endif
 135
 136 /* the largest reasonable packet buffer driver uses for ethernet MTU in bytes */
 137 #define PKTBUFSZ        2048    /* largest reasonable packet buffer, driver uses for ethernet MTU */
 138
 139 #define OSL_SYSUPTIME()         ((u32)jiffies * (1000 / HZ))
 140 #define printf(fmt, args...)    printk(fmt , ## args)
 141 #ifdef BRCM_FULLMAC
 142 #include <linux/kernel.h>       /* for vsn/printf's */
 143 #include <linux/string.h>       /* for mem*, str* */
 144 #endif
 145 /* bcopy's: Linux kernel doesn't provide these (anymore) */
 146 #define bcopy(src, dst, len)    memcpy((dst), (src), (len))
 147 #define bcmp(b1, b2, len)       memcmp((b1), (b2), (len))
 148 #define bzero(b, len)           memset((b), '\0', (len))
 149
 150 /* register access macros */
 151 #if defined(OSLREGOPS)
 152 #else
 153 #ifndef IL_BIGENDIAN
 154 #ifndef __mips__
 155 #define R_REG(osh, r) (\
 156         SELECT_BUS_READ(osh, sizeof(*(r)) == sizeof(u8) ? readb((volatile u8*)(r)) : \
 157         sizeof(*(r)) == sizeof(u16) ? readw((volatile u16*)(r)) : \
 158         readl((volatile u32*)(r)), OSL_READ_REG(osh, r)) \
 159 )
 160 #else                           /* __mips__ */
 161 #define R_REG(osh, r) (\
 162         SELECT_BUS_READ(osh, \
 163                 ({ \
 164                         __typeof(*(r)) __osl_v; \
 165                         __asm__ __volatile__("sync"); \
 166                         switch (sizeof(*(r))) { \
 167                         case sizeof(u8): \
 168                                 __osl_v = readb((volatile u8*)(r)); \
 169                                 break; \
 170                         case sizeof(u16): \
 171                                 __osl_v = readw((volatile u16*)(r)); \
 172                                 break; \
 173                         case sizeof(u32): \
 174                                 __osl_v = \
 175                                 readl((volatile u32*)(r)); \
 176                                 break; \
 177                         } \
 178                         __asm__ __volatile__("sync"); \
 179                         __osl_v; \
 180                 }), \
 181                 ({ \
 182                         __typeof(*(r)) __osl_v; \
 183                         __asm__ __volatile__("sync"); \
 184                         __osl_v = OSL_READ_REG(osh, r); \
 185                         __asm__ __volatile__("sync"); \
 186                         __osl_v; \
 187                 })) \
 188 )
 189 #endif                          /* __mips__ */
 190
 191 #define W_REG(osh, r, v) do { \
 192         SELECT_BUS_WRITE(osh,  \
 193                 switch (sizeof(*(r))) { \
 194                 case sizeof(u8): \
 195                         writeb((u8)(v), (volatile u8*)(r)); break; \
 196                 case sizeof(u16): \
 197                         writew((u16)(v), (volatile u16*)(r)); break; \
 198                 case sizeof(u32): \
 199                         writel((u32)(v), (volatile u32*)(r)); break; \
 200                 }, \
 201                 (OSL_WRITE_REG(osh, r, v))); \
 202         } while (0)
 203 #else                           /* IL_BIGENDIAN */
 204 #define R_REG(osh, r) (\
 205         SELECT_BUS_READ(osh, \
 206                 ({ \
 207                         __typeof(*(r)) __osl_v; \
 208                         switch (sizeof(*(r))) { \
 209                         case sizeof(u8): \
 210                                 __osl_v = \
 211                                 readb((volatile u8*)((r)^3)); \
 212                                 break; \
 213                         case sizeof(u16): \
 214                                 __osl_v = \
 215                                 readw((volatile u16*)((r)^2)); \
 216                                 break; \
 217                         case sizeof(u32): \
 218                                 __osl_v = readl((volatile u32*)(r)); \
 219                                 break; \
 220                         } \
 221                         __osl_v; \
 222                 }), \
 223                 OSL_READ_REG(osh, r)) \
 224 )
 225 #define W_REG(osh, r, v) do { \
 226         SELECT_BUS_WRITE(osh,  \
 227                 switch (sizeof(*(r))) { \
 228                 case sizeof(u8):        \
 229                         writeb((u8)(v), \
 230                         (volatile u8*)((r)^3)); break; \
 231                 case sizeof(u16):       \
 232                         writew((u16)(v), \
 233                         (volatile u16*)((r)^2)); break; \
 234                 case sizeof(u32):       \
 235                         writel((u32)(v), \
 236                         (volatile u32*)(r)); break; \
 237                 }, \
 238                 (OSL_WRITE_REG(osh, r, v))); \
 239         } while (0)
 240 #endif                          /* IL_BIGENDIAN */
 241
 242 #endif                          /* OSLREGOPS */
 243
 244 #define AND_REG(osh, r, v)              W_REG(osh, (r), R_REG(osh, r) & (v))
 245 #define OR_REG(osh, r, v)               W_REG(osh, (r), R_REG(osh, r) | (v))
 246
 247 /* bcopy, bcmp, and bzero functions */
 248 #define bcopy(src, dst, len)    memcpy((dst), (src), (len))
 249 #define bcmp(b1, b2, len)       memcmp((b1), (b2), (len))
 250 #define bzero(b, len)           memset((b), '\0', (len))
 251
 252 /* uncached/cached virtual address */
 253 #ifdef __mips__
 254 #include <asm/addrspace.h>
 255 #define OSL_UNCACHED(va)        ((void *)KSEG1ADDR((va)))
 256 #define OSL_CACHED(va)          ((void *)KSEG0ADDR((va)))
 257 #else
 258 #define OSL_UNCACHED(va)        ((void *)va)
 259 #define OSL_CACHED(va)          ((void *)va)
 260 #endif                          /* mips */
 261
 262 /* map/unmap physical to virtual I/O */
 263 #if !defined(CONFIG_MMC_MSM7X00A)
 264 #define REG_MAP(pa, size)       ioremap_nocache((unsigned long)(pa), (unsigned long)(size))
 265 #else
 266 #define REG_MAP(pa, size)       (void *)(0)
 267 #endif                          /* !defined(CONFIG_MMC_MSM7X00A */
 268 #define REG_UNMAP(va)           iounmap((va))
 269
 270 #define R_SM(r)                 (*(r))
 271 #define W_SM(r, v)              (*(r) = (v))
 272 #define BZERO_SM(r, len)        memset((r), '\0', (len))
 273
 274 /* packet primitives */
 275 #define PKTGET(osh, len, send)          osl_pktget((osh), (len))
 276 #define PKTFREE(osh, skb, send)         osl_pktfree((osh), (skb), (send))
 277 #define PKTDATA(skb)            (((struct sk_buff *)(skb))->data)
 278 #define PKTLEN(skb)             (((struct sk_buff *)(skb))->len)
 279 #define PKTHEADROOM(skb)                (PKTDATA(skb)-(((struct sk_buff *)(skb))->head))
 280 #define PKTTAILROOM(skb) ((((struct sk_buff *)(skb))->end)-(((struct sk_buff *)(skb))->tail))
 281 #define PKTNEXT(skb)            (((struct sk_buff *)(skb))->next)
 282 #define PKTSETNEXT(skb, x)      \
 283         (((struct sk_buff *)(skb))->next = (struct sk_buff *)(x))
 284 #define PKTSETLEN(skb, len)     __skb_trim((struct sk_buff *)(skb), (len))
 285 #define PKTPUSH(skb, bytes)     skb_push((struct sk_buff *)(skb), (bytes))
 286 #define PKTPULL(skb, bytes)     skb_pull((struct sk_buff *)(skb), (bytes))
 287 #define PKTALLOCED(osh)         (((osl_pubinfo_t *)(osh))->pktalloced)
 288 #define PKTSETPOOL(osh, skb, x, y)      do {} while (0)
 289 #define PKTPOOL(osh, skb)               false
 290 extern void *osl_pktget(osl_t *osh, uint len);
 291 extern void osl_pktfree(osl_t *osh, void *skb, bool send);
 292
 293 #ifdef BRCM_FULLMAC
 294 extern void *osl_pktget_static(osl_t *osh, uint len);
 295 extern void osl_pktfree_static(osl_t *osh, void *skb, bool send);
 296
 297 static inline void *
 298 osl_pkt_frmnative(osl_pubinfo_t *osh, struct sk_buff *skb)
 299 {
 300         struct sk_buff *nskb;
 301
 302         for (nskb = skb; nskb; nskb = nskb->next)
 303                 osh->pktalloced++;
 304
 305         return (void *)skb;
 306 }
 307 #define PKTFRMNATIVE(osh, skb)  \
 308         osl_pkt_frmnative(((osl_pubinfo_t *)osh), (struct sk_buff*)(skb))
 309
 310 static inline struct sk_buff *
 311 osl_pkt_tonative(osl_pubinfo_t *osh, void *pkt)
 312 {
 313         struct sk_buff *nskb;
 314
 315         for (nskb = (struct sk_buff *)pkt; nskb; nskb = nskb->next)
 316                 osh->pktalloced--;
 317
 318         return (struct sk_buff *)pkt;
 319 }
 320 #define PKTTONATIVE(osh, pkt)   \
 321         osl_pkt_tonative((osl_pubinfo_t *)(osh), (pkt))
 322 #else /* !BRCM_FULLMAC */
 323 #define PKTUNALLOC(osh)                 (((osl_pubinfo_t *)(osh))->pktalloced--)
 324
 325 #define PKTSETSKIPCT(osh, skb)
 326 #define PKTCLRSKIPCT(osh, skb)
 327 #define PKTSKIPCT(osh, skb)
 328 #endif  /* BRCM_FULLMAC */
 329
 330 #define PKTLINK(skb)                    (((struct sk_buff *)(skb))->prev)
 331 #define PKTSETLINK(skb, x)              (((struct sk_buff *)(skb))->prev = (struct sk_buff*)(x))
 332 #define PKTPRIO(skb)                    (((struct sk_buff *)(skb))->priority)
 333 #define PKTSETPRIO(skb, x)              (((struct sk_buff *)(skb))->priority = (x))
 334 #define PKTSUMNEEDED(skb)               (((struct sk_buff *)(skb))->ip_summed == CHECKSUM_PARTIAL)
 335 #define PKTSETSUMGOOD(skb, x)           (((struct sk_buff *)(skb))->ip_summed = \
 336                                                 ((x) ? CHECKSUM_UNNECESSARY : CHECKSUM_NONE))
 337 /* PKTSETSUMNEEDED and PKTSUMGOOD are not possible because skb->ip_summed is overloaded */
 338 #define PKTSHARED(skb)                  (((struct sk_buff *)(skb))->cloned)
 339
 340 #if defined(BCMSDIO) && !defined(BRCM_FULLMAC)
 341 #define RPC_READ_REG(osh, r) (\
 342         sizeof(*(r)) == sizeof(u8) ? osl_readb((osh), (volatile u8*)(r)) : \
 343         sizeof(*(r)) == sizeof(u16) ? osl_readw((osh), (volatile u16*)(r)) : \
 344         osl_readl((osh), (volatile u32*)(r)) \
 345 )
 346 #define RPC_WRITE_REG(osh, r, v) do { \
 347         switch (sizeof(*(r))) { \
 348         case sizeof(u8): \
 349                 osl_writeb((osh), (volatile u8*)(r), (u8)(v)); \
 350                 break; \
 351         case sizeof(u16): \
 352                 osl_writew((osh), (volatile u16*)(r), (u16)(v)); \
 353                 break; \
 354         case sizeof(u32): \
 355                 osl_writel((osh), (volatile u32*)(r), (u32)(v)); \
 356                 break; \
 357         } \
 358 } while (0)
 359
 360 extern u8 osl_readb(osl_t *osh, volatile u8 *r);
 361 extern u16 osl_readw(osl_t *osh, volatile u16 *r);
 362 extern u32 osl_readl(osl_t *osh, volatile u32 *r);
 363 extern void osl_writeb(osl_t *osh, volatile u8 *r, u8 v);
 364 extern void osl_writew(osl_t *osh, volatile u16 *r, u16 v);
 365 extern void osl_writel(osl_t *osh, volatile u32 *r, u32 v);
 366 #endif                          /* BCMSDIO */
 367
 368 #endif                          /* _linux_osl_h_ */