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 * File: device.h
20 *
21 * Purpose: MAC Data structure
22 *
23 * Author: Tevin Chen
24 *
25 * Date: Mar 17, 1997
26 *
27 */
28
29#ifndef __DEVICE_H__
30#define __DEVICE_H__
31
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/suspend.h>
39#include <linux/if_arp.h>
40#include <linux/wireless.h>
41#include <linux/timer.h>
42#include <linux/usb.h>
43#include <linux/crc32.h>
44#include <net/mac80211.h>
45
46#ifdef SIOCETHTOOL
47#define DEVICE_ETHTOOL_IOCTL_SUPPORT
48#include <linux/ethtool.h>
49#else
50#undef DEVICE_ETHTOOL_IOCTL_SUPPORT
51#endif
52
53#define RATE_1M		0
54#define RATE_2M		1
55#define RATE_5M		2
56#define RATE_11M	3
57#define RATE_6M		4
58#define RATE_9M		5
59#define RATE_12M	6
60#define RATE_18M	7
61#define RATE_24M	8
62#define RATE_36M	9
63#define RATE_48M	10
64#define RATE_54M	11
65#define RATE_AUTO	12
66
67#define MAX_RATE			12
68
69/*
70 * device specific
71 */
72
73#include "wcmd.h"
74#include "desc.h"
75#include "key.h"
76#include "card.h"
77
78#define VNT_USB_VENDOR_ID                     0x160a
79#define VNT_USB_PRODUCT_ID                    0x3184
80
81#define DEVICE_NAME			"vt6656"
82#define DEVICE_FULL_DRV_NAM		"VIA Networking Wireless LAN USB Driver"
83
84#define DEVICE_VERSION			"mac80211"
85
86#define CONFIG_PATH			"/etc/vntconfiguration.dat"
87
88#define MAX_UINTS			8
89#define OPTION_DEFAULT			{ [0 ... MAX_UINTS-1] = -1}
90
91#define DUPLICATE_RX_CACHE_LENGTH       5
92
93#define AUTO_FB_NONE            0
94#define AUTO_FB_0               1
95#define AUTO_FB_1               2
96
97#define FB_RATE0                0
98#define FB_RATE1                1
99
100/* Antenna Mode */
101#define ANT_A                   0
102#define ANT_B                   1
103#define ANT_DIVERSITY           2
104#define ANT_RXD_TXA             3
105#define ANT_RXD_TXB             4
106#define ANT_UNKNOWN             0xFF
107#define ANT_TXA                 0
108#define ANT_TXB                 1
109#define ANT_RXA                 2
110#define ANT_RXB                 3
111
112#define BB_VGA_LEVEL            4
113#define BB_VGA_CHANGE_THRESHOLD 3
114
115#define EEP_MAX_CONTEXT_SIZE    256
116
117/* Contents in the EEPROM */
118#define EEP_OFS_PAR		0x0
119#define EEP_OFS_ANTENNA		0x17
120#define EEP_OFS_RADIOCTL	0x18
121#define EEP_OFS_RFTYPE		0x1b
122#define EEP_OFS_MINCHANNEL	0x1c
123#define EEP_OFS_MAXCHANNEL	0x1d
124#define EEP_OFS_SIGNATURE	0x1e
125#define EEP_OFS_ZONETYPE	0x1f
126#define EEP_OFS_RFTABLE		0x20
127#define EEP_OFS_PWR_CCK		0x20
128#define EEP_OFS_SETPT_CCK	0x21
129#define EEP_OFS_PWR_OFDMG	0x23
130
131#define EEP_OFS_CALIB_TX_IQ	0x24
132#define EEP_OFS_CALIB_TX_DC	0x25
133#define EEP_OFS_CALIB_RX_IQ	0x26
134
135#define EEP_OFS_MAJOR_VER	0x2e
136#define EEP_OFS_MINOR_VER	0x2f
137
138#define EEP_OFS_CCK_PWR_TBL	0x30
139#define EEP_OFS_OFDM_PWR_TBL	0x40
140#define EEP_OFS_OFDMA_PWR_TBL	0x50
141
142/* Bits in EEP_OFS_ANTENNA */
143#define EEP_ANTENNA_MAIN	0x1
144#define EEP_ANTENNA_AUX		0x2
145#define EEP_ANTINV		0x4
146
147/* Bits in EEP_OFS_RADIOCTL */
148#define EEP_RADIOCTL_ENABLE	0x80
149
150/* control commands */
151#define MESSAGE_TYPE_READ		0x1
152#define MESSAGE_TYPE_WRITE		0x0
153#define MESSAGE_TYPE_LOCK_OR		0x2
154#define MESSAGE_TYPE_LOCK_AND		0x3
155#define MESSAGE_TYPE_WRITE_MASK		0x4
156#define MESSAGE_TYPE_CARDINIT		0x5
157#define MESSAGE_TYPE_INIT_RSP		0x6
158#define MESSAGE_TYPE_MACSHUTDOWN	0x7
159#define MESSAGE_TYPE_SETKEY		0x8
160#define MESSAGE_TYPE_CLRKEYENTRY	0x9
161#define MESSAGE_TYPE_WRITE_MISCFF	0xa
162#define MESSAGE_TYPE_SET_ANTMD		0xb
163#define MESSAGE_TYPE_SELECT_CHANNEL	0xc
164#define MESSAGE_TYPE_SET_TSFTBTT	0xd
165#define MESSAGE_TYPE_SET_SSTIFS		0xe
166#define MESSAGE_TYPE_CHANGE_BBTYPE	0xf
167#define MESSAGE_TYPE_DISABLE_PS		0x10
168#define MESSAGE_TYPE_WRITE_IFRF		0x11
169
170/* command read/write(index) */
171#define MESSAGE_REQUEST_MEM		0x1
172#define MESSAGE_REQUEST_BBREG		0x2
173#define MESSAGE_REQUEST_MACREG		0x3
174#define MESSAGE_REQUEST_EEPROM		0x4
175#define MESSAGE_REQUEST_TSF		0x5
176#define MESSAGE_REQUEST_TBTT		0x6
177#define MESSAGE_REQUEST_BBAGC		0x7
178#define MESSAGE_REQUEST_VERSION		0x8
179#define MESSAGE_REQUEST_RF_INIT		0x9
180#define MESSAGE_REQUEST_RF_INIT2	0xa
181#define MESSAGE_REQUEST_RF_CH0		0xb
182#define MESSAGE_REQUEST_RF_CH1		0xc
183#define MESSAGE_REQUEST_RF_CH2		0xd
184
185/* USB registers */
186#define USB_REG4			0x604
187
188#define DEVICE_INIT_COLD	0x0 /* cold init */
189#define DEVICE_INIT_RESET	0x1 /* reset init or Dx to D0 power remain */
190#define DEVICE_INIT_DXPL	0x2 /* Dx to D0 power lost init */
191
192/* Device init */
193struct vnt_cmd_card_init {
194	u8 init_class;
195	u8 exist_sw_net_addr;
196	u8 sw_net_addr[6];
197	u8 short_retry_limit;
198	u8 long_retry_limit;
199};
200
201struct vnt_rsp_card_init {
202	u8 status;
203	u8 net_addr[6];
204	u8 rf_type;
205	u8 min_channel;
206	u8 max_channel;
207};
208
209/* USB */
210
211/*
212 * Enum of context types for SendPacket
213 */
214enum {
215	CONTEXT_DATA_PACKET = 1,
216	CONTEXT_MGMT_PACKET,
217	CONTEXT_BEACON_PACKET
218};
219
220/* RCB (Receive Control Block) */
221struct vnt_rcb {
222	void *priv;
223	struct urb *urb;
224	struct sk_buff *skb;
225	int in_use;
226};
227
228/* used to track bulk out irps */
229struct vnt_usb_send_context {
230	void *priv;
231	struct sk_buff *skb;
232	struct urb *urb;
233	struct ieee80211_hdr *hdr;
234	unsigned int buf_len;
235	u32 frame_len;
236	u16 tx_hdr_size;
237	u16 tx_rate;
238	u8 type;
239	u8 pkt_no;
240	u8 pkt_type;
241	u8 need_ack;
242	u8 fb_option;
243	bool in_use;
244	unsigned char data[MAX_TOTAL_SIZE_WITH_ALL_HEADERS];
245};
246
247/*
248 * Structure to keep track of USB interrupt packets
249 */
250struct vnt_interrupt_buffer {
251	u8 *data_buf;
252	bool in_use;
253};
254
255/*++ NDIS related */
256
257enum {
258	STATUS_SUCCESS = 0,
259	STATUS_FAILURE,
260	STATUS_RESOURCES,
261	STATUS_PENDING,
262};
263
264/* flags for options */
265#define DEVICE_FLAGS_UNPLUG		BIT(0)
266#define DEVICE_FLAGS_DISCONNECTED	BIT(1)
267
268struct vnt_private {
269	/* mac80211 */
270	struct ieee80211_hw *hw;
271	struct ieee80211_vif *vif;
272	u8 mac_hw;
273	/* netdev */
274	struct usb_device *usb;
275
276	u64 tsf_time;
277	u8 rx_rate;
278
279	u32 rx_buf_sz;
280	int mc_list_count;
281
282	spinlock_t lock;
283	struct mutex usb_lock;
284
285	unsigned long flags;
286
287	/* USB */
288	struct urb *interrupt_urb;
289	u32 int_interval;
290
291	/* Variables to track resources for the BULK In Pipe */
292	struct vnt_rcb *rcb[CB_MAX_RX_DESC];
293	u32 num_rcb;
294
295	/* Variables to track resources for the BULK Out Pipe */
296	struct vnt_usb_send_context *tx_context[CB_MAX_TX_DESC];
297	u32 num_tx_context;
298
299	/* Variables to track resources for the Interrupt In Pipe */
300	struct vnt_interrupt_buffer int_buf;
301
302	/* Version control */
303	u16 firmware_version;
304	u8 local_id;
305	u8 rf_type;
306	u8 bb_rx_conf;
307
308	struct vnt_cmd_card_init init_command;
309	struct vnt_rsp_card_init init_response;
310	u8 current_net_addr[ETH_ALEN] __aligned(2);
311	u8 permanent_net_addr[ETH_ALEN] __aligned(2);
312
313	u8 exist_sw_net_addr;
314
315	u64 current_tsf;
316
317	/* 802.11 MAC specific */
318	u32 current_rssi;
319
320	/* Antenna Diversity */
321	int tx_rx_ant_inv;
322	u32 rx_antenna_sel;
323	u8 rx_antenna_mode;
324	u8 tx_antenna_mode;
325	u8 radio_ctl;
326
327	/* IFS & Cw */
328	u32 sifs;  /* Current SIFS */
329	u32 difs;  /* Current DIFS */
330	u32 eifs;  /* Current EIFS */
331	u32 slot;  /* Current SlotTime */
332
333	/* Rate */
334	u8 bb_type; /* 0: 11A, 1:11B, 2:11G */
335	u8 packet_type; /* 0:11a 1:11b 2:11gb 3:11ga */
336	u32 basic_rates;
337	u8 top_ofdm_basic_rate;
338	u8 top_cck_basic_rate;
339
340	u8 eeprom[EEP_MAX_CONTEXT_SIZE];  /*u32 alignment */
341
342	u8 preamble_type;
343
344	/* For RF Power table */
345	u8 cck_pwr;
346	u8 ofdm_pwr_g;
347	u8 ofdm_pwr_a;
348	u8 power;
349	u8 cck_pwr_tbl[14];
350	u8 ofdm_pwr_tbl[14];
351	u8 ofdm_a_pwr_tbl[42];
352
353	u16 current_rate;
354	u16 tx_rate_fb0;
355	u16 tx_rate_fb1;
356
357	u8 short_retry_limit;
358	u8 long_retry_limit;
359
360	enum nl80211_iftype op_mode;
361
362	int short_slot_time;
363
364	/* Power save */
365	u16 current_aid;
366
367	/* Beacon releated */
368	u16 seq_counter;
369
370	enum vnt_cmd_state command_state;
371
372	enum vnt_cmd command;
373
374	/* 802.11 counter */
375
376	enum vnt_cmd cmd_queue[CMD_Q_SIZE];
377	u32 cmd_dequeue_idx;
378	u32 cmd_enqueue_idx;
379	u32 free_cmd_queue;
380	int cmd_running;
381
382	unsigned long key_entry_inuse;
383
384	u8 auto_fb_ctrl;
385
386	/* For Update BaseBand VGA Gain Offset */
387	u8 bb_vga[BB_VGA_LEVEL];
388
389	u8 bb_pre_ed_rssi;
390	u8 bb_pre_ed_index;
391
392	/* command timer */
393	struct delayed_work run_command_work;
394
395	struct ieee80211_low_level_stats low_stats;
396};
397
398#define ADD_ONE_WITH_WRAP_AROUND(uVar, uModulo) {	\
399	if ((uVar) >= ((uModulo) - 1))			\
400		(uVar) = 0;				\
401	else						\
402		(uVar)++;				\
403}
404
405int vnt_init(struct vnt_private *priv);
406
407#endif
408