]> Pileus Git - ~andy/linux/blob - drivers/staging/vt6656/wmgr.h
Staging: add Samsung Laptop driver
[~andy/linux] / drivers / staging / vt6656 / wmgr.h
1 /*
2  * Copyright (c) 1996, 2003 VIA Networking Technologies, Inc.
3  * All rights reserved.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  *
19  *
20  * File: wmgr.h
21  *
22  * Purpose:
23  *
24  * Author: lyndon chen
25  *
26  * Date: Jan 2, 2003
27  *
28  * Functions:
29  *
30  * Revision History:
31  *
32  */
33
34 #ifndef __WMGR_H__
35 #define __WMGR_H__
36
37 #include "ttype.h"
38 #include "80211mgr.h"
39 #include "80211hdr.h"
40 #include "wcmd.h"
41 #include "bssdb.h"
42 #include "wpa2.h"
43 #include "card.h"
44
45 /*---------------------  Export Definitions -------------------------*/
46
47
48
49 // Scan time
50 #define PROBE_DELAY                  100  // (us)
51 #define SWITCH_CHANNEL_DELAY         200 // (us)
52 #define WLAN_SCAN_MINITIME           25   // (ms)
53 #define WLAN_SCAN_MAXTIME            100  // (ms)
54 #define TRIVIAL_SYNC_DIFFERENCE      0    // (us)
55 #define DEFAULT_IBSS_BI              100  // (ms)
56
57 #define WCMD_ACTIVE_SCAN_TIME   20 //(ms)
58 #define WCMD_PASSIVE_SCAN_TIME  100 //(ms)
59
60
61 #define DEFAULT_MSDU_LIFETIME           512  // ms
62 #define DEFAULT_MSDU_LIFETIME_RES_64us  8000 // 64us
63
64 #define DEFAULT_MGN_LIFETIME            8    // ms
65 #define DEFAULT_MGN_LIFETIME_RES_64us   125  // 64us
66
67 #define MAKE_BEACON_RESERVED            10  //(us)
68
69
70 #define TIM_MULTICAST_MASK           0x01
71 #define TIM_BITMAPOFFSET_MASK        0xFE
72 #define DEFAULT_DTIM_PERIOD             1
73
74 #define AP_LONG_RETRY_LIMIT             4
75
76 #define DEFAULT_IBSS_CHANNEL            6  //2.4G
77
78
79 /*---------------------  Export Classes  ----------------------------*/
80
81 /*---------------------  Export Variables  --------------------------*/
82
83 /*---------------------  Export Types  ------------------------------*/
84 //mike define: make timer  to expire after desired times
85 #define timer_expire(timer,next_tick)   mod_timer(&timer, RUN_AT(next_tick))
86
87 typedef void (*TimerFunction)(ULONG);
88
89
90 //+++ NDIS related
91
92 typedef UCHAR   NDIS_802_11_MAC_ADDRESS[6];
93 typedef struct _NDIS_802_11_AI_REQFI
94 {
95     USHORT Capabilities;
96     USHORT ListenInterval;
97     NDIS_802_11_MAC_ADDRESS  CurrentAPAddress;
98 } NDIS_802_11_AI_REQFI, *PNDIS_802_11_AI_REQFI;
99
100 typedef struct _NDIS_802_11_AI_RESFI
101 {
102     USHORT Capabilities;
103     USHORT StatusCode;
104     USHORT AssociationId;
105 } NDIS_802_11_AI_RESFI, *PNDIS_802_11_AI_RESFI;
106
107 typedef struct _NDIS_802_11_ASSOCIATION_INFORMATION
108 {
109     ULONG                   Length;
110     USHORT                  AvailableRequestFixedIEs;
111     NDIS_802_11_AI_REQFI    RequestFixedIEs;
112     ULONG                   RequestIELength;
113     ULONG                   OffsetRequestIEs;
114     USHORT                  AvailableResponseFixedIEs;
115     NDIS_802_11_AI_RESFI    ResponseFixedIEs;
116     ULONG                   ResponseIELength;
117     ULONG                   OffsetResponseIEs;
118 } NDIS_802_11_ASSOCIATION_INFORMATION, *PNDIS_802_11_ASSOCIATION_INFORMATION;
119
120
121
122 typedef struct tagSAssocInfo {
123     NDIS_802_11_ASSOCIATION_INFORMATION     AssocInfo;
124     BYTE                                    abyIEs[WLAN_BEACON_FR_MAXLEN+WLAN_BEACON_FR_MAXLEN];
125     // store ReqIEs set by OID_802_11_ASSOCIATION_INFORMATION
126     ULONG                                   RequestIELength;
127     BYTE                                    abyReqIEs[WLAN_BEACON_FR_MAXLEN];
128 } SAssocInfo, *PSAssocInfo;
129 //---
130
131
132
133 typedef enum tagWMAC_AUTHENTICATION_MODE {
134
135     WMAC_AUTH_OPEN,
136     WMAC_AUTH_SHAREKEY,
137     WMAC_AUTH_AUTO,
138     WMAC_AUTH_WPA,
139     WMAC_AUTH_WPAPSK,
140     WMAC_AUTH_WPANONE,
141     WMAC_AUTH_WPA2,
142     WMAC_AUTH_WPA2PSK,
143     WMAC_AUTH_MAX       // Not a real mode, defined as upper bound
144 } WMAC_AUTHENTICATION_MODE, *PWMAC_AUTHENTICATION_MODE;
145
146
147
148 // Pre-configured Mode (from XP)
149
150 typedef enum tagWMAC_CONFIG_MODE {
151     WMAC_CONFIG_ESS_STA,
152     WMAC_CONFIG_IBSS_STA,
153     WMAC_CONFIG_AUTO,
154     WMAC_CONFIG_AP
155
156 } WMAC_CONFIG_MODE, *PWMAC_CONFIG_MODE;
157
158
159 typedef enum tagWMAC_SCAN_TYPE {
160
161     WMAC_SCAN_ACTIVE,
162     WMAC_SCAN_PASSIVE,
163     WMAC_SCAN_HYBRID
164
165 } WMAC_SCAN_TYPE, *PWMAC_SCAN_TYPE;
166
167
168 typedef enum tagWMAC_SCAN_STATE {
169
170     WMAC_NO_SCANNING,
171     WMAC_IS_SCANNING,
172     WMAC_IS_PROBEPENDING
173
174 } WMAC_SCAN_STATE, *PWMAC_SCAN_STATE;
175
176
177
178 // Notes:
179 // Basic Service Set state explained as following:
180 // WMAC_STATE_IDLE          : no BSS is selected (Adhoc or Infra)
181 // WMAC_STATE_STARTED       : no BSS is selected, start own IBSS (Adhoc only)
182 // WMAC_STATE_JOINTED       : BSS is selected and synchronized (Adhoc or Infra)
183 // WMAC_STATE_AUTHPENDING   : Authentication pending (Infra)
184 // WMAC_STATE_AUTH          : Authenticated (Infra)
185 // WMAC_STATE_ASSOCPENDING  : Association pending (Infra)
186 // WMAC_STATE_ASSOC         : Associated (Infra)
187
188 typedef enum tagWMAC_BSS_STATE {
189
190     WMAC_STATE_IDLE,
191     WMAC_STATE_STARTED,
192     WMAC_STATE_JOINTED,
193     WMAC_STATE_AUTHPENDING,
194     WMAC_STATE_AUTH,
195     WMAC_STATE_ASSOCPENDING,
196     WMAC_STATE_ASSOC
197
198 } WMAC_BSS_STATE, *PWMAC_BSS_STATE;
199
200 // WMAC selected running mode
201 typedef enum tagWMAC_CURRENT_MODE {
202
203     WMAC_MODE_STANDBY,
204     WMAC_MODE_ESS_STA,
205     WMAC_MODE_IBSS_STA,
206     WMAC_MODE_ESS_AP
207
208 } WMAC_CURRENT_MODE, *PWMAC_CURRENT_MODE;
209
210
211 typedef enum tagWMAC_POWER_MODE {
212
213     WMAC_POWER_CAM,
214     WMAC_POWER_FAST,
215     WMAC_POWER_MAX
216
217 } WMAC_POWER_MODE, *PWMAC_POWER_MODE;
218
219
220
221 // Tx Managment Packet descriptor
222 typedef struct tagSTxMgmtPacket {
223
224     PUWLAN_80211HDR     p80211Header;
225     UINT                cbMPDULen;
226     UINT                cbPayloadLen;
227
228 } STxMgmtPacket, *PSTxMgmtPacket;
229
230
231 // Rx Managment Packet descriptor
232 typedef struct tagSRxMgmtPacket {
233
234     PUWLAN_80211HDR     p80211Header;
235     QWORD               qwLocalTSF;
236     UINT                cbMPDULen;
237     UINT                cbPayloadLen;
238     UINT                uRSSI;
239     BYTE                bySQ;
240     BYTE                byRxRate;
241     BYTE                byRxChannel;
242
243 } SRxMgmtPacket, *PSRxMgmtPacket;
244
245
246
247 typedef struct tagSMgmtObject
248 {
249
250     PVOID                   pAdapter;
251     // MAC address
252     BYTE                    abyMACAddr[WLAN_ADDR_LEN];
253
254     // Configuration Mode
255     WMAC_CONFIG_MODE        eConfigMode; // MAC pre-configed mode
256
257     CARD_PHY_TYPE           eCurrentPHYMode;
258
259
260     // Operation state variables
261     WMAC_CURRENT_MODE       eCurrMode;   // MAC current connection mode
262     WMAC_BSS_STATE          eCurrState;  // MAC current BSS state
263     #ifdef SndEvt_ToAPI
264     WMAC_BSS_STATE          eLastState;  // MAC last BSS state
265     #endif
266
267     PKnownBSS               pCurrBSS;
268     BYTE                    byCSSGK;
269     BYTE                    byCSSPK;
270
271 //    BYTE                    abyNewSuppRates[WLAN_IEHDR_LEN + WLAN_RATES_MAXLEN];
272 //    BYTE                    abyNewExtSuppRates[WLAN_IEHDR_LEN + WLAN_RATES_MAXLEN];
273     BOOL                    bCurrBSSIDFilterOn;
274
275     // Current state vars
276     UINT                    uCurrChannel;
277     BYTE                    abyCurrSuppRates[WLAN_IEHDR_LEN + WLAN_RATES_MAXLEN + 1];
278     BYTE                    abyCurrExtSuppRates[WLAN_IEHDR_LEN + WLAN_RATES_MAXLEN + 1];
279     BYTE                    abyCurrSSID[WLAN_IEHDR_LEN + WLAN_SSID_MAXLEN + 1];
280     BYTE                    abyCurrBSSID[WLAN_BSSID_LEN];
281     WORD                    wCurrCapInfo;
282     WORD                    wCurrAID;
283     UINT                    uRSSITrigger;
284     WORD                    wCurrATIMWindow;
285     WORD                    wCurrBeaconPeriod;
286     BOOL                    bIsDS;
287     BYTE                    byERPContext;
288
289     CMD_STATE               eCommandState;
290     UINT                    uScanChannel;
291
292     // Desire joinning BSS vars
293     BYTE                    abyDesireSSID[WLAN_IEHDR_LEN + WLAN_SSID_MAXLEN + 1];
294     BYTE                    abyDesireBSSID[WLAN_BSSID_LEN];
295
296 //restore BSS info for Ad-Hoc mode
297 //20080131-05,<Add> by Mike Liu
298 #ifdef Adhoc_STA
299      BYTE                    abyAdHocSSID[WLAN_IEHDR_LEN + WLAN_SSID_MAXLEN + 1];
300 #endif
301
302     // Adhoc or AP configuration vars
303     WORD                    wIBSSBeaconPeriod;
304     WORD                    wIBSSATIMWindow;
305     UINT                    uIBSSChannel;
306     BYTE                    abyIBSSSuppRates[WLAN_IEHDR_LEN + WLAN_RATES_MAXLEN + 1];
307     BYTE                    byAPBBType;
308     BYTE                    abyWPAIE[MAX_WPA_IE_LEN];
309     WORD                    wWPAIELen;
310
311     UINT                    uAssocCount;
312     BOOL                    bMoreData;
313
314     // Scan state vars
315     WMAC_SCAN_STATE         eScanState;
316     WMAC_SCAN_TYPE          eScanType;
317     UINT                    uScanStartCh;
318     UINT                    uScanEndCh;
319     WORD                    wScanSteps;
320     UINT                    uScanBSSType;
321     // Desire scannig vars
322     BYTE                    abyScanSSID[WLAN_IEHDR_LEN + WLAN_SSID_MAXLEN + 1];
323     BYTE                    abyScanBSSID[WLAN_BSSID_LEN];
324
325     // Privacy
326     WMAC_AUTHENTICATION_MODE eAuthenMode;
327     BOOL                    bShareKeyAlgorithm;
328     BYTE                    abyChallenge[WLAN_CHALLENGE_LEN];
329     BOOL                    bPrivacyInvoked;
330
331     // Received beacon state vars
332     BOOL                    bInTIM;
333     BOOL                    bMulticastTIM;
334     BYTE                    byDTIMCount;
335     BYTE                    byDTIMPeriod;
336
337     // Power saving state vars
338     WMAC_POWER_MODE         ePSMode;
339     WORD                    wListenInterval;
340     WORD                    wCountToWakeUp;
341     BOOL                    bInTIMWake;
342     PBYTE                   pbyPSPacketPool;
343     BYTE                    byPSPacketPool[sizeof(STxMgmtPacket) + WLAN_NULLDATA_FR_MAXLEN];
344     BOOL                    bRxBeaconInTBTTWake;
345     BYTE                    abyPSTxMap[MAX_NODE_NUM + 1];
346
347     // managment command related
348     UINT                    uCmdBusy;
349     UINT                    uCmdHostAPBusy;
350
351     // managment packet pool
352     PBYTE                   pbyMgmtPacketPool;
353     BYTE                    byMgmtPacketPool[sizeof(STxMgmtPacket) + WLAN_A3FR_MAXLEN];
354
355
356     // One second callback timer
357         struct timer_list           sTimerSecondCallback;
358
359     // Temporarily Rx Mgmt Packet Descriptor
360     SRxMgmtPacket           sRxPacket;
361
362     // link list of known bss's (scan results)
363     KnownBSS                sBSSList[MAX_BSS_NUM];
364    //link list of same bss's  //DavidWang
365     KnownBSS                            pSameBSS[6] ;
366     BOOL          Cisco_cckm ;
367     BYTE          Roam_dbm;
368
369     // table list of known node
370     // sNodeDBList[0] is reserved for AP under Infra mode
371     // sNodeDBList[0] is reserved for Multicast under adhoc/AP mode
372     KnownNodeDB             sNodeDBTable[MAX_NODE_NUM + 1];
373
374
375
376     // WPA2 PMKID Cache
377     SPMKIDCache             gsPMKIDCache;
378     BOOL                    bRoaming;
379
380     // rate fall back vars
381
382
383
384     // associate info
385     SAssocInfo              sAssocInfo;
386
387
388     // for 802.11h
389     BOOL                    b11hEnable;
390     BOOL                    bSwitchChannel;
391     BYTE                    byNewChannel;
392     PWLAN_IE_MEASURE_REP    pCurrMeasureEIDRep;
393     UINT                    uLengthOfRepEIDs;
394     BYTE                    abyCurrentMSRReq[sizeof(STxMgmtPacket) + WLAN_A3FR_MAXLEN];
395     BYTE                    abyCurrentMSRRep[sizeof(STxMgmtPacket) + WLAN_A3FR_MAXLEN];
396     BYTE                    abyIECountry[WLAN_A3FR_MAXLEN];
397     BYTE                    abyIBSSDFSOwner[6];
398     BYTE                    byIBSSDFSRecovery;
399
400     struct sk_buff  skb;
401
402 } SMgmtObject, *PSMgmtObject;
403
404
405 /*---------------------  Export Macros ------------------------------*/
406
407
408 /*---------------------  Export Functions  --------------------------*/
409
410
411 void
412 vMgrObjectInit(
413     IN  HANDLE hDeviceContext
414     );
415
416
417 void
418 vMgrAssocBeginSta(
419     IN  HANDLE hDeviceContext,
420     IN  PSMgmtObject pMgmt,
421     OUT PCMD_STATUS pStatus
422     );
423
424 VOID
425 vMgrReAssocBeginSta(
426     IN  HANDLE hDeviceContext,
427     IN  PSMgmtObject pMgmt,
428     OUT PCMD_STATUS pStatus
429     );
430
431 VOID
432 vMgrDisassocBeginSta(
433     IN  HANDLE hDeviceContext,
434     IN  PSMgmtObject pMgmt,
435     IN  PBYTE  abyDestAddress,
436     IN  WORD    wReason,
437     OUT PCMD_STATUS pStatus
438     );
439
440 VOID
441 vMgrAuthenBeginSta(
442     IN  HANDLE hDeviceContext,
443     IN  PSMgmtObject pMgmt,
444     OUT PCMD_STATUS pStatus
445     );
446
447 VOID
448 vMgrCreateOwnIBSS(
449     IN  HANDLE hDeviceContext,
450     OUT PCMD_STATUS pStatus
451     );
452
453 VOID
454 vMgrJoinBSSBegin(
455     IN  HANDLE hDeviceContext,
456     OUT PCMD_STATUS pStatus
457     );
458
459 VOID
460 vMgrRxManagePacket(
461     IN  HANDLE hDeviceContext,
462     IN  PSMgmtObject pMgmt,
463     IN  PSRxMgmtPacket pRxPacket
464     );
465
466 /*
467 VOID
468 vMgrScanBegin(
469     IN  HANDLE hDeviceContext,
470     OUT PCMD_STATUS pStatus
471     );
472 */
473
474 VOID
475 vMgrDeAuthenBeginSta(
476     IN  HANDLE hDeviceContext,
477     IN  PSMgmtObject  pMgmt,
478     IN  PBYTE   abyDestAddress,
479     IN  WORD    wReason,
480     OUT PCMD_STATUS pStatus
481     );
482
483 BOOL
484 bMgrPrepareBeaconToSend(
485     IN  HANDLE hDeviceContext,
486     IN  PSMgmtObject pMgmt
487     );
488
489
490 BOOL
491 bAdd_PMKID_Candidate (
492     IN HANDLE    hDeviceContext,
493     IN PBYTE          pbyBSSID,
494     IN PSRSNCapObject psRSNCapObj
495     );
496
497 VOID
498 vFlush_PMKID_Candidate (
499     IN HANDLE hDeviceContext
500     );
501
502 #endif // __WMGR_H__