FreeBSD/Linux Kernel Cross Reference
sys/dev/ic/rtwvar.h
1 /* $NetBSD: rtwvar.h,v 1.22 2005/03/02 05:20:43 dyoung Exp $ */
2 /*-
3 * Copyright (c) 2004, 2005 David Young. All rights reserved.
4 *
5 * Driver for the Realtek RTL8180 802.11 MAC/BBP by David Young.
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, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. The name of David Young may not be used to endorse or promote
16 * products derived from this software without specific prior
17 * written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY David Young ``AS IS'' AND ANY
20 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
22 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL David
23 * Young BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
25 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
27 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
30 * OF SUCH DAMAGE.
31 */
32
33 #ifndef _DEV_IC_RTWVAR_H_
34 #define _DEV_IC_RTWVAR_H_
35
36 #include <sys/queue.h>
37 #include <sys/callout.h>
38
39 #ifdef RTW_DEBUG
40 #define RTW_DEBUG_TUNE 0x000001
41 #define RTW_DEBUG_PKTFILT 0x000002
42 #define RTW_DEBUG_XMIT 0x000004
43 #define RTW_DEBUG_XMIT_DESC 0x000008
44 #define RTW_DEBUG_NODE 0x000010
45 #define RTW_DEBUG_PWR 0x000020
46 #define RTW_DEBUG_ATTACH 0x000040
47 #define RTW_DEBUG_REGDUMP 0x000080
48 #define RTW_DEBUG_ACCESS 0x000100
49 #define RTW_DEBUG_RESET 0x000200
50 #define RTW_DEBUG_INIT 0x000400
51 #define RTW_DEBUG_IOSTATE 0x000800
52 #define RTW_DEBUG_RECV 0x001000
53 #define RTW_DEBUG_RECV_DESC 0x002000
54 #define RTW_DEBUG_IO_KICK 0x004000
55 #define RTW_DEBUG_INTR 0x008000
56 #define RTW_DEBUG_PHY 0x010000
57 #define RTW_DEBUG_PHYIO 0x020000
58 #define RTW_DEBUG_PHYBITIO 0x040000
59 #define RTW_DEBUG_TIMEOUT 0x080000
60 #define RTW_DEBUG_BUGS 0x100000
61 #define RTW_DEBUG_BEACON 0x200000
62 #define RTW_DEBUG_LED 0x400000
63 #define RTW_DEBUG_MAX 0x7fffff
64
65 extern int rtw_debug;
66 #define RTW_DPRINTF(__flags, __x) \
67 if ((rtw_debug & (__flags)) != 0) printf __x
68 #define DPRINTF(__sc, __flags, __x) \
69 if (((__sc)->sc_ic.ic_if.if_flags & IFF_DEBUG) != 0) \
70 RTW_DPRINTF(__flags, __x)
71 #define RTW_PRINT_REGS(__regs, __dvname, __where) \
72 rtw_print_regs((__regs), (__dvname), (__where))
73 #else /* RTW_DEBUG */
74 #define RTW_DPRINTF(__flags, __x)
75 #define DPRINTF(__sc, __flags, __x)
76 #define RTW_PRINT_REGS(__regs, __dvname, __where)
77 #endif /* RTW_DEBUG */
78
79 enum rtw_locale {
80 RTW_LOCALE_USA = 0,
81 RTW_LOCALE_EUROPE,
82 RTW_LOCALE_JAPAN,
83 RTW_LOCALE_UNKNOWN
84 };
85
86 enum rtw_rfchipid {
87 RTW_RFCHIPID_RESERVED = 0,
88 RTW_RFCHIPID_INTERSIL = 1,
89 RTW_RFCHIPID_RFMD = 2,
90 RTW_RFCHIPID_PHILIPS = 3,
91 RTW_RFCHIPID_MAXIM = 4,
92 RTW_RFCHIPID_GCT = 5
93 };
94
95 /* sc_flags */
96 #define RTW_F_ENABLED 0x00000001 /* chip is enabled */
97 #define RTW_F_DIGPHY 0x00000002 /* digital PHY */
98 #define RTW_F_DFLANTB 0x00000004 /* B antenna is default */
99 #define RTW_F_ANTDIV 0x00000010 /* h/w antenna diversity */
100 #define RTW_F_9356SROM 0x00000020 /* 93c56 SROM */
101 #define RTW_F_SLEEP 0x00000040 /* chip is asleep */
102 #define RTW_F_INVALID 0x00000080 /* chip is absent */
103 /* all PHY flags */
104 #define RTW_F_ALLPHY (RTW_F_DIGPHY|RTW_F_DFLANTB|RTW_F_ANTDIV)
105
106 enum rtw_access {RTW_ACCESS_NONE = 0,
107 RTW_ACCESS_CONFIG = 1,
108 RTW_ACCESS_ANAPARM = 2};
109
110 struct rtw_regs {
111 bus_space_tag_t r_bt;
112 bus_space_handle_t r_bh;
113 enum rtw_access r_access;
114 };
115
116 #define RTW_SR_GET(sr, ofs) \
117 (((sr)->sr_content[(ofs)/2] >> (((ofs) % 2 == 0) ? 0 : 8)) & 0xff)
118
119 #define RTW_SR_GET16(sr, ofs) \
120 (RTW_SR_GET((sr), (ofs)) | (RTW_SR_GET((sr), (ofs) + 1) << 8))
121
122 struct rtw_srom {
123 uint16_t *sr_content;
124 uint16_t sr_size;
125 };
126
127 struct rtw_rxsoft {
128 struct mbuf *rs_mbuf;
129 bus_dmamap_t rs_dmamap;
130 };
131
132 struct rtw_txsoft {
133 SIMPLEQ_ENTRY(rtw_txsoft) ts_q;
134 struct mbuf *ts_mbuf;
135 bus_dmamap_t ts_dmamap;
136 struct ieee80211_node *ts_ni; /* destination node */
137 u_int ts_first; /* 1st hw descriptor */
138 u_int ts_last; /* last hw descriptor */
139 struct ieee80211_duration ts_d0;
140 struct ieee80211_duration ts_dn;
141 };
142
143 #define RTW_NTXPRI 4 /* number of Tx priorities */
144 #define RTW_TXPRILO 0
145 #define RTW_TXPRIMD 1
146 #define RTW_TXPRIHI 2
147 #define RTW_TXPRIBCN 3 /* beacon priority */
148
149 #define RTW_MAXPKTSEGS 64 /* Max 64 segments per Tx packet */
150
151 #define CASSERT(cond, complaint) complaint[(cond) ? 0 : -1] = complaint[(cond) ? 0 : -1]
152
153 /* Note well: the descriptor rings must begin on RTW_DESC_ALIGNMENT
154 * boundaries. I allocate them consecutively from one buffer, so
155 * just round up.
156 */
157 #define RTW_TXQLENLO 64 /* low-priority queue length */
158 #define RTW_TXQLENMD 64 /* medium-priority */
159 #define RTW_TXQLENHI 64 /* high-priority */
160 #define RTW_TXQLENBCN 2 /* beacon */
161
162 #define RTW_NTXDESCLO RTW_TXQLENLO
163 #define RTW_NTXDESCMD RTW_TXQLENMD
164 #define RTW_NTXDESCHI RTW_TXQLENHI
165 #define RTW_NTXDESCBCN RTW_TXQLENBCN
166
167 #define RTW_NTXDESCTOTAL (RTW_NTXDESCLO + RTW_NTXDESCMD + \
168 RTW_NTXDESCHI + RTW_NTXDESCBCN)
169
170 #define RTW_RXQLEN 64
171
172 struct rtw_rxdesc_blk {
173 struct rtw_rxdesc *rdb_desc;
174 u_int rdb_next;
175 u_int rdb_ndesc;
176 bus_dma_tag_t rdb_dmat;
177 bus_dmamap_t rdb_dmamap;
178 };
179
180 struct rtw_txdesc_blk {
181 u_int tdb_ndesc;
182 u_int tdb_next;
183 u_int tdb_nfree;
184 bus_dma_tag_t tdb_dmat;
185 bus_dmamap_t tdb_dmamap;
186 bus_addr_t tdb_physbase;
187 bus_addr_t tdb_ofs;
188 struct rtw_txdesc *tdb_desc;
189 };
190
191 #define RTW_NEXT_IDX(__htc, __idx) (((__idx) + 1) % (__htc)->tdb_ndesc)
192
193 #define RTW_NEXT_DESC(__htc, __idx) \
194 ((__htc)->tdb_physbase + \
195 sizeof(struct rtw_txdesc) * RTW_NEXT_IDX((__htc), (__idx)))
196
197 SIMPLEQ_HEAD(rtw_txq, rtw_txsoft);
198
199 struct rtw_txsoft_blk {
200 /* dirty/free s/w descriptors */
201 struct rtw_txq tsb_dirtyq;
202 struct rtw_txq tsb_freeq;
203 u_int tsb_ndesc;
204 int tsb_tx_timer;
205 struct rtw_txsoft *tsb_desc;
206 uint8_t tsb_poll;
207 };
208
209 struct rtw_descs {
210 struct rtw_txdesc hd_txlo[RTW_NTXDESCLO];
211 struct rtw_txdesc hd_txmd[RTW_NTXDESCMD];
212 struct rtw_txdesc hd_txhi[RTW_NTXDESCMD];
213 struct rtw_rxdesc hd_rx[RTW_RXQLEN];
214 struct rtw_txdesc hd_bcn[RTW_NTXDESCBCN];
215 };
216 #define RTW_DESC_OFFSET(ring, i) offsetof(struct rtw_descs, ring[i])
217 #define RTW_RING_OFFSET(ring) RTW_DESC_OFFSET(ring, 0)
218 #define RTW_RING_BASE(sc, ring) ((sc)->sc_desc_physaddr + \
219 RTW_RING_OFFSET(ring))
220
221 /* Radio capture format for RTL8180. */
222
223 #define RTW_RX_RADIOTAP_PRESENT \
224 ((1 << IEEE80211_RADIOTAP_TSFT) | \
225 (1 << IEEE80211_RADIOTAP_FLAGS) | \
226 (1 << IEEE80211_RADIOTAP_RATE) | \
227 (1 << IEEE80211_RADIOTAP_CHANNEL) | \
228 (1 << IEEE80211_RADIOTAP_LOCK_QUALITY) | \
229 (1 << IEEE80211_RADIOTAP_DB_ANTSIGNAL) | \
230 0)
231
232 struct rtw_rx_radiotap_header {
233 struct ieee80211_radiotap_header rr_ihdr;
234 uint64_t rr_tsft;
235 uint8_t rr_flags;
236 uint8_t rr_rate;
237 uint16_t rr_chan_freq;
238 uint16_t rr_chan_flags;
239 uint16_t rr_barker_lock;
240 uint8_t rr_antsignal;
241 } __attribute__((__packed__));
242
243 #define RTW_TX_RADIOTAP_PRESENT \
244 ((1 << IEEE80211_RADIOTAP_FLAGS) | \
245 (1 << IEEE80211_RADIOTAP_RATE) | \
246 (1 << IEEE80211_RADIOTAP_CHANNEL) | \
247 0)
248
249 struct rtw_tx_radiotap_header {
250 struct ieee80211_radiotap_header rt_ihdr;
251 uint8_t rt_flags;
252 uint8_t rt_rate;
253 uint16_t rt_chan_freq;
254 uint16_t rt_chan_flags;
255 } __attribute__((__packed__));
256
257 enum rtw_attach_state {FINISHED, FINISH_DESCMAP_LOAD, FINISH_DESCMAP_CREATE,
258 FINISH_DESC_MAP, FINISH_DESC_ALLOC, FINISH_RXMAPS_CREATE,
259 FINISH_TXMAPS_CREATE, FINISH_RESET, FINISH_READ_SROM, FINISH_PARSE_SROM,
260 FINISH_RF_ATTACH, FINISH_ID_STA, FINISH_TXDESCBLK_SETUP,
261 FINISH_TXCTLBLK_SETUP, DETACHED};
262
263 struct rtw_hooks {
264 void *rh_shutdown; /* shutdown hook */
265 void *rh_power; /* power management hook */
266 };
267
268 struct rtw_mtbl {
269 int (*mt_newstate)(struct ieee80211com *,
270 enum ieee80211_state, int);
271 void (*mt_recv_mgmt)(struct ieee80211com *,
272 struct mbuf *, struct ieee80211_node *,
273 int, int, uint32_t);
274 struct ieee80211_node *(*mt_node_alloc)(struct ieee80211com *);
275 void (*mt_node_free)(struct ieee80211com *,
276 struct ieee80211_node *);
277 };
278
279 enum rtw_pwrstate { RTW_OFF = 0, RTW_SLEEP, RTW_ON };
280
281 typedef void (*rtw_continuous_tx_cb_t)(void *arg, int);
282
283 struct rtw_phy {
284 struct rtw_rf *p_rf;
285 struct rtw_regs *p_regs;
286 };
287
288 struct rtw_bbpset {
289 u_int bb_antatten;
290 u_int bb_chestlim;
291 u_int bb_chsqlim;
292 u_int bb_ifagcdet;
293 u_int bb_ifagcini;
294 u_int bb_ifagclimit;
295 u_int bb_lnadet;
296 u_int bb_sys1;
297 u_int bb_sys2;
298 u_int bb_sys3;
299 u_int bb_trl;
300 u_int bb_txagc;
301 };
302
303 struct rtw_rf {
304 void (*rf_destroy)(struct rtw_rf *);
305 /* args: frequency, txpower, power state */
306 int (*rf_init)(struct rtw_rf *, u_int, uint8_t,
307 enum rtw_pwrstate);
308 /* arg: power state */
309 int (*rf_pwrstate)(struct rtw_rf *, enum rtw_pwrstate);
310 /* arg: frequency */
311 int (*rf_tune)(struct rtw_rf *, u_int);
312 /* arg: txpower */
313 int (*rf_txpower)(struct rtw_rf *, uint8_t);
314 rtw_continuous_tx_cb_t rf_continuous_tx_cb;
315 void *rf_continuous_tx_arg;
316 struct rtw_bbpset rf_bbpset;
317 };
318
319 static __inline void
320 rtw_rf_destroy(struct rtw_rf *rf)
321 {
322 (*rf->rf_destroy)(rf);
323 }
324
325 static __inline int
326 rtw_rf_init(struct rtw_rf *rf, u_int freq, uint8_t opaque_txpower,
327 enum rtw_pwrstate power)
328 {
329 return (*rf->rf_init)(rf, freq, opaque_txpower, power);
330 }
331
332 static __inline int
333 rtw_rf_pwrstate(struct rtw_rf *rf, enum rtw_pwrstate power)
334 {
335 return (*rf->rf_pwrstate)(rf, power);
336 }
337
338 static __inline int
339 rtw_rf_tune(struct rtw_rf *rf, u_int freq)
340 {
341 return (*rf->rf_tune)(rf, freq);
342 }
343
344 static __inline int
345 rtw_rf_txpower(struct rtw_rf *rf, uint8_t opaque_txpower)
346 {
347 return (*rf->rf_txpower)(rf, opaque_txpower);
348 }
349
350 typedef int (*rtw_rf_write_t)(struct rtw_regs *, enum rtw_rfchipid, u_int,
351 uint32_t);
352
353 struct rtw_rfbus {
354 struct rtw_regs *b_regs;
355 rtw_rf_write_t b_write;
356 };
357
358 static __inline int
359 rtw_rfbus_write(struct rtw_rfbus *bus, enum rtw_rfchipid rfchipid, u_int addr,
360 uint32_t val)
361 {
362 return (*bus->b_write)(bus->b_regs, rfchipid, addr, val);
363 }
364
365 struct rtw_max2820 {
366 struct rtw_rf mx_rf;
367 struct rtw_rfbus mx_bus;
368 int mx_is_a; /* 1: MAX2820A/MAX2821A */
369 };
370
371 struct rtw_sa2400 {
372 struct rtw_rf sa_rf;
373 struct rtw_rfbus sa_bus;
374 int sa_digphy; /* 1: digital PHY */
375 };
376
377 typedef void (*rtw_pwrstate_t)(struct rtw_regs *, enum rtw_pwrstate, int, int);
378
379 union rtw_keys {
380 uint8_t rk_keys[4][16];
381 uint32_t rk_words[16];
382 };
383
384 #define RTW_LED_SLOW_TICKS MAX(1, hz/2)
385 #define RTW_LED_FAST_TICKS MAX(1, hz/10)
386
387 struct rtw_led_state {
388 #define RTW_LED0 0x1
389 #define RTW_LED1 0x2
390 uint8_t ls_slowblink:2;
391 uint8_t ls_actblink:2;
392 uint8_t ls_default:2;
393 uint8_t ls_state;
394 uint8_t ls_event;
395 #define RTW_LED_S_RX 0x1
396 #define RTW_LED_S_TX 0x2
397 #define RTW_LED_S_SLOW 0x4
398 struct callout ls_slow_ch;
399 struct callout ls_fast_ch;
400 };
401
402 struct rtw_softc {
403 struct device sc_dev;
404 struct ieee80211com sc_ic;
405 struct rtw_regs sc_regs;
406 bus_dma_tag_t sc_dmat;
407 uint32_t sc_flags;
408
409 enum rtw_attach_state sc_attach_state;
410 enum rtw_rfchipid sc_rfchipid;
411 enum rtw_locale sc_locale;
412 uint8_t sc_phydelay;
413
414 /* s/w Tx/Rx descriptors */
415 struct rtw_txsoft_blk sc_txsoft_blk[RTW_NTXPRI];
416 struct rtw_txdesc_blk sc_txdesc_blk[RTW_NTXPRI];
417
418 struct rtw_rxsoft sc_rxsoft[RTW_RXQLEN];
419 struct rtw_rxdesc_blk sc_rxdesc_blk;
420
421 struct rtw_descs *sc_descs;
422
423 bus_dma_segment_t sc_desc_segs;
424 int sc_desc_nsegs;
425 bus_dmamap_t sc_desc_dmamap;
426 #define sc_desc_physaddr sc_desc_dmamap->dm_segs[0].ds_addr
427
428 struct rtw_srom sc_srom;
429
430 enum rtw_pwrstate sc_pwrstate;
431
432 rtw_pwrstate_t sc_pwrstate_cb;
433
434 struct rtw_rf *sc_rf;
435
436 uint16_t sc_inten;
437
438 /* interrupt acknowledge hook */
439 void (*sc_intr_ack)(struct rtw_regs *);
440
441 int (*sc_enable)(struct rtw_softc *);
442 void (*sc_disable)(struct rtw_softc *);
443 void (*sc_power)(struct rtw_softc *, int);
444 struct rtw_mtbl sc_mtbl;
445 struct rtw_hooks sc_hooks;
446
447 caddr_t sc_radiobpf;
448
449 struct callout sc_scan_ch;
450 u_int sc_cur_chan;
451
452 uint32_t sc_tsfth; /* most significant TSFT bits */
453 uint32_t sc_rcr; /* RTW_RCR */
454 uint8_t sc_csthr; /* carrier-sense threshold */
455
456 int sc_do_tick; /* indicate 1s ticks */
457 struct timeval sc_tick0; /* first tick */
458
459 uint8_t sc_rev; /* PCI/Cardbus revision */
460
461 uint32_t sc_anaparm; /* register RTW_ANAPARM */
462
463 union {
464 struct rtw_rx_radiotap_header tap;
465 uint8_t pad[64];
466 } sc_rxtapu;
467 union {
468 struct rtw_tx_radiotap_header tap;
469 uint8_t pad[64];
470 } sc_txtapu;
471 union rtw_keys sc_keys;
472 int sc_txkey;
473 struct ifqueue sc_beaconq;
474 struct rtw_led_state sc_led_state;
475 int sc_hwverid;
476 };
477
478 #define sc_if sc_ic.ic_if
479 #define sc_rxtap sc_rxtapu.tap
480 #define sc_txtap sc_txtapu.tap
481
482 extern int rtw_host_rfio;
483
484 void rtw_txdac_enable(struct rtw_softc *, int);
485 void rtw_anaparm_enable(struct rtw_regs *, int);
486 void rtw_config0123_enable(struct rtw_regs *, int);
487 void rtw_continuous_tx_enable(struct rtw_softc *, int);
488 void rtw_set_access(struct rtw_regs *, enum rtw_access);
489
490 void rtw_attach(struct rtw_softc *);
491 int rtw_detach(struct rtw_softc *);
492 int rtw_intr(void *);
493
494 void rtw_disable(struct rtw_softc *);
495 int rtw_enable(struct rtw_softc *);
496
497 int rtw_activate(struct device *, enum devact);
498 void rtw_power(int, void *);
499 void rtw_shutdown(void *);
500
501 const char *rtw_pwrstate_string(enum rtw_pwrstate);
502
503 #endif /* _DEV_IC_RTWVAR_H_ */
Cache object: c27b3eb0d9e9f2d5f4fca1f2da877413
|