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