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