| /* |
| * 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 _bcmutils_h_ |
| #define _bcmutils_h_ |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| #ifdef BRCM_FULLMAC |
| /* ctype replacement */ |
| #define _BCM_U 0x01 /* upper */ |
| #define _BCM_L 0x02 /* lower */ |
| #define _BCM_D 0x04 /* digit */ |
| #define _BCM_C 0x08 /* cntrl */ |
| #define _BCM_P 0x10 /* punct */ |
| #define _BCM_S 0x20 /* white space (space/lf/tab) */ |
| #define _BCM_X 0x40 /* hex digit */ |
| #define _BCM_SP 0x80 /* hard space (0x20) */ |
| |
| extern const unsigned char bcm_ctype[]; |
| #define bcm_ismask(x) (bcm_ctype[(int)(unsigned char)(x)]) |
| |
| #define bcm_isalnum(c) ((bcm_ismask(c)&(_BCM_U|_BCM_L|_BCM_D)) != 0) |
| #define bcm_isalpha(c) ((bcm_ismask(c)&(_BCM_U|_BCM_L)) != 0) |
| #define bcm_iscntrl(c) ((bcm_ismask(c)&(_BCM_C)) != 0) |
| #define bcm_isdigit(c) ((bcm_ismask(c)&(_BCM_D)) != 0) |
| #define bcm_isgraph(c) ((bcm_ismask(c)&(_BCM_P|_BCM_U|_BCM_L|_BCM_D)) != 0) |
| #define bcm_islower(c) ((bcm_ismask(c)&(_BCM_L)) != 0) |
| #define bcm_isprint(c) \ |
| ((bcm_ismask(c)&(_BCM_P|_BCM_U|_BCM_L|_BCM_D|_BCM_SP)) != 0) |
| #define bcm_ispunct(c) ((bcm_ismask(c)&(_BCM_P)) != 0) |
| #define bcm_isspace(c) ((bcm_ismask(c)&(_BCM_S)) != 0) |
| #define bcm_isupper(c) ((bcm_ismask(c)&(_BCM_U)) != 0) |
| #define bcm_isxdigit(c) ((bcm_ismask(c)&(_BCM_D|_BCM_X)) != 0) |
| #define bcm_tolower(c) (bcm_isupper((c)) ? ((c) + 'a' - 'A') : (c)) |
| #define bcm_toupper(c) (bcm_islower((c)) ? ((c) + 'A' - 'a') : (c)) |
| #endif /* BRCM_FULLMAC */ |
| |
| /* Buffer structure for collecting string-formatted data |
| * using bcm_bprintf() API. |
| * Use bcm_binit() to initialize before use |
| */ |
| |
| struct bcmstrbuf { |
| char *buf; /* pointer to current position in origbuf */ |
| unsigned int size; /* current (residual) size in bytes */ |
| char *origbuf; /* unmodified pointer to orignal buffer */ |
| unsigned int origsize; /* unmodified orignal buffer size in bytes */ |
| }; |
| |
| /* ** driver-only section ** */ |
| #include <osl.h> |
| |
| #define GPIO_PIN_NOTDEFINED 0x20 /* Pin not defined */ |
| |
| /* |
| * 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)) {\ |
| OSL_DELAY(10); \ |
| countdown -= 10; \ |
| } \ |
| } |
| |
| /* osl multi-precedence packet queue */ |
| #ifndef PKTQ_LEN_DEFAULT |
| #define PKTQ_LEN_DEFAULT 128 /* Max 128 packets */ |
| #endif |
| #ifndef PKTQ_MAX_PREC |
| #define PKTQ_MAX_PREC 16 /* Maximum precedence levels */ |
| #endif |
| |
| typedef struct pktq_prec { |
| void *head; /* first packet to dequeue */ |
| void *tail; /* last packet to dequeue */ |
| uint16 len; /* number of queued packets */ |
| uint16 max; /* maximum number of queued packets */ |
| } pktq_prec_t; |
| |
| /* multi-priority pkt queue */ |
| struct pktq { |
| uint16 num_prec; /* number of precedences in use */ |
| uint16 hi_prec; /* rapid dequeue hint (>= highest non-empty prec) */ |
| uint16 max; /* total max packets */ |
| uint16 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]; |
| }; |
| |
| /* simple, non-priority pkt queue */ |
| struct spktq { |
| uint16 num_prec; /* number of precedences in use (always 1) */ |
| uint16 hi_prec; /* rapid dequeue hint (>= highest non-empty prec) */ |
| uint16 max; /* total max packets */ |
| uint16 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[1]; |
| }; |
| |
| #define PKTQ_PREC_ITER(pq, prec) for (prec = (pq)->num_prec - 1; prec >= 0; prec--) |
| |
| /* fn(pkt, arg). return true if pkt belongs to if */ |
| typedef bool(*ifpkt_cb_t) (void *, int); |
| |
| /* forward definition of ether_addr structure used by some function prototypes */ |
| |
| struct ether_addr; |
| |
| extern int ether_isbcast(const void *ea); |
| extern int ether_isnulladdr(const void *ea); |
| |
| /* operations on a specific precedence in packet queue */ |
| |
| #define pktq_psetmax(pq, prec, _max) ((pq)->q[prec].max = (_max)) |
| #define pktq_plen(pq, prec) ((pq)->q[prec].len) |
| #define pktq_pavail(pq, prec) ((pq)->q[prec].max - (pq)->q[prec].len) |
| #define pktq_pfull(pq, prec) ((pq)->q[prec].len >= (pq)->q[prec].max) |
| #define pktq_pempty(pq, prec) ((pq)->q[prec].len == 0) |
| |
| #define pktq_ppeek(pq, prec) ((pq)->q[prec].head) |
| #define pktq_ppeek_tail(pq, prec) ((pq)->q[prec].tail) |
| |
| extern void *pktq_penq(struct pktq *pq, int prec, void *p); |
| extern void *pktq_penq_head(struct pktq *pq, int prec, void *p); |
| extern void *pktq_pdeq(struct pktq *pq, int prec); |
| extern void *pktq_pdeq_tail(struct pktq *pq, int prec); |
| /* Empty the queue at particular precedence level */ |
| #ifdef BRCM_FULLMAC |
| extern void pktq_pflush(osl_t *osh, struct pktq *pq, int prec, |
| bool dir); |
| #else |
| extern void pktq_pflush(osl_t *osh, struct pktq *pq, int prec, |
| bool dir, ifpkt_cb_t fn, int arg); |
| #endif |
| /* Remove a specified packet from its queue */ |
| extern bool pktq_pdel(struct pktq *pq, void *p, int prec); |
| |
| /* operations on a set of precedences in packet queue */ |
| |
| extern int pktq_mlen(struct pktq *pq, uint prec_bmp); |
| extern void *pktq_mdeq(struct pktq *pq, uint prec_bmp, int *prec_out); |
| |
| /* operations on packet queue as a whole */ |
| |
| #define pktq_len(pq) ((int)(pq)->len) |
| #define pktq_max(pq) ((int)(pq)->max) |
| #define pktq_avail(pq) ((int)((pq)->max - (pq)->len)) |
| #define pktq_full(pq) ((pq)->len >= (pq)->max) |
| #define pktq_empty(pq) ((pq)->len == 0) |
| |
| /* operations for single precedence queues */ |
| #define pktenq(pq, p) pktq_penq(((struct pktq *)pq), 0, (p)) |
| #define pktenq_head(pq, p) pktq_penq_head(((struct pktq *)pq), 0, (p)) |
| #define pktdeq(pq) pktq_pdeq(((struct pktq *)pq), 0) |
| #define pktdeq_tail(pq) pktq_pdeq_tail(((struct pktq *)pq), 0) |
| #define pktqinit(pq, len) pktq_init(((struct pktq *)pq), 1, len) |
| |
| extern void 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 void *pktq_deq(struct pktq *pq, int *prec_out); |
| extern void *pktq_deq_tail(struct pktq *pq, int *prec_out); |
| extern void *pktq_peek(struct pktq *pq, int *prec_out); |
| extern void *pktq_peek_tail(struct pktq *pq, int *prec_out); |
| #ifdef BRCM_FULLMAC |
| extern void pktq_flush(osl_t *osh, struct pktq *pq, bool dir); |
| #else |
| extern void pktq_flush(osl_t *osh, struct pktq *pq, bool dir, |
| ifpkt_cb_t fn, int arg); |
| #endif |
| |
| /* externs */ |
| /* packet */ |
| extern uint pktcopy(osl_t *osh, void *p, uint offset, int len, |
| uchar *buf); |
| extern uint pktfrombuf(osl_t *osh, void *p, uint offset, int len, |
| uchar *buf); |
| extern uint pkttotlen(osl_t *osh, void *p); |
| extern void *pktlast(osl_t *osh, void *p); |
| extern uint pktsegcnt(osl_t *osh, void *p); |
| |
| /* Get priority from a packet and pass it back in scb (or equiv) */ |
| extern uint pktsetprio(void *pkt, bool update_vtag); |
| #define PKTPRIO_VDSCP 0x100 /* DSCP prio found after VLAN tag */ |
| #define PKTPRIO_VLAN 0x200 /* VLAN prio found */ |
| #define PKTPRIO_UPD 0x400 /* DSCP used to update VLAN prio */ |
| #define PKTPRIO_DSCP 0x800 /* DSCP prio found */ |
| |
| #ifdef BRCM_FULLMAC |
| /* string */ |
| extern int BCMROMFN(bcm_atoi) (char *s); |
| extern ulong BCMROMFN(bcm_strtoul) (char *cp, char **endp, uint base); |
| extern char *BCMROMFN(bcmstrstr) (char *haystack, char *needle); |
| extern char *BCMROMFN(bcmstrcat) (char *dest, const char *src); |
| extern char *BCMROMFN(bcmstrncat) (char *dest, const char *src, |
| uint size); |
| extern ulong wchar2ascii(char *abuf, ushort *wbuf, ushort wbuflen, |
| ulong abuflen); |
| char *bcmstrtok(char **string, const char *delimiters, char *tokdelim); |
| int bcmstricmp(const char *s1, const char *s2); |
| int bcmstrnicmp(const char *s1, const char *s2, int cnt); |
| #endif |
| /* ethernet address */ |
| extern char *bcm_ether_ntoa(const struct ether_addr *ea, char *buf); |
| extern int BCMROMFN(bcm_ether_atoe) (char *p, struct ether_addr *ea); |
| |
| /* ip address */ |
| struct ipv4_addr; |
| extern char *bcm_ip_ntoa(struct ipv4_addr *ia, char *buf); |
| |
| /* delay */ |
| extern void bcm_mdelay(uint ms); |
| /* variable access */ |
| extern char *getvar(char *vars, const char *name); |
| extern int getintvar(char *vars, const char *name); |
| extern int getintvararray(char *vars, const char *name, uint8 index); |
| extern uint getgpiopin(char *vars, char *pin_name, uint def_pin); |
| #ifdef BCMDBG |
| extern void prpkt(const char *msg, osl_t *osh, void *p0); |
| #endif /* BCMDBG */ |
| #define bcm_perf_enable() |
| #define bcmstats(fmt) |
| #define bcmlog(fmt, a1, a2) |
| #define bcmdumplog(buf, size) (*buf = '\0') |
| #define bcmdumplogent(buf, idx) -1 |
| |
| #define bcmtslog(tstamp, fmt, a1, a2) |
| #define bcmprinttslogs() |
| #define bcmprinttstamp(us) |
| |
| extern char *bcm_nvram_vars(uint *length); |
| extern int bcm_nvram_cache(void *sih); |
| |
| /* Support for sharing code across in-driver iovar implementations. |
| * The intent is that a driver use this structure to map iovar names |
| * to its (private) iovar identifiers, and the lookup function to |
| * find the entry. Macros are provided to map ids and get/set actions |
| * into a single number space for a switch statement. |
| */ |
| |
| /* iovar structure */ |
| typedef struct bcm_iovar { |
| const char *name; /* name for lookup and display */ |
| uint16 varid; /* id for switch */ |
| uint16 flags; /* driver-specific flag bits */ |
| uint16 type; /* base type of argument */ |
| uint16 minlen; /* min length for buffer vars */ |
| } bcm_iovar_t; |
| |
| /* varid definitions are per-driver, may use these get/set bits */ |
| |
| /* IOVar action bits for id mapping */ |
| #define IOV_GET 0 /* Get an iovar */ |
| #define IOV_SET 1 /* Set an iovar */ |
| |
| /* Varid to actionid mapping */ |
| #define IOV_GVAL(id) ((id)*2) |
| #define IOV_SVAL(id) (((id)*2)+IOV_SET) |
| #define IOV_ISSET(actionid) ((actionid & IOV_SET) == IOV_SET) |
| #define IOV_ID(actionid) (actionid >> 1) |
| |
| /* flags are per-driver based on driver attributes */ |
| |
| extern const bcm_iovar_t *bcm_iovar_lookup(const bcm_iovar_t *table, |
| const char *name); |
| extern int bcm_iovar_lencheck(const bcm_iovar_t *table, void *arg, |
| int len, bool set); |
| #if defined(BCMDBG) |
| extern int bcm_format_ssid(char *buf, const uchar ssid[], |
| uint ssid_len); |
| #endif |
| |
| /* Base type definitions */ |
| #define IOVT_VOID 0 /* no value (implictly set only) */ |
| #define IOVT_BOOL 1 /* any value ok (zero/nonzero) */ |
| #define IOVT_INT8 2 /* integer values are range-checked */ |
| #define IOVT_UINT8 3 /* unsigned int 8 bits */ |
| #define IOVT_INT16 4 /* int 16 bits */ |
| #define IOVT_UINT16 5 /* unsigned int 16 bits */ |
| #define IOVT_INT32 6 /* int 32 bits */ |
| #define IOVT_UINT32 7 /* unsigned int 32 bits */ |
| #define IOVT_BUFFER 8 /* buffer is size-checked as per minlen */ |
| #define BCM_IOVT_VALID(type) (((unsigned int)(type)) <= IOVT_BUFFER) |
| |
| /* Initializer for IOV type strings */ |
| #define BCM_IOV_TYPE_INIT { \ |
| "void", \ |
| "bool", \ |
| "int8", \ |
| "uint8", \ |
| "int16", \ |
| "uint16", \ |
| "int32", \ |
| "uint32", \ |
| "buffer", \ |
| "" } |
| |
| #define BCM_IOVT_IS_INT(type) (\ |
| (type == IOVT_BOOL) || \ |
| (type == IOVT_INT8) || \ |
| (type == IOVT_UINT8) || \ |
| (type == IOVT_INT16) || \ |
| (type == IOVT_UINT16) || \ |
| (type == IOVT_INT32) || \ |
| (type == IOVT_UINT32)) |
| |
| /* ** driver/apps-shared section ** */ |
| |
| #define BCME_STRLEN 64 /* Max string length for BCM errors */ |
| #define VALID_BCMERROR(e) ((e <= 0) && (e >= BCME_LAST)) |
| |
| /* |
| * error codes could be added but the defined ones shouldn't be changed/deleted |
| * these error codes are exposed to the user code |
| * when ever a new error code is added to this list |
| * please update errorstring table with the related error string and |
| * update osl files with os specific errorcode map |
| */ |
| |
| #define BCME_OK 0 /* Success */ |
| #define BCME_ERROR -1 /* Error generic */ |
| #define BCME_BADARG -2 /* Bad Argument */ |
| #define BCME_BADOPTION -3 /* Bad option */ |
| #define BCME_NOTUP -4 /* Not up */ |
| #define BCME_NOTDOWN -5 /* Not down */ |
| #define BCME_NOTAP -6 /* Not AP */ |
| #define BCME_NOTSTA -7 /* Not STA */ |
| #define BCME_BADKEYIDX -8 /* BAD Key Index */ |
| #define BCME_RADIOOFF -9 /* Radio Off */ |
| #define BCME_NOTBANDLOCKED -10 /* Not band locked */ |
| #define BCME_NOCLK -11 /* No Clock */ |
| #define BCME_BADRATESET -12 /* BAD Rate valueset */ |
| #define BCME_BADBAND -13 /* BAD Band */ |
| #define BCME_BUFTOOSHORT -14 /* Buffer too short */ |
| #define BCME_BUFTOOLONG -15 /* Buffer too long */ |
| #define BCME_BUSY -16 /* Busy */ |
| #define BCME_NOTASSOCIATED -17 /* Not Associated */ |
| #define BCME_BADSSIDLEN -18 /* Bad SSID len */ |
| #define BCME_OUTOFRANGECHAN -19 /* Out of Range Channel */ |
| #define BCME_BADCHAN -20 /* Bad Channel */ |
| #define BCME_BADADDR -21 /* Bad Address */ |
| #define BCME_NORESOURCE -22 /* Not Enough Resources */ |
| #define BCME_UNSUPPORTED -23 /* Unsupported */ |
| #define BCME_BADLEN -24 /* Bad length */ |
| #define BCME_NOTREADY -25 /* Not Ready */ |
| #define BCME_EPERM -26 /* Not Permitted */ |
| #define BCME_NOMEM -27 /* No Memory */ |
| #define BCME_ASSOCIATED -28 /* Associated */ |
| #define BCME_RANGE -29 /* Not In Range */ |
| #define BCME_NOTFOUND -30 /* Not Found */ |
| #define BCME_WME_NOT_ENABLED -31 /* WME Not Enabled */ |
| #define BCME_TSPEC_NOTFOUND -32 /* TSPEC Not Found */ |
| #define BCME_ACM_NOTSUPPORTED -33 /* ACM Not Supported */ |
| #define BCME_NOT_WME_ASSOCIATION -34 /* Not WME Association */ |
| #define BCME_SDIO_ERROR -35 /* SDIO Bus Error */ |
| #define BCME_DONGLE_DOWN -36 /* Dongle Not Accessible */ |
| #define BCME_VERSION -37 /* Incorrect version */ |
| #define BCME_TXFAIL -38 /* TX failure */ |
| #define BCME_RXFAIL -39 /* RX failure */ |
| #define BCME_NODEVICE -40 /* Device not present */ |
| #define BCME_NMODE_DISABLED -41 /* NMODE disabled */ |
| #define BCME_NONRESIDENT -42 /* access to nonresident overlay */ |
| #define BCME_LAST BCME_NONRESIDENT |
| |
| /* These are collection of BCME Error strings */ |
| #define BCMERRSTRINGTABLE { \ |
| "OK", \ |
| "Undefined error", \ |
| "Bad Argument", \ |
| "Bad Option", \ |
| "Not up", \ |
| "Not down", \ |
| "Not AP", \ |
| "Not STA", \ |
| "Bad Key Index", \ |
| "Radio Off", \ |
| "Not band locked", \ |
| "No clock", \ |
| "Bad Rate valueset", \ |
| "Bad Band", \ |
| "Buffer too short", \ |
| "Buffer too long", \ |
| "Busy", \ |
| "Not Associated", \ |
| "Bad SSID len", \ |
| "Out of Range Channel", \ |
| "Bad Channel", \ |
| "Bad Address", \ |
| "Not Enough Resources", \ |
| "Unsupported", \ |
| "Bad length", \ |
| "Not Ready", \ |
| "Not Permitted", \ |
| "No Memory", \ |
| "Associated", \ |
| "Not In Range", \ |
| "Not Found", \ |
| "WME Not Enabled", \ |
| "TSPEC Not Found", \ |
| "ACM Not Supported", \ |
| "Not WME Association", \ |
| "SDIO Bus Error", \ |
| "Dongle Not Accessible", \ |
| "Incorrect version", \ |
| "TX Failure", \ |
| "RX Failure", \ |
| "Device Not Present", \ |
| "NMODE Disabled", \ |
| "Nonresident overlay access", \ |
| } |
| |
| #ifndef ABS |
| #define ABS(a) (((a) < 0) ? -(a) : (a)) |
| #endif /* ABS */ |
| |
| #ifndef MIN |
| #define MIN(a, b) (((a) < (b)) ? (a) : (b)) |
| #endif /* MIN */ |
| |
| #ifndef MAX |
| #define MAX(a, b) (((a) > (b)) ? (a) : (b)) |
| #endif /* MAX */ |
| |
| #define CEIL(x, y) (((x) + ((y)-1)) / (y)) |
| #define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y)) |
| #define ISALIGNED(a, x) (((a) & ((x)-1)) == 0) |
| #define ALIGN_ADDR(addr, boundary) (void *)(((uintptr)(addr) + (boundary) - 1) \ |
| & ~((boundary) - 1)) |
| #define ISPOWEROF2(x) ((((x)-1)&(x)) == 0) |
| #define VALID_MASK(mask) (!((mask) & ((mask) + 1))) |
| #ifndef OFFSETOF |
| #define OFFSETOF(type, member) ((uint)(uintptr)&((type *)0)->member) |
| #endif /* OFFSETOF */ |
| #ifndef ARRAYSIZE |
| #define ARRAYSIZE(a) (sizeof(a)/sizeof(a[0])) |
| #endif |
| |
| /* bit map related macros */ |
| #ifndef setbit |
| #ifndef NBBY /* the BSD family defines NBBY */ |
| #define NBBY 8 /* 8 bits per byte */ |
| #endif /* #ifndef NBBY */ |
| #define setbit(a, i) (((uint8 *)a)[(i)/NBBY] |= 1<<((i)%NBBY)) |
| #define clrbit(a, i) (((uint8 *)a)[(i)/NBBY] &= ~(1<<((i)%NBBY))) |
| #define isset(a, i) (((const uint8 *)a)[(i)/NBBY] & (1<<((i)%NBBY))) |
| #define isclr(a, i) ((((const uint8 *)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) |
| |
| /* basic mux operation - can be optimized on several architectures */ |
| #define MUX(pred, true, false) ((pred) ? (true) : (false)) |
| |
| /* modulo inc/dec - assumes x E [0, bound - 1] */ |
| #define MODDEC(x, bound) MUX((x) == 0, (bound) - 1, (x) - 1) |
| #define MODINC(x, bound) MUX((x) == (bound) - 1, 0, (x) + 1) |
| |
| /* modulo inc/dec, bound = 2^k */ |
| #define MODDEC_POW2(x, bound) (((x) - 1) & ((bound) - 1)) |
| #define MODINC_POW2(x, bound) (((x) + 1) & ((bound) - 1)) |
| |
| /* modulo add/sub - assumes x, y E [0, bound - 1] */ |
| #define MODADD(x, y, bound) \ |
| MUX((x) + (y) >= (bound), (x) + (y) - (bound), (x) + (y)) |
| #define MODSUB(x, y, bound) \ |
| MUX(((int)(x)) - ((int)(y)) < 0, (x) - (y) + (bound), (x) - (y)) |
| |
| /* module add/sub, bound = 2^k */ |
| #define MODADD_POW2(x, y, bound) (((x) + (y)) & ((bound) - 1)) |
| #define MODSUB_POW2(x, y, bound) (((x) - (y)) & ((bound) - 1)) |
| |
| /* crc defines */ |
| #define CRC8_INIT_VALUE 0xff /* Initial CRC8 checksum value */ |
| #define CRC8_GOOD_VALUE 0x9f /* Good final CRC8 checksum value */ |
| #define CRC16_INIT_VALUE 0xffff /* Initial CRC16 checksum value */ |
| #define CRC16_GOOD_VALUE 0xf0b8 /* Good final CRC16 checksum value */ |
| |
| /* bcm_format_flags() bit description structure */ |
| typedef struct bcm_bit_desc { |
| uint32 bit; |
| const char *name; |
| } bcm_bit_desc_t; |
| |
| /* tag_ID/length/value_buffer tuple */ |
| typedef struct bcm_tlv { |
| uint8 id; |
| uint8 len; |
| uint8 data[1]; |
| } bcm_tlv_t; |
| |
| /* Check that bcm_tlv_t fits into the given buflen */ |
| #define bcm_valid_tlv(elt, buflen) ((buflen) >= 2 && (int)(buflen) >= (int)(2 + (elt)->len)) |
| |
| /* buffer length for ethernet address from bcm_ether_ntoa() */ |
| #define ETHER_ADDR_STR_LEN 18 /* 18-bytes of Ethernet address buffer length */ |
| |
| /* crypto utility function */ |
| /* 128-bit xor: *dst = *src1 xor *src2. dst1, src1 and src2 may have any alignment */ |
| static inline void |
| xor_128bit_block(const uint8 *src1, const uint8 *src2, uint8 *dst) { |
| if ( |
| #ifdef __i386__ |
| 1 || |
| #endif |
| (((uintptr) src1 | (uintptr) src2 | (uintptr) dst) & |
| 3) == 0) { |
| /* ARM CM3 rel time: 1229 (727 if alignment check could be omitted) */ |
| /* x86 supports unaligned. This version runs 6x-9x faster on x86. */ |
| ((uint32 *) dst)[0] = |
| ((const uint32 *)src1)[0] ^ ((const uint32 *) |
| src2)[0]; |
| ((uint32 *) dst)[1] = |
| ((const uint32 *)src1)[1] ^ ((const uint32 *) |
| src2)[1]; |
| ((uint32 *) dst)[2] = |
| ((const uint32 *)src1)[2] ^ ((const uint32 *) |
| src2)[2]; |
| ((uint32 *) dst)[3] = |
| ((const uint32 *)src1)[3] ^ ((const uint32 *) |
| src2)[3]; |
| } else { |
| /* ARM CM3 rel time: 4668 (4191 if alignment check could be omitted) */ |
| int k; |
| for (k = 0; k < 16; k++) |
| dst[k] = src1[k] ^ src2[k]; |
| } |
| } |
| |
| /* externs */ |
| /* crc */ |
| extern uint8 BCMROMFN(hndcrc8) (uint8 *p, uint nbytes, uint8 crc); |
| extern uint16 BCMROMFN(hndcrc16) (uint8 *p, uint nbytes, uint16 crc); |
| /* format/print */ |
| #if defined(BCMDBG) |
| extern int bcm_format_flags(const bcm_bit_desc_t *bd, uint32 flags, |
| char *buf, int len); |
| extern int bcm_format_hex(char *str, const void *bytes, int len); |
| #endif |
| #ifdef BCMDBG |
| extern void deadbeef(void *p, uint len); |
| #endif |
| extern const char *bcm_crypto_algo_name(uint algo); |
| extern char *bcm_chipname(uint chipid, char *buf, uint len); |
| extern char *bcm_brev_str(uint32 brev, char *buf); |
| extern void printbig(char *buf); |
| extern void prhex(const char *msg, uchar *buf, uint len); |
| |
| /* IE parsing */ |
| extern bcm_tlv_t *BCMROMFN(bcm_next_tlv) (bcm_tlv_t *elt, int *buflen); |
| extern bcm_tlv_t *BCMROMFN(bcm_parse_tlvs) (void *buf, int buflen, |
| uint key); |
| extern bcm_tlv_t *BCMROMFN(bcm_parse_ordered_tlvs) (void *buf, |
| int buflen, |
| uint key); |
| |
| /* bcmerror */ |
| extern const char *bcmerrorstr(int bcmerror); |
| |
| /* multi-bool data type: set of bools, mbool is true if any is set */ |
| typedef uint32 mbool; |
| #define mboolset(mb, bit) ((mb) |= (bit)) /* set one bool */ |
| #define mboolclr(mb, bit) ((mb) &= ~(bit)) /* clear one bool */ |
| #define mboolisset(mb, bit) (((mb) & (bit)) != 0) /* TRUE if one bool is set */ |
| #define mboolmaskset(mb, mask, val) ((mb) = (((mb) & ~(mask)) | (val))) |
| |
| /* power conversion */ |
| extern uint16 BCMROMFN(bcm_qdbm_to_mw) (uint8 qdbm); |
| extern uint8 BCMROMFN(bcm_mw_to_qdbm) (uint16 mw); |
| |
| /* generic datastruct to help dump routines */ |
| struct fielddesc { |
| const char *nameandfmt; |
| uint32 offset; |
| uint32 len; |
| }; |
| |
| extern void bcm_binit(struct bcmstrbuf *b, char *buf, uint size); |
| extern int bcm_bprintf(struct bcmstrbuf *b, const char *fmt, ...); |
| extern void bcm_inc_bytes(uchar *num, int num_bytes, uint8 amount); |
| extern int bcm_cmp_bytes(uchar *arg1, uchar *arg2, uint8 nbytes); |
| extern void bcm_print_bytes(char *name, const uchar *cdata, int len); |
| |
| typedef uint32(*bcmutl_rdreg_rtn) (void *arg0, uint arg1, |
| uint32 offset); |
| extern uint bcmdumpfields(bcmutl_rdreg_rtn func_ptr, void *arg0, |
| uint arg1, struct fielddesc *str, char *buf, |
| uint32 bufsize); |
| |
| extern uint bcm_mkiovar(char *name, char *data, uint datalen, char *buf, |
| uint len); |
| extern uint BCMROMFN(bcm_bitcount) (uint8 *bitmap, uint bytelength); |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* _bcmutils_h_ */ |