1/* $NetBSD: if_urtwreg.h,v 1.7 2021/08/26 21:33:36 andvar Exp $ */ 2/* $OpenBSD: if_urtwreg.h,v 1.13 2010/08/27 17:08:01 jsg Exp $ */ 3 4/*- 5 * Copyright (c) 2009 Martynas Venckus <martynas@openbsd.org> 6 * Copyright (c) 2008 Weongyo Jeong <weongyo@FreeBSD.org> 7 * 8 * Permission to use, copy, modify, and distribute this software for any 9 * purpose with or without fee is hereby granted, provided that the above 10 * copyright notice and this permission notice appear in all copies. 11 * 12 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 13 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 14 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 15 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 16 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 17 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 18 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 19 */ 20 21#define URTW_CONFIG_NO 1 22#define URTW_IFACE_INDEX 0 23 24/* 25 * Known hardware revisions. 26 */ 27#define URTW_HWREV_8187 0x01 28#define URTW_HWREV_8187_B 0x02 29#define URTW_HWREV_8187_D 0x04 30#define URTW_HWREV_8187B 0x08 31#define URTW_HWREV_8187B_B 0x10 32#define URTW_HWREV_8187B_D 0x20 33#define URTW_HWREV_8187B_E 0x40 34 35/* 36 * Registers specific to RTL8187 and RTL8187B. 37 */ 38#define URTW_MAC0 0x0000 /* 1 byte */ 39#define URTW_MAC1 0x0001 /* 1 byte */ 40#define URTW_MAC2 0x0002 /* 1 byte */ 41#define URTW_MAC3 0x0003 /* 1 byte */ 42#define URTW_MAC4 0x0004 /* 1 byte */ 43#define URTW_MAC5 0x0005 /* 1 byte */ 44#define URTW_8187_BRSR 0x002c /* 2 byte */ 45#define URTW_BRSR_MBR_8185 (0x0fff) 46#define URTW_8187B_EIFS 0x002d /* 1 byte */ 47#define URTW_BSSID 0x002e /* 6 byte */ 48#define URTW_RESP_RATE 0x0034 /* 1 byte */ 49#define URTW_8187B_BRSR 0x0034 /* 2 byte */ 50#define URTW_RESP_MAX_RATE_SHIFT (4) 51#define URTW_RESP_MIN_RATE_SHIFT (0) 52#define URTW_8187_EIFS 0x0035 /* 1 byte */ 53#define URTW_INTR_MASK 0x003c /* 2 byte */ 54#define URTW_CMD 0x0037 /* 1 byte */ 55#define URTW_CMD_TX_ENABLE (0x4) 56#define URTW_CMD_RX_ENABLE (0x8) 57#define URTW_CMD_RST (0x10) 58#define URTW_TX_CONF 0x0040 /* 4 byte */ 59#define URTW_TX_HWREV_MASK (7 << 25) 60#define URTW_TX_HWREV_8187_D (5 << 25) 61#define URTW_TX_HWREV_8187B_D (6 << 25) 62#define URTW_TX_DURPROCMODE (1 << 30) 63#define URTW_TX_DISREQQSIZE (1 << 28) 64#define URTW_TX_SHORTRETRY (7 << 8) 65#define URTW_TX_LONGRETRY (7 << 0) 66#define URTW_TX_LOOPBACK_SHIFT (17) 67#define URTW_TX_LOOPBACK_NONE (0 << URTW_TX_LOOPBACK_SHIFT) 68#define URTW_TX_LOOPBACK_MAC (1 << URTW_TX_LOOPBACK_SHIFT) 69#define URTW_TX_LOOPBACK_BASEBAND (2 << URTW_TX_LOOPBACK_SHIFT) 70#define URTW_TX_LOOPBACK_CONTINUE (3 << URTW_TX_LOOPBACK_SHIFT) 71#define URTW_TX_LOOPBACK_MASK (0x60000) 72#define URTW_TX_DPRETRY_MASK (0xff00) 73#define URTW_TX_RTSRETRY_MASK (0xff) 74#define URTW_TX_DPRETRY_SHIFT (0) 75#define URTW_TX_RTSRETRY_SHIFT (8) 76#define URTW_TX_NOCRC (0x10000) 77#define URTW_TX_MXDMA_MASK (0xe00000) 78#define URTW_TX_MXDMA_1024 (6 << URTW_TX_MXDMA_SHIFT) 79#define URTW_TX_MXDMA_2048 (7 << URTW_TX_MXDMA_SHIFT) 80#define URTW_TX_MXDMA_SHIFT (21) 81#define URTW_TX_CWMIN (1 << 31) 82#define URTW_TX_DISCW (1 << 20) 83#define URTW_TX_SWPLCPLEN (1 << 24) 84#define URTW_TX_NOICV (0x80000) 85#define URTW_RX 0x0044 /* 4 byte */ 86#define URTW_RX_9356SEL (1 << 6) 87#define URTW_RX_FILTER_MASK \ 88 (URTW_RX_FILTER_ALLMAC | URTW_RX_FILTER_NICMAC | URTW_RX_FILTER_MCAST | \ 89 URTW_RX_FILTER_BCAST | URTW_RX_FILTER_CRCERR | URTW_RX_FILTER_ICVERR | \ 90 URTW_RX_FILTER_DATA | URTW_RX_FILTER_CTL | URTW_RX_FILTER_MNG | \ 91 (1 << 21) | \ 92 URTW_RX_FILTER_PWR | URTW_RX_CHECK_BSSID) 93#define URTW_RX_FILTER_ALLMAC (0x00000001) 94#define URTW_RX_FILTER_NICMAC (0x00000002) 95#define URTW_RX_FILTER_MCAST (0x00000004) 96#define URTW_RX_FILTER_BCAST (0x00000008) 97#define URTW_RX_FILTER_CRCERR (0x00000020) 98#define URTW_RX_FILTER_ICVERR (0x00001000) 99#define URTW_RX_FILTER_DATA (0x00040000) 100#define URTW_RX_FILTER_CTL (0x00080000) 101#define URTW_RX_FILTER_MNG (0x00100000) 102#define URTW_RX_FILTER_PWR (0x00400000) 103#define URTW_RX_CHECK_BSSID (0x00800000) 104#define URTW_RX_FIFO_THRESHOLD_MASK ((1 << 13) | (1 << 14) | (1 << 15)) 105#define URTW_RX_FIFO_THRESHOLD_SHIFT (13) 106#define URTW_RX_FIFO_THRESHOLD_128 (3) 107#define URTW_RX_FIFO_THRESHOLD_256 (4) 108#define URTW_RX_FIFO_THRESHOLD_512 (5) 109#define URTW_RX_FIFO_THRESHOLD_1024 (6) 110#define URTW_RX_FIFO_THRESHOLD_NONE (7 << URTW_RX_FIFO_THRESHOLD_SHIFT) 111#define URTW_RX_AUTORESETPHY (1 << URTW_RX_AUTORESETPHY_SHIFT) 112#define URTW_RX_AUTORESETPHY_SHIFT (28) 113#define URTW_MAX_RX_DMA_MASK ((1<<8) | (1<<9) | (1<<10)) 114#define URTW_MAX_RX_DMA_2048 (7 << URTW_MAX_RX_DMA_SHIFT) 115#define URTW_MAX_RX_DMA_1024 (6) 116#define URTW_MAX_RX_DMA_SHIFT (10) 117#define URTW_RCR_ONLYERLPKT (1 << 31) 118#define URTW_INT_TIMEOUT 0x0048 /* 4 byte */ 119#define URTW_EPROM_CMD 0x0050 /* 1 byte */ 120#define URTW_EPROM_CMD_NORMAL (0x0) 121#define URTW_EPROM_CMD_NORMAL_MODE \ 122 (URTW_EPROM_CMD_NORMAL << URTW_EPROM_CMD_SHIFT) 123#define URTW_EPROM_CMD_LOAD (0x1) 124#define URTW_EPROM_CMD_PROGRAM (0x2) 125#define URTW_EPROM_CMD_PROGRAM_MODE \ 126 (URTW_EPROM_CMD_PROGRAM << URTW_EPROM_CMD_SHIFT) 127#define URTW_EPROM_CMD_CONFIG (0x3) 128#define URTW_EPROM_CMD_SHIFT (6) 129#define URTW_EPROM_CMD_MASK ((1 << 7) | (1 << 6)) 130#define URTW_EPROM_READBIT (0x1) 131#define URTW_EPROM_WRITEBIT (0x2) 132#define URTW_EPROM_CK (0x4) 133#define URTW_EPROM_CS (0x8) 134#define URTW_CONFIG1 0x0052 /* 1 byte */ 135#define URTW_CONFIG2 0x0053 /* 1 byte */ 136#define URTW_ANAPARAM 0x0054 /* 4 byte */ 137#define URTW_8187_8225_ANAPARAM_ON (0xa0000a59) 138#define URTW_8187B_8225_ANAPARAM_ON (0x45090658) 139#define URTW_MSR 0x0058 /* 1 byte */ 140#define URTW_MSR_LINK_MASK ((1 << 2) | (1 << 3)) 141#define URTW_MSR_LINK_SHIFT (2) 142#define URTW_MSR_LINK_NONE (0 << URTW_MSR_LINK_SHIFT) 143#define URTW_MSR_LINK_ADHOC (1 << URTW_MSR_LINK_SHIFT) 144#define URTW_MSR_LINK_STA (2 << URTW_MSR_LINK_SHIFT) 145#define URTW_MSR_LINK_HOSTAP (3 << URTW_MSR_LINK_SHIFT) 146#define URTW_MSR_LINK_ENEDCA (4 << URTW_MSR_LINK_SHIFT) 147#define URTW_CONFIG3 0x0059 /* 1 byte */ 148#define URTW_CONFIG3_ANAPARAM_WRITE (0x40) 149#define URTW_CONFIG3_ANAPARAM_W_SHIFT (6) 150#define URTW_CONFIG3_GNT_SELECT (0x80) 151#define URTW_PSR 0x005e /* 1 byte */ 152#define URTW_ANAPARAM2 0x0060 /* 4 byte */ 153#define URTW_8187_8225_ANAPARAM2_ON (0x860c7312) 154#define URTW_8187B_8225_ANAPARAM2_ON (0x727f3f52) 155#define URTW_BEACON_INTERVAL 0x0070 /* 2 byte */ 156#define URTW_ATIM_WND 0x0072 /* 2 byte */ 157#define URTW_BEACON_INTERVAL_TIME 0x0074 /* 2 byte */ 158#define URTW_ATIM_TR_ITV 0x0076 /* 2 byte */ 159#define URTW_RF_PINS_OUTPUT 0x0080 /* 2 byte */ 160#define URTW_BB_HOST_BANG_CLK (1 << 1) 161#define URTW_BB_HOST_BANG_EN (1 << 2) 162#define URTW_BB_HOST_BANG_RW (1 << 3) 163#define URTW_RF_PINS_ENABLE 0x0082 /* 2 byte */ 164#define URTW_RF_PINS_SELECT 0x0084 /* 2 byte */ 165#define URTW_RF_PINS_INPUT 0x0086 /* 2 byte */ 166#define URTW_RF_PARA 0x0088 /* 4 byte */ 167#define URTW_RF_TIMING 0x008c /* 4 byte */ 168#define URTW_GP_ENABLE 0x0090 /* 1 byte */ 169#define URTW_GPIO 0x0091 /* 1 byte */ 170#define URTW_HSSI_PARA 0x0094 /* 4 byte */ 171#define URTW_TX_AGC_CTL 0x009c /* 1 byte */ 172#define URTW_TX_AGC_CTL_PERPACKET_GAIN (0x1) 173#define URTW_TX_AGC_CTL_PERPACKET_ANTSEL (0x2) 174#define URTW_TX_AGC_CTL_FEEDBACK_ANT (0x4) 175#define URTW_TX_GAIN_CCK 0x009d /* 1 byte */ 176#define URTW_TX_GAIN_OFDM 0x009e /* 1 byte */ 177#define URTW_TX_ANTENNA 0x009f /* 1 byte */ 178#define URTW_WPA_CONFIG 0x00b0 /* 1 byte */ 179#define URTW_SIFS 0x00b4 /* 1 byte */ 180#define URTW_DIFS 0x00b5 /* 1 byte */ 181#define URTW_SLOT 0x00b6 /* 1 byte */ 182#define URTW_CW_CONF 0x00bc /* 1 byte */ 183#define URTW_CW_CONF_PERPACKET_RETRY (0x2) 184#define URTW_CW_CONF_PERPACKET_CW (0x1) 185#define URTW_CW_VAL 0x00bd /* 1 byte */ 186#define URTW_RATE_FALLBACK 0x00be /* 1 byte */ 187#define URTW_RATE_FALLBACK_ENABLE (0x80) 188#define URTW_ACM_CONTROL 0x00bf /* 1 byte */ 189#define URTW_8187B_HWREV 0x00e1 /* 1 byte */ 190#define URTW_8187B_HWREV_8187B_B (0x0) 191#define URTW_8187B_HWREV_8187B_D (0x1) 192#define URTW_8187B_HWREV_8187B_E (0x2) 193#define URTW_INT_MIG 0x00e2 /* 2 byte */ 194#define URTW_TID_AC_MAP 0x00e8 /* 2 byte */ 195#define URTW_ANAPARAM3 0x00ee /* 4 byte */ 196#define URTW_8187B_8225_ANAPARAM3_ON (0x0) 197#define URTW_TALLY_SEL 0x00fc /* 1 byte */ 198#define URTW_AC_VO 0x00f0 /* 1 byte */ 199#define URTW_AC_VI 0x00f4 /* 1 byte */ 200#define URTW_AC_BE 0x00f8 /* 1 byte */ 201#define URTW_AC_BK 0x00fc /* 1 byte */ 202#define URTW_FEMR 0x01d4 /* 2 byte */ 203#define URTW_ARFR 0x01e0 /* 2 byte */ 204#define URTW_RFSW_CTRL 0x0272 /* 2 byte */ 205 206/* for EEPROM */ 207#define URTW_EPROM_TXPW_BASE 0x05 208#define URTW_EPROM_RFCHIPID 0x06 209#define URTW_EPROM_RFCHIPID_RTL8225U (5) 210#define URTW_EPROM_MACADDR 0x07 211#define URTW_EPROM_TXPW0 0x16 212#define URTW_EPROM_TXPW2 0x1b 213#define URTW_EPROM_TXPW1 0x3d 214#define URTW_EPROM_SWREV 0x3f 215#define URTW_EPROM_CID_MASK (0xff) 216#define URTW_EPROM_CID_RSVD0 (0x00) 217#define URTW_EPROM_CID_RSVD1 (0xff) 218#define URTW_EPROM_CID_ALPHA0 (0x01) 219#define URTW_EPROM_CID_SERCOMM_PS (0x02) 220#define URTW_EPROM_CID_HW_LED (0x03) 221 222/* LED */ 223#define URTW_CID_DEFAULT 0 224#define URTW_CID_8187_ALPHA0 1 225#define URTW_CID_8187_SERCOMM_PS 2 226#define URTW_CID_8187_HW_LED 3 227#define URTW_SW_LED_MODE0 0 228#define URTW_SW_LED_MODE1 1 229#define URTW_SW_LED_MODE2 2 230#define URTW_SW_LED_MODE3 3 231#define URTW_HW_LED 4 232#define URTW_LED_CTL_POWER_ON 0 233#define URTW_LED_CTL_LINK 2 234#define URTW_LED_CTL_TX 4 235#define URTW_LED_PIN_GPIO0 0 236#define URTW_LED_PIN_LED0 1 237#define URTW_LED_PIN_LED1 2 238#define URTW_LED_UNKNOWN 0 239#define URTW_LED_ON 1 240#define URTW_LED_OFF 2 241#define URTW_LED_BLINK_NORMAL 3 242#define URTW_LED_BLINK_SLOWLY 4 243#define URTW_LED_POWER_ON_BLINK 5 244#define URTW_LED_SCAN_BLINK 6 245#define URTW_LED_NO_LINK_BLINK 7 246#define URTW_LED_BLINK_CM3 8 247 248/* for extra area */ 249#define URTW_EPROM_DISABLE 0 250#define URTW_EPROM_ENABLE 1 251#define URTW_EPROM_DELAY 10 252#define URTW_8187_GETREGS_REQ 5 253#define URTW_8187_SETREGS_REQ 5 254#define URTW_8225_RF_MAX_SENS 6 255#define URTW_8225_RF_DEF_SENS 4 256#define URTW_DEFAULT_RTS_RETRY 7 257#define URTW_DEFAULT_TX_RETRY 7 258#define URTW_DEFAULT_RTS_THRESHOLD 2342U 259 260#define URTW_MAX_CHANNELS 15 261 262struct urtw_tx_data { 263 struct urtw_softc *sc; 264 struct usbd_xfer *xfer; 265 uint8_t *buf; 266 struct ieee80211_node *ni; 267}; 268 269struct urtw_rx_data { 270 struct urtw_softc *sc; 271 struct usbd_xfer *xfer; 272 uint8_t *buf; 273 struct mbuf *m; 274}; 275 276/* XXX not correct.. */ 277#define URTW_MIN_RXBUFSZ \ 278 (sizeof(struct ieee80211_frame_min)) 279 280#define URTW_RX_DATA_LIST_COUNT 1 281#define URTW_TX_DATA_LIST_COUNT 16 282#define URTW_RX_MAXSIZE 0x9c4 283#define URTW_TX_MAXSIZE 0x9c4 284 285struct urtw_rx_radiotap_header { 286 struct ieee80211_radiotap_header wr_ihdr; 287 uint8_t wr_flags; 288 uint16_t wr_chan_freq; 289 uint16_t wr_chan_flags; 290 int8_t wr_dbm_antsignal; 291}; 292 293#define URTW_RX_RADIOTAP_PRESENT \ 294 ((1 << IEEE80211_RADIOTAP_FLAGS) | \ 295 (1 << IEEE80211_RADIOTAP_CHANNEL) | \ 296 (1 << IEEE80211_RADIOTAP_DBM_ANTSIGNAL)) 297 298struct urtw_tx_radiotap_header { 299 struct ieee80211_radiotap_header wt_ihdr; 300 uint8_t wt_flags; 301 uint8_t wt_rate; 302 uint16_t wt_chan_freq; 303 uint16_t wt_chan_flags; 304}; 305 306#define URTW_TX_RADIOTAP_PRESENT \ 307 ((1 << IEEE80211_RADIOTAP_FLAGS) | \ 308 (1 << IEEE80211_RADIOTAP_CHANNEL)) 309 310struct urtw_rf { 311 /* RF methods */ 312 usbd_status (*init)(struct urtw_rf *); 313 usbd_status (*set_chan)(struct urtw_rf *, int); 314 usbd_status (*set_sens)(struct urtw_rf *); 315 316 /* RF attributes */ 317 struct urtw_softc *rf_sc; 318 uint32_t max_sens; 319 uint32_t sens; 320}; 321 322struct urtw_softc { 323 device_t sc_dev; 324 struct ieee80211com sc_ic; 325 struct ethercom sc_ec; 326#define sc_if sc_ec.ec_if 327 328 kmutex_t sc_media_mtx; /* XXX */ 329 330 enum { 331 URTW_INIT_NONE, 332 URTW_INIT_INITED 333 } sc_init_state; 334 int (*sc_newstate)(struct ieee80211com *, 335 enum ieee80211_state, int); 336 struct urtw_rf sc_rf; 337 338 bool sc_dying; 339 340 struct usb_task sc_task; 341 struct usbd_device * sc_udev; 342 struct usbd_interface * sc_iface; 343 344 enum ieee80211_state sc_state; 345 int sc_arg; 346 347 uint8_t sc_hwrev; 348 int sc_flags; 349#define URTW_INIT_ONCE (1 << 1) 350 int sc_epromtype; 351#define URTW_EEPROM_93C46 0 352#define URTW_EEPROM_93C56 1 353 uint8_t sc_crcmon; 354 uint8_t sc_bssid[IEEE80211_ADDR_LEN]; 355 356 /* for LED */ 357 struct callout sc_led_ch; 358 struct usb_task sc_ledtask; 359 uint8_t sc_psr; 360 uint8_t sc_strategy; 361#define URTW_LED_GPIO 1 362 uint8_t sc_gpio_ledon; 363 uint8_t sc_gpio_ledinprogress; 364 uint8_t sc_gpio_ledstate; 365 uint8_t sc_gpio_ledpin; 366 uint8_t sc_gpio_blinktime; 367 uint8_t sc_gpio_blinkstate; 368 /* RX/TX */ 369 struct usbd_pipe * sc_rxpipe; 370 struct usbd_pipe * sc_txpipe_low; 371 struct usbd_pipe * sc_txpipe_normal; 372#define URTW_PRIORITY_LOW 0 373#define URTW_PRIORITY_NORMAL 1 374#define URTW_PRIORITY_MAX 2 375#define URTW_DATA_TIMEOUT 10000 /* 10 sec */ 376 struct urtw_rx_data sc_rx_data[URTW_RX_DATA_LIST_COUNT]; 377 struct urtw_tx_data sc_tx_data[URTW_PRIORITY_MAX][URTW_TX_DATA_LIST_COUNT]; 378 uint32_t sc_tx_queued[URTW_PRIORITY_MAX]; 379 uint32_t sc_txidx[URTW_PRIORITY_MAX]; 380 uint8_t sc_rts_retry; 381 uint8_t sc_tx_retry; 382 uint8_t sc_preamble_mode; 383 struct callout scan_to; 384 int sc_txtimer; 385 int sc_currate; 386 /* TX power */ 387 uint8_t sc_txpwr_cck[URTW_MAX_CHANNELS]; 388 uint8_t sc_txpwr_cck_base; 389 uint8_t sc_txpwr_ofdm[URTW_MAX_CHANNELS]; 390 uint8_t sc_txpwr_ofdm_base; 391 392 struct bpf_if * sc_drvbpf; 393 394 union { 395 struct urtw_rx_radiotap_header th; 396 uint8_t pad[64]; 397 } sc_rxtapu; 398#define sc_rxtap sc_rxtapu.th 399 int sc_rxtap_len; 400 401 union { 402 struct urtw_tx_radiotap_header th; 403 uint8_t pad[64]; 404 } sc_txtapu; 405#define sc_txtap sc_txtapu.th 406 int sc_txtap_len; 407}; 408 409