rtwvar.h revision 1.2
1 /* $NetBSD: rtwvar.h,v 1.2 2004/12/12 06:37:59 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 }; 121 122 #define RTW_NTXPRI 4 /* number of Tx priorities */ 123 #define RTW_TXPRILO 0 124 #define RTW_TXPRIMD 1 125 #define RTW_TXPRIHI 2 126 #define RTW_TXPRIBCN 3 /* beacon priority */ 127 128 #define RTW_MAXPKTSEGS 32 /* max 32 segments per Tx packet */ 129 130 #define CASSERT(cond, complaint) complaint[(cond) ? 0 : -1] = complaint[(cond) ? 0 : -1] 131 132 #define RTW_NTXDESC_ROUNDUP(n) \ 133 roundup(n, RTW_DESC_ALIGNMENT / sizeof(struct rtw_txdesc)) 134 135 #define RTW_TXQLEN_ROUNDUP(n) \ 136 (RTW_NTXDESC_ROUNDUP(n * RTW_MAXPKTSEGS) / RTW_MAXPKTSEGS) 137 138 #define RTW_RXQLEN_ROUNDUP(n) \ 139 roundup(n, RTW_DESC_ALIGNMENT / sizeof(struct rtw_rxctl)) 140 141 /* The descriptor rings must begin on RTW_DESC_ALIGNMENT boundaries. 142 * I allocate them consecutively from one buffer, so just round up. 143 */ 144 #define RTW_TXQLENLO RTW_TXQLEN_ROUNDUP(64) /* high-priority queue length */ 145 #define RTW_TXQLENMD RTW_TXQLEN_ROUNDUP(32) /* medium-priority */ 146 #define RTW_TXQLENHI RTW_TXQLEN_ROUNDUP(16) /* high-priority */ 147 #define RTW_TXQLENBCN 1 /* beacon */ 148 149 #define RTW_NTXDESCLO (RTW_TXQLENLO * RTW_MAXPKTSEGS) 150 #define RTW_NTXDESCMD (RTW_TXQLENMD * RTW_MAXPKTSEGS) 151 #define RTW_NTXDESCHI (RTW_TXQLENHI * RTW_MAXPKTSEGS) 152 #define RTW_NTXDESCBCN (RTW_TXQLENBCN * RTW_MAXPKTSEGS) 153 154 #define RTW_NTXDESCTOTAL (RTW_NTXDESCLO + RTW_NTXDESCMD + \ 155 RTW_NTXDESCHI + RTW_NTXDESCBCN) 156 157 #define RTW_RXQLEN RTW_RXQLEN_ROUNDUP(32) 158 #define RTW_NRXDESC RTW_RXQLEN 159 160 struct rtw_txdesc_blk { 161 u_int htc_ndesc; 162 u_int htc_next; 163 u_int htc_nfree; 164 bus_addr_t htc_physbase; 165 bus_addr_t htc_ofs; 166 struct rtw_txdesc *htc_desc; 167 }; 168 169 #define RTW_NEXT_DESC(htc, idx) \ 170 (htc->htc_physbase + \ 171 sizeof(struct rtw_txdesc) * ((idx + 1) % htc->htc_ndesc)) 172 173 SIMPLEQ_HEAD(rtw_txq, rtw_txctl); 174 175 struct rtw_txctl_blk { 176 /* dirty/free s/w descriptors */ 177 struct rtw_txq stc_dirtyq; 178 struct rtw_txq stc_freeq; 179 u_int stc_ndesc; 180 struct rtw_txctl *stc_desc; 181 }; 182 183 struct rtw_descs { 184 struct rtw_txdesc hd_txlo[RTW_NTXDESCLO]; 185 struct rtw_txdesc hd_txmd[RTW_NTXDESCMD]; 186 struct rtw_txdesc hd_txhi[RTW_NTXDESCMD]; 187 struct rtw_rxdesc hd_rx[RTW_NRXDESC]; 188 struct rtw_txdesc hd_bcn[RTW_NTXDESCBCN]; 189 }; 190 #define RTW_DESC_OFFSET(ring, i) offsetof(struct rtw_descs, ring[i]) 191 #define RTW_RING_OFFSET(ring) RTW_DESC_OFFSET(ring, 0) 192 #define RTW_RING_BASE(sc, ring) ((sc)->sc_desc_physaddr + \ 193 RTW_RING_OFFSET(ring)) 194 195 /* Radio capture format for RTL8180. */ 196 197 #define RTW_RX_RADIOTAP_PRESENT \ 198 ((1 << IEEE80211_RADIOTAP_FLAGS) | (1 << IEEE80211_RADIOTAP_RATE) | \ 199 (1 << IEEE80211_RADIOTAP_CHANNEL) | \ 200 (1 << IEEE80211_RADIOTAP_DB_ANTSIGNAL)) 201 202 struct rtw_rx_radiotap_header { 203 struct ieee80211_radiotap_header rr_ihdr; 204 u_int8_t rr_flags; 205 u_int8_t rr_rate; 206 u_int16_t rr_chan_freq; 207 u_int16_t rr_chan_flags; 208 u_int8_t rr_antsignal; 209 } __attribute__((__packed__)); 210 211 #define RTW_TX_RADIOTAP_PRESENT ((1 << IEEE80211_RADIOTAP_FLAGS) | \ 212 (1 << IEEE80211_RADIOTAP_RATE) | \ 213 (1 << IEEE80211_RADIOTAP_CHANNEL)) 214 215 struct rtw_tx_radiotap_header { 216 struct ieee80211_radiotap_header rt_ihdr; 217 u_int8_t rt_flags; 218 u_int8_t rt_rate; 219 u_int16_t rt_chan_freq; 220 u_int16_t rt_chan_flags; 221 } __attribute__((__packed__)); 222 223 enum rtw_attach_state {FINISHED, FINISH_DESCMAP_LOAD, FINISH_DESCMAP_CREATE, 224 FINISH_DESC_MAP, FINISH_DESC_ALLOC, FINISH_RXMAPS_CREATE, 225 FINISH_TXMAPS_CREATE, FINISH_RESET, FINISH_READ_SROM, FINISH_PARSE_SROM, 226 FINISH_RF_ATTACH, FINISH_ID_STA, FINISH_TXDESCBLK_SETUP, 227 FINISH_TXCTLBLK_SETUP, DETACHED}; 228 229 struct rtw_hooks { 230 void *rh_shutdown; /* shutdown hook */ 231 void *rh_power; /* power management hook */ 232 }; 233 234 struct rtw_mtbl { 235 int (*mt_newstate)(struct ieee80211com *, 236 enum ieee80211_state, int); 237 void (*mt_recv_mgmt)(struct ieee80211com *, 238 struct mbuf *, struct ieee80211_node *, 239 int, int, u_int32_t); 240 struct ieee80211_node *(*mt_node_alloc)(struct ieee80211com *); 241 void (*mt_node_free)(struct ieee80211com *, 242 struct ieee80211_node *); 243 }; 244 245 enum rtw_pwrstate { RTW_OFF = 0, RTW_SLEEP, RTW_ON }; 246 247 typedef void (*rtw_continuous_tx_cb_t)(void *arg, int); 248 249 struct rtw_phy { 250 struct rtw_rf *p_rf; 251 struct rtw_regs *p_regs; 252 }; 253 254 struct rtw_bbpset { 255 u_int bb_antatten; 256 u_int bb_chestlim; 257 u_int bb_chsqlim; 258 u_int bb_ifagcdet; 259 u_int bb_ifagcini; 260 u_int bb_ifagclimit; 261 u_int bb_lnadet; 262 u_int bb_sys1; 263 u_int bb_sys2; 264 u_int bb_sys3; 265 u_int bb_trl; 266 u_int bb_txagc; 267 }; 268 269 struct rtw_rf { 270 void (*rf_destroy)(struct rtw_rf *); 271 /* args: frequency, txpower, power state */ 272 int (*rf_init)(struct rtw_rf *, u_int, u_int8_t, 273 enum rtw_pwrstate); 274 /* arg: power state */ 275 int (*rf_pwrstate)(struct rtw_rf *, enum rtw_pwrstate); 276 /* arg: frequency */ 277 int (*rf_tune)(struct rtw_rf *, u_int); 278 /* arg: txpower */ 279 int (*rf_txpower)(struct rtw_rf *, u_int8_t); 280 rtw_continuous_tx_cb_t rf_continuous_tx_cb; 281 void *rf_continuous_tx_arg; 282 struct rtw_bbpset rf_bbpset; 283 }; 284 285 static __inline void 286 rtw_rf_destroy(struct rtw_rf *rf) 287 { 288 (*rf->rf_destroy)(rf); 289 } 290 291 static __inline int 292 rtw_rf_init(struct rtw_rf *rf, u_int freq, u_int8_t opaque_txpower, 293 enum rtw_pwrstate power) 294 { 295 return (*rf->rf_init)(rf, freq, opaque_txpower, power); 296 } 297 298 static __inline int 299 rtw_rf_pwrstate(struct rtw_rf *rf, enum rtw_pwrstate power) 300 { 301 return (*rf->rf_pwrstate)(rf, power); 302 } 303 304 static __inline int 305 rtw_rf_tune(struct rtw_rf *rf, u_int freq) 306 { 307 return (*rf->rf_tune)(rf, freq); 308 } 309 310 static __inline int 311 rtw_rf_txpower(struct rtw_rf *rf, u_int8_t opaque_txpower) 312 { 313 return (*rf->rf_txpower)(rf, opaque_txpower); 314 } 315 316 typedef int (*rtw_rf_write_t)(struct rtw_regs *, enum rtw_rfchipid, u_int, 317 u_int32_t); 318 319 struct rtw_rfbus { 320 struct rtw_regs *b_regs; 321 rtw_rf_write_t b_write; 322 }; 323 324 static __inline int 325 rtw_rfbus_write(struct rtw_rfbus *bus, enum rtw_rfchipid rfchipid, u_int addr, 326 u_int32_t val) 327 { 328 return (*bus->b_write)(bus->b_regs, rfchipid, addr, val); 329 } 330 331 struct rtw_max2820 { 332 struct rtw_rf mx_rf; 333 struct rtw_rfbus mx_bus; 334 int mx_is_a; /* 1: MAX2820A/MAX2821A */ 335 }; 336 337 struct rtw_sa2400 { 338 struct rtw_rf sa_rf; 339 struct rtw_rfbus sa_bus; 340 int sa_digphy; /* 1: digital PHY */ 341 }; 342 343 typedef void (*rtw_pwrstate_t)(struct rtw_regs *, enum rtw_pwrstate, int); 344 345 enum rtw_access {RTW_ACCESS_NONE = 0, 346 RTW_ACCESS_CONFIG = 1, 347 RTW_ACCESS_ANAPARM = 2}; 348 349 struct rtw_softc { 350 struct device sc_dev; 351 struct ieee80211com sc_ic; 352 struct rtw_regs sc_regs; 353 bus_dma_tag_t sc_dmat; 354 u_int32_t sc_flags; 355 356 #if 0 357 enum rtw_rftype sc_rftype; 358 #endif 359 enum rtw_attach_state sc_attach_state; 360 enum rtw_rfchipid sc_rfchipid; 361 enum rtw_locale sc_locale; 362 u_int8_t sc_phydelay; 363 364 /* s/w Tx/Rx descriptors */ 365 struct rtw_txctl_blk sc_txctl_blk[RTW_NTXPRI]; 366 struct rtw_rxctl sc_rxctl[RTW_RXQLEN]; 367 u_int sc_txq; 368 u_int sc_txnext; 369 370 struct rtw_txdesc_blk sc_txdesc_blk[RTW_NTXPRI]; 371 struct rtw_rxdesc *sc_rxdesc; 372 u_int sc_rxnext; 373 374 struct rtw_descs *sc_descs; 375 376 bus_dma_segment_t sc_desc_segs; 377 int sc_desc_nsegs; 378 bus_dmamap_t sc_desc_dmamap; 379 #define sc_desc_physaddr sc_desc_dmamap->dm_segs[0].ds_addr 380 381 struct rtw_srom sc_srom; 382 383 enum rtw_pwrstate sc_pwrstate; 384 385 rtw_pwrstate_t sc_pwrstate_cb; 386 387 struct rtw_rf *sc_rf; 388 389 u_int16_t sc_inten; 390 391 /* interrupt acknowledge hook */ 392 void (*sc_intr_ack) __P((struct rtw_regs *)); 393 394 int (*sc_enable)(struct rtw_softc *); 395 void (*sc_disable)(struct rtw_softc *); 396 void (*sc_power)(struct rtw_softc *, int); 397 struct rtw_mtbl sc_mtbl; 398 struct rtw_hooks sc_hooks; 399 400 caddr_t sc_radiobpf; 401 402 struct callout sc_scan_ch; 403 u_int sc_cur_chan; 404 405 u_int32_t sc_tsfth; /* most significant TSFT bits */ 406 u_int32_t sc_rcr; /* RTW_RCR */ 407 u_int8_t sc_csthr; /* carrier-sense threshold */ 408 409 int sc_do_tick; /* indicate 1s ticks */ 410 struct timeval sc_tick0; /* first tick */ 411 412 uint8_t sc_rev; /* PCI/Cardbus revision */ 413 414 union { 415 struct rtw_rx_radiotap_header tap; 416 u_int8_t pad[64]; 417 } sc_rxtapu; 418 union { 419 struct rtw_tx_radiotap_header tap; 420 u_int8_t pad[64]; 421 } sc_txtapu; 422 enum rtw_access sc_access; 423 }; 424 425 #define sc_if sc_ic.ic_if 426 #define sc_rxtap sc_rxtapu.tap 427 #define sc_txtap sc_txtapu.tap 428 429 void rtw_txdac_enable(struct rtw_regs *, int); 430 void rtw_anaparm_enable(struct rtw_regs *, int); 431 void rtw_config0123_enable(struct rtw_regs *, int); 432 void rtw_continuous_tx_enable(struct rtw_softc *, int); 433 void rtw_set_access(struct rtw_softc *, enum rtw_access); 434 435 void rtw_attach(struct rtw_softc *); 436 int rtw_detach(struct rtw_softc *); 437 int rtw_intr(void *); 438 439 void rtw_disable(struct rtw_softc *); 440 int rtw_enable(struct rtw_softc *); 441 442 int rtw_activate(struct device *, enum devact); 443 void rtw_power(int, void *); 444 void rtw_shutdown(void *); 445 446 const char *rtw_pwrstate_string(enum rtw_pwrstate); 447 448 #endif /* _DEV_IC_RTWVAR_H_ */ 449
Indexes created Thu Sep 25 16:09:42 GMT 2025