aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/net/wireless/brcm80211/include/brcmu_utils.h
diff options
context:
space:
mode:
authorDmitry Torokhov <dmitry.torokhov@gmail.com>2012-01-09 02:38:23 -0500
committerDmitry Torokhov <dmitry.torokhov@gmail.com>2012-01-09 02:38:23 -0500
commitda733563be5a9da26fe81d9f007262d00b846e22 (patch)
treedb28291df94a2043af2123911984c5c173da4e6f /drivers/net/wireless/brcm80211/include/brcmu_utils.h
parent6ccbcf2cb41131f8d56ef0723bf3f7c1f8486076 (diff)
parentdab78d7924598ea4031663dd10db814e2e324928 (diff)
Merge branch 'next' into for-linus
Diffstat (limited to 'drivers/net/wireless/brcm80211/include/brcmu_utils.h')
-rw-r--r--drivers/net/wireless/brcm80211/include/brcmu_utils.h195
1 files changed, 195 insertions, 0 deletions
diff --git a/drivers/net/wireless/brcm80211/include/brcmu_utils.h b/drivers/net/wireless/brcm80211/include/brcmu_utils.h
new file mode 100644
index 000000000000..7d0f46e0eb95
--- /dev/null
+++ b/drivers/net/wireless/brcm80211/include/brcmu_utils.h
@@ -0,0 +1,195 @@
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 _BRCMU_UTILS_H_
18#define _BRCMU_UTILS_H_
19
20#include <linux/skbuff.h>
21
22/*
23 * Spin at most 'us' microseconds while 'exp' is true.
24 * Caller should explicitly test 'exp' when this completes
25 * and take appropriate error action if 'exp' is still true.
26 */
27#define SPINWAIT(exp, us) { \
28 uint countdown = (us) + 9; \
29 while ((exp) && (countdown >= 10)) {\
30 udelay(10); \
31 countdown -= 10; \
32 } \
33}
34
35/* osl multi-precedence packet queue */
36#define PKTQ_LEN_DEFAULT 128 /* Max 128 packets */
37#define PKTQ_MAX_PREC 16 /* Maximum precedence levels */
38
39#define BCME_STRLEN 64 /* Max string length for BCM errors */
40
41/* the largest reasonable packet buffer driver uses for ethernet MTU in bytes */
42#define PKTBUFSZ 2048
43
44#ifndef setbit
45#ifndef NBBY /* the BSD family defines NBBY */
46#define NBBY 8 /* 8 bits per byte */
47#endif /* #ifndef NBBY */
48#define setbit(a, i) (((u8 *)a)[(i)/NBBY] |= 1<<((i)%NBBY))
49#define clrbit(a, i) (((u8 *)a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
50#define isset(a, i) (((const u8 *)a)[(i)/NBBY] & (1<<((i)%NBBY)))
51#define isclr(a, i) ((((const u8 *)a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
52#endif /* setbit */
53
54#define NBITS(type) (sizeof(type) * 8)
55#define NBITVAL(nbits) (1 << (nbits))
56#define MAXBITVAL(nbits) ((1 << (nbits)) - 1)
57#define NBITMASK(nbits) MAXBITVAL(nbits)
58#define MAXNBVAL(nbyte) MAXBITVAL((nbyte) * 8)
59
60/* crc defines */
61#define CRC16_INIT_VALUE 0xffff /* Initial CRC16 checksum value */
62#define CRC16_GOOD_VALUE 0xf0b8 /* Good final CRC16 checksum value */
63
64/* 18-bytes of Ethernet address buffer length */
65#define ETHER_ADDR_STR_LEN 18
66
67struct pktq_prec {
68 struct sk_buff *head; /* first packet to dequeue */
69 struct sk_buff *tail; /* last packet to dequeue */
70 u16 len; /* number of queued packets */
71 u16 max; /* maximum number of queued packets */
72};
73
74/* multi-priority pkt queue */
75struct pktq {
76 u16 num_prec; /* number of precedences in use */
77 u16 hi_prec; /* rapid dequeue hint (>= highest non-empty prec) */
78 u16 max; /* total max packets */
79 u16 len; /* total number of packets */
80 /*
81 * q array must be last since # of elements can be either
82 * PKTQ_MAX_PREC or 1
83 */
84 struct pktq_prec q[PKTQ_MAX_PREC];
85};
86
87/* operations on a specific precedence in packet queue */
88
89static inline int pktq_plen(struct pktq *pq, int prec)
90{
91 return pq->q[prec].len;
92}
93
94static inline int pktq_pavail(struct pktq *pq, int prec)
95{
96 return pq->q[prec].max - pq->q[prec].len;
97}
98
99static inline bool pktq_pfull(struct pktq *pq, int prec)
100{
101 return pq->q[prec].len >= pq->q[prec].max;
102}
103
104static inline bool pktq_pempty(struct pktq *pq, int prec)
105{
106 return pq->q[prec].len == 0;
107}
108
109static inline struct sk_buff *pktq_ppeek(struct pktq *pq, int prec)
110{
111 return pq->q[prec].head;
112}
113
114static inline struct sk_buff *pktq_ppeek_tail(struct pktq *pq, int prec)
115{
116 return pq->q[prec].tail;
117}
118
119extern struct sk_buff *brcmu_pktq_penq(struct pktq *pq, int prec,
120 struct sk_buff *p);
121extern struct sk_buff *brcmu_pktq_penq_head(struct pktq *pq, int prec,
122 struct sk_buff *p);
123extern struct sk_buff *brcmu_pktq_pdeq(struct pktq *pq, int prec);
124extern struct sk_buff *brcmu_pktq_pdeq_tail(struct pktq *pq, int prec);
125
126/* packet primitives */
127extern struct sk_buff *brcmu_pkt_buf_get_skb(uint len);
128extern void brcmu_pkt_buf_free_skb(struct sk_buff *skb);
129
130/* Empty the queue at particular precedence level */
131/* callback function fn(pkt, arg) returns true if pkt belongs to if */
132extern void brcmu_pktq_pflush(struct pktq *pq, int prec,
133 bool dir, bool (*fn)(struct sk_buff *, void *), void *arg);
134
135/* operations on a set of precedences in packet queue */
136
137extern int brcmu_pktq_mlen(struct pktq *pq, uint prec_bmp);
138extern struct sk_buff *brcmu_pktq_mdeq(struct pktq *pq, uint prec_bmp,
139 int *prec_out);
140
141/* operations on packet queue as a whole */
142
143static inline int pktq_len(struct pktq *pq)
144{
145 return (int)pq->len;
146}
147
148static inline int pktq_max(struct pktq *pq)
149{
150 return (int)pq->max;
151}
152
153static inline int pktq_avail(struct pktq *pq)
154{
155 return (int)(pq->max - pq->len);
156}
157
158static inline bool pktq_full(struct pktq *pq)
159{
160 return pq->len >= pq->max;
161}
162
163static inline bool pktq_empty(struct pktq *pq)
164{
165 return pq->len == 0;
166}
167
168extern void brcmu_pktq_init(struct pktq *pq, int num_prec, int max_len);
169/* prec_out may be NULL if caller is not interested in return value */
170extern struct sk_buff *brcmu_pktq_peek_tail(struct pktq *pq, int *prec_out);
171extern void brcmu_pktq_flush(struct pktq *pq, bool dir,
172 bool (*fn)(struct sk_buff *, void *), void *arg);
173
174/* externs */
175/* packet */
176extern uint brcmu_pktfrombuf(struct sk_buff *p,
177 uint offset, int len, unsigned char *buf);
178extern uint brcmu_pkttotlen(struct sk_buff *p);
179
180/* ip address */
181struct ipv4_addr;
182
183#ifdef BCMDBG
184extern void brcmu_prpkt(const char *msg, struct sk_buff *p0);
185#else
186#define brcmu_prpkt(a, b)
187#endif /* BCMDBG */
188
189/* externs */
190/* format/print */
191#if defined(BCMDBG)
192extern int brcmu_format_hex(char *str, const void *bytes, int len);
193#endif
194
195#endif /* _BRCMU_UTILS_H_ */