brcm80211/include/brcmu_utils.h

0001 // SPDX-License-Identifier: ISC
0002 /*
0003  * Copyright (c) 2010 Broadcom Corporation
0004  */
0005
0006 #ifndef _BRCMU_UTILS_H_
0007 #define _BRCMU_UTILS_H_
0008
0009 #include <linux/skbuff.h>
0010
0011 /*
0012  * Spin at most 'us' microseconds while 'exp' is true.
0013  * Caller should explicitly test 'exp' when this completes
0014  * and take appropriate error action if 'exp' is still true.
0015  */
0016 #define SPINWAIT(exp, us) { \
0017     uint countdown = (us) + 9; \
0018     while ((exp) && (countdown >= 10)) {\
0019         udelay(10); \
0020         countdown -= 10; \
0021     } \
0022 }
0023
0024 /* osl multi-precedence packet queue */
0025 #define PKTQ_LEN_DEFAULT        128 /* Max 128 packets */
0026 #define PKTQ_MAX_PREC           16  /* Maximum precedence levels */
0027
0028 #define BCME_STRLEN     64  /* Max string length for BCM errors */
0029
0030 /* the largest reasonable packet buffer driver uses for ethernet MTU in bytes */
0031 #define PKTBUFSZ    2048
0032
0033 #ifndef setbit
0034 #ifndef NBBY            /* the BSD family defines NBBY */
0035 #define NBBY    8       /* 8 bits per byte */
0036 #endif              /* #ifndef NBBY */
0037 #define setbit(a, i)    (((u8 *)a)[(i)/NBBY] |= 1<<((i)%NBBY))
0038 #define clrbit(a, i)    (((u8 *)a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
0039 #define isset(a, i) (((const u8 *)a)[(i)/NBBY] & (1<<((i)%NBBY)))
0040 #define isclr(a, i) ((((const u8 *)a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
0041 #endif              /* setbit */
0042
0043 #define NBITS(type) (sizeof(type) * 8)
0044 #define NBITVAL(nbits)  (1 << (nbits))
0045 #define MAXBITVAL(nbits)    ((1 << (nbits)) - 1)
0046 #define NBITMASK(nbits) MAXBITVAL(nbits)
0047 #define MAXNBVAL(nbyte) MAXBITVAL((nbyte) * 8)
0048
0049 /* crc defines */
0050 #define CRC16_INIT_VALUE 0xffff /* Initial CRC16 checksum value */
0051 #define CRC16_GOOD_VALUE 0xf0b8 /* Good final CRC16 checksum value */
0052
0053 /* 18-bytes of Ethernet address buffer length */
0054 #define ETHER_ADDR_STR_LEN  18
0055
0056 struct pktq_prec {
0057     struct sk_buff_head skblist;
0058     u16 max;        /* maximum number of queued packets */
0059 };
0060
0061 /* multi-priority pkt queue */
0062 struct pktq {
0063     u16 num_prec;   /* number of precedences in use */
0064     u16 hi_prec;    /* rapid dequeue hint (>= highest non-empty prec) */
0065     u16 max;    /* total max packets */
0066     u16 len;    /* total number of packets */
0067     /*
0068      * q array must be last since # of elements can be either
0069      * PKTQ_MAX_PREC or 1
0070      */
0071     struct pktq_prec q[PKTQ_MAX_PREC];
0072 };
0073
0074 /* operations on a specific precedence in packet queue */
0075
0076 static inline int pktq_plen(struct pktq *pq, int prec)
0077 {
0078     return pq->q[prec].skblist.qlen;
0079 }
0080
0081 static inline int pktq_pavail(struct pktq *pq, int prec)
0082 {
0083     return pq->q[prec].max - pq->q[prec].skblist.qlen;
0084 }
0085
0086 static inline bool pktq_pfull(struct pktq *pq, int prec)
0087 {
0088     return pq->q[prec].skblist.qlen >= pq->q[prec].max;
0089 }
0090
0091 static inline bool pktq_pempty(struct pktq *pq, int prec)
0092 {
0093     return skb_queue_empty(&pq->q[prec].skblist);
0094 }
0095
0096 static inline struct sk_buff *pktq_ppeek(struct pktq *pq, int prec)
0097 {
0098     return skb_peek(&pq->q[prec].skblist);
0099 }
0100
0101 static inline struct sk_buff *pktq_ppeek_tail(struct pktq *pq, int prec)
0102 {
0103     return skb_peek_tail(&pq->q[prec].skblist);
0104 }
0105
0106 struct sk_buff *brcmu_pktq_penq(struct pktq *pq, int prec, struct sk_buff *p);
0107 struct sk_buff *brcmu_pktq_penq_head(struct pktq *pq, int prec,
0108                      struct sk_buff *p);
0109 struct sk_buff *brcmu_pktq_pdeq(struct pktq *pq, int prec);
0110 struct sk_buff *brcmu_pktq_pdeq_tail(struct pktq *pq, int prec);
0111 struct sk_buff *brcmu_pktq_pdeq_match(struct pktq *pq, int prec,
0112                       bool (*match_fn)(struct sk_buff *p,
0113                                void *arg),
0114                       void *arg);
0115
0116 /* packet primitives */
0117 struct sk_buff *brcmu_pkt_buf_get_skb(uint len);
0118 void brcmu_pkt_buf_free_skb(struct sk_buff *skb);
0119
0120 /* Empty the queue at particular precedence level */
0121 /* callback function fn(pkt, arg) returns true if pkt belongs to if */
0122 void brcmu_pktq_pflush(struct pktq *pq, int prec, bool dir,
0123                bool (*fn)(struct sk_buff *, void *), void *arg);
0124
0125 /* operations on a set of precedences in packet queue */
0126
0127 int brcmu_pktq_mlen(struct pktq *pq, uint prec_bmp);
0128 struct sk_buff *brcmu_pktq_mdeq(struct pktq *pq, uint prec_bmp, int *prec_out);
0129
0130 /* operations on packet queue as a whole */
0131
0132 static inline int pktq_len(struct pktq *pq)
0133 {
0134     return (int)pq->len;
0135 }
0136
0137 static inline int pktq_max(struct pktq *pq)
0138 {
0139     return (int)pq->max;
0140 }
0141
0142 static inline int pktq_avail(struct pktq *pq)
0143 {
0144     return (int)(pq->max - pq->len);
0145 }
0146
0147 static inline bool pktq_full(struct pktq *pq)
0148 {
0149     return pq->len >= pq->max;
0150 }
0151
0152 static inline bool pktq_empty(struct pktq *pq)
0153 {
0154     return pq->len == 0;
0155 }
0156
0157 void brcmu_pktq_init(struct pktq *pq, int num_prec, int max_len);
0158 /* prec_out may be NULL if caller is not interested in return value */
0159 struct sk_buff *brcmu_pktq_peek_tail(struct pktq *pq, int *prec_out);
0160 void brcmu_pktq_flush(struct pktq *pq, bool dir,
0161               bool (*fn)(struct sk_buff *, void *), void *arg);
0162
0163 /* externs */
0164 /* ip address */
0165 struct ipv4_addr;
0166
0167 /*
0168  * bitfield macros using masking and shift
0169  *
0170  * remark: the mask parameter should be a shifted mask.
0171  */
0172 static inline void brcmu_maskset32(u32 *var, u32 mask, u8 shift, u32 value)
0173 {
0174     value = (value << shift) & mask;
0175     *var = (*var & ~mask) | value;
0176 }
0177 static inline u32 brcmu_maskget32(u32 var, u32 mask, u8 shift)
0178 {
0179     return (var & mask) >> shift;
0180 }
0181 static inline void brcmu_maskset16(u16 *var, u16 mask, u8 shift, u16 value)
0182 {
0183     value = (value << shift) & mask;
0184     *var = (*var & ~mask) | value;
0185 }
0186 static inline u16 brcmu_maskget16(u16 var, u16 mask, u8 shift)
0187 {
0188     return (var & mask) >> shift;
0189 }
0190
0191 /* externs */
0192 /* format/print */
0193 #ifdef DEBUG
0194 void brcmu_prpkt(const char *msg, struct sk_buff *p0);
0195 #else
0196 #define brcmu_prpkt(a, b)
0197 #endif              /* DEBUG */
0198
0199 #ifdef DEBUG
0200 __printf(3, 4)
0201 void brcmu_dbg_hex_dump(const void *data, size_t size, const char *fmt, ...);
0202 #else
0203 __printf(3, 4)
0204 static inline
0205 void brcmu_dbg_hex_dump(const void *data, size_t size, const char *fmt, ...)
0206 {
0207 }
0208 #endif
0209
0210 #define BRCMU_BOARDREV_LEN  8
0211 #define BRCMU_DOTREV_LEN    16
0212
0213 char *brcmu_boardrev_str(u32 brev, char *buf);
0214 char *brcmu_dotrev_str(u32 dotrev, char *buf);
0215
0216 #endif              /* _BRCMU_UTILS_H_ */