wireg.h revision 1.5 1 /* $NetBSD: wireg.h,v 1.5 2001/05/16 10:45:36 tsubai Exp $ */
2
3 /*
4 * Copyright (c) 1997, 1998, 1999
5 * Bill Paul <wpaul (at) ctr.columbia.edu>. 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 Bill Paul.
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 Bill Paul 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 Bill Paul 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 * FreeBSD driver ported to NetBSD by Bill Sommerfeld in the back of the
37 * Oslo IETF plenary meeting.
38 */
39
40 #define WI_TIMEOUT 65536
41
42 #define WI_PORT0 0
43 #define WI_PORT1 1
44 #define WI_PORT2 2
45 #define WI_PORT3 3
46 #define WI_PORT4 4
47 #define WI_PORT5 5
48
49 /* Default port: 0 (only 0 exists on stations) */
50 #define WI_DEFAULT_PORT (WI_PORT0 << 8)
51
52 /* Default TX rate: 2Mbps, auto fallback */
53 #define WI_DEFAULT_TX_RATE 3
54
55 /* Default network name: ANY */
56 /*
57 * [sommerfeld 1999/07/15] Changed from "ANY" to ""; according to Bill Fenner,
58 * ANY is used in MS driver user interfaces, while "" is used over the
59 * wire..
60 */
61 #define WI_DEFAULT_NETNAME ""
62
63 #define WI_DEFAULT_AP_DENSITY 1
64
65 #define WI_DEFAULT_RTS_THRESH 2347
66
67 #define WI_DEFAULT_DATALEN 2304
68
69 #define WI_DEFAULT_CREATE_IBSS 0
70
71 #define WI_DEFAULT_PM_ENABLED 0
72
73 #define WI_DEFAULT_MAX_SLEEP 100
74
75 #define WI_DEFAULT_ROAMING 1
76
77 #define WI_DEFAULT_AUTHTYPE 1
78
79 #ifdef __NetBSD__
80 #define OS_STRING_NAME "NetBSD"
81 #endif
82 #ifdef __FreeBSD__
83 #define OS_STRING_NAME "FreeBSD"
84 #endif
85 #ifdef __OpenBSD__
86 #define OS_STRING_NAME "OpenBSD"
87 #endif
88
89 #define WI_DEFAULT_NODENAME OS_STRING_NAME " WaveLAN/IEEE node"
90
91 #define WI_DEFAULT_IBSS OS_STRING_NAME " IBSS"
92
93 #define WI_DEFAULT_CHAN 3
94
95 /*
96 * register space access macros
97 */
98 #define CSR_WRITE_4(sc, reg, val) \
99 bus_space_write_4(sc->sc_iot, sc->sc_ioh, reg, val)
100 #define CSR_WRITE_2(sc, reg, val) \
101 bus_space_write_2(sc->sc_iot, sc->sc_ioh, reg, val)
102 #define CSR_WRITE_1(sc, reg, val) \
103 bus_space_write_1(sc->sc_iot, sc->sc_ioh, reg, val)
104
105 #define CSR_READ_4(sc, reg) \
106 bus_space_read_4(sc->sc_iot, sc->sc_ioh, reg)
107 #define CSR_READ_2(sc, reg) \
108 bus_space_read_2(sc->sc_iot, sc->sc_ioh, reg)
109 #define CSR_READ_1(sc, reg) \
110 bus_space_read_1(sc->sc_iot, sc->sc_ioh, reg)
111
112 #ifndef __BUS_SPACE_HAS_STREAM_METHODS
113 #define bus_space_write_stream_2 bus_space_write_2
114 #define bus_space_read_stream_2 bus_space_read_2
115 #endif
116
117 #define CSR_WRITE_STREAM_2(sc, reg, val) \
118 bus_space_write_stream_2(sc->sc_iot, sc->sc_ioh, reg, val)
119 #define CSR_READ_STREAM_2(sc, reg) \
120 bus_space_read_stream_2(sc->sc_iot, sc->sc_ioh, reg)
121
122 /*
123 * The WaveLAN/IEEE cards contain an 802.11 MAC controller which Lucent
124 * calls 'Hermes.' In typical fashion, getting documentation about this
125 * controller is about as easy as squeezing blood from a stone. Here
126 * is more or less what I know:
127 *
128 * - The Hermes controller is firmware driven, and the host interacts
129 * with the Hermes via a firmware interface, which can change.
130 *
131 * - The Hermes is described in a document called: "Hermes Firmware
132 * WaveLAN/IEEE Station Functions," document #010245, which of course
133 * Lucent will not release without an NDA.
134 *
135 * - Lucent has created a library called HCF (Hardware Control Functions)
136 * though which it wants developers to interact with the card. The HCF
137 * is needlessly complex, ill conceived and badly documented. Actually,
138 * the comments in the HCP code itself aren't bad, but the publically
139 * available manual that comes with it is awful, probably due largely to
140 * the fact that it has been emasculated in order to hide information
141 * that Lucent wants to keep proprietary. The purpose of the HCF seems
142 * to be to insulate the driver programmer from the Hermes itself so that
143 * Lucent has an excuse not to release programming in for it.
144 *
145 * - Lucent only makes available documentation and code for 'HCF Light'
146 * which is a stripped down version of HCF with certain features not
147 * implemented, most notably support for 802.11 frames.
148 *
149 * - The HCF code which I have seen blows goats. Whoever decided to
150 * use a 132 column format should be shot.
151 *
152 * Rather than actually use the Lucent HCF library, I have stripped all
153 * the useful information from it and used it to create a driver in the
154 * usual BSD form. Note: I don't want to hear anybody whining about the
155 * fact that the Lucent code is GPLed and mine isn't. I did not actually
156 * put any of Lucent's code in this driver: I only used it as a reference
157 * to obtain information about the underlying hardware. The Hermes
158 * programming interface is not GPLed, so bite me.
159 */
160
161 /*
162 * Size of Hermes I/O space.
163 */
164 #define WI_IOSIZE 0x40
165
166 /*
167 * Hermes register definitions and what little I know about them.
168 */
169
170 /* Hermes command/status registers. */
171 #define WI_COMMAND 0x00
172 #define WI_PARAM0 0x02
173 #define WI_PARAM1 0x04
174 #define WI_PARAM2 0x06
175 #define WI_STATUS 0x08
176 #define WI_RESP0 0x0A
177 #define WI_RESP1 0x0C
178 #define WI_RESP2 0x0E
179
180 /* Command register values. */
181 #define WI_CMD_BUSY 0x8000 /* busy bit */
182 #define WI_CMD_INI 0x0000 /* initialize */
183 #define WI_CMD_ENABLE 0x0001 /* enable */
184 #define WI_CMD_DISABLE 0x0002 /* disable */
185 #define WI_CMD_DIAG 0x0003
186 #define WI_CMD_ALLOC_MEM 0x000A /* allocate NIC memory */
187 #define WI_CMD_TX 0x000B /* transmit */
188 #define WI_CMD_NOTIFY 0x0010
189 #define WI_CMD_INQUIRE 0x0011
190 #define WI_CMD_ACCESS 0x0021
191 #define WI_CMD_PROGRAM 0x0022
192
193 #define WI_CMD_CODE_MASK 0x003F
194
195 /*
196 * Reclaim qualifier bit, applicable to the
197 * TX and INQUIRE commands.
198 */
199 #define WI_RECLAIM 0x0100 /* reclaim NIC memory */
200
201 /*
202 * ACCESS command qualifier bits.
203 */
204 #define WI_ACCESS_READ 0x0000
205 #define WI_ACCESS_WRITE 0x0100
206
207 /*
208 * PROGRAM command qualifier bits.
209 */
210 #define WI_PROGRAM_DISABLE 0x0000
211 #define WI_PROGRAM_ENABLE_RAM 0x0100
212 #define WI_PROGRAM_ENABLE_NVRAM 0x0200
213 #define WI_PROGRAM_NVRAM 0x0300
214
215 /* Status register values */
216 #define WI_STAT_CMD_CODE 0x003F
217 #define WI_STAT_DIAG_ERR 0x0100
218 #define WI_STAT_INQ_ERR 0x0500
219 #define WI_STAT_CMD_RESULT 0x7F00
220
221 /* memory handle management registers */
222 #define WI_INFO_FID 0x10
223 #define WI_RX_FID 0x20
224 #define WI_ALLOC_FID 0x22
225 #define WI_TX_CMP_FID 0x24
226
227 /*
228 * Buffer Access Path (BAP) registers.
229 * These are I/O channels. I believe you can use each one for
230 * any desired purpose independently of the other. In general
231 * though, we use BAP1 for reading and writing LTV records and
232 * reading received data frames, and BAP0 for writing transmit
233 * frames. This is a convention though, not a rule.
234 */
235 #define WI_SEL0 0x18
236 #define WI_SEL1 0x1A
237 #define WI_OFF0 0x1C
238 #define WI_OFF1 0x1E
239 #define WI_DATA0 0x36
240 #define WI_DATA1 0x38
241 #define WI_BAP0 WI_DATA0
242 #define WI_BAP1 WI_DATA1
243
244 #define WI_OFF_BUSY 0x8000
245 #define WI_OFF_ERR 0x4000
246 #define WI_OFF_DATAOFF 0x0FFF
247
248 /* Event registers */
249 #define WI_EVENT_STAT 0x30 /* Event status */
250 #define WI_INT_EN 0x32 /* Interrupt enable/disable */
251 #define WI_EVENT_ACK 0x34 /* Ack event */
252
253 /* Events */
254 #define WI_EV_TICK 0x8000 /* aux timer tick */
255 #define WI_EV_RES 0x4000 /* controller h/w error (time out) */
256 #define WI_EV_INFO_DROP 0x2000 /* no RAM to build unsolicited frame */
257 #define WI_EV_NO_CARD 0x0800 /* card removed (hunh?) */
258 #define WI_EV_DUIF_RX 0x0400 /* wavelan management packet received */
259 #define WI_EV_INFO 0x0080 /* async info frame */
260 #define WI_EV_CMD 0x0010 /* command completed */
261 #define WI_EV_ALLOC 0x0008 /* async alloc/reclaim completed */
262 #define WI_EV_TX_EXC 0x0004 /* async xmit completed with failure */
263 #define WI_EV_TX 0x0002 /* async xmit completed succesfully */
264 #define WI_EV_RX 0x0001 /* async rx completed */
265
266 #define WI_INTRS \
267 (WI_EV_RX|WI_EV_TX|WI_EV_TX_EXC|WI_EV_ALLOC|WI_EV_INFO|WI_EV_INFO_DROP)
268
269 /* Host software registers */
270 #define WI_SW0 0x28
271 #define WI_SW1 0x2A
272 #define WI_SW2 0x2C
273 #define WI_SW3 0x2E
274
275 #define WI_CNTL 0x14
276
277 #define WI_CNTL_AUX_ENA 0xC000
278 #define WI_CNTL_AUX_ENA_STAT 0xC000
279 #define WI_CNTL_AUX_DIS_STAT 0x0000
280 #define WI_CNTL_AUX_ENA_CNTL 0x8000
281 #define WI_CNTL_AUX_DIS_CNTL 0x4000
282
283 #define WI_AUX_PAGE 0x3A
284 #define WI_AUX_OFFSET 0x3C
285 #define WI_AUX_DATA 0x3E
286
287 /*
288 * One form of communication with the Hermes is with what Lucent calls
289 * LTV records, where LTV stands for Length, Type and Value. The length
290 * and type are 16 bits and are in native byte order. The value is in
291 * multiples of 16 bits and is in little endian byte order.
292 */
293 struct wi_ltv_gen {
294 u_int16_t wi_len;
295 u_int16_t wi_type;
296 u_int16_t wi_val;
297 };
298
299 struct wi_ltv_str {
300 u_int16_t wi_len;
301 u_int16_t wi_type;
302 u_int16_t wi_str[17];
303 };
304
305 #define WI_SETVAL(recno, val) \
306 do { \
307 struct wi_ltv_gen g; \
308 \
309 g.wi_len = 2; \
310 g.wi_type = recno; \
311 g.wi_val = htole16(val); \
312 wi_write_record(sc, &g); \
313 } while (0)
314
315 #define WI_SETSTR(recno, str) \
316 do { \
317 struct wi_ltv_str s; \
318 int l; \
319 \
320 l = (strlen(str) + 1) & ~0x1; \
321 bzero((char *)&s, sizeof(s)); \
322 s.wi_len = (l / 2) + 2; \
323 s.wi_type = recno; \
324 s.wi_str[0] = htole16(strlen(str)); \
325 bcopy(str, (char *)&s.wi_str[1], strlen(str)); \
326 wi_write_record(sc, (struct wi_ltv_gen *)&s); \
327 } while (0)
328
329 /*
330 * Download buffer location and length (0xFD01).
331 */
332 #define WI_RID_DNLD_BUF 0xFD01
333 struct wi_ltv_dnld_buf {
334 u_int16_t wi_len;
335 u_int16_t wi_type;
336 u_int16_t wi_buf_pg; /* page addr of intermediate dl buf*/
337 u_int16_t wi_buf_off; /* offset of idb */
338 u_int16_t wi_buf_len; /* len of idb */
339 };
340
341 /*
342 * Mem sizes (0xFD02).
343 */
344 #define WI_RID_MEMSZ 0xFD02
345 struct wi_ltv_memsz {
346 u_int16_t wi_len;
347 u_int16_t wi_type;
348 u_int16_t wi_mem_ram;
349 u_int16_t wi_mem_nvram;
350 };
351
352 /*
353 * NIC Identification (0xFD0B)
354 */
355 #define WI_RID_CARDID 0xFD0B
356 #define WI_RID_IDENT 0xFD20
357 struct wi_ltv_ver {
358 u_int16_t wi_len;
359 u_int16_t wi_type;
360 u_int16_t wi_ver[4];
361 #define WI_NIC_EVB2 0x8000
362 #define WI_NIC_HWB3763 0x8001
363 #define WI_NIC_HWB3163 0x8002
364 #define WI_NIC_HWB3163B 0x8003
365 #define WI_NIC_EVB3 0x8004
366 #define WI_NIC_HWB1153 0x8007
367 #define WI_NIC_P2_SST 0x8008 /* Prism2 with SST flush */
368 };
369
370 /*
371 * List of intended regulatory domains (0xFD11).
372 */
373 #define WI_RID_DOMAINS 0xFD11
374 struct wi_ltv_domains {
375 u_int16_t wi_len;
376 u_int16_t wi_type;
377 u_int16_t wi_domains[6];
378 };
379
380 /*
381 * CIS struct (0xFD13).
382 */
383 #define WI_RID_CIS 0xFD13
384 struct wi_ltv_cis {
385 u_int16_t wi_len;
386 u_int16_t wi_type;
387 u_int16_t wi_cis[240];
388 };
389
390 /*
391 * Communications quality (0xFD43).
392 */
393 #define WI_RID_COMMQUAL 0xFD43
394 struct wi_ltv_commqual {
395 u_int16_t wi_len;
396 u_int16_t wi_type;
397 u_int16_t wi_coms_qual;
398 u_int16_t wi_sig_lvl;
399 u_int16_t wi_noise_lvl;
400 };
401
402 /*
403 * Actual system scale thresholds (0xFD46).
404 */
405 #define WI_RID_SYSTEM_SCALE 0xFC06
406 #define WI_RID_SCALETHRESH 0xFD46
407 struct wi_ltv_scalethresh {
408 u_int16_t wi_len;
409 u_int16_t wi_type;
410 u_int16_t wi_energy_detect;
411 u_int16_t wi_carrier_detect;
412 u_int16_t wi_defer;
413 u_int16_t wi_cell_search;
414 u_int16_t wi_out_of_range;
415 u_int16_t wi_delta_snr;
416 };
417
418 /*
419 * PCF info struct (0xFD87).
420 */
421 #define WI_RID_PCF 0xFD87
422 struct wi_ltv_pcf {
423 u_int16_t wi_len;
424 u_int16_t wi_type;
425 u_int16_t wi_medium_occupancy_limit;
426 u_int16_t wi_cfp_period;
427 u_int16_t wi_cfp_max_duration;
428 };
429
430 /*
431 * Connection control characteristics.
432 * 1 == Basic Service Set (BSS)
433 * 2 == Wireless Distribudion System (WDS)
434 * 3 == Pseudo IBSS
435 */
436 #define WI_RID_PORTTYPE 0xFC00
437 #define WI_PORTTYPE_BSS 0x1
438 #define WI_PORTTYPE_WDS 0x2
439 #define WI_PORTTYPE_ADHOC 0x3
440
441 /*
442 * Mac addresses.
443 */
444 #define WI_RID_MAC_NODE 0xFC01
445 #define WI_RID_MAC_WDS 0xFC08
446 struct wi_ltv_macaddr {
447 u_int16_t wi_len;
448 u_int16_t wi_type;
449 u_int8_t wi_mac_addr[6];
450 };
451
452 /*
453 * Station set identification (SSID).
454 */
455 #define WI_RID_DESIRED_SSID 0xFC02
456 #define WI_RID_OWN_SSID 0xFC04
457 struct wi_ltv_ssid {
458 u_int16_t wi_len;
459 u_int16_t wi_type;
460 u_int16_t wi_id[17];
461 };
462
463 /*
464 * Set communications channel (radio frequency).
465 */
466 #define WI_RID_OWN_CHNL 0xFC03
467
468 /*
469 * Frame data size.
470 */
471 #define WI_RID_MAX_DATALEN 0xFC07
472
473 /*
474 * ESS power management enable
475 */
476 #define WI_RID_PM_ENABLED 0xFC09
477
478 /*
479 * ESS max PM sleep internal
480 */
481 #define WI_RID_MAX_SLEEP 0xFC0C
482
483 /*
484 * Set our station name.
485 */
486 #define WI_RID_NODENAME 0xFC0E
487 struct wi_ltv_nodename {
488 u_int16_t wi_len;
489 u_int16_t wi_type;
490 u_int16_t wi_nodename[17];
491 };
492
493 /*
494 * Multicast addresses to be put in filter. We're
495 * allowed up to 16 addresses in the filter.
496 */
497 #define WI_RID_MCAST 0xFC80
498 struct wi_ltv_mcast {
499 u_int16_t wi_len;
500 u_int16_t wi_type;
501 struct ether_addr wi_mcast[16];
502 };
503
504 /*
505 * Create IBSS.
506 */
507 #define WI_RID_CREATE_IBSS 0xFC81
508
509 #define WI_RID_FRAG_THRESH 0xFC82
510 #define WI_RID_RTS_THRESH 0xFC83
511
512 /*
513 * TX rate control
514 * 0 == Fixed 1mbps
515 * 1 == Fixed 2mbps
516 * 2 == auto fallback
517 */
518 #define WI_RID_TX_RATE 0xFC84
519
520 /*
521 * promiscuous mode.
522 */
523 #define WI_RID_PROMISC 0xFC85
524
525 /*
526 * Auxiliary Timer tick interval
527 */
528 #define WI_RID_TICK_TIME 0xFCE0
529
530 /*
531 * Information frame types.
532 */
533 #define WI_INFO_NOTIFY 0xF000 /* Handover address */
534 #define WI_INFO_COUNTERS 0xF100 /* Statistics counters */
535 #define WI_INFO_SCAN_RESULTS 0xF101 /* Scan results */
536 #define WI_INFO_LINK_STAT 0xF200 /* Link status */
537 #define WI_INFO_ASSOC_STAT 0xF201 /* Association status */
538
539 /*
540 * Hermes transmit/receive frame structure
541 */
542 struct wi_frame {
543 u_int16_t wi_status; /* 0x00 */
544 u_int16_t wi_rsvd0; /* 0x02 */
545 u_int16_t wi_rsvd1; /* 0x04 */
546 u_int16_t wi_q_info; /* 0x06 */
547 u_int16_t wi_rsvd2; /* 0x08 */
548 u_int16_t wi_rsvd3; /* 0x0A */
549 u_int16_t wi_tx_ctl; /* 0x0C */
550 u_int16_t wi_frame_ctl; /* 0x0E */
551 u_int16_t wi_id; /* 0x10 */
552 u_int8_t wi_addr1[6]; /* 0x12 */
553 u_int8_t wi_addr2[6]; /* 0x18 */
554 u_int8_t wi_addr3[6]; /* 0x1E */
555 u_int16_t wi_seq_ctl; /* 0x24 */
556 u_int8_t wi_addr4[6]; /* 0x26 */
557 u_int16_t wi_dat_len; /* 0x2C */
558 u_int8_t wi_dst_addr[6]; /* 0x2E */
559 u_int8_t wi_src_addr[6]; /* 0x34 */
560 u_int16_t wi_len; /* 0x3A */
561 u_int16_t wi_dat[3]; /* 0x3C */ /* SNAP header */
562 u_int16_t wi_type; /* 0x42 */
563 };
564
565 #define WI_802_3_OFFSET 0x2E
566 #define WI_802_11_OFFSET 0x44
567 #define WI_802_11_OFFSET_RAW 0x3C
568
569 #define WI_STAT_BADCRC 0x0001
570 #define WI_STAT_UNDECRYPTABLE 0x0002
571 #define WI_STAT_ERRSTAT 0x0003
572 #define WI_STAT_MAC_PORT 0x0700
573 #define WI_STAT_1042 0x2000 /* RFC1042 encoded */
574 #define WI_STAT_TUNNEL 0x4000 /* Bridge-tunnel encoded */
575 #define WI_STAT_WMP_MSG 0x6000 /* WaveLAN-II management protocol */
576 #define WI_RXSTAT_MSG_TYPE 0xE000
577
578 #define WI_ENC_TX_802_3 0x00
579 #define WI_ENC_TX_802_11 0x11
580 #define WI_ENC_TX_E_II 0x0E
581
582 #define WI_ENC_TX_1042 0x00
583 #define WI_ENC_TX_TUNNEL 0xF8
584
585 #define WI_TXCNTL_MACPORT 0x00FF
586 #define WI_TXCNTL_STRUCTTYPE 0xFF00
587
588 /*
589 * SNAP (sub-network access protocol) constants for transmission
590 * of IP datagrams over IEEE 802 networks, taken from RFC1042.
591 * We need these for the LLC/SNAP header fields in the TX/RX frame
592 * structure.
593 */
594 #define WI_SNAP_K1 0xaa /* assigned global SAP for SNAP */
595 #define WI_SNAP_K2 0x00
596 #define WI_SNAP_CONTROL 0x03 /* unnumbered information format */
597 #define WI_SNAP_WORD0 (WI_SNAP_K1 | (WI_SNAP_K1 << 8))
598 #define WI_SNAP_WORD1 (WI_SNAP_K2 | (WI_SNAP_CONTROL << 8))
599 #define WI_SNAPHDR_LEN 0x6
600