rt2870_softc.h

   1
   2 /*-
   3  * Copyright (c) 2009-2010 Alexander Egorenkov <egorenar@gmail.com>
   4  * Copyright (c) 2009 Damien Bergamini <damien.bergamini@free.fr>
   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 #ifndef _RT2870_SOFTC_H_
  20 #define _RT2870_SOFTC_H_
  21
  22 #include <sys/param.h>
  23 #include <sys/sysctl.h>
  24 #include <sys/sockio.h>
  25 #include <sys/mbuf.h>
  26 #include <sys/kernel.h>
  27 #include <sys/socket.h>
  28 #include <sys/systm.h>
  29 #include <sys/malloc.h>
  30 #include <sys/taskqueue.h>
  31 #include <sys/queue.h>
  32 #include <sys/module.h>
  33 #include <sys/bus.h>
  34 #include <sys/endian.h>
  35
  36 #include <machine/bus.h>
  37 #include <machine/resource.h>
  38 #include <sys/rman.h>
  39
  40 #include <net/bpf.h>
  41 #include <net/if.h>
  42 #include <net/if_arp.h>
  43 #include <net/ethernet.h>
  44 #include <net/if_dl.h>
  45 #include <net/if_media.h>
  46 #include <net/if_types.h>
  47
  48 #include <net80211/ieee80211_var.h>
  49 #include <net80211/ieee80211_input.h>
  50 #include <net80211/ieee80211_radiotap.h>
  51 #include <net80211/ieee80211_regdomain.h>
  52
  53 #include <dev/usb/usb.h>
  54 #include <dev/usb/usbdi.h>
  55 #include "usbdevs.h"
  56
  57 #include "rt2870_txwi.h"
  58 #include "rt2870_amrr.h"
  59
  60 #define RT2870_SOFTC_LOCK(sc)                                                           mtx_lock(&(sc)->lock)
  61 #define RT2870_SOFTC_UNLOCK(sc)                                                         mtx_unlock(&(sc)->lock)
  62 #define RT2870_SOFTC_ASSERT_LOCKED(sc)                                          mtx_assert(&(sc)->lock, MA_OWNED)
  63
  64 #define RT2870_SOFTC_FLAGS_UCODE_LOADED                                         (1 << 0)
  65
  66 #define RT2870_SOFTC_USB_XFER_COUNT                                                     (1 + RT2870_SOFTC_TX_RING_COUNT)
  67
  68 #define RT2870_SOFTC_LED_OFF_COUNT                                                      3
  69
  70 #define RT2870_SOFTC_RSSI_OFF_COUNT                                                     3
  71
  72 #define RT2870_SOFTC_LNA_GAIN_COUNT                                                     4
  73
  74 #define RT2870_SOFTC_TXPOW_COUNT                                                        50
  75
  76 #define RT2870_SOFTC_TXPOW_RATE_COUNT                                           5
  77
  78 #define RT2870_SOFTC_TSSI_COUNT                                                         9
  79
  80 #define RT2870_SOFTC_BBP_EEPROM_COUNT                                           8
  81
  82 #define RT2870_SOFTC_AMRR_NODE_COUNT                                            256
  83
  84 #define RT2870_SOFTC_RSSI_COUNT                                                         3
  85
  86 #define RT2870_SOFTC_TX_RING_COUNT                                                      6
  87
  88 #define RT2870_SOFTC_RX_RING_DATA_COUNT                                         128
  89
  90 #define RT2870_SOFTC_TX_RING_DATA_COUNT                                         256
  91
  92 #define RT2870_SOFTC_CMD_DATA_LEN                                                       256
  93 #define RT2870_SOFTC_CMD_RING_CMD_COUNT                                         64
  94
  95 #define RT2870_SOFTC_RX_RADIOTAP_PRESENT                                        \
  96         ((1 << IEEE80211_RADIOTAP_FLAGS) |                                              \
  97          (1 << IEEE80211_RADIOTAP_RATE) |                                               \
  98          (1 << IEEE80211_RADIOTAP_DBM_ANTSIGNAL) |                              \
  99          (1 << IEEE80211_RADIOTAP_DBM_ANTNOISE) |                               \
 100          (1 << IEEE80211_RADIOTAP_ANTENNA) |                                    \
 101          (1 << IEEE80211_RADIOTAP_DB_ANTSIGNAL) |                               \
 102          (1 << IEEE80211_RADIOTAP_XCHANNEL))
 103
 104 #define RT2870_SOFTC_TX_RADIOTAP_PRESENT                                        \
 105         ((1 << IEEE80211_RADIOTAP_FLAGS) |                                              \
 106          (1 << IEEE80211_RADIOTAP_RATE) |                                               \
 107          (1 << IEEE80211_RADIOTAP_XCHANNEL))
 108
 109 struct rt2870_softc;
 110
 111 struct rt2870_softc_rx_data
 112 {
 113         STAILQ_ENTRY(rt2870_softc_rx_data) next;
 114         uint8_t *buf;
 115         uint16_t len;
 116 };
 117
 118 typedef STAILQ_HEAD(, rt2870_softc_rx_data) rt2870_softc_rx_data_queue;
 119
 120 struct rt2870_softc_rx_ring
 121 {
 122         struct rt2870_softc_rx_data data[RT2870_SOFTC_RX_RING_DATA_COUNT];
 123         rt2870_softc_rx_data_queue inactive;
 124         rt2870_softc_rx_data_queue active;
 125         rt2870_softc_rx_data_queue done;
 126 };
 127
 128 struct rt2870_softc_tx_data
 129 {
 130         STAILQ_ENTRY(rt2870_softc_tx_data) next;
 131         struct ieee80211_node *ni;
 132         uint8_t *buf;
 133         uint16_t len;
 134         struct mbuf *m;
 135 };
 136
 137 typedef STAILQ_HEAD(, rt2870_softc_tx_data) rt2870_softc_tx_data_queue;
 138
 139 struct rt2870_softc_tx_ring
 140 {
 141         struct rt2870_softc_tx_data data[RT2870_SOFTC_TX_RING_DATA_COUNT];
 142         rt2870_softc_tx_data_queue inactive;
 143         rt2870_softc_tx_data_queue pending;
 144         rt2870_softc_tx_data_queue active;
 145         rt2870_softc_tx_data_queue done;
 146         int queued;
 147         int qid;
 148 };
 149
 150 struct rt2870_softc_cmd
 151 {
 152         STAILQ_ENTRY(rt2870_softc_cmd) next;
 153         void (*cb)(struct rt2870_softc *sc, void *arg);
 154         uint8_t data[RT2870_SOFTC_CMD_DATA_LEN];
 155 };
 156
 157 typedef STAILQ_HEAD(, rt2870_softc_cmd) rt2870_softc_cmd_queue;
 158
 159 struct rt2870_softc_cmd_ring
 160 {
 161         struct rt2870_softc_cmd cmd[RT2870_SOFTC_CMD_RING_CMD_COUNT];
 162         rt2870_softc_cmd_queue inactive;
 163         rt2870_softc_cmd_queue active;
 164         int     queued;
 165 };
 166
 167 struct rt2870_softc_node
 168 {
 169         struct ieee80211_node ni;
 170
 171         uint8_t last_rssi[RT2870_SOFTC_RSSI_COUNT];
 172         int8_t last_rssi_dbm[RT2870_SOFTC_RSSI_COUNT];
 173 };
 174
 175 struct rt2870_softc_vap
 176 {
 177         struct ieee80211vap     vap;
 178
 179         struct ieee80211_beacon_offsets beacon_offsets;
 180         struct mbuf *beacon_mbuf;
 181         struct rt2870_txwi beacon_txwi;
 182
 183         struct rt2870_amrr amrr;
 184
 185         int     (*newstate)(struct ieee80211vap *vap,
 186                 enum ieee80211_state nstate, int arg);
 187 };
 188
 189 struct rt2870_softc_rx_radiotap_header
 190 {
 191         struct ieee80211_radiotap_header ihdr;
 192         uint8_t flags;
 193         uint8_t rate;
 194         int8_t dbm_antsignal;
 195         int8_t dbm_antnoise;
 196         uint8_t antenna;
 197         uint8_t antsignal;
 198         uint8_t pad[2];
 199         uint32_t chan_flags;
 200         uint16_t chan_freq;
 201         uint8_t chan_ieee;
 202         int8_t chan_maxpow;
 203 } __packed;
 204
 205 struct rt2870_softc_tx_radiotap_header
 206 {
 207         struct ieee80211_radiotap_header ihdr;
 208         uint8_t flags;
 209         uint8_t rate;
 210         uint8_t pad[2];
 211         uint32_t chan_flags;
 212         uint16_t chan_freq;
 213         uint8_t chan_ieee;
 214         int8_t chan_maxpow;
 215 } __packed;
 216
 217 struct rt2870_softc
 218 {
 219         struct mtx lock;
 220
 221         uint32_t flags;
 222
 223         device_t dev;
 224
 225         int usb_endpoints;
 226         struct usb_device *usb_dev;
 227         struct usb_xfer *usb_xfer[1 + RT2870_SOFTC_TX_RING_COUNT];
 228
 229         struct ifnet *ifp;
 230         int if_flags;
 231
 232         int tx_ampdu_sessions;
 233
 234         int (*recv_action)(struct ieee80211_node *ni,
 235                 const struct ieee80211_frame *wh,
 236                 const uint8_t *frm, const uint8_t *efrm);
 237
 238         int (*send_action)(struct ieee80211_node *ni,
 239                 int cat, int act, void *sa);
 240
 241         struct rt2870_amrr_node amrr_node[RT2870_SOFTC_AMRR_NODE_COUNT];
 242
 243         uint32_t mac_rev;
 244         uint16_t eeprom_rev;
 245         uint8_t rf_rev;
 246
 247         uint8_t mac_addr[IEEE80211_ADDR_LEN];
 248
 249         uint8_t ntxpath;
 250         uint8_t nrxpath;
 251
 252         int hw_radio_cntl;
 253         int tx_agc_cntl;
 254         int ext_lna_2ghz;
 255         int ext_lna_5ghz;
 256
 257         uint8_t country_2ghz;
 258         uint8_t country_5ghz;
 259
 260         uint8_t rf_freq_off;
 261
 262         uint8_t led_cntl;
 263         uint16_t led_off[RT2870_SOFTC_LED_OFF_COUNT];
 264
 265         int8_t rssi_off_2ghz[RT2870_SOFTC_RSSI_OFF_COUNT];
 266         int8_t rssi_off_5ghz[RT2870_SOFTC_RSSI_OFF_COUNT];
 267
 268         int8_t lna_gain[RT2870_SOFTC_LNA_GAIN_COUNT];
 269
 270         int8_t txpow1[RT2870_SOFTC_TXPOW_COUNT];
 271         int8_t txpow2[RT2870_SOFTC_TXPOW_COUNT];
 272
 273         int8_t txpow_rate_delta_2ghz;
 274         int8_t txpow_rate_delta_5ghz;
 275         uint32_t txpow_rate_20mhz[RT2870_SOFTC_TXPOW_RATE_COUNT];
 276         uint32_t txpow_rate_40mhz_2ghz[RT2870_SOFTC_TXPOW_RATE_COUNT];
 277         uint32_t txpow_rate_40mhz_5ghz[RT2870_SOFTC_TXPOW_RATE_COUNT];
 278
 279         int tx_agc_cntl_2ghz;
 280         int tx_agc_cntl_5ghz;
 281
 282         uint8_t tssi_2ghz[RT2870_SOFTC_TSSI_COUNT];
 283         uint8_t tssi_step_2ghz;
 284         uint8_t tssi_5ghz[RT2870_SOFTC_TSSI_COUNT];
 285         uint8_t tssi_step_5ghz;
 286
 287         struct
 288         {
 289                 uint8_t val;
 290                 uint8_t reg;
 291         } __packed bbp_eeprom[RT2870_SOFTC_BBP_EEPROM_COUNT];
 292
 293         struct task rx_done_task;
 294         int rx_process_limit;
 295
 296         struct task tx_done_task;
 297         uint32_t tx_qid_pending_mask;
 298
 299         struct task periodic_task;
 300         struct callout periodic_ch;
 301         unsigned long periodic_round;
 302
 303         struct task cmd_task;
 304
 305         struct taskqueue *taskqueue;
 306
 307         struct rt2870_softc_rx_ring rx_ring;
 308
 309         struct rt2870_softc_tx_ring tx_ring[RT2870_SOFTC_TX_RING_COUNT];
 310         int tx_ring_mgtqid;
 311
 312         struct callout tx_watchdog_ch;
 313         int tx_timer;
 314
 315         struct rt2870_softc_cmd_ring cmd_ring;
 316
 317         struct rt2870_softc_rx_radiotap_header rxtap;
 318         struct rt2870_softc_tx_radiotap_header txtap;
 319
 320         /* statistic counters */
 321
 322         unsigned long interrupts;
 323         unsigned long rx_interrupts;
 324         unsigned long tx_interrupts[RT2870_SOFTC_TX_RING_COUNT];
 325
 326         unsigned long tx_data_queue_full[RT2870_SOFTC_TX_RING_COUNT];
 327
 328         unsigned long tx_watchdog_timeouts;
 329
 330         unsigned long rx_mbuf_alloc_errors;
 331
 332         unsigned long tx_queue_not_empty[2];
 333
 334         unsigned long tx_beacons;
 335         unsigned long tx_noretryok;
 336         unsigned long tx_retryok;
 337         unsigned long tx_failed;
 338         unsigned long tx_underflows;
 339         unsigned long tx_zerolen;
 340         unsigned long tx_nonagg;
 341         unsigned long tx_agg;
 342         unsigned long tx_ampdu;
 343         unsigned long tx_mpdu_zero_density;
 344
 345         unsigned long rx_packets;
 346         unsigned long rx_ampdu;
 347         unsigned long rx_mpdu_zero_density;
 348         unsigned long rx_amsdu;
 349         unsigned long rx_crc_errors;
 350         unsigned long rx_phy_errors;
 351         unsigned long rx_false_ccas;
 352         unsigned long rx_plcp_errors;
 353         unsigned long rx_dup_packets;
 354         unsigned long rx_fifo_overflows;
 355         unsigned long rx_cipher_no_errors;
 356         unsigned long rx_cipher_icv_errors;
 357         unsigned long rx_cipher_mic_errors;
 358         unsigned long rx_cipher_invalid_key_errors;
 359
 360 #ifdef RT2870_DEBUG
 361         int debug;
 362 #endif
 363 };
 364
 365 #endif /* #ifndef _RT2870_SOFTC_H_ */