Documentation/gpu/i915.rst

   1 ===========================
   2  drm/i915 Intel GFX Driver
   3 ===========================
   4
   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.
   9
  10 Core Driver Infrastructure
  11 ==========================
  12
  13 This section covers core driver infrastructure used by both the display
  14 and the GEM parts of the driver.
  15
  16 Runtime Power Management
  17 ------------------------
  18
  19 .. kernel-doc:: drivers/gpu/drm/i915/intel_runtime_pm.c
  20    :doc: runtime pm
  21
  22 .. kernel-doc:: drivers/gpu/drm/i915/intel_runtime_pm.c
  23    :internal:
  24
  25 .. kernel-doc:: drivers/gpu/drm/i915/intel_uncore.c
  26    :internal:
  27
  28 Interrupt Handling
  29 ------------------
  30
  31 .. kernel-doc:: drivers/gpu/drm/i915/i915_irq.c
  32    :doc: interrupt handling
  33
  34 .. kernel-doc:: drivers/gpu/drm/i915/i915_irq.c
  35    :functions: intel_irq_init intel_irq_init_hw intel_hpd_init
  36
  37 .. kernel-doc:: drivers/gpu/drm/i915/i915_irq.c
  38    :functions: intel_runtime_pm_disable_interrupts
  39
  40 .. kernel-doc:: drivers/gpu/drm/i915/i915_irq.c
  41    :functions: intel_runtime_pm_enable_interrupts
  42
  43 Intel GVT-g Guest Support(vGPU)
  44 -------------------------------
  45
  46 .. kernel-doc:: drivers/gpu/drm/i915/i915_vgpu.c
  47    :doc: Intel GVT-g guest support
  48
  49 .. kernel-doc:: drivers/gpu/drm/i915/i915_vgpu.c
  50    :internal:
  51
  52 Intel GVT-g Host Support(vGPU device model)
  53 -------------------------------------------
  54
  55 .. kernel-doc:: drivers/gpu/drm/i915/intel_gvt.c
  56    :doc: Intel GVT-g host support
  57
  58 .. kernel-doc:: drivers/gpu/drm/i915/intel_gvt.c
  59    :internal:
  60
  61 Display Hardware Handling
  62 =========================
  63
  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.
  67
  68 Mode Setting Infrastructure
  69 ---------------------------
  70
  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
  74 change.
  75
  76 Frontbuffer Tracking
  77 --------------------
  78
  79 .. kernel-doc:: drivers/gpu/drm/i915/intel_frontbuffer.c
  80    :doc: frontbuffer tracking
  81
  82 .. kernel-doc:: drivers/gpu/drm/i915/intel_frontbuffer.h
  83    :internal:
  84
  85 .. kernel-doc:: drivers/gpu/drm/i915/intel_frontbuffer.c
  86    :internal:
  87
  88 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem.c
  89    :functions: i915_gem_track_fb
  90
  91 Display FIFO Underrun Reporting
  92 -------------------------------
  93
  94 .. kernel-doc:: drivers/gpu/drm/i915/intel_fifo_underrun.c
  95    :doc: fifo underrun handling
  96
  97 .. kernel-doc:: drivers/gpu/drm/i915/intel_fifo_underrun.c
  98    :internal:
  99
 100 Plane Configuration
 101 -------------------
 102
 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
 107 panel self refresh.
 108
 109 Atomic Plane Helpers
 110 --------------------
 111
 112 .. kernel-doc:: drivers/gpu/drm/i915/intel_atomic_plane.c
 113    :doc: atomic plane helpers
 114
 115 .. kernel-doc:: drivers/gpu/drm/i915/intel_atomic_plane.c
 116    :internal:
 117
 118 Output Probing
 119 --------------
 120
 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.
 125
 126 Hotplug
 127 -------
 128
 129 .. kernel-doc:: drivers/gpu/drm/i915/intel_hotplug.c
 130    :doc: Hotplug
 131
 132 .. kernel-doc:: drivers/gpu/drm/i915/intel_hotplug.c
 133    :internal:
 134
 135 High Definition Audio
 136 ---------------------
 137
 138 .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
 139    :doc: High Definition Audio over HDMI and Display Port
 140
 141 .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
 142    :internal:
 143
 144 .. kernel-doc:: include/drm/i915_component.h
 145    :internal:
 146
 147 Intel HDMI LPE Audio Support
 148 ----------------------------
 149
 150 .. kernel-doc:: drivers/gpu/drm/i915/intel_lpe_audio.c
 151    :doc: LPE Audio integration for HDMI or DP playback
 152
 153 .. kernel-doc:: drivers/gpu/drm/i915/intel_lpe_audio.c
 154    :internal:
 155
 156 Panel Self Refresh PSR (PSR/SRD)
 157 --------------------------------
 158
 159 .. kernel-doc:: drivers/gpu/drm/i915/intel_psr.c
 160    :doc: Panel Self Refresh (PSR/SRD)
 161
 162 .. kernel-doc:: drivers/gpu/drm/i915/intel_psr.c
 163    :internal:
 164
 165 Frame Buffer Compression (FBC)
 166 ------------------------------
 167
 168 .. kernel-doc:: drivers/gpu/drm/i915/intel_fbc.c
 169    :doc: Frame Buffer Compression (FBC)
 170
 171 .. kernel-doc:: drivers/gpu/drm/i915/intel_fbc.c
 172    :internal:
 173
 174 Display Refresh Rate Switching (DRRS)
 175 -------------------------------------
 176
 177 .. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
 178    :doc: Display Refresh Rate Switching (DRRS)
 179
 180 .. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
 181    :functions: intel_dp_set_drrs_state
 182
 183 .. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
 184    :functions: intel_edp_drrs_enable
 185
 186 .. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
 187    :functions: intel_edp_drrs_disable
 188
 189 .. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
 190    :functions: intel_edp_drrs_invalidate
 191
 192 .. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
 193    :functions: intel_edp_drrs_flush
 194
 195 .. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
 196    :functions: intel_dp_drrs_init
 197
 198 DPIO
 199 ----
 200
 201 .. kernel-doc:: drivers/gpu/drm/i915/intel_dpio_phy.c
 202    :doc: DPIO
 203
 204 CSR firmware support for DMC
 205 ----------------------------
 206
 207 .. kernel-doc:: drivers/gpu/drm/i915/intel_csr.c
 208    :doc: csr support for dmc
 209
 210 .. kernel-doc:: drivers/gpu/drm/i915/intel_csr.c
 211    :internal:
 212
 213 Video BIOS Table (VBT)
 214 ----------------------
 215
 216 .. kernel-doc:: drivers/gpu/drm/i915/intel_bios.c
 217    :doc: Video BIOS Table (VBT)
 218
 219 .. kernel-doc:: drivers/gpu/drm/i915/intel_bios.c
 220    :internal:
 221
 222 .. kernel-doc:: drivers/gpu/drm/i915/intel_vbt_defs.h
 223    :internal:
 224
 225 Display clocks
 226 --------------
 227
 228 .. kernel-doc:: drivers/gpu/drm/i915/intel_cdclk.c
 229    :doc: CDCLK / RAWCLK
 230
 231 .. kernel-doc:: drivers/gpu/drm/i915/intel_cdclk.c
 232    :internal:
 233
 234 Display PLLs
 235 ------------
 236
 237 .. kernel-doc:: drivers/gpu/drm/i915/intel_dpll_mgr.c
 238    :doc: Display PLLs
 239
 240 .. kernel-doc:: drivers/gpu/drm/i915/intel_dpll_mgr.c
 241    :internal:
 242
 243 .. kernel-doc:: drivers/gpu/drm/i915/intel_dpll_mgr.h
 244    :internal:
 245
 246 Memory Management and Command Submission
 247 ========================================
 248
 249 This sections covers all things related to the GEM implementation in the
 250 i915 driver.
 251
 252 Batchbuffer Parsing
 253 -------------------
 254
 255 .. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_parser.c
 256    :doc: batch buffer command parser
 257
 258 .. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_parser.c
 259    :internal:
 260
 261 Batchbuffer Pools
 262 -----------------
 263
 264 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_batch_pool.c
 265    :doc: batch pool
 266
 267 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_batch_pool.c
 268    :internal:
 269
 270 Logical Rings, Logical Ring Contexts and Execlists
 271 --------------------------------------------------
 272
 273 .. kernel-doc:: drivers/gpu/drm/i915/intel_lrc.c
 274    :doc: Logical Rings, Logical Ring Contexts and Execlists
 275
 276 .. kernel-doc:: drivers/gpu/drm/i915/intel_lrc.c
 277    :internal:
 278
 279 Global GTT views
 280 ----------------
 281
 282 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_gtt.c
 283    :doc: Global GTT views
 284
 285 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_gtt.c
 286    :internal:
 287
 288 GTT Fences and Swizzling
 289 ------------------------
 290
 291 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence_reg.c
 292    :internal:
 293
 294 Global GTT Fence Handling
 295 ~~~~~~~~~~~~~~~~~~~~~~~~~
 296
 297 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence_reg.c
 298    :doc: fence register handling
 299
 300 Hardware Tiling and Swizzling Details
 301 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 302
 303 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence_reg.c
 304    :doc: tiling swizzling details
 305
 306 Object Tiling IOCTLs
 307 --------------------
 308
 309 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_tiling.c
 310    :internal:
 311
 312 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_tiling.c
 313    :doc: buffer object tiling
 314
 315 Buffer Object Eviction
 316 ----------------------
 317
 318 This section documents the interface functions for evicting buffer
 319 objects to make space available in the virtual gpu address spaces. Note
 320 that this is mostly orthogonal to shrinking buffer objects caches, which
 321 has the goal to make main memory (shared with the gpu through the
 322 unified memory architecture) available.
 323
 324 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_evict.c
 325    :internal:
 326
 327 Buffer Object Memory Shrinking
 328 ------------------------------
 329
 330 This section documents the interface function for shrinking memory usage
 331 of buffer object caches. Shrinking is used to make main memory
 332 available. Note that this is mostly orthogonal to evicting buffer
 333 objects, which has the goal to make space in gpu virtual address spaces.
 334
 335 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_shrinker.c
 336    :internal:
 337
 338 GuC
 339 ===
 340
 341 GuC-specific firmware loader
 342 ----------------------------
 343
 344 .. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
 345    :doc: GuC-specific firmware loader
 346
 347 .. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
 348    :internal:
 349
 350 GuC-based command submission
 351 ----------------------------
 352
 353 .. kernel-doc:: drivers/gpu/drm/i915/i915_guc_submission.c
 354    :doc: GuC-based command submission
 355
 356 .. kernel-doc:: drivers/gpu/drm/i915/i915_guc_submission.c
 357    :internal:
 358
 359 GuC Firmware Layout
 360 -------------------
 361
 362 .. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fwif.h
 363    :doc: GuC Firmware Layout
 364
 365 Tracing
 366 =======
 367
 368 This sections covers all things related to the tracepoints implemented
 369 in the i915 driver.
 370
 371 i915_ppgtt_create and i915_ppgtt_release
 372 ----------------------------------------
 373
 374 .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
 375    :doc: i915_ppgtt_create and i915_ppgtt_release tracepoints
 376
 377 i915_context_create and i915_context_free
 378 -----------------------------------------
 379
 380 .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
 381    :doc: i915_context_create and i915_context_free tracepoints
 382
 383 switch_mm
 384 ---------
 385
 386 .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
 387    :doc: switch_mm tracepoint
 388
 389 Perf
 390 ====
 391
 392 Overview
 393 --------
 394 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 395    :doc: i915 Perf Overview
 396
 397 Comparison with Core Perf
 398 -------------------------
 399 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 400    :doc: i915 Perf History and Comparison with Core Perf
 401
 402 i915 Driver Entry Points
 403 ------------------------
 404
 405 This section covers the entrypoints exported outside of i915_perf.c to
 406 integrate with drm/i915 and to handle the `DRM_I915_PERF_OPEN` ioctl.
 407
 408 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 409    :functions: i915_perf_init
 410 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 411    :functions: i915_perf_fini
 412 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 413    :functions: i915_perf_register
 414 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 415    :functions: i915_perf_unregister
 416 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 417    :functions: i915_perf_open_ioctl
 418 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 419    :functions: i915_perf_release
 420 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 421    :functions: i915_perf_add_config_ioctl
 422 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 423    :functions: i915_perf_remove_config_ioctl
 424
 425 i915 Perf Stream
 426 ----------------
 427
 428 This section covers the stream-semantics-agnostic structures and functions
 429 for representing an i915 perf stream FD and associated file operations.
 430
 431 .. kernel-doc:: drivers/gpu/drm/i915/i915_drv.h
 432    :functions: i915_perf_stream
 433 .. kernel-doc:: drivers/gpu/drm/i915/i915_drv.h
 434    :functions: i915_perf_stream_ops
 435
 436 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 437    :functions: read_properties_unlocked
 438 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 439    :functions: i915_perf_open_ioctl_locked
 440 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 441    :functions: i915_perf_destroy_locked
 442 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 443    :functions: i915_perf_read
 444 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 445    :functions: i915_perf_ioctl
 446 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 447    :functions: i915_perf_enable_locked
 448 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 449    :functions: i915_perf_disable_locked
 450 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 451    :functions: i915_perf_poll
 452 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 453    :functions: i915_perf_poll_locked
 454
 455 i915 Perf Observation Architecture Stream
 456 -----------------------------------------
 457
 458 .. kernel-doc:: drivers/gpu/drm/i915/i915_drv.h
 459    :functions: i915_oa_ops
 460
 461 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 462    :functions: i915_oa_stream_init
 463 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 464    :functions: i915_oa_read
 465 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 466    :functions: i915_oa_stream_enable
 467 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 468    :functions: i915_oa_stream_disable
 469 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 470    :functions: i915_oa_wait_unlocked
 471 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 472    :functions: i915_oa_poll_wait
 473
 474 All i915 Perf Internals
 475 -----------------------
 476
 477 This section simply includes all currently documented i915 perf internals, in
 478 no particular order, but may include some more minor utilities or platform
 479 specific details than found in the more high-level sections.
 480
 481 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
 482    :internal:
 483
 484 Style
 485 =====
 486
 487 The drm/i915 driver codebase has some style rules in addition to (and, in some
 488 cases, deviating from) the kernel coding style.
 489
 490 Register macro definition style
 491 -------------------------------
 492
 493 The style guide for ``i915_reg.h``.
 494
 495 .. kernel-doc:: drivers/gpu/drm/i915/i915_reg.h
 496    :doc: The i915 register macro definition style guide