if_atureg.h revision 1.6.14.1 1 /* $NetBSD: if_atureg.h,v 1.6.14.1 2007/06/13 04:13:00 itohy Exp $ */
2 /* $OpenBSD: if_atureg.h,v 1.21 2004/12/23 13:19:38 dlg Exp $ */
3 /*
4 * Copyright (c) 2003
5 * Daan Vreeken <Danovitsch (at) Vitsch.net>. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by Daan Vreeken.
18 * 4. Neither the name of the author nor the names of any co-contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY DAAN VREEKEN AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL Daan Vreeken OR THE VOICES IN HIS HEAD
26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32 * THE POSSIBILITY OF SUCH DAMAGE.
33 *
34 */
35
36 #define ATU_CONFIG_NO 1
37 #define ATU_IFACE_IDX 0
38
39 /* the number of simultaniuously requested RX transfers */
40 #define ATU_RX_LIST_CNT 1
41
42 /*
43 * the number of simultaniously started TX transfers
44 * my measurements :
45 * 1 430.82 KB/sec
46 * 2 534.66 KB/sec
47 * 3 536.23 KB/sec
48 * 4 537.80 KB/sec
49 * 6 537.30 KB/sec
50 * 8 535.31 KB/sec
51 * 16 535.68 KB/sec
52 * 128 535.67 KB/sec (before you ask : yes, 128 is silly :)
53 * (+/- 24% increase)
54 */
55 #define ATU_TX_LIST_CNT 8
56
57 /*
58 * According to the 802.11 spec (7.1.2) the frame body can be up to 2312 bytes
59 */
60 #define ATU_RX_BUFSZ (ATU_RX_HDRLEN + \
61 sizeof(struct ieee80211_frame_addr4) + 2312 + 4)
62 /* BE CAREFULL! should add ATU_TX_PADDING */
63 #define ATU_TX_BUFSZ (ATU_TX_HDRLEN + \
64 sizeof(struct ieee80211_frame_addr4) + 2312)
65
66 #define ATU_MIN_FRAMELEN 60
67
68 /*
69 * Sending packets of more than 1500 bytes confuses some access points, so the
70 * default MTU is set to 1500 but can be increased up to 2310 bytes using
71 * ifconfig
72 */
73 #define ATU_DEFAULT_MTU 1500
74 #define ATU_MAX_MTU (2312 - 2)
75
76 #define ATU_ENDPT_RX 0x0
77 #define ATU_ENDPT_TX 0x1
78 #define ATU_ENDPT_MAX 0x2
79
80 #define ATU_TX_TIMEOUT 10000
81 #define ATU_JOIN_TIMEOUT 2000
82
83 #define ATU_NO_QUIRK 0x0000
84 #define ATU_QUIRK_NO_REMAP 0x0001
85 #define ATU_QUIRK_FW_DELAY 0x0002
86
87 #define ATU_DEFAULT_SSID ""
88 #define ATU_DEFAULT_CHANNEL 10
89
90 enum atu_radio_type {
91 RadioRFMD = 0,
92 RadioRFMD2958,
93 RadioRFMD2958_SMC,
94 RadioIntersil
95 };
96
97 struct atu_type {
98 u_int16_t atu_vid;
99 u_int16_t atu_pid;
100 enum atu_radio_type atu_radio;
101 u_int16_t atu_quirk;
102 };
103
104 struct atu_cdata {
105 struct ue_chain atu_tx_chain[ATU_TX_LIST_CNT];
106 struct ue_chain atu_rx_chain[ATU_RX_LIST_CNT];
107
108 struct ue_list_head atu_tx_free;
109
110 u_int8_t atu_tx_inuse;
111 u_int8_t atu_tx_last_idx;
112 };
113
114 #define MAX_SSID_LEN 32
115 #define ATU_AVG_TIME 20
116
117 struct atu_softc {
118 USBBASEDEVICE atu_dev;
119 struct ethercom sc_ec;
120 struct ieee80211com sc_ic;
121 int (*sc_newstate)(struct ieee80211com *,
122 enum ieee80211_state, int);
123
124 char sc_state;
125 #define ATU_S_DEAD 0
126 #define ATU_S_OK 1
127 #define ATU_S_UNCONFIG 2
128 char sc_cmd;
129 #define ATU_C_NONE 0
130 #define ATU_C_SCAN 1
131 #define ATU_C_JOIN 2
132 struct usb_task sc_task;
133
134 usbd_device_handle atu_udev;
135 usbd_interface_handle atu_iface;
136 struct ethercom atu_ec;
137 struct ifmedia atu_media;
138 int atu_ed[ATU_ENDPT_MAX];
139 usbd_pipe_handle atu_ep[ATU_ENDPT_MAX];
140 int atu_unit;
141 int atu_if_flags;
142
143 struct atu_cdata atu_cdata;
144
145 struct timeval atu_rx_notice;
146
147 u_int8_t atu_bssid[ETHER_ADDR_LEN];
148 enum atu_radio_type atu_radio;
149 u_int16_t atu_quirk;
150
151 u_int8_t atu_channel;
152 u_int16_t atu_desired_channel;
153 u_int8_t atu_mode;
154 #define NO_MODE_YET 0
155 #define AD_HOC_MODE 1
156 #define INFRASTRUCTURE_MODE 2
157
158 u_int8_t atu_radio_on;
159 u_int8_t atu_encrypt;
160 #define ATU_WEP_RX 0x01
161 #define ATU_WEP_TX 0x02
162 #define ATU_WEP_TXRX (ATU_WEP_RX | ATU_WEP_TX)
163 int atu_wepkey;
164 int atu_wepkeylen;
165 u_int8_t atu_wepkeys[4][13];
166 };
167
168 #define sc_if sc_ec.ec_if
169
170 /* Commands for uploading the firmware (standard DFU interface) */
171 #define DFU_DNLOAD UT_WRITE_CLASS_INTERFACE, 0x01
172 #define DFU_GETSTATUS UT_READ_CLASS_INTERFACE, 0x03
173 #define DFU_GETSTATE UT_READ_CLASS_INTERFACE, 0x05
174 #define DFU_REMAP UT_WRITE_VENDOR_INTERFACE, 0x0a
175
176 /* DFU states */
177 #define DFUState_AppIdle 0
178 #define DFUState_AppDetach 1
179 #define DFUState_DFUIdle 2
180 #define DFUState_DnLoadSync 3
181 #define DFUState_DnLoadBusy 4
182 #define DFUState_DnLoadIdle 5
183 #define DFUState_ManifestSync 6
184 #define DFUState_Manifest 7
185 #define DFUState_ManifestWait 8
186 #define DFUState_UploadIdle 9
187 #define DFUState_DFUError 10
188
189 #define DFU_MaxBlockSize 1024
190
191 /* AT76c503 operating modes */
192 #define MODE_NONE 0x00
193 #define MODE_NETCARD 0x01
194 #define MODE_CONFIG 0x02
195 #define MODE_DFU 0x03
196 #define MODE_NOFLASHNETCARD 0x04
197
198 /* AT76c503 commands */
199 #define CMD_SET_MIB 0x01
200 #define CMD_START_SCAN 0x03
201 #define CMD_JOIN 0x04
202 #define CMD_START_IBSS 0x05
203 #define CMD_RADIO 0x06
204 #define CMD_RADIO_ON 0x06
205 #define CMD_RADIO_OFF 0x07
206 #define CMD_STARTUP 0x0b
207
208 /* AT76c503 status messages - used in atu_wait_completion */
209 #define STATUS_IDLE 0x00
210 #define STATUS_COMPLETE 0x01
211 #define STATUS_UNKNOWN 0x02
212 #define STATUS_INVALID_PARAMETER 0x03
213 #define STATUS_FUNCTION_NOT_SUPPORTED 0x04
214 #define STATUS_TIME_OUT 0x07
215 #define STATUS_IN_PROGRESS 0x08
216 #define STATUS_HOST_FAILURE 0xff
217 #define STATUS_SCAN_FAILED 0xf0
218
219 /* AT76c503 command header */
220 struct atu_cmd {
221 uByte Cmd;
222 uByte Reserved;
223 uWord Size;
224 } UPACKED;
225
226 /* CMD_SET_MIB command (0x01) */
227 struct atu_cmd_set_mib {
228 /* AT76c503 command header */
229 uByte AtCmd;
230 uByte AtReserved;
231 uWord AtSize;
232
233 /* MIB header */
234 uByte MIBType;
235 uByte MIBSize;
236 uByte MIBIndex;
237 uByte MIBReserved;
238
239 /* MIB data */
240 uByte data[72];
241 } UPACKED;
242
243 /* CMD_STARTUP command (0x0b) */
244 struct atu_cmd_card_config {
245 uByte Cmd;
246 uByte Reserved;
247 uWord Size;
248
249 uByte ExcludeUnencrypted;
250 uByte PromiscuousMode;
251 uByte ShortRetryLimit;
252 uByte EncryptionType;
253 uWord RTS_Threshold;
254 uWord FragThreshold; /* 256 .. 2346 */
255 uByte BasicRateSet[4];
256 uByte AutoRateFallback;
257 uByte Channel;
258 uByte PrivacyInvoked; /* wep */
259 uByte WEP_DefaultKeyID; /* 0 .. 3 */
260 uByte SSID[MAX_SSID_LEN];
261 uByte WEP_DefaultKey[4][13];
262 uByte SSID_Len;
263 uByte ShortPreamble;
264 uWord BeaconPeriod;
265 } UPACKED;
266
267 /* CMD_SCAN command (0x03) */
268 struct atu_cmd_do_scan {
269 uByte Cmd;
270 uByte Reserved;
271 uWord Size;
272
273 uByte BSSID[ETHER_ADDR_LEN];
274 uByte SSID[MAX_SSID_LEN];
275 uByte ScanType;
276 uByte Channel;
277 uWord ProbeDelay;
278 uWord MinChannelTime;
279 uWord MaxChannelTime;
280 uByte SSID_Len;
281 uByte InternationalScan;
282 } UPACKED;
283
284 #define ATU_SCAN_ACTIVE 0x00
285 #define ATU_SCAN_PASSIVE 0x01
286
287 /* CMD_JOIN command (0x04) */
288 struct atu_cmd_join {
289 uByte Cmd;
290 uByte Reserved;
291 uWord Size;
292
293 uByte bssid[ETHER_ADDR_LEN];
294 uByte essid[32];
295 uByte bss_type;
296 uByte channel;
297 uWord timeout;
298 uByte essid_size;
299 uByte reserved;
300 } UPACKED;
301
302 /* CMD_START_IBSS (0x05) */
303 struct atu_cmd_start_ibss {
304 uByte Cmd;
305 uByte Reserved;
306 uWord Size;
307
308 uByte BSSID[ETHER_ADDR_LEN];
309 uByte SSID[32];
310 uByte BSSType;
311 uByte Channel;
312 uByte SSIDSize;
313 uByte Res[3];
314 } UPACKED;
315
316 /*
317 * The At76c503 adapters come with different types of radios on them.
318 * At this moment the driver supports adapters with RFMD and Intersil radios.
319 */
320
321 /* The config structure of an RFMD radio */
322 struct atu_rfmd_conf {
323 u_int8_t CR20[14];
324 u_int8_t CR21[14];
325 u_int8_t BB_CR[14];
326 u_int8_t PidVid[4];
327 u_int8_t MACAddr[ETHER_ADDR_LEN];
328 u_int8_t RegulatoryDomain;
329 u_int8_t LowPowerValues[14];
330 u_int8_t NormalPowerValues[14];
331 u_int8_t Reserved[3];
332 /* then we have 84 bytes, somehow Windows reads 95?? */
333 u_int8_t Rest[11];
334 } UPACKED;
335
336 /* The config structure of an Intersil radio */
337 struct atu_intersil_conf {
338 u_int8_t MACAddr[ETHER_ADDR_LEN];
339 /* From the HFA3861B manual : */
340 /* Manual TX power control (7bit : -64 to 63) */
341 u_int8_t CR31[14];
342 /* TX power measurement */
343 u_int8_t CR58[14];
344 u_int8_t PidVid[4];
345 u_int8_t RegulatoryDomain;
346 u_int8_t Reserved[1];
347 } UPACKED;
348
349
350 /* Firmware information request */
351 struct atu_fw {
352 u_int8_t major;
353 u_int8_t minor;
354 u_int8_t patch;
355 u_int8_t build;
356 } UPACKED;
357
358 /*
359 * The header the AT76c503 puts in front of RX packets (for both managment &
360 * data)
361 */
362 struct atu_rx_hdr {
363 uWord length;
364 uByte rx_rate;
365 uByte newbss;
366 uByte fragmentation;
367 uByte rssi;
368 uByte link_quality;
369 uByte noise_level;
370 uDWord rx_time;
371 } UPACKED;
372 #define ATU_RX_HDRLEN sizeof(struct atu_rx_hdr)
373
374 /*
375 * The header we have to put in front of a TX packet before sending it to the
376 * AT76c503
377 */
378 struct atu_tx_hdr {
379 uWord length;
380 uByte tx_rate;
381 uByte padding;
382 uByte reserved[4];
383 } UPACKED;
384 #define ATU_TX_HDRLEN sizeof(struct atu_tx_hdr)
385
386 #define NR(x) (void *)((long)x)
387
388 /*
389 * The linux driver uses separate routines for every mib request they do
390 * (eg. set_radio / set_preamble / set_frag / etc etc )
391 * We just define a list of types, sizes and offsets and use those
392 */
393
394 /* Name Type Size Index */
395 #define MIB_LOCAL 0x01
396 #define MIB_LOCAL__BEACON_ENABLE MIB_LOCAL, 1, 2
397 #define MIB_LOCAL__AUTO_RATE_FALLBACK MIB_LOCAL, 1, 3
398 #define MIB_LOCAL__SSID_SIZE MIB_LOCAL, 1, 5
399 #define MIB_LOCAL__PREAMBLE MIB_LOCAL, 1, 9
400 #define MIB_MAC_ADDR 0x02
401 #define MIB_MAC_ADDR__ADDR MIB_MAC_ADDR, 6, 0
402 #define MIB_MAC 0x03
403 #define MIB_MAC__FRAG MIB_MAC, 2, 8
404 #define MIB_MAC__RTS MIB_MAC, 2, 10
405 #define MIB_MAC__DESIRED_SSID MIB_MAC, 32, 28
406 #define MIB_MAC_MGMT 0x05
407 #define MIB_MAC_MGMT__BEACON_PERIOD MIB_MAC_MGMT, 2, 0
408 #define MIB_MAC_MGMT__CURRENT_BSSID MIB_MAC_MGMT, 6, 14
409 #define MIB_MAC_MGMT__CURRENT_ESSID MIB_MAC_MGMT, 32, 20
410 #define MIB_MAC_MGMT__POWER_MODE MIB_MAC_MGMT, 1, 53
411 #define MIB_MAC_MGMT__IBSS_CHANGE MIB_MAC_MGMT, 1, 54
412 #define MIB_MAC_WEP 0x06
413 #define MIB_MAC_WEP__PRIVACY_INVOKED MIB_MAC_WEP, 1, 0
414 #define MIB_MAC_WEP__KEY_ID MIB_MAC_WEP, 1, 1
415 #define MIB_MAC_WEP__ICV_ERROR_COUNT MIB_MAC_WEP, 4, 4
416 #define MIB_MAC_WEP__EXCLUDED_COUNT MIB_MAC_WEP, 4, 8
417 #define MIB_MAC_WEP__KEYS(nr) MIB_MAC_WEP, 13, 12+(nr)*13
418 #define MIB_MAC_WEP__ENCR_LEVEL MIB_MAC_WEP, 1, 64
419 #define MIB_PHY 0x07
420 #define MIB_PHY__CHANNEL MIB_PHY, 1, 20
421 #define MIB_PHY__REG_DOMAIN MIB_PHY, 1, 23
422 #define MIB_FW_VERSION 0x08
423 #define MIB_DOMAIN 0x09
424 #define MIB_DOMAIN__POWER_LEVELS MIB_DOMAIN, 14, 0
425 #define MIB_DOMAIN__CHANNELS MIB_DOMAIN, 14, 14
426
427 #define ATU_WEP_OFF 0
428 #define ATU_WEP_40BITS 1
429 #define ATU_WEP_104BITS 2
430
431 #define POWER_MODE_ACTIVE 1
432 #define POWER_MODE_SAVE 2
433 #define POWER_MODE_SMART 3
434
435 #define PREAMBLE_SHORT 1
436 #define PREAMBLE_LONG 0
437