internal.h

Go to the documentation of this file.

/******************************************************************************
 *
 * Copyright(c) 2003 - 2012 Intel Corporation. All rights reserved.
 *
 * 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 <[email protected]>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 *****************************************************************************/
#ifndef __iwl_trans_int_pcie_h__
#define __iwl_trans_int_pcie_h__

#include <linux/spinlock.h>
#include <linux/interrupt.h>
#include <linux/skbuff.h>
#include <linux/wait.h>
#include <linux/pci.h>
#include <linux/timer.h>

#include "iwl-fh.h"
#include "iwl-csr.h"
#include "iwl-trans.h"
#include "iwl-debug.h"
#include "iwl-io.h"
#include "iwl-op-mode.h"

struct iwl_host_cmd;

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

struct iwl_rx_mem_buffer {
    dma_addr_t page_dma;
    struct page *page;
    struct list_head list;
};

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

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

struct iwl_dma_ptr {
    dma_addr_t dma;
    void *addr;
    size_t size;
};

static inline int iwl_queue_inc_wrap(int index, int n_bd)
{
    return ++index & (n_bd - 1);
}

static inline int iwl_queue_dec_wrap(int index, int n_bd)
{
    return --index & (n_bd - 1);
}

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

    u32 flags;
};

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

#define TFD_TX_CMD_SLOTS 256
#define TFD_CMD_SLOTS 32

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

struct iwl_tx_queue {
    struct iwl_queue q;
    struct iwl_tfd *tfds;
    struct iwl_pcie_tx_queue_entry *entries;
    spinlock_t lock;
    struct timer_list stuck_timer;
    struct iwl_trans_pcie *trans_pcie;
    u8 need_update;
    u8 active;
};

struct iwl_trans_pcie {
    struct iwl_rx_queue rxq;
    struct work_struct rx_replenish;
    struct iwl_trans *trans;
    struct iwl_drv *drv;

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

    unsigned int irq;
    spinlock_t irq_lock;
    u32 inta_mask;
    u32 scd_base_addr;
    struct iwl_dma_ptr scd_bc_tbls;
    struct iwl_dma_ptr kw;

    struct iwl_tx_queue *txq;
    unsigned long queue_used[BITS_TO_LONGS(IWL_MAX_HW_QUEUES)];
    unsigned long queue_stopped[BITS_TO_LONGS(IWL_MAX_HW_QUEUES)];

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

    bool ucode_write_complete;
    wait_queue_head_t ucode_write_waitq;
    unsigned long status;
    u8 cmd_queue;
    u8 cmd_fifo;
    u8 n_no_reclaim_cmds;
    u8 no_reclaim_cmds[MAX_NO_RECLAIM_CMDS];

    bool rx_buf_size_8k;
    u32 rx_page_order;

    const char **command_names;

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

/*****************************************************
* DRIVER STATUS FUNCTIONS
******************************************************/
#define STATUS_HCMD_ACTIVE  0
#define STATUS_DEVICE_ENABLED   1
#define STATUS_TPOWER_PMI   2
#define STATUS_INT_ENABLED  3

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

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

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

/*****************************************************
* RX
******************************************************/
void iwl_bg_rx_replenish(struct work_struct *data);
void iwl_irq_tasklet(struct iwl_trans *trans);
void iwl_rx_replenish(struct iwl_trans *trans);
void iwl_rx_queue_update_write_ptr(struct iwl_trans *trans,
                   struct iwl_rx_queue *q);

/*****************************************************
* ICT
******************************************************/
void iwl_reset_ict(struct iwl_trans *trans);
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);
irqreturn_t iwl_isr_ict(int irq, void *data);

/*****************************************************
* TX / HCMD
******************************************************/
void iwl_txq_update_write_ptr(struct iwl_trans *trans,
                  struct iwl_tx_queue *txq);
int iwlagn_txq_attach_buf_to_tfd(struct iwl_trans *trans,
                 struct iwl_tx_queue *txq,
                 dma_addr_t addr, u16 len, u8 reset);
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);
void iwl_tx_cmd_complete(struct iwl_trans *trans,
             struct iwl_rx_cmd_buffer *rxb, int handler_status);
void iwl_trans_txq_update_byte_cnt_tbl(struct iwl_trans *trans,
                       struct iwl_tx_queue *txq,
                       u16 byte_cnt);
void iwl_trans_pcie_txq_enable(struct iwl_trans *trans, int txq_id, int fifo,
                   int sta_id, int tid, int frame_limit, u16 ssn);
void iwl_trans_pcie_txq_disable(struct iwl_trans *trans, int queue);
void iwl_txq_free_tfd(struct iwl_trans *trans, struct iwl_tx_queue *txq,
              enum dma_data_direction dma_dir);
int iwl_tx_queue_reclaim(struct iwl_trans *trans, int txq_id, int index,
             struct sk_buff_head *skbs);
int iwl_queue_space(const struct iwl_queue *q);

/*****************************************************
* Error handling
******************************************************/
int iwl_dump_fh(struct iwl_trans *trans, char **buf);
void iwl_dump_csr(struct iwl_trans *trans);

/*****************************************************
* Helpers
******************************************************/
static inline void iwl_disable_interrupts(struct iwl_trans *trans)
{
    struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
    clear_bit(STATUS_INT_ENABLED, &trans_pcie->status);

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

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

static inline void iwl_enable_interrupts(struct iwl_trans *trans)
{
    struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);

    IWL_DEBUG_ISR(trans, "Enabling interrupts\n");
    set_bit(STATUS_INT_ENABLED, &trans_pcie->status);
    iwl_write32(trans, CSR_INT_MASK, trans_pcie->inta_mask);
}

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

static inline void iwl_wake_queue(struct iwl_trans *trans,
                  struct iwl_tx_queue *txq)
{
    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);
    }
}

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

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

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

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

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

#endif /* __iwl_trans_int_pcie_h__ */