71fb8f65db09cff874fb10d0c1bce27a0f9153f0
[dragonfly.git] / sys / dev / netif / wi / if_wivar.h
1 /*-
2  * Copyright (c) 2002
3  *      M Warner Losh <imp@freebsd.org>.  All rights reserved.
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: head/sys/dev/wi/if_wivar.h 194023 2009-06-11 17:14:28Z avg $
35  */
36
37 /*
38  * Encryption controls. We can enable or disable encryption as
39  * well as specify up to 4 encryption keys. We can also specify
40  * which of the four keys will be used for transmit encryption.
41  */
42 #define WI_RID_ENCRYPTION       0xFC20
43 #define WI_RID_AUTHTYPE         0xFC21
44 #define WI_RID_DEFLT_CRYPT_KEYS 0xFCB0
45 #define WI_RID_TX_CRYPT_KEY     0xFCB1
46 #define WI_RID_WEP_AVAIL        0xFD4F
47 #define WI_RID_P2_TX_CRYPT_KEY  0xFC23
48 #define WI_RID_P2_CRYPT_KEY0    0xFC24
49 #define WI_RID_P2_CRYPT_KEY1    0xFC25
50 #define WI_RID_MICROWAVE_OVEN   0xFC25
51 #define WI_RID_P2_CRYPT_KEY2    0xFC26
52 #define WI_RID_P2_CRYPT_KEY3    0xFC27
53 #define WI_RID_P2_ENCRYPTION    0xFC28
54 #define WI_RID_ROAMING_MODE     0xFC2D
55 #define WI_RID_CUR_TX_RATE      0xFD44 /* current TX rate */
56
57 #define WI_MAX_AID              256     /* max stations for ap operation */
58
59 struct wi_vap {
60         struct ieee80211vap     wv_vap;
61         struct ieee80211_beacon_offsets wv_bo;
62
63         void            (*wv_recv_mgmt)(struct ieee80211_node *, struct mbuf *,
64                             int, int, int);
65         int             (*wv_newstate)(struct ieee80211vap *,
66                             enum ieee80211_state, int);
67 };
68 #define WI_VAP(vap)             ((struct wi_vap *)(vap))
69
70 struct wi_softc {
71         struct arpcom           arpcom;
72         struct ifnet            *sc_ifp;
73         device_t                sc_dev;
74         struct callout          sc_watchdog;
75         int                     sc_unit;
76         int                     wi_gone;
77         int                     sc_enabled;
78         int                     sc_reset;
79         int                     sc_firmware_type;
80 #define WI_NOTYPE       0
81 #define WI_LUCENT       1
82 #define WI_INTERSIL     2
83 #define WI_SYMBOL       3
84         int                     sc_pri_firmware_ver;    /* Primary firmware */
85         int                     sc_sta_firmware_ver;    /* Station firmware */
86         unsigned int            sc_nic_id;              /* Type of NIC */
87         char *                  sc_nic_name;
88
89         int                     wi_bus_type;    /* Bus attachment type */
90         struct resource *       local;
91         int                     local_rid;
92         struct resource *       iobase;
93         int                     iobase_rid;
94         struct resource *       irq;
95         int                     irq_rid;
96         struct resource *       mem;
97         int                     mem_rid;
98         bus_space_handle_t      wi_localhandle;
99         bus_space_tag_t         wi_localtag;
100         bus_space_handle_t      wi_bhandle;
101         bus_space_tag_t         wi_btag;
102         bus_space_handle_t      wi_bmemhandle;
103         bus_space_tag_t         wi_bmemtag;
104         void *                  wi_intrhand;
105         struct ieee80211_channel *wi_channel;
106         int                     wi_io_addr;
107         int                     wi_cmd_count;
108
109         int                     sc_flags;
110         int                     sc_if_flags;
111         int                     sc_bap_id;
112         int                     sc_bap_off;
113
114         int                     sc_porttype;
115         u_int16_t               sc_portnum;
116         u_int16_t               sc_encryption;
117         u_int16_t               sc_monitor_port;
118
119         /* RSSI interpretation */
120         u_int16_t               sc_min_rssi;    /* clamp sc_min_rssi < RSSI */
121         u_int16_t               sc_max_rssi;    /* clamp RSSI < sc_max_rssi */
122         u_int16_t               sc_dbm_offset;  /* dBm ~ RSSI - sc_dbm_offset */
123
124         int                     sc_buflen;              /* TX buffer size */
125         int                     sc_ntxbuf;
126 #define WI_NTXBUF       3
127         struct {
128                 int             d_fid;
129                 int             d_len;
130         }                       sc_txd[WI_NTXBUF];      /* TX buffers */
131         int                     sc_txnext;              /* index of next TX */
132         int                     sc_txcur;               /* index of current TX*/
133         int                     sc_tx_timer;
134
135         struct wi_counters      sc_stats;
136         u_int16_t               sc_ibss_port;
137
138         struct timeval          sc_last_syn;
139         int                     sc_false_syns;
140
141         u_int16_t               sc_txbuf[IEEE80211_MAX_LEN/2];
142
143         struct wi_tx_radiotap_header sc_tx_th;
144         struct wi_rx_radiotap_header sc_rx_th;
145
146         struct sysctl_ctx_list  sc_sysctl_ctx;
147 };
148
149 /* maximum consecutive false change-of-BSSID indications */
150 #define WI_MAX_FALSE_SYNS               10      
151
152 #define WI_FLAGS_HAS_ENHSECURITY        0x0001
153 #define WI_FLAGS_HAS_WPASUPPORT         0x0002
154 #define WI_FLAGS_HAS_ROAMING            0x0020
155 #define WI_FLAGS_HAS_FRAGTHR            0x0200
156 #define WI_FLAGS_HAS_DBMADJUST          0x0400
157
158 struct wi_card_ident {
159         u_int16_t       card_id;
160         char            *card_name;
161         u_int8_t        firm_type;
162 };
163
164 #define WI_PRISM_MIN_RSSI       0x1b
165 #define WI_PRISM_MAX_RSSI       0x9a
166 #define WI_PRISM_DBM_OFFSET     100 /* XXX */
167
168 #define WI_LUCENT_MIN_RSSI      47
169 #define WI_LUCENT_MAX_RSSI      138
170 #define WI_LUCENT_DBM_OFFSET    149
171
172 #define WI_RSSI_TO_DBM(sc, rssi) (MIN((sc)->sc_max_rssi, \
173     MAX((sc)->sc_min_rssi, (rssi))) - (sc)->sc_dbm_offset)
174
175 int     wi_attach(device_t);
176 int     wi_detach(device_t);
177 int     wi_shutdown(device_t);
178 int     wi_alloc(device_t, int);
179 void    wi_free(device_t);
180 extern devclass_t wi_devclass;
181 void    wi_init(void *);
182 void    wi_intr(void *);
183 int     wi_mgmt_xmit(struct wi_softc *, caddr_t, int);
184 void    wi_stop(struct wi_softc *, int);