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
59 * to out of skb
60 */
61 #define WIFI_MP_CTX_CCK_HW 0x00100000 /* in continuous tx*/
62 #define WIFI_MP_CTX_CCK_CS 0x00200000 /* in cont, tx with carrier
63 * suppression
64 */
65 #define WIFI_MP_LPBK_STATE 0x00400000
66
67 #define _FW_UNDER_LINKING WIFI_UNDER_LINKING
68 #define _FW_LINKED WIFI_ASOC_STATE
69 #define _FW_UNDER_SURVEY WIFI_SITE_MONITOR
70
71 /*
72 * there are several "locks" in mlme_priv,
73 * since mlme_priv is a shared resource between many threads,
74 * like ISR/Call-Back functions, the OID handlers, and even timer functions.
75 * Each _queue has its own locks, already.
76 * Other items are protected by mlme_priv.lock.
77 * To avoid possible dead lock, any thread trying to modify mlme_priv
78 * SHALL not lock up more than one lock at a time!
79 */
80
81 #define traffic_threshold 10
82 #define traffic_scan_period 500
83
84 struct sitesurvey_ctrl {
85 u64 last_tx_pkts;
86 uint last_rx_pkts;
87 sint traffic_busy;
88 struct timer_list sitesurvey_ctrl_timer;
89 };
90
91 struct mlme_priv {
92
93 spinlock_t lock;
94 spinlock_t lock2;
95 sint fw_state; /*shall we protect this variable? */
96 u8 to_join; /*flag*/
97 u8 *nic_hdl;
98 struct list_head *pscanned;
99 struct __queue free_bss_pool;
100 struct __queue scanned_queue;
101 u8 *free_bss_buf;
102 unsigned long num_of_scanned;
103 u8 passive_mode; /*add for Android's SCAN-ACTIVE/SCAN-PASSIVE */
104 struct ndis_802_11_ssid assoc_ssid;
105 u8 assoc_bssid[6];
106 struct wlan_network cur_network;
107 struct sitesurvey_ctrl sitesurveyctrl;
108 struct timer_list assoc_timer;
109 uint assoc_by_bssid;
110 uint assoc_by_rssi;
111 struct timer_list scan_to_timer; /* driver handles scan_timeout.*/
112 struct timer_list dhcp_timer; /* set dhcp to if driver in ps mode.*/
113 struct qos_priv qospriv;
114 struct ht_priv htpriv;
115 struct timer_list wdg_timer; /*watchdog periodic timer*/
116 };
117
get_bssid(struct mlme_priv * pmlmepriv)118 static inline u8 *get_bssid(struct mlme_priv *pmlmepriv)
119 {
120 return pmlmepriv->cur_network.network.MacAddress;
121 }
122
check_fwstate(struct mlme_priv * pmlmepriv,sint state)123 static inline u8 check_fwstate(struct mlme_priv *pmlmepriv, sint state)
124 {
125 if (pmlmepriv->fw_state & state)
126 return true;
127 return false;
128 }
129
get_fwstate(struct mlme_priv * pmlmepriv)130 static inline sint get_fwstate(struct mlme_priv *pmlmepriv)
131 {
132 return pmlmepriv->fw_state;
133 }
134
135 /*
136 * No Limit on the calling context,
137 * therefore set it to be the critical section...
138 *
139 * ### NOTE:#### (!!!!)
140 * TAKE CARE BEFORE CALLING THIS FUNC, LOCK pmlmepriv->lock
141 */
set_fwstate(struct mlme_priv * pmlmepriv,sint state)142 static inline void set_fwstate(struct mlme_priv *pmlmepriv, sint state)
143 {
144 pmlmepriv->fw_state |= state;
145 }
146
_clr_fwstate_(struct mlme_priv * pmlmepriv,sint state)147 static inline void _clr_fwstate_(struct mlme_priv *pmlmepriv, sint state)
148 {
149 pmlmepriv->fw_state &= ~state;
150 }
151
152 /*
153 * No Limit on the calling context,
154 * therefore set it to be the critical section...
155 */
clr_fwstate(struct mlme_priv * pmlmepriv,sint state)156 static inline void clr_fwstate(struct mlme_priv *pmlmepriv, sint state)
157 {
158 unsigned long irqL;
159
160 spin_lock_irqsave(&pmlmepriv->lock, irqL);
161 if (check_fwstate(pmlmepriv, state))
162 pmlmepriv->fw_state ^= state;
163 spin_unlock_irqrestore(&pmlmepriv->lock, irqL);
164 }
165
set_scanned_network_val(struct mlme_priv * pmlmepriv,sint val)166 static inline void set_scanned_network_val(struct mlme_priv *pmlmepriv,
167 sint val)
168 {
169 unsigned long irqL;
170
171 spin_lock_irqsave(&pmlmepriv->lock, irqL);
172 pmlmepriv->num_of_scanned = val;
173 spin_unlock_irqrestore(&pmlmepriv->lock, irqL);
174 }
175
176 void r8712_survey_event_callback(struct _adapter *adapter, u8 *pbuf);
177 void r8712_surveydone_event_callback(struct _adapter *adapter, u8 *pbuf);
178 void r8712_joinbss_event_callback(struct _adapter *adapter, u8 *pbuf);
179 void r8712_stassoc_event_callback(struct _adapter *adapter, u8 *pbuf);
180 void r8712_stadel_event_callback(struct _adapter *adapter, u8 *pbuf);
181 void r8712_atimdone_event_callback(struct _adapter *adapter, u8 *pbuf);
182 void r8712_cpwm_event_callback(struct _adapter *adapter, u8 *pbuf);
183 void r8712_wpspbc_event_callback(struct _adapter *adapter, u8 *pbuf);
184 void r8712_free_network_queue(struct _adapter *adapter);
185 int r8712_init_mlme_priv(struct _adapter *adapter);
186 void r8712_free_mlme_priv(struct mlme_priv *pmlmepriv);
187 sint r8712_select_and_join_from_scan(struct mlme_priv *pmlmepriv);
188 sint r8712_set_key(struct _adapter *adapter,
189 struct security_priv *psecuritypriv, sint keyid);
190 sint r8712_set_auth(struct _adapter *adapter,
191 struct security_priv *psecuritypriv);
192 uint r8712_get_wlan_bssid_ex_sz(struct wlan_bssid_ex *bss);
193 void r8712_generate_random_ibss(u8 *pibss);
194 u8 *r8712_get_capability_from_ie(u8 *ie);
195 struct wlan_network *r8712_get_oldest_wlan_network(
196 struct __queue *scanned_queue);
197 void r8712_free_assoc_resources(struct _adapter *adapter);
198 void r8712_ind_disconnect(struct _adapter *adapter);
199 void r8712_indicate_connect(struct _adapter *adapter);
200 int r8712_restruct_sec_ie(struct _adapter *adapter, u8 *in_ie,
201 u8 *out_ie, uint in_len);
202 int r8712_restruct_wmm_ie(struct _adapter *adapter, u8 *in_ie,
203 u8 *out_ie, uint in_len, uint initial_out_len);
204 void r8712_init_registrypriv_dev_network(struct _adapter *adapter);
205 void r8712_update_registrypriv_dev_network(struct _adapter *adapter);
206 void _r8712_sitesurvey_ctrl_handler(struct _adapter *adapter);
207 void _r8712_join_timeout_handler(struct _adapter *adapter);
208 void r8712_scan_timeout_handler(struct _adapter *adapter);
209 void _r8712_dhcp_timeout_handler(struct _adapter *adapter);
210 void _r8712_wdg_timeout_handler(struct _adapter *adapter);
211 struct wlan_network *_r8712_alloc_network(struct mlme_priv *pmlmepriv);
212 sint r8712_if_up(struct _adapter *padapter);
213 void r8712_joinbss_reset(struct _adapter *padapter);
214 unsigned int r8712_restructure_ht_ie(struct _adapter *padapter, u8 *in_ie,
215 u8 *out_ie, uint in_len, uint *pout_len);
216 void r8712_issue_addbareq_cmd(struct _adapter *padapter, int priority);
217 int r8712_is_same_ibss(struct _adapter *adapter, struct wlan_network *pnetwork);
218
219 #endif /*__RTL871X_MLME_H_*/
220
