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