« back to all changes in this revision
Viewing changes to src/src/include/bcmutils.h
- browse files at revision 1
- compare with another revision
- download diff
- download tarball
- view history from revision 1
- Committer: Bazaar Package Importer
- Author(s): Tim Gardner
- Date: 2009-05-11 16:04:29 UTC
- Revision ID: james.westby@ubuntu.com-20090511160429-lciigiqnpp0fpu2k
Tags: 5.10.91.9-2
Add src/lib/LICENSE.txt to copyright notice.
- files added:
- .bzr-builddeb
- debian
- src
- src/lib
- src/patches
- src/src
- src/src/include
- src/src/include/proto
- src/src/shared
- src/src/wl
- src/src/wl/sys
added
removed
src/src/include/bcmutils.h
1
/*
2
* Misc useful os-independent macros and functions.
3
*
4
* Copyright 2008, Broadcom Corporation
5
* All Rights Reserved.
6
*
7
* Unless you and Broadcom execute a separate written software license
8
* agreement governing use of this software, this software is licensed to you
9
* under the terms of the GNU General Public License version 2, available at
10
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html (the "GPL"), with the
11
* following added to such license:
12
* As a special exception, the copyright holders of this software give you
13
* permission to link this software with independent modules, regardless of the
14
* license terms of these independent modules, and to copy and distribute the
15
* resulting executable under terms of your choice, provided that you also meet,
16
* for each linked independent module, the terms and conditions of the license
17
* of that module. An independent module is a module which is not derived from
18
* this software.
19
*
20
* THIS SOFTWARE IS OFFERED "AS IS", AND BROADCOM GRANTS NO WARRANTIES OF ANY
21
* KIND, EXPRESS OR IMPLIED, BY STATUTE, COMMUNICATION OR OTHERWISE. BROADCOM
22
* SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
23
* FOR A SPECIFIC PURPOSE OR NONINFRINGEMENT CONCERNING THIS SOFTWARE.
24
*
25
* $Id: bcmutils.h,v 13.199.2.5 2008/11/25 12:13:46 Exp $
26
*/
27
28
#ifndef _bcmutils_h_
29
#define _bcmutils_h_
30
31
#define _BCM_U 0x01
32
#define _BCM_L 0x02
33
#define _BCM_D 0x04
34
#define _BCM_C 0x08
35
#define _BCM_P 0x10
36
#define _BCM_S 0x20
37
#define _BCM_X 0x40
38
#define _BCM_SP 0x80
39
40
extern const unsigned char bcm_ctype[];
41
#define bcm_ismask(x) (bcm_ctype[(int)(unsigned char)(x)])
42
43
#define bcm_isalnum(c) ((bcm_ismask(c)&(_BCM_U|_BCM_L|_BCM_D)) != 0)
44
#define bcm_isalpha(c) ((bcm_ismask(c)&(_BCM_U|_BCM_L)) != 0)
45
#define bcm_iscntrl(c) ((bcm_ismask(c)&(_BCM_C)) != 0)
46
#define bcm_isdigit(c) ((bcm_ismask(c)&(_BCM_D)) != 0)
47
#define bcm_isgraph(c) ((bcm_ismask(c)&(_BCM_P|_BCM_U|_BCM_L|_BCM_D)) != 0)
48
#define bcm_islower(c) ((bcm_ismask(c)&(_BCM_L)) != 0)
49
#define bcm_isprint(c) ((bcm_ismask(c)&(_BCM_P|_BCM_U|_BCM_L|_BCM_D|_BCM_SP)) != 0)
50
#define bcm_ispunct(c) ((bcm_ismask(c)&(_BCM_P)) != 0)
51
#define bcm_isspace(c) ((bcm_ismask(c)&(_BCM_S)) != 0)
52
#define bcm_isupper(c) ((bcm_ismask(c)&(_BCM_U)) != 0)
53
#define bcm_isxdigit(c) ((bcm_ismask(c)&(_BCM_D|_BCM_X)) != 0)
54
#define bcm_tolower(c) (bcm_isupper((c)) ? ((c) + 'a' - 'A') : (c))
55
#define bcm_toupper(c) (bcm_islower((c)) ? ((c) + 'A' - 'a') : (c))
56
57
struct bcmstrbuf {
58
char *buf;
59
unsigned int size;
60
char *origbuf;
61
unsigned int origsize;
62
};
63
64
#include <osl.h>
65
66
#define GPIO_PIN_NOTDEFINED 0x20
67
68
#define SPINWAIT(exp, us) { \
69
uint countdown = (us) + 9; \
70
while ((exp) && (countdown >= 10)) {\
71
OSL_DELAY(10); \
72
countdown -= 10; \
73
} \
74
}
75
76
#ifndef PKTQ_LEN_DEFAULT
77
#define PKTQ_LEN_DEFAULT 128
78
#endif
79
#ifndef PKTQ_MAX_PREC
80
#define PKTQ_MAX_PREC 16
81
#endif
82
83
typedef struct pktq_prec {
84
void *head;
85
void *tail;
86
uint16 len;
87
uint16 max;
88
} pktq_prec_t;
89
90
struct pktq {
91
uint16 num_prec;
92
uint16 hi_prec;
93
uint16 max;
94
uint16 len;
95
96
struct pktq_prec q[PKTQ_MAX_PREC];
97
};
98
99
struct spktq {
100
uint16 num_prec;
101
uint16 hi_prec;
102
uint16 max;
103
uint16 len;
104
105
struct pktq_prec q[1];
106
};
107
108
#define PKTQ_PREC_ITER(pq, prec) for (prec = (pq)->num_prec - 1; prec >= 0; prec--)
109
110
struct ether_addr;
111
112
#define pktq_psetmax(pq, prec, _max) ((pq)->q[prec].max = (_max))
113
#define pktq_plen(pq, prec) ((pq)->q[prec].len)
114
#define pktq_pavail(pq, prec) ((pq)->q[prec].max - (pq)->q[prec].len)
115
#define pktq_pfull(pq, prec) ((pq)->q[prec].len >= (pq)->q[prec].max)
116
#define pktq_pempty(pq, prec) ((pq)->q[prec].len == 0)
117
118
#define pktq_ppeek(pq, prec) ((pq)->q[prec].head)
119
#define pktq_ppeek_tail(pq, prec) ((pq)->q[prec].tail)
120
121
extern void *pktq_penq(struct pktq *pq, int prec, void *p);
122
extern void *pktq_penq_head(struct pktq *pq, int prec, void *p);
123
extern void *pktq_pdeq(struct pktq *pq, int prec);
124
extern void *pktq_pdeq_tail(struct pktq *pq, int prec);
125
126
extern void pktq_pflush(osl_t *osh, struct pktq *pq, int prec, bool dir);
127
128
extern bool pktq_pdel(struct pktq *pq, void *p, int prec);
129
130
extern int pktq_mlen(struct pktq *pq, uint prec_bmp);
131
extern void *pktq_mdeq(struct pktq *pq, uint prec_bmp, int *prec_out);
132
133
#define pktq_len(pq) ((int)(pq)->len)
134
#define pktq_max(pq) ((int)(pq)->max)
135
#define pktq_avail(pq) ((int)((pq)->max - (pq)->len))
136
#define pktq_full(pq) ((pq)->len >= (pq)->max)
137
#define pktq_empty(pq) ((pq)->len == 0)
138
139
#define pktenq(pq, p) pktq_penq(((struct pktq *)pq), 0, (p))
140
#define pktenq_head(pq, p) pktq_penq_head(((struct pktq *)pq), 0, (p))
141
#define pktdeq(pq) pktq_pdeq(((struct pktq *)pq), 0)
142
#define pktdeq_tail(pq) pktq_pdeq_tail(((struct pktq *)pq), 0)
143
#define pktqinit(pq, len) pktq_init(((struct pktq *)pq), 1, len)
144
145
extern void pktq_init(struct pktq *pq, int num_prec, int max_len);
146
147
extern void *pktq_deq(struct pktq *pq, int *prec_out);
148
extern void *pktq_deq_tail(struct pktq *pq, int *prec_out);
149
extern void *pktq_peek(struct pktq *pq, int *prec_out);
150
extern void *pktq_peek_tail(struct pktq *pq, int *prec_out);
151
extern void pktq_flush(osl_t *osh, struct pktq *pq, bool dir);
152
153
extern uint pktcopy(osl_t *osh, void *p, uint offset, int len, uchar *buf);
154
extern uint pktfrombuf(osl_t *osh, void *p, uint offset, int len, uchar *buf);
155
extern uint pkttotlen(osl_t *osh, void *p);
156
extern void *pktlast(osl_t *osh, void *p);
157
extern uint pktsegcnt(osl_t *osh, void *p);
158
159
extern uint pktsetprio(void *pkt, bool update_vtag);
160
#define PKTPRIO_VDSCP 0x100
161
#define PKTPRIO_VLAN 0x200
162
#define PKTPRIO_UPD 0x400
163
#define PKTPRIO_DSCP 0x800
164
165
extern int BCMROMFN(bcm_atoi)(char *s);
166
extern ulong BCMROMFN(bcm_strtoul)(char *cp, char **endp, uint base);
167
extern char *BCMROMFN(bcmstrstr)(char *haystack, char *needle);
168
extern char *BCMROMFN(bcmstrcat)(char *dest, const char *src);
169
extern char *BCMROMFN(bcmstrncat)(char *dest, const char *src, uint size);
170
extern ulong wchar2ascii(char *abuf, ushort *wbuf, ushort wbuflen, ulong abuflen);
171
172
extern char *bcm_ether_ntoa(const struct ether_addr *ea, char *buf);
173
extern int BCMROMFN(bcm_ether_atoe)(char *p, struct ether_addr *ea);
174
175
struct ipv4_addr;
176
extern char *bcm_ip_ntoa(struct ipv4_addr *ia, char *buf);
177
178
extern void bcm_mdelay(uint ms);
179
180
extern char *getvar(char *vars, const char *name);
181
extern int getintvar(char *vars, const char *name);
182
extern uint getgpiopin(char *vars, char *pin_name, uint def_pin);
183
#ifdef BCMDBG
184
extern void prpkt(const char *msg, osl_t *osh, void *p0);
185
#endif
186
#define bcm_perf_enable()
187
#define bcmstats(fmt)
188
#define bcmlog(fmt, a1, a2)
189
#define bcmdumplog(buf, size) *buf = '\0'
190
#define bcmdumplogent(buf, idx) -1
191
192
#define bcmtslog(tstamp, fmt, a1, a2)
193
#define bcmprinttslogs()
194
#define bcmprinttstamp(us)
195
196
extern char *bcm_nvram_vars(uint *length);
197
extern int bcm_nvram_cache(void *sih);
198
199
typedef struct bcm_iovar {
200
const char *name;
201
uint16 varid;
202
uint16 flags;
203
uint16 type;
204
uint16 minlen;
205
} bcm_iovar_t;
206
207
#define IOV_GET 0
208
#define IOV_SET 1
209
210
#define IOV_GVAL(id) ((id)*2)
211
#define IOV_SVAL(id) (((id)*2)+IOV_SET)
212
#define IOV_ISSET(actionid) ((actionid & IOV_SET) == IOV_SET)
213
#define IOV_ID(actionid) (actionid >> 1)
214
215
extern const bcm_iovar_t *bcm_iovar_lookup(const bcm_iovar_t *table, const char *name);
216
extern int bcm_iovar_lencheck(const bcm_iovar_t *table, void *arg, int len, bool set);
217
218
#define IOVT_VOID 0
219
#define IOVT_BOOL 1
220
#define IOVT_INT8 2
221
#define IOVT_UINT8 3
222
#define IOVT_INT16 4
223
#define IOVT_UINT16 5
224
#define IOVT_INT32 6
225
#define IOVT_UINT32 7
226
#define IOVT_BUFFER 8
227
#define BCM_IOVT_VALID(type) (((unsigned int)(type)) <= IOVT_BUFFER)
228
229
#define BCM_IOV_TYPE_INIT { \
230
"void", \
231
"bool", \
232
"int8", \
233
"uint8", \
234
"int16", \
235
"uint16", \
236
"int32", \
237
"uint32", \
238
"buffer", \
239
"" }
240
241
#define BCM_IOVT_IS_INT(type) (\
242
(type == IOVT_BOOL) || \
243
(type == IOVT_INT8) || \
244
(type == IOVT_UINT8) || \
245
(type == IOVT_INT16) || \
246
(type == IOVT_UINT16) || \
247
(type == IOVT_INT32) || \
248
(type == IOVT_UINT32))
249
250
#define BCME_STRLEN 64
251
#define VALID_BCMERROR(e) ((e <= 0) && (e >= BCME_LAST))
252
253
#define BCME_OK 0
254
#define BCME_ERROR -1
255
#define BCME_BADARG -2
256
#define BCME_BADOPTION -3
257
#define BCME_NOTUP -4
258
#define BCME_NOTDOWN -5
259
#define BCME_NOTAP -6
260
#define BCME_NOTSTA -7
261
#define BCME_BADKEYIDX -8
262
#define BCME_RADIOOFF -9
263
#define BCME_NOTBANDLOCKED -10
264
#define BCME_NOCLK -11
265
#define BCME_BADRATESET -12
266
#define BCME_BADBAND -13
267
#define BCME_BUFTOOSHORT -14
268
#define BCME_BUFTOOLONG -15
269
#define BCME_BUSY -16
270
#define BCME_NOTASSOCIATED -17
271
#define BCME_BADSSIDLEN -18
272
#define BCME_OUTOFRANGECHAN -19
273
#define BCME_BADCHAN -20
274
#define BCME_BADADDR -21
275
#define BCME_NORESOURCE -22
276
#define BCME_UNSUPPORTED -23
277
#define BCME_BADLEN -24
278
#define BCME_NOTREADY -25
279
#define BCME_EPERM -26
280
#define BCME_NOMEM -27
281
#define BCME_ASSOCIATED -28
282
#define BCME_RANGE -29
283
#define BCME_NOTFOUND -30
284
#define BCME_WME_NOT_ENABLED -31
285
#define BCME_TSPEC_NOTFOUND -32
286
#define BCME_ACM_NOTSUPPORTED -33
287
#define BCME_NOT_WME_ASSOCIATION -34
288
#define BCME_SDIO_ERROR -35
289
#define BCME_DONGLE_DOWN -36
290
#define BCME_VERSION -37
291
#define BCME_TXFAIL -38
292
#define BCME_RXFAIL -39
293
#define BCME_NODEVICE -40
294
#define BCME_LAST BCME_NODEVICE
295
296
#define BCMERRSTRINGTABLE { \
297
"OK", \
298
"Undefined error", \
299
"Bad Argument", \
300
"Bad Option", \
301
"Not up", \
302
"Not down", \
303
"Not AP", \
304
"Not STA", \
305
"Bad Key Index", \
306
"Radio Off", \
307
"Not band locked", \
308
"No clock", \
309
"Bad Rate valueset", \
310
"Bad Band", \
311
"Buffer too short", \
312
"Buffer too long", \
313
"Busy", \
314
"Not Associated", \
315
"Bad SSID len", \
316
"Out of Range Channel", \
317
"Bad Channel", \
318
"Bad Address", \
319
"Not Enough Resources", \
320
"Unsupported", \
321
"Bad length", \
322
"Not Ready", \
323
"Not Permitted", \
324
"No Memory", \
325
"Associated", \
326
"Not In Range", \
327
"Not Found", \
328
"WME Not Enabled", \
329
"TSPEC Not Found", \
330
"ACM Not Supported", \
331
"Not WME Association", \
332
"SDIO Bus Error", \
333
"Dongle Not Accessible", \
334
"Incorrect version", \
335
"TX Failure", \
336
"RX Failure", \
337
"Device Not Present", \
338
}
339
340
#ifndef ABS
341
#define ABS(a) (((a) < 0)?-(a):(a))
342
#endif
343
344
#ifndef MIN
345
#define MIN(a, b) (((a) < (b))?(a):(b))
346
#endif
347
348
#ifndef MAX
349
#define MAX(a, b) (((a) > (b))?(a):(b))
350
#endif
351
352
#define CEIL(x, y) (((x) + ((y)-1)) / (y))
353
#define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y))
354
#define ISALIGNED(a, x) (((a) & ((x)-1)) == 0)
355
#define ALIGN_ADDR(addr, boundary) (void *)(((uintptr)(addr) + (boundary) - 1) \
356
& ~((boundary) - 1))
357
#define ISPOWEROF2(x) ((((x)-1)&(x)) == 0)
358
#define VALID_MASK(mask) !((mask) & ((mask) + 1))
359
#ifndef OFFSETOF
360
#define OFFSETOF(type, member) ((uint)(uintptr)&((type *)0)->member)
361
#endif
362
#ifndef ARRAYSIZE
363
#define ARRAYSIZE(a) (sizeof(a)/sizeof(a[0]))
364
#endif
365
366
#ifndef setbit
367
#ifndef NBBY
368
#define NBBY 8
369
#endif
370
#define setbit(a, i) (((uint8 *)a)[(i)/NBBY] |= 1<<((i)%NBBY))
371
#define clrbit(a, i) (((uint8 *)a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
372
#define isset(a, i) (((const uint8 *)a)[(i)/NBBY] & (1<<((i)%NBBY)))
373
#define isclr(a, i) ((((const uint8 *)a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
374
#endif
375
376
#define NBITS(type) (sizeof(type) * 8)
377
#define NBITVAL(nbits) (1 << (nbits))
378
#define MAXBITVAL(nbits) ((1 << (nbits)) - 1)
379
#define NBITMASK(nbits) MAXBITVAL(nbits)
380
#define MAXNBVAL(nbyte) MAXBITVAL((nbyte) * 8)
381
382
#define MUX(pred, true, false) ((pred) ? (true) : (false))
383
384
#define MODDEC(x, bound) MUX((x) == 0, (bound) - 1, (x) - 1)
385
#define MODINC(x, bound) MUX((x) == (bound) - 1, 0, (x) + 1)
386
387
#define MODDEC_POW2(x, bound) (((x) - 1) & ((bound) - 1))
388
#define MODINC_POW2(x, bound) (((x) + 1) & ((bound) - 1))
389
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
#define MODADD_POW2(x, y, bound) (((x) + (y)) & ((bound) - 1))
396
#define MODSUB_POW2(x, y, bound) (((x) - (y)) & ((bound) - 1))
397
398
#define CRC8_INIT_VALUE 0xff
399
#define CRC8_GOOD_VALUE 0x9f
400
#define CRC16_INIT_VALUE 0xffff
401
#define CRC16_GOOD_VALUE 0xf0b8
402
#define CRC32_INIT_VALUE 0xffffffff
403
#define CRC32_GOOD_VALUE 0xdebb20e3
404
405
typedef struct bcm_bit_desc {
406
uint32 bit;
407
const char* name;
408
} bcm_bit_desc_t;
409
410
typedef struct bcm_tlv {
411
uint8 id;
412
uint8 len;
413
uint8 data[1];
414
} bcm_tlv_t;
415
416
#define bcm_valid_tlv(elt, buflen) ((buflen) >= 2 && (int)(buflen) >= (int)(2 + (elt)->len))
417
418
#define ETHER_ADDR_STR_LEN 18
419
420
static INLINE uint32
421
load32_ua(uint8 *a)
422
{
423
return ((a[3] << 24) | (a[2] << 16) | (a[1] << 8) | a[0]);
424
}
425
426
static INLINE void
427
store32_ua(uint8 *a, uint32 v)
428
{
429
a[3] = (v >> 24) & 0xff;
430
a[2] = (v >> 16) & 0xff;
431
a[1] = (v >> 8) & 0xff;
432
a[0] = v & 0xff;
433
}
434
435
static INLINE uint16
436
load16_ua(uint8 *a)
437
{
438
return ((a[1] << 8) | a[0]);
439
}
440
441
static INLINE void
442
store16_ua(uint8 *a, uint16 v)
443
{
444
a[1] = (v >> 8) & 0xff;
445
a[0] = v & 0xff;
446
}
447
448
extern uint8 BCMROMFN(hndcrc8)(uint8 *p, uint nbytes, uint8 crc);
449
extern uint16 BCMROMFN(hndcrc16)(uint8 *p, uint nbytes, uint16 crc);
450
extern uint32 BCMROMFN(hndcrc32)(uint8 *p, uint nbytes, uint32 crc);
451
452
#if defined(BCMDBG) || defined(BCMDBG_ERR) || defined(BCMDBG_DUMP)
453
extern int bcm_format_flags(const bcm_bit_desc_t *bd, uint32 flags, char* buf, int len);
454
extern int bcm_format_hex(char *str, const void *bytes, int len);
455
extern void prhex(const char *msg, uchar *buf, uint len);
456
#endif
457
#ifdef BCMDBG
458
extern void deadbeef(void *p, uint len);
459
#endif
460
extern char *bcm_chipname(uint chipid, char *buf, uint len);
461
extern char *bcm_brev_str(uint32 brev, char *buf);
462
extern void printbig(char *buf);
463
464
extern bcm_tlv_t *BCMROMFN(bcm_next_tlv)(bcm_tlv_t *elt, int *buflen);
465
extern bcm_tlv_t *BCMROMFN(bcm_parse_tlvs)(void *buf, int buflen, uint key);
466
extern bcm_tlv_t *BCMROMFN(bcm_parse_ordered_tlvs)(void *buf, int buflen, uint key);
467
468
extern const char *bcmerrorstr(int bcmerror);
469
470
typedef uint32 mbool;
471
#define mboolset(mb, bit) ((mb) |= (bit))
472
#define mboolclr(mb, bit) ((mb) &= ~(bit))
473
#define mboolisset(mb, bit) (((mb) & (bit)) != 0)
474
#define mboolmaskset(mb, mask, val) ((mb) = (((mb) & ~(mask)) | (val)))
475
476
extern uint16 BCMROMFN(bcm_qdbm_to_mw)(uint8 qdbm);
477
extern uint8 BCMROMFN(bcm_mw_to_qdbm)(uint16 mw);
478
479
struct fielddesc {
480
const char *nameandfmt;
481
uint32 offset;
482
uint32 len;
483
};
484
485
extern void bcm_binit(struct bcmstrbuf *b, char *buf, uint size);
486
extern int bcm_bprintf(struct bcmstrbuf *b, const char *fmt, ...);
487
488
typedef uint32 (*bcmutl_rdreg_rtn)(void *arg0, uint arg1, uint32 offset);
489
extern uint bcmdumpfields(bcmutl_rdreg_rtn func_ptr, void *arg0, uint arg1, struct fielddesc *str,
490
char *buf, uint32 bufsize);
491
492
extern uint bcm_mkiovar(char *name, char *data, uint datalen, char *buf, uint len);
493
extern uint BCMROMFN(bcm_bitcount)(uint8 *bitmap, uint bytelength);
494
495
#endif
Loggerhead is a web-based interface for Breezy
Version: 2.0.1