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 "registers.h"
  27 #include <linux/init.h>
  28 #include <linux/dmapool.h>
  29 #include <linux/cache.h>
  30 #include <linux/pci_ids.h>
  31 #include <net/tcp.h>
  32
  33 #define IOAT_DMA_VERSION  "4.00"
  34
  35 #define IOAT_LOW_COMPLETION_MASK        0xffffffc0
  36 #define IOAT_DMA_DCA_ANY_CPU            ~0
  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 /*
  46  * workaround for IOAT ver.3.0 null descriptor issue
  47  * (channel returns error when size is 0)
  48  */
  49 #define NULL_DESC_BUFFER_SIZE 1
  50
  51 enum ioat_irq_mode {
  52         IOAT_NOIRQ = 0,
  53         IOAT_MSIX,
  54         IOAT_MSIX_SINGLE,
  55         IOAT_MSI,
  56         IOAT_INTX
  57 };
  58
  59 /**
  60  * struct ioatdma_device - internal representation of a IOAT device
  61  * @pdev: PCI-Express device
  62  * @reg_base: MMIO register space base address
  63  * @dma_pool: for allocating DMA descriptors
  64  * @common: embedded struct dma_device
  65  * @version: version of ioatdma device
  66  * @msix_entries: irq handlers
  67  * @idx: per channel data
  68  * @dca: direct cache access context
  69  * @intr_quirk: interrupt setup quirk (for ioat_v1 devices)
  70  * @enumerate_channels: hw version specific channel enumeration
  71  * @reset_hw: hw version specific channel (re)initialization
  72  * @cleanup_fn: select between the v2 and v3 cleanup routines
  73  * @timer_fn: select between the v2 and v3 timer watchdog routines
  74  * @self_test: hardware version specific self test for each supported op type
  75  *
  76  * Note: the v3 cleanup routine supports raid operations
  77  */
  78 struct ioatdma_device {
  79         struct pci_dev *pdev;
  80         void __iomem *reg_base;
  81         struct pci_pool *dma_pool;
  82         struct pci_pool *completion_pool;
  83         struct dma_device common;
  84         u8 version;
  85         struct msix_entry msix_entries[4];
  86         struct ioat_chan_common *idx[4];
  87         struct dca_provider *dca;
  88         enum ioat_irq_mode irq_mode;
  89         void (*intr_quirk)(struct ioatdma_device *device);
  90         int (*enumerate_channels)(struct ioatdma_device *device);
  91         int (*reset_hw)(struct ioat_chan_common *chan);
  92         void (*cleanup_fn)(unsigned long data);
  93         void (*timer_fn)(unsigned long data);
  94         int (*self_test)(struct ioatdma_device *device);
  95 };
  96
  97 struct ioat_chan_common {
  98         struct dma_chan common;
  99         void __iomem *reg_base;
 100         dma_addr_t last_completion;
 101         spinlock_t cleanup_lock;
 102         unsigned long state;
 103         #define IOAT_COMPLETION_PENDING 0
 104         #define IOAT_COMPLETION_ACK 1
 105         #define IOAT_RESET_PENDING 2
 106         #define IOAT_KOBJ_INIT_FAIL 3
 107         #define IOAT_RESHAPE_PENDING 4
 108         #define IOAT_RUN 5
 109         #define IOAT_CHAN_ACTIVE 6
 110         struct timer_list timer;
 111         #define COMPLETION_TIMEOUT msecs_to_jiffies(100)
 112         #define IDLE_TIMEOUT msecs_to_jiffies(2000)
 113         #define RESET_DELAY msecs_to_jiffies(100)
 114         struct ioatdma_device *device;
 115         dma_addr_t completion_dma;
 116         u64 *completion;
 117         struct tasklet_struct cleanup_task;
 118         struct kobject kobj;
 119 };
 120
 121 struct ioat_sysfs_entry {
 122         struct attribute attr;
 123         ssize_t (*show)(struct dma_chan *, char *);
 124 };
 125
 126 /**
 127  * struct ioat_dma_chan - internal representation of a DMA channel
 128  */
 129 struct ioat_dma_chan {
 130         struct ioat_chan_common base;
 131
 132         size_t xfercap; /* XFERCAP register value expanded out */
 133
 134         spinlock_t desc_lock;
 135         struct list_head free_desc;
 136         struct list_head used_desc;
 137
 138         int pending;
 139         u16 desccount;
 140         u16 active;
 141 };
 142
 143 static inline struct ioat_chan_common *to_chan_common(struct dma_chan *c)
 144 {
 145         return container_of(c, struct ioat_chan_common, common);
 146 }
 147
 148 static inline struct ioat_dma_chan *to_ioat_chan(struct dma_chan *c)
 149 {
 150         struct ioat_chan_common *chan = to_chan_common(c);
 151
 152         return container_of(chan, struct ioat_dma_chan, base);
 153 }
 154
 155 /* wrapper around hardware descriptor format + additional software fields */
 156
 157 /**
 158  * struct ioat_desc_sw - wrapper around hardware descriptor
 159  * @hw: hardware DMA descriptor (for memcpy)
 160  * @node: this descriptor will either be on the free list,
 161  *     or attached to a transaction list (tx_list)
 162  * @txd: the generic software descriptor for all engines
 163  * @id: identifier for debug
 164  */
 165 struct ioat_desc_sw {
 166         struct ioat_dma_descriptor *hw;
 167         struct list_head node;
 168         size_t len;
 169         struct list_head tx_list;
 170         struct dma_async_tx_descriptor txd;
 171         #ifdef DEBUG
 172         int id;
 173         #endif
 174 };
 175
 176 #ifdef DEBUG
 177 #define set_desc_id(desc, i) ((desc)->id = (i))
 178 #define desc_id(desc) ((desc)->id)
 179 #else
 180 #define set_desc_id(desc, i)
 181 #define desc_id(desc) (0)
 182 #endif
 183
 184 static inline void
 185 __dump_desc_dbg(struct ioat_chan_common *chan, struct ioat_dma_descriptor *hw,
 186                 struct dma_async_tx_descriptor *tx, int id)
 187 {
 188         struct device *dev = to_dev(chan);
 189
 190         dev_dbg(dev, "desc[%d]: (%#llx->%#llx) cookie: %d flags: %#x"
 191                 " ctl: %#10.8x (op: %#x int_en: %d compl: %d)\n", id,
 192                 (unsigned long long) tx->phys,
 193                 (unsigned long long) hw->next, tx->cookie, tx->flags,
 194                 hw->ctl, hw->ctl_f.op, hw->ctl_f.int_en, hw->ctl_f.compl_write);
 195 }
 196
 197 #define dump_desc_dbg(c, d) \
 198         ({ if (d) __dump_desc_dbg(&c->base, d->hw, &d->txd, desc_id(d)); 0; })
 199
 200 static inline void ioat_set_tcp_copy_break(unsigned long copybreak)
 201 {
 202         #ifdef CONFIG_NET_DMA
 203         sysctl_tcp_dma_copybreak = copybreak;
 204         #endif
 205 }
 206
 207 static inline struct ioat_chan_common *
 208 ioat_chan_by_index(struct ioatdma_device *device, int index)
 209 {
 210         return device->idx[index];
 211 }
 212
 213 static inline u64 ioat_chansts_32(struct ioat_chan_common *chan)
 214 {
 215         u8 ver = chan->device->version;
 216         u64 status;
 217         u32 status_lo;
 218
 219         /* We need to read the low address first as this causes the
 220          * chipset to latch the upper bits for the subsequent read
 221          */
 222         status_lo = readl(chan->reg_base + IOAT_CHANSTS_OFFSET_LOW(ver));
 223         status = readl(chan->reg_base + IOAT_CHANSTS_OFFSET_HIGH(ver));
 224         status <<= 32;
 225         status |= status_lo;
 226
 227         return status;
 228 }
 229
 230 #if BITS_PER_LONG == 64
 231
 232 static inline u64 ioat_chansts(struct ioat_chan_common *chan)
 233 {
 234         u8 ver = chan->device->version;
 235         u64 status;
 236
 237          /* With IOAT v3.3 the status register is 64bit.  */
 238         if (ver >= IOAT_VER_3_3)
 239                 status = readq(chan->reg_base + IOAT_CHANSTS_OFFSET(ver));
 240         else
 241                 status = ioat_chansts_32(chan);
 242
 243         return status;
 244 }
 245
 246 #else
 247 #define ioat_chansts ioat_chansts_32
 248 #endif
 249
 250 static inline void ioat_start(struct ioat_chan_common *chan)
 251 {
 252         u8 ver = chan->device->version;
 253
 254         writeb(IOAT_CHANCMD_START, chan->reg_base + IOAT_CHANCMD_OFFSET(ver));
 255 }
 256
 257 static inline u64 ioat_chansts_to_addr(u64 status)
 258 {
 259         return status & IOAT_CHANSTS_COMPLETED_DESCRIPTOR_ADDR;
 260 }
 261
 262 static inline u32 ioat_chanerr(struct ioat_chan_common *chan)
 263 {
 264         return readl(chan->reg_base + IOAT_CHANERR_OFFSET);
 265 }
 266
 267 static inline void ioat_suspend(struct ioat_chan_common *chan)
 268 {
 269         u8 ver = chan->device->version;
 270
 271         writeb(IOAT_CHANCMD_SUSPEND, chan->reg_base + IOAT_CHANCMD_OFFSET(ver));
 272 }
 273
 274 static inline void ioat_reset(struct ioat_chan_common *chan)
 275 {
 276         u8 ver = chan->device->version;
 277
 278         writeb(IOAT_CHANCMD_RESET, chan->reg_base + IOAT_CHANCMD_OFFSET(ver));
 279 }
 280
 281 static inline bool ioat_reset_pending(struct ioat_chan_common *chan)
 282 {
 283         u8 ver = chan->device->version;
 284         u8 cmd;
 285
 286         cmd = readb(chan->reg_base + IOAT_CHANCMD_OFFSET(ver));
 287         return (cmd & IOAT_CHANCMD_RESET) == IOAT_CHANCMD_RESET;
 288 }
 289
 290 static inline void ioat_set_chainaddr(struct ioat_dma_chan *ioat, u64 addr)
 291 {
 292         struct ioat_chan_common *chan = &ioat->base;
 293
 294         writel(addr & 0x00000000FFFFFFFF,
 295                chan->reg_base + IOAT1_CHAINADDR_OFFSET_LOW);
 296         writel(addr >> 32,
 297                chan->reg_base + IOAT1_CHAINADDR_OFFSET_HIGH);
 298 }
 299
 300 static inline bool is_ioat_active(unsigned long status)
 301 {
 302         return ((status & IOAT_CHANSTS_STATUS) == IOAT_CHANSTS_ACTIVE);
 303 }
 304
 305 static inline bool is_ioat_idle(unsigned long status)
 306 {
 307         return ((status & IOAT_CHANSTS_STATUS) == IOAT_CHANSTS_DONE);
 308 }
 309
 310 static inline bool is_ioat_halted(unsigned long status)
 311 {
 312         return ((status & IOAT_CHANSTS_STATUS) == IOAT_CHANSTS_HALTED);
 313 }
 314
 315 static inline bool is_ioat_suspended(unsigned long status)
 316 {
 317         return ((status & IOAT_CHANSTS_STATUS) == IOAT_CHANSTS_SUSPENDED);
 318 }
 319
 320 /* channel was fatally programmed */
 321 static inline bool is_ioat_bug(unsigned long err)
 322 {
 323         return !!err;
 324 }
 325
 326 static inline void ioat_unmap(struct pci_dev *pdev, dma_addr_t addr, size_t len,
 327                               int direction, enum dma_ctrl_flags flags, bool dst)
 328 {
 329         if ((dst && (flags & DMA_COMPL_DEST_UNMAP_SINGLE)) ||
 330             (!dst && (flags & DMA_COMPL_SRC_UNMAP_SINGLE)))
 331                 pci_unmap_single(pdev, addr, len, direction);
 332         else
 333                 pci_unmap_page(pdev, addr, len, direction);
 334 }
 335
 336 int ioat_probe(struct ioatdma_device *device);
 337 int ioat_register(struct ioatdma_device *device);
 338 int ioat1_dma_probe(struct ioatdma_device *dev, int dca);
 339 int ioat_dma_self_test(struct ioatdma_device *device);
 340 void ioat_dma_remove(struct ioatdma_device *device);
 341 struct dca_provider *ioat_dca_init(struct pci_dev *pdev, void __iomem *iobase);
 342 dma_addr_t ioat_get_current_completion(struct ioat_chan_common *chan);
 343 void ioat_init_channel(struct ioatdma_device *device,
 344                        struct ioat_chan_common *chan, int idx);
 345 enum dma_status ioat_dma_tx_status(struct dma_chan *c, dma_cookie_t cookie,
 346                                    struct dma_tx_state *txstate);
 347 void ioat_dma_unmap(struct ioat_chan_common *chan, enum dma_ctrl_flags flags,
 348                     size_t len, struct ioat_dma_descriptor *hw);
 349 bool ioat_cleanup_preamble(struct ioat_chan_common *chan,
 350                            dma_addr_t *phys_complete);
 351 void ioat_kobject_add(struct ioatdma_device *device, struct kobj_type *type);
 352 void ioat_kobject_del(struct ioatdma_device *device);
 353 int ioat_dma_setup_interrupts(struct ioatdma_device *device);
 354 extern const struct sysfs_ops ioat_sysfs_ops;
 355 extern struct ioat_sysfs_entry ioat_version_attr;
 356 extern struct ioat_sysfs_entry ioat_cap_attr;
 357 #endif /* IOATDMA_H */