if_iwnvar.h revision 201209
1/*	$FreeBSD: head/sys/dev/iwn/if_iwnvar.h 201209 2009-12-29 19:47:34Z rpaulo $	*/
2/*	$OpenBSD: if_iwnvar.h,v 1.16 2009/11/04 17:46:52 damien Exp $	*/
3
4/*-
5 * Copyright (c) 2007, 2008
6 *	Damien Bergamini <damien.bergamini@free.fr>
7 * Copyright (c) 2008 Sam Leffler, Errno Consulting
8 *
9 * Permission to use, copy, modify, and distribute this software for any
10 * purpose with or without fee is hereby granted, provided that the above
11 * copyright notice and this permission notice appear in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
14 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
15 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
16 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
17 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
18 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
19 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20 */
21
22struct iwn_rx_radiotap_header {
23	struct ieee80211_radiotap_header wr_ihdr;
24	uint64_t	wr_tsft;
25	uint8_t		wr_flags;
26	uint8_t		wr_rate;
27	uint16_t	wr_chan_freq;
28	uint16_t	wr_chan_flags;
29	int8_t		wr_dbm_antsignal;
30	int8_t		wr_dbm_antnoise;
31} __packed;
32
33#define IWN_RX_RADIOTAP_PRESENT						\
34	((1 << IEEE80211_RADIOTAP_TSFT) |				\
35	 (1 << IEEE80211_RADIOTAP_FLAGS) |				\
36	 (1 << IEEE80211_RADIOTAP_RATE) |				\
37	 (1 << IEEE80211_RADIOTAP_CHANNEL) |				\
38	 (1 << IEEE80211_RADIOTAP_DBM_ANTSIGNAL) |			\
39	 (1 << IEEE80211_RADIOTAP_DBM_ANTNOISE))
40
41struct iwn_tx_radiotap_header {
42	struct ieee80211_radiotap_header wt_ihdr;
43	uint8_t		wt_flags;
44	uint8_t		wt_rate;
45	uint16_t	wt_chan_freq;
46	uint16_t	wt_chan_flags;
47} __packed;
48
49#define IWN_TX_RADIOTAP_PRESENT						\
50	((1 << IEEE80211_RADIOTAP_FLAGS) |				\
51	 (1 << IEEE80211_RADIOTAP_RATE) |				\
52	 (1 << IEEE80211_RADIOTAP_CHANNEL))
53
54struct iwn_dma_info {
55	bus_dma_tag_t		tag;
56	bus_dmamap_t		map;
57	bus_dma_segment_t	seg;
58	bus_addr_t		paddr;
59	caddr_t			vaddr;
60	bus_size_t		size;
61};
62
63struct iwn_tx_data {
64	bus_dmamap_t		map;
65	bus_addr_t		cmd_paddr;
66	bus_addr_t		scratch_paddr;
67	struct mbuf		*m;
68	struct ieee80211_node	*ni;
69};
70
71struct iwn_tx_ring {
72	struct iwn_dma_info	desc_dma;
73	struct iwn_dma_info	cmd_dma;
74	struct iwn_tx_desc	*desc;
75	struct iwn_tx_cmd	*cmd;
76	struct iwn_tx_data	data[IWN_TX_RING_COUNT];
77	bus_dma_tag_t		data_dmat;
78	int			qid;
79	int			queued;
80	int			cur;
81};
82
83struct iwn_softc;
84
85struct iwn_rx_data {
86	struct mbuf	*m;
87	bus_dmamap_t	map;
88};
89
90struct iwn_rx_ring {
91	struct iwn_dma_info	desc_dma;
92	struct iwn_dma_info	stat_dma;
93	uint32_t		*desc;
94	struct iwn_rx_status	*stat;
95	struct iwn_rx_data	data[IWN_RX_RING_COUNT];
96	bus_dma_tag_t		data_dmat;
97	int			cur;
98};
99
100struct iwn_node {
101	struct	ieee80211_node		ni;	/* must be the first */
102	struct	ieee80211_amrr_node	amn;
103	uint16_t			disable_tid;
104	uint8_t				id;
105	uint8_t				ridx[IEEE80211_RATE_MAXSIZE];
106};
107
108struct iwn_calib_state {
109	uint8_t		state;
110#define IWN_CALIB_STATE_INIT	0
111#define IWN_CALIB_STATE_ASSOC	1
112#define IWN_CALIB_STATE_RUN	2
113
114	u_int		nbeacons;
115	uint32_t	noise[3];
116	uint32_t	rssi[3];
117	uint32_t	ofdm_x1;
118	uint32_t	ofdm_mrc_x1;
119	uint32_t	ofdm_x4;
120	uint32_t	ofdm_mrc_x4;
121	uint32_t	cck_x4;
122	uint32_t	cck_mrc_x4;
123	uint32_t	bad_plcp_ofdm;
124	uint32_t	fa_ofdm;
125	uint32_t	bad_plcp_cck;
126	uint32_t	fa_cck;
127	uint32_t	low_fa;
128	uint8_t		cck_state;
129#define IWN_CCK_STATE_INIT	0
130#define IWN_CCK_STATE_LOFA	1
131#define IWN_CCK_STATE_HIFA	2
132
133	uint8_t		noise_samples[20];
134	u_int		cur_noise_sample;
135	uint8_t		noise_ref;
136	uint32_t	energy_samples[10];
137	u_int		cur_energy_sample;
138	uint32_t	energy_cck;
139};
140
141struct iwn_calib_info {
142	uint8_t		*buf;
143	u_int		len;
144};
145
146struct iwn_fw_part {
147	const uint8_t	*text;
148	uint32_t	textsz;
149	const uint8_t	*data;
150	uint32_t	datasz;
151};
152
153struct iwn_fw_info {
154	u_char			*data;
155	struct iwn_fw_part	init;
156	struct iwn_fw_part	main;
157	struct iwn_fw_part	boot;
158};
159
160struct iwn_hal {
161	int		(*load_firmware)(struct iwn_softc *);
162	void		(*read_eeprom)(struct iwn_softc *);
163	int		(*post_alive)(struct iwn_softc *);
164	int		(*nic_config)(struct iwn_softc *);
165	void		(*update_sched)(struct iwn_softc *, int, int, uint8_t,
166			    uint16_t);
167	int		(*get_temperature)(struct iwn_softc *);
168	int		(*get_rssi)(struct iwn_softc *, struct iwn_rx_stat *);
169	int		(*set_txpower)(struct iwn_softc *, int);
170	int		(*init_gains)(struct iwn_softc *);
171	int		(*set_gains)(struct iwn_softc *);
172	int		(*add_node)(struct iwn_softc *, struct iwn_node_info *,
173			    int);
174	void		(*tx_done)(struct iwn_softc *, struct iwn_rx_desc *,
175			    struct iwn_rx_data *);
176#if 0	/* HT */
177	void		(*ampdu_tx_start)(struct iwn_softc *,
178			    struct ieee80211_node *, uint8_t, uint16_t);
179	void		(*ampdu_tx_stop)(struct iwn_softc *, uint8_t,
180			    uint16_t);
181#endif
182	int		ntxqs;
183	int		ndmachnls;
184	uint8_t		broadcast_id;
185	int		rxonsz;
186	int		schedsz;
187	uint32_t	fw_text_maxsz;
188	uint32_t	fw_data_maxsz;
189	uint32_t	fwsz;
190	bus_size_t	sched_txfact_addr;
191};
192
193struct iwn_vap {
194	struct ieee80211vap	iv_vap;
195	struct ieee80211_amrr	iv_amrr;
196	struct callout		iv_amrr_to;
197	uint8_t			iv_ridx;
198
199	int			(*iv_newstate)(struct ieee80211vap *,
200				    enum ieee80211_state, int);
201};
202#define	IWN_VAP(_vap)	((struct iwn_vap *)(_vap))
203
204struct iwn_softc {
205	struct ifnet		*sc_ifp;
206	int			sc_debug;
207
208	/* Locks */
209	struct mtx		sc_mtx;
210
211	/* Bus */
212	device_t 		sc_dev;
213	int			mem_rid;
214	int			irq_rid;
215	struct resource 	*mem;
216	struct resource		*irq;
217
218	u_int			sc_flags;
219#define IWN_FLAG_HAS_5GHZ	(1 << 0)
220#define IWN_FLAG_HAS_OTPROM	(1 << 1)
221#define IWN_FLAG_CALIB_DONE	(1 << 2)
222#define IWN_FLAG_USE_ICT	(1 << 3)
223#define IWN_FLAG_INTERNAL_PA	(1 << 4)
224
225	uint8_t 		hw_type;
226	const struct iwn_hal	*sc_hal;
227	const char		*fwname;
228	const struct iwn_sensitivity_limits
229				*limits;
230
231	/* TX scheduler rings. */
232	struct iwn_dma_info	sched_dma;
233	uint16_t		*sched;
234	uint32_t		sched_base;
235
236	/* "Keep Warm" page. */
237	struct iwn_dma_info	kw_dma;
238
239	/* Firmware image. */
240	const struct firmware	*fw_fp;
241
242	/* Firmware DMA transfer. */
243	struct iwn_dma_info	fw_dma;
244
245	/* ICT table. */
246	struct iwn_dma_info	ict_dma;
247	uint32_t		*ict;
248	int			ict_cur;
249
250	/* TX/RX rings. */
251	struct iwn_tx_ring	txq[IWN5000_NTXQUEUES];
252	struct iwn_rx_ring	rxq;
253
254	bus_space_tag_t		sc_st;
255	bus_space_handle_t	sc_sh;
256	void 			*sc_ih;
257	bus_size_t		sc_sz;
258	int			sc_cap_off;	/* PCIe Capabilities. */
259
260	/* Tasks used by the driver */
261	struct task             sc_reinit_task;
262	struct task		sc_radioon_task;
263	struct task		sc_radiooff_task;
264
265	int			calib_cnt;
266	struct iwn_calib_state	calib;
267
268	struct iwn_fw_info	fw;
269	struct iwn_calib_info	calibcmd[5];
270	uint32_t		errptr;
271
272	struct iwn_rx_stat	last_rx_stat;
273	int			last_rx_valid;
274	struct iwn_ucode_info	ucode_info;
275	struct iwn_rxon		rxon;
276	uint32_t		rawtemp;
277	int			temp;
278	int			noise;
279	uint32_t		qfullmsk;
280
281	uint32_t		prom_base;
282	struct iwn4965_eeprom_band
283				bands[IWN_NBANDS];
284	struct iwn_eeprom_chan	eeprom_channels[IWN_NBANDS][IWN_MAX_CHAN_PER_BAND];
285	uint16_t		rfcfg;
286	char			eeprom_domain[4];
287	uint32_t		eeprom_crystal;
288	int16_t			eeprom_voltage;
289	int8_t			maxpwr2GHz;
290	int8_t			maxpwr5GHz;
291	int8_t			maxpwr[IEEE80211_CHAN_MAX];
292	int8_t			enh_maxpwr[35];
293
294	int32_t			temp_off;
295	uint32_t		int_mask;
296	uint8_t			ntxchains;
297	uint8_t			nrxchains;
298	uint8_t			txchainmask;
299	uint8_t			rxchainmask;
300	uint8_t			chainmask;
301
302	struct callout		sc_timer_to;
303	int			sc_tx_timer;
304
305	struct iwn_rx_radiotap_header sc_rxtap;
306	struct iwn_tx_radiotap_header sc_txtap;
307};
308
309#define IWN_LOCK_INIT(_sc) \
310	mtx_init(&(_sc)->sc_mtx, device_get_nameunit((_sc)->sc_dev), \
311	     MTX_NETWORK_LOCK, MTX_DEF)
312#define IWN_LOCK(_sc)			mtx_lock(&(_sc)->sc_mtx)
313#define IWN_LOCK_ASSERT(_sc)		mtx_assert(&(_sc)->sc_mtx, MA_OWNED)
314#define IWN_UNLOCK(_sc)			mtx_unlock(&(_sc)->sc_mtx)
315#define IWN_LOCK_DESTROY(_sc)		mtx_destroy(&(_sc)->sc_mtx)
316