1 /* SPDX-License-Identifier: MIT */
2 /*
3 * Copyright © 2019 Intel Corporation
4 */
5
6 #ifndef __INTEL_ENGINE_TYPES__
7 #define __INTEL_ENGINE_TYPES__
8
9 #include <linux/average.h>
10 #include <linux/hashtable.h>
11 #include <linux/irq_work.h>
12 #include <linux/kref.h>
13 #include <linux/list.h>
14 #include <linux/llist.h>
15 #include <linux/rbtree.h>
16 #include <linux/timer.h>
17 #include <linux/types.h>
18 #include <linux/workqueue.h>
19
20 #include "i915_gem.h"
21 #include "i915_pmu.h"
22 #include "i915_priolist_types.h"
23 #include "i915_selftest.h"
24 #include "intel_sseu.h"
25 #include "intel_timeline_types.h"
26 #include "intel_uncore.h"
27 #include "intel_wakeref.h"
28 #include "intel_workarounds_types.h"
29
30 /* HW Engine class + instance */
31 #define RENDER_CLASS 0
32 #define VIDEO_DECODE_CLASS 1
33 #define VIDEO_ENHANCEMENT_CLASS 2
34 #define COPY_ENGINE_CLASS 3
35 #define OTHER_CLASS 4
36 #define COMPUTE_CLASS 5
37 #define MAX_ENGINE_CLASS 5
38 #define MAX_ENGINE_INSTANCE 8
39
40 #define I915_MAX_SLICES 3
41 #define I915_MAX_SUBSLICES 8
42
43 #define I915_CMD_HASH_ORDER 9
44
45 struct dma_fence;
46 struct drm_i915_gem_object;
47 struct drm_i915_reg_table;
48 struct i915_gem_context;
49 struct i915_request;
50 struct i915_sched_attr;
51 struct i915_sched_engine;
52 struct intel_gt;
53 struct intel_ring;
54 struct intel_uncore;
55 struct intel_breadcrumbs;
56 struct intel_engine_cs;
57 struct i915_perf_group;
58
59 typedef u32 intel_engine_mask_t;
60 #define ALL_ENGINES ((intel_engine_mask_t)~0ul)
61 #define VIRTUAL_ENGINES BIT(BITS_PER_TYPE(intel_engine_mask_t) - 1)
62
63 struct intel_hw_status_page {
64 struct list_head timelines;
65 struct i915_vma *vma;
66 u32 *addr;
67 };
68
69 struct intel_instdone {
70 u32 instdone;
71 /* The following exist only in the RCS engine */
72 u32 slice_common;
73 u32 slice_common_extra[2];
74 u32 sampler[GEN_MAX_GSLICES][I915_MAX_SUBSLICES];
75 u32 row[GEN_MAX_GSLICES][I915_MAX_SUBSLICES];
76
77 /* Added in XeHPG */
78 u32 geom_svg[GEN_MAX_GSLICES][I915_MAX_SUBSLICES];
79 };
80
81 /*
82 * we use a single page to load ctx workarounds so all of these
83 * values are referred in terms of dwords
84 *
85 * struct i915_wa_ctx_bb:
86 * offset: specifies batch starting position, also helpful in case
87 * if we want to have multiple batches at different offsets based on
88 * some criteria. It is not a requirement at the moment but provides
89 * an option for future use.
90 * size: size of the batch in DWORDS
91 */
92 struct i915_ctx_workarounds {
93 struct i915_wa_ctx_bb {
94 u32 offset;
95 u32 size;
96 } indirect_ctx, per_ctx;
97 struct i915_vma *vma;
98 };
99
100 #define I915_MAX_VCS 8
101 #define I915_MAX_VECS 4
102 #define I915_MAX_SFC (I915_MAX_VCS / 2)
103 #define I915_MAX_CCS 4
104 #define I915_MAX_RCS 1
105 #define I915_MAX_BCS 9
106
107 /*
108 * Engine IDs definitions.
109 * Keep instances of the same type engine together.
110 */
111 enum intel_engine_id {
112 RCS0 = 0,
113 BCS0,
114 BCS1,
115 BCS2,
116 BCS3,
117 BCS4,
118 BCS5,
119 BCS6,
120 BCS7,
121 BCS8,
122 #define _BCS(n) (BCS0 + (n))
123 VCS0,
124 VCS1,
125 VCS2,
126 VCS3,
127 VCS4,
128 VCS5,
129 VCS6,
130 VCS7,
131 #define _VCS(n) (VCS0 + (n))
132 VECS0,
133 VECS1,
134 VECS2,
135 VECS3,
136 #define _VECS(n) (VECS0 + (n))
137 CCS0,
138 CCS1,
139 CCS2,
140 CCS3,
141 #define _CCS(n) (CCS0 + (n))
142 GSC0,
143 I915_NUM_ENGINES
144 #define INVALID_ENGINE ((enum intel_engine_id)-1)
145 };
146
147 /* A simple estimator for the round-trip latency of an engine */
148 DECLARE_EWMA(_engine_latency, 6, 4)
149
150 struct st_preempt_hang {
151 struct completion completion;
152 unsigned int count;
153 };
154
155 /**
156 * struct intel_engine_execlists - execlist submission queue and port state
157 *
158 * The struct intel_engine_execlists represents the combined logical state of
159 * driver and the hardware state for execlist mode of submission.
160 */
161 struct intel_engine_execlists {
162 /**
163 * @timer: kick the current context if its timeslice expires
164 */
165 struct timeout timer;
166
167 /**
168 * @preempt: reset the current context if it fails to give way
169 */
170 struct timeout preempt;
171
172 /**
173 * @preempt_target: active request at the time of the preemption request
174 *
175 * We force a preemption to occur if the pending contexts have not
176 * been promoted to active upon receipt of the CS ack event within
177 * the timeout. This timeout maybe chosen based on the target,
178 * using a very short timeout if the context is no longer schedulable.
179 * That short timeout may not be applicable to other contexts, so
180 * if a context switch should happen within before the preemption
181 * timeout, we may shoot early at an innocent context. To prevent this,
182 * we record which context was active at the time of the preemption
183 * request and only reset that context upon the timeout.
184 */
185 const struct i915_request *preempt_target;
186
187 /**
188 * @ccid: identifier for contexts submitted to this engine
189 */
190 u32 ccid;
191
192 /**
193 * @yield: CCID at the time of the last semaphore-wait interrupt.
194 *
195 * Instead of leaving a semaphore busy-spinning on an engine, we would
196 * like to switch to another ready context, i.e. yielding the semaphore
197 * timeslice.
198 */
199 u32 yield;
200
201 /**
202 * @error_interrupt: CS Master EIR
203 *
204 * The CS generates an interrupt when it detects an error. We capture
205 * the first error interrupt, record the EIR and schedule the tasklet.
206 * In the tasklet, we process the pending CS events to ensure we have
207 * the guilty request, and then reset the engine.
208 *
209 * Low 16b are used by HW, with the upper 16b used as the enabling mask.
210 * Reserve the upper 16b for tracking internal errors.
211 */
212 u32 error_interrupt;
213 #define ERROR_CSB BIT(31)
214 #define ERROR_PREEMPT BIT(30)
215
216 /**
217 * @reset_ccid: Active CCID [EXECLISTS_STATUS_HI] at the time of reset
218 */
219 u32 reset_ccid;
220
221 /**
222 * @submit_reg: gen-specific execlist submission register
223 * set to the ExecList Submission Port (elsp) register pre-Gen11 and to
224 * the ExecList Submission Queue Contents register array for Gen11+
225 */
226 u32 __iomem *submit_reg;
227
228 /**
229 * @ctrl_reg: the enhanced execlists control register, used to load the
230 * submit queue on the HW and to request preemptions to idle
231 */
232 u32 __iomem *ctrl_reg;
233
234 #define EXECLIST_MAX_PORTS 2
235 /**
236 * @active: the currently known context executing on HW
237 */
238 struct i915_request * const *active;
239 /**
240 * @inflight: the set of contexts submitted and acknowleged by HW
241 *
242 * The set of inflight contexts is managed by reading CS events
243 * from the HW. On a context-switch event (not preemption), we
244 * know the HW has transitioned from port0 to port1, and we
245 * advance our inflight/active tracking accordingly.
246 */
247 struct i915_request *inflight[EXECLIST_MAX_PORTS + 1 /* sentinel */];
248 /**
249 * @pending: the next set of contexts submitted to ELSP
250 *
251 * We store the array of contexts that we submit to HW (via ELSP) and
252 * promote them to the inflight array once HW has signaled the
253 * preemption or idle-to-active event.
254 */
255 struct i915_request *pending[EXECLIST_MAX_PORTS + 1];
256
257 /**
258 * @port_mask: number of execlist ports - 1
259 */
260 unsigned int port_mask;
261
262 /**
263 * @virtual: Queue of requets on a virtual engine, sorted by priority.
264 * Each RB entry is a struct i915_priolist containing a list of requests
265 * of the same priority.
266 */
267 struct rb_root_cached virtual;
268
269 /**
270 * @csb_write: control register for Context Switch buffer
271 *
272 * Note this register may be either mmio or HWSP shadow.
273 */
274 u32 *csb_write;
275
276 /**
277 * @csb_status: status array for Context Switch buffer
278 *
279 * Note these register may be either mmio or HWSP shadow.
280 */
281 u64 *csb_status;
282
283 /**
284 * @csb_size: context status buffer FIFO size
285 */
286 u8 csb_size;
287
288 /**
289 * @csb_head: context status buffer head
290 */
291 u8 csb_head;
292
293 /* private: selftest */
294 I915_SELFTEST_DECLARE(struct st_preempt_hang preempt_hang;)
295 };
296
297 #define INTEL_ENGINE_CS_MAX_NAME 8
298
299 struct intel_engine_execlists_stats {
300 /**
301 * @active: Number of contexts currently scheduled in.
302 */
303 unsigned int active;
304
305 /**
306 * @lock: Lock protecting the below fields.
307 */
308 seqcount_t lock;
309
310 /**
311 * @total: Total time this engine was busy.
312 *
313 * Accumulated time not counting the most recent block in cases where
314 * engine is currently busy (active > 0).
315 */
316 ktime_t total;
317
318 /**
319 * @start: Timestamp of the last idle to active transition.
320 *
321 * Idle is defined as active == 0, active is active > 0.
322 */
323 ktime_t start;
324 };
325
326 struct intel_engine_guc_stats {
327 /**
328 * @running: Active state of the engine when busyness was last sampled.
329 */
330 bool running;
331
332 /**
333 * @prev_total: Previous value of total runtime clock cycles.
334 */
335 u32 prev_total;
336
337 /**
338 * @total_gt_clks: Total gt clock cycles this engine was busy.
339 */
340 u64 total_gt_clks;
341
342 /**
343 * @start_gt_clk: GT clock time of last idle to active transition.
344 */
345 u64 start_gt_clk;
346 };
347
348 union intel_engine_tlb_inv_reg {
349 i915_reg_t reg;
350 i915_mcr_reg_t mcr_reg;
351 };
352
353 struct intel_engine_tlb_inv {
354 bool mcr;
355 union intel_engine_tlb_inv_reg reg;
356 u32 request;
357 u32 done;
358 };
359
360 struct intel_engine_cs {
361 struct drm_i915_private *i915;
362 struct intel_gt *gt;
363 struct intel_uncore *uncore;
364 char name[INTEL_ENGINE_CS_MAX_NAME];
365
366 enum intel_engine_id id;
367 enum intel_engine_id legacy_idx;
368
369 unsigned int guc_id;
370
371 intel_engine_mask_t mask;
372 u32 reset_domain;
373 /**
374 * @logical_mask: logical mask of engine, reported to user space via
375 * query IOCTL and used to communicate with the GuC in logical space.
376 * The logical instance of a physical engine can change based on product
377 * and fusing.
378 */
379 intel_engine_mask_t logical_mask;
380
381 u8 class;
382 u8 instance;
383
384 u16 uabi_class;
385 u16 uabi_instance;
386
387 u32 uabi_capabilities;
388 u32 context_size;
389 u32 mmio_base;
390
391 struct intel_engine_tlb_inv tlb_inv;
392
393 /*
394 * Some w/a require forcewake to be held (which prevents RC6) while
395 * a particular engine is active. If so, we set fw_domain to which
396 * domains need to be held for the duration of request activity,
397 * and 0 if none. We try to limit the duration of the hold as much
398 * as possible.
399 */
400 enum forcewake_domains fw_domain;
401 unsigned int fw_active;
402
403 unsigned long context_tag;
404
405 struct rb_node uabi_node;
406
407 struct intel_sseu sseu;
408
409 struct i915_sched_engine *sched_engine;
410
411 /* keep a request in reserve for a [pm] barrier under oom */
412 struct i915_request *request_pool;
413
414 struct intel_context *hung_ce;
415
416 struct llist_head barrier_tasks;
417
418 struct intel_context *kernel_context; /* pinned */
419 struct intel_context *bind_context; /* pinned, only for BCS0 */
420 /* mark the bind context's availability status */
421 bool bind_context_ready;
422
423 /**
424 * pinned_contexts_list: List of pinned contexts. This list is only
425 * assumed to be manipulated during driver load- or unload time and
426 * does therefore not have any additional protection.
427 */
428 struct list_head pinned_contexts_list;
429
430 intel_engine_mask_t saturated; /* submitting semaphores too late? */
431
432 struct {
433 struct delayed_work work;
434 struct i915_request *systole;
435 unsigned long blocked;
436 } heartbeat;
437
438 unsigned long serial;
439
440 unsigned long wakeref_serial;
441 struct intel_wakeref wakeref;
442 #ifdef __linux__
443 struct file *default_state;
444 #else
445 struct uvm_object *default_state;
446 #endif
447
448 struct {
449 struct intel_ring *ring;
450 struct intel_timeline *timeline;
451 } legacy;
452
453 /*
454 * We track the average duration of the idle pulse on parking the
455 * engine to keep an estimate of the how the fast the engine is
456 * under ideal conditions.
457 */
458 struct ewma__engine_latency latency;
459
460 /* Keep track of all the seqno used, a trail of breadcrumbs */
461 struct intel_breadcrumbs *breadcrumbs;
462
463 struct intel_engine_pmu {
464 /**
465 * @enable: Bitmask of enable sample events on this engine.
466 *
467 * Bits correspond to sample event types, for instance
468 * I915_SAMPLE_QUEUED is bit 0 etc.
469 */
470 u32 enable;
471 /**
472 * @enable_count: Reference count for the enabled samplers.
473 *
474 * Index number corresponds to @enum drm_i915_pmu_engine_sample.
475 */
476 unsigned int enable_count[I915_ENGINE_SAMPLE_COUNT];
477 /**
478 * @sample: Counter values for sampling events.
479 *
480 * Our internal timer stores the current counters in this field.
481 *
482 * Index number corresponds to @enum drm_i915_pmu_engine_sample.
483 */
484 struct i915_pmu_sample sample[I915_ENGINE_SAMPLE_COUNT];
485 } pmu;
486
487 struct intel_hw_status_page status_page;
488 struct i915_ctx_workarounds wa_ctx;
489 struct i915_wa_list ctx_wa_list;
490 struct i915_wa_list wa_list;
491 struct i915_wa_list whitelist;
492
493 u32 irq_keep_mask; /* always keep these interrupts */
494 u32 irq_enable_mask; /* bitmask to enable ring interrupt */
495 void (*irq_enable)(struct intel_engine_cs *engine);
496 void (*irq_disable)(struct intel_engine_cs *engine);
497 void (*irq_handler)(struct intel_engine_cs *engine, u16 iir);
498
499 void (*sanitize)(struct intel_engine_cs *engine);
500 int (*resume)(struct intel_engine_cs *engine);
501
502 struct {
503 void (*prepare)(struct intel_engine_cs *engine);
504
505 void (*rewind)(struct intel_engine_cs *engine, bool stalled);
506 void (*cancel)(struct intel_engine_cs *engine);
507
508 void (*finish)(struct intel_engine_cs *engine);
509 } reset;
510
511 void (*park)(struct intel_engine_cs *engine);
512 void (*unpark)(struct intel_engine_cs *engine);
513
514 void (*bump_serial)(struct intel_engine_cs *engine);
515
516 void (*set_default_submission)(struct intel_engine_cs *engine);
517
518 const struct intel_context_ops *cops;
519
520 int (*request_alloc)(struct i915_request *rq);
521
522 int (*emit_flush)(struct i915_request *request, u32 mode);
523 #define EMIT_INVALIDATE BIT(0)
524 #define EMIT_FLUSH BIT(1)
525 #define EMIT_BARRIER (EMIT_INVALIDATE | EMIT_FLUSH)
526 int (*emit_bb_start)(struct i915_request *rq,
527 u64 offset, u32 length,
528 unsigned int dispatch_flags);
529 #define I915_DISPATCH_SECURE BIT(0)
530 #define I915_DISPATCH_PINNED BIT(1)
531 int (*emit_init_breadcrumb)(struct i915_request *rq);
532 u32 *(*emit_fini_breadcrumb)(struct i915_request *rq,
533 u32 *cs);
534 unsigned int emit_fini_breadcrumb_dw;
535
536 /* Pass the request to the hardware queue (e.g. directly into
537 * the legacy ringbuffer or to the end of an execlist).
538 *
539 * This is called from an atomic context with irqs disabled; must
540 * be irq safe.
541 */
542 void (*submit_request)(struct i915_request *rq);
543
544 void (*release)(struct intel_engine_cs *engine);
545
546 /*
547 * Add / remove request from engine active tracking
548 */
549 void (*add_active_request)(struct i915_request *rq);
550 void (*remove_active_request)(struct i915_request *rq);
551
552 /*
553 * Get engine busyness and the time at which the busyness was sampled.
554 */
555 ktime_t (*busyness)(struct intel_engine_cs *engine,
556 ktime_t *now);
557
558 struct intel_engine_execlists execlists;
559
560 /*
561 * Keep track of completed timelines on this engine for early
562 * retirement with the goal of quickly enabling powersaving as
563 * soon as the engine is idle.
564 */
565 struct intel_timeline *retire;
566 struct work_struct retire_work;
567
568 /* status_notifier: list of callbacks for context-switch changes */
569 #ifdef notyet
570 struct atomic_notifier_head context_status_notifier;
571 #endif
572
573 #define I915_ENGINE_USING_CMD_PARSER BIT(0)
574 #define I915_ENGINE_SUPPORTS_STATS BIT(1)
575 #define I915_ENGINE_HAS_PREEMPTION BIT(2)
576 #define I915_ENGINE_HAS_SEMAPHORES BIT(3)
577 #define I915_ENGINE_HAS_TIMESLICES BIT(4)
578 #define I915_ENGINE_IS_VIRTUAL BIT(5)
579 #define I915_ENGINE_HAS_RELATIVE_MMIO BIT(6)
580 #define I915_ENGINE_REQUIRES_CMD_PARSER BIT(7)
581 #define I915_ENGINE_WANT_FORCED_PREEMPTION BIT(8)
582 #define I915_ENGINE_HAS_RCS_REG_STATE BIT(9)
583 #define I915_ENGINE_HAS_EU_PRIORITY BIT(10)
584 #define I915_ENGINE_FIRST_RENDER_COMPUTE BIT(11)
585 #define I915_ENGINE_USES_WA_HOLD_CCS_SWITCHOUT BIT(12)
586 unsigned int flags;
587
588 /*
589 * Table of commands the command parser needs to know about
590 * for this engine.
591 */
592 DECLARE_HASHTABLE(cmd_hash, I915_CMD_HASH_ORDER);
593
594 /*
595 * Table of registers allowed in commands that read/write registers.
596 */
597 const struct drm_i915_reg_table *reg_tables;
598 int reg_table_count;
599
600 /*
601 * Returns the bitmask for the length field of the specified command.
602 * Return 0 for an unrecognized/invalid command.
603 *
604 * If the command parser finds an entry for a command in the engine's
605 * cmd_tables, it gets the command's length based on the table entry.
606 * If not, it calls this function to determine the per-engine length
607 * field encoding for the command (i.e. different opcode ranges use
608 * certain bits to encode the command length in the header).
609 */
610 u32 (*get_cmd_length_mask)(u32 cmd_header);
611
612 struct {
613 union {
614 struct intel_engine_execlists_stats execlists;
615 struct intel_engine_guc_stats guc;
616 };
617
618 /**
619 * @rps: Utilisation at last RPS sampling.
620 */
621 ktime_t rps;
622 } stats;
623
624 struct {
625 unsigned long heartbeat_interval_ms;
626 unsigned long max_busywait_duration_ns;
627 unsigned long preempt_timeout_ms;
628 unsigned long stop_timeout_ms;
629 unsigned long timeslice_duration_ms;
630 } props, defaults;
631
632 I915_SELFTEST_DECLARE(struct fault_attr reset_timeout);
633
634 /*
635 * The perf group maps to one OA unit which controls one OA buffer. All
636 * reports corresponding to this engine will be reported to this OA
637 * buffer. An engine will map to a single OA unit, but a single OA unit
638 * can generate reports for multiple engines.
639 */
640 struct i915_perf_group *oa_group;
641 };
642
643 static inline bool
intel_engine_using_cmd_parser(const struct intel_engine_cs * engine)644 intel_engine_using_cmd_parser(const struct intel_engine_cs *engine)
645 {
646 return engine->flags & I915_ENGINE_USING_CMD_PARSER;
647 }
648
649 static inline bool
intel_engine_requires_cmd_parser(const struct intel_engine_cs * engine)650 intel_engine_requires_cmd_parser(const struct intel_engine_cs *engine)
651 {
652 return engine->flags & I915_ENGINE_REQUIRES_CMD_PARSER;
653 }
654
655 static inline bool
intel_engine_supports_stats(const struct intel_engine_cs * engine)656 intel_engine_supports_stats(const struct intel_engine_cs *engine)
657 {
658 return engine->flags & I915_ENGINE_SUPPORTS_STATS;
659 }
660
661 static inline bool
intel_engine_has_preemption(const struct intel_engine_cs * engine)662 intel_engine_has_preemption(const struct intel_engine_cs *engine)
663 {
664 return engine->flags & I915_ENGINE_HAS_PREEMPTION;
665 }
666
667 static inline bool
intel_engine_has_semaphores(const struct intel_engine_cs * engine)668 intel_engine_has_semaphores(const struct intel_engine_cs *engine)
669 {
670 return engine->flags & I915_ENGINE_HAS_SEMAPHORES;
671 }
672
673 static inline bool
intel_engine_has_timeslices(const struct intel_engine_cs * engine)674 intel_engine_has_timeslices(const struct intel_engine_cs *engine)
675 {
676 if (!CONFIG_DRM_I915_TIMESLICE_DURATION)
677 return false;
678
679 return engine->flags & I915_ENGINE_HAS_TIMESLICES;
680 }
681
682 static inline bool
intel_engine_is_virtual(const struct intel_engine_cs * engine)683 intel_engine_is_virtual(const struct intel_engine_cs *engine)
684 {
685 return engine->flags & I915_ENGINE_IS_VIRTUAL;
686 }
687
688 static inline bool
intel_engine_has_relative_mmio(const struct intel_engine_cs * const engine)689 intel_engine_has_relative_mmio(const struct intel_engine_cs * const engine)
690 {
691 return engine->flags & I915_ENGINE_HAS_RELATIVE_MMIO;
692 }
693
694 /* Wa_14014475959:dg2 */
695 static inline bool
intel_engine_uses_wa_hold_ccs_switchout(struct intel_engine_cs * engine)696 intel_engine_uses_wa_hold_ccs_switchout(struct intel_engine_cs *engine)
697 {
698 return engine->flags & I915_ENGINE_USES_WA_HOLD_CCS_SWITCHOUT;
699 }
700
701 #endif /* __INTEL_ENGINE_TYPES_H__ */
702