sys/dev/netif/acx/if_acxvar.h

   1 /*
   2  * Copyright (c) 2006 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Sepherosa Ziehau <sepherosa@gmail.com>
   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  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $DragonFly: src/sys/dev/netif/acx/if_acxvar.h,v 1.10 2007/02/16 11:46:47 sephe Exp $
  35  */
  36
  37 #ifndef _IF_ACXVAR_H
  38 #define _IF_ACXVAR_H
  39
  40 #ifdef ACX_DEBUG
  41 #define DPRINTF(x)              if_printf x
  42 #else
  43 #define DPRINTF(x)              ((void)0)
  44 #endif
  45
  46 #define ACX_FRAME_HDRLEN        sizeof(struct ieee80211_frame)
  47 #define ACX_MEMBLOCK_SIZE       256
  48
  49 #define ACX_TX_DESC_CNT         16
  50 #define ACX_RX_DESC_CNT         16
  51
  52 #define ACX_TX_RING_SIZE        \
  53         (2 * ACX_TX_DESC_CNT * sizeof(struct acx_host_desc))
  54 #define ACX_RX_RING_SIZE        \
  55         (ACX_RX_DESC_CNT * sizeof(struct acx_host_desc))
  56
  57 #define CSR_READ_1(sc, reg)                                     \
  58         bus_space_read_1((sc)->sc_mem1_bt, (sc)->sc_mem1_bh,    \
  59                          (sc)->chip_ioreg[(reg)])
  60 #define CSR_READ_2(sc, reg)                                     \
  61         bus_space_read_2((sc)->sc_mem1_bt, (sc)->sc_mem1_bh,    \
  62                          (sc)->chip_ioreg[(reg)])
  63 #define CSR_READ_4(sc, reg)                                     \
  64         bus_space_read_4((sc)->sc_mem1_bt, (sc)->sc_mem1_bh,    \
  65                          (sc)->chip_ioreg[(reg)])
  66
  67 #define CSR_WRITE_2(sc, reg, val)                               \
  68         bus_space_write_2((sc)->sc_mem1_bt, (sc)->sc_mem1_bh,   \
  69                           (sc)->chip_ioreg[(reg)], val)
  70 #define CSR_WRITE_4(sc, reg, val)                               \
  71         bus_space_write_4((sc)->sc_mem1_bt, (sc)->sc_mem1_bh,   \
  72                           (sc)->chip_ioreg[(reg)], val)
  73
  74 #define CSR_SETB_2(sc, reg, b)          \
  75         CSR_WRITE_2((sc), (reg), CSR_READ_2((sc), (reg)) | (b))
  76 #define CSR_CLRB_2(sc, reg, b)          \
  77         CSR_WRITE_2((sc), (reg), CSR_READ_2((sc), (reg)) & (~(b)))
  78
  79 #define DESC_READ_1(sc, off)            \
  80         bus_space_read_1((sc)->sc_mem2_bt, (sc)->sc_mem2_bh, (off))
  81 #define DESC_READ_2(sc, off)            \
  82         bus_space_read_2((sc)->sc_mem2_bt, (sc)->sc_mem2_bh, (off))
  83 #define DESC_READ_4(sc, off)            \
  84         bus_space_read_4((sc)->sc_mem2_bt, (sc)->sc_mem2_bh, (off))
  85
  86 #define DESC_WRITE_1(sc, off, val)      \
  87         bus_space_write_1((sc)->sc_mem2_bt, (sc)->sc_mem2_bh, (off), (val))
  88 #define DESC_WRITE_2(sc, off, val)      \
  89         bus_space_write_2((sc)->sc_mem2_bt, (sc)->sc_mem2_bh, (off), (val))
  90 #define DESC_WRITE_4(sc, off, val)      \
  91         bus_space_write_4((sc)->sc_mem2_bt, (sc)->sc_mem2_bh, (off), (val))
  92 #define DESC_WRITE_REGION_1(sc, off, d, dlen)                           \
  93         bus_space_write_region_1((sc)->sc_mem2_bt, (sc)->sc_mem2_bh,    \
  94                                  (off), (const uint8_t *)(d), (dlen))
  95
  96 #define FW_TXDESC_SETFIELD(sc, mb, field, val, sz)      \
  97         DESC_WRITE_##sz((sc), (mb)->tb_fwdesc_ofs +     \
  98                               __offsetof(struct acx_fw_txdesc, field), (val))
  99
 100 #define FW_TXDESC_GETFIELD(sc, mb, field, sz)           \
 101         DESC_READ_##sz((sc), (mb)->tb_fwdesc_ofs +      \
 102                              __offsetof(struct acx_fw_txdesc, field))
 103
 104 #define FW_TXDESC_SETFIELD_1(sc, mb, field, val)        \
 105         FW_TXDESC_SETFIELD(sc, mb, field, val, 1)
 106 #define FW_TXDESC_SETFIELD_2(sc, mb, field, val)        \
 107         FW_TXDESC_SETFIELD(sc, mb, field, htole16(val), 2)
 108 #define FW_TXDESC_SETFIELD_4(sc, mb, field, val)        \
 109         FW_TXDESC_SETFIELD(sc, mb, field, htole32(val), 4)
 110
 111 #define FW_TXDESC_GETFIELD_1(sc, mb, field)             \
 112         FW_TXDESC_GETFIELD(sc, mb, field, 1)
 113 #define FW_TXDESC_GETFIELD_2(sc, mb, field)             \
 114         le16toh(FW_TXDESC_GETFIELD(sc, mb, field, 2))
 115 #define FW_TXDESC_GETFIELD_4(sc, mb, field)             \
 116         le32toh(FW_TXDESC_GETFIELD(sc, mb, field, 4))
 117
 118 /*
 119  * Firmware TX descriptor
 120  * Fields are little endian
 121  */
 122 struct acx_fw_txdesc {
 123         uint32_t        f_tx_next_desc; /* next acx_fw_txdesc phyaddr */
 124         uint32_t        f_tx_host_desc; /* acx_host_desc phyaddr */
 125         uint32_t        f_tx_acx_ptr;
 126         uint32_t        f_tx_time;
 127         uint16_t        f_tx_len;
 128         uint16_t        f_tx_reserved;
 129
 130         uint32_t        f_tx_dev_spec[4];
 131
 132         uint8_t         f_tx_ctrl;              /* see DESC_CTRL_ */
 133         uint8_t         f_tx_ctrl2;
 134         uint8_t         f_tx_error;             /* see DESC_ERR_ */
 135         uint8_t         f_tx_data_nretry;       /* non-RTS retries */
 136         uint8_t         f_tx_rts_nretry;        /* RTS retries */
 137         uint8_t         f_tx_rts_ok;
 138
 139         /* XXX should be moved to chip specific file */
 140         union {
 141                 struct {
 142                         uint8_t         rate100;        /* acx100 tx rate */
 143                         uint8_t         queue_ctrl;
 144                 } __packed r1;
 145                 struct {
 146                         uint16_t        rate111;        /* acx111 tx rate */
 147                 } __packed r2;
 148         } u;
 149 #define f_tx_rate100    u.r1.rate100
 150 #define f_tx_queue_ctrl u.r1.queue_ctrl
 151 #define f_tx_rate111    u.r2.rate111
 152         uint32_t        f_tx_queue_info;
 153 } __packed;
 154
 155 /*
 156  * Firmware RX descriptor
 157  * Fields are little endian
 158  */
 159 struct acx_fw_rxdesc {
 160         uint32_t        f_rx_next_desc; /* next acx_fw_rxdesc phyaddr */
 161         uint32_t        f_rx_host_desc; /* acx_host_desc phyaddr */
 162         uint32_t        f_rx_acx_ptr;
 163         uint32_t        f_rx_time;
 164         uint16_t        f_rx_len;
 165         uint16_t        f_rx_wep_len;
 166         uint32_t        f_rx_wep_ofs;
 167
 168         uint8_t         f_rx_dev_spec[16];
 169
 170         uint8_t         f_rx_ctrl;      /* see DESC_CTRL_ */
 171         uint8_t         f_rx_rate;
 172         uint8_t         f_rx_error;
 173         uint8_t         f_rx_snr;       /* signal noise ratio */
 174         uint8_t         f_rx_level;
 175         uint8_t         f_rx_queue_ctrl;
 176         uint16_t        f_rx_unknown0;
 177         uint32_t        f_rx_unknown1;
 178 } __packed;
 179
 180 /*
 181  * Host TX/RX descriptor
 182  * Fields are little endian
 183  */
 184 struct acx_host_desc {
 185         uint32_t        h_data_paddr;   /* data phyaddr */
 186         uint16_t        h_data_ofs;
 187         uint16_t        h_reserved;
 188         uint16_t        h_ctrl;         /* see DESC_CTRL_ */
 189         uint16_t        h_data_len;     /* data length */
 190         uint32_t        h_next_desc;    /* next acx_host_desc phyaddr */
 191         uint32_t        h_pnext;
 192         uint32_t        h_status;       /* see DESC_STATUS_ */
 193 } __packed;
 194
 195 #define DESC_STATUS_FULL                0x80000000
 196
 197 #define DESC_CTRL_SHORT_PREAMBLE        0x01
 198 #define DESC_CTRL_FIRST_FRAG            0x02
 199 #define DESC_CTRL_AUTODMA               0x04
 200 #define DESC_CTRL_RECLAIM               0x08
 201 #define DESC_CTRL_HOSTDONE              0x20    /* host finished buf proc */
 202 #define DESC_CTRL_ACXDONE               0x40    /* chip finished buf proc */
 203 #define DESC_CTRL_HOSTOWN               0x80    /* host controls desc */
 204
 205 #define DESC_ERR_OTHER_FRAG             0x01
 206 #define DESC_ERR_ABORT                  0x02
 207 #define DESC_ERR_PARAM                  0x04
 208 #define DESC_ERR_NO_WEPKEY              0x08
 209 #define DESC_ERR_MSDU_TIMEOUT           0x10
 210 #define DESC_ERR_EXCESSIVE_RETRY        0x20
 211 #define DESC_ERR_BUF_OVERFLOW           0x40
 212 #define DESC_ERR_DMA                    0x80
 213
 214 /*
 215  * Extra header in receiving buffer
 216  * Fields are little endian
 217  */
 218 struct acx_rxbuf_hdr {
 219         uint16_t        rbh_len;        /* ACX_RXBUG_LEN_MASK part is len */
 220         uint8_t         rbh_memblk_cnt;
 221         uint8_t         rbh_status;
 222         uint8_t         rbh_bbp_stat;   /* see ACX_RXBUF_STAT_ */
 223         uint8_t         rbh_plcp;
 224         uint8_t         rbh_level;      /* signal level */
 225         uint8_t         rbh_snr;        /* signal noise ratio */
 226         uint32_t        rbh_time;       /* recv timestamp */
 227
 228         /*
 229          * XXX may have 4~8 byte here which
 230          * depends on firmware version
 231          */
 232 } __packed;
 233
 234 #define ACX_RXBUF_LEN_MASK      0xfff
 235
 236 #define ACX_RXBUF_STAT_OFDM     0x04
 237 #define ACX_RXBUF_STAT_ANT1     0x10
 238 #define ACX_RXBUF_STAT_SHPRE    0x80
 239
 240 struct acx_ring_data {
 241         struct acx_host_desc    *rx_ring;
 242         bus_dma_tag_t           rx_ring_dma_tag;
 243         bus_dmamap_t            rx_ring_dmamap;
 244         uint32_t                rx_ring_paddr;
 245
 246         struct acx_host_desc    *tx_ring;
 247         bus_dma_tag_t           tx_ring_dma_tag;
 248         bus_dmamap_t            tx_ring_dmamap;
 249         uint32_t                tx_ring_paddr;
 250 };
 251
 252 struct acx_txbuf {
 253         struct mbuf             *tb_mbuf;
 254         bus_dmamap_t            tb_mbuf_dmamap;
 255
 256         struct acx_host_desc    *tb_desc1;
 257         struct acx_host_desc    *tb_desc2;
 258
 259         uint32_t                tb_fwdesc_ofs;
 260
 261         /*
 262          * TX rate control
 263          */
 264         struct ieee80211_node   *tb_node;
 265         int                     tb_rateidx_len;
 266         int                     tb_rateidx[IEEE80211_RATEIDX_MAX];
 267 };
 268
 269 struct acx_rxbuf {
 270         struct mbuf             *rb_mbuf;
 271         bus_dmamap_t            rb_mbuf_dmamap;
 272
 273         struct acx_host_desc    *rb_desc;
 274 };
 275
 276 struct acx_buf_data {
 277         struct acx_rxbuf        rx_buf[ACX_RX_DESC_CNT];
 278         struct acx_txbuf        tx_buf[ACX_TX_DESC_CNT];
 279         bus_dma_tag_t           mbuf_dma_tag;
 280         bus_dmamap_t            mbuf_tmp_dmamap;
 281
 282         int                     rx_scan_start;
 283
 284         int                     tx_free_start;
 285         int                     tx_used_start;
 286         int                     tx_used_count;
 287 };
 288
 289 struct acx_firmware {
 290         uint8_t *base_fw;
 291         int     base_fw_len;
 292
 293         uint8_t *radio_fw;
 294         int     radio_fw_len;
 295 };
 296
 297 struct acx_config {
 298         uint8_t eaddr[IEEE80211_ADDR_LEN];
 299         uint8_t antenna;
 300         uint8_t regdom;
 301         uint8_t cca_mode;       /* acx100 */
 302         uint8_t ed_thresh;      /* acx100 */
 303 };
 304
 305 struct acx_stats {
 306         uint64_t        err_oth_frag;   /* XXX error in other frag?? */
 307         uint64_t        err_abort;      /* tx abortion */
 308         uint64_t        err_param;      /* tx desc contains invalid param */
 309         uint64_t        err_no_wepkey;  /* no WEP key exists */
 310         uint64_t        err_msdu_timeout; /* MSDU timed out */
 311         uint64_t        err_ex_retry;   /* excessive tx retry */
 312         uint64_t        err_buf_oflow;  /* buffer overflow */
 313         uint64_t        err_dma;        /* DMA error */
 314         uint64_t        err_unkn;       /* XXX unknown error */
 315 };
 316
 317 #define ACX_RX_RADIOTAP_PRESENT                         \
 318         ((1 << IEEE80211_RADIOTAP_TSFT)         |       \
 319          (1 << IEEE80211_RADIOTAP_FLAGS)        |       \
 320          (1 << IEEE80211_RADIOTAP_RATE)         |       \
 321          (1 << IEEE80211_RADIOTAP_CHANNEL)      |       \
 322          (1 << IEEE80211_RADIOTAP_DBM_ANTSIGNAL)|       \
 323          (1 << IEEE80211_RADIOTAP_ANTENNA))
 324
 325 struct acx_rx_radiotap_header {
 326         struct ieee80211_radiotap_header wr_ihdr;
 327         uint64_t        wr_tsf;
 328         uint8_t         wr_flags;
 329         uint8_t         wr_rate;
 330         uint16_t        wr_chan_freq;
 331         uint16_t        wr_chan_flags;
 332         uint8_t         wr_antsignal;
 333         uint8_t         wr_antenna;
 334 };
 335
 336 #define ACX_TX_RADIOTAP_PRESENT                         \
 337         ((1 << IEEE80211_RADIOTAP_FLAGS)        |       \
 338          (1 << IEEE80211_RADIOTAP_RATE)         |       \
 339          (1 << IEEE80211_RADIOTAP_CHANNEL))
 340
 341 struct acx_tx_radiotap_header {
 342         struct ieee80211_radiotap_header wt_ihdr;
 343         uint8_t         wt_flags;
 344         uint8_t         wt_rate;
 345         uint16_t        wt_chan_freq;
 346         uint16_t        wt_chan_flags;
 347 };
 348
 349 struct acx_softc {
 350         /*
 351          * sc_xxx are filled in by common code
 352          * chip_xxx are filled in by chip specific code
 353          */
 354         struct ieee80211com     sc_ic;
 355
 356         /*
 357          * Radio tap
 358          */
 359         struct bpf_if           *sc_drvbpf;
 360         union {
 361                 struct acx_tx_radiotap_header u_tx_th;
 362                 uint8_t         u_pad[IEEE80211_RADIOTAP_HDRLEN];
 363         } sc_u_tx_th;
 364         int                     sc_tx_th_len;
 365         union {
 366                 struct acx_rx_radiotap_header u_rx_th;
 367                 uint8_t         u_pad[IEEE80211_RADIOTAP_HDRLEN];
 368         } sc_u_rx_th;
 369         int                     sc_rx_th_len;
 370 #define sc_tx_th        sc_u_tx_th.u_tx_th
 371 #define sc_rx_th        sc_u_rx_th.u_rx_th
 372
 373         struct callout          sc_scan_timer;
 374         uint32_t                sc_flags;       /* see ACX_FLAG_ */
 375         int                     sc_tx_timer;
 376
 377         struct acx_firmware     sc_firmware;
 378         uint32_t                sc_firmware_ver;
 379         uint32_t                sc_hardware_id;
 380
 381         /*
 382          * MMIO 1
 383          */
 384         struct resource         *sc_mem1_res;
 385         bus_space_tag_t         sc_mem1_bt;
 386         bus_space_handle_t      sc_mem1_bh;
 387         int                     chip_mem1_rid;
 388
 389         /*
 390          * MMIO 2
 391          */
 392         struct resource         *sc_mem2_res;
 393         bus_space_tag_t         sc_mem2_bt;
 394         bus_space_handle_t      sc_mem2_bh;
 395         int                     chip_mem2_rid;
 396
 397         struct resource         *sc_irq_res;
 398         void                    *sc_irq_handle;
 399         int                     sc_irq_rid;
 400
 401         uint32_t                sc_cmd;         /* cmd reg (MMIO 2) */
 402         uint32_t                sc_cmd_param;   /* cmd param reg (MMIO 2) */
 403         uint32_t                sc_info;        /* unused */
 404         uint32_t                sc_info_param;  /* unused */
 405
 406         const uint16_t          *chip_ioreg;    /* reg map (MMIO 1) */
 407
 408         /*
 409          * NOTE:
 410          * chip_intr_enable is not necessarily same as
 411          * ~chip_intr_disable
 412          */
 413         uint16_t                chip_intr_enable;
 414         uint16_t                chip_intr_disable;
 415
 416         int                     chip_hw_crypt;
 417         uint16_t                chip_gpio_pled; /* power led */
 418         uint16_t                chip_chan_flags; /* see IEEE80211_CHAN_ */
 419         uint16_t                chip_txdesc1_len;
 420         int                     chip_rxbuf_exhdr; /* based on fw ver */
 421         uint32_t                chip_ee_eaddr_ofs;
 422         enum ieee80211_phymode  chip_phymode;   /* see IEEE80211_MODE_ */
 423         uint8_t                 chip_fw_txdesc_ctrl;
 424         int                     chip_rssi_corr;
 425
 426         uint8_t                 sc_eeprom_ver;  /* unused */
 427         uint8_t                 sc_form_factor; /* unused */
 428         uint8_t                 sc_radio_type;  /* see ACX_RADIO_TYPE_ */
 429
 430         struct acx_ring_data    sc_ring_data;
 431         struct acx_buf_data     sc_buf_data;
 432
 433         struct acx_stats        sc_stats;       /* statistics */
 434
 435         struct sysctl_ctx_list  sc_sysctl_ctx;
 436         struct sysctl_oid       *sc_sysctl_tree;
 437
 438         int                     sc_long_retry_limit;
 439         int                     chip_short_retry_limit;
 440         int                     chip_rate_fallback;
 441
 442         /*
 443          * Per interface sysctl variables
 444          */
 445         int                     sc_msdu_lifetime;
 446         int                     sc_scan_dwell;  /* unit: millisecond */
 447
 448         int                     (*sc_newstate)
 449                                 (struct ieee80211com *,
 450                                  enum ieee80211_state, int);
 451
 452         int                     (*chip_init)            /* non-NULL */
 453                                 (struct acx_softc *);
 454
 455         int                     (*chip_set_wepkey)
 456                                 (struct acx_softc *,
 457                                  struct ieee80211_key *, int);
 458
 459         int                     (*chip_read_config)
 460                                 (struct acx_softc *, struct acx_config *);
 461
 462         int                     (*chip_write_config)
 463                                 (struct acx_softc *, struct acx_config *);
 464
 465         uint8_t                 (*chip_set_fw_txdesc_rate) /* non-NULL */
 466                                 (struct acx_softc *, struct acx_txbuf *,
 467                                  struct ieee80211_node *, int);
 468
 469         void                    (*chip_tx_complete)     /* non-NULL */
 470                                 (struct acx_softc *, struct acx_txbuf *,
 471                                  int, int);
 472
 473         void                    (*chip_set_bss_join_param) /* non-NULL */
 474                                 (struct acx_softc *, void *, int);
 475
 476         void                    (*chip_proc_wep_rxbuf)
 477                                 (struct acx_softc *, struct mbuf *, int *);
 478 };
 479
 480 #define ACX_FLAG_FW_LOADED      0x1
 481 #define ACX_FLAG_PROMISC        0x2
 482
 483 #define ACX_RADIO_TYPE_MAXIM    0x0d
 484 #define ACX_RADIO_TYPE_RFMD     0x11
 485 #define ACX_RADIO_TYPE_RALINK   0x15
 486 #define ACX_RADIO_TYPE_RADIA    0x16
 487 #define ACX_RADIO_TYPE_UNKN17   0x17
 488 #define ACX_RADIO_TYPE_UNKN19   0x19
 489
 490 extern const struct ieee80211_rateset   acx_rates_11b;
 491 extern const struct ieee80211_rateset   acx_rates_11g;
 492
 493 void    acx100_set_param(device_t);
 494 void    acx111_set_param(device_t);
 495
 496 int     acx_init_tmplt_ordered(struct acx_softc *);
 497 void    acx_write_phyreg(struct acx_softc *, uint32_t, uint8_t);
 498
 499 #endif  /* !_IF_ACXVAR_H */