diff options
Diffstat (limited to 'Documentation/gpu/i915.rst')
| -rw-r--r-- | Documentation/gpu/i915.rst | 81 |
1 files changed, 41 insertions, 40 deletions
diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst index 9c6732123c3c..2fe5952e90f1 100644 --- a/Documentation/gpu/i915.rst +++ b/Documentation/gpu/i915.rst @@ -1,5 +1,6 @@ -drm/i915 Intel GFX Driver -========================= +=========================== + drm/i915 Intel GFX Driver +=========================== The drm/i915 driver supports all (with the exception of some very early models) integrated GFX chipsets with both Intel display and rendering @@ -7,13 +8,13 @@ blocks. This excludes a set of SoC platforms with an SGX rendering unit, those have basic support through the gma500 drm driver. Core Driver Infrastructure --------------------------- +========================== This section covers core driver infrastructure used by both the display and the GEM parts of the driver. Runtime Power Management -~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------ .. kernel-doc:: drivers/gpu/drm/i915/intel_runtime_pm.c :doc: runtime pm @@ -25,7 +26,7 @@ Runtime Power Management :internal: Interrupt Handling -~~~~~~~~~~~~~~~~~~ +------------------ .. kernel-doc:: drivers/gpu/drm/i915/i915_irq.c :doc: interrupt handling @@ -40,7 +41,7 @@ Interrupt Handling :functions: intel_runtime_pm_enable_interrupts Intel GVT-g Guest Support(vGPU) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------- .. kernel-doc:: drivers/gpu/drm/i915/i915_vgpu.c :doc: Intel GVT-g guest support @@ -49,14 +50,14 @@ Intel GVT-g Guest Support(vGPU) :internal: Display Hardware Handling -------------------------- +========================= This section covers everything related to the display hardware including the mode setting infrastructure, plane, sprite and cursor handling and display, output probing and related topics. Mode Setting Infrastructure -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +--------------------------- The i915 driver is thus far the only DRM driver which doesn't use the common DRM helper code to implement mode setting sequences. Thus it has @@ -64,7 +65,7 @@ its own tailor-made infrastructure for executing a display configuration change. Frontbuffer Tracking -~~~~~~~~~~~~~~~~~~~~ +-------------------- .. kernel-doc:: drivers/gpu/drm/i915/intel_frontbuffer.c :doc: frontbuffer tracking @@ -76,7 +77,7 @@ Frontbuffer Tracking :functions: i915_gem_track_fb Display FIFO Underrun Reporting -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------- .. kernel-doc:: drivers/gpu/drm/i915/intel_fifo_underrun.c :doc: fifo underrun handling @@ -85,7 +86,7 @@ Display FIFO Underrun Reporting :internal: Plane Configuration -~~~~~~~~~~~~~~~~~~~ +------------------- This section covers plane configuration and composition with the primary plane, sprites, cursors and overlays. This includes the infrastructure @@ -94,7 +95,7 @@ topics like watermark setup and computation, framebuffer compression and panel self refresh. Atomic Plane Helpers -~~~~~~~~~~~~~~~~~~~~ +-------------------- .. kernel-doc:: drivers/gpu/drm/i915/intel_atomic_plane.c :doc: atomic plane helpers @@ -103,7 +104,7 @@ Atomic Plane Helpers :internal: Output Probing -~~~~~~~~~~~~~~ +-------------- This section covers output probing and related infrastructure like the hotplug interrupt storm detection and mitigation code. Note that the @@ -111,7 +112,7 @@ i915 driver still uses most of the common DRM helper code for output probing, so those sections fully apply. Hotplug -~~~~~~~ +------- .. kernel-doc:: drivers/gpu/drm/i915/intel_hotplug.c :doc: Hotplug @@ -120,7 +121,7 @@ Hotplug :internal: High Definition Audio -~~~~~~~~~~~~~~~~~~~~~ +--------------------- .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c :doc: High Definition Audio over HDMI and Display Port @@ -132,7 +133,7 @@ High Definition Audio :internal: Panel Self Refresh PSR (PSR/SRD) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +-------------------------------- .. kernel-doc:: drivers/gpu/drm/i915/intel_psr.c :doc: Panel Self Refresh (PSR/SRD) @@ -141,7 +142,7 @@ Panel Self Refresh PSR (PSR/SRD) :internal: Frame Buffer Compression (FBC) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------ .. kernel-doc:: drivers/gpu/drm/i915/intel_fbc.c :doc: Frame Buffer Compression (FBC) @@ -150,7 +151,7 @@ Frame Buffer Compression (FBC) :internal: Display Refresh Rate Switching (DRRS) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------------- .. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c :doc: Display Refresh Rate Switching (DRRS) @@ -174,13 +175,13 @@ Display Refresh Rate Switching (DRRS) :functions: intel_dp_drrs_init DPIO -~~~~ +---- .. kernel-doc:: drivers/gpu/drm/i915/i915_reg.h :doc: DPIO CSR firmware support for DMC -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +---------------------------- .. kernel-doc:: drivers/gpu/drm/i915/intel_csr.c :doc: csr support for dmc @@ -189,7 +190,7 @@ CSR firmware support for DMC :internal: Video BIOS Table (VBT) -~~~~~~~~~~~~~~~~~~~~~~ +---------------------- .. kernel-doc:: drivers/gpu/drm/i915/intel_bios.c :doc: Video BIOS Table (VBT) @@ -201,13 +202,13 @@ Video BIOS Table (VBT) :internal: Memory Management and Command Submission ----------------------------------------- +======================================== This sections covers all things related to the GEM implementation in the i915 driver. Batchbuffer Parsing -~~~~~~~~~~~~~~~~~~~ +------------------- .. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_parser.c :doc: batch buffer command parser @@ -216,7 +217,7 @@ Batchbuffer Parsing :internal: Batchbuffer Pools -~~~~~~~~~~~~~~~~~ +----------------- .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_batch_pool.c :doc: batch pool @@ -225,7 +226,7 @@ Batchbuffer Pools :internal: Logical Rings, Logical Ring Contexts and Execlists -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +-------------------------------------------------- .. kernel-doc:: drivers/gpu/drm/i915/intel_lrc.c :doc: Logical Rings, Logical Ring Contexts and Execlists @@ -234,7 +235,7 @@ Logical Rings, Logical Ring Contexts and Execlists :internal: Global GTT views -~~~~~~~~~~~~~~~~ +---------------- .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_gtt.c :doc: Global GTT views @@ -243,25 +244,25 @@ Global GTT views :internal: GTT Fences and Swizzling -~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------ .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence.c :internal: Global GTT Fence Handling -^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~ .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence.c :doc: fence register handling Hardware Tiling and Swizzling Details -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence.c :doc: tiling swizzling details Object Tiling IOCTLs -~~~~~~~~~~~~~~~~~~~~ +-------------------- .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_tiling.c :internal: @@ -270,7 +271,7 @@ Object Tiling IOCTLs :doc: buffer object tiling Buffer Object Eviction -~~~~~~~~~~~~~~~~~~~~~~ +---------------------- This section documents the interface functions for evicting buffer objects to make space available in the virtual gpu address spaces. Note @@ -282,7 +283,7 @@ unified memory architecture) available. :internal: Buffer Object Memory Shrinking -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------ This section documents the interface function for shrinking memory usage of buffer object caches. Shrinking is used to make main memory @@ -293,10 +294,10 @@ objects, which has the goal to make space in gpu virtual address spaces. :internal: GuC ---- +=== GuC-specific firmware loader -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +---------------------------- .. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c :doc: GuC-specific firmware loader @@ -305,7 +306,7 @@ GuC-specific firmware loader :internal: GuC-based command submission -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +---------------------------- .. kernel-doc:: drivers/gpu/drm/i915/i915_guc_submission.c :doc: GuC-based command submission @@ -314,31 +315,31 @@ GuC-based command submission :internal: GuC Firmware Layout -~~~~~~~~~~~~~~~~~~~ +------------------- .. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fwif.h :doc: GuC Firmware Layout Tracing -------- +======= This sections covers all things related to the tracepoints implemented in the i915 driver. i915_ppgtt_create and i915_ppgtt_release -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +---------------------------------------- .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h :doc: i915_ppgtt_create and i915_ppgtt_release tracepoints i915_context_create and i915_context_free -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +----------------------------------------- .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h :doc: i915_context_create and i915_context_free tracepoints switch_mm -~~~~~~~~~~ +--------- .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h :doc: switch_mm tracepoint |