[I/OAT]: Driver for the Intel(R) I/OAT DMA engine
[linux-2.6.git] / drivers / dma / ioatdma.h
1 /*
2  * Copyright(c) 2004 - 2006 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 "ioatdma_hw.h"
26 #include <linux/init.h>
27 #include <linux/dmapool.h>
28 #include <linux/cache.h>
29
30 #define PCI_DEVICE_ID_INTEL_IOAT        0x1a38
31
32 #define IOAT_LOW_COMPLETION_MASK        0xffffffc0
33
34 extern struct list_head dma_device_list;
35 extern struct list_head dma_client_list;
36
37 /**
38  * struct ioat_device - internal representation of a IOAT device
39  * @pdev: PCI-Express device
40  * @reg_base: MMIO register space base address
41  * @dma_pool: for allocating DMA descriptors
42  * @common: embedded struct dma_device
43  * @msi: Message Signaled Interrupt number
44  */
45
46 struct ioat_device {
47         struct pci_dev *pdev;
48         void *reg_base;
49         struct pci_pool *dma_pool;
50         struct pci_pool *completion_pool;
51
52         struct dma_device common;
53         u8 msi;
54 };
55
56 /**
57  * struct ioat_dma_chan - internal representation of a DMA channel
58  * @device:
59  * @reg_base:
60  * @sw_in_use:
61  * @completion:
62  * @completion_low:
63  * @completion_high:
64  * @completed_cookie: last cookie seen completed on cleanup
65  * @cookie: value of last cookie given to client
66  * @last_completion:
67  * @xfercap:
68  * @desc_lock:
69  * @free_desc:
70  * @used_desc:
71  * @resource:
72  * @device_node:
73  */
74
75 struct ioat_dma_chan {
76
77         void *reg_base;
78
79         dma_cookie_t completed_cookie;
80         unsigned long last_completion;
81
82         u32 xfercap;    /* XFERCAP register value expanded out */
83
84         spinlock_t cleanup_lock;
85         spinlock_t desc_lock;
86         struct list_head free_desc;
87         struct list_head used_desc;
88
89         int pending;
90
91         struct ioat_device *device;
92         struct dma_chan common;
93
94         dma_addr_t completion_addr;
95         union {
96                 u64 full; /* HW completion writeback */
97                 struct {
98                         u32 low;
99                         u32 high;
100                 };
101         } *completion_virt;
102 };
103
104 /* wrapper around hardware descriptor format + additional software fields */
105
106 /**
107  * struct ioat_desc_sw - wrapper around hardware descriptor
108  * @hw: hardware DMA descriptor
109  * @node:
110  * @cookie:
111  * @phys:
112  */
113
114 struct ioat_desc_sw {
115         struct ioat_dma_descriptor *hw;
116         struct list_head node;
117         dma_cookie_t cookie;
118         dma_addr_t phys;
119         DECLARE_PCI_UNMAP_ADDR(src)
120         DECLARE_PCI_UNMAP_LEN(src_len)
121         DECLARE_PCI_UNMAP_ADDR(dst)
122         DECLARE_PCI_UNMAP_LEN(dst_len)
123 };
124
125 #endif /* IOATDMA_H */
126