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_DBG_NONE             0
  21 #define WL_DBG_CONN             (1 << 5)
  22 #define WL_DBG_SCAN             (1 << 4)
  23 #define WL_DBG_TRACE            (1 << 3)
  24 #define WL_DBG_INFO             (1 << 1)
  25 #define WL_DBG_ERR              (1 << 0)
  26 #define WL_DBG_MASK             ((WL_DBG_INFO | WL_DBG_ERR | WL_DBG_TRACE) | \
  27                                 (WL_DBG_SCAN) | (WL_DBG_CONN))
  28
  29 #define WL_ERR(fmt, ...)                                        \
  30 do {                                                            \
  31         if (brcmf_dbg_level & WL_DBG_ERR) {                     \
  32                 if (net_ratelimit()) {                          \
  33                         pr_err("ERROR @%s : " fmt,              \
  34                                __func__, ##__VA_ARGS__);        \
  35                 }                                               \
  36         }                                                       \
  37 } while (0)
  38
  39 #if (defined DEBUG)
  40 #define WL_INFO(fmt, ...)                                       \
  41 do {                                                            \
  42         if (brcmf_dbg_level & WL_DBG_INFO) {                    \
  43                 if (net_ratelimit()) {                          \
  44                         pr_err("INFO @%s : " fmt,               \
  45                                __func__, ##__VA_ARGS__);        \
  46                 }                                               \
  47         }                                                       \
  48 } while (0)
  49
  50 #define WL_TRACE(fmt, ...)                                      \
  51 do {                                                            \
  52         if (brcmf_dbg_level & WL_DBG_TRACE) {                   \
  53                 if (net_ratelimit()) {                          \
  54                         pr_err("TRACE @%s : " fmt,              \
  55                                __func__, ##__VA_ARGS__);        \
  56                 }                                               \
  57         }                                                       \
  58 } while (0)
  59
  60 #define WL_SCAN(fmt, ...)                                       \
  61 do {                                                            \
  62         if (brcmf_dbg_level & WL_DBG_SCAN) {                    \
  63                 if (net_ratelimit()) {                          \
  64                         pr_err("SCAN @%s : " fmt,               \
  65                                __func__, ##__VA_ARGS__);        \
  66                 }                                               \
  67         }                                                       \
  68 } while (0)
  69
  70 #define WL_CONN(fmt, ...)                                       \
  71 do {                                                            \
  72         if (brcmf_dbg_level & WL_DBG_CONN) {                    \
  73                 if (net_ratelimit()) {                          \
  74                         pr_err("CONN @%s : " fmt,               \
  75                                __func__, ##__VA_ARGS__);        \
  76                 }                                               \
  77         }                                                       \
  78 } while (0)
  79
  80 #else /* (defined DEBUG) */
  81 #define WL_INFO(fmt, args...)
  82 #define WL_TRACE(fmt, args...)
  83 #define WL_SCAN(fmt, args...)
  84 #define WL_CONN(fmt, args...)
  85 #endif /* (defined DEBUG) */
  86
  87 #define WL_NUM_SCAN_MAX         1
  88 #define WL_NUM_PMKIDS_MAX       MAXPMKID        /* will be used
  89                                                  * for 2.6.33 kernel
  90                                                  * or later
  91                                                  */
  92 #define WL_SCAN_BUF_MAX                 (1024 * 8)
  93 #define WL_TLV_INFO_MAX                 1024
  94 #define WL_BSS_INFO_MAX                 2048
  95 #define WL_ASSOC_INFO_MAX       512     /*
  96                                  * needs to grab assoc info from dongle to
  97                                  * report it to cfg80211 through "connect"
  98                                  * event
  99                                  */
 100 #define WL_DCMD_LEN_MAX 1024
 101 #define WL_EXTRA_BUF_MAX        2048
 102 #define WL_ISCAN_BUF_MAX        2048    /*
 103                                  * the buf length can be BRCMF_DCMD_MAXLEN
 104                                  * to reduce iteration
 105                                  */
 106 #define WL_ISCAN_TIMER_INTERVAL_MS      3000
 107 #define WL_SCAN_ERSULTS_LAST    (BRCMF_SCAN_RESULTS_NO_MEM+1)
 108 #define WL_AP_MAX       256     /* virtually unlimitted as long
 109                                  * as kernel memory allows
 110                                  */
 111
 112 #define WL_ROAM_TRIGGER_LEVEL           -75
 113 #define WL_ROAM_DELTA                   20
 114 #define WL_BEACON_TIMEOUT               3
 115
 116 #define WL_SCAN_CHANNEL_TIME            40
 117 #define WL_SCAN_UNASSOC_TIME            40
 118 #define WL_SCAN_PASSIVE_TIME            120
 119
 120 #define WL_ESCAN_BUF_SIZE               (1024 * 64)
 121 #define WL_ESCAN_TIMER_INTERVAL_MS      8000 /* E-Scan timeout */
 122
 123 #define WL_ESCAN_ACTION_START           1
 124 #define WL_ESCAN_ACTION_CONTINUE        2
 125 #define WL_ESCAN_ACTION_ABORT           3
 126
 127 #define WL_AUTH_SHARED_KEY              1       /* d11 shared authentication */
 128 #define IE_MAX_LEN                      512
 129
 130 /* dongle status */
 131 enum wl_status {
 132         WL_STATUS_READY,
 133         WL_STATUS_SCANNING,
 134         WL_STATUS_SCAN_ABORTING,
 135         WL_STATUS_CONNECTING,
 136         WL_STATUS_CONNECTED,
 137         WL_STATUS_AP_CREATING,
 138         WL_STATUS_AP_CREATED
 139 };
 140
 141 /* wi-fi mode */
 142 enum wl_mode {
 143         WL_MODE_BSS,
 144         WL_MODE_IBSS,
 145         WL_MODE_AP
 146 };
 147
 148 /* dongle profile list */
 149 enum wl_prof_list {
 150         WL_PROF_MODE,
 151         WL_PROF_SSID,
 152         WL_PROF_SEC,
 153         WL_PROF_IBSS,
 154         WL_PROF_BAND,
 155         WL_PROF_BSSID,
 156         WL_PROF_ACT,
 157         WL_PROF_BEACONINT,
 158         WL_PROF_DTIMPERIOD
 159 };
 160
 161 /* dongle iscan state */
 162 enum wl_iscan_state {
 163         WL_ISCAN_STATE_IDLE,
 164         WL_ISCAN_STATE_SCANING
 165 };
 166
 167 /* dongle configuration */
 168 struct brcmf_cfg80211_conf {
 169         u32 mode;               /* adhoc , infrastructure or ap */
 170         u32 frag_threshold;
 171         u32 rts_threshold;
 172         u32 retry_short;
 173         u32 retry_long;
 174         s32 tx_power;
 175         struct ieee80211_channel channel;
 176 };
 177
 178 /* forward declaration */
 179 struct brcmf_cfg80211_info;
 180
 181 /* cfg80211 main event loop */
 182 struct brcmf_cfg80211_event_loop {
 183         s32(*handler[BRCMF_E_LAST]) (struct brcmf_cfg80211_info *cfg,
 184                                      struct net_device *ndev,
 185                                      const struct brcmf_event_msg *e,
 186                                      void *data);
 187 };
 188
 189 /* basic structure of scan request */
 190 struct brcmf_cfg80211_scan_req {
 191         struct brcmf_ssid_le ssid_le;
 192 };
 193
 194 /* basic structure of information element */
 195 struct brcmf_cfg80211_ie {
 196         u16 offset;
 197         u8 buf[WL_TLV_INFO_MAX];
 198 };
 199
 200 /* event queue for cfg80211 main event */
 201 struct brcmf_cfg80211_event_q {
 202         struct list_head evt_q_list;
 203         u32 etype;
 204         struct brcmf_event_msg emsg;
 205         s8 edata[1];
 206 };
 207
 208 /* security information with currently associated ap */
 209 struct brcmf_cfg80211_security {
 210         u32 wpa_versions;
 211         u32 auth_type;
 212         u32 cipher_pairwise;
 213         u32 cipher_group;
 214         u32 wpa_auth;
 215 };
 216
 217 /* ibss information for currently joined ibss network */
 218 struct brcmf_cfg80211_ibss {
 219         u8 beacon_interval;     /* in millisecond */
 220         u8 atim;                /* in millisecond */
 221         s8 join_only;
 222         u8 band;
 223         u8 channel;
 224 };
 225
 226 /* dongle profile */
 227 struct brcmf_cfg80211_profile {
 228         u32 mode;
 229         struct brcmf_ssid ssid;
 230         u8 bssid[ETH_ALEN];
 231         u16 beacon_interval;
 232         u8 dtim_period;
 233         struct brcmf_cfg80211_security sec;
 234         struct brcmf_cfg80211_ibss ibss;
 235         s32 band;
 236 };
 237
 238 /* dongle iscan event loop */
 239 struct brcmf_cfg80211_iscan_eloop {
 240         s32 (*handler[WL_SCAN_ERSULTS_LAST])
 241                 (struct brcmf_cfg80211_info *cfg);
 242 };
 243
 244 /* dongle iscan controller */
 245 struct brcmf_cfg80211_iscan_ctrl {
 246         struct net_device *ndev;
 247         struct timer_list timer;
 248         u32 timer_ms;
 249         u32 timer_on;
 250         s32 state;
 251         struct work_struct work;
 252         struct brcmf_cfg80211_iscan_eloop el;
 253         void *data;
 254         s8 dcmd_buf[BRCMF_DCMD_SMLEN];
 255         s8 scan_buf[WL_ISCAN_BUF_MAX];
 256 };
 257
 258 /* association inform */
 259 struct brcmf_cfg80211_connect_info {
 260         u8 *req_ie;
 261         s32 req_ie_len;
 262         u8 *resp_ie;
 263         s32 resp_ie_len;
 264 };
 265
 266 /* assoc ie length */
 267 struct brcmf_cfg80211_assoc_ielen_le {
 268         __le32 req_len;
 269         __le32 resp_len;
 270 };
 271
 272 /* wpa2 pmk list */
 273 struct brcmf_cfg80211_pmk_list {
 274         struct pmkid_list pmkids;
 275         struct pmkid foo[MAXPMKID - 1];
 276 };
 277
 278 /* dongle escan state */
 279 enum wl_escan_state {
 280         WL_ESCAN_STATE_IDLE,
 281         WL_ESCAN_STATE_SCANNING
 282 };
 283
 284 struct escan_info {
 285         u32 escan_state;
 286         u8 escan_buf[WL_ESCAN_BUF_SIZE];
 287         struct wiphy *wiphy;
 288         struct net_device *ndev;
 289 };
 290
 291 /* Structure to hold WPS, WPA IEs for a AP */
 292 struct ap_info {
 293         u8 probe_res_ie[IE_MAX_LEN];
 294         u8 beacon_ie[IE_MAX_LEN];
 295         u32 probe_res_ie_len;
 296         u32 beacon_ie_len;
 297         u8 *wpa_ie;
 298         u8 *rsn_ie;
 299         bool security_mode;
 300 };
 301
 302 /**
 303  * struct brcmf_pno_param_le - PNO scan configuration parameters
 304  *
 305  * @version: PNO parameters version.
 306  * @scan_freq: scan frequency.
 307  * @lost_network_timeout: #sec. to declare discovered network as lost.
 308  * @flags: Bit field to control features of PFN such as sort criteria auto
 309  *      enable switch and background scan.
 310  * @rssi_margin: Margin to avoid jitter for choosing a PFN based on RSSI sort
 311  *      criteria.
 312  * @bestn: number of best networks in each scan.
 313  * @mscan: number of scans recorded.
 314  * @repeat: minimum number of scan intervals before scan frequency changes
 315  *      in adaptive scan.
 316  * @exp: exponent of 2 for maximum scan interval.
 317  * @slow_freq: slow scan period.
 318  */
 319 struct brcmf_pno_param_le {
 320         __le32 version;
 321         __le32 scan_freq;
 322         __le32 lost_network_timeout;
 323         __le16 flags;
 324         __le16 rssi_margin;
 325         u8 bestn;
 326         u8 mscan;
 327         u8 repeat;
 328         u8 exp;
 329         __le32 slow_freq;
 330 };
 331
 332 /**
 333  * struct brcmf_pno_net_param_le - scan parameters per preferred network.
 334  *
 335  * @ssid: ssid name and its length.
 336  * @flags: bit2: hidden.
 337  * @infra: BSS vs IBSS.
 338  * @auth: Open vs Closed.
 339  * @wpa_auth: WPA type.
 340  * @wsec: wsec value.
 341  */
 342 struct brcmf_pno_net_param_le {
 343         struct brcmf_ssid_le ssid;
 344         __le32 flags;
 345         __le32 infra;
 346         __le32 auth;
 347         __le32 wpa_auth;
 348         __le32 wsec;
 349 };
 350
 351 /**
 352  * struct brcmf_pno_net_info_le - information per found network.
 353  *
 354  * @bssid: BSS network identifier.
 355  * @channel: channel number only.
 356  * @SSID_len: length of ssid.
 357  * @SSID: ssid characters.
 358  * @RSSI: receive signal strength (in dBm).
 359  * @timestamp: age in seconds.
 360  */
 361 struct brcmf_pno_net_info_le {
 362         u8 bssid[ETH_ALEN];
 363         u8 channel;
 364         u8 SSID_len;
 365         u8 SSID[32];
 366         __le16  RSSI;
 367         __le16  timestamp;
 368 };
 369
 370 /**
 371  * struct brcmf_pno_scanresults_le - result returned in PNO NET FOUND event.
 372  *
 373  * @version: PNO version identifier.
 374  * @status: indicates completion status of PNO scan.
 375  * @count: amount of brcmf_pno_net_info_le entries appended.
 376  */
 377 struct brcmf_pno_scanresults_le {
 378         __le32 version;
 379         __le32 status;
 380         __le32 count;
 381 };
 382
 383 /**
 384  * struct brcmf_cfg80211_info - dongle private data of cfg80211 interface
 385  *
 386  * @wdev: representing wl cfg80211 device.
 387  * @conf: dongle configuration.
 388  * @scan_request: cfg80211 scan request object.
 389  * @el: main event loop.
 390  * @evt_q_list: used for event queue.
 391  * @evt_q_lock: for event queue synchronization.
 392  * @usr_sync: mainly for dongle up/down synchronization.
 393  * @bss_list: bss_list holding scanned ap information.
 394  * @scan_results: results of the last scan.
 395  * @scan_req_int: internal scan request object.
 396  * @bss_info: bss information for cfg80211 layer.
 397  * @ie: information element object for internal purpose.
 398  * @profile: holding dongle profile.
 399  * @iscan: iscan controller information.
 400  * @conn_info: association info.
 401  * @pmk_list: wpa2 pmk list.
 402  * @event_work: event handler work struct.
 403  * @status: current dongle status.
 404  * @pub: common driver information.
 405  * @channel: current channel.
 406  * @iscan_on: iscan on/off switch.
 407  * @iscan_kickstart: indicate iscan already started.
 408  * @active_scan: current scan mode.
 409  * @sched_escan: e-scan for scheduled scan support running.
 410  * @ibss_starter: indicates this sta is ibss starter.
 411  * @link_up: link/connection up flag.
 412  * @pwr_save: indicate whether dongle to support power save mode.
 413  * @dongle_up: indicate whether dongle up or not.
 414  * @roam_on: on/off switch for dongle self-roaming.
 415  * @scan_tried: indicates if first scan attempted.
 416  * @dcmd_buf: dcmd buffer.
 417  * @extra_buf: mainly to grab assoc information.
 418  * @debugfsdir: debugfs folder for this device.
 419  * @escan_on: escan on/off switch.
 420  * @escan_info: escan information.
 421  * @escan_timeout: Timer for catch scan timeout.
 422  * @escan_timeout_work: scan timeout worker.
 423  * @escan_ioctl_buf: dongle command buffer for escan commands.
 424  * @ap_info: host ap information.
 425  * @ci: used to link this structure to netdev private data.
 426  */
 427 struct brcmf_cfg80211_info {
 428         struct wireless_dev *wdev;
 429         struct brcmf_cfg80211_conf *conf;
 430         struct cfg80211_scan_request *scan_request;
 431         struct brcmf_cfg80211_event_loop el;
 432         struct list_head evt_q_list;
 433         spinlock_t       evt_q_lock;
 434         struct mutex usr_sync;
 435         struct brcmf_scan_results *bss_list;
 436         struct brcmf_scan_results *scan_results;
 437         struct brcmf_cfg80211_scan_req *scan_req_int;
 438         struct wl_cfg80211_bss_info *bss_info;
 439         struct brcmf_cfg80211_ie ie;
 440         struct brcmf_cfg80211_profile *profile;
 441         struct brcmf_cfg80211_iscan_ctrl *iscan;
 442         struct brcmf_cfg80211_connect_info conn_info;
 443         struct brcmf_cfg80211_pmk_list *pmk_list;
 444         struct work_struct event_work;
 445         unsigned long status;
 446         struct brcmf_pub *pub;
 447         u32 channel;
 448         bool iscan_on;
 449         bool iscan_kickstart;
 450         bool active_scan;
 451         bool sched_escan;
 452         bool ibss_starter;
 453         bool link_up;
 454         bool pwr_save;
 455         bool dongle_up;
 456         bool roam_on;
 457         bool scan_tried;
 458         u8 *dcmd_buf;
 459         u8 *extra_buf;
 460         struct dentry *debugfsdir;
 461         bool escan_on;
 462         struct escan_info escan_info;
 463         struct timer_list escan_timeout;
 464         struct work_struct escan_timeout_work;
 465         u8 *escan_ioctl_buf;
 466         struct ap_info *ap_info;
 467 };
 468
 469 static inline struct wiphy *cfg_to_wiphy(struct brcmf_cfg80211_info *w)
 470 {
 471         return w->wdev->wiphy;
 472 }
 473
 474 static inline struct brcmf_cfg80211_info *wiphy_to_cfg(struct wiphy *w)
 475 {
 476         return (struct brcmf_cfg80211_info *)(wiphy_priv(w));
 477 }
 478
 479 static inline struct brcmf_cfg80211_info *wdev_to_cfg(struct wireless_dev *wd)
 480 {
 481         return (struct brcmf_cfg80211_info *)(wdev_priv(wd));
 482 }
 483
 484 static inline struct net_device *cfg_to_ndev(struct brcmf_cfg80211_info *cfg)
 485 {
 486         return cfg->wdev->netdev;
 487 }
 488
 489 static inline struct brcmf_cfg80211_info *ndev_to_cfg(struct net_device *ndev)
 490 {
 491         return wdev_to_cfg(ndev->ieee80211_ptr);
 492 }
 493
 494 #define iscan_to_cfg(i) ((struct brcmf_cfg80211_info *)(i->data))
 495 #define cfg_to_iscan(w) (w->iscan)
 496
 497 static inline struct
 498 brcmf_cfg80211_connect_info *cfg_to_conn(struct brcmf_cfg80211_info *cfg)
 499 {
 500         return &cfg->conn_info;
 501 }
 502
 503 struct brcmf_cfg80211_info *brcmf_cfg80211_attach(struct net_device *ndev,
 504                                                   struct device *busdev,
 505                                                   struct brcmf_pub *drvr);
 506 void brcmf_cfg80211_detach(struct brcmf_cfg80211_info *cfg);
 507
 508 /* event handler from dongle */
 509 void brcmf_cfg80211_event(struct net_device *ndev,
 510                           const struct brcmf_event_msg *e, void *data);
 511 s32 brcmf_cfg80211_up(struct brcmf_cfg80211_info *cfg);
 512 s32 brcmf_cfg80211_down(struct brcmf_cfg80211_info *cfg);
 513
 514 #endif                          /* _wl_cfg80211_h_ */