xref: /netbsd-src/sys/dev/ic/wi_ieee.h (revision 06be8101a16cc95f40783b3cb7afd12112103a9a)
1 /*	$NetBSD: wi_ieee.h,v 1.6 2001/11/11 00:34:52 christos Exp $	*/
2 
3 /*
4  * Copyright (c) 1997, 1998, 1999
5  *	Bill Paul <wpaul@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  * $FreeBSD: src/sys/i386/include/if_wavelan_ieee.h,v 1.4 1999/12/29 04:33:01 peter Exp $
35  */
36 
37 #ifndef _IF_WAVELAN_IEEE_H
38 #define _IF_WAVELAN_IEEE_H
39 
40 /*
41  * FreeBSD driver ported to NetBSD by Bill Sommerfeld in the back of the
42  * Oslo IETF plenary meeting.
43  * The stuff in here should probably go into a generic extension to the
44  * ifmedia goop.
45  *
46  * Michael Graff brought over the encryption bits.
47  */
48 
49 /*
50  * This header defines a simple command interface to the FreeBSD
51  * WaveLAN/IEEE driver (wi) driver, which is used to set certain
52  * device-specific parameters which can't be easily managed through
53  * ifconfig(8). No, sysctl(2) is not the answer. I said a _simple_
54  * interface, didn't I.
55  */
56 
57 #ifndef SIOCSWAVELAN
58 #define SIOCSWAVELAN	SIOCSIFGENERIC
59 #endif
60 
61 #ifndef SIOCGWAVELAN
62 #define SIOCGWAVELAN	SIOCGIFGENERIC
63 #endif
64 
65 /*
66  * Technically I don't think there's a limit to a record
67  * length. The largest record is the one that contains the CIS
68  * data, which is 240 words long, so 256 should be a safe
69  * value.  But 512 is more safe?
70  */
71 #define WI_MAX_DATALEN	512
72 
73 struct wi_req {
74 	u_int16_t	wi_len;
75 	u_int16_t	wi_type;
76 	u_int16_t	wi_val[WI_MAX_DATALEN];
77 };
78 
79 #define WI_IOCTL_SET_SCAN		1
80 #define WI_IOCTL_GET_SCAN		2
81 #define WI_IOCTL_GET_SCAN_RESULTS	3
82 #define WI_IOCTL_SET_TESTMODE		4
83 #define WI_IOCTL_MGMT_XMIT		5
84 #define WI_IOCTL_IFACE_STATS		6
85 
86 /*
87  * Private LTV records (interpreted only by the driver). This is
88  * a minor kludge to allow reading the interface statistics from
89  * the driver.
90  */
91 #define WI_RID_IFACE_STATS	0x0100
92 #define WI_RID_MGMT_XMIT	0x0200
93 #ifdef WICACHE
94 #define WI_RID_ZERO_CACHE	0x0300
95 #define WI_RID_READ_CACHE	0x0400
96 #endif
97 
98 struct wi_80211_hdr {
99 	u_int16_t		frame_ctl;
100 	u_int16_t		dur_id;
101 	u_int8_t		addr1[6];
102 	u_int8_t		addr2[6];
103 	u_int8_t		addr3[6];
104 	u_int16_t		seq_ctl;
105 	u_int8_t		addr4[6];
106 };
107 
108 #define WI_FCTL_VERS		0x0002
109 #define WI_FCTL_FTYPE		0x000C
110 #define WI_FCTL_STYPE		0x00F0
111 #define WI_FCTL_TODS		0x0100
112 #define WI_FCTL_FROMDS		0x0200
113 #define WI_FCTL_MOREFRAGS	0x0400
114 #define WI_FCTL_RETRY		0x0800
115 #define WI_FCTL_PM		0x1000
116 #define WI_FCTL_MOREDATA	0x2000
117 #define WI_FCTL_WEP		0x4000
118 #define WI_FCTL_ORDER		0x8000
119 
120 #define WI_FTYPE_MGMT		0x0000
121 #define WI_FTYPE_CTL		0x0004
122 #define WI_FTYPE_DATA		0x0008
123 
124 #define WI_STYPE_MGMT_ASREQ	0x0000	/* association request */
125 #define WI_STYPE_MGMT_ASRESP	0x0010	/* association response */
126 #define WI_STYPE_MGMT_REASREQ	0x0020	/* reassociation request */
127 #define WI_STYPE_MGMT_REASRESP	0x0030	/* reassociation response */
128 #define WI_STYPE_MGMT_PROBEREQ	0x0040	/* probe request */
129 #define WI_STYPE_MGMT_PROBERESP	0x0050	/* probe response */
130 #define WI_STYPE_MGMT_BEACON	0x0080	/* beacon */
131 #define WI_STYPE_MGMT_ATIM	0x0090	/* announcement traffic ind msg */
132 #define WI_STYPE_MGMT_DISAS	0x00A0	/* disassociation */
133 #define WI_STYPE_MGMT_AUTH	0x00B0	/* authentication */
134 #define WI_STYPE_MGMT_DEAUTH	0x00C0	/* deauthentication */
135 
136 struct wi_mgmt_hdr {
137 	u_int16_t		frame_ctl;
138 	u_int16_t		duration;
139 	u_int8_t		dst_addr[6];
140 	u_int8_t		src_addr[6];
141 	u_int8_t		bssid[6];
142 	u_int16_t		seq_ctl;
143 };
144 
145 /*
146  * Lucent/wavelan IEEE signal strength cache
147  *
148  * driver keeps cache of last
149  * MAXWICACHE packets to arrive including signal strength info.
150  * daemons may read this via ioctl
151  *
152  * Each entry in the wi_sigcache has a unique macsrc.
153  */
154 #ifdef WICACHE
155 #define	MAXWICACHE	10
156 
157 struct wi_sigcache {
158 	char	macsrc[6];	/* unique MAC address for entry */
159 	int	ipsrc;		/* ip address associated with packet */
160 	int	signal;		/* signal strength of the packet */
161 	int	noise;		/* noise value */
162 	int	quality;	/* quality of the packet */
163 };
164 #endif
165 
166 struct wi_counters {
167 	u_int32_t		wi_tx_unicast_frames;
168 	u_int32_t		wi_tx_multicast_frames;
169 	u_int32_t		wi_tx_fragments;
170 	u_int32_t		wi_tx_unicast_octets;
171 	u_int32_t		wi_tx_multicast_octets;
172 	u_int32_t		wi_tx_deferred_xmits;
173 	u_int32_t		wi_tx_single_retries;
174 	u_int32_t		wi_tx_multi_retries;
175 	u_int32_t		wi_tx_retry_limit;
176 	u_int32_t		wi_tx_discards;
177 	u_int32_t		wi_rx_unicast_frames;
178 	u_int32_t		wi_rx_multicast_frames;
179 	u_int32_t		wi_rx_fragments;
180 	u_int32_t		wi_rx_unicast_octets;
181 	u_int32_t		wi_rx_multicast_octets;
182 	u_int32_t		wi_rx_fcs_errors;
183 	u_int32_t		wi_rx_discards_nobuf;
184 	u_int32_t		wi_tx_discards_wrong_sa;
185 	u_int32_t		wi_rx_WEP_cant_decrypt;
186 	u_int32_t		wi_rx_msg_in_msg_frags;
187 	u_int32_t		wi_rx_msg_in_bad_msg_frags;
188 };
189 
190 /*
191  * results of last ap scan
192  */
193 #define WI_SCAN_RESULTS_MAXLEN	512
194 struct wi_scan_results {
195 	int			truncated;	/* incomplete data in result */
196 	u_int			scanning;	/* in hz units */
197 	struct timeval		lastscan;	/* time scan was completed */
198 	u_int16_t		len;		/* number of words */
199 	u_int16_t		scan_results[WI_SCAN_RESULTS_MAXLEN];
200 };
201 
202 /*
203  * Network parameters, static configuration entities.
204  */
205 #define WI_RID_PORTTYPE		0xFC00 /* Connection control characteristics */
206 #define WI_RID_MAC_NODE		0xFC01 /* MAC address of this station */
207 #define WI_RID_DESIRED_SSID	0xFC02 /* Service Set ID for connection */
208 #define WI_RID_OWN_CHNL		0xFC03 /* Comm channel for BSS creation */
209 #define WI_RID_OWN_SSID		0xFC04 /* IBSS creation ID */
210 #define WI_RID_OWN_ATIM_WIN	0xFC05 /* ATIM window time for IBSS creation */
211 #define WI_RID_SYSTEM_SCALE	0xFC06 /* scale that specifies AP density */
212 #define WI_RID_MAX_DATALEN	0xFC07 /* Max len of MAC frame body data */
213 #define WI_RID_MAC_WDS		0xFC08 /* MAC addr of corresponding WDS node */
214 #define WI_RID_PM_ENABLED	0xFC09 /* ESS power management enable */
215 #define WI_RID_PM_EPS		0xFC0A /* PM EPS/PS mode */
216 #define WI_RID_MCAST_RX		0xFC0B /* ESS PM mcast reception */
217 #define WI_RID_MAX_SLEEP	0xFC0C /* max sleep time for ESS PM */
218 #define WI_RID_HOLDOVER		0xFC0D /* holdover time for ESS PM */
219 #define WI_RID_NODENAME		0xFC0E /* ID name of this node for diag */
220 #define WI_RID_DTIM_PERIOD	0xFC10 /* beacon interval between DTIMs */
221 #define WI_RID_WDS_ADDR1	0xFC11 /* port 1 MAC of WDS link node */
222 #define WI_RID_WDS_ADDR2	0xFC12 /* port 1 MAC of WDS link node */
223 #define WI_RID_WDS_ADDR3	0xFC13 /* port 1 MAC of WDS link node */
224 #define WI_RID_WDS_ADDR4	0xFC14 /* port 1 MAC of WDS link node */
225 #define WI_RID_WDS_ADDR5	0xFC15 /* port 1 MAC of WDS link node */
226 #define WI_RID_WDS_ADDR6	0xFC16 /* port 1 MAC of WDS link node */
227 #define WI_RID_MCAST_PM_BUF	0xFC17 /* PM buffering of mcast */
228 #define WI_RID_ENCRYPTION	0xFC20 /* enable/disable WEP */
229 #define WI_RID_AUTHTYPE		0xFC21 /* specify authentication type */
230 #define WI_RID_P2_TX_CRYPT_KEY	0xFC23
231 #define WI_RID_P2_CRYPT_KEY0	0xFC24
232 #define WI_RID_P2_CRYPT_KEY1	0xFC25
233 #define WI_RID_MICROWAVE_OVEN	0xFC25
234 #define WI_RID_P2_CRYPT_KEY2	0xFC26
235 #define WI_RID_P2_CRYPT_KEY3	0xFC27
236 #define WI_RID_P2_ENCRYPTION	0xFC28
237 #define WI_RID_WEP_MAPTABLE	0xFC29
238 #define WI_RID_AUTH_CNTL	0xFC2A
239 #define WI_RID_ROAMING_MODE	0xFC2D
240 #define WI_RID_BASIC_RATE	0xFCB3
241 #define WI_RID_SUPPORT_RATE	0xFCB4
242 
243 /*
244  * Network parameters, dynamic configuration entities
245  */
246 #define WI_RID_MCAST_LIST	0xFC80 /* multicast addrs to put in filter */
247 #define WI_RID_CREATE_IBSS	0xFC81 /* create IBSS */
248 #define WI_RID_FRAG_THRESH	0xFC82 /* frag len, unicast msg xmit */
249 #define WI_RID_RTS_THRESH	0xFC83 /* frame len for RTS/CTS handshake */
250 #define WI_RID_TX_RATE		0xFC84 /* data rate for message xmit
251  					* 0 == Fixed 1mbps
252  					* 1 == Fixed 2mbps
253  					* 2 == auto fallback
254 					*/
255 #define WI_RID_PROMISC		0xFC85 /* enable promisc mode */
256 #define WI_RID_FRAG_THRESH0	0xFC90
257 #define WI_RID_FRAG_THRESH1	0xFC91
258 #define WI_RID_FRAG_THRESH2	0xFC92
259 #define WI_RID_FRAG_THRESH3	0xFC93
260 #define WI_RID_FRAG_THRESH4	0xFC94
261 #define WI_RID_FRAG_THRESH5	0xFC95
262 #define WI_RID_FRAG_THRESH6	0xFC96
263 #define WI_RID_RTS_THRESH0	0xFC97
264 #define WI_RID_RTS_THRESH1	0xFC98
265 #define WI_RID_RTS_THRESH2	0xFC99
266 #define WI_RID_RTS_THRESH3	0xFC9A
267 #define WI_RID_RTS_THRESH4	0xFC9B
268 #define WI_RID_RTS_THRESH5	0xFC9C
269 #define WI_RID_RTS_THRESH6	0xFC9D
270 #define WI_RID_TX_RATE0		0xFC9E
271 #define WI_RID_TX_RATE1		0xFC9F
272 #define WI_RID_TX_RATE2		0xFCA0
273 #define WI_RID_TX_RATE3		0xFCA1
274 #define WI_RID_TX_RATE4		0xFCA2
275 #define WI_RID_TX_RATE5		0xFCA3
276 #define WI_RID_TX_RATE6		0xFCA4
277 #define WI_RID_DEFLT_CRYPT_KEYS	0xFCB0
278 #define WI_RID_TX_CRYPT_KEY	0xFCB1
279 #define WI_RID_TICK_TIME	0xFCE0 	/* Auxiliary Timer tick interval */
280 #define WI_RID_SCAN_REQ		0xFCE1
281 #define WI_RID_JOIN_REQ		0xFCE2
282 
283 struct wi_key {
284 	u_int16_t		wi_keylen;
285 	u_int8_t		wi_keydat[14];
286 };
287 
288 struct wi_ltv_keys {
289 	u_int16_t		wi_len;
290 	u_int16_t		wi_type;
291 	struct wi_key		wi_keys[4];
292 };
293 
294 /*
295  * NIC information
296  */
297 #define WI_RID_DNLD_BUF		0xFD01
298 #define WI_RID_MEMSZ		0xFD02 /* memory size info */
299 #define WI_RID_PRI_SUP_RANGE	0xFD03 /* primary supplier compatibility */
300 #define WI_RID_CIF_ACT_RANGE	0xFD04 /* controller sup. compatibility */
301 #define WI_RID_SERIALNO		0xFD0A /* card serial number */
302 #define WI_RID_CARD_ID		0xFD0B /* card identification */
303 #define WI_RID_MFI_SUP_RANGE	0xFD0C /* modem supplier compatibility */
304 #define WI_RID_CFI_SUP_RANGE	0xFD0D /* controller sup. compatibility */
305 #define WI_RID_CHANNEL_LIST	0xFD10 /* allowd comm. frequencies. */
306 #define WI_RID_REG_DOMAINS	0xFD11 /* list of intendted regulatory doms */
307 #define WI_RID_TEMP_TYPE	0xFD12 /* hw temp range code */
308 #define WI_RID_CIS		0xFD13 /* PC card info struct */
309 #define WI_RID_STA_IDENTITY	0xFD20 /* station funcs firmware ident */
310 #define WI_RID_STA_SUP_RANGE	0xFD21 /* station supplier compat */
311 #define WI_RID_MFI_ACT_RANGE	0xFD22
312 #define WI_RID_CFI_ACT_RANGE	0xFD33
313 #define WI_RID_COMMQUAL		0xFD43
314 #define WI_RID_SCALETHRESH	0xFD46
315 #define WI_RID_PCF		0xFD87
316 
317 /*
318  * MAC information
319  */
320 #define WI_RID_PORT_STAT	0xFD40 /* actual MAC port con control stat */
321 #define WI_RID_CURRENT_SSID	0xFD41 /* ID of actually connected SS */
322 #define WI_RID_CURRENT_BSSID	0xFD42 /* ID of actually connected BSS */
323 #define WI_RID_COMMS_QUALITY	0xFD43 /* quality of BSS connection */
324 #define WI_RID_CUR_TX_RATE	0xFD44 /* current TX rate */
325 #define WI_RID_OWN_BEACON_INT	0xFD45 /* beacon xmit time for BSS creation */
326 #define WI_RID_CUR_SCALE_THRESH	0xFD46 /* actual system scane thresh setting */
327 #define WI_RID_PROT_RESP_TIME	0xFD47 /* time to wait for resp to req msg */
328 #define WI_RID_SHORT_RTR_LIM	0xFD48 /* max tx attempts for short frames */
329 #define WI_RID_LONG_RTS_LIM	0xFD49 /* max tx attempts for long frames */
330 #define WI_RID_MAX_TX_LIFE	0xFD4A /* max tx frame handling duration */
331 #define WI_RID_MAX_RX_LIFE	0xFD4B /* max rx frame handling duration */
332 #define WI_RID_CF_POLL		0xFD4C /* contention free pollable ind */
333 #define WI_RID_AUTH_ALGS	0xFD4D /* auth algorithms available */
334 #define WI_RID_AUTH_TYPE	0xFD4E /* available auth types */
335 #define WI_RID_WEP_AVAIL	0xFD4F /* WEP privacy option available */
336 #define WI_RID_CUR_TX_RATE1	0xFD80
337 #define WI_RID_CUR_TX_RATE2	0xFD81
338 #define WI_RID_CUR_TX_RATE3	0xFD82
339 #define WI_RID_CUR_TX_RATE4	0xFD83
340 #define WI_RID_CUR_TX_RATE5	0xFD84
341 #define WI_RID_CUR_TX_RATE6	0xFD85
342 #define WI_RID_OWN_MAC		0xFD86 /* unique local MAC addr */
343 #define WI_RID_PCI_INFO		0xFD87 /* point coordination func cap */
344 
345 /*
346  * Modem information
347  */
348 #define WI_RID_PHY_TYPE		0xFDC0 /* phys layer type indication */
349 #define WI_RID_CURRENT_CHAN	0xFDC1 /* current frequency */
350 #define WI_RID_PWR_STATE	0xFDC2 /* pwr consumption status */
351 #define WI_RID_CCA_MODE		0xFDC3 /* clear chan assess mode indication */
352 #define WI_RID_CCA_TIME		0xFDC4 /* clear chan assess time */
353 #define WI_RID_MAC_PROC_DELAY	0xFDC5 /* MAC processing delay time */
354 #define WI_RID_DATA_RATES	0xFDC6 /* supported data rates */
355 
356 #endif
357