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/delay.h>
36 #include <linux/device.h>
37 #include <linux/firmware.h>
38 #include <linux/etherdevice.h>
39 #include <linux/suspend.h>
40 #include <linux/if_arp.h>
41 #include <linux/wireless.h>
42 #include <net/iw_handler.h>
43 #include <net/cfg80211.h>
44 #include <linux/timer.h>
45 #include <linux/usb.h>
46 #include <linux/crc32.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 #define DEVICE_INIT_COLD 0x0 /* cold init */
153 #define DEVICE_INIT_RESET 0x1 /* reset init or Dx to D0 power remain */
154 #define DEVICE_INIT_DXPL 0x2 /* Dx to D0 power lost init */
159 * Enum of context types for SendPacket
161 typedef enum _CONTEXT_TYPE
{
162 CONTEXT_DATA_PACKET
= 1,
166 /* RCB (Receive Control Block) */
172 struct vnt_rx_mgmt sMngPacket
;
177 /* used to track bulk out irps */
178 struct vnt_usb_send_context
{
180 struct sk_buff
*pPacket
;
182 unsigned int uBufLen
;
184 struct ethhdr sEthHeader
;
187 unsigned char Data
[MAX_TOTAL_SIZE_WITH_ALL_HEADERS
];
190 /* tx packet info for rxtx */
191 struct vnt_tx_pkt_info
{
193 u8 dest_addr
[ETH_ALEN
];
196 /* structure got from configuration file as user-desired default settings */
197 typedef struct _DEFAULT_CONFIG
{
199 signed int eConfigMode
;
200 signed int eAuthenMode
; /* open/wep/wpa */
201 signed int bShareKeyAlgorithm
; /* open-open/{open,wep}-sharekey */
202 signed int keyidx
; /* wepkey index */
203 signed int eEncryptionStatus
;
204 } DEFAULT_CONFIG
, *PDEFAULT_CONFIG
;
207 * Structure to keep track of USB interrupt packets
210 unsigned int uDataLen
;
212 /* struct urb *pUrb; */
214 } INT_BUFFER
, *PINT_BUFFER
;
216 /* 0:11A 1:11B 2:11G */
217 typedef enum _VIA_BB_TYPE
222 } VIA_BB_TYPE
, *PVIA_BB_TYPE
;
224 /* 0:11a, 1:11b, 2:11gb (only CCK in BasicRate), 3:11ga(OFDM in BasicRate) */
225 typedef enum _VIA_PKT_TYPE
231 } VIA_PKT_TYPE
, *PVIA_PKT_TYPE
;
235 typedef enum __DEVICE_NDIS_STATUS
{
240 } DEVICE_NDIS_STATUS
, *PDEVICE_NDIS_STATUS
;
242 #define MAX_BSSIDINFO_4_PMKID 16
243 #define MAX_PMKIDLIST 5
244 /* flags for PMKID Candidate list structure */
245 #define NDIS_802_11_PMKID_CANDIDATE_PREAUTH_ENABLED 0x01
247 /* PMKID Structures */
248 typedef unsigned char NDIS_802_11_PMKID_VALUE
[16];
250 typedef enum _NDIS_802_11_WEP_STATUS
252 Ndis802_11WEPEnabled
,
253 Ndis802_11Encryption1Enabled
= Ndis802_11WEPEnabled
,
254 Ndis802_11WEPDisabled
,
255 Ndis802_11EncryptionDisabled
= Ndis802_11WEPDisabled
,
256 Ndis802_11WEPKeyAbsent
,
257 Ndis802_11Encryption1KeyAbsent
= Ndis802_11WEPKeyAbsent
,
258 Ndis802_11WEPNotSupported
,
259 Ndis802_11EncryptionNotSupported
= Ndis802_11WEPNotSupported
,
260 Ndis802_11Encryption2Enabled
,
261 Ndis802_11Encryption2KeyAbsent
,
262 Ndis802_11Encryption3Enabled
,
263 Ndis802_11Encryption3KeyAbsent
264 } NDIS_802_11_WEP_STATUS
, *PNDIS_802_11_WEP_STATUS
,
265 NDIS_802_11_ENCRYPTION_STATUS
, *PNDIS_802_11_ENCRYPTION_STATUS
;
267 typedef enum _NDIS_802_11_STATUS_TYPE
269 Ndis802_11StatusType_Authentication
,
270 Ndis802_11StatusType_MediaStreamMode
,
271 Ndis802_11StatusType_PMKID_CandidateList
,
272 Ndis802_11StatusTypeMax
, /* not a real type, defined as upper bound */
273 } NDIS_802_11_STATUS_TYPE
, *PNDIS_802_11_STATUS_TYPE
;
275 /* added new types for PMKID Candidate lists */
276 typedef struct _PMKID_CANDIDATE
{
277 NDIS_802_11_MAC_ADDRESS BSSID
;
279 } PMKID_CANDIDATE
, *PPMKID_CANDIDATE
;
281 typedef struct _BSSID_INFO
283 NDIS_802_11_MAC_ADDRESS BSSID
;
284 NDIS_802_11_PMKID_VALUE PMKID
;
285 } BSSID_INFO
, *PBSSID_INFO
;
287 typedef struct tagSPMKID
{
288 unsigned long Length
;
289 unsigned long BSSIDInfoCount
;
290 BSSID_INFO BSSIDInfo
[MAX_BSSIDINFO_4_PMKID
];
293 typedef struct tagSPMKIDCandidateEvent
{
294 NDIS_802_11_STATUS_TYPE StatusType
;
295 unsigned long Version
; /* Version of the structure */
296 unsigned long NumCandidates
; /* No. of pmkid candidates */
297 PMKID_CANDIDATE CandidateList
[MAX_PMKIDLIST
];
298 } SPMKIDCandidateEvent
, *PSPMKIDCandidateEvent
;
300 /*++ 802.11h related */
301 #define MAX_QUIET_COUNT 8
303 typedef struct tagSQuietControl
{
308 } SQuietControl
, *PSQuietControl
;
310 /* The receive duplicate detection cache entry */
311 typedef struct tagSCacheEntry
{
313 u8 abyAddr2
[ETH_ALEN
];
315 } SCacheEntry
, *PSCacheEntry
;
317 typedef struct tagSCache
{
318 /* The receive cache is updated circularly. The next entry to be written is
319 * indexed by the "InPtr".
321 unsigned int uInPtr
; /* Place to use next */
322 SCacheEntry asCacheEntry
[DUPLICATE_RX_CACHE_LENGTH
];
325 #define CB_MAX_RX_FRAG 64
327 * DeFragment Control Block, used for collecting fragments prior to reassembly
329 typedef struct tagSDeFragControlBlock
333 u8 abyAddr2
[ETH_ALEN
];
334 unsigned int uLifetime
;
337 unsigned int cbFrameLength
;
339 } SDeFragControlBlock
, *PSDeFragControlBlock
;
341 /* flags for options */
342 #define DEVICE_FLAGS_UNPLUG 0x00000001UL
343 #define DEVICE_FLAGS_PREAMBLE_TYPE 0x00000002UL
344 #define DEVICE_FLAGS_OP_MODE 0x00000004UL
345 #define DEVICE_FLAGS_PS_MODE 0x00000008UL
346 #define DEVICE_FLAGS_80211h_MODE 0x00000010UL
348 /* flags for driver status */
349 #define DEVICE_FLAGS_OPENED 0x00010000UL
350 #define DEVICE_FLAGS_WOL_ENABLED 0x00080000UL
351 /* flags for capabilities */
352 #define DEVICE_FLAGS_TX_ALIGN 0x01000000UL
353 #define DEVICE_FLAGS_HAVE_CAM 0x02000000UL
354 #define DEVICE_FLAGS_FLOW_CTRL 0x04000000UL
356 /* flags for MII status */
357 #define DEVICE_LINK_FAIL 0x00000001UL
358 #define DEVICE_SPEED_10 0x00000002UL
359 #define DEVICE_SPEED_100 0x00000004UL
360 #define DEVICE_SPEED_1000 0x00000008UL
361 #define DEVICE_DUPLEX_FULL 0x00000010UL
362 #define DEVICE_AUTONEG_ENABLE 0x00000020UL
363 #define DEVICE_FORCED_BY_EEPROM 0x00000040UL
364 /* for device_set_media_duplex */
365 #define DEVICE_LINK_CHANGE 0x00000001UL
367 typedef struct __device_opt
{
368 int nRxDescs0
; /* number of RX descriptors 0 */
369 int nTxDescs0
; /* number of TX descriptors 0, 1, 2, 3 */
370 int rts_thresh
; /* RTS threshold */
379 } OPTIONS
, *POPTIONS
;
383 struct usb_device
*usb
;
384 struct net_device
*dev
;
385 struct net_device_stats stats
;
389 struct tasklet_struct CmdWorkItem
;
390 struct tasklet_struct EventWorkItem
;
391 struct work_struct read_work_item
;
392 struct work_struct rx_mng_work_item
;
409 SDeFragControlBlock sRxDFCB
[CB_MAX_RX_FRAG
];
415 struct urb
*pControlURB
;
416 struct urb
*pInterruptURB
;
417 struct usb_ctrlrequest sUsbCtlRequest
;
420 /* Variables to track resources for the BULK In Pipe */
421 struct vnt_rcb
*pRCBMem
;
422 struct vnt_rcb
*apRCB
[CB_MAX_RX_DESC
];
424 struct vnt_rcb
*FirstRecvFreeList
;
425 struct vnt_rcb
*LastRecvFreeList
;
427 struct vnt_rcb
*FirstRecvMngList
;
428 struct vnt_rcb
*LastRecvMngList
;
430 int bIsRxWorkItemQueued
;
431 int bIsRxMngWorkItemQueued
;
432 unsigned long ulRcvRefCount
; /* packets that have not returned back */
434 /* Variables to track resources for the BULK Out Pipe */
435 struct vnt_usb_send_context
*apTD
[CB_MAX_TX_DESC
];
437 struct vnt_tx_pkt_info pkt_info
[16];
439 /* Variables to track resources for the Interrupt In Pipe */
441 int fKillEventPollingThread
;
444 /* default config from file by user setting */
445 DEFAULT_CONFIG config_file
;
447 /* Statistic for USB */
448 unsigned long ulBulkInPosted
;
449 unsigned long ulBulkInError
;
450 unsigned long ulBulkInContCRCError
;
451 unsigned long ulBulkInBytesRead
;
453 unsigned long ulBulkOutPosted
;
454 unsigned long ulBulkOutError
;
455 unsigned long ulBulkOutContCRCError
;
456 unsigned long ulBulkOutBytesWrite
;
458 unsigned long ulIntInPosted
;
459 unsigned long ulIntInError
;
460 unsigned long ulIntInContCRCError
;
461 unsigned long ulIntInBytesRead
;
463 /* Version control */
464 u16 wFirmwareVersion
;
472 u8 byOriginalZonetype
;
474 int bLinkPass
; /* link status: OK or fail */
475 struct vnt_cmd_card_init init_command
;
476 struct vnt_rsp_card_init init_response
;
477 u8 abyCurrentNetAddr
[ETH_ALEN
];
478 u8 abyPermanentNetAddr
[ETH_ALEN
];
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];
588 u16 wFragmentationThreshold
;
589 u8 byShortRetryLimit
;
591 CARD_OP_MODE eOPMode
;
593 u16 wMaxTransmitMSDULifetime
;
594 u8 abyBSSID
[ETH_ALEN
];
595 u8 abyDesireBSSID
[ETH_ALEN
];
597 u32 dwMaxReceiveLifetime
; /* dot11MaxReceiveLifetime */
600 int bEncryptionEnable
;
604 int bBarkerPreambleMd
;
607 u16 wUseProtectCntDown
;
609 int bRadioControlOff
;
616 WMAC_POWER_MODE ePSMode
;
617 unsigned long ulPSModeWaitTx
;
620 /* Beacon releated */
628 CMD_STATE eCommandState
;
637 u32 uAutoReConnectTime
;
642 CMD_ITEM eCmdQueue
[CMD_Q_SIZE
];
657 unsigned long ulTxPower
;
660 NDIS_802_11_WEP_STATUS eEncryptionStatus
;
662 NDIS_802_11_WEP_STATUS eOldEncryptionStatus
;
667 u8 abyPRNG
[WLAN_WEPMAX_KEYLEN
+3];
671 u8 abyKey
[WLAN_WEP232_KEYLEN
];
685 /* For Update BaseBand VGA Gain Offset */
690 u8 abyBBVGA
[BB_VGA_LEVEL
];
691 signed long ldBmThreshold
[BB_VGA_LEVEL
];
701 /* For Auto Power Tunning */
704 /* BaseBand Loopback Use */
711 struct delayed_work run_command_work
;
712 /* One second callback */
713 struct delayed_work second_callback_work
;
717 int fWPA_Authened
; /*is WPA/WPA-PSK or WPA2/WPA2-PSK authen?? */
721 struct ethhdr sTxEthHeader
;
722 struct ethhdr sRxEthHeader
;
723 u8 abyBroadcastAddr
[ETH_ALEN
];
724 u8 abySNAP_RFC1042
[ETH_ALEN
];
725 u8 abySNAP_Bridgetunnel
[ETH_ALEN
];
727 /* Pre-Authentication & PMK cache */
729 SPMKIDCandidateEvent gsPMKIDCandidate
;
736 u8 byChannelSwitchCount
;
738 /* WPA supplicant daemon */
744 int bWPASuppWextEnabled
;
746 /* user space daemon: hostapd, is used for HOSTAP */
750 struct net_device
*apdev
;
751 int (*tx_80211
)(struct sk_buff
*skb
, struct net_device
*dev
);
755 struct iw_statistics wstats
; /* wireless stats */
761 #define EnqueueRCB(_Head, _Tail, _RCB) \
767 _Tail->Next = _RCB; \
773 #define DequeueRCB(Head, Tail) \
775 struct vnt_rcb *RCB = Head; \
782 #define ADD_ONE_WITH_WRAP_AROUND(uVar, uModulo) { \
783 if ((uVar) >= ((uModulo) - 1)) \
789 #define fMP_RESET_IN_PROGRESS 0x00000001
790 #define fMP_DISCONNECTED 0x00000002
791 #define fMP_HALT_IN_PROGRESS 0x00000004
792 #define fMP_SURPRISE_REMOVED 0x00000008
793 #define fMP_RECV_LOOKASIDE 0x00000010
794 #define fMP_INIT_IN_PROGRESS 0x00000020
795 #define fMP_SEND_SIDE_RESOURCE_ALLOCATED 0x00000040
796 #define fMP_RECV_SIDE_RESOURCE_ALLOCATED 0x00000080
797 #define fMP_POST_READS 0x00000100
798 #define fMP_POST_WRITES 0x00000200
799 #define fMP_CONTROL_READS 0x00000400
800 #define fMP_CONTROL_WRITES 0x00000800
802 #define MP_SET_FLAG(_M, _F) ((_M)->Flags |= (_F))
803 #define MP_CLEAR_FLAG(_M, _F) ((_M)->Flags &= ~(_F))
804 #define MP_TEST_FLAGS(_M, _F) (((_M)->Flags & (_F)) == (_F))
806 #define MP_IS_READY(_M) (((_M)->Flags & \
807 (fMP_DISCONNECTED | fMP_RESET_IN_PROGRESS | fMP_HALT_IN_PROGRESS | fMP_INIT_IN_PROGRESS | fMP_SURPRISE_REMOVED)) == 0)
809 int device_alloc_frag_buf(struct vnt_private
*, PSDeFragControlBlock pDeF
);