2 * Copyright (c) 1996, 2003 VIA Networking Technologies, Inc.
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.
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.
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.
21 * Purpose: MAC Data structure
32 #include <linux/module.h>
33 #include <linux/kernel.h>
34 #include <linux/slab.h>
35 #include <linux/init.h>
36 #include <linux/delay.h>
37 #include <linux/device.h>
38 #include <linux/firmware.h>
39 #include <linux/etherdevice.h>
40 #include <linux/suspend.h>
41 #include <linux/if_arp.h>
42 #include <linux/wireless.h>
43 #include <net/iw_handler.h>
44 #include <net/cfg80211.h>
45 #include <linux/timer.h>
46 #include <linux/usb.h>
49 #define DEVICE_ETHTOOL_IOCTL_SUPPORT
50 #include <linux/ethtool.h>
52 #undef DEVICE_ETHTOOL_IOCTL_SUPPORT
55 /* please copy below macro to driver_event.c for API */
56 #define RT_INSMOD_EVENT_FLAG 0x0101
57 #define RT_UPDEV_EVENT_FLAG 0x0102
58 #define RT_DISCONNECTED_EVENT_FLAG 0x0103
59 #define RT_WPACONNECTED_EVENT_FLAG 0x0104
60 #define RT_DOWNDEV_EVENT_FLAG 0x0105
61 #define RT_RMMOD_EVENT_FLAG 0x0106
67 #include "device_cfg.h"
79 #define VNT_USB_VENDOR_ID 0x160a
80 #define VNT_USB_PRODUCT_ID 0x3184
82 #define MAC_MAX_CONTEXT_REG (256+128)
84 #define MAX_MULTICAST_ADDRESS_NUM 32
85 #define MULTICAST_ADDRESS_LIST_SIZE (MAX_MULTICAST_ADDRESS_NUM * ETH_ALEN)
87 #define DUPLICATE_RX_CACHE_LENGTH 5
89 #define NUM_KEY_ENTRY 11
94 #define TX_WEP_SWOTP 3
95 #define TX_WEP_OTPSW 4
96 #define TX_WEP_SW232 5
98 #define KEYSEL_WEP40 0
99 #define KEYSEL_WEP104 1
100 #define KEYSEL_TKIP 2
101 #define KEYSEL_CCMP 3
103 #define AUTO_FB_NONE 0
113 #define ANT_DIVERSITY 2
114 #define ANT_RXD_TXA 3
115 #define ANT_RXD_TXB 4
116 #define ANT_UNKNOWN 0xFF
122 #define MAXCHECKHANGCNT 4
125 #define TX_PKT_UNI 0x00
126 #define TX_PKT_MULTI 0x01
127 #define TX_PKT_BROAD 0x02
129 #define BB_VGA_LEVEL 4
130 #define BB_VGA_CHANGE_THRESHOLD 3
133 #define RUN_AT(x) (jiffies+(x))
137 #define RESERV_AC0DMA 4
139 #define PRIVATE_Message 0
141 #define DBG_PRT(l, p, args...) { if (l <= msglevel) printk(p, ##args); }
142 #define PRINT_K(p, args...) { if (PRIVATE_Message) printk(p, ##args); }
144 typedef enum __device_msg_level {
145 MSG_LEVEL_ERR = 0, /* Errors causing abnormal operation */
146 MSG_LEVEL_NOTICE = 1, /* Errors needing user notification */
147 MSG_LEVEL_INFO = 2, /* Normal message. */
148 MSG_LEVEL_VERBOSE = 3, /* Will report all trival errors. */
149 MSG_LEVEL_DEBUG = 4 /* Only for debug purpose. */
150 } DEVICE_MSG_LEVEL, *PDEVICE_MSG_LEVEL;
152 typedef enum __device_init_type {
153 DEVICE_INIT_COLD = 0, /* cold init */
154 DEVICE_INIT_RESET, /* reset init or Dx to D0 power remain */
155 DEVICE_INIT_DXPL /* Dx to D0 power lost init */
156 } DEVICE_INIT_TYPE, *PDEVICE_INIT_TYPE;
161 * Enum of context types for SendPacket
163 typedef enum _CONTEXT_TYPE {
164 CONTEXT_DATA_PACKET = 1,
168 /* RCB (Receive Control Block) */
175 struct vnt_rx_mgmt sMngPacket;
181 /* used to track bulk out irps */
182 typedef struct _USB_SEND_CONTEXT {
184 struct sk_buff *pPacket;
186 unsigned int uBufLen;
188 struct ethhdr sEthHeader;
191 unsigned char Data[MAX_TOTAL_SIZE_WITH_ALL_HEADERS];
192 } USB_SEND_CONTEXT, *PUSB_SEND_CONTEXT;
194 /* structure got from configuration file as user-desired default settings */
195 typedef struct _DEFAULT_CONFIG {
197 signed int eConfigMode;
198 signed int eAuthenMode; /* open/wep/wpa */
199 signed int bShareKeyAlgorithm; /* open-open/{open,wep}-sharekey */
200 signed int keyidx; /* wepkey index */
201 signed int eEncryptionStatus;
202 } DEFAULT_CONFIG, *PDEFAULT_CONFIG;
205 * Structure to keep track of USB interrupt packets
208 unsigned int uDataLen;
210 /* struct urb *pUrb; */
212 } INT_BUFFER, *PINT_BUFFER;
214 /* 0:11A 1:11B 2:11G */
215 typedef enum _VIA_BB_TYPE
220 } VIA_BB_TYPE, *PVIA_BB_TYPE;
222 /* 0:11a, 1:11b, 2:11gb (only CCK in BasicRate), 3:11ga(OFDM in BasicRate) */
223 typedef enum _VIA_PKT_TYPE
229 } VIA_PKT_TYPE, *PVIA_PKT_TYPE;
233 typedef enum __DEVICE_NDIS_STATUS {
238 } DEVICE_NDIS_STATUS, *PDEVICE_NDIS_STATUS;
240 #define MAX_BSSIDINFO_4_PMKID 16
241 #define MAX_PMKIDLIST 5
242 /* flags for PMKID Candidate list structure */
243 #define NDIS_802_11_PMKID_CANDIDATE_PREAUTH_ENABLED 0x01
245 /* PMKID Structures */
246 typedef unsigned char NDIS_802_11_PMKID_VALUE[16];
248 typedef enum _NDIS_802_11_WEP_STATUS
250 Ndis802_11WEPEnabled,
251 Ndis802_11Encryption1Enabled = Ndis802_11WEPEnabled,
252 Ndis802_11WEPDisabled,
253 Ndis802_11EncryptionDisabled = Ndis802_11WEPDisabled,
254 Ndis802_11WEPKeyAbsent,
255 Ndis802_11Encryption1KeyAbsent = Ndis802_11WEPKeyAbsent,
256 Ndis802_11WEPNotSupported,
257 Ndis802_11EncryptionNotSupported = Ndis802_11WEPNotSupported,
258 Ndis802_11Encryption2Enabled,
259 Ndis802_11Encryption2KeyAbsent,
260 Ndis802_11Encryption3Enabled,
261 Ndis802_11Encryption3KeyAbsent
262 } NDIS_802_11_WEP_STATUS, *PNDIS_802_11_WEP_STATUS,
263 NDIS_802_11_ENCRYPTION_STATUS, *PNDIS_802_11_ENCRYPTION_STATUS;
265 typedef enum _NDIS_802_11_STATUS_TYPE
267 Ndis802_11StatusType_Authentication,
268 Ndis802_11StatusType_MediaStreamMode,
269 Ndis802_11StatusType_PMKID_CandidateList,
270 Ndis802_11StatusTypeMax, /* not a real type, defined as upper bound */
271 } NDIS_802_11_STATUS_TYPE, *PNDIS_802_11_STATUS_TYPE;
273 /* added new types for PMKID Candidate lists */
274 typedef struct _PMKID_CANDIDATE {
275 NDIS_802_11_MAC_ADDRESS BSSID;
277 } PMKID_CANDIDATE, *PPMKID_CANDIDATE;
279 typedef struct _BSSID_INFO
281 NDIS_802_11_MAC_ADDRESS BSSID;
282 NDIS_802_11_PMKID_VALUE PMKID;
283 } BSSID_INFO, *PBSSID_INFO;
285 typedef struct tagSPMKID {
286 unsigned long Length;
287 unsigned long BSSIDInfoCount;
288 BSSID_INFO BSSIDInfo[MAX_BSSIDINFO_4_PMKID];
291 typedef struct tagSPMKIDCandidateEvent {
292 NDIS_802_11_STATUS_TYPE StatusType;
293 unsigned long Version; /* Version of the structure */
294 unsigned long NumCandidates; /* No. of pmkid candidates */
295 PMKID_CANDIDATE CandidateList[MAX_PMKIDLIST];
296 } SPMKIDCandidateEvent, *PSPMKIDCandidateEvent;
298 /*++ 802.11h related */
299 #define MAX_QUIET_COUNT 8
301 typedef struct tagSQuietControl {
306 } SQuietControl, *PSQuietControl;
308 /* The receive duplicate detection cache entry */
309 typedef struct tagSCacheEntry{
311 u8 abyAddr2[ETH_ALEN];
313 } SCacheEntry, *PSCacheEntry;
315 typedef struct tagSCache{
316 /* The receive cache is updated circularly. The next entry to be written is
317 * indexed by the "InPtr".
319 unsigned int uInPtr; /* Place to use next */
320 SCacheEntry asCacheEntry[DUPLICATE_RX_CACHE_LENGTH];
323 #define CB_MAX_RX_FRAG 64
325 * DeFragment Control Block, used for collecting fragments prior to reassembly
327 typedef struct tagSDeFragControlBlock
331 u8 abyAddr2[ETH_ALEN];
332 unsigned int uLifetime;
335 unsigned int cbFrameLength;
337 } SDeFragControlBlock, *PSDeFragControlBlock;
339 /* flags for options */
340 #define DEVICE_FLAGS_UNPLUG 0x00000001UL
341 #define DEVICE_FLAGS_PREAMBLE_TYPE 0x00000002UL
342 #define DEVICE_FLAGS_OP_MODE 0x00000004UL
343 #define DEVICE_FLAGS_PS_MODE 0x00000008UL
344 #define DEVICE_FLAGS_80211h_MODE 0x00000010UL
346 /* flags for driver status */
347 #define DEVICE_FLAGS_OPENED 0x00010000UL
348 #define DEVICE_FLAGS_WOL_ENABLED 0x00080000UL
349 /* flags for capabilities */
350 #define DEVICE_FLAGS_TX_ALIGN 0x01000000UL
351 #define DEVICE_FLAGS_HAVE_CAM 0x02000000UL
352 #define DEVICE_FLAGS_FLOW_CTRL 0x04000000UL
354 /* flags for MII status */
355 #define DEVICE_LINK_FAIL 0x00000001UL
356 #define DEVICE_SPEED_10 0x00000002UL
357 #define DEVICE_SPEED_100 0x00000004UL
358 #define DEVICE_SPEED_1000 0x00000008UL
359 #define DEVICE_DUPLEX_FULL 0x00000010UL
360 #define DEVICE_AUTONEG_ENABLE 0x00000020UL
361 #define DEVICE_FORCED_BY_EEPROM 0x00000040UL
362 /* for device_set_media_duplex */
363 #define DEVICE_LINK_CHANGE 0x00000001UL
365 typedef struct __device_opt {
366 int nRxDescs0; /* number of RX descriptors 0 */
367 int nTxDescs0; /* number of TX descriptors 0, 1, 2, 3 */
368 int rts_thresh; /* RTS threshold */
377 } OPTIONS, *POPTIONS;
381 struct usb_device *usb;
382 struct net_device *dev;
383 struct net_device_stats stats;
387 struct tasklet_struct CmdWorkItem;
388 struct tasklet_struct EventWorkItem;
389 struct tasklet_struct ReadWorkItem;
390 struct tasklet_struct RxMngWorkItem;
407 SDeFragControlBlock sRxDFCB[CB_MAX_RX_FRAG];
413 struct urb *pControlURB;
414 struct urb *pInterruptURB;
415 struct usb_ctrlrequest sUsbCtlRequest;
418 /* Variables to track resources for the BULK In Pipe */
420 PRCB apRCB[CB_MAX_RX_DESC];
422 PRCB FirstRecvFreeList;
423 PRCB LastRecvFreeList;
425 PRCB FirstRecvMngList;
426 PRCB LastRecvMngList;
428 int bIsRxWorkItemQueued;
429 int bIsRxMngWorkItemQueued;
430 unsigned long ulRcvRefCount; /* packets that have not returned back */
432 /* Variables to track resources for the BULK Out Pipe */
433 PUSB_SEND_CONTEXT apTD[CB_MAX_TX_DESC];
436 /* Variables to track resources for the Interrupt In Pipe */
438 int fKillEventPollingThread;
441 /* default config from file by user setting */
442 DEFAULT_CONFIG config_file;
444 /* Statistic for USB */
445 unsigned long ulBulkInPosted;
446 unsigned long ulBulkInError;
447 unsigned long ulBulkInContCRCError;
448 unsigned long ulBulkInBytesRead;
450 unsigned long ulBulkOutPosted;
451 unsigned long ulBulkOutError;
452 unsigned long ulBulkOutContCRCError;
453 unsigned long ulBulkOutBytesWrite;
455 unsigned long ulIntInPosted;
456 unsigned long ulIntInError;
457 unsigned long ulIntInContCRCError;
458 unsigned long ulIntInBytesRead;
460 /* Version control */
461 u16 wFirmwareVersion;
469 u8 byOriginalZonetype;
471 int bLinkPass; /* link status: OK or fail */
472 u8 abyCurrentNetAddr[ETH_ALEN];
473 u8 abyPermanentNetAddr[ETH_ALEN];
477 /* Adapter statistics */
478 SStatCounter scStatistic;
480 SDot11Counters s802_11Counter;
482 /* Maintain statistical debug info. */
483 unsigned long packetsReceived;
484 unsigned long packetsReceivedDropped;
485 unsigned long packetsReceivedOverflow;
486 unsigned long packetsSent;
487 unsigned long packetsSentDropped;
488 unsigned long SendContextsInUse;
489 unsigned long RcvBuffersInUse;
491 /* 802.11 management */
492 struct vnt_manager vnt_mgmt;
498 /* 802.11 MAC specific */
502 /* Antenna Diversity */
512 /* SQ3 functions for antenna diversity */
513 struct timer_list TimerSQ3Tmax1;
514 struct timer_list TimerSQ3Tmax2;
515 struct timer_list TimerSQ3Tmax3;
517 int bDiversityRegCtlON;
518 int bDiversityEnable;
519 unsigned long ulDiversityNValue;
520 unsigned long ulDiversityMValue;
524 unsigned long ulSQ3TH;
526 unsigned long uDiversityCnt;
528 unsigned long ulRatio_State0;
529 unsigned long ulRatio_State1;
530 unsigned long ulSQ3_State0;
531 unsigned long ulSQ3_State1;
533 unsigned long aulSQ3Val[MAX_RATE];
534 unsigned long aulPktNum[MAX_RATE];
537 u32 uSIFS; /* Current SIFS */
538 u32 uDIFS; /* Current DIFS */
539 u32 uEIFS; /* Current EIFS */
540 u32 uSlot; /* Current SlotTime */
541 u32 uCwMin; /* Current CwMin */
542 u32 uCwMax; /* CwMax is fixed on 1023 */
552 VIA_BB_TYPE byBBType; /* 0: 11A, 1:11B, 2:11G */
553 VIA_PKT_TYPE byPacketType; /* 0:11a 1:11b 2:11gb 3:11ga */
556 u8 byTopOFDMBasicRate;
557 u8 byTopCCKBasicRate;
559 u32 dwAotoRateTxOkCnt;
560 u32 dwAotoRateTxFailCnt;
561 u32 dwErrorRateThreshold[13];
562 u32 dwTPTable[MAX_RATE];
563 u8 abyEEPROM[EEP_MAX_CONTEXT_SIZE]; /*u32 alignment */
574 /* For RF Power table */
580 u8 abyOFDMPwrTbl[14];
581 u8 abyOFDMAPwrTbl[42];
585 u16 wFragmentationThreshold;
586 u8 byShortRetryLimit;
588 CARD_OP_MODE eOPMode;
590 u16 wMaxTransmitMSDULifetime;
591 u8 abyBSSID[ETH_ALEN];
592 u8 abyDesireBSSID[ETH_ALEN];
594 u16 wCTSDuration; /* update while speed change */
597 u8 byRTSServiceField;
600 u32 dwMaxReceiveLifetime; /* dot11MaxReceiveLifetime */
603 int bEncryptionEnable;
605 int bSoftwareGenCrcErr;
609 int bBarkerPreambleMd;
612 u16 wUseProtectCntDown;
614 int bRadioControlOff;
621 WMAC_POWER_MODE ePSMode;
622 unsigned long ulPSModeWaitTx;
625 /* Beacon releated */
633 CMD_STATE eCommandState;
642 u32 uAutoReConnectTime;
647 CMD_ITEM eCmdQueue[CMD_Q_SIZE];
662 unsigned long ulTxPower;
665 NDIS_802_11_WEP_STATUS eEncryptionStatus;
667 NDIS_802_11_WEP_STATUS eOldEncryptionStatus;
672 u8 abyPRNG[WLAN_WEPMAX_KEYLEN+3];
678 u8 abyKey[WLAN_WEP232_KEYLEN];
692 /* For Update BaseBand VGA Gain Offset */
697 u8 abyBBVGA[BB_VGA_LEVEL];
698 signed long ldBmThreshold[BB_VGA_LEVEL];
709 /* For Auto Power Tunning */
712 /* BaseBand Loopback Use */
719 struct timer_list sTimerCommand;
721 struct timer_list sTimerTxData;
722 unsigned long nTxDataTimeCout;
726 int fWPA_Authened; /*is WPA/WPA-PSK or WPA2/WPA2-PSK authen?? */
730 struct ethhdr sTxEthHeader;
731 struct ethhdr sRxEthHeader;
732 u8 abyBroadcastAddr[ETH_ALEN];
733 u8 abySNAP_RFC1042[ETH_ALEN];
734 u8 abySNAP_Bridgetunnel[ETH_ALEN];
736 /* Pre-Authentication & PMK cache */
738 SPMKIDCandidateEvent gsPMKIDCandidate;
745 u8 byChannelSwitchCount;
747 /* WPA supplicant daemon */
753 int bWPASuppWextEnabled;
755 /* user space daemon: hostapd, is used for HOSTAP */
759 struct net_device *apdev;
760 int (*tx_80211)(struct sk_buff *skb, struct net_device *dev);
764 struct iw_statistics wstats; /* wireless stats */
770 #define EnqueueRCB(_Head, _Tail, _RCB) \
776 _Tail->Next = _RCB; \
782 #define DequeueRCB(Head, Tail) \
791 #define ADD_ONE_WITH_WRAP_AROUND(uVar, uModulo) { \
792 if ((uVar) >= ((uModulo) - 1)) \
798 #define fMP_RESET_IN_PROGRESS 0x00000001
799 #define fMP_DISCONNECTED 0x00000002
800 #define fMP_HALT_IN_PROGRESS 0x00000004
801 #define fMP_SURPRISE_REMOVED 0x00000008
802 #define fMP_RECV_LOOKASIDE 0x00000010
803 #define fMP_INIT_IN_PROGRESS 0x00000020
804 #define fMP_SEND_SIDE_RESOURCE_ALLOCATED 0x00000040
805 #define fMP_RECV_SIDE_RESOURCE_ALLOCATED 0x00000080
806 #define fMP_POST_READS 0x00000100
807 #define fMP_POST_WRITES 0x00000200
808 #define fMP_CONTROL_READS 0x00000400
809 #define fMP_CONTROL_WRITES 0x00000800
811 #define MP_SET_FLAG(_M, _F) ((_M)->Flags |= (_F))
812 #define MP_CLEAR_FLAG(_M, _F) ((_M)->Flags &= ~(_F))
813 #define MP_TEST_FLAGS(_M, _F) (((_M)->Flags & (_F)) == (_F))
815 #define MP_IS_READY(_M) (((_M)->Flags & \
816 (fMP_DISCONNECTED | fMP_RESET_IN_PROGRESS | fMP_HALT_IN_PROGRESS | fMP_INIT_IN_PROGRESS | fMP_SURPRISE_REMOVED)) == 0)
818 int device_alloc_frag_buf(struct vnt_private *, PSDeFragControlBlock pDeF);