xref: /freebsd/sys/dev/ipw/if_ipwvar.h (revision b3aaa0cc21c63d388230c7ef2a80abd631ff20d5)
1 /*      $FreeBSD$	*/
2 
3 /*-
4  * Copyright (c) 2004-2006
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 #define IPW_MAX_NSEG	1
31 
32 struct ipw_soft_bd {
33 	struct ipw_bd	*bd;
34 	int		type;
35 #define IPW_SBD_TYPE_NOASSOC	0
36 #define IPW_SBD_TYPE_COMMAND	1
37 #define IPW_SBD_TYPE_HEADER	2
38 #define IPW_SBD_TYPE_DATA	3
39 	void		*priv;
40 };
41 
42 struct ipw_soft_hdr {
43 	struct ipw_hdr			hdr;
44 	bus_dmamap_t			map;
45 	SLIST_ENTRY(ipw_soft_hdr)	next;
46 };
47 
48 struct ipw_soft_buf {
49 	struct mbuf			*m;
50 	struct ieee80211_node		*ni;
51 	bus_dmamap_t			map;
52 	SLIST_ENTRY(ipw_soft_buf)	next;
53 };
54 
55 struct ipw_rx_radiotap_header {
56 	struct ieee80211_radiotap_header wr_ihdr;
57 	uint8_t		wr_flags;
58 	uint16_t	wr_chan_freq;
59 	uint16_t	wr_chan_flags;
60 	uint8_t		wr_antsignal;
61 };
62 
63 #define IPW_RX_RADIOTAP_PRESENT						\
64 	((1 << IEEE80211_RADIOTAP_FLAGS) |				\
65 	 (1 << IEEE80211_RADIOTAP_CHANNEL) |				\
66 	 (1 << IEEE80211_RADIOTAP_DB_ANTSIGNAL))
67 
68 struct ipw_tx_radiotap_header {
69 	struct ieee80211_radiotap_header wt_ihdr;
70 	uint8_t		wt_flags;
71 	uint16_t	wt_chan_freq;
72 	uint16_t	wt_chan_flags;
73 };
74 
75 #define IPW_TX_RADIOTAP_PRESENT						\
76 	((1 << IEEE80211_RADIOTAP_FLAGS) |				\
77 	 (1 << IEEE80211_RADIOTAP_CHANNEL))
78 
79 struct ipw_vap {
80 	struct ieee80211vap	vap;
81 	struct task		assoc_task;
82 	struct task		disassoc_task;
83 	struct task		assoc_success_task;
84 	struct task		assoc_failed_task;
85 	struct task		scandone_task;
86 
87 	int			(*newstate)(struct ieee80211vap *,
88 				    enum ieee80211_state, int);
89 };
90 #define	IPW_VAP(vap)	((struct ipw_vap *)(vap))
91 
92 struct ipw_softc {
93 	struct ifnet			*sc_ifp;
94 	device_t			sc_dev;
95 
96 	struct mtx			sc_mtx;
97 	struct task			sc_init_task;
98 	struct task			sc_scan_task;
99 	struct task			sc_chan_task;
100 	struct task			sc_bmiss_task;
101 	struct callout			sc_wdtimer;	/* watchdog timer */
102 
103 	uint32_t			flags;
104 #define IPW_FLAG_FW_INITED		0x0001
105 #define IPW_FLAG_INIT_LOCKED		0x0002
106 #define IPW_FLAG_HAS_RADIO_SWITCH	0x0004
107 #define	IPW_FLAG_HACK			0x0008
108 #define	IPW_FLAG_SCANNING		0x0010
109 #define	IPW_FLAG_ENABLED		0x0020
110 #define	IPW_FLAG_BUSY			0x0040
111 #define	IPW_FLAG_ASSOCIATING		0x0080
112 #define	IPW_FLAG_ASSOCIATED		0x0100
113 
114 	int				irq_rid;
115 	int				mem_rid;
116 	struct resource			*irq;
117 	struct resource			*mem;
118 	bus_space_tag_t			sc_st;
119 	bus_space_handle_t		sc_sh;
120 	void 				*sc_ih;
121 	const struct firmware		*sc_firmware;
122 
123 	int				sc_tx_timer;
124 	int				sc_scan_timer;
125 
126 	bus_dma_tag_t			tbd_dmat;
127 	bus_dma_tag_t			rbd_dmat;
128 	bus_dma_tag_t			status_dmat;
129 	bus_dma_tag_t			cmd_dmat;
130 	bus_dma_tag_t			hdr_dmat;
131 	bus_dma_tag_t			txbuf_dmat;
132 	bus_dma_tag_t			rxbuf_dmat;
133 
134 	bus_dmamap_t			tbd_map;
135 	bus_dmamap_t			rbd_map;
136 	bus_dmamap_t			status_map;
137 	bus_dmamap_t			cmd_map;
138 
139 	bus_addr_t			tbd_phys;
140 	bus_addr_t			rbd_phys;
141 	bus_addr_t			status_phys;
142 
143 	struct ipw_bd			*tbd_list;
144 	struct ipw_bd			*rbd_list;
145 	struct ipw_status		*status_list;
146 
147 	struct ipw_cmd			cmd;
148 	struct ipw_soft_bd		stbd_list[IPW_NTBD];
149 	struct ipw_soft_buf		tx_sbuf_list[IPW_NDATA];
150 	struct ipw_soft_hdr		shdr_list[IPW_NDATA];
151 	struct ipw_soft_bd		srbd_list[IPW_NRBD];
152 	struct ipw_soft_buf		rx_sbuf_list[IPW_NRBD];
153 
154 	SLIST_HEAD(, ipw_soft_hdr)	free_shdr;
155 	SLIST_HEAD(, ipw_soft_buf)	free_sbuf;
156 
157 	uint32_t			table1_base;
158 	uint32_t			table2_base;
159 
160 	uint32_t			txcur;
161 	uint32_t			txold;
162 	uint32_t			rxcur;
163 	int				txfree;
164 
165 	struct ipw_rx_radiotap_header	sc_rxtap;
166 	int				sc_rxtap_len;
167 
168 	struct ipw_tx_radiotap_header	sc_txtap;
169 	int				sc_txtap_len;
170 };
171 
172 /*
173  * NB.: This models the only instance of async locking in ipw_init_locked
174  *	and must be kept in sync.
175  */
176 #define	IPW_LOCK_DECL	int	__waslocked = 0
177 #define IPW_LOCK(sc)	do {				\
178 	if (!(__waslocked = mtx_owned(&(sc)->sc_mtx)))	\
179 		mtx_lock(&sc->sc_mtx);			\
180 } while (0)
181 #define IPW_UNLOCK(sc)	do {				\
182 	if (!__waslocked)				\
183 		mtx_unlock(&sc->sc_mtx);		\
184 } while (0)
185 #define IPW_LOCK_ASSERT(sc)	mtx_assert(&(sc)->sc_mtx, MA_OWNED)
186