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