blob: 0f29e07a9581b3c000a39a0db241b391f5962089 [file] [log] [blame]
Zou Nan hai8187a2b2010-05-21 09:08:55 +08001#ifndef _INTEL_RINGBUFFER_H_
2#define _INTEL_RINGBUFFER_H_
3
Brad Volkin44e895a2014-05-10 14:10:43 -07004#include <linux/hashtable.h>
Chris Wilson06fbca72015-04-07 16:20:36 +01005#include "i915_gem_batch_pool.h"
Chris Wilsondcff85c2016-08-05 10:14:11 +01006#include "i915_gem_request.h"
Chris Wilson73cb9702016-10-28 13:58:46 +01007#include "i915_gem_timeline.h"
Chris Wilsonf97fbf92017-02-13 17:15:14 +00008#include "i915_selftest.h"
Brad Volkin44e895a2014-05-10 14:10:43 -07009
10#define I915_CMD_HASH_ORDER 9
11
Oscar Mateo47122742014-07-24 17:04:28 +010012/* Early gen2 devices have a cacheline of just 32 bytes, using 64 is overkill,
13 * but keeps the logic simple. Indeed, the whole purpose of this macro is just
14 * to give some inclination as to some of the magic values used in the various
15 * workarounds!
16 */
17#define CACHELINE_BYTES 64
Arun Siluvery17ee9502015-06-19 19:07:01 +010018#define CACHELINE_DWORDS (CACHELINE_BYTES / sizeof(uint32_t))
Oscar Mateo47122742014-07-24 17:04:28 +010019
Ville Syrjälä633cf8f2012-12-03 18:43:32 +020020/*
21 * Gen2 BSpec "1. Programming Environment" / 1.4.4.6 "Ring Buffer Use"
22 * Gen3 BSpec "vol1c Memory Interface Functions" / 2.3.4.5 "Ring Buffer Use"
23 * Gen4+ BSpec "vol1c Memory Interface and Command Stream" / 5.3.4.5 "Ring Buffer Use"
24 *
25 * "If the Ring Buffer Head Pointer and the Tail Pointer are on the same
26 * cacheline, the Head Pointer must not be greater than the Tail
27 * Pointer."
28 */
29#define I915_RING_FREE_SPACE 64
30
Chris Wilson57e88532016-08-15 10:48:57 +010031struct intel_hw_status_page {
32 struct i915_vma *vma;
33 u32 *page_addr;
34 u32 ggtt_offset;
Zou Nan hai8187a2b2010-05-21 09:08:55 +080035};
36
Dave Gordonbbdc070a2016-07-20 18:16:05 +010037#define I915_READ_TAIL(engine) I915_READ(RING_TAIL((engine)->mmio_base))
38#define I915_WRITE_TAIL(engine, val) I915_WRITE(RING_TAIL((engine)->mmio_base), val)
Zou Nan haicae58522010-11-09 17:17:32 +080039
Dave Gordonbbdc070a2016-07-20 18:16:05 +010040#define I915_READ_START(engine) I915_READ(RING_START((engine)->mmio_base))
41#define I915_WRITE_START(engine, val) I915_WRITE(RING_START((engine)->mmio_base), val)
Zou Nan haicae58522010-11-09 17:17:32 +080042
Dave Gordonbbdc070a2016-07-20 18:16:05 +010043#define I915_READ_HEAD(engine) I915_READ(RING_HEAD((engine)->mmio_base))
44#define I915_WRITE_HEAD(engine, val) I915_WRITE(RING_HEAD((engine)->mmio_base), val)
Zou Nan haicae58522010-11-09 17:17:32 +080045
Dave Gordonbbdc070a2016-07-20 18:16:05 +010046#define I915_READ_CTL(engine) I915_READ(RING_CTL((engine)->mmio_base))
47#define I915_WRITE_CTL(engine, val) I915_WRITE(RING_CTL((engine)->mmio_base), val)
Zou Nan haicae58522010-11-09 17:17:32 +080048
Dave Gordonbbdc070a2016-07-20 18:16:05 +010049#define I915_READ_IMR(engine) I915_READ(RING_IMR((engine)->mmio_base))
50#define I915_WRITE_IMR(engine, val) I915_WRITE(RING_IMR((engine)->mmio_base), val)
Daniel Vetter870e86d2010-08-02 16:29:44 +020051
Dave Gordonbbdc070a2016-07-20 18:16:05 +010052#define I915_READ_MODE(engine) I915_READ(RING_MI_MODE((engine)->mmio_base))
53#define I915_WRITE_MODE(engine, val) I915_WRITE(RING_MI_MODE((engine)->mmio_base), val)
Naresh Kumar Kachhie9fea572014-03-12 16:39:41 +053054
Ben Widawsky3e789982014-06-30 09:53:37 -070055/* seqno size is actually only a uint32, but since we plan to use MI_FLUSH_DW to
56 * do the writes, and that must have qw aligned offsets, simply pretend it's 8b.
57 */
Chris Wilson8c12672e2016-04-07 07:29:14 +010058#define gen8_semaphore_seqno_size sizeof(uint64_t)
59#define GEN8_SEMAPHORE_OFFSET(__from, __to) \
60 (((__from) * I915_NUM_ENGINES + (__to)) * gen8_semaphore_seqno_size)
Ben Widawsky3e789982014-06-30 09:53:37 -070061#define GEN8_SIGNAL_OFFSET(__ring, to) \
Chris Wilson51d545d2016-08-15 10:49:02 +010062 (dev_priv->semaphore->node.start + \
Chris Wilson8c12672e2016-04-07 07:29:14 +010063 GEN8_SEMAPHORE_OFFSET((__ring)->id, (to)))
Ben Widawsky3e789982014-06-30 09:53:37 -070064#define GEN8_WAIT_OFFSET(__ring, from) \
Chris Wilson51d545d2016-08-15 10:49:02 +010065 (dev_priv->semaphore->node.start + \
Chris Wilson8c12672e2016-04-07 07:29:14 +010066 GEN8_SEMAPHORE_OFFSET(from, (__ring)->id))
Ben Widawsky3e789982014-06-30 09:53:37 -070067
Chris Wilson7e37f882016-08-02 22:50:21 +010068enum intel_engine_hangcheck_action {
Mika Kuoppala3fe3b032016-11-18 15:09:04 +020069 ENGINE_IDLE = 0,
70 ENGINE_WAIT,
71 ENGINE_ACTIVE_SEQNO,
72 ENGINE_ACTIVE_HEAD,
73 ENGINE_ACTIVE_SUBUNITS,
74 ENGINE_WAIT_KICK,
75 ENGINE_DEAD,
Jani Nikulaf2f4d822013-08-11 12:44:01 +030076};
Mika Kuoppalaad8beae2013-06-12 12:35:32 +030077
Mika Kuoppala3fe3b032016-11-18 15:09:04 +020078static inline const char *
79hangcheck_action_to_str(const enum intel_engine_hangcheck_action a)
80{
81 switch (a) {
82 case ENGINE_IDLE:
83 return "idle";
84 case ENGINE_WAIT:
85 return "wait";
86 case ENGINE_ACTIVE_SEQNO:
87 return "active seqno";
88 case ENGINE_ACTIVE_HEAD:
89 return "active head";
90 case ENGINE_ACTIVE_SUBUNITS:
91 return "active subunits";
92 case ENGINE_WAIT_KICK:
93 return "wait kick";
94 case ENGINE_DEAD:
95 return "dead";
96 }
97
98 return "unknown";
99}
Mika Kuoppalab6b0fac2014-01-30 19:04:43 +0200100
Ben Widawskyf9e61372016-09-20 16:54:33 +0300101#define I915_MAX_SLICES 3
102#define I915_MAX_SUBSLICES 3
103
104#define instdone_slice_mask(dev_priv__) \
105 (INTEL_GEN(dev_priv__) == 7 ? \
106 1 : INTEL_INFO(dev_priv__)->sseu.slice_mask)
107
108#define instdone_subslice_mask(dev_priv__) \
109 (INTEL_GEN(dev_priv__) == 7 ? \
110 1 : INTEL_INFO(dev_priv__)->sseu.subslice_mask)
111
112#define for_each_instdone_slice_subslice(dev_priv__, slice__, subslice__) \
113 for ((slice__) = 0, (subslice__) = 0; \
114 (slice__) < I915_MAX_SLICES; \
115 (subslice__) = ((subslice__) + 1) < I915_MAX_SUBSLICES ? (subslice__) + 1 : 0, \
116 (slice__) += ((subslice__) == 0)) \
117 for_each_if((BIT(slice__) & instdone_slice_mask(dev_priv__)) && \
118 (BIT(subslice__) & instdone_subslice_mask(dev_priv__)))
119
Ben Widawskyd6369512016-09-20 16:54:32 +0300120struct intel_instdone {
121 u32 instdone;
122 /* The following exist only in the RCS engine */
123 u32 slice_common;
Ben Widawskyf9e61372016-09-20 16:54:33 +0300124 u32 sampler[I915_MAX_SLICES][I915_MAX_SUBSLICES];
125 u32 row[I915_MAX_SLICES][I915_MAX_SUBSLICES];
Ben Widawskyd6369512016-09-20 16:54:32 +0300126};
127
Chris Wilson7e37f882016-08-02 22:50:21 +0100128struct intel_engine_hangcheck {
Chris Wilson50877442014-03-21 12:41:53 +0000129 u64 acthd;
Mika Kuoppala92cab732013-05-24 17:16:07 +0300130 u32 seqno;
Chris Wilson7e37f882016-08-02 22:50:21 +0100131 enum intel_engine_hangcheck_action action;
Mika Kuoppala3fe3b032016-11-18 15:09:04 +0200132 unsigned long action_timestamp;
Chris Wilson4be17382014-06-06 10:22:29 +0100133 int deadlock;
Ben Widawskyd6369512016-09-20 16:54:32 +0300134 struct intel_instdone instdone;
Mika Kuoppala3fe3b032016-11-18 15:09:04 +0200135 bool stalled;
Mika Kuoppala92cab732013-05-24 17:16:07 +0300136};
137
Chris Wilson7e37f882016-08-02 22:50:21 +0100138struct intel_ring {
Tvrtko Ursulin0eb973d2016-01-15 15:10:28 +0000139 struct i915_vma *vma;
Chris Wilson57e88532016-08-15 10:48:57 +0100140 void *vaddr;
Oscar Mateo8ee14972014-05-22 14:13:34 +0100141
Tvrtko Ursulin4a570db2016-03-16 11:00:38 +0000142 struct intel_engine_cs *engine;
Daniel Vetter0c7dd532014-08-11 16:17:44 +0200143
Chris Wilson675d9ad2016-08-04 07:52:36 +0100144 struct list_head request_list;
145
Oscar Mateo8ee14972014-05-22 14:13:34 +0100146 u32 head;
147 u32 tail;
Chris Wilsoneca56a32017-02-06 17:05:01 +0000148
Oscar Mateo8ee14972014-05-22 14:13:34 +0100149 int space;
150 int size;
151 int effective_size;
152
153 /** We track the position of the requests in the ring buffer, and
154 * when each is retired we increment last_retired_head as the GPU
155 * must have finished processing the request and so we know we
156 * can advance the ringbuffer up to that position.
157 *
158 * last_retired_head is set to -1 after the value is consumed so
159 * we can detect new retirements.
160 */
161 u32 last_retired_head;
162};
163
Chris Wilsone2efd132016-05-24 14:53:34 +0100164struct i915_gem_context;
Jordan Justen361b0272016-03-06 23:30:27 -0800165struct drm_i915_reg_table;
Nick Hoath21076372015-01-15 13:10:38 +0000166
Arun Siluvery17ee9502015-06-19 19:07:01 +0100167/*
168 * we use a single page to load ctx workarounds so all of these
169 * values are referred in terms of dwords
170 *
171 * struct i915_wa_ctx_bb:
172 * offset: specifies batch starting position, also helpful in case
173 * if we want to have multiple batches at different offsets based on
174 * some criteria. It is not a requirement at the moment but provides
175 * an option for future use.
176 * size: size of the batch in DWORDS
177 */
Chris Wilson48bb74e2016-08-15 10:49:04 +0100178struct i915_ctx_workarounds {
Arun Siluvery17ee9502015-06-19 19:07:01 +0100179 struct i915_wa_ctx_bb {
180 u32 offset;
181 u32 size;
182 } indirect_ctx, per_ctx;
Chris Wilson48bb74e2016-08-15 10:49:04 +0100183 struct i915_vma *vma;
Arun Siluvery17ee9502015-06-19 19:07:01 +0100184};
185
Chris Wilsonc81d4612016-07-01 17:23:25 +0100186struct drm_i915_gem_request;
Chris Wilson4e50f082016-10-28 13:58:31 +0100187struct intel_render_state;
Chris Wilsonc81d4612016-07-01 17:23:25 +0100188
Chris Wilsonc0336662016-05-06 15:40:21 +0100189struct intel_engine_cs {
190 struct drm_i915_private *i915;
Zou Nan hai8187a2b2010-05-21 09:08:55 +0800191 const char *name;
Tvrtko Ursulin117897f2016-03-16 11:00:40 +0000192 enum intel_engine_id {
Tvrtko Ursulinde1add32016-01-15 15:12:50 +0000193 RCS = 0,
Daniel Vetter96154f22011-12-14 13:57:00 +0100194 BCS,
Tvrtko Ursulinde1add32016-01-15 15:12:50 +0000195 VCS,
196 VCS2, /* Keep instances of the same type engine together. */
197 VECS
Chris Wilson92204342010-09-18 11:02:01 +0100198 } id;
Tvrtko Ursulinde1add32016-01-15 15:12:50 +0000199#define _VCS(n) (VCS + (n))
Chris Wilson426960b2016-01-15 16:51:46 +0000200 unsigned int exec_id;
Tvrtko Ursulin5ec2cf72016-08-16 17:04:20 +0100201 enum intel_engine_hw_id {
202 RCS_HW = 0,
203 VCS_HW,
204 BCS_HW,
205 VECS_HW,
206 VCS2_HW
207 } hw_id;
208 enum intel_engine_hw_id guc_id; /* XXX same as hw_id? */
Daniel Vetter333e9fe2010-08-02 16:24:01 +0200209 u32 mmio_base;
Dave Gordonc2c7f242016-07-13 16:03:35 +0100210 unsigned int irq_shift;
Chris Wilson7e37f882016-08-02 22:50:21 +0100211 struct intel_ring *buffer;
Chris Wilson73cb9702016-10-28 13:58:46 +0100212 struct intel_timeline *timeline;
Zou Nan hai8187a2b2010-05-21 09:08:55 +0800213
Chris Wilson4e50f082016-10-28 13:58:31 +0100214 struct intel_render_state *render_state;
215
Chris Wilson2246bea2017-02-17 15:13:00 +0000216 atomic_t irq_count;
Chris Wilson538b2572017-01-24 15:18:05 +0000217 unsigned long irq_posted;
218#define ENGINE_IRQ_BREADCRUMB 0
Chris Wilsonf7470262017-01-24 15:20:21 +0000219#define ENGINE_IRQ_EXECLIST 1
Chris Wilson538b2572017-01-24 15:18:05 +0000220
Chris Wilson688e6c72016-07-01 17:23:15 +0100221 /* Rather than have every client wait upon all user interrupts,
222 * with the herd waking after every interrupt and each doing the
223 * heavyweight seqno dance, we delegate the task (of being the
224 * bottom-half of the user interrupt) to the first client. After
225 * every interrupt, we wake up one client, who does the heavyweight
226 * coherent seqno read and either goes back to sleep (if incomplete),
227 * or wakes up all the completed clients in parallel, before then
228 * transferring the bottom-half status to the next client in the queue.
229 *
230 * Compared to walking the entire list of waiters in a single dedicated
231 * bottom-half, we reduce the latency of the first waiter by avoiding
232 * a context switch, but incur additional coherent seqno reads when
233 * following the chain of request breadcrumbs. Since it is most likely
234 * that we have a single client waiting on each seqno, then reducing
235 * the overhead of waking that client is much preferred.
236 */
237 struct intel_breadcrumbs {
Chris Wilsondbd6ef22016-08-09 17:47:52 +0100238 struct task_struct __rcu *irq_seqno_bh; /* bh for interrupts */
Chris Wilsonaca34b62016-07-06 12:39:02 +0100239
Chris Wilsonf6168e32016-10-28 13:58:55 +0100240 spinlock_t lock; /* protects the lists of requests; irqsafe */
Chris Wilson688e6c72016-07-01 17:23:15 +0100241 struct rb_root waiters; /* sorted by retirement, priority */
Chris Wilsonc81d4612016-07-01 17:23:25 +0100242 struct rb_root signals; /* sorted by retirement */
Chris Wilson688e6c72016-07-01 17:23:15 +0100243 struct intel_wait *first_wait; /* oldest waiter by retirement */
Chris Wilsonc81d4612016-07-01 17:23:25 +0100244 struct task_struct *signaler; /* used for fence signalling */
Chris Wilsoncced5e22017-02-23 07:44:15 +0000245 struct drm_i915_gem_request __rcu *first_signal;
Chris Wilson688e6c72016-07-01 17:23:15 +0100246 struct timer_list fake_irq; /* used after a missed interrupt */
Chris Wilson83348ba2016-08-09 17:47:51 +0100247 struct timer_list hangcheck; /* detect missed interrupts */
248
Chris Wilson2246bea2017-02-17 15:13:00 +0000249 unsigned int hangcheck_interrupts;
Chris Wilsonaca34b62016-07-06 12:39:02 +0100250
251 bool irq_enabled : 1;
252 bool rpm_wakelock : 1;
Chris Wilsonf97fbf92017-02-13 17:15:14 +0000253 I915_SELFTEST_DECLARE(bool mock : 1);
Chris Wilson688e6c72016-07-01 17:23:15 +0100254 } breadcrumbs;
255
Chris Wilson06fbca72015-04-07 16:20:36 +0100256 /*
257 * A pool of objects to use as shadow copies of client batch buffers
258 * when the command parser is enabled. Prevents the client from
259 * modifying the batch contents after software parsing.
260 */
261 struct i915_gem_batch_pool batch_pool;
262
Zou Nan hai8187a2b2010-05-21 09:08:55 +0800263 struct intel_hw_status_page status_page;
Arun Siluvery17ee9502015-06-19 19:07:01 +0100264 struct i915_ctx_workarounds wa_ctx;
Chris Wilson56c0f1a2016-08-15 10:48:58 +0100265 struct i915_vma *scratch;
Zou Nan hai8187a2b2010-05-21 09:08:55 +0800266
Chris Wilson61ff75a2016-07-01 17:23:28 +0100267 u32 irq_keep_mask; /* always keep these interrupts */
268 u32 irq_enable_mask; /* bitmask to enable ring interrupt */
Dave Gordon38a0f2d2016-07-20 18:16:06 +0100269 void (*irq_enable)(struct intel_engine_cs *engine);
270 void (*irq_disable)(struct intel_engine_cs *engine);
Zou Nan hai8187a2b2010-05-21 09:08:55 +0800271
Dave Gordon38a0f2d2016-07-20 18:16:06 +0100272 int (*init_hw)(struct intel_engine_cs *engine);
Chris Wilson821ed7d2016-09-09 14:11:53 +0100273 void (*reset_hw)(struct intel_engine_cs *engine,
274 struct drm_i915_gem_request *req);
Zou Nan hai8187a2b2010-05-21 09:08:55 +0800275
Chris Wilsone8a9c582016-12-18 15:37:20 +0000276 int (*context_pin)(struct intel_engine_cs *engine,
277 struct i915_gem_context *ctx);
278 void (*context_unpin)(struct intel_engine_cs *engine,
279 struct i915_gem_context *ctx);
Chris Wilsonf73e7392016-12-18 15:37:24 +0000280 int (*request_alloc)(struct drm_i915_gem_request *req);
John Harrison87531812015-05-29 17:43:44 +0100281 int (*init_context)(struct drm_i915_gem_request *req);
Arun Siluvery86d7f232014-08-26 14:44:50 +0100282
Chris Wilsonddd66c52016-08-02 22:50:31 +0100283 int (*emit_flush)(struct drm_i915_gem_request *request,
284 u32 mode);
285#define EMIT_INVALIDATE BIT(0)
286#define EMIT_FLUSH BIT(1)
287#define EMIT_BARRIER (EMIT_INVALIDATE | EMIT_FLUSH)
288 int (*emit_bb_start)(struct drm_i915_gem_request *req,
289 u64 offset, u32 length,
290 unsigned int dispatch_flags);
291#define I915_DISPATCH_SECURE BIT(0)
292#define I915_DISPATCH_PINNED BIT(1)
293#define I915_DISPATCH_RS BIT(2)
Chris Wilsoncaddfe72016-10-28 13:58:52 +0100294 void (*emit_breadcrumb)(struct drm_i915_gem_request *req,
Tvrtko Ursulin73dec952017-02-14 11:32:42 +0000295 u32 *cs);
Chris Wilson98f29e82016-10-28 13:58:51 +0100296 int emit_breadcrumb_sz;
Chris Wilson5590af32016-09-09 14:11:54 +0100297
298 /* Pass the request to the hardware queue (e.g. directly into
299 * the legacy ringbuffer or to the end of an execlist).
300 *
301 * This is called from an atomic context with irqs disabled; must
302 * be irq safe.
303 */
Chris Wilsonddd66c52016-08-02 22:50:31 +0100304 void (*submit_request)(struct drm_i915_gem_request *req);
Chris Wilson5590af32016-09-09 14:11:54 +0100305
Chris Wilson0de91362016-11-14 20:41:01 +0000306 /* Call when the priority on a request has changed and it and its
307 * dependencies may need rescheduling. Note the request itself may
308 * not be ready to run!
309 *
310 * Called under the struct_mutex.
311 */
312 void (*schedule)(struct drm_i915_gem_request *request,
313 int priority);
314
Chris Wilsonb2eadbc2012-08-09 10:58:30 +0100315 /* Some chipsets are not quite as coherent as advertised and need
316 * an expensive kick to force a true read of the up-to-date seqno.
317 * However, the up-to-date seqno is not always required and the last
318 * seen value is good enough. Note that the seqno will always be
319 * monotonic, even if not coherent.
320 */
Dave Gordon38a0f2d2016-07-20 18:16:06 +0100321 void (*irq_seqno_barrier)(struct intel_engine_cs *engine);
Dave Gordon38a0f2d2016-07-20 18:16:06 +0100322 void (*cleanup)(struct intel_engine_cs *engine);
Ben Widawskyebc348b2014-04-29 14:52:28 -0700323
Ben Widawsky3e789982014-06-30 09:53:37 -0700324 /* GEN8 signal/wait table - never trust comments!
325 * signal to signal to signal to signal to signal to
326 * RCS VCS BCS VECS VCS2
327 * --------------------------------------------------------------------
328 * RCS | NOP (0x00) | VCS (0x08) | BCS (0x10) | VECS (0x18) | VCS2 (0x20) |
329 * |-------------------------------------------------------------------
330 * VCS | RCS (0x28) | NOP (0x30) | BCS (0x38) | VECS (0x40) | VCS2 (0x48) |
331 * |-------------------------------------------------------------------
332 * BCS | RCS (0x50) | VCS (0x58) | NOP (0x60) | VECS (0x68) | VCS2 (0x70) |
333 * |-------------------------------------------------------------------
334 * VECS | RCS (0x78) | VCS (0x80) | BCS (0x88) | NOP (0x90) | VCS2 (0x98) |
335 * |-------------------------------------------------------------------
336 * VCS2 | RCS (0xa0) | VCS (0xa8) | BCS (0xb0) | VECS (0xb8) | NOP (0xc0) |
337 * |-------------------------------------------------------------------
338 *
339 * Generalization:
340 * f(x, y) := (x->id * NUM_RINGS * seqno_size) + (seqno_size * y->id)
341 * ie. transpose of g(x, y)
342 *
343 * sync from sync from sync from sync from sync from
344 * RCS VCS BCS VECS VCS2
345 * --------------------------------------------------------------------
346 * RCS | NOP (0x00) | VCS (0x28) | BCS (0x50) | VECS (0x78) | VCS2 (0xa0) |
347 * |-------------------------------------------------------------------
348 * VCS | RCS (0x08) | NOP (0x30) | BCS (0x58) | VECS (0x80) | VCS2 (0xa8) |
349 * |-------------------------------------------------------------------
350 * BCS | RCS (0x10) | VCS (0x38) | NOP (0x60) | VECS (0x88) | VCS2 (0xb0) |
351 * |-------------------------------------------------------------------
352 * VECS | RCS (0x18) | VCS (0x40) | BCS (0x68) | NOP (0x90) | VCS2 (0xb8) |
353 * |-------------------------------------------------------------------
354 * VCS2 | RCS (0x20) | VCS (0x48) | BCS (0x70) | VECS (0x98) | NOP (0xc0) |
355 * |-------------------------------------------------------------------
356 *
357 * Generalization:
358 * g(x, y) := (y->id * NUM_RINGS * seqno_size) + (seqno_size * x->id)
359 * ie. transpose of f(x, y)
360 */
Ben Widawskyebc348b2014-04-29 14:52:28 -0700361 struct {
Ben Widawsky3e789982014-06-30 09:53:37 -0700362 union {
Tvrtko Ursulin318f89c2016-08-16 17:04:21 +0100363#define GEN6_SEMAPHORE_LAST VECS_HW
364#define GEN6_NUM_SEMAPHORES (GEN6_SEMAPHORE_LAST + 1)
365#define GEN6_SEMAPHORES_MASK GENMASK(GEN6_SEMAPHORE_LAST, 0)
Ben Widawsky3e789982014-06-30 09:53:37 -0700366 struct {
367 /* our mbox written by others */
Tvrtko Ursulin318f89c2016-08-16 17:04:21 +0100368 u32 wait[GEN6_NUM_SEMAPHORES];
Ben Widawsky3e789982014-06-30 09:53:37 -0700369 /* mboxes this ring signals to */
Tvrtko Ursulin318f89c2016-08-16 17:04:21 +0100370 i915_reg_t signal[GEN6_NUM_SEMAPHORES];
Ben Widawsky3e789982014-06-30 09:53:37 -0700371 } mbox;
Tvrtko Ursulin666796d2016-03-16 11:00:39 +0000372 u64 signal_ggtt[I915_NUM_ENGINES];
Ben Widawsky3e789982014-06-30 09:53:37 -0700373 };
Ben Widawsky78325f22014-04-29 14:52:29 -0700374
375 /* AKA wait() */
Chris Wilsonad7bdb22016-08-02 22:50:40 +0100376 int (*sync_to)(struct drm_i915_gem_request *req,
377 struct drm_i915_gem_request *signal);
Tvrtko Ursulin73dec952017-02-14 11:32:42 +0000378 u32 *(*signal)(struct drm_i915_gem_request *req, u32 *cs);
Ben Widawskyebc348b2014-04-29 14:52:28 -0700379 } semaphore;
Ben Widawskyad776f82013-05-28 19:22:18 -0700380
Oscar Mateo4da46e12014-07-24 17:04:27 +0100381 /* Execlists */
Tvrtko Ursulin27af5ee2016-04-04 12:11:56 +0100382 struct tasklet_struct irq_tasklet;
Chris Wilson70c2a242016-09-09 14:11:46 +0100383 struct execlist_port {
384 struct drm_i915_gem_request *request;
385 unsigned int count;
Chris Wilsonae9a0432017-02-07 10:23:19 +0000386 GEM_DEBUG_DECL(u32 context_id);
Chris Wilson70c2a242016-09-09 14:11:46 +0100387 } execlist_port[2];
Chris Wilson20311bd2016-11-14 20:41:03 +0000388 struct rb_root execlist_queue;
389 struct rb_node *execlist_first;
Tvrtko Ursulin37566852016-04-12 14:37:31 +0100390 unsigned int fw_domains;
Oscar Mateo4da46e12014-07-24 17:04:27 +0100391
Chris Wilsone8a9c582016-12-18 15:37:20 +0000392 /* Contexts are pinned whilst they are active on the GPU. The last
393 * context executed remains active whilst the GPU is idle - the
394 * switch away and write to the context object only occurs on the
395 * next execution. Contexts are only unpinned on retirement of the
396 * following request ensuring that we can always write to the object
397 * on the context switch even after idling. Across suspend, we switch
398 * to the kernel context and trash it as the save may not happen
399 * before the hardware is powered down.
400 */
401 struct i915_gem_context *last_retired_context;
402
403 /* We track the current MI_SET_CONTEXT in order to eliminate
404 * redudant context switches. This presumes that requests are not
405 * reordered! Or when they are the tracking is updated along with
406 * the emission of individual requests into the legacy command
407 * stream (ring).
408 */
409 struct i915_gem_context *legacy_active_context;
Ben Widawsky40521052012-06-04 14:42:43 -0700410
Chris Wilson7e37f882016-08-02 22:50:21 +0100411 struct intel_engine_hangcheck hangcheck;
Mika Kuoppala92cab732013-05-24 17:16:07 +0300412
Brad Volkin44e895a2014-05-10 14:10:43 -0700413 bool needs_cmd_parser;
414
Brad Volkin351e3db2014-02-18 10:15:46 -0800415 /*
Brad Volkin44e895a2014-05-10 14:10:43 -0700416 * Table of commands the command parser needs to know about
Chris Wilson33a051a2016-07-27 09:07:26 +0100417 * for this engine.
Brad Volkin351e3db2014-02-18 10:15:46 -0800418 */
Brad Volkin44e895a2014-05-10 14:10:43 -0700419 DECLARE_HASHTABLE(cmd_hash, I915_CMD_HASH_ORDER);
Brad Volkin351e3db2014-02-18 10:15:46 -0800420
421 /*
422 * Table of registers allowed in commands that read/write registers.
423 */
Jordan Justen361b0272016-03-06 23:30:27 -0800424 const struct drm_i915_reg_table *reg_tables;
425 int reg_table_count;
Brad Volkin351e3db2014-02-18 10:15:46 -0800426
427 /*
428 * Returns the bitmask for the length field of the specified command.
429 * Return 0 for an unrecognized/invalid command.
430 *
Chris Wilson33a051a2016-07-27 09:07:26 +0100431 * If the command parser finds an entry for a command in the engine's
Brad Volkin351e3db2014-02-18 10:15:46 -0800432 * cmd_tables, it gets the command's length based on the table entry.
Chris Wilson33a051a2016-07-27 09:07:26 +0100433 * If not, it calls this function to determine the per-engine length
434 * field encoding for the command (i.e. different opcode ranges use
435 * certain bits to encode the command length in the header).
Brad Volkin351e3db2014-02-18 10:15:46 -0800436 */
437 u32 (*get_cmd_length_mask)(u32 cmd_header);
Zou Nan hai8187a2b2010-05-21 09:08:55 +0800438};
439
Daniel Vetter96154f22011-12-14 13:57:00 +0100440static inline unsigned
Chris Wilson67d97da2016-07-04 08:08:31 +0100441intel_engine_flag(const struct intel_engine_cs *engine)
Daniel Vetter96154f22011-12-14 13:57:00 +0100442{
Tvrtko Ursulin0bc40be2016-03-16 11:00:37 +0000443 return 1 << engine->id;
Daniel Vetter96154f22011-12-14 13:57:00 +0100444}
445
Imre Deak319404d2015-08-14 18:35:27 +0300446static inline void
Tvrtko Ursulin0bc40be2016-03-16 11:00:37 +0000447intel_flush_status_page(struct intel_engine_cs *engine, int reg)
Imre Deak319404d2015-08-14 18:35:27 +0300448{
Chris Wilson0d317ce2016-04-09 10:57:56 +0100449 mb();
450 clflush(&engine->status_page.page_addr[reg]);
451 mb();
Imre Deak319404d2015-08-14 18:35:27 +0300452}
453
Chris Wilson1ec14ad2010-12-04 11:30:53 +0000454static inline u32
Chris Wilson5dd8e502016-04-09 10:57:57 +0100455intel_read_status_page(struct intel_engine_cs *engine, int reg)
Zou Nan hai8187a2b2010-05-21 09:08:55 +0800456{
Daniel Vetter4225d0f2012-04-26 23:28:16 +0200457 /* Ensure that the compiler doesn't optimize away the load. */
Chris Wilson5dd8e502016-04-09 10:57:57 +0100458 return READ_ONCE(engine->status_page.page_addr[reg]);
Zou Nan hai8187a2b2010-05-21 09:08:55 +0800459}
460
Mika Kuoppalab70ec5b2012-12-19 11:13:05 +0200461static inline void
Tvrtko Ursulin0bc40be2016-03-16 11:00:37 +0000462intel_write_status_page(struct intel_engine_cs *engine,
Mika Kuoppalab70ec5b2012-12-19 11:13:05 +0200463 int reg, u32 value)
464{
Tvrtko Ursulin0bc40be2016-03-16 11:00:37 +0000465 engine->status_page.page_addr[reg] = value;
Mika Kuoppalab70ec5b2012-12-19 11:13:05 +0200466}
467
Jani Nikulae2828912016-01-18 09:19:47 +0200468/*
Chris Wilson311bd682011-01-13 19:06:50 +0000469 * Reads a dword out of the status page, which is written to from the command
470 * queue by automatic updates, MI_REPORT_HEAD, MI_STORE_DATA_INDEX, or
471 * MI_STORE_DATA_IMM.
472 *
473 * The following dwords have a reserved meaning:
474 * 0x00: ISR copy, updated when an ISR bit not set in the HWSTAM changes.
475 * 0x04: ring 0 head pointer
476 * 0x05: ring 1 head pointer (915-class)
477 * 0x06: ring 2 head pointer (915-class)
478 * 0x10-0x1b: Context status DWords (GM45)
479 * 0x1f: Last written status offset. (GM45)
Thomas Danielb07da532015-02-18 11:48:21 +0000480 * 0x20-0x2f: Reserved (Gen6+)
Chris Wilson311bd682011-01-13 19:06:50 +0000481 *
Thomas Danielb07da532015-02-18 11:48:21 +0000482 * The area from dword 0x30 to 0x3ff is available for driver usage.
Chris Wilson311bd682011-01-13 19:06:50 +0000483 */
Thomas Danielb07da532015-02-18 11:48:21 +0000484#define I915_GEM_HWS_INDEX 0x30
Chris Wilson7c17d372016-01-20 15:43:35 +0200485#define I915_GEM_HWS_INDEX_ADDR (I915_GEM_HWS_INDEX << MI_STORE_DWORD_INDEX_SHIFT)
Thomas Danielb07da532015-02-18 11:48:21 +0000486#define I915_GEM_HWS_SCRATCH_INDEX 0x40
Jesse Barnes9a289772012-10-26 09:42:42 -0700487#define I915_GEM_HWS_SCRATCH_ADDR (I915_GEM_HWS_SCRATCH_INDEX << MI_STORE_DWORD_INDEX_SHIFT)
Chris Wilson311bd682011-01-13 19:06:50 +0000488
Chris Wilson7e37f882016-08-02 22:50:21 +0100489struct intel_ring *
490intel_engine_create_ring(struct intel_engine_cs *engine, int size);
Daniele Ceraolo Spuriod3ef1af2016-12-23 15:56:21 -0800491int intel_ring_pin(struct intel_ring *ring, unsigned int offset_bias);
Chris Wilsonaad29fb2016-08-02 22:50:23 +0100492void intel_ring_unpin(struct intel_ring *ring);
Chris Wilson7e37f882016-08-02 22:50:21 +0100493void intel_ring_free(struct intel_ring *ring);
Oscar Mateo84c23772014-07-24 17:04:15 +0100494
Chris Wilson7e37f882016-08-02 22:50:21 +0100495void intel_engine_stop(struct intel_engine_cs *engine);
496void intel_engine_cleanup(struct intel_engine_cs *engine);
Ben Widawsky96f298a2011-03-19 18:14:27 -0700497
Chris Wilson821ed7d2016-09-09 14:11:53 +0100498void intel_legacy_submission_resume(struct drm_i915_private *dev_priv);
499
John Harrisonbba09b12015-05-29 17:44:06 +0100500int __must_check intel_ring_cacheline_align(struct drm_i915_gem_request *req);
Chris Wilson406ea8d2016-07-20 13:31:55 +0100501
Tvrtko Ursulin73dec952017-02-14 11:32:42 +0000502u32 __must_check *intel_ring_begin(struct drm_i915_gem_request *req, int n);
Chris Wilson406ea8d2016-07-20 13:31:55 +0100503
Tvrtko Ursulin73dec952017-02-14 11:32:42 +0000504static inline void
505intel_ring_advance(struct drm_i915_gem_request *req, u32 *cs)
Chris Wilson09246732013-08-10 22:16:32 +0100506{
Chris Wilson8f942012016-08-02 22:50:30 +0100507 /* Dummy function.
508 *
509 * This serves as a placeholder in the code so that the reader
510 * can compare against the preceding intel_ring_begin() and
511 * check that the number of dwords emitted matches the space
512 * reserved for the command packet (i.e. the value passed to
513 * intel_ring_begin()).
Chris Wilsonc5efa1a2016-08-02 22:50:29 +0100514 */
Tvrtko Ursulin73dec952017-02-14 11:32:42 +0000515 GEM_BUG_ON((req->ring->vaddr + req->ring->tail) != cs);
Chris Wilson8f942012016-08-02 22:50:30 +0100516}
517
Tvrtko Ursulin73dec952017-02-14 11:32:42 +0000518static inline u32
519intel_ring_offset(struct drm_i915_gem_request *req, void *addr)
Chris Wilson8f942012016-08-02 22:50:30 +0100520{
521 /* Don't write ring->size (equivalent to 0) as that hangs some GPUs. */
Tvrtko Ursulin73dec952017-02-14 11:32:42 +0000522 u32 offset = addr - req->ring->vaddr;
523 GEM_BUG_ON(offset > req->ring->size);
524 return offset & (req->ring->size - 1);
Chris Wilson09246732013-08-10 22:16:32 +0100525}
Chris Wilson406ea8d2016-07-20 13:31:55 +0100526
Chris Wilson32c04f12016-08-02 22:50:22 +0100527void intel_ring_update_space(struct intel_ring *ring);
Chris Wilson09246732013-08-10 22:16:32 +0100528
Chris Wilson73cb9702016-10-28 13:58:46 +0100529void intel_engine_init_global_seqno(struct intel_engine_cs *engine, u32 seqno);
Zou Nan hai8187a2b2010-05-21 09:08:55 +0800530
Tvrtko Ursulin019bf272016-07-13 16:03:41 +0100531void intel_engine_setup_common(struct intel_engine_cs *engine);
532int intel_engine_init_common(struct intel_engine_cs *engine);
Chris Wilsonadc320c2016-08-15 10:48:59 +0100533int intel_engine_create_scratch(struct intel_engine_cs *engine, int size);
Chris Wilson96a945a2016-08-03 13:19:16 +0100534void intel_engine_cleanup_common(struct intel_engine_cs *engine);
Tvrtko Ursulin019bf272016-07-13 16:03:41 +0100535
Tvrtko Ursulin8b3e2d32016-07-13 16:03:37 +0100536int intel_init_render_ring_buffer(struct intel_engine_cs *engine);
537int intel_init_bsd_ring_buffer(struct intel_engine_cs *engine);
538int intel_init_bsd2_ring_buffer(struct intel_engine_cs *engine);
539int intel_init_blt_ring_buffer(struct intel_engine_cs *engine);
540int intel_init_vebox_ring_buffer(struct intel_engine_cs *engine);
Zou Nan hai8187a2b2010-05-21 09:08:55 +0800541
Chris Wilson7e37f882016-08-02 22:50:21 +0100542u64 intel_engine_get_active_head(struct intel_engine_cs *engine);
Chris Wilson1b365952016-10-04 21:11:31 +0100543u64 intel_engine_get_last_batch_head(struct intel_engine_cs *engine);
544
Chris Wilson1b7744e2016-07-01 17:23:17 +0100545static inline u32 intel_engine_get_seqno(struct intel_engine_cs *engine)
546{
547 return intel_read_status_page(engine, I915_GEM_HWS_INDEX);
548}
Daniel Vetter79f321b2010-09-24 21:20:10 +0200549
Chris Wilsoncb399ea2016-11-01 10:03:16 +0000550static inline u32 intel_engine_last_submit(struct intel_engine_cs *engine)
551{
552 /* We are only peeking at the tail of the submit queue (and not the
553 * queue itself) in order to gain a hint as to the current active
554 * state of the engine. Callers are not expected to be taking
555 * engine->timeline->lock, nor are they expected to be concerned
556 * wtih serialising this hint with anything, so document it as
557 * a hint and nothing more.
558 */
Chris Wilson9b6586a2017-02-23 07:44:08 +0000559 return READ_ONCE(engine->timeline->seqno);
Chris Wilsoncb399ea2016-11-01 10:03:16 +0000560}
561
Tvrtko Ursulin0bc40be2016-03-16 11:00:37 +0000562int init_workarounds_ring(struct intel_engine_cs *engine);
Tvrtko Ursulin4ac96592017-02-14 15:00:17 +0000563int intel_ring_workarounds_emit(struct drm_i915_gem_request *req);
Michel Thierry771b9a52014-11-11 16:47:33 +0000564
Chris Wilson0e704472016-10-12 10:05:17 +0100565void intel_engine_get_instdone(struct intel_engine_cs *engine,
566 struct intel_instdone *instdone);
567
John Harrison29b1b412015-06-18 13:10:09 +0100568/*
569 * Arbitrary size for largest possible 'add request' sequence. The code paths
570 * are complex and variable. Empirical measurement shows that the worst case
Chris Wilson596e5ef2016-04-29 09:07:04 +0100571 * is BDW at 192 bytes (6 + 6 + 36 dwords), then ILK at 136 bytes. However,
572 * we need to allocate double the largest single packet within that emission
573 * to account for tail wraparound (so 6 + 6 + 72 dwords for BDW).
John Harrison29b1b412015-06-18 13:10:09 +0100574 */
Chris Wilson596e5ef2016-04-29 09:07:04 +0100575#define MIN_SPACE_FOR_ADD_REQUEST 336
John Harrison29b1b412015-06-18 13:10:09 +0100576
Chris Wilsona58c01a2016-04-29 13:18:21 +0100577static inline u32 intel_hws_seqno_address(struct intel_engine_cs *engine)
578{
Chris Wilson57e88532016-08-15 10:48:57 +0100579 return engine->status_page.ggtt_offset + I915_GEM_HWS_INDEX_ADDR;
Chris Wilsona58c01a2016-04-29 13:18:21 +0100580}
581
Chris Wilson688e6c72016-07-01 17:23:15 +0100582/* intel_breadcrumbs.c -- user interrupt bottom-half for waiters */
Chris Wilson688e6c72016-07-01 17:23:15 +0100583int intel_engine_init_breadcrumbs(struct intel_engine_cs *engine);
584
Chris Wilson754c9fd2017-02-23 07:44:14 +0000585static inline void intel_wait_init(struct intel_wait *wait)
586{
587 wait->tsk = current;
588}
589
590static inline void intel_wait_init_for_seqno(struct intel_wait *wait, u32 seqno)
Chris Wilson688e6c72016-07-01 17:23:15 +0100591{
592 wait->tsk = current;
593 wait->seqno = seqno;
594}
595
Chris Wilson754c9fd2017-02-23 07:44:14 +0000596static inline bool intel_wait_has_seqno(const struct intel_wait *wait)
597{
598 return wait->seqno;
599}
600
601static inline bool
602intel_wait_update_seqno(struct intel_wait *wait, u32 seqno)
603{
604 wait->seqno = seqno;
605 return intel_wait_has_seqno(wait);
606}
607
608static inline bool
609intel_wait_update_request(struct intel_wait *wait,
610 const struct drm_i915_gem_request *rq)
611{
612 return intel_wait_update_seqno(wait, i915_gem_request_global_seqno(rq));
613}
614
615static inline bool
616intel_wait_check_seqno(const struct intel_wait *wait, u32 seqno)
617{
618 return wait->seqno == seqno;
619}
620
621static inline bool
622intel_wait_check_request(const struct intel_wait *wait,
623 const struct drm_i915_gem_request *rq)
624{
625 return intel_wait_check_seqno(wait, i915_gem_request_global_seqno(rq));
626}
627
Chris Wilson688e6c72016-07-01 17:23:15 +0100628static inline bool intel_wait_complete(const struct intel_wait *wait)
629{
630 return RB_EMPTY_NODE(&wait->node);
631}
632
633bool intel_engine_add_wait(struct intel_engine_cs *engine,
634 struct intel_wait *wait);
635void intel_engine_remove_wait(struct intel_engine_cs *engine,
636 struct intel_wait *wait);
Chris Wilsonb3850852016-07-01 17:23:26 +0100637void intel_engine_enable_signaling(struct drm_i915_gem_request *request);
Chris Wilson9eb143b2017-02-23 07:44:16 +0000638void intel_engine_cancel_signaling(struct drm_i915_gem_request *request);
Chris Wilson688e6c72016-07-01 17:23:15 +0100639
Chris Wilsondbd6ef22016-08-09 17:47:52 +0100640static inline bool intel_engine_has_waiter(const struct intel_engine_cs *engine)
Chris Wilson688e6c72016-07-01 17:23:15 +0100641{
Chris Wilsondbd6ef22016-08-09 17:47:52 +0100642 return rcu_access_pointer(engine->breadcrumbs.irq_seqno_bh);
Chris Wilson688e6c72016-07-01 17:23:15 +0100643}
644
Chris Wilsondbd6ef22016-08-09 17:47:52 +0100645static inline bool intel_engine_wakeup(const struct intel_engine_cs *engine)
Chris Wilson688e6c72016-07-01 17:23:15 +0100646{
647 bool wakeup = false;
Chris Wilsondbd6ef22016-08-09 17:47:52 +0100648
Chris Wilson688e6c72016-07-01 17:23:15 +0100649 /* Note that for this not to dangerously chase a dangling pointer,
Chris Wilsondbd6ef22016-08-09 17:47:52 +0100650 * we must hold the rcu_read_lock here.
Chris Wilson688e6c72016-07-01 17:23:15 +0100651 *
652 * Also note that tsk is likely to be in !TASK_RUNNING state so an
653 * early test for tsk->state != TASK_RUNNING before wake_up_process()
654 * is unlikely to be beneficial.
655 */
Chris Wilsondbd6ef22016-08-09 17:47:52 +0100656 if (intel_engine_has_waiter(engine)) {
657 struct task_struct *tsk;
658
659 rcu_read_lock();
660 tsk = rcu_dereference(engine->breadcrumbs.irq_seqno_bh);
661 if (tsk)
662 wakeup = wake_up_process(tsk);
663 rcu_read_unlock();
664 }
665
Chris Wilson688e6c72016-07-01 17:23:15 +0100666 return wakeup;
667}
668
Chris Wilsonad07dfc2016-10-07 07:53:26 +0100669void intel_engine_reset_breadcrumbs(struct intel_engine_cs *engine);
Chris Wilson688e6c72016-07-01 17:23:15 +0100670void intel_engine_fini_breadcrumbs(struct intel_engine_cs *engine);
Chris Wilson9b6586a2017-02-23 07:44:08 +0000671bool intel_breadcrumbs_busy(struct intel_engine_cs *engine);
Chris Wilson688e6c72016-07-01 17:23:15 +0100672
Tvrtko Ursulin9f235df2017-02-16 12:23:25 +0000673static inline u32 *gen8_emit_pipe_control(u32 *batch, u32 flags, u32 offset)
674{
675 memset(batch, 0, 6 * sizeof(u32));
676
677 batch[0] = GFX_OP_PIPE_CONTROL(6);
678 batch[1] = flags;
679 batch[2] = offset;
680
681 return batch + 6;
682}
683
Zou Nan hai8187a2b2010-05-21 09:08:55 +0800684#endif /* _INTEL_RINGBUFFER_H_ */