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 /*******************************************************************************
  27  * IO codes that are interpreted by dongle firmware
  28  ******************************************************************************/
  29 #define BRCMF_C_UP                              2
  30 #define BRCMF_C_SET_PROMISC                     10
  31 #define BRCMF_C_GET_RATE                        12
  32 #define BRCMF_C_GET_INFRA                       19
  33 #define BRCMF_C_SET_INFRA                       20
  34 #define BRCMF_C_GET_AUTH                        21
  35 #define BRCMF_C_SET_AUTH                        22
  36 #define BRCMF_C_GET_BSSID                       23
  37 #define BRCMF_C_GET_SSID                        25
  38 #define BRCMF_C_SET_SSID                        26
  39 #define BRCMF_C_GET_CHANNEL                     29
  40 #define BRCMF_C_GET_SRL                         31
  41 #define BRCMF_C_GET_LRL                         33
  42 #define BRCMF_C_GET_RADIO                       37
  43 #define BRCMF_C_SET_RADIO                       38
  44 #define BRCMF_C_GET_PHYTYPE                     39
  45 #define BRCMF_C_SET_KEY                         45
  46 #define BRCMF_C_SET_PASSIVE_SCAN                49
  47 #define BRCMF_C_SCAN                            50
  48 #define BRCMF_C_SCAN_RESULTS                    51
  49 #define BRCMF_C_DISASSOC                        52
  50 #define BRCMF_C_REASSOC                         53
  51 #define BRCMF_C_SET_ROAM_TRIGGER                55
  52 #define BRCMF_C_SET_ROAM_DELTA                  57
  53 #define BRCMF_C_GET_DTIMPRD                     77
  54 #define BRCMF_C_SET_COUNTRY                     84
  55 #define BRCMF_C_GET_PM                          85
  56 #define BRCMF_C_SET_PM                          86
  57 #define BRCMF_C_GET_AP                          117
  58 #define BRCMF_C_SET_AP                          118
  59 #define BRCMF_C_GET_RSSI                        127
  60 #define BRCMF_C_GET_WSEC                        133
  61 #define BRCMF_C_SET_WSEC                        134
  62 #define BRCMF_C_GET_PHY_NOISE                   135
  63 #define BRCMF_C_GET_BSS_INFO                    136
  64 #define BRCMF_C_SET_SCAN_CHANNEL_TIME           185
  65 #define BRCMF_C_SET_SCAN_UNASSOC_TIME           187
  66 #define BRCMF_C_SCB_DEAUTHENTICATE_FOR_REASON   201
  67 #define BRCMF_C_GET_VALID_CHANNELS              217
  68 #define BRCMF_C_GET_KEY_PRIMARY                 235
  69 #define BRCMF_C_SET_KEY_PRIMARY                 236
  70 #define BRCMF_C_SET_SCAN_PASSIVE_TIME           258
  71 #define BRCMF_C_GET_VAR                         262
  72 #define BRCMF_C_SET_VAR                         263
  73
  74 /* phy types (returned by WLC_GET_PHYTPE) */
  75 #define WLC_PHY_TYPE_A          0
  76 #define WLC_PHY_TYPE_B          1
  77 #define WLC_PHY_TYPE_G          2
  78 #define WLC_PHY_TYPE_N          4
  79 #define WLC_PHY_TYPE_LP         5
  80 #define WLC_PHY_TYPE_SSN        6
  81 #define WLC_PHY_TYPE_HT         7
  82 #define WLC_PHY_TYPE_LCN        8
  83 #define WLC_PHY_TYPE_NULL       0xf
  84
  85 #define BRCMF_EVENTING_MASK_LEN 16
  86
  87 #define TOE_TX_CSUM_OL          0x00000001
  88 #define TOE_RX_CSUM_OL          0x00000002
  89
  90 #define BRCMF_BSS_INFO_VERSION  108 /* current ver of brcmf_bss_info struct */
  91
  92 /* size of brcmf_scan_params not including variable length array */
  93 #define BRCMF_SCAN_PARAMS_FIXED_SIZE 64
  94
  95 /* masks for channel and ssid count */
  96 #define BRCMF_SCAN_PARAMS_COUNT_MASK 0x0000ffff
  97 #define BRCMF_SCAN_PARAMS_NSSID_SHIFT 16
  98
  99 #define BRCMF_SCAN_ACTION_START      1
 100 #define BRCMF_SCAN_ACTION_CONTINUE   2
 101 #define WL_SCAN_ACTION_ABORT      3
 102
 103 #define BRCMF_ISCAN_REQ_VERSION 1
 104
 105 /* brcmf_iscan_results status values */
 106 #define BRCMF_SCAN_RESULTS_SUCCESS      0
 107 #define BRCMF_SCAN_RESULTS_PARTIAL      1
 108 #define BRCMF_SCAN_RESULTS_PENDING      2
 109 #define BRCMF_SCAN_RESULTS_ABORTED      3
 110 #define BRCMF_SCAN_RESULTS_NO_MEM       4
 111
 112 /* Indicates this key is using soft encrypt */
 113 #define WL_SOFT_KEY     (1 << 0)
 114 /* primary (ie tx) key */
 115 #define BRCMF_PRIMARY_KEY       (1 << 1)
 116 /* Reserved for backward compat */
 117 #define WL_KF_RES_4     (1 << 4)
 118 /* Reserved for backward compat */
 119 #define WL_KF_RES_5     (1 << 5)
 120 /* Indicates a group key for a IBSS PEER */
 121 #define WL_IBSS_PEER_GROUP_KEY  (1 << 6)
 122
 123 /* For supporting multiple interfaces */
 124 #define BRCMF_MAX_IFS   16
 125 #define BRCMF_DEL_IF    -0xe
 126 #define BRCMF_BAD_IF    -0xf
 127
 128 #define DOT11_BSSTYPE_ANY                       2
 129 #define DOT11_MAX_DEFAULT_KEYS  4
 130
 131 #define BRCMF_EVENT_MSG_LINK            0x01
 132 #define BRCMF_EVENT_MSG_FLUSHTXQ        0x02
 133 #define BRCMF_EVENT_MSG_GROUP           0x04
 134
 135 struct brcmf_event_msg {
 136         __be16 version;
 137         __be16 flags;
 138         __be32 event_type;
 139         __be32 status;
 140         __be32 reason;
 141         __be32 auth_type;
 142         __be32 datalen;
 143         u8 addr[ETH_ALEN];
 144         char ifname[IFNAMSIZ];
 145 } __packed;
 146
 147 struct brcm_ethhdr {
 148         u16 subtype;
 149         u16 length;
 150         u8 version;
 151         u8 oui[3];
 152         u16 usr_subtype;
 153 } __packed;
 154
 155 struct brcmf_event {
 156         struct ethhdr eth;
 157         struct brcm_ethhdr hdr;
 158         struct brcmf_event_msg msg;
 159 } __packed;
 160
 161 struct dngl_stats {
 162         unsigned long rx_packets;       /* total packets received */
 163         unsigned long tx_packets;       /* total packets transmitted */
 164         unsigned long rx_bytes; /* total bytes received */
 165         unsigned long tx_bytes; /* total bytes transmitted */
 166         unsigned long rx_errors;        /* bad packets received */
 167         unsigned long tx_errors;        /* packet transmit problems */
 168         unsigned long rx_dropped;       /* packets dropped by dongle */
 169         unsigned long tx_dropped;       /* packets dropped by dongle */
 170         unsigned long multicast;        /* multicast packets received */
 171 };
 172
 173 /* event codes sent by the dongle to this driver */
 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         __le32 version;         /* version field */
 370         __le32 length;          /* byte length of data in this record,
 371                                  * starting at version and including IEs
 372                                  */
 373         u8 BSSID[ETH_ALEN];
 374         __le16 beacon_period;   /* units are Kusec */
 375         __le16 capability;      /* Capability information */
 376         u8 SSID_len;
 377         u8 SSID[32];
 378         struct {
 379                 __le32 count;   /* # rates in this set */
 380                 u8 rates[16]; /* rates in 500kbps units w/hi bit set if basic */
 381         } rateset;              /* supported rates */
 382         __le16 chanspec;        /* chanspec for bss */
 383         __le16 atim_window;     /* units are Kusec */
 384         u8 dtim_period; /* DTIM period */
 385         __le16 RSSI;            /* receive signal strength (in dBm) */
 386         s8 phy_noise;           /* noise (in dBm) */
 387
 388         u8 n_cap;               /* BSS is 802.11N Capable */
 389         /* 802.11N BSS Capabilities (based on HT_CAP_*): */
 390         __le32 nbss_cap;
 391         u8 ctl_ch;              /* 802.11N BSS control channel number */
 392         __le32 reserved32[1];   /* Reserved for expansion of BSS properties */
 393         u8 flags;               /* flags */
 394         u8 reserved[3]; /* Reserved for expansion of BSS properties */
 395         u8 basic_mcs[MCSSET_LEN];       /* 802.11N BSS required MCS set */
 396
 397         __le16 ie_offset;       /* offset at which IEs start, from beginning */
 398         __le32 ie_length;       /* byte length of Information Elements */
 399         __le16 SNR;             /* average SNR of during frame reception */
 400         /* Add new fields here */
 401         /* variable length Information Elements */
 402 };
 403
 404 struct brcm_rateset_le {
 405         /* # rates in this set */
 406         __le32 count;
 407         /* rates in 500kbps units w/hi bit set if basic */
 408         u8 rates[WL_NUMRATES];
 409 };
 410
 411 struct brcmf_ssid {
 412         u32 SSID_len;
 413         unsigned char SSID[32];
 414 };
 415
 416 struct brcmf_ssid_le {
 417         __le32 SSID_len;
 418         unsigned char SSID[32];
 419 };
 420
 421 struct brcmf_scan_params_le {
 422         struct brcmf_ssid_le ssid_le;   /* default: {0, ""} */
 423         u8 bssid[ETH_ALEN];     /* default: bcast */
 424         s8 bss_type;            /* default: any,
 425                                  * DOT11_BSSTYPE_ANY/INFRASTRUCTURE/INDEPENDENT
 426                                  */
 427         u8 scan_type;   /* flags, 0 use default */
 428         __le32 nprobes;   /* -1 use default, number of probes per channel */
 429         __le32 active_time;     /* -1 use default, dwell time per channel for
 430                                  * active scanning
 431                                  */
 432         __le32 passive_time;    /* -1 use default, dwell time per channel
 433                                  * for passive scanning
 434                                  */
 435         __le32 home_time;       /* -1 use default, dwell time for the
 436                                  * home channel between channel scans
 437                                  */
 438         __le32 channel_num;     /* count of channels and ssids that follow
 439                                  *
 440                                  * low half is count of channels in
 441                                  * channel_list, 0 means default (use all
 442                                  * available channels)
 443                                  *
 444                                  * high half is entries in struct brcmf_ssid
 445                                  * array that follows channel_list, aligned for
 446                                  * s32 (4 bytes) meaning an odd channel count
 447                                  * implies a 2-byte pad between end of
 448                                  * channel_list and first ssid
 449                                  *
 450                                  * if ssid count is zero, single ssid in the
 451                                  * fixed parameter portion is assumed, otherwise
 452                                  * ssid in the fixed portion is ignored
 453                                  */
 454         __le16 channel_list[1]; /* list of chanspecs */
 455 };
 456
 457 /* incremental scan struct */
 458 struct brcmf_iscan_params_le {
 459         __le32 version;
 460         __le16 action;
 461         __le16 scan_duration;
 462         struct brcmf_scan_params_le params_le;
 463 };
 464
 465 struct brcmf_scan_results {
 466         u32 buflen;
 467         u32 version;
 468         u32 count;
 469         struct brcmf_bss_info bss_info[1];
 470 };
 471
 472 struct brcmf_scan_results_le {
 473         __le32 buflen;
 474         __le32 version;
 475         __le32 count;
 476         struct brcmf_bss_info bss_info[1];
 477 };
 478
 479 /* used for association with a specific BSSID and chanspec list */
 480 struct brcmf_assoc_params_le {
 481         /* 00:00:00:00:00:00: broadcast scan */
 482         u8 bssid[ETH_ALEN];
 483         /* 0: all available channels, otherwise count of chanspecs in
 484          * chanspec_list */
 485         __le32 chanspec_num;
 486         /* list of chanspecs */
 487         __le16 chanspec_list[1];
 488 };
 489
 490 /* used for join with or without a specific bssid and channel list */
 491 struct brcmf_join_params {
 492         struct brcmf_ssid_le ssid_le;
 493         struct brcmf_assoc_params_le params_le;
 494 };
 495
 496 /* size of brcmf_scan_results not including variable length array */
 497 #define BRCMF_SCAN_RESULTS_FIXED_SIZE \
 498         (sizeof(struct brcmf_scan_results) - sizeof(struct brcmf_bss_info))
 499
 500 /* incremental scan results struct */
 501 struct brcmf_iscan_results {
 502         union {
 503                 u32 status;
 504                 __le32 status_le;
 505         };
 506         union {
 507                 struct brcmf_scan_results results;
 508                 struct brcmf_scan_results_le results_le;
 509         };
 510 };
 511
 512 /* size of brcmf_iscan_results not including variable length array */
 513 #define BRCMF_ISCAN_RESULTS_FIXED_SIZE \
 514         (BRCMF_SCAN_RESULTS_FIXED_SIZE + \
 515          offsetof(struct brcmf_iscan_results, results))
 516
 517 struct brcmf_wsec_key {
 518         u32 index;              /* key index */
 519         u32 len;                /* key length */
 520         u8 data[WLAN_MAX_KEY_LEN];      /* key data */
 521         u32 pad_1[18];
 522         u32 algo;       /* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
 523         u32 flags;      /* misc flags */
 524         u32 pad_2[3];
 525         u32 iv_initialized;     /* has IV been initialized already? */
 526         u32 pad_3;
 527         /* Rx IV */
 528         struct {
 529                 u32 hi; /* upper 32 bits of IV */
 530                 u16 lo; /* lower 16 bits of IV */
 531         } rxiv;
 532         u32 pad_4[2];
 533         u8 ea[ETH_ALEN];        /* per station */
 534 };
 535
 536 /*
 537  * dongle requires same struct as above but with fields in little endian order
 538  */
 539 struct brcmf_wsec_key_le {
 540         __le32 index;           /* key index */
 541         __le32 len;             /* key length */
 542         u8 data[WLAN_MAX_KEY_LEN];      /* key data */
 543         __le32 pad_1[18];
 544         __le32 algo;    /* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
 545         __le32 flags;   /* misc flags */
 546         __le32 pad_2[3];
 547         __le32 iv_initialized;  /* has IV been initialized already? */
 548         __le32 pad_3;
 549         /* Rx IV */
 550         struct {
 551                 __le32 hi;      /* upper 32 bits of IV */
 552                 __le16 lo;      /* lower 16 bits of IV */
 553         } rxiv;
 554         __le32 pad_4[2];
 555         u8 ea[ETH_ALEN];        /* per station */
 556 };
 557
 558 /* Used to get specific STA parameters */
 559 struct brcmf_scb_val_le {
 560         __le32 val;
 561         u8 ea[ETH_ALEN];
 562 };
 563
 564 /* channel encoding */
 565 struct brcmf_channel_info_le {
 566         __le32 hw_channel;
 567         __le32 target_channel;
 568         __le32 scan_channel;
 569 };
 570
 571 /* Bus independent dongle command */
 572 struct brcmf_dcmd {
 573         uint cmd;               /* common dongle cmd definition */
 574         void *buf;              /* pointer to user buffer */
 575         uint len;               /* length of user buffer */
 576         u8 set;                 /* get or set request (optional) */
 577         uint used;              /* bytes read or written (optional) */
 578         uint needed;            /* bytes needed (optional) */
 579 };
 580
 581 /* Forward decls for struct brcmf_pub (see below) */
 582 struct brcmf_bus;               /* device bus info */
 583 struct brcmf_proto;     /* device communication protocol info */
 584 struct brcmf_info;      /* device driver info */
 585 struct brcmf_cfg80211_dev; /* cfg80211 device info */
 586
 587 /* Common structure for module and instance linkage */
 588 struct brcmf_pub {
 589         /* Linkage ponters */
 590         struct brcmf_bus *bus;
 591         struct brcmf_proto *prot;
 592         struct brcmf_info *info;
 593         struct brcmf_cfg80211_dev *config;
 594
 595         /* Internal brcmf items */
 596         bool up;                /* Driver up/down (to OS) */
 597         bool txoff;             /* Transmit flow-controlled */
 598         enum brcmf_bus_state busstate;
 599         uint hdrlen;            /* Total BRCMF header length (proto + bus) */
 600         uint maxctl;            /* Max size rxctl request from proto to bus */
 601         uint rxsz;              /* Rx buffer size bus module should use */
 602         u8 wme_dp;              /* wme discard priority */
 603
 604         /* Dongle media info */
 605         bool iswl;              /* Dongle-resident driver is wl */
 606         unsigned long drv_version;      /* Version of dongle-resident driver */
 607         u8 mac[ETH_ALEN];               /* MAC address obtained from dongle */
 608         struct dngl_stats dstats;       /* Stats for dongle-based data */
 609
 610         /* Additional stats for the bus level */
 611
 612         /* Data packets sent to dongle */
 613         unsigned long tx_packets;
 614         /* Multicast data packets sent to dongle */
 615         unsigned long tx_multicast;
 616         /* Errors in sending data to dongle */
 617         unsigned long tx_errors;
 618         /* Control packets sent to dongle */
 619         unsigned long tx_ctlpkts;
 620         /* Errors sending control frames to dongle */
 621         unsigned long tx_ctlerrs;
 622         /* Packets sent up the network interface */
 623         unsigned long rx_packets;
 624         /* Multicast packets sent up the network interface */
 625         unsigned long rx_multicast;
 626         /* Errors processing rx data packets */
 627         unsigned long rx_errors;
 628         /* Control frames processed from dongle */
 629         unsigned long rx_ctlpkts;
 630
 631         /* Errors in processing rx control frames */
 632         unsigned long rx_ctlerrs;
 633         /* Packets dropped locally (no memory) */
 634         unsigned long rx_dropped;
 635         /* Packets flushed due to unscheduled sendup thread */
 636         unsigned long rx_flushed;
 637         /* Number of times dpc scheduled by watchdog timer */
 638         unsigned long wd_dpc_sched;
 639
 640         /* Number of packets where header read-ahead was used. */
 641         unsigned long rx_readahead_cnt;
 642         /* Number of tx packets we had to realloc for headroom */
 643         unsigned long tx_realloc;
 644         /* Number of flow control pkts recvd */
 645         unsigned long fc_packets;
 646
 647         /* Last error return */
 648         int bcmerror;
 649         uint tickcnt;
 650
 651         /* Last error from dongle */
 652         int dongle_error;
 653
 654         /* Suspend disable flag  flag */
 655         int suspend_disable_flag;       /* "1" to disable all extra powersaving
 656                                          during suspend */
 657         int in_suspend;         /* flag set to 1 when early suspend called */
 658         int dtim_skip;          /* dtim skip , default 0 means wake each dtim */
 659
 660         /* Pkt filter defination */
 661         char *pktfilter[100];
 662         int pktfilter_count;
 663
 664         u8 country_code[BRCM_CNTRY_BUF_SZ];
 665         char eventmask[BRCMF_EVENTING_MASK_LEN];
 666
 667 };
 668
 669 struct brcmf_if_event {
 670         u8 ifidx;
 671         u8 action;
 672         u8 flags;
 673         u8 bssidx;
 674 };
 675
 676 struct bcmevent_name {
 677         uint event;
 678         const char *name;
 679 };
 680
 681 extern const struct bcmevent_name bcmevent_names[];
 682
 683 /* Indication from bus module regarding presence/insertion of dongle.
 684  * Return struct brcmf_pub pointer, used as handle to OS module in later calls.
 685  * Returned structure should have bus and prot pointers filled in.
 686  * bus_hdrlen specifies required headroom for bus module header.
 687  */
 688 extern struct brcmf_pub *brcmf_attach(struct brcmf_bus *bus,
 689                                       uint bus_hdrlen);
 690 extern int brcmf_net_attach(struct brcmf_pub *drvr, int idx);
 691 extern int brcmf_netdev_wait_pend8021x(struct net_device *ndev);
 692
 693 extern s32 brcmf_exec_dcmd(struct net_device *dev, u32 cmd, void *arg, u32 len);
 694
 695 /* Indication from bus module regarding removal/absence of dongle */
 696 extern void brcmf_detach(struct brcmf_pub *drvr);
 697
 698 /* Indication from bus module to change flow-control state */
 699 extern void brcmf_txflowcontrol(struct brcmf_pub *drvr, int ifidx, bool on);
 700
 701 extern bool brcmf_c_prec_enq(struct brcmf_pub *drvr, struct pktq *q,
 702                          struct sk_buff *pkt, int prec);
 703
 704 /* Receive frame for delivery to OS.  Callee disposes of rxp. */
 705 extern void brcmf_rx_frame(struct brcmf_pub *drvr, int ifidx,
 706                          struct sk_buff *rxp, int numpkt);
 707
 708 /* Return pointer to interface name */
 709 extern char *brcmf_ifname(struct brcmf_pub *drvr, int idx);
 710
 711 /* Notify tx completion */
 712 extern void brcmf_txcomplete(struct brcmf_pub *drvr, struct sk_buff *txp,
 713                              bool success);
 714
 715 /* Query dongle */
 716 extern int brcmf_proto_cdc_query_dcmd(struct brcmf_pub *drvr, int ifidx,
 717                                        uint cmd, void *buf, uint len);
 718
 719 /* OS independent layer functions */
 720 extern int brcmf_os_proto_block(struct brcmf_pub *drvr);
 721 extern int brcmf_os_proto_unblock(struct brcmf_pub *drvr);
 722 #ifdef BCMDBG
 723 extern int brcmf_write_to_file(struct brcmf_pub *drvr, u8 *buf, int size);
 724 #endif                          /* BCMDBG */
 725
 726 extern int brcmf_ifname2idx(struct brcmf_info *drvr_priv, char *name);
 727 extern int brcmf_c_host_event(struct brcmf_info *drvr_priv, int *idx,
 728                               void *pktdata, struct brcmf_event_msg *,
 729                               void **data_ptr);
 730
 731 extern void brcmf_c_init(void);
 732
 733 extern int brcmf_add_if(struct brcmf_info *drvr_priv, int ifidx,
 734                         struct net_device *ndev, char *name, u8 *mac_addr,
 735                         u32 flags, u8 bssidx);
 736 extern void brcmf_del_if(struct brcmf_info *drvr_priv, int ifidx);
 737
 738 /* Send packet to dongle via data channel */
 739 extern int brcmf_sendpkt(struct brcmf_pub *drvr, int ifidx,\
 740                          struct sk_buff *pkt);
 741
 742 extern int brcmf_bus_start(struct brcmf_pub *drvr);
 743
 744 extern void brcmf_c_pktfilter_offload_set(struct brcmf_pub *drvr, char *arg);
 745 extern void brcmf_c_pktfilter_offload_enable(struct brcmf_pub *drvr, char *arg,
 746                                              int enable, int master_mode);
 747
 748 #define BRCMF_DCMD_SMLEN        256     /* "small" cmd buffer required */
 749 #define BRCMF_DCMD_MEDLEN       1536    /* "med" cmd buffer required */
 750 #define BRCMF_DCMD_MAXLEN       8192    /* max length cmd buffer required */
 751
 752 /* message levels */
 753 #define BRCMF_ERROR_VAL 0x0001
 754 #define BRCMF_TRACE_VAL 0x0002
 755 #define BRCMF_INFO_VAL  0x0004
 756 #define BRCMF_DATA_VAL  0x0008
 757 #define BRCMF_CTL_VAL   0x0010
 758 #define BRCMF_TIMER_VAL 0x0020
 759 #define BRCMF_HDRS_VAL  0x0040
 760 #define BRCMF_BYTES_VAL 0x0080
 761 #define BRCMF_INTR_VAL  0x0100
 762 #define BRCMF_GLOM_VAL  0x0400
 763 #define BRCMF_EVENT_VAL 0x0800
 764 #define BRCMF_BTA_VAL   0x1000
 765 #define BRCMF_ISCAN_VAL 0x2000
 766
 767 /* Enter idle immediately (no timeout) */
 768 #define BRCMF_IDLE_IMMEDIATE    (-1)
 769 #define BRCMF_IDLE_ACTIVE       0       /* Do not request any SD clock change
 770                                  when idle */
 771 #define BRCMF_IDLE_INTERVAL     1
 772
 773 #endif                          /* _BRCMF_H_ */