[deliverable/linux.git] / drivers / net / wireless / brcm80211 / include / brcmu_utils.h

/*
 * Copyright (c) 2010 Broadcom Corporation
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef	_BRCMU_UTILS_H_
#define	_BRCMU_UTILS_H_

#include <linux/skbuff.h>

/*
 * Spin at most 'us' microseconds while 'exp' is true.
 * Caller should explicitly test 'exp' when this completes
 * and take appropriate error action if 'exp' is still true.
 */
#define SPINWAIT(exp, us) { \
	uint countdown = (us) + 9; \
	while ((exp) && (countdown >= 10)) {\
		udelay(10); \
		countdown -= 10; \
	} \
}

/* osl multi-precedence packet queue */
#define PKTQ_LEN_DEFAULT        128	/* Max 128 packets */
#define PKTQ_MAX_PREC           16	/* Maximum precedence levels */

#define BCME_STRLEN		64	/* Max string length for BCM errors */

/* the largest reasonable packet buffer driver uses for ethernet MTU in bytes */
#define	PKTBUFSZ	2048

#ifndef setbit
#ifndef NBBY			/* the BSD family defines NBBY */
#define	NBBY	8		/* 8 bits per byte */
#endif				/* #ifndef NBBY */
#define	setbit(a, i)	(((u8 *)a)[(i)/NBBY] |= 1<<((i)%NBBY))
#define	clrbit(a, i)	(((u8 *)a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
#define	isset(a, i)	(((const u8 *)a)[(i)/NBBY] & (1<<((i)%NBBY)))
#define	isclr(a, i)	((((const u8 *)a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
#endif				/* setbit */

#define	NBITS(type)	(sizeof(type) * 8)
#define NBITVAL(nbits)	(1 << (nbits))
#define MAXBITVAL(nbits)	((1 << (nbits)) - 1)
#define	NBITMASK(nbits)	MAXBITVAL(nbits)
#define MAXNBVAL(nbyte)	MAXBITVAL((nbyte) * 8)

/* crc defines */
#define CRC16_INIT_VALUE 0xffff	/* Initial CRC16 checksum value */
#define CRC16_GOOD_VALUE 0xf0b8	/* Good final CRC16 checksum value */

/* 18-bytes of Ethernet address buffer length */
#define ETHER_ADDR_STR_LEN	18

struct pktq_prec {
	struct sk_buff_head skblist;
	u16 max;		/* maximum number of queued packets */
};

/* multi-priority pkt queue */
struct pktq {
	u16 num_prec;	/* number of precedences in use */
	u16 hi_prec;	/* rapid dequeue hint (>= highest non-empty prec) */
	u16 max;	/* total max packets */
	u16 len;	/* total number of packets */
	/*
	 * q array must be last since # of elements can be either
	 * PKTQ_MAX_PREC or 1
	 */
	struct pktq_prec q[PKTQ_MAX_PREC];
};

/* operations on a specific precedence in packet queue */

static inline int pktq_plen(struct pktq *pq, int prec)
{
	return pq->q[prec].skblist.qlen;
}

static inline int pktq_pavail(struct pktq *pq, int prec)
{
	return pq->q[prec].max - pq->q[prec].skblist.qlen;
}

static inline bool pktq_pfull(struct pktq *pq, int prec)
{
	return pq->q[prec].skblist.qlen >= pq->q[prec].max;
}

static inline bool pktq_pempty(struct pktq *pq, int prec)
{
	return skb_queue_empty(&pq->q[prec].skblist);
}

static inline struct sk_buff *pktq_ppeek(struct pktq *pq, int prec)
{
	return skb_peek(&pq->q[prec].skblist);
}

static inline struct sk_buff *pktq_ppeek_tail(struct pktq *pq, int prec)
{
	return skb_peek_tail(&pq->q[prec].skblist);
}

extern struct sk_buff *brcmu_pktq_penq(struct pktq *pq, int prec,
				 struct sk_buff *p);
extern struct sk_buff *brcmu_pktq_penq_head(struct pktq *pq, int prec,
				      struct sk_buff *p);
extern struct sk_buff *brcmu_pktq_pdeq(struct pktq *pq, int prec);
extern struct sk_buff *brcmu_pktq_pdeq_tail(struct pktq *pq, int prec);
extern struct sk_buff *brcmu_pktq_pdeq_match(struct pktq *pq, int prec,
					     bool (*match_fn)(struct sk_buff *p,
							      void *arg),
					     void *arg);

/* packet primitives */
extern struct sk_buff *brcmu_pkt_buf_get_skb(uint len);
extern void brcmu_pkt_buf_free_skb(struct sk_buff *skb);

/* Empty the queue at particular precedence level */
/* callback function fn(pkt, arg) returns true if pkt belongs to if */
extern void brcmu_pktq_pflush(struct pktq *pq, int prec,
	bool dir, bool (*fn)(struct sk_buff *, void *), void *arg);

/* operations on a set of precedences in packet queue */

extern int brcmu_pktq_mlen(struct pktq *pq, uint prec_bmp);
extern struct sk_buff *brcmu_pktq_mdeq(struct pktq *pq, uint prec_bmp,
	int *prec_out);

/* operations on packet queue as a whole */

static inline int pktq_len(struct pktq *pq)
{
	return (int)pq->len;
}

static inline int pktq_max(struct pktq *pq)
{
	return (int)pq->max;
}

static inline int pktq_avail(struct pktq *pq)
{
	return (int)(pq->max - pq->len);
}

static inline bool pktq_full(struct pktq *pq)
{
	return pq->len >= pq->max;
}

static inline bool pktq_empty(struct pktq *pq)
{
	return pq->len == 0;
}

extern void brcmu_pktq_init(struct pktq *pq, int num_prec, int max_len);
/* prec_out may be NULL if caller is not interested in return value */
extern struct sk_buff *brcmu_pktq_peek_tail(struct pktq *pq, int *prec_out);
extern void brcmu_pktq_flush(struct pktq *pq, bool dir,
		bool (*fn)(struct sk_buff *, void *), void *arg);

/* externs */
/* ip address */
struct ipv4_addr;

/*
 * bitfield macros using masking and shift
 *
 * remark: the mask parameter should be a shifted mask.
 */
static inline void brcmu_maskset32(u32 *var, u32 mask, u8 shift, u32 value)
{
	value = (value << shift) & mask;
	*var = (*var & ~mask) | value;
}
static inline u32 brcmu_maskget32(u32 var, u32 mask, u8 shift)
{
	return (var & mask) >> shift;
}
static inline void brcmu_maskset16(u16 *var, u16 mask, u8 shift, u16 value)
{
	value = (value << shift) & mask;
	*var = (*var & ~mask) | value;
}
static inline u16 brcmu_maskget16(u16 var, u16 mask, u8 shift)
{
	return (var & mask) >> shift;
}

/* externs */
/* format/print */
#ifdef DEBUG
extern void brcmu_prpkt(const char *msg, struct sk_buff *p0);
#else
#define brcmu_prpkt(a, b)
#endif				/* DEBUG */

#ifdef DEBUG
extern __printf(3, 4)
void brcmu_dbg_hex_dump(const void *data, size_t size, const char *fmt, ...);
#else
__printf(3, 4)
static inline
void brcmu_dbg_hex_dump(const void *data, size_t size, const char *fmt, ...)
{
}
#endif

#endif				/* _BRCMU_UTILS_H_ */
Commit	Line	Data
5b435de0 AS	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
67	struct pktq_prec {
ad3b8b39	68	struct sk_buff_head skblist;
5b435de0 AS	69	u16 max; /* maximum number of queued packets */
	70	};
	71
	72	/* multi-priority pkt queue */
	73	struct pktq {
	74	u16 num_prec; /* number of precedences in use */
	75	u16 hi_prec; /* rapid dequeue hint (>= highest non-empty prec) */
	76	u16 max; /* total max packets */
	77	u16 len; /* total number of packets */
	78	/*
	79	* q array must be last since # of elements can be either
	80	* PKTQ_MAX_PREC or 1
	81	*/
	82	struct pktq_prec q[PKTQ_MAX_PREC];
	83	};
	84
	85	/* operations on a specific precedence in packet queue */
	86
	87	static inline int pktq_plen(struct pktq *pq, int prec)
	88	{
ad3b8b39	89	return pq->q[prec].skblist.qlen;
5b435de0 AS	90	}
	91
	92	static inline int pktq_pavail(struct pktq *pq, int prec)
	93	{
ad3b8b39	94	return pq->q[prec].max - pq->q[prec].skblist.qlen;
5b435de0 AS	95	}
	96
	97	static inline bool pktq_pfull(struct pktq *pq, int prec)
	98	{
ad3b8b39	99	return pq->q[prec].skblist.qlen >= pq->q[prec].max;
5b435de0 AS	100	}
	101
	102	static inline bool pktq_pempty(struct pktq *pq, int prec)
	103	{
ad3b8b39	104	return skb_queue_empty(&pq->q[prec].skblist);
5b435de0 AS	105	}
	106
	107	static inline struct sk_buff pktq_ppeek(struct pktq pq, int prec)
	108	{
ad3b8b39	109	return skb_peek(&pq->q[prec].skblist);
5b435de0 AS	110	}
	111
	112	static inline struct sk_buff pktq_ppeek_tail(struct pktq pq, int prec)
	113	{
ad3b8b39	114	return skb_peek_tail(&pq->q[prec].skblist);
5b435de0 AS	115	}
	116
	117	extern struct sk_buff brcmu_pktq_penq(struct pktq pq, int prec,
	118	struct sk_buff *p);
	119	extern struct sk_buff brcmu_pktq_penq_head(struct pktq pq, int prec,
	120	struct sk_buff *p);
	121	extern struct sk_buff brcmu_pktq_pdeq(struct pktq pq, int prec);
	122	extern struct sk_buff brcmu_pktq_pdeq_tail(struct pktq pq, int prec);
17f14d7c AS	123	extern struct sk_buff brcmu_pktq_pdeq_match(struct pktq pq, int prec,
	124	bool (match_fn)(struct sk_buff p,
	125	void *arg),
	126	void *arg);
5b435de0 AS	127
	128	/* packet primitives */
	129	extern struct sk_buff *brcmu_pkt_buf_get_skb(uint len);
	130	extern void brcmu_pkt_buf_free_skb(struct sk_buff *skb);
	131
	132	/* Empty the queue at particular precedence level */
	133	/* callback function fn(pkt, arg) returns true if pkt belongs to if */
	134	extern void brcmu_pktq_pflush(struct pktq *pq, int prec,
	135	bool dir, bool (fn)(struct sk_buff , void ), void arg);
	136
	137	/* operations on a set of precedences in packet queue */
	138
	139	extern int brcmu_pktq_mlen(struct pktq *pq, uint prec_bmp);
	140	extern struct sk_buff brcmu_pktq_mdeq(struct pktq pq, uint prec_bmp,
	141	int *prec_out);
	142
	143	/* operations on packet queue as a whole */
	144
	145	static inline int pktq_len(struct pktq *pq)
	146	{
	147	return (int)pq->len;
	148	}
	149
	150	static inline int pktq_max(struct pktq *pq)
	151	{
	152	return (int)pq->max;
	153	}
	154
	155	static inline int pktq_avail(struct pktq *pq)
	156	{
	157	return (int)(pq->max - pq->len);
	158	}
	159
	160	static inline bool pktq_full(struct pktq *pq)
	161	{
	162	return pq->len >= pq->max;
	163	}
	164
	165	static inline bool pktq_empty(struct pktq *pq)
	166	{
	167	return pq->len == 0;
	168	}
	169
	170	extern void brcmu_pktq_init(struct pktq *pq, int num_prec, int max_len);
	171	/* prec_out may be NULL if caller is not interested in return value */
	172	extern struct sk_buff brcmu_pktq_peek_tail(struct pktq pq, int *prec_out);
	173	extern void brcmu_pktq_flush(struct pktq *pq, bool dir,
	174	bool (fn)(struct sk_buff , void ), void arg);
	175
	176	/* externs */
5b435de0 AS	177	/* ip address */
	178	struct ipv4_addr;
	179
edee1668 AS	180	/*
	181	* bitfield macros using masking and shift
	182	*
	183	* remark: the mask parameter should be a shifted mask.
	184	*/
	185	static inline void brcmu_maskset32(u32 *var, u32 mask, u8 shift, u32 value)
	186	{
	187	value = (value << shift) & mask;
	188	var = (var & ~mask) \| value;
	189	}
	190	static inline u32 brcmu_maskget32(u32 var, u32 mask, u8 shift)
	191	{
	192	return (var & mask) >> shift;
	193	}
	194	static inline void brcmu_maskset16(u16 *var, u16 mask, u8 shift, u16 value)
	195	{
	196	value = (value << shift) & mask;
	197	var = (var & ~mask) \| value;
	198	}
	199	static inline u16 brcmu_maskget16(u16 var, u16 mask, u8 shift)
	200	{
	201	return (var & mask) >> shift;
	202	}
09c7dfa0 AS	203
	204	/* externs */
	205	/* format/print */
8ae74654	206	#ifdef DEBUG
5b435de0 AS	207	extern void brcmu_prpkt(const char msg, struct sk_buff p0);
	208	#else
	209	#define brcmu_prpkt(a, b)
8ae74654	210	#endif /* DEBUG */
5b435de0	211
1e023829 JP	212	#ifdef DEBUG
	213	extern __printf(3, 4)
	214	void brcmu_dbg_hex_dump(const void data, size_t size, const char fmt, ...);
	215	#else
	216	__printf(3, 4)
	217	static inline
	218	void brcmu_dbg_hex_dump(const void data, size_t size, const char fmt, ...)
	219	{
	220	}
	221	#endif
	222
5b435de0	223	#endif /* _BRCMU_UTILS_H_ */