drivers/net/wireless/brcm80211/brcmfmac/dhd.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 /****************
  18  * Common types *
  19  */
  20
  21 #ifndef _BRCMF_H_
  22 #define _BRCMF_H_
  23
  24 #define BRCMF_VERSION_STR               "4.218.248.5"
  25
  26 #include "fweh.h"
  27
  28 /*******************************************************************************
  29  * IO codes that are interpreted by dongle firmware
  30  ******************************************************************************/
  31 #define BRCMF_C_GET_VERSION                     1
  32 #define BRCMF_C_UP                              2
  33 #define BRCMF_C_DOWN                            3
  34 #define BRCMF_C_SET_PROMISC                     10
  35 #define BRCMF_C_GET_RATE                        12
  36 #define BRCMF_C_GET_INFRA                       19
  37 #define BRCMF_C_SET_INFRA                       20
  38 #define BRCMF_C_GET_AUTH                        21
  39 #define BRCMF_C_SET_AUTH                        22
  40 #define BRCMF_C_GET_BSSID                       23
  41 #define BRCMF_C_GET_SSID                        25
  42 #define BRCMF_C_SET_SSID                        26
  43 #define BRCMF_C_TERMINATED                      28
  44 #define BRCMF_C_GET_CHANNEL                     29
  45 #define BRCMF_C_SET_CHANNEL                     30
  46 #define BRCMF_C_GET_SRL                         31
  47 #define BRCMF_C_SET_SRL                         32
  48 #define BRCMF_C_GET_LRL                         33
  49 #define BRCMF_C_SET_LRL                         34
  50 #define BRCMF_C_GET_RADIO                       37
  51 #define BRCMF_C_SET_RADIO                       38
  52 #define BRCMF_C_GET_PHYTYPE                     39
  53 #define BRCMF_C_SET_KEY                         45
  54 #define BRCMF_C_SET_PASSIVE_SCAN                49
  55 #define BRCMF_C_SCAN                            50
  56 #define BRCMF_C_SCAN_RESULTS                    51
  57 #define BRCMF_C_DISASSOC                        52
  58 #define BRCMF_C_REASSOC                         53
  59 #define BRCMF_C_SET_ROAM_TRIGGER                55
  60 #define BRCMF_C_SET_ROAM_DELTA                  57
  61 #define BRCMF_C_GET_BCNPRD                      75
  62 #define BRCMF_C_SET_BCNPRD                      76
  63 #define BRCMF_C_GET_DTIMPRD                     77
  64 #define BRCMF_C_SET_DTIMPRD                     78
  65 #define BRCMF_C_SET_COUNTRY                     84
  66 #define BRCMF_C_GET_PM                          85
  67 #define BRCMF_C_SET_PM                          86
  68 #define BRCMF_C_GET_CURR_RATESET                114
  69 #define BRCMF_C_GET_AP                          117
  70 #define BRCMF_C_SET_AP                          118
  71 #define BRCMF_C_GET_RSSI                        127
  72 #define BRCMF_C_GET_WSEC                        133
  73 #define BRCMF_C_SET_WSEC                        134
  74 #define BRCMF_C_GET_PHY_NOISE                   135
  75 #define BRCMF_C_GET_BSS_INFO                    136
  76 #define BRCMF_C_GET_BANDLIST                    140
  77 #define BRCMF_C_SET_SCB_TIMEOUT                 158
  78 #define BRCMF_C_GET_PHYLIST                     180
  79 #define BRCMF_C_SET_SCAN_CHANNEL_TIME           185
  80 #define BRCMF_C_SET_SCAN_UNASSOC_TIME           187
  81 #define BRCMF_C_SCB_DEAUTHENTICATE_FOR_REASON   201
  82 #define BRCMF_C_GET_VALID_CHANNELS              217
  83 #define BRCMF_C_GET_KEY_PRIMARY                 235
  84 #define BRCMF_C_SET_KEY_PRIMARY                 236
  85 #define BRCMF_C_SET_SCAN_PASSIVE_TIME           258
  86 #define BRCMF_C_GET_VAR                         262
  87 #define BRCMF_C_SET_VAR                         263
  88
  89 /* phy types (returned by WLC_GET_PHYTPE) */
  90 #define WLC_PHY_TYPE_A          0
  91 #define WLC_PHY_TYPE_B          1
  92 #define WLC_PHY_TYPE_G          2
  93 #define WLC_PHY_TYPE_N          4
  94 #define WLC_PHY_TYPE_LP         5
  95 #define WLC_PHY_TYPE_SSN        6
  96 #define WLC_PHY_TYPE_HT         7
  97 #define WLC_PHY_TYPE_LCN        8
  98 #define WLC_PHY_TYPE_NULL       0xf
  99
 100 #define BRCMF_EVENTING_MASK_LEN 16
 101
 102 #define TOE_TX_CSUM_OL          0x00000001
 103 #define TOE_RX_CSUM_OL          0x00000002
 104
 105 #define BRCMF_BSS_INFO_VERSION  109 /* curr ver of brcmf_bss_info_le struct */
 106
 107 /* size of brcmf_scan_params not including variable length array */
 108 #define BRCMF_SCAN_PARAMS_FIXED_SIZE 64
 109
 110 /* masks for channel and ssid count */
 111 #define BRCMF_SCAN_PARAMS_COUNT_MASK 0x0000ffff
 112 #define BRCMF_SCAN_PARAMS_NSSID_SHIFT 16
 113
 114 /* primary (ie tx) key */
 115 #define BRCMF_PRIMARY_KEY       (1 << 1)
 116
 117 /* For supporting multiple interfaces */
 118 #define BRCMF_MAX_IFS   16
 119
 120 #define DOT11_BSSTYPE_ANY                       2
 121 #define DOT11_MAX_DEFAULT_KEYS  4
 122
 123 #define BRCMF_ESCAN_REQ_VERSION 1
 124
 125 #define WLC_BSS_RSSI_ON_CHANNEL         0x0002
 126
 127 #define BRCMF_MAXRATES_IN_SET           16      /* max # of rates in rateset */
 128 #define BRCMF_STA_ASSOC                 0x10            /* Associated */
 129
 130 #define BRCMF_E_STATUS_SUCCESS                  0
 131 #define BRCMF_E_STATUS_FAIL                     1
 132 #define BRCMF_E_STATUS_TIMEOUT                  2
 133 #define BRCMF_E_STATUS_NO_NETWORKS              3
 134 #define BRCMF_E_STATUS_ABORT                    4
 135 #define BRCMF_E_STATUS_NO_ACK                   5
 136 #define BRCMF_E_STATUS_UNSOLICITED              6
 137 #define BRCMF_E_STATUS_ATTEMPT                  7
 138 #define BRCMF_E_STATUS_PARTIAL                  8
 139 #define BRCMF_E_STATUS_NEWSCAN                  9
 140 #define BRCMF_E_STATUS_NEWASSOC                 10
 141 #define BRCMF_E_STATUS_11HQUIET                 11
 142 #define BRCMF_E_STATUS_SUPPRESS                 12
 143 #define BRCMF_E_STATUS_NOCHANS                  13
 144 #define BRCMF_E_STATUS_CS_ABORT                 15
 145 #define BRCMF_E_STATUS_ERROR                    16
 146
 147 #define BRCMF_E_REASON_INITIAL_ASSOC            0
 148 #define BRCMF_E_REASON_LOW_RSSI                 1
 149 #define BRCMF_E_REASON_DEAUTH                   2
 150 #define BRCMF_E_REASON_DISASSOC                 3
 151 #define BRCMF_E_REASON_BCNS_LOST                4
 152 #define BRCMF_E_REASON_MINTXRATE                9
 153 #define BRCMF_E_REASON_TXFAIL                   10
 154
 155 #define BRCMF_E_REASON_LINK_BSSCFG_DIS          4
 156 #define BRCMF_E_REASON_FAST_ROAM_FAILED         5
 157 #define BRCMF_E_REASON_DIRECTED_ROAM            6
 158 #define BRCMF_E_REASON_TSPEC_REJECTED           7
 159 #define BRCMF_E_REASON_BETTER_AP                8
 160
 161 #define BRCMF_E_PRUNE_ENCR_MISMATCH             1
 162 #define BRCMF_E_PRUNE_BCAST_BSSID               2
 163 #define BRCMF_E_PRUNE_MAC_DENY                  3
 164 #define BRCMF_E_PRUNE_MAC_NA                    4
 165 #define BRCMF_E_PRUNE_REG_PASSV                 5
 166 #define BRCMF_E_PRUNE_SPCT_MGMT                 6
 167 #define BRCMF_E_PRUNE_RADAR                     7
 168 #define BRCMF_E_RSN_MISMATCH                    8
 169 #define BRCMF_E_PRUNE_NO_COMMON_RATES           9
 170 #define BRCMF_E_PRUNE_BASIC_RATES               10
 171 #define BRCMF_E_PRUNE_CIPHER_NA                 12
 172 #define BRCMF_E_PRUNE_KNOWN_STA                 13
 173 #define BRCMF_E_PRUNE_WDS_PEER                  15
 174 #define BRCMF_E_PRUNE_QBSS_LOAD                 16
 175 #define BRCMF_E_PRUNE_HOME_AP                   17
 176
 177 #define BRCMF_E_SUP_OTHER                       0
 178 #define BRCMF_E_SUP_DECRYPT_KEY_DATA            1
 179 #define BRCMF_E_SUP_BAD_UCAST_WEP128            2
 180 #define BRCMF_E_SUP_BAD_UCAST_WEP40             3
 181 #define BRCMF_E_SUP_UNSUP_KEY_LEN               4
 182 #define BRCMF_E_SUP_PW_KEY_CIPHER               5
 183 #define BRCMF_E_SUP_MSG3_TOO_MANY_IE            6
 184 #define BRCMF_E_SUP_MSG3_IE_MISMATCH            7
 185 #define BRCMF_E_SUP_NO_INSTALL_FLAG             8
 186 #define BRCMF_E_SUP_MSG3_NO_GTK                 9
 187 #define BRCMF_E_SUP_GRP_KEY_CIPHER              10
 188 #define BRCMF_E_SUP_GRP_MSG1_NO_GTK             11
 189 #define BRCMF_E_SUP_GTK_DECRYPT_FAIL            12
 190 #define BRCMF_E_SUP_SEND_FAIL                   13
 191 #define BRCMF_E_SUP_DEAUTH                      14
 192
 193 #define BRCMF_E_IF_ADD                          1
 194 #define BRCMF_E_IF_DEL                          2
 195 #define BRCMF_E_IF_CHANGE                       3
 196
 197 #define BRCMF_E_IF_FLAG_NOIF                    1
 198
 199 #define BRCMF_E_IF_ROLE_STA                     0
 200 #define BRCMF_E_IF_ROLE_AP                      1
 201 #define BRCMF_E_IF_ROLE_WDS                     2
 202
 203 #define BRCMF_E_LINK_BCN_LOSS                   1
 204 #define BRCMF_E_LINK_DISASSOC                   2
 205 #define BRCMF_E_LINK_ASSOC_REC                  3
 206 #define BRCMF_E_LINK_BSSCFG_DIS                 4
 207
 208 /* Small, medium and maximum buffer size for dcmd
 209  */
 210 #define BRCMF_DCMD_SMLEN        256
 211 #define BRCMF_DCMD_MEDLEN       1536
 212 #define BRCMF_DCMD_MAXLEN       8192
 213
 214 #define BRCMF_AMPDU_RX_REORDER_MAXFLOWS         256
 215
 216 /* Pattern matching filter. Specifies an offset within received packets to
 217  * start matching, the pattern to match, the size of the pattern, and a bitmask
 218  * that indicates which bits within the pattern should be matched.
 219  */
 220 struct brcmf_pkt_filter_pattern_le {
 221         /*
 222          * Offset within received packet to start pattern matching.
 223          * Offset '0' is the first byte of the ethernet header.
 224          */
 225         __le32 offset;
 226         /* Size of the pattern.  Bitmask must be the same size.*/
 227         __le32 size_bytes;
 228         /*
 229          * Variable length mask and pattern data. mask starts at offset 0.
 230          * Pattern immediately follows mask.
 231          */
 232         u8 mask_and_pattern[1];
 233 };
 234
 235 /* IOVAR "pkt_filter_add" parameter. Used to install packet filters. */
 236 struct brcmf_pkt_filter_le {
 237         __le32 id;              /* Unique filter id, specified by app. */
 238         __le32 type;            /* Filter type (WL_PKT_FILTER_TYPE_xxx). */
 239         __le32 negate_match;    /* Negate the result of filter matches */
 240         union {                 /* Filter definitions */
 241                 struct brcmf_pkt_filter_pattern_le pattern; /* Filter pattern */
 242         } u;
 243 };
 244
 245 /* IOVAR "pkt_filter_enable" parameter. */
 246 struct brcmf_pkt_filter_enable_le {
 247         __le32 id;              /* Unique filter id */
 248         __le32 enable;          /* Enable/disable bool */
 249 };
 250
 251 /* BSS info structure
 252  * Applications MUST CHECK ie_offset field and length field to access IEs and
 253  * next bss_info structure in a vector (in struct brcmf_scan_results)
 254  */
 255 struct brcmf_bss_info_le {
 256         __le32 version;         /* version field */
 257         __le32 length;          /* byte length of data in this record,
 258                                  * starting at version and including IEs
 259                                  */
 260         u8 BSSID[ETH_ALEN];
 261         __le16 beacon_period;   /* units are Kusec */
 262         __le16 capability;      /* Capability information */
 263         u8 SSID_len;
 264         u8 SSID[32];
 265         struct {
 266                 __le32 count;   /* # rates in this set */
 267                 u8 rates[16]; /* rates in 500kbps units w/hi bit set if basic */
 268         } rateset;              /* supported rates */
 269         __le16 chanspec;        /* chanspec for bss */
 270         __le16 atim_window;     /* units are Kusec */
 271         u8 dtim_period; /* DTIM period */
 272         __le16 RSSI;            /* receive signal strength (in dBm) */
 273         s8 phy_noise;           /* noise (in dBm) */
 274
 275         u8 n_cap;               /* BSS is 802.11N Capable */
 276         /* 802.11N BSS Capabilities (based on HT_CAP_*): */
 277         __le32 nbss_cap;
 278         u8 ctl_ch;              /* 802.11N BSS control channel number */
 279         __le32 reserved32[1];   /* Reserved for expansion of BSS properties */
 280         u8 flags;               /* flags */
 281         u8 reserved[3]; /* Reserved for expansion of BSS properties */
 282         u8 basic_mcs[MCSSET_LEN];       /* 802.11N BSS required MCS set */
 283
 284         __le16 ie_offset;       /* offset at which IEs start, from beginning */
 285         __le32 ie_length;       /* byte length of Information Elements */
 286         __le16 SNR;             /* average SNR of during frame reception */
 287         /* Add new fields here */
 288         /* variable length Information Elements */
 289 };
 290
 291 struct brcm_rateset_le {
 292         /* # rates in this set */
 293         __le32 count;
 294         /* rates in 500kbps units w/hi bit set if basic */
 295         u8 rates[BRCMF_MAXRATES_IN_SET];
 296 };
 297
 298 struct brcmf_ssid {
 299         u32 SSID_len;
 300         unsigned char SSID[32];
 301 };
 302
 303 struct brcmf_ssid_le {
 304         __le32 SSID_len;
 305         unsigned char SSID[32];
 306 };
 307
 308 struct brcmf_scan_params_le {
 309         struct brcmf_ssid_le ssid_le;   /* default: {0, ""} */
 310         u8 bssid[ETH_ALEN];     /* default: bcast */
 311         s8 bss_type;            /* default: any,
 312                                  * DOT11_BSSTYPE_ANY/INFRASTRUCTURE/INDEPENDENT
 313                                  */
 314         u8 scan_type;   /* flags, 0 use default */
 315         __le32 nprobes;   /* -1 use default, number of probes per channel */
 316         __le32 active_time;     /* -1 use default, dwell time per channel for
 317                                  * active scanning
 318                                  */
 319         __le32 passive_time;    /* -1 use default, dwell time per channel
 320                                  * for passive scanning
 321                                  */
 322         __le32 home_time;       /* -1 use default, dwell time for the
 323                                  * home channel between channel scans
 324                                  */
 325         __le32 channel_num;     /* count of channels and ssids that follow
 326                                  *
 327                                  * low half is count of channels in
 328                                  * channel_list, 0 means default (use all
 329                                  * available channels)
 330                                  *
 331                                  * high half is entries in struct brcmf_ssid
 332                                  * array that follows channel_list, aligned for
 333                                  * s32 (4 bytes) meaning an odd channel count
 334                                  * implies a 2-byte pad between end of
 335                                  * channel_list and first ssid
 336                                  *
 337                                  * if ssid count is zero, single ssid in the
 338                                  * fixed parameter portion is assumed, otherwise
 339                                  * ssid in the fixed portion is ignored
 340                                  */
 341         __le16 channel_list[1]; /* list of chanspecs */
 342 };
 343
 344 struct brcmf_scan_results {
 345         u32 buflen;
 346         u32 version;
 347         u32 count;
 348         struct brcmf_bss_info_le bss_info_le[];
 349 };
 350
 351 struct brcmf_escan_params_le {
 352         __le32 version;
 353         __le16 action;
 354         __le16 sync_id;
 355         struct brcmf_scan_params_le params_le;
 356 };
 357
 358 struct brcmf_escan_result_le {
 359         __le32 buflen;
 360         __le32 version;
 361         __le16 sync_id;
 362         __le16 bss_count;
 363         struct brcmf_bss_info_le bss_info_le;
 364 };
 365
 366 #define WL_ESCAN_RESULTS_FIXED_SIZE (sizeof(struct brcmf_escan_result_le) - \
 367         sizeof(struct brcmf_bss_info_le))
 368
 369 /* used for association with a specific BSSID and chanspec list */
 370 struct brcmf_assoc_params_le {
 371         /* 00:00:00:00:00:00: broadcast scan */
 372         u8 bssid[ETH_ALEN];
 373         /* 0: all available channels, otherwise count of chanspecs in
 374          * chanspec_list */
 375         __le32 chanspec_num;
 376         /* list of chanspecs */
 377         __le16 chanspec_list[1];
 378 };
 379
 380 /* used for join with or without a specific bssid and channel list */
 381 struct brcmf_join_params {
 382         struct brcmf_ssid_le ssid_le;
 383         struct brcmf_assoc_params_le params_le;
 384 };
 385
 386 /* scan params for extended join */
 387 struct brcmf_join_scan_params_le {
 388         u8 scan_type;           /* 0 use default, active or passive scan */
 389         __le32 nprobes;         /* -1 use default, nr of probes per channel */
 390         __le32 active_time;     /* -1 use default, dwell time per channel for
 391                                  * active scanning
 392                                  */
 393         __le32 passive_time;    /* -1 use default, dwell time per channel
 394                                  * for passive scanning
 395                                  */
 396         __le32 home_time;       /* -1 use default, dwell time for the home
 397                                  * channel between channel scans
 398                                  */
 399 };
 400
 401 /* extended join params */
 402 struct brcmf_ext_join_params_le {
 403         struct brcmf_ssid_le ssid_le;   /* {0, ""}: wildcard scan */
 404         struct brcmf_join_scan_params_le scan_le;
 405         struct brcmf_assoc_params_le assoc_le;
 406 };
 407
 408 struct brcmf_wsec_key {
 409         u32 index;              /* key index */
 410         u32 len;                /* key length */
 411         u8 data[WLAN_MAX_KEY_LEN];      /* key data */
 412         u32 pad_1[18];
 413         u32 algo;       /* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
 414         u32 flags;      /* misc flags */
 415         u32 pad_2[3];
 416         u32 iv_initialized;     /* has IV been initialized already? */
 417         u32 pad_3;
 418         /* Rx IV */
 419         struct {
 420                 u32 hi; /* upper 32 bits of IV */
 421                 u16 lo; /* lower 16 bits of IV */
 422         } rxiv;
 423         u32 pad_4[2];
 424         u8 ea[ETH_ALEN];        /* per station */
 425 };
 426
 427 /*
 428  * dongle requires same struct as above but with fields in little endian order
 429  */
 430 struct brcmf_wsec_key_le {
 431         __le32 index;           /* key index */
 432         __le32 len;             /* key length */
 433         u8 data[WLAN_MAX_KEY_LEN];      /* key data */
 434         __le32 pad_1[18];
 435         __le32 algo;    /* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
 436         __le32 flags;   /* misc flags */
 437         __le32 pad_2[3];
 438         __le32 iv_initialized;  /* has IV been initialized already? */
 439         __le32 pad_3;
 440         /* Rx IV */
 441         struct {
 442                 __le32 hi;      /* upper 32 bits of IV */
 443                 __le16 lo;      /* lower 16 bits of IV */
 444         } rxiv;
 445         __le32 pad_4[2];
 446         u8 ea[ETH_ALEN];        /* per station */
 447 };
 448
 449 /* Used to get specific STA parameters */
 450 struct brcmf_scb_val_le {
 451         __le32 val;
 452         u8 ea[ETH_ALEN];
 453 };
 454
 455 /* channel encoding */
 456 struct brcmf_channel_info_le {
 457         __le32 hw_channel;
 458         __le32 target_channel;
 459         __le32 scan_channel;
 460 };
 461
 462 struct brcmf_sta_info_le {
 463         __le16  ver;            /* version of this struct */
 464         __le16  len;            /* length in bytes of this structure */
 465         __le16  cap;            /* sta's advertised capabilities */
 466         __le32  flags;          /* flags defined below */
 467         __le32  idle;           /* time since data pkt rx'd from sta */
 468         u8      ea[ETH_ALEN];           /* Station address */
 469         __le32  count;                  /* # rates in this set */
 470         u8      rates[BRCMF_MAXRATES_IN_SET];   /* rates in 500kbps units */
 471                                                 /* w/hi bit set if basic */
 472         __le32  in;             /* seconds elapsed since associated */
 473         __le32  listen_interval_inms; /* Min Listen interval in ms for STA */
 474         __le32  tx_pkts;        /* # of packets transmitted */
 475         __le32  tx_failures;    /* # of packets failed */
 476         __le32  rx_ucast_pkts;  /* # of unicast packets received */
 477         __le32  rx_mcast_pkts;  /* # of multicast packets received */
 478         __le32  tx_rate;        /* Rate of last successful tx frame */
 479         __le32  rx_rate;        /* Rate of last successful rx frame */
 480         __le32  rx_decrypt_succeeds;    /* # of packet decrypted successfully */
 481         __le32  rx_decrypt_failures;    /* # of packet decrypted failed */
 482 };
 483
 484 struct brcmf_chanspec_list {
 485         __le32  count;          /* # of entries */
 486         __le32  element[1];     /* variable length uint32 list */
 487 };
 488
 489 /*
 490  * WLC_E_PROBRESP_MSG
 491  * WLC_E_P2P_PROBREQ_MSG
 492  * WLC_E_ACTION_FRAME_RX
 493  */
 494 struct brcmf_rx_mgmt_data {
 495         __be16  version;
 496         __be16  chanspec;
 497         __be32  rssi;
 498         __be32  mactime;
 499         __be32  rate;
 500 };
 501
 502 /* Bus independent dongle command */
 503 struct brcmf_dcmd {
 504         uint cmd;               /* common dongle cmd definition */
 505         void *buf;              /* pointer to user buffer */
 506         uint len;               /* length of user buffer */
 507         u8 set;                 /* get or set request (optional) */
 508         uint used;              /* bytes read or written (optional) */
 509         uint needed;            /* bytes needed (optional) */
 510 };
 511
 512 /**
 513  * struct brcmf_ampdu_rx_reorder - AMPDU receive reorder info
 514  *
 515  * @pktslots: dynamic allocated array for ordering AMPDU packets.
 516  * @flow_id: AMPDU flow identifier.
 517  * @cur_idx: last AMPDU index from firmware.
 518  * @exp_idx: expected next AMPDU index.
 519  * @max_idx: maximum amount of packets per AMPDU.
 520  * @pend_pkts: number of packets currently in @pktslots.
 521  */
 522 struct brcmf_ampdu_rx_reorder {
 523         struct sk_buff **pktslots;
 524         u8 flow_id;
 525         u8 cur_idx;
 526         u8 exp_idx;
 527         u8 max_idx;
 528         u8 pend_pkts;
 529 };
 530
 531 /* Forward decls for struct brcmf_pub (see below) */
 532 struct brcmf_proto;     /* device communication protocol info */
 533 struct brcmf_cfg80211_dev; /* cfg80211 device info */
 534 struct brcmf_fws_info; /* firmware signalling info */
 535
 536 /* Common structure for module and instance linkage */
 537 struct brcmf_pub {
 538         /* Linkage ponters */
 539         struct brcmf_bus *bus_if;
 540         struct brcmf_proto *prot;
 541         struct brcmf_cfg80211_info *config;
 542
 543         /* Internal brcmf items */
 544         uint hdrlen;            /* Total BRCMF header length (proto + bus) */
 545         uint rxsz;              /* Rx buffer size bus module should use */
 546         u8 wme_dp;              /* wme discard priority */
 547
 548         /* Dongle media info */
 549         unsigned long drv_version;      /* Version of dongle-resident driver */
 550         u8 mac[ETH_ALEN];               /* MAC address obtained from dongle */
 551
 552         /* Multicast data packets sent to dongle */
 553         unsigned long tx_multicast;
 554
 555         struct brcmf_if *iflist[BRCMF_MAX_IFS];
 556
 557         struct mutex proto_block;
 558         unsigned char proto_buf[BRCMF_DCMD_MAXLEN];
 559
 560         struct brcmf_fweh_info fweh;
 561
 562         struct brcmf_fws_info *fws;
 563
 564         struct brcmf_ampdu_rx_reorder
 565                 *reorder_flows[BRCMF_AMPDU_RX_REORDER_MAXFLOWS];
 566 #ifdef DEBUG
 567         struct dentry *dbgfs_dir;
 568 #endif
 569 };
 570
 571 struct brcmf_if_event {
 572         u8 ifidx;
 573         u8 action;
 574         u8 flags;
 575         u8 bssidx;
 576         u8 role;
 577 };
 578
 579 /* forward declarations */
 580 struct brcmf_cfg80211_vif;
 581 struct brcmf_fws_mac_descriptor;
 582
 583 /**
 584  * enum brcmf_netif_stop_reason - reason for stopping netif queue.
 585  *
 586  * @BRCMF_NETIF_STOP_REASON_FWS_FC:
 587  *      netif stopped due to firmware signalling flow control.
 588  * @BRCMF_NETIF_STOP_REASON_BLOCK_BUS:
 589  *      netif stopped due to bus blocking.
 590  */
 591 enum brcmf_netif_stop_reason {
 592         BRCMF_NETIF_STOP_REASON_FWS_FC = 1,
 593         BRCMF_NETIF_STOP_REASON_BLOCK_BUS = 2
 594 };
 595
 596 /**
 597  * struct brcmf_if - interface control information.
 598  *
 599  * @drvr: points to device related information.
 600  * @vif: points to cfg80211 specific interface information.
 601  * @ndev: associated network device.
 602  * @stats: interface specific network statistics.
 603  * @setmacaddr_work: worker object for setting mac address.
 604  * @multicast_work: worker object for multicast provisioning.
 605  * @fws_desc: interface specific firmware-signalling descriptor.
 606  * @ifidx: interface index in device firmware.
 607  * @bssidx: index of bss associated with this interface.
 608  * @mac_addr: assigned mac address.
 609  * @netif_stop: bitmap indicates reason why netif queues are stopped.
 610  * @netif_stop_lock: spinlock for update netif_stop from multiple sources.
 611  * @pend_8021x_cnt: tracks outstanding number of 802.1x frames.
 612  * @pend_8021x_wait: used for signalling change in count.
 613  */
 614 struct brcmf_if {
 615         struct brcmf_pub *drvr;
 616         struct brcmf_cfg80211_vif *vif;
 617         struct net_device *ndev;
 618         struct net_device_stats stats;
 619         struct work_struct setmacaddr_work;
 620         struct work_struct multicast_work;
 621         struct brcmf_fws_mac_descriptor *fws_desc;
 622         int ifidx;
 623         s32 bssidx;
 624         u8 mac_addr[ETH_ALEN];
 625         u8 netif_stop;
 626         spinlock_t netif_stop_lock;
 627         atomic_t pend_8021x_cnt;
 628         wait_queue_head_t pend_8021x_wait;
 629 };
 630
 631 struct brcmf_skb_reorder_data {
 632         u8 *reorder;
 633 };
 634
 635 extern int brcmf_netdev_wait_pend8021x(struct net_device *ndev);
 636
 637 /* Return pointer to interface name */
 638 extern char *brcmf_ifname(struct brcmf_pub *drvr, int idx);
 639
 640 /* Query dongle */
 641 extern int brcmf_proto_cdc_query_dcmd(struct brcmf_pub *drvr, int ifidx,
 642                                        uint cmd, void *buf, uint len);
 643 extern int brcmf_proto_cdc_set_dcmd(struct brcmf_pub *drvr, int ifidx, uint cmd,
 644                                     void *buf, uint len);
 645
 646 /* Remove any protocol-specific data header. */
 647 extern int brcmf_proto_hdrpull(struct brcmf_pub *drvr, bool do_fws, u8 *ifidx,
 648                                struct sk_buff *rxp);
 649
 650 extern int brcmf_net_attach(struct brcmf_if *ifp, bool rtnl_locked);
 651 extern struct brcmf_if *brcmf_add_if(struct brcmf_pub *drvr, s32 bssidx,
 652                                      s32 ifidx, char *name, u8 *mac_addr);
 653 extern void brcmf_del_if(struct brcmf_pub *drvr, s32 bssidx);
 654 void brcmf_txflowblock_if(struct brcmf_if *ifp,
 655                           enum brcmf_netif_stop_reason reason, bool state);
 656 extern u32 brcmf_get_chip_info(struct brcmf_if *ifp);
 657 extern void brcmf_txfinalize(struct brcmf_pub *drvr, struct sk_buff *txp,
 658                              bool success);
 659
 660 #endif                          /* _BRCMF_H_ */