• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Misc useful os-independent macros and functions.
3  *
4  * Copyright (C) 1999-2012, Broadcom Corporation
5  *
6  * Permission to use, copy, modify, and/or distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
13  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
15  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
16  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  *
18  * $Id: bcmutils.h 347624 2012-07-27 10:49:56Z $
19  */
20 
21 #ifndef	_bcmutils_h_
22 #define	_bcmutils_h_
23 
24 #define bcm_strcpy_s(dst, noOfElements, src)            strcpy((dst), (src))
25 #define bcm_strncpy_s(dst, noOfElements, src, count)    strncpy((dst), (src), (count))
26 #define bcm_strcat_s(dst, noOfElements, src)            strcat((dst), (src))
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 #ifdef PKTQ_LOG
33 #include <wlioctl.h>
34 #endif
35 
36 
37 #define _BCM_U	0x01
38 #define _BCM_L	0x02
39 #define _BCM_D	0x04
40 #define _BCM_C	0x08
41 #define _BCM_P	0x10
42 #define _BCM_S	0x20
43 #define _BCM_X	0x40
44 #define _BCM_SP	0x80
45 
46 extern const unsigned char bcm_ctype[];
47 #define bcm_ismask(x)	(bcm_ctype[(int)(unsigned char)(x)])
48 
49 #define bcm_isalnum(c)	((bcm_ismask(c)&(_BCM_U|_BCM_L|_BCM_D)) != 0)
50 #define bcm_isalpha(c)	((bcm_ismask(c)&(_BCM_U|_BCM_L)) != 0)
51 #define bcm_iscntrl(c)	((bcm_ismask(c)&(_BCM_C)) != 0)
52 #define bcm_isdigit(c)	((bcm_ismask(c)&(_BCM_D)) != 0)
53 #define bcm_isgraph(c)	((bcm_ismask(c)&(_BCM_P|_BCM_U|_BCM_L|_BCM_D)) != 0)
54 #define bcm_islower(c)	((bcm_ismask(c)&(_BCM_L)) != 0)
55 #define bcm_isprint(c)	((bcm_ismask(c)&(_BCM_P|_BCM_U|_BCM_L|_BCM_D|_BCM_SP)) != 0)
56 #define bcm_ispunct(c)	((bcm_ismask(c)&(_BCM_P)) != 0)
57 #define bcm_isspace(c)	((bcm_ismask(c)&(_BCM_S)) != 0)
58 #define bcm_isupper(c)	((bcm_ismask(c)&(_BCM_U)) != 0)
59 #define bcm_isxdigit(c)	((bcm_ismask(c)&(_BCM_D|_BCM_X)) != 0)
60 #define bcm_tolower(c)	(bcm_isupper((c)) ? ((c) + 'a' - 'A') : (c))
61 #define bcm_toupper(c)	(bcm_islower((c)) ? ((c) + 'A' - 'a') : (c))
62 
63 
64 
65 struct bcmstrbuf {
66 	char *buf;
67 	unsigned int size;
68 	char *origbuf;
69 	unsigned int origsize;
70 };
71 
72 
73 #ifdef BCMDRIVER
74 #include <osl.h>
75 
76 #define GPIO_PIN_NOTDEFINED 	0x20
77 
78 
79 #define SPINWAIT(exp, us) { \
80 	uint countdown = (us) + 9; \
81 	while ((exp) && (countdown >= 10)) {\
82 		OSL_DELAY(10); \
83 		countdown -= 10; \
84 	} \
85 }
86 
87 
88 #ifndef PKTQ_LEN_DEFAULT
89 #define PKTQ_LEN_DEFAULT        128
90 #endif
91 #ifndef PKTQ_MAX_PREC
92 #define PKTQ_MAX_PREC           16
93 #endif
94 
95 typedef struct pktq_prec {
96 	void *head;
97 	void *tail;
98 	uint16 len;
99 	uint16 max;
100 } pktq_prec_t;
101 
102 #ifdef PKTQ_LOG
103 typedef struct {
104 	uint32 requested;
105 	uint32 stored;
106 	uint32 saved;
107 	uint32 selfsaved;
108 	uint32 full_dropped;
109 	uint32 dropped;
110 	uint32 sacrificed;
111 	uint32 busy;
112 	uint32 retry;
113 	uint32 ps_retry;
114 	uint32 retry_drop;
115 	uint32 max_avail;
116 	uint32 max_used;
117 	uint32 queue_capacity;
118 } pktq_counters_t;
119 #endif
120 
121 
122 #define PKTQ_COMMON	\
123 	uint16 num_prec;        			\
124 	uint16 hi_prec;         	\
125 	uint16 max;             					\
126 	uint16 len;
127 
128 
129 struct pktq {
130 	PKTQ_COMMON
131 
132 	struct pktq_prec q[PKTQ_MAX_PREC];
133 #ifdef PKTQ_LOG
134 	pktq_counters_t	_prec_cnt[PKTQ_MAX_PREC];
135 #endif
136 };
137 
138 
139 struct spktq {
140 	PKTQ_COMMON
141 
142 	struct pktq_prec q[1];
143 };
144 
145 #define PKTQ_PREC_ITER(pq, prec)        for (prec = (pq)->num_prec - 1; prec >= 0; prec--)
146 
147 
148 typedef bool (*ifpkt_cb_t)(void*, int);
149 
150 #ifdef BCMPKTPOOL
151 #define POOL_ENAB(pool)		((pool) && (pool)->inited)
152 #if defined(BCM4329C0)
153 #define SHARED_POOL		(pktpool_shared_ptr)
154 #else
155 #define SHARED_POOL		(pktpool_shared)
156 #endif
157 #else
158 #define POOL_ENAB(bus)		0
159 #define SHARED_POOL		((struct pktpool *)NULL)
160 #endif
161 
162 #ifndef PKTPOOL_LEN_MAX
163 #define PKTPOOL_LEN_MAX		40
164 #endif
165 #define PKTPOOL_CB_MAX		3
166 
167 struct pktpool;
168 typedef void (*pktpool_cb_t)(struct pktpool *pool, void *arg);
169 typedef struct {
170 	pktpool_cb_t cb;
171 	void *arg;
172 } pktpool_cbinfo_t;
173 
174 #ifdef BCMDBG_POOL
175 
176 #define POOL_IDLE	0
177 #define POOL_RXFILL	1
178 #define POOL_RXDH	2
179 #define POOL_RXD11	3
180 #define POOL_TXDH	4
181 #define POOL_TXD11	5
182 #define POOL_AMPDU	6
183 #define POOL_TXENQ	7
184 
185 typedef struct {
186 	void *p;
187 	uint32 cycles;
188 	uint32 dur;
189 } pktpool_dbg_t;
190 
191 typedef struct {
192 	uint8 txdh;
193 	uint8 txd11;
194 	uint8 enq;
195 	uint8 rxdh;
196 	uint8 rxd11;
197 	uint8 rxfill;
198 	uint8 idle;
199 } pktpool_stats_t;
200 #endif
201 
202 typedef struct pktpool {
203 	bool inited;
204 	uint16 r;
205 	uint16 w;
206 	uint16 len;
207 	uint16 maxlen;
208 	uint16 plen;
209 	bool istx;
210 	bool empty;
211 	uint8 cbtoggle;
212 	uint8 cbcnt;
213 	uint8 ecbcnt;
214 	bool emptycb_disable;
215 	pktpool_cbinfo_t *availcb_excl;
216 	pktpool_cbinfo_t cbs[PKTPOOL_CB_MAX];
217 	pktpool_cbinfo_t ecbs[PKTPOOL_CB_MAX];
218 	void *q[PKTPOOL_LEN_MAX + 1];
219 
220 #ifdef BCMDBG_POOL
221 	uint8 dbg_cbcnt;
222 	pktpool_cbinfo_t dbg_cbs[PKTPOOL_CB_MAX];
223 	uint16 dbg_qlen;
224 	pktpool_dbg_t dbg_q[PKTPOOL_LEN_MAX + 1];
225 #endif
226 } pktpool_t;
227 
228 #if defined(BCM4329C0)
229 extern pktpool_t *pktpool_shared_ptr;
230 #else
231 extern pktpool_t *pktpool_shared;
232 #endif
233 
234 extern int pktpool_init(osl_t *osh, pktpool_t *pktp, int *pktplen, int plen, bool istx);
235 extern int pktpool_deinit(osl_t *osh, pktpool_t *pktp);
236 extern int pktpool_fill(osl_t *osh, pktpool_t *pktp, bool minimal);
237 extern void* pktpool_get(pktpool_t *pktp);
238 extern void pktpool_free(pktpool_t *pktp, void *p);
239 extern int pktpool_add(pktpool_t *pktp, void *p);
240 extern uint16 pktpool_avail(pktpool_t *pktp);
241 extern int pktpool_avail_notify_normal(osl_t *osh, pktpool_t *pktp);
242 extern int pktpool_avail_notify_exclusive(osl_t *osh, pktpool_t *pktp, pktpool_cb_t cb);
243 extern int pktpool_avail_register(pktpool_t *pktp, pktpool_cb_t cb, void *arg);
244 extern int pktpool_empty_register(pktpool_t *pktp, pktpool_cb_t cb, void *arg);
245 extern int pktpool_setmaxlen(pktpool_t *pktp, uint16 maxlen);
246 extern int pktpool_setmaxlen_strict(osl_t *osh, pktpool_t *pktp, uint16 maxlen);
247 extern void pktpool_emptycb_disable(pktpool_t *pktp, bool disable);
248 extern bool pktpool_emptycb_disabled(pktpool_t *pktp);
249 
250 #define POOLPTR(pp)			((pktpool_t *)(pp))
251 #define pktpool_len(pp)			(POOLPTR(pp)->len - 1)
252 #define pktpool_plen(pp)		(POOLPTR(pp)->plen)
253 #define pktpool_maxlen(pp)		(POOLPTR(pp)->maxlen)
254 
255 #ifdef BCMDBG_POOL
256 extern int pktpool_dbg_register(pktpool_t *pktp, pktpool_cb_t cb, void *arg);
257 extern int pktpool_start_trigger(pktpool_t *pktp, void *p);
258 extern int pktpool_dbg_dump(pktpool_t *pktp);
259 extern int pktpool_dbg_notify(pktpool_t *pktp);
260 extern int pktpool_stats_dump(pktpool_t *pktp, pktpool_stats_t *stats);
261 #endif
262 
263 
264 
265 struct ether_addr;
266 
267 extern int ether_isbcast(const void *ea);
268 extern int ether_isnulladdr(const void *ea);
269 
270 
271 
272 #define pktq_psetmax(pq, prec, _max)	((pq)->q[prec].max = (_max))
273 #define pktq_pmax(pq, prec)		((pq)->q[prec].max)
274 #define pktq_plen(pq, prec)		((pq)->q[prec].len)
275 #define pktq_pavail(pq, prec)		((pq)->q[prec].max - (pq)->q[prec].len)
276 #define pktq_pfull(pq, prec)		((pq)->q[prec].len >= (pq)->q[prec].max)
277 #define pktq_pempty(pq, prec)		((pq)->q[prec].len == 0)
278 
279 #define pktq_ppeek(pq, prec)		((pq)->q[prec].head)
280 #define pktq_ppeek_tail(pq, prec)	((pq)->q[prec].tail)
281 
282 extern void *pktq_penq(struct pktq *pq, int prec, void *p);
283 extern void *pktq_penq_head(struct pktq *pq, int prec, void *p);
284 extern void *pktq_pdeq(struct pktq *pq, int prec);
285 extern void *pktq_pdeq_prev(struct pktq *pq, int prec, void *prev_p);
286 extern void *pktq_pdeq_tail(struct pktq *pq, int prec);
287 
288 extern void pktq_pflush(osl_t *osh, struct pktq *pq, int prec, bool dir,
289 	ifpkt_cb_t fn, int arg);
290 
291 extern bool pktq_pdel(struct pktq *pq, void *p, int prec);
292 
293 
294 
295 extern int pktq_mlen(struct pktq *pq, uint prec_bmp);
296 extern void *pktq_mdeq(struct pktq *pq, uint prec_bmp, int *prec_out);
297 extern void *pktq_mpeek(struct pktq *pq, uint prec_bmp, int *prec_out);
298 
299 
300 
301 #define pktq_len(pq)		((int)(pq)->len)
302 #define pktq_max(pq)		((int)(pq)->max)
303 #define pktq_avail(pq)		((int)((pq)->max - (pq)->len))
304 #define pktq_full(pq)		((pq)->len >= (pq)->max)
305 #define pktq_empty(pq)		((pq)->len == 0)
306 
307 
308 #define pktenq(pq, p)		pktq_penq(((struct pktq *)(void *)pq), 0, (p))
309 #define pktenq_head(pq, p)	pktq_penq_head(((struct pktq *)(void *)pq), 0, (p))
310 #define pktdeq(pq)		pktq_pdeq(((struct pktq *)(void *)pq), 0)
311 #define pktdeq_tail(pq)		pktq_pdeq_tail(((struct pktq *)(void *)pq), 0)
312 #define pktqinit(pq, len)	pktq_init(((struct pktq *)(void *)pq), 1, len)
313 
314 extern void pktq_init(struct pktq *pq, int num_prec, int max_len);
315 extern void pktq_set_max_plen(struct pktq *pq, int prec, int max_len);
316 
317 
318 extern void *pktq_deq(struct pktq *pq, int *prec_out);
319 extern void *pktq_deq_tail(struct pktq *pq, int *prec_out);
320 extern void *pktq_peek(struct pktq *pq, int *prec_out);
321 extern void *pktq_peek_tail(struct pktq *pq, int *prec_out);
322 extern void pktq_flush(osl_t *osh, struct pktq *pq, bool dir, ifpkt_cb_t fn, int arg);
323 
324 
325 
326 extern uint pktcopy(osl_t *osh, void *p, uint offset, int len, uchar *buf);
327 extern uint pktfrombuf(osl_t *osh, void *p, uint offset, int len, uchar *buf);
328 extern uint pkttotlen(osl_t *osh, void *p);
329 extern void *pktlast(osl_t *osh, void *p);
330 extern uint pktsegcnt(osl_t *osh, void *p);
331 extern uint pktsegcnt_war(osl_t *osh, void *p);
332 extern uint8 *pktoffset(osl_t *osh, void *p,  uint offset);
333 
334 
335 #define	PKTPRIO_VDSCP	0x100
336 #define	PKTPRIO_VLAN	0x200
337 #define	PKTPRIO_UPD	0x400
338 #define	PKTPRIO_DSCP	0x800
339 
340 extern uint pktsetprio(void *pkt, bool update_vtag);
341 
342 
343 extern int bcm_atoi(const char *s);
344 extern ulong bcm_strtoul(const char *cp, char **endp, uint base);
345 extern char *bcmstrstr(const char *haystack, const char *needle);
346 extern char *bcmstrcat(char *dest, const char *src);
347 extern char *bcmstrncat(char *dest, const char *src, uint size);
348 extern ulong wchar2ascii(char *abuf, ushort *wbuf, ushort wbuflen, ulong abuflen);
349 char* bcmstrtok(char **string, const char *delimiters, char *tokdelim);
350 int bcmstricmp(const char *s1, const char *s2);
351 int bcmstrnicmp(const char* s1, const char* s2, int cnt);
352 
353 
354 
355 extern char *bcm_ether_ntoa(const struct ether_addr *ea, char *buf);
356 extern int bcm_ether_atoe(const char *p, struct ether_addr *ea);
357 
358 
359 struct ipv4_addr;
360 extern char *bcm_ip_ntoa(struct ipv4_addr *ia, char *buf);
361 
362 
363 extern void bcm_mdelay(uint ms);
364 
365 #define NVRAM_RECLAIM_CHECK(name)
366 
367 extern char *getvar(char *vars, const char *name);
368 extern int getintvar(char *vars, const char *name);
369 extern int getintvararray(char *vars, const char *name, int index);
370 extern int getintvararraysize(char *vars, const char *name);
371 extern uint getgpiopin(char *vars, char *pin_name, uint def_pin);
372 #define bcm_perf_enable()
373 #define bcmstats(fmt)
374 #define	bcmlog(fmt, a1, a2)
375 #define	bcmdumplog(buf, size)	*buf = '\0'
376 #define	bcmdumplogent(buf, idx)	-1
377 
378 #define bcmtslog(tstamp, fmt, a1, a2)
379 #define bcmprinttslogs()
380 #define bcmprinttstamp(us)
381 #define bcmdumptslog(buf, size)
382 
383 extern char *bcm_nvram_vars(uint *length);
384 extern int bcm_nvram_cache(void *sih);
385 
386 
387 
388 
389 typedef struct bcm_iovar {
390 	const char *name;
391 	uint16 varid;
392 	uint16 flags;
393 	uint16 type;
394 	uint16 minlen;
395 } bcm_iovar_t;
396 
397 
398 
399 
400 #define IOV_GET 0
401 #define IOV_SET 1
402 
403 
404 #define IOV_GVAL(id)		((id)*2)
405 #define IOV_SVAL(id)		((id) * 2 + IOV_SET)
406 #define IOV_ISSET(actionid)	((actionid & IOV_SET) == IOV_SET)
407 #define IOV_ID(actionid)	(actionid >> 1)
408 
409 
410 
411 extern const bcm_iovar_t *bcm_iovar_lookup(const bcm_iovar_t *table, const char *name);
412 extern int bcm_iovar_lencheck(const bcm_iovar_t *table, void *arg, int len, bool set);
413 #if defined(WLTINYDUMP) || defined(WLMSG_INFORM) || defined(WLMSG_ASSOC) || \
414 	defined(WLMSG_PRPKT) || defined(WLMSG_WSEC)
415 extern int bcm_format_ssid(char* buf, const uchar ssid[], uint ssid_len);
416 #endif
417 #endif
418 
419 
420 #define IOVT_VOID	0
421 #define IOVT_BOOL	1
422 #define IOVT_INT8	2
423 #define IOVT_UINT8	3
424 #define IOVT_INT16	4
425 #define IOVT_UINT16	5
426 #define IOVT_INT32	6
427 #define IOVT_UINT32	7
428 #define IOVT_BUFFER	8
429 #define BCM_IOVT_VALID(type) (((unsigned int)(type)) <= IOVT_BUFFER)
430 
431 
432 #define BCM_IOV_TYPE_INIT { \
433 	"void", \
434 	"bool", \
435 	"int8", \
436 	"uint8", \
437 	"int16", \
438 	"uint16", \
439 	"int32", \
440 	"uint32", \
441 	"buffer", \
442 	"" }
443 
444 #define BCM_IOVT_IS_INT(type) (\
445 	(type == IOVT_BOOL) || \
446 	(type == IOVT_INT8) || \
447 	(type == IOVT_UINT8) || \
448 	(type == IOVT_INT16) || \
449 	(type == IOVT_UINT16) || \
450 	(type == IOVT_INT32) || \
451 	(type == IOVT_UINT32))
452 
453 
454 
455 #define BCME_STRLEN 		64
456 #define VALID_BCMERROR(e)  ((e <= 0) && (e >= BCME_LAST))
457 
458 
459 
460 
461 #define BCME_OK				0
462 #define BCME_ERROR			-1
463 #define BCME_BADARG			-2
464 #define BCME_BADOPTION			-3
465 #define BCME_NOTUP			-4
466 #define BCME_NOTDOWN			-5
467 #define BCME_NOTAP			-6
468 #define BCME_NOTSTA			-7
469 #define BCME_BADKEYIDX			-8
470 #define BCME_RADIOOFF 			-9
471 #define BCME_NOTBANDLOCKED		-10
472 #define BCME_NOCLK			-11
473 #define BCME_BADRATESET			-12
474 #define BCME_BADBAND			-13
475 #define BCME_BUFTOOSHORT		-14
476 #define BCME_BUFTOOLONG			-15
477 #define BCME_BUSY			-16
478 #define BCME_NOTASSOCIATED		-17
479 #define BCME_BADSSIDLEN			-18
480 #define BCME_OUTOFRANGECHAN		-19
481 #define BCME_BADCHAN			-20
482 #define BCME_BADADDR			-21
483 #define BCME_NORESOURCE			-22
484 #define BCME_UNSUPPORTED		-23
485 #define BCME_BADLEN			-24
486 #define BCME_NOTREADY			-25
487 #define BCME_EPERM			-26
488 #define BCME_NOMEM			-27
489 #define BCME_ASSOCIATED			-28
490 #define BCME_RANGE			-29
491 #define BCME_NOTFOUND			-30
492 #define BCME_WME_NOT_ENABLED		-31
493 #define BCME_TSPEC_NOTFOUND		-32
494 #define BCME_ACM_NOTSUPPORTED		-33
495 #define BCME_NOT_WME_ASSOCIATION	-34
496 #define BCME_SDIO_ERROR			-35
497 #define BCME_DONGLE_DOWN		-36
498 #define BCME_VERSION			-37
499 #define BCME_TXFAIL			-38
500 #define BCME_RXFAIL			-39
501 #define BCME_NODEVICE			-40
502 #define BCME_NMODE_DISABLED		-41
503 #define BCME_NONRESIDENT		-42
504 #define BCME_LAST			BCME_NONRESIDENT
505 
506 
507 #define BCMERRSTRINGTABLE {		\
508 	"OK",				\
509 	"Undefined error",		\
510 	"Bad Argument",			\
511 	"Bad Option",			\
512 	"Not up",			\
513 	"Not down",			\
514 	"Not AP",			\
515 	"Not STA",			\
516 	"Bad Key Index",		\
517 	"Radio Off",			\
518 	"Not band locked",		\
519 	"No clock",			\
520 	"Bad Rate valueset",		\
521 	"Bad Band",			\
522 	"Buffer too short",		\
523 	"Buffer too long",		\
524 	"Busy",				\
525 	"Not Associated",		\
526 	"Bad SSID len",			\
527 	"Out of Range Channel",		\
528 	"Bad Channel",			\
529 	"Bad Address",			\
530 	"Not Enough Resources",		\
531 	"Unsupported",			\
532 	"Bad length",			\
533 	"Not Ready",			\
534 	"Not Permitted",		\
535 	"No Memory",			\
536 	"Associated",			\
537 	"Not In Range",			\
538 	"Not Found",			\
539 	"WME Not Enabled",		\
540 	"TSPEC Not Found",		\
541 	"ACM Not Supported",		\
542 	"Not WME Association",		\
543 	"SDIO Bus Error",		\
544 	"Dongle Not Accessible",	\
545 	"Incorrect version",		\
546 	"TX Failure",			\
547 	"RX Failure",			\
548 	"Device Not Present",		\
549 	"NMODE Disabled",		\
550 	"Nonresident overlay access", \
551 }
552 
553 #ifndef ABS
554 #define	ABS(a)			(((a) < 0)?-(a):(a))
555 #endif
556 
557 #ifndef MIN
558 #define	MIN(a, b)		(((a) < (b))?(a):(b))
559 #endif
560 
561 #ifndef MAX
562 #define	MAX(a, b)		(((a) > (b))?(a):(b))
563 #endif
564 
565 #define CEIL(x, y)		(((x) + ((y)-1)) / (y))
566 #define	ROUNDUP(x, y)		((((x)+((y)-1))/(y))*(y))
567 #define	ISALIGNED(a, x)		(((uintptr)(a) & ((x)-1)) == 0)
568 #define ALIGN_ADDR(addr, boundary) (void *)(((uintptr)(addr) + (boundary) - 1) \
569 	                                         & ~((boundary) - 1))
570 #define ALIGN_SIZE(size, boundary) (((size) + (boundary) - 1) \
571 	                                         & ~((boundary) - 1))
572 #define	ISPOWEROF2(x)		((((x) - 1) & (x)) == 0)
573 #define VALID_MASK(mask)	!((mask) & ((mask) + 1))
574 
575 #ifndef OFFSETOF
576 #ifdef __ARMCC_VERSION
577 
578 #include <stddef.h>
579 #define	OFFSETOF(type, member)	offsetof(type, member)
580 #else
581 #define	OFFSETOF(type, member)	((uint)(uintptr)&((type *)0)->member)
582 #endif
583 #endif
584 
585 #ifndef ARRAYSIZE
586 #define ARRAYSIZE(a)		(sizeof(a)/sizeof(a[0]))
587 #endif
588 
589 
590 extern void *_bcmutils_dummy_fn;
591 #define REFERENCE_FUNCTION(f)	(_bcmutils_dummy_fn = (void *)(f))
592 
593 
594 #ifndef setbit
595 #ifndef NBBY
596 #define	NBBY	8
597 #endif
598 #define	setbit(a, i)	(((uint8 *)a)[(i)/NBBY] |= 1<<((i)%NBBY))
599 #define	clrbit(a, i)	(((uint8 *)a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
600 #define	isset(a, i)	(((const uint8 *)a)[(i)/NBBY] & (1<<((i)%NBBY)))
601 #define	isclr(a, i)	((((const uint8 *)a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
602 #endif
603 
604 #define	NBITS(type)	(sizeof(type) * 8)
605 #define NBITVAL(nbits)	(1 << (nbits))
606 #define MAXBITVAL(nbits)	((1 << (nbits)) - 1)
607 #define	NBITMASK(nbits)	MAXBITVAL(nbits)
608 #define MAXNBVAL(nbyte)	MAXBITVAL((nbyte) * 8)
609 
610 
611 #define MUX(pred, true, false) ((pred) ? (true) : (false))
612 
613 
614 #define MODDEC(x, bound) MUX((x) == 0, (bound) - 1, (x) - 1)
615 #define MODINC(x, bound) MUX((x) == (bound) - 1, 0, (x) + 1)
616 
617 
618 #define MODDEC_POW2(x, bound) (((x) - 1) & ((bound) - 1))
619 #define MODINC_POW2(x, bound) (((x) + 1) & ((bound) - 1))
620 
621 
622 #define MODADD(x, y, bound) \
623     MUX((x) + (y) >= (bound), (x) + (y) - (bound), (x) + (y))
624 #define MODSUB(x, y, bound) \
625     MUX(((int)(x)) - ((int)(y)) < 0, (x) - (y) + (bound), (x) - (y))
626 
627 
628 #define MODADD_POW2(x, y, bound) (((x) + (y)) & ((bound) - 1))
629 #define MODSUB_POW2(x, y, bound) (((x) - (y)) & ((bound) - 1))
630 
631 
632 #define CRC8_INIT_VALUE  0xff
633 #define CRC8_GOOD_VALUE  0x9f
634 #define CRC16_INIT_VALUE 0xffff
635 #define CRC16_GOOD_VALUE 0xf0b8
636 #define CRC32_INIT_VALUE 0xffffffff
637 #define CRC32_GOOD_VALUE 0xdebb20e3
638 
639 
640 #define MACF				"%02x:%02x:%02x:%02x:%02x:%02x"
641 #define ETHERP_TO_MACF(ea)	((struct ether_addr *) (ea))->octet[0], \
642 							((struct ether_addr *) (ea))->octet[1], \
643 							((struct ether_addr *) (ea))->octet[2], \
644 							((struct ether_addr *) (ea))->octet[3], \
645 							((struct ether_addr *) (ea))->octet[4], \
646 							((struct ether_addr *) (ea))->octet[5]
647 
648 #define ETHER_TO_MACF(ea) 	(ea).octet[0], \
649 							(ea).octet[1], \
650 							(ea).octet[2], \
651 							(ea).octet[3], \
652 							(ea).octet[4], \
653 							(ea).octet[5]
654 
655 typedef struct bcm_bit_desc {
656 	uint32	bit;
657 	const char* name;
658 } bcm_bit_desc_t;
659 
660 
661 typedef struct bcm_tlv {
662 	uint8	id;
663 	uint8	len;
664 	uint8	data[1];
665 } bcm_tlv_t;
666 
667 
668 #define bcm_valid_tlv(elt, buflen) ((buflen) >= 2 && (int)(buflen) >= (int)(2 + (elt)->len))
669 
670 
671 #define ETHER_ADDR_STR_LEN	18
672 
673 
674 
675 static INLINE void
xor_128bit_block(const uint8 * src1,const uint8 * src2,uint8 * dst)676 xor_128bit_block(const uint8 *src1, const uint8 *src2, uint8 *dst)
677 {
678 	if (
679 #ifdef __i386__
680 	    1 ||
681 #endif
682 	    (((uintptr)src1 | (uintptr)src2 | (uintptr)dst) & 3) == 0) {
683 
684 
685 		((uint32 *)dst)[0] = ((const uint32 *)src1)[0] ^ ((const uint32 *)src2)[0];
686 		((uint32 *)dst)[1] = ((const uint32 *)src1)[1] ^ ((const uint32 *)src2)[1];
687 		((uint32 *)dst)[2] = ((const uint32 *)src1)[2] ^ ((const uint32 *)src2)[2];
688 		((uint32 *)dst)[3] = ((const uint32 *)src1)[3] ^ ((const uint32 *)src2)[3];
689 	} else {
690 
691 		int k;
692 		for (k = 0; k < 16; k++)
693 			dst[k] = src1[k] ^ src2[k];
694 	}
695 }
696 
697 
698 
699 extern uint8 hndcrc8(uint8 *p, uint nbytes, uint8 crc);
700 extern uint16 hndcrc16(uint8 *p, uint nbytes, uint16 crc);
701 extern uint32 hndcrc32(uint8 *p, uint nbytes, uint32 crc);
702 
703 #if defined(DHD_DEBUG) || defined(WLMSG_PRHDRS) || defined(WLMSG_PRPKT) || \
704 	defined(WLMSG_ASSOC)
705 extern int bcm_format_flags(const bcm_bit_desc_t *bd, uint32 flags, char* buf, int len);
706 #endif
707 
708 #if defined(DHD_DEBUG) || defined(WLMSG_PRHDRS) || defined(WLMSG_PRPKT) || \
709 	defined(WLMSG_ASSOC) || defined(WLMEDIA_PEAKRATE)
710 extern int bcm_format_hex(char *str, const void *bytes, int len);
711 #endif
712 
713 extern const char *bcm_crypto_algo_name(uint algo);
714 extern char *bcm_chipname(uint chipid, char *buf, uint len);
715 extern char *bcm_brev_str(uint32 brev, char *buf);
716 extern void printbig(char *buf);
717 extern void prhex(const char *msg, uchar *buf, uint len);
718 
719 
720 extern bcm_tlv_t *bcm_next_tlv(bcm_tlv_t *elt, int *buflen);
721 extern bcm_tlv_t *bcm_parse_tlvs(void *buf, int buflen, uint key);
722 extern bcm_tlv_t *bcm_parse_ordered_tlvs(void *buf, int buflen, uint key);
723 
724 
725 extern const char *bcmerrorstr(int bcmerror);
726 extern bcm_tlv_t *bcm_parse_tlvs(void *buf, int buflen, uint key);
727 
728 
729 typedef uint32 mbool;
730 #define mboolset(mb, bit)		((mb) |= (bit))
731 #define mboolclr(mb, bit)		((mb) &= ~(bit))
732 #define mboolisset(mb, bit)		(((mb) & (bit)) != 0)
733 #define	mboolmaskset(mb, mask, val)	((mb) = (((mb) & ~(mask)) | (val)))
734 
735 
736 struct fielddesc {
737 	const char *nameandfmt;
738 	uint32 	offset;
739 	uint32 	len;
740 };
741 
742 extern void bcm_binit(struct bcmstrbuf *b, char *buf, uint size);
743 extern void bcm_bprhex(struct bcmstrbuf *b, const char *msg, bool newline, uint8 *buf, int len);
744 
745 extern void bcm_inc_bytes(uchar *num, int num_bytes, uint8 amount);
746 extern int bcm_cmp_bytes(const uchar *arg1, const uchar *arg2, uint8 nbytes);
747 extern void bcm_print_bytes(const char *name, const uchar *cdata, int len);
748 
749 typedef  uint32 (*bcmutl_rdreg_rtn)(void *arg0, uint arg1, uint32 offset);
750 extern uint bcmdumpfields(bcmutl_rdreg_rtn func_ptr, void *arg0, uint arg1, struct fielddesc *str,
751                           char *buf, uint32 bufsize);
752 extern uint bcm_bitcount(uint8 *bitmap, uint bytelength);
753 
754 extern int bcm_bprintf(struct bcmstrbuf *b, const char *fmt, ...);
755 
756 
757 extern uint16 bcm_qdbm_to_mw(uint8 qdbm);
758 extern uint8 bcm_mw_to_qdbm(uint16 mw);
759 extern uint bcm_mkiovar(char *name, char *data, uint datalen, char *buf, uint len);
760 
761 unsigned int process_nvram_vars(char *varbuf, unsigned int len);
762 
763 #ifdef __cplusplus
764 	}
765 #endif
766 
767 #endif
768