xref: /freebsd/sys/dev/iwi/if_iwivar.h (revision f0a75d274af375d15b97b830966b99a02b7db911)
1 /*	$FreeBSD$	*/
2 
3 /*-
4  * Copyright (c) 2004, 2005
5  *      Damien Bergamini <damien.bergamini@free.fr>. 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 unmodified, this list of conditions, and the following
12  *    disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 struct iwi_rx_radiotap_header {
31 	struct ieee80211_radiotap_header wr_ihdr;
32 	uint8_t		wr_flags;
33 	uint8_t		wr_rate;
34 	uint16_t	wr_chan_freq;
35 	uint16_t	wr_chan_flags;
36 	uint8_t		wr_antsignal;
37 	uint8_t		wr_antenna;
38 };
39 
40 #define IWI_RX_RADIOTAP_PRESENT						\
41 	((1 << IEEE80211_RADIOTAP_FLAGS) |				\
42 	 (1 << IEEE80211_RADIOTAP_RATE) |				\
43 	 (1 << IEEE80211_RADIOTAP_CHANNEL) |				\
44 	 (1 << IEEE80211_RADIOTAP_DB_ANTSIGNAL) |			\
45 	 (1 << IEEE80211_RADIOTAP_ANTENNA))
46 
47 struct iwi_tx_radiotap_header {
48 	struct ieee80211_radiotap_header wt_ihdr;
49 	uint8_t		wt_flags;
50 	uint16_t	wt_chan_freq;
51 	uint16_t	wt_chan_flags;
52 };
53 
54 #define IWI_TX_RADIOTAP_PRESENT						\
55 	((1 << IEEE80211_RADIOTAP_FLAGS) |				\
56 	 (1 << IEEE80211_RADIOTAP_CHANNEL))
57 
58 struct iwi_cmd_ring {
59 	bus_dma_tag_t		desc_dmat;
60 	bus_dmamap_t		desc_map;
61 	bus_addr_t		physaddr;
62 	struct iwi_cmd_desc	*desc;
63 	int			count;
64 	int			queued;
65 	int			cur;
66 	int			next;
67 };
68 
69 struct iwi_tx_data {
70 	bus_dmamap_t		map;
71 	struct mbuf		*m;
72 	struct ieee80211_node	*ni;
73 };
74 
75 struct iwi_tx_ring {
76 	bus_dma_tag_t		desc_dmat;
77 	bus_dma_tag_t		data_dmat;
78 	bus_dmamap_t		desc_map;
79 	bus_addr_t		physaddr;
80 	bus_addr_t		csr_ridx;
81 	bus_addr_t		csr_widx;
82 	struct iwi_tx_desc	*desc;
83 	struct iwi_tx_data	*data;
84 	int			count;
85 	int			queued;
86 	int			cur;
87 	int			next;
88 };
89 
90 struct iwi_rx_data {
91 	bus_dmamap_t	map;
92 	bus_addr_t	physaddr;
93 	uint32_t	reg;
94 	struct mbuf	*m;
95 };
96 
97 struct iwi_rx_ring {
98 	bus_dma_tag_t		data_dmat;
99 	struct iwi_rx_data	*data;
100 	int			count;
101 	int			cur;
102 };
103 
104 struct iwi_node {
105 	struct ieee80211_node	in_node;
106 	int			in_station;
107 #define IWI_MAX_IBSSNODE	32
108 };
109 
110 struct iwi_fw {
111 	const struct firmware	*fp;		/* image handle */
112 	const char		*data;		/* firmware image data */
113 	size_t			size;		/* firmware image size */
114 	const char		*name;		/* associated image name */
115 };
116 
117 struct iwi_softc {
118 	struct ifnet		*sc_ifp;
119 	struct ieee80211com	sc_ic;
120 	int			(*sc_newstate)(struct ieee80211com *,
121 				    enum ieee80211_state, int);
122 	void			(*sc_node_free)(struct ieee80211_node *);
123 	device_t		sc_dev;
124 
125 	struct mtx		sc_mtx;
126 	uint8_t			sc_mcast[IEEE80211_ADDR_LEN];
127 	struct unrhdr		*sc_unr;
128 	struct taskqueue	*sc_tq;		/* private task queue */
129 #if __FreeBSD_version < 700000
130 	struct proc		*sc_tqproc;
131 #endif
132 
133 	uint32_t		flags;
134 #define IWI_FLAG_FW_INITED	(1 << 0)
135 #define IWI_FLAG_SCANNING	(1 << 1)
136 #define	IWI_FLAG_FW_LOADING	(1 << 2)
137 #define	IWI_FLAG_BUSY		(1 << 3)	/* busy sending a command */
138 #define	IWI_FLAG_ASSOCIATED	(1 << 4)	/* currently associated  */
139 
140 	struct iwi_cmd_ring	cmdq;
141 	struct iwi_tx_ring	txq[WME_NUM_AC];
142 	struct iwi_rx_ring	rxq;
143 
144 	struct resource		*irq;
145 	struct resource		*mem;
146 	bus_space_tag_t		sc_st;
147 	bus_space_handle_t	sc_sh;
148 	void 			*sc_ih;
149 	int			mem_rid;
150 	int			irq_rid;
151 
152 	/*
153 	 * The card needs external firmware images to work, which is made of a
154 	 * bootloader, microcode and firmware proper. In version 3.00 and
155 	 * above, all pieces are contained in a single image, preceded by a
156 	 * struct iwi_firmware_hdr indicating the size of the 3 pieces.
157 	 * Old firmware < 3.0 has separate boot and ucode, so we need to
158 	 * load all of them explicitly.
159 	 * To avoid issues related to fragmentation, we keep the block of
160 	 * dma-ble memory around until detach time, and reallocate it when
161 	 * it becomes too small. fw_dma_size is the size currently allocated.
162 	 */
163 	int			fw_dma_size;
164 	uint32_t		fw_flags;	/* allocation status */
165 #define	IWI_FW_HAVE_DMAT	0x01
166 #define	IWI_FW_HAVE_MAP		0x02
167 #define	IWI_FW_HAVE_PHY		0x04
168 	bus_dma_tag_t		fw_dmat;
169 	bus_dmamap_t		fw_map;
170 	bus_addr_t		fw_physaddr;
171 	void			*fw_virtaddr;
172 	enum ieee80211_opmode	fw_mode;	/* mode of current firmware */
173 	struct iwi_fw		fw_boot;	/* boot firmware */
174 	struct iwi_fw		fw_uc;		/* microcode */
175 	struct iwi_fw		fw_fw;		/* operating mode support */
176 
177 	int			curchan;	/* current h/w channel # */
178 	int			antenna;
179 	int			dwelltime;
180 	int			bluetooth;
181 	struct iwi_associate	assoc;
182 	struct iwi_wme_params	wme[3];
183 
184 	struct task		sc_radiontask;	/* radio on processing */
185 	struct task		sc_radiofftask;	/* radio off processing */
186 	struct task		sc_scanstarttask;/* scan start processing */
187 	struct task		sc_scanaborttask;/* scan abort processing */
188 	struct task		sc_scandonetask;/* scan completed processing */
189 	struct task		sc_scantask;	/* scan channel processing */
190 	struct task		sc_setwmetask;	/* set wme params processing */
191 	struct task		sc_downtask;	/* disassociate processing */
192 	struct task		sc_restarttask;	/* restart adapter processing */
193 
194 	unsigned int		sc_softled : 1,	/* enable LED gpio status */
195 				sc_ledstate: 1,	/* LED on/off state */
196 				sc_blinking: 1;	/* LED blink operation active */
197 	u_int			sc_nictype;	/* NIC type from EEPROM */
198 	u_int			sc_ledpin;	/* mask for activity LED */
199 	u_int			sc_ledidle;	/* idle polling interval */
200 	int			sc_ledevent;	/* time of last LED event */
201 	u_int8_t		sc_rxrate;	/* current rx rate for LED */
202 	u_int8_t		sc_rxrix;
203 	u_int8_t		sc_txrate;	/* current tx rate for LED */
204 	u_int8_t		sc_txrix;
205 	u_int16_t		sc_ledoff;	/* off time for current blink */
206 	struct callout		sc_ledtimer;	/* led off timer */
207 
208 	int			sc_tx_timer;
209 	int			sc_rfkill_timer;/* poll for rfkill change */
210 	int			sc_scan_timer;	/* scan request timeout */
211 
212 	struct bpf_if		*sc_drvbpf;
213 
214 	union {
215 		struct iwi_rx_radiotap_header th;
216 		uint8_t	pad[64];
217 	}			sc_rxtapu;
218 #define sc_rxtap	sc_rxtapu.th
219 	int			sc_rxtap_len;
220 
221 	union {
222 		struct iwi_tx_radiotap_header th;
223 		uint8_t	pad[64];
224 	}			sc_txtapu;
225 #define sc_txtap	sc_txtapu.th
226 	int			sc_txtap_len;
227 };
228 
229 /*
230  * NB.: This models the only instance of async locking in iwi_init_locked
231  *	and must be kept in sync.
232  */
233 #define	IWI_LOCK_DECL	int	__waslocked = 0
234 #define IWI_LOCK_CHECK(sc)	do {				\
235 	if (!mtx_owned(&(sc)->sc_mtx))	\
236 		DPRINTF(("%s iwi_lock not held\n", __func__));		\
237 } while (0)
238 #define IWI_LOCK(sc)	do {				\
239 	if (!(__waslocked = mtx_owned(&(sc)->sc_mtx)))	\
240 		mtx_lock(&(sc)->sc_mtx);		\
241 } while (0)
242 #define IWI_UNLOCK(sc)	do {			\
243 	if (!__waslocked)			\
244 		mtx_unlock(&(sc)->sc_mtx);	\
245 } while (0)
246