1 ===========================
2 drm/i915 Intel GFX Driver
3 ===========================
5 The drm/i915 driver supports all (with the exception of some very early
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,
8 those have basic support through the gma500 drm driver.
10 Core Driver Infrastructure
11 ==========================
13 This section covers core driver infrastructure used by both the display
14 and the GEM parts of the driver.
16 Runtime Power Management
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
31 .. kernel-doc:: drivers/gpu/drm/i915/i915_irq.c
32 :doc: interrupt handling
34 .. kernel-doc:: drivers/gpu/drm/i915/i915_irq.c
35 :functions: intel_irq_init intel_irq_init_hw intel_hpd_init
37 .. kernel-doc:: drivers/gpu/drm/i915/i915_irq.c
38 :functions: intel_runtime_pm_disable_interrupts
40 .. kernel-doc:: drivers/gpu/drm/i915/i915_irq.c
41 :functions: intel_runtime_pm_enable_interrupts
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
61 Display Hardware Handling
62 =========================
64 This section covers everything related to the display hardware including
65 the mode setting infrastructure, plane, sprite and cursor handling and
66 display, output probing and related topics.
68 Mode Setting Infrastructure
69 ---------------------------
71 The i915 driver is thus far the only DRM driver which doesn't use the
72 common DRM helper code to implement mode setting sequences. Thus it has
73 its own tailor-made infrastructure for executing a display configuration
79 .. kernel-doc:: drivers/gpu/drm/i915/intel_frontbuffer.c
80 :doc: frontbuffer tracking
82 .. kernel-doc:: drivers/gpu/drm/i915/intel_frontbuffer.h
85 .. kernel-doc:: drivers/gpu/drm/i915/intel_frontbuffer.c
88 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem.c
89 :functions: i915_gem_track_fb
91 Display FIFO Underrun Reporting
92 -------------------------------
94 .. kernel-doc:: drivers/gpu/drm/i915/intel_fifo_underrun.c
95 :doc: fifo underrun handling
97 .. kernel-doc:: drivers/gpu/drm/i915/intel_fifo_underrun.c
103 This section covers plane configuration and composition with the primary
104 plane, sprites, cursors and overlays. This includes the infrastructure
105 to do atomic vsync'ed updates of all this state and also tightly coupled
106 topics like watermark setup and computation, framebuffer compression and
112 .. kernel-doc:: drivers/gpu/drm/i915/intel_atomic_plane.c
113 :doc: atomic plane helpers
115 .. kernel-doc:: drivers/gpu/drm/i915/intel_atomic_plane.c
121 This section covers output probing and related infrastructure like the
122 hotplug interrupt storm detection and mitigation code. Note that the
123 i915 driver still uses most of the common DRM helper code for output
124 probing, so those sections fully apply.
129 .. kernel-doc:: drivers/gpu/drm/i915/intel_hotplug.c
132 .. kernel-doc:: drivers/gpu/drm/i915/intel_hotplug.c
135 High Definition Audio
136 ---------------------
138 .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
139 :doc: High Definition Audio over HDMI and Display Port
141 .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
144 .. kernel-doc:: include/drm/i915_component.h
147 Intel HDMI LPE Audio Support
148 ----------------------------
150 .. kernel-doc:: drivers/gpu/drm/i915/intel_lpe_audio.c
151 :doc: LPE Audio integration for HDMI or DP playback
153 .. kernel-doc:: drivers/gpu/drm/i915/intel_lpe_audio.c
156 Panel Self Refresh PSR (PSR/SRD)
157 --------------------------------
159 .. kernel-doc:: drivers/gpu/drm/i915/intel_psr.c
160 :doc: Panel Self Refresh (PSR/SRD)
162 .. kernel-doc:: drivers/gpu/drm/i915/intel_psr.c
165 Frame Buffer Compression (FBC)
166 ------------------------------
168 .. kernel-doc:: drivers/gpu/drm/i915/intel_fbc.c
169 :doc: Frame Buffer Compression (FBC)
171 .. kernel-doc:: drivers/gpu/drm/i915/intel_fbc.c
174 Display Refresh Rate Switching (DRRS)
175 -------------------------------------
177 .. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
178 :doc: Display Refresh Rate Switching (DRRS)
180 .. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
181 :functions: intel_dp_set_drrs_state
183 .. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
184 :functions: intel_edp_drrs_enable
186 .. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
187 :functions: intel_edp_drrs_disable
189 .. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
190 :functions: intel_edp_drrs_invalidate
192 .. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
193 :functions: intel_edp_drrs_flush
195 .. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
196 :functions: intel_dp_drrs_init
201 .. kernel-doc:: drivers/gpu/drm/i915/intel_dpio_phy.c
204 CSR firmware support for DMC
205 ----------------------------
207 .. kernel-doc:: drivers/gpu/drm/i915/intel_csr.c
208 :doc: csr support for dmc
210 .. kernel-doc:: drivers/gpu/drm/i915/intel_csr.c
213 Video BIOS Table (VBT)
214 ----------------------
216 .. kernel-doc:: drivers/gpu/drm/i915/intel_bios.c
217 :doc: Video BIOS Table (VBT)
219 .. kernel-doc:: drivers/gpu/drm/i915/intel_bios.c
222 .. kernel-doc:: drivers/gpu/drm/i915/intel_vbt_defs.h
228 .. kernel-doc:: drivers/gpu/drm/i915/intel_dpll_mgr.c
231 .. kernel-doc:: drivers/gpu/drm/i915/intel_dpll_mgr.c
234 .. kernel-doc:: drivers/gpu/drm/i915/intel_dpll_mgr.h
237 Memory Management and Command Submission
238 ========================================
240 This sections covers all things related to the GEM implementation in the
246 .. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_parser.c
247 :doc: batch buffer command parser
249 .. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_parser.c
255 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_batch_pool.c
258 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_batch_pool.c
261 Logical Rings, Logical Ring Contexts and Execlists
262 --------------------------------------------------
264 .. kernel-doc:: drivers/gpu/drm/i915/intel_lrc.c
265 :doc: Logical Rings, Logical Ring Contexts and Execlists
267 .. kernel-doc:: drivers/gpu/drm/i915/intel_lrc.c
273 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_gtt.c
274 :doc: Global GTT views
276 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_gtt.c
279 GTT Fences and Swizzling
280 ------------------------
282 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence_reg.c
285 Global GTT Fence Handling
286 ~~~~~~~~~~~~~~~~~~~~~~~~~
288 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence_reg.c
289 :doc: fence register handling
291 Hardware Tiling and Swizzling Details
292 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
294 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence_reg.c
295 :doc: tiling swizzling details
300 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_tiling.c
303 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_tiling.c
304 :doc: buffer object tiling
306 Buffer Object Eviction
307 ----------------------
309 This section documents the interface functions for evicting buffer
310 objects to make space available in the virtual gpu address spaces. Note
311 that this is mostly orthogonal to shrinking buffer objects caches, which
312 has the goal to make main memory (shared with the gpu through the
313 unified memory architecture) available.
315 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_evict.c
318 Buffer Object Memory Shrinking
319 ------------------------------
321 This section documents the interface function for shrinking memory usage
322 of buffer object caches. Shrinking is used to make main memory
323 available. Note that this is mostly orthogonal to evicting buffer
324 objects, which has the goal to make space in gpu virtual address spaces.
326 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_shrinker.c
332 GuC-specific firmware loader
333 ----------------------------
335 .. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
336 :doc: GuC-specific firmware loader
338 .. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
341 GuC-based command submission
342 ----------------------------
344 .. kernel-doc:: drivers/gpu/drm/i915/i915_guc_submission.c
345 :doc: GuC-based command submission
347 .. kernel-doc:: drivers/gpu/drm/i915/i915_guc_submission.c
353 .. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fwif.h
354 :doc: GuC Firmware Layout
359 This sections covers all things related to the tracepoints implemented
362 i915_ppgtt_create and i915_ppgtt_release
363 ----------------------------------------
365 .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
366 :doc: i915_ppgtt_create and i915_ppgtt_release tracepoints
368 i915_context_create and i915_context_free
369 -----------------------------------------
371 .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
372 :doc: i915_context_create and i915_context_free tracepoints
377 .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
378 :doc: switch_mm tracepoint
385 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
386 :doc: i915 Perf Overview
388 Comparison with Core Perf
389 -------------------------
390 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
391 :doc: i915 Perf History and Comparison with Core Perf
393 i915 Driver Entry Points
394 ------------------------
396 This section covers the entrypoints exported outside of i915_perf.c to
397 integrate with drm/i915 and to handle the `DRM_I915_PERF_OPEN` ioctl.
399 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
400 :functions: i915_perf_init
401 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
402 :functions: i915_perf_fini
403 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
404 :functions: i915_perf_register
405 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
406 :functions: i915_perf_unregister
407 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
408 :functions: i915_perf_open_ioctl
409 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
410 :functions: i915_perf_release
415 This section covers the stream-semantics-agnostic structures and functions
416 for representing an i915 perf stream FD and associated file operations.
418 .. kernel-doc:: drivers/gpu/drm/i915/i915_drv.h
419 :functions: i915_perf_stream
420 .. kernel-doc:: drivers/gpu/drm/i915/i915_drv.h
421 :functions: i915_perf_stream_ops
423 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
424 :functions: read_properties_unlocked
425 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
426 :functions: i915_perf_open_ioctl_locked
427 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
428 :functions: i915_perf_destroy_locked
429 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
430 :functions: i915_perf_read
431 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
432 :functions: i915_perf_ioctl
433 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
434 :functions: i915_perf_enable_locked
435 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
436 :functions: i915_perf_disable_locked
437 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
438 :functions: i915_perf_poll
439 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
440 :functions: i915_perf_poll_locked
442 i915 Perf Observation Architecture Stream
443 -----------------------------------------
445 .. kernel-doc:: drivers/gpu/drm/i915/i915_drv.h
446 :functions: i915_oa_ops
448 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
449 :functions: i915_oa_stream_init
450 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
451 :functions: i915_oa_read
452 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
453 :functions: i915_oa_stream_enable
454 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
455 :functions: i915_oa_stream_disable
456 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
457 :functions: i915_oa_wait_unlocked
458 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
459 :functions: i915_oa_poll_wait
461 All i915 Perf Internals
462 -----------------------
464 This section simply includes all currently documented i915 perf internals, in
465 no particular order, but may include some more minor utilities or platform
466 specific details than found in the more high-level sections.
468 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
471 .. WARNING: DOCPROC directive not supported: !Cdrivers/gpu/drm/i915/i915_irq.c