ioat: prepare the code for ioat[12]_dma_chan split
[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_ioatdma_device(dev) container_of(dev, struct ioatdma_device, common)
39 #define to_ioat_desc(lh) container_of(lh, struct ioat_desc_sw, node)
40 #define tx_to_ioat_desc(tx) container_of(tx, struct ioat_desc_sw, txd)
41 #define to_dev(ioat_chan) (&(ioat_chan)->device->pdev->dev)
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  * @dca: direct cache access context
64  * @intr_quirk: interrupt setup quirk (for ioat_v1 devices)
65  */
66
67 struct ioatdma_device {
68         struct pci_dev *pdev;
69         void __iomem *reg_base;
70         struct pci_pool *dma_pool;
71         struct pci_pool *completion_pool;
72         struct dma_device common;
73         u8 version;
74         struct delayed_work work;
75         struct msix_entry msix_entries[4];
76         struct ioat_chan_common *idx[4];
77         struct dca_provider *dca;
78         void (*intr_quirk)(struct ioatdma_device *device);
79 };
80
81 struct ioat_chan_common {
82         void __iomem *reg_base;
83
84         unsigned long last_completion;
85         unsigned long last_completion_time;
86
87         spinlock_t cleanup_lock;
88         dma_cookie_t completed_cookie;
89         unsigned long watchdog_completion;
90         int watchdog_tcp_cookie;
91         u32 watchdog_last_tcp_cookie;
92         struct delayed_work work;
93
94         struct ioatdma_device *device;
95         struct dma_chan common;
96
97         dma_addr_t completion_addr;
98         union {
99                 u64 full; /* HW completion writeback */
100                 struct {
101                         u32 low;
102                         u32 high;
103                 };
104         } *completion_virt;
105         unsigned long last_compl_desc_addr_hw;
106         struct tasklet_struct cleanup_task;
107 };
108
109 /**
110  * struct ioat_dma_chan - internal representation of a DMA channel
111  */
112 struct ioat_dma_chan {
113         struct ioat_chan_common base;
114
115         size_t xfercap; /* XFERCAP register value expanded out */
116
117         spinlock_t desc_lock;
118         struct list_head free_desc;
119         struct list_head used_desc;
120
121         int pending;
122         u16 dmacount;
123         u16 desccount;
124 };
125
126 static inline struct ioat_chan_common *to_chan_common(struct dma_chan *c)
127 {
128         return container_of(c, struct ioat_chan_common, common);
129 }
130
131 static inline struct ioat_dma_chan *to_ioat_chan(struct dma_chan *c)
132 {
133         struct ioat_chan_common *chan = to_chan_common(c);
134
135         return container_of(chan, struct ioat_dma_chan, base);
136 }
137
138 /* wrapper around hardware descriptor format + additional software fields */
139
140 /**
141  * struct ioat_desc_sw - wrapper around hardware descriptor
142  * @hw: hardware DMA descriptor
143  * @node: this descriptor will either be on the free list,
144  *     or attached to a transaction list (async_tx.tx_list)
145  * @tx_cnt: number of descriptors required to complete the transaction
146  * @txd: the generic software descriptor for all engines
147  */
148 struct ioat_desc_sw {
149         struct ioat_dma_descriptor *hw;
150         struct list_head node;
151         int tx_cnt;
152         size_t len;
153         dma_addr_t src;
154         dma_addr_t dst;
155         struct dma_async_tx_descriptor txd;
156 };
157
158 static inline void ioat_set_tcp_copy_break(unsigned long copybreak)
159 {
160         #ifdef CONFIG_NET_DMA
161         sysctl_tcp_dma_copybreak = copybreak;
162         #endif
163 }
164
165 int ioat1_dma_probe(struct ioatdma_device *dev, int dca);
166 int ioat2_dma_probe(struct ioatdma_device *dev, int dca);
167 int ioat3_dma_probe(struct ioatdma_device *dev, int dca);
168 void ioat_dma_remove(struct ioatdma_device *device);
169 struct dca_provider *ioat_dca_init(struct pci_dev *pdev, void __iomem *iobase);
170 struct dca_provider *ioat2_dca_init(struct pci_dev *pdev, void __iomem *iobase);
171 struct dca_provider *ioat3_dca_init(struct pci_dev *pdev, void __iomem *iobase);
172 #endif /* IOATDMA_H */