drivers/staging/brcm80211/include/bcmutils.h

   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 _bcmutils_h_
  18 #define _bcmutils_h_
  19
  20 /* Buffer structure for collecting string-formatted data
  21 * using bcm_bprintf() API.
  22 * Use bcm_binit() to initialize before use
  23 */
  24
  25         struct bcmstrbuf {
  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 */
  30         };
  31
  32 /* ** driver-only section ** */
  33 #include <osl.h>
  34
  35 #define GPIO_PIN_NOTDEFINED     0x20    /* Pin not defined */
  36
  37 /*
  38  * Spin at most 'us' microseconds while 'exp' is true.
  39  * Caller should explicitly test 'exp' when this completes
  40  * and take appropriate error action if 'exp' is still true.
  41  */
  42 #define SPINWAIT(exp, us) { \
  43         uint countdown = (us) + 9; \
  44         while ((exp) && (countdown >= 10)) {\
  45                 OSL_DELAY(10); \
  46                 countdown -= 10; \
  47         } \
  48 }
  49
  50 /* osl multi-precedence packet queue */
  51 #ifndef PKTQ_LEN_DEFAULT
  52 #define PKTQ_LEN_DEFAULT        128     /* Max 128 packets */
  53 #endif
  54 #ifndef PKTQ_MAX_PREC
  55 #define PKTQ_MAX_PREC           16      /* Maximum precedence levels */
  56 #endif
  57
  58         typedef struct pktq_prec {
  59                 void *head;     /* first packet to dequeue */
  60                 void *tail;     /* last packet to dequeue */
  61                 u16 len;        /* number of queued packets */
  62                 u16 max;        /* maximum number of queued packets */
  63         } pktq_prec_t;
  64
  65 /* multi-priority pkt queue */
  66         struct pktq {
  67                 u16 num_prec;   /* number of precedences in use */
  68                 u16 hi_prec;    /* rapid dequeue hint (>= highest non-empty prec) */
  69                 u16 max;        /* total max packets */
  70                 u16 len;        /* total number of packets */
  71                 /* q array must be last since # of elements can be either PKTQ_MAX_PREC or 1 */
  72                 struct pktq_prec q[PKTQ_MAX_PREC];
  73         };
  74
  75 /* simple, non-priority pkt queue */
  76         struct spktq {
  77                 u16 num_prec;   /* number of precedences in use (always 1) */
  78                 u16 hi_prec;    /* rapid dequeue hint (>= highest non-empty prec) */
  79                 u16 max;        /* total max packets */
  80                 u16 len;        /* total number of packets */
  81                 /* q array must be last since # of elements can be either PKTQ_MAX_PREC or 1 */
  82                 struct pktq_prec q[1];
  83         };
  84
  85 #define PKTQ_PREC_ITER(pq, prec)        for (prec = (pq)->num_prec - 1; prec >= 0; prec--)
  86
  87 /* fn(pkt, arg).  return true if pkt belongs to if */
  88         typedef bool(*ifpkt_cb_t) (void *, int);
  89
  90 /* forward definition of ether_addr structure used by some function prototypes */
  91
  92         struct ether_addr;
  93
  94         extern int ether_isbcast(const void *ea);
  95         extern int ether_isnulladdr(const void *ea);
  96
  97 /* operations on a specific precedence in packet queue */
  98
  99 #define pktq_psetmax(pq, prec, _max)    ((pq)->q[prec].max = (_max))
 100 #define pktq_plen(pq, prec)             ((pq)->q[prec].len)
 101 #define pktq_pavail(pq, prec)           ((pq)->q[prec].max - (pq)->q[prec].len)
 102 #define pktq_pfull(pq, prec)            ((pq)->q[prec].len >= (pq)->q[prec].max)
 103 #define pktq_pempty(pq, prec)           ((pq)->q[prec].len == 0)
 104
 105 #define pktq_ppeek(pq, prec)            ((pq)->q[prec].head)
 106 #define pktq_ppeek_tail(pq, prec)       ((pq)->q[prec].tail)
 107
 108         extern void *pktq_penq(struct pktq *pq, int prec, void *p);
 109         extern void *pktq_penq_head(struct pktq *pq, int prec, void *p);
 110         extern void *pktq_pdeq(struct pktq *pq, int prec);
 111         extern void *pktq_pdeq_tail(struct pktq *pq, int prec);
 112 /* Empty the queue at particular precedence level */
 113 #ifdef BRCM_FULLMAC
 114         extern void pktq_pflush(osl_t *osh, struct pktq *pq, int prec,
 115                 bool dir);
 116 #else
 117         extern void pktq_pflush(osl_t *osh, struct pktq *pq, int prec,
 118                 bool dir, ifpkt_cb_t fn, int arg);
 119 #endif /* BRCM_FULLMAC */
 120
 121 /* operations on a set of precedences in packet queue */
 122
 123         extern int pktq_mlen(struct pktq *pq, uint prec_bmp);
 124         extern void *pktq_mdeq(struct pktq *pq, uint prec_bmp, int *prec_out);
 125
 126 /* operations on packet queue as a whole */
 127
 128 #define pktq_len(pq)                    ((int)(pq)->len)
 129 #define pktq_max(pq)                    ((int)(pq)->max)
 130 #define pktq_avail(pq)                  ((int)((pq)->max - (pq)->len))
 131 #define pktq_full(pq)                   ((pq)->len >= (pq)->max)
 132 #define pktq_empty(pq)                  ((pq)->len == 0)
 133
 134 /* operations for single precedence queues */
 135 #define pktenq(pq, p)           pktq_penq(((struct pktq *)pq), 0, (p))
 136 #define pktenq_head(pq, p)      pktq_penq_head(((struct pktq *)pq), 0, (p))
 137 #define pktdeq(pq)              pktq_pdeq(((struct pktq *)pq), 0)
 138 #define pktdeq_tail(pq)         pktq_pdeq_tail(((struct pktq *)pq), 0)
 139 #define pktqinit(pq, len) pktq_init(((struct pktq *)pq), 1, len)
 140
 141         extern void pktq_init(struct pktq *pq, int num_prec, int max_len);
 142 /* prec_out may be NULL if caller is not interested in return value */
 143         extern void *pktq_peek_tail(struct pktq *pq, int *prec_out);
 144 #ifdef BRCM_FULLMAC
 145         extern void pktq_flush(osl_t *osh, struct pktq *pq, bool dir);
 146 #else
 147         extern void pktq_flush(osl_t *osh, struct pktq *pq, bool dir,
 148                 ifpkt_cb_t fn, int arg);
 149 #endif
 150
 151 /* externs */
 152 /* packet */
 153         extern uint pktfrombuf(osl_t *osh, void *p, uint offset, int len,
 154                                unsigned char *buf);
 155         extern uint pktsegcnt(osl_t *osh, void *p);
 156         extern uint pkttotlen(osl_t *osh, void *p);
 157
 158 /* Get priority from a packet and pass it back in scb (or equiv) */
 159         extern uint pktsetprio(void *pkt, bool update_vtag);
 160 #define PKTPRIO_VDSCP   0x100   /* DSCP prio found after VLAN tag */
 161 #define PKTPRIO_VLAN    0x200   /* VLAN prio found */
 162 #define PKTPRIO_UPD     0x400   /* DSCP used to update VLAN prio */
 163 #define PKTPRIO_DSCP    0x800   /* DSCP prio found */
 164
 165         char *bcmstrtok(char **string, const char *delimiters, char *tokdelim);
 166 /* ethernet address */
 167         extern char *bcm_ether_ntoa(const struct ether_addr *ea, char *buf);
 168         extern int bcm_ether_atoe(char *p, struct ether_addr *ea);
 169
 170 /* ip address */
 171         struct ipv4_addr;
 172         extern char *bcm_ip_ntoa(struct ipv4_addr *ia, char *buf);
 173
 174 /* variable access */
 175         extern char *getvar(char *vars, const char *name);
 176         extern int getintvar(char *vars, const char *name);
 177 #ifdef BCMDBG
 178         extern void prpkt(const char *msg, osl_t *osh, void *p0);
 179 #endif                          /* BCMDBG */
 180 #define bcm_perf_enable()
 181 #define bcmstats(fmt)
 182 #define bcmlog(fmt, a1, a2)
 183 #define bcmdumplog(buf, size)   (*buf = '\0')
 184 #define bcmdumplogent(buf, idx) -1
 185
 186 #define bcmtslog(tstamp, fmt, a1, a2)
 187 #define bcmprinttslogs()
 188 #define bcmprinttstamp(us)
 189
 190 /* Support for sharing code across in-driver iovar implementations.
 191  * The intent is that a driver use this structure to map iovar names
 192  * to its (private) iovar identifiers, and the lookup function to
 193  * find the entry.  Macros are provided to map ids and get/set actions
 194  * into a single number space for a switch statement.
 195  */
 196
 197 /* iovar structure */
 198         typedef struct bcm_iovar {
 199                 const char *name;       /* name for lookup and display */
 200                 u16 varid;      /* id for switch */
 201                 u16 flags;      /* driver-specific flag bits */
 202                 u16 type;       /* base type of argument */
 203                 u16 minlen;     /* min length for buffer vars */
 204         } bcm_iovar_t;
 205
 206 /* varid definitions are per-driver, may use these get/set bits */
 207
 208 /* IOVar action bits for id mapping */
 209 #define IOV_GET 0               /* Get an iovar */
 210 #define IOV_SET 1               /* Set an iovar */
 211
 212 /* Varid to actionid mapping */
 213 #define IOV_GVAL(id)            ((id)*2)
 214 #define IOV_SVAL(id)            (((id)*2)+IOV_SET)
 215 #define IOV_ISSET(actionid)     ((actionid & IOV_SET) == IOV_SET)
 216 #define IOV_ID(actionid)        (actionid >> 1)
 217
 218 /* flags are per-driver based on driver attributes */
 219
 220         extern const bcm_iovar_t *bcm_iovar_lookup(const bcm_iovar_t *table,
 221                                                    const char *name);
 222         extern int bcm_iovar_lencheck(const bcm_iovar_t *table, void *arg,
 223                                       int len, bool set);
 224
 225 /* Base type definitions */
 226 #define IOVT_VOID       0       /* no value (implictly set only) */
 227 #define IOVT_BOOL       1       /* any value ok (zero/nonzero) */
 228 #define IOVT_INT8       2       /* integer values are range-checked */
 229 #define IOVT_UINT8      3       /* unsigned int 8 bits */
 230 #define IOVT_INT16      4       /* int 16 bits */
 231 #define IOVT_UINT16     5       /* unsigned int 16 bits */
 232 #define IOVT_INT32      6       /* int 32 bits */
 233 #define IOVT_UINT32     7       /* unsigned int 32 bits */
 234 #define IOVT_BUFFER     8       /* buffer is size-checked as per minlen */
 235 #define BCM_IOVT_VALID(type) (((unsigned int)(type)) <= IOVT_BUFFER)
 236
 237 /* Initializer for IOV type strings */
 238 #define BCM_IOV_TYPE_INIT { \
 239         "void", \
 240         "bool", \
 241         "s8", \
 242         "u8", \
 243         "s16", \
 244         "u16", \
 245         "s32", \
 246         "u32", \
 247         "buffer", \
 248         "" }
 249
 250 #define BCM_IOVT_IS_INT(type) (\
 251         (type == IOVT_BOOL) || \
 252         (type == IOVT_INT8) || \
 253         (type == IOVT_UINT8) || \
 254         (type == IOVT_INT16) || \
 255         (type == IOVT_UINT16) || \
 256         (type == IOVT_INT32) || \
 257         (type == IOVT_UINT32))
 258
 259 /* ** driver/apps-shared section ** */
 260
 261 #define BCME_STRLEN             64      /* Max string length for BCM errors */
 262 #define VALID_BCMERROR(e)  ((e <= 0) && (e >= BCME_LAST))
 263
 264 /*
 265  * error codes could be added but the defined ones shouldn't be changed/deleted
 266  * these error codes are exposed to the user code
 267  * when ever a new error code is added to this list
 268  * please update errorstring table with the related error string and
 269  * update osl files with os specific errorcode map
 270 */
 271
 272 #define BCME_OK                         0       /* Success */
 273 #define BCME_ERROR                      -1      /* Error generic */
 274 #define BCME_BADARG                     -2      /* Bad Argument */
 275 #define BCME_BADOPTION                  -3      /* Bad option */
 276 #define BCME_NOTUP                      -4      /* Not up */
 277 #define BCME_NOTDOWN                    -5      /* Not down */
 278 #define BCME_NOTAP                      -6      /* Not AP */
 279 #define BCME_NOTSTA                     -7      /* Not STA  */
 280 #define BCME_BADKEYIDX                  -8      /* BAD Key Index */
 281 #define BCME_RADIOOFF                   -9      /* Radio Off */
 282 #define BCME_NOTBANDLOCKED              -10     /* Not  band locked */
 283 #define BCME_NOCLK                      -11     /* No Clock */
 284 #define BCME_BADRATESET                 -12     /* BAD Rate valueset */
 285 #define BCME_BADBAND                    -13     /* BAD Band */
 286 #define BCME_BUFTOOSHORT                -14     /* Buffer too short */
 287 #define BCME_BUFTOOLONG                 -15     /* Buffer too long */
 288 #define BCME_BUSY                       -16     /* Busy */
 289 #define BCME_NOTASSOCIATED              -17     /* Not Associated */
 290 #define BCME_BADSSIDLEN                 -18     /* Bad SSID len */
 291 #define BCME_OUTOFRANGECHAN             -19     /* Out of Range Channel */
 292 #define BCME_BADCHAN                    -20     /* Bad Channel */
 293 #define BCME_BADADDR                    -21     /* Bad Address */
 294 #define BCME_NORESOURCE                 -22     /* Not Enough Resources */
 295 #define BCME_UNSUPPORTED                -23     /* Unsupported */
 296 #define BCME_BADLEN                     -24     /* Bad length */
 297 #define BCME_NOTREADY                   -25     /* Not Ready */
 298 #define BCME_EPERM                      -26     /* Not Permitted */
 299 #define BCME_NOMEM                      -27     /* No Memory */
 300 #define BCME_ASSOCIATED                 -28     /* Associated */
 301 #define BCME_RANGE                      -29     /* Not In Range */
 302 #define BCME_NOTFOUND                   -30     /* Not Found */
 303 #define BCME_WME_NOT_ENABLED            -31     /* WME Not Enabled */
 304 #define BCME_TSPEC_NOTFOUND             -32     /* TSPEC Not Found */
 305 #define BCME_ACM_NOTSUPPORTED           -33     /* ACM Not Supported */
 306 #define BCME_NOT_WME_ASSOCIATION        -34     /* Not WME Association */
 307 #define BCME_SDIO_ERROR                 -35     /* SDIO Bus Error */
 308 #define BCME_DONGLE_DOWN                -36     /* Dongle Not Accessible */
 309 #define BCME_VERSION                    -37     /* Incorrect version */
 310 #define BCME_TXFAIL                     -38     /* TX failure */
 311 #define BCME_RXFAIL                     -39     /* RX failure */
 312 #define BCME_NODEVICE                   -40     /* Device not present */
 313 #define BCME_NMODE_DISABLED             -41     /* NMODE disabled */
 314 #define BCME_NONRESIDENT                -42     /* access to nonresident overlay */
 315 #define BCME_LAST                       BCME_NONRESIDENT
 316
 317 /* These are collection of BCME Error strings */
 318 #define BCMERRSTRINGTABLE {             \
 319         "OK",                           \
 320         "Undefined error",              \
 321         "Bad Argument",                 \
 322         "Bad Option",                   \
 323         "Not up",                       \
 324         "Not down",                     \
 325         "Not AP",                       \
 326         "Not STA",                      \
 327         "Bad Key Index",                \
 328         "Radio Off",                    \
 329         "Not band locked",              \
 330         "No clock",                     \
 331         "Bad Rate valueset",            \
 332         "Bad Band",                     \
 333         "Buffer too short",             \
 334         "Buffer too long",              \
 335         "Busy",                         \
 336         "Not Associated",               \
 337         "Bad SSID len",                 \
 338         "Out of Range Channel",         \
 339         "Bad Channel",                  \
 340         "Bad Address",                  \
 341         "Not Enough Resources",         \
 342         "Unsupported",                  \
 343         "Bad length",                   \
 344         "Not Ready",                    \
 345         "Not Permitted",                \
 346         "No Memory",                    \
 347         "Associated",                   \
 348         "Not In Range",                 \
 349         "Not Found",                    \
 350         "WME Not Enabled",              \
 351         "TSPEC Not Found",              \
 352         "ACM Not Supported",            \
 353         "Not WME Association",          \
 354         "SDIO Bus Error",               \
 355         "Dongle Not Accessible",        \
 356         "Incorrect version",            \
 357         "TX Failure",                   \
 358         "RX Failure",                   \
 359         "Device Not Present",           \
 360         "NMODE Disabled",               \
 361         "Nonresident overlay access", \
 362 }
 363
 364 #ifndef ABS
 365 #define ABS(a)                  (((a) < 0) ? -(a) : (a))
 366 #endif                          /* ABS */
 367
 368 #define CEIL(x, y)              (((x) + ((y)-1)) / (y))
 369 #define ISPOWEROF2(x)           ((((x)-1)&(x)) == 0)
 370
 371 /* bit map related macros */
 372 #ifndef setbit
 373 #ifndef NBBY                    /* the BSD family defines NBBY */
 374 #define NBBY    8               /* 8 bits per byte */
 375 #endif                          /* #ifndef NBBY */
 376 #define setbit(a, i)    (((u8 *)a)[(i)/NBBY] |= 1<<((i)%NBBY))
 377 #define clrbit(a, i)    (((u8 *)a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
 378 #define isset(a, i)     (((const u8 *)a)[(i)/NBBY] & (1<<((i)%NBBY)))
 379 #define isclr(a, i)     ((((const u8 *)a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
 380 #endif                          /* setbit */
 381
 382 #define NBITS(type)     (sizeof(type) * 8)
 383 #define NBITVAL(nbits)  (1 << (nbits))
 384 #define MAXBITVAL(nbits)        ((1 << (nbits)) - 1)
 385 #define NBITMASK(nbits) MAXBITVAL(nbits)
 386 #define MAXNBVAL(nbyte) MAXBITVAL((nbyte) * 8)
 387
 388 /* basic mux operation - can be optimized on several architectures */
 389 #define MUX(pred, true, false) ((pred) ? (true) : (false))
 390
 391 /* modulo inc/dec - assumes x E [0, bound - 1] */
 392 #define MODDEC(x, bound) MUX((x) == 0, (bound) - 1, (x) - 1)
 393 #define MODINC(x, bound) MUX((x) == (bound) - 1, 0, (x) + 1)
 394
 395 /* modulo inc/dec, bound = 2^k */
 396 #define MODDEC_POW2(x, bound) (((x) - 1) & ((bound) - 1))
 397 #define MODINC_POW2(x, bound) (((x) + 1) & ((bound) - 1))
 398
 399 /* modulo add/sub - assumes x, y E [0, bound - 1] */
 400 #define MODADD(x, y, bound) \
 401     MUX((x) + (y) >= (bound), (x) + (y) - (bound), (x) + (y))
 402 #define MODSUB(x, y, bound) \
 403     MUX(((int)(x)) - ((int)(y)) < 0, (x) - (y) + (bound), (x) - (y))
 404
 405 /* module add/sub, bound = 2^k */
 406 #define MODADD_POW2(x, y, bound) (((x) + (y)) & ((bound) - 1))
 407 #define MODSUB_POW2(x, y, bound) (((x) - (y)) & ((bound) - 1))
 408
 409 /* crc defines */
 410 #define CRC8_INIT_VALUE  0xff   /* Initial CRC8 checksum value */
 411 #define CRC8_GOOD_VALUE  0x9f   /* Good final CRC8 checksum value */
 412 #define CRC16_INIT_VALUE 0xffff /* Initial CRC16 checksum value */
 413 #define CRC16_GOOD_VALUE 0xf0b8 /* Good final CRC16 checksum value */
 414
 415 /* bcm_format_flags() bit description structure */
 416         typedef struct bcm_bit_desc {
 417                 u32 bit;
 418                 const char *name;
 419         } bcm_bit_desc_t;
 420
 421 /* tag_ID/length/value_buffer tuple */
 422         typedef struct bcm_tlv {
 423                 u8 id;
 424                 u8 len;
 425                 u8 data[1];
 426         } bcm_tlv_t;
 427
 428 /* Check that bcm_tlv_t fits into the given buflen */
 429 #define bcm_valid_tlv(elt, buflen) ((buflen) >= 2 && (int)(buflen) >= (int)(2 + (elt)->len))
 430
 431 /* buffer length for ethernet address from bcm_ether_ntoa() */
 432 #define ETHER_ADDR_STR_LEN      18      /* 18-bytes of Ethernet address buffer length */
 433
 434 /* crypto utility function */
 435 /* 128-bit xor: *dst = *src1 xor *src2. dst1, src1 and src2 may have any alignment */
 436         static inline void
 437          xor_128bit_block(const u8 *src1, const u8 *src2, u8 *dst) {
 438                 if (
 439 #ifdef __i386__
 440                            1 ||
 441 #endif
 442                            (((uintptr) src1 | (uintptr) src2 | (uintptr) dst) &
 443                             3) == 0) {
 444                         /* ARM CM3 rel time: 1229 (727 if alignment check could be omitted) */
 445                         /* x86 supports unaligned.  This version runs 6x-9x faster on x86. */
 446                         ((u32 *) dst)[0] =
 447                             ((const u32 *)src1)[0] ^ ((const u32 *)
 448                                                          src2)[0];
 449                         ((u32 *) dst)[1] =
 450                             ((const u32 *)src1)[1] ^ ((const u32 *)
 451                                                          src2)[1];
 452                         ((u32 *) dst)[2] =
 453                             ((const u32 *)src1)[2] ^ ((const u32 *)
 454                                                          src2)[2];
 455                         ((u32 *) dst)[3] =
 456                             ((const u32 *)src1)[3] ^ ((const u32 *)
 457                                                          src2)[3];
 458                 } else {
 459                         /* ARM CM3 rel time: 4668 (4191 if alignment check could be omitted) */
 460                         int k;
 461                         for (k = 0; k < 16; k++)
 462                                 dst[k] = src1[k] ^ src2[k];
 463                 }
 464         }
 465
 466 /* externs */
 467 /* crc */
 468         extern u8 hndcrc8(u8 *p, uint nbytes, u8 crc);
 469         extern u16 hndcrc16(u8 *p, uint nbytes, u16 crc);
 470 /* format/print */
 471 #if defined(BCMDBG)
 472         extern int bcm_format_flags(const bcm_bit_desc_t *bd, u32 flags,
 473                                     char *buf, int len);
 474         extern int bcm_format_hex(char *str, const void *bytes, int len);
 475 #endif
 476         extern char *bcm_chipname(uint chipid, char *buf, uint len);
 477         extern void prhex(const char *msg, unsigned char *buf, uint len);
 478
 479         extern bcm_tlv_t *bcm_parse_tlvs(void *buf, int buflen,
 480                                                     uint key);
 481 /* bcmerror */
 482         extern const char *bcmerrorstr(int bcmerror);
 483
 484 /* multi-bool data type: set of bools, mbool is true if any is set */
 485         typedef u32 mbool;
 486 #define mboolset(mb, bit)               ((mb) |= (bit)) /* set one bool */
 487 #define mboolclr(mb, bit)               ((mb) &= ~(bit))        /* clear one bool */
 488 #define mboolisset(mb, bit)             (((mb) & (bit)) != 0)   /* TRUE if one bool is set */
 489 #define mboolmaskset(mb, mask, val)     ((mb) = (((mb) & ~(mask)) | (val)))
 490
 491 /* power conversion */
 492         extern u16 bcm_qdbm_to_mw(u8 qdbm);
 493         extern u8 bcm_mw_to_qdbm(u16 mw);
 494
 495 /* generic datastruct to help dump routines */
 496         struct fielddesc {
 497                 const char *nameandfmt;
 498                 u32 offset;
 499                 u32 len;
 500         };
 501
 502         extern void bcm_binit(struct bcmstrbuf *b, char *buf, uint size);
 503         extern int bcm_bprintf(struct bcmstrbuf *b, const char *fmt, ...);
 504
 505         typedef u32(*bcmutl_rdreg_rtn) (void *arg0, uint arg1,
 506                                            u32 offset);
 507
 508         extern uint bcm_mkiovar(char *name, char *data, uint datalen, char *buf,
 509                                 uint len);
 510         extern uint bcm_bitcount(u8 *bitmap, uint bytelength);
 511
 512 #endif                          /* _bcmutils_h_ */