drivers/net/wireless/iwlwifi/iwl-trans-pcie-int.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2003 - 2011 Intel Corporation. All rights reserved.
   4  *
   5  * Portions of this file are derived from the ipw3945 project, as well
   6  * as portions of the ieee80211 subsystem header files.
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of version 2 of the GNU General Public License as
  10  * published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  15  * more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along with
  18  * this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
  20  *
  21  * The full GNU General Public License is included in this distribution in the
  22  * file called LICENSE.
  23  *
  24  * Contact Information:
  25  *  Intel Linux Wireless <ilw@linux.intel.com>
  26  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  27  *
  28  *****************************************************************************/
  29 #ifndef __iwl_trans_int_pcie_h__
  30 #define __iwl_trans_int_pcie_h__
  31
  32 #include <linux/spinlock.h>
  33 #include <linux/interrupt.h>
  34 #include <linux/skbuff.h>
  35 #include <linux/pci.h>
  36
  37 #include "iwl-fh.h"
  38 #include "iwl-csr.h"
  39 #include "iwl-shared.h"
  40 #include "iwl-trans.h"
  41 #include "iwl-debug.h"
  42 #include "iwl-io.h"
  43
  44 struct iwl_tx_queue;
  45 struct iwl_queue;
  46 struct iwl_host_cmd;
  47
  48 /*This file includes the declaration that are internal to the
  49  * trans_pcie layer */
  50
  51 /**
  52  * struct isr_statistics - interrupt statistics
  53  *
  54  */
  55 struct isr_statistics {
  56         u32 hw;
  57         u32 sw;
  58         u32 err_code;
  59         u32 sch;
  60         u32 alive;
  61         u32 rfkill;
  62         u32 ctkill;
  63         u32 wakeup;
  64         u32 rx;
  65         u32 tx;
  66         u32 unhandled;
  67 };
  68
  69 /**
  70  * struct iwl_rx_queue - Rx queue
  71  * @bd: driver's pointer to buffer of receive buffer descriptors (rbd)
  72  * @bd_dma: bus address of buffer of receive buffer descriptors (rbd)
  73  * @pool:
  74  * @queue:
  75  * @read: Shared index to newest available Rx buffer
  76  * @write: Shared index to oldest written Rx packet
  77  * @free_count: Number of pre-allocated buffers in rx_free
  78  * @write_actual:
  79  * @rx_free: list of free SKBs for use
  80  * @rx_used: List of Rx buffers with no SKB
  81  * @need_update: flag to indicate we need to update read/write index
  82  * @rb_stts: driver's pointer to receive buffer status
  83  * @rb_stts_dma: bus address of receive buffer status
  84  * @lock:
  85  *
  86  * NOTE:  rx_free and rx_used are used as a FIFO for iwl_rx_mem_buffers
  87  */
  88 struct iwl_rx_queue {
  89         __le32 *bd;
  90         dma_addr_t bd_dma;
  91         struct iwl_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
  92         struct iwl_rx_mem_buffer *queue[RX_QUEUE_SIZE];
  93         u32 read;
  94         u32 write;
  95         u32 free_count;
  96         u32 write_actual;
  97         struct list_head rx_free;
  98         struct list_head rx_used;
  99         int need_update;
 100         struct iwl_rb_status *rb_stts;
 101         dma_addr_t rb_stts_dma;
 102         spinlock_t lock;
 103 };
 104
 105 struct iwl_dma_ptr {
 106         dma_addr_t dma;
 107         void *addr;
 108         size_t size;
 109 };
 110
 111 /*
 112  * This queue number is required for proper operation
 113  * because the ucode will stop/start the scheduler as
 114  * required.
 115  */
 116 #define IWL_IPAN_MCAST_QUEUE            8
 117
 118 struct iwl_cmd_meta {
 119         /* only for SYNC commands, iff the reply skb is wanted */
 120         struct iwl_host_cmd *source;
 121
 122         u32 flags;
 123
 124         DEFINE_DMA_UNMAP_ADDR(mapping);
 125         DEFINE_DMA_UNMAP_LEN(len);
 126 };
 127
 128 /*
 129  * Generic queue structure
 130  *
 131  * Contains common data for Rx and Tx queues.
 132  *
 133  * Note the difference between n_bd and n_window: the hardware
 134  * always assumes 256 descriptors, so n_bd is always 256 (unless
 135  * there might be HW changes in the future). For the normal TX
 136  * queues, n_window, which is the size of the software queue data
 137  * is also 256; however, for the command queue, n_window is only
 138  * 32 since we don't need so many commands pending. Since the HW
 139  * still uses 256 BDs for DMA though, n_bd stays 256. As a result,
 140  * the software buffers (in the variables @meta, @txb in struct
 141  * iwl_tx_queue) only have 32 entries, while the HW buffers (@tfds
 142  * in the same struct) have 256.
 143  * This means that we end up with the following:
 144  *  HW entries: | 0 | ... | N * 32 | ... | N * 32 + 31 | ... | 255 |
 145  *  SW entries:           | 0      | ... | 31          |
 146  * where N is a number between 0 and 7. This means that the SW
 147  * data is a window overlayed over the HW queue.
 148  */
 149 struct iwl_queue {
 150         int n_bd;              /* number of BDs in this queue */
 151         int write_ptr;       /* 1-st empty entry (index) host_w*/
 152         int read_ptr;         /* last used entry (index) host_r*/
 153         /* use for monitoring and recovering the stuck queue */
 154         dma_addr_t dma_addr;   /* physical addr for BD's */
 155         int n_window;          /* safe queue window */
 156         u32 id;
 157         int low_mark;          /* low watermark, resume queue if free
 158                                 * space more than this */
 159         int high_mark;         /* high watermark, stop queue if free
 160                                 * space less than this */
 161 };
 162
 163 /**
 164  * struct iwl_tx_queue - Tx Queue for DMA
 165  * @q: generic Rx/Tx queue descriptor
 166  * @bd: base of circular buffer of TFDs
 167  * @cmd: array of command/TX buffer pointers
 168  * @meta: array of meta data for each command/tx buffer
 169  * @dma_addr_cmd: physical address of cmd/tx buffer array
 170  * @txb: array of per-TFD driver data
 171  * @time_stamp: time (in jiffies) of last read_ptr change
 172  * @need_update: indicates need to update read/write index
 173  * @sched_retry: indicates queue is high-throughput aggregation (HT AGG) enabled
 174  * @sta_id: valid if sched_retry is set
 175  * @tid: valid if sched_retry is set
 176  *
 177  * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
 178  * descriptors) and required locking structures.
 179  */
 180 #define TFD_TX_CMD_SLOTS 256
 181 #define TFD_CMD_SLOTS 32
 182
 183 struct iwl_tx_queue {
 184         struct iwl_queue q;
 185         struct iwl_tfd *tfds;
 186         struct iwl_device_cmd **cmd;
 187         struct iwl_cmd_meta *meta;
 188         struct sk_buff **skbs;
 189         unsigned long time_stamp;
 190         u8 need_update;
 191         u8 sched_retry;
 192         u8 active;
 193         u8 swq_id;
 194
 195         u16 sta_id;
 196         u16 tid;
 197 };
 198
 199 /**
 200  * struct iwl_trans_pcie - PCIe transport specific data
 201  * @rxq: all the RX queue data
 202  * @rx_replenish: work that will be called when buffers need to be allocated
 203  * @trans: pointer to the generic transport area
 204  * @scd_base_addr: scheduler sram base address in SRAM
 205  * @scd_bc_tbls: pointer to the byte count table of the scheduler
 206  * @kw: keep warm address
 207  * @ac_to_fifo: to what fifo is a specifc AC mapped ?
 208  * @ac_to_queue: to what tx queue  is a specifc AC mapped ?
 209  * @mcast_queue:
 210  * @txq: Tx DMA processing queues
 211  * @txq_ctx_active_msk: what queue is active
 212  * queue_stopped: tracks what queue is stopped
 213  * queue_stop_count: tracks what SW queue is stopped
 214  */
 215 struct iwl_trans_pcie {
 216         struct iwl_rx_queue rxq;
 217         struct work_struct rx_replenish;
 218         struct iwl_trans *trans;
 219
 220         /* INT ICT Table */
 221         __le32 *ict_tbl;
 222         void *ict_tbl_vir;
 223         dma_addr_t ict_tbl_dma;
 224         dma_addr_t aligned_ict_tbl_dma;
 225         int ict_index;
 226         u32 inta;
 227         bool use_ict;
 228         struct tasklet_struct irq_tasklet;
 229         struct isr_statistics isr_stats;
 230
 231         u32 inta_mask;
 232         u32 scd_base_addr;
 233         struct iwl_dma_ptr scd_bc_tbls;
 234         struct iwl_dma_ptr kw;
 235
 236         const u8 *ac_to_fifo[NUM_IWL_RXON_CTX];
 237         const u8 *ac_to_queue[NUM_IWL_RXON_CTX];
 238         u8 mcast_queue[NUM_IWL_RXON_CTX];
 239
 240         struct iwl_tx_queue *txq;
 241         unsigned long txq_ctx_active_msk;
 242 #define IWL_MAX_HW_QUEUES       32
 243         unsigned long queue_stopped[BITS_TO_LONGS(IWL_MAX_HW_QUEUES)];
 244         atomic_t queue_stop_count[4];
 245 };
 246
 247 #define IWL_TRANS_GET_PCIE_TRANS(_iwl_trans) \
 248         ((struct iwl_trans_pcie *) ((_iwl_trans)->trans_specific))
 249
 250 /*****************************************************
 251 * RX
 252 ******************************************************/
 253 void iwl_bg_rx_replenish(struct work_struct *data);
 254 void iwl_irq_tasklet(struct iwl_trans *trans);
 255 void iwlagn_rx_replenish(struct iwl_trans *trans);
 256 void iwl_rx_queue_update_write_ptr(struct iwl_trans *trans,
 257                         struct iwl_rx_queue *q);
 258
 259 /*****************************************************
 260 * ICT
 261 ******************************************************/
 262 int iwl_reset_ict(struct iwl_trans *trans);
 263 void iwl_disable_ict(struct iwl_trans *trans);
 264 int iwl_alloc_isr_ict(struct iwl_trans *trans);
 265 void iwl_free_isr_ict(struct iwl_trans *trans);
 266 irqreturn_t iwl_isr_ict(int irq, void *data);
 267
 268 /*****************************************************
 269 * TX / HCMD
 270 ******************************************************/
 271 void iwl_txq_update_write_ptr(struct iwl_trans *trans,
 272                         struct iwl_tx_queue *txq);
 273 int iwlagn_txq_attach_buf_to_tfd(struct iwl_trans *trans,
 274                                  struct iwl_tx_queue *txq,
 275                                  dma_addr_t addr, u16 len, u8 reset);
 276 int iwl_queue_init(struct iwl_queue *q, int count, int slots_num, u32 id);
 277 int iwl_trans_pcie_send_cmd(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
 278 int __must_check iwl_trans_pcie_send_cmd_pdu(struct iwl_trans *trans, u8 id,
 279                         u32 flags, u16 len, const void *data);
 280 void iwl_tx_cmd_complete(struct iwl_trans *trans,
 281                          struct iwl_rx_mem_buffer *rxb, int handler_status);
 282 void iwl_trans_txq_update_byte_cnt_tbl(struct iwl_trans *trans,
 283                                            struct iwl_tx_queue *txq,
 284                                            u16 byte_cnt);
 285 void iwl_trans_pcie_txq_agg_disable(struct iwl_trans *trans, int txq_id);
 286 int iwl_trans_pcie_tx_agg_disable(struct iwl_trans *trans,
 287                                   enum iwl_rxon_context_id ctx, int sta_id,
 288                                   int tid);
 289 void iwl_trans_set_wr_ptrs(struct iwl_trans *trans, int txq_id, u32 index);
 290 void iwl_trans_tx_queue_set_status(struct iwl_trans *trans,
 291                              struct iwl_tx_queue *txq,
 292                              int tx_fifo_id, int scd_retry);
 293 int iwl_trans_pcie_tx_agg_alloc(struct iwl_trans *trans,
 294                                 enum iwl_rxon_context_id ctx, int sta_id,
 295                                 int tid, u16 *ssn);
 296 void iwl_trans_pcie_tx_agg_setup(struct iwl_trans *trans,
 297                                  enum iwl_rxon_context_id ctx,
 298                                  int sta_id, int tid, int frame_limit);
 299 void iwlagn_txq_free_tfd(struct iwl_trans *trans, struct iwl_tx_queue *txq,
 300         int index, enum dma_data_direction dma_dir);
 301 int iwl_tx_queue_reclaim(struct iwl_trans *trans, int txq_id, int index,
 302                          struct sk_buff_head *skbs);
 303 int iwl_queue_space(const struct iwl_queue *q);
 304
 305 /*****************************************************
 306 * Error handling
 307 ******************************************************/
 308 int iwl_dump_nic_event_log(struct iwl_trans *trans, bool full_log,
 309                             char **buf, bool display);
 310 int iwl_dump_fh(struct iwl_trans *trans, char **buf, bool display);
 311 void iwl_dump_csr(struct iwl_trans *trans);
 312
 313 /*****************************************************
 314 * Helpers
 315 ******************************************************/
 316 static inline void iwl_disable_interrupts(struct iwl_trans *trans)
 317 {
 318         clear_bit(STATUS_INT_ENABLED, &trans->shrd->status);
 319
 320         /* disable interrupts from uCode/NIC to host */
 321         iwl_write32(bus(trans), CSR_INT_MASK, 0x00000000);
 322
 323         /* acknowledge/clear/reset any interrupts still pending
 324          * from uCode or flow handler (Rx/Tx DMA) */
 325         iwl_write32(bus(trans), CSR_INT, 0xffffffff);
 326         iwl_write32(bus(trans), CSR_FH_INT_STATUS, 0xffffffff);
 327         IWL_DEBUG_ISR(trans, "Disabled interrupts\n");
 328 }
 329
 330 static inline void iwl_enable_interrupts(struct iwl_trans *trans)
 331 {
 332         struct iwl_trans_pcie *trans_pcie =
 333                 IWL_TRANS_GET_PCIE_TRANS(trans);
 334
 335         IWL_DEBUG_ISR(trans, "Enabling interrupts\n");
 336         set_bit(STATUS_INT_ENABLED, &trans->shrd->status);
 337         iwl_write32(bus(trans), CSR_INT_MASK, trans_pcie->inta_mask);
 338 }
 339
 340 /*
 341  * we have 8 bits used like this:
 342  *
 343  * 7 6 5 4 3 2 1 0
 344  * | | | | | | | |
 345  * | | | | | | +-+-------- AC queue (0-3)
 346  * | | | | | |
 347  * | +-+-+-+-+------------ HW queue ID
 348  * |
 349  * +---------------------- unused
 350  */
 351 static inline void iwl_set_swq_id(struct iwl_tx_queue *txq, u8 ac, u8 hwq)
 352 {
 353         BUG_ON(ac > 3);   /* only have 2 bits */
 354         BUG_ON(hwq > 31); /* only use 5 bits */
 355
 356         txq->swq_id = (hwq << 2) | ac;
 357 }
 358
 359 static inline void iwl_wake_queue(struct iwl_trans *trans,
 360                                   struct iwl_tx_queue *txq)
 361 {
 362         u8 queue = txq->swq_id;
 363         u8 ac = queue & 3;
 364         u8 hwq = (queue >> 2) & 0x1f;
 365         struct iwl_trans_pcie *trans_pcie =
 366                 IWL_TRANS_GET_PCIE_TRANS(trans);
 367
 368         if (test_and_clear_bit(hwq, trans_pcie->queue_stopped))
 369                 if (atomic_dec_return(&trans_pcie->queue_stop_count[ac]) <= 0)
 370                         iwl_wake_sw_queue(priv(trans), ac);
 371 }
 372
 373 static inline void iwl_stop_queue(struct iwl_trans *trans,
 374                                   struct iwl_tx_queue *txq)
 375 {
 376         u8 queue = txq->swq_id;
 377         u8 ac = queue & 3;
 378         u8 hwq = (queue >> 2) & 0x1f;
 379         struct iwl_trans_pcie *trans_pcie =
 380                 IWL_TRANS_GET_PCIE_TRANS(trans);
 381
 382         if (!test_and_set_bit(hwq, trans_pcie->queue_stopped))
 383                 if (atomic_inc_return(&trans_pcie->queue_stop_count[ac]) > 0)
 384                         iwl_stop_sw_queue(priv(trans), ac);
 385 }
 386
 387 #ifdef ieee80211_stop_queue
 388 #undef ieee80211_stop_queue
 389 #endif
 390
 391 #define ieee80211_stop_queue DO_NOT_USE_ieee80211_stop_queue
 392
 393 #ifdef ieee80211_wake_queue
 394 #undef ieee80211_wake_queue
 395 #endif
 396
 397 #define ieee80211_wake_queue DO_NOT_USE_ieee80211_wake_queue
 398
 399 static inline void iwl_txq_ctx_activate(struct iwl_trans_pcie *trans_pcie,
 400                                         int txq_id)
 401 {
 402         set_bit(txq_id, &trans_pcie->txq_ctx_active_msk);
 403 }
 404
 405 static inline void iwl_txq_ctx_deactivate(struct iwl_trans_pcie *trans_pcie,
 406                                           int txq_id)
 407 {
 408         clear_bit(txq_id, &trans_pcie->txq_ctx_active_msk);
 409 }
 410
 411 static inline int iwl_queue_used(const struct iwl_queue *q, int i)
 412 {
 413         return q->write_ptr >= q->read_ptr ?
 414                 (i >= q->read_ptr && i < q->write_ptr) :
 415                 !(i < q->read_ptr && i >= q->write_ptr);
 416 }
 417
 418 static inline u8 get_cmd_index(struct iwl_queue *q, u32 index)
 419 {
 420         return index & (q->n_window - 1);
 421 }
 422
 423 #define IWL_TX_FIFO_BK          0       /* shared */
 424 #define IWL_TX_FIFO_BE          1
 425 #define IWL_TX_FIFO_VI          2       /* shared */
 426 #define IWL_TX_FIFO_VO          3
 427 #define IWL_TX_FIFO_BK_IPAN     IWL_TX_FIFO_BK
 428 #define IWL_TX_FIFO_BE_IPAN     4
 429 #define IWL_TX_FIFO_VI_IPAN     IWL_TX_FIFO_VI
 430 #define IWL_TX_FIFO_VO_IPAN     5
 431 /* re-uses the VO FIFO, uCode will properly flush/schedule */
 432 #define IWL_TX_FIFO_AUX         5
 433 #define IWL_TX_FIFO_UNUSED      -1
 434
 435 /* AUX (TX during scan dwell) queue */
 436 #define IWL_AUX_QUEUE           10
 437
 438 #endif /* __iwl_trans_int_pcie_h__ */