Home | History | Annotate | Line # | Download | only in ic
wivar.h revision 1.41
      1 /*	$NetBSD: wivar.h,v 1.41 2003/12/07 05:44:49 dyoung 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 /* Radio capture format for Prism. */
     36 
     37 #define WI_RX_RADIOTAP_PRESENT	((1 << IEEE80211_RADIOTAP_FLAGS) | \
     38 				 (1 << IEEE80211_RADIOTAP_RATE) | \
     39 				 (1 << IEEE80211_RADIOTAP_CHANNEL) | \
     40 				 (1 << IEEE80211_RADIOTAP_DBM_ANTSIGNAL) | \
     41 				 (1 << IEEE80211_RADIOTAP_DBM_ANTNOISE))
     42 
     43 struct wi_rx_radiotap_header {
     44 	struct ieee80211_radiotap_header	wr_ihdr;
     45 	u_int8_t				wr_flags;
     46 	u_int8_t				wr_rate;
     47 	u_int16_t				wr_chan_freq;
     48 	u_int16_t				wr_chan_flags;
     49 	int8_t					wr_antsignal;
     50 	int8_t					wr_antnoise;
     51 } __attribute__((__packed__));
     52 
     53 #define WI_TX_RADIOTAP_PRESENT	((1 << IEEE80211_RADIOTAP_FLAGS) | \
     54 				 (1 << IEEE80211_RADIOTAP_RATE) | \
     55 				 (1 << IEEE80211_RADIOTAP_CHANNEL))
     56 
     57 struct wi_tx_radiotap_header {
     58 	struct ieee80211_radiotap_header	wt_ihdr;
     59 	u_int8_t				wt_flags;
     60 	u_int8_t				wt_rate;
     61 	u_int16_t				wt_chan_freq;
     62 	u_int16_t				wt_chan_flags;
     63 } __attribute__((__packed__));
     64 
     65 /*
     66  * FreeBSD driver ported to NetBSD by Bill Sommerfeld in the back of the
     67  * Oslo IETF plenary meeting.
     68  */
     69 struct wi_softc	{
     70 	struct device		sc_dev;
     71 	struct ieee80211com	sc_ic;
     72 	void			*sc_ih;		/* interrupt handler */
     73 	int			(*sc_enable)(struct wi_softc *);
     74 	void			(*sc_disable)(struct wi_softc *);
     75 	void			(*sc_reset)(struct wi_softc *);
     76 
     77 	int			(*sc_newstate)(struct ieee80211com *,
     78 				    enum ieee80211_state, int);
     79 
     80 	int			sc_attached;
     81 	int			sc_enabled;
     82 	int			sc_invalid;
     83 	int			sc_firmware_type;
     84 #define	WI_NOTYPE	0
     85 #define	WI_LUCENT	1
     86 #define	WI_INTERSIL	2
     87 #define	WI_SYMBOL	3
     88 	int			sc_pri_firmware_ver;	/* Primary firm vers */
     89 	int			sc_sta_firmware_ver;	/* Station firm vers */
     90 	int			sc_pci;			/* attach to PCI-Bus */
     91 
     92 	bus_space_tag_t		sc_iot;			/* bus cookie */
     93 	bus_space_handle_t	sc_ioh;			/* bus i/o handle */
     94 
     95 	caddr_t			sc_drvbpf;
     96 	int			sc_flags;
     97 	int			sc_bap_id;
     98 	int			sc_bap_off;
     99 
    100 	u_int16_t		sc_portnum;
    101 
    102 	/* RSSI interpretation */
    103 	u_int16_t		sc_dbm_offset;	/* dBm ~ RSSI - sc_dbm_offset */
    104 	u_int16_t		sc_max_datalen;
    105 	u_int16_t		sc_frag_thresh;
    106 	u_int16_t		sc_rts_thresh;
    107 	u_int16_t		sc_system_scale;
    108 	u_int16_t		sc_tx_rate;
    109 	u_int16_t		sc_cnfauthmode;
    110 	u_int16_t		sc_roaming_mode;
    111 	u_int16_t		sc_microwave_oven;
    112 
    113 	int			sc_nodelen;
    114 	char			sc_nodename[IEEE80211_NWID_LEN];
    115 
    116 	int			sc_buflen;
    117 #define	WI_NTXBUF	3
    118 #define	WI_NTXRSS	10
    119 	struct sc_txdesc {
    120 		int				d_fid;
    121 		int				d_len;
    122 		int				d_rate;
    123 	}			sc_txd[WI_NTXBUF];
    124 	int			sc_txnext;
    125 	int			sc_txcur;
    126 	struct wi_rssdesc {
    127 		struct ieee80211_rssdesc	rd_desc;
    128 		SLIST_ENTRY(wi_rssdesc)		rd_next;
    129 	}			sc_rssd[WI_NTXRSS];
    130 	SLIST_HEAD(,wi_rssdesc)	sc_rssdfree;
    131 	int			sc_tx_timer;
    132 	int			sc_scan_timer;
    133 	int			sc_syn_timer;
    134 
    135 	struct wi_counters	sc_stats;
    136 	u_int16_t		sc_ibss_port;
    137 
    138 	struct wi_apinfo	sc_aps[MAXAPINFO];
    139 	int 			sc_naps;
    140 
    141 	int			sc_false_syns;
    142 	int			sc_alt_retry;
    143 
    144 	union {
    145 		struct wi_rx_radiotap_header	tap;
    146 		u_int8_t			pad[64];
    147 	} sc_rxtapu;
    148 	union {
    149 		struct wi_tx_radiotap_header	tap;
    150 		u_int8_t			pad[64];
    151 	} sc_txtapu;
    152 	u_int16_t		sc_txbuf[IEEE80211_MAX_LEN/2];
    153 	/* number of transmissions pending at each data rate */
    154 	u_int8_t		sc_txpending[IEEE80211_RATE_MAXSIZE];
    155 	struct callout		sc_rssadapt_ch;
    156 };
    157 
    158 #define sc_rxtap	sc_rxtapu.tap
    159 #define sc_txtap	sc_txtapu.tap
    160 
    161 #define	sc_if			sc_ic.ic_if
    162 
    163 struct wi_node {
    164 	struct ieee80211_node		wn_node;
    165 	struct ieee80211_rssadapt	wn_rssadapt;
    166 };
    167 
    168 /* maximum consecutive false change-of-BSSID indications */
    169 #define	WI_MAX_FALSE_SYNS		10
    170 
    171 #define	WI_PRISM_DBM_OFFSET	100	/* XXX */
    172 
    173 #define	WI_LUCENT_DBM_OFFSET	149
    174 
    175 #define	WI_RSSI_TO_DBM(sc, rssi) ((rssi) - (sc)->sc_dbm_offset)
    176 
    177 #define	WI_SCAN_INQWAIT			3	/* wait sec before inquire */
    178 #define	WI_SCAN_WAIT			5	/* maximum scan wait */
    179 
    180 /* Values for wi_flags. */
    181 #define	WI_FLAGS_ATTACHED		0x0001
    182 #define	WI_FLAGS_INITIALIZED		0x0002
    183 #define	WI_FLAGS_OUTRANGE		0x0004
    184 #define	WI_FLAGS_RSSADAPT		0x0008
    185 #define	WI_FLAGS_HAS_MOR		0x0010
    186 #define	WI_FLAGS_HAS_ROAMING		0x0020
    187 #define	WI_FLAGS_HAS_DIVERSITY		0x0040
    188 #define	WI_FLAGS_HAS_SYSSCALE		0x0080
    189 #define	WI_FLAGS_BUG_AUTOINC		0x0100
    190 #define	WI_FLAGS_HAS_FRAGTHR		0x0200
    191 #define	WI_FLAGS_HAS_DBMADJUST		0x0400
    192 
    193 struct wi_card_ident {
    194 	u_int16_t	card_id;
    195 	char		*card_name;
    196 	u_int8_t	firm_type;
    197 };
    198 
    199 /*
    200  * register space access macros
    201  */
    202 #ifdef WI_AT_BIGENDIAN_BUS_HACK
    203 	/*
    204 	 * XXX - ugly hack for sparc bus_space_* macro deficiencies:
    205 	 *       assume the bus we are accessing is big endian.
    206 	 */
    207 
    208 #define CSR_WRITE_4(sc, reg, val)	\
    209 	bus_space_write_4(sc->sc_iot, sc->sc_ioh,	\
    210 			(sc->sc_pci? reg * 2: reg) , htole32(val))
    211 #define CSR_WRITE_2(sc, reg, val)	\
    212 	bus_space_write_2(sc->sc_iot, sc->sc_ioh,	\
    213 			(sc->sc_pci? reg * 2: reg), htole16(val))
    214 #define CSR_WRITE_1(sc, reg, val)	\
    215 	bus_space_write_1(sc->sc_iot, sc->sc_ioh,	\
    216 			(sc->sc_pci? reg * 2: reg), val)
    217 
    218 #define CSR_READ_4(sc, reg)		\
    219 	le32toh(bus_space_read_4(sc->sc_iot, sc->sc_ioh,	\
    220 			(sc->sc_pci? reg * 2: reg)))
    221 #define CSR_READ_2(sc, reg)		\
    222 	le16toh(bus_space_read_2(sc->sc_iot, sc->sc_ioh,	\
    223 			(sc->sc_pci? reg * 2: reg)))
    224 #define CSR_READ_1(sc, reg)		\
    225 	bus_space_read_1(sc->sc_iot, sc->sc_ioh,	\
    226 			(sc->sc_pci? reg * 2: reg))
    227 
    228 #else
    229 
    230 #define CSR_WRITE_4(sc, reg, val)	\
    231 	bus_space_write_4(sc->sc_iot, sc->sc_ioh,	\
    232 			(sc->sc_pci? reg * 2: reg) , val)
    233 #define CSR_WRITE_2(sc, reg, val)	\
    234 	bus_space_write_2(sc->sc_iot, sc->sc_ioh,	\
    235 			(sc->sc_pci? reg * 2: reg), val)
    236 #define CSR_WRITE_1(sc, reg, val)	\
    237 	bus_space_write_1(sc->sc_iot, sc->sc_ioh,	\
    238 			(sc->sc_pci? reg * 2: reg), val)
    239 
    240 #define CSR_READ_4(sc, reg)		\
    241 	bus_space_read_4(sc->sc_iot, sc->sc_ioh,	\
    242 			(sc->sc_pci? reg * 2: reg))
    243 #define CSR_READ_2(sc, reg)		\
    244 	bus_space_read_2(sc->sc_iot, sc->sc_ioh,	\
    245 			(sc->sc_pci? reg * 2: reg))
    246 #define CSR_READ_1(sc, reg)		\
    247 	bus_space_read_1(sc->sc_iot, sc->sc_ioh,	\
    248 			(sc->sc_pci? reg * 2: reg))
    249 #endif
    250 
    251 #ifndef __BUS_SPACE_HAS_STREAM_METHODS
    252 #define bus_space_write_stream_2	bus_space_write_2
    253 #define bus_space_write_multi_stream_2	bus_space_write_multi_2
    254 #define bus_space_read_stream_2		bus_space_read_2
    255 #define bus_space_read_multi_stream_2		bus_space_read_multi_2
    256 #endif
    257 
    258 #define CSR_WRITE_STREAM_2(sc, reg, val)	\
    259 	bus_space_write_stream_2(sc->sc_iot, sc->sc_ioh,	\
    260 			(sc->sc_pci? reg * 2: reg), val)
    261 #define CSR_WRITE_MULTI_STREAM_2(sc, reg, val, count)	\
    262 	bus_space_write_multi_stream_2(sc->sc_iot, sc->sc_ioh,	\
    263 			(sc->sc_pci? reg * 2: reg), val, count)
    264 #define CSR_READ_STREAM_2(sc, reg)		\
    265 	bus_space_read_stream_2(sc->sc_iot, sc->sc_ioh,	\
    266 			(sc->sc_pci? reg * 2: reg))
    267 #define CSR_READ_MULTI_STREAM_2(sc, reg, buf, count)		\
    268 	bus_space_read_multi_stream_2(sc->sc_iot, sc->sc_ioh,	\
    269 			(sc->sc_pci? reg * 2: reg), buf, count)
    270 
    271 
    272 int	wi_attach(struct wi_softc *);
    273 int	wi_detach(struct wi_softc *);
    274 int	wi_activate(struct device *, enum devact);
    275 int	wi_intr(void *arg);
    276 void	wi_power(struct wi_softc *, int);
    277 void	wi_shutdown(struct wi_softc *);
    278