xref: /freebsd/sys/dev/iwi/if_iwivar.h (revision db612abe8df3355d1eb23bb3b50fdd97bc21e979)
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_vap {
118 	struct ieee80211vap	iwi_vap;
119 	struct task		iwi_authsuccess_task;
120 	struct task		iwi_assocsuccess_task;
121 	struct task		iwi_assocfailed_task;
122 
123 	int			(*iwi_newstate)(struct ieee80211vap *,
124 				    enum ieee80211_state, int);
125 };
126 #define	IWI_VAP(vap)	((struct iwi_vap *)(vap))
127 
128 struct iwi_softc {
129 	struct ifnet		*sc_ifp;
130 	void			(*sc_node_free)(struct ieee80211_node *);
131 	device_t		sc_dev;
132 
133 	struct mtx		sc_mtx;
134 	struct mtx		sc_cmdlock;
135 	char			sc_cmdname[12];	/* e.g. "iwi0_cmd" */
136 	uint8_t			sc_mcast[IEEE80211_ADDR_LEN];
137 	struct unrhdr		*sc_unr;
138 	struct taskqueue	*sc_tq;		/* private task queue */
139 	struct taskqueue	*sc_tq2;	/* reset task queue */
140 
141 	uint32_t		flags;
142 #define IWI_FLAG_FW_INITED	(1 << 0)
143 #define	IWI_FLAG_BUSY		(1 << 3)	/* busy sending a command */
144 #define	IWI_FLAG_ASSOCIATED	(1 << 4)	/* currently associated  */
145 #define IWI_FLAG_CHANNEL_SCAN	(1 << 5)
146 	uint32_t		fw_state;
147 #define IWI_FW_IDLE		0
148 #define IWI_FW_LOADING		1
149 #define IWI_FW_ASSOCIATING	2
150 #define IWI_FW_DISASSOCIATING	3
151 #define IWI_FW_SCANNING		4
152 	struct iwi_cmd_ring	cmdq;
153 	struct iwi_tx_ring	txq[WME_NUM_AC];
154 	struct iwi_rx_ring	rxq;
155 
156 	struct resource		*irq;
157 	struct resource		*mem;
158 	bus_space_tag_t		sc_st;
159 	bus_space_handle_t	sc_sh;
160 	void 			*sc_ih;
161 	int			mem_rid;
162 	int			irq_rid;
163 
164 	/*
165 	 * The card needs external firmware images to work, which is made of a
166 	 * bootloader, microcode and firmware proper. In version 3.00 and
167 	 * above, all pieces are contained in a single image, preceded by a
168 	 * struct iwi_firmware_hdr indicating the size of the 3 pieces.
169 	 * Old firmware < 3.0 has separate boot and ucode, so we need to
170 	 * load all of them explicitly.
171 	 * To avoid issues related to fragmentation, we keep the block of
172 	 * dma-ble memory around until detach time, and reallocate it when
173 	 * it becomes too small. fw_dma_size is the size currently allocated.
174 	 */
175 	int			fw_dma_size;
176 	uint32_t		fw_flags;	/* allocation status */
177 #define	IWI_FW_HAVE_DMAT	0x01
178 #define	IWI_FW_HAVE_MAP		0x02
179 #define	IWI_FW_HAVE_PHY		0x04
180 	bus_dma_tag_t		fw_dmat;
181 	bus_dmamap_t		fw_map;
182 	bus_addr_t		fw_physaddr;
183 	void			*fw_virtaddr;
184 	enum ieee80211_opmode	fw_mode;	/* mode of current firmware */
185 	struct iwi_fw		fw_boot;	/* boot firmware */
186 	struct iwi_fw		fw_uc;		/* microcode */
187 	struct iwi_fw		fw_fw;		/* operating mode support */
188 
189 	int			curchan;	/* current h/w channel # */
190 	int			antenna;
191 	int			bluetooth;
192 	struct iwi_associate	assoc;
193 	struct iwi_wme_params	wme[3];
194 	u_int			sc_scangen;
195 
196 	struct task		sc_radiontask;	/* radio on processing */
197 	struct task		sc_radiofftask;	/* radio off processing */
198 	struct task		sc_scanaborttask;	/* cancel active scan */
199 	struct task		sc_restarttask;	/* restart adapter processing */
200 	struct task		sc_opstask;	/* scan / auth processing */
201 
202 	unsigned int		sc_softled : 1,	/* enable LED gpio status */
203 				sc_ledstate: 1,	/* LED on/off state */
204 				sc_blinking: 1;	/* LED blink operation active */
205 	u_int			sc_nictype;	/* NIC type from EEPROM */
206 	u_int			sc_ledpin;	/* mask for activity LED */
207 	u_int			sc_ledidle;	/* idle polling interval */
208 	int			sc_ledevent;	/* time of last LED event */
209 	u_int8_t		sc_rxrate;	/* current rx rate for LED */
210 	u_int8_t		sc_rxrix;
211 	u_int8_t		sc_txrate;	/* current tx rate for LED */
212 	u_int8_t		sc_txrix;
213 	u_int16_t		sc_ledoff;	/* off time for current blink */
214 	struct callout		sc_ledtimer;	/* led off timer */
215 	struct callout		sc_wdtimer;	/* watchdog timer */
216 	struct callout		sc_rftimer;	/* rfkill timer */
217 
218 	int			sc_tx_timer;
219 	int			sc_state_timer;	/* firmware state timer */
220 	int			sc_busy_timer;	/* firmware cmd timer */
221 
222 #define	IWI_CMD_MAXOPS		10
223 	int			sc_cmd[IWI_CMD_MAXOPS];
224 	unsigned long		sc_arg[IWI_CMD_MAXOPS];
225 	int			sc_cmd_cur;	/* current queued scan task */
226 	int			sc_cmd_next;	/* last queued scan task */
227 #define	IWI_CMD_FREE		0		/* for marking slots unused */
228 #define IWI_SCAN_START		1
229 #define IWI_SET_CHANNEL	        2
230 #define	IWI_AUTH		3
231 #define	IWI_ASSOC		4
232 #define	IWI_DISASSOC		5
233 #define	IWI_SCAN_CURCHAN	6
234 #define	IWI_SCAN_ALLCHAN	7
235 #define	IWI_SET_WME		8
236 
237 	struct iwi_rx_radiotap_header sc_rxtap;
238 	int			sc_rxtap_len;
239 
240 	struct iwi_tx_radiotap_header sc_txtap;
241 	int			sc_txtap_len;
242 };
243 
244 #define	IWI_STATE_BEGIN(_sc, _state)	do {			\
245 	KASSERT(_sc->fw_state == IWI_FW_IDLE,			\
246 	    ("iwi firmware not idle"));				\
247 	_sc->fw_state = _state;					\
248 	_sc->sc_state_timer = 5;				\
249 	DPRINTF(("enter %s state\n", iwi_fw_states[_state]));	\
250 } while (0)
251 
252 #define	IWI_STATE_END(_sc, _state)	do {			\
253 	if (_sc->fw_state == _state)				\
254 		DPRINTF(("exit %s state\n", iwi_fw_states[_state])); \
255 	 else							\
256 		DPRINTF(("expected %s state, got %s\n",	\
257 		    iwi_fw_states[_state], iwi_fw_states[_sc->fw_state])); \
258 	_sc->fw_state = IWI_FW_IDLE;				\
259 	wakeup(_sc);						\
260 	_sc->sc_state_timer = 0;				\
261 } while (0)
262 /*
263  * NB.: This models the only instance of async locking in iwi_init_locked
264  *	and must be kept in sync.
265  */
266 #define	IWI_LOCK_INIT(sc) \
267 	mtx_init(&(sc)->sc_mtx, device_get_nameunit((sc)->sc_dev), \
268 	    MTX_NETWORK_LOCK, MTX_DEF)
269 #define	IWI_LOCK_DESTROY(sc)	mtx_destroy(&(sc)->sc_mtx)
270 #define	IWI_LOCK_DECL	int	__waslocked = 0
271 #define IWI_LOCK_ASSERT(sc)	mtx_assert(&(sc)->sc_mtx, MA_OWNED)
272 #define IWI_LOCK(sc)	do {				\
273 	if (!(__waslocked = mtx_owned(&(sc)->sc_mtx)))	\
274 		mtx_lock(&(sc)->sc_mtx);		\
275 } while (0)
276 #define IWI_UNLOCK(sc)	do {			\
277 	if (!__waslocked)			\
278 		mtx_unlock(&(sc)->sc_mtx);	\
279 } while (0)
280 #define	IWI_CMD_LOCK_INIT(sc) do { \
281 	snprintf((sc)->sc_cmdname, sizeof((sc)->sc_cmdname), "%s_cmd", \
282 		device_get_nameunit((sc)->sc_dev)); \
283 	mtx_init(&(sc)->sc_cmdlock, (sc)->sc_cmdname, NULL, MTX_DEF); \
284 } while (0)
285 #define	IWI_CMD_LOCK_DESTROY(sc)	mtx_destroy(&(sc)->sc_cmdlock)
286 #define	IWI_CMD_LOCK(sc)		mtx_lock(&(sc)->sc_cmdlock)
287 #define	IWI_CMD_UNLOCK(sc)		mtx_unlock(&(sc)->sc_cmdlock)
288