drivers/net/wireless/brcm80211/brcmfmac/fwil_types.h

   1 /*
   2  * Copyright (c) 2012 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 #ifndef FWIL_TYPES_H_
  19 #define FWIL_TYPES_H_
  20
  21 #include <linux/if_ether.h>
  22
  23
  24 #define BRCMF_FIL_ACTION_FRAME_SIZE     1800
  25
  26 /* ARP Offload feature flags for arp_ol iovar */
  27 #define BRCMF_ARP_OL_AGENT              0x00000001
  28 #define BRCMF_ARP_OL_SNOOP              0x00000002
  29 #define BRCMF_ARP_OL_HOST_AUTO_REPLY    0x00000004
  30 #define BRCMF_ARP_OL_PEER_AUTO_REPLY    0x00000008
  31
  32 #define BRCMF_BSS_INFO_VERSION  109 /* curr ver of brcmf_bss_info_le struct */
  33 #define BRCMF_BSS_RSSI_ON_CHANNEL       0x0002
  34
  35 #define BRCMF_STA_ASSOC                 0x10            /* Associated */
  36
  37 /* size of brcmf_scan_params not including variable length array */
  38 #define BRCMF_SCAN_PARAMS_FIXED_SIZE    64
  39
  40 /* masks for channel and ssid count */
  41 #define BRCMF_SCAN_PARAMS_COUNT_MASK    0x0000ffff
  42 #define BRCMF_SCAN_PARAMS_NSSID_SHIFT   16
  43
  44 /* primary (ie tx) key */
  45 #define BRCMF_PRIMARY_KEY               (1 << 1)
  46 #define DOT11_BSSTYPE_ANY               2
  47 #define BRCMF_ESCAN_REQ_VERSION         1
  48
  49 #define BRCMF_MAXRATES_IN_SET           16      /* max # of rates in rateset */
  50
  51 /* OBSS Coex Auto/On/Off */
  52 #define BRCMF_OBSS_COEX_AUTO            (-1)
  53 #define BRCMF_OBSS_COEX_OFF             0
  54 #define BRCMF_OBSS_COEX_ON              1
  55
  56 /* WOWL bits */
  57 /* Wakeup on Magic packet: */
  58 #define BRCMF_WOWL_MAGIC                (1 << 0)
  59 /* Wakeup on Netpattern */
  60 #define BRCMF_WOWL_NET                  (1 << 1)
  61 /* Wakeup on loss-of-link due to Disassoc/Deauth: */
  62 #define BRCMF_WOWL_DIS                  (1 << 2)
  63 /* Wakeup on retrograde TSF: */
  64 #define BRCMF_WOWL_RETR                 (1 << 3)
  65 /* Wakeup on loss of beacon: */
  66 #define BRCMF_WOWL_BCN                  (1 << 4)
  67 /* Wakeup after test: */
  68 #define BRCMF_WOWL_TST                  (1 << 5)
  69 /* Wakeup after PTK refresh: */
  70 #define BRCMF_WOWL_M1                   (1 << 6)
  71 /* Wakeup after receipt of EAP-Identity Req: */
  72 #define BRCMF_WOWL_EAPID                (1 << 7)
  73 /* Wakeind via PME(0) or GPIO(1): */
  74 #define BRCMF_WOWL_PME_GPIO             (1 << 8)
  75 /* need tkip phase 1 key to be updated by the driver: */
  76 #define BRCMF_WOWL_NEEDTKIP1            (1 << 9)
  77 /* enable wakeup if GTK fails: */
  78 #define BRCMF_WOWL_GTK_FAILURE          (1 << 10)
  79 /* support extended magic packets: */
  80 #define BRCMF_WOWL_EXTMAGPAT            (1 << 11)
  81 /* support ARP/NS/keepalive offloading: */
  82 #define BRCMF_WOWL_ARPOFFLOAD           (1 << 12)
  83 /* read protocol version for EAPOL frames: */
  84 #define BRCMF_WOWL_WPA2                 (1 << 13)
  85 /* If the bit is set, use key rotaton: */
  86 #define BRCMF_WOWL_KEYROT               (1 << 14)
  87 /* If the bit is set, frm received was bcast frame: */
  88 #define BRCMF_WOWL_BCAST                (1 << 15)
  89 /* If the bit is set, scan offload is enabled: */
  90 #define BRCMF_WOWL_SCANOL               (1 << 16)
  91 /* Wakeup on tcpkeep alive timeout: */
  92 #define BRCMF_WOWL_TCPKEEP_TIME         (1 << 17)
  93 /* Wakeup on mDNS Conflict Resolution: */
  94 #define BRCMF_WOWL_MDNS_CONFLICT        (1 << 18)
  95 /* Wakeup on mDNS Service Connect: */
  96 #define BRCMF_WOWL_MDNS_SERVICE         (1 << 19)
  97 /* tcp keepalive got data: */
  98 #define BRCMF_WOWL_TCPKEEP_DATA         (1 << 20)
  99 /* Firmware died in wowl mode: */
 100 #define BRCMF_WOWL_FW_HALT              (1 << 21)
 101 /* Enable detection of radio button changes: */
 102 #define BRCMF_WOWL_ENAB_HWRADIO         (1 << 22)
 103 /* Offloads detected MIC failure(s): */
 104 #define BRCMF_WOWL_MIC_FAIL             (1 << 23)
 105 /* Wakeup in Unassociated state (Net/Magic Pattern): */
 106 #define BRCMF_WOWL_UNASSOC              (1 << 24)
 107 /* Wakeup if received matched secured pattern: */
 108 #define BRCMF_WOWL_SECURE               (1 << 25)
 109 /* Link Down indication in WoWL mode: */
 110 #define BRCMF_WOWL_LINKDOWN             (1 << 31)
 111
 112 #define BRCMF_WOWL_MAXPATTERNS          8
 113 #define BRCMF_WOWL_MAXPATTERNSIZE       128
 114
 115
 116 /* join preference types for join_pref iovar */
 117 enum brcmf_join_pref_types {
 118         BRCMF_JOIN_PREF_RSSI = 1,
 119         BRCMF_JOIN_PREF_WPA,
 120         BRCMF_JOIN_PREF_BAND,
 121         BRCMF_JOIN_PREF_RSSI_DELTA,
 122 };
 123
 124 enum brcmf_fil_p2p_if_types {
 125         BRCMF_FIL_P2P_IF_CLIENT,
 126         BRCMF_FIL_P2P_IF_GO,
 127         BRCMF_FIL_P2P_IF_DYNBCN_GO,
 128         BRCMF_FIL_P2P_IF_DEV,
 129 };
 130
 131 enum brcmf_wowl_pattern_type {
 132         BRCMF_WOWL_PATTERN_TYPE_BITMAP = 0,
 133         BRCMF_WOWL_PATTERN_TYPE_ARP,
 134         BRCMF_WOWL_PATTERN_TYPE_NA
 135 };
 136
 137 struct brcmf_fil_p2p_if_le {
 138         u8 addr[ETH_ALEN];
 139         __le16 type;
 140         __le16 chspec;
 141 };
 142
 143 struct brcmf_fil_chan_info_le {
 144         __le32 hw_channel;
 145         __le32 target_channel;
 146         __le32 scan_channel;
 147 };
 148
 149 struct brcmf_fil_action_frame_le {
 150         u8      da[ETH_ALEN];
 151         __le16  len;
 152         __le32  packet_id;
 153         u8      data[BRCMF_FIL_ACTION_FRAME_SIZE];
 154 };
 155
 156 struct brcmf_fil_af_params_le {
 157         __le32                                  channel;
 158         __le32                                  dwell_time;
 159         u8                                      bssid[ETH_ALEN];
 160         u8                                      pad[2];
 161         struct brcmf_fil_action_frame_le        action_frame;
 162 };
 163
 164 struct brcmf_fil_bss_enable_le {
 165         __le32 bsscfg_idx;
 166         __le32 enable;
 167 };
 168
 169 struct brcmf_fil_bwcap_le {
 170         __le32 band;
 171         __le32 bw_cap;
 172 };
 173
 174 /**
 175  * struct tdls_iovar - common structure for tdls iovars.
 176  *
 177  * @ea: ether address of peer station.
 178  * @mode: mode value depending on specific tdls iovar.
 179  * @chanspec: channel specification.
 180  * @pad: unused (for future use).
 181  */
 182 struct brcmf_tdls_iovar_le {
 183         u8 ea[ETH_ALEN];                /* Station address */
 184         u8 mode;                        /* mode: depends on iovar */
 185         __le16 chanspec;
 186         __le32 pad;                     /* future */
 187 };
 188
 189 enum brcmf_tdls_manual_ep_ops {
 190         BRCMF_TDLS_MANUAL_EP_CREATE = 1,
 191         BRCMF_TDLS_MANUAL_EP_DELETE = 3,
 192         BRCMF_TDLS_MANUAL_EP_DISCOVERY = 6
 193 };
 194
 195 /* Pattern matching filter. Specifies an offset within received packets to
 196  * start matching, the pattern to match, the size of the pattern, and a bitmask
 197  * that indicates which bits within the pattern should be matched.
 198  */
 199 struct brcmf_pkt_filter_pattern_le {
 200         /*
 201          * Offset within received packet to start pattern matching.
 202          * Offset '0' is the first byte of the ethernet header.
 203          */
 204         __le32 offset;
 205         /* Size of the pattern.  Bitmask must be the same size.*/
 206         __le32 size_bytes;
 207         /*
 208          * Variable length mask and pattern data. mask starts at offset 0.
 209          * Pattern immediately follows mask.
 210          */
 211         u8 mask_and_pattern[1];
 212 };
 213
 214 /* IOVAR "pkt_filter_add" parameter. Used to install packet filters. */
 215 struct brcmf_pkt_filter_le {
 216         __le32 id;              /* Unique filter id, specified by app. */
 217         __le32 type;            /* Filter type (WL_PKT_FILTER_TYPE_xxx). */
 218         __le32 negate_match;    /* Negate the result of filter matches */
 219         union {                 /* Filter definitions */
 220                 struct brcmf_pkt_filter_pattern_le pattern; /* Filter pattern */
 221         } u;
 222 };
 223
 224 /* IOVAR "pkt_filter_enable" parameter. */
 225 struct brcmf_pkt_filter_enable_le {
 226         __le32 id;              /* Unique filter id */
 227         __le32 enable;          /* Enable/disable bool */
 228 };
 229
 230 /* BSS info structure
 231  * Applications MUST CHECK ie_offset field and length field to access IEs and
 232  * next bss_info structure in a vector (in struct brcmf_scan_results)
 233  */
 234 struct brcmf_bss_info_le {
 235         __le32 version;         /* version field */
 236         __le32 length;          /* byte length of data in this record,
 237                                  * starting at version and including IEs
 238                                  */
 239         u8 BSSID[ETH_ALEN];
 240         __le16 beacon_period;   /* units are Kusec */
 241         __le16 capability;      /* Capability information */
 242         u8 SSID_len;
 243         u8 SSID[32];
 244         struct {
 245                 __le32 count;   /* # rates in this set */
 246                 u8 rates[16]; /* rates in 500kbps units w/hi bit set if basic */
 247         } rateset;              /* supported rates */
 248         __le16 chanspec;        /* chanspec for bss */
 249         __le16 atim_window;     /* units are Kusec */
 250         u8 dtim_period; /* DTIM period */
 251         __le16 RSSI;            /* receive signal strength (in dBm) */
 252         s8 phy_noise;           /* noise (in dBm) */
 253
 254         u8 n_cap;               /* BSS is 802.11N Capable */
 255         /* 802.11N BSS Capabilities (based on HT_CAP_*): */
 256         __le32 nbss_cap;
 257         u8 ctl_ch;              /* 802.11N BSS control channel number */
 258         __le32 reserved32[1];   /* Reserved for expansion of BSS properties */
 259         u8 flags;               /* flags */
 260         u8 reserved[3]; /* Reserved for expansion of BSS properties */
 261         u8 basic_mcs[MCSSET_LEN];       /* 802.11N BSS required MCS set */
 262
 263         __le16 ie_offset;       /* offset at which IEs start, from beginning */
 264         __le32 ie_length;       /* byte length of Information Elements */
 265         __le16 SNR;             /* average SNR of during frame reception */
 266         /* Add new fields here */
 267         /* variable length Information Elements */
 268 };
 269
 270 struct brcm_rateset_le {
 271         /* # rates in this set */
 272         __le32 count;
 273         /* rates in 500kbps units w/hi bit set if basic */
 274         u8 rates[BRCMF_MAXRATES_IN_SET];
 275 };
 276
 277 struct brcmf_ssid {
 278         u32 SSID_len;
 279         unsigned char SSID[32];
 280 };
 281
 282 struct brcmf_ssid_le {
 283         __le32 SSID_len;
 284         unsigned char SSID[32];
 285 };
 286
 287 struct brcmf_scan_params_le {
 288         struct brcmf_ssid_le ssid_le;   /* default: {0, ""} */
 289         u8 bssid[ETH_ALEN];     /* default: bcast */
 290         s8 bss_type;            /* default: any,
 291                                  * DOT11_BSSTYPE_ANY/INFRASTRUCTURE/INDEPENDENT
 292                                  */
 293         u8 scan_type;   /* flags, 0 use default */
 294         __le32 nprobes;   /* -1 use default, number of probes per channel */
 295         __le32 active_time;     /* -1 use default, dwell time per channel for
 296                                  * active scanning
 297                                  */
 298         __le32 passive_time;    /* -1 use default, dwell time per channel
 299                                  * for passive scanning
 300                                  */
 301         __le32 home_time;       /* -1 use default, dwell time for the
 302                                  * home channel between channel scans
 303                                  */
 304         __le32 channel_num;     /* count of channels and ssids that follow
 305                                  *
 306                                  * low half is count of channels in
 307                                  * channel_list, 0 means default (use all
 308                                  * available channels)
 309                                  *
 310                                  * high half is entries in struct brcmf_ssid
 311                                  * array that follows channel_list, aligned for
 312                                  * s32 (4 bytes) meaning an odd channel count
 313                                  * implies a 2-byte pad between end of
 314                                  * channel_list and first ssid
 315                                  *
 316                                  * if ssid count is zero, single ssid in the
 317                                  * fixed parameter portion is assumed, otherwise
 318                                  * ssid in the fixed portion is ignored
 319                                  */
 320         __le16 channel_list[1]; /* list of chanspecs */
 321 };
 322
 323 struct brcmf_scan_results {
 324         u32 buflen;
 325         u32 version;
 326         u32 count;
 327         struct brcmf_bss_info_le bss_info_le[];
 328 };
 329
 330 struct brcmf_escan_params_le {
 331         __le32 version;
 332         __le16 action;
 333         __le16 sync_id;
 334         struct brcmf_scan_params_le params_le;
 335 };
 336
 337 struct brcmf_escan_result_le {
 338         __le32 buflen;
 339         __le32 version;
 340         __le16 sync_id;
 341         __le16 bss_count;
 342         struct brcmf_bss_info_le bss_info_le;
 343 };
 344
 345 #define WL_ESCAN_RESULTS_FIXED_SIZE (sizeof(struct brcmf_escan_result_le) - \
 346         sizeof(struct brcmf_bss_info_le))
 347
 348 /* used for association with a specific BSSID and chanspec list */
 349 struct brcmf_assoc_params_le {
 350         /* 00:00:00:00:00:00: broadcast scan */
 351         u8 bssid[ETH_ALEN];
 352         /* 0: all available channels, otherwise count of chanspecs in
 353          * chanspec_list */
 354         __le32 chanspec_num;
 355         /* list of chanspecs */
 356         __le16 chanspec_list[1];
 357 };
 358
 359 /**
 360  * struct join_pref params - parameters for preferred join selection.
 361  *
 362  * @type: preference type (see enum brcmf_join_pref_types).
 363  * @len: length of bytes following (currently always 2).
 364  * @rssi_gain: signal gain for selection (only when @type is RSSI_DELTA).
 365  * @band: band to which selection preference applies.
 366  *      This is used if @type is BAND or RSSI_DELTA.
 367  */
 368 struct brcmf_join_pref_params {
 369         u8 type;
 370         u8 len;
 371         u8 rssi_gain;
 372         u8 band;
 373 };
 374
 375 /* used for join with or without a specific bssid and channel list */
 376 struct brcmf_join_params {
 377         struct brcmf_ssid_le ssid_le;
 378         struct brcmf_assoc_params_le params_le;
 379 };
 380
 381 /* scan params for extended join */
 382 struct brcmf_join_scan_params_le {
 383         u8 scan_type;           /* 0 use default, active or passive scan */
 384         __le32 nprobes;         /* -1 use default, nr of probes per channel */
 385         __le32 active_time;     /* -1 use default, dwell time per channel for
 386                                  * active scanning
 387                                  */
 388         __le32 passive_time;    /* -1 use default, dwell time per channel
 389                                  * for passive scanning
 390                                  */
 391         __le32 home_time;       /* -1 use default, dwell time for the home
 392                                  * channel between channel scans
 393                                  */
 394 };
 395
 396 /* extended join params */
 397 struct brcmf_ext_join_params_le {
 398         struct brcmf_ssid_le ssid_le;   /* {0, ""}: wildcard scan */
 399         struct brcmf_join_scan_params_le scan_le;
 400         struct brcmf_assoc_params_le assoc_le;
 401 };
 402
 403 struct brcmf_wsec_key {
 404         u32 index;              /* key index */
 405         u32 len;                /* key length */
 406         u8 data[WLAN_MAX_KEY_LEN];      /* key data */
 407         u32 pad_1[18];
 408         u32 algo;       /* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
 409         u32 flags;      /* misc flags */
 410         u32 pad_2[3];
 411         u32 iv_initialized;     /* has IV been initialized already? */
 412         u32 pad_3;
 413         /* Rx IV */
 414         struct {
 415                 u32 hi; /* upper 32 bits of IV */
 416                 u16 lo; /* lower 16 bits of IV */
 417         } rxiv;
 418         u32 pad_4[2];
 419         u8 ea[ETH_ALEN];        /* per station */
 420 };
 421
 422 /*
 423  * dongle requires same struct as above but with fields in little endian order
 424  */
 425 struct brcmf_wsec_key_le {
 426         __le32 index;           /* key index */
 427         __le32 len;             /* key length */
 428         u8 data[WLAN_MAX_KEY_LEN];      /* key data */
 429         __le32 pad_1[18];
 430         __le32 algo;    /* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
 431         __le32 flags;   /* misc flags */
 432         __le32 pad_2[3];
 433         __le32 iv_initialized;  /* has IV been initialized already? */
 434         __le32 pad_3;
 435         /* Rx IV */
 436         struct {
 437                 __le32 hi;      /* upper 32 bits of IV */
 438                 __le16 lo;      /* lower 16 bits of IV */
 439         } rxiv;
 440         __le32 pad_4[2];
 441         u8 ea[ETH_ALEN];        /* per station */
 442 };
 443
 444 /* Used to get specific STA parameters */
 445 struct brcmf_scb_val_le {
 446         __le32 val;
 447         u8 ea[ETH_ALEN];
 448 };
 449
 450 /* channel encoding */
 451 struct brcmf_channel_info_le {
 452         __le32 hw_channel;
 453         __le32 target_channel;
 454         __le32 scan_channel;
 455 };
 456
 457 struct brcmf_sta_info_le {
 458         __le16  ver;            /* version of this struct */
 459         __le16  len;            /* length in bytes of this structure */
 460         __le16  cap;            /* sta's advertised capabilities */
 461         __le32  flags;          /* flags defined below */
 462         __le32  idle;           /* time since data pkt rx'd from sta */
 463         u8      ea[ETH_ALEN];           /* Station address */
 464         __le32  count;                  /* # rates in this set */
 465         u8      rates[BRCMF_MAXRATES_IN_SET];   /* rates in 500kbps units */
 466                                                 /* w/hi bit set if basic */
 467         __le32  in;             /* seconds elapsed since associated */
 468         __le32  listen_interval_inms; /* Min Listen interval in ms for STA */
 469         __le32  tx_pkts;        /* # of packets transmitted */
 470         __le32  tx_failures;    /* # of packets failed */
 471         __le32  rx_ucast_pkts;  /* # of unicast packets received */
 472         __le32  rx_mcast_pkts;  /* # of multicast packets received */
 473         __le32  tx_rate;        /* Rate of last successful tx frame */
 474         __le32  rx_rate;        /* Rate of last successful rx frame */
 475         __le32  rx_decrypt_succeeds;    /* # of packet decrypted successfully */
 476         __le32  rx_decrypt_failures;    /* # of packet decrypted failed */
 477 };
 478
 479 struct brcmf_chanspec_list {
 480         __le32  count;          /* # of entries */
 481         __le32  element[1];     /* variable length uint32 list */
 482 };
 483
 484 /*
 485  * WLC_E_PROBRESP_MSG
 486  * WLC_E_P2P_PROBREQ_MSG
 487  * WLC_E_ACTION_FRAME_RX
 488  */
 489 struct brcmf_rx_mgmt_data {
 490         __be16  version;
 491         __be16  chanspec;
 492         __be32  rssi;
 493         __be32  mactime;
 494         __be32  rate;
 495 };
 496
 497 /**
 498  * struct brcmf_fil_wowl_pattern_le - wowl pattern configuration struct.
 499  *
 500  * @cmd: "add", "del" or "clr".
 501  * @masksize: Size of the mask in #of bytes
 502  * @offset: Pattern byte offset in packet
 503  * @patternoffset: Offset of start of pattern. Starting from field masksize.
 504  * @patternsize: Size of the pattern itself in #of bytes
 505  * @id: id
 506  * @reasonsize: Size of the wakeup reason code
 507  * @type: Type of pattern (enum brcmf_wowl_pattern_type)
 508  */
 509 struct brcmf_fil_wowl_pattern_le {
 510         u8      cmd[4];
 511         __le32  masksize;
 512         __le32  offset;
 513         __le32  patternoffset;
 514         __le32  patternsize;
 515         __le32  id;
 516         __le32  reasonsize;
 517         __le32  type;
 518         /* u8 mask[] - Mask follows the structure above */
 519         /* u8 pattern[] - Pattern follows the mask is at 'patternoffset' */
 520 };
 521
 522 struct brcmf_mbss_ssid_le {
 523         __le32  bsscfgidx;
 524         __le32  SSID_len;
 525         unsigned char SSID[32];
 526 };
 527
 528 #endif /* FWIL_TYPES_H_ */