2 * Copyright (c) 2010 Broadcom Corporation
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.
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.
20 /* Buffer structure for collecting string-formatted data
21 * using bcm_bprintf() API.
22 * Use bcm_binit() to initialize before use
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 */
32 /* ** driver-only section ** */
34 #define GPIO_PIN_NOTDEFINED 0x20 /* Pin not defined */
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.
41 #define SPINWAIT(exp, us) { \
42 uint countdown = (us) + 9; \
43 while ((exp) && (countdown >= 10)) {\
49 /* osl multi-precedence packet queue */
50 #ifndef PKTQ_LEN_DEFAULT
51 #define PKTQ_LEN_DEFAULT 128 /* Max 128 packets */
54 #define PKTQ_MAX_PREC 16 /* Maximum precedence levels */
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 */
64 /* multi-priority pkt queue */
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
];
74 #define PKTQ_PREC_ITER(pq, prec) for (prec = (pq)->num_prec - 1; prec >= 0; prec--)
76 /* fn(pkt, arg). return true if pkt belongs to if */
77 typedef bool(*ifpkt_cb_t
) (void *, int);
79 /* operations on a specific precedence in packet queue */
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)
87 #define pktq_ppeek(pq, prec) ((pq)->q[prec].head)
88 #define pktq_ppeek_tail(pq, prec) ((pq)->q[prec].tail)
90 extern struct sk_buff
*pktq_penq(struct pktq
*pq
, int prec
,
92 extern struct sk_buff
*pktq_penq_head(struct pktq
*pq
, int prec
,
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
);
97 /* packet primitives */
98 extern struct sk_buff
*pkt_buf_get_skb(struct osl_info
*osh
, uint len
);
99 extern void pkt_buf_free_skb(struct osl_info
*osh
,
100 struct sk_buff
*skb
, bool send
);
102 /* Empty the queue at particular precedence level */
104 extern void pktq_pflush(struct osl_info
*osh
, struct pktq
*pq
, int prec
,
107 extern void pktq_pflush(struct osl_info
*osh
, struct pktq
*pq
, int prec
,
108 bool dir
, ifpkt_cb_t fn
, int arg
);
109 #endif /* BRCM_FULLMAC */
111 /* operations on a set of precedences in packet queue */
113 extern int pktq_mlen(struct pktq
*pq
, uint prec_bmp
);
114 extern struct sk_buff
*pktq_mdeq(struct pktq
*pq
, uint prec_bmp
, int *prec_out
);
116 /* operations on packet queue as a whole */
118 #define pktq_len(pq) ((int)(pq)->len)
119 #define pktq_max(pq) ((int)(pq)->max)
120 #define pktq_avail(pq) ((int)((pq)->max - (pq)->len))
121 #define pktq_full(pq) ((pq)->len >= (pq)->max)
122 #define pktq_empty(pq) ((pq)->len == 0)
124 /* operations for single precedence queues */
125 #define pktenq(pq, p) pktq_penq(((struct pktq *)pq), 0, (p))
126 #define pktenq_head(pq, p) pktq_penq_head(((struct pktq *)pq), 0, (p))
127 #define pktdeq(pq) pktq_pdeq(((struct pktq *)pq), 0)
128 #define pktdeq_tail(pq) pktq_pdeq_tail(((struct pktq *)pq), 0)
129 #define pktqinit(pq, len) pktq_init(((struct pktq *)pq), 1, len)
131 extern void pktq_init(struct pktq
*pq
, int num_prec
, int max_len
);
132 /* prec_out may be NULL if caller is not interested in return value */
133 extern struct sk_buff
*pktq_peek_tail(struct pktq
*pq
, int *prec_out
);
135 extern void pktq_flush(struct osl_info
*osh
, struct pktq
*pq
, bool dir
);
137 extern void pktq_flush(struct osl_info
*osh
, struct pktq
*pq
, bool dir
,
138 ifpkt_cb_t fn
, int arg
);
143 extern uint
pktfrombuf(struct osl_info
*osh
, struct sk_buff
*p
,
144 uint offset
, int len
, unsigned char *buf
);
145 extern uint
pkttotlen(struct osl_info
*osh
, struct sk_buff
*p
);
147 /* ethernet address */
148 extern int bcm_ether_atoe(char *p
, u8
*ea
);
152 extern char *bcm_ip_ntoa(struct ipv4_addr
*ia
, char *buf
);
154 /* variable access */
155 extern char *getvar(char *vars
, const char *name
);
156 extern int getintvar(char *vars
, const char *name
);
158 extern void prpkt(const char *msg
, struct osl_info
*osh
,
161 #define prpkt(a, b, c)
164 #define bcm_perf_enable()
165 #define bcmstats(fmt)
166 #define bcmlog(fmt, a1, a2)
167 #define bcmdumplog(buf, size) (*buf = '\0')
168 #define bcmdumplogent(buf, idx) -1
170 #define bcmtslog(tstamp, fmt, a1, a2)
171 #define bcmprinttslogs()
172 #define bcmprinttstamp(us)
174 /* Support for sharing code across in-driver iovar implementations.
175 * The intent is that a driver use this structure to map iovar names
176 * to its (private) iovar identifiers, and the lookup function to
177 * find the entry. Macros are provided to map ids and get/set actions
178 * into a single number space for a switch statement.
181 /* iovar structure */
182 typedef struct bcm_iovar
{
183 const char *name
; /* name for lookup and display */
184 u16 varid
; /* id for switch */
185 u16 flags
; /* driver-specific flag bits */
186 u16 type
; /* base type of argument */
187 u16 minlen
; /* min length for buffer vars */
190 /* varid definitions are per-driver, may use these get/set bits */
192 /* IOVar action bits for id mapping */
193 #define IOV_GET 0 /* Get an iovar */
194 #define IOV_SET 1 /* Set an iovar */
196 /* Varid to actionid mapping */
197 #define IOV_GVAL(id) ((id)*2)
198 #define IOV_SVAL(id) (((id)*2)+IOV_SET)
199 #define IOV_ISSET(actionid) ((actionid & IOV_SET) == IOV_SET)
200 #define IOV_ID(actionid) (actionid >> 1)
202 /* flags are per-driver based on driver attributes */
204 extern const bcm_iovar_t
*bcm_iovar_lookup(const bcm_iovar_t
*table
,
206 extern int bcm_iovar_lencheck(const bcm_iovar_t
*table
, void *arg
,
209 /* Base type definitions */
210 #define IOVT_VOID 0 /* no value (implictly set only) */
211 #define IOVT_BOOL 1 /* any value ok (zero/nonzero) */
212 #define IOVT_INT8 2 /* integer values are range-checked */
213 #define IOVT_UINT8 3 /* unsigned int 8 bits */
214 #define IOVT_INT16 4 /* int 16 bits */
215 #define IOVT_UINT16 5 /* unsigned int 16 bits */
216 #define IOVT_INT32 6 /* int 32 bits */
217 #define IOVT_UINT32 7 /* unsigned int 32 bits */
218 #define IOVT_BUFFER 8 /* buffer is size-checked as per minlen */
219 #define BCM_IOVT_VALID(type) (((unsigned int)(type)) <= IOVT_BUFFER)
221 /* Initializer for IOV type strings */
222 #define BCM_IOV_TYPE_INIT { \
234 #define BCM_IOVT_IS_INT(type) (\
235 (type == IOVT_BOOL) || \
236 (type == IOVT_INT8) || \
237 (type == IOVT_UINT8) || \
238 (type == IOVT_INT16) || \
239 (type == IOVT_UINT16) || \
240 (type == IOVT_INT32) || \
241 (type == IOVT_UINT32))
243 /* ** driver/apps-shared section ** */
245 #define BCME_STRLEN 64 /* Max string length for BCM errors */
246 #define VALID_BCMERROR(e) ((e <= 0) && (e >= BCME_LAST))
249 * error codes could be added but the defined ones shouldn't be changed/deleted
250 * these error codes are exposed to the user code
251 * when ever a new error code is added to this list
252 * please update errorstring table with the related error string and
253 * update osl files with os specific errorcode map
256 #define BCME_OK 0 /* Success */
257 #define BCME_ERROR -1 /* Error generic */
258 #define BCME_BADARG -2 /* Bad Argument */
259 #define BCME_BADOPTION -3 /* Bad option */
260 #define BCME_NOTUP -4 /* Not up */
261 #define BCME_NOTDOWN -5 /* Not down */
262 #define BCME_NOTAP -6 /* Not AP */
263 #define BCME_NOTSTA -7 /* Not STA */
264 #define BCME_BADKEYIDX -8 /* BAD Key Index */
265 #define BCME_RADIOOFF -9 /* Radio Off */
266 #define BCME_NOTBANDLOCKED -10 /* Not band locked */
267 #define BCME_NOCLK -11 /* No Clock */
268 #define BCME_BADRATESET -12 /* BAD Rate valueset */
269 #define BCME_BADBAND -13 /* BAD Band */
270 #define BCME_BUFTOOSHORT -14 /* Buffer too short */
271 #define BCME_BUFTOOLONG -15 /* Buffer too long */
272 #define BCME_BUSY -16 /* Busy */
273 #define BCME_NOTASSOCIATED -17 /* Not Associated */
274 #define BCME_BADSSIDLEN -18 /* Bad SSID len */
275 #define BCME_OUTOFRANGECHAN -19 /* Out of Range Channel */
276 #define BCME_BADCHAN -20 /* Bad Channel */
277 #define BCME_BADADDR -21 /* Bad Address */
278 #define BCME_NORESOURCE -22 /* Not Enough Resources */
279 #define BCME_UNSUPPORTED -23 /* Unsupported */
280 #define BCME_BADLEN -24 /* Bad length */
281 #define BCME_NOTREADY -25 /* Not Ready */
282 #define BCME_EPERM -26 /* Not Permitted */
283 #define BCME_NOMEM -27 /* No Memory */
284 #define BCME_ASSOCIATED -28 /* Associated */
285 #define BCME_RANGE -29 /* Not In Range */
286 #define BCME_NOTFOUND -30 /* Not Found */
287 #define BCME_WME_NOT_ENABLED -31 /* WME Not Enabled */
288 #define BCME_TSPEC_NOTFOUND -32 /* TSPEC Not Found */
289 #define BCME_ACM_NOTSUPPORTED -33 /* ACM Not Supported */
290 #define BCME_NOT_WME_ASSOCIATION -34 /* Not WME Association */
291 #define BCME_SDIO_ERROR -35 /* SDIO Bus Error */
292 #define BCME_DONGLE_DOWN -36 /* Dongle Not Accessible */
293 #define BCME_VERSION -37 /* Incorrect version */
294 #define BCME_TXFAIL -38 /* TX failure */
295 #define BCME_RXFAIL -39 /* RX failure */
296 #define BCME_NODEVICE -40 /* Device not present */
297 #define BCME_NMODE_DISABLED -41 /* NMODE disabled */
298 #define BCME_NONRESIDENT -42 /* access to nonresident overlay */
299 #define BCME_LAST BCME_NONRESIDENT
301 /* These are collection of BCME Error strings */
302 #define BCMERRSTRINGTABLE { \
315 "Bad Rate valueset", \
317 "Buffer too short", \
322 "Out of Range Channel", \
325 "Not Enough Resources", \
336 "ACM Not Supported", \
337 "Not WME Association", \
339 "Dongle Not Accessible", \
340 "Incorrect version", \
343 "Device Not Present", \
345 "Nonresident overlay access", \
349 #define ABS(a) (((a) < 0) ? -(a) : (a))
352 #define CEIL(x, y) (((x) + ((y)-1)) / (y))
353 #define ISPOWEROF2(x) ((((x)-1)&(x)) == 0)
355 /* map physical to virtual I/O */
356 #if !defined(CONFIG_MMC_MSM7X00A)
357 #define REG_MAP(pa, size) ioremap_nocache((unsigned long)(pa), \
358 (unsigned long)(size))
360 #define REG_MAP(pa, size) (void *)(0)
363 /* Register operations */
364 #define AND_REG(osh, r, v) W_REG(osh, (r), R_REG(osh, r) & (v))
365 #define OR_REG(osh, r, v) W_REG(osh, (r), R_REG(osh, r) | (v))
367 #define SET_REG(osh, r, mask, val) \
368 W_REG((osh), (r), ((R_REG((osh), r) & ~(mask)) | (val)))
371 #ifndef NBBY /* the BSD family defines NBBY */
372 #define NBBY 8 /* 8 bits per byte */
373 #endif /* #ifndef NBBY */
374 #define setbit(a, i) (((u8 *)a)[(i)/NBBY] |= 1<<((i)%NBBY))
375 #define clrbit(a, i) (((u8 *)a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
376 #define isset(a, i) (((const u8 *)a)[(i)/NBBY] & (1<<((i)%NBBY)))
377 #define isclr(a, i) ((((const u8 *)a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
380 #define NBITS(type) (sizeof(type) * 8)
381 #define NBITVAL(nbits) (1 << (nbits))
382 #define MAXBITVAL(nbits) ((1 << (nbits)) - 1)
383 #define NBITMASK(nbits) MAXBITVAL(nbits)
384 #define MAXNBVAL(nbyte) MAXBITVAL((nbyte) * 8)
386 /* basic mux operation - can be optimized on several architectures */
387 #define MUX(pred, true, false) ((pred) ? (true) : (false))
389 /* modulo inc/dec - assumes x E [0, bound - 1] */
390 #define MODDEC(x, bound) MUX((x) == 0, (bound) - 1, (x) - 1)
391 #define MODINC(x, bound) MUX((x) == (bound) - 1, 0, (x) + 1)
393 /* modulo inc/dec, bound = 2^k */
394 #define MODDEC_POW2(x, bound) (((x) - 1) & ((bound) - 1))
395 #define MODINC_POW2(x, bound) (((x) + 1) & ((bound) - 1))
397 /* modulo add/sub - assumes x, y E [0, bound - 1] */
398 #define MODADD(x, y, bound) \
399 MUX((x) + (y) >= (bound), (x) + (y) - (bound), (x) + (y))
400 #define MODSUB(x, y, bound) \
401 MUX(((int)(x)) - ((int)(y)) < 0, (x) - (y) + (bound), (x) - (y))
403 /* module add/sub, bound = 2^k */
404 #define MODADD_POW2(x, y, bound) (((x) + (y)) & ((bound) - 1))
405 #define MODSUB_POW2(x, y, bound) (((x) - (y)) & ((bound) - 1))
408 #define CRC8_INIT_VALUE 0xff /* Initial CRC8 checksum value */
409 #define CRC8_GOOD_VALUE 0x9f /* Good final CRC8 checksum value */
410 #define CRC16_INIT_VALUE 0xffff /* Initial CRC16 checksum value */
411 #define CRC16_GOOD_VALUE 0xf0b8 /* Good final CRC16 checksum value */
413 /* bcm_format_flags() bit description structure */
414 typedef struct bcm_bit_desc
{
419 /* tag_ID/length/value_buffer tuple */
420 typedef struct bcm_tlv
{
426 /* Check that bcm_tlv_t fits into the given buflen */
427 #define bcm_valid_tlv(elt, buflen) ((buflen) >= 2 && (int)(buflen) >= (int)(2 + (elt)->len))
429 #define ETHER_ADDR_STR_LEN 18 /* 18-bytes of Ethernet address buffer length */
431 /* crypto utility function */
432 /* 128-bit xor: *dst = *src1 xor *src2. dst1, src1 and src2 may have any alignment */
434 xor_128bit_block(const u8
*src1
, const u8
*src2
, u8
*dst
) {
439 (((unsigned long) src1
| (unsigned long) src2
| (unsigned long) dst
) &
441 /* ARM CM3 rel time: 1229 (727 if alignment check could be omitted) */
442 /* x86 supports unaligned. This version runs 6x-9x faster on x86. */
444 ((const u32
*)src1
)[0] ^ ((const u32
*)
447 ((const u32
*)src1
)[1] ^ ((const u32
*)
450 ((const u32
*)src1
)[2] ^ ((const u32
*)
453 ((const u32
*)src1
)[3] ^ ((const u32
*)
456 /* ARM CM3 rel time: 4668 (4191 if alignment check could be omitted) */
458 for (k
= 0; k
< 16; k
++)
459 dst
[k
] = src1
[k
] ^ src2
[k
];
465 extern u8
hndcrc8(u8
*p
, uint nbytes
, u8 crc
);
466 extern u16
hndcrc16(u8
*p
, uint nbytes
, u16 crc
);
469 extern int bcm_format_flags(const bcm_bit_desc_t
*bd
, u32 flags
,
471 extern int bcm_format_hex(char *str
, const void *bytes
, int len
);
473 extern char *bcm_chipname(uint chipid
, char *buf
, uint len
);
474 extern void prhex(const char *msg
, unsigned char *buf
, uint len
);
476 extern bcm_tlv_t
*bcm_parse_tlvs(void *buf
, int buflen
,
479 extern const char *bcmerrorstr(int bcmerror
);
481 /* multi-bool data type: set of bools, mbool is true if any is set */
483 #define mboolset(mb, bit) ((mb) |= (bit)) /* set one bool */
484 #define mboolclr(mb, bit) ((mb) &= ~(bit)) /* clear one bool */
485 #define mboolisset(mb, bit) (((mb) & (bit)) != 0) /* true if one bool is set */
486 #define mboolmaskset(mb, mask, val) ((mb) = (((mb) & ~(mask)) | (val)))
488 /* power conversion */
489 extern u16
bcm_qdbm_to_mw(u8 qdbm
);
490 extern u8
bcm_mw_to_qdbm(u16 mw
);
492 extern void bcm_binit(struct bcmstrbuf
*b
, char *buf
, uint size
);
493 extern int bcm_bprintf(struct bcmstrbuf
*b
, const char *fmt
, ...);
495 extern uint
bcm_mkiovar(char *name
, char *data
, uint datalen
, char *buf
,
497 extern uint
bcm_bitcount(u8
*bitmap
, uint bytelength
);
499 #endif /* _bcmutils_h_ */