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 _BRCMF_H_
  22 #define _BRCMF_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 BRCMF_EVENTING_MASK_LEN 16
  87
  88 #define TOE_TX_CSUM_OL          0x00000001
  89 #define TOE_RX_CSUM_OL          0x00000002
  90
  91 #define BRCMF_BSS_INFO_VERSION  108 /* current ver of brcmf_bss_info struct */
  92
  93 /* size of brcmf_scan_params not including variable length array */
  94 #define BRCMF_SCAN_PARAMS_FIXED_SIZE 64
  95
  96 /* masks for channel and ssid count */
  97 #define BRCMF_SCAN_PARAMS_COUNT_MASK 0x0000ffff
  98 #define BRCMF_SCAN_PARAMS_NSSID_SHIFT 16
  99
 100 #define BRCMF_SCAN_ACTION_START      1
 101 #define BRCMF_SCAN_ACTION_CONTINUE   2
 102 #define WL_SCAN_ACTION_ABORT      3
 103
 104 #define BRCMF_ISCAN_REQ_VERSION 1
 105
 106 /* brcmf_iscan_results status values */
 107 #define BRCMF_SCAN_RESULTS_SUCCESS      0
 108 #define BRCMF_SCAN_RESULTS_PARTIAL      1
 109 #define BRCMF_SCAN_RESULTS_PENDING      2
 110 #define BRCMF_SCAN_RESULTS_ABORTED      3
 111 #define BRCMF_SCAN_RESULTS_NO_MEM       4
 112
 113 /* Indicates this key is using soft encrypt */
 114 #define WL_SOFT_KEY     (1 << 0)
 115 /* primary (ie tx) key */
 116 #define BRCMF_PRIMARY_KEY       (1 << 1)
 117 /* Reserved for backward compat */
 118 #define WL_KF_RES_4     (1 << 4)
 119 /* Reserved for backward compat */
 120 #define WL_KF_RES_5     (1 << 5)
 121 /* Indicates a group key for a IBSS PEER */
 122 #define WL_IBSS_PEER_GROUP_KEY  (1 << 6)
 123
 124 /* For supporting multiple interfaces */
 125 #define BRCMF_MAX_IFS   16
 126 #define BRCMF_DEL_IF    -0xe
 127 #define BRCMF_BAD_IF    -0xf
 128
 129 #define DOT11_BSSTYPE_ANY                       2
 130 #define DOT11_MAX_DEFAULT_KEYS  4
 131
 132 #define BRCMF_EVENT_MSG_LINK            0x01
 133 #define BRCMF_EVENT_MSG_FLUSHTXQ        0x02
 134 #define BRCMF_EVENT_MSG_GROUP           0x04
 135
 136 struct brcmf_event_msg {
 137         u16 version;
 138         u16 flags;
 139         u32 event_type;
 140         u32 status;
 141         u32 reason;
 142         u32 auth_type;
 143         u32 datalen;
 144         u8 addr[ETH_ALEN];
 145         char ifname[IFNAMSIZ];
 146 } __packed;
 147
 148 struct brcm_ethhdr {
 149         u16 subtype;
 150         u16 length;
 151         u8 version;
 152         u8 oui[3];
 153         u16 usr_subtype;
 154 } __packed;
 155
 156 struct brcmf_event {
 157         struct ethhdr eth;
 158         struct brcm_ethhdr hdr;
 159         struct brcmf_event_msg msg;
 160 } __packed;
 161
 162 struct dngl_stats {
 163         unsigned long rx_packets;       /* total packets received */
 164         unsigned long tx_packets;       /* total packets transmitted */
 165         unsigned long rx_bytes; /* total bytes received */
 166         unsigned long tx_bytes; /* total bytes transmitted */
 167         unsigned long rx_errors;        /* bad packets received */
 168         unsigned long tx_errors;        /* packet transmit problems */
 169         unsigned long rx_dropped;       /* packets dropped by dongle */
 170         unsigned long tx_dropped;       /* packets dropped by dongle */
 171         unsigned long multicast;        /* multicast packets received */
 172 };
 173
 174 #define BRCMF_E_SET_SSID                        0
 175 #define BRCMF_E_JOIN                            1
 176 #define BRCMF_E_START                           2
 177 #define BRCMF_E_AUTH                            3
 178 #define BRCMF_E_AUTH_IND                        4
 179 #define BRCMF_E_DEAUTH                          5
 180 #define BRCMF_E_DEAUTH_IND                      6
 181 #define BRCMF_E_ASSOC                           7
 182 #define BRCMF_E_ASSOC_IND                       8
 183 #define BRCMF_E_REASSOC                         9
 184 #define BRCMF_E_REASSOC_IND                     10
 185 #define BRCMF_E_DISASSOC                        11
 186 #define BRCMF_E_DISASSOC_IND                    12
 187 #define BRCMF_E_QUIET_START                     13
 188 #define BRCMF_E_QUIET_END                       14
 189 #define BRCMF_E_BEACON_RX                       15
 190 #define BRCMF_E_LINK                            16
 191 #define BRCMF_E_MIC_ERROR                       17
 192 #define BRCMF_E_NDIS_LINK                       18
 193 #define BRCMF_E_ROAM                            19
 194 #define BRCMF_E_TXFAIL                          20
 195 #define BRCMF_E_PMKID_CACHE                     21
 196 #define BRCMF_E_RETROGRADE_TSF                  22
 197 #define BRCMF_E_PRUNE                           23
 198 #define BRCMF_E_AUTOAUTH                        24
 199 #define BRCMF_E_EAPOL_MSG                       25
 200 #define BRCMF_E_SCAN_COMPLETE                   26
 201 #define BRCMF_E_ADDTS_IND                       27
 202 #define BRCMF_E_DELTS_IND                       28
 203 #define BRCMF_E_BCNSENT_IND                     29
 204 #define BRCMF_E_BCNRX_MSG                       30
 205 #define BRCMF_E_BCNLOST_MSG                     31
 206 #define BRCMF_E_ROAM_PREP                       32
 207 #define BRCMF_E_PFN_NET_FOUND                   33
 208 #define BRCMF_E_PFN_NET_LOST                    34
 209 #define BRCMF_E_RESET_COMPLETE                  35
 210 #define BRCMF_E_JOIN_START                      36
 211 #define BRCMF_E_ROAM_START                      37
 212 #define BRCMF_E_ASSOC_START                     38
 213 #define BRCMF_E_IBSS_ASSOC                      39
 214 #define BRCMF_E_RADIO                           40
 215 #define BRCMF_E_PSM_WATCHDOG                    41
 216 #define BRCMF_E_PROBREQ_MSG                     44
 217 #define BRCMF_E_SCAN_CONFIRM_IND                45
 218 #define BRCMF_E_PSK_SUP                         46
 219 #define BRCMF_E_COUNTRY_CODE_CHANGED            47
 220 #define BRCMF_E_EXCEEDED_MEDIUM_TIME            48
 221 #define BRCMF_E_ICV_ERROR                       49
 222 #define BRCMF_E_UNICAST_DECODE_ERROR            50
 223 #define BRCMF_E_MULTICAST_DECODE_ERROR          51
 224 #define BRCMF_E_TRACE                           52
 225 #define BRCMF_E_IF                              54
 226 #define BRCMF_E_RSSI                            56
 227 #define BRCMF_E_PFN_SCAN_COMPLETE               57
 228 #define BRCMF_E_EXTLOG_MSG                      58
 229 #define BRCMF_E_ACTION_FRAME                    59
 230 #define BRCMF_E_ACTION_FRAME_COMPLETE           60
 231 #define BRCMF_E_PRE_ASSOC_IND                   61
 232 #define BRCMF_E_PRE_REASSOC_IND                 62
 233 #define BRCMF_E_CHANNEL_ADOPTED                 63
 234 #define BRCMF_E_AP_STARTED                      64
 235 #define BRCMF_E_DFS_AP_STOP                     65
 236 #define BRCMF_E_DFS_AP_RESUME                   66
 237 #define BRCMF_E_RESERVED1                       67
 238 #define BRCMF_E_RESERVED2                       68
 239 #define BRCMF_E_ESCAN_RESULT                    69
 240 #define BRCMF_E_ACTION_FRAME_OFF_CHAN_COMPLETE  70
 241 #define BRCMF_E_DCS_REQUEST                     73
 242
 243 #define BRCMF_E_FIFO_CREDIT_MAP                 74
 244
 245 #define BRCMF_E_LAST                            75
 246
 247 #define BRCMF_E_STATUS_SUCCESS                  0
 248 #define BRCMF_E_STATUS_FAIL                     1
 249 #define BRCMF_E_STATUS_TIMEOUT                  2
 250 #define BRCMF_E_STATUS_NO_NETWORKS              3
 251 #define BRCMF_E_STATUS_ABORT                    4
 252 #define BRCMF_E_STATUS_NO_ACK                   5
 253 #define BRCMF_E_STATUS_UNSOLICITED              6
 254 #define BRCMF_E_STATUS_ATTEMPT                  7
 255 #define BRCMF_E_STATUS_PARTIAL                  8
 256 #define BRCMF_E_STATUS_NEWSCAN                  9
 257 #define BRCMF_E_STATUS_NEWASSOC                 10
 258 #define BRCMF_E_STATUS_11HQUIET                 11
 259 #define BRCMF_E_STATUS_SUPPRESS                 12
 260 #define BRCMF_E_STATUS_NOCHANS                  13
 261 #define BRCMF_E_STATUS_CS_ABORT                 15
 262 #define BRCMF_E_STATUS_ERROR                    16
 263
 264 #define BRCMF_E_REASON_INITIAL_ASSOC            0
 265 #define BRCMF_E_REASON_LOW_RSSI                 1
 266 #define BRCMF_E_REASON_DEAUTH                   2
 267 #define BRCMF_E_REASON_DISASSOC                 3
 268 #define BRCMF_E_REASON_BCNS_LOST                4
 269 #define BRCMF_E_REASON_MINTXRATE                9
 270 #define BRCMF_E_REASON_TXFAIL                   10
 271
 272 #define BRCMF_E_REASON_FAST_ROAM_FAILED         5
 273 #define BRCMF_E_REASON_DIRECTED_ROAM            6
 274 #define BRCMF_E_REASON_TSPEC_REJECTED           7
 275 #define BRCMF_E_REASON_BETTER_AP                8
 276
 277 #define BRCMF_E_PRUNE_ENCR_MISMATCH             1
 278 #define BRCMF_E_PRUNE_BCAST_BSSID               2
 279 #define BRCMF_E_PRUNE_MAC_DENY                  3
 280 #define BRCMF_E_PRUNE_MAC_NA                    4
 281 #define BRCMF_E_PRUNE_REG_PASSV                 5
 282 #define BRCMF_E_PRUNE_SPCT_MGMT                 6
 283 #define BRCMF_E_PRUNE_RADAR                     7
 284 #define BRCMF_E_RSN_MISMATCH                    8
 285 #define BRCMF_E_PRUNE_NO_COMMON_RATES           9
 286 #define BRCMF_E_PRUNE_BASIC_RATES               10
 287 #define BRCMF_E_PRUNE_CIPHER_NA                 12
 288 #define BRCMF_E_PRUNE_KNOWN_STA                 13
 289 #define BRCMF_E_PRUNE_WDS_PEER                  15
 290 #define BRCMF_E_PRUNE_QBSS_LOAD                 16
 291 #define BRCMF_E_PRUNE_HOME_AP                   17
 292
 293 #define BRCMF_E_SUP_OTHER                       0
 294 #define BRCMF_E_SUP_DECRYPT_KEY_DATA            1
 295 #define BRCMF_E_SUP_BAD_UCAST_WEP128            2
 296 #define BRCMF_E_SUP_BAD_UCAST_WEP40             3
 297 #define BRCMF_E_SUP_UNSUP_KEY_LEN               4
 298 #define BRCMF_E_SUP_PW_KEY_CIPHER               5
 299 #define BRCMF_E_SUP_MSG3_TOO_MANY_IE            6
 300 #define BRCMF_E_SUP_MSG3_IE_MISMATCH            7
 301 #define BRCMF_E_SUP_NO_INSTALL_FLAG             8
 302 #define BRCMF_E_SUP_MSG3_NO_GTK                 9
 303 #define BRCMF_E_SUP_GRP_KEY_CIPHER              10
 304 #define BRCMF_E_SUP_GRP_MSG1_NO_GTK             11
 305 #define BRCMF_E_SUP_GTK_DECRYPT_FAIL            12
 306 #define BRCMF_E_SUP_SEND_FAIL                   13
 307 #define BRCMF_E_SUP_DEAUTH                      14
 308
 309 #define BRCMF_E_IF_ADD                          1
 310 #define BRCMF_E_IF_DEL                          2
 311 #define BRCMF_E_IF_CHANGE                       3
 312
 313 #define BRCMF_E_IF_ROLE_STA                     0
 314 #define BRCMF_E_IF_ROLE_AP                      1
 315 #define BRCMF_E_IF_ROLE_WDS                     2
 316
 317 #define BRCMF_E_LINK_BCN_LOSS                   1
 318 #define BRCMF_E_LINK_DISASSOC                   2
 319 #define BRCMF_E_LINK_ASSOC_REC                  3
 320 #define BRCMF_E_LINK_BSSCFG_DIS                 4
 321
 322 /* The level of bus communication with the dongle */
 323 enum brcmf_bus_state {
 324         BRCMF_BUS_DOWN,         /* Not ready for frame transfers */
 325         BRCMF_BUS_LOAD,         /* Download access only (CPU reset) */
 326         BRCMF_BUS_DATA          /* Ready for frame transfers */
 327 };
 328
 329 /* Pattern matching filter. Specifies an offset within received packets to
 330  * start matching, the pattern to match, the size of the pattern, and a bitmask
 331  * that indicates which bits within the pattern should be matched.
 332  */
 333 struct brcmf_pkt_filter_pattern {
 334         /*
 335          * Offset within received packet to start pattern matching.
 336          * Offset '0' is the first byte of the ethernet header.
 337          */
 338         u32 offset;
 339         /* Size of the pattern.  Bitmask must be the same size.*/
 340         u32 size_bytes;
 341         /*
 342          * Variable length mask and pattern data. mask starts at offset 0.
 343          * Pattern immediately follows mask.
 344          */
 345         u8 mask_and_pattern[1];
 346 };
 347
 348 /* IOVAR "pkt_filter_add" parameter. Used to install packet filters. */
 349 struct brcmf_pkt_filter {
 350         u32 id;         /* Unique filter id, specified by app. */
 351         u32 type;               /* Filter type (WL_PKT_FILTER_TYPE_xxx). */
 352         u32 negate_match;       /* Negate the result of filter matches */
 353         union {                 /* Filter definitions */
 354                 struct brcmf_pkt_filter_pattern pattern; /* Filter pattern */
 355         } u;
 356 };
 357
 358 /* IOVAR "pkt_filter_enable" parameter. */
 359 struct brcmf_pkt_filter_enable {
 360         u32 id;         /* Unique filter id */
 361         u32 enable;             /* Enable/disable bool */
 362 };
 363
 364 /* BSS info structure
 365  * Applications MUST CHECK ie_offset field and length field to access IEs and
 366  * next bss_info structure in a vector (in struct brcmf_scan_results)
 367  */
 368 struct brcmf_bss_info {
 369         u32 version;            /* version field */
 370         u32 length;             /* byte length of data in this record,
 371                                  * starting at version and including IEs
 372                                  */
 373         u8 BSSID[ETH_ALEN];
 374         u16 beacon_period;      /* units are Kusec */
 375         u16 capability; /* Capability information */
 376         u8 SSID_len;
 377         u8 SSID[32];
 378         struct {
 379                 uint count;   /* # rates in this set */
 380                 u8 rates[16]; /* rates in 500kbps units w/hi bit set if basic */
 381         } rateset;              /* supported rates */
 382         u16 chanspec;   /* chanspec for bss */
 383         u16 atim_window;        /* units are Kusec */
 384         u8 dtim_period; /* DTIM period */
 385         s16 RSSI;               /* receive signal strength (in dBm) */
 386         s8 phy_noise;           /* noise (in dBm) */
 387
 388         u8 n_cap;               /* BSS is 802.11N Capable */
 389         u32 nbss_cap;   /* 802.11N BSS Capabilities (based on HT_CAP_*) */
 390         u8 ctl_ch;              /* 802.11N BSS control channel number */
 391         u32 reserved32[1];      /* Reserved for expansion of BSS properties */
 392         u8 flags;               /* flags */
 393         u8 reserved[3]; /* Reserved for expansion of BSS properties */
 394         u8 basic_mcs[MCSSET_LEN];       /* 802.11N BSS required MCS set */
 395
 396         u16 ie_offset;  /* offset at which IEs start, from beginning */
 397         u32 ie_length;  /* byte length of Information Elements */
 398         s16 SNR;                /* average SNR of during frame reception */
 399         /* Add new fields here */
 400         /* variable length Information Elements */
 401 };
 402
 403 struct brcmf_ssid {
 404         u32 SSID_len;
 405         unsigned char SSID[32];
 406 };
 407
 408 struct brcmf_ssid_le {
 409         __le32 SSID_len;
 410         unsigned char SSID[32];
 411 };
 412
 413 struct brcmf_scan_params_le {
 414         struct brcmf_ssid_le ssid_le;   /* default: {0, ""} */
 415         u8 bssid[ETH_ALEN];     /* default: bcast */
 416         s8 bss_type;            /* default: any,
 417                                  * DOT11_BSSTYPE_ANY/INFRASTRUCTURE/INDEPENDENT
 418                                  */
 419         u8 scan_type;   /* flags, 0 use default */
 420         __le32 nprobes;   /* -1 use default, number of probes per channel */
 421         __le32 active_time;     /* -1 use default, dwell time per channel for
 422                                  * active scanning
 423                                  */
 424         __le32 passive_time;    /* -1 use default, dwell time per channel
 425                                  * for passive scanning
 426                                  */
 427         __le32 home_time;       /* -1 use default, dwell time for the
 428                                  * home channel between channel scans
 429                                  */
 430         __le32 channel_num;     /* count of channels and ssids that follow
 431                                  *
 432                                  * low half is count of channels in
 433                                  * channel_list, 0 means default (use all
 434                                  * available channels)
 435                                  *
 436                                  * high half is entries in struct brcmf_ssid
 437                                  * array that follows channel_list, aligned for
 438                                  * s32 (4 bytes) meaning an odd channel count
 439                                  * implies a 2-byte pad between end of
 440                                  * channel_list and first ssid
 441                                  *
 442                                  * if ssid count is zero, single ssid in the
 443                                  * fixed parameter portion is assumed, otherwise
 444                                  * ssid in the fixed portion is ignored
 445                                  */
 446         __le16 channel_list[1]; /* list of chanspecs */
 447 };
 448
 449 /* incremental scan struct */
 450 struct brcmf_iscan_params_le {
 451         __le32 version;
 452         __le16 action;
 453         __le16 scan_duration;
 454         struct brcmf_scan_params_le params_le;
 455 };
 456
 457 struct brcmf_scan_results {
 458         u32 buflen;
 459         u32 version;
 460         u32 count;
 461         struct brcmf_bss_info bss_info[1];
 462 };
 463
 464 /* used for association with a specific BSSID and chanspec list */
 465 struct brcmf_assoc_params_le {
 466         /* 00:00:00:00:00:00: broadcast scan */
 467         u8 bssid[ETH_ALEN];
 468         /* 0: all available channels, otherwise count of chanspecs in
 469          * chanspec_list */
 470         __le32 chanspec_num;
 471         /* list of chanspecs */
 472         __le16 chanspec_list[1];
 473 };
 474
 475 /* used for join with or without a specific bssid and channel list */
 476 struct brcmf_join_params {
 477         struct brcmf_ssid_le ssid_le;
 478         struct brcmf_assoc_params_le params_le;
 479 };
 480
 481 /* size of brcmf_scan_results not including variable length array */
 482 #define BRCMF_SCAN_RESULTS_FIXED_SIZE \
 483         (sizeof(struct brcmf_scan_results) - sizeof(struct brcmf_bss_info))
 484
 485 /* incremental scan results struct */
 486 struct brcmf_iscan_results {
 487         u32 status;
 488         struct brcmf_scan_results results;
 489 };
 490
 491 /* size of brcmf_iscan_results not including variable length array */
 492 #define BRCMF_ISCAN_RESULTS_FIXED_SIZE \
 493         (BRCMF_SCAN_RESULTS_FIXED_SIZE + \
 494          offsetof(struct brcmf_iscan_results, results))
 495
 496 struct brcmf_wsec_key {
 497         u32 index;              /* key index */
 498         u32 len;                /* key length */
 499         u8 data[WLAN_MAX_KEY_LEN];      /* key data */
 500         u32 pad_1[18];
 501         u32 algo;       /* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
 502         u32 flags;      /* misc flags */
 503         u32 pad_2[3];
 504         u32 iv_initialized;     /* has IV been initialized already? */
 505         u32 pad_3;
 506         /* Rx IV */
 507         struct {
 508                 u32 hi; /* upper 32 bits of IV */
 509                 u16 lo; /* lower 16 bits of IV */
 510         } rxiv;
 511         u32 pad_4[2];
 512         u8 ea[ETH_ALEN];        /* per station */
 513 };
 514
 515 /*
 516  * dongle requires same struct as above but with fields in little endian order
 517  */
 518 struct brcmf_wsec_key_le {
 519         __le32 index;           /* key index */
 520         __le32 len;             /* key length */
 521         u8 data[WLAN_MAX_KEY_LEN];      /* key data */
 522         __le32 pad_1[18];
 523         __le32 algo;    /* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
 524         __le32 flags;   /* misc flags */
 525         __le32 pad_2[3];
 526         __le32 iv_initialized;  /* has IV been initialized already? */
 527         __le32 pad_3;
 528         /* Rx IV */
 529         struct {
 530                 __le32 hi;      /* upper 32 bits of IV */
 531                 __le16 lo;      /* lower 16 bits of IV */
 532         } rxiv;
 533         __le32 pad_4[2];
 534         u8 ea[ETH_ALEN];        /* per station */
 535 };
 536
 537 /* Used to get specific STA parameters */
 538 struct brcmf_scb_val {
 539         u32 val;
 540         u8 ea[ETH_ALEN];
 541 };
 542
 543 /* channel encoding */
 544 struct brcmf_channel_info {
 545         int hw_channel;
 546         int target_channel;
 547         int scan_channel;
 548 };
 549
 550 /* Linux network driver ioctl encoding */
 551 struct brcmf_ioctl {
 552         uint cmd;               /* common ioctl definition */
 553         void *buf;              /* pointer to user buffer */
 554         uint len;               /* length of user buffer */
 555         u8 set;         /* get or set request (optional) */
 556         uint used;              /* bytes read or written (optional) */
 557         uint needed;            /* bytes needed (optional) */
 558 };
 559
 560 /* Forward decls for struct brcmf_pub (see below) */
 561 struct brcmf_bus;               /* device bus info */
 562 struct brcmf_proto;     /* device communication protocol info */
 563 struct brcmf_info;      /* device driver info */
 564 struct brcmf_cfg80211_dev; /* cfg80211 device info */
 565
 566 /* Common structure for module and instance linkage */
 567 struct brcmf_pub {
 568         /* Linkage ponters */
 569         struct brcmf_bus *bus;
 570         struct brcmf_proto *prot;
 571         struct brcmf_info *info;
 572         struct brcmf_cfg80211_dev *config;
 573
 574         /* Internal brcmf items */
 575         bool up;                /* Driver up/down (to OS) */
 576         bool txoff;             /* Transmit flow-controlled */
 577         bool dongle_reset;      /* true = DEVRESET put dongle into reset */
 578         enum brcmf_bus_state busstate;
 579         uint hdrlen;            /* Total BRCMF header length (proto + bus) */
 580         uint maxctl;            /* Max size rxctl request from proto to bus */
 581         uint rxsz;              /* Rx buffer size bus module should use */
 582         u8 wme_dp;              /* wme discard priority */
 583
 584         /* Dongle media info */
 585         bool iswl;              /* Dongle-resident driver is wl */
 586         unsigned long drv_version;      /* Version of dongle-resident driver */
 587         u8 mac[ETH_ALEN];               /* MAC address obtained from dongle */
 588         struct dngl_stats dstats;       /* Stats for dongle-based data */
 589
 590         /* Additional stats for the bus level */
 591
 592         /* Data packets sent to dongle */
 593         unsigned long tx_packets;
 594         /* Multicast data packets sent to dongle */
 595         unsigned long tx_multicast;
 596         /* Errors in sending data to dongle */
 597         unsigned long tx_errors;
 598         /* Control packets sent to dongle */
 599         unsigned long tx_ctlpkts;
 600         /* Errors sending control frames to dongle */
 601         unsigned long tx_ctlerrs;
 602         /* Packets sent up the network interface */
 603         unsigned long rx_packets;
 604         /* Multicast packets sent up the network interface */
 605         unsigned long rx_multicast;
 606         /* Errors processing rx data packets */
 607         unsigned long rx_errors;
 608         /* Control frames processed from dongle */
 609         unsigned long rx_ctlpkts;
 610
 611         /* Errors in processing rx control frames */
 612         unsigned long rx_ctlerrs;
 613         /* Packets dropped locally (no memory) */
 614         unsigned long rx_dropped;
 615         /* Packets flushed due to unscheduled sendup thread */
 616         unsigned long rx_flushed;
 617         /* Number of times dpc scheduled by watchdog timer */
 618         unsigned long wd_dpc_sched;
 619
 620         /* Number of packets where header read-ahead was used. */
 621         unsigned long rx_readahead_cnt;
 622         /* Number of tx packets we had to realloc for headroom */
 623         unsigned long tx_realloc;
 624         /* Number of flow control pkts recvd */
 625         unsigned long fc_packets;
 626
 627         /* Last error return */
 628         int bcmerror;
 629         uint tickcnt;
 630
 631         /* Last error from dongle */
 632         int dongle_error;
 633
 634         /* Suspend disable flag  flag */
 635         int suspend_disable_flag;       /* "1" to disable all extra powersaving
 636                                          during suspend */
 637         int in_suspend;         /* flag set to 1 when early suspend called */
 638         int dtim_skip;          /* dtim skip , default 0 means wake each dtim */
 639
 640         /* Pkt filter defination */
 641         char *pktfilter[100];
 642         int pktfilter_count;
 643
 644         u8 country_code[BRCM_CNTRY_BUF_SZ];
 645         char eventmask[BRCMF_EVENTING_MASK_LEN];
 646
 647 };
 648
 649 struct brcmf_if_event {
 650         u8 ifidx;
 651         u8 action;
 652         u8 flags;
 653         u8 bssidx;
 654 };
 655
 656 struct bcmevent_name {
 657         uint event;
 658         const char *name;
 659 };
 660
 661 /*
 662  * Insmod parameters for debug/test
 663  */
 664
 665 /* ARP offload agent mode */
 666 extern uint brcmf_arp_mode;
 667
 668 /* ARP offload enable */
 669 extern uint brcmf_arp_enable;
 670
 671 /* Override to force tx queueing all the time */
 672 extern uint brcmf_force_tx_queueing;
 673
 674 extern const struct bcmevent_name bcmevent_names[];
 675 extern const int bcmevent_names_size;
 676
 677
 678 static inline void MUTEX_LOCK_INIT(struct brcmf_pub *drvr)
 679 {
 680 }
 681
 682 static inline void MUTEX_LOCK(struct brcmf_pub *drvr)
 683 {
 684 }
 685
 686 static inline void MUTEX_UNLOCK(struct brcmf_pub *drvr)
 687 {
 688 }
 689
 690 static inline void MUTEX_LOCK_WL_SCAN_SET_INIT(void)
 691 {
 692 }
 693
 694 static inline void MUTEX_LOCK_WL_SCAN_SET(void)
 695 {
 696 }
 697
 698 static inline void MUTEX_UNLOCK_WL_SCAN_SET(void)
 699 {
 700 }
 701
 702 /* Indication from bus module regarding presence/insertion of dongle.
 703  * Return struct brcmf_pub pointer, used as handle to OS module in later calls.
 704  * Returned structure should have bus and prot pointers filled in.
 705  * bus_hdrlen specifies required headroom for bus module header.
 706  */
 707 extern struct brcmf_pub *brcmf_attach(struct brcmf_bus *bus,
 708                                       uint bus_hdrlen);
 709 extern int brcmf_net_attach(struct brcmf_pub *drvr, int idx);
 710 extern int brcmf_netdev_wait_pend8021x(struct net_device *dev);
 711
 712 extern int brcmf_netdev_ioctl_priv(struct net_device *net,
 713                                    struct brcmf_ioctl *ioc);
 714
 715 /* Indication from bus module regarding removal/absence of dongle */
 716 extern void brcmf_detach(struct brcmf_pub *drvr);
 717
 718 /* Indication from bus module to change flow-control state */
 719 extern void brcmf_txflowcontrol(struct brcmf_pub *drvr, int ifidx, bool on);
 720
 721 extern bool brcmf_c_prec_enq(struct brcmf_pub *drvr, struct pktq *q,
 722                          struct sk_buff *pkt, int prec);
 723
 724 /* Receive frame for delivery to OS.  Callee disposes of rxp. */
 725 extern void brcmf_rx_frame(struct brcmf_pub *drvr, int ifidx,
 726                          struct sk_buff *rxp, int numpkt);
 727
 728 /* Return pointer to interface name */
 729 extern char *brcmf_ifname(struct brcmf_pub *drvr, int idx);
 730
 731 /* Notify tx completion */
 732 extern void brcmf_txcomplete(struct brcmf_pub *drvr, struct sk_buff *txp,
 733                              bool success);
 734
 735 /* Query ioctl */
 736 extern int brcmf_proto_cdc_query_ioctl(struct brcmf_pub *drvr, int ifidx,
 737                                        uint cmd, void *buf, uint len);
 738
 739 /* OS independent layer functions */
 740 extern int brcmf_os_proto_block(struct brcmf_pub *drvr);
 741 extern int brcmf_os_proto_unblock(struct brcmf_pub *drvr);
 742 #ifdef BCMDBG
 743 extern int brcmf_write_to_file(struct brcmf_pub *drvr, u8 *buf, int size);
 744 #endif                          /* BCMDBG */
 745
 746 extern int brcmf_ifname2idx(struct brcmf_info *drvr_priv, char *name);
 747 extern int brcmf_c_host_event(struct brcmf_info *drvr_priv, int *idx,
 748                               void *pktdata, struct brcmf_event_msg *,
 749                               void **data_ptr);
 750
 751 extern void brcmf_c_init(void);
 752
 753 extern int brcmf_add_if(struct brcmf_info *drvr_priv, int ifidx,
 754                         struct net_device *net, char *name, u8 *mac_addr,
 755                         u32 flags, u8 bssidx);
 756 extern void brcmf_del_if(struct brcmf_info *drvr_priv, int ifidx);
 757
 758 /* Send packet to dongle via data channel */
 759 extern int brcmf_sendpkt(struct brcmf_pub *drvr, int ifidx,\
 760                          struct sk_buff *pkt);
 761
 762 extern int brcmf_bus_devreset(struct brcmf_pub *drvr, u8 flag);
 763 extern int brcmf_bus_start(struct brcmf_pub *drvr);
 764
 765 extern void brcmf_c_pktfilter_offload_set(struct brcmf_pub *drvr, char *arg);
 766 extern void brcmf_c_pktfilter_offload_enable(struct brcmf_pub *drvr, char *arg,
 767                                              int enable, int master_mode);
 768
 769 /* per-driver magic numbers */
 770 #define BRCMF_IOCTL_MAGIC               0x00444944
 771
 772 /* bump this number if you change the ioctl interface */
 773 #define BRCMF_IOCTL_VERSION     1
 774 #define BRCMF_IOCTL_MAXLEN      8192    /* max length ioctl buffer required */
 775
 776 /* common ioctl definitions */
 777 #define BRCMF_GET_VERSION                               1
 778 #define BRCMF_GET_VAR                           2
 779 #define BRCMF_SET_VAR                           3
 780
 781 /* message levels */
 782 #define BRCMF_ERROR_VAL 0x0001
 783 #define BRCMF_TRACE_VAL 0x0002
 784 #define BRCMF_INFO_VAL  0x0004
 785 #define BRCMF_DATA_VAL  0x0008
 786 #define BRCMF_CTL_VAL   0x0010
 787 #define BRCMF_TIMER_VAL 0x0020
 788 #define BRCMF_HDRS_VAL  0x0040
 789 #define BRCMF_BYTES_VAL 0x0080
 790 #define BRCMF_INTR_VAL  0x0100
 791 #define BRCMF_GLOM_VAL  0x0400
 792 #define BRCMF_EVENT_VAL 0x0800
 793 #define BRCMF_BTA_VAL   0x1000
 794 #define BRCMF_ISCAN_VAL 0x2000
 795
 796 /* Enter idle immediately (no timeout) */
 797 #define BRCMF_IDLE_IMMEDIATE    (-1)
 798 #define BRCMF_IDLE_ACTIVE       0       /* Do not request any SD clock change
 799                                  when idle */
 800
 801 #endif                          /* _BRCMF_H_ */