[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

/*
 * 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;

	/** 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;

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;

	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 intel_engine_cs *ring,
					struct intel_context *ctx);

	void		(*write_tail)(struct intel_engine_cs *ring,
				      u32 value);
	int __must_check (*flush)(struct intel_engine_cs *ring,
				  u32	invalidate_domains,
				  u32	flush_domains);
	int		(*add_request)(struct intel_engine_cs *ring);
	/* 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 intel_engine_cs *ring,
					       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 intel_engine_cs *ring,
				   struct intel_engine_cs *to,
				   u32 seqno);
		int	(*signal)(struct intel_engine_cs *signaller,
				  /* 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 intel_ringbuffer *ringbuf,
					struct drm_i915_gem_request *request);
	int		(*emit_flush)(struct intel_ringbuffer *ringbuf,
				      struct intel_context *ctx,
				      u32 invalidate_domains,
				      u32 flush_domains);
	int		(*emit_bb_start)(struct intel_ringbuffer *ringbuf,
					 struct intel_context *ctx,
					 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;
	/**
	 * Seqno of request most recently submitted to request_list.
	 * Used exclusively by hang checker to avoid grabbing lock while
	 * inspecting request list.
	 */
	u32 last_submitted_seqno;

	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);
void __intel_ring_advance(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 intel_engine_cs *ring);
int intel_ring_invalidate_all_caches(struct intel_engine_cs *ring);

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;
}

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