2 * Copyright(c) 2004 - 2009 Intel Corporation. All rights reserved.
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)
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
14 * The full GNU General Public License is included in this distribution in the
15 * file called COPYING.
20 #include <linux/dmaengine.h>
22 #include "registers.h"
23 #include <linux/init.h>
24 #include <linux/dmapool.h>
25 #include <linux/cache.h>
26 #include <linux/pci_ids.h>
29 #define IOAT_DMA_VERSION "4.00"
31 #define IOAT_LOW_COMPLETION_MASK 0xffffffc0
32 #define IOAT_DMA_DCA_ANY_CPU ~0
34 #define to_ioatdma_device(dev) container_of(dev, struct ioatdma_device, common)
35 #define to_ioat_desc(lh) container_of(lh, struct ioat_desc_sw, node)
36 #define tx_to_ioat_desc(tx) container_of(tx, struct ioat_desc_sw, txd)
37 #define to_dev(ioat_chan) (&(ioat_chan)->device->pdev->dev)
38 #define to_pdev(ioat_chan) ((ioat_chan)->device->pdev)
40 #define chan_num(ch) ((int)((ch)->reg_base - (ch)->device->reg_base) / 0x80)
43 * workaround for IOAT ver.3.0 null descriptor issue
44 * (channel returns error when size is 0)
46 #define NULL_DESC_BUFFER_SIZE 1
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 * @dca: direct cache access context
65 * @intr_quirk: interrupt setup quirk (for ioat_v1 devices)
66 * @enumerate_channels: hw version specific channel enumeration
67 * @reset_hw: hw version specific channel (re)initialization
68 * @cleanup_fn: select between the v2 and v3 cleanup routines
69 * @timer_fn: select between the v2 and v3 timer watchdog routines
70 * @self_test: hardware version specific self test for each supported op type
72 * Note: the v3 cleanup routine supports raid operations
74 struct ioatdma_device
{
76 void __iomem
*reg_base
;
77 struct pci_pool
*dma_pool
;
78 struct pci_pool
*completion_pool
;
79 #define MAX_SED_POOLS 5
80 struct dma_pool
*sed_hw_pool
[MAX_SED_POOLS
];
81 struct dma_device common
;
83 struct msix_entry msix_entries
[4];
84 struct ioat_chan_common
*idx
[4];
85 struct dca_provider
*dca
;
86 enum ioat_irq_mode irq_mode
;
88 void (*intr_quirk
)(struct ioatdma_device
*device
);
89 int (*enumerate_channels
)(struct ioatdma_device
*device
);
90 int (*reset_hw
)(struct ioat_chan_common
*chan
);
91 void (*cleanup_fn
)(unsigned long data
);
92 void (*timer_fn
)(unsigned long data
);
93 int (*self_test
)(struct ioatdma_device
*device
);
96 struct ioat_chan_common
{
97 struct dma_chan common
;
98 void __iomem
*reg_base
;
99 dma_addr_t last_completion
;
100 spinlock_t cleanup_lock
;
102 #define IOAT_COMPLETION_PENDING 0
103 #define IOAT_COMPLETION_ACK 1
104 #define IOAT_RESET_PENDING 2
105 #define IOAT_KOBJ_INIT_FAIL 3
106 #define IOAT_RESHAPE_PENDING 4
108 #define IOAT_CHAN_ACTIVE 6
109 struct timer_list timer
;
110 #define COMPLETION_TIMEOUT msecs_to_jiffies(100)
111 #define IDLE_TIMEOUT msecs_to_jiffies(2000)
112 #define RESET_DELAY msecs_to_jiffies(100)
113 struct ioatdma_device
*device
;
114 dma_addr_t completion_dma
;
116 struct tasklet_struct cleanup_task
;
120 struct ioat_sysfs_entry
{
121 struct attribute attr
;
122 ssize_t (*show
)(struct dma_chan
*, char *);
126 * struct ioat_dma_chan - internal representation of a DMA channel
128 struct ioat_dma_chan
{
129 struct ioat_chan_common base
;
131 size_t xfercap
; /* XFERCAP register value expanded out */
133 spinlock_t desc_lock
;
134 struct list_head free_desc
;
135 struct list_head used_desc
;
143 * struct ioat_sed_ent - wrapper around super extended hardware descriptor
145 * @sed_dma: dma address for the SED
147 * @parent: point to the dma descriptor that's the parent
149 struct ioat_sed_ent
{
150 struct ioat_sed_raw_descriptor
*hw
;
152 struct ioat_ring_ent
*parent
;
153 unsigned int hw_pool
;
156 static inline struct ioat_chan_common
*to_chan_common(struct dma_chan
*c
)
158 return container_of(c
, struct ioat_chan_common
, common
);
161 static inline struct ioat_dma_chan
*to_ioat_chan(struct dma_chan
*c
)
163 struct ioat_chan_common
*chan
= to_chan_common(c
);
165 return container_of(chan
, struct ioat_dma_chan
, base
);
168 /* wrapper around hardware descriptor format + additional software fields */
171 * struct ioat_desc_sw - wrapper around hardware descriptor
172 * @hw: hardware DMA descriptor (for memcpy)
173 * @node: this descriptor will either be on the free list,
174 * or attached to a transaction list (tx_list)
175 * @txd: the generic software descriptor for all engines
176 * @id: identifier for debug
178 struct ioat_desc_sw
{
179 struct ioat_dma_descriptor
*hw
;
180 struct list_head node
;
182 struct list_head tx_list
;
183 struct dma_async_tx_descriptor txd
;
190 #define set_desc_id(desc, i) ((desc)->id = (i))
191 #define desc_id(desc) ((desc)->id)
193 #define set_desc_id(desc, i)
194 #define desc_id(desc) (0)
198 __dump_desc_dbg(struct ioat_chan_common
*chan
, struct ioat_dma_descriptor
*hw
,
199 struct dma_async_tx_descriptor
*tx
, int id
)
201 struct device
*dev
= to_dev(chan
);
203 dev_dbg(dev
, "desc[%d]: (%#llx->%#llx) cookie: %d flags: %#x"
204 " ctl: %#10.8x (op: %#x int_en: %d compl: %d)\n", id
,
205 (unsigned long long) tx
->phys
,
206 (unsigned long long) hw
->next
, tx
->cookie
, tx
->flags
,
207 hw
->ctl
, hw
->ctl_f
.op
, hw
->ctl_f
.int_en
, hw
->ctl_f
.compl_write
);
210 #define dump_desc_dbg(c, d) \
211 ({ if (d) __dump_desc_dbg(&c->base, d->hw, &d->txd, desc_id(d)); 0; })
213 static inline struct ioat_chan_common
*
214 ioat_chan_by_index(struct ioatdma_device
*device
, int index
)
216 return device
->idx
[index
];
219 static inline u64
ioat_chansts_32(struct ioat_chan_common
*chan
)
221 u8 ver
= chan
->device
->version
;
225 /* We need to read the low address first as this causes the
226 * chipset to latch the upper bits for the subsequent read
228 status_lo
= readl(chan
->reg_base
+ IOAT_CHANSTS_OFFSET_LOW(ver
));
229 status
= readl(chan
->reg_base
+ IOAT_CHANSTS_OFFSET_HIGH(ver
));
236 #if BITS_PER_LONG == 64
238 static inline u64
ioat_chansts(struct ioat_chan_common
*chan
)
240 u8 ver
= chan
->device
->version
;
243 /* With IOAT v3.3 the status register is 64bit. */
244 if (ver
>= IOAT_VER_3_3
)
245 status
= readq(chan
->reg_base
+ IOAT_CHANSTS_OFFSET(ver
));
247 status
= ioat_chansts_32(chan
);
253 #define ioat_chansts ioat_chansts_32
256 static inline void ioat_start(struct ioat_chan_common
*chan
)
258 u8 ver
= chan
->device
->version
;
260 writeb(IOAT_CHANCMD_START
, chan
->reg_base
+ IOAT_CHANCMD_OFFSET(ver
));
263 static inline u64
ioat_chansts_to_addr(u64 status
)
265 return status
& IOAT_CHANSTS_COMPLETED_DESCRIPTOR_ADDR
;
268 static inline u32
ioat_chanerr(struct ioat_chan_common
*chan
)
270 return readl(chan
->reg_base
+ IOAT_CHANERR_OFFSET
);
273 static inline void ioat_suspend(struct ioat_chan_common
*chan
)
275 u8 ver
= chan
->device
->version
;
277 writeb(IOAT_CHANCMD_SUSPEND
, chan
->reg_base
+ IOAT_CHANCMD_OFFSET(ver
));
280 static inline void ioat_reset(struct ioat_chan_common
*chan
)
282 u8 ver
= chan
->device
->version
;
284 writeb(IOAT_CHANCMD_RESET
, chan
->reg_base
+ IOAT_CHANCMD_OFFSET(ver
));
287 static inline bool ioat_reset_pending(struct ioat_chan_common
*chan
)
289 u8 ver
= chan
->device
->version
;
292 cmd
= readb(chan
->reg_base
+ IOAT_CHANCMD_OFFSET(ver
));
293 return (cmd
& IOAT_CHANCMD_RESET
) == IOAT_CHANCMD_RESET
;
296 static inline void ioat_set_chainaddr(struct ioat_dma_chan
*ioat
, u64 addr
)
298 struct ioat_chan_common
*chan
= &ioat
->base
;
300 writel(addr
& 0x00000000FFFFFFFF,
301 chan
->reg_base
+ IOAT1_CHAINADDR_OFFSET_LOW
);
303 chan
->reg_base
+ IOAT1_CHAINADDR_OFFSET_HIGH
);
306 static inline bool is_ioat_active(unsigned long status
)
308 return ((status
& IOAT_CHANSTS_STATUS
) == IOAT_CHANSTS_ACTIVE
);
311 static inline bool is_ioat_idle(unsigned long status
)
313 return ((status
& IOAT_CHANSTS_STATUS
) == IOAT_CHANSTS_DONE
);
316 static inline bool is_ioat_halted(unsigned long status
)
318 return ((status
& IOAT_CHANSTS_STATUS
) == IOAT_CHANSTS_HALTED
);
321 static inline bool is_ioat_suspended(unsigned long status
)
323 return ((status
& IOAT_CHANSTS_STATUS
) == IOAT_CHANSTS_SUSPENDED
);
326 /* channel was fatally programmed */
327 static inline bool is_ioat_bug(unsigned long err
)
332 int ioat_probe(struct ioatdma_device
*device
);
333 int ioat_register(struct ioatdma_device
*device
);
334 int ioat1_dma_probe(struct ioatdma_device
*dev
, int dca
);
335 int ioat_dma_self_test(struct ioatdma_device
*device
);
336 void ioat_dma_remove(struct ioatdma_device
*device
);
337 struct dca_provider
*ioat_dca_init(struct pci_dev
*pdev
, void __iomem
*iobase
);
338 dma_addr_t
ioat_get_current_completion(struct ioat_chan_common
*chan
);
339 void ioat_init_channel(struct ioatdma_device
*device
,
340 struct ioat_chan_common
*chan
, int idx
);
341 enum dma_status
ioat_dma_tx_status(struct dma_chan
*c
, dma_cookie_t cookie
,
342 struct dma_tx_state
*txstate
);
343 bool ioat_cleanup_preamble(struct ioat_chan_common
*chan
,
344 dma_addr_t
*phys_complete
);
345 void ioat_kobject_add(struct ioatdma_device
*device
, struct kobj_type
*type
);
346 void ioat_kobject_del(struct ioatdma_device
*device
);
347 int ioat_dma_setup_interrupts(struct ioatdma_device
*device
);
348 void ioat_stop(struct ioat_chan_common
*chan
);
349 extern const struct sysfs_ops ioat_sysfs_ops
;
350 extern struct ioat_sysfs_entry ioat_version_attr
;
351 extern struct ioat_sysfs_entry ioat_cap_attr
;
352 #endif /* IOATDMA_H */