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