1 /******************************************************************************
3 * Copyright(c) 2003 - 2010 Intel Corporation. All rights reserved.
5 * Portions of this file are derived from the ipw3945 project, as well
6 * as portions of the ieee80211 subsystem header files.
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.
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
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
21 * The full GNU General Public License is included in this distribution in the
22 * file called LICENSE.
24 * Contact Information:
25 * Intel Linux Wireless <ilw@linux.intel.com>
26 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
28 *****************************************************************************/
30 #include <linux/etherdevice.h>
31 #include <linux/sched.h>
32 #include <linux/slab.h>
33 #include <net/mac80211.h>
34 #include "iwl-eeprom.h"
39 #include "iwl-helpers.h"
42 * iwl_txq_update_write_ptr - Send new write index to hardware
44 void iwl_txq_update_write_ptr(struct iwl_priv
*priv
, struct iwl_tx_queue
*txq
)
47 int txq_id
= txq
->q
.id
;
49 if (txq
->need_update
== 0)
52 if (priv
->cfg
->base_params
->shadow_reg_enable
) {
53 /* shadow register enabled */
54 iwl_write32(priv
, HBUS_TARG_WRPTR
,
55 txq
->q
.write_ptr
| (txq_id
<< 8));
57 /* if we're trying to save power */
58 if (test_bit(STATUS_POWER_PMI
, &priv
->status
)) {
59 /* wake up nic if it's powered down ...
60 * uCode will wake up, and interrupt us again, so next
61 * time we'll skip this part. */
62 reg
= iwl_read32(priv
, CSR_UCODE_DRV_GP1
);
64 if (reg
& CSR_UCODE_DRV_GP1_BIT_MAC_SLEEP
) {
66 "Tx queue %d requesting wakeup,"
67 " GP1 = 0x%x\n", txq_id
, reg
);
68 iwl_set_bit(priv
, CSR_GP_CNTRL
,
69 CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ
);
73 iwl_write_direct32(priv
, HBUS_TARG_WRPTR
,
74 txq
->q
.write_ptr
| (txq_id
<< 8));
77 * else not in power-save mode,
78 * uCode will never sleep when we're
79 * trying to tx (during RFKILL, we're not trying to tx).
82 iwl_write32(priv
, HBUS_TARG_WRPTR
,
83 txq
->q
.write_ptr
| (txq_id
<< 8));
87 EXPORT_SYMBOL(iwl_txq_update_write_ptr
);
90 * iwl_tx_queue_free - Deallocate DMA queue.
91 * @txq: Transmit queue to deallocate.
93 * Empty queue by removing and destroying all BD's.
95 * 0-fill, but do not free "txq" descriptor structure.
97 void iwl_tx_queue_free(struct iwl_priv
*priv
, int txq_id
)
99 struct iwl_tx_queue
*txq
= &priv
->txq
[txq_id
];
100 struct iwl_queue
*q
= &txq
->q
;
101 struct device
*dev
= &priv
->pci_dev
->dev
;
107 /* first, empty all BD's */
108 for (; q
->write_ptr
!= q
->read_ptr
;
109 q
->read_ptr
= iwl_queue_inc_wrap(q
->read_ptr
, q
->n_bd
))
110 priv
->cfg
->ops
->lib
->txq_free_tfd(priv
, txq
);
112 /* De-alloc array of command/tx buffers */
113 for (i
= 0; i
< TFD_TX_CMD_SLOTS
; i
++)
116 /* De-alloc circular buffer of TFDs */
118 dma_free_coherent(dev
, priv
->hw_params
.tfd_size
*
119 txq
->q
.n_bd
, txq
->tfds
, txq
->q
.dma_addr
);
121 /* De-alloc array of per-TFD driver data */
125 /* deallocate arrays */
131 /* 0-fill queue descriptor structure */
132 memset(txq
, 0, sizeof(*txq
));
134 EXPORT_SYMBOL(iwl_tx_queue_free
);
137 * iwl_cmd_queue_free - Deallocate DMA queue.
138 * @txq: Transmit queue to deallocate.
140 * Empty queue by removing and destroying all BD's.
142 * 0-fill, but do not free "txq" descriptor structure.
144 void iwl_cmd_queue_free(struct iwl_priv
*priv
)
146 struct iwl_tx_queue
*txq
= &priv
->txq
[priv
->cmd_queue
];
147 struct iwl_queue
*q
= &txq
->q
;
148 struct device
*dev
= &priv
->pci_dev
->dev
;
155 for (; q
->read_ptr
!= q
->write_ptr
;
156 q
->read_ptr
= iwl_queue_inc_wrap(q
->read_ptr
, q
->n_bd
)) {
157 /* we have no way to tell if it is a huge cmd ATM */
158 i
= get_cmd_index(q
, q
->read_ptr
, 0);
160 if (txq
->meta
[i
].flags
& CMD_SIZE_HUGE
) {
165 pci_unmap_single(priv
->pci_dev
,
166 dma_unmap_addr(&txq
->meta
[i
], mapping
),
167 dma_unmap_len(&txq
->meta
[i
], len
),
168 PCI_DMA_BIDIRECTIONAL
);
172 pci_unmap_single(priv
->pci_dev
,
173 dma_unmap_addr(&txq
->meta
[i
], mapping
),
174 dma_unmap_len(&txq
->meta
[i
], len
),
175 PCI_DMA_BIDIRECTIONAL
);
178 /* De-alloc array of command/tx buffers */
179 for (i
= 0; i
<= TFD_CMD_SLOTS
; i
++)
182 /* De-alloc circular buffer of TFDs */
184 dma_free_coherent(dev
, priv
->hw_params
.tfd_size
* txq
->q
.n_bd
,
185 txq
->tfds
, txq
->q
.dma_addr
);
187 /* deallocate arrays */
193 /* 0-fill queue descriptor structure */
194 memset(txq
, 0, sizeof(*txq
));
196 EXPORT_SYMBOL(iwl_cmd_queue_free
);
198 /*************** DMA-QUEUE-GENERAL-FUNCTIONS *****
201 * Theory of operation
203 * A Tx or Rx queue resides in host DRAM, and is comprised of a circular buffer
204 * of buffer descriptors, each of which points to one or more data buffers for
205 * the device to read from or fill. Driver and device exchange status of each
206 * queue via "read" and "write" pointers. Driver keeps minimum of 2 empty
207 * entries in each circular buffer, to protect against confusing empty and full
210 * The device reads or writes the data in the queues via the device's several
211 * DMA/FIFO channels. Each queue is mapped to a single DMA channel.
213 * For Tx queue, there are low mark and high mark limits. If, after queuing
214 * the packet for Tx, free space become < low mark, Tx queue stopped. When
215 * reclaiming packets (on 'tx done IRQ), if free space become > high mark,
218 * See more detailed info in iwl-4965-hw.h.
219 ***************************************************/
221 int iwl_queue_space(const struct iwl_queue
*q
)
223 int s
= q
->read_ptr
- q
->write_ptr
;
225 if (q
->read_ptr
> q
->write_ptr
)
230 /* keep some reserve to not confuse empty and full situations */
236 EXPORT_SYMBOL(iwl_queue_space
);
240 * iwl_queue_init - Initialize queue's high/low-water and read/write indexes
242 static int iwl_queue_init(struct iwl_priv
*priv
, struct iwl_queue
*q
,
243 int count
, int slots_num
, u32 id
)
246 q
->n_window
= slots_num
;
249 /* count must be power-of-two size, otherwise iwl_queue_inc_wrap
250 * and iwl_queue_dec_wrap are broken. */
251 BUG_ON(!is_power_of_2(count
));
253 /* slots_num must be power-of-two size, otherwise
254 * get_cmd_index is broken. */
255 BUG_ON(!is_power_of_2(slots_num
));
257 q
->low_mark
= q
->n_window
/ 4;
261 q
->high_mark
= q
->n_window
/ 8;
262 if (q
->high_mark
< 2)
265 q
->write_ptr
= q
->read_ptr
= 0;
271 * iwl_tx_queue_alloc - Alloc driver data and TFD CB for one Tx/cmd queue
273 static int iwl_tx_queue_alloc(struct iwl_priv
*priv
,
274 struct iwl_tx_queue
*txq
, u32 id
)
276 struct device
*dev
= &priv
->pci_dev
->dev
;
277 size_t tfd_sz
= priv
->hw_params
.tfd_size
* TFD_QUEUE_SIZE_MAX
;
279 /* Driver private data, only for Tx (not command) queues,
280 * not shared with device. */
281 if (id
!= priv
->cmd_queue
) {
282 txq
->txb
= kzalloc(sizeof(txq
->txb
[0]) *
283 TFD_QUEUE_SIZE_MAX
, GFP_KERNEL
);
285 IWL_ERR(priv
, "kmalloc for auxiliary BD "
286 "structures failed\n");
293 /* Circular buffer of transmit frame descriptors (TFDs),
294 * shared with device */
295 txq
->tfds
= dma_alloc_coherent(dev
, tfd_sz
, &txq
->q
.dma_addr
,
298 IWL_ERR(priv
, "pci_alloc_consistent(%zd) failed\n", tfd_sz
);
313 * iwl_tx_queue_init - Allocate and initialize one tx/cmd queue
315 int iwl_tx_queue_init(struct iwl_priv
*priv
, struct iwl_tx_queue
*txq
,
316 int slots_num
, u32 txq_id
)
320 int actual_slots
= slots_num
;
323 * Alloc buffer array for commands (Tx or other types of commands).
324 * For the command queue (#4/#9), allocate command space + one big
325 * command for scan, since scan command is very huge; the system will
326 * not have two scans at the same time, so only one is needed.
327 * For normal Tx queues (all other queues), no super-size command
330 if (txq_id
== priv
->cmd_queue
)
333 txq
->meta
= kzalloc(sizeof(struct iwl_cmd_meta
) * actual_slots
,
335 txq
->cmd
= kzalloc(sizeof(struct iwl_device_cmd
*) * actual_slots
,
338 if (!txq
->meta
|| !txq
->cmd
)
339 goto out_free_arrays
;
341 len
= sizeof(struct iwl_device_cmd
);
342 for (i
= 0; i
< actual_slots
; i
++) {
343 /* only happens for cmd queue */
345 len
= IWL_MAX_CMD_SIZE
;
347 txq
->cmd
[i
] = kmalloc(len
, GFP_KERNEL
);
352 /* Alloc driver data array and TFD circular buffer */
353 ret
= iwl_tx_queue_alloc(priv
, txq
, txq_id
);
357 txq
->need_update
= 0;
360 * For the default queues 0-3, set up the swq_id
361 * already -- all others need to get one later
362 * (if they need one at all).
365 iwl_set_swq_id(txq
, txq_id
, txq_id
);
367 /* TFD_QUEUE_SIZE_MAX must be power-of-two size, otherwise
368 * iwl_queue_inc_wrap and iwl_queue_dec_wrap are broken. */
369 BUILD_BUG_ON(TFD_QUEUE_SIZE_MAX
& (TFD_QUEUE_SIZE_MAX
- 1));
371 /* Initialize queue's high/low-water marks, and head/tail indexes */
372 iwl_queue_init(priv
, &txq
->q
, TFD_QUEUE_SIZE_MAX
, slots_num
, txq_id
);
374 /* Tell device where to find queue */
375 priv
->cfg
->ops
->lib
->txq_init(priv
, txq
);
379 for (i
= 0; i
< actual_slots
; i
++)
387 EXPORT_SYMBOL(iwl_tx_queue_init
);
389 void iwl_tx_queue_reset(struct iwl_priv
*priv
, struct iwl_tx_queue
*txq
,
390 int slots_num
, u32 txq_id
)
392 int actual_slots
= slots_num
;
394 if (txq_id
== priv
->cmd_queue
)
397 memset(txq
->meta
, 0, sizeof(struct iwl_cmd_meta
) * actual_slots
);
399 txq
->need_update
= 0;
401 /* Initialize queue's high/low-water marks, and head/tail indexes */
402 iwl_queue_init(priv
, &txq
->q
, TFD_QUEUE_SIZE_MAX
, slots_num
, txq_id
);
404 /* Tell device where to find queue */
405 priv
->cfg
->ops
->lib
->txq_init(priv
, txq
);
407 EXPORT_SYMBOL(iwl_tx_queue_reset
);
409 /*************** HOST COMMAND QUEUE FUNCTIONS *****/
412 * iwl_enqueue_hcmd - enqueue a uCode command
413 * @priv: device private data point
414 * @cmd: a point to the ucode command structure
416 * The function returns < 0 values to indicate the operation is
417 * failed. On success, it turns the index (> 0) of command in the
420 int iwl_enqueue_hcmd(struct iwl_priv
*priv
, struct iwl_host_cmd
*cmd
)
422 struct iwl_tx_queue
*txq
= &priv
->txq
[priv
->cmd_queue
];
423 struct iwl_queue
*q
= &txq
->q
;
424 struct iwl_device_cmd
*out_cmd
;
425 struct iwl_cmd_meta
*out_meta
;
426 dma_addr_t phys_addr
;
431 bool is_ct_kill
= false;
433 cmd
->len
= priv
->cfg
->ops
->utils
->get_hcmd_size(cmd
->id
, cmd
->len
);
434 fix_size
= (u16
)(cmd
->len
+ sizeof(out_cmd
->hdr
));
436 /* If any of the command structures end up being larger than
437 * the TFD_MAX_PAYLOAD_SIZE, and it sent as a 'small' command then
438 * we will need to increase the size of the TFD entries
439 * Also, check to see if command buffer should not exceed the size
440 * of device_cmd and max_cmd_size. */
441 BUG_ON((fix_size
> TFD_MAX_PAYLOAD_SIZE
) &&
442 !(cmd
->flags
& CMD_SIZE_HUGE
));
443 BUG_ON(fix_size
> IWL_MAX_CMD_SIZE
);
445 if (iwl_is_rfkill(priv
) || iwl_is_ctkill(priv
)) {
446 IWL_WARN(priv
, "Not sending command - %s KILL\n",
447 iwl_is_rfkill(priv
) ? "RF" : "CT");
451 if (iwl_queue_space(q
) < ((cmd
->flags
& CMD_ASYNC
) ? 2 : 1)) {
452 IWL_ERR(priv
, "No space in command queue\n");
453 if (priv
->cfg
->ops
->lib
->tt_ops
.ct_kill_check
) {
455 priv
->cfg
->ops
->lib
->tt_ops
.ct_kill_check(priv
);
458 IWL_ERR(priv
, "Restarting adapter due to queue full\n");
459 queue_work(priv
->workqueue
, &priv
->restart
);
464 spin_lock_irqsave(&priv
->hcmd_lock
, flags
);
466 /* If this is a huge cmd, mark the huge flag also on the meta.flags
467 * of the _original_ cmd. This is used for DMA mapping clean up.
469 if (cmd
->flags
& CMD_SIZE_HUGE
) {
470 idx
= get_cmd_index(q
, q
->write_ptr
, 0);
471 txq
->meta
[idx
].flags
= CMD_SIZE_HUGE
;
474 idx
= get_cmd_index(q
, q
->write_ptr
, cmd
->flags
& CMD_SIZE_HUGE
);
475 out_cmd
= txq
->cmd
[idx
];
476 out_meta
= &txq
->meta
[idx
];
478 memset(out_meta
, 0, sizeof(*out_meta
)); /* re-initialize to NULL */
479 out_meta
->flags
= cmd
->flags
;
480 if (cmd
->flags
& CMD_WANT_SKB
)
481 out_meta
->source
= cmd
;
482 if (cmd
->flags
& CMD_ASYNC
)
483 out_meta
->callback
= cmd
->callback
;
485 out_cmd
->hdr
.cmd
= cmd
->id
;
486 memcpy(&out_cmd
->cmd
.payload
, cmd
->data
, cmd
->len
);
488 /* At this point, the out_cmd now has all of the incoming cmd
491 out_cmd
->hdr
.flags
= 0;
492 out_cmd
->hdr
.sequence
= cpu_to_le16(QUEUE_TO_SEQ(priv
->cmd_queue
) |
493 INDEX_TO_SEQ(q
->write_ptr
));
494 if (cmd
->flags
& CMD_SIZE_HUGE
)
495 out_cmd
->hdr
.sequence
|= SEQ_HUGE_FRAME
;
496 len
= sizeof(struct iwl_device_cmd
);
497 if (idx
== TFD_CMD_SLOTS
)
498 len
= IWL_MAX_CMD_SIZE
;
500 #ifdef CONFIG_IWLWIFI_DEBUG
501 switch (out_cmd
->hdr
.cmd
) {
502 case REPLY_TX_LINK_QUALITY_CMD
:
503 case SENSITIVITY_CMD
:
504 IWL_DEBUG_HC_DUMP(priv
, "Sending command %s (#%x), seq: 0x%04X, "
505 "%d bytes at %d[%d]:%d\n",
506 get_cmd_string(out_cmd
->hdr
.cmd
),
508 le16_to_cpu(out_cmd
->hdr
.sequence
), fix_size
,
509 q
->write_ptr
, idx
, priv
->cmd_queue
);
512 IWL_DEBUG_HC(priv
, "Sending command %s (#%x), seq: 0x%04X, "
513 "%d bytes at %d[%d]:%d\n",
514 get_cmd_string(out_cmd
->hdr
.cmd
),
516 le16_to_cpu(out_cmd
->hdr
.sequence
), fix_size
,
517 q
->write_ptr
, idx
, priv
->cmd_queue
);
520 txq
->need_update
= 1;
522 if (priv
->cfg
->ops
->lib
->txq_update_byte_cnt_tbl
)
523 /* Set up entry in queue's byte count circular buffer */
524 priv
->cfg
->ops
->lib
->txq_update_byte_cnt_tbl(priv
, txq
, 0);
526 phys_addr
= pci_map_single(priv
->pci_dev
, &out_cmd
->hdr
,
527 fix_size
, PCI_DMA_BIDIRECTIONAL
);
528 dma_unmap_addr_set(out_meta
, mapping
, phys_addr
);
529 dma_unmap_len_set(out_meta
, len
, fix_size
);
531 trace_iwlwifi_dev_hcmd(priv
, &out_cmd
->hdr
, fix_size
, cmd
->flags
);
533 priv
->cfg
->ops
->lib
->txq_attach_buf_to_tfd(priv
, txq
,
534 phys_addr
, fix_size
, 1,
537 /* Increment and update queue's write index */
538 q
->write_ptr
= iwl_queue_inc_wrap(q
->write_ptr
, q
->n_bd
);
539 iwl_txq_update_write_ptr(priv
, txq
);
541 spin_unlock_irqrestore(&priv
->hcmd_lock
, flags
);
546 * iwl_hcmd_queue_reclaim - Reclaim TX command queue entries already Tx'd
548 * When FW advances 'R' index, all entries between old and new 'R' index
549 * need to be reclaimed. As result, some free space forms. If there is
550 * enough free space (> low mark), wake the stack that feeds us.
552 static void iwl_hcmd_queue_reclaim(struct iwl_priv
*priv
, int txq_id
,
553 int idx
, int cmd_idx
)
555 struct iwl_tx_queue
*txq
= &priv
->txq
[txq_id
];
556 struct iwl_queue
*q
= &txq
->q
;
559 if ((idx
>= q
->n_bd
) || (iwl_queue_used(q
, idx
) == 0)) {
560 IWL_ERR(priv
, "Read index for DMA queue txq id (%d), index %d, "
561 "is out of range [0-%d] %d %d.\n", txq_id
,
562 idx
, q
->n_bd
, q
->write_ptr
, q
->read_ptr
);
566 for (idx
= iwl_queue_inc_wrap(idx
, q
->n_bd
); q
->read_ptr
!= idx
;
567 q
->read_ptr
= iwl_queue_inc_wrap(q
->read_ptr
, q
->n_bd
)) {
570 IWL_ERR(priv
, "HCMD skipped: index (%d) %d %d\n", idx
,
571 q
->write_ptr
, q
->read_ptr
);
572 queue_work(priv
->workqueue
, &priv
->restart
);
579 * iwl_tx_cmd_complete - Pull unused buffers off the queue and reclaim them
580 * @rxb: Rx buffer to reclaim
582 * If an Rx buffer has an async callback associated with it the callback
583 * will be executed. The attached skb (if present) will only be freed
584 * if the callback returns 1
586 void iwl_tx_cmd_complete(struct iwl_priv
*priv
, struct iwl_rx_mem_buffer
*rxb
)
588 struct iwl_rx_packet
*pkt
= rxb_addr(rxb
);
589 u16 sequence
= le16_to_cpu(pkt
->hdr
.sequence
);
590 int txq_id
= SEQ_TO_QUEUE(sequence
);
591 int index
= SEQ_TO_INDEX(sequence
);
593 bool huge
= !!(pkt
->hdr
.sequence
& SEQ_HUGE_FRAME
);
594 struct iwl_device_cmd
*cmd
;
595 struct iwl_cmd_meta
*meta
;
596 struct iwl_tx_queue
*txq
= &priv
->txq
[priv
->cmd_queue
];
598 /* If a Tx command is being handled and it isn't in the actual
599 * command queue then there a command routing bug has been introduced
600 * in the queue management code. */
601 if (WARN(txq_id
!= priv
->cmd_queue
,
602 "wrong command queue %d (should be %d), sequence 0x%X readp=%d writep=%d\n",
603 txq_id
, priv
->cmd_queue
, sequence
,
604 priv
->txq
[priv
->cmd_queue
].q
.read_ptr
,
605 priv
->txq
[priv
->cmd_queue
].q
.write_ptr
)) {
606 iwl_print_hex_error(priv
, pkt
, 32);
610 /* If this is a huge cmd, clear the huge flag on the meta.flags
611 * of the _original_ cmd. So that iwl_cmd_queue_free won't unmap
612 * the DMA buffer for the scan (huge) command.
615 cmd_index
= get_cmd_index(&txq
->q
, index
, 0);
616 txq
->meta
[cmd_index
].flags
= 0;
618 cmd_index
= get_cmd_index(&txq
->q
, index
, huge
);
619 cmd
= txq
->cmd
[cmd_index
];
620 meta
= &txq
->meta
[cmd_index
];
622 pci_unmap_single(priv
->pci_dev
,
623 dma_unmap_addr(meta
, mapping
),
624 dma_unmap_len(meta
, len
),
625 PCI_DMA_BIDIRECTIONAL
);
627 /* Input error checking is done when commands are added to queue. */
628 if (meta
->flags
& CMD_WANT_SKB
) {
629 meta
->source
->reply_page
= (unsigned long)rxb_addr(rxb
);
631 } else if (meta
->callback
)
632 meta
->callback(priv
, cmd
, pkt
);
634 iwl_hcmd_queue_reclaim(priv
, txq_id
, index
, cmd_index
);
636 if (!(meta
->flags
& CMD_ASYNC
)) {
637 clear_bit(STATUS_HCMD_ACTIVE
, &priv
->status
);
638 IWL_DEBUG_INFO(priv
, "Clearing HCMD_ACTIVE for command %s\n",
639 get_cmd_string(cmd
->hdr
.cmd
));
640 wake_up_interruptible(&priv
->wait_command_queue
);
644 EXPORT_SYMBOL(iwl_tx_cmd_complete
);