[mirror_ubuntu-hirsute-kernel.git] / drivers / dma / ioat / dma.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Copyright(c) 2004 - 2009 Intel Corporation. All rights reserved.
 */
#ifndef IOATDMA_H
#define IOATDMA_H

#include <linux/dmaengine.h>
#include <linux/init.h>
#include <linux/dmapool.h>
#include <linux/cache.h>
#include <linux/pci_ids.h>
#include <linux/circ_buf.h>
#include <linux/interrupt.h>
#include "registers.h"
#include "hw.h"

#define IOAT_DMA_VERSION  "5.00"

#define IOAT_DMA_DCA_ANY_CPU		~0

#define to_ioatdma_device(dev) container_of(dev, struct ioatdma_device, dma_dev)
#define to_dev(ioat_chan) (&(ioat_chan)->ioat_dma->pdev->dev)
#define to_pdev(ioat_chan) ((ioat_chan)->ioat_dma->pdev)

#define chan_num(ch) ((int)((ch)->reg_base - (ch)->ioat_dma->reg_base) / 0x80)

/* ioat hardware assumes at least two sources for raid operations */
#define src_cnt_to_sw(x) ((x) + 2)
#define src_cnt_to_hw(x) ((x) - 2)
#define ndest_to_sw(x) ((x) + 1)
#define ndest_to_hw(x) ((x) - 1)
#define src16_cnt_to_sw(x) ((x) + 9)
#define src16_cnt_to_hw(x) ((x) - 9)

/*
 * workaround for IOAT ver.3.0 null descriptor issue
 * (channel returns error when size is 0)
 */
#define NULL_DESC_BUFFER_SIZE 1

enum ioat_irq_mode {
	IOAT_NOIRQ = 0,
	IOAT_MSIX,
	IOAT_MSI,
	IOAT_INTX
};

/**
 * struct ioatdma_device - internal representation of a IOAT device
 * @pdev: PCI-Express device
 * @reg_base: MMIO register space base address
 * @completion_pool: DMA buffers for completion ops
 * @sed_hw_pool: DMA super descriptor pools
 * @dma_dev: embedded struct dma_device
 * @version: version of ioatdma device
 * @msix_entries: irq handlers
 * @idx: per channel data
 * @dca: direct cache access context
 * @irq_mode: interrupt mode (INTX, MSI, MSIX)
 * @cap: read DMA capabilities register
 */
struct ioatdma_device {
	struct pci_dev *pdev;
	void __iomem *reg_base;
	struct dma_pool *completion_pool;
#define MAX_SED_POOLS	5
	struct dma_pool *sed_hw_pool[MAX_SED_POOLS];
	struct dma_device dma_dev;
	u8 version;
#define IOAT_MAX_CHANS 4
	struct msix_entry msix_entries[IOAT_MAX_CHANS];
	struct ioatdma_chan *idx[IOAT_MAX_CHANS];
	struct dca_provider *dca;
	enum ioat_irq_mode irq_mode;
	u32 cap;

	/* shadow version for CB3.3 chan reset errata workaround */
	u64 msixtba0;
	u64 msixdata0;
	u32 msixpba;
};

#define IOAT_MAX_ORDER 16
#define IOAT_MAX_DESCS (1 << IOAT_MAX_ORDER)
#define IOAT_CHUNK_SIZE (SZ_512K)
#define IOAT_DESCS_PER_CHUNK (IOAT_CHUNK_SIZE / IOAT_DESC_SZ)

struct ioat_descs {
	void *virt;
	dma_addr_t hw;
};

struct ioatdma_chan {
	struct dma_chan dma_chan;
	void __iomem *reg_base;
	dma_addr_t last_completion;
	spinlock_t cleanup_lock;
	unsigned long state;
	#define IOAT_CHAN_DOWN 0
	#define IOAT_COMPLETION_ACK 1
	#define IOAT_RESET_PENDING 2
	#define IOAT_KOBJ_INIT_FAIL 3
	#define IOAT_RUN 5
	#define IOAT_CHAN_ACTIVE 6
	struct timer_list timer;
	#define RESET_DELAY msecs_to_jiffies(100)
	struct ioatdma_device *ioat_dma;
	dma_addr_t completion_dma;
	u64 *completion;
	struct tasklet_struct cleanup_task;
	struct kobject kobj;

/* ioat v2 / v3 channel attributes
 * @xfercap_log; log2 of channel max transfer length (for fast division)
 * @head: allocated index
 * @issued: hardware notification point
 * @tail: cleanup index
 * @dmacount: identical to 'head' except for occasionally resetting to zero
 * @alloc_order: log2 of the number of allocated descriptors
 * @produce: number of descriptors to produce at submit time
 * @ring: software ring buffer implementation of hardware ring
 * @prep_lock: serializes descriptor preparation (producers)
 */
	size_t xfercap_log;
	u16 head;
	u16 issued;
	u16 tail;
	u16 dmacount;
	u16 alloc_order;
	u16 produce;
	struct ioat_ring_ent **ring;
	spinlock_t prep_lock;
	struct ioat_descs descs[IOAT_MAX_DESCS / IOAT_DESCS_PER_CHUNK];
	int desc_chunks;
	int intr_coalesce;
	int prev_intr_coalesce;
};

struct ioat_sysfs_entry {
	struct attribute attr;
	ssize_t (*show)(struct dma_chan *, char *);
	ssize_t (*store)(struct dma_chan *, const char *, size_t);
};

/**
 * struct ioat_sed_ent - wrapper around super extended hardware descriptor
 * @hw: hardware SED
 * @dma: dma address for the SED
 * @parent: point to the dma descriptor that's the parent
 * @hw_pool: descriptor pool index
 */
struct ioat_sed_ent {
	struct ioat_sed_raw_descriptor *hw;
	dma_addr_t dma;
	struct ioat_ring_ent *parent;
	unsigned int hw_pool;
};

/**
 * struct ioat_ring_ent - wrapper around hardware descriptor
 * @hw: hardware DMA descriptor (for memcpy)
 * @xor: hardware xor descriptor
 * @xor_ex: hardware xor extension descriptor
 * @pq: hardware pq descriptor
 * @pq_ex: hardware pq extension descriptor
 * @pqu: hardware pq update descriptor
 * @raw: hardware raw (un-typed) descriptor
 * @txd: the generic software descriptor for all engines
 * @len: total transaction length for unmap
 * @result: asynchronous result of validate operations
 * @id: identifier for debug
 * @sed: pointer to super extended descriptor sw desc
 */

struct ioat_ring_ent {
	union {
		struct ioat_dma_descriptor *hw;
		struct ioat_xor_descriptor *xor;
		struct ioat_xor_ext_descriptor *xor_ex;
		struct ioat_pq_descriptor *pq;
		struct ioat_pq_ext_descriptor *pq_ex;
		struct ioat_pq_update_descriptor *pqu;
		struct ioat_raw_descriptor *raw;
	};
	size_t len;
	struct dma_async_tx_descriptor txd;
	enum sum_check_flags *result;
	#ifdef DEBUG
	int id;
	#endif
	struct ioat_sed_ent *sed;
};

extern const struct sysfs_ops ioat_sysfs_ops;
extern struct ioat_sysfs_entry ioat_version_attr;
extern struct ioat_sysfs_entry ioat_cap_attr;
extern int ioat_pending_level;
extern int ioat_ring_alloc_order;
extern struct kobj_type ioat_ktype;
extern struct kmem_cache *ioat_cache;
extern int ioat_ring_max_alloc_order;
extern struct kmem_cache *ioat_sed_cache;

static inline struct ioatdma_chan *to_ioat_chan(struct dma_chan *c)
{
	return container_of(c, struct ioatdma_chan, dma_chan);
}

/* wrapper around hardware descriptor format + additional software fields */
#ifdef DEBUG
#define set_desc_id(desc, i) ((desc)->id = (i))
#define desc_id(desc) ((desc)->id)
#else
#define set_desc_id(desc, i)
#define desc_id(desc) (0)
#endif

static inline void
__dump_desc_dbg(struct ioatdma_chan *ioat_chan, struct ioat_dma_descriptor *hw,
		struct dma_async_tx_descriptor *tx, int id)
{
	struct device *dev = to_dev(ioat_chan);

	dev_dbg(dev, "desc[%d]: (%#llx->%#llx) cookie: %d flags: %#x"
		" ctl: %#10.8x (op: %#x int_en: %d compl: %d)\n", id,
		(unsigned long long) tx->phys,
		(unsigned long long) hw->next, tx->cookie, tx->flags,
		hw->ctl, hw->ctl_f.op, hw->ctl_f.int_en, hw->ctl_f.compl_write);
}

#define dump_desc_dbg(c, d) \
	({ if (d) __dump_desc_dbg(c, d->hw, &d->txd, desc_id(d)); 0; })

static inline struct ioatdma_chan *
ioat_chan_by_index(struct ioatdma_device *ioat_dma, int index)
{
	return ioat_dma->idx[index];
}

static inline u64 ioat_chansts(struct ioatdma_chan *ioat_chan)
{
	return readq(ioat_chan->reg_base + IOAT_CHANSTS_OFFSET);
}

static inline u64 ioat_chansts_to_addr(u64 status)
{
	return status & IOAT_CHANSTS_COMPLETED_DESCRIPTOR_ADDR;
}

static inline u32 ioat_chanerr(struct ioatdma_chan *ioat_chan)
{
	return readl(ioat_chan->reg_base + IOAT_CHANERR_OFFSET);
}

static inline void ioat_suspend(struct ioatdma_chan *ioat_chan)
{
	u8 ver = ioat_chan->ioat_dma->version;

	writeb(IOAT_CHANCMD_SUSPEND,
	       ioat_chan->reg_base + IOAT_CHANCMD_OFFSET(ver));
}

static inline void ioat_reset(struct ioatdma_chan *ioat_chan)
{
	u8 ver = ioat_chan->ioat_dma->version;

	writeb(IOAT_CHANCMD_RESET,
	       ioat_chan->reg_base + IOAT_CHANCMD_OFFSET(ver));
}

static inline bool ioat_reset_pending(struct ioatdma_chan *ioat_chan)
{
	u8 ver = ioat_chan->ioat_dma->version;
	u8 cmd;

	cmd = readb(ioat_chan->reg_base + IOAT_CHANCMD_OFFSET(ver));
	return (cmd & IOAT_CHANCMD_RESET) == IOAT_CHANCMD_RESET;
}

static inline bool is_ioat_active(unsigned long status)
{
	return ((status & IOAT_CHANSTS_STATUS) == IOAT_CHANSTS_ACTIVE);
}

static inline bool is_ioat_idle(unsigned long status)
{
	return ((status & IOAT_CHANSTS_STATUS) == IOAT_CHANSTS_DONE);
}

static inline bool is_ioat_halted(unsigned long status)
{
	return ((status & IOAT_CHANSTS_STATUS) == IOAT_CHANSTS_HALTED);
}

static inline bool is_ioat_suspended(unsigned long status)
{
	return ((status & IOAT_CHANSTS_STATUS) == IOAT_CHANSTS_SUSPENDED);
}

/* channel was fatally programmed */
static inline bool is_ioat_bug(unsigned long err)
{
	return !!err;
}


static inline u32 ioat_ring_size(struct ioatdma_chan *ioat_chan)
{
	return 1 << ioat_chan->alloc_order;
}

/* count of descriptors in flight with the engine */
static inline u16 ioat_ring_active(struct ioatdma_chan *ioat_chan)
{
	return CIRC_CNT(ioat_chan->head, ioat_chan->tail,
			ioat_ring_size(ioat_chan));
}

/* count of descriptors pending submission to hardware */
static inline u16 ioat_ring_pending(struct ioatdma_chan *ioat_chan)
{
	return CIRC_CNT(ioat_chan->head, ioat_chan->issued,
			ioat_ring_size(ioat_chan));
}

static inline u32 ioat_ring_space(struct ioatdma_chan *ioat_chan)
{
	return ioat_ring_size(ioat_chan) - ioat_ring_active(ioat_chan);
}

static inline u16
ioat_xferlen_to_descs(struct ioatdma_chan *ioat_chan, size_t len)
{
	u16 num_descs = len >> ioat_chan->xfercap_log;

	num_descs += !!(len & ((1 << ioat_chan->xfercap_log) - 1));
	return num_descs;
}

static inline struct ioat_ring_ent *
ioat_get_ring_ent(struct ioatdma_chan *ioat_chan, u16 idx)
{
	return ioat_chan->ring[idx & (ioat_ring_size(ioat_chan) - 1)];
}

static inline void
ioat_set_chainaddr(struct ioatdma_chan *ioat_chan, u64 addr)
{
	writel(addr & 0x00000000FFFFFFFF,
	       ioat_chan->reg_base + IOAT2_CHAINADDR_OFFSET_LOW);
	writel(addr >> 32,
	       ioat_chan->reg_base + IOAT2_CHAINADDR_OFFSET_HIGH);
}

/* IOAT Prep functions */
struct dma_async_tx_descriptor *
ioat_dma_prep_memcpy_lock(struct dma_chan *c, dma_addr_t dma_dest,
			   dma_addr_t dma_src, size_t len, unsigned long flags);
struct dma_async_tx_descriptor *
ioat_prep_interrupt_lock(struct dma_chan *c, unsigned long flags);
struct dma_async_tx_descriptor *
ioat_prep_xor(struct dma_chan *chan, dma_addr_t dest, dma_addr_t *src,
	       unsigned int src_cnt, size_t len, unsigned long flags);
struct dma_async_tx_descriptor *
ioat_prep_xor_val(struct dma_chan *chan, dma_addr_t *src,
		    unsigned int src_cnt, size_t len,
		    enum sum_check_flags *result, unsigned long flags);
struct dma_async_tx_descriptor *
ioat_prep_pq(struct dma_chan *chan, dma_addr_t *dst, dma_addr_t *src,
	      unsigned int src_cnt, const unsigned char *scf, size_t len,
	      unsigned long flags);
struct dma_async_tx_descriptor *
ioat_prep_pq_val(struct dma_chan *chan, dma_addr_t *pq, dma_addr_t *src,
		  unsigned int src_cnt, const unsigned char *scf, size_t len,
		  enum sum_check_flags *pqres, unsigned long flags);
struct dma_async_tx_descriptor *
ioat_prep_pqxor(struct dma_chan *chan, dma_addr_t dst, dma_addr_t *src,
		 unsigned int src_cnt, size_t len, unsigned long flags);
struct dma_async_tx_descriptor *
ioat_prep_pqxor_val(struct dma_chan *chan, dma_addr_t *src,
		     unsigned int src_cnt, size_t len,
		     enum sum_check_flags *result, unsigned long flags);

/* IOAT Operation functions */
irqreturn_t ioat_dma_do_interrupt(int irq, void *data);
irqreturn_t ioat_dma_do_interrupt_msix(int irq, void *data);
struct ioat_ring_ent **
ioat_alloc_ring(struct dma_chan *c, int order, gfp_t flags);
void ioat_start_null_desc(struct ioatdma_chan *ioat_chan);
void ioat_free_ring_ent(struct ioat_ring_ent *desc, struct dma_chan *chan);
int ioat_reset_hw(struct ioatdma_chan *ioat_chan);
enum dma_status
ioat_tx_status(struct dma_chan *c, dma_cookie_t cookie,
		struct dma_tx_state *txstate);
void ioat_cleanup_event(unsigned long data);
void ioat_timer_event(struct timer_list *t);
int ioat_check_space_lock(struct ioatdma_chan *ioat_chan, int num_descs);
void ioat_issue_pending(struct dma_chan *chan);

/* IOAT Init functions */
bool is_bwd_ioat(struct pci_dev *pdev);
struct dca_provider *ioat_dca_init(struct pci_dev *pdev, void __iomem *iobase);
void ioat_kobject_add(struct ioatdma_device *ioat_dma, struct kobj_type *type);
void ioat_kobject_del(struct ioatdma_device *ioat_dma);
int ioat_dma_setup_interrupts(struct ioatdma_device *ioat_dma);
void ioat_stop(struct ioatdma_chan *ioat_chan);
#endif /* IOATDMA_H */
Commit	Line	Data
9ab65aff	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
0bbd5f4e	2	/*
211a22ce	3	* Copyright(c) 2004 - 2009 Intel Corporation. All rights reserved.
0bbd5f4e CL	4	*/
	5	#ifndef IOATDMA_H
	6	#define IOATDMA_H
	7
	8	#include <linux/dmaengine.h>
0bbd5f4e CL	9	#include <linux/init.h>
	10	#include <linux/dmapool.h>
	11	#include <linux/cache.h>
57c651f7	12	#include <linux/pci_ids.h>
885b2010 DJ	13	#include <linux/circ_buf.h>
	14	#include <linux/interrupt.h>
	15	#include "registers.h"
	16	#include "hw.h"
0bbd5f4e	17
4d75873f	18	#define IOAT_DMA_VERSION "5.00"
5149fd01	19
7bb67c14 SN	20	#define IOAT_DMA_DCA_ANY_CPU ~0
7bb67c14 SN	21
55f878ec DJ	22	#define to_ioatdma_device(dev) container_of(dev, struct ioatdma_device, dma_dev)
	23	#define to_dev(ioat_chan) (&(ioat_chan)->ioat_dma->pdev->dev)
	24	#define to_pdev(ioat_chan) ((ioat_chan)->ioat_dma->pdev)
1f27adc2	25
55f878ec	26	#define chan_num(ch) ((int)((ch)->reg_base - (ch)->ioat_dma->reg_base) / 0x80)
1f27adc2	27
599d49de DJ	28	/* ioat hardware assumes at least two sources for raid operations */
	29	#define src_cnt_to_sw(x) ((x) + 2)
	30	#define src_cnt_to_hw(x) ((x) - 2)
	31	#define ndest_to_sw(x) ((x) + 1)
	32	#define ndest_to_hw(x) ((x) - 1)
	33	#define src16_cnt_to_sw(x) ((x) + 9)
	34	#define src16_cnt_to_hw(x) ((x) - 9)
	35
1f27adc2 DW	36	/*
	37	* workaround for IOAT ver.3.0 null descriptor issue
	38	* (channel returns error when size is 0)
	39	*/
	40	#define NULL_DESC_BUFFER_SIZE 1
	41
8a52b9ff DJ	42	enum ioat_irq_mode {
	43	IOAT_NOIRQ = 0,
	44	IOAT_MSIX,
8a52b9ff DJ	45	IOAT_MSI,
	46	IOAT_INTX
	47	};
	48
0bbd5f4e	49	/**
8ab89567	50	* struct ioatdma_device - internal representation of a IOAT device
0bbd5f4e CL	51	* @pdev: PCI-Express device
0bbd5f4e CL	52	* @reg_base: MMIO register space base address
c7b0e8d7 DJ	53	* @completion_pool: DMA buffers for completion ops
c7b0e8d7 DJ	54	* @sed_hw_pool: DMA super descriptor pools
55f878ec	55	* @dma_dev: embedded struct dma_device
8ab89567	56	* @version: version of ioatdma device
7bb67c14 SN	57	* @msix_entries: irq handlers
7bb67c14 SN	58	* @idx: per channel data
f2427e27	59	* @dca: direct cache access context
c7b0e8d7 DJ	60	* @irq_mode: interrupt mode (INTX, MSI, MSIX)
c7b0e8d7 DJ	61	* @cap: read DMA capabilities register
0bbd5f4e	62	*/
8ab89567	63	struct ioatdma_device {
0bbd5f4e	64	struct pci_dev *pdev;
47b16539	65	void __iomem *reg_base;
679cfbf7	66	struct dma_pool *completion_pool;
7727eaa4 DJ	67	#define MAX_SED_POOLS 5
7727eaa4 DJ	68	struct dma_pool *sed_hw_pool[MAX_SED_POOLS];
55f878ec	69	struct dma_device dma_dev;
8ab89567	70	u8 version;
ad4a7b50 DJ	71	#define IOAT_MAX_CHANS 4
	72	struct msix_entry msix_entries[IOAT_MAX_CHANS];
	73	struct ioatdma_chan *idx[IOAT_MAX_CHANS];
f2427e27	74	struct dca_provider *dca;
8a52b9ff	75	enum ioat_irq_mode irq_mode;
75c6f0ab	76	u32 cap;
c997e30e DJ	77
	78	/* shadow version for CB3.3 chan reset errata workaround */
	79	u64 msixtba0;
	80	u64 msixdata0;
	81	u32 msixpba;
0bbd5f4e CL	82	};
0bbd5f4e CL	83
bd2bf302 LR	84	#define IOAT_MAX_ORDER 16
bd2bf302 LR	85	#define IOAT_MAX_DESCS (1 << IOAT_MAX_ORDER)
a02254f8	86	#define IOAT_CHUNK_SIZE (SZ_512K)
bd2bf302 LR	87	#define IOAT_DESCS_PER_CHUNK (IOAT_CHUNK_SIZE / IOAT_DESC_SZ)
bd2bf302 LR	88
dd4645eb DJ	89	struct ioat_descs {
	90	void *virt;
	91	dma_addr_t hw;
	92	};
	93
5a976888 DJ	94	struct ioatdma_chan {
5a976888 DJ	95	struct dma_chan dma_chan;
47b16539	96	void __iomem *reg_base;
27502935	97	dma_addr_t last_completion;
0bbd5f4e	98	spinlock_t cleanup_lock;
09c8a5b8	99	unsigned long state;
ad4a7b50	100	#define IOAT_CHAN_DOWN 0
09c8a5b8 DW	101	#define IOAT_COMPLETION_ACK 1
09c8a5b8 DW	102	#define IOAT_RESET_PENDING 2
5669e31c	103	#define IOAT_KOBJ_INIT_FAIL 3
556ab45f	104	#define IOAT_RUN 5
4dec23d7	105	#define IOAT_CHAN_ACTIVE 6
09c8a5b8	106	struct timer_list timer;
09c8a5b8	107	#define RESET_DELAY msecs_to_jiffies(100)
55f878ec	108	struct ioatdma_device *ioat_dma;
4fb9b9e8 DW	109	dma_addr_t completion_dma;
4fb9b9e8 DW	110	u64 *completion;
3e037454	111	struct tasklet_struct cleanup_task;
5669e31c	112	struct kobject kobj;
5a976888 DJ	113
	114	/* ioat v2 / v3 channel attributes
	115	* @xfercap_log; log2 of channel max transfer length (for fast division)
	116	* @head: allocated index
	117	* @issued: hardware notification point
	118	* @tail: cleanup index
	119	* @dmacount: identical to 'head' except for occasionally resetting to zero
	120	* @alloc_order: log2 of the number of allocated descriptors
	121	* @produce: number of descriptors to produce at submit time
	122	* @ring: software ring buffer implementation of hardware ring
	123	* @prep_lock: serializes descriptor preparation (producers)
	124	*/
	125	size_t xfercap_log;
	126	u16 head;
	127	u16 issued;
	128	u16 tail;
	129	u16 dmacount;
	130	u16 alloc_order;
	131	u16 produce;
	132	struct ioat_ring_ent **ring;
	133	spinlock_t prep_lock;
bd2bf302	134	struct ioat_descs descs[IOAT_MAX_DESCS / IOAT_DESCS_PER_CHUNK];
dd4645eb	135	int desc_chunks;
268e2519 US	136	int intr_coalesce;
268e2519 US	137	int prev_intr_coalesce;
0bbd5f4e CL	138	};
0bbd5f4e CL	139
5669e31c DW	140	struct ioat_sysfs_entry {
	141	struct attribute attr;
	142	ssize_t (show)(struct dma_chan , char *);
268e2519	143	ssize_t (store)(struct dma_chan , const char *, size_t);
5669e31c	144	};
5cbafa65	145
7727eaa4 DJ	146	/**
	147	* struct ioat_sed_ent - wrapper around super extended hardware descriptor
	148	* @hw: hardware SED
c7b0e8d7	149	* @dma: dma address for the SED
7727eaa4	150	* @parent: point to the dma descriptor that's the parent
c7b0e8d7	151	* @hw_pool: descriptor pool index
7727eaa4 DJ	152	*/
	153	struct ioat_sed_ent {
	154	struct ioat_sed_raw_descriptor *hw;
	155	dma_addr_t dma;
	156	struct ioat_ring_ent *parent;
	157	unsigned int hw_pool;
	158	};
	159
885b2010 DJ	160	/**
	161	* struct ioat_ring_ent - wrapper around hardware descriptor
	162	* @hw: hardware DMA descriptor (for memcpy)
885b2010 DJ	163	* @xor: hardware xor descriptor
	164	* @xor_ex: hardware xor extension descriptor
	165	* @pq: hardware pq descriptor
	166	* @pq_ex: hardware pq extension descriptor
	167	* @pqu: hardware pq update descriptor
	168	* @raw: hardware raw (un-typed) descriptor
	169	* @txd: the generic software descriptor for all engines
	170	* @len: total transaction length for unmap
	171	* @result: asynchronous result of validate operations
	172	* @id: identifier for debug
c7b0e8d7	173	* @sed: pointer to super extended descriptor sw desc
885b2010 DJ	174	*/
	175
	176	struct ioat_ring_ent {
	177	union {
	178	struct ioat_dma_descriptor *hw;
	179	struct ioat_xor_descriptor *xor;
	180	struct ioat_xor_ext_descriptor *xor_ex;
	181	struct ioat_pq_descriptor *pq;
	182	struct ioat_pq_ext_descriptor *pq_ex;
	183	struct ioat_pq_update_descriptor *pqu;
	184	struct ioat_raw_descriptor *raw;
	185	};
	186	size_t len;
	187	struct dma_async_tx_descriptor txd;
	188	enum sum_check_flags *result;
	189	#ifdef DEBUG
	190	int id;
	191	#endif
	192	struct ioat_sed_ent *sed;
	193	};
	194
599d49de DJ	195	extern const struct sysfs_ops ioat_sysfs_ops;
	196	extern struct ioat_sysfs_entry ioat_version_attr;
	197	extern struct ioat_sysfs_entry ioat_cap_attr;
	198	extern int ioat_pending_level;
	199	extern int ioat_ring_alloc_order;
	200	extern struct kobj_type ioat_ktype;
	201	extern struct kmem_cache *ioat_cache;
	202	extern int ioat_ring_max_alloc_order;
	203	extern struct kmem_cache *ioat_sed_cache;
	204
5a976888	205	static inline struct ioatdma_chan to_ioat_chan(struct dma_chan c)
dcbc853a	206	{
5a976888	207	return container_of(c, struct ioatdma_chan, dma_chan);
dcbc853a DW	208	}
dcbc853a DW	209
0bbd5f4e	210	/* wrapper around hardware descriptor format + additional software fields */
6df9183a DW	211	#ifdef DEBUG
	212	#define set_desc_id(desc, i) ((desc)->id = (i))
	213	#define desc_id(desc) ((desc)->id)
	214	#else
	215	#define set_desc_id(desc, i)
	216	#define desc_id(desc) (0)
	217	#endif
	218
	219	static inline void
5a976888	220	__dump_desc_dbg(struct ioatdma_chan ioat_chan, struct ioat_dma_descriptor hw,
6df9183a DW	221	struct dma_async_tx_descriptor *tx, int id)
6df9183a DW	222	{
5a976888	223	struct device *dev = to_dev(ioat_chan);
6df9183a DW	224
6df9183a DW	225	dev_dbg(dev, "desc[%d]: (%#llx->%#llx) cookie: %d flags: %#x"
50f9f97e	226	" ctl: %#10.8x (op: %#x int_en: %d compl: %d)\n", id,
6df9183a DW	227	(unsigned long long) tx->phys,
	228	(unsigned long long) hw->next, tx->cookie, tx->flags,
	229	hw->ctl, hw->ctl_f.op, hw->ctl_f.int_en, hw->ctl_f.compl_write);
	230	}
	231
	232	#define dump_desc_dbg(c, d) \
5a976888	233	({ if (d) __dump_desc_dbg(c, d->hw, &d->txd, desc_id(d)); 0; })
6df9183a	234
5a976888	235	static inline struct ioatdma_chan *
55f878ec	236	ioat_chan_by_index(struct ioatdma_device *ioat_dma, int index)
5cbafa65	237	{
55f878ec	238	return ioat_dma->idx[index];
5cbafa65 DW	239	}
5cbafa65 DW	240
5a976888	241	static inline u64 ioat_chansts(struct ioatdma_chan *ioat_chan)
d92a8d7c	242	{
d3cd63f9	243	return readq(ioat_chan->reg_base + IOAT_CHANSTS_OFFSET);
d92a8d7c DJ	244	}
d92a8d7c DJ	245
09c8a5b8 DW	246	static inline u64 ioat_chansts_to_addr(u64 status)
	247	{
	248	return status & IOAT_CHANSTS_COMPLETED_DESCRIPTOR_ADDR;
	249	}
	250
5a976888	251	static inline u32 ioat_chanerr(struct ioatdma_chan *ioat_chan)
09c8a5b8	252	{
5a976888	253	return readl(ioat_chan->reg_base + IOAT_CHANERR_OFFSET);
09c8a5b8 DW	254	}
09c8a5b8 DW	255
5a976888	256	static inline void ioat_suspend(struct ioatdma_chan *ioat_chan)
09c8a5b8	257	{
55f878ec	258	u8 ver = ioat_chan->ioat_dma->version;
09c8a5b8	259
5a976888 DJ	260	writeb(IOAT_CHANCMD_SUSPEND,
5a976888 DJ	261	ioat_chan->reg_base + IOAT_CHANCMD_OFFSET(ver));
09c8a5b8 DW	262	}
09c8a5b8 DW	263
5a976888	264	static inline void ioat_reset(struct ioatdma_chan *ioat_chan)
a6d52d70	265	{
55f878ec	266	u8 ver = ioat_chan->ioat_dma->version;
a6d52d70	267
5a976888 DJ	268	writeb(IOAT_CHANCMD_RESET,
5a976888 DJ	269	ioat_chan->reg_base + IOAT_CHANCMD_OFFSET(ver));
a6d52d70 DW	270	}
a6d52d70 DW	271
5a976888	272	static inline bool ioat_reset_pending(struct ioatdma_chan *ioat_chan)
a6d52d70	273	{
55f878ec	274	u8 ver = ioat_chan->ioat_dma->version;
a6d52d70 DW	275	u8 cmd;
a6d52d70 DW	276
5a976888	277	cmd = readb(ioat_chan->reg_base + IOAT_CHANCMD_OFFSET(ver));
a6d52d70 DW	278	return (cmd & IOAT_CHANCMD_RESET) == IOAT_CHANCMD_RESET;
	279	}
	280
09c8a5b8 DW	281	static inline bool is_ioat_active(unsigned long status)
	282	{
	283	return ((status & IOAT_CHANSTS_STATUS) == IOAT_CHANSTS_ACTIVE);
	284	}
	285
	286	static inline bool is_ioat_idle(unsigned long status)
	287	{
	288	return ((status & IOAT_CHANSTS_STATUS) == IOAT_CHANSTS_DONE);
	289	}
	290
	291	static inline bool is_ioat_halted(unsigned long status)
	292	{
	293	return ((status & IOAT_CHANSTS_STATUS) == IOAT_CHANSTS_HALTED);
	294	}
	295
	296	static inline bool is_ioat_suspended(unsigned long status)
	297	{
	298	return ((status & IOAT_CHANSTS_STATUS) == IOAT_CHANSTS_SUSPENDED);
	299	}
	300
	301	/* channel was fatally programmed */
	302	static inline bool is_ioat_bug(unsigned long err)
	303	{
b57014de	304	return !!err;
09c8a5b8 DW	305	}
09c8a5b8 DW	306
885b2010 DJ	307
	308	static inline u32 ioat_ring_size(struct ioatdma_chan *ioat_chan)
	309	{
	310	return 1 << ioat_chan->alloc_order;
	311	}
	312
	313	/* count of descriptors in flight with the engine */
	314	static inline u16 ioat_ring_active(struct ioatdma_chan *ioat_chan)
	315	{
	316	return CIRC_CNT(ioat_chan->head, ioat_chan->tail,
	317	ioat_ring_size(ioat_chan));
	318	}
	319
	320	/* count of descriptors pending submission to hardware */
	321	static inline u16 ioat_ring_pending(struct ioatdma_chan *ioat_chan)
	322	{
	323	return CIRC_CNT(ioat_chan->head, ioat_chan->issued,
	324	ioat_ring_size(ioat_chan));
	325	}
	326
	327	static inline u32 ioat_ring_space(struct ioatdma_chan *ioat_chan)
	328	{
	329	return ioat_ring_size(ioat_chan) - ioat_ring_active(ioat_chan);
	330	}
	331
	332	static inline u16
	333	ioat_xferlen_to_descs(struct ioatdma_chan *ioat_chan, size_t len)
	334	{
	335	u16 num_descs = len >> ioat_chan->xfercap_log;
	336
	337	num_descs += !!(len & ((1 << ioat_chan->xfercap_log) - 1));
	338	return num_descs;
	339	}
	340
	341	static inline struct ioat_ring_ent *
	342	ioat_get_ring_ent(struct ioatdma_chan *ioat_chan, u16 idx)
	343	{
	344	return ioat_chan->ring[idx & (ioat_ring_size(ioat_chan) - 1)];
	345	}
	346
	347	static inline void
	348	ioat_set_chainaddr(struct ioatdma_chan *ioat_chan, u64 addr)
	349	{
	350	writel(addr & 0x00000000FFFFFFFF,
	351	ioat_chan->reg_base + IOAT2_CHAINADDR_OFFSET_LOW);
	352	writel(addr >> 32,
	353	ioat_chan->reg_base + IOAT2_CHAINADDR_OFFSET_HIGH);
	354	}
	355
599d49de DJ	356	/* IOAT Prep functions */
	357	struct dma_async_tx_descriptor *
	358	ioat_dma_prep_memcpy_lock(struct dma_chan *c, dma_addr_t dma_dest,
	359	dma_addr_t dma_src, size_t len, unsigned long flags);
c0f28ce6 DJ	360	struct dma_async_tx_descriptor *
	361	ioat_prep_interrupt_lock(struct dma_chan *c, unsigned long flags);
	362	struct dma_async_tx_descriptor *
	363	ioat_prep_xor(struct dma_chan chan, dma_addr_t dest, dma_addr_t src,
	364	unsigned int src_cnt, size_t len, unsigned long flags);
	365	struct dma_async_tx_descriptor *
	366	ioat_prep_xor_val(struct dma_chan chan, dma_addr_t src,
	367	unsigned int src_cnt, size_t len,
	368	enum sum_check_flags *result, unsigned long flags);
	369	struct dma_async_tx_descriptor *
	370	ioat_prep_pq(struct dma_chan chan, dma_addr_t dst, dma_addr_t *src,
	371	unsigned int src_cnt, const unsigned char *scf, size_t len,
	372	unsigned long flags);
	373	struct dma_async_tx_descriptor *
	374	ioat_prep_pq_val(struct dma_chan chan, dma_addr_t pq, dma_addr_t *src,
	375	unsigned int src_cnt, const unsigned char *scf, size_t len,
	376	enum sum_check_flags *pqres, unsigned long flags);
	377	struct dma_async_tx_descriptor *
	378	ioat_prep_pqxor(struct dma_chan chan, dma_addr_t dst, dma_addr_t src,
	379	unsigned int src_cnt, size_t len, unsigned long flags);
	380	struct dma_async_tx_descriptor *
	381	ioat_prep_pqxor_val(struct dma_chan chan, dma_addr_t src,
	382	unsigned int src_cnt, size_t len,
	383	enum sum_check_flags *result, unsigned long flags);
599d49de DJ	384
	385	/* IOAT Operation functions */
	386	irqreturn_t ioat_dma_do_interrupt(int irq, void *data);
	387	irqreturn_t ioat_dma_do_interrupt_msix(int irq, void *data);
	388	struct ioat_ring_ent **
	389	ioat_alloc_ring(struct dma_chan *c, int order, gfp_t flags);
	390	void ioat_start_null_desc(struct ioatdma_chan *ioat_chan);
	391	void ioat_free_ring_ent(struct ioat_ring_ent desc, struct dma_chan chan);
	392	int ioat_reset_hw(struct ioatdma_chan *ioat_chan);
c0f28ce6 DJ	393	enum dma_status
	394	ioat_tx_status(struct dma_chan *c, dma_cookie_t cookie,
	395	struct dma_tx_state *txstate);
	396	void ioat_cleanup_event(unsigned long data);
bcdc4bd3	397	void ioat_timer_event(struct timer_list *t);
885b2010	398	int ioat_check_space_lock(struct ioatdma_chan *ioat_chan, int num_descs);
885b2010	399	void ioat_issue_pending(struct dma_chan *chan);
885b2010	400
599d49de DJ	401	/* IOAT Init functions */
599d49de DJ	402	bool is_bwd_ioat(struct pci_dev *pdev);
3372de58	403	struct dca_provider ioat_dca_init(struct pci_dev pdev, void __iomem *iobase);
599d49de DJ	404	void ioat_kobject_add(struct ioatdma_device ioat_dma, struct kobj_type type);
	405	void ioat_kobject_del(struct ioatdma_device *ioat_dma);
	406	int ioat_dma_setup_interrupts(struct ioatdma_device *ioat_dma);
	407	void ioat_stop(struct ioatdma_chan *ioat_chan);
0bbd5f4e	408	#endif /* IOATDMA_H */