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 #ifdef BRCM_FULLMAC
  21 #include <typedefs.h>
  22 #endif
  23
  24 /* Linux Kernel: File Operations: start */
  25 extern void *osl_os_open_image(char *filename);
  26 extern int osl_os_get_image_block(char *buf, int len, void *image);
  27 extern void osl_os_close_image(void *image);
  28 /* Linux Kernel: File Operations: end */
  29
  30 extern osl_t *osl_attach(void *pdev, uint bustype, bool pkttag);
  31 extern void osl_detach(osl_t *osh);
  32
  33 extern uint32 g_assert_type;
  34
  35 #if defined(BCMDBG_ASSERT)
  36 #define ASSERT(exp) \
  37           do { if (!(exp)) osl_assert(#exp, __FILE__, __LINE__); } while (0)
  38 extern void osl_assert(char *exp, char *file, int line);
  39 #else
  40 #ifdef __GNUC__
  41 #define GCC_VERSION \
  42                         (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
  43 #if GCC_VERSION > 30100
  44 #define ASSERT(exp)     do {} while (0)
  45 #else
  46                         /* ASSERT could cause segmentation fault on GCC3.1, use empty instead */
  47 #define ASSERT(exp)
  48 #endif                          /* GCC_VERSION > 30100 */
  49 #endif                          /* __GNUC__ */
  50 #endif                          /* defined(BCMDBG_ASSERT) */
  51
  52 #define OSL_DELAY(usec)         osl_delay(usec)
  53 extern void osl_delay(uint usec);
  54
  55 #define OSL_PCMCIA_READ_ATTR(osh, offset, buf, size) \
  56         osl_pcmcia_read_attr((osh), (offset), (buf), (size))
  57 #define OSL_PCMCIA_WRITE_ATTR(osh, offset, buf, size) \
  58         osl_pcmcia_write_attr((osh), (offset), (buf), (size))
  59 extern void osl_pcmcia_read_attr(osl_t *osh, uint offset, void *buf, int size);
  60 extern void osl_pcmcia_write_attr(osl_t *osh, uint offset, void *buf,
  61                                   int size);
  62
  63 /* PCI configuration space access macros */
  64 #define OSL_PCI_READ_CONFIG(osh, offset, size) \
  65         osl_pci_read_config((osh), (offset), (size))
  66 #define OSL_PCI_WRITE_CONFIG(osh, offset, size, val) \
  67         osl_pci_write_config((osh), (offset), (size), (val))
  68 extern uint32 osl_pci_read_config(osl_t *osh, uint offset, uint size);
  69 extern void osl_pci_write_config(osl_t *osh, uint offset, uint size, uint val);
  70
  71 /* PCI device bus # and slot # */
  72 #define OSL_PCI_BUS(osh)        osl_pci_bus(osh)
  73 #define OSL_PCI_SLOT(osh)       osl_pci_slot(osh)
  74 extern uint osl_pci_bus(osl_t *osh);
  75 extern uint osl_pci_slot(osl_t *osh);
  76
  77 /* Pkttag flag should be part of public information */
  78 typedef struct {
  79         bool pkttag;
  80         uint pktalloced;        /* Number of allocated packet buffers */
  81         bool mmbus;             /* Bus supports memory-mapped register accesses */
  82         pktfree_cb_fn_t tx_fn;  /* Callback function for PKTFREE */
  83         void *tx_ctx;           /* Context to the callback function */
  84 #if defined(BCMSDIO) && !defined(BRCM_FULLMAC)
  85         osl_rreg_fn_t rreg_fn;  /* Read Register function */
  86         osl_wreg_fn_t wreg_fn;  /* Write Register function */
  87         void *reg_ctx;          /* Context to the reg callback functions */
  88 #endif
  89 } osl_pubinfo_t;
  90
  91 #define PKTFREESETCB(osh, _tx_fn, _tx_ctx)                      \
  92         do {                                                    \
  93                 ((osl_pubinfo_t *)osh)->tx_fn = _tx_fn;         \
  94                 ((osl_pubinfo_t *)osh)->tx_ctx = _tx_ctx;       \
  95         } while (0)
  96
  97 #if defined(BCMSDIO) && !defined(BRCM_FULLMAC)
  98 #define REGOPSSET(osh, rreg, wreg, ctx)                 \
  99         do {                                            \
 100                 ((osl_pubinfo_t *)osh)->rreg_fn = rreg; \
 101                 ((osl_pubinfo_t *)osh)->wreg_fn = wreg; \
 102                 ((osl_pubinfo_t *)osh)->reg_ctx = ctx;  \
 103         } while (0)
 104 #endif
 105
 106 #define BUS_SWAP32(v)           (v)
 107
 108 #define MALLOC(osh, size)       osl_malloc((osh), (size))
 109 #define MFREE(osh, addr, size)  osl_mfree((osh), (addr), (size))
 110 #define MALLOCED(osh)           osl_malloced((osh))
 111 extern void *osl_malloc(osl_t *osh, uint size);
 112 extern void osl_mfree(osl_t *osh, void *addr, uint size);
 113 extern uint osl_malloced(osl_t *osh);
 114
 115 #define NATIVE_MALLOC(osh, size)        kmalloc(size, GFP_ATOMIC)
 116 #define NATIVE_MFREE(osh, addr, size)   kfree(addr)
 117 #define MALLOC_FAILED(osh)              osl_malloc_failed((osh))
 118 extern uint osl_malloc_failed(osl_t *osh);
 119
 120 #ifdef BRCM_FULLMAC
 121 #define DMA_CONSISTENT_ALIGN    PAGE_SIZE
 122 #define DMA_ALLOC_CONSISTENT(osh, size, pap, dmah, alignbits) \
 123         osl_dma_alloc_consistent((osh), (size), (pap))
 124 extern void *osl_dma_alloc_consistent(osl_t *osh, uint size, unsigned long *pap);
 125 #else
 126 /* allocate/free shared (dma-able) consistent memory */
 127 #define DMA_CONSISTENT_ALIGN    osl_dma_consistent_align()
 128 #define DMA_ALLOC_CONSISTENT(osh, size, align, tot, pap, dmah) \
 129         osl_dma_alloc_consistent((osh), (size), (align), (tot), (pap))
 130 extern uint osl_dma_consistent_align(void);
 131 extern void *osl_dma_alloc_consistent(osl_t *osh, uint size, uint16 align,
 132                                       uint *tot, unsigned long *pap);
 133 #endif
 134 #define DMA_FREE_CONSISTENT(osh, va, size, pa, dmah) \
 135         osl_dma_free_consistent((osh), (void *)(va), (size), (pa))
 136 extern void osl_dma_free_consistent(osl_t *osh, void *va, uint size, unsigned long pa);
 137
 138 /* map/unmap direction */
 139 #define DMA_TX  1               /* TX direction for DMA */
 140 #define DMA_RX  2               /* RX direction for DMA */
 141
 142 /* map/unmap shared (dma-able) memory */
 143 #define DMA_MAP(osh, va, size, direction, p, dmah) \
 144         osl_dma_map((osh), (va), (size), (direction))
 145 #define DMA_UNMAP(osh, pa, size, direction, p, dmah) \
 146         osl_dma_unmap((osh), (pa), (size), (direction))
 147 extern uint osl_dma_map(osl_t *osh, void *va, uint size, int direction);
 148 extern void osl_dma_unmap(osl_t *osh, uint pa, uint size, int direction);
 149
 150 /* API for DMA addressing capability */
 151 #define OSL_DMADDRWIDTH(osh, addrwidth) do {} while (0)
 152
 153 /* register access macros */
 154 #if defined(BCMSDIO)
 155 #ifdef BRCM_FULLMAC
 156 #include <bcmsdh.h>
 157 #endif
 158 #define OSL_WRITE_REG(osh, r, v) (bcmsdh_reg_write(NULL, (uintptr)(r), sizeof(*(r)), (v)))
 159 #define OSL_READ_REG(osh, r) (bcmsdh_reg_read(NULL, (uintptr)(r), sizeof(*(r))))
 160 #endif
 161
 162 #if defined(BCMSDIO)
 163 #define SELECT_BUS_WRITE(osh, mmap_op, bus_op) if (((osl_pubinfo_t *)(osh))->mmbus) \
 164                 mmap_op else bus_op
 165 #define SELECT_BUS_READ(osh, mmap_op, bus_op) (((osl_pubinfo_t *)(osh))->mmbus) ? \
 166                 mmap_op : bus_op
 167 #else
 168 #define SELECT_BUS_WRITE(osh, mmap_op, bus_op) mmap_op
 169 #define SELECT_BUS_READ(osh, mmap_op, bus_op) mmap_op
 170 #endif
 171
 172 #define OSL_ERROR(bcmerror)     osl_error(bcmerror)
 173 extern int osl_error(int bcmerror);
 174
 175 /* the largest reasonable packet buffer driver uses for ethernet MTU in bytes */
 176 #define PKTBUFSZ        2048    /* largest reasonable packet buffer, driver uses for ethernet MTU */
 177
 178 #define OSL_SYSUPTIME()         ((uint32)jiffies * (1000 / HZ))
 179 #define printf(fmt, args...)    printk(fmt , ## args)
 180 #ifdef BRCM_FULLMAC
 181 #include <linux/kernel.h>       /* for vsn/printf's */
 182 #include <linux/string.h>       /* for mem*, str* */
 183 #endif
 184 /* bcopy's: Linux kernel doesn't provide these (anymore) */
 185 #define bcopy(src, dst, len)    memcpy((dst), (src), (len))
 186 #define bcmp(b1, b2, len)       memcmp((b1), (b2), (len))
 187 #define bzero(b, len)           memset((b), '\0', (len))
 188
 189 /* register access macros */
 190 #if defined(OSLREGOPS)
 191 #else
 192 #ifndef IL_BIGENDIAN
 193 #ifndef __mips__
 194 #define R_REG(osh, r) (\
 195         SELECT_BUS_READ(osh, sizeof(*(r)) == sizeof(u8) ? readb((volatile u8*)(r)) : \
 196         sizeof(*(r)) == sizeof(uint16) ? readw((volatile uint16*)(r)) : \
 197         readl((volatile uint32*)(r)), OSL_READ_REG(osh, r)) \
 198 )
 199 #else                           /* __mips__ */
 200 #define R_REG(osh, r) (\
 201         SELECT_BUS_READ(osh, \
 202                 ({ \
 203                         __typeof(*(r)) __osl_v; \
 204                         __asm__ __volatile__("sync"); \
 205                         switch (sizeof(*(r))) { \
 206                         case sizeof(u8): \
 207                                 __osl_v = readb((volatile u8*)(r)); \
 208                                 break; \
 209                         case sizeof(uint16): \
 210                                 __osl_v = readw((volatile uint16*)(r)); \
 211                                 break; \
 212                         case sizeof(uint32): \
 213                                 __osl_v = \
 214                                 readl((volatile uint32*)(r)); \
 215                                 break; \
 216                         } \
 217                         __asm__ __volatile__("sync"); \
 218                         __osl_v; \
 219                 }), \
 220                 ({ \
 221                         __typeof(*(r)) __osl_v; \
 222                         __asm__ __volatile__("sync"); \
 223                         __osl_v = OSL_READ_REG(osh, r); \
 224                         __asm__ __volatile__("sync"); \
 225                         __osl_v; \
 226                 })) \
 227 )
 228 #endif                          /* __mips__ */
 229
 230 #define W_REG(osh, r, v) do { \
 231         SELECT_BUS_WRITE(osh,  \
 232                 switch (sizeof(*(r))) { \
 233                 case sizeof(u8): \
 234                         writeb((u8)(v), (volatile u8*)(r)); break; \
 235                 case sizeof(uint16): \
 236                         writew((uint16)(v), (volatile uint16*)(r)); break; \
 237                 case sizeof(uint32): \
 238                         writel((uint32)(v), (volatile uint32*)(r)); break; \
 239                 }, \
 240                 (OSL_WRITE_REG(osh, r, v))); \
 241         } while (0)
 242 #else                           /* IL_BIGENDIAN */
 243 #define R_REG(osh, r) (\
 244         SELECT_BUS_READ(osh, \
 245                 ({ \
 246                         __typeof(*(r)) __osl_v; \
 247                         switch (sizeof(*(r))) { \
 248                         case sizeof(u8): \
 249                                 __osl_v = \
 250                                 readb((volatile u8*)((uintptr)(r)^3)); \
 251                                 break; \
 252                         case sizeof(uint16): \
 253                                 __osl_v = \
 254                                 readw((volatile uint16*)((uintptr)(r)^2)); \
 255                                 break; \
 256                         case sizeof(uint32): \
 257                                 __osl_v = readl((volatile uint32*)(r)); \
 258                                 break; \
 259                         } \
 260                         __osl_v; \
 261                 }), \
 262                 OSL_READ_REG(osh, r)) \
 263 )
 264 #define W_REG(osh, r, v) do { \
 265         SELECT_BUS_WRITE(osh,  \
 266                 switch (sizeof(*(r))) { \
 267                 case sizeof(u8):        \
 268                         writeb((u8)(v), \
 269                         (volatile u8*)((uintptr)(r)^3)); break; \
 270                 case sizeof(uint16):    \
 271                         writew((uint16)(v), \
 272                         (volatile uint16*)((uintptr)(r)^2)); break; \
 273                 case sizeof(uint32):    \
 274                         writel((uint32)(v), \
 275                         (volatile uint32*)(r)); break; \
 276                 }, \
 277                 (OSL_WRITE_REG(osh, r, v))); \
 278         } while (0)
 279 #endif                          /* IL_BIGENDIAN */
 280
 281 #endif                          /* OSLREGOPS */
 282
 283 #define AND_REG(osh, r, v)              W_REG(osh, (r), R_REG(osh, r) & (v))
 284 #define OR_REG(osh, r, v)               W_REG(osh, (r), R_REG(osh, r) | (v))
 285
 286 /* bcopy, bcmp, and bzero functions */
 287 #define bcopy(src, dst, len)    memcpy((dst), (src), (len))
 288 #define bcmp(b1, b2, len)       memcmp((b1), (b2), (len))
 289 #define bzero(b, len)           memset((b), '\0', (len))
 290
 291 /* uncached/cached virtual address */
 292 #ifdef __mips__
 293 #include <asm/addrspace.h>
 294 #define OSL_UNCACHED(va)        ((void *)KSEG1ADDR((va)))
 295 #define OSL_CACHED(va)          ((void *)KSEG0ADDR((va)))
 296 #else
 297 #define OSL_UNCACHED(va)        ((void *)va)
 298 #define OSL_CACHED(va)          ((void *)va)
 299 #endif                          /* mips */
 300
 301 #if defined(mips)
 302 #define OSL_GETCYCLES(x)        ((x) = read_c0_count() * 2)
 303 #elif defined(__i386__)
 304 #define OSL_GETCYCLES(x)        rdtscl((x))
 305 #else
 306 #define OSL_GETCYCLES(x)        ((x) = 0)
 307 #endif                          /* defined(mips) */
 308
 309 /* dereference an address that may cause a bus exception */
 310 #ifdef mips
 311 #define BUSPROBE(val, addr)     get_dbe((val), (addr))
 312 #include <asm/paccess.h>
 313 #else
 314 #define BUSPROBE(val, addr)     ({ (val) = R_REG(NULL, (addr)); 0; })
 315 #endif                          /* mips */
 316
 317 /* map/unmap physical to virtual I/O */
 318 #if !defined(CONFIG_MMC_MSM7X00A)
 319 #define REG_MAP(pa, size)       ioremap_nocache((unsigned long)(pa), (unsigned long)(size))
 320 #else
 321 #define REG_MAP(pa, size)       (void *)(0)
 322 #endif                          /* !defined(CONFIG_MMC_MSM7X00A */
 323 #define REG_UNMAP(va)           iounmap((va))
 324
 325 #define R_SM(r)                 (*(r))
 326 #define W_SM(r, v)              (*(r) = (v))
 327 #define BZERO_SM(r, len)        memset((r), '\0', (len))
 328
 329 #ifdef BRCM_FULLMAC
 330 #include <linuxver.h>           /* use current 2.4.x calling conventions */
 331 #endif
 332
 333 /* packet primitives */
 334 #define PKTGET(osh, len, send)          osl_pktget((osh), (len))
 335 #define PKTFREE(osh, skb, send)         osl_pktfree((osh), (skb), (send))
 336 #define PKTDATA(skb)            (((struct sk_buff *)(skb))->data)
 337 #define PKTLEN(skb)             (((struct sk_buff *)(skb))->len)
 338 #define PKTHEADROOM(skb)                (PKTDATA(skb)-(((struct sk_buff *)(skb))->head))
 339 #define PKTTAILROOM(skb) ((((struct sk_buff *)(skb))->end)-(((struct sk_buff *)(skb))->tail))
 340 #define PKTNEXT(skb)            (((struct sk_buff *)(skb))->next)
 341 #define PKTSETNEXT(skb, x)      \
 342         (((struct sk_buff *)(skb))->next = (struct sk_buff *)(x))
 343 #define PKTSETLEN(skb, len)     __skb_trim((struct sk_buff *)(skb), (len))
 344 #define PKTPUSH(skb, bytes)     skb_push((struct sk_buff *)(skb), (bytes))
 345 #define PKTPULL(skb, bytes)     skb_pull((struct sk_buff *)(skb), (bytes))
 346 #define PKTDUP(osh, skb)        osl_pktdup((osh), (skb))
 347 #define PKTTAG(skb)             ((void *)(((struct sk_buff *)(skb))->cb))
 348 #define PKTALLOCED(osh)         (((osl_pubinfo_t *)(osh))->pktalloced)
 349 #define PKTSETPOOL(osh, skb, x, y)      do {} while (0)
 350 #define PKTPOOL(osh, skb)               FALSE
 351 extern void *osl_pktget(osl_t *osh, uint len);
 352 extern void osl_pktfree(osl_t *osh, void *skb, bool send);
 353 extern void *osl_pktdup(osl_t *osh, void *skb);
 354
 355 #ifdef BRCM_FULLMAC
 356 #ifdef DHD_USE_STATIC_BUF
 357 #define PKTGET_STATIC(osh, len, send)           osl_pktget_static((osh), (len))
 358 #define PKTFREE_STATIC(osh, skb, send)  \
 359         osl_pktfree_static((osh), (skb), (send))
 360 #endif
 361 extern void *osl_pktget_static(osl_t *osh, uint len);
 362 extern void osl_pktfree_static(osl_t *osh, void *skb, bool send);
 363
 364 static inline void *
 365 osl_pkt_frmnative(osl_pubinfo_t *osh, struct sk_buff *skb)
 366 {
 367         struct sk_buff *nskb;
 368
 369         if (osh->pkttag)
 370                 bzero((void *)skb->cb, OSL_PKTTAG_SZ);
 371
 372         for (nskb = skb; nskb; nskb = nskb->next)
 373                 osh->pktalloced++;
 374
 375         return (void *)skb;
 376 }
 377 #define PKTFRMNATIVE(osh, skb)  \
 378         osl_pkt_frmnative(((osl_pubinfo_t *)osh), (struct sk_buff*)(skb))
 379
 380 static inline struct sk_buff *
 381 osl_pkt_tonative(osl_pubinfo_t *osh, void *pkt)
 382 {
 383         struct sk_buff *nskb;
 384
 385         if (osh->pkttag)
 386                 bzero(((struct sk_buff *)pkt)->cb, OSL_PKTTAG_SZ);
 387
 388         for (nskb = (struct sk_buff *)pkt; nskb; nskb = nskb->next)
 389                 osh->pktalloced--;
 390
 391         return (struct sk_buff *)pkt;
 392 }
 393 #define PKTTONATIVE(osh, pkt)   \
 394         osl_pkt_tonative((osl_pubinfo_t *)(osh), (pkt))
 395 #else /* !BRCM_FULLMAC */
 396 #define PKTUNALLOC(osh)                 (((osl_pubinfo_t *)(osh))->pktalloced--)
 397
 398 #define PKTSETSKIPCT(osh, skb)
 399 #define PKTCLRSKIPCT(osh, skb)
 400 #define PKTSKIPCT(osh, skb)
 401 #endif  /* BRCM_FULLMAC */
 402
 403 #define PKTLINK(skb)                    (((struct sk_buff *)(skb))->prev)
 404 #define PKTSETLINK(skb, x)              (((struct sk_buff *)(skb))->prev = (struct sk_buff*)(x))
 405 #define PKTPRIO(skb)                    (((struct sk_buff *)(skb))->priority)
 406 #define PKTSETPRIO(skb, x)              (((struct sk_buff *)(skb))->priority = (x))
 407 #define PKTSUMNEEDED(skb)               (((struct sk_buff *)(skb))->ip_summed == CHECKSUM_PARTIAL)
 408 #define PKTSETSUMGOOD(skb, x)           (((struct sk_buff *)(skb))->ip_summed = \
 409                                                 ((x) ? CHECKSUM_UNNECESSARY : CHECKSUM_NONE))
 410 /* PKTSETSUMNEEDED and PKTSUMGOOD are not possible because skb->ip_summed is overloaded */
 411 #define PKTSHARED(skb)                  (((struct sk_buff *)(skb))->cloned)
 412
 413 #if defined(BCMSDIO) && !defined(BRCM_FULLMAC)
 414 #define RPC_READ_REG(osh, r) (\
 415         sizeof(*(r)) == sizeof(u8) ? osl_readb((osh), (volatile u8*)(r)) : \
 416         sizeof(*(r)) == sizeof(uint16) ? osl_readw((osh), (volatile uint16*)(r)) : \
 417         osl_readl((osh), (volatile uint32*)(r)) \
 418 )
 419 #define RPC_WRITE_REG(osh, r, v) do { \
 420         switch (sizeof(*(r))) { \
 421         case sizeof(u8): \
 422                 osl_writeb((osh), (volatile u8*)(r), (u8)(v)); \
 423                 break; \
 424         case sizeof(uint16): \
 425                 osl_writew((osh), (volatile uint16*)(r), (uint16)(v)); \
 426                 break; \
 427         case sizeof(uint32): \
 428                 osl_writel((osh), (volatile uint32*)(r), (uint32)(v)); \
 429                 break; \
 430         } \
 431 } while (0)
 432
 433 extern u8 osl_readb(osl_t *osh, volatile u8 *r);
 434 extern uint16 osl_readw(osl_t *osh, volatile uint16 *r);
 435 extern uint32 osl_readl(osl_t *osh, volatile uint32 *r);
 436 extern void osl_writeb(osl_t *osh, volatile u8 *r, u8 v);
 437 extern void osl_writew(osl_t *osh, volatile uint16 *r, uint16 v);
 438 extern void osl_writel(osl_t *osh, volatile uint32 *r, uint32 v);
 439 #endif                          /* BCMSDIO */
 440
 441 #endif                          /* _linux_osl_h_ */