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