if_atureg.h revision 1.1 1 /* $NetBSD: if_atureg.h,v 1.1 2005/01/24 01:17:03 joff 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_softc;
105
106 struct atu_chain {
107 struct atu_softc *atu_sc;
108 usbd_xfer_handle atu_xfer;
109 char *atu_buf;
110 struct mbuf *atu_mbuf;
111 u_int8_t atu_idx;
112 u_int16_t atu_length;
113 int atu_in_xfer;
114 SLIST_ENTRY(atu_chain) atu_list;
115 };
116
117 struct atu_cdata {
118 struct atu_chain atu_tx_chain[ATU_TX_LIST_CNT];
119 struct atu_chain atu_rx_chain[ATU_RX_LIST_CNT];
120
121 SLIST_HEAD(atu_list_head, atu_chain) atu_rx_free;
122 struct atu_list_head atu_tx_free;
123
124 u_int8_t atu_tx_inuse;
125 u_int8_t atu_tx_last_idx;
126 };
127
128 #define MAX_SSID_LEN 32
129 #define ATU_AVG_TIME 20
130
131 struct atu_softc {
132 USBBASEDEVICE atu_dev;
133 struct ieee80211com sc_ic;
134 int (*sc_newstate)(struct ieee80211com *,
135 enum ieee80211_state, int);
136
137 char sc_state;
138 #define ATU_S_DEAD 0
139 #define ATU_S_OK 1
140 #define ATU_S_UNCONFIG 2
141 char sc_cmd;
142 #define ATU_C_NONE 0
143 #define ATU_C_SCAN 1
144 #define ATU_C_JOIN 2
145 struct usb_task sc_task;
146
147 usbd_device_handle atu_udev;
148 usbd_interface_handle atu_iface;
149 struct ethercom atu_ec;
150 struct ifmedia atu_media;
151 int atu_ed[ATU_ENDPT_MAX];
152 usbd_pipe_handle atu_ep[ATU_ENDPT_MAX];
153 int atu_unit;
154 int atu_if_flags;
155
156 struct atu_cdata atu_cdata;
157
158 struct timeval atu_rx_notice;
159
160 u_int8_t atu_bssid[ETHER_ADDR_LEN];
161 enum atu_radio_type atu_radio;
162 u_int16_t atu_quirk;
163
164 u_int8_t atu_ssid[MAX_SSID_LEN];
165 u_int8_t atu_ssidlen;
166 u_int8_t atu_channel;
167 u_int16_t atu_desired_channel;
168 u_int8_t atu_mode;
169 #define NO_MODE_YET 0
170 #define AD_HOC_MODE 1
171 #define INFRASTRUCTURE_MODE 2
172
173 u_int8_t atu_radio_on;
174 u_int8_t atu_encrypt;
175 #define ATU_WEP_RX 0x01
176 #define ATU_WEP_TX 0x02
177 #define ATU_WEP_TXRX (ATU_WEP_RX | ATU_WEP_TX)
178 int atu_wepkey;
179 int atu_wepkeylen;
180 u_int8_t atu_wepkeys[4][13];
181 };
182
183 /* Commands for uploading the firmware (standard DFU interface) */
184 #define DFU_DNLOAD UT_WRITE_CLASS_INTERFACE, 0x01
185 #define DFU_GETSTATUS UT_READ_CLASS_INTERFACE, 0x03
186 #define DFU_GETSTATE UT_READ_CLASS_INTERFACE, 0x05
187 #define DFU_REMAP UT_WRITE_VENDOR_INTERFACE, 0x0a
188
189 /* DFU states */
190 #define DFUState_AppIdle 0
191 #define DFUState_AppDetach 1
192 #define DFUState_DFUIdle 2
193 #define DFUState_DnLoadSync 3
194 #define DFUState_DnLoadBusy 4
195 #define DFUState_DnLoadIdle 5
196 #define DFUState_ManifestSync 6
197 #define DFUState_Manifest 7
198 #define DFUState_ManifestWait 8
199 #define DFUState_UploadIdle 9
200 #define DFUState_DFUError 10
201
202 #define DFU_MaxBlockSize 1024
203
204 /* AT76c503 operating modes */
205 #define MODE_NONE 0x00
206 #define MODE_NETCARD 0x01
207 #define MODE_CONFIG 0x02
208 #define MODE_DFU 0x03
209 #define MODE_NOFLASHNETCARD 0x04
210
211 /* AT76c503 commands */
212 #define CMD_SET_MIB 0x01
213 #define CMD_START_SCAN 0x03
214 #define CMD_JOIN 0x04
215 #define CMD_START_IBSS 0x05
216 #define CMD_RADIO 0x06
217 #define CMD_RADIO_ON 0x06
218 #define CMD_RADIO_OFF 0x07
219 #define CMD_STARTUP 0x0b
220
221 /* AT76c503 status messages - used in atu_wait_completion */
222 #define STATUS_IDLE 0x00
223 #define STATUS_COMPLETE 0x01
224 #define STATUS_UNKNOWN 0x02
225 #define STATUS_INVALID_PARAMETER 0x03
226 #define STATUS_FUNCTION_NOT_SUPPORTED 0x04
227 #define STATUS_TIME_OUT 0x07
228 #define STATUS_IN_PROGRESS 0x08
229 #define STATUS_HOST_FAILURE 0xff
230 #define STATUS_SCAN_FAILED 0xf0
231
232 /* AT76c503 command header */
233 struct atu_cmd {
234 uByte Cmd;
235 uByte Reserved;
236 uWord Size;
237 } UPACKED;
238
239 /* CMD_SET_MIB command (0x01) */
240 struct atu_cmd_set_mib {
241 /* AT76c503 command header */
242 uByte AtCmd;
243 uByte AtReserved;
244 uWord AtSize;
245
246 /* MIB header */
247 uByte MIBType;
248 uByte MIBSize;
249 uByte MIBIndex;
250 uByte MIBReserved;
251
252 /* MIB data */
253 uByte data[72];
254 } UPACKED;
255
256 /* CMD_STARTUP command (0x0b) */
257 struct atu_cmd_card_config {
258 uByte Cmd;
259 uByte Reserved;
260 uWord Size;
261
262 uByte ExcludeUnencrypted;
263 uByte PromiscuousMode;
264 uByte ShortRetryLimit;
265 uByte EncryptionType;
266 uWord RTS_Threshold;
267 uWord FragThreshold; /* 256 .. 2346 */
268 uByte BasicRateSet[4];
269 uByte AutoRateFallback;
270 uByte Channel;
271 uByte PrivacyInvoked; /* wep */
272 uByte WEP_DefaultKeyID; /* 0 .. 3 */
273 uByte SSID[MAX_SSID_LEN];
274 uByte WEP_DefaultKey[4][13];
275 uByte SSID_Len;
276 uByte ShortPreamble;
277 uWord BeaconPeriod;
278 } UPACKED;
279
280 /* CMD_SCAN command (0x03) */
281 struct atu_cmd_do_scan {
282 uByte Cmd;
283 uByte Reserved;
284 uWord Size;
285
286 uByte BSSID[ETHER_ADDR_LEN];
287 uByte SSID[MAX_SSID_LEN];
288 uByte ScanType;
289 uByte Channel;
290 uWord ProbeDelay;
291 uWord MinChannelTime;
292 uWord MaxChannelTime;
293 uByte SSID_Len;
294 uByte InternationalScan;
295 } UPACKED;
296
297 #define ATU_SCAN_ACTIVE 0x00
298 #define ATU_SCAN_PASSIVE 0x01
299
300 /* CMD_JOIN command (0x04) */
301 struct atu_cmd_join {
302 uByte Cmd;
303 uByte Reserved;
304 uWord Size;
305
306 uByte bssid[ETHER_ADDR_LEN];
307 uByte essid[32];
308 uByte bss_type;
309 uByte channel;
310 uWord timeout;
311 uByte essid_size;
312 uByte reserved;
313 } UPACKED;
314
315 /* CMD_START_IBSS (0x05) */
316 struct atu_cmd_start_ibss {
317 uByte Cmd;
318 uByte Reserved;
319 uWord Size;
320
321 uByte BSSID[ETHER_ADDR_LEN];
322 uByte SSID[32];
323 uByte BSSType;
324 uByte Channel;
325 uByte SSIDSize;
326 uByte Res[3];
327 } UPACKED;
328
329 /*
330 * The At76c503 adapters come with different types of radios on them.
331 * At this moment the driver supports adapters with RFMD and Intersil radios.
332 */
333
334 /* The config structure of an RFMD radio */
335 struct atu_rfmd_conf {
336 u_int8_t CR20[14];
337 u_int8_t CR21[14];
338 u_int8_t BB_CR[14];
339 u_int8_t PidVid[4];
340 u_int8_t MACAddr[ETHER_ADDR_LEN];
341 u_int8_t RegulatoryDomain;
342 u_int8_t LowPowerValues[14];
343 u_int8_t NormalPowerValues[14];
344 u_int8_t Reserved[3];
345 /* then we have 84 bytes, somehow Windows reads 95?? */
346 u_int8_t Rest[11];
347 } UPACKED;
348
349 /* The config structure of an Intersil radio */
350 struct atu_intersil_conf {
351 u_int8_t MACAddr[ETHER_ADDR_LEN];
352 /* From the HFA3861B manual : */
353 /* Manual TX power control (7bit : -64 to 63) */
354 u_int8_t CR31[14];
355 /* TX power measurement */
356 u_int8_t CR58[14];
357 u_int8_t PidVid[4];
358 u_int8_t RegulatoryDomain;
359 u_int8_t Reserved[1];
360 } UPACKED;
361
362
363 /* Firmware information request */
364 struct atu_fw {
365 u_int8_t major;
366 u_int8_t minor;
367 u_int8_t patch;
368 u_int8_t build;
369 } UPACKED;
370
371 /*
372 * The header the AT76c503 puts in front of RX packets (for both managment &
373 * data)
374 */
375 struct atu_rx_hdr {
376 uWord length;
377 uByte rx_rate;
378 uByte newbss;
379 uByte fragmentation;
380 uByte rssi;
381 uByte link_quality;
382 uByte noise_level;
383 uDWord rx_time;
384 } UPACKED;
385 #define ATU_RX_HDRLEN sizeof(struct atu_rx_hdr)
386
387 /*
388 * The header we have to put in front of a TX packet before sending it to the
389 * AT76c503
390 */
391 struct atu_tx_hdr {
392 uWord length;
393 uByte tx_rate;
394 uByte padding;
395 uByte reserved[4];
396 } UPACKED;
397 #define ATU_TX_HDRLEN sizeof(struct atu_tx_hdr)
398
399 #define NR(x) (void *)((long)x)
400
401 /*
402 * The linux driver uses seperate routines for every mib request they do
403 * (eg. set_radio / set_preamble / set_frag / etc etc )
404 * We just define a list of types, sizes and offsets and use those
405 */
406
407 /* Name Type Size Index */
408 #define MIB_LOCAL 0x01
409 #define MIB_LOCAL__BEACON_ENABLE MIB_LOCAL, 1, 2
410 #define MIB_LOCAL__AUTO_RATE_FALLBACK MIB_LOCAL, 1, 3
411 #define MIB_LOCAL__SSID_SIZE MIB_LOCAL, 1, 5
412 #define MIB_LOCAL__PREAMBLE MIB_LOCAL, 1, 9
413 #define MIB_MAC_ADDR 0x02
414 #define MIB_MAC_ADDR__ADDR MIB_MAC_ADDR, 6, 0
415 #define MIB_MAC 0x03
416 #define MIB_MAC__FRAG MIB_MAC, 2, 8
417 #define MIB_MAC__RTS MIB_MAC, 2, 10
418 #define MIB_MAC__DESIRED_SSID MIB_MAC, 32, 28
419 #define MIB_MAC_MGMT 0x05
420 #define MIB_MAC_MGMT__BEACON_PERIOD MIB_MAC_MGMT, 2, 0
421 #define MIB_MAC_MGMT__CURRENT_BSSID MIB_MAC_MGMT, 6, 14
422 #define MIB_MAC_MGMT__CURRENT_ESSID MIB_MAC_MGMT, 32, 20
423 #define MIB_MAC_MGMT__POWER_MODE MIB_MAC_MGMT, 1, 53
424 #define MIB_MAC_MGMT__IBSS_CHANGE MIB_MAC_MGMT, 1, 54
425 #define MIB_MAC_WEP 0x06
426 #define MIB_MAC_WEP__PRIVACY_INVOKED MIB_MAC_WEP, 1, 0
427 #define MIB_MAC_WEP__KEY_ID MIB_MAC_WEP, 1, 1
428 #define MIB_MAC_WEP__ICV_ERROR_COUNT MIB_MAC_WEP, 4, 4
429 #define MIB_MAC_WEP__EXCLUDED_COUNT MIB_MAC_WEP, 4, 8
430 #define MIB_MAC_WEP__KEYS(nr) MIB_MAC_WEP, 13, 12+(nr)*13
431 #define MIB_MAC_WEP__ENCR_LEVEL MIB_MAC_WEP, 1, 64
432 #define MIB_PHY 0x07
433 #define MIB_PHY__CHANNEL MIB_PHY, 1, 20
434 #define MIB_PHY__REG_DOMAIN MIB_PHY, 1, 23
435 #define MIB_FW_VERSION 0x08
436 #define MIB_DOMAIN 0x09
437 #define MIB_DOMAIN__POWER_LEVELS MIB_DOMAIN, 14, 0
438 #define MIB_DOMAIN__CHANNELS MIB_DOMAIN, 14, 14
439
440 #define ATU_WEP_OFF 0
441 #define ATU_WEP_40BITS 1
442 #define ATU_WEP_104BITS 2
443
444 #define POWER_MODE_ACTIVE 1
445 #define POWER_MODE_SAVE 2
446 #define POWER_MODE_SMART 3
447
448 #define PREAMBLE_SHORT 1
449 #define PREAMBLE_LONG 0
450