iwl-trans-pcie-int.h 15.4 KB
Newer Older
1 2
/******************************************************************************
 *
Wey-Yi Guy's avatar
Wey-Yi Guy committed
3
 * Copyright(c) 2003 - 2012 Intel Corporation. All rights reserved.
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
 *
 * Portions of this file are derived from the ipw3945 project, as well
 * as portions of the ieee80211 subsystem header files.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
 *
 * The full GNU General Public License is included in this distribution in the
 * file called LICENSE.
 *
 * Contact Information:
 *  Intel Linux Wireless <ilw@linux.intel.com>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 *****************************************************************************/
#ifndef __iwl_trans_int_pcie_h__
#define __iwl_trans_int_pcie_h__

32 33 34
#include <linux/spinlock.h>
#include <linux/interrupt.h>
#include <linux/skbuff.h>
35
#include <linux/wait.h>
36
#include <linux/pci.h>
37

38
#include "iwl-fh.h"
39 40 41 42 43
#include "iwl-csr.h"
#include "iwl-shared.h"
#include "iwl-trans.h"
#include "iwl-debug.h"
#include "iwl-io.h"
44
#include "iwl-op-mode.h"
45 46 47 48

struct iwl_tx_queue;
struct iwl_queue;
struct iwl_host_cmd;
49

50 51 52
/*This file includes the declaration that are internal to the
 * trans_pcie layer */

53 54 55 56 57 58
struct iwl_rx_mem_buffer {
	dma_addr_t page_dma;
	struct page *page;
	struct list_head list;
};

59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
/**
 * struct isr_statistics - interrupt statistics
 *
 */
struct isr_statistics {
	u32 hw;
	u32 sw;
	u32 err_code;
	u32 sch;
	u32 alive;
	u32 rfkill;
	u32 ctkill;
	u32 wakeup;
	u32 rx;
	u32 tx;
	u32 unhandled;
};

77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
/**
 * struct iwl_rx_queue - Rx queue
 * @bd: driver's pointer to buffer of receive buffer descriptors (rbd)
 * @bd_dma: bus address of buffer of receive buffer descriptors (rbd)
 * @pool:
 * @queue:
 * @read: Shared index to newest available Rx buffer
 * @write: Shared index to oldest written Rx packet
 * @free_count: Number of pre-allocated buffers in rx_free
 * @write_actual:
 * @rx_free: list of free SKBs for use
 * @rx_used: List of Rx buffers with no SKB
 * @need_update: flag to indicate we need to update read/write index
 * @rb_stts: driver's pointer to receive buffer status
 * @rb_stts_dma: bus address of receive buffer status
 * @lock:
 *
 * NOTE:  rx_free and rx_used are used as a FIFO for iwl_rx_mem_buffers
 */
struct iwl_rx_queue {
	__le32 *bd;
	dma_addr_t bd_dma;
	struct iwl_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
	struct iwl_rx_mem_buffer *queue[RX_QUEUE_SIZE];
	u32 read;
	u32 write;
	u32 free_count;
	u32 write_actual;
	struct list_head rx_free;
	struct list_head rx_used;
	int need_update;
	struct iwl_rb_status *rb_stts;
	dma_addr_t rb_stts_dma;
	spinlock_t lock;
};

113 114 115 116 117 118
struct iwl_dma_ptr {
	dma_addr_t dma;
	void *addr;
	size_t size;
};

119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
/**
 * iwl_queue_inc_wrap - increment queue index, wrap back to beginning
 * @index -- current index
 * @n_bd -- total number of entries in queue (must be power of 2)
 */
static inline int iwl_queue_inc_wrap(int index, int n_bd)
{
	return ++index & (n_bd - 1);
}

/**
 * iwl_queue_dec_wrap - decrement queue index, wrap back to end
 * @index -- current index
 * @n_bd -- total number of entries in queue (must be power of 2)
 */
static inline int iwl_queue_dec_wrap(int index, int n_bd)
{
	return --index & (n_bd - 1);
}

139 140 141 142 143 144 145
/*
 * This queue number is required for proper operation
 * because the ucode will stop/start the scheduler as
 * required.
 */
#define IWL_IPAN_MCAST_QUEUE		8

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
struct iwl_cmd_meta {
	/* only for SYNC commands, iff the reply skb is wanted */
	struct iwl_host_cmd *source;

	u32 flags;

	DEFINE_DMA_UNMAP_ADDR(mapping);
	DEFINE_DMA_UNMAP_LEN(len);
};

/*
 * Generic queue structure
 *
 * Contains common data for Rx and Tx queues.
 *
 * Note the difference between n_bd and n_window: the hardware
 * always assumes 256 descriptors, so n_bd is always 256 (unless
 * there might be HW changes in the future). For the normal TX
 * queues, n_window, which is the size of the software queue data
 * is also 256; however, for the command queue, n_window is only
 * 32 since we don't need so many commands pending. Since the HW
 * still uses 256 BDs for DMA though, n_bd stays 256. As a result,
 * the software buffers (in the variables @meta, @txb in struct
 * iwl_tx_queue) only have 32 entries, while the HW buffers (@tfds
 * in the same struct) have 256.
 * This means that we end up with the following:
 *  HW entries: | 0 | ... | N * 32 | ... | N * 32 + 31 | ... | 255 |
 *  SW entries:           | 0      | ... | 31          |
 * where N is a number between 0 and 7. This means that the SW
 * data is a window overlayed over the HW queue.
 */
struct iwl_queue {
	int n_bd;              /* number of BDs in this queue */
	int write_ptr;       /* 1-st empty entry (index) host_w*/
	int read_ptr;         /* last used entry (index) host_r*/
	/* use for monitoring and recovering the stuck queue */
	dma_addr_t dma_addr;   /* physical addr for BD's */
	int n_window;	       /* safe queue window */
	u32 id;
	int low_mark;	       /* low watermark, resume queue if free
				* space more than this */
	int high_mark;         /* high watermark, stop queue if free
				* space less than this */
};

/**
 * struct iwl_tx_queue - Tx Queue for DMA
 * @q: generic Rx/Tx queue descriptor
 * @bd: base of circular buffer of TFDs
 * @cmd: array of command/TX buffer pointers
 * @meta: array of meta data for each command/tx buffer
 * @dma_addr_cmd: physical address of cmd/tx buffer array
 * @txb: array of per-TFD driver data
199
 * lock: queue lock
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
 * @time_stamp: time (in jiffies) of last read_ptr change
 * @need_update: indicates need to update read/write index
 * @sched_retry: indicates queue is high-throughput aggregation (HT AGG) enabled
 * @sta_id: valid if sched_retry is set
 * @tid: valid if sched_retry is set
 *
 * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
 * descriptors) and required locking structures.
 */
#define TFD_TX_CMD_SLOTS 256
#define TFD_CMD_SLOTS 32

struct iwl_tx_queue {
	struct iwl_queue q;
	struct iwl_tfd *tfds;
	struct iwl_device_cmd **cmd;
	struct iwl_cmd_meta *meta;
	struct sk_buff **skbs;
218
	spinlock_t lock;
219 220 221 222 223 224 225 226 227 228
	unsigned long time_stamp;
	u8 need_update;
	u8 sched_retry;
	u8 active;
	u8 swq_id;

	u16 sta_id;
	u16 tid;
};

229 230
/**
 * struct iwl_trans_pcie - PCIe transport specific data
231 232 233
 * @rxq: all the RX queue data
 * @rx_replenish: work that will be called when buffers need to be allocated
 * @trans: pointer to the generic transport area
Johannes Berg's avatar
Johannes Berg committed
234
 * @irq - the irq number for the device
235
 * @irq_requested: true when the irq has been requested
236 237
 * @scd_base_addr: scheduler sram base address in SRAM
 * @scd_bc_tbls: pointer to the byte count table of the scheduler
238
 * @kw: keep warm address
239 240 241
 * @ac_to_fifo: to what fifo is a specifc AC mapped ?
 * @ac_to_queue: to what tx queue  is a specifc AC mapped ?
 * @mcast_queue:
242 243 244 245
 * @txq: Tx DMA processing queues
 * @txq_ctx_active_msk: what queue is active
 * queue_stopped: tracks what queue is stopped
 * queue_stop_count: tracks what SW queue is stopped
246 247
 * @pci_dev: basic pci-network driver stuff
 * @hw_base: pci hardware address support
248 249
 * @ucode_write_complete: indicates that the ucode has been copied.
 * @ucode_write_waitq: wait queue for uCode load
250
 * @status - transport specific status flags
251
 * @cmd_queue - command queue number
252 253
 */
struct iwl_trans_pcie {
254 255 256
	struct iwl_rx_queue rxq;
	struct work_struct rx_replenish;
	struct iwl_trans *trans;
257 258 259 260 261 262 263

	/* INT ICT Table */
	__le32 *ict_tbl;
	dma_addr_t ict_tbl_dma;
	int ict_index;
	u32 inta;
	bool use_ict;
264
	bool irq_requested;
265
	struct tasklet_struct irq_tasklet;
266
	struct isr_statistics isr_stats;
267

Johannes Berg's avatar
Johannes Berg committed
268
	unsigned int irq;
269
	spinlock_t irq_lock;
270
	u32 inta_mask;
271 272
	u32 scd_base_addr;
	struct iwl_dma_ptr scd_bc_tbls;
273
	struct iwl_dma_ptr kw;
274 275 276 277

	const u8 *ac_to_fifo[NUM_IWL_RXON_CTX];
	const u8 *ac_to_queue[NUM_IWL_RXON_CTX];
	u8 mcast_queue[NUM_IWL_RXON_CTX];
278
	u8 agg_txq[IWLAGN_STATION_COUNT][IWL_MAX_TID_COUNT];
279 280 281 282 283 284

	struct iwl_tx_queue *txq;
	unsigned long txq_ctx_active_msk;
#define IWL_MAX_HW_QUEUES	32
	unsigned long queue_stopped[BITS_TO_LONGS(IWL_MAX_HW_QUEUES)];
	atomic_t queue_stop_count[4];
285 286 287 288

	/* PCI bus related data */
	struct pci_dev *pci_dev;
	void __iomem *hw_base;
289 290 291

	bool ucode_write_complete;
	wait_queue_head_t ucode_write_waitq;
292
	unsigned long status;
293
	u8 cmd_queue;
294 295
	u8 n_no_reclaim_cmds;
	u8 no_reclaim_cmds[MAX_NO_RECLAIM_CMDS];
296 297
};

298 299 300
#define IWL_TRANS_GET_PCIE_TRANS(_iwl_trans) \
	((struct iwl_trans_pcie *) ((_iwl_trans)->trans_specific))

301 302 303
/*****************************************************
* RX
******************************************************/
304
void iwl_bg_rx_replenish(struct work_struct *data);
305
void iwl_irq_tasklet(struct iwl_trans *trans);
306 307
void iwlagn_rx_replenish(struct iwl_trans *trans);
void iwl_rx_queue_update_write_ptr(struct iwl_trans *trans,
308 309
			struct iwl_rx_queue *q);

310 311 312
/*****************************************************
* ICT
******************************************************/
313
void iwl_reset_ict(struct iwl_trans *trans);
314 315 316
void iwl_disable_ict(struct iwl_trans *trans);
int iwl_alloc_isr_ict(struct iwl_trans *trans);
void iwl_free_isr_ict(struct iwl_trans *trans);
317 318
irqreturn_t iwl_isr_ict(int irq, void *data);

319 320 321
/*****************************************************
* TX / HCMD
******************************************************/
322 323
void iwl_txq_update_write_ptr(struct iwl_trans *trans,
			struct iwl_tx_queue *txq);
324
int iwlagn_txq_attach_buf_to_tfd(struct iwl_trans *trans,
325 326
				 struct iwl_tx_queue *txq,
				 dma_addr_t addr, u16 len, u8 reset);
327 328
int iwl_queue_init(struct iwl_queue *q, int count, int slots_num, u32 id);
int iwl_trans_pcie_send_cmd(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
329
void iwl_tx_cmd_complete(struct iwl_trans *trans,
330
			 struct iwl_rx_cmd_buffer *rxb, int handler_status);
331
void iwl_trans_txq_update_byte_cnt_tbl(struct iwl_trans *trans,
332 333
					   struct iwl_tx_queue *txq,
					   u16 byte_cnt);
334
int iwl_trans_pcie_tx_agg_disable(struct iwl_trans *trans,
335
				  int sta_id, int tid);
336
void iwl_trans_set_wr_ptrs(struct iwl_trans *trans, int txq_id, u32 index);
337
void iwl_trans_tx_queue_set_status(struct iwl_trans *trans,
338 339
			     struct iwl_tx_queue *txq,
			     int tx_fifo_id, int scd_retry);
340
int iwl_trans_pcie_tx_agg_alloc(struct iwl_trans *trans, int sta_id, int tid);
341 342
void iwl_trans_pcie_tx_agg_setup(struct iwl_trans *trans,
				 enum iwl_rxon_context_id ctx,
343
				 int sta_id, int tid, int frame_limit, u16 ssn);
344
void iwlagn_txq_free_tfd(struct iwl_trans *trans, struct iwl_tx_queue *txq,
345
	int index, enum dma_data_direction dma_dir);
346 347
int iwl_tx_queue_reclaim(struct iwl_trans *trans, int txq_id, int index,
			 struct sk_buff_head *skbs);
348
int iwl_queue_space(const struct iwl_queue *q);
349

350 351 352
/*****************************************************
* Error handling
******************************************************/
353 354
int iwl_dump_nic_event_log(struct iwl_trans *trans, bool full_log,
			    char **buf, bool display);
355 356 357
int iwl_dump_fh(struct iwl_trans *trans, char **buf, bool display);
void iwl_dump_csr(struct iwl_trans *trans);

358 359 360
/*****************************************************
* Helpers
******************************************************/
361 362
static inline void iwl_disable_interrupts(struct iwl_trans *trans)
{
Don Fry's avatar
Don Fry committed
363 364
	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
	clear_bit(STATUS_INT_ENABLED, &trans_pcie->status);
365 366

	/* disable interrupts from uCode/NIC to host */
367
	iwl_write32(trans, CSR_INT_MASK, 0x00000000);
368 369 370

	/* acknowledge/clear/reset any interrupts still pending
	 * from uCode or flow handler (Rx/Tx DMA) */
371 372
	iwl_write32(trans, CSR_INT, 0xffffffff);
	iwl_write32(trans, CSR_FH_INT_STATUS, 0xffffffff);
373 374 375 376 377
	IWL_DEBUG_ISR(trans, "Disabled interrupts\n");
}

static inline void iwl_enable_interrupts(struct iwl_trans *trans)
{
Don Fry's avatar
Don Fry committed
378
	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
379 380

	IWL_DEBUG_ISR(trans, "Enabling interrupts\n");
Don Fry's avatar
Don Fry committed
381
	set_bit(STATUS_INT_ENABLED, &trans_pcie->status);
382
	iwl_write32(trans, CSR_INT_MASK, trans_pcie->inta_mask);
383 384
}

385 386 387 388 389 390
static inline void iwl_enable_rfkill_int(struct iwl_trans *trans)
{
	IWL_DEBUG_ISR(trans, "Enabling rfkill interrupt\n");
	iwl_write32(trans, CSR_INT_MASK, CSR_INT_BIT_RF_KILL);
}

391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
/*
 * we have 8 bits used like this:
 *
 * 7 6 5 4 3 2 1 0
 * | | | | | | | |
 * | | | | | | +-+-------- AC queue (0-3)
 * | | | | | |
 * | +-+-+-+-+------------ HW queue ID
 * |
 * +---------------------- unused
 */
static inline void iwl_set_swq_id(struct iwl_tx_queue *txq, u8 ac, u8 hwq)
{
	BUG_ON(ac > 3);   /* only have 2 bits */
	BUG_ON(hwq > 31); /* only use 5 bits */

	txq->swq_id = (hwq << 2) | ac;
}

410 411 412 413 414
static inline u8 iwl_get_queue_ac(struct iwl_tx_queue *txq)
{
	return txq->swq_id & 0x3;
}

415
static inline void iwl_wake_queue(struct iwl_trans *trans,
416
				  struct iwl_tx_queue *txq)
417 418 419 420
{
	u8 queue = txq->swq_id;
	u8 ac = queue & 3;
	u8 hwq = (queue >> 2) & 0x1f;
421 422
	struct iwl_trans_pcie *trans_pcie =
		IWL_TRANS_GET_PCIE_TRANS(trans);
423

424 425
	if (test_and_clear_bit(hwq, trans_pcie->queue_stopped)) {
		if (atomic_dec_return(&trans_pcie->queue_stop_count[ac]) <= 0) {
426
			iwl_op_mode_queue_not_full(trans->op_mode, ac);
427 428
			IWL_DEBUG_TX_QUEUES(trans, "Wake hwq %d ac %d",
					    hwq, ac);
429
		} else {
430 431 432 433
			IWL_DEBUG_TX_QUEUES(trans,
				"Don't wake hwq %d ac %d stop count %d",
				hwq, ac,
				atomic_read(&trans_pcie->queue_stop_count[ac]));
434 435
		}
	}
436 437 438
}

static inline void iwl_stop_queue(struct iwl_trans *trans,
439
				  struct iwl_tx_queue *txq)
440 441 442 443
{
	u8 queue = txq->swq_id;
	u8 ac = queue & 3;
	u8 hwq = (queue >> 2) & 0x1f;
444 445
	struct iwl_trans_pcie *trans_pcie =
		IWL_TRANS_GET_PCIE_TRANS(trans);
446

447 448
	if (!test_and_set_bit(hwq, trans_pcie->queue_stopped)) {
		if (atomic_inc_return(&trans_pcie->queue_stop_count[ac]) > 0) {
449
			iwl_op_mode_queue_full(trans->op_mode, ac);
450 451 452 453
			IWL_DEBUG_TX_QUEUES(trans,
				"Stop hwq %d ac %d stop count %d",
				hwq, ac,
				atomic_read(&trans_pcie->queue_stop_count[ac]));
454
		} else {
455 456 457 458
			IWL_DEBUG_TX_QUEUES(trans,
				"Don't stop hwq %d ac %d stop count %d",
				hwq, ac,
				atomic_read(&trans_pcie->queue_stop_count[ac]));
459 460
		}
	} else {
461 462
		IWL_DEBUG_TX_QUEUES(trans, "stop hwq %d, but it is stopped",
				    hwq);
463
	}
464 465
}

466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
static inline void iwl_txq_ctx_activate(struct iwl_trans_pcie *trans_pcie,
					int txq_id)
{
	set_bit(txq_id, &trans_pcie->txq_ctx_active_msk);
}

static inline void iwl_txq_ctx_deactivate(struct iwl_trans_pcie *trans_pcie,
					  int txq_id)
{
	clear_bit(txq_id, &trans_pcie->txq_ctx_active_msk);
}

static inline int iwl_queue_used(const struct iwl_queue *q, int i)
{
	return q->write_ptr >= q->read_ptr ?
		(i >= q->read_ptr && i < q->write_ptr) :
		!(i < q->read_ptr && i >= q->write_ptr);
}

static inline u8 get_cmd_index(struct iwl_queue *q, u32 index)
{
	return index & (q->n_window - 1);
}

490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
#define IWL_TX_FIFO_BK		0	/* shared */
#define IWL_TX_FIFO_BE		1
#define IWL_TX_FIFO_VI		2	/* shared */
#define IWL_TX_FIFO_VO		3
#define IWL_TX_FIFO_BK_IPAN	IWL_TX_FIFO_BK
#define IWL_TX_FIFO_BE_IPAN	4
#define IWL_TX_FIFO_VI_IPAN	IWL_TX_FIFO_VI
#define IWL_TX_FIFO_VO_IPAN	5
/* re-uses the VO FIFO, uCode will properly flush/schedule */
#define IWL_TX_FIFO_AUX		5
#define IWL_TX_FIFO_UNUSED	-1

/* AUX (TX during scan dwell) queue */
#define IWL_AUX_QUEUE		10

505
#endif /* __iwl_trans_int_pcie_h__ */