drivers/staging/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 #include <linux/wireless.h>
  21 #include <typedefs.h>
  22 #include <proto/ethernet.h>
  23 #include <wlioctl.h>
  24 #include <linux/wireless.h>
  25 #include <net/cfg80211.h>
  26
  27 struct wl_conf;
  28 struct wl_iface;
  29 struct wl_priv;
  30 struct wl_security;
  31 struct wl_ibss;
  32
  33 #if defined(IL_BIGENDIAN)
  34 #include <bcmendian.h>
  35 #define htod32(i) (bcmswap32(i))
  36 #define htod16(i) (bcmswap16(i))
  37 #define dtoh32(i) (bcmswap32(i))
  38 #define dtoh16(i) (bcmswap16(i))
  39 #define htodchanspec(i) htod16(i)
  40 #define dtohchanspec(i) dtoh16(i)
  41 #else
  42 #define htod32(i) i
  43 #define htod16(i) i
  44 #define dtoh32(i) i
  45 #define dtoh16(i) i
  46 #define htodchanspec(i) i
  47 #define dtohchanspec(i) i
  48 #endif
  49
  50 #define WL_DBG_NONE     0
  51 #define WL_DBG_DBG      (1 << 2)
  52 #define WL_DBG_INFO     (1 << 1)
  53 #define WL_DBG_ERR      (1 << 0)
  54 #define WL_DBG_MASK ((WL_DBG_DBG | WL_DBG_INFO | WL_DBG_ERR) << 1)
  55
  56 #define WL_DBG_LEVEL 1          /* 0 invalidates all debug messages.
  57                                  default is 1 */
  58 #define WL_ERR(args)                                                                    \
  59 do {                                                                            \
  60         if (wl_dbg_level & WL_DBG_ERR) {                                \
  61                 if (net_ratelimit()) {                                          \
  62                         printk(KERN_ERR "ERROR @%s : ", __func__);      \
  63                         printk args;                                            \
  64                 }                                                               \
  65         }                                                                       \
  66 } while (0)
  67 #define WL_INFO(args)                                                                   \
  68 do {                                                                            \
  69         if (wl_dbg_level & WL_DBG_INFO) {                               \
  70                 if (net_ratelimit()) {                                          \
  71                         printk(KERN_ERR "INFO @%s : ", __func__);       \
  72                         printk args;                                            \
  73                 }                                                               \
  74         }                                                                       \
  75 } while (0)
  76 #if (WL_DBG_LEVEL > 0)
  77 #define WL_DBG(args)                                                            \
  78 do {                                                                    \
  79         if (wl_dbg_level & WL_DBG_DBG) {                        \
  80                 printk(KERN_ERR "DEBUG @%s :", __func__);       \
  81                 printk args;                                                    \
  82         }                                                                       \
  83 } while (0)
  84 #else                           /* !(WL_DBG_LEVEL > 0) */
  85 #define WL_DBG(args)
  86 #endif                          /* (WL_DBG_LEVEL > 0) */
  87
  88 #define WL_SCAN_RETRY_MAX       3       /* used for ibss scan */
  89 #define WL_NUM_SCAN_MAX         1
  90 #define WL_NUM_PMKIDS_MAX       MAXPMKID        /* will be used
  91                                                  * for 2.6.33 kernel
  92                                                  * or later
  93                                                  */
  94 #define WL_SCAN_BUF_MAX                 (1024 * 8)
  95 #define WL_TLV_INFO_MAX                 1024
  96 #define WL_BSS_INFO_MAX                 2048
  97 #define WL_ASSOC_INFO_MAX       512     /*
  98                                  * needs to grab assoc info from dongle to
  99                                  * report it to cfg80211 through "connect"
 100                                  * event
 101                                  */
 102 #define WL_IOCTL_LEN_MAX        1024
 103 #define WL_EXTRA_BUF_MAX        2048
 104 #define WL_ISCAN_BUF_MAX        2048    /*
 105                                  * the buf lengh can be WLC_IOCTL_MAXLEN (8K)
 106                                  * to reduce iteration
 107                                  */
 108 #define WL_ISCAN_TIMER_INTERVAL_MS      3000
 109 #define WL_SCAN_ERSULTS_LAST    (WL_SCAN_RESULTS_NO_MEM+1)
 110 #define WL_AP_MAX       256     /* virtually unlimitted as long
 111                                  * as kernel memory allows
 112                                  */
 113 #define WL_FILE_NAME_MAX                256
 114
 115 /* dongle status */
 116 enum wl_status {
 117         WL_STATUS_READY,
 118         WL_STATUS_SCANNING,
 119         WL_STATUS_SCAN_ABORTING,
 120         WL_STATUS_CONNECTING,
 121         WL_STATUS_CONNECTED
 122 };
 123
 124 /* wi-fi mode */
 125 enum wl_mode {
 126         WL_MODE_BSS,
 127         WL_MODE_IBSS,
 128         WL_MODE_AP
 129 };
 130
 131 /* dongle profile list */
 132 enum wl_prof_list {
 133         WL_PROF_MODE,
 134         WL_PROF_SSID,
 135         WL_PROF_SEC,
 136         WL_PROF_IBSS,
 137         WL_PROF_BAND,
 138         WL_PROF_BSSID,
 139         WL_PROF_ACT
 140 };
 141
 142 /* dongle iscan state */
 143 enum wl_iscan_state {
 144         WL_ISCAN_STATE_IDLE,
 145         WL_ISCAN_STATE_SCANING
 146 };
 147
 148 /* fw downloading status */
 149 enum wl_fw_status {
 150         WL_FW_LOADING_DONE,
 151         WL_NVRAM_LOADING_DONE
 152 };
 153
 154 /* dongle configuration */
 155 struct wl_conf {
 156         uint32 mode;            /* adhoc , infrastructure or ap */
 157         uint32 frag_threshold;
 158         uint32 rts_threshold;
 159         uint32 retry_short;
 160         uint32 retry_long;
 161         int32 tx_power;
 162         struct ieee80211_channel channel;
 163 };
 164
 165 /* cfg80211 main event loop */
 166 struct wl_event_loop {
 167         int32(*handler[WLC_E_LAST]) (struct wl_priv *wl,
 168                                      struct net_device *ndev,
 169                                      const wl_event_msg_t *e, void *data);
 170 };
 171
 172 /* representing interface of cfg80211 plane */
 173 struct wl_iface {
 174         struct wl_priv *wl;
 175 };
 176
 177 struct wl_dev {
 178         void *driver_data;      /* to store cfg80211 object information */
 179 };
 180
 181 /* bss inform structure for cfg80211 interface */
 182 struct wl_cfg80211_bss_info {
 183         uint16 band;
 184         uint16 channel;
 185         int16 rssi;
 186         uint16 frame_len;
 187         u8 frame_buf[1];
 188 };
 189
 190 /* basic structure of scan request */
 191 struct wl_scan_req {
 192         struct wlc_ssid ssid;
 193 };
 194
 195 /* basic structure of information element */
 196 struct wl_ie {
 197         uint16 offset;
 198         u8 buf[WL_TLV_INFO_MAX];
 199 };
 200
 201 /* event queue for cfg80211 main event */
 202 struct wl_event_q {
 203         struct list_head eq_list;
 204         uint32 etype;
 205         wl_event_msg_t emsg;
 206         s8 edata[1];
 207 };
 208
 209 /* security information with currently associated ap */
 210 struct wl_security {
 211         uint32 wpa_versions;
 212         uint32 auth_type;
 213         uint32 cipher_pairwise;
 214         uint32 cipher_group;
 215         uint32 wpa_auth;
 216 };
 217
 218 /* ibss information for currently joined ibss network */
 219 struct wl_ibss {
 220         u8 beacon_interval;     /* in millisecond */
 221         u8 atim;                /* in millisecond */
 222         s8 join_only;
 223         u8 band;
 224         u8 channel;
 225 };
 226
 227 /* dongle profile */
 228 struct wl_profile {
 229         uint32 mode;
 230         struct wlc_ssid ssid;
 231         u8 bssid[ETHER_ADDR_LEN];
 232         struct wl_security sec;
 233         struct wl_ibss ibss;
 234         int32 band;
 235         bool active;
 236 };
 237
 238 /* dongle iscan event loop */
 239 struct wl_iscan_eloop {
 240         int32(*handler[WL_SCAN_ERSULTS_LAST]) (struct wl_priv *wl);
 241 };
 242
 243 /* dongle iscan controller */
 244 struct wl_iscan_ctrl {
 245         struct net_device *dev;
 246         struct timer_list timer;
 247         uint32 timer_ms;
 248         uint32 timer_on;
 249         int32 state;
 250         int32 pid;
 251         struct semaphore sync;
 252         struct completion exited;
 253         struct wl_iscan_eloop el;
 254         void *data;
 255         s8 ioctl_buf[WLC_IOCTL_SMLEN];
 256         s8 scan_buf[WL_ISCAN_BUF_MAX];
 257 };
 258
 259 /* association inform */
 260 struct wl_connect_info {
 261         u8 *req_ie;
 262         int32 req_ie_len;
 263         u8 *resp_ie;
 264         int32 resp_ie_len;
 265 };
 266
 267 /* firmware /nvram downloading controller */
 268 struct wl_fw_ctrl {
 269         const struct firmware *fw_entry;
 270         unsigned long status;
 271         uint32 ptr;
 272         s8 fw_name[WL_FILE_NAME_MAX];
 273         s8 nvram_name[WL_FILE_NAME_MAX];
 274 };
 275
 276 /* assoc ie length */
 277 struct wl_assoc_ielen {
 278         uint32 req_len;
 279         uint32 resp_len;
 280 };
 281
 282 /* wpa2 pmk list */
 283 struct wl_pmk_list {
 284         pmkid_list_t pmkids;
 285         pmkid_t foo[MAXPMKID - 1];
 286 };
 287
 288 /* dongle private data of cfg80211 interface */
 289 struct wl_priv {
 290         struct wireless_dev *wdev;      /* representing wl cfg80211 device */
 291         struct wl_conf *conf;   /* dongle configuration */
 292         struct cfg80211_scan_request *scan_request;     /* scan request
 293                                                          object */
 294         struct wl_event_loop el;        /* main event loop */
 295         struct list_head eq_list;       /* used for event queue */
 296         spinlock_t eq_lock;     /* for event queue synchronization */
 297         struct mutex usr_sync;  /* maily for dongle up/down synchronization */
 298         struct wl_scan_results *bss_list;       /* bss_list holding scanned
 299                                                  ap information */
 300         struct wl_scan_results *scan_results;
 301         struct wl_scan_req *scan_req_int;       /* scan request object for
 302                                                  internal purpose */
 303         struct wl_cfg80211_bss_info *bss_info;  /* bss information for
 304                                                  cfg80211 layer */
 305         struct wl_ie ie;        /* information element object for
 306                                          internal purpose */
 307         struct ether_addr bssid;        /* bssid of currently engaged network */
 308         struct semaphore event_sync;    /* for synchronization of main event
 309                                          thread */
 310         struct completion event_exit;
 311         struct wl_profile *profile;     /* holding dongle profile */
 312         struct wl_iscan_ctrl *iscan;    /* iscan controller */
 313         struct wl_connect_info conn_info;       /* association information
 314                                                  container */
 315         struct wl_fw_ctrl *fw;  /* control firwmare / nvram paramter
 316                                  downloading */
 317         struct wl_pmk_list *pmk_list;   /* wpa2 pmk list */
 318         int32 event_pid;        /* pid of main event handler thread */
 319         unsigned long status;           /* current dongle status */
 320         void *pub;
 321         uint32 channel;         /* current channel */
 322         bool iscan_on;          /* iscan on/off switch */
 323         bool iscan_kickstart;   /* indicate iscan already started */
 324         bool active_scan;       /* current scan mode */
 325         bool ibss_starter;      /* indicates this sta is ibss starter */
 326         bool link_up;           /* link/connection up flag */
 327         bool pwr_save;          /* indicate whether dongle to support
 328                                          power save mode */
 329         bool dongle_up;         /* indicate whether dongle up or not */
 330         bool roam_on;           /* on/off switch for dongle self-roaming */
 331         bool scan_tried;        /* indicates if first scan attempted */
 332         u8 *ioctl_buf;  /* ioctl buffer */
 333         u8 *extra_buf;  /* maily to grab assoc information */
 334         u8 ci[0] __attribute__ ((__aligned__(NETDEV_ALIGN)));
 335 };
 336
 337 #define wl_to_dev(w) (wiphy_dev(wl->wdev->wiphy))
 338 #define wl_to_wiphy(w) (w->wdev->wiphy)
 339 #define wiphy_to_wl(w) ((struct wl_priv *)(wiphy_priv(w)))
 340 #define wl_to_wdev(w) (w->wdev)
 341 #define wdev_to_wl(w) ((struct wl_priv *)(wdev_priv(w)))
 342 #define wl_to_ndev(w) (w->wdev->netdev)
 343 #define ndev_to_wl(n) (wdev_to_wl(n->ieee80211_ptr))
 344 #define ci_to_wl(c) (ci->wl)
 345 #define wl_to_ci(w) (&w->ci)
 346 #define wl_to_sr(w) (w->scan_req_int)
 347 #define wl_to_ie(w) (&w->ie)
 348 #define iscan_to_wl(i) ((struct wl_priv *)(i->data))
 349 #define wl_to_iscan(w) (w->iscan)
 350 #define wl_to_conn(w) (&w->conn_info)
 351
 352 static inline struct wl_bss_info *next_bss(struct wl_scan_results *list,
 353                                            struct wl_bss_info *bss)
 354 {
 355         return bss = bss ?
 356                 (struct wl_bss_info *)((uintptr) bss +
 357                                        dtoh32(bss->length)) : list->bss_info;
 358 }
 359
 360 #define for_each_bss(list, bss, __i)    \
 361         for (__i = 0; __i < list->count && __i < WL_AP_MAX; __i++, bss = next_bss(list, bss))
 362
 363 extern int32 wl_cfg80211_attach(struct net_device *ndev, void *data);
 364 extern void wl_cfg80211_detach(void);
 365 /* event handler from dongle */
 366 extern void wl_cfg80211_event(struct net_device *ndev, const wl_event_msg_t *e,
 367                               void *data);
 368 extern void wl_cfg80211_sdio_func(void *func);  /* set sdio function info */
 369 extern int32 wl_cfg80211_up(void);      /* dongle up */
 370 extern int32 wl_cfg80211_down(void);    /* dongle down */
 371 extern void wl_cfg80211_dbg_level(uint32 level);        /* set dongle
 372                                                          debugging level */
 373 extern void *wl_cfg80211_request_fw(s8 *file_name);     /* request fw /nvram
 374                                                          downloading */
 375 extern int32 wl_cfg80211_read_fw(s8 *buf, uint32 size); /* read fw
 376                                                                  image */
 377 extern void wl_cfg80211_release_fw(void);       /* release fw */
 378 extern s8 *wl_cfg80211_get_fwname(void);        /* get firmware name for
 379                                                  the dongle */
 380 extern s8 *wl_cfg80211_get_nvramname(void);     /* get nvram name for
 381                                                  the dongle */
 382
 383 #endif                          /* _wl_cfg80211_h_ */