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