drivers/staging/brcm80211/brcmsmac/wlc_pub.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 _wlc_pub_h_
  18 #define _wlc_pub_h_
  19
  20 #define WLC_NUMRATES    16      /* max # of rates in a rateset */
  21 #define MAXMULTILIST    32      /* max # multicast addresses */
  22 #define D11_PHY_HDR_LEN 6       /* Phy header length - 6 bytes */
  23
  24 /* phy types */
  25 #define PHY_TYPE_A      0       /* Phy type A */
  26 #define PHY_TYPE_G      2       /* Phy type G */
  27 #define PHY_TYPE_N      4       /* Phy type N */
  28 #define PHY_TYPE_LP     5       /* Phy type Low Power A/B/G */
  29 #define PHY_TYPE_SSN    6       /* Phy type Single Stream N */
  30 #define PHY_TYPE_LCN    8       /* Phy type Single Stream N */
  31 #define PHY_TYPE_LCNXN  9       /* Phy type 2-stream N */
  32 #define PHY_TYPE_HT     7       /* Phy type 3-Stream N */
  33
  34 /* bw */
  35 #define WLC_10_MHZ      10      /* 10Mhz nphy channel bandwidth */
  36 #define WLC_20_MHZ      20      /* 20Mhz nphy channel bandwidth */
  37 #define WLC_40_MHZ      40      /* 40Mhz nphy channel bandwidth */
  38
  39 #define CHSPEC_WLC_BW(chanspec) (CHSPEC_IS40(chanspec) ? WLC_40_MHZ : \
  40                                  CHSPEC_IS20(chanspec) ? WLC_20_MHZ : \
  41                                                          WLC_10_MHZ)
  42
  43 #define WLC_RSSI_MINVAL         -200    /* Low value, e.g. for forcing roam */
  44 #define WLC_RSSI_NO_SIGNAL      -91     /* NDIS RSSI link quality cutoffs */
  45 #define WLC_RSSI_VERY_LOW       -80     /* Very low quality cutoffs */
  46 #define WLC_RSSI_LOW            -70     /* Low quality cutoffs */
  47 #define WLC_RSSI_GOOD           -68     /* Good quality cutoffs */
  48 #define WLC_RSSI_VERY_GOOD      -58     /* Very good quality cutoffs */
  49 #define WLC_RSSI_EXCELLENT      -57     /* Excellent quality cutoffs */
  50
  51 #define WLC_PHYTYPE(_x) (_x)    /* macro to perform WLC PHY -> D11 PHY TYPE, currently 1:1 */
  52
  53 #define MA_WINDOW_SZ            8       /* moving average window size */
  54
  55 #define WLC_SNR_INVALID         0       /* invalid SNR value */
  56
  57 /* a large TX Power as an init value to factor out of min() calculations,
  58  * keep low enough to fit in an s8, units are .25 dBm
  59  */
  60 #define WLC_TXPWR_MAX           (127)   /* ~32 dBm = 1,500 mW */
  61
  62 /* rate related definitions */
  63 #define WLC_RATE_FLAG   0x80    /* Flag to indicate it is a basic rate */
  64 #define WLC_RATE_MASK   0x7f    /* Rate value mask w/o basic rate flag */
  65
  66 /* legacy rx Antenna diversity for SISO rates */
  67 #define ANT_RX_DIV_FORCE_0              0       /* Use antenna 0 */
  68 #define ANT_RX_DIV_FORCE_1              1       /* Use antenna 1 */
  69 #define ANT_RX_DIV_START_1              2       /* Choose starting with 1 */
  70 #define ANT_RX_DIV_START_0              3       /* Choose starting with 0 */
  71 #define ANT_RX_DIV_ENABLE               3       /* APHY bbConfig Enable RX Diversity */
  72 #define ANT_RX_DIV_DEF          ANT_RX_DIV_START_0      /* default antdiv setting */
  73
  74 /* legacy rx Antenna diversity for SISO rates */
  75 #define ANT_TX_FORCE_0          0       /* Tx on antenna 0, "legacy term Main" */
  76 #define ANT_TX_FORCE_1          1       /* Tx on antenna 1, "legacy term Aux" */
  77 #define ANT_TX_LAST_RX          3       /* Tx on phy's last good Rx antenna */
  78 #define ANT_TX_DEF                      3       /* driver's default tx antenna setting */
  79
  80 #define TXCORE_POLICY_ALL       0x1     /* use all available core for transmit */
  81
  82 /* Tx Chain values */
  83 #define TXCHAIN_DEF             0x1     /* def bitmap of txchain */
  84 #define TXCHAIN_DEF_NPHY        0x3     /* default bitmap of tx chains for nphy */
  85 #define TXCHAIN_DEF_HTPHY       0x7     /* default bitmap of tx chains for nphy */
  86 #define RXCHAIN_DEF             0x1     /* def bitmap of rxchain */
  87 #define RXCHAIN_DEF_NPHY        0x3     /* default bitmap of rx chains for nphy */
  88 #define RXCHAIN_DEF_HTPHY       0x7     /* default bitmap of rx chains for nphy */
  89 #define ANTSWITCH_NONE          0       /* no antenna switch */
  90 #define ANTSWITCH_TYPE_1        1       /* antenna switch on 4321CB2, 2of3 */
  91 #define ANTSWITCH_TYPE_2        2       /* antenna switch on 4321MPCI, 2of3 */
  92 #define ANTSWITCH_TYPE_3        3       /* antenna switch on 4322, 2of3 */
  93
  94 #define RXBUFSZ         PKTBUFSZ
  95 #ifndef AIDMAPSZ
  96 #define AIDMAPSZ        (roundup(MAXSCB, NBBY)/NBBY)    /* aid bitmap size in bytes */
  97 #endif                          /* AIDMAPSZ */
  98
  99 struct ieee80211_tx_queue_params;
 100
 101 typedef struct wlc_tunables {
 102         int ntxd;               /* size of tx descriptor table */
 103         int nrxd;               /* size of rx descriptor table */
 104         int rxbufsz;            /* size of rx buffers to post */
 105         int nrxbufpost;         /* # of rx buffers to post */
 106         int maxscb;             /* # of SCBs supported */
 107         int ampdunummpdu;       /* max number of mpdu in an ampdu */
 108         int maxpktcb;           /* max # of packet callbacks */
 109         int maxucodebss;        /* max # of BSS handled in ucode bcn/prb */
 110         int maxucodebss4;       /* max # of BSS handled in sw bcn/prb */
 111         int maxbss;             /* max # of bss info elements in scan list */
 112         int datahiwat;          /* data msg txq hiwat mark */
 113         int ampdudatahiwat;     /* AMPDU msg txq hiwat mark */
 114         int rxbnd;              /* max # of rx bufs to process before deferring to dpc */
 115         int txsbnd;             /* max # tx status to process in wlc_txstatus() */
 116         int memreserved;        /* memory reserved for BMAC's USB dma rx */
 117 } wlc_tunables_t;
 118
 119 typedef struct wlc_rateset {
 120         uint count;             /* number of rates in rates[] */
 121         u8 rates[WLC_NUMRATES]; /* rates in 500kbps units w/hi bit set if basic */
 122         u8 htphy_membership;    /* HT PHY Membership */
 123         u8 mcs[MCSSET_LEN];     /* supported mcs index bit map */
 124 } wlc_rateset_t;
 125
 126 struct rsn_parms {
 127         u8 flags;               /* misc booleans (e.g., supported) */
 128         u8 multicast;   /* multicast cipher */
 129         u8 ucount;              /* count of unicast ciphers */
 130         u8 unicast[4];  /* unicast ciphers */
 131         u8 acount;              /* count of auth modes */
 132         u8 auth[4];             /* Authentication modes */
 133         u8 PAD[4];              /* padding for future growth */
 134 };
 135
 136 /*
 137  * buffer length needed for wlc_format_ssid
 138  * 32 SSID chars, max of 4 chars for each SSID char "\xFF", plus NULL.
 139  */
 140 #define SSID_FMT_BUF_LEN        ((4 * IEEE80211_MAX_SSID_LEN) + 1)
 141
 142 #define RSN_FLAGS_SUPPORTED             0x1     /* Flag for rsn_params */
 143 #define RSN_FLAGS_PREAUTH               0x2     /* Flag for WPA2 rsn_params */
 144
 145 /* All the HT-specific default advertised capabilities (including AMPDU)
 146  * should be grouped here at one place
 147  */
 148 #define AMPDU_DEF_MPDU_DENSITY  6       /* default mpdu density (110 ==> 4us) */
 149
 150 /* defaults for the HT (MIMO) bss */
 151 #define HT_CAP  (IEEE80211_HT_CAP_SM_PS |\
 152         IEEE80211_HT_CAP_SUP_WIDTH_20_40 | IEEE80211_HT_CAP_GRN_FLD |\
 153         IEEE80211_HT_CAP_MAX_AMSDU | IEEE80211_HT_CAP_DSSSCCK40)
 154
 155 /* wlc internal bss_info, wl external one is in wlioctl.h */
 156 typedef struct wlc_bss_info {
 157         u8 BSSID[ETH_ALEN];     /* network BSSID */
 158         u16 flags;              /* flags for internal attributes */
 159         u8 SSID_len;            /* the length of SSID */
 160         u8 SSID[32];            /* SSID string */
 161         s16 RSSI;               /* receive signal strength (in dBm) */
 162         s16 SNR;                /* receive signal SNR in dB */
 163         u16 beacon_period;      /* units are Kusec */
 164         u16 atim_window;        /* units are Kusec */
 165         chanspec_t chanspec;    /* Channel num, bw, ctrl_sb and band */
 166         s8 infra;               /* 0=IBSS, 1=infrastructure, 2=unknown */
 167         wlc_rateset_t rateset;  /* supported rates */
 168         u8 dtim_period; /* DTIM period */
 169         s8 phy_noise;           /* noise right after tx (in dBm) */
 170         u16 capability; /* Capability information */
 171         u8 wme_qosinfo; /* QoS Info from WME IE; valid if WLC_BSS_WME flag set */
 172         struct rsn_parms wpa;
 173         struct rsn_parms wpa2;
 174         u16 qbss_load_aac;      /* qbss load available admission capacity */
 175         /* qbss_load_chan_free <- (0xff - channel_utilization of qbss_load_ie_t) */
 176         u8 qbss_load_chan_free; /* indicates how free the channel is */
 177         u8 mcipher;             /* multicast cipher */
 178         u8 wpacfg;              /* wpa config index */
 179 } wlc_bss_info_t;
 180
 181 /* forward declarations */
 182 struct wlc_if;
 183
 184 /* wlc_ioctl error codes */
 185 #define WLC_ENOIOCTL    1       /* No such Ioctl */
 186 #define WLC_EINVAL      2       /* Invalid value */
 187 #define WLC_ETOOSMALL   3       /* Value too small */
 188 #define WLC_ETOOBIG     4       /* Value too big */
 189 #define WLC_ERANGE      5       /* Out of range */
 190 #define WLC_EDOWN       6       /* Down */
 191 #define WLC_EUP         7       /* Up */
 192 #define WLC_ENOMEM      8       /* No Memory */
 193 #define WLC_EBUSY       9       /* Busy */
 194
 195 /* IOVar flags for common error checks */
 196 #define IOVF_MFG        (1<<3)  /* flag for mfgtest iovars */
 197 #define IOVF_WHL        (1<<4)  /* value must be whole (0-max) */
 198 #define IOVF_NTRL       (1<<5)  /* value must be natural (1-max) */
 199
 200 #define IOVF_SET_UP     (1<<6)  /* set requires driver be up */
 201 #define IOVF_SET_DOWN   (1<<7)  /* set requires driver be down */
 202 #define IOVF_SET_CLK    (1<<8)  /* set requires core clock */
 203 #define IOVF_SET_BAND   (1<<9)  /* set requires fixed band */
 204
 205 #define IOVF_GET_UP     (1<<10) /* get requires driver be up */
 206 #define IOVF_GET_DOWN   (1<<11) /* get requires driver be down */
 207 #define IOVF_GET_CLK    (1<<12) /* get requires core clock */
 208 #define IOVF_GET_BAND   (1<<13) /* get requires fixed band */
 209 #define IOVF_OPEN_ALLOW (1<<14) /* set allowed iovar for opensrc */
 210
 211 /* watchdog down and dump callback function proto's */
 212 typedef int (*watchdog_fn_t) (void *handle);
 213 typedef int (*down_fn_t) (void *handle);
 214 typedef int (*dump_fn_t) (void *handle, struct bcmstrbuf *b);
 215
 216 /* IOVar handler
 217  *
 218  * handle - a pointer value registered with the function
 219  * vi - iovar_info that was looked up
 220  * actionid - action ID, calculated by IOV_GVAL() and IOV_SVAL() based on varid.
 221  * name - the actual iovar name
 222  * params/plen - parameters and length for a get, input only.
 223  * arg/len - buffer and length for value to be set or retrieved, input or output.
 224  * vsize - value size, valid for integer type only.
 225  * wlcif - interface context (wlc_if pointer)
 226  *
 227  * All pointers may point into the same buffer.
 228  */
 229 typedef int (*iovar_fn_t) (void *handle, const bcm_iovar_t *vi,
 230                            u32 actionid, const char *name, void *params,
 231                            uint plen, void *arg, int alen, int vsize,
 232                            struct wlc_if *wlcif);
 233
 234 #define MAC80211_PROMISC_BCNS   (1 << 0)
 235 #define MAC80211_SCAN           (1 << 1)
 236
 237 /*
 238  * Public portion of "common" os-independent state structure.
 239  * The wlc handle points at this.
 240  */
 241 struct wlc_pub {
 242         void *wlc;
 243
 244         struct ieee80211_hw *ieee_hw;
 245         struct scb *global_scb;
 246         scb_ampdu_t *global_ampdu;
 247         uint mac80211_state;
 248         uint unit;              /* device instance number */
 249         uint corerev;           /* core revision */
 250         si_t *sih;              /* SB handle (cookie for siutils calls) */
 251         char *vars;             /* "environment" name=value */
 252         bool up;                /* interface up and running */
 253         bool hw_off;            /* HW is off */
 254         wlc_tunables_t *tunables;       /* tunables: ntxd, nrxd, maxscb, etc. */
 255         bool hw_up;             /* one time hw up/down(from boot or hibernation) */
 256         bool _piomode;          /* true if pio mode *//* BMAC_NOTE: NEED In both */
 257         uint _nbands;           /* # bands supported */
 258         uint now;               /* # elapsed seconds */
 259
 260         bool promisc;           /* promiscuous destination address */
 261         bool delayed_down;      /* down delayed */
 262         bool _ap;               /* AP mode enabled */
 263         bool _apsta;            /* simultaneous AP/STA mode enabled */
 264         bool _assoc_recreate;   /* association recreation on up transitions */
 265         int _wme;               /* WME QoS mode */
 266         u8 _mbss;               /* MBSS mode on */
 267         bool allmulti;          /* enable all multicasts */
 268         bool associated;        /* true:part of [I]BSS, false: not */
 269         /* (union of stas_associated, aps_associated) */
 270         bool phytest_on;        /* whether a PHY test is running */
 271         bool bf_preempt_4306;   /* True to enable 'darwin' mode */
 272         bool _ampdu;            /* ampdu enabled or not */
 273         bool _cac;              /* 802.11e CAC enabled */
 274         u8 _n_enab;             /* bitmap of 11N + HT support */
 275         bool _n_reqd;           /* N support required for clients */
 276
 277         s8 _coex;               /* 20/40 MHz BSS Management AUTO, ENAB, DISABLE */
 278         bool _priofc;           /* Priority-based flowcontrol */
 279
 280         u8 cur_etheraddr[ETH_ALEN];     /* our local ethernet address */
 281
 282         u8 *multicast;  /* ptr to list of multicast addresses */
 283         uint nmulticast;        /* # enabled multicast addresses */
 284
 285         u32 wlfeatureflag;      /* Flags to control sw features from registry */
 286         int psq_pkts_total;     /* total num of ps pkts */
 287
 288         u16 txmaxpkts;  /* max number of large pkts allowed to be pending */
 289
 290         /* s/w decryption counters */
 291         u32 swdecrypt;  /* s/w decrypt attempts */
 292
 293         int bcmerror;           /* last bcm error */
 294
 295         mbool radio_disabled;   /* bit vector for radio disabled reasons */
 296         bool radio_active;      /* radio on/off state */
 297         u16 roam_time_thresh;   /* Max. # secs. of not hearing beacons
 298                                          * before roaming.
 299                                          */
 300         bool align_wd_tbtt;     /* Align watchdog with tbtt indication
 301                                  * handling. This flag is cleared by default
 302                                  * and is set by per port code explicitly and
 303                                  * you need to make sure the OSL_SYSUPTIME()
 304                                  * is implemented properly in osl of that port
 305                                  * when it enables this Power Save feature.
 306                                  */
 307
 308         u16 boardrev;   /* version # of particular board */
 309         u8 sromrev;             /* version # of the srom */
 310         char srom_ccode[WLC_CNTRY_BUF_SZ];      /* Country Code in SROM */
 311         u32 boardflags; /* Board specific flags from srom */
 312         u32 boardflags2;        /* More board flags if sromrev >= 4 */
 313         bool tempsense_disable; /* disable periodic tempsense check */
 314
 315         bool _lmac;             /* lmac module included and enabled */
 316         bool _lmacproto;        /* lmac protocol module included and enabled */
 317         bool phy_11ncapable;    /* the PHY/HW is capable of 802.11N */
 318         bool _ampdumac;         /* mac assist ampdu enabled or not */
 319
 320         struct wl_cnt *_cnt;    /* low-level counters in driver */
 321 };
 322
 323 /* wl_monitor rx status per packet */
 324 typedef struct wl_rxsts {
 325         uint pkterror;          /* error flags per pkt */
 326         uint phytype;           /* 802.11 A/B/G ... */
 327         uint channel;           /* channel */
 328         uint datarate;          /* rate in 500kbps */
 329         uint antenna;           /* antenna pkts received on */
 330         uint pktlength;         /* pkt length minus bcm phy hdr */
 331         u32 mactime;            /* time stamp from mac, count per 1us */
 332         uint sq;                /* signal quality */
 333         s32 signal;             /* in dbm */
 334         s32 noise;              /* in dbm */
 335         uint preamble;          /* Unknown, short, long */
 336         uint encoding;          /* Unknown, CCK, PBCC, OFDM */
 337         uint nfrmtype;          /* special 802.11n frames(AMPDU, AMSDU) */
 338         struct wl_if *wlif;     /* wl interface */
 339 } wl_rxsts_t;
 340
 341 /* status per error RX pkt */
 342 #define WL_RXS_CRC_ERROR                0x00000001      /* CRC Error in packet */
 343 #define WL_RXS_RUNT_ERROR               0x00000002      /* Runt packet */
 344 #define WL_RXS_ALIGN_ERROR              0x00000004      /* Misaligned packet */
 345 #define WL_RXS_OVERSIZE_ERROR           0x00000008      /* packet bigger than RX_LENGTH (usually 1518) */
 346 #define WL_RXS_WEP_ICV_ERROR            0x00000010      /* Integrity Check Value error */
 347 #define WL_RXS_WEP_ENCRYPTED            0x00000020      /* Encrypted with WEP */
 348 #define WL_RXS_PLCP_SHORT               0x00000040      /* Short PLCP error */
 349 #define WL_RXS_DECRYPT_ERR              0x00000080      /* Decryption error */
 350 #define WL_RXS_OTHER_ERR                0x80000000      /* Other errors */
 351
 352 /* phy type */
 353 #define WL_RXS_PHY_A                    0x00000000      /* A phy type */
 354 #define WL_RXS_PHY_B                    0x00000001      /* B phy type */
 355 #define WL_RXS_PHY_G                    0x00000002      /* G phy type */
 356 #define WL_RXS_PHY_N                    0x00000004      /* N phy type */
 357
 358 /* encoding */
 359 #define WL_RXS_ENCODING_CCK             0x00000000      /* CCK encoding */
 360 #define WL_RXS_ENCODING_OFDM            0x00000001      /* OFDM encoding */
 361
 362 /* preamble */
 363 #define WL_RXS_UNUSED_STUB              0x0     /* stub to match with wlc_ethereal.h */
 364 #define WL_RXS_PREAMBLE_SHORT           0x00000001      /* Short preamble */
 365 #define WL_RXS_PREAMBLE_LONG            0x00000002      /* Long preamble */
 366 #define WL_RXS_PREAMBLE_MIMO_MM         0x00000003      /* MIMO mixed mode preamble */
 367 #define WL_RXS_PREAMBLE_MIMO_GF         0x00000004      /* MIMO green field preamble */
 368
 369 #define WL_RXS_NFRM_AMPDU_FIRST         0x00000001      /* first MPDU in A-MPDU */
 370 #define WL_RXS_NFRM_AMPDU_SUB           0x00000002      /* subsequent MPDU(s) in A-MPDU */
 371 #define WL_RXS_NFRM_AMSDU_FIRST         0x00000004      /* first MSDU in A-MSDU */
 372 #define WL_RXS_NFRM_AMSDU_SUB           0x00000008      /* subsequent MSDU(s) in A-MSDU */
 373
 374 /* forward declare and use the struct notation so we don't have to
 375  * have it defined if not necessary.
 376  */
 377 struct wlc_info;
 378 struct wlc_hw_info;
 379 struct wlc_bsscfg;
 380 struct wlc_if;
 381
 382 /***********************************************
 383  * Feature-related macros to optimize out code *
 384  * *********************************************
 385  */
 386
 387 /* AP Support (versus STA) */
 388 #define AP_ENAB(pub)    (0)
 389
 390 /* Macro to check if APSTA mode enabled */
 391 #define APSTA_ENAB(pub) (0)
 392
 393 /* Some useful combinations */
 394 #define STA_ONLY(pub)   (!AP_ENAB(pub))
 395 #define AP_ONLY(pub)    (AP_ENAB(pub) && !APSTA_ENAB(pub))
 396
 397 #define ENAB_1x1        0x01
 398 #define ENAB_2x2        0x02
 399 #define ENAB_3x3        0x04
 400 #define ENAB_4x4        0x08
 401 #define SUPPORT_11N     (ENAB_1x1|ENAB_2x2)
 402 #define SUPPORT_HT      (ENAB_1x1|ENAB_2x2|ENAB_3x3)
 403 /* WL11N Support */
 404 #if ((defined(NCONF) && (NCONF != 0)) || (defined(LCNCONF) && (LCNCONF != 0)) || \
 405         (defined(HTCONF) && (HTCONF != 0)) || (defined(SSLPNCONF) && (SSLPNCONF != 0)))
 406 #define N_ENAB(pub) ((pub)->_n_enab & SUPPORT_11N)
 407 #define N_REQD(pub) ((pub)->_n_reqd)
 408 #else
 409 #define N_ENAB(pub)     0
 410 #define N_REQD(pub)     0
 411 #endif
 412
 413 #if (defined(HTCONF) && (HTCONF != 0))
 414 #define HT_ENAB(pub) (((pub)->_n_enab & SUPPORT_HT) == SUPPORT_HT)
 415 #else
 416 #define HT_ENAB(pub) 0
 417 #endif
 418
 419 #define AMPDU_AGG_HOST  1
 420 #define AMPDU_ENAB(pub) ((pub)->_ampdu)
 421
 422 #define EDCF_ENAB(pub) (WME_ENAB(pub))
 423 #define QOS_ENAB(pub) (WME_ENAB(pub) || N_ENAB(pub))
 424
 425 #define MONITOR_ENAB(wlc)       ((wlc)->monitor)
 426
 427 #define PROMISC_ENAB(wlc)       ((wlc)->promisc)
 428
 429 #define WLC_PREC_COUNT          16      /* Max precedence level implemented */
 430
 431 /* pri is priority encoded in the packet. This maps the Packet priority to
 432  * enqueue precedence as defined in wlc_prec_map
 433  */
 434 extern const u8 wlc_prio2prec_map[];
 435 #define WLC_PRIO_TO_PREC(pri)   wlc_prio2prec_map[(pri) & 7]
 436
 437 /* This maps priority to one precedence higher - Used by PS-Poll response packets to
 438  * simulate enqueue-at-head operation, but still maintain the order on the queue
 439  */
 440 #define WLC_PRIO_TO_HI_PREC(pri)        min(WLC_PRIO_TO_PREC(pri) + 1, WLC_PREC_COUNT - 1)
 441
 442 extern const u8 wme_fifo2ac[];
 443 #define WME_PRIO2AC(prio)       wme_fifo2ac[prio2fifo[(prio)]]
 444
 445 /* Mask to describe all precedence levels */
 446 #define WLC_PREC_BMP_ALL                MAXBITVAL(WLC_PREC_COUNT)
 447
 448 /* Define a bitmap of precedences comprised by each AC */
 449 #define WLC_PREC_BMP_AC_BE      (NBITVAL(WLC_PRIO_TO_PREC(PRIO_8021D_BE)) |     \
 450                                 NBITVAL(WLC_PRIO_TO_HI_PREC(PRIO_8021D_BE)) |   \
 451                                 NBITVAL(WLC_PRIO_TO_PREC(PRIO_8021D_EE)) |      \
 452                                 NBITVAL(WLC_PRIO_TO_HI_PREC(PRIO_8021D_EE)))
 453 #define WLC_PREC_BMP_AC_BK      (NBITVAL(WLC_PRIO_TO_PREC(PRIO_8021D_BK)) |     \
 454                                 NBITVAL(WLC_PRIO_TO_HI_PREC(PRIO_8021D_BK)) |   \
 455                                 NBITVAL(WLC_PRIO_TO_PREC(PRIO_8021D_NONE)) |    \
 456                                 NBITVAL(WLC_PRIO_TO_HI_PREC(PRIO_8021D_NONE)))
 457 #define WLC_PREC_BMP_AC_VI      (NBITVAL(WLC_PRIO_TO_PREC(PRIO_8021D_CL)) |     \
 458                                 NBITVAL(WLC_PRIO_TO_HI_PREC(PRIO_8021D_CL)) |   \
 459                                 NBITVAL(WLC_PRIO_TO_PREC(PRIO_8021D_VI)) |      \
 460                                 NBITVAL(WLC_PRIO_TO_HI_PREC(PRIO_8021D_VI)))
 461 #define WLC_PREC_BMP_AC_VO      (NBITVAL(WLC_PRIO_TO_PREC(PRIO_8021D_VO)) |     \
 462                                 NBITVAL(WLC_PRIO_TO_HI_PREC(PRIO_8021D_VO)) |   \
 463                                 NBITVAL(WLC_PRIO_TO_PREC(PRIO_8021D_NC)) |      \
 464                                 NBITVAL(WLC_PRIO_TO_HI_PREC(PRIO_8021D_NC)))
 465
 466 /* WME Support */
 467 #define WME_ENAB(pub) ((pub)->_wme != OFF)
 468 #define WME_AUTO(wlc) ((wlc)->pub->_wme == AUTO)
 469
 470 #define WLC_USE_COREFLAGS       0xffffffff      /* invalid core flags, use the saved coreflags */
 471
 472
 473 /* network protection config */
 474 #define WLC_PROT_G_SPEC         1       /* SPEC g protection */
 475 #define WLC_PROT_G_OVR          2       /* SPEC g prot override */
 476 #define WLC_PROT_G_USER         3       /* gmode specified by user */
 477 #define WLC_PROT_OVERLAP        4       /* overlap */
 478 #define WLC_PROT_N_USER         10      /* nmode specified by user */
 479 #define WLC_PROT_N_CFG          11      /* n protection */
 480 #define WLC_PROT_N_CFG_OVR      12      /* n protection override */
 481 #define WLC_PROT_N_NONGF        13      /* non-GF protection */
 482 #define WLC_PROT_N_NONGF_OVR    14      /* non-GF protection override */
 483 #define WLC_PROT_N_PAM_OVR      15      /* n preamble override */
 484 #define WLC_PROT_N_OBSS         16      /* non-HT OBSS present */
 485
 486 /* common functions for every port */
 487 extern void *wlc_attach(struct wl_info *wl, u16 vendor, u16 device, uint unit,
 488                         bool piomode, void *regsva, uint bustype, void *btparam,
 489                         uint *perr);
 490 extern uint wlc_detach(struct wlc_info *wlc);
 491 extern int wlc_up(struct wlc_info *wlc);
 492 extern uint wlc_down(struct wlc_info *wlc);
 493
 494 extern int wlc_set(struct wlc_info *wlc, int cmd, int arg);
 495 extern int wlc_get(struct wlc_info *wlc, int cmd, int *arg);
 496 extern int wlc_iovar_getint(struct wlc_info *wlc, const char *name, int *arg);
 497 extern int wlc_iovar_setint(struct wlc_info *wlc, const char *name, int arg);
 498 extern bool wlc_chipmatch(u16 vendor, u16 device);
 499 extern void wlc_init(struct wlc_info *wlc);
 500 extern void wlc_reset(struct wlc_info *wlc);
 501
 502 extern void wlc_intrson(struct wlc_info *wlc);
 503 extern u32 wlc_intrsoff(struct wlc_info *wlc);
 504 extern void wlc_intrsrestore(struct wlc_info *wlc, u32 macintmask);
 505 extern bool wlc_intrsupd(struct wlc_info *wlc);
 506 extern bool wlc_isr(struct wlc_info *wlc, bool *wantdpc);
 507 extern bool wlc_dpc(struct wlc_info *wlc, bool bounded);
 508 extern bool wlc_sendpkt_mac80211(struct wlc_info *wlc, struct sk_buff *sdu,
 509                                  struct ieee80211_hw *hw);
 510 extern int wlc_iovar_op(struct wlc_info *wlc, const char *name, void *params,
 511                         int p_len, void *arg, int len, bool set,
 512                         struct wlc_if *wlcif);
 513 extern int wlc_ioctl(struct wlc_info *wlc, int cmd, void *arg, int len,
 514                      struct wlc_if *wlcif);
 515 extern bool wlc_aggregatable(struct wlc_info *wlc, u8 tid);
 516
 517 /* helper functions */
 518 extern void wlc_statsupd(struct wlc_info *wlc);
 519 extern void wlc_protection_upd(struct wlc_info *wlc, uint idx, int val);
 520 extern int wlc_get_header_len(void);
 521 extern void wlc_mac_bcn_promisc_change(struct wlc_info *wlc, bool promisc);
 522 extern void wlc_set_addrmatch(struct wlc_info *wlc, int match_reg_offset,
 523                               const u8 *addr);
 524 extern void wlc_wme_setparams(struct wlc_info *wlc, u16 aci,
 525                               const struct ieee80211_tx_queue_params *arg,
 526                               bool suspend);
 527 extern struct wlc_pub *wlc_pub(void *wlc);
 528
 529 /* common functions for every port */
 530 extern void wlc_mhf(struct wlc_info *wlc, u8 idx, u16 mask, u16 val,
 531                     int bands);
 532 extern void wlc_rate_lookup_init(struct wlc_info *wlc, wlc_rateset_t *rateset);
 533 extern void wlc_default_rateset(struct wlc_info *wlc, wlc_rateset_t *rs);
 534
 535 struct ieee80211_sta;
 536 extern void wlc_ampdu_flush(struct wlc_info *wlc, struct ieee80211_sta *sta,
 537                             u16 tid);
 538
 539 /* wlc_phy.c helper functions */
 540 extern void wlc_set_ps_ctrl(struct wlc_info *wlc);
 541 extern void wlc_mctrl(struct wlc_info *wlc, u32 mask, u32 val);
 542
 543 /* ioctl */
 544 extern int wlc_iovar_check(struct wlc_pub *pub, const bcm_iovar_t *vi,
 545                            void *arg,
 546                            int len, bool set);
 547
 548 extern int wlc_module_register(struct wlc_pub *pub, const bcm_iovar_t *iovars,
 549                                const char *name, void *hdl, iovar_fn_t iovar_fn,
 550                                watchdog_fn_t watchdog_fn, down_fn_t down_fn);
 551 extern int wlc_module_unregister(struct wlc_pub *pub, const char *name,
 552                                  void *hdl);
 553 extern void wlc_suspend_mac_and_wait(struct wlc_info *wlc);
 554 extern void wlc_enable_mac(struct wlc_info *wlc);
 555 extern void wlc_associate_upd(struct wlc_info *wlc, bool state);
 556 extern void wlc_scan_start(struct wlc_info *wlc);
 557 extern void wlc_scan_stop(struct wlc_info *wlc);
 558 extern int wlc_get_curband(struct wlc_info *wlc);
 559 extern void wlc_wait_for_tx_completion(struct wlc_info *wlc, bool drop);
 560
 561 #if defined(BCMDBG)
 562 extern int wlc_iocregchk(struct wlc_info *wlc, uint band);
 563 #endif
 564
 565 /* helper functions */
 566 extern bool wlc_check_radio_disabled(struct wlc_info *wlc);
 567 extern bool wlc_radio_monitor_stop(struct wlc_info *wlc);
 568
 569 #if defined(BCMDBG)
 570 extern int wlc_format_ssid(char *buf, const unsigned char ssid[], uint ssid_len);
 571 #endif
 572
 573 #define MAXBANDS                2       /* Maximum #of bands */
 574 /* bandstate array indices */
 575 #define BAND_2G_INDEX           0       /* wlc->bandstate[x] index */
 576 #define BAND_5G_INDEX           1       /* wlc->bandstate[x] index */
 577
 578 #define BAND_2G_NAME            "2.4G"
 579 #define BAND_5G_NAME            "5G"
 580
 581 /* BMAC RPC: 7 u32 params: pkttotlen, fifo, commit, fid, txpktpend, pktflag, rpc_id */
 582 #define WLC_RPCTX_PARAMS                32
 583
 584 #endif                          /* _wlc_pub_h_ */