drivers/dma/ioat/dma.h

   1 /*
   2  * Copyright(c) 2004 - 2009 Intel Corporation. All rights reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License as published by the Free
   6  * Software Foundation; either version 2 of the License, or (at your option)
   7  * any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc., 59
  16  * Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  17  *
  18  * The full GNU General Public License is included in this distribution in the
  19  * file called COPYING.
  20  */
  21 #ifndef IOATDMA_H
  22 #define IOATDMA_H
  23
  24 #include <linux/dmaengine.h>
  25 #include "hw.h"
  26 #include <linux/init.h>
  27 #include <linux/dmapool.h>
  28 #include <linux/cache.h>
  29 #include <linux/pci_ids.h>
  30 #include <net/tcp.h>
  31
  32 #define IOAT_DMA_VERSION  "3.64"
  33
  34 enum ioat_interrupt {
  35         none = 0,
  36         msix_multi_vector = 1,
  37         msix_single_vector = 2,
  38         msi = 3,
  39         intx = 4,
  40 };
  41
  42 #define IOAT_LOW_COMPLETION_MASK        0xffffffc0
  43 #define IOAT_DMA_DCA_ANY_CPU            ~0
  44 #define IOAT_WATCHDOG_PERIOD            (2 * HZ)
  45
  46 #define to_ioat_chan(chan) container_of(chan, struct ioat_dma_chan, common)
  47 #define to_ioatdma_device(dev) container_of(dev, struct ioatdma_device, common)
  48 #define to_ioat_desc(lh) container_of(lh, struct ioat_desc_sw, node)
  49 #define tx_to_ioat_desc(tx) container_of(tx, struct ioat_desc_sw, async_tx)
  50
  51 #define chan_num(ch) ((int)((ch)->reg_base - (ch)->device->reg_base) / 0x80)
  52
  53 #define RESET_DELAY  msecs_to_jiffies(100)
  54 #define WATCHDOG_DELAY  round_jiffies(msecs_to_jiffies(2000))
  55
  56 /*
  57  * workaround for IOAT ver.3.0 null descriptor issue
  58  * (channel returns error when size is 0)
  59  */
  60 #define NULL_DESC_BUFFER_SIZE 1
  61
  62
  63 /**
  64  * struct ioatdma_device - internal representation of a IOAT device
  65  * @pdev: PCI-Express device
  66  * @reg_base: MMIO register space base address
  67  * @dma_pool: for allocating DMA descriptors
  68  * @common: embedded struct dma_device
  69  * @version: version of ioatdma device
  70  * @irq_mode: which style irq to use
  71  * @msix_entries: irq handlers
  72  * @idx: per channel data
  73  */
  74
  75 struct ioatdma_device {
  76         struct pci_dev *pdev;
  77         void __iomem *reg_base;
  78         struct pci_pool *dma_pool;
  79         struct pci_pool *completion_pool;
  80         struct dma_device common;
  81         u8 version;
  82         enum ioat_interrupt irq_mode;
  83         struct delayed_work work;
  84         struct msix_entry msix_entries[4];
  85         struct ioat_dma_chan *idx[4];
  86 };
  87
  88 /**
  89  * struct ioat_dma_chan - internal representation of a DMA channel
  90  */
  91 struct ioat_dma_chan {
  92
  93         void __iomem *reg_base;
  94
  95         dma_cookie_t completed_cookie;
  96         unsigned long last_completion;
  97         unsigned long last_completion_time;
  98
  99         size_t xfercap; /* XFERCAP register value expanded out */
 100
 101         spinlock_t cleanup_lock;
 102         spinlock_t desc_lock;
 103         struct list_head free_desc;
 104         struct list_head used_desc;
 105         unsigned long watchdog_completion;
 106         int watchdog_tcp_cookie;
 107         u32 watchdog_last_tcp_cookie;
 108         struct delayed_work work;
 109
 110         int pending;
 111         int dmacount;
 112         int desccount;
 113
 114         struct ioatdma_device *device;
 115         struct dma_chan common;
 116
 117         dma_addr_t completion_addr;
 118         union {
 119                 u64 full; /* HW completion writeback */
 120                 struct {
 121                         u32 low;
 122                         u32 high;
 123                 };
 124         } *completion_virt;
 125         unsigned long last_compl_desc_addr_hw;
 126         struct tasklet_struct cleanup_task;
 127 };
 128
 129 /* wrapper around hardware descriptor format + additional software fields */
 130
 131 /**
 132  * struct ioat_desc_sw - wrapper around hardware descriptor
 133  * @hw: hardware DMA descriptor
 134  * @node: this descriptor will either be on the free list,
 135  *     or attached to a transaction list (async_tx.tx_list)
 136  * @tx_cnt: number of descriptors required to complete the transaction
 137  * @async_tx: the generic software descriptor for all engines
 138  */
 139 struct ioat_desc_sw {
 140         struct ioat_dma_descriptor *hw;
 141         struct list_head node;
 142         int tx_cnt;
 143         size_t len;
 144         dma_addr_t src;
 145         dma_addr_t dst;
 146         struct dma_async_tx_descriptor async_tx;
 147 };
 148
 149 static inline void ioat_set_tcp_copy_break(struct ioatdma_device *dev)
 150 {
 151         #ifdef CONFIG_NET_DMA
 152         switch (dev->version) {
 153         case IOAT_VER_1_2:
 154                 sysctl_tcp_dma_copybreak = 4096;
 155                 break;
 156         case IOAT_VER_2_0:
 157                 sysctl_tcp_dma_copybreak = 2048;
 158                 break;
 159         case IOAT_VER_3_0:
 160                 sysctl_tcp_dma_copybreak = 262144;
 161                 break;
 162         }
 163         #endif
 164 }
 165
 166 #if defined(CONFIG_INTEL_IOATDMA) || defined(CONFIG_INTEL_IOATDMA_MODULE)
 167 struct ioatdma_device *ioat_dma_probe(struct pci_dev *pdev,
 168                                       void __iomem *iobase);
 169 void ioat_dma_remove(struct ioatdma_device *device);
 170 struct dca_provider *ioat_dca_init(struct pci_dev *pdev, void __iomem *iobase);
 171 struct dca_provider *ioat2_dca_init(struct pci_dev *pdev, void __iomem *iobase);
 172 struct dca_provider *ioat3_dca_init(struct pci_dev *pdev, void __iomem *iobase);
 173 #else
 174 #define ioat_dma_probe(pdev, iobase)    NULL
 175 #define ioat_dma_remove(device)         do { } while (0)
 176 #define ioat_dca_init(pdev, iobase)     NULL
 177 #define ioat2_dca_init(pdev, iobase)    NULL
 178 #define ioat3_dca_init(pdev, iobase)    NULL
 179 #endif
 180
 181 #endif /* IOATDMA_H */