Documentation/gpu/i915.rst

6 models) integrated GFX chipsets with both Intel display and rendering
7 blocks. This excludes a set of SoC platforms with an SGX rendering unit,
13 This section covers core driver infrastructure used by both the display
17 ------------------------
19 .. kernel-doc:: drivers/gpu/drm/i915/intel_runtime_pm.c
22 .. kernel-doc:: drivers/gpu/drm/i915/intel_runtime_pm.c
25 .. kernel-doc:: drivers/gpu/drm/i915/intel_uncore.c
29 ------------------
31 .. kernel-doc:: drivers/gpu/drm/i915/i915_irq.c
34 .. kernel-doc:: drivers/gpu/drm/i915/i915_irq.c
37 .. kernel-doc:: drivers/gpu/drm/i915/i915_irq.c
40 .. kernel-doc:: drivers/gpu/drm/i915/i915_irq.c
43 Intel GVT-g Guest Support(vGPU)
44 -------------------------------
46 .. kernel-doc:: drivers/gpu/drm/i915/i915_vgpu.c
47    :doc: Intel GVT-g guest support
49 .. kernel-doc:: drivers/gpu/drm/i915/i915_vgpu.c
52 Intel GVT-g Host Support(vGPU device model)
53 -------------------------------------------
55 .. kernel-doc:: drivers/gpu/drm/i915/intel_gvt.c
56    :doc: Intel GVT-g host support
58 .. kernel-doc:: drivers/gpu/drm/i915/intel_gvt.c
62 -----------
64 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_workarounds.c
67 Display Hardware Handling
70 This section covers everything related to the display hardware including
72 display, output probing and related topics.
75 ---------------------------
79 its own tailor-made infrastructure for executing a display configuration
83 --------------------
85 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_frontbuffer.c
88 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_frontbuffer.h
91 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_frontbuffer.c
94 Display FIFO Underrun Reporting
95 -------------------------------
97 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_fifo_underrun.c
100 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_fifo_underrun.c
104 -------------------
113 --------------------
115 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_atomic_plane.c
118 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_atomic_plane.c
122 ----------------------
124 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_display.c
128 --------------
136 -------
138 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_hotplug.c
141 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_hotplug.c
145 ---------------------
147 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_audio.c
148    :doc: High Definition Audio over HDMI and Display Port
150 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_audio.c
153 .. kernel-doc:: include/drm/i915_component.h
157 ----------------------------
159 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_lpe_audio.c
162 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_lpe_audio.c
166 --------------------------------
168 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_psr.c
171 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_psr.c
175 ------------------------------
177 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_fbc.c
180 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_fbc.c
183 Display Refresh Rate Switching (DRRS)
184 -------------------------------------
186 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
187    :doc: Display Refresh Rate Switching (DRRS)
189 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
193 ----
195 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dpio_phy.c
199 --------------------
201 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dmc.c
204 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dmc.c
208 ----------------------
210 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_bios.c
213 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_bios.c
216 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_vbt_defs.h
219 Display clocks
220 --------------
222 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_cdclk.c
225 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_cdclk.c
228 Display PLLs
229 ------------
231 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dpll_mgr.c
232    :doc: Display PLLs
234 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dpll_mgr.c
237 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dpll_mgr.h
240 Display State Buffer
241 --------------------
243 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dsb.c
246 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dsb.c
253 ------------------------------------
255 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_gt_mcr.c
258 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_gt_mcr.c
268 ----------------
272 - RCS engine is for rendering 3D and performing compute, this is named
274 - BCS is a blitting (copy) engine, this is named `I915_EXEC_BLT` in user
276 - VCS is a video encode and decode engine, this is named `I915_EXEC_BSD`
278 - VECS is video enhancement engine, this is named `I915_EXEC_VEBOX` in user
280 - The enumeration `I915_EXEC_DEFAULT` does not refer to specific engine;
281   instead it is to be used by user space to specify a default rendering
284 The Intel GPU family is a family of integrated GPU's using Unified
291 `DRM_IOCTL_I915_GEM_CREATE`). An ioctl providing a batchbuffer for the GPU
296 The i915 driver allows user space to create a context via the ioctl
297 `DRM_IOCTL_I915_GEM_CONTEXT_CREATE` which is identified by a 32-bit
298 integer. Such a context should be viewed by user-space as -loosely-
299 analogous to the idea of a CPU process of an operating system. The i915
300 driver guarantees that commands issued to a fixed context are to be
301 executed so that writes of a previously issued command are seen by
306 Gen4, also have that a context carries with it a GPU HW context;
307 the HW context is essentially (most of at least) the state of a GPU.
309 state via HW context when commands are issued to a context, this saves
311 start of each batchbuffer. The non-deprecated ioctls to submit batchbuffer
317 GPUs (i.e. those before Gen8), there is a single global such translation
318 table, a global Graphics Translation Table (GTT). For newer generation
319 GPUs each context has its own translation table, called Per-Process
321 PPGTT is named per-process it is actually per context. When user space
322 submits a batchbuffer, the kernel walks the list of GEM buffer objects
328 the GPU address when a GEM BO is assigned a GPU address and the kernel
329 might evict a different GEM BO from the (PP)GTT to make address room
330 for another GEM BO. Consequently, the ioctls submitting a batchbuffer
331 for execution also include a list of all locations within buffers that
332 refer to GPU-addresses so that the kernel can edit the buffer correctly.
336 ------------------
339    This is a description of how the locking should be after
343 #. All locking rules and interface contracts with cross-driver interfaces
344    (dma-buf, dma_fence) need to be followed.
356 	  allocate memory while holding these looks we get a rehash
379 	* -EDEADLK handling with ww_mutex
382 ----------------------------------------
384 .. kernel-doc:: drivers/gpu/drm/i915/i915_vma_types.h
388 ----------------------
396 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_evict.c
400 ------------------------------
407 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_shrinker.c
411 -------------------
413 .. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_parser.c
416 .. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_parser.c
420 --------------------------
422 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_context_types.h
424 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_execbuffer.c
428 ----------
429 .. kernel-doc:: drivers/gpu/drm/i915/i915_scheduler_types.h
433 --------------------------------------------------
435 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_execlists_submission.c
439 ----------------
441 .. kernel-doc:: drivers/gpu/drm/i915/i915_vma_types.h
444 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_gtt.c
448 ------------------------
450 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ggtt_fencing.c
456 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ggtt_fencing.c
462 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ggtt_fencing.c
466 --------------------
468 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_tiling.c
471 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_tiling.c
475 -----------------
477 .. kernel-doc:: drivers/gpu/drm/i915/pxp/intel_pxp.c
480 .. kernel-doc:: drivers/gpu/drm/i915/pxp/intel_pxp_types.h
487 display microcontroller (DMC). The driver is responsible for loading the
492 -----
497 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_wopcm.c
501 ---
503 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.c
506 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.h
511 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h
517 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.c
519 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.c
523 GuC-specific firmware loader
526 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_fw.c
529 GuC-based command submission
532 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_submission.c
533    :doc: GuC-based command submission
538 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_messages_abi.h
539 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h
540 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h
541 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_actions_abi.h
542 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_klvs_abi.h
545 ---
546 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc.c
548 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc.c
554 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc.c
562 ---
572 ----------------------------------------
574 .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
578 -----------------------------------------
580 .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
587 --------
588 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
592 -------------------------
593 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
597 ------------------------
602 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
604 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
606 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
608 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
610 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
612 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
614 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
616 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
620 ----------------
622 This section covers the stream-semantics-agnostic structures and functions
625 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf_types.h
627 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf_types.h
630 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
632 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
634 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
636 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
638 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
640 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
642 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
644 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
646 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
650 -----------------------------------------
652 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf_types.h
655 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
657 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
659 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
661 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
663 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
665 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
669 -------------------------
673 specific details than found in the more high-level sections.
675 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
677    :no-identifiers:
706 -------------------------------
710 .. kernel-doc:: drivers/gpu/drm/i915/i915_reg.h
713 .. _i915-usage-stats:
719 documented in :ref:`drm-client-usage-stats`.
729       drm-driver: i915
730       drm-pdev:   0000:00:02.0
731       drm-client-id:      7
732       drm-engine-render:  9288864723 ns
733       drm-engine-copy:    2035071108 ns
734       drm-engine-video:   0 ns
735       drm-engine-capacity-video:   2
736       drm-engine-video-enhance:   0 ns
738 Possible `drm-engine-` key names are: `render`, `copy`, `video` and
739 `video-enhance`.