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
34 #include <linux/modversions.h>
35 #endif /* MODVERSIONS */
36 #include <linux/module.h>
39 #include <linux/types.h>
40 #include <linux/init.h>
42 #include <linux/errno.h>
43 #include <linux/ioport.h>
44 #include <linux/pci.h>
45 #include <linux/kernel.h>
46 #include <linux/netdevice.h>
47 #include <linux/etherdevice.h>
48 #include <linux/skbuff.h>
49 #include <linux/delay.h>
50 #include <linux/timer.h>
51 #include <linux/slab.h>
52 #include <linux/interrupt.h>
53 #include <linux/version.h>
54 #include <linux/string.h>
55 #include <linux/wait.h>
56 #include <linux/if_arp.h>
57 #include <linux/sched.h>
59 #include <linux/rtnetlink.h>//James
60 #include <linux/proc_fs.h>
61 #include <linux/inetdevice.h>
62 #include <linux/reboot.h>
63 #include <linux/usb.h>
64 #include <linux/signal.h>
66 #include <asm/uaccess.h>
68 #define DEVICE_ETHTOOL_IOCTL_SUPPORT
69 #include <linux/ethtool.h>
71 #undef DEVICE_ETHTOOL_IOCTL_SUPPORT
73 /* Include Wireless Extension definition and check version - Jean II */
74 #include <linux/wireless.h>
76 #include <net/iw_handler.h> // New driver API
77 #endif /* WIRELESS_EXT > 12 */
79 //2008-0409-07, <Add> by Einsn Liu
81 #ifndef WPA_SUPPLICANT_DRIVER_WEXT_SUPPORT
82 #define WPA_SUPPLICANT_DRIVER_WEXT_SUPPORT
86 //2007-0920-01<Add>by MikeLiu
89 //please copy below macro to driver_event.c for API
90 #define RT_INSMOD_EVENT_FLAG 0x0101
91 #define RT_UPDEV_EVENT_FLAG 0x0102
92 #define RT_DISCONNECTED_EVENT_FLAG 0x0103
93 #define RT_WPACONNECTED_EVENT_FLAG 0x0104
94 #define RT_DOWNDEV_EVENT_FLAG 0x0105
95 #define RT_RMMOD_EVENT_FLAG 0x0106
102 #if !defined(_KCOMPAT_H)
106 #if !defined(__DEVICE_CONFIG_H)
107 #include "device_cfg.h"
110 #if !defined(__TTYPE_H__)
113 #if !defined(__80211HDR_H__)
114 #include "80211hdr.h"
116 #if !defined(__TETHER_H__)
119 #if !defined(__WMGR_H__)
122 #if !defined(__WCMD_H__)
125 #if !defined(__MIB_H__)
128 #if !defined(__SROM_H__)
131 #if !defined(__RC4_H__)
134 #if !defined(__TPCI_H__)
137 #if !defined(__DESC_H__)
140 #if !defined(__KEY_H__)
143 #if !defined(__CARD_H__)
147 /*--------------------- Export Definitions -------------------------*/
148 #define VNT_USB_VENDOR_ID 0x160A
149 #define VNT_USB_PRODUCT_ID 0x3184
151 #define MAC_MAX_CONTEXT_REG (256+128)
153 #define MAX_MULTICAST_ADDRESS_NUM 32
154 #define MULTICAST_ADDRESS_LIST_SIZE (MAX_MULTICAST_ADDRESS_NUM * U_ETHER_ADDR_LEN)
157 //#define OP_MODE_INFRASTRUCTURE 0
158 //#define OP_MODE_ADHOC 1
159 //#define OP_MODE_AP 2
161 #define DUPLICATE_RX_CACHE_LENGTH 5
163 #define NUM_KEY_ENTRY 11
165 #define TX_WEP_NONE 0
168 #define TX_WEP_SWOTP 3
169 #define TX_WEP_OTPSW 4
170 #define TX_WEP_SW232 5
172 #define KEYSEL_WEP40 0
173 #define KEYSEL_WEP104 1
174 #define KEYSEL_TKIP 2
175 #define KEYSEL_CCMP 3
179 #define AUTO_FB_NONE 0
189 #define ANT_DIVERSITY 2
190 #define ANT_RXD_TXA 3
191 #define ANT_RXD_TXB 4
192 #define ANT_UNKNOWN 0xFF
199 #define MAXCHECKHANGCNT 4
202 #define TX_PKT_UNI 0x00
203 #define TX_PKT_MULTI 0x01
204 #define TX_PKT_BROAD 0x02
206 #define BB_VGA_LEVEL 4
207 #define BB_VGA_CHANGE_THRESHOLD 3
212 #define RUN_AT(x) (jiffies+(x))
216 #define RESERV_AC0DMA 4
218 #define PRIVATE_Message 0
220 /*--------------------- Export Types ------------------------------*/
222 #define DBG_PRT(l, p, args...) {if (l<=msglevel) printk( p ,##args);}
223 #define PRINT_K(p, args...) {if (PRIVATE_Message) printk( p ,##args);}
225 typedef enum __device_msg_level {
226 MSG_LEVEL_ERR=0, //Errors that will cause abnormal operation.
227 MSG_LEVEL_NOTICE=1, //Some errors need users to be notified.
228 MSG_LEVEL_INFO=2, //Normal message.
229 MSG_LEVEL_VERBOSE=3, //Will report all trival errors.
230 MSG_LEVEL_DEBUG=4 //Only for debug purpose.
231 } DEVICE_MSG_LEVEL, *PDEVICE_MSG_LEVEL;
233 typedef enum __device_init_type {
234 DEVICE_INIT_COLD=0, // cold init
235 DEVICE_INIT_RESET, // reset init or Dx to D0 power remain init
236 DEVICE_INIT_DXPL // Dx to D0 power lost init
237 } DEVICE_INIT_TYPE, *PDEVICE_INIT_TYPE;
243 // Enum of context types for SendPacket
245 typedef enum _CONTEXT_TYPE {
246 CONTEXT_DATA_PACKET = 1,
253 // RCB (Receive Control Block)
260 SRxMgmtPacket sMngPacket;
267 // used to track bulk out irps
268 typedef struct _USB_SEND_CONTEXT {
270 struct sk_buff *pPacket;
274 SEthernetHeader sEthHeader;
277 UCHAR Data[MAX_TOTAL_SIZE_WITH_ALL_HEADERS];
278 } USB_SEND_CONTEXT, *PUSB_SEND_CONTEXT;
281 //structure got from configuration file as user desired default setting.
282 typedef struct _DEFAULT_CONFIG{
285 INT eAuthenMode; //open/wep/wpa
286 INT bShareKeyAlgorithm; //open-open/open-sharekey/wep-sharekey
287 INT keyidx; //wepkey index
288 INT eEncryptionStatus;
290 }DEFAULT_CONFIG,*PDEFAULT_CONFIG;
293 // Structure to keep track of usb interrupt packets
300 } INT_BUFFER, *PINT_BUFFER;
305 typedef enum _VIA_BB_TYPE
310 } VIA_BB_TYPE, *PVIA_BB_TYPE;
312 //0:11a,1:11b,2:11gb(only CCK in BasicRate),3:11ga(OFDM in Basic Rate)
313 typedef enum _VIA_PKT_TYPE
319 } VIA_PKT_TYPE, *PVIA_PKT_TYPE;
326 #define NDIS_STATUS int
329 typedef enum __DEVICE_NDIS_STATUS {
334 } DEVICE_NDIS_STATUS, *PDEVICE_NDIS_STATUS;
337 #define MAX_BSSIDINFO_4_PMKID 16
338 #define MAX_PMKIDLIST 5
339 //Flags for PMKID Candidate list structure
340 #define NDIS_802_11_PMKID_CANDIDATE_PREAUTH_ENABLED 0x01
343 typedef UCHAR NDIS_802_11_PMKID_VALUE[16];
346 typedef enum _NDIS_802_11_WEP_STATUS
348 Ndis802_11WEPEnabled,
349 Ndis802_11Encryption1Enabled = Ndis802_11WEPEnabled,
350 Ndis802_11WEPDisabled,
351 Ndis802_11EncryptionDisabled = Ndis802_11WEPDisabled,
352 Ndis802_11WEPKeyAbsent,
353 Ndis802_11Encryption1KeyAbsent = Ndis802_11WEPKeyAbsent,
354 Ndis802_11WEPNotSupported,
355 Ndis802_11EncryptionNotSupported = Ndis802_11WEPNotSupported,
356 Ndis802_11Encryption2Enabled,
357 Ndis802_11Encryption2KeyAbsent,
358 Ndis802_11Encryption3Enabled,
359 Ndis802_11Encryption3KeyAbsent
360 } NDIS_802_11_WEP_STATUS, *PNDIS_802_11_WEP_STATUS,
361 NDIS_802_11_ENCRYPTION_STATUS, *PNDIS_802_11_ENCRYPTION_STATUS;
364 typedef enum _NDIS_802_11_STATUS_TYPE
366 Ndis802_11StatusType_Authentication,
367 Ndis802_11StatusType_MediaStreamMode,
368 Ndis802_11StatusType_PMKID_CandidateList,
369 Ndis802_11StatusTypeMax // not a real type, defined as an upper bound
370 } NDIS_802_11_STATUS_TYPE, *PNDIS_802_11_STATUS_TYPE;
372 //Added new types for PMKID Candidate lists.
373 typedef struct _PMKID_CANDIDATE {
374 NDIS_802_11_MAC_ADDRESS BSSID;
376 } PMKID_CANDIDATE, *PPMKID_CANDIDATE;
379 typedef struct _BSSID_INFO
381 NDIS_802_11_MAC_ADDRESS BSSID;
382 NDIS_802_11_PMKID_VALUE PMKID;
383 } BSSID_INFO, *PBSSID_INFO;
385 typedef struct tagSPMKID {
387 ULONG BSSIDInfoCount;
388 BSSID_INFO BSSIDInfo[MAX_BSSIDINFO_4_PMKID];
391 typedef struct tagSPMKIDCandidateEvent {
392 NDIS_802_11_STATUS_TYPE StatusType;
393 ULONG Version; // Version of the structure
394 ULONG NumCandidates; // No. of pmkid candidates
395 PMKID_CANDIDATE CandidateList[MAX_PMKIDLIST];
396 } SPMKIDCandidateEvent, DEF* PSPMKIDCandidateEvent;
401 #define MAX_QUIET_COUNT 8
403 typedef struct tagSQuietControl {
408 } SQuietControl, DEF* PSQuietControl;
413 // The receive duplicate detection cache entry
414 typedef struct tagSCacheEntry{
416 BYTE abyAddr2[U_ETHER_ADDR_LEN];
418 } SCacheEntry, *PSCacheEntry;
420 typedef struct tagSCache{
421 /* The receive cache is updated circularly. The next entry to be written is
422 * indexed by the "InPtr".
424 UINT uInPtr; // Place to use next
425 SCacheEntry asCacheEntry[DUPLICATE_RX_CACHE_LENGTH];
428 #define CB_MAX_RX_FRAG 64
429 // DeFragment Control Block, used for collecting fragments prior to reassembly
430 typedef struct tagSDeFragControlBlock
434 BYTE abyAddr2[U_ETHER_ADDR_LEN];
440 } SDeFragControlBlock, DEF* PSDeFragControlBlock;
445 #define DEVICE_FLAGS_UNPLUG 0x00000001UL
446 #define DEVICE_FLAGS_PREAMBLE_TYPE 0x00000002UL
447 #define DEVICE_FLAGS_OP_MODE 0x00000004UL
448 #define DEVICE_FLAGS_PS_MODE 0x00000008UL
449 #define DEVICE_FLAGS_80211h_MODE 0x00000010UL
451 //flags for driver status
452 #define DEVICE_FLAGS_OPENED 0x00010000UL
453 #define DEVICE_FLAGS_WOL_ENABLED 0x00080000UL
454 //flags for capbilities
455 #define DEVICE_FLAGS_TX_ALIGN 0x01000000UL
456 #define DEVICE_FLAGS_HAVE_CAM 0x02000000UL
457 #define DEVICE_FLAGS_FLOW_CTRL 0x04000000UL
459 //flags for MII status
460 #define DEVICE_LINK_FAIL 0x00000001UL
461 #define DEVICE_SPEED_10 0x00000002UL
462 #define DEVICE_SPEED_100 0x00000004UL
463 #define DEVICE_SPEED_1000 0x00000008UL
464 #define DEVICE_DUPLEX_FULL 0x00000010UL
465 #define DEVICE_AUTONEG_ENABLE 0x00000020UL
466 #define DEVICE_FORCED_BY_EEPROM 0x00000040UL
467 //for device_set_media_duplex
468 #define DEVICE_LINK_CHANGE 0x00000001UL
471 typedef struct __device_opt {
472 int nRxDescs0; //Number of RX descriptors0
473 int nTxDescs0; //Number of TX descriptors 0, 1, 2, 3
474 int rts_thresh; //rts threshold
483 } OPTIONS, *POPTIONS;
486 typedef struct __device_info {
489 struct usb_device* usb;
490 struct net_device* dev;
491 struct net_device_stats stats;
495 struct tasklet_struct CmdWorkItem;
496 struct tasklet_struct EventWorkItem;
497 struct tasklet_struct ReadWorkItem;
498 struct tasklet_struct RxMngWorkItem;
515 SDeFragControlBlock sRxDFCB[CB_MAX_RX_FRAG];
518 UINT uCurrentDFCBIdx;
522 struct urb *pControlURB;
523 struct urb *pInterruptURB;
524 struct usb_ctrlrequest sUsbCtlRequest;
528 // Variables to track resources for the BULK In Pipe
531 PRCB apRCB[CB_MAX_RX_DESC];
533 PRCB FirstRecvFreeList;
534 PRCB LastRecvFreeList;
535 UINT NumRecvFreeList;
536 PRCB FirstRecvMngList;
537 PRCB LastRecvMngList;
539 BOOL bIsRxWorkItemQueued;
540 BOOL bIsRxMngWorkItemQueued;
541 ULONG ulRcvRefCount; // number of packets that have not been returned back
544 // Variables to track resources for the BULK Out Pipe
547 PUSB_SEND_CONTEXT apTD[CB_MAX_TX_DESC];
551 // Variables to track resources for the Interript In Pipe
554 BOOL fKillEventPollingThread;
555 BOOL bEventAvailable;
558 //default config from file by user setting
559 DEFAULT_CONFIG config_file;
564 // protect with spinlock
565 ULONG ulBulkInPosted;
567 ULONG ulBulkInContCRCError;
568 ULONG ulBulkInBytesRead;
570 ULONG ulBulkOutPosted;
571 ULONG ulBulkOutError;
572 ULONG ulBulkOutContCRCError;
573 ULONG ulBulkOutBytesWrite;
577 ULONG ulIntInContCRCError;
578 ULONG ulIntInBytesRead;
582 WORD wFirmwareVersion;
591 BYTE byOriginalZonetype;
593 BOOL bLinkPass; // link status: OK or fail
594 BYTE abyCurrentNetAddr[U_ETHER_ADDR_LEN];
595 BYTE abyPermanentNetAddr[U_ETHER_ADDR_LEN];
596 // SW network address
597 // BYTE abySoftwareNetAddr[U_ETHER_ADDR_LEN];
598 BOOL bExistSWNetAddr;
600 // Adapter statistics
601 SStatCounter scStatistic;
603 SDot11Counters s802_11Counter;
606 // Maintain statistical debug info.
608 ULONG packetsReceived;
609 ULONG packetsReceivedDropped;
610 ULONG packetsReceivedOverflow;
612 ULONG packetsSentDropped;
613 ULONG SendContextsInUse;
614 ULONG RcvBuffersInUse;
618 SMgmtObject sMgmtObj;
624 // 802.11 MAC specific
631 DWORD dwRxAntennaSel;
632 DWORD dwTxAntennaSel;
634 BYTE byRxAntennaMode;
635 BYTE byTxAntennaMode;
639 //SQ3 functions for antenna diversity
640 struct timer_list TimerSQ3Tmax1;
641 struct timer_list TimerSQ3Tmax2;
642 struct timer_list TimerSQ3Tmax3;
644 BOOL bDiversityRegCtlON;
645 BOOL bDiversityEnable;
646 ULONG ulDiversityNValue;
647 ULONG ulDiversityMValue;
655 ULONG ulRatio_State0;
656 ULONG ulRatio_State1;
660 ULONG aulSQ3Val[MAX_RATE];
661 ULONG aulPktNum[MAX_RATE];
664 UINT uSIFS; //Current SIFS
665 UINT uDIFS; //Current DIFS
666 UINT uEIFS; //Current EIFS
667 UINT uSlot; //Current SlotTime
668 UINT uCwMin; //Current CwMin
669 UINT uCwMax; //CwMax is fixed on 1023.
678 VIA_BB_TYPE byBBType; //0: 11A, 1:11B, 2:11G
679 VIA_PKT_TYPE byPacketType; //0:11a,1:11b,2:11gb(only CCK in BasicRate),3:11ga(OFDM in Basic Rate)
682 BYTE byTopOFDMBasicRate;
683 BYTE byTopCCKBasicRate;
686 DWORD dwAotoRateTxOkCnt;
687 DWORD dwAotoRateTxFailCnt;
688 DWORD dwErrorRateThreshold[13];
689 DWORD dwTPTable[MAX_RATE];
690 BYTE abyEEPROM[EEP_MAX_CONTEXT_SIZE]; //DWORD alignment
694 UINT uConnectionRate;
697 BYTE byShortPreamble;
701 // For RF Power table
706 BYTE abyCCKPwrTbl[14];
707 BYTE abyOFDMPwrTbl[14];
708 BYTE abyOFDMAPwrTbl[42];
712 WORD wFragmentationThreshold;
713 BYTE byShortRetryLimit;
714 BYTE byLongRetryLimit;
715 CARD_OP_MODE eOPMode;
717 WORD wMaxTransmitMSDULifetime;
718 BYTE abyBSSID[U_ETHER_ADDR_LEN];
719 BYTE abyDesireBSSID[U_ETHER_ADDR_LEN];
720 WORD wCTSDuration; // update while speed change
721 WORD wACKDuration; // update while speed change
722 WORD wRTSTransmitLen; // update while speed change
723 BYTE byRTSServiceField; // update while speed change
724 BYTE byRTSSignalField; // update while speed change
726 DWORD dwMaxReceiveLifetime; // dot11MaxReceiveLifetime
729 BOOL bEncryptionEnable;
731 BOOL bSoftwareGenCrcErr;
735 BOOL bBarkerPreambleMd;
738 WORD wUseProtectCntDown;
740 BOOL bRadioControlOff;
745 WORD wListenInterval;
747 WMAC_POWER_MODE ePSMode;
748 ULONG ulPSModeWaitTx;
753 BOOL bBeaconBufReady;
759 CMD_STATE eCommandState;
768 UINT uAutoReConnectTime;
773 CMD_ITEM eCmdQueue[CMD_Q_SIZE];
781 BOOL bEnableRoaming; //DavidWang
782 BOOL bIsRoaming; //DavidWang
783 BOOL bFastRoaming; //DavidWang
784 BYTE bSameBSSMaxNum; //Davidwang
785 BYTE bSameBSSCurNum; //DavidWang
791 NDIS_802_11_WEP_STATUS eEncryptionStatus;
794 //2007-0925-01<Add>by MikeLiu
795 //mike add :save old Encryption
796 NDIS_802_11_WEP_STATUS eOldEncryptionStatus;
803 BYTE abyPRNG[WLAN_WEPMAX_KEYLEN+3];
810 BYTE abyKey[WLAN_WEP232_KEYLEN];
826 // For Update BaseBand VGA Gain Offset
828 UINT uBBVGADiffCount;
831 BYTE abyBBVGA[BB_VGA_LEVEL];
832 LONG ldBmThreshold[BB_VGA_LEVEL];
839 DWORD dwDiagRefCount;
844 // For Auto Power Tunning
846 BYTE byAutoPwrTunning;
848 // BaseBand Loopback Use
855 struct timer_list sTimerCommand;
857 //2007-0115-01<Add>by MikeLiu
859 struct timer_list sTimerTxData;
860 ULONG nTxDataTimeCout;
862 BOOL IsTxDataTrigger;
865 #ifdef WPA_SM_Transtatus
866 BOOL fWPA_Authened; //is WPA/WPA-PSK or WPA2/WPA2-PSK authen??
868 BYTE byReAssocCount; //mike add:re-association retry times!
869 BYTE byLinkWaitCount;
871 SEthernetHeader sTxEthHeader;
872 SEthernetHeader sRxEthHeader;
873 BYTE abyBroadcastAddr[U_ETHER_ADDR_LEN];
874 BYTE abySNAP_RFC1042[U_ETHER_ADDR_LEN];
875 BYTE abySNAP_Bridgetunnel[U_ETHER_ADDR_LEN];
877 // Pre-Authentication & PMK cache
879 SPMKIDCandidateEvent gsPMKIDCandidate;
887 BYTE byChannelSwitchCount;
889 //WPA supplicant daemon
890 struct net_device *wpadev;
895 #ifdef WPA_SUPPLICANT_DRIVER_WEXT_SUPPORT
900 BOOL bWPASuppWextEnabled;
904 // user space daemon: hostapd, is used for HOSTAP
908 struct net_device *apdev;
909 int (*tx_80211)(struct sk_buff *skb, struct net_device *dev);
914 struct iw_statistics wstats; // wireless stats
915 #endif /* WIRELESS_EXT */
918 } DEVICE_INFO, *PSDevice;
923 #define EnqueueRCB(_Head, _Tail, _RCB) \
929 _Tail->Next = _RCB; \
935 #define DequeueRCB(Head, Tail) \
945 #define ADD_ONE_WITH_WRAP_AROUND(uVar, uModulo) { \
946 if ((uVar) >= ((uModulo) - 1)) \
953 #define fMP_RESET_IN_PROGRESS 0x00000001
954 #define fMP_DISCONNECTED 0x00000002
955 #define fMP_HALT_IN_PROGRESS 0x00000004
956 #define fMP_SURPRISE_REMOVED 0x00000008
957 #define fMP_RECV_LOOKASIDE 0x00000010
958 #define fMP_INIT_IN_PROGRESS 0x00000020
959 #define fMP_SEND_SIDE_RESOURCE_ALLOCATED 0x00000040
960 #define fMP_RECV_SIDE_RESOURCE_ALLOCATED 0x00000080
961 #define fMP_POST_READS 0x00000100
962 #define fMP_POST_WRITES 0x00000200
963 #define fMP_CONTROL_READS 0x00000400
964 #define fMP_CONTROL_WRITES 0x00000800
968 #define MP_SET_FLAG(_M, _F) ((_M)->Flags |= (_F))
969 #define MP_CLEAR_FLAG(_M, _F) ((_M)->Flags &= ~(_F))
970 #define MP_TEST_FLAG(_M, _F) (((_M)->Flags & (_F)) != 0)
971 #define MP_TEST_FLAGS(_M, _F) (((_M)->Flags & (_F)) == (_F))
973 #define MP_IS_READY(_M) (((_M)->Flags & \
974 (fMP_DISCONNECTED | fMP_RESET_IN_PROGRESS | fMP_HALT_IN_PROGRESS | fMP_INIT_IN_PROGRESS | fMP_SURPRISE_REMOVED)) == 0)
976 /*--------------------- Export Functions --------------------------*/
978 //BOOL device_dma0_xmit(PSDevice pDevice, struct sk_buff *skb, UINT uNodeIndex);
979 BOOL device_alloc_frag_buf(PSDevice pDevice, PSDeFragControlBlock pDeF);