drivers/net/wireless/brcm80211/brcmfmac/wl_cfg80211.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 #ifndef _wl_cfg80211_h_
  18 #define _wl_cfg80211_h_
  19
  20 #define WL_NUM_SCAN_MAX                 10
  21 #define WL_NUM_PMKIDS_MAX               MAXPMKID
  22 #define WL_TLV_INFO_MAX                 1024
  23 #define WL_BSS_INFO_MAX                 2048
  24 #define WL_ASSOC_INFO_MAX               512     /* assoc related fil max buf */
  25 #define WL_EXTRA_BUF_MAX                2048
  26 #define WL_ROAM_TRIGGER_LEVEL           -75
  27 #define WL_ROAM_DELTA                   20
  28 #define WL_BEACON_TIMEOUT               3
  29
  30 #define WL_SCAN_CHANNEL_TIME            40
  31 #define WL_SCAN_UNASSOC_TIME            40
  32 #define WL_SCAN_PASSIVE_TIME            120
  33
  34 #define WL_ESCAN_BUF_SIZE               (1024 * 64)
  35 #define WL_ESCAN_TIMER_INTERVAL_MS      8000 /* E-Scan timeout */
  36
  37 #define WL_ESCAN_ACTION_START           1
  38 #define WL_ESCAN_ACTION_CONTINUE        2
  39 #define WL_ESCAN_ACTION_ABORT           3
  40
  41 #define WL_AUTH_SHARED_KEY              1       /* d11 shared authentication */
  42 #define IE_MAX_LEN                      512
  43
  44 /* IE TLV processing */
  45 #define TLV_LEN_OFF                     1       /* length offset */
  46 #define TLV_HDR_LEN                     2       /* header length */
  47 #define TLV_BODY_OFF                    2       /* body offset */
  48 #define TLV_OUI_LEN                     3       /* oui id length */
  49
  50 /* 802.11 Mgmt Packet flags */
  51 #define BRCMF_VNDR_IE_BEACON_FLAG       0x1
  52 #define BRCMF_VNDR_IE_PRBRSP_FLAG       0x2
  53 #define BRCMF_VNDR_IE_ASSOCRSP_FLAG     0x4
  54 #define BRCMF_VNDR_IE_AUTHRSP_FLAG      0x8
  55 #define BRCMF_VNDR_IE_PRBREQ_FLAG       0x10
  56 #define BRCMF_VNDR_IE_ASSOCREQ_FLAG     0x20
  57 /* vendor IE in IW advertisement protocol ID field */
  58 #define BRCMF_VNDR_IE_IWAPID_FLAG       0x40
  59 /* allow custom IE id */
  60 #define BRCMF_VNDR_IE_CUSTOM_FLAG       0x100
  61
  62 /* P2P Action Frames flags (spec ordered) */
  63 #define BRCMF_VNDR_IE_GONREQ_FLAG     0x001000
  64 #define BRCMF_VNDR_IE_GONRSP_FLAG     0x002000
  65 #define BRCMF_VNDR_IE_GONCFM_FLAG     0x004000
  66 #define BRCMF_VNDR_IE_INVREQ_FLAG     0x008000
  67 #define BRCMF_VNDR_IE_INVRSP_FLAG     0x010000
  68 #define BRCMF_VNDR_IE_DISREQ_FLAG     0x020000
  69 #define BRCMF_VNDR_IE_DISRSP_FLAG     0x040000
  70 #define BRCMF_VNDR_IE_PRDREQ_FLAG     0x080000
  71 #define BRCMF_VNDR_IE_PRDRSP_FLAG     0x100000
  72
  73 #define BRCMF_VNDR_IE_P2PAF_SHIFT       12
  74
  75
  76 /**
  77  * enum brcmf_scan_status - dongle scan status
  78  *
  79  * @BRCMF_SCAN_STATUS_BUSY: scanning in progress on dongle.
  80  * @BRCMF_SCAN_STATUS_ABORT: scan being aborted on dongle.
  81  */
  82 enum brcmf_scan_status {
  83         BRCMF_SCAN_STATUS_BUSY,
  84         BRCMF_SCAN_STATUS_ABORT,
  85 };
  86
  87 /**
  88  * enum wl_mode - driver mode of virtual interface.
  89  *
  90  * @WL_MODE_BSS: connects to BSS.
  91  * @WL_MODE_IBSS: operate as ad-hoc.
  92  * @WL_MODE_AP: operate as access-point.
  93  * @WL_MODE_P2P: provide P2P discovery.
  94  */
  95 enum wl_mode {
  96         WL_MODE_BSS,
  97         WL_MODE_IBSS,
  98         WL_MODE_AP,
  99         WL_MODE_P2P
 100 };
 101
 102 /* dongle configuration */
 103 struct brcmf_cfg80211_conf {
 104         u32 frag_threshold;
 105         u32 rts_threshold;
 106         u32 retry_short;
 107         u32 retry_long;
 108         s32 tx_power;
 109         struct ieee80211_channel channel;
 110 };
 111
 112 /* basic structure of scan request */
 113 struct brcmf_cfg80211_scan_req {
 114         struct brcmf_ssid_le ssid_le;
 115 };
 116
 117 /* basic structure of information element */
 118 struct brcmf_cfg80211_ie {
 119         u16 offset;
 120         u8 buf[WL_TLV_INFO_MAX];
 121 };
 122
 123 /* security information with currently associated ap */
 124 struct brcmf_cfg80211_security {
 125         u32 wpa_versions;
 126         u32 auth_type;
 127         u32 cipher_pairwise;
 128         u32 cipher_group;
 129         u32 wpa_auth;
 130 };
 131
 132 /**
 133  * struct brcmf_cfg80211_profile - profile information.
 134  *
 135  * @ssid: ssid of associated/associating ap.
 136  * @bssid: bssid of joined/joining ibss.
 137  * @sec: security information.
 138  */
 139 struct brcmf_cfg80211_profile {
 140         struct brcmf_ssid ssid;
 141         u8 bssid[ETH_ALEN];
 142         struct brcmf_cfg80211_security sec;
 143 };
 144
 145 /**
 146  * enum brcmf_vif_status - bit indices for vif status.
 147  *
 148  * @BRCMF_VIF_STATUS_READY: ready for operation.
 149  * @BRCMF_VIF_STATUS_CONNECTING: connect/join in progress.
 150  * @BRCMF_VIF_STATUS_CONNECTED: connected/joined succesfully.
 151  * @BRCMF_VIF_STATUS_DISCONNECTING: disconnect/disable in progress.
 152  * @BRCMF_VIF_STATUS_AP_CREATING: interface configured for AP operation.
 153  * @BRCMF_VIF_STATUS_AP_CREATED: AP operation started.
 154  */
 155 enum brcmf_vif_status {
 156         BRCMF_VIF_STATUS_READY,
 157         BRCMF_VIF_STATUS_CONNECTING,
 158         BRCMF_VIF_STATUS_CONNECTED,
 159         BRCMF_VIF_STATUS_DISCONNECTING,
 160         BRCMF_VIF_STATUS_AP_CREATING,
 161         BRCMF_VIF_STATUS_AP_CREATED
 162 };
 163
 164 /**
 165  * struct vif_saved_ie - holds saved IEs for a virtual interface.
 166  *
 167  * @probe_req_ie: IE info for probe request.
 168  * @probe_res_ie: IE info for probe response.
 169  * @beacon_ie: IE info for beacon frame.
 170  * @probe_req_ie_len: IE info length for probe request.
 171  * @probe_res_ie_len: IE info length for probe response.
 172  * @beacon_ie_len: IE info length for beacon frame.
 173  */
 174 struct vif_saved_ie {
 175         u8  probe_req_ie[IE_MAX_LEN];
 176         u8  probe_res_ie[IE_MAX_LEN];
 177         u8  beacon_ie[IE_MAX_LEN];
 178         u8  assoc_req_ie[IE_MAX_LEN];
 179         u32 probe_req_ie_len;
 180         u32 probe_res_ie_len;
 181         u32 beacon_ie_len;
 182         u32 assoc_req_ie_len;
 183 };
 184
 185 /**
 186  * struct brcmf_cfg80211_vif - virtual interface specific information.
 187  *
 188  * @ifp: lower layer interface pointer
 189  * @wdev: wireless device.
 190  * @profile: profile information.
 191  * @mode: operating mode.
 192  * @roam_off: roaming state.
 193  * @sme_state: SME state using enum brcmf_vif_status bits.
 194  * @pm_block: power-management blocked.
 195  * @list: linked list.
 196  * @mgmt_rx_reg: registered rx mgmt frame types.
 197  */
 198 struct brcmf_cfg80211_vif {
 199         struct brcmf_if *ifp;
 200         struct wireless_dev wdev;
 201         struct brcmf_cfg80211_profile profile;
 202         s32 mode;
 203         s32 roam_off;
 204         unsigned long sme_state;
 205         bool pm_block;
 206         struct vif_saved_ie saved_ie;
 207         struct list_head list;
 208         u16 mgmt_rx_reg;
 209 };
 210
 211 /* association inform */
 212 struct brcmf_cfg80211_connect_info {
 213         u8 *req_ie;
 214         s32 req_ie_len;
 215         u8 *resp_ie;
 216         s32 resp_ie_len;
 217 };
 218
 219 /* assoc ie length */
 220 struct brcmf_cfg80211_assoc_ielen_le {
 221         __le32 req_len;
 222         __le32 resp_len;
 223 };
 224
 225 /* wpa2 pmk list */
 226 struct brcmf_cfg80211_pmk_list {
 227         struct pmkid_list pmkids;
 228         struct pmkid foo[MAXPMKID - 1];
 229 };
 230
 231 /* dongle escan state */
 232 enum wl_escan_state {
 233         WL_ESCAN_STATE_IDLE,
 234         WL_ESCAN_STATE_SCANNING
 235 };
 236
 237 struct escan_info {
 238         u32 escan_state;
 239         u8 escan_buf[WL_ESCAN_BUF_SIZE];
 240         struct wiphy *wiphy;
 241         struct brcmf_if *ifp;
 242         s32 (*run)(struct brcmf_cfg80211_info *cfg, struct brcmf_if *ifp,
 243                    struct cfg80211_scan_request *request, u16 action);
 244 };
 245
 246 /**
 247  * struct brcmf_pno_param_le - PNO scan configuration parameters
 248  *
 249  * @version: PNO parameters version.
 250  * @scan_freq: scan frequency.
 251  * @lost_network_timeout: #sec. to declare discovered network as lost.
 252  * @flags: Bit field to control features of PFN such as sort criteria auto
 253  *      enable switch and background scan.
 254  * @rssi_margin: Margin to avoid jitter for choosing a PFN based on RSSI sort
 255  *      criteria.
 256  * @bestn: number of best networks in each scan.
 257  * @mscan: number of scans recorded.
 258  * @repeat: minimum number of scan intervals before scan frequency changes
 259  *      in adaptive scan.
 260  * @exp: exponent of 2 for maximum scan interval.
 261  * @slow_freq: slow scan period.
 262  */
 263 struct brcmf_pno_param_le {
 264         __le32 version;
 265         __le32 scan_freq;
 266         __le32 lost_network_timeout;
 267         __le16 flags;
 268         __le16 rssi_margin;
 269         u8 bestn;
 270         u8 mscan;
 271         u8 repeat;
 272         u8 exp;
 273         __le32 slow_freq;
 274 };
 275
 276 /**
 277  * struct brcmf_pno_net_param_le - scan parameters per preferred network.
 278  *
 279  * @ssid: ssid name and its length.
 280  * @flags: bit2: hidden.
 281  * @infra: BSS vs IBSS.
 282  * @auth: Open vs Closed.
 283  * @wpa_auth: WPA type.
 284  * @wsec: wsec value.
 285  */
 286 struct brcmf_pno_net_param_le {
 287         struct brcmf_ssid_le ssid;
 288         __le32 flags;
 289         __le32 infra;
 290         __le32 auth;
 291         __le32 wpa_auth;
 292         __le32 wsec;
 293 };
 294
 295 /**
 296  * struct brcmf_pno_net_info_le - information per found network.
 297  *
 298  * @bssid: BSS network identifier.
 299  * @channel: channel number only.
 300  * @SSID_len: length of ssid.
 301  * @SSID: ssid characters.
 302  * @RSSI: receive signal strength (in dBm).
 303  * @timestamp: age in seconds.
 304  */
 305 struct brcmf_pno_net_info_le {
 306         u8 bssid[ETH_ALEN];
 307         u8 channel;
 308         u8 SSID_len;
 309         u8 SSID[32];
 310         __le16  RSSI;
 311         __le16  timestamp;
 312 };
 313
 314 /**
 315  * struct brcmf_pno_scanresults_le - result returned in PNO NET FOUND event.
 316  *
 317  * @version: PNO version identifier.
 318  * @status: indicates completion status of PNO scan.
 319  * @count: amount of brcmf_pno_net_info_le entries appended.
 320  */
 321 struct brcmf_pno_scanresults_le {
 322         __le32 version;
 323         __le32 status;
 324         __le32 count;
 325 };
 326
 327 /**
 328  * struct brcmf_cfg80211_vif_event - virtual interface event information.
 329  *
 330  * @vif_wq: waitqueue awaiting interface event from firmware.
 331  * @vif_event_lock: protects other members in this structure.
 332  * @vif_complete: completion for net attach.
 333  * @action: either add, change, or delete.
 334  * @vif: virtual interface object related to the event.
 335  */
 336 struct brcmf_cfg80211_vif_event {
 337         wait_queue_head_t vif_wq;
 338         struct mutex vif_event_lock;
 339         u8 action;
 340         struct brcmf_cfg80211_vif *vif;
 341 };
 342
 343 /**
 344  * struct brcmf_cfg80211_info - dongle private data of cfg80211 interface
 345  *
 346  * @wiphy: wiphy object for cfg80211 interface.
 347  * @conf: dongle configuration.
 348  * @p2p: peer-to-peer specific information.
 349  * @scan_request: cfg80211 scan request object.
 350  * @usr_sync: mainly for dongle up/down synchronization.
 351  * @bss_list: bss_list holding scanned ap information.
 352  * @scan_req_int: internal scan request object.
 353  * @bss_info: bss information for cfg80211 layer.
 354  * @ie: information element object for internal purpose.
 355  * @conn_info: association info.
 356  * @pmk_list: wpa2 pmk list.
 357  * @scan_status: scan activity on the dongle.
 358  * @pub: common driver information.
 359  * @channel: current channel.
 360  * @active_scan: current scan mode.
 361  * @sched_escan: e-scan for scheduled scan support running.
 362  * @ibss_starter: indicates this sta is ibss starter.
 363  * @pwr_save: indicate whether dongle to support power save mode.
 364  * @dongle_up: indicate whether dongle up or not.
 365  * @roam_on: on/off switch for dongle self-roaming.
 366  * @scan_tried: indicates if first scan attempted.
 367  * @dcmd_buf: dcmd buffer.
 368  * @extra_buf: mainly to grab assoc information.
 369  * @debugfsdir: debugfs folder for this device.
 370  * @escan_info: escan information.
 371  * @escan_timeout: Timer for catch scan timeout.
 372  * @escan_timeout_work: scan timeout worker.
 373  * @escan_ioctl_buf: dongle command buffer for escan commands.
 374  * @vif_list: linked list of vif instances.
 375  * @vif_cnt: number of vif instances.
 376  * @vif_event: vif event signalling.
 377  */
 378 struct brcmf_cfg80211_info {
 379         struct wiphy *wiphy;
 380         struct brcmf_cfg80211_conf *conf;
 381         struct brcmf_p2p_info p2p;
 382         struct cfg80211_scan_request *scan_request;
 383         struct mutex usr_sync;
 384         struct brcmf_scan_results *bss_list;
 385         struct brcmf_cfg80211_scan_req scan_req_int;
 386         struct wl_cfg80211_bss_info *bss_info;
 387         struct brcmf_cfg80211_ie ie;
 388         struct brcmf_cfg80211_connect_info conn_info;
 389         struct brcmf_cfg80211_pmk_list *pmk_list;
 390         unsigned long scan_status;
 391         struct brcmf_pub *pub;
 392         u32 channel;
 393         bool active_scan;
 394         bool sched_escan;
 395         bool ibss_starter;
 396         bool pwr_save;
 397         bool dongle_up;
 398         bool roam_on;
 399         bool scan_tried;
 400         u8 *dcmd_buf;
 401         u8 *extra_buf;
 402         struct dentry *debugfsdir;
 403         struct escan_info escan_info;
 404         struct timer_list escan_timeout;
 405         struct work_struct escan_timeout_work;
 406         u8 *escan_ioctl_buf;
 407         struct list_head vif_list;
 408         u8 vif_cnt;
 409         struct brcmf_cfg80211_vif_event vif_event;
 410         struct completion vif_disabled;
 411 };
 412
 413 /**
 414  * struct brcmf_tlv - tag_ID/length/value_buffer tuple.
 415  *
 416  * @id: tag identifier.
 417  * @len: number of bytes in value buffer.
 418  * @data: value buffer.
 419  */
 420 struct brcmf_tlv {
 421         u8 id;
 422         u8 len;
 423         u8 data[1];
 424 };
 425
 426 static inline struct wiphy *cfg_to_wiphy(struct brcmf_cfg80211_info *cfg)
 427 {
 428         return cfg->wiphy;
 429 }
 430
 431 static inline struct brcmf_cfg80211_info *wiphy_to_cfg(struct wiphy *w)
 432 {
 433         return (struct brcmf_cfg80211_info *)(wiphy_priv(w));
 434 }
 435
 436 static inline struct brcmf_cfg80211_info *wdev_to_cfg(struct wireless_dev *wd)
 437 {
 438         return (struct brcmf_cfg80211_info *)(wdev_priv(wd));
 439 }
 440
 441 static inline
 442 struct net_device *cfg_to_ndev(struct brcmf_cfg80211_info *cfg)
 443 {
 444         struct brcmf_cfg80211_vif *vif;
 445         vif = list_first_entry(&cfg->vif_list, struct brcmf_cfg80211_vif, list);
 446         return vif->wdev.netdev;
 447 }
 448
 449 static inline struct brcmf_cfg80211_info *ndev_to_cfg(struct net_device *ndev)
 450 {
 451         return wdev_to_cfg(ndev->ieee80211_ptr);
 452 }
 453
 454 static inline struct brcmf_cfg80211_profile *ndev_to_prof(struct net_device *nd)
 455 {
 456         struct brcmf_if *ifp = netdev_priv(nd);
 457         return &ifp->vif->profile;
 458 }
 459
 460 static inline struct brcmf_cfg80211_vif *ndev_to_vif(struct net_device *ndev)
 461 {
 462         struct brcmf_if *ifp = netdev_priv(ndev);
 463         return ifp->vif;
 464 }
 465
 466 static inline struct
 467 brcmf_cfg80211_connect_info *cfg_to_conn(struct brcmf_cfg80211_info *cfg)
 468 {
 469         return &cfg->conn_info;
 470 }
 471
 472 struct brcmf_cfg80211_info *brcmf_cfg80211_attach(struct brcmf_pub *drvr,
 473                                                   struct device *busdev);
 474 void brcmf_cfg80211_detach(struct brcmf_cfg80211_info *cfg);
 475 s32 brcmf_cfg80211_up(struct net_device *ndev);
 476 s32 brcmf_cfg80211_down(struct net_device *ndev);
 477
 478 struct brcmf_cfg80211_vif *brcmf_alloc_vif(struct brcmf_cfg80211_info *cfg,
 479                                            enum nl80211_iftype type,
 480                                            bool pm_block);
 481 void brcmf_free_vif(struct brcmf_cfg80211_vif *vif);
 482
 483 s32 brcmf_vif_set_mgmt_ie(struct brcmf_cfg80211_vif *vif, s32 pktflag,
 484                           const u8 *vndr_ie_buf, u32 vndr_ie_len);
 485 s32 brcmf_vif_clear_mgmt_ies(struct brcmf_cfg80211_vif *vif);
 486 struct brcmf_tlv *brcmf_parse_tlvs(void *buf, int buflen, uint key);
 487 u16 channel_to_chanspec(struct ieee80211_channel *ch);
 488 u32 wl_get_vif_state_all(struct brcmf_cfg80211_info *cfg, unsigned long state);
 489 void brcmf_cfg80211_arm_vif_event(struct brcmf_cfg80211_info *cfg,
 490                                   struct brcmf_cfg80211_vif *vif);
 491 bool brcmf_cfg80211_vif_event_armed(struct brcmf_cfg80211_info *cfg);
 492 int brcmf_cfg80211_wait_vif_event_timeout(struct brcmf_cfg80211_info *cfg,
 493                                           u8 action, ulong timeout);
 494 s32 brcmf_notify_escan_complete(struct brcmf_cfg80211_info *cfg,
 495                                 struct brcmf_if *ifp, bool aborted,
 496                                 bool fw_abort);
 497 void brcmf_set_mpc(struct brcmf_if *ndev, int mpc);
 498 void brcmf_abort_scanning(struct brcmf_cfg80211_info *cfg);
 499
 500 #endif                          /* _wl_cfg80211_h_ */