sys/dev/usb/wlan/if_urtwreg.h

   1 /*      $FreeBSD$       */
   2
   3 /*-
   4  * Copyright (c) 2008 Weongyo Jeong <weongyo@FreeBSD.org>
   5  *
   6  * Permission to use, copy, modify, and distribute this software for any
   7  * purpose with or without fee is hereby granted, provided that the above
   8  * copyright notice and this permission notice appear in all copies.
   9  *
  10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  17  */
  18
  19 #define URTW_CONFIG_INDEX               0
  20 #define URTW_IFACE_INDEX                0
  21
  22 /* for 8187  */
  23 #define URTW_MAC0                       0x0000          /* 1 byte  */
  24 #define URTW_MAC1                       0x0001          /* 1 byte  */
  25 #define URTW_MAC2                       0x0002          /* 1 byte  */
  26 #define URTW_MAC3                       0x0003          /* 1 byte  */
  27 #define URTW_MAC4                       0x0004          /* 1 byte  */
  28 #define URTW_MAC5                       0x0005          /* 1 byte  */
  29 #define URTW_BRSR                       0x002c          /* 2 byte  */
  30 #define URTW_BRSR_MBR_8185              (0x0fff)
  31 #define URTW_BSSID                      0x002e          /* 6 byte  */
  32 #define URTW_RESP_RATE                  0x0034          /* 1 byte  */
  33 #define URTW_RESP_MAX_RATE_SHIFT        (4)
  34 #define URTW_RESP_MIN_RATE_SHIFT        (0)
  35 #define URTW_EIFS                       0x0035          /* 1 byte  */
  36 #define URTW_INTR_MASK                  0x003c          /* 2 byte  */
  37 #define URTW_CMD                        0x0037          /* 1 byte  */
  38 #define URTW_CMD_TX_ENABLE              (0x4)
  39 #define URTW_CMD_RX_ENABLE              (0x8)
  40 #define URTW_CMD_RST                    (0x10)
  41 #define URTW_TX_CONF                    0x0040          /* 4 byte  */
  42 #define URTW_TX_LOOPBACK_SHIFT          (17)
  43 #define URTW_TX_LOOPBACK_NONE           (0 << URTW_TX_LOOPBACK_SHIFT)
  44 #define URTW_TX_LOOPBACK_MAC            (1 << URTW_TX_LOOPBACK_SHIFT)
  45 #define URTW_TX_LOOPBACK_BASEBAND       (2 << URTW_TX_LOOPBACK_SHIFT)
  46 #define URTW_TX_LOOPBACK_CONTINUE       (3 << URTW_TX_LOOPBACK_SHIFT)
  47 #define URTW_TX_LOOPBACK_MASK           (0x60000)
  48 #define URTW_TX_DPRETRY_MASK            (0xff00)
  49 #define URTW_TX_RTSRETRY_MASK           (0xff)
  50 #define URTW_TX_DPRETRY_SHIFT           (0)
  51 #define URTW_TX_RTSRETRY_SHIFT          (8)
  52 #define URTW_TX_NOCRC                   (0x10000)
  53 #define URTW_TX_MXDMA_MASK              (0xe00000)
  54 #define URTW_TX_MXDMA_1024              (6 << URTW_TX_MXDMA_SHIFT)
  55 #define URTW_TX_MXDMA_2048              (7 << URTW_TX_MXDMA_SHIFT)
  56 #define URTW_TX_MXDMA_SHIFT             (21)
  57 #define URTW_TX_DISCW                   (1 << 20)
  58 #define URTW_TX_SWPLCPLEN               (1 << 24)
  59 #define URTW_TX_DISREQQSIZE             (1 << 28)
  60 #define URTW_TX_HW_SEQNUM               (1 << 30)
  61 #define URTW_TX_CWMIN                   (1 << 31)
  62 #define URTW_TX_NOICV                   (0x80000)
  63 #define URTW_RX                         0x0044          /* 4 byte  */
  64 #define URTW_RX_9356SEL                 (1 << 6)
  65 #define URTW_RX_FILTER_MASK                     \
  66         (URTW_RX_FILTER_ALLMAC | URTW_RX_FILTER_NICMAC | URTW_RX_FILTER_MCAST | \
  67         URTW_RX_FILTER_BCAST | URTW_RX_FILTER_CRCERR | URTW_RX_FILTER_ICVERR | \
  68         URTW_RX_FILTER_DATA | URTW_RX_FILTER_CTL | URTW_RX_FILTER_MNG | \
  69         (1 << 21) |                                                     \
  70         URTW_RX_FILTER_PWR | URTW_RX_CHECK_BSSID)
  71 #define URTW_RX_FILTER_ALLMAC           (0x00000001)
  72 #define URTW_RX_FILTER_NICMAC           (0x00000002)
  73 #define URTW_RX_FILTER_MCAST            (0x00000004)
  74 #define URTW_RX_FILTER_BCAST            (0x00000008)
  75 #define URTW_RX_FILTER_CRCERR           (0x00000020)
  76 #define URTW_RX_FILTER_ICVERR           (0x00001000)
  77 #define URTW_RX_FILTER_DATA             (0x00040000)
  78 #define URTW_RX_FILTER_CTL              (0x00080000)
  79 #define URTW_RX_FILTER_MNG              (0x00100000)
  80 #define URTW_RX_FILTER_PWR              (0x00400000)
  81 #define URTW_RX_CHECK_BSSID             (0x00800000)
  82 #define URTW_RX_FIFO_THRESHOLD_MASK     ((1 << 13) | (1 << 14) | (1 << 15))
  83 #define URTW_RX_FIFO_THRESHOLD_SHIFT    (13)
  84 #define URTW_RX_FIFO_THRESHOLD_128      (3)
  85 #define URTW_RX_FIFO_THRESHOLD_256      (4)
  86 #define URTW_RX_FIFO_THRESHOLD_512      (5)
  87 #define URTW_RX_FIFO_THRESHOLD_1024     (6)
  88 #define URTW_RX_FIFO_THRESHOLD_NONE     (7 << URTW_RX_FIFO_THRESHOLD_SHIFT)
  89 #define URTW_RX_AUTORESETPHY            (1 << URTW_RX_AUTORESETPHY_SHIFT)
  90 #define URTW_RX_AUTORESETPHY_SHIFT      (28)
  91 #define URTW_MAX_RX_DMA_MASK            ((1<<8) | (1<<9) | (1<<10))
  92 #define URTW_MAX_RX_DMA_2048            (7 << URTW_MAX_RX_DMA_SHIFT)
  93 #define URTW_MAX_RX_DMA_1024            (6)
  94 #define URTW_MAX_RX_DMA_SHIFT           (10)
  95 #define URTW_RCR_ONLYERLPKT             (1 << 31)
  96 #define URTW_INT_TIMEOUT                0x0048          /* 4 byte  */
  97 #define URTW_EPROM_CMD                  0x0050          /* 1 byte  */
  98 #define URTW_EPROM_CMD_NORMAL           (0x0)
  99 #define URTW_EPROM_CMD_NORMAL_MODE                              \
 100         (URTW_EPROM_CMD_NORMAL << URTW_EPROM_CMD_SHIFT)
 101 #define URTW_EPROM_CMD_LOAD             (0x1)
 102 #define URTW_EPROM_CMD_PROGRAM          (0x2)
 103 #define URTW_EPROM_CMD_PROGRAM_MODE                             \
 104         (URTW_EPROM_CMD_PROGRAM << URTW_EPROM_CMD_SHIFT)
 105 #define URTW_EPROM_CMD_CONFIG           (0x3)
 106 #define URTW_EPROM_CMD_SHIFT            (6)
 107 #define URTW_EPROM_CMD_MASK             ((1 << 7) | (1 << 6))
 108 #define URTW_EPROM_READBIT              (0x1)
 109 #define URTW_EPROM_WRITEBIT             (0x2)
 110 #define URTW_EPROM_CK                   (0x4)
 111 #define URTW_EPROM_CS                   (0x8)
 112 #define URTW_CONFIG1                    0x0052          /* 1 byte  */
 113 #define URTW_CONFIG2                    0x0053          /* 1 byte  */
 114 #define URTW_ANAPARAM                   0x0054          /* 4 byte  */
 115 #define URTW_8225_ANAPARAM_ON           (0xa0000a59)
 116 #define URTW_8225_ANAPARAM_OFF          (0xa00beb59)
 117 #define URTW_8187B_8225_ANAPARAM_ON     (0x45090658)
 118 #define URTW_8187B_8225_ANAPARAM_OFF    (0x55480658)
 119 #define URTW_MSR                        0x0058          /* 1 byte  */
 120 #define URTW_MSR_LINK_MASK              ((1 << 2) | (1 << 3))
 121 #define URTW_MSR_LINK_SHIFT             (2)
 122 #define URTW_MSR_LINK_NONE              (0 << URTW_MSR_LINK_SHIFT)
 123 #define URTW_MSR_LINK_ADHOC             (1 << URTW_MSR_LINK_SHIFT)
 124 #define URTW_MSR_LINK_STA               (2 << URTW_MSR_LINK_SHIFT)
 125 #define URTW_MSR_LINK_HOSTAP            (3 << URTW_MSR_LINK_SHIFT)
 126 #define URTW_MSR_LINK_ENEDCA            (1 << 4)
 127 #define URTW_CONFIG3                    0x0059          /* 1 byte  */
 128 #define URTW_CONFIG3_ANAPARAM_WRITE     (0x40)
 129 #define URTW_CONFIG3_GNT_SELECT         (0x80)
 130 #define URTW_CONFIG3_ANAPARAM_W_SHIFT   (6)
 131 #define URTW_CONFIG4                    0x005a          /* 1 byte  */
 132 #define URTW_CONFIG4_VCOOFF             (1 << 7)
 133 #define URTW_TESTR                      0x005b          /* 1 byte  */
 134 #define URTW_PSR                        0x005e          /* 1 byte  */
 135 #define URTW_ANAPARAM2                  0x0060          /* 4 byte  */
 136 #define URTW_8225_ANAPARAM2_ON          (0x860c7312)
 137 #define URTW_8225_ANAPARAM2_OFF         (0x840dec11)
 138 #define URTW_8187B_8225_ANAPARAM2_ON    (0x727f3f52)
 139 #define URTW_8187B_8225_ANAPARAM2_OFF   (0x72003f50)
 140 #define URTW_BEACON_INTERVAL            0x0070          /* 2 byte  */
 141 #define URTW_ATIM_WND                   0x0072          /* 2 byte  */
 142 #define URTW_BEACON_INTERVAL_TIME       0x0074          /* 2 byte  */
 143 #define URTW_ATIM_TR_ITV                0x0076          /* 2 byte  */
 144 #define URTW_CARRIER_SCOUNT             0x0079          /* 1 byte  */
 145 #define URTW_PHY_MAGIC1                 0x007c          /* 1 byte  */
 146 #define URTW_PHY_MAGIC2                 0x007d          /* 1 byte  */
 147 #define URTW_PHY_MAGIC3                 0x007e          /* 1 byte  */
 148 #define URTW_PHY_MAGIC4                 0x007f          /* 1 byte  */
 149 #define URTW_RF_PINS_OUTPUT             0x0080          /* 2 byte  */
 150 #define URTW_RF_PINS_OUTPUT_MAGIC1      (0x3a0)
 151 #define URTW_BB_HOST_BANG_CLK           (1 << 1)
 152 #define URTW_BB_HOST_BANG_EN            (1 << 2)
 153 #define URTW_BB_HOST_BANG_RW            (1 << 3)
 154 #define URTW_RF_PINS_ENABLE             0x0082          /* 2 byte  */
 155 #define URTW_RF_PINS_SELECT             0x0084          /* 2 byte  */
 156 #define URTW_ADDR_MAGIC1                0x0085          /* broken?  */
 157 #define URTW_RF_PINS_INPUT              0x0086          /* 2 byte  */
 158 #define URTW_RF_PINS_MAGIC1             (0xfff3)
 159 #define URTW_RF_PINS_MAGIC2             (0xfff0)
 160 #define URTW_RF_PINS_MAGIC3             (0x0007)
 161 #define URTW_RF_PINS_MAGIC4             (0xf)
 162 #define URTW_RF_PINS_MAGIC5             (0x0080)
 163 #define URTW_RF_PARA                    0x0088          /* 4 byte  */
 164 #define URTW_RF_TIMING                  0x008c          /* 4 byte  */
 165 #define URTW_GP_ENABLE                  0x0090          /* 1 byte  */
 166 #define URTW_GP_ENABLE_DATA_MAGIC1      (0x1)
 167 #define URTW_GPIO                       0x0091          /* 1 byte  */
 168 #define URTW_GPIO_DATA_MAGIC1           (0x1)
 169 #define URTW_HSSI_PARA                  0x0094          /* 4 byte  */
 170 #define URTW_TX_AGC_CTL                 0x009c          /* 1 byte  */
 171 #define URTW_TX_AGC_CTL_PERPACKET_GAIN  (0x1)
 172 #define URTW_TX_AGC_CTL_PERPACKET_ANTSEL        (0x2)
 173 #define URTW_TX_AGC_CTL_FEEDBACK_ANT    (0x4)
 174 #define URTW_TX_GAIN_CCK                0x009d          /* 1 byte  */
 175 #define URTW_TX_GAIN_OFDM               0x009e          /* 1 byte  */
 176 #define URTW_TX_ANTENNA                 0x009f          /* 1 byte  */
 177 #define URTW_WPA_CONFIG                 0x00b0          /* 1 byte  */
 178 #define URTW_SIFS                       0x00b4          /* 1 byte  */
 179 #define URTW_DIFS                       0x00b5          /* 1 byte  */
 180 #define URTW_SLOT                       0x00b6          /* 1 byte  */
 181 #define URTW_CW_CONF                    0x00bc          /* 1 byte  */
 182 #define URTW_CW_CONF_PERPACKET_RETRY    (0x2)
 183 #define URTW_CW_CONF_PERPACKET_CW       (0x1)
 184 #define URTW_CW_VAL                     0x00bd          /* 1 byte  */
 185 #define URTW_RATE_FALLBACK              0x00be          /* 1 byte  */
 186 #define URTW_RATE_FALLBACK_ENABLE       (0x80)
 187 #define URTW_ACM_CONTROL                0x00bf          /* 1 byte  */
 188 #define URTW_INT_MIG                    0x00e2          /* 2 byte  */
 189 #define URTW_TID_AC_MAP                 0x00e8          /* 2 byte  */
 190 #define URTW_ANAPARAM3                  0x00ee          /* 1 byte  */
 191 #define URTW_8187B_8225_ANAPARAM3_ON    (0x0)
 192 #define URTW_8187B_8225_ANAPARAM3_OFF   (0x0)
 193
 194 #define URTW_TALLY_SEL                  0x00fc          /* 1 byte  */
 195 #define URTW_ADDR_MAGIC2                0x00fe          /* 2 byte  */
 196 #define URTW_ADDR_MAGIC3                0x00ff          /* 1 byte  */
 197
 198 /* for 8225  */
 199 #define URTW_8225_ADDR_0_MAGIC          0x0
 200 #define URTW_8225_ADDR_0_DATA_MAGIC1    (0x1b7)
 201 #define URTW_8225_ADDR_0_DATA_MAGIC2    (0x0b7)
 202 #define URTW_8225_ADDR_0_DATA_MAGIC3    (0x127)
 203 #define URTW_8225_ADDR_0_DATA_MAGIC4    (0x027)
 204 #define URTW_8225_ADDR_0_DATA_MAGIC5    (0x22f)
 205 #define URTW_8225_ADDR_0_DATA_MAGIC6    (0x2bf)
 206 #define URTW_8225_ADDR_1_MAGIC          0x1
 207 #define URTW_8225_ADDR_2_MAGIC          0x2
 208 #define URTW_8225_ADDR_2_DATA_MAGIC1    (0xc4d)
 209 #define URTW_8225_ADDR_2_DATA_MAGIC2    (0x44d)
 210 #define URTW_8225_ADDR_3_MAGIC          0x3
 211 #define URTW_8225_ADDR_3_DATA_MAGIC1    (0x2)
 212 #define URTW_8225_ADDR_5_MAGIC          0x5
 213 #define URTW_8225_ADDR_5_DATA_MAGIC1    (0x4)
 214 #define URTW_8225_ADDR_6_MAGIC          0x6
 215 #define URTW_8225_ADDR_6_DATA_MAGIC1    (0xe6)
 216 #define URTW_8225_ADDR_6_DATA_MAGIC2    (0x80)
 217 #define URTW_8225_ADDR_7_MAGIC          0x7
 218 #define URTW_8225_ADDR_8_MAGIC          0x8
 219 #define URTW_8225_ADDR_8_DATA_MAGIC1    (0x588)
 220 #define URTW_8225_ADDR_9_MAGIC          0x9
 221 #define URTW_8225_ADDR_9_DATA_MAGIC1    (0x700)
 222 #define URTW_8225_ADDR_C_MAGIC          0xc
 223 #define URTW_8225_ADDR_C_DATA_MAGIC1    (0x850)
 224 #define URTW_8225_ADDR_C_DATA_MAGIC2    (0x050)
 225
 226 /* for EEPROM  */
 227 #define URTW_EPROM_TXPW_BASE            0x05
 228 #define URTW_EPROM_RFCHIPID             0x06
 229 #define URTW_EPROM_RFCHIPID_RTL8225U    (5)
 230 #define URTW_EPROM_RFCHIPID_RTL8225Z2   (6)
 231 #define URTW_EPROM_MACADDR              0x07
 232 #define URTW_EPROM_TXPW0                0x16
 233 #define URTW_EPROM_TXPW2                0x1b
 234 #define URTW_EPROM_TXPW1                0x3d
 235 #define URTW_EPROM_SWREV                0x3f
 236 #define URTW_EPROM_CID_MASK             (0xff)
 237 #define URTW_EPROM_CID_RSVD0            (0x00)
 238 #define URTW_EPROM_CID_RSVD1            (0xff)
 239 #define URTW_EPROM_CID_ALPHA0           (0x01)
 240 #define URTW_EPROM_CID_SERCOMM_PS       (0x02)
 241 #define URTW_EPROM_CID_HW_LED           (0x03)
 242
 243 /* LED  */
 244 #define URTW_CID_DEFAULT                0
 245 #define URTW_CID_8187_ALPHA0            1
 246 #define URTW_CID_8187_SERCOMM_PS        2
 247 #define URTW_CID_8187_HW_LED            3
 248 #define URTW_SW_LED_MODE0               0
 249 #define URTW_SW_LED_MODE1               1
 250 #define URTW_SW_LED_MODE2               2
 251 #define URTW_SW_LED_MODE3               3
 252 #define URTW_HW_LED                     4
 253 #define URTW_LED_CTL_POWER_ON           0
 254 #define URTW_LED_CTL_LINK               2
 255 #define URTW_LED_CTL_TX                 4
 256 #define URTW_LED_PIN_GPIO0              0
 257 #define URTW_LED_PIN_LED0               1
 258 #define URTW_LED_PIN_LED1               2
 259 #define URTW_LED_UNKNOWN                0
 260 #define URTW_LED_ON                     1
 261 #define URTW_LED_OFF                    2
 262 #define URTW_LED_BLINK_NORMAL           3
 263 #define URTW_LED_BLINK_SLOWLY           4
 264 #define URTW_LED_POWER_ON_BLINK         5
 265 #define URTW_LED_SCAN_BLINK             6
 266 #define URTW_LED_NO_LINK_BLINK          7
 267 #define URTW_LED_BLINK_CM3              8
 268
 269 /* for extra area  */
 270 #define URTW_EPROM_DISABLE              0
 271 #define URTW_EPROM_ENABLE               1
 272 #define URTW_EPROM_DELAY                10
 273 #define URTW_8187_GETREGS_REQ           5
 274 #define URTW_8187_SETREGS_REQ           5
 275 #define URTW_8225_RF_MAX_SENS           6
 276 #define URTW_8225_RF_DEF_SENS           4
 277 #define URTW_DEFAULT_RTS_RETRY          7
 278 #define URTW_DEFAULT_TX_RETRY           7
 279 #define URTW_DEFAULT_RTS_THRESHOLD      2342U
 280
 281 struct urtw_8187b_rxhdr {
 282         uint32_t                flags;
 283         uint64_t                mactime;
 284         uint8_t                 sq;
 285         uint8_t                 rssi;
 286         uint8_t                 agc;
 287         uint8_t                 flags2;
 288         uint16_t                unknown;
 289         int8_t                  pwdb;
 290         uint8_t                 fot;
 291 } __packed;
 292
 293 struct urtw_8187b_txhdr {
 294         uint32_t                flags;
 295         uint16_t                rts_duration;
 296         uint16_t                len;
 297         uint32_t                unknown1;
 298         uint16_t                unknown2;
 299         uint16_t                tx_duration;
 300         uint32_t                unknown3;
 301         uint32_t                retry;
 302         uint32_t                unknown4[2];
 303 } __packed;