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/types.h>
34 #include <linux/init.h>
36 #include <linux/errno.h>
37 #include <linux/ioport.h>
38 #include <linux/pci.h>
39 #include <linux/kernel.h>
40 #include <linux/netdevice.h>
41 #include <linux/etherdevice.h>
42 #include <linux/skbuff.h>
43 #include <linux/delay.h>
44 #include <linux/timer.h>
45 #include <linux/slab.h>
46 #include <linux/interrupt.h>
47 #include <linux/string.h>
48 #include <linux/wait.h>
49 #include <linux/if_arp.h>
50 #include <linux/sched.h>
52 #include <linux/rtnetlink.h>//James
53 #include <linux/proc_fs.h>
54 #include <linux/inetdevice.h>
55 #include <linux/reboot.h>
56 #include <linux/usb.h>
57 #include <linux/signal.h>
59 #include <asm/uaccess.h>
61 #define DEVICE_ETHTOOL_IOCTL_SUPPORT
62 #include <linux/ethtool.h>
64 #undef DEVICE_ETHTOOL_IOCTL_SUPPORT
66 /* Include Wireless Extension definition and check version - Jean II */
67 #include <linux/wireless.h>
68 #include <net/iw_handler.h> // New driver API
70 #ifndef WPA_SUPPLICANT_DRIVER_WEXT_SUPPORT
71 #define WPA_SUPPLICANT_DRIVER_WEXT_SUPPORT
74 //please copy below macro to driver_event.c for API
75 #define RT_INSMOD_EVENT_FLAG 0x0101
76 #define RT_UPDEV_EVENT_FLAG 0x0102
77 #define RT_DISCONNECTED_EVENT_FLAG 0x0103
78 #define RT_WPACONNECTED_EVENT_FLAG 0x0104
79 #define RT_DOWNDEV_EVENT_FLAG 0x0105
80 #define RT_RMMOD_EVENT_FLAG 0x0106
86 #include "device_cfg.h"
99 /*--------------------- Export Definitions -------------------------*/
100 #define VNT_USB_VENDOR_ID 0x160a
101 #define VNT_USB_PRODUCT_ID 0x3184
103 #define MAC_MAX_CONTEXT_REG (256+128)
105 #define MAX_MULTICAST_ADDRESS_NUM 32
106 #define MULTICAST_ADDRESS_LIST_SIZE (MAX_MULTICAST_ADDRESS_NUM * ETH_ALEN)
108 //#define OP_MODE_INFRASTRUCTURE 0
109 //#define OP_MODE_ADHOC 1
110 //#define OP_MODE_AP 2
112 #define DUPLICATE_RX_CACHE_LENGTH 5
114 #define NUM_KEY_ENTRY 11
116 #define TX_WEP_NONE 0
119 #define TX_WEP_SWOTP 3
120 #define TX_WEP_OTPSW 4
121 #define TX_WEP_SW232 5
123 #define KEYSEL_WEP40 0
124 #define KEYSEL_WEP104 1
125 #define KEYSEL_TKIP 2
126 #define KEYSEL_CCMP 3
128 #define AUTO_FB_NONE 0
138 #define ANT_DIVERSITY 2
139 #define ANT_RXD_TXA 3
140 #define ANT_RXD_TXB 4
141 #define ANT_UNKNOWN 0xFF
148 #define MAXCHECKHANGCNT 4
151 #define TX_PKT_UNI 0x00
152 #define TX_PKT_MULTI 0x01
153 #define TX_PKT_BROAD 0x02
155 #define BB_VGA_LEVEL 4
156 #define BB_VGA_CHANGE_THRESHOLD 3
159 #define RUN_AT(x) (jiffies+(x))
163 #define RESERV_AC0DMA 4
165 #define PRIVATE_Message 0
167 /*--------------------- Export Types ------------------------------*/
169 #define DBG_PRT(l, p, args...) { if (l <= msglevel) printk(p, ##args); }
170 #define PRINT_K(p, args...) { if (PRIVATE_Message) printk(p, ##args); }
172 typedef enum __device_msg_level {
173 MSG_LEVEL_ERR = 0, /* Errors causing abnormal operation */
174 MSG_LEVEL_NOTICE = 1, /* Errors needing user notification */
175 MSG_LEVEL_INFO = 2, /* Normal message. */
176 MSG_LEVEL_VERBOSE = 3, /* Will report all trival errors. */
177 MSG_LEVEL_DEBUG = 4 /* Only for debug purpose. */
178 } DEVICE_MSG_LEVEL, *PDEVICE_MSG_LEVEL;
180 typedef enum __device_init_type {
181 DEVICE_INIT_COLD = 0, /* cold init */
182 DEVICE_INIT_RESET, /* reset init or Dx to D0 power remain */
183 DEVICE_INIT_DXPL /* Dx to D0 power lost init */
184 } DEVICE_INIT_TYPE, *PDEVICE_INIT_TYPE;
189 // Enum of context types for SendPacket
191 typedef enum _CONTEXT_TYPE {
192 CONTEXT_DATA_PACKET = 1,
196 // RCB (Receive Control Block)
203 SRxMgmtPacket sMngPacket;
209 // used to track bulk out irps
210 typedef struct _USB_SEND_CONTEXT {
212 struct sk_buff *pPacket;
214 unsigned int uBufLen;
216 SEthernetHeader sEthHeader;
219 unsigned char Data[MAX_TOTAL_SIZE_WITH_ALL_HEADERS];
220 } USB_SEND_CONTEXT, *PUSB_SEND_CONTEXT;
222 /* structure got from configuration file as user-desired default settings */
223 typedef struct _DEFAULT_CONFIG {
225 signed int eConfigMode;
226 signed int eAuthenMode; /* open/wep/wpa */
227 signed int bShareKeyAlgorithm; /* open-open/{open,wep}-sharekey */
228 signed int keyidx; /* wepkey index */
229 signed int eEncryptionStatus;
230 } DEFAULT_CONFIG, *PDEFAULT_CONFIG;
233 // Structure to keep track of usb interrupt packets
236 unsigned int uDataLen;
240 } INT_BUFFER, *PINT_BUFFER;
243 typedef enum _VIA_BB_TYPE
248 } VIA_BB_TYPE, *PVIA_BB_TYPE;
250 //0:11a,1:11b,2:11gb(only CCK in BasicRate),3:11ga(OFDM in Basic Rate)
251 typedef enum _VIA_PKT_TYPE
257 } VIA_PKT_TYPE, *PVIA_PKT_TYPE;
261 #define NDIS_STATUS int
264 typedef enum __DEVICE_NDIS_STATUS {
269 } DEVICE_NDIS_STATUS, *PDEVICE_NDIS_STATUS;
272 #define MAX_BSSIDINFO_4_PMKID 16
273 #define MAX_PMKIDLIST 5
274 //Flags for PMKID Candidate list structure
275 #define NDIS_802_11_PMKID_CANDIDATE_PREAUTH_ENABLED 0x01
278 typedef unsigned char NDIS_802_11_PMKID_VALUE[16];
281 typedef enum _NDIS_802_11_WEP_STATUS
283 Ndis802_11WEPEnabled,
284 Ndis802_11Encryption1Enabled = Ndis802_11WEPEnabled,
285 Ndis802_11WEPDisabled,
286 Ndis802_11EncryptionDisabled = Ndis802_11WEPDisabled,
287 Ndis802_11WEPKeyAbsent,
288 Ndis802_11Encryption1KeyAbsent = Ndis802_11WEPKeyAbsent,
289 Ndis802_11WEPNotSupported,
290 Ndis802_11EncryptionNotSupported = Ndis802_11WEPNotSupported,
291 Ndis802_11Encryption2Enabled,
292 Ndis802_11Encryption2KeyAbsent,
293 Ndis802_11Encryption3Enabled,
294 Ndis802_11Encryption3KeyAbsent
295 } NDIS_802_11_WEP_STATUS, *PNDIS_802_11_WEP_STATUS,
296 NDIS_802_11_ENCRYPTION_STATUS, *PNDIS_802_11_ENCRYPTION_STATUS;
299 typedef enum _NDIS_802_11_STATUS_TYPE
301 Ndis802_11StatusType_Authentication,
302 Ndis802_11StatusType_MediaStreamMode,
303 Ndis802_11StatusType_PMKID_CandidateList,
304 Ndis802_11StatusTypeMax // not a real type, defined as an upper bound
305 } NDIS_802_11_STATUS_TYPE, *PNDIS_802_11_STATUS_TYPE;
307 //Added new types for PMKID Candidate lists.
308 typedef struct _PMKID_CANDIDATE {
309 NDIS_802_11_MAC_ADDRESS BSSID;
311 } PMKID_CANDIDATE, *PPMKID_CANDIDATE;
314 typedef struct _BSSID_INFO
316 NDIS_802_11_MAC_ADDRESS BSSID;
317 NDIS_802_11_PMKID_VALUE PMKID;
318 } BSSID_INFO, *PBSSID_INFO;
320 typedef struct tagSPMKID {
321 unsigned long Length;
322 unsigned long BSSIDInfoCount;
323 BSSID_INFO BSSIDInfo[MAX_BSSIDINFO_4_PMKID];
326 typedef struct tagSPMKIDCandidateEvent {
327 NDIS_802_11_STATUS_TYPE StatusType;
328 unsigned long Version; /* Version of the structure */
329 unsigned long NumCandidates; /* No. of pmkid candidates */
330 PMKID_CANDIDATE CandidateList[MAX_PMKIDLIST];
331 } SPMKIDCandidateEvent, *PSPMKIDCandidateEvent;
336 #define MAX_QUIET_COUNT 8
338 typedef struct tagSQuietControl {
343 } SQuietControl, *PSQuietControl;
348 // The receive duplicate detection cache entry
349 typedef struct tagSCacheEntry{
351 BYTE abyAddr2[ETH_ALEN];
353 } SCacheEntry, *PSCacheEntry;
355 typedef struct tagSCache{
356 /* The receive cache is updated circularly. The next entry to be written is
357 * indexed by the "InPtr".
359 unsigned int uInPtr; /* Place to use next */
360 SCacheEntry asCacheEntry[DUPLICATE_RX_CACHE_LENGTH];
363 #define CB_MAX_RX_FRAG 64
364 // DeFragment Control Block, used for collecting fragments prior to reassembly
365 typedef struct tagSDeFragControlBlock
369 BYTE abyAddr2[ETH_ALEN];
370 unsigned int uLifetime;
373 unsigned int cbFrameLength;
375 } SDeFragControlBlock, *PSDeFragControlBlock;
380 #define DEVICE_FLAGS_UNPLUG 0x00000001UL
381 #define DEVICE_FLAGS_PREAMBLE_TYPE 0x00000002UL
382 #define DEVICE_FLAGS_OP_MODE 0x00000004UL
383 #define DEVICE_FLAGS_PS_MODE 0x00000008UL
384 #define DEVICE_FLAGS_80211h_MODE 0x00000010UL
386 //flags for driver status
387 #define DEVICE_FLAGS_OPENED 0x00010000UL
388 #define DEVICE_FLAGS_WOL_ENABLED 0x00080000UL
389 //flags for capbilities
390 #define DEVICE_FLAGS_TX_ALIGN 0x01000000UL
391 #define DEVICE_FLAGS_HAVE_CAM 0x02000000UL
392 #define DEVICE_FLAGS_FLOW_CTRL 0x04000000UL
394 //flags for MII status
395 #define DEVICE_LINK_FAIL 0x00000001UL
396 #define DEVICE_SPEED_10 0x00000002UL
397 #define DEVICE_SPEED_100 0x00000004UL
398 #define DEVICE_SPEED_1000 0x00000008UL
399 #define DEVICE_DUPLEX_FULL 0x00000010UL
400 #define DEVICE_AUTONEG_ENABLE 0x00000020UL
401 #define DEVICE_FORCED_BY_EEPROM 0x00000040UL
402 //for device_set_media_duplex
403 #define DEVICE_LINK_CHANGE 0x00000001UL
406 typedef struct __device_opt {
407 int nRxDescs0; //Number of RX descriptors0
408 int nTxDescs0; //Number of TX descriptors 0, 1, 2, 3
409 int rts_thresh; //rts threshold
418 } OPTIONS, *POPTIONS;
421 typedef struct __device_info {
424 struct usb_device* usb;
425 struct net_device* dev;
426 struct net_device_stats stats;
430 struct tasklet_struct CmdWorkItem;
431 struct tasklet_struct EventWorkItem;
432 struct tasklet_struct ReadWorkItem;
433 struct tasklet_struct RxMngWorkItem;
450 SDeFragControlBlock sRxDFCB[CB_MAX_RX_FRAG];
452 unsigned int cbFreeDFCB;
453 unsigned int uCurrentDFCBIdx;
457 struct urb *pControlURB;
458 struct urb *pInterruptURB;
459 struct usb_ctrlrequest sUsbCtlRequest;
461 unsigned int int_interval;
463 // Variables to track resources for the BULK In Pipe
466 PRCB apRCB[CB_MAX_RX_DESC];
468 PRCB FirstRecvFreeList;
469 PRCB LastRecvFreeList;
470 unsigned int NumRecvFreeList;
471 PRCB FirstRecvMngList;
472 PRCB LastRecvMngList;
473 unsigned int NumRecvMngList;
474 BOOL bIsRxWorkItemQueued;
475 BOOL bIsRxMngWorkItemQueued;
476 unsigned long ulRcvRefCount; /* packets that have not returned back */
479 // Variables to track resources for the BULK Out Pipe
482 PUSB_SEND_CONTEXT apTD[CB_MAX_TX_DESC];
486 // Variables to track resources for the Interript In Pipe
489 BOOL fKillEventPollingThread;
490 BOOL bEventAvailable;
493 //default config from file by user setting
494 DEFAULT_CONFIG config_file;
499 // protect with spinlock
500 unsigned long ulBulkInPosted;
501 unsigned long ulBulkInError;
502 unsigned long ulBulkInContCRCError;
503 unsigned long ulBulkInBytesRead;
505 unsigned long ulBulkOutPosted;
506 unsigned long ulBulkOutError;
507 unsigned long ulBulkOutContCRCError;
508 unsigned long ulBulkOutBytesWrite;
510 unsigned long ulIntInPosted;
511 unsigned long ulIntInError;
512 unsigned long ulIntInContCRCError;
513 unsigned long ulIntInBytesRead;
517 WORD wFirmwareVersion;
526 BYTE byOriginalZonetype;
528 BOOL bLinkPass; // link status: OK or fail
529 BYTE abyCurrentNetAddr[ETH_ALEN];
530 BYTE abyPermanentNetAddr[ETH_ALEN];
531 // SW network address
532 /* u8 abySoftwareNetAddr[ETH_ALEN]; */
533 BOOL bExistSWNetAddr;
535 // Adapter statistics
536 SStatCounter scStatistic;
538 SDot11Counters s802_11Counter;
541 // Maintain statistical debug info.
543 unsigned long packetsReceived;
544 unsigned long packetsReceivedDropped;
545 unsigned long packetsReceivedOverflow;
546 unsigned long packetsSent;
547 unsigned long packetsSentDropped;
548 unsigned long SendContextsInUse;
549 unsigned long RcvBuffersInUse;
553 SMgmtObject sMgmtObj;
556 unsigned int cbBulkInMax;
559 // 802.11 MAC specific
560 unsigned int uCurrRSSI;
566 DWORD dwRxAntennaSel;
567 DWORD dwTxAntennaSel;
569 BYTE byRxAntennaMode;
570 BYTE byTxAntennaMode;
574 //SQ3 functions for antenna diversity
575 struct timer_list TimerSQ3Tmax1;
576 struct timer_list TimerSQ3Tmax2;
577 struct timer_list TimerSQ3Tmax3;
579 BOOL bDiversityRegCtlON;
580 BOOL bDiversityEnable;
581 unsigned long ulDiversityNValue;
582 unsigned long ulDiversityMValue;
586 unsigned long ulSQ3TH;
588 unsigned long uDiversityCnt;
590 unsigned long ulRatio_State0;
591 unsigned long ulRatio_State1;
592 unsigned long ulSQ3_State0;
593 unsigned long ulSQ3_State1;
595 unsigned long aulSQ3Val[MAX_RATE];
596 unsigned long aulPktNum[MAX_RATE];
599 unsigned int uSIFS; /* Current SIFS */
600 unsigned int uDIFS; /* Current DIFS */
601 unsigned int uEIFS; /* Current EIFS */
602 unsigned int uSlot; /* Current SlotTime */
603 unsigned int uCwMin; /* Current CwMin */
604 unsigned int uCwMax; /* CwMax is fixed on 1023 */
614 VIA_BB_TYPE byBBType; //0: 11A, 1:11B, 2:11G
615 VIA_PKT_TYPE byPacketType; //0:11a,1:11b,2:11gb(only CCK in BasicRate),3:11ga(OFDM in Basic Rate)
618 BYTE byTopOFDMBasicRate;
619 BYTE byTopCCKBasicRate;
622 DWORD dwAotoRateTxOkCnt;
623 DWORD dwAotoRateTxFailCnt;
624 DWORD dwErrorRateThreshold[13];
625 DWORD dwTPTable[MAX_RATE];
626 BYTE abyEEPROM[EEP_MAX_CONTEXT_SIZE]; //DWORD alignment
630 unsigned int uConnectionRate;
633 BYTE byShortPreamble;
637 // For RF Power table
642 BYTE abyCCKPwrTbl[14];
643 BYTE abyOFDMPwrTbl[14];
644 BYTE abyOFDMAPwrTbl[42];
648 WORD wFragmentationThreshold;
649 BYTE byShortRetryLimit;
650 BYTE byLongRetryLimit;
651 CARD_OP_MODE eOPMode;
653 WORD wMaxTransmitMSDULifetime;
654 BYTE abyBSSID[ETH_ALEN];
655 BYTE abyDesireBSSID[ETH_ALEN];
656 WORD wCTSDuration; // update while speed change
657 WORD wACKDuration; // update while speed change
658 WORD wRTSTransmitLen; // update while speed change
659 BYTE byRTSServiceField; // update while speed change
660 BYTE byRTSSignalField; // update while speed change
662 DWORD dwMaxReceiveLifetime; // dot11MaxReceiveLifetime
665 BOOL bEncryptionEnable;
667 BOOL bSoftwareGenCrcErr;
671 BOOL bBarkerPreambleMd;
674 WORD wUseProtectCntDown;
676 BOOL bRadioControlOff;
681 WORD wListenInterval;
683 WMAC_POWER_MODE ePSMode;
684 unsigned long ulPSModeWaitTx;
689 BOOL bBeaconBufReady;
693 unsigned int uScanTime;
695 CMD_STATE eCommandState;
704 unsigned int uAutoReConnectTime;
705 unsigned int uIsroamingTime;
709 CMD_ITEM eCmdQueue[CMD_Q_SIZE];
710 unsigned int uCmdDequeueIdx;
711 unsigned int uCmdEnqueueIdx;
712 unsigned int cbFreeCmdQueue;
717 BOOL bEnableRoaming; //DavidWang
718 BOOL bIsRoaming; //DavidWang
719 BOOL bFastRoaming; //DavidWang
720 BYTE bSameBSSMaxNum; //Davidwang
721 BYTE bSameBSSCurNum; //DavidWang
724 unsigned long ulTxPower;
727 NDIS_802_11_WEP_STATUS eEncryptionStatus;
730 //2007-0925-01<Add>by MikeLiu
731 //mike add :save old Encryption
732 NDIS_802_11_WEP_STATUS eOldEncryptionStatus;
739 BYTE abyPRNG[WLAN_WEPMAX_KEYLEN+3];
745 unsigned int uKeyLength;
746 BYTE abyKey[WLAN_WEP232_KEYLEN];
749 unsigned int uAssocCount;
762 // For Update BaseBand VGA Gain Offset
764 unsigned int uBBVGADiffCount;
767 BYTE abyBBVGA[BB_VGA_LEVEL];
768 signed long ldBmThreshold[BB_VGA_LEVEL];
775 DWORD dwDiagRefCount;
780 // For Auto Power Tunning
782 BYTE byAutoPwrTunning;
784 // BaseBand Loopback Use
791 struct timer_list sTimerCommand;
793 struct timer_list sTimerTxData;
794 unsigned long nTxDataTimeCout;
796 BOOL IsTxDataTrigger;
798 #ifdef WPA_SM_Transtatus
799 BOOL fWPA_Authened; //is WPA/WPA-PSK or WPA2/WPA2-PSK authen??
801 BYTE byReAssocCount; //mike add:re-association retry times!
802 BYTE byLinkWaitCount;
804 SEthernetHeader sTxEthHeader;
805 SEthernetHeader sRxEthHeader;
806 BYTE abyBroadcastAddr[ETH_ALEN];
807 BYTE abySNAP_RFC1042[ETH_ALEN];
808 BYTE abySNAP_Bridgetunnel[ETH_ALEN];
810 // Pre-Authentication & PMK cache
812 SPMKIDCandidateEvent gsPMKIDCandidate;
820 BYTE byChannelSwitchCount;
822 //WPA supplicant daemon
823 struct net_device *wpadev;
828 #ifdef WPA_SUPPLICANT_DRIVER_WEXT_SUPPORT
833 BOOL bWPASuppWextEnabled;
837 // user space daemon: hostapd, is used for HOSTAP
841 struct net_device *apdev;
842 int (*tx_80211)(struct sk_buff *skb, struct net_device *dev);
844 unsigned int uChannel;
846 struct iw_statistics wstats; // wireless stats
849 } DEVICE_INFO, *PSDevice;
854 #define EnqueueRCB(_Head, _Tail, _RCB) \
860 _Tail->Next = _RCB; \
866 #define DequeueRCB(Head, Tail) \
876 #define ADD_ONE_WITH_WRAP_AROUND(uVar, uModulo) { \
877 if ((uVar) >= ((uModulo) - 1)) \
884 #define fMP_RESET_IN_PROGRESS 0x00000001
885 #define fMP_DISCONNECTED 0x00000002
886 #define fMP_HALT_IN_PROGRESS 0x00000004
887 #define fMP_SURPRISE_REMOVED 0x00000008
888 #define fMP_RECV_LOOKASIDE 0x00000010
889 #define fMP_INIT_IN_PROGRESS 0x00000020
890 #define fMP_SEND_SIDE_RESOURCE_ALLOCATED 0x00000040
891 #define fMP_RECV_SIDE_RESOURCE_ALLOCATED 0x00000080
892 #define fMP_POST_READS 0x00000100
893 #define fMP_POST_WRITES 0x00000200
894 #define fMP_CONTROL_READS 0x00000400
895 #define fMP_CONTROL_WRITES 0x00000800
899 #define MP_SET_FLAG(_M, _F) ((_M)->Flags |= (_F))
900 #define MP_CLEAR_FLAG(_M, _F) ((_M)->Flags &= ~(_F))
901 #define MP_TEST_FLAG(_M, _F) (((_M)->Flags & (_F)) != 0)
902 #define MP_TEST_FLAGS(_M, _F) (((_M)->Flags & (_F)) == (_F))
904 #define MP_IS_READY(_M) (((_M)->Flags & \
905 (fMP_DISCONNECTED | fMP_RESET_IN_PROGRESS | fMP_HALT_IN_PROGRESS | fMP_INIT_IN_PROGRESS | fMP_SURPRISE_REMOVED)) == 0)
907 /*--------------------- Export Functions --------------------------*/
909 /* BOOL device_dma0_xmit(PSDevice pDevice, struct sk_buff *skb,
910 * unsigned int uNodeIndex);
912 BOOL device_alloc_frag_buf(PSDevice pDevice, PSDeFragControlBlock pDeF);