iwl-trans-pcie-int.h 13.8 KB
Newer Older
1 2
/******************************************************************************
 *
W
Wey-Yi Guy 已提交
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__

E
Emmanuel Grumbach 已提交
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
#include <linux/timer.h>
E
Emmanuel Grumbach 已提交
38

39
#include "iwl-fh.h"
E
Emmanuel Grumbach 已提交
40 41 42 43
#include "iwl-csr.h"
#include "iwl-trans.h"
#include "iwl-debug.h"
#include "iwl-io.h"
44
#include "iwl-op-mode.h"
E
Emmanuel Grumbach 已提交
45 46

struct iwl_host_cmd;
47

48 49 50
/*This file includes the declaration that are internal to the
 * trans_pcie layer */

51 52 53 54 55 56
struct iwl_rx_mem_buffer {
	dma_addr_t page_dma;
	struct page *page;
	struct list_head list;
};

57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
/**
 * 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;
};

75 76 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
/**
 * 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;
};

E
Emmanuel Grumbach 已提交
111 112 113 114 115 116
struct iwl_dma_ptr {
	dma_addr_t dma;
	void *addr;
	size_t size;
};

117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
/**
 * 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);
}

137 138 139 140 141 142
struct iwl_cmd_meta {
	/* only for SYNC commands, iff the reply skb is wanted */
	struct iwl_host_cmd *source;

	DEFINE_DMA_UNMAP_ADDR(mapping);
	DEFINE_DMA_UNMAP_LEN(len);
143 144

	u32 flags;
145 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
};

/*
 * 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 */
};

182 183 184 185 186 187 188 189 190
#define TFD_TX_CMD_SLOTS 256
#define TFD_CMD_SLOTS 32

struct iwl_pcie_tx_queue_entry {
	struct iwl_device_cmd *cmd;
	struct sk_buff *skb;
	struct iwl_cmd_meta meta;
};

191 192 193
/**
 * struct iwl_tx_queue - Tx Queue for DMA
 * @q: generic Rx/Tx queue descriptor
194 195 196 197 198
 * @tfds: transmit frame descriptors (DMA memory)
 * @entries: transmit entries (driver state)
 * @lock: queue lock
 * @stuck_timer: timer that fires if queue gets stuck
 * @trans_pcie: pointer back to transport (for timer)
199
 * @need_update: indicates need to update read/write index
200
 * @active: stores if queue is active
201 202 203 204 205 206 207
 *
 * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
 * descriptors) and required locking structures.
 */
struct iwl_tx_queue {
	struct iwl_queue q;
	struct iwl_tfd *tfds;
208
	struct iwl_pcie_tx_queue_entry *entries;
209
	spinlock_t lock;
210 211
	struct timer_list stuck_timer;
	struct iwl_trans_pcie *trans_pcie;
212 213 214 215
	u8 need_update;
	u8 active;
};

216 217
/**
 * struct iwl_trans_pcie - PCIe transport specific data
218 219
 * @rxq: all the RX queue data
 * @rx_replenish: work that will be called when buffers need to be allocated
220
 * @drv - pointer to iwl_drv
221
 * @trans: pointer to the generic transport area
J
Johannes Berg 已提交
222
 * @irq - the irq number for the device
223
 * @irq_requested: true when the irq has been requested
224 225
 * @scd_base_addr: scheduler sram base address in SRAM
 * @scd_bc_tbls: pointer to the byte count table of the scheduler
226
 * @kw: keep warm address
227 228
 * @pci_dev: basic pci-network driver stuff
 * @hw_base: pci hardware address support
229 230
 * @ucode_write_complete: indicates that the ucode has been copied.
 * @ucode_write_waitq: wait queue for uCode load
231
 * @status - transport specific status flags
232
 * @cmd_queue - command queue number
233 234
 * @rx_buf_size_8k: 8 kB RX buffer size
 * @rx_page_order: page order for receive buffer size
235
 * @wd_timeout: queue watchdog timeout (jiffies)
236 237
 */
struct iwl_trans_pcie {
238 239 240
	struct iwl_rx_queue rxq;
	struct work_struct rx_replenish;
	struct iwl_trans *trans;
241
	struct iwl_drv *drv;
242 243 244 245 246 247 248

	/* INT ICT Table */
	__le32 *ict_tbl;
	dma_addr_t ict_tbl_dma;
	int ict_index;
	u32 inta;
	bool use_ict;
249
	bool irq_requested;
250
	struct tasklet_struct irq_tasklet;
251
	struct isr_statistics isr_stats;
252

J
Johannes Berg 已提交
253
	unsigned int irq;
J
Johannes Berg 已提交
254
	spinlock_t irq_lock;
255
	u32 inta_mask;
256 257
	u32 scd_base_addr;
	struct iwl_dma_ptr scd_bc_tbls;
258
	struct iwl_dma_ptr kw;
259

260
	struct iwl_tx_queue *txq;
261
	unsigned long queue_used[BITS_TO_LONGS(IWL_MAX_HW_QUEUES)];
262
	unsigned long queue_stopped[BITS_TO_LONGS(IWL_MAX_HW_QUEUES)];
263 264 265 266

	/* PCI bus related data */
	struct pci_dev *pci_dev;
	void __iomem *hw_base;
267 268 269

	bool ucode_write_complete;
	wait_queue_head_t ucode_write_waitq;
270
	unsigned long status;
271
	u8 cmd_queue;
272 273
	u8 n_no_reclaim_cmds;
	u8 no_reclaim_cmds[MAX_NO_RECLAIM_CMDS];
274 275
	u8 setup_q_to_fifo[IWL_MAX_HW_QUEUES];
	u8 n_q_to_fifo;
276 277 278

	bool rx_buf_size_8k;
	u32 rx_page_order;
279

J
Johannes Berg 已提交
280
	const char **command_names;
281 282 283

	/* queue watchdog */
	unsigned long wd_timeout;
284 285
};

286 287 288 289 290 291 292 293
/*****************************************************
* DRIVER STATUS FUNCTIONS
******************************************************/
#define STATUS_HCMD_ACTIVE	0
#define STATUS_DEVICE_ENABLED	1
#define STATUS_TPOWER_PMI	2
#define STATUS_INT_ENABLED	3

294 295 296
#define IWL_TRANS_GET_PCIE_TRANS(_iwl_trans) \
	((struct iwl_trans_pcie *) ((_iwl_trans)->trans_specific))

297 298 299 300 301 302 303
static inline struct iwl_trans *
iwl_trans_pcie_get_trans(struct iwl_trans_pcie *trans_pcie)
{
	return container_of((void *)trans_pcie, struct iwl_trans,
			    trans_specific);
}

304 305 306 307 308
struct iwl_trans *iwl_trans_pcie_alloc(struct pci_dev *pdev,
				       const struct pci_device_id *ent,
				       const struct iwl_cfg *cfg);
void iwl_trans_pcie_free(struct iwl_trans *trans);

309 310 311
/*****************************************************
* RX
******************************************************/
312
void iwl_bg_rx_replenish(struct work_struct *data);
313
void iwl_irq_tasklet(struct iwl_trans *trans);
314 315
void iwlagn_rx_replenish(struct iwl_trans *trans);
void iwl_rx_queue_update_write_ptr(struct iwl_trans *trans,
316 317
			struct iwl_rx_queue *q);

318 319 320
/*****************************************************
* ICT
******************************************************/
321
void iwl_reset_ict(struct iwl_trans *trans);
322 323 324
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);
325 326
irqreturn_t iwl_isr_ict(int irq, void *data);

327 328 329
/*****************************************************
* TX / HCMD
******************************************************/
330 331
void iwl_txq_update_write_ptr(struct iwl_trans *trans,
			struct iwl_tx_queue *txq);
332
int iwlagn_txq_attach_buf_to_tfd(struct iwl_trans *trans,
333 334
				 struct iwl_tx_queue *txq,
				 dma_addr_t addr, u16 len, u8 reset);
335 336
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);
337
void iwl_tx_cmd_complete(struct iwl_trans *trans,
338
			 struct iwl_rx_cmd_buffer *rxb, int handler_status);
339
void iwl_trans_txq_update_byte_cnt_tbl(struct iwl_trans *trans,
340 341
					   struct iwl_tx_queue *txq,
					   u16 byte_cnt);
342
void iwl_trans_pcie_tx_agg_disable(struct iwl_trans *trans, int queue);
343
void iwl_trans_set_wr_ptrs(struct iwl_trans *trans, int txq_id, u32 index);
344
void iwl_trans_tx_queue_set_status(struct iwl_trans *trans,
345 346 347
				   struct iwl_tx_queue *txq,
				   int tx_fifo_id, bool active);
void iwl_trans_pcie_tx_agg_setup(struct iwl_trans *trans, int queue, int fifo,
348
				 int sta_id, int tid, int frame_limit, u16 ssn);
349
void iwlagn_txq_free_tfd(struct iwl_trans *trans, struct iwl_tx_queue *txq,
350
	int index, enum dma_data_direction dma_dir);
351 352
int iwl_tx_queue_reclaim(struct iwl_trans *trans, int txq_id, int index,
			 struct sk_buff_head *skbs);
353
int iwl_queue_space(const struct iwl_queue *q);
354

355 356 357
/*****************************************************
* Error handling
******************************************************/
358 359 360
int iwl_dump_fh(struct iwl_trans *trans, char **buf, bool display);
void iwl_dump_csr(struct iwl_trans *trans);

361 362 363
/*****************************************************
* Helpers
******************************************************/
364 365
static inline void iwl_disable_interrupts(struct iwl_trans *trans)
{
D
Don Fry 已提交
366 367
	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
	clear_bit(STATUS_INT_ENABLED, &trans_pcie->status);
368 369

	/* disable interrupts from uCode/NIC to host */
370
	iwl_write32(trans, CSR_INT_MASK, 0x00000000);
371 372 373

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

static inline void iwl_enable_interrupts(struct iwl_trans *trans)
{
D
Don Fry 已提交
381
	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
382 383

	IWL_DEBUG_ISR(trans, "Enabling interrupts\n");
D
Don Fry 已提交
384
	set_bit(STATUS_INT_ENABLED, &trans_pcie->status);
385
	iwl_write32(trans, CSR_INT_MASK, trans_pcie->inta_mask);
386 387
}

388 389 390 391 392 393
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);
}

394
static inline void iwl_wake_queue(struct iwl_trans *trans,
395
				  struct iwl_tx_queue *txq)
396
{
397 398 399 400 401
	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);

	if (test_and_clear_bit(txq->q.id, trans_pcie->queue_stopped)) {
		IWL_DEBUG_TX_QUEUES(trans, "Wake hwq %d\n", txq->q.id);
		iwl_op_mode_queue_not_full(trans->op_mode, txq->q.id);
402
	}
403 404 405
}

static inline void iwl_stop_queue(struct iwl_trans *trans,
406
				  struct iwl_tx_queue *txq)
407
{
408
	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
409

410 411 412 413 414 415
	if (!test_and_set_bit(txq->q.id, trans_pcie->queue_stopped)) {
		iwl_op_mode_queue_full(trans->op_mode, txq->q.id);
		IWL_DEBUG_TX_QUEUES(trans, "Stop hwq %d\n", txq->q.id);
	} else
		IWL_DEBUG_TX_QUEUES(trans, "hwq %d already stopped\n",
				    txq->q.id);
416 417 418 419 420 421 422 423 424 425 426 427 428 429
}

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);
}

J
Johannes Berg 已提交
430 431 432 433 434 435 436 437
static inline const char *
trans_pcie_get_cmd_string(struct iwl_trans_pcie *trans_pcie, u8 cmd)
{
	if (!trans_pcie->command_names || !trans_pcie->command_names[cmd])
		return "UNKNOWN";
	return trans_pcie->command_names[cmd];
}

438 439 440 441 442 443
static inline bool iwl_is_rfkill_set(struct iwl_trans *trans)
{
	return !(iwl_read32(trans, CSR_GP_CNTRL) &
		CSR_GP_CNTRL_REG_FLAG_HW_RF_KILL_SW);
}

444
#endif /* __iwl_trans_int_pcie_h__ */