/* * Misc useful os-independent macros and functions. * * Copyright (C) 1999-2013, Broadcom Corporation * * Unless you and Broadcom execute a separate written software license * agreement governing use of this software, this software is licensed to you * under the terms of the GNU General Public License version 2 (the "GPL"), * available at http://www.broadcom.com/licenses/GPLv2.php, with the * following added to such license: * * As a special exception, the copyright holders of this software give you * permission to link this software with independent modules, and to copy and * distribute the resulting executable under terms of your choice, provided that * you also meet, for each linked independent module, the terms and conditions of * the license of that module. An independent module is a module which is not * derived from this software. The special exception does not apply to any * modifications of the software. * * Notwithstanding the above, under no circumstances may you combine this * software in any way with any other Broadcom software provided under a license * other than the GPL, without Broadcom's express prior written consent. * * $Id: bcmutils.h 382763 2013-02-04 10:21:08Z $ */ #ifndef _bcmutils_h_ #define _bcmutils_h_ #define bcm_strcpy_s(dst, noOfElements, src) strcpy((dst), (src)) #define bcm_strncpy_s(dst, noOfElements, src, count) strncpy((dst), (src), (count)) #define bcm_strcat_s(dst, noOfElements, src) strcat((dst), (src)) #ifdef __cplusplus extern "C" { #endif #ifdef PKTQ_LOG #include #endif /* 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)) /* 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 ** */ #ifdef BCMDRIVER #include #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; #ifdef PKTQ_LOG typedef struct { uint32 requested; /* packets requested to be stored */ uint32 stored; /* packets stored */ uint32 saved; /* packets saved, because a lowest priority queue has given away one packet */ uint32 selfsaved; /* packets saved, because an older packet from the same queue has been dropped */ uint32 full_dropped; /* packets dropped, because pktq is full with higher precedence packets */ uint32 dropped; /* packets dropped because pktq per that precedence is full */ uint32 sacrificed; /* packets dropped, in order to save one from a queue of a highest priority */ uint32 busy; /* packets droped because of hardware/transmission error */ uint32 retry; /* packets re-sent because they were not received */ uint32 ps_retry; /* packets retried again prior to moving power save mode */ uint32 retry_drop; /* packets finally dropped after retry limit */ uint32 max_avail; /* the high-water mark of the queue capacity for packets - goes to zero as queue fills */ uint32 max_used; /* the high-water mark of the queue utilisation for packets - increases with use ('inverse' of max_avail) */ uint32 queue_capacity; /* the maximum capacity of the queue */ uint32 rtsfail; /* count of rts attempts that failed to receive cts */ uint32 acked; /* count of packets sent (acked) successfully */ } pktq_counters_t; #endif /* PKTQ_LOG */ #define PKTQ_COMMON \ 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 */ /* multi-priority pkt queue */ struct pktq { PKTQ_COMMON /* q array must be last since # of elements can be either PKTQ_MAX_PREC or 1 */ struct pktq_prec q[PKTQ_MAX_PREC]; #ifdef PKTQ_LOG pktq_counters_t _prec_cnt[PKTQ_MAX_PREC]; /* Counters per queue */ pktq_counters_t _prec_bytes[PKTQ_MAX_PREC]; /* Byte count per queue */ uint32 _logtime; /* timestamp of last counter clear */ #endif }; /* simple, non-priority pkt queue */ struct spktq { PKTQ_COMMON /* 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); #ifdef BCMPKTPOOL #define POOL_ENAB(pool) ((pool) && (pool)->inited) #define SHARED_POOL (pktpool_shared) #else /* BCMPKTPOOL */ #define POOL_ENAB(bus) 0 #define SHARED_POOL ((struct pktpool *)NULL) #endif /* BCMPKTPOOL */ #ifndef PKTPOOL_LEN_MAX #define PKTPOOL_LEN_MAX 40 #endif /* PKTPOOL_LEN_MAX */ #define PKTPOOL_CB_MAX 3 struct pktpool; typedef void (*pktpool_cb_t)(struct pktpool *pool, void *arg); typedef struct { pktpool_cb_t cb; void *arg; } pktpool_cbinfo_t; #ifdef BCMDBG_POOL /* pkt pool debug states */ #define POOL_IDLE 0 #define POOL_RXFILL 1 #define POOL_RXDH 2 #define POOL_RXD11 3 #define POOL_TXDH 4 #define POOL_TXD11 5 #define POOL_AMPDU 6 #define POOL_TXENQ 7 typedef struct { void *p; uint32 cycles; uint32 dur; } pktpool_dbg_t; typedef struct { uint8 txdh; /* tx to host */ uint8 txd11; /* tx to d11 */ uint8 enq; /* waiting in q */ uint8 rxdh; /* rx from host */ uint8 rxd11; /* rx from d11 */ uint8 rxfill; /* dma_rxfill */ uint8 idle; /* avail in pool */ } pktpool_stats_t; #endif /* BCMDBG_POOL */ typedef struct pktpool { bool inited; uint16 r; uint16 w; uint16 len; uint16 maxlen; uint16 plen; bool istx; bool empty; uint8 cbtoggle; uint8 cbcnt; uint8 ecbcnt; bool emptycb_disable; pktpool_cbinfo_t *availcb_excl; pktpool_cbinfo_t cbs[PKTPOOL_CB_MAX]; pktpool_cbinfo_t ecbs[PKTPOOL_CB_MAX]; void *q[PKTPOOL_LEN_MAX + 1]; #ifdef BCMDBG_POOL uint8 dbg_cbcnt; pktpool_cbinfo_t dbg_cbs[PKTPOOL_CB_MAX]; uint16 dbg_qlen; pktpool_dbg_t dbg_q[PKTPOOL_LEN_MAX + 1]; #endif } pktpool_t; extern pktpool_t *pktpool_shared; extern int pktpool_init(osl_t *osh, pktpool_t *pktp, int *pktplen, int plen, bool istx); extern int pktpool_deinit(osl_t *osh, pktpool_t *pktp); extern int pktpool_fill(osl_t *osh, pktpool_t *pktp, bool minimal); extern void* pktpool_get(pktpool_t *pktp); extern void pktpool_free(pktpool_t *pktp, void *p); extern int pktpool_add(pktpool_t *pktp, void *p); extern uint16 pktpool_avail(pktpool_t *pktp); extern int pktpool_avail_notify_normal(osl_t *osh, pktpool_t *pktp); extern int pktpool_avail_notify_exclusive(osl_t *osh, pktpool_t *pktp, pktpool_cb_t cb); extern int pktpool_avail_register(pktpool_t *pktp, pktpool_cb_t cb, void *arg); extern int pktpool_empty_register(pktpool_t *pktp, pktpool_cb_t cb, void *arg); extern int pktpool_setmaxlen(pktpool_t *pktp, uint16 maxlen); extern int pktpool_setmaxlen_strict(osl_t *osh, pktpool_t *pktp, uint16 maxlen); extern void pktpool_emptycb_disable(pktpool_t *pktp, bool disable); extern bool pktpool_emptycb_disabled(pktpool_t *pktp); #define POOLPTR(pp) ((pktpool_t *)(pp)) #define pktpool_len(pp) (POOLPTR(pp)->len - 1) #define pktpool_plen(pp) (POOLPTR(pp)->plen) #define pktpool_maxlen(pp) (POOLPTR(pp)->maxlen) #ifdef BCMDBG_POOL extern int pktpool_dbg_register(pktpool_t *pktp, pktpool_cb_t cb, void *arg); extern int pktpool_start_trigger(pktpool_t *pktp, void *p); extern int pktpool_dbg_dump(pktpool_t *pktp); extern int pktpool_dbg_notify(pktpool_t *pktp); extern int pktpool_stats_dump(pktpool_t *pktp, pktpool_stats_t *stats); #endif /* BCMDBG_POOL */ /* 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_pmax(pq, prec) ((pq)->q[prec].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_prev(struct pktq *pq, int prec, void *prev_p); extern void *pktq_pdeq_with_fn(struct pktq *pq, int prec, ifpkt_cb_t fn, int arg); extern void *pktq_pdeq_tail(struct pktq *pq, int prec); /* Empty the queue at particular precedence level */ extern void pktq_pflush(osl_t *osh, struct pktq *pq, int prec, bool dir, ifpkt_cb_t fn, int arg); /* 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); extern void *pktq_mpeek(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 *)(void *)pq), 0, (p)) #define pktenq_head(pq, p) pktq_penq_head(((struct pktq *)(void *)pq), 0, (p)) #define pktdeq(pq) pktq_pdeq(((struct pktq *)(void *)pq), 0) #define pktdeq_tail(pq) pktq_pdeq_tail(((struct pktq *)(void *)pq), 0) #define pktqinit(pq, len) pktq_init(((struct pktq *)(void *)pq), 1, len) extern void pktq_init(struct pktq *pq, int num_prec, int max_len); extern void pktq_set_max_plen(struct pktq *pq, int 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); extern void pktq_flush(osl_t *osh, struct pktq *pq, bool dir, ifpkt_cb_t fn, int arg); /* 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); extern uint pktsegcnt_war(osl_t *osh, void *p); extern uint8 *pktdataoffset(osl_t *osh, void *p, uint offset); extern void *pktoffset(osl_t *osh, void *p, uint offset); /* Get priority from a packet and pass it back in scb (or equiv) */ #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 */ /* DSCP type definitions (RFC4594) */ /* AF1x: High-Throughput Data (RFC2597) */ #define DSCP_AF11 0x0A #define DSCP_AF12 0x0C #define DSCP_AF13 0x0E /* AF2x: Low-Latency Data (RFC2597) */ #define DSCP_AF21 0x12 #define DSCP_AF22 0x14 #define DSCP_AF23 0x16 /* AF3x: Multimedia Streaming (RFC2597) */ #define DSCP_AF31 0x1A #define DSCP_AF32 0x1C #define DSCP_AF33 0x1E /* EF: Telephony (RFC3246) */ #define DSCP_EF 0x2E extern uint pktsetprio(void *pkt, bool update_vtag); /* string */ extern int bcm_atoi(const char *s); extern ulong bcm_strtoul(const char *cp, char **endp, uint base); extern char *bcmstrstr(const char *haystack, const char *needle); extern char *bcmstrcat(char *dest, const char *src); extern char *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); /* ethernet address */ extern char *bcm_ether_ntoa(const struct ether_addr *ea, char *buf); extern int bcm_ether_atoe(const char *p, struct ether_addr *ea); /* ip address */ struct ipv4_addr; extern char *bcm_ip_ntoa(struct ipv4_addr *ia, char *buf); extern int bcm_atoipv4(const char *p, struct ipv4_addr *ip); /* delay */ extern void bcm_mdelay(uint ms); /* variable access */ #define NVRAM_RECLAIM_CHECK(name) extern char *getvar(char *vars, const char *name); extern int getintvar(char *vars, const char *name); extern int getintvararray(char *vars, const char *name, int index); extern int getintvararraysize(char *vars, const char *name); extern uint getgpiopin(char *vars, char *pin_name, uint def_pin); #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) #define bcmdumptslog(buf, size) 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(WLTINYDUMP) || defined(WLMSG_INFORM) || defined(WLMSG_ASSOC) || \ defined(WLMSG_PRPKT) || defined(WLMSG_WSEC) extern int bcm_format_ssid(char* buf, const uchar ssid[], uint ssid_len); #endif #endif /* BCMDRIVER */ /* 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_SCANREJECT -43 /* reject scan request */ #define BCME_USAGE_ERROR -44 /* WLCMD usage error */ #define BCME_IOCTL_ERROR -45 /* WLCMD ioctl error */ #define BCME_SERIAL_PORT_ERR -46 /* RWL serial port error */ #define BCME_LAST BCME_SERIAL_PORT_ERR /* 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", \ "Scan Rejected", \ "WLCMD usage error", \ "WLCMD ioctl error", \ "RWL serial port error", \ } #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 */ /* limit to [min, max] */ #ifndef LIMIT_TO_RANGE #define LIMIT_TO_RANGE(x, min, max) \ ((x) < (min) ? (min) : ((x) > (max) ? (max) : (x))) #endif /* LIMIT_TO_RANGE */ /* limit to max */ #ifndef LIMIT_TO_MAX #define LIMIT_TO_MAX(x, max) \ (((x) > (max) ? (max) : (x))) #endif /* LIMIT_TO_MAX */ /* limit to min */ #ifndef LIMIT_TO_MIN #define LIMIT_TO_MIN(x, min) \ (((x) < (min) ? (min) : (x))) #endif /* LIMIT_TO_MIN */ #define CEIL(x, y) (((x) + ((y) - 1)) / (y)) #define ROUNDUP(x, y) ((((x) + ((y) - 1)) / (y)) * (y)) #define ISALIGNED(a, x) (((uintptr)(a) & ((x) - 1)) == 0) #define ALIGN_ADDR(addr, boundary) (void *)(((uintptr)(addr) + (boundary) - 1) \ & ~((boundary) - 1)) #define ALIGN_SIZE(size, boundary) (((size) + (boundary) - 1) \ & ~((boundary) - 1)) #define ISPOWEROF2(x) ((((x) - 1) & (x)) == 0) #define VALID_MASK(mask) !((mask) & ((mask) + 1)) #ifndef OFFSETOF #ifdef __ARMCC_VERSION /* * The ARM RVCT compiler complains when using OFFSETOF where a constant * expression is expected, such as an initializer for a static object. * offsetof from the runtime library doesn't have that problem. */ #include #define OFFSETOF(type, member) offsetof(type, member) #else #define OFFSETOF(type, member) ((uint)(uintptr)&((type *)0)->member) #endif /* __ARMCC_VERSION */ #endif /* OFFSETOF */ #ifndef ARRAYSIZE #define ARRAYSIZE(a) (sizeof(a) / sizeof(a[0])) #endif #ifndef ARRAYLAST /* returns pointer to last array element */ #define ARRAYLAST(a) (&a[ARRAYSIZE(a)-1]) #endif /* Reference a function; used to prevent a static function from being optimized out */ extern void *_bcmutils_dummy_fn; #define REFERENCE_FUNCTION(f) (_bcmutils_dummy_fn = (void *)(f)) /* bit map related macros */ #ifndef setbit #ifndef NBBY /* the BSD family defines NBBY */ #define NBBY 8 /* 8 bits per byte */ #endif /* #ifndef NBBY */ #ifdef BCMUTILS_BIT_MACROS_USE_FUNCS extern void setbit(void *array, uint bit); extern void clrbit(void *array, uint bit); extern bool isset(const void *array, uint bit); extern bool isclr(const void *array, uint bit); #else #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 #endif /* setbit */ #define isbitset(a, i) (((a) & (1 << (i))) != 0) #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 */ #define CRC32_INIT_VALUE 0xffffffff /* Initial CRC32 checksum value */ #define CRC32_GOOD_VALUE 0xdebb20e3 /* Good final CRC32 checksum value */ /* use for direct output of MAC address in printf etc */ #define MACF "%02x:%02x:%02x:%02x:%02x:%02x" #define ETHERP_TO_MACF(ea) ((struct ether_addr *) (ea))->octet[0], \ ((struct ether_addr *) (ea))->octet[1], \ ((struct ether_addr *) (ea))->octet[2], \ ((struct ether_addr *) (ea))->octet[3], \ ((struct ether_addr *) (ea))->octet[4], \ ((struct ether_addr *) (ea))->octet[5] #define ETHER_TO_MACF(ea) (ea).octet[0], \ (ea).octet[1], \ (ea).octet[2], \ (ea).octet[3], \ (ea).octet[4], \ (ea).octet[5] #if !defined(SIMPLE_MAC_PRINT) #define MACDBG "%02x:%02x:%02x:%02x:%02x:%02x" #define MAC2STRDBG(ea) (ea)[0], (ea)[1], (ea)[2], (ea)[3], (ea)[4], (ea)[5] #else #define MACDBG "%02x:%02x:%02x" #define MAC2STRDBG(ea) (ea)[0], (ea)[4], (ea)[5] #endif /* SIMPLE_MAC_PRINT */ /* bcm_format_flags() bit description structure */ typedef struct bcm_bit_desc { uint32 bit; const char* name; } bcm_bit_desc_t; /* bcm_format_field */ typedef struct bcm_bit_desc_ex { uint32 mask; const bcm_bit_desc_t *bitfield; } bcm_bit_desc_ex_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 hndcrc8(uint8 *p, uint nbytes, uint8 crc); extern uint16 hndcrc16(uint8 *p, uint nbytes, uint16 crc); extern uint32 hndcrc32(uint8 *p, uint nbytes, uint32 crc); /* format/print */ #if defined(DHD_DEBUG) || defined(WLMSG_PRHDRS) || defined(WLMSG_PRPKT) || \ defined(WLMSG_ASSOC) /* print out the value a field has: fields may have 1-32 bits and may hold any value */ extern int bcm_format_field(const bcm_bit_desc_ex_t *bd, uint32 field, char* buf, int len); /* print out which bits in flags are set */ extern int bcm_format_flags(const bcm_bit_desc_t *bd, uint32 flags, char* buf, int len); #endif #if defined(DHD_DEBUG) || defined(WLMSG_PRHDRS) || defined(WLMSG_PRPKT) || \ defined(WLMSG_ASSOC) || defined(WLMEDIA_PEAKRATE) extern int bcm_format_hex(char *str, const void *bytes, int 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 *bcm_next_tlv(bcm_tlv_t *elt, int *buflen); extern bcm_tlv_t *bcm_parse_tlvs(void *buf, int buflen, uint key); extern bcm_tlv_t *bcm_parse_ordered_tlvs(void *buf, int buflen, uint key); /* bcmerror */ extern const char *bcmerrorstr(int bcmerror); /* extern bcm_tlv_t *bcm_parse_tlvs(void *buf, int buflen, uint key); */ /* 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))) /* 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 void bcm_bprhex(struct bcmstrbuf *b, const char *msg, bool newline, uint8 *buf, int len); extern void bcm_inc_bytes(uchar *num, int num_bytes, uint8 amount); extern int bcm_cmp_bytes(const uchar *arg1, const uchar *arg2, uint8 nbytes); extern void bcm_print_bytes(const 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_bitcount(uint8 *bitmap, uint bytelength); extern int bcm_bprintf(struct bcmstrbuf *b, const char *fmt, ...); /* power conversion */ extern uint16 bcm_qdbm_to_mw(uint8 qdbm); extern uint8 bcm_mw_to_qdbm(uint16 mw); extern uint bcm_mkiovar(char *name, char *data, uint datalen, char *buf, uint len); unsigned int process_nvram_vars(char *varbuf, unsigned int len); extern bcm_tlv_t *find_vendor_ie(void *tlvs, int tlvs_len, const char *voui, uint8 *type, int type_len); /* calculate a * b + c */ extern void bcm_uint64_multiple_add(uint32* r_high, uint32* r_low, uint32 a, uint32 b, uint32 c); /* calculate a / b */ extern void bcm_uint64_divide(uint32* r, uint32 a_high, uint32 a_low, uint32 b); /* return chip ID */ #if defined(SUPPORT_MULTIPLE_REVISION) extern uint bcm_get_chip_id(void); #endif /* SUPPORT_MULTIPLE_REVISION */ #ifdef __cplusplus } #endif #endif /* _bcmutils_h_ */