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