[deliverable/linux.git] / drivers / gpu / drm / i915 / intel_ringbuffer.h

#ifndef _INTEL_RINGBUFFER_H_
#define _INTEL_RINGBUFFER_H_

#include <linux/hashtable.h>
#include "i915_gem_batch_pool.h"

#define I915_CMD_HASH_ORDER 9

/* Early gen2 devices have a cacheline of just 32 bytes, using 64 is overkill,
 * but keeps the logic simple. Indeed, the whole purpose of this macro is just
 * to give some inclination as to some of the magic values used in the various
 * workarounds!
 */
#define CACHELINE_BYTES 64
#define CACHELINE_DWORDS (CACHELINE_BYTES / sizeof(uint32_t))

/*
 * Gen2 BSpec "1. Programming Environment" / 1.4.4.6 "Ring Buffer Use"
 * Gen3 BSpec "vol1c Memory Interface Functions" / 2.3.4.5 "Ring Buffer Use"
 * Gen4+ BSpec "vol1c Memory Interface and Command Stream" / 5.3.4.5 "Ring Buffer Use"
 *
 * "If the Ring Buffer Head Pointer and the Tail Pointer are on the same
 * cacheline, the Head Pointer must not be greater than the Tail
 * Pointer."
 */
#define I915_RING_FREE_SPACE 64

struct  intel_hw_status_page {
	u32		*page_addr;
	unsigned int	gfx_addr;
	struct		drm_i915_gem_object *obj;
};

#define I915_READ_TAIL(ring) I915_READ(RING_TAIL((ring)->mmio_base))
#define I915_WRITE_TAIL(ring, val) I915_WRITE(RING_TAIL((ring)->mmio_base), val)

#define I915_READ_START(ring) I915_READ(RING_START((ring)->mmio_base))
#define I915_WRITE_START(ring, val) I915_WRITE(RING_START((ring)->mmio_base), val)

#define I915_READ_HEAD(ring)  I915_READ(RING_HEAD((ring)->mmio_base))
#define I915_WRITE_HEAD(ring, val) I915_WRITE(RING_HEAD((ring)->mmio_base), val)

#define I915_READ_CTL(ring) I915_READ(RING_CTL((ring)->mmio_base))
#define I915_WRITE_CTL(ring, val) I915_WRITE(RING_CTL((ring)->mmio_base), val)

#define I915_READ_IMR(ring) I915_READ(RING_IMR((ring)->mmio_base))
#define I915_WRITE_IMR(ring, val) I915_WRITE(RING_IMR((ring)->mmio_base), val)

#define I915_READ_MODE(ring) I915_READ(RING_MI_MODE((ring)->mmio_base))
#define I915_WRITE_MODE(ring, val) I915_WRITE(RING_MI_MODE((ring)->mmio_base), val)

/* seqno size is actually only a uint32, but since we plan to use MI_FLUSH_DW to
 * do the writes, and that must have qw aligned offsets, simply pretend it's 8b.
 */
#define i915_semaphore_seqno_size sizeof(uint64_t)
#define GEN8_SIGNAL_OFFSET(__ring, to)			     \
	(i915_gem_obj_ggtt_offset(dev_priv->semaphore_obj) + \
	((__ring)->id * I915_NUM_RINGS * i915_semaphore_seqno_size) +	\
	(i915_semaphore_seqno_size * (to)))

#define GEN8_WAIT_OFFSET(__ring, from)			     \
	(i915_gem_obj_ggtt_offset(dev_priv->semaphore_obj) + \
	((from) * I915_NUM_RINGS * i915_semaphore_seqno_size) + \
	(i915_semaphore_seqno_size * (__ring)->id))

#define GEN8_RING_SEMAPHORE_INIT do { \
	if (!dev_priv->semaphore_obj) { \
		break; \
	} \
	ring->semaphore.signal_ggtt[RCS] = GEN8_SIGNAL_OFFSET(ring, RCS); \
	ring->semaphore.signal_ggtt[VCS] = GEN8_SIGNAL_OFFSET(ring, VCS); \
	ring->semaphore.signal_ggtt[BCS] = GEN8_SIGNAL_OFFSET(ring, BCS); \
	ring->semaphore.signal_ggtt[VECS] = GEN8_SIGNAL_OFFSET(ring, VECS); \
	ring->semaphore.signal_ggtt[VCS2] = GEN8_SIGNAL_OFFSET(ring, VCS2); \
	ring->semaphore.signal_ggtt[ring->id] = MI_SEMAPHORE_SYNC_INVALID; \
	} while(0)

enum intel_ring_hangcheck_action {
	HANGCHECK_IDLE = 0,
	HANGCHECK_WAIT,
	HANGCHECK_ACTIVE,
	HANGCHECK_ACTIVE_LOOP,
	HANGCHECK_KICK,
	HANGCHECK_HUNG,
};

#define HANGCHECK_SCORE_RING_HUNG 31

struct intel_ring_hangcheck {
	u64 acthd;
	u64 max_acthd;
	u32 seqno;
	int score;
	enum intel_ring_hangcheck_action action;
	int deadlock;
};

struct intel_ringbuffer {
	struct drm_i915_gem_object *obj;
	void __iomem *virtual_start;

	struct intel_engine_cs *ring;

	u32 head;
	u32 tail;
	int space;
	int size;
	int effective_size;
	int reserved_size;
	int reserved_tail;
	bool reserved_in_use;

	/** We track the position of the requests in the ring buffer, and
	 * when each is retired we increment last_retired_head as the GPU
	 * must have finished processing the request and so we know we
	 * can advance the ringbuffer up to that position.
	 *
	 * last_retired_head is set to -1 after the value is consumed so
	 * we can detect new retirements.
	 */
	u32 last_retired_head;
};

struct	intel_context;
struct drm_i915_reg_descriptor;

/*
 * we use a single page to load ctx workarounds so all of these
 * values are referred in terms of dwords
 *
 * struct i915_wa_ctx_bb:
 *  offset: specifies batch starting position, also helpful in case
 *    if we want to have multiple batches at different offsets based on
 *    some criteria. It is not a requirement at the moment but provides
 *    an option for future use.
 *  size: size of the batch in DWORDS
 */
struct  i915_ctx_workarounds {
	struct i915_wa_ctx_bb {
		u32 offset;
		u32 size;
	} indirect_ctx, per_ctx;
	struct drm_i915_gem_object *obj;
};

struct  intel_engine_cs {
	const char	*name;
	enum intel_ring_id {
		RCS = 0x0,
		VCS,
		BCS,
		VECS,
		VCS2
	} id;
#define I915_NUM_RINGS 5
#define LAST_USER_RING (VECS + 1)
	u32		mmio_base;
	struct		drm_device *dev;
	struct intel_ringbuffer *buffer;

	/*
	 * A pool of objects to use as shadow copies of client batch buffers
	 * when the command parser is enabled. Prevents the client from
	 * modifying the batch contents after software parsing.
	 */
	struct i915_gem_batch_pool batch_pool;

	struct intel_hw_status_page status_page;
	struct i915_ctx_workarounds wa_ctx;

	unsigned irq_refcount; /* protected by dev_priv->irq_lock */
	u32		irq_enable_mask;	/* bitmask to enable ring interrupt */
	struct drm_i915_gem_request *trace_irq_req;
	bool __must_check (*irq_get)(struct intel_engine_cs *ring);
	void		(*irq_put)(struct intel_engine_cs *ring);

	int		(*init_hw)(struct intel_engine_cs *ring);

	int		(*init_context)(struct drm_i915_gem_request *req);

	void		(*write_tail)(struct intel_engine_cs *ring,
				      u32 value);
	int __must_check (*flush)(struct drm_i915_gem_request *req,
				  u32	invalidate_domains,
				  u32	flush_domains);
	int		(*add_request)(struct drm_i915_gem_request *req);
	/* Some chipsets are not quite as coherent as advertised and need
	 * an expensive kick to force a true read of the up-to-date seqno.
	 * However, the up-to-date seqno is not always required and the last
	 * seen value is good enough. Note that the seqno will always be
	 * monotonic, even if not coherent.
	 */
	u32		(*get_seqno)(struct intel_engine_cs *ring,
				     bool lazy_coherency);
	void		(*set_seqno)(struct intel_engine_cs *ring,
				     u32 seqno);
	int		(*dispatch_execbuffer)(struct drm_i915_gem_request *req,
					       u64 offset, u32 length,
					       unsigned dispatch_flags);
#define I915_DISPATCH_SECURE 0x1
#define I915_DISPATCH_PINNED 0x2
	void		(*cleanup)(struct intel_engine_cs *ring);

	/* GEN8 signal/wait table - never trust comments!
	 *	  signal to	signal to    signal to   signal to      signal to
	 *	    RCS		   VCS          BCS        VECS		 VCS2
	 *      --------------------------------------------------------------------
	 *  RCS | NOP (0x00) | VCS (0x08) | BCS (0x10) | VECS (0x18) | VCS2 (0x20) |
	 *	|-------------------------------------------------------------------
	 *  VCS | RCS (0x28) | NOP (0x30) | BCS (0x38) | VECS (0x40) | VCS2 (0x48) |
	 *	|-------------------------------------------------------------------
	 *  BCS | RCS (0x50) | VCS (0x58) | NOP (0x60) | VECS (0x68) | VCS2 (0x70) |
	 *	|-------------------------------------------------------------------
	 * VECS | RCS (0x78) | VCS (0x80) | BCS (0x88) |  NOP (0x90) | VCS2 (0x98) |
	 *	|-------------------------------------------------------------------
	 * VCS2 | RCS (0xa0) | VCS (0xa8) | BCS (0xb0) | VECS (0xb8) | NOP  (0xc0) |
	 *	|-------------------------------------------------------------------
	 *
	 * Generalization:
	 *  f(x, y) := (x->id * NUM_RINGS * seqno_size) + (seqno_size * y->id)
	 *  ie. transpose of g(x, y)
	 *
	 *	 sync from	sync from    sync from    sync from	sync from
	 *	    RCS		   VCS          BCS        VECS		 VCS2
	 *      --------------------------------------------------------------------
	 *  RCS | NOP (0x00) | VCS (0x28) | BCS (0x50) | VECS (0x78) | VCS2 (0xa0) |
	 *	|-------------------------------------------------------------------
	 *  VCS | RCS (0x08) | NOP (0x30) | BCS (0x58) | VECS (0x80) | VCS2 (0xa8) |
	 *	|-------------------------------------------------------------------
	 *  BCS | RCS (0x10) | VCS (0x38) | NOP (0x60) | VECS (0x88) | VCS2 (0xb0) |
	 *	|-------------------------------------------------------------------
	 * VECS | RCS (0x18) | VCS (0x40) | BCS (0x68) |  NOP (0x90) | VCS2 (0xb8) |
	 *	|-------------------------------------------------------------------
	 * VCS2 | RCS (0x20) | VCS (0x48) | BCS (0x70) | VECS (0x98) |  NOP (0xc0) |
	 *	|-------------------------------------------------------------------
	 *
	 * Generalization:
	 *  g(x, y) := (y->id * NUM_RINGS * seqno_size) + (seqno_size * x->id)
	 *  ie. transpose of f(x, y)
	 */
	struct {
		u32	sync_seqno[I915_NUM_RINGS-1];

		union {
			struct {
				/* our mbox written by others */
				u32		wait[I915_NUM_RINGS];
				/* mboxes this ring signals to */
				u32		signal[I915_NUM_RINGS];
			} mbox;
			u64		signal_ggtt[I915_NUM_RINGS];
		};

		/* AKA wait() */
		int	(*sync_to)(struct drm_i915_gem_request *to_req,
				   struct intel_engine_cs *from,
				   u32 seqno);
		int	(*signal)(struct drm_i915_gem_request *signaller_req,
				  /* num_dwords needed by caller */
				  unsigned int num_dwords);
	} semaphore;

	/* Execlists */
	spinlock_t execlist_lock;
	struct list_head execlist_queue;
	struct list_head execlist_retired_req_list;
	u8 next_context_status_buffer;
	u32             irq_keep_mask; /* bitmask for interrupts that should not be masked */
	int		(*emit_request)(struct drm_i915_gem_request *request);
	int		(*emit_flush)(struct drm_i915_gem_request *request,
				      u32 invalidate_domains,
				      u32 flush_domains);
	int		(*emit_bb_start)(struct drm_i915_gem_request *req,
					 u64 offset, unsigned dispatch_flags);

	/**
	 * List of objects currently involved in rendering from the
	 * ringbuffer.
	 *
	 * Includes buffers having the contents of their GPU caches
	 * flushed, not necessarily primitives.  last_read_req
	 * represents when the rendering involved will be completed.
	 *
	 * A reference is held on the buffer while on this list.
	 */
	struct list_head active_list;

	/**
	 * List of breadcrumbs associated with GPU requests currently
	 * outstanding.
	 */
	struct list_head request_list;

	/**
	 * Do we have some not yet emitted requests outstanding?
	 */
	struct drm_i915_gem_request *outstanding_lazy_request;
	bool gpu_caches_dirty;

	wait_queue_head_t irq_queue;

	struct intel_context *default_context;
	struct intel_context *last_context;

	struct intel_ring_hangcheck hangcheck;

	struct {
		struct drm_i915_gem_object *obj;
		u32 gtt_offset;
		volatile u32 *cpu_page;
	} scratch;

	bool needs_cmd_parser;

	/*
	 * Table of commands the command parser needs to know about
	 * for this ring.
	 */
	DECLARE_HASHTABLE(cmd_hash, I915_CMD_HASH_ORDER);

	/*
	 * Table of registers allowed in commands that read/write registers.
	 */
	const struct drm_i915_reg_descriptor *reg_table;
	int reg_count;

	/*
	 * Table of registers allowed in commands that read/write registers, but
	 * only from the DRM master.
	 */
	const struct drm_i915_reg_descriptor *master_reg_table;
	int master_reg_count;

	/*
	 * Returns the bitmask for the length field of the specified command.
	 * Return 0 for an unrecognized/invalid command.
	 *
	 * If the command parser finds an entry for a command in the ring's
	 * cmd_tables, it gets the command's length based on the table entry.
	 * If not, it calls this function to determine the per-ring length field
	 * encoding for the command (i.e. certain opcode ranges use certain bits
	 * to encode the command length in the header).
	 */
	u32 (*get_cmd_length_mask)(u32 cmd_header);
};

bool intel_ring_initialized(struct intel_engine_cs *ring);

static inline unsigned
intel_ring_flag(struct intel_engine_cs *ring)
{
	return 1 << ring->id;
}

static inline u32
intel_ring_sync_index(struct intel_engine_cs *ring,
		      struct intel_engine_cs *other)
{
	int idx;

	/*
	 * rcs -> 0 = vcs, 1 = bcs, 2 = vecs, 3 = vcs2;
	 * vcs -> 0 = bcs, 1 = vecs, 2 = vcs2, 3 = rcs;
	 * bcs -> 0 = vecs, 1 = vcs2. 2 = rcs, 3 = vcs;
	 * vecs -> 0 = vcs2, 1 = rcs, 2 = vcs, 3 = bcs;
	 * vcs2 -> 0 = rcs, 1 = vcs, 2 = bcs, 3 = vecs;
	 */

	idx = (other - ring) - 1;
	if (idx < 0)
		idx += I915_NUM_RINGS;

	return idx;
}

static inline u32
intel_read_status_page(struct intel_engine_cs *ring,
		       int reg)
{
	/* Ensure that the compiler doesn't optimize away the load. */
	barrier();
	return ring->status_page.page_addr[reg];
}

static inline void
intel_write_status_page(struct intel_engine_cs *ring,
			int reg, u32 value)
{
	ring->status_page.page_addr[reg] = value;
}

/**
 * Reads a dword out of the status page, which is written to from the command
 * queue by automatic updates, MI_REPORT_HEAD, MI_STORE_DATA_INDEX, or
 * MI_STORE_DATA_IMM.
 *
 * The following dwords have a reserved meaning:
 * 0x00: ISR copy, updated when an ISR bit not set in the HWSTAM changes.
 * 0x04: ring 0 head pointer
 * 0x05: ring 1 head pointer (915-class)
 * 0x06: ring 2 head pointer (915-class)
 * 0x10-0x1b: Context status DWords (GM45)
 * 0x1f: Last written status offset. (GM45)
 * 0x20-0x2f: Reserved (Gen6+)
 *
 * The area from dword 0x30 to 0x3ff is available for driver usage.
 */
#define I915_GEM_HWS_INDEX		0x30
#define I915_GEM_HWS_SCRATCH_INDEX	0x40
#define I915_GEM_HWS_SCRATCH_ADDR (I915_GEM_HWS_SCRATCH_INDEX << MI_STORE_DWORD_INDEX_SHIFT)

void intel_unpin_ringbuffer_obj(struct intel_ringbuffer *ringbuf);
int intel_pin_and_map_ringbuffer_obj(struct drm_device *dev,
				     struct intel_ringbuffer *ringbuf);
void intel_destroy_ringbuffer_obj(struct intel_ringbuffer *ringbuf);
int intel_alloc_ringbuffer_obj(struct drm_device *dev,
			       struct intel_ringbuffer *ringbuf);

void intel_stop_ring_buffer(struct intel_engine_cs *ring);
void intel_cleanup_ring_buffer(struct intel_engine_cs *ring);

int intel_ring_alloc_request_extras(struct drm_i915_gem_request *request);

int __must_check intel_ring_begin(struct intel_engine_cs *ring, int n);
int __must_check intel_ring_cacheline_align(struct intel_engine_cs *ring);
static inline void intel_ring_emit(struct intel_engine_cs *ring,
				   u32 data)
{
	struct intel_ringbuffer *ringbuf = ring->buffer;
	iowrite32(data, ringbuf->virtual_start + ringbuf->tail);
	ringbuf->tail += 4;
}
static inline void intel_ring_advance(struct intel_engine_cs *ring)
{
	struct intel_ringbuffer *ringbuf = ring->buffer;
	ringbuf->tail &= ringbuf->size - 1;
}
int __intel_ring_space(int head, int tail, int size);
void intel_ring_update_space(struct intel_ringbuffer *ringbuf);
int intel_ring_space(struct intel_ringbuffer *ringbuf);
bool intel_ring_stopped(struct intel_engine_cs *ring);

int __must_check intel_ring_idle(struct intel_engine_cs *ring);
void intel_ring_init_seqno(struct intel_engine_cs *ring, u32 seqno);
int intel_ring_flush_all_caches(struct drm_i915_gem_request *req);
int intel_ring_invalidate_all_caches(struct drm_i915_gem_request *req);

void intel_fini_pipe_control(struct intel_engine_cs *ring);
int intel_init_pipe_control(struct intel_engine_cs *ring);

int intel_init_render_ring_buffer(struct drm_device *dev);
int intel_init_bsd_ring_buffer(struct drm_device *dev);
int intel_init_bsd2_ring_buffer(struct drm_device *dev);
int intel_init_blt_ring_buffer(struct drm_device *dev);
int intel_init_vebox_ring_buffer(struct drm_device *dev);

u64 intel_ring_get_active_head(struct intel_engine_cs *ring);

int init_workarounds_ring(struct intel_engine_cs *ring);

static inline u32 intel_ring_get_tail(struct intel_ringbuffer *ringbuf)
{
	return ringbuf->tail;
}

static inline struct drm_i915_gem_request *
intel_ring_get_request(struct intel_engine_cs *ring)
{
	BUG_ON(ring->outstanding_lazy_request == NULL);
	return ring->outstanding_lazy_request;
}

/*
 * Arbitrary size for largest possible 'add request' sequence. The code paths
 * are complex and variable. Empirical measurement shows that the worst case
 * is ILK at 136 words. Reserving too much is better than reserving too little
 * as that allows for corner cases that might have been missed. So the figure
 * has been rounded up to 160 words.
 */
#define MIN_SPACE_FOR_ADD_REQUEST	160

/*
 * Reserve space in the ring to guarantee that the i915_add_request() call
 * will always have sufficient room to do its stuff. The request creation
 * code calls this automatically.
 */
void intel_ring_reserved_space_reserve(struct intel_ringbuffer *ringbuf, int size);
/* Cancel the reservation, e.g. because the request is being discarded. */
void intel_ring_reserved_space_cancel(struct intel_ringbuffer *ringbuf);
/* Use the reserved space - for use by i915_add_request() only. */
void intel_ring_reserved_space_use(struct intel_ringbuffer *ringbuf);
/* Finish with the reserved space - for use by i915_add_request() only. */
void intel_ring_reserved_space_end(struct intel_ringbuffer *ringbuf);

#endif /* _INTEL_RINGBUFFER_H_ */
Commit	Line	Data
8187a2b7 ZN	1	#ifndef _INTEL_RINGBUFFER_H_
	2	#define _INTEL_RINGBUFFER_H_
	3
44e895a8	4	#include <linux/hashtable.h>
06fbca71	5	#include "i915_gem_batch_pool.h"
44e895a8 BV	6
	7	#define I915_CMD_HASH_ORDER 9
	8
4712274c OM	9	/* Early gen2 devices have a cacheline of just 32 bytes, using 64 is overkill,
	10	* but keeps the logic simple. Indeed, the whole purpose of this macro is just
	11	* to give some inclination as to some of the magic values used in the various
	12	* workarounds!
	13	*/
	14	#define CACHELINE_BYTES 64
17ee950d	15	#define CACHELINE_DWORDS (CACHELINE_BYTES / sizeof(uint32_t))
4712274c	16
633cf8f5 VS	17	/*
	18	* Gen2 BSpec "1. Programming Environment" / 1.4.4.6 "Ring Buffer Use"
	19	* Gen3 BSpec "vol1c Memory Interface Functions" / 2.3.4.5 "Ring Buffer Use"
	20	* Gen4+ BSpec "vol1c Memory Interface and Command Stream" / 5.3.4.5 "Ring Buffer Use"
	21	*
	22	* "If the Ring Buffer Head Pointer and the Tail Pointer are on the same
	23	* cacheline, the Head Pointer must not be greater than the Tail
	24	* Pointer."
	25	*/
	26	#define I915_RING_FREE_SPACE 64
	27
8187a2b7	28	struct intel_hw_status_page {
4225d0f2	29	u32 *page_addr;
8187a2b7	30	unsigned int gfx_addr;
05394f39	31	struct drm_i915_gem_object *obj;
8187a2b7 ZN	32	};
8187a2b7 ZN	33
b7287d80 BW	34	#define I915_READ_TAIL(ring) I915_READ(RING_TAIL((ring)->mmio_base))
b7287d80 BW	35	#define I915_WRITE_TAIL(ring, val) I915_WRITE(RING_TAIL((ring)->mmio_base), val)
cae5852d	36
b7287d80 BW	37	#define I915_READ_START(ring) I915_READ(RING_START((ring)->mmio_base))
b7287d80 BW	38	#define I915_WRITE_START(ring, val) I915_WRITE(RING_START((ring)->mmio_base), val)
cae5852d	39
b7287d80 BW	40	#define I915_READ_HEAD(ring) I915_READ(RING_HEAD((ring)->mmio_base))
b7287d80 BW	41	#define I915_WRITE_HEAD(ring, val) I915_WRITE(RING_HEAD((ring)->mmio_base), val)
cae5852d	42
b7287d80 BW	43	#define I915_READ_CTL(ring) I915_READ(RING_CTL((ring)->mmio_base))
b7287d80 BW	44	#define I915_WRITE_CTL(ring, val) I915_WRITE(RING_CTL((ring)->mmio_base), val)
cae5852d	45
b7287d80 BW	46	#define I915_READ_IMR(ring) I915_READ(RING_IMR((ring)->mmio_base))
b7287d80 BW	47	#define I915_WRITE_IMR(ring, val) I915_WRITE(RING_IMR((ring)->mmio_base), val)
870e86dd	48
e9fea574	49	#define I915_READ_MODE(ring) I915_READ(RING_MI_MODE((ring)->mmio_base))
9991ae78	50	#define I915_WRITE_MODE(ring, val) I915_WRITE(RING_MI_MODE((ring)->mmio_base), val)
e9fea574	51
3e78998a BW	52	/* seqno size is actually only a uint32, but since we plan to use MI_FLUSH_DW to
	53	* do the writes, and that must have qw aligned offsets, simply pretend it's 8b.
	54	*/
	55	#define i915_semaphore_seqno_size sizeof(uint64_t)
	56	#define GEN8_SIGNAL_OFFSET(__ring, to) \
	57	(i915_gem_obj_ggtt_offset(dev_priv->semaphore_obj) + \
	58	((__ring)->id * I915_NUM_RINGS * i915_semaphore_seqno_size) + \
	59	(i915_semaphore_seqno_size * (to)))
	60
	61	#define GEN8_WAIT_OFFSET(__ring, from) \
	62	(i915_gem_obj_ggtt_offset(dev_priv->semaphore_obj) + \
	63	((from) * I915_NUM_RINGS * i915_semaphore_seqno_size) + \
	64	(i915_semaphore_seqno_size * (__ring)->id))
	65
	66	#define GEN8_RING_SEMAPHORE_INIT do { \
	67	if (!dev_priv->semaphore_obj) { \
	68	break; \
	69	} \
	70	ring->semaphore.signal_ggtt[RCS] = GEN8_SIGNAL_OFFSET(ring, RCS); \
	71	ring->semaphore.signal_ggtt[VCS] = GEN8_SIGNAL_OFFSET(ring, VCS); \
	72	ring->semaphore.signal_ggtt[BCS] = GEN8_SIGNAL_OFFSET(ring, BCS); \
	73	ring->semaphore.signal_ggtt[VECS] = GEN8_SIGNAL_OFFSET(ring, VECS); \
	74	ring->semaphore.signal_ggtt[VCS2] = GEN8_SIGNAL_OFFSET(ring, VCS2); \
	75	ring->semaphore.signal_ggtt[ring->id] = MI_SEMAPHORE_SYNC_INVALID; \
	76	} while(0)
	77
f2f4d82f	78	enum intel_ring_hangcheck_action {
da661464	79	HANGCHECK_IDLE = 0,
f2f4d82f JN	80	HANGCHECK_WAIT,
f2f4d82f JN	81	HANGCHECK_ACTIVE,
f260fe7b	82	HANGCHECK_ACTIVE_LOOP,
f2f4d82f JN	83	HANGCHECK_KICK,
	84	HANGCHECK_HUNG,
	85	};
ad8beaea	86
b6b0fac0 MK	87	#define HANGCHECK_SCORE_RING_HUNG 31
b6b0fac0 MK	88
92cab734	89	struct intel_ring_hangcheck {
50877445	90	u64 acthd;
f260fe7b	91	u64 max_acthd;
92cab734	92	u32 seqno;
05407ff8	93	int score;
ad8beaea	94	enum intel_ring_hangcheck_action action;
4be17381	95	int deadlock;
92cab734 MK	96	};
92cab734 MK	97
8ee14975 OM	98	struct intel_ringbuffer {
	99	struct drm_i915_gem_object *obj;
	100	void __iomem *virtual_start;
	101
0c7dd53b DV	102	struct intel_engine_cs *ring;
0c7dd53b DV	103
8ee14975 OM	104	u32 head;
	105	u32 tail;
	106	int space;
	107	int size;
	108	int effective_size;
29b1b415 JH	109	int reserved_size;
	110	int reserved_tail;
	111	bool reserved_in_use;
8ee14975 OM	112
	113	/** We track the position of the requests in the ring buffer, and
	114	* when each is retired we increment last_retired_head as the GPU
	115	* must have finished processing the request and so we know we
	116	* can advance the ringbuffer up to that position.
	117	*
	118	* last_retired_head is set to -1 after the value is consumed so
	119	* we can detect new retirements.
	120	*/
	121	u32 last_retired_head;
	122	};
	123
21076372	124	struct intel_context;
4e86f725	125	struct drm_i915_reg_descriptor;
21076372	126
17ee950d AS	127	/*
	128	* we use a single page to load ctx workarounds so all of these
	129	* values are referred in terms of dwords
	130	*
	131	* struct i915_wa_ctx_bb:
	132	* offset: specifies batch starting position, also helpful in case
	133	* if we want to have multiple batches at different offsets based on
	134	* some criteria. It is not a requirement at the moment but provides
	135	* an option for future use.
	136	* size: size of the batch in DWORDS
	137	*/
	138	struct i915_ctx_workarounds {
	139	struct i915_wa_ctx_bb {
	140	u32 offset;
	141	u32 size;
	142	} indirect_ctx, per_ctx;
	143	struct drm_i915_gem_object *obj;
	144	};
	145
a4872ba6	146	struct intel_engine_cs {
8187a2b7	147	const char *name;
9220434a	148	enum intel_ring_id {
96154f2f DV	149	RCS = 0x0,
	150	VCS,
	151	BCS,
4a3dd19d	152	VECS,
845f74a7	153	VCS2
9220434a	154	} id;
845f74a7	155	#define I915_NUM_RINGS 5
b1a93306	156	#define LAST_USER_RING (VECS + 1)
333e9fe9	157	u32 mmio_base;
8187a2b7	158	struct drm_device *dev;
8ee14975	159	struct intel_ringbuffer *buffer;
8187a2b7	160
06fbca71 CW	161	/*
	162	* A pool of objects to use as shadow copies of client batch buffers
	163	* when the command parser is enabled. Prevents the client from
	164	* modifying the batch contents after software parsing.
	165	*/
	166	struct i915_gem_batch_pool batch_pool;
	167
8187a2b7	168	struct intel_hw_status_page status_page;
17ee950d	169	struct i915_ctx_workarounds wa_ctx;
8187a2b7	170
c7113cc3	171	unsigned irq_refcount; /* protected by dev_priv->irq_lock */
6a848ccb	172	u32 irq_enable_mask; /* bitmask to enable ring interrupt */
581c26e8	173	struct drm_i915_gem_request *trace_irq_req;
a4872ba6 OM	174	bool __must_check (irq_get)(struct intel_engine_cs ring);
a4872ba6 OM	175	void (irq_put)(struct intel_engine_cs ring);
8187a2b7	176
ecfe00d8	177	int (init_hw)(struct intel_engine_cs ring);
8187a2b7	178
8753181e	179	int (init_context)(struct drm_i915_gem_request req);
86d7f238	180
a4872ba6	181	void (write_tail)(struct intel_engine_cs ring,
297b0c5b	182	u32 value);
a84c3ae1	183	int __must_check (flush)(struct drm_i915_gem_request req,
b72f3acb CW	184	u32 invalidate_domains,
b72f3acb CW	185	u32 flush_domains);
ee044a88	186	int (add_request)(struct drm_i915_gem_request req);
b2eadbc8 CW	187	/* Some chipsets are not quite as coherent as advertised and need
	188	* an expensive kick to force a true read of the up-to-date seqno.
	189	* However, the up-to-date seqno is not always required and the last
	190	* seen value is good enough. Note that the seqno will always be
	191	* monotonic, even if not coherent.
	192	*/
a4872ba6	193	u32 (get_seqno)(struct intel_engine_cs ring,
b2eadbc8	194	bool lazy_coherency);
a4872ba6	195	void (set_seqno)(struct intel_engine_cs ring,
b70ec5bf	196	u32 seqno);
53fddaf7	197	int (dispatch_execbuffer)(struct drm_i915_gem_request req,
9bcb144c	198	u64 offset, u32 length,
8e004efc	199	unsigned dispatch_flags);
d7d4eedd	200	#define I915_DISPATCH_SECURE 0x1
b45305fc	201	#define I915_DISPATCH_PINNED 0x2
a4872ba6	202	void (cleanup)(struct intel_engine_cs ring);
ebc348b2	203
3e78998a BW	204	/* GEN8 signal/wait table - never trust comments!
	205	* signal to signal to signal to signal to signal to
	206	* RCS VCS BCS VECS VCS2
	207	* --------------------------------------------------------------------
	208	* RCS \| NOP (0x00) \| VCS (0x08) \| BCS (0x10) \| VECS (0x18) \| VCS2 (0x20) \|
	209	* \|-------------------------------------------------------------------
	210	* VCS \| RCS (0x28) \| NOP (0x30) \| BCS (0x38) \| VECS (0x40) \| VCS2 (0x48) \|
	211	* \|-------------------------------------------------------------------
	212	* BCS \| RCS (0x50) \| VCS (0x58) \| NOP (0x60) \| VECS (0x68) \| VCS2 (0x70) \|
	213	* \|-------------------------------------------------------------------
	214	* VECS \| RCS (0x78) \| VCS (0x80) \| BCS (0x88) \| NOP (0x90) \| VCS2 (0x98) \|
	215	* \|-------------------------------------------------------------------
	216	* VCS2 \| RCS (0xa0) \| VCS (0xa8) \| BCS (0xb0) \| VECS (0xb8) \| NOP (0xc0) \|
	217	* \|-------------------------------------------------------------------
	218	*
	219	* Generalization:
	220	* f(x, y) := (x->id * NUM_RINGS * seqno_size) + (seqno_size * y->id)
	221	* ie. transpose of g(x, y)
	222	*
	223	* sync from sync from sync from sync from sync from
	224	* RCS VCS BCS VECS VCS2
	225	* --------------------------------------------------------------------
	226	* RCS \| NOP (0x00) \| VCS (0x28) \| BCS (0x50) \| VECS (0x78) \| VCS2 (0xa0) \|
	227	* \|-------------------------------------------------------------------
	228	* VCS \| RCS (0x08) \| NOP (0x30) \| BCS (0x58) \| VECS (0x80) \| VCS2 (0xa8) \|
	229	* \|-------------------------------------------------------------------
	230	* BCS \| RCS (0x10) \| VCS (0x38) \| NOP (0x60) \| VECS (0x88) \| VCS2 (0xb0) \|
	231	* \|-------------------------------------------------------------------
	232	* VECS \| RCS (0x18) \| VCS (0x40) \| BCS (0x68) \| NOP (0x90) \| VCS2 (0xb8) \|
	233	* \|-------------------------------------------------------------------
	234	* VCS2 \| RCS (0x20) \| VCS (0x48) \| BCS (0x70) \| VECS (0x98) \| NOP (0xc0) \|
	235	* \|-------------------------------------------------------------------
	236	*
	237	* Generalization:
	238	* g(x, y) := (y->id * NUM_RINGS * seqno_size) + (seqno_size * x->id)
	239	* ie. transpose of f(x, y)
	240	*/
ebc348b2 BW	241	struct {
ebc348b2 BW	242	u32 sync_seqno[I915_NUM_RINGS-1];
78325f2d	243
3e78998a BW	244	union {
	245	struct {
	246	/* our mbox written by others */
	247	u32 wait[I915_NUM_RINGS];
	248	/* mboxes this ring signals to */
	249	u32 signal[I915_NUM_RINGS];
	250	} mbox;
	251	u64 signal_ggtt[I915_NUM_RINGS];
	252	};
78325f2d BW	253
78325f2d BW	254	/* AKA wait() */
599d924c JH	255	int (sync_to)(struct drm_i915_gem_request to_req,
599d924c JH	256	struct intel_engine_cs *from,
78325f2d	257	u32 seqno);
f7169687	258	int (signal)(struct drm_i915_gem_request signaller_req,
024a43e1 BW	259	/* num_dwords needed by caller */
024a43e1 BW	260	unsigned int num_dwords);
ebc348b2	261	} semaphore;
ad776f8b	262
4da46e1e	263	/* Execlists */
acdd884a MT	264	spinlock_t execlist_lock;
acdd884a MT	265	struct list_head execlist_queue;
c86ee3a9	266	struct list_head execlist_retired_req_list;
e981e7b1	267	u8 next_context_status_buffer;
73d477f6	268	u32 irq_keep_mask; /* bitmask for interrupts that should not be masked */
c4e76638	269	int (emit_request)(struct drm_i915_gem_request request);
7deb4d39	270	int (emit_flush)(struct drm_i915_gem_request request,
4712274c OM	271	u32 invalidate_domains,
4712274c OM	272	u32 flush_domains);
be795fc1	273	int (emit_bb_start)(struct drm_i915_gem_request req,
8e004efc	274	u64 offset, unsigned dispatch_flags);
4da46e1e	275
8187a2b7 ZN	276	/**
	277	* List of objects currently involved in rendering from the
	278	* ringbuffer.
	279	*
	280	* Includes buffers having the contents of their GPU caches
97b2a6a1	281	* flushed, not necessarily primitives. last_read_req
8187a2b7 ZN	282	* represents when the rendering involved will be completed.
	283	*
	284	* A reference is held on the buffer while on this list.
	285	*/
	286	struct list_head active_list;
	287
	288	/**
	289	* List of breadcrumbs associated with GPU requests currently
	290	* outstanding.
	291	*/
	292	struct list_head request_list;
	293
a56ba56c CW	294	/**
	295	* Do we have some not yet emitted requests outstanding?
	296	*/
6259cead	297	struct drm_i915_gem_request *outstanding_lazy_request;
cc889e0f	298	bool gpu_caches_dirty;
a56ba56c	299
8187a2b7	300	wait_queue_head_t irq_queue;
8d19215b	301
273497e5 OM	302	struct intel_context *default_context;
273497e5 OM	303	struct intel_context *last_context;
40521054	304
92cab734 MK	305	struct intel_ring_hangcheck hangcheck;
92cab734 MK	306
0d1aacac CW	307	struct {
	308	struct drm_i915_gem_object *obj;
	309	u32 gtt_offset;
	310	volatile u32 *cpu_page;
	311	} scratch;
351e3db2	312
44e895a8 BV	313	bool needs_cmd_parser;
44e895a8 BV	314
351e3db2	315	/*
44e895a8	316	* Table of commands the command parser needs to know about
351e3db2 BV	317	* for this ring.
351e3db2 BV	318	*/
44e895a8	319	DECLARE_HASHTABLE(cmd_hash, I915_CMD_HASH_ORDER);
351e3db2 BV	320
	321	/*
	322	* Table of registers allowed in commands that read/write registers.
	323	*/
4e86f725	324	const struct drm_i915_reg_descriptor *reg_table;
351e3db2 BV	325	int reg_count;
	326
	327	/*
	328	* Table of registers allowed in commands that read/write registers, but
	329	* only from the DRM master.
	330	*/
4e86f725	331	const struct drm_i915_reg_descriptor *master_reg_table;
351e3db2 BV	332	int master_reg_count;
	333
	334	/*
	335	* Returns the bitmask for the length field of the specified command.
	336	* Return 0 for an unrecognized/invalid command.
	337	*
	338	* If the command parser finds an entry for a command in the ring's
	339	* cmd_tables, it gets the command's length based on the table entry.
	340	* If not, it calls this function to determine the per-ring length field
	341	* encoding for the command (i.e. certain opcode ranges use certain bits
	342	* to encode the command length in the header).
	343	*/
	344	u32 (*get_cmd_length_mask)(u32 cmd_header);
8187a2b7 ZN	345	};
8187a2b7 ZN	346
48d82387	347	bool intel_ring_initialized(struct intel_engine_cs *ring);
b4519513	348
96154f2f	349	static inline unsigned
a4872ba6	350	intel_ring_flag(struct intel_engine_cs *ring)
96154f2f DV	351	{
	352	return 1 << ring->id;
	353	}
	354
1ec14ad3	355	static inline u32
a4872ba6 OM	356	intel_ring_sync_index(struct intel_engine_cs *ring,
a4872ba6 OM	357	struct intel_engine_cs *other)
1ec14ad3 CW	358	{
	359	int idx;
	360
	361	/*
ddd4dbc6 RV	362	* rcs -> 0 = vcs, 1 = bcs, 2 = vecs, 3 = vcs2;
	363	* vcs -> 0 = bcs, 1 = vecs, 2 = vcs2, 3 = rcs;
	364	* bcs -> 0 = vecs, 1 = vcs2. 2 = rcs, 3 = vcs;
	365	* vecs -> 0 = vcs2, 1 = rcs, 2 = vcs, 3 = bcs;
	366	* vcs2 -> 0 = rcs, 1 = vcs, 2 = bcs, 3 = vecs;
1ec14ad3 CW	367	*/
	368
	369	idx = (other - ring) - 1;
	370	if (idx < 0)
	371	idx += I915_NUM_RINGS;
	372
	373	return idx;
	374	}
	375
8187a2b7	376	static inline u32
a4872ba6	377	intel_read_status_page(struct intel_engine_cs *ring,
78501eac	378	int reg)
8187a2b7	379	{
4225d0f2 DV	380	/* Ensure that the compiler doesn't optimize away the load. */
	381	barrier();
	382	return ring->status_page.page_addr[reg];
8187a2b7 ZN	383	}
8187a2b7 ZN	384
b70ec5bf	385	static inline void
a4872ba6	386	intel_write_status_page(struct intel_engine_cs *ring,
b70ec5bf MK	387	int reg, u32 value)
	388	{
	389	ring->status_page.page_addr[reg] = value;
	390	}
	391
311bd68e CW	392	/**
	393	* Reads a dword out of the status page, which is written to from the command
	394	* queue by automatic updates, MI_REPORT_HEAD, MI_STORE_DATA_INDEX, or
	395	* MI_STORE_DATA_IMM.
	396	*
	397	* The following dwords have a reserved meaning:
	398	* 0x00: ISR copy, updated when an ISR bit not set in the HWSTAM changes.
	399	* 0x04: ring 0 head pointer
	400	* 0x05: ring 1 head pointer (915-class)
	401	* 0x06: ring 2 head pointer (915-class)
	402	* 0x10-0x1b: Context status DWords (GM45)
	403	* 0x1f: Last written status offset. (GM45)
b07da53c	404	* 0x20-0x2f: Reserved (Gen6+)
311bd68e	405	*
b07da53c	406	* The area from dword 0x30 to 0x3ff is available for driver usage.
311bd68e	407	*/
b07da53c TD	408	#define I915_GEM_HWS_INDEX 0x30
b07da53c TD	409	#define I915_GEM_HWS_SCRATCH_INDEX 0x40
9a289771	410	#define I915_GEM_HWS_SCRATCH_ADDR (I915_GEM_HWS_SCRATCH_INDEX << MI_STORE_DWORD_INDEX_SHIFT)
311bd68e	411
7ba717cf TD	412	void intel_unpin_ringbuffer_obj(struct intel_ringbuffer *ringbuf);
	413	int intel_pin_and_map_ringbuffer_obj(struct drm_device *dev,
	414	struct intel_ringbuffer *ringbuf);
84c2377f OM	415	void intel_destroy_ringbuffer_obj(struct intel_ringbuffer *ringbuf);
	416	int intel_alloc_ringbuffer_obj(struct drm_device *dev,
	417	struct intel_ringbuffer *ringbuf);
	418
a4872ba6 OM	419	void intel_stop_ring_buffer(struct intel_engine_cs *ring);
a4872ba6 OM	420	void intel_cleanup_ring_buffer(struct intel_engine_cs *ring);
96f298aa	421
6689cb2b JH	422	int intel_ring_alloc_request_extras(struct drm_i915_gem_request *request);
6689cb2b JH	423
a4872ba6 OM	424	int __must_check intel_ring_begin(struct intel_engine_cs *ring, int n);
	425	int __must_check intel_ring_cacheline_align(struct intel_engine_cs *ring);
	426	static inline void intel_ring_emit(struct intel_engine_cs *ring,
78501eac	427	u32 data)
e898cd22	428	{
93b0a4e0 OM	429	struct intel_ringbuffer *ringbuf = ring->buffer;
	430	iowrite32(data, ringbuf->virtual_start + ringbuf->tail);
	431	ringbuf->tail += 4;
e898cd22	432	}
a4872ba6	433	static inline void intel_ring_advance(struct intel_engine_cs *ring)
09246732	434	{
93b0a4e0 OM	435	struct intel_ringbuffer *ringbuf = ring->buffer;
93b0a4e0 OM	436	ringbuf->tail &= ringbuf->size - 1;
09246732	437	}
82e104cc	438	int __intel_ring_space(int head, int tail, int size);
ebd0fd4b	439	void intel_ring_update_space(struct intel_ringbuffer *ringbuf);
82e104cc OM	440	int intel_ring_space(struct intel_ringbuffer *ringbuf);
82e104cc OM	441	bool intel_ring_stopped(struct intel_engine_cs *ring);
09246732	442
a4872ba6 OM	443	int __must_check intel_ring_idle(struct intel_engine_cs *ring);
a4872ba6 OM	444	void intel_ring_init_seqno(struct intel_engine_cs *ring, u32 seqno);
4866d729	445	int intel_ring_flush_all_caches(struct drm_i915_gem_request *req);
2f20055d	446	int intel_ring_invalidate_all_caches(struct drm_i915_gem_request *req);
8187a2b7	447
9b1136d5 OM	448	void intel_fini_pipe_control(struct intel_engine_cs *ring);
	449	int intel_init_pipe_control(struct intel_engine_cs *ring);
	450
5c1143bb XH	451	int intel_init_render_ring_buffer(struct drm_device *dev);
5c1143bb XH	452	int intel_init_bsd_ring_buffer(struct drm_device *dev);
845f74a7	453	int intel_init_bsd2_ring_buffer(struct drm_device *dev);
549f7365	454	int intel_init_blt_ring_buffer(struct drm_device *dev);
9a8a2213	455	int intel_init_vebox_ring_buffer(struct drm_device *dev);
8187a2b7	456
a4872ba6	457	u64 intel_ring_get_active_head(struct intel_engine_cs *ring);
79f321b7	458
771b9a53 MT	459	int init_workarounds_ring(struct intel_engine_cs *ring);
771b9a53 MT	460
1b5d063f	461	static inline u32 intel_ring_get_tail(struct intel_ringbuffer *ringbuf)
a71d8d94	462	{
1b5d063f	463	return ringbuf->tail;
a71d8d94 CW	464	}
a71d8d94 CW	465
b793a00a JH	466	static inline struct drm_i915_gem_request *
	467	intel_ring_get_request(struct intel_engine_cs *ring)
	468	{
6259cead JH	469	BUG_ON(ring->outstanding_lazy_request == NULL);
6259cead JH	470	return ring->outstanding_lazy_request;
b793a00a JH	471	}
b793a00a JH	472
29b1b415 JH	473	/*
	474	* Arbitrary size for largest possible 'add request' sequence. The code paths
	475	* are complex and variable. Empirical measurement shows that the worst case
	476	* is ILK at 136 words. Reserving too much is better than reserving too little
	477	* as that allows for corner cases that might have been missed. So the figure
	478	* has been rounded up to 160 words.
	479	*/
	480	#define MIN_SPACE_FOR_ADD_REQUEST 160
	481
	482	/*
	483	* Reserve space in the ring to guarantee that the i915_add_request() call
	484	* will always have sufficient room to do its stuff. The request creation
	485	* code calls this automatically.
	486	*/
	487	void intel_ring_reserved_space_reserve(struct intel_ringbuffer *ringbuf, int size);
	488	/* Cancel the reservation, e.g. because the request is being discarded. */
	489	void intel_ring_reserved_space_cancel(struct intel_ringbuffer *ringbuf);
	490	/* Use the reserved space - for use by i915_add_request() only. */
	491	void intel_ring_reserved_space_use(struct intel_ringbuffer *ringbuf);
	492	/* Finish with the reserved space - for use by i915_add_request() only. */
	493	void intel_ring_reserved_space_end(struct intel_ringbuffer *ringbuf);
	494
8187a2b7	495	#endif /* _INTEL_RINGBUFFER_H_ */