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 #include <linux/pci_ids.h>
  30
  31 #define IOAT_LOW_COMPLETION_MASK        0xffffffc0
  32
  33 /**
  34  * struct ioatdma_device - internal representation of a IOAT device
  35  * @pdev: PCI-Express device
  36  * @reg_base: MMIO register space base address
  37  * @dma_pool: for allocating DMA descriptors
  38  * @common: embedded struct dma_device
  39  * @version: version of ioatdma device
  40  */
  41
  42 struct ioatdma_device {
  43         struct pci_dev *pdev;
  44         void __iomem *reg_base;
  45         struct pci_pool *dma_pool;
  46         struct pci_pool *completion_pool;
  47         struct dma_device common;
  48         u8 version;
  49 };
  50
  51 /**
  52  * struct ioat_dma_chan - internal representation of a DMA channel
  53  * @device:
  54  * @reg_base:
  55  * @sw_in_use:
  56  * @completion:
  57  * @completion_low:
  58  * @completion_high:
  59  * @completed_cookie: last cookie seen completed on cleanup
  60  * @cookie: value of last cookie given to client
  61  * @last_completion:
  62  * @xfercap:
  63  * @desc_lock:
  64  * @free_desc:
  65  * @used_desc:
  66  * @resource:
  67  * @device_node:
  68  */
  69
  70 struct ioat_dma_chan {
  71
  72         void __iomem *reg_base;
  73
  74         dma_cookie_t completed_cookie;
  75         unsigned long last_completion;
  76
  77         u32 xfercap;    /* XFERCAP register value expanded out */
  78
  79         spinlock_t cleanup_lock;
  80         spinlock_t desc_lock;
  81         struct list_head free_desc;
  82         struct list_head used_desc;
  83
  84         int pending;
  85
  86         struct ioatdma_device *device;
  87         struct dma_chan common;
  88
  89         dma_addr_t completion_addr;
  90         union {
  91                 u64 full; /* HW completion writeback */
  92                 struct {
  93                         u32 low;
  94                         u32 high;
  95                 };
  96         } *completion_virt;
  97 };
  98
  99 /* wrapper around hardware descriptor format + additional software fields */
 100
 101 /**
 102  * struct ioat_desc_sw - wrapper around hardware descriptor
 103  * @hw: hardware DMA descriptor
 104  * @node: this descriptor will either be on the free list,
 105  *     or attached to a transaction list (async_tx.tx_list)
 106  * @tx_cnt: number of descriptors required to complete the transaction
 107  * @async_tx: the generic software descriptor for all engines
 108  */
 109 struct ioat_desc_sw {
 110         struct ioat_dma_descriptor *hw;
 111         struct list_head node;
 112         int tx_cnt;
 113         DECLARE_PCI_UNMAP_LEN(len)
 114         DECLARE_PCI_UNMAP_ADDR(src)
 115         DECLARE_PCI_UNMAP_ADDR(dst)
 116         struct dma_async_tx_descriptor async_tx;
 117 };
 118
 119 #if defined(CONFIG_INTEL_IOATDMA) || defined(CONFIG_INTEL_IOATDMA_MODULE)
 120 struct ioatdma_device *ioat_dma_probe(struct pci_dev *pdev,
 121                                       void __iomem *iobase);
 122 void ioat_dma_remove(struct ioatdma_device *device);
 123 #else
 124 #define ioat_dma_probe(pdev, iobase)    NULL
 125 #define ioat_dma_remove(device)         do { } while (0)
 126 #endif
 127
 128 #endif /* IOATDMA_H */