5e8d7cfabc211f3af689ee2c29727a5708c36ae6
[linux-2.6.git] / 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 #define IOAT_LOW_COMPLETION_MASK        0xffffffc0
35 #define IOAT_DMA_DCA_ANY_CPU            ~0
36 #define IOAT_WATCHDOG_PERIOD            (2 * HZ)
37
38 #define to_ioat_chan(chan) container_of(chan, struct ioat_dma_chan, common)
39 #define to_ioatdma_device(dev) container_of(dev, struct ioatdma_device, common)
40 #define to_ioat_desc(lh) container_of(lh, struct ioat_desc_sw, node)
41 #define tx_to_ioat_desc(tx) container_of(tx, struct ioat_desc_sw, async_tx)
42
43 #define chan_num(ch) ((int)((ch)->reg_base - (ch)->device->reg_base) / 0x80)
44
45 #define RESET_DELAY  msecs_to_jiffies(100)
46 #define WATCHDOG_DELAY  round_jiffies(msecs_to_jiffies(2000))
47
48 /*
49  * workaround for IOAT ver.3.0 null descriptor issue
50  * (channel returns error when size is 0)
51  */
52 #define NULL_DESC_BUFFER_SIZE 1
53
54 /**
55  * struct ioatdma_device - internal representation of a IOAT device
56  * @pdev: PCI-Express device
57  * @reg_base: MMIO register space base address
58  * @dma_pool: for allocating DMA descriptors
59  * @common: embedded struct dma_device
60  * @version: version of ioatdma device
61  * @msix_entries: irq handlers
62  * @idx: per channel data
63  */
64
65 struct ioatdma_device {
66         struct pci_dev *pdev;
67         void __iomem *reg_base;
68         struct pci_pool *dma_pool;
69         struct pci_pool *completion_pool;
70         struct dma_device common;
71         u8 version;
72         struct delayed_work work;
73         struct msix_entry msix_entries[4];
74         struct ioat_dma_chan *idx[4];
75 };
76
77 /**
78  * struct ioat_dma_chan - internal representation of a DMA channel
79  */
80 struct ioat_dma_chan {
81
82         void __iomem *reg_base;
83
84         dma_cookie_t completed_cookie;
85         unsigned long last_completion;
86         unsigned long last_completion_time;
87
88         size_t xfercap; /* XFERCAP register value expanded out */
89
90         spinlock_t cleanup_lock;
91         spinlock_t desc_lock;
92         struct list_head free_desc;
93         struct list_head used_desc;
94         unsigned long watchdog_completion;
95         int watchdog_tcp_cookie;
96         u32 watchdog_last_tcp_cookie;
97         struct delayed_work work;
98
99         int pending;
100         int dmacount;
101         int desccount;
102
103         struct ioatdma_device *device;
104         struct dma_chan common;
105
106         dma_addr_t completion_addr;
107         union {
108                 u64 full; /* HW completion writeback */
109                 struct {
110                         u32 low;
111                         u32 high;
112                 };
113         } *completion_virt;
114         unsigned long last_compl_desc_addr_hw;
115         struct tasklet_struct cleanup_task;
116 };
117
118 /* wrapper around hardware descriptor format + additional software fields */
119
120 /**
121  * struct ioat_desc_sw - wrapper around hardware descriptor
122  * @hw: hardware DMA descriptor
123  * @node: this descriptor will either be on the free list,
124  *     or attached to a transaction list (async_tx.tx_list)
125  * @tx_cnt: number of descriptors required to complete the transaction
126  * @async_tx: the generic software descriptor for all engines
127  */
128 struct ioat_desc_sw {
129         struct ioat_dma_descriptor *hw;
130         struct list_head node;
131         int tx_cnt;
132         size_t len;
133         dma_addr_t src;
134         dma_addr_t dst;
135         struct dma_async_tx_descriptor async_tx;
136 };
137
138 static inline void ioat_set_tcp_copy_break(struct ioatdma_device *dev)
139 {
140         #ifdef CONFIG_NET_DMA
141         switch (dev->version) {
142         case IOAT_VER_1_2:
143                 sysctl_tcp_dma_copybreak = 4096;
144                 break;
145         case IOAT_VER_2_0:
146                 sysctl_tcp_dma_copybreak = 2048;
147                 break;
148         case IOAT_VER_3_0:
149                 sysctl_tcp_dma_copybreak = 262144;
150                 break;
151         }
152         #endif
153 }
154
155 #if defined(CONFIG_INTEL_IOATDMA) || defined(CONFIG_INTEL_IOATDMA_MODULE)
156 struct ioatdma_device *ioat_dma_probe(struct pci_dev *pdev,
157                                       void __iomem *iobase);
158 void ioat_dma_remove(struct ioatdma_device *device);
159 struct dca_provider *ioat_dca_init(struct pci_dev *pdev, void __iomem *iobase);
160 struct dca_provider *ioat2_dca_init(struct pci_dev *pdev, void __iomem *iobase);
161 struct dca_provider *ioat3_dca_init(struct pci_dev *pdev, void __iomem *iobase);
162 #else
163 #define ioat_dma_probe(pdev, iobase)    NULL
164 #define ioat_dma_remove(device)         do { } while (0)
165 #define ioat_dca_init(pdev, iobase)     NULL
166 #define ioat2_dca_init(pdev, iobase)    NULL
167 #define ioat3_dca_init(pdev, iobase)    NULL
168 #endif
169
170 #endif /* IOATDMA_H */