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 - Render Command Streamer (RCS). An engine for rendering 3D and
274 - Blitting Command Streamer (BCS). An engine for performing blitting and/or
276 - Video Command Streamer. An engine used for video encoding and decoding. Also
278 - Video Enhancement Command Streamer (VECS). An engine for video enhancement.
280 - Compute Command Streamer (CCS). An engine that has access to the media and
282 - Graphics Security Controller (GSCCS). A dedicated engine for internal
284   High-bandwidth Digital Content Protection (HDCP), Protected Xe Path (PXP),
287 The Intel GPU family is a family of integrated GPU's using Unified
294 `DRM_IOCTL_I915_GEM_CREATE`). An ioctl providing a batchbuffer for the GPU
299 The i915 driver allows user space to create a context via the ioctl
300 `DRM_IOCTL_I915_GEM_CONTEXT_CREATE` which is identified by a 32-bit
301 integer. Such a context should be viewed by user-space as -loosely-
302 analogous to the idea of a CPU process of an operating system. The i915
303 driver guarantees that commands issued to a fixed context are to be
304 executed so that writes of a previously issued command are seen by
309 Gen4, also have that a context carries with it a GPU HW context;
310 the HW context is essentially (most of at least) the state of a GPU.
312 state via HW context when commands are issued to a context, this saves
314 start of each batchbuffer. The non-deprecated ioctls to submit batchbuffer
320 GPUs (i.e. those before Gen8), there is a single global such translation
321 table, a global Graphics Translation Table (GTT). For newer generation
322 GPUs each context has its own translation table, called Per-Process
324 PPGTT is named per-process it is actually per context. When user space
325 submits a batchbuffer, the kernel walks the list of GEM buffer objects
331 the GPU address when a GEM BO is assigned a GPU address and the kernel
332 might evict a different GEM BO from the (PP)GTT to make address room
333 for another GEM BO. Consequently, the ioctls submitting a batchbuffer
334 for execution also include a list of all locations within buffers that
335 refer to GPU-addresses so that the kernel can edit the buffer correctly.
339 ------------------
342    This is a description of how the locking should be after
346 #. All locking rules and interface contracts with cross-driver interfaces
347    (dma-buf, dma_fence) need to be followed.
359 	  allocate memory while holding these looks we get a rehash
382 	* -EDEADLK handling with ww_mutex
385 ----------------------------------------
387 .. kernel-doc:: drivers/gpu/drm/i915/i915_vma_types.h
391 ----------------------
399 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_evict.c
403 ------------------------------
410 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_shrinker.c
414 -------------------
416 .. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_parser.c
419 .. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_parser.c
423 --------------------------
425 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_context_types.h
427 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_execbuffer.c
431 ----------
432 .. kernel-doc:: drivers/gpu/drm/i915/i915_scheduler_types.h
436 --------------------------------------------------
438 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_execlists_submission.c
442 ----------------
444 .. kernel-doc:: drivers/gpu/drm/i915/i915_vma_types.h
447 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_gtt.c
451 ------------------------
453 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ggtt_fencing.c
459 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ggtt_fencing.c
465 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ggtt_fencing.c
469 --------------------
471 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_tiling.c
474 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_tiling.c
478 -----------------
480 .. kernel-doc:: drivers/gpu/drm/i915/pxp/intel_pxp.c
483 .. kernel-doc:: drivers/gpu/drm/i915/pxp/intel_pxp_types.h
490 display microcontroller (DMC). The driver is responsible for loading the
495 -----
500 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_wopcm.c
504 ---
506 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.c
509 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.h
514 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h
520 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.c
522 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.c
526 GuC-specific firmware loader
529 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_fw.c
532 GuC-based command submission
535 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_submission.c
536    :doc: GuC-based command submission
541 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_messages_abi.h
542 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h
543 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h
544 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_actions_abi.h
545 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_klvs_abi.h
548 ---
549 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc.c
551 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc.c
557 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc.c
565 ---
575 ----------------------------------------
577 .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
581 -----------------------------------------
583 .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
590 --------
591 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
595 -------------------------
596 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
600 ------------------------
605 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
607 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
609 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
611 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
613 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
615 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
617 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
619 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
623 ----------------
625 This section covers the stream-semantics-agnostic structures and functions
628 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf_types.h
630 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf_types.h
633 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
635 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
637 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
639 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
641 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
643 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
645 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
647 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
649 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
653 -----------------------------------------
655 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf_types.h
658 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
660 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
662 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
664 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
666 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
668 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
672 -------------------------
676 specific details than found in the more high-level sections.
678 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
680    :no-identifiers:
709 -------------------------------
713 .. kernel-doc:: drivers/gpu/drm/i915/i915_reg.h
716 .. _i915-usage-stats:
722 documented in :ref:`drm-client-usage-stats`.
732       drm-driver: i915
733       drm-pdev:   0000:00:02.0
734       drm-client-id:      7
735       drm-engine-render:  9288864723 ns
736       drm-engine-copy:    2035071108 ns
737       drm-engine-video:   0 ns
738       drm-engine-capacity-video:   2
739       drm-engine-video-enhance:   0 ns
741 Possible `drm-engine-` key names are: `render`, `copy`, `video` and
742 `video-enhance`.