drivers/staging/rtl8712/rtl871x_mlme.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2007 - 2010 Realtek Corporation. All rights reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of version 2 of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
  17  *
  18  * Modifications for inclusion into the Linux staging tree are
  19  * Copyright(c) 2010 Larry Finger. All rights reserved.
  20  *
  21  * Contact information:
  22  * WLAN FAE <wlanfae@realtek.com>
  23  * Larry Finger <Larry.Finger@lwfinger.net>
  24  *
  25  ******************************************************************************/
  26 #ifndef __RTL871X_MLME_H_
  27 #define __RTL871X_MLME_H_
  28
  29 #include "osdep_service.h"
  30 #include "drv_types.h"
  31 #include "wlan_bssdef.h"
  32
  33 #define MAX_BSS_CNT     64
  34 #define   MAX_JOIN_TIMEOUT      6000
  35
  36 #define         SCANNING_TIMEOUT        4500
  37
  38 #define SCANQUEUE_LIFETIME 20 /* unit:sec */
  39
  40 #define         WIFI_NULL_STATE 0x00000000
  41 #define WIFI_ASOC_STATE         0x00000001      /* Under Linked state...*/
  42 #define         WIFI_REASOC_STATE 0x00000002
  43 #define WIFI_SLEEP_STATE        0x00000004
  44 #define WIFI_STATION_STATE      0x00000008
  45 #define WIFI_AP_STATE           0x00000010
  46 #define WIFI_ADHOC_STATE        0x00000020
  47 #define   WIFI_ADHOC_MASTER_STATE 0x00000040
  48 #define   WIFI_UNDER_LINKING    0x00000080
  49 #define WIFI_SITE_MONITOR       0x00000800      /* to indicate the station
  50                                                  * is under site surveying
  51                                                  */
  52 #define WIFI_MP_STATE           0x00010000
  53 #define WIFI_MP_CTX_BACKGROUND  0x00020000      /* in cont. tx background*/
  54 #define WIFI_MP_CTX_ST          0x00040000      /* in cont. tx with
  55                                                  * single-tone
  56                                                  */
  57 #define WIFI_MP_CTX_BACKGROUND_PENDING  0x00080000 /* pending in cont, tx
  58                                                     * background due to out of skb
  59                                                     */
  60 #define WIFI_MP_CTX_CCK_HW      0x00100000      /* in continuous tx*/
  61 #define WIFI_MP_CTX_CCK_CS      0x00200000      /* in cont, tx with carrier
  62                                                  * suppression
  63                                                  */
  64 #define   WIFI_MP_LPBK_STATE    0x00400000
  65
  66 #define _FW_UNDER_LINKING       WIFI_UNDER_LINKING
  67 #define _FW_LINKED              WIFI_ASOC_STATE
  68 #define _FW_UNDER_SURVEY        WIFI_SITE_MONITOR
  69
  70 /*
  71 there are several "locks" in mlme_priv,
  72 since mlme_priv is a shared resource between many threads,
  73 like ISR/Call-Back functions, the OID handlers, and even timer functions.
  74 Each _queue has its own locks, already.
  75 Other items are protected by mlme_priv.lock.
  76 To avoid possible dead lock, any thread trying to modify mlme_priv
  77 SHALL not lock up more than one lock at a time!
  78 */
  79
  80 #define traffic_threshold       10
  81 #define traffic_scan_period     500
  82
  83 struct sitesurvey_ctrl {
  84         u64     last_tx_pkts;
  85         uint    last_rx_pkts;
  86         sint    traffic_busy;
  87         struct timer_list sitesurvey_ctrl_timer;
  88 };
  89
  90 struct mlme_priv {
  91
  92         spinlock_t lock;
  93         spinlock_t lock2;
  94         sint    fw_state;       /*shall we protect this variable? */
  95         u8 to_join; /*flag*/
  96         u8 *nic_hdl;
  97         struct list_head *pscanned;
  98         struct  __queue free_bss_pool;
  99         struct  __queue scanned_queue;
 100         u8 *free_bss_buf;
 101         unsigned long num_of_scanned;
 102         u8 passive_mode; /*add for Android's SCAN-ACTIVE/SCAN-PASSIVE */
 103         struct ndis_802_11_ssid assoc_ssid;
 104         u8 assoc_bssid[6];
 105         struct wlan_network cur_network;
 106         struct sitesurvey_ctrl sitesurveyctrl;
 107         struct timer_list assoc_timer;
 108         uint assoc_by_bssid;
 109         uint assoc_by_rssi;
 110         struct timer_list scan_to_timer; /* driver handles scan_timeout.*/
 111         struct timer_list dhcp_timer; /* set dhcp to if driver in ps mode.*/
 112         struct qos_priv qospriv;
 113         struct ht_priv  htpriv;
 114         struct timer_list wdg_timer; /*watchdog periodic timer*/
 115 };
 116
 117 static inline u8 *get_bssid(struct mlme_priv *pmlmepriv)
 118 {
 119         return pmlmepriv->cur_network.network.MacAddress;
 120 }
 121
 122 static inline u8 check_fwstate(struct mlme_priv *pmlmepriv, sint state)
 123 {
 124         if (pmlmepriv->fw_state & state)
 125                 return true;
 126         return false;
 127 }
 128
 129 static inline sint get_fwstate(struct mlme_priv *pmlmepriv)
 130 {
 131         return pmlmepriv->fw_state;
 132 }
 133
 134 /*
 135  * No Limit on the calling context,
 136  * therefore set it to be the critical section...
 137  *
 138  * ### NOTE:#### (!!!!)
 139  * TAKE CARE BEFORE CALLING THIS FUNC, LOCK pmlmepriv->lock
 140  */
 141 static inline void set_fwstate(struct mlme_priv *pmlmepriv, sint state)
 142 {
 143         pmlmepriv->fw_state |= state;
 144 }
 145
 146 static inline void _clr_fwstate_(struct mlme_priv *pmlmepriv, sint state)
 147 {
 148         pmlmepriv->fw_state &= ~state;
 149 }
 150
 151 /*
 152  * No Limit on the calling context,
 153  * therefore set it to be the critical section...
 154  */
 155 static inline void clr_fwstate(struct mlme_priv *pmlmepriv, sint state)
 156 {
 157         unsigned long irqL;
 158
 159         spin_lock_irqsave(&pmlmepriv->lock, irqL);
 160         if (check_fwstate(pmlmepriv, state))
 161                 pmlmepriv->fw_state ^= state;
 162         spin_unlock_irqrestore(&pmlmepriv->lock, irqL);
 163 }
 164
 165 static inline void up_scanned_network(struct mlme_priv *pmlmepriv)
 166 {
 167         unsigned long irqL;
 168
 169         spin_lock_irqsave(&pmlmepriv->lock, irqL);
 170         pmlmepriv->num_of_scanned++;
 171         spin_unlock_irqrestore(&pmlmepriv->lock, irqL);
 172 }
 173
 174 static inline void down_scanned_network(struct mlme_priv *pmlmepriv)
 175 {
 176         unsigned long irqL;
 177
 178         spin_lock_irqsave(&pmlmepriv->lock, irqL);
 179         pmlmepriv->num_of_scanned--;
 180         spin_unlock_irqrestore(&pmlmepriv->lock, irqL);
 181 }
 182
 183 static inline void set_scanned_network_val(struct mlme_priv *pmlmepriv,
 184                                              sint val)
 185 {
 186         unsigned long irqL;
 187
 188         spin_lock_irqsave(&pmlmepriv->lock, irqL);
 189         pmlmepriv->num_of_scanned = val;
 190         spin_unlock_irqrestore(&pmlmepriv->lock, irqL);
 191 }
 192
 193 void r8712_survey_event_callback(struct _adapter *adapter, u8 *pbuf);
 194 void r8712_surveydone_event_callback(struct _adapter *adapter, u8 *pbuf);
 195 void r8712_joinbss_event_callback(struct _adapter *adapter, u8 *pbuf);
 196 void r8712_stassoc_event_callback(struct _adapter *adapter, u8 *pbuf);
 197 void r8712_stadel_event_callback(struct _adapter *adapter, u8 *pbuf);
 198 void r8712_atimdone_event_callback(struct _adapter *adapter, u8 *pbuf);
 199 void r8712_cpwm_event_callback(struct _adapter *adapter, u8 *pbuf);
 200 void r8712_wpspbc_event_callback(struct _adapter *adapter, u8 *pbuf);
 201 void r8712_free_network_queue(struct _adapter *adapter);
 202 int r8712_init_mlme_priv(struct _adapter *adapter);
 203 void r8712_free_mlme_priv(struct mlme_priv *pmlmepriv);
 204 sint r8712_select_and_join_from_scan(struct mlme_priv *pmlmepriv);
 205 sint r8712_set_key(struct _adapter *adapter,
 206                    struct security_priv *psecuritypriv, sint keyid);
 207 sint r8712_set_auth(struct _adapter *adapter,
 208                     struct security_priv *psecuritypriv);
 209 uint r8712_get_wlan_bssid_ex_sz(struct wlan_bssid_ex *bss);
 210 void r8712_generate_random_ibss(u8 *pibss);
 211 u8 *r8712_get_capability_from_ie(u8 *ie);
 212 struct wlan_network *r8712_get_oldest_wlan_network(
 213                                 struct  __queue *scanned_queue);
 214 void r8712_free_assoc_resources(struct _adapter *adapter);
 215 void r8712_ind_disconnect(struct _adapter *adapter);
 216 void r8712_indicate_connect(struct _adapter *adapter);
 217 int r8712_restruct_sec_ie(struct _adapter *adapter, u8 *in_ie,
 218                           u8 *out_ie, uint in_len);
 219 int r8712_restruct_wmm_ie(struct _adapter *adapter, u8 *in_ie,
 220                           u8 *out_ie, uint in_len, uint initial_out_len);
 221 void r8712_init_registrypriv_dev_network(struct _adapter *adapter);
 222 void r8712_update_registrypriv_dev_network(struct _adapter *adapter);
 223 void _r8712_sitesurvey_ctrl_handler(struct _adapter *adapter);
 224 void _r8712_join_timeout_handler(struct _adapter *adapter);
 225 void r8712_scan_timeout_handler(struct _adapter *adapter);
 226 void _r8712_dhcp_timeout_handler(struct _adapter *adapter);
 227 void _r8712_wdg_timeout_handler(struct _adapter *adapter);
 228 struct wlan_network *_r8712_alloc_network(struct mlme_priv *pmlmepriv);
 229 sint r8712_if_up(struct _adapter *padapter);
 230 void r8712_joinbss_reset(struct _adapter *padapter);
 231 unsigned int r8712_restructure_ht_ie(struct _adapter *padapter, u8 *in_ie,
 232                                      u8 *out_ie, uint in_len, uint *pout_len);
 233 void r8712_issue_addbareq_cmd(struct _adapter *padapter, int priority);
 234 int r8712_is_same_ibss(struct _adapter *adapter, struct wlan_network *pnetwork);
 235
 236 #endif /*__RTL871X_MLME_H_*/