drivers/net/wireless/brcm80211/include/brcmu_wifi.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 _BRCMU_WIFI_H_
  18 #define _BRCMU_WIFI_H_
  19
  20 #include <linux/if_ether.h>             /* for ETH_ALEN */
  21 #include <linux/ieee80211.h>            /* for WLAN_PMKID_LEN */
  22
  23 /*
  24  * A chanspec (u16) holds the channel number, band, bandwidth and control
  25  * sideband
  26  */
  27
  28 /* channel defines */
  29 #define CH_UPPER_SB                     0x01
  30 #define CH_LOWER_SB                     0x02
  31 #define CH_EWA_VALID                    0x04
  32 #define CH_30MHZ_APART                  6
  33 #define CH_20MHZ_APART                  4
  34 #define CH_10MHZ_APART                  2
  35 #define CH_5MHZ_APART                   1 /* 2G band channels are 5 Mhz apart */
  36 #define CH_MIN_2G_CHANNEL               1
  37 #define CH_MAX_2G_CHANNEL               14      /* Max channel in 2G band */
  38 #define CH_MIN_5G_CHANNEL               34
  39
  40 /* bandstate array indices */
  41 #define BAND_2G_INDEX           0       /* wlc->bandstate[x] index */
  42 #define BAND_5G_INDEX           1       /* wlc->bandstate[x] index */
  43
  44 /*
  45  * max # supported channels. The max channel no is 216, this is that + 1
  46  * rounded up to a multiple of NBBY (8). DO NOT MAKE it > 255: channels are
  47  * u8's all over
  48 */
  49 #define MAXCHANNEL              224
  50
  51 #define WL_CHANSPEC_CHAN_MASK           0x00ff
  52 #define WL_CHANSPEC_CHAN_SHIFT          0
  53
  54 #define WL_CHANSPEC_CTL_SB_MASK         0x0300
  55 #define WL_CHANSPEC_CTL_SB_SHIFT             8
  56 #define WL_CHANSPEC_CTL_SB_LOWER        0x0100
  57 #define WL_CHANSPEC_CTL_SB_UPPER        0x0200
  58 #define WL_CHANSPEC_CTL_SB_NONE         0x0300
  59
  60 #define WL_CHANSPEC_BW_MASK             0x0C00
  61 #define WL_CHANSPEC_BW_SHIFT                10
  62 #define WL_CHANSPEC_BW_10               0x0400
  63 #define WL_CHANSPEC_BW_20               0x0800
  64 #define WL_CHANSPEC_BW_40               0x0C00
  65 #define WL_CHANSPEC_BW_80               0x2000
  66
  67 #define WL_CHANSPEC_BAND_MASK           0xf000
  68 #define WL_CHANSPEC_BAND_SHIFT          12
  69 #define WL_CHANSPEC_BAND_5G             0x1000
  70 #define WL_CHANSPEC_BAND_2G             0x2000
  71 #define INVCHANSPEC                     255
  72
  73 #define WL_CHAN_VALID_HW                (1 << 0) /* valid with current HW */
  74 #define WL_CHAN_VALID_SW                (1 << 1) /* valid with country sett. */
  75 #define WL_CHAN_BAND_5G                 (1 << 2) /* 5GHz-band channel */
  76 #define WL_CHAN_RADAR                   (1 << 3) /* radar sensitive  channel */
  77 #define WL_CHAN_INACTIVE                (1 << 4) /* inactive due to radar */
  78 #define WL_CHAN_PASSIVE                 (1 << 5) /* channel in passive mode */
  79 #define WL_CHAN_RESTRICTED              (1 << 6) /* restricted use channel */
  80
  81 /* values for band specific 40MHz capabilities  */
  82 #define WLC_N_BW_20ALL                  0
  83 #define WLC_N_BW_40ALL                  1
  84 #define WLC_N_BW_20IN2G_40IN5G          2
  85
  86 #define WLC_BW_20MHZ_BIT                BIT(0)
  87 #define WLC_BW_40MHZ_BIT                BIT(1)
  88 #define WLC_BW_80MHZ_BIT                BIT(2)
  89 #define WLC_BW_160MHZ_BIT               BIT(3)
  90
  91 /* Bandwidth capabilities */
  92 #define WLC_BW_CAP_20MHZ                (WLC_BW_20MHZ_BIT)
  93 #define WLC_BW_CAP_40MHZ                (WLC_BW_40MHZ_BIT|WLC_BW_20MHZ_BIT)
  94 #define WLC_BW_CAP_80MHZ                (WLC_BW_80MHZ_BIT|WLC_BW_40MHZ_BIT| \
  95                                          WLC_BW_20MHZ_BIT)
  96 #define WLC_BW_CAP_160MHZ               (WLC_BW_160MHZ_BIT|WLC_BW_80MHZ_BIT| \
  97                                          WLC_BW_40MHZ_BIT|WLC_BW_20MHZ_BIT)
  98 #define WLC_BW_CAP_UNRESTRICTED         0xFF
  99
 100 /* band types */
 101 #define WLC_BAND_AUTO                   0       /* auto-select */
 102 #define WLC_BAND_5G                     1       /* 5 Ghz */
 103 #define WLC_BAND_2G                     2       /* 2.4 Ghz */
 104 #define WLC_BAND_ALL                    3       /* all bands */
 105
 106 #define CHSPEC_CHANNEL(chspec)  ((u8)((chspec) & WL_CHANSPEC_CHAN_MASK))
 107 #define CHSPEC_BAND(chspec)     ((chspec) & WL_CHANSPEC_BAND_MASK)
 108
 109 #define CHSPEC_CTL_SB(chspec)   ((chspec) & WL_CHANSPEC_CTL_SB_MASK)
 110 #define CHSPEC_BW(chspec)       ((chspec) & WL_CHANSPEC_BW_MASK)
 111
 112 #define CHSPEC_IS10(chspec) \
 113         (((chspec) & WL_CHANSPEC_BW_MASK) == WL_CHANSPEC_BW_10)
 114
 115 #define CHSPEC_IS20(chspec) \
 116         (((chspec) & WL_CHANSPEC_BW_MASK) == WL_CHANSPEC_BW_20)
 117
 118 #define CHSPEC_IS40(chspec) \
 119         (((chspec) & WL_CHANSPEC_BW_MASK) == WL_CHANSPEC_BW_40)
 120
 121 #define CHSPEC_IS80(chspec) \
 122         (((chspec) & WL_CHANSPEC_BW_MASK) == WL_CHANSPEC_BW_80)
 123
 124 #define CHSPEC_IS5G(chspec) \
 125         (((chspec) & WL_CHANSPEC_BAND_MASK) == WL_CHANSPEC_BAND_5G)
 126
 127 #define CHSPEC_IS2G(chspec) \
 128         (((chspec) & WL_CHANSPEC_BAND_MASK) == WL_CHANSPEC_BAND_2G)
 129
 130 #define CHSPEC_SB_NONE(chspec) \
 131         (((chspec) & WL_CHANSPEC_CTL_SB_MASK) == WL_CHANSPEC_CTL_SB_NONE)
 132
 133 #define CHSPEC_SB_UPPER(chspec) \
 134         (((chspec) & WL_CHANSPEC_CTL_SB_MASK) == WL_CHANSPEC_CTL_SB_UPPER)
 135
 136 #define CHSPEC_SB_LOWER(chspec) \
 137         (((chspec) & WL_CHANSPEC_CTL_SB_MASK) == WL_CHANSPEC_CTL_SB_LOWER)
 138
 139 #define CHSPEC_CTL_CHAN(chspec) \
 140         ((CHSPEC_SB_LOWER(chspec)) ? \
 141         (lower_20_sb(((chspec) & WL_CHANSPEC_CHAN_MASK))) : \
 142         (upper_20_sb(((chspec) & WL_CHANSPEC_CHAN_MASK))))
 143
 144 #define CHSPEC2BAND(chspec) (CHSPEC_IS5G(chspec) ? BRCM_BAND_5G : BRCM_BAND_2G)
 145
 146 #define CHANSPEC_STR_LEN    8
 147
 148 static inline int lower_20_sb(int channel)
 149 {
 150         return channel > CH_10MHZ_APART ? (channel - CH_10MHZ_APART) : 0;
 151 }
 152
 153 static inline int upper_20_sb(int channel)
 154 {
 155         return (channel < (MAXCHANNEL - CH_10MHZ_APART)) ?
 156                channel + CH_10MHZ_APART : 0;
 157 }
 158
 159 static inline int chspec_bandunit(u16 chspec)
 160 {
 161         return CHSPEC_IS5G(chspec) ? BAND_5G_INDEX : BAND_2G_INDEX;
 162 }
 163
 164 static inline u16 ch20mhz_chspec(int channel)
 165 {
 166         u16 rc = channel <= CH_MAX_2G_CHANNEL ?
 167                  WL_CHANSPEC_BAND_2G : WL_CHANSPEC_BAND_5G;
 168
 169         return  (u16)((u16)channel | WL_CHANSPEC_BW_20 |
 170                       WL_CHANSPEC_CTL_SB_NONE | rc);
 171 }
 172
 173 static inline int next_20mhz_chan(int channel)
 174 {
 175         return channel < (MAXCHANNEL - CH_20MHZ_APART) ?
 176                channel + CH_20MHZ_APART : 0;
 177 }
 178
 179 /* defined rate in 500kbps */
 180 #define BRCM_MAXRATE    108     /* in 500kbps units */
 181 #define BRCM_RATE_1M    2       /* in 500kbps units */
 182 #define BRCM_RATE_2M    4       /* in 500kbps units */
 183 #define BRCM_RATE_5M5   11      /* in 500kbps units */
 184 #define BRCM_RATE_11M   22      /* in 500kbps units */
 185 #define BRCM_RATE_6M    12      /* in 500kbps units */
 186 #define BRCM_RATE_9M    18      /* in 500kbps units */
 187 #define BRCM_RATE_12M   24      /* in 500kbps units */
 188 #define BRCM_RATE_18M   36      /* in 500kbps units */
 189 #define BRCM_RATE_24M   48      /* in 500kbps units */
 190 #define BRCM_RATE_36M   72      /* in 500kbps units */
 191 #define BRCM_RATE_48M   96      /* in 500kbps units */
 192 #define BRCM_RATE_54M   108     /* in 500kbps units */
 193
 194 #define BRCM_2G_25MHZ_OFFSET            5       /* 2.4GHz band channel offset */
 195
 196 #define MCSSET_LEN      16
 197
 198 static inline bool ac_bitmap_tst(u8 bitmap, int prec)
 199 {
 200         return (bitmap & (1 << (prec))) != 0;
 201 }
 202
 203 /* Enumerate crypto algorithms */
 204 #define CRYPTO_ALGO_OFF                 0
 205 #define CRYPTO_ALGO_WEP1                1
 206 #define CRYPTO_ALGO_TKIP                2
 207 #define CRYPTO_ALGO_WEP128              3
 208 #define CRYPTO_ALGO_AES_CCM             4
 209 #define CRYPTO_ALGO_AES_RESERVED1       5
 210 #define CRYPTO_ALGO_AES_RESERVED2       6
 211 #define CRYPTO_ALGO_NALG                7
 212
 213 /* wireless security bitvec */
 214
 215 #define WEP_ENABLED             0x0001
 216 #define TKIP_ENABLED            0x0002
 217 #define AES_ENABLED             0x0004
 218 #define WSEC_SWFLAG             0x0008
 219 /* to go into transition mode without setting wep */
 220 #define SES_OW_ENABLED          0x0040
 221 /* MFP */
 222 #define MFP_CAPABLE             0x0200
 223 #define MFP_REQUIRED            0x0400
 224
 225 /* WPA authentication mode bitvec */
 226 #define WPA_AUTH_DISABLED       0x0000  /* Legacy (i.e., non-WPA) */
 227 #define WPA_AUTH_NONE           0x0001  /* none (IBSS) */
 228 #define WPA_AUTH_UNSPECIFIED    0x0002  /* over 802.1x */
 229 #define WPA_AUTH_PSK            0x0004  /* Pre-shared key */
 230 #define WPA_AUTH_RESERVED1      0x0008
 231 #define WPA_AUTH_RESERVED2      0x0010
 232
 233 #define WPA2_AUTH_RESERVED1     0x0020
 234 #define WPA2_AUTH_UNSPECIFIED   0x0040  /* over 802.1x */
 235 #define WPA2_AUTH_PSK           0x0080  /* Pre-shared key */
 236 #define WPA2_AUTH_RESERVED3     0x0200
 237 #define WPA2_AUTH_RESERVED4     0x0400
 238 #define WPA2_AUTH_RESERVED5     0x0800
 239
 240 /* pmkid */
 241 #define MAXPMKID                16
 242
 243 #define DOT11_DEFAULT_RTS_LEN           2347
 244 #define DOT11_DEFAULT_FRAG_LEN          2346
 245
 246 #define DOT11_ICV_AES_LEN               8
 247 #define DOT11_QOS_LEN                   2
 248 #define DOT11_IV_MAX_LEN                8
 249 #define DOT11_A4_HDR_LEN                30
 250
 251 #define HT_CAP_RX_STBC_NO               0x0
 252 #define HT_CAP_RX_STBC_ONE_STREAM       0x1
 253
 254 struct pmkid {
 255         u8 BSSID[ETH_ALEN];
 256         u8 PMKID[WLAN_PMKID_LEN];
 257 };
 258
 259 struct pmkid_list {
 260         __le32 npmkid;
 261         struct pmkid pmkid[1];
 262 };
 263
 264 struct pmkid_cand {
 265         u8 BSSID[ETH_ALEN];
 266         u8 preauth;
 267 };
 268
 269 struct pmkid_cand_list {
 270         u32 npmkid_cand;
 271         struct pmkid_cand pmkid_cand[1];
 272 };
 273
 274 #endif                          /* _BRCMU_WIFI_H_ */