drivers/staging/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 _dhd_h_
  22 #define _dhd_h_
  23
  24 #define BRCMF_VERSION_STR               "4.218.248.5"
  25
  26 #define BRCMF_C_IOCTL_SMLEN     256     /* "small" ioctl buffer required */
  27 #define BRCMF_C_IOCTL_MEDLEN    1536    /* "med" ioctl buffer required */
  28 #define BRCMF_C_IOCTL_MAXLEN    8192
  29
  30 #define BRCMF_C_UP                              2
  31 #define BRCMF_C_SET_PROMISC                     10
  32 #define BRCMF_C_GET_RATE                        12
  33 #define BRCMF_C_GET_INFRA                       19
  34 #define BRCMF_C_SET_INFRA                       20
  35 #define BRCMF_C_GET_AUTH                        21
  36 #define BRCMF_C_SET_AUTH                        22
  37 #define BRCMF_C_GET_BSSID                       23
  38 #define BRCMF_C_GET_SSID                        25
  39 #define BRCMF_C_SET_SSID                        26
  40 #define BRCMF_C_GET_CHANNEL                     29
  41 #define BRCMF_C_GET_SRL                         31
  42 #define BRCMF_C_GET_LRL                         33
  43 #define BRCMF_C_GET_RADIO                       37
  44 #define BRCMF_C_SET_RADIO                       38
  45 #define BRCMF_C_GET_PHYTYPE                     39
  46 #define BRCMF_C_SET_KEY                         45
  47 #define BRCMF_C_SET_PASSIVE_SCAN                49
  48 #define BRCMF_C_SCAN                            50
  49 #define BRCMF_C_SCAN_RESULTS                    51
  50 #define BRCMF_C_DISASSOC                        52
  51 #define BRCMF_C_REASSOC                         53
  52 #define BRCMF_C_SET_ROAM_TRIGGER                55
  53 #define BRCMF_C_SET_ROAM_DELTA                  57
  54 #define BRCMF_C_GET_DTIMPRD                     77
  55 #define BRCMF_C_SET_COUNTRY                     84
  56 #define BRCMF_C_GET_PM                          85
  57 #define BRCMF_C_SET_PM                          86
  58 #define BRCMF_C_GET_AP                          117
  59 #define BRCMF_C_SET_AP                          118
  60 #define BRCMF_C_GET_RSSI                        127
  61 #define BRCMF_C_GET_WSEC                        133
  62 #define BRCMF_C_SET_WSEC                        134
  63 #define BRCMF_C_GET_PHY_NOISE                   135
  64 #define BRCMF_C_GET_BSS_INFO                    136
  65 #define BRCMF_C_SET_SCAN_CHANNEL_TIME           185
  66 #define BRCMF_C_SET_SCAN_UNASSOC_TIME           187
  67 #define BRCMF_C_SCB_DEAUTHENTICATE_FOR_REASON   201
  68 #define BRCMF_C_GET_VALID_CHANNELS              217
  69 #define BRCMF_C_GET_KEY_PRIMARY                 235
  70 #define BRCMF_C_SET_KEY_PRIMARY                 236
  71 #define BRCMF_C_SET_SCAN_PASSIVE_TIME           258
  72 #define BRCMF_C_GET_VAR                         262
  73 #define BRCMF_C_SET_VAR                         263
  74
  75 /* phy types (returned by WLC_GET_PHYTPE) */
  76 #define WLC_PHY_TYPE_A          0
  77 #define WLC_PHY_TYPE_B          1
  78 #define WLC_PHY_TYPE_G          2
  79 #define WLC_PHY_TYPE_N          4
  80 #define WLC_PHY_TYPE_LP         5
  81 #define WLC_PHY_TYPE_SSN        6
  82 #define WLC_PHY_TYPE_HT         7
  83 #define WLC_PHY_TYPE_LCN        8
  84 #define WLC_PHY_TYPE_NULL       0xf
  85
  86 #define WL_PKT_FILTER_FIXED_LEN           offsetof(wl_pkt_filter_t, u)
  87 #define WL_PKT_FILTER_PATTERN_FIXED_LEN   offsetof(wl_pkt_filter_pattern_t, mask_and_pattern)
  88
  89 #define WL_EVENTING_MASK_LEN    16
  90
  91 #define TOE_TX_CSUM_OL          0x00000001
  92 #define TOE_RX_CSUM_OL          0x00000002
  93
  94 /* maximum channels returned by the get valid channels iovar */
  95 #define WL_NUMCHANNELS          64
  96
  97 #define WL_BSS_INFO_VERSION     108     /* current ver of wl_bss_info struct */
  98
  99 /* size of wl_scan_params not including variable length array */
 100 #define WL_SCAN_PARAMS_FIXED_SIZE 64
 101
 102 /* masks for channel and ssid count */
 103 #define WL_SCAN_PARAMS_COUNT_MASK 0x0000ffff
 104 #define WL_SCAN_PARAMS_NSSID_SHIFT 16
 105
 106 #define WL_SCAN_ACTION_START      1
 107 #define WL_SCAN_ACTION_CONTINUE   2
 108 #define WL_SCAN_ACTION_ABORT      3
 109
 110 #define ISCAN_REQ_VERSION 1
 111
 112 /* wl_iscan_results status values */
 113 #define WL_SCAN_RESULTS_SUCCESS 0
 114 #define WL_SCAN_RESULTS_PARTIAL 1
 115 #define WL_SCAN_RESULTS_PENDING 2
 116 #define WL_SCAN_RESULTS_ABORTED 3
 117 #define WL_SCAN_RESULTS_NO_MEM  4
 118
 119 #define WL_SOFT_KEY     (1 << 0)        /* Indicates this key is using soft encrypt */
 120 #define WL_PRIMARY_KEY  (1 << 1)        /* Indicates this key is the primary (ie tx) key */
 121 #define WL_KF_RES_4     (1 << 4)        /* Reserved for backward compat */
 122 #define WL_KF_RES_5     (1 << 5)        /* Reserved for backward compat */
 123 #define WL_IBSS_PEER_GROUP_KEY  (1 << 6)        /* Indicates a group key for a IBSS PEER */
 124
 125 /* For supporting multiple interfaces */
 126 #define DHD_MAX_IFS     16
 127 #define DHD_DEL_IF      -0xe
 128 #define DHD_BAD_IF      -0xf
 129
 130 #define DOT11_BSSTYPE_ANY                       2
 131 #define DOT11_MAX_DEFAULT_KEYS  4
 132
 133 #define BRCMF_EVENT_MSG_LINK            0x01
 134 #define BRCMF_EVENT_MSG_FLUSHTXQ        0x02
 135 #define BRCMF_EVENT_MSG_GROUP           0x04
 136
 137 typedef struct brcmf_event_msg {
 138         u16 version;
 139         u16 flags;
 140         u32 event_type;
 141         u32 status;
 142         u32 reason;
 143         u32 auth_type;
 144         u32 datalen;
 145         u8 addr[ETH_ALEN];
 146         char ifname[IFNAMSIZ];
 147 } __packed brcmf_event_msg_t;
 148
 149 struct brcm_ethhdr {
 150         u16 subtype;
 151         u16 length;
 152         u8 version;
 153         u8 oui[3];
 154         u16 usr_subtype;
 155 } __packed;
 156
 157 typedef struct brcmf_event {
 158         struct ethhdr eth;
 159         struct brcm_ethhdr hdr;
 160         struct brcmf_event_msg msg;
 161 } __packed brcmf_event_t;
 162
 163 #define BRCMF_E_SET_SSID                        0
 164 #define BRCMF_E_JOIN                            1
 165 #define BRCMF_E_START                           2
 166 #define BRCMF_E_AUTH                            3
 167 #define BRCMF_E_AUTH_IND                        4
 168 #define BRCMF_E_DEAUTH                          5
 169 #define BRCMF_E_DEAUTH_IND                      6
 170 #define BRCMF_E_ASSOC                           7
 171 #define BRCMF_E_ASSOC_IND                       8
 172 #define BRCMF_E_REASSOC                         9
 173 #define BRCMF_E_REASSOC_IND                     10
 174 #define BRCMF_E_DISASSOC                        11
 175 #define BRCMF_E_DISASSOC_IND                    12
 176 #define BRCMF_E_QUIET_START                     13
 177 #define BRCMF_E_QUIET_END                       14
 178 #define BRCMF_E_BEACON_RX                       15
 179 #define BRCMF_E_LINK                            16
 180 #define BRCMF_E_MIC_ERROR                       17
 181 #define BRCMF_E_NDIS_LINK                       18
 182 #define BRCMF_E_ROAM                            19
 183 #define BRCMF_E_TXFAIL                          20
 184 #define BRCMF_E_PMKID_CACHE                     21
 185 #define BRCMF_E_RETROGRADE_TSF                  22
 186 #define BRCMF_E_PRUNE                           23
 187 #define BRCMF_E_AUTOAUTH                        24
 188 #define BRCMF_E_EAPOL_MSG                       25
 189 #define BRCMF_E_SCAN_COMPLETE                   26
 190 #define BRCMF_E_ADDTS_IND                       27
 191 #define BRCMF_E_DELTS_IND                       28
 192 #define BRCMF_E_BCNSENT_IND                     29
 193 #define BRCMF_E_BCNRX_MSG                       30
 194 #define BRCMF_E_BCNLOST_MSG                     31
 195 #define BRCMF_E_ROAM_PREP                       32
 196 #define BRCMF_E_PFN_NET_FOUND                   33
 197 #define BRCMF_E_PFN_NET_LOST                    34
 198 #define BRCMF_E_RESET_COMPLETE                  35
 199 #define BRCMF_E_JOIN_START                      36
 200 #define BRCMF_E_ROAM_START                      37
 201 #define BRCMF_E_ASSOC_START                     38
 202 #define BRCMF_E_IBSS_ASSOC                      39
 203 #define BRCMF_E_RADIO                           40
 204 #define BRCMF_E_PSM_WATCHDOG                    41
 205 #define BRCMF_E_PROBREQ_MSG                     44
 206 #define BRCMF_E_SCAN_CONFIRM_IND                45
 207 #define BRCMF_E_PSK_SUP                         46
 208 #define BRCMF_E_COUNTRY_CODE_CHANGED            47
 209 #define BRCMF_E_EXCEEDED_MEDIUM_TIME            48
 210 #define BRCMF_E_ICV_ERROR                       49
 211 #define BRCMF_E_UNICAST_DECODE_ERROR            50
 212 #define BRCMF_E_MULTICAST_DECODE_ERROR          51
 213 #define BRCMF_E_TRACE                           52
 214 #define BRCMF_E_IF                              54
 215 #define BRCMF_E_RSSI                            56
 216 #define BRCMF_E_PFN_SCAN_COMPLETE               57
 217 #define BRCMF_E_EXTLOG_MSG                      58
 218 #define BRCMF_E_ACTION_FRAME                    59
 219 #define BRCMF_E_ACTION_FRAME_COMPLETE           60
 220 #define BRCMF_E_PRE_ASSOC_IND                   61
 221 #define BRCMF_E_PRE_REASSOC_IND                 62
 222 #define BRCMF_E_CHANNEL_ADOPTED                 63
 223 #define BRCMF_E_AP_STARTED                      64
 224 #define BRCMF_E_DFS_AP_STOP                     65
 225 #define BRCMF_E_DFS_AP_RESUME                   66
 226 #define BRCMF_E_RESERVED1                       67
 227 #define BRCMF_E_RESERVED2                       68
 228 #define BRCMF_E_ESCAN_RESULT                    69
 229 #define BRCMF_E_ACTION_FRAME_OFF_CHAN_COMPLETE  70
 230 #define BRCMF_E_DCS_REQUEST                     73
 231
 232 #define BRCMF_E_FIFO_CREDIT_MAP                 74
 233
 234 #define BRCMF_E_LAST                            75
 235
 236 #define BRCMF_E_STATUS_SUCCESS                  0
 237 #define BRCMF_E_STATUS_FAIL                     1
 238 #define BRCMF_E_STATUS_TIMEOUT                  2
 239 #define BRCMF_E_STATUS_NO_NETWORKS              3
 240 #define BRCMF_E_STATUS_ABORT                    4
 241 #define BRCMF_E_STATUS_NO_ACK                   5
 242 #define BRCMF_E_STATUS_UNSOLICITED              6
 243 #define BRCMF_E_STATUS_ATTEMPT                  7
 244 #define BRCMF_E_STATUS_PARTIAL                  8
 245 #define BRCMF_E_STATUS_NEWSCAN                  9
 246 #define BRCMF_E_STATUS_NEWASSOC                 10
 247 #define BRCMF_E_STATUS_11HQUIET                 11
 248 #define BRCMF_E_STATUS_SUPPRESS                 12
 249 #define BRCMF_E_STATUS_NOCHANS                  13
 250 #define BRCMF_E_STATUS_CS_ABORT                 15
 251 #define BRCMF_E_STATUS_ERROR                    16
 252
 253 #define BRCMF_E_REASON_INITIAL_ASSOC            0
 254 #define BRCMF_E_REASON_LOW_RSSI                 1
 255 #define BRCMF_E_REASON_DEAUTH                   2
 256 #define BRCMF_E_REASON_DISASSOC                 3
 257 #define BRCMF_E_REASON_BCNS_LOST                4
 258 #define BRCMF_E_REASON_MINTXRATE                9
 259 #define BRCMF_E_REASON_TXFAIL                   10
 260
 261 #define BRCMF_E_REASON_FAST_ROAM_FAILED         5
 262 #define BRCMF_E_REASON_DIRECTED_ROAM            6
 263 #define BRCMF_E_REASON_TSPEC_REJECTED           7
 264 #define BRCMF_E_REASON_BETTER_AP                8
 265
 266 #define BRCMF_E_PRUNE_ENCR_MISMATCH             1
 267 #define BRCMF_E_PRUNE_BCAST_BSSID               2
 268 #define BRCMF_E_PRUNE_MAC_DENY                  3
 269 #define BRCMF_E_PRUNE_MAC_NA                    4
 270 #define BRCMF_E_PRUNE_REG_PASSV                 5
 271 #define BRCMF_E_PRUNE_SPCT_MGMT                 6
 272 #define BRCMF_E_PRUNE_RADAR                     7
 273 #define BRCMF_E_RSN_MISMATCH                    8
 274 #define BRCMF_E_PRUNE_NO_COMMON_RATES           9
 275 #define BRCMF_E_PRUNE_BASIC_RATES               10
 276 #define BRCMF_E_PRUNE_CIPHER_NA                 12
 277 #define BRCMF_E_PRUNE_KNOWN_STA                 13
 278 #define BRCMF_E_PRUNE_WDS_PEER                  15
 279 #define BRCMF_E_PRUNE_QBSS_LOAD                 16
 280 #define BRCMF_E_PRUNE_HOME_AP                   17
 281
 282 #define BRCMF_E_SUP_OTHER                       0
 283 #define BRCMF_E_SUP_DECRYPT_KEY_DATA            1
 284 #define BRCMF_E_SUP_BAD_UCAST_WEP128            2
 285 #define BRCMF_E_SUP_BAD_UCAST_WEP40             3
 286 #define BRCMF_E_SUP_UNSUP_KEY_LEN               4
 287 #define BRCMF_E_SUP_PW_KEY_CIPHER               5
 288 #define BRCMF_E_SUP_MSG3_TOO_MANY_IE            6
 289 #define BRCMF_E_SUP_MSG3_IE_MISMATCH            7
 290 #define BRCMF_E_SUP_NO_INSTALL_FLAG             8
 291 #define BRCMF_E_SUP_MSG3_NO_GTK                 9
 292 #define BRCMF_E_SUP_GRP_KEY_CIPHER              10
 293 #define BRCMF_E_SUP_GRP_MSG1_NO_GTK             11
 294 #define BRCMF_E_SUP_GTK_DECRYPT_FAIL            12
 295 #define BRCMF_E_SUP_SEND_FAIL                   13
 296 #define BRCMF_E_SUP_DEAUTH                      14
 297
 298 #define BRCMF_E_IF_ADD                          1
 299 #define BRCMF_E_IF_DEL                          2
 300 #define BRCMF_E_IF_CHANGE                       3
 301
 302 #define BRCMF_E_IF_ROLE_STA                     0
 303 #define BRCMF_E_IF_ROLE_AP                      1
 304 #define BRCMF_E_IF_ROLE_WDS                     2
 305
 306 #define BRCMF_E_LINK_BCN_LOSS                   1
 307 #define BRCMF_E_LINK_DISASSOC                   2
 308 #define BRCMF_E_LINK_ASSOC_REC                  3
 309 #define BRCMF_E_LINK_BSSCFG_DIS                 4
 310
 311 /* The level of bus communication with the dongle */
 312 enum dhd_bus_state {
 313         DHD_BUS_DOWN,           /* Not ready for frame transfers */
 314         DHD_BUS_LOAD,           /* Download access only (CPU reset) */
 315         DHD_BUS_DATA            /* Ready for frame transfers */
 316 };
 317
 318 /* Pattern matching filter. Specifies an offset within received packets to
 319  * start matching, the pattern to match, the size of the pattern, and a bitmask
 320  * that indicates which bits within the pattern should be matched.
 321  */
 322 typedef struct wl_pkt_filter_pattern {
 323         u32 offset;             /* Offset within received packet to start pattern matching.
 324                                  * Offset '0' is the first byte of the ethernet header.
 325                                  */
 326         u32 size_bytes; /* Size of the pattern.  Bitmask must be the same size. */
 327         u8 mask_and_pattern[1]; /* Variable length mask and pattern data.  mask starts
 328                                          * at offset 0.  Pattern immediately follows mask.
 329                                          */
 330 } wl_pkt_filter_pattern_t;
 331
 332 /* IOVAR "pkt_filter_add" parameter. Used to install packet filters. */
 333 typedef struct wl_pkt_filter {
 334         u32 id;         /* Unique filter id, specified by app. */
 335         u32 type;               /* Filter type (WL_PKT_FILTER_TYPE_xxx). */
 336         u32 negate_match;       /* Negate the result of filter matches */
 337         union {                 /* Filter definitions */
 338                 wl_pkt_filter_pattern_t pattern;        /* Pattern matching filter */
 339         } u;
 340 } wl_pkt_filter_t;
 341
 342 /* IOVAR "pkt_filter_enable" parameter. */
 343 typedef struct wl_pkt_filter_enable {
 344         u32 id;         /* Unique filter id */
 345         u32 enable;             /* Enable/disable bool */
 346 } wl_pkt_filter_enable_t;
 347
 348 /* BSS info structure
 349  * Applications MUST CHECK ie_offset field and length field to access IEs and
 350  * next bss_info structure in a vector (in wl_scan_results_t)
 351  */
 352 typedef struct wl_bss_info {
 353         u32 version;            /* version field */
 354         u32 length;             /* byte length of data in this record,
 355                                  * starting at version and including IEs
 356                                  */
 357         u8 BSSID[ETH_ALEN];
 358         u16 beacon_period;      /* units are Kusec */
 359         u16 capability; /* Capability information */
 360         u8 SSID_len;
 361         u8 SSID[32];
 362         struct {
 363                 uint count;     /* # rates in this set */
 364                 u8 rates[16];   /* rates in 500kbps units w/hi bit set if basic */
 365         } rateset;              /* supported rates */
 366         chanspec_t chanspec;    /* chanspec for bss */
 367         u16 atim_window;        /* units are Kusec */
 368         u8 dtim_period; /* DTIM period */
 369         s16 RSSI;               /* receive signal strength (in dBm) */
 370         s8 phy_noise;           /* noise (in dBm) */
 371
 372         u8 n_cap;               /* BSS is 802.11N Capable */
 373         u32 nbss_cap;   /* 802.11N BSS Capabilities (based on HT_CAP_*) */
 374         u8 ctl_ch;              /* 802.11N BSS control channel number */
 375         u32 reserved32[1];      /* Reserved for expansion of BSS properties */
 376         u8 flags;               /* flags */
 377         u8 reserved[3]; /* Reserved for expansion of BSS properties */
 378         u8 basic_mcs[MCSSET_LEN];       /* 802.11N BSS required MCS set */
 379
 380         u16 ie_offset;  /* offset at which IEs start, from beginning */
 381         u32 ie_length;  /* byte length of Information Elements */
 382         s16 SNR;                /* average SNR of during frame reception */
 383         /* Add new fields here */
 384         /* variable length Information Elements */
 385 } wl_bss_info_t;
 386
 387 typedef struct wlc_ssid {
 388         u32 SSID_len;
 389         unsigned char SSID[32];
 390 } wlc_ssid_t;
 391
 392 typedef struct wl_scan_params {
 393         wlc_ssid_t ssid;        /* default: {0, ""} */
 394         u8 bssid[ETH_ALEN];     /* default: bcast */
 395         s8 bss_type;            /* default: any,
 396                                  * DOT11_BSSTYPE_ANY/INFRASTRUCTURE/INDEPENDENT
 397                                  */
 398         u8 scan_type;   /* flags, 0 use default */
 399         s32 nprobes;            /* -1 use default, number of probes per channel */
 400         s32 active_time;        /* -1 use default, dwell time per channel for
 401                                  * active scanning
 402                                  */
 403         s32 passive_time;       /* -1 use default, dwell time per channel
 404                                  * for passive scanning
 405                                  */
 406         s32 home_time;  /* -1 use default, dwell time for the home channel
 407                                  * between channel scans
 408                                  */
 409         s32 channel_num;        /* count of channels and ssids that follow
 410                                  *
 411                                  * low half is count of channels in channel_list, 0
 412                                  * means default (use all available channels)
 413                                  *
 414                                  * high half is entries in wlc_ssid_t array that
 415                                  * follows channel_list, aligned for s32 (4 bytes)
 416                                  * meaning an odd channel count implies a 2-byte pad
 417                                  * between end of channel_list and first ssid
 418                                  *
 419                                  * if ssid count is zero, single ssid in the fixed
 420                                  * parameter portion is assumed, otherwise ssid in
 421                                  * the fixed portion is ignored
 422                                  */
 423         u16 channel_list[1];    /* list of chanspecs */
 424 } wl_scan_params_t;
 425
 426 /* incremental scan struct */
 427 typedef struct wl_iscan_params {
 428         u32 version;
 429         u16 action;
 430         u16 scan_duration;
 431         wl_scan_params_t params;
 432 } wl_iscan_params_t;
 433
 434 /* 3 fields + size of wl_scan_params, not including variable length array */
 435 #define WL_ISCAN_PARAMS_FIXED_SIZE (offsetof(wl_iscan_params_t, params) + sizeof(wlc_ssid_t))
 436
 437 typedef struct wl_scan_results {
 438         u32 buflen;
 439         u32 version;
 440         u32 count;
 441         wl_bss_info_t bss_info[1];
 442 } wl_scan_results_t;
 443
 444 /* used for association with a specific BSSID and chanspec list */
 445 typedef struct wl_assoc_params {
 446         u8 bssid[ETH_ALEN];     /* 00:00:00:00:00:00: broadcast scan */
 447         s32 chanspec_num;       /* 0: all available channels,
 448                                  * otherwise count of chanspecs in chanspec_list
 449                                  */
 450         chanspec_t chanspec_list[1];    /* list of chanspecs */
 451 } wl_assoc_params_t;
 452 #define WL_ASSOC_PARAMS_FIXED_SIZE      (sizeof(wl_assoc_params_t) - sizeof(chanspec_t))
 453
 454 /* used for join with or without a specific bssid and channel list */
 455 typedef struct wl_join_params {
 456         wlc_ssid_t ssid;
 457         wl_assoc_params_t params;       /* optional field, but it must include the fixed portion
 458                                          * of the wl_assoc_params_t struct when it does present.
 459                                          */
 460 } wl_join_params_t;
 461
 462 /* size of wl_scan_results not including variable length array */
 463 #define WL_SCAN_RESULTS_FIXED_SIZE (sizeof(wl_scan_results_t) - sizeof(wl_bss_info_t))
 464
 465 /* incremental scan results struct */
 466 typedef struct wl_iscan_results {
 467         u32 status;
 468         wl_scan_results_t results;
 469 } wl_iscan_results_t;
 470
 471 /* size of wl_iscan_results not including variable length array */
 472 #define WL_ISCAN_RESULTS_FIXED_SIZE \
 473         (WL_SCAN_RESULTS_FIXED_SIZE + offsetof(wl_iscan_results_t, results))
 474
 475 typedef struct wl_wsec_key {
 476         u32 index;              /* key index */
 477         u32 len;                /* key length */
 478         u8 data[WLAN_MAX_KEY_LEN];      /* key data */
 479         u32 pad_1[18];
 480         u32 algo;               /* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
 481         u32 flags;              /* misc flags */
 482         u32 pad_2[2];
 483         int pad_3;
 484         int iv_initialized;     /* has IV been initialized already? */
 485         int pad_4;
 486         /* Rx IV */
 487         struct {
 488                 u32 hi; /* upper 32 bits of IV */
 489                 u16 lo; /* lower 16 bits of IV */
 490         } rxiv;
 491         u32 pad_5[2];
 492         u8 ea[ETH_ALEN];        /* per station */
 493 } wl_wsec_key_t;
 494
 495 /* Used to get specific STA parameters */
 496 typedef struct {
 497         u32 val;
 498         u8 ea[ETH_ALEN];
 499 } scb_val_t;
 500
 501 /* channel encoding */
 502 typedef struct channel_info {
 503         int hw_channel;
 504         int target_channel;
 505         int scan_channel;
 506 } channel_info_t;
 507
 508 /* Linux network driver ioctl encoding */
 509 typedef struct wl_ioctl {
 510         uint cmd;               /* common ioctl definition */
 511         void *buf;              /* pointer to user buffer */
 512         uint len;               /* length of user buffer */
 513         u8 set;         /* get or set request (optional) */
 514         uint used;              /* bytes read or written (optional) */
 515         uint needed;            /* bytes needed (optional) */
 516 } wl_ioctl_t;
 517
 518 /* Forward decls for struct dhd_pub (see below) */
 519 struct dhd_bus;         /* device bus info */
 520 struct brcmf_proto;     /* device communication protocol info */
 521 struct dhd_info;        /* device driver info */
 522
 523 /* Common structure for module and instance linkage */
 524 typedef struct dhd_pub {
 525         /* Linkage ponters */
 526         struct dhd_bus *bus;
 527         struct brcmf_proto *prot;
 528         struct dhd_info *info;
 529
 530         /* Internal dhd items */
 531         bool up;                /* Driver up/down (to OS) */
 532         bool txoff;             /* Transmit flow-controlled */
 533         bool dongle_reset;      /* true = DEVRESET put dongle into reset */
 534         enum dhd_bus_state busstate;
 535         uint hdrlen;            /* Total DHD header length (proto + bus) */
 536         uint maxctl;            /* Max size rxctl request from proto to bus */
 537         uint rxsz;              /* Rx buffer size bus module should use */
 538         u8 wme_dp;              /* wme discard priority */
 539
 540         /* Dongle media info */
 541         bool iswl;              /* Dongle-resident driver is wl */
 542         unsigned long drv_version;      /* Version of dongle-resident driver */
 543         u8 mac[ETH_ALEN];                       /* MAC address obtained from dongle */
 544         dngl_stats_t dstats;            /* Stats for dongle-based data */
 545
 546         /* Additional stats for the bus level */
 547         unsigned long tx_packets;       /* Data packets sent to dongle */
 548         unsigned long tx_multicast;     /* Multicast data packets sent to dongle */
 549         unsigned long tx_errors;        /* Errors in sending data to dongle */
 550         unsigned long tx_ctlpkts;       /* Control packets sent to dongle */
 551         unsigned long tx_ctlerrs;       /* Errors sending control frames to dongle */
 552         unsigned long rx_packets;       /* Packets sent up the network interface */
 553         unsigned long rx_multicast;     /* Multicast packets sent up the network
 554                                          interface */
 555         unsigned long rx_errors;        /* Errors processing rx data packets */
 556         unsigned long rx_ctlpkts;       /* Control frames processed from dongle */
 557         unsigned long rx_ctlerrs;       /* Errors in processing rx control frames */
 558         unsigned long rx_dropped;       /* Packets dropped locally (no memory) */
 559         unsigned long rx_flushed;       /* Packets flushed due to
 560                                 unscheduled sendup thread */
 561         unsigned long wd_dpc_sched;     /* Number of times dhd dpc scheduled by
 562                                          watchdog timer */
 563
 564         unsigned long rx_readahead_cnt; /* Number of packets where header read-ahead
 565                                          was used. */
 566         unsigned long tx_realloc;       /* Number of tx packets we had to realloc for
 567                                          headroom */
 568         unsigned long fc_packets;       /* Number of flow control pkts recvd */
 569
 570         /* Last error return */
 571         int bcmerror;
 572         uint tickcnt;
 573
 574         /* Last error from dongle */
 575         int dongle_error;
 576
 577         /* Suspend disable flag  flag */
 578         int suspend_disable_flag;       /* "1" to disable all extra powersaving
 579                                          during suspend */
 580         int in_suspend;         /* flag set to 1 when early suspend called */
 581         int dtim_skip;          /* dtim skip , default 0 means wake each dtim */
 582
 583         /* Pkt filter defination */
 584         char *pktfilter[100];
 585         int pktfilter_count;
 586
 587         u8 country_code[WLC_CNTRY_BUF_SZ];
 588         char eventmask[WL_EVENTING_MASK_LEN];
 589
 590 } dhd_pub_t;
 591
 592 typedef struct dhd_if_event {
 593         u8 ifidx;
 594         u8 action;
 595         u8 flags;
 596         u8 bssidx;
 597 } dhd_if_event_t;
 598
 599 typedef struct {
 600         u32 limit;              /* Expiration time (usec) */
 601         u32 increment;  /* Current expiration increment (usec) */
 602         u32 elapsed;            /* Current elapsed time (usec) */
 603         u32 tick;               /* O/S tick time (usec) */
 604 } dhd_timeout_t;
 605
 606 typedef struct {
 607         uint event;
 608         const char *name;
 609 } bcmevent_name_t;
 610
 611 #if defined(CONFIG_PM_SLEEP)
 612 extern atomic_t brcmf_mmc_suspend;
 613 #define DHD_PM_RESUME_WAIT_INIT(a) DECLARE_WAIT_QUEUE_HEAD(a);
 614 #define _DHD_PM_RESUME_WAIT(a, b) do { \
 615                 int retry = 0; \
 616                 while (atomic_read(&brcmf_mmc_suspend) && retry++ != b) { \
 617                         wait_event_timeout(a, false, HZ/100); \
 618                 } \
 619         }       while (0)
 620 #define DHD_PM_RESUME_WAIT(a)   _DHD_PM_RESUME_WAIT(a, 30)
 621 #define DHD_PM_RESUME_WAIT_FOREVER(a)   _DHD_PM_RESUME_WAIT(a, ~0)
 622 #define DHD_PM_RESUME_RETURN_ERROR(a)   \
 623         do { if (atomic_read(&brcmf_mmc_suspend)) return a; } while (0)
 624 #define DHD_PM_RESUME_RETURN    do { \
 625         if (atomic_read(&brcmf_mmc_suspend)) \
 626                 return; \
 627         } while (0)
 628
 629 #define DHD_SPINWAIT_SLEEP_INIT(a) DECLARE_WAIT_QUEUE_HEAD(a);
 630 #define SPINWAIT_SLEEP(a, exp, us) do { \
 631                 uint countdown = (us) + 9999; \
 632                 while ((exp) && (countdown >= 10000)) { \
 633                         wait_event_timeout(a, false, HZ/100); \
 634                         countdown -= 10000; \
 635                 } \
 636         } while (0)
 637
 638 #else
 639
 640 #define DHD_PM_RESUME_WAIT_INIT(a)
 641 #define DHD_PM_RESUME_WAIT(a)
 642 #define DHD_PM_RESUME_WAIT_FOREVER(a)
 643 #define DHD_PM_RESUME_RETURN_ERROR(a)
 644 #define DHD_PM_RESUME_RETURN
 645
 646 #define DHD_SPINWAIT_SLEEP_INIT(a)
 647 #define SPINWAIT_SLEEP(a, exp, us)  do { \
 648                 uint countdown = (us) + 9; \
 649                 while ((exp) && (countdown >= 10)) { \
 650                         udelay(10);  \
 651                         countdown -= 10;  \
 652                 } \
 653         } while (0)
 654
 655 #endif  /* defined(CONFIG_PM_SLEEP) */
 656
 657 /*
 658  * Insmod parameters for debug/test
 659  */
 660
 661 /* Use interrupts */
 662 extern uint brcmf_intr;
 663
 664 /* Use polling */
 665 extern uint brcmf_poll;
 666
 667 /* ARP offload agent mode */
 668 extern uint brcmf_arp_mode;
 669
 670 /* ARP offload enable */
 671 extern uint brcmf_arp_enable;
 672
 673 /* Pkt filte enable control */
 674 extern uint brcmf_pkt_filter_enable;
 675
 676 /*  Pkt filter init setup */
 677 extern uint brcmf_pkt_filter_init;
 678
 679 /* Pkt filter mode control */
 680 extern uint brcmf_master_mode;
 681
 682 /* Roaming mode control */
 683 extern uint brcmf_roam;
 684
 685 /* Roaming mode control */
 686 extern uint brcmf_radio_up;
 687
 688 /* Initial idletime ticks (may be -1 for immediate idle, 0 for no idle) */
 689 extern int brcmf_idletime;
 690 #define BRCMF_IDLETIME_TICKS 1
 691
 692 /* SDIO Drive Strength */
 693 extern uint brcmf_sdiod_drive_strength;
 694
 695 /* Override to force tx queueing all the time */
 696 extern uint brcmf_force_tx_queueing;
 697
 698 #ifdef SDTEST
 699 /* Echo packet generator (SDIO), pkts/s */
 700 extern uint brcmf_pktgen;
 701
 702 /* Echo packet len (0 => sawtooth, max 1800) */
 703 extern uint brcmf_pktgen_len;
 704 #define BRCMF_MAX_PKTGEN_LEN 1800
 705 #endif
 706
 707 extern u32 g_assert_type;
 708 extern const bcmevent_name_t bcmevent_names[];
 709 extern const int bcmevent_names_size;
 710
 711
 712 static inline void MUTEX_LOCK_INIT(dhd_pub_t *dhdp)
 713 {
 714 }
 715
 716 static inline void MUTEX_LOCK(dhd_pub_t *dhdp)
 717 {
 718 }
 719
 720 static inline void MUTEX_UNLOCK(dhd_pub_t *dhdp)
 721 {
 722 }
 723
 724 static inline void MUTEX_LOCK_SOFTAP_SET_INIT(dhd_pub_t *dhdp)
 725 {
 726 }
 727
 728 static inline void MUTEX_LOCK_SOFTAP_SET(dhd_pub_t *dhdp)
 729 {
 730 }
 731
 732 static inline void MUTEX_UNLOCK_SOFTAP_SET(dhd_pub_t *dhdp)
 733 {
 734 }
 735
 736 static inline void MUTEX_LOCK_WL_SCAN_SET_INIT(void)
 737 {
 738 }
 739
 740 static inline void MUTEX_LOCK_WL_SCAN_SET(void)
 741 {
 742 }
 743
 744 static inline void MUTEX_UNLOCK_WL_SCAN_SET(void)
 745 {
 746 }
 747
 748 /*
 749  * Exported from dhd OS modules (dhd_linux/dhd_ndis)
 750  */
 751
 752 /* Indication from bus module regarding presence/insertion of dongle.
 753  * Return dhd_pub_t pointer, used as handle to OS module in later calls.
 754  * Returned structure should have bus and prot pointers filled in.
 755  * bus_hdrlen specifies required headroom for bus module header.
 756  */
 757 extern dhd_pub_t *brcmf_attach(struct dhd_bus *bus,
 758                                 uint bus_hdrlen);
 759 extern int brcmf_net_attach(dhd_pub_t *dhdp, int idx);
 760 extern int brcmf_netdev_wait_pend8021x(struct net_device *dev);
 761
 762 /* Indication from bus module regarding removal/absence of dongle */
 763 extern void brcmf_detach(dhd_pub_t *dhdp);
 764
 765 /* Indication from bus module to change flow-control state */
 766 extern void brcmf_txflowcontrol(dhd_pub_t *dhdp, int ifidx, bool on);
 767
 768 extern bool brcmf_c_prec_enq(dhd_pub_t *dhdp, struct pktq *q,
 769                          struct sk_buff *pkt, int prec);
 770
 771 /* Receive frame for delivery to OS.  Callee disposes of rxp. */
 772 extern void brcmf_rx_frame(dhd_pub_t *dhdp, int ifidx,
 773                          struct sk_buff *rxp, int numpkt);
 774
 775 /* Return pointer to interface name */
 776 extern char *brcmf_ifname(dhd_pub_t *dhdp, int idx);
 777
 778 /* Request scheduling of the bus dpc */
 779 extern void brcmf_sched_dpc(dhd_pub_t *dhdp);
 780
 781 /* Notify tx completion */
 782 extern void brcmf_txcomplete(dhd_pub_t *dhdp, struct sk_buff *txp,
 783                              bool success);
 784
 785 /* Query ioctl */
 786 extern int brcmf_proto_cdc_query_ioctl(dhd_pub_t *dhd, int ifidx, uint cmd,
 787                                        void *buf, uint len);
 788
 789 /* OS independent layer functions */
 790 extern int brcmf_os_proto_block(dhd_pub_t *pub);
 791 extern int brcmf_os_proto_unblock(dhd_pub_t *pub);
 792 extern int brcmf_os_ioctl_resp_wait(dhd_pub_t *pub, uint *condition,
 793                                   bool *pending);
 794 extern int brcmf_os_ioctl_resp_wake(dhd_pub_t *pub);
 795 extern unsigned int brcmf_os_get_ioctl_resp_timeout(void);
 796 extern void brcmf_os_set_ioctl_resp_timeout(unsigned int timeout_msec);
 797 extern void brcmf_os_sdlock_sndup_rxq(dhd_pub_t *pub);
 798 extern void brcmf_customer_gpio_wlan_ctrl(int onoff);
 799 extern int brcmf_custom_get_mac_address(unsigned char *buf);
 800 extern void brcmf_os_sdunlock_sndup_rxq(dhd_pub_t *pub);
 801 extern void brcmf_os_sdlock_eventq(dhd_pub_t *pub);
 802 extern void brcmf_os_sdunlock_eventq(dhd_pub_t *pub);
 803 #ifdef BCMDBG
 804 extern int brcmf_write_to_file(dhd_pub_t *dhd, u8 *buf, int size);
 805 #endif                          /* BCMDBG */
 806
 807 extern void brcmf_timeout_start(dhd_timeout_t *tmo, uint usec);
 808 extern int brcmf_timeout_expired(dhd_timeout_t *tmo);
 809
 810 extern int brcmf_ifname2idx(struct dhd_info *dhd, char *name);
 811 extern int brcmf_c_host_event(struct dhd_info *dhd, int *idx, void *pktdata,
 812                          brcmf_event_msg_t *, void **data_ptr);
 813
 814 extern void brcmf_c_init(void);
 815
 816 extern int brcmf_add_if(struct dhd_info *dhd, int ifidx, void *handle,
 817                       char *name, u8 *mac_addr, u32 flags, u8 bssidx);
 818 extern void brcmf_del_if(struct dhd_info *dhd, int ifidx);
 819
 820 extern void brcmf_vif_add(struct dhd_info *dhd, int ifidx, char *name);
 821 extern void brcmf_vif_del(struct dhd_info *dhd, int ifidx);
 822
 823 extern void brcmf_event(struct dhd_info *dhd, char *evpkt, int evlen,
 824                         int ifidx);
 825 extern void brcmf_vif_sendup(struct dhd_info *dhd, int ifidx,
 826                              unsigned char *cp, int len);
 827
 828 /* Send packet to dongle via data channel */
 829 extern int brcmf_sendpkt(dhd_pub_t *dhdp, int ifidx, struct sk_buff *pkt);
 830
 831 extern int brcmf_bus_devreset(dhd_pub_t *dhdp, u8 flag);
 832 extern int brcmf_bus_start(dhd_pub_t *dhdp);
 833
 834 extern void brcmf_c_pktfilter_offload_set(dhd_pub_t *dhd, char *arg);
 835 extern void brcmf_c_pktfilter_offload_enable(dhd_pub_t *dhd, char *arg,
 836                                              int enable, int master_mode);
 837
 838 #ifdef BCMDBG
 839 #define ASSERT(exp) \
 840           do { if (!(exp)) osl_assert(#exp, __FILE__, __LINE__); } while (0)
 841 extern void osl_assert(char *exp, char *file, int line);
 842 #else
 843 #define ASSERT(exp)     do {} while (0)
 844 #endif  /* defined(BCMDBG) */
 845
 846 /* Linux network driver ioctl encoding */
 847 typedef struct dhd_ioctl {
 848         uint cmd;               /* common ioctl definition */
 849         void *buf;              /* pointer to user buffer */
 850         uint len;               /* length of user buffer */
 851         bool set;               /* get or set request (optional) */
 852         uint used;              /* bytes read or written (optional) */
 853         uint needed;            /* bytes needed (optional) */
 854         uint driver;            /* to identify target driver */
 855 } dhd_ioctl_t;
 856
 857 /* per-driver magic numbers */
 858 #define DHD_IOCTL_MAGIC         0x00444944
 859
 860 /* bump this number if you change the ioctl interface */
 861 #define DHD_IOCTL_VERSION       1
 862
 863 #define DHD_IOCTL_MAXLEN        8192    /* max length ioctl buffer required */
 864 #define DHD_IOCTL_SMLEN 256     /* "small" length ioctl buffer required */
 865
 866 /* common ioctl definitions */
 867 #define DHD_GET_MAGIC                           0
 868 #define DHD_GET_VERSION                         1
 869 #define DHD_GET_VAR                             2
 870 #define DHD_SET_VAR                             3
 871
 872 /* message levels */
 873 #define DHD_ERROR_VAL   0x0001
 874 #define DHD_TRACE_VAL   0x0002
 875 #define DHD_INFO_VAL    0x0004
 876 #define DHD_DATA_VAL    0x0008
 877 #define DHD_CTL_VAL     0x0010
 878 #define DHD_TIMER_VAL   0x0020
 879 #define DHD_HDRS_VAL    0x0040
 880 #define DHD_BYTES_VAL   0x0080
 881 #define DHD_INTR_VAL    0x0100
 882 #define DHD_LOG_VAL     0x0200
 883 #define DHD_GLOM_VAL    0x0400
 884 #define DHD_EVENT_VAL   0x0800
 885 #define DHD_BTA_VAL     0x1000
 886 #define DHD_ISCAN_VAL 0x2000
 887
 888 #ifdef SDTEST
 889 /* For pktgen iovar */
 890 typedef struct brcmf_pktgen {
 891         uint version;           /* To allow structure change tracking */
 892         uint freq;              /* Max ticks between tx/rx attempts */
 893         uint count;             /* Test packets to send/rcv each attempt */
 894         uint print;             /* Print counts every <print> attempts */
 895         uint total;             /* Total packets (or bursts) */
 896         uint minlen;            /* Minimum length of packets to send */
 897         uint maxlen;            /* Maximum length of packets to send */
 898         uint numsent;           /* Count of test packets sent */
 899         uint numrcvd;           /* Count of test packets received */
 900         uint numfail;           /* Count of test send failures */
 901         uint mode;              /* Test mode (type of test packets) */
 902         uint stop;              /* Stop after this many tx failures */
 903 } brcmf_pktgen_t;
 904
 905 /* Version in case structure changes */
 906 #define DHD_PKTGEN_VERSION 2
 907
 908 /* Type of test packets to use */
 909 #define DHD_PKTGEN_ECHO         1       /* Send echo requests */
 910 #define DHD_PKTGEN_SEND         2       /* Send discard packets */
 911 #define DHD_PKTGEN_RXBURST      3       /* Request dongle send N packets */
 912 #define DHD_PKTGEN_RECV         4       /* Continuous rx from continuous
 913                                          tx dongle */
 914 #endif                          /* SDTEST */
 915
 916 /* Enter idle immediately (no timeout) */
 917 #define DHD_IDLE_IMMEDIATE      (-1)
 918
 919 /* Values for idleclock iovar: other values are the sd_divisor to use
 920          when idle */
 921 #define DHD_IDLE_ACTIVE 0       /* Do not request any SD clock change
 922                                  when idle */
 923 #define DHD_IDLE_STOP   (-1)    /* Request SD clock be stopped
 924                                  (and use SD1 mode) */
 925
 926 #endif                          /* _dhd_h_ */