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