1 /* $NetBSD: rtwvar.h,v 1.27 2005/12/29 22:27:17 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 0x0000001 41 #define RTW_DEBUG_PKTFILT 0x0000002 42 #define RTW_DEBUG_XMIT 0x0000004 43 #define RTW_DEBUG_XMIT_DESC 0x0000008 44 #define RTW_DEBUG_NODE 0x0000010 45 #define RTW_DEBUG_PWR 0x0000020 46 #define RTW_DEBUG_ATTACH 0x0000040 47 #define RTW_DEBUG_REGDUMP 0x0000080 48 #define RTW_DEBUG_ACCESS 0x0000100 49 #define RTW_DEBUG_RESET 0x0000200 50 #define RTW_DEBUG_INIT 0x0000400 51 #define RTW_DEBUG_IOSTATE 0x0000800 52 #define RTW_DEBUG_RECV 0x0001000 53 #define RTW_DEBUG_RECV_DESC 0x0002000 54 #define RTW_DEBUG_IO_KICK 0x0004000 55 #define RTW_DEBUG_INTR 0x0008000 56 #define RTW_DEBUG_PHY 0x0010000 57 #define RTW_DEBUG_PHYIO 0x0020000 58 #define RTW_DEBUG_PHYBITIO 0x0040000 59 #define RTW_DEBUG_TIMEOUT 0x0080000 60 #define RTW_DEBUG_BUGS 0x0100000 61 #define RTW_DEBUG_BEACON 0x0200000 62 #define RTW_DEBUG_LED 0x0400000 63 #define RTW_DEBUG_KEY 0x0800000 64 #define RTW_DEBUG_XMIT_RSRC 0x1000000 65 #define RTW_DEBUG_OACTIVE 0x2000000 66 #define RTW_DEBUG_MAX 0x3ffffff 67 68 extern int rtw_debug; 69 #define RTW_DPRINTF(__flags, __x) \ 70 if ((rtw_debug & (__flags)) != 0) printf __x 71 #define DPRINTF(__sc, __flags, __x) \ 72 if (((__sc)->sc_if.if_flags & IFF_DEBUG) != 0) \ 73 RTW_DPRINTF(__flags, __x) 74 #define RTW_PRINT_REGS(__regs, __dvname, __where) \ 75 rtw_print_regs((__regs), (__dvname), (__where)) 76 #else /* RTW_DEBUG */ 77 #define RTW_DPRINTF(__flags, __x) 78 #define DPRINTF(__sc, __flags, __x) 79 #define RTW_PRINT_REGS(__regs, __dvname, __where) 80 #endif /* RTW_DEBUG */ 81 82 enum rtw_locale { 83 RTW_LOCALE_USA = 0, 84 RTW_LOCALE_EUROPE, 85 RTW_LOCALE_JAPAN, 86 RTW_LOCALE_UNKNOWN 87 }; 88 89 enum rtw_rfchipid { 90 RTW_RFCHIPID_RESERVED = 0, 91 RTW_RFCHIPID_INTERSIL = 1, 92 RTW_RFCHIPID_RFMD = 2, 93 RTW_RFCHIPID_PHILIPS = 3, 94 RTW_RFCHIPID_MAXIM = 4, 95 RTW_RFCHIPID_GCT = 5 96 }; 97 98 /* sc_flags */ 99 #define RTW_F_ENABLED 0x00000001 /* chip is enabled */ 100 #define RTW_F_DIGPHY 0x00000002 /* digital PHY */ 101 #define RTW_F_DFLANTB 0x00000004 /* B antenna is default */ 102 #define RTW_F_ANTDIV 0x00000010 /* h/w antenna diversity */ 103 #define RTW_F_9356SROM 0x00000020 /* 93c56 SROM */ 104 #define RTW_F_SLEEP 0x00000040 /* chip is asleep */ 105 #define RTW_F_INVALID 0x00000080 /* chip is absent */ 106 #define RTW_F_DK_VALID 0x00000100 /* keys in DK0-DK3 are valid */ 107 #define RTW_C_RXWEP_40 0x00000200 /* h/w decrypts 40-bit WEP */ 108 #define RTW_C_RXWEP_104 0x00000400 /* h/w decrypts 104-bit WEP */ 109 /* all PHY flags */ 110 #define RTW_F_ALLPHY (RTW_F_DIGPHY|RTW_F_DFLANTB|RTW_F_ANTDIV) 111 enum rtw_access {RTW_ACCESS_NONE = 0, 112 RTW_ACCESS_CONFIG = 1, 113 RTW_ACCESS_ANAPARM = 2}; 114 115 struct rtw_regs { 116 bus_space_tag_t r_bt; 117 bus_space_handle_t r_bh; 118 enum rtw_access r_access; 119 }; 120 121 #define RTW_SR_GET(sr, ofs) \ 122 (((sr)->sr_content[(ofs)/2] >> (((ofs) % 2 == 0) ? 0 : 8)) & 0xff) 123 124 #define RTW_SR_GET16(sr, ofs) \ 125 (RTW_SR_GET((sr), (ofs)) | (RTW_SR_GET((sr), (ofs) + 1) << 8)) 126 127 struct rtw_srom { 128 uint16_t *sr_content; 129 uint16_t sr_size; 130 }; 131 132 struct rtw_rxsoft { 133 struct mbuf *rs_mbuf; 134 bus_dmamap_t rs_dmamap; 135 }; 136 137 struct rtw_txsoft { 138 SIMPLEQ_ENTRY(rtw_txsoft) ts_q; 139 struct mbuf *ts_mbuf; 140 bus_dmamap_t ts_dmamap; 141 struct ieee80211_node *ts_ni; /* destination node */ 142 u_int ts_first; /* 1st hw descriptor */ 143 u_int ts_last; /* last hw descriptor */ 144 struct ieee80211_duration ts_d0; 145 struct ieee80211_duration ts_dn; 146 }; 147 148 #define RTW_NTXPRI 4 /* number of Tx priorities */ 149 #define RTW_TXPRILO 0 150 #define RTW_TXPRIMD 1 151 #define RTW_TXPRIHI 2 152 #define RTW_TXPRIBCN 3 /* beacon priority */ 153 154 #define RTW_MAXPKTSEGS 64 /* Max 64 segments per Tx packet */ 155 156 #define CASSERT(cond, complaint) complaint[(cond) ? 0 : -1] = complaint[(cond) ? 0 : -1] 157 158 /* Note well: the descriptor rings must begin on RTW_DESC_ALIGNMENT 159 * boundaries. I allocate them consecutively from one buffer, so 160 * just round up. 161 */ 162 #define RTW_TXQLENLO 64 /* low-priority queue length */ 163 #define RTW_TXQLENMD 64 /* medium-priority */ 164 #define RTW_TXQLENHI 64 /* high-priority */ 165 #define RTW_TXQLENBCN 8 /* beacon */ 166 167 #define RTW_NTXDESCLO RTW_TXQLENLO 168 #define RTW_NTXDESCMD RTW_TXQLENMD 169 #define RTW_NTXDESCHI RTW_TXQLENHI 170 #define RTW_NTXDESCBCN RTW_TXQLENBCN 171 172 #define RTW_NTXDESCTOTAL (RTW_NTXDESCLO + RTW_NTXDESCMD + \ 173 RTW_NTXDESCHI + RTW_NTXDESCBCN) 174 175 #define RTW_RXQLEN 64 176 177 struct rtw_rxdesc_blk { 178 struct rtw_rxdesc *rdb_desc; 179 u_int rdb_next; 180 u_int rdb_ndesc; 181 bus_dma_tag_t rdb_dmat; 182 bus_dmamap_t rdb_dmamap; 183 }; 184 185 struct rtw_txdesc_blk { 186 u_int tdb_ndesc; 187 u_int tdb_next; 188 u_int tdb_nfree; 189 bus_dma_tag_t tdb_dmat; 190 bus_dmamap_t tdb_dmamap; 191 bus_addr_t tdb_physbase; 192 bus_addr_t tdb_ofs; 193 bus_size_t tdb_basereg; 194 uint32_t tdb_base; 195 struct rtw_txdesc *tdb_desc; 196 }; 197 198 #define RTW_NEXT_IDX(__htc, __idx) (((__idx) + 1) % (__htc)->tdb_ndesc) 199 200 #define RTW_NEXT_DESC(__htc, __idx) \ 201 ((__htc)->tdb_physbase + \ 202 sizeof(struct rtw_txdesc) * RTW_NEXT_IDX((__htc), (__idx))) 203 204 SIMPLEQ_HEAD(rtw_txq, rtw_txsoft); 205 206 struct rtw_txsoft_blk { 207 /* dirty/free s/w descriptors */ 208 struct rtw_txq tsb_dirtyq; 209 struct rtw_txq tsb_freeq; 210 u_int tsb_ndesc; 211 int tsb_tx_timer; 212 struct rtw_txsoft *tsb_desc; 213 uint8_t tsb_poll; 214 }; 215 216 struct rtw_descs { 217 struct rtw_txdesc hd_txlo[RTW_NTXDESCLO]; 218 struct rtw_txdesc hd_txmd[RTW_NTXDESCMD]; 219 struct rtw_txdesc hd_txhi[RTW_NTXDESCMD]; 220 struct rtw_rxdesc hd_rx[RTW_RXQLEN]; 221 struct rtw_txdesc hd_bcn[RTW_NTXDESCBCN]; 222 }; 223 #define RTW_DESC_OFFSET(ring, i) offsetof(struct rtw_descs, ring[i]) 224 #define RTW_RING_OFFSET(ring) RTW_DESC_OFFSET(ring, 0) 225 #define RTW_RING_BASE(sc, ring) ((sc)->sc_desc_physaddr + \ 226 RTW_RING_OFFSET(ring)) 227 228 /* Radio capture format for RTL8180. */ 229 230 #define RTW_RX_RADIOTAP_PRESENT \ 231 ((1 << IEEE80211_RADIOTAP_TSFT) | \ 232 (1 << IEEE80211_RADIOTAP_FLAGS) | \ 233 (1 << IEEE80211_RADIOTAP_RATE) | \ 234 (1 << IEEE80211_RADIOTAP_CHANNEL) | \ 235 (1 << IEEE80211_RADIOTAP_LOCK_QUALITY) | \ 236 (1 << IEEE80211_RADIOTAP_DB_ANTSIGNAL) | \ 237 0) 238 239 struct rtw_rx_radiotap_header { 240 struct ieee80211_radiotap_header rr_ihdr; 241 uint64_t rr_tsft; 242 uint8_t rr_flags; 243 uint8_t rr_rate; 244 uint16_t rr_chan_freq; 245 uint16_t rr_chan_flags; 246 uint16_t rr_barker_lock; 247 uint8_t rr_antsignal; 248 } __attribute__((__packed__)); 249 250 #define RTW_TX_RADIOTAP_PRESENT \ 251 ((1 << IEEE80211_RADIOTAP_FLAGS) | \ 252 (1 << IEEE80211_RADIOTAP_RATE) | \ 253 (1 << IEEE80211_RADIOTAP_CHANNEL) | \ 254 0) 255 256 struct rtw_tx_radiotap_header { 257 struct ieee80211_radiotap_header rt_ihdr; 258 uint8_t rt_flags; 259 uint8_t rt_rate; 260 uint16_t rt_chan_freq; 261 uint16_t rt_chan_flags; 262 } __attribute__((__packed__)); 263 264 enum rtw_attach_state {FINISHED, FINISH_DESCMAP_LOAD, FINISH_DESCMAP_CREATE, 265 FINISH_DESC_MAP, FINISH_DESC_ALLOC, FINISH_RXMAPS_CREATE, 266 FINISH_TXMAPS_CREATE, FINISH_RESET, FINISH_READ_SROM, FINISH_PARSE_SROM, 267 FINISH_RF_ATTACH, FINISH_ID_STA, FINISH_TXDESCBLK_SETUP, 268 FINISH_TXCTLBLK_SETUP, DETACHED}; 269 270 struct rtw_hooks { 271 void *rh_shutdown; /* shutdown hook */ 272 void *rh_power; /* power management hook */ 273 }; 274 275 struct rtw_mtbl { 276 int (*mt_newstate)(struct ieee80211com *, 277 enum ieee80211_state, int); 278 void (*mt_recv_mgmt)(struct ieee80211com *, 279 struct mbuf *, struct ieee80211_node *, 280 int, int, uint32_t); 281 struct ieee80211_node *(*mt_node_alloc)(struct ieee80211_node_table*); 282 void (*mt_node_free)(struct ieee80211_node *); 283 }; 284 285 enum rtw_pwrstate { RTW_OFF = 0, RTW_SLEEP, RTW_ON }; 286 287 typedef void (*rtw_continuous_tx_cb_t)(void *arg, int); 288 289 struct rtw_phy { 290 struct rtw_rf *p_rf; 291 struct rtw_regs *p_regs; 292 }; 293 294 struct rtw_bbpset { 295 u_int bb_antatten; 296 u_int bb_chestlim; 297 u_int bb_chsqlim; 298 u_int bb_ifagcdet; 299 u_int bb_ifagcini; 300 u_int bb_ifagclimit; 301 u_int bb_lnadet; 302 u_int bb_sys1; 303 u_int bb_sys2; 304 u_int bb_sys3; 305 u_int bb_trl; 306 u_int bb_txagc; 307 }; 308 309 struct rtw_rf { 310 void (*rf_destroy)(struct rtw_rf *); 311 /* args: frequency, txpower, power state */ 312 int (*rf_init)(struct rtw_rf *, u_int, uint8_t, 313 enum rtw_pwrstate); 314 /* arg: power state */ 315 int (*rf_pwrstate)(struct rtw_rf *, enum rtw_pwrstate); 316 /* arg: frequency */ 317 int (*rf_tune)(struct rtw_rf *, u_int); 318 /* arg: txpower */ 319 int (*rf_txpower)(struct rtw_rf *, uint8_t); 320 rtw_continuous_tx_cb_t rf_continuous_tx_cb; 321 void *rf_continuous_tx_arg; 322 struct rtw_bbpset rf_bbpset; 323 }; 324 325 static inline void 326 rtw_rf_destroy(struct rtw_rf *rf) 327 { 328 (*rf->rf_destroy)(rf); 329 } 330 331 static inline int 332 rtw_rf_init(struct rtw_rf *rf, u_int freq, uint8_t opaque_txpower, 333 enum rtw_pwrstate power) 334 { 335 return (*rf->rf_init)(rf, freq, opaque_txpower, power); 336 } 337 338 static inline int 339 rtw_rf_pwrstate(struct rtw_rf *rf, enum rtw_pwrstate power) 340 { 341 return (*rf->rf_pwrstate)(rf, power); 342 } 343 344 static inline int 345 rtw_rf_tune(struct rtw_rf *rf, u_int freq) 346 { 347 return (*rf->rf_tune)(rf, freq); 348 } 349 350 static inline int 351 rtw_rf_txpower(struct rtw_rf *rf, uint8_t opaque_txpower) 352 { 353 return (*rf->rf_txpower)(rf, opaque_txpower); 354 } 355 356 typedef int (*rtw_rf_write_t)(struct rtw_regs *, enum rtw_rfchipid, u_int, 357 uint32_t); 358 359 struct rtw_rfbus { 360 struct rtw_regs *b_regs; 361 rtw_rf_write_t b_write; 362 }; 363 364 static inline int 365 rtw_rfbus_write(struct rtw_rfbus *bus, enum rtw_rfchipid rfchipid, u_int addr, 366 uint32_t val) 367 { 368 return (*bus->b_write)(bus->b_regs, rfchipid, addr, val); 369 } 370 371 struct rtw_max2820 { 372 struct rtw_rf mx_rf; 373 struct rtw_rfbus mx_bus; 374 int mx_is_a; /* 1: MAX2820A/MAX2821A */ 375 }; 376 377 struct rtw_grf5101 { 378 struct rtw_rf gr_rf; 379 struct rtw_rfbus gr_bus; 380 }; 381 382 struct rtw_sa2400 { 383 struct rtw_rf sa_rf; 384 struct rtw_rfbus sa_bus; 385 int sa_digphy; /* 1: digital PHY */ 386 }; 387 388 typedef void (*rtw_pwrstate_t)(struct rtw_regs *, enum rtw_pwrstate, int, int); 389 390 union rtw_keys { 391 uint8_t rk_keys[4][16]; 392 uint32_t rk_words[16]; 393 }; 394 395 #define RTW_LED_SLOW_TICKS MAX(1, hz/2) 396 #define RTW_LED_FAST_TICKS MAX(1, hz/10) 397 398 struct rtw_led_state { 399 #define RTW_LED0 0x1 400 #define RTW_LED1 0x2 401 uint8_t ls_slowblink:2; 402 uint8_t ls_actblink:2; 403 uint8_t ls_default:2; 404 uint8_t ls_state; 405 uint8_t ls_event; 406 #define RTW_LED_S_RX 0x1 407 #define RTW_LED_S_TX 0x2 408 #define RTW_LED_S_SLOW 0x4 409 struct callout ls_slow_ch; 410 struct callout ls_fast_ch; 411 }; 412 413 struct rtw_softc { 414 struct device sc_dev; 415 struct ethercom sc_ec; 416 struct ieee80211com sc_ic; 417 struct rtw_regs sc_regs; 418 bus_dma_tag_t sc_dmat; 419 uint32_t sc_flags; 420 421 enum rtw_attach_state sc_attach_state; 422 enum rtw_rfchipid sc_rfchipid; 423 enum rtw_locale sc_locale; 424 uint8_t sc_phydelay; 425 426 /* s/w Tx/Rx descriptors */ 427 struct rtw_txsoft_blk sc_txsoft_blk[RTW_NTXPRI]; 428 struct rtw_txdesc_blk sc_txdesc_blk[RTW_NTXPRI]; 429 430 struct rtw_rxsoft sc_rxsoft[RTW_RXQLEN]; 431 struct rtw_rxdesc_blk sc_rxdesc_blk; 432 433 struct rtw_descs *sc_descs; 434 435 bus_dma_segment_t sc_desc_segs; 436 int sc_desc_nsegs; 437 bus_dmamap_t sc_desc_dmamap; 438 #define sc_desc_physaddr sc_desc_dmamap->dm_segs[0].ds_addr 439 440 struct rtw_srom sc_srom; 441 442 enum rtw_pwrstate sc_pwrstate; 443 444 rtw_pwrstate_t sc_pwrstate_cb; 445 446 struct rtw_rf *sc_rf; 447 448 uint16_t sc_inten; 449 450 /* interrupt acknowledge hook */ 451 void (*sc_intr_ack)(struct rtw_regs *); 452 453 int (*sc_enable)(struct rtw_softc *); 454 void (*sc_disable)(struct rtw_softc *); 455 void (*sc_power)(struct rtw_softc *, int); 456 struct rtw_mtbl sc_mtbl; 457 struct rtw_hooks sc_hooks; 458 459 caddr_t sc_radiobpf; 460 461 struct callout sc_scan_ch; 462 u_int sc_cur_chan; 463 464 uint32_t sc_tsfth; /* most significant TSFT bits */ 465 uint32_t sc_rcr; /* RTW_RCR */ 466 uint8_t sc_csthr; /* carrier-sense threshold */ 467 468 int sc_do_tick; /* indicate 1s ticks */ 469 struct timeval sc_tick0; /* first tick */ 470 471 uint8_t sc_rev; /* PCI/Cardbus revision */ 472 473 uint32_t sc_anaparm; /* register RTW_ANAPARM */ 474 475 union { 476 struct rtw_rx_radiotap_header tap; 477 uint8_t pad[64]; 478 } sc_rxtapu; 479 union { 480 struct rtw_tx_radiotap_header tap; 481 uint8_t pad[64]; 482 } sc_txtapu; 483 union rtw_keys sc_keys; 484 struct ifqueue sc_beaconq; 485 struct rtw_led_state sc_led_state; 486 int sc_hwverid; 487 }; 488 489 #define sc_if sc_ec.ec_if 490 #define sc_rxtap sc_rxtapu.tap 491 #define sc_txtap sc_txtapu.tap 492 493 extern int rtw_host_rfio; 494 495 void rtw_txdac_enable(struct rtw_softc *, int); 496 void rtw_anaparm_enable(struct rtw_regs *, int); 497 void rtw_config0123_enable(struct rtw_regs *, int); 498 void rtw_continuous_tx_enable(struct rtw_softc *, int); 499 void rtw_set_access(struct rtw_regs *, enum rtw_access); 500 501 void rtw_attach(struct rtw_softc *); 502 int rtw_detach(struct rtw_softc *); 503 int rtw_intr(void *); 504 505 void rtw_disable(struct rtw_softc *); 506 int rtw_enable(struct rtw_softc *); 507 508 int rtw_activate(struct device *, enum devact); 509 void rtw_power(int, void *); 510 void rtw_shutdown(void *); 511 512 const char *rtw_pwrstate_string(enum rtw_pwrstate); 513 514 #endif /* _DEV_IC_RTWVAR_H_ */ 515