xref: /freebsd/sys/dev/usb/wlan/if_rumvar.h (revision 1f4bcc459a76b7aa664f3fd557684cd0ba6da352)
1 /*	$FreeBSD$	*/
2 
3 /*-
4  * Copyright (c) 2005, 2006 Damien Bergamini <damien.bergamini@free.fr>
5  * Copyright (c) 2006 Niall O'Higgins <niallo@openbsd.org>
6  *
7  * Permission to use, copy, modify, and distribute this software for any
8  * purpose with or without fee is hereby granted, provided that the above
9  * copyright notice and this permission notice appear in all copies.
10  *
11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 #define RUM_TX_LIST_COUNT	8
21 #define RUM_TX_MINFREE		2
22 
23 struct rum_rx_radiotap_header {
24 	struct ieee80211_radiotap_header wr_ihdr;
25 	uint64_t	wr_tsf;
26 	uint8_t		wr_flags;
27 	uint8_t		wr_rate;
28 	uint16_t	wr_chan_freq;
29 	uint16_t	wr_chan_flags;
30 	int8_t		wr_antsignal;
31 	int8_t		wr_antnoise;
32 	uint8_t		wr_antenna;
33 } __packed __aligned(8);
34 
35 #define RT2573_RX_RADIOTAP_PRESENT					\
36 	((1 << IEEE80211_RADIOTAP_TSFT) |				\
37 	 (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 	 (1 << IEEE80211_RADIOTAP_ANTENNA) |				\
43 	 0)
44 
45 struct rum_tx_radiotap_header {
46 	struct ieee80211_radiotap_header wt_ihdr;
47 	uint64_t	wt_tsf;
48 	uint8_t		wt_flags;
49 	uint8_t		wt_rate;
50 	uint16_t	wt_chan_freq;
51 	uint16_t	wt_chan_flags;
52 	uint8_t		wt_antenna;
53 } __packed __aligned(8);
54 
55 #define RT2573_TX_RADIOTAP_PRESENT					\
56 	((1 << IEEE80211_RADIOTAP_TSFT) |				\
57 	 (1 << IEEE80211_RADIOTAP_FLAGS) |				\
58 	 (1 << IEEE80211_RADIOTAP_RATE) |				\
59 	 (1 << IEEE80211_RADIOTAP_CHANNEL) |				\
60 	 (1 << IEEE80211_RADIOTAP_ANTENNA))
61 
62 struct rum_softc;
63 
64 struct rum_tx_data {
65 	STAILQ_ENTRY(rum_tx_data)	next;
66 	struct rum_softc		*sc;
67 	struct rum_tx_desc		desc;
68 	struct mbuf			*m;
69 	struct ieee80211_node		*ni;
70 	int				rate;
71 };
72 typedef STAILQ_HEAD(, rum_tx_data) rum_txdhead;
73 
74 union sec_param {
75 	struct ieee80211_key		key;
76 	uint8_t				macaddr[IEEE80211_ADDR_LEN];
77 	struct ieee80211vap		*vap;
78 };
79 #define CMD_FUNC_PROTO			void (*func)(struct rum_softc *, \
80 					    union sec_param *, uint8_t)
81 
82 struct rum_cmdq {
83 	union sec_param			data;
84 	uint8_t				rvp_id;
85 
86 	CMD_FUNC_PROTO;
87 };
88 #define RUM_CMDQ_SIZE			16
89 
90 struct rum_vap {
91 	struct ieee80211vap		vap;
92 	struct mbuf			*bcn_mbuf;
93 	struct usb_callout		ratectl_ch;
94 	struct task			ratectl_task;
95 	uint8_t				maxretry;
96 
97 	int				(*newstate)(struct ieee80211vap *,
98 					    enum ieee80211_state, int);
99 };
100 #define	RUM_VAP(vap)	((struct rum_vap *)(vap))
101 
102 enum {
103 	RUM_BULK_WR,
104 	RUM_BULK_RD,
105 	RUM_N_TRANSFER = 2,
106 };
107 
108 struct rum_softc {
109 	struct ieee80211com		sc_ic;
110 	struct mbufq			sc_snd;
111 	device_t			sc_dev;
112 	struct usb_device		*sc_udev;
113 
114 	struct usb_xfer			*sc_xfer[RUM_N_TRANSFER];
115 
116 	uint8_t				rf_rev;
117 	uint8_t				rffreq;
118 
119 	struct rum_tx_data		tx_data[RUM_TX_LIST_COUNT];
120 	rum_txdhead			tx_q;
121 	rum_txdhead			tx_free;
122 	int				tx_nfree;
123 	struct rum_rx_desc		sc_rx_desc;
124 
125 	struct mtx			sc_mtx;
126 
127 	struct rum_cmdq			cmdq[RUM_CMDQ_SIZE];
128 	struct mtx			cmdq_mtx;
129 	struct task			cmdq_task;
130 	uint8_t				cmdq_first;
131 	uint8_t				cmdq_last;
132 
133 	uint32_t			sta[6];
134 	uint32_t			rf_regs[4];
135 	uint8_t				txpow[44];
136 	u_int				sc_detached:1,
137 					sc_running:1,
138 					sc_clr_shkeys:1;
139 
140 	uint8_t				sc_bssid[IEEE80211_ADDR_LEN];
141 	struct wmeParams		wme_params[WME_NUM_AC];
142 
143 	uint8_t				vap_key_count[1];
144 	uint64_t			keys_bmap;
145 
146 	struct {
147 		uint8_t	val;
148 		uint8_t	reg;
149 	} __packed			bbp_prom[16];
150 
151 	int				hw_radio;
152 	int				rx_ant;
153 	int				tx_ant;
154 	int				nb_ant;
155 	int				ext_2ghz_lna;
156 	int				ext_5ghz_lna;
157 	int				rssi_2ghz_corr;
158 	int				rssi_5ghz_corr;
159 	uint8_t				bbp17;
160 
161 	struct rum_rx_radiotap_header	sc_rxtap;
162 	struct rum_tx_radiotap_header	sc_txtap;
163 };
164 
165 #define RUM_LOCK_INIT(sc) \
166 	mtx_init(&(sc)->sc_mtx, device_get_nameunit((sc)->sc_dev), \
167 	    MTX_NETWORK_LOCK, MTX_DEF);
168 #define RUM_LOCK(sc)			mtx_lock(&(sc)->sc_mtx)
169 #define RUM_UNLOCK(sc)			mtx_unlock(&(sc)->sc_mtx)
170 #define RUM_LOCK_ASSERT(sc)		mtx_assert(&(sc)->sc_mtx, MA_OWNED)
171 #define RUM_LOCK_DESTROY(sc)		mtx_destroy(&(sc)->sc_mtx)
172 
173 #define RUM_CMDQ_LOCK_INIT(sc) \
174 	mtx_init(&(sc)->cmdq_mtx, "cmdq lock", NULL, MTX_DEF)
175 #define RUM_CMDQ_LOCK(sc)		mtx_lock(&(sc)->cmdq_mtx)
176 #define RUM_CMDQ_UNLOCK(sc)		mtx_unlock(&(sc)->cmdq_mtx)
177 #define RUM_CMDQ_LOCK_DESTROY(sc)	mtx_destroy(&(sc)->cmdq_mtx)
178