xref: /openbmc/linux/Documentation/gpu/i915.rst (revision 8730046c)
1===========================
2 drm/i915 Intel GFX Driver
3===========================
4
5The drm/i915 driver supports all (with the exception of some very early
6models) integrated GFX chipsets with both Intel display and rendering
7blocks. This excludes a set of SoC platforms with an SGX rendering unit,
8those have basic support through the gma500 drm driver.
9
10Core Driver Infrastructure
11==========================
12
13This section covers core driver infrastructure used by both the display
14and the GEM parts of the driver.
15
16Runtime 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
28Interrupt 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
43Intel 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
52Intel 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
61Display Hardware Handling
62=========================
63
64This section covers everything related to the display hardware including
65the mode setting infrastructure, plane, sprite and cursor handling and
66display, output probing and related topics.
67
68Mode Setting Infrastructure
69---------------------------
70
71The i915 driver is thus far the only DRM driver which doesn't use the
72common DRM helper code to implement mode setting sequences. Thus it has
73its own tailor-made infrastructure for executing a display configuration
74change.
75
76Frontbuffer 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
91Display 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
100Plane Configuration
101-------------------
102
103This section covers plane configuration and composition with the primary
104plane, sprites, cursors and overlays. This includes the infrastructure
105to do atomic vsync'ed updates of all this state and also tightly coupled
106topics like watermark setup and computation, framebuffer compression and
107panel self refresh.
108
109Atomic 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
118Output Probing
119--------------
120
121This section covers output probing and related infrastructure like the
122hotplug interrupt storm detection and mitigation code. Note that the
123i915 driver still uses most of the common DRM helper code for output
124probing, so those sections fully apply.
125
126Hotplug
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
135High 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
147Panel Self Refresh PSR (PSR/SRD)
148--------------------------------
149
150.. kernel-doc:: drivers/gpu/drm/i915/intel_psr.c
151   :doc: Panel Self Refresh (PSR/SRD)
152
153.. kernel-doc:: drivers/gpu/drm/i915/intel_psr.c
154   :internal:
155
156Frame Buffer Compression (FBC)
157------------------------------
158
159.. kernel-doc:: drivers/gpu/drm/i915/intel_fbc.c
160   :doc: Frame Buffer Compression (FBC)
161
162.. kernel-doc:: drivers/gpu/drm/i915/intel_fbc.c
163   :internal:
164
165Display Refresh Rate Switching (DRRS)
166-------------------------------------
167
168.. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
169   :doc: Display Refresh Rate Switching (DRRS)
170
171.. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
172   :functions: intel_dp_set_drrs_state
173
174.. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
175   :functions: intel_edp_drrs_enable
176
177.. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
178   :functions: intel_edp_drrs_disable
179
180.. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
181   :functions: intel_edp_drrs_invalidate
182
183.. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
184   :functions: intel_edp_drrs_flush
185
186.. kernel-doc:: drivers/gpu/drm/i915/intel_dp.c
187   :functions: intel_dp_drrs_init
188
189DPIO
190----
191
192.. kernel-doc:: drivers/gpu/drm/i915/intel_dpio_phy.c
193   :doc: DPIO
194
195CSR firmware support for DMC
196----------------------------
197
198.. kernel-doc:: drivers/gpu/drm/i915/intel_csr.c
199   :doc: csr support for dmc
200
201.. kernel-doc:: drivers/gpu/drm/i915/intel_csr.c
202   :internal:
203
204Video BIOS Table (VBT)
205----------------------
206
207.. kernel-doc:: drivers/gpu/drm/i915/intel_bios.c
208   :doc: Video BIOS Table (VBT)
209
210.. kernel-doc:: drivers/gpu/drm/i915/intel_bios.c
211   :internal:
212
213.. kernel-doc:: drivers/gpu/drm/i915/intel_vbt_defs.h
214   :internal:
215
216Memory Management and Command Submission
217========================================
218
219This sections covers all things related to the GEM implementation in the
220i915 driver.
221
222Batchbuffer Parsing
223-------------------
224
225.. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_parser.c
226   :doc: batch buffer command parser
227
228.. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_parser.c
229   :internal:
230
231Batchbuffer Pools
232-----------------
233
234.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_batch_pool.c
235   :doc: batch pool
236
237.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_batch_pool.c
238   :internal:
239
240Logical Rings, Logical Ring Contexts and Execlists
241--------------------------------------------------
242
243.. kernel-doc:: drivers/gpu/drm/i915/intel_lrc.c
244   :doc: Logical Rings, Logical Ring Contexts and Execlists
245
246.. kernel-doc:: drivers/gpu/drm/i915/intel_lrc.c
247   :internal:
248
249Global GTT views
250----------------
251
252.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_gtt.c
253   :doc: Global GTT views
254
255.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_gtt.c
256   :internal:
257
258GTT Fences and Swizzling
259------------------------
260
261.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence_reg.c
262   :internal:
263
264Global GTT Fence Handling
265~~~~~~~~~~~~~~~~~~~~~~~~~
266
267.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence_reg.c
268   :doc: fence register handling
269
270Hardware Tiling and Swizzling Details
271~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
272
273.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence_reg.c
274   :doc: tiling swizzling details
275
276Object Tiling IOCTLs
277--------------------
278
279.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_tiling.c
280   :internal:
281
282.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_tiling.c
283   :doc: buffer object tiling
284
285Buffer Object Eviction
286----------------------
287
288This section documents the interface functions for evicting buffer
289objects to make space available in the virtual gpu address spaces. Note
290that this is mostly orthogonal to shrinking buffer objects caches, which
291has the goal to make main memory (shared with the gpu through the
292unified memory architecture) available.
293
294.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_evict.c
295   :internal:
296
297Buffer Object Memory Shrinking
298------------------------------
299
300This section documents the interface function for shrinking memory usage
301of buffer object caches. Shrinking is used to make main memory
302available. Note that this is mostly orthogonal to evicting buffer
303objects, which has the goal to make space in gpu virtual address spaces.
304
305.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_shrinker.c
306   :internal:
307
308GuC
309===
310
311GuC-specific firmware loader
312----------------------------
313
314.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
315   :doc: GuC-specific firmware loader
316
317.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
318   :internal:
319
320GuC-based command submission
321----------------------------
322
323.. kernel-doc:: drivers/gpu/drm/i915/i915_guc_submission.c
324   :doc: GuC-based command submission
325
326.. kernel-doc:: drivers/gpu/drm/i915/i915_guc_submission.c
327   :internal:
328
329GuC Firmware Layout
330-------------------
331
332.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fwif.h
333   :doc: GuC Firmware Layout
334
335Tracing
336=======
337
338This sections covers all things related to the tracepoints implemented
339in the i915 driver.
340
341i915_ppgtt_create and i915_ppgtt_release
342----------------------------------------
343
344.. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
345   :doc: i915_ppgtt_create and i915_ppgtt_release tracepoints
346
347i915_context_create and i915_context_free
348-----------------------------------------
349
350.. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
351   :doc: i915_context_create and i915_context_free tracepoints
352
353switch_mm
354---------
355
356.. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
357   :doc: switch_mm tracepoint
358
359.. WARNING: DOCPROC directive not supported: !Cdrivers/gpu/drm/i915/i915_irq.c
360