staging: brcm80211: remove unused type definitions from driver
[pandora-kernel.git] / drivers / staging / brcm80211 / include / bcmutils.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 _bcmutils_h_
18 #define _bcmutils_h_
19
20 /* Buffer structure for collecting string-formatted data
21 * using bcm_bprintf() API.
22 * Use bcm_binit() to initialize before use
23 */
24
25         struct bcmstrbuf {
26                 char *buf;      /* pointer to current position in origbuf */
27                 unsigned int size;      /* current (residual) size in bytes */
28                 char *origbuf;  /* unmodified pointer to orignal buffer */
29                 unsigned int origsize;  /* unmodified orignal buffer size in bytes */
30         };
31
32 /* ** driver-only section ** */
33
34 #define GPIO_PIN_NOTDEFINED     0x20    /* Pin not defined */
35
36 /*
37  * Spin at most 'us' microseconds while 'exp' is true.
38  * Caller should explicitly test 'exp' when this completes
39  * and take appropriate error action if 'exp' is still true.
40  */
41 #define SPINWAIT(exp, us) { \
42         uint countdown = (us) + 9; \
43         while ((exp) && (countdown >= 10)) {\
44                 udelay(10); \
45                 countdown -= 10; \
46         } \
47 }
48
49 /* osl multi-precedence packet queue */
50 #ifndef PKTQ_LEN_DEFAULT
51 #define PKTQ_LEN_DEFAULT        128     /* Max 128 packets */
52 #endif
53 #ifndef PKTQ_MAX_PREC
54 #define PKTQ_MAX_PREC           16      /* Maximum precedence levels */
55 #endif
56
57         struct pktq_prec {
58                 struct sk_buff *head;   /* first packet to dequeue */
59                 struct sk_buff *tail;   /* last packet to dequeue */
60                 u16 len;                /* number of queued packets */
61                 u16 max;                /* maximum number of queued packets */
62         };
63
64 /* multi-priority pkt queue */
65         struct pktq {
66                 u16 num_prec;   /* number of precedences in use */
67                 u16 hi_prec;    /* rapid dequeue hint (>= highest non-empty prec) */
68                 u16 max;        /* total max packets */
69                 u16 len;        /* total number of packets */
70                 /* q array must be last since # of elements can be either PKTQ_MAX_PREC or 1 */
71                 struct pktq_prec q[PKTQ_MAX_PREC];
72         };
73
74 #define PKTQ_PREC_ITER(pq, prec)        for (prec = (pq)->num_prec - 1; prec >= 0; prec--)
75
76 /* fn(pkt, arg).  return true if pkt belongs to if */
77         typedef bool(*ifpkt_cb_t) (void *, int);
78
79 /* operations on a specific precedence in packet queue */
80
81 #define pktq_psetmax(pq, prec, _max)    ((pq)->q[prec].max = (_max))
82 #define pktq_plen(pq, prec)             ((pq)->q[prec].len)
83 #define pktq_pavail(pq, prec)           ((pq)->q[prec].max - (pq)->q[prec].len)
84 #define pktq_pfull(pq, prec)            ((pq)->q[prec].len >= (pq)->q[prec].max)
85 #define pktq_pempty(pq, prec)           ((pq)->q[prec].len == 0)
86
87 #define pktq_ppeek(pq, prec)            ((pq)->q[prec].head)
88 #define pktq_ppeek_tail(pq, prec)       ((pq)->q[prec].tail)
89
90 extern struct sk_buff *pktq_penq(struct pktq *pq, int prec,
91                                  struct sk_buff *p);
92 extern struct sk_buff *pktq_penq_head(struct pktq *pq, int prec,
93                                       struct sk_buff *p);
94 extern struct sk_buff *pktq_pdeq(struct pktq *pq, int prec);
95 extern struct sk_buff *pktq_pdeq_tail(struct pktq *pq, int prec);
96
97 /* Empty the queue at particular precedence level */
98 #ifdef BRCM_FULLMAC
99         extern void pktq_pflush(struct osl_info *osh, struct pktq *pq, int prec,
100                 bool dir);
101 #else
102         extern void pktq_pflush(struct osl_info *osh, struct pktq *pq, int prec,
103                 bool dir, ifpkt_cb_t fn, int arg);
104 #endif /* BRCM_FULLMAC */
105
106 /* operations on a set of precedences in packet queue */
107
108 extern int pktq_mlen(struct pktq *pq, uint prec_bmp);
109 extern struct sk_buff *pktq_mdeq(struct pktq *pq, uint prec_bmp, int *prec_out);
110
111 /* operations on packet queue as a whole */
112
113 #define pktq_len(pq)                    ((int)(pq)->len)
114 #define pktq_max(pq)                    ((int)(pq)->max)
115 #define pktq_avail(pq)                  ((int)((pq)->max - (pq)->len))
116 #define pktq_full(pq)                   ((pq)->len >= (pq)->max)
117 #define pktq_empty(pq)                  ((pq)->len == 0)
118
119 /* operations for single precedence queues */
120 #define pktenq(pq, p)           pktq_penq(((struct pktq *)pq), 0, (p))
121 #define pktenq_head(pq, p)      pktq_penq_head(((struct pktq *)pq), 0, (p))
122 #define pktdeq(pq)              pktq_pdeq(((struct pktq *)pq), 0)
123 #define pktdeq_tail(pq)         pktq_pdeq_tail(((struct pktq *)pq), 0)
124 #define pktqinit(pq, len) pktq_init(((struct pktq *)pq), 1, len)
125
126         extern void pktq_init(struct pktq *pq, int num_prec, int max_len);
127 /* prec_out may be NULL if caller is not interested in return value */
128         extern struct sk_buff *pktq_peek_tail(struct pktq *pq, int *prec_out);
129 #ifdef BRCM_FULLMAC
130         extern void pktq_flush(struct osl_info *osh, struct pktq *pq, bool dir);
131 #else
132         extern void pktq_flush(struct osl_info *osh, struct pktq *pq, bool dir,
133                 ifpkt_cb_t fn, int arg);
134 #endif
135
136 /* externs */
137 /* packet */
138         extern uint pktfrombuf(struct osl_info *osh, struct sk_buff *p,
139                                uint offset, int len, unsigned char *buf);
140         extern uint pkttotlen(struct osl_info *osh, struct sk_buff *p);
141
142 /* ethernet address */
143         extern int bcm_ether_atoe(char *p, u8 *ea);
144
145 /* ip address */
146         struct ipv4_addr;
147         extern char *bcm_ip_ntoa(struct ipv4_addr *ia, char *buf);
148
149 /* variable access */
150         extern char *getvar(char *vars, const char *name);
151         extern int getintvar(char *vars, const char *name);
152 #ifdef BCMDBG
153         extern void prpkt(const char *msg, struct osl_info *osh,
154                           struct sk_buff *p0);
155 #endif                          /* BCMDBG */
156 #define bcm_perf_enable()
157 #define bcmstats(fmt)
158 #define bcmlog(fmt, a1, a2)
159 #define bcmdumplog(buf, size)   (*buf = '\0')
160 #define bcmdumplogent(buf, idx) -1
161
162 #define bcmtslog(tstamp, fmt, a1, a2)
163 #define bcmprinttslogs()
164 #define bcmprinttstamp(us)
165
166 /* Support for sharing code across in-driver iovar implementations.
167  * The intent is that a driver use this structure to map iovar names
168  * to its (private) iovar identifiers, and the lookup function to
169  * find the entry.  Macros are provided to map ids and get/set actions
170  * into a single number space for a switch statement.
171  */
172
173 /* iovar structure */
174         typedef struct bcm_iovar {
175                 const char *name;       /* name for lookup and display */
176                 u16 varid;      /* id for switch */
177                 u16 flags;      /* driver-specific flag bits */
178                 u16 type;       /* base type of argument */
179                 u16 minlen;     /* min length for buffer vars */
180         } bcm_iovar_t;
181
182 /* varid definitions are per-driver, may use these get/set bits */
183
184 /* IOVar action bits for id mapping */
185 #define IOV_GET 0               /* Get an iovar */
186 #define IOV_SET 1               /* Set an iovar */
187
188 /* Varid to actionid mapping */
189 #define IOV_GVAL(id)            ((id)*2)
190 #define IOV_SVAL(id)            (((id)*2)+IOV_SET)
191 #define IOV_ISSET(actionid)     ((actionid & IOV_SET) == IOV_SET)
192 #define IOV_ID(actionid)        (actionid >> 1)
193
194 /* flags are per-driver based on driver attributes */
195
196         extern const bcm_iovar_t *bcm_iovar_lookup(const bcm_iovar_t *table,
197                                                    const char *name);
198         extern int bcm_iovar_lencheck(const bcm_iovar_t *table, void *arg,
199                                       int len, bool set);
200
201 /* Base type definitions */
202 #define IOVT_VOID       0       /* no value (implictly set only) */
203 #define IOVT_BOOL       1       /* any value ok (zero/nonzero) */
204 #define IOVT_INT8       2       /* integer values are range-checked */
205 #define IOVT_UINT8      3       /* unsigned int 8 bits */
206 #define IOVT_INT16      4       /* int 16 bits */
207 #define IOVT_UINT16     5       /* unsigned int 16 bits */
208 #define IOVT_INT32      6       /* int 32 bits */
209 #define IOVT_UINT32     7       /* unsigned int 32 bits */
210 #define IOVT_BUFFER     8       /* buffer is size-checked as per minlen */
211 #define BCM_IOVT_VALID(type) (((unsigned int)(type)) <= IOVT_BUFFER)
212
213 /* Initializer for IOV type strings */
214 #define BCM_IOV_TYPE_INIT { \
215         "void", \
216         "bool", \
217         "s8", \
218         "u8", \
219         "s16", \
220         "u16", \
221         "s32", \
222         "u32", \
223         "buffer", \
224         "" }
225
226 #define BCM_IOVT_IS_INT(type) (\
227         (type == IOVT_BOOL) || \
228         (type == IOVT_INT8) || \
229         (type == IOVT_UINT8) || \
230         (type == IOVT_INT16) || \
231         (type == IOVT_UINT16) || \
232         (type == IOVT_INT32) || \
233         (type == IOVT_UINT32))
234
235 /* ** driver/apps-shared section ** */
236
237 #define BCME_STRLEN             64      /* Max string length for BCM errors */
238 #define VALID_BCMERROR(e)  ((e <= 0) && (e >= BCME_LAST))
239
240 /*
241  * error codes could be added but the defined ones shouldn't be changed/deleted
242  * these error codes are exposed to the user code
243  * when ever a new error code is added to this list
244  * please update errorstring table with the related error string and
245  * update osl files with os specific errorcode map
246 */
247
248 #define BCME_OK                         0       /* Success */
249 #define BCME_ERROR                      -1      /* Error generic */
250 #define BCME_BADARG                     -2      /* Bad Argument */
251 #define BCME_BADOPTION                  -3      /* Bad option */
252 #define BCME_NOTUP                      -4      /* Not up */
253 #define BCME_NOTDOWN                    -5      /* Not down */
254 #define BCME_NOTAP                      -6      /* Not AP */
255 #define BCME_NOTSTA                     -7      /* Not STA  */
256 #define BCME_BADKEYIDX                  -8      /* BAD Key Index */
257 #define BCME_RADIOOFF                   -9      /* Radio Off */
258 #define BCME_NOTBANDLOCKED              -10     /* Not  band locked */
259 #define BCME_NOCLK                      -11     /* No Clock */
260 #define BCME_BADRATESET                 -12     /* BAD Rate valueset */
261 #define BCME_BADBAND                    -13     /* BAD Band */
262 #define BCME_BUFTOOSHORT                -14     /* Buffer too short */
263 #define BCME_BUFTOOLONG                 -15     /* Buffer too long */
264 #define BCME_BUSY                       -16     /* Busy */
265 #define BCME_NOTASSOCIATED              -17     /* Not Associated */
266 #define BCME_BADSSIDLEN                 -18     /* Bad SSID len */
267 #define BCME_OUTOFRANGECHAN             -19     /* Out of Range Channel */
268 #define BCME_BADCHAN                    -20     /* Bad Channel */
269 #define BCME_BADADDR                    -21     /* Bad Address */
270 #define BCME_NORESOURCE                 -22     /* Not Enough Resources */
271 #define BCME_UNSUPPORTED                -23     /* Unsupported */
272 #define BCME_BADLEN                     -24     /* Bad length */
273 #define BCME_NOTREADY                   -25     /* Not Ready */
274 #define BCME_EPERM                      -26     /* Not Permitted */
275 #define BCME_NOMEM                      -27     /* No Memory */
276 #define BCME_ASSOCIATED                 -28     /* Associated */
277 #define BCME_RANGE                      -29     /* Not In Range */
278 #define BCME_NOTFOUND                   -30     /* Not Found */
279 #define BCME_WME_NOT_ENABLED            -31     /* WME Not Enabled */
280 #define BCME_TSPEC_NOTFOUND             -32     /* TSPEC Not Found */
281 #define BCME_ACM_NOTSUPPORTED           -33     /* ACM Not Supported */
282 #define BCME_NOT_WME_ASSOCIATION        -34     /* Not WME Association */
283 #define BCME_SDIO_ERROR                 -35     /* SDIO Bus Error */
284 #define BCME_DONGLE_DOWN                -36     /* Dongle Not Accessible */
285 #define BCME_VERSION                    -37     /* Incorrect version */
286 #define BCME_TXFAIL                     -38     /* TX failure */
287 #define BCME_RXFAIL                     -39     /* RX failure */
288 #define BCME_NODEVICE                   -40     /* Device not present */
289 #define BCME_NMODE_DISABLED             -41     /* NMODE disabled */
290 #define BCME_NONRESIDENT                -42     /* access to nonresident overlay */
291 #define BCME_LAST                       BCME_NONRESIDENT
292
293 /* These are collection of BCME Error strings */
294 #define BCMERRSTRINGTABLE {             \
295         "OK",                           \
296         "Undefined error",              \
297         "Bad Argument",                 \
298         "Bad Option",                   \
299         "Not up",                       \
300         "Not down",                     \
301         "Not AP",                       \
302         "Not STA",                      \
303         "Bad Key Index",                \
304         "Radio Off",                    \
305         "Not band locked",              \
306         "No clock",                     \
307         "Bad Rate valueset",            \
308         "Bad Band",                     \
309         "Buffer too short",             \
310         "Buffer too long",              \
311         "Busy",                         \
312         "Not Associated",               \
313         "Bad SSID len",                 \
314         "Out of Range Channel",         \
315         "Bad Channel",                  \
316         "Bad Address",                  \
317         "Not Enough Resources",         \
318         "Unsupported",                  \
319         "Bad length",                   \
320         "Not Ready",                    \
321         "Not Permitted",                \
322         "No Memory",                    \
323         "Associated",                   \
324         "Not In Range",                 \
325         "Not Found",                    \
326         "WME Not Enabled",              \
327         "TSPEC Not Found",              \
328         "ACM Not Supported",            \
329         "Not WME Association",          \
330         "SDIO Bus Error",               \
331         "Dongle Not Accessible",        \
332         "Incorrect version",            \
333         "TX Failure",                   \
334         "RX Failure",                   \
335         "Device Not Present",           \
336         "NMODE Disabled",               \
337         "Nonresident overlay access", \
338 }
339
340 #ifndef ABS
341 #define ABS(a)                  (((a) < 0) ? -(a) : (a))
342 #endif                          /* ABS */
343
344 #define CEIL(x, y)              (((x) + ((y)-1)) / (y))
345 #define ISPOWEROF2(x)           ((((x)-1)&(x)) == 0)
346
347 /* map physical to virtual I/O */
348 #if !defined(CONFIG_MMC_MSM7X00A)
349 #define REG_MAP(pa, size)       ioremap_nocache((unsigned long)(pa), \
350                                         (unsigned long)(size))
351 #else
352 #define REG_MAP(pa, size)       (void *)(0)
353 #endif
354
355 /* Register operations */
356 #define AND_REG(osh, r, v)      W_REG(osh, (r), R_REG(osh, r) & (v))
357 #define OR_REG(osh, r, v)       W_REG(osh, (r), R_REG(osh, r) | (v))
358
359 #define SET_REG(osh, r, mask, val) \
360                 W_REG((osh), (r), ((R_REG((osh), r) & ~(mask)) | (val)))
361
362 #ifndef setbit
363 #ifndef NBBY                    /* the BSD family defines NBBY */
364 #define NBBY    8               /* 8 bits per byte */
365 #endif                          /* #ifndef NBBY */
366 #define setbit(a, i)    (((u8 *)a)[(i)/NBBY] |= 1<<((i)%NBBY))
367 #define clrbit(a, i)    (((u8 *)a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
368 #define isset(a, i)     (((const u8 *)a)[(i)/NBBY] & (1<<((i)%NBBY)))
369 #define isclr(a, i)     ((((const u8 *)a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
370 #endif                          /* setbit */
371
372 #define NBITS(type)     (sizeof(type) * 8)
373 #define NBITVAL(nbits)  (1 << (nbits))
374 #define MAXBITVAL(nbits)        ((1 << (nbits)) - 1)
375 #define NBITMASK(nbits) MAXBITVAL(nbits)
376 #define MAXNBVAL(nbyte) MAXBITVAL((nbyte) * 8)
377
378 /* basic mux operation - can be optimized on several architectures */
379 #define MUX(pred, true, false) ((pred) ? (true) : (false))
380
381 /* modulo inc/dec - assumes x E [0, bound - 1] */
382 #define MODDEC(x, bound) MUX((x) == 0, (bound) - 1, (x) - 1)
383 #define MODINC(x, bound) MUX((x) == (bound) - 1, 0, (x) + 1)
384
385 /* modulo inc/dec, bound = 2^k */
386 #define MODDEC_POW2(x, bound) (((x) - 1) & ((bound) - 1))
387 #define MODINC_POW2(x, bound) (((x) + 1) & ((bound) - 1))
388
389 /* modulo add/sub - assumes x, y E [0, bound - 1] */
390 #define MODADD(x, y, bound) \
391     MUX((x) + (y) >= (bound), (x) + (y) - (bound), (x) + (y))
392 #define MODSUB(x, y, bound) \
393     MUX(((int)(x)) - ((int)(y)) < 0, (x) - (y) + (bound), (x) - (y))
394
395 /* module add/sub, bound = 2^k */
396 #define MODADD_POW2(x, y, bound) (((x) + (y)) & ((bound) - 1))
397 #define MODSUB_POW2(x, y, bound) (((x) - (y)) & ((bound) - 1))
398
399 /* crc defines */
400 #define CRC8_INIT_VALUE  0xff   /* Initial CRC8 checksum value */
401 #define CRC8_GOOD_VALUE  0x9f   /* Good final CRC8 checksum value */
402 #define CRC16_INIT_VALUE 0xffff /* Initial CRC16 checksum value */
403 #define CRC16_GOOD_VALUE 0xf0b8 /* Good final CRC16 checksum value */
404
405 /* bcm_format_flags() bit description structure */
406         typedef struct bcm_bit_desc {
407                 u32 bit;
408                 const char *name;
409         } bcm_bit_desc_t;
410
411 /* tag_ID/length/value_buffer tuple */
412         typedef struct bcm_tlv {
413                 u8 id;
414                 u8 len;
415                 u8 data[1];
416         } bcm_tlv_t;
417
418 /* Check that bcm_tlv_t fits into the given buflen */
419 #define bcm_valid_tlv(elt, buflen) ((buflen) >= 2 && (int)(buflen) >= (int)(2 + (elt)->len))
420
421 #define ETHER_ADDR_STR_LEN      18      /* 18-bytes of Ethernet address buffer length */
422
423 /* crypto utility function */
424 /* 128-bit xor: *dst = *src1 xor *src2. dst1, src1 and src2 may have any alignment */
425         static inline void
426          xor_128bit_block(const u8 *src1, const u8 *src2, u8 *dst) {
427                 if (
428 #ifdef __i386__
429                            1 ||
430 #endif
431                            (((unsigned long) src1 | (unsigned long) src2 | (unsigned long) dst) &
432                             3) == 0) {
433                         /* ARM CM3 rel time: 1229 (727 if alignment check could be omitted) */
434                         /* x86 supports unaligned.  This version runs 6x-9x faster on x86. */
435                         ((u32 *) dst)[0] =
436                             ((const u32 *)src1)[0] ^ ((const u32 *)
437                                                          src2)[0];
438                         ((u32 *) dst)[1] =
439                             ((const u32 *)src1)[1] ^ ((const u32 *)
440                                                          src2)[1];
441                         ((u32 *) dst)[2] =
442                             ((const u32 *)src1)[2] ^ ((const u32 *)
443                                                          src2)[2];
444                         ((u32 *) dst)[3] =
445                             ((const u32 *)src1)[3] ^ ((const u32 *)
446                                                          src2)[3];
447                 } else {
448                         /* ARM CM3 rel time: 4668 (4191 if alignment check could be omitted) */
449                         int k;
450                         for (k = 0; k < 16; k++)
451                                 dst[k] = src1[k] ^ src2[k];
452                 }
453         }
454
455 /* externs */
456 /* crc */
457         extern u8 hndcrc8(u8 *p, uint nbytes, u8 crc);
458         extern u16 hndcrc16(u8 *p, uint nbytes, u16 crc);
459 /* format/print */
460 #if defined(BCMDBG)
461         extern int bcm_format_flags(const bcm_bit_desc_t *bd, u32 flags,
462                                     char *buf, int len);
463         extern int bcm_format_hex(char *str, const void *bytes, int len);
464 #endif
465         extern char *bcm_chipname(uint chipid, char *buf, uint len);
466         extern void prhex(const char *msg, unsigned char *buf, uint len);
467
468         extern bcm_tlv_t *bcm_parse_tlvs(void *buf, int buflen,
469                                                     uint key);
470 /* bcmerror */
471         extern const char *bcmerrorstr(int bcmerror);
472
473 /* multi-bool data type: set of bools, mbool is true if any is set */
474         typedef u32 mbool;
475 #define mboolset(mb, bit)               ((mb) |= (bit)) /* set one bool */
476 #define mboolclr(mb, bit)               ((mb) &= ~(bit))        /* clear one bool */
477 #define mboolisset(mb, bit)             (((mb) & (bit)) != 0)   /* true if one bool is set */
478 #define mboolmaskset(mb, mask, val)     ((mb) = (((mb) & ~(mask)) | (val)))
479
480 /* power conversion */
481         extern u16 bcm_qdbm_to_mw(u8 qdbm);
482         extern u8 bcm_mw_to_qdbm(u16 mw);
483
484         extern void bcm_binit(struct bcmstrbuf *b, char *buf, uint size);
485         extern int bcm_bprintf(struct bcmstrbuf *b, const char *fmt, ...);
486
487         extern uint bcm_mkiovar(char *name, char *data, uint datalen, char *buf,
488                                 uint len);
489         extern uint bcm_bitcount(u8 *bitmap, uint bytelength);
490
491 #endif                          /* _bcmutils_h_ */