rtwvar.h revision 1.6
1 /* $NetBSD: rtwvar.h,v 1.6 2004/12/20 23:05:41 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 extern int rtw_debug; 41 #define RTW_DPRINTF(x) if (rtw_debug > 0) printf x 42 #define RTW_DPRINTF2(x) if (rtw_debug > 1) printf x 43 #define RTW_DPRINTF3(x) if (rtw_debug > 2) printf x 44 #define DPRINTF(sc, x) if ((sc)->sc_ic.ic_if.if_flags & IFF_DEBUG) printf x 45 #define DPRINTF2(sc, x) if ((sc)->sc_ic.ic_if.if_flags & IFF_DEBUG) RTW_DPRINTF2(x) 46 #define DPRINTF3(sc, x) if ((sc)->sc_ic.ic_if.if_flags & IFF_DEBUG) RTW_DPRINTF3(x) 47 #else /* RTW_DEBUG */ 48 #define RTW_DPRINTF(x) 49 #define RTW_DPRINTF2(x) 50 #define RTW_DPRINTF3(x) 51 #define DPRINTF(sc, x) 52 #define DPRINTF2(sc, x) 53 #define DPRINTF3(sc, x) 54 #endif /* RTW_DEBUG */ 55 56 #if 0 57 enum rtw_rftype { 58 RTW_RFTYPE_INTERSIL = 0, 59 RTW_RFTYPE_RFMD, 60 RTW_RFTYPE_PHILIPS, 61 RTW_RFTYPE_MAXIM 62 }; 63 #endif 64 65 enum rtw_locale { 66 RTW_LOCALE_USA = 0, 67 RTW_LOCALE_EUROPE, 68 RTW_LOCALE_JAPAN, 69 RTW_LOCALE_UNKNOWN 70 }; 71 72 enum rtw_rfchipid { 73 RTW_RFCHIPID_RESERVED = 0, 74 RTW_RFCHIPID_INTERSIL = 1, 75 RTW_RFCHIPID_RFMD = 2, 76 RTW_RFCHIPID_PHILIPS = 3, 77 RTW_RFCHIPID_MAXIM = 4, 78 RTW_RFCHIPID_GCT = 5 79 }; 80 81 /* sc_flags */ 82 #define RTW_F_ENABLED 0x00000001 /* chip is enabled */ 83 #define RTW_F_DIGPHY 0x00000002 /* digital PHY */ 84 #define RTW_F_DFLANTB 0x00000004 /* B antenna is default */ 85 #define RTW_F_ANTDIV 0x00000010 /* h/w antenna diversity */ 86 #define RTW_F_9356SROM 0x00000020 /* 93c56 SROM */ 87 #define RTW_F_SLEEP 0x00000040 /* chip is asleep */ 88 #define RTW_F_INVALID 0x00000080 /* chip is absent */ 89 /* all PHY flags */ 90 #define RTW_F_ALLPHY (RTW_F_DIGPHY|RTW_F_DFLANTB|RTW_F_ANTDIV) 91 92 struct rtw_regs { 93 bus_space_tag_t r_bt; 94 bus_space_handle_t r_bh; 95 }; 96 97 #define RTW_SR_GET(sr, ofs) \ 98 (((sr)->sr_content[(ofs)/2] >> (((ofs) % 2 == 0) ? 0 : 8)) & 0xff) 99 100 #define RTW_SR_GET16(sr, ofs) \ 101 (RTW_SR_GET((sr), (ofs)) | (RTW_SR_GET((sr), (ofs) + 1) << 8)) 102 103 struct rtw_srom { 104 u_int16_t *sr_content; 105 u_int16_t sr_size; 106 }; 107 108 struct rtw_rxctl { 109 struct mbuf *srx_mbuf; 110 bus_dmamap_t srx_dmamap; 111 }; 112 113 struct rtw_txctl { 114 SIMPLEQ_ENTRY(rtw_txctl) stx_q; 115 struct mbuf *stx_mbuf; 116 bus_dmamap_t stx_dmamap; 117 struct ieee80211_node *stx_ni; /* destination node */ 118 u_int stx_first; /* 1st hw descriptor */ 119 u_int stx_last; /* last hw descriptor */ 120 struct ieee80211_duration stx_d0; 121 struct ieee80211_duration stx_dn; 122 }; 123 124 #define RTW_NTXPRI 4 /* number of Tx priorities */ 125 #define RTW_TXPRILO 0 126 #define RTW_TXPRIMD 1 127 #define RTW_TXPRIHI 2 128 #define RTW_TXPRIBCN 3 /* beacon priority */ 129 130 #define RTW_MAXPKTSEGS 32 /* max 32 segments per Tx packet */ 131 132 #define CASSERT(cond, complaint) complaint[(cond) ? 0 : -1] = complaint[(cond) ? 0 : -1] 133 134 #define RTW_NTXDESC_ROUNDUP(n) \ 135 roundup(n, RTW_DESC_ALIGNMENT / sizeof(struct rtw_txdesc)) 136 137 #define RTW_TXQLEN_ROUNDUP(n) \ 138 (RTW_NTXDESC_ROUNDUP(n * RTW_MAXPKTSEGS) / RTW_MAXPKTSEGS) 139 140 #define RTW_RXQLEN_ROUNDUP(n) \ 141 roundup(n, RTW_DESC_ALIGNMENT / sizeof(struct rtw_rxctl)) 142 143 /* The descriptor rings must begin on RTW_DESC_ALIGNMENT boundaries. 144 * I allocate them consecutively from one buffer, so just round up. 145 */ 146 #define RTW_TXQLENLO RTW_TXQLEN_ROUNDUP(64) /* low-priority queue length */ 147 #define RTW_TXQLENMD RTW_TXQLEN_ROUNDUP(32) /* medium-priority */ 148 #define RTW_TXQLENHI RTW_TXQLEN_ROUNDUP(16) /* high-priority */ 149 #define RTW_TXQLENBCN 1 /* beacon */ 150 151 #define RTW_NTXDESCLO (RTW_TXQLENLO * RTW_MAXPKTSEGS) 152 #define RTW_NTXDESCMD (RTW_TXQLENMD * RTW_MAXPKTSEGS) 153 #define RTW_NTXDESCHI (RTW_TXQLENHI * RTW_MAXPKTSEGS) 154 #define RTW_NTXDESCBCN (RTW_TXQLENBCN * RTW_MAXPKTSEGS) 155 156 #define RTW_NTXDESCTOTAL (RTW_NTXDESCLO + RTW_NTXDESCMD + \ 157 RTW_NTXDESCHI + RTW_NTXDESCBCN) 158 159 #define RTW_RXQLEN RTW_RXQLEN_ROUNDUP(32) 160 #define RTW_NRXDESC RTW_RXQLEN 161 162 struct rtw_txdesc_blk { 163 u_int htc_ndesc; 164 u_int htc_next; 165 u_int htc_nfree; 166 bus_addr_t htc_physbase; 167 bus_addr_t htc_ofs; 168 struct rtw_txdesc *htc_desc; 169 }; 170 171 #define RTW_NEXT_IDX(__htc, __idx) (((__idx) + 1) % (__htc)->htc_ndesc) 172 173 #define RTW_NEXT_DESC(__htc, __idx) \ 174 ((__htc)->htc_physbase + \ 175 sizeof(struct rtw_txdesc) * RTW_NEXT_IDX((__htc), (__idx))) 176 177 SIMPLEQ_HEAD(rtw_txq, rtw_txctl); 178 179 struct rtw_txctl_blk { 180 /* dirty/free s/w descriptors */ 181 struct rtw_txq stc_dirtyq; 182 struct rtw_txq stc_freeq; 183 u_int stc_ndesc; 184 int stc_tx_timer; 185 struct rtw_txctl *stc_desc; 186 }; 187 188 struct rtw_descs { 189 struct rtw_txdesc hd_txlo[RTW_NTXDESCLO]; 190 struct rtw_txdesc hd_txmd[RTW_NTXDESCMD]; 191 struct rtw_txdesc hd_txhi[RTW_NTXDESCMD]; 192 struct rtw_rxdesc hd_rx[RTW_NRXDESC]; 193 struct rtw_txdesc hd_bcn[RTW_NTXDESCBCN]; 194 }; 195 #define RTW_DESC_OFFSET(ring, i) offsetof(struct rtw_descs, ring[i]) 196 #define RTW_RING_OFFSET(ring) RTW_DESC_OFFSET(ring, 0) 197 #define RTW_RING_BASE(sc, ring) ((sc)->sc_desc_physaddr + \ 198 RTW_RING_OFFSET(ring)) 199 200 /* Radio capture format for RTL8180. */ 201 202 #define RTW_RX_RADIOTAP_PRESENT \ 203 ((1 << IEEE80211_RADIOTAP_FLAGS) | (1 << IEEE80211_RADIOTAP_RATE) | \ 204 (1 << IEEE80211_RADIOTAP_CHANNEL) | \ 205 (1 << IEEE80211_RADIOTAP_DB_ANTSIGNAL)) 206 207 struct rtw_rx_radiotap_header { 208 struct ieee80211_radiotap_header rr_ihdr; 209 u_int8_t rr_flags; 210 u_int8_t rr_rate; 211 u_int16_t rr_chan_freq; 212 u_int16_t rr_chan_flags; 213 u_int8_t rr_antsignal; 214 } __attribute__((__packed__)); 215 216 #define RTW_TX_RADIOTAP_PRESENT ((1 << IEEE80211_RADIOTAP_FLAGS) | \ 217 (1 << IEEE80211_RADIOTAP_RATE) | \ 218 (1 << IEEE80211_RADIOTAP_CHANNEL)) 219 220 struct rtw_tx_radiotap_header { 221 struct ieee80211_radiotap_header rt_ihdr; 222 u_int8_t rt_flags; 223 u_int8_t rt_rate; 224 u_int16_t rt_chan_freq; 225 u_int16_t rt_chan_flags; 226 } __attribute__((__packed__)); 227 228 enum rtw_attach_state {FINISHED, FINISH_DESCMAP_LOAD, FINISH_DESCMAP_CREATE, 229 FINISH_DESC_MAP, FINISH_DESC_ALLOC, FINISH_RXMAPS_CREATE, 230 FINISH_TXMAPS_CREATE, FINISH_RESET, FINISH_READ_SROM, FINISH_PARSE_SROM, 231 FINISH_RF_ATTACH, FINISH_ID_STA, FINISH_TXDESCBLK_SETUP, 232 FINISH_TXCTLBLK_SETUP, DETACHED}; 233 234 struct rtw_hooks { 235 void *rh_shutdown; /* shutdown hook */ 236 void *rh_power; /* power management hook */ 237 }; 238 239 struct rtw_mtbl { 240 int (*mt_newstate)(struct ieee80211com *, 241 enum ieee80211_state, int); 242 void (*mt_recv_mgmt)(struct ieee80211com *, 243 struct mbuf *, struct ieee80211_node *, 244 int, int, u_int32_t); 245 struct ieee80211_node *(*mt_node_alloc)(struct ieee80211com *); 246 void (*mt_node_free)(struct ieee80211com *, 247 struct ieee80211_node *); 248 }; 249 250 enum rtw_pwrstate { RTW_OFF = 0, RTW_SLEEP, RTW_ON }; 251 252 typedef void (*rtw_continuous_tx_cb_t)(void *arg, int); 253 254 struct rtw_phy { 255 struct rtw_rf *p_rf; 256 struct rtw_regs *p_regs; 257 }; 258 259 struct rtw_bbpset { 260 u_int bb_antatten; 261 u_int bb_chestlim; 262 u_int bb_chsqlim; 263 u_int bb_ifagcdet; 264 u_int bb_ifagcini; 265 u_int bb_ifagclimit; 266 u_int bb_lnadet; 267 u_int bb_sys1; 268 u_int bb_sys2; 269 u_int bb_sys3; 270 u_int bb_trl; 271 u_int bb_txagc; 272 }; 273 274 struct rtw_rf { 275 void (*rf_destroy)(struct rtw_rf *); 276 /* args: frequency, txpower, power state */ 277 int (*rf_init)(struct rtw_rf *, u_int, u_int8_t, 278 enum rtw_pwrstate); 279 /* arg: power state */ 280 int (*rf_pwrstate)(struct rtw_rf *, enum rtw_pwrstate); 281 /* arg: frequency */ 282 int (*rf_tune)(struct rtw_rf *, u_int); 283 /* arg: txpower */ 284 int (*rf_txpower)(struct rtw_rf *, u_int8_t); 285 rtw_continuous_tx_cb_t rf_continuous_tx_cb; 286 void *rf_continuous_tx_arg; 287 struct rtw_bbpset rf_bbpset; 288 }; 289 290 static __inline void 291 rtw_rf_destroy(struct rtw_rf *rf) 292 { 293 (*rf->rf_destroy)(rf); 294 } 295 296 static __inline int 297 rtw_rf_init(struct rtw_rf *rf, u_int freq, u_int8_t opaque_txpower, 298 enum rtw_pwrstate power) 299 { 300 return (*rf->rf_init)(rf, freq, opaque_txpower, power); 301 } 302 303 static __inline int 304 rtw_rf_pwrstate(struct rtw_rf *rf, enum rtw_pwrstate power) 305 { 306 return (*rf->rf_pwrstate)(rf, power); 307 } 308 309 static __inline int 310 rtw_rf_tune(struct rtw_rf *rf, u_int freq) 311 { 312 return (*rf->rf_tune)(rf, freq); 313 } 314 315 static __inline int 316 rtw_rf_txpower(struct rtw_rf *rf, u_int8_t opaque_txpower) 317 { 318 return (*rf->rf_txpower)(rf, opaque_txpower); 319 } 320 321 typedef int (*rtw_rf_write_t)(struct rtw_regs *, enum rtw_rfchipid, u_int, 322 u_int32_t); 323 324 struct rtw_rfbus { 325 struct rtw_regs *b_regs; 326 rtw_rf_write_t b_write; 327 }; 328 329 static __inline int 330 rtw_rfbus_write(struct rtw_rfbus *bus, enum rtw_rfchipid rfchipid, u_int addr, 331 u_int32_t val) 332 { 333 return (*bus->b_write)(bus->b_regs, rfchipid, addr, val); 334 } 335 336 struct rtw_max2820 { 337 struct rtw_rf mx_rf; 338 struct rtw_rfbus mx_bus; 339 int mx_is_a; /* 1: MAX2820A/MAX2821A */ 340 }; 341 342 struct rtw_sa2400 { 343 struct rtw_rf sa_rf; 344 struct rtw_rfbus sa_bus; 345 int sa_digphy; /* 1: digital PHY */ 346 }; 347 348 typedef void (*rtw_pwrstate_t)(struct rtw_regs *, enum rtw_pwrstate, int, int); 349 350 enum rtw_access {RTW_ACCESS_NONE = 0, 351 RTW_ACCESS_CONFIG = 1, 352 RTW_ACCESS_ANAPARM = 2}; 353 354 struct rtw_softc { 355 struct device sc_dev; 356 struct ieee80211com sc_ic; 357 struct rtw_regs sc_regs; 358 bus_dma_tag_t sc_dmat; 359 u_int32_t sc_flags; 360 361 #if 0 362 enum rtw_rftype sc_rftype; 363 #endif 364 enum rtw_attach_state sc_attach_state; 365 enum rtw_rfchipid sc_rfchipid; 366 enum rtw_locale sc_locale; 367 u_int8_t sc_phydelay; 368 369 /* s/w Tx/Rx descriptors */ 370 struct rtw_txctl_blk sc_txctl_blk[RTW_NTXPRI]; 371 struct rtw_rxctl sc_rxctl[RTW_RXQLEN]; 372 u_int sc_txq; 373 u_int sc_txnext; 374 375 struct rtw_txdesc_blk sc_txdesc_blk[RTW_NTXPRI]; 376 struct rtw_rxdesc *sc_rxdesc; 377 u_int sc_rxnext; 378 379 struct rtw_descs *sc_descs; 380 381 bus_dma_segment_t sc_desc_segs; 382 int sc_desc_nsegs; 383 bus_dmamap_t sc_desc_dmamap; 384 #define sc_desc_physaddr sc_desc_dmamap->dm_segs[0].ds_addr 385 386 struct rtw_srom sc_srom; 387 388 enum rtw_pwrstate sc_pwrstate; 389 390 rtw_pwrstate_t sc_pwrstate_cb; 391 392 struct rtw_rf *sc_rf; 393 394 u_int16_t sc_inten; 395 396 /* interrupt acknowledge hook */ 397 void (*sc_intr_ack) __P((struct rtw_regs *)); 398 399 int (*sc_enable)(struct rtw_softc *); 400 void (*sc_disable)(struct rtw_softc *); 401 void (*sc_power)(struct rtw_softc *, int); 402 struct rtw_mtbl sc_mtbl; 403 struct rtw_hooks sc_hooks; 404 405 caddr_t sc_radiobpf; 406 407 struct callout sc_scan_ch; 408 u_int sc_cur_chan; 409 410 u_int32_t sc_tsfth; /* most significant TSFT bits */ 411 u_int32_t sc_rcr; /* RTW_RCR */ 412 u_int8_t sc_csthr; /* carrier-sense threshold */ 413 414 int sc_do_tick; /* indicate 1s ticks */ 415 struct timeval sc_tick0; /* first tick */ 416 417 uint8_t sc_rev; /* PCI/Cardbus revision */ 418 419 uint32_t sc_anaparm; /* register RTW_ANAPARM */ 420 421 union { 422 struct rtw_rx_radiotap_header tap; 423 u_int8_t pad[64]; 424 } sc_rxtapu; 425 union { 426 struct rtw_tx_radiotap_header tap; 427 u_int8_t pad[64]; 428 } sc_txtapu; 429 enum rtw_access sc_access; 430 }; 431 432 #define sc_if sc_ic.ic_if 433 #define sc_rxtap sc_rxtapu.tap 434 #define sc_txtap sc_txtapu.tap 435 436 extern int rtw_host_rfio; 437 extern int rtw_flush_rfio; 438 extern int rtw_rfio_delay; 439 440 void rtw_txdac_enable(struct rtw_softc *, int); 441 void rtw_anaparm_enable(struct rtw_regs *, int); 442 void rtw_config0123_enable(struct rtw_regs *, int); 443 void rtw_continuous_tx_enable(struct rtw_softc *, int); 444 void rtw_set_access(struct rtw_softc *, enum rtw_access); 445 446 void rtw_attach(struct rtw_softc *); 447 int rtw_detach(struct rtw_softc *); 448 int rtw_intr(void *); 449 450 void rtw_disable(struct rtw_softc *); 451 int rtw_enable(struct rtw_softc *); 452 453 int rtw_activate(struct device *, enum devact); 454 void rtw_power(int, void *); 455 void rtw_shutdown(void *); 456 457 const char *rtw_pwrstate_string(enum rtw_pwrstate); 458 459 #endif /* _DEV_IC_RTWVAR_H_ */ 460
Indexes created Fri Sep 26 20:09:58 GMT 2025