sys/dev/wpi/if_wpivar.h

   1 /*      $FreeBSD$       */
   2
   3 /*-
   4  * Copyright (c) 2006,2007
   5  *      Damien Bergamini <damien.bergamini@free.fr>
   6  *
   7  * Permission to use, copy, modify, and distribute this software for any
   8  * purpose with or without fee is hereby granted, provided that the above
   9  * copyright notice and this permission notice appear in all copies.
  10  *
  11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  18  */
  19 struct wpi_rx_radiotap_header {
  20         struct ieee80211_radiotap_header wr_ihdr;
  21         uint64_t        wr_tsft;
  22         uint8_t         wr_flags;
  23         uint8_t         wr_rate;
  24         uint16_t        wr_chan_freq;
  25         uint16_t        wr_chan_flags;
  26         int8_t          wr_dbm_antsignal;
  27         int8_t          wr_dbm_antnoise;
  28         uint8_t         wr_antenna;
  29 } __packed;
  30
  31 #define WPI_RX_RADIOTAP_PRESENT                                         \
  32         ((1 << IEEE80211_RADIOTAP_TSFT) |                               \
  33          (1 << IEEE80211_RADIOTAP_FLAGS) |                              \
  34          (1 << IEEE80211_RADIOTAP_RATE) |                               \
  35          (1 << IEEE80211_RADIOTAP_CHANNEL) |                            \
  36          (1 << IEEE80211_RADIOTAP_DBM_ANTSIGNAL) |                      \
  37          (1 << IEEE80211_RADIOTAP_DBM_ANTNOISE) |                       \
  38          (1 << IEEE80211_RADIOTAP_ANTENNA))
  39
  40 struct wpi_tx_radiotap_header {
  41         struct ieee80211_radiotap_header wt_ihdr;
  42         uint8_t         wt_flags;
  43         uint8_t         wt_rate;
  44         uint16_t        wt_chan_freq;
  45         uint16_t        wt_chan_flags;
  46 } __packed;
  47
  48 #define WPI_TX_RADIOTAP_PRESENT                                         \
  49         ((1 << IEEE80211_RADIOTAP_FLAGS) |                              \
  50          (1 << IEEE80211_RADIOTAP_RATE) |                               \
  51          (1 << IEEE80211_RADIOTAP_CHANNEL))
  52
  53 struct wpi_dma_info {
  54         bus_dma_tag_t           tag;
  55         bus_dmamap_t            map;
  56         bus_addr_t              paddr;
  57         caddr_t                 vaddr;
  58         bus_size_t              size;
  59 };
  60
  61 struct wpi_tx_data {
  62         bus_dmamap_t            map;
  63         bus_addr_t              cmd_paddr;
  64         struct mbuf             *m;
  65         struct ieee80211_node   *ni;
  66 };
  67
  68 struct wpi_tx_ring {
  69         struct wpi_dma_info     desc_dma;
  70         struct wpi_dma_info     cmd_dma;
  71         struct wpi_tx_desc      *desc;
  72         struct wpi_tx_cmd       *cmd;
  73         struct wpi_tx_data      data[WPI_TX_RING_COUNT];
  74         bus_dma_tag_t           data_dmat;
  75         int                     qid;
  76         int                     queued;
  77         int                     cur;
  78         int                     update;
  79 };
  80
  81 struct wpi_rx_data {
  82         struct mbuf     *m;
  83         bus_dmamap_t    map;
  84 };
  85
  86 struct wpi_rx_ring {
  87         struct wpi_dma_info     desc_dma;
  88         uint32_t                *desc;
  89         struct wpi_rx_data      data[WPI_RX_RING_COUNT];
  90         bus_dma_tag_t           data_dmat;
  91         int                     cur;
  92         int                     update;
  93 };
  94
  95 struct wpi_node {
  96         struct ieee80211_node   ni;     /* must be the first */
  97         uint8_t                 id;
  98 };
  99 #define WPI_NODE(ni)    ((struct wpi_node *)(ni))
 100
 101 struct wpi_power_sample {
 102         uint8_t index;
 103         int8_t  power;
 104 };
 105
 106 struct wpi_power_group {
 107 #define WPI_SAMPLES_COUNT       5
 108         struct wpi_power_sample samples[WPI_SAMPLES_COUNT];
 109         uint8_t chan;
 110         int8_t  maxpwr;
 111         int16_t temp;
 112 };
 113
 114 struct wpi_buf {
 115         uint8_t                 data[56];  /* sizeof(struct wpi_cmd_beacon) */
 116         struct ieee80211_node   *ni;
 117         struct mbuf             *m;
 118         size_t                  size;
 119         int                     code;
 120         int                     ac;
 121 };
 122
 123 struct wpi_vap {
 124         struct ieee80211vap     wv_vap;
 125
 126         struct wpi_buf          wv_bcbuf;
 127         struct ieee80211_beacon_offsets wv_boff;
 128         struct mtx              wv_mtx;
 129
 130         uint32_t                wv_gtk;
 131 #define WPI_VAP_KEY(kid)        (1 << kid)
 132
 133         int                     (*wv_newstate)(struct ieee80211vap *,
 134                                     enum ieee80211_state, int);
 135         void                    (*wv_recv_mgmt)(struct ieee80211_node *,
 136                                     struct mbuf *, int,
 137                                     const struct ieee80211_rx_stats *,
 138                                     int, int);
 139 };
 140 #define WPI_VAP(vap)    ((struct wpi_vap *)(vap))
 141
 142 #define WPI_VAP_LOCK_INIT(_wvp) \
 143         mtx_init(&(_wvp)->wv_mtx, "lock for wv_bcbuf/wv_boff structures", \
 144             NULL, MTX_DEF)
 145 #define WPI_VAP_LOCK(_wvp)              mtx_lock(&(_wvp)->wv_mtx)
 146 #define WPI_VAP_UNLOCK(_wvp)            mtx_unlock(&(_wvp)->wv_mtx)
 147 #define WPI_VAP_LOCK_ASSERT(_wvp)       mtx_assert(&(_wvp)->wv_mtx, MA_OWNED)
 148 #define WPI_VAP_LOCK_DESTROY(_wvp)      mtx_destroy(&(_wvp)->wv_mtx)
 149
 150 struct wpi_fw_part {
 151         const uint8_t   *text;
 152         uint32_t        textsz;
 153         const uint8_t   *data;
 154         uint32_t        datasz;
 155 };
 156
 157 struct wpi_fw_info {
 158         const uint8_t           *data;
 159         size_t                  size;
 160         struct wpi_fw_part      init;
 161         struct wpi_fw_part      main;
 162         struct wpi_fw_part      boot;
 163 };
 164
 165 struct wpi_softc {
 166         device_t                sc_dev;
 167
 168         struct ifnet            *sc_ifp;
 169         int                     sc_debug;
 170
 171         int                     sc_flags;
 172 #define WPI_PS_PATH             (1 << 0)
 173
 174         struct mtx              sc_mtx;
 175         struct mtx              tx_mtx;
 176
 177         /* Shared area. */
 178         struct wpi_dma_info     shared_dma;
 179         struct wpi_shared       *shared;
 180
 181         struct wpi_tx_ring      txq[WPI_NTXQUEUES];
 182         struct mtx              txq_mtx;
 183         struct mtx              txq_state_mtx;
 184         uint32_t                txq_active;
 185
 186         struct wpi_rx_ring      rxq;
 187         uint64_t                rx_tstamp;
 188
 189         /* TX Thermal Callibration. */
 190         struct callout          calib_to;
 191         int                     calib_cnt;
 192
 193         struct callout          scan_timeout;
 194         struct callout          tx_timeout;
 195
 196         /* Watch dog timer. */
 197         struct callout          watchdog_rfkill;
 198
 199         /* Firmware image. */
 200         struct wpi_fw_info      fw;
 201         uint32_t                errptr;
 202
 203         struct resource         *irq;
 204         struct resource         *mem;
 205         bus_space_tag_t         sc_st;
 206         bus_space_handle_t      sc_sh;
 207         void                    *sc_ih;
 208         bus_size_t              sc_sz;
 209         int                     sc_cap_off;     /* PCIe Capabilities. */
 210
 211         struct wpi_rxon         rxon;
 212         struct mtx              rxon_mtx;
 213
 214         int                     temp;
 215         uint32_t                qfullmsk;
 216
 217         uint32_t                nodesmsk;
 218         struct mtx              nt_mtx;
 219
 220         void                    (*sc_node_free)(struct ieee80211_node *);
 221         void                    (*sc_update_rx_ring)(struct wpi_softc *);
 222         void                    (*sc_update_tx_ring)(struct wpi_softc *,
 223                                     struct wpi_tx_ring *);
 224
 225         struct wpi_rx_radiotap_header   sc_rxtap;
 226         struct wpi_tx_radiotap_header   sc_txtap;
 227
 228         /* Firmware image. */
 229         const struct firmware   *fw_fp;
 230
 231         /* Firmware DMA transfer. */
 232         struct wpi_dma_info     fw_dma;
 233
 234         /* Tasks used by the driver. */
 235         struct task             sc_reinittask;
 236         struct task             sc_radiooff_task;
 237         struct task             sc_radioon_task;
 238         struct task             sc_start_task;
 239
 240         /* Taskqueue */
 241         struct taskqueue        *sc_tq;
 242
 243         /* Eeprom info. */
 244         uint8_t                 cap;
 245         uint16_t                rev;
 246         uint8_t                 type;
 247         struct wpi_eeprom_chan
 248             eeprom_channels[WPI_CHAN_BANDS_COUNT][WPI_MAX_CHAN_PER_BAND];
 249         struct wpi_power_group  groups[WPI_POWER_GROUPS_COUNT];
 250         int8_t                  maxpwr[IEEE80211_CHAN_MAX];
 251         char                    domain[4];      /* Regulatory domain. */
 252 };
 253
 254 /*
 255  * Locking order:
 256  * 1. WPI_LOCK;
 257  * 2. WPI_RXON_LOCK;
 258  * 3. WPI_TX_LOCK;
 259  * 4. WPI_NT_LOCK / WPI_VAP_LOCK;
 260  * 5. WPI_TXQ_LOCK;
 261  * 6. WPI_TXQ_STATE_LOCK;
 262  */
 263
 264 #define WPI_LOCK_INIT(_sc) \
 265         mtx_init(&(_sc)->sc_mtx, device_get_nameunit((_sc)->sc_dev), \
 266             MTX_NETWORK_LOCK, MTX_DEF)
 267 #define WPI_LOCK(_sc)           mtx_lock(&(_sc)->sc_mtx)
 268 #define WPI_UNLOCK(_sc)         mtx_unlock(&(_sc)->sc_mtx)
 269 #define WPI_LOCK_ASSERT(_sc)    mtx_assert(&(_sc)->sc_mtx, MA_OWNED)
 270 #define WPI_LOCK_DESTROY(_sc)   mtx_destroy(&(_sc)->sc_mtx)
 271
 272 #define WPI_RXON_LOCK_INIT(_sc) \
 273         mtx_init(&(_sc)->rxon_mtx, "lock for wpi_rxon structure", NULL, MTX_DEF)
 274 #define WPI_RXON_LOCK(_sc)              mtx_lock(&(_sc)->rxon_mtx)
 275 #define WPI_RXON_UNLOCK(_sc)            mtx_unlock(&(_sc)->rxon_mtx)
 276 #define WPI_RXON_LOCK_ASSERT(_sc)       mtx_assert(&(_sc)->rxon_mtx, MA_OWNED)
 277 #define WPI_RXON_LOCK_DESTROY(_sc)      mtx_destroy(&(_sc)->rxon_mtx)
 278
 279 #define WPI_TX_LOCK_INIT(_sc) \
 280         mtx_init(&(_sc)->tx_mtx, "tx path lock", NULL, MTX_DEF)
 281 #define WPI_TX_LOCK(_sc)                mtx_lock(&(_sc)->tx_mtx)
 282 #define WPI_TX_UNLOCK(_sc)              mtx_unlock(&(_sc)->tx_mtx)
 283 #define WPI_TX_LOCK_DESTROY(_sc)        mtx_destroy(&(_sc)->tx_mtx)
 284
 285 #define WPI_NT_LOCK_INIT(_sc) \
 286         mtx_init(&(_sc)->nt_mtx, "node table lock", NULL, MTX_DEF)
 287 #define WPI_NT_LOCK(_sc)                mtx_lock(&(_sc)->nt_mtx)
 288 #define WPI_NT_UNLOCK(_sc)              mtx_unlock(&(_sc)->nt_mtx)
 289 #define WPI_NT_LOCK_DESTROY(_sc)        mtx_destroy(&(_sc)->nt_mtx)
 290
 291 #define WPI_TXQ_LOCK_INIT(_sc) \
 292         mtx_init(&(_sc)->txq_mtx, "txq/cmdq lock", NULL, MTX_DEF)
 293 #define WPI_TXQ_LOCK(_sc)               mtx_lock(&(_sc)->txq_mtx)
 294 #define WPI_TXQ_UNLOCK(_sc)             mtx_unlock(&(_sc)->txq_mtx)
 295 #define WPI_TXQ_LOCK_DESTROY(_sc)       mtx_destroy(&(_sc)->txq_mtx)
 296
 297 #define WPI_TXQ_STATE_LOCK_INIT(_sc) \
 298         mtx_init(&(_sc)->txq_state_mtx, "txq state lock", NULL, MTX_DEF)
 299 #define WPI_TXQ_STATE_LOCK(_sc)         mtx_lock(&(_sc)->txq_state_mtx)
 300 #define WPI_TXQ_STATE_UNLOCK(_sc)       mtx_unlock(&(_sc)->txq_state_mtx)
 301 #define WPI_TXQ_STATE_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->txq_state_mtx)