Merge tag 'nfs-for-5.19-1' of git://git.linux-nfs.org/projects/anna/linux-nfs
[linux-block.git] / Documentation / gpu / i915.rst
CommitLineData
22554020
JN
1===========================
2 drm/i915 Intel GFX Driver
3===========================
ca00c2b9
JN
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
22554020 11==========================
ca00c2b9
JN
12
13This section covers core driver infrastructure used by both the display
14and the GEM parts of the driver.
15
16Runtime Power Management
22554020 17------------------------
ca00c2b9
JN
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
22554020 29------------------
ca00c2b9
JN
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)
22554020 44-------------------------------
ca00c2b9
JN
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
22681c7b
ZW
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
7d3c425f
OM
61Workarounds
62-----------
63
bcc8737d 64.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_workarounds.c
7d3c425f
OM
65 :doc: Hardware workarounds
66
ca00c2b9 67Display Hardware Handling
22554020 68=========================
ca00c2b9
JN
69
70This section covers everything related to the display hardware including
71the mode setting infrastructure, plane, sprite and cursor handling and
72display, output probing and related topics.
73
74Mode Setting Infrastructure
22554020 75---------------------------
ca00c2b9
JN
76
77The i915 driver is thus far the only DRM driver which doesn't use the
78common DRM helper code to implement mode setting sequences. Thus it has
79its own tailor-made infrastructure for executing a display configuration
80change.
81
82Frontbuffer Tracking
22554020 83--------------------
ca00c2b9 84
6800d9a5 85.. kernel-doc:: drivers/gpu/drm/i915/display/intel_frontbuffer.c
ca00c2b9
JN
86 :doc: frontbuffer tracking
87
6800d9a5 88.. kernel-doc:: drivers/gpu/drm/i915/display/intel_frontbuffer.h
5d723d7a
CW
89 :internal:
90
6800d9a5 91.. kernel-doc:: drivers/gpu/drm/i915/display/intel_frontbuffer.c
ca00c2b9
JN
92 :internal:
93
ca00c2b9 94Display FIFO Underrun Reporting
22554020 95-------------------------------
ca00c2b9 96
6800d9a5 97.. kernel-doc:: drivers/gpu/drm/i915/display/intel_fifo_underrun.c
ca00c2b9
JN
98 :doc: fifo underrun handling
99
6800d9a5 100.. kernel-doc:: drivers/gpu/drm/i915/display/intel_fifo_underrun.c
ca00c2b9
JN
101 :internal:
102
103Plane Configuration
22554020 104-------------------
ca00c2b9
JN
105
106This section covers plane configuration and composition with the primary
107plane, sprites, cursors and overlays. This includes the infrastructure
108to do atomic vsync'ed updates of all this state and also tightly coupled
109topics like watermark setup and computation, framebuffer compression and
110panel self refresh.
111
112Atomic Plane Helpers
22554020 113--------------------
ca00c2b9 114
6800d9a5 115.. kernel-doc:: drivers/gpu/drm/i915/display/intel_atomic_plane.c
ca00c2b9
JN
116 :doc: atomic plane helpers
117
6800d9a5 118.. kernel-doc:: drivers/gpu/drm/i915/display/intel_atomic_plane.c
ca00c2b9
JN
119 :internal:
120
6914c968
K
121Asynchronous Page Flip
122----------------------
123
124.. kernel-doc:: drivers/gpu/drm/i915/display/intel_display.c
125 :doc: asynchronous flip implementation
126
ca00c2b9 127Output Probing
22554020 128--------------
ca00c2b9
JN
129
130This section covers output probing and related infrastructure like the
131hotplug interrupt storm detection and mitigation code. Note that the
132i915 driver still uses most of the common DRM helper code for output
133probing, so those sections fully apply.
134
135Hotplug
22554020 136-------
ca00c2b9 137
6800d9a5 138.. kernel-doc:: drivers/gpu/drm/i915/display/intel_hotplug.c
ca00c2b9
JN
139 :doc: Hotplug
140
6800d9a5 141.. kernel-doc:: drivers/gpu/drm/i915/display/intel_hotplug.c
ca00c2b9
JN
142 :internal:
143
144High Definition Audio
22554020 145---------------------
ca00c2b9 146
6800d9a5 147.. kernel-doc:: drivers/gpu/drm/i915/display/intel_audio.c
ca00c2b9
JN
148 :doc: High Definition Audio over HDMI and Display Port
149
6800d9a5 150.. kernel-doc:: drivers/gpu/drm/i915/display/intel_audio.c
ca00c2b9
JN
151 :internal:
152
153.. kernel-doc:: include/drm/i915_component.h
154 :internal:
155
eacc8daf
TI
156Intel HDMI LPE Audio Support
157----------------------------
158
6800d9a5 159.. kernel-doc:: drivers/gpu/drm/i915/display/intel_lpe_audio.c
eacc8daf
TI
160 :doc: LPE Audio integration for HDMI or DP playback
161
6800d9a5 162.. kernel-doc:: drivers/gpu/drm/i915/display/intel_lpe_audio.c
eacc8daf
TI
163 :internal:
164
ca00c2b9 165Panel Self Refresh PSR (PSR/SRD)
22554020 166--------------------------------
ca00c2b9 167
6800d9a5 168.. kernel-doc:: drivers/gpu/drm/i915/display/intel_psr.c
ca00c2b9
JN
169 :doc: Panel Self Refresh (PSR/SRD)
170
6800d9a5 171.. kernel-doc:: drivers/gpu/drm/i915/display/intel_psr.c
ca00c2b9
JN
172 :internal:
173
174Frame Buffer Compression (FBC)
22554020 175------------------------------
ca00c2b9 176
6800d9a5 177.. kernel-doc:: drivers/gpu/drm/i915/display/intel_fbc.c
ca00c2b9
JN
178 :doc: Frame Buffer Compression (FBC)
179
6800d9a5 180.. kernel-doc:: drivers/gpu/drm/i915/display/intel_fbc.c
ca00c2b9
JN
181 :internal:
182
183Display Refresh Rate Switching (DRRS)
22554020 184-------------------------------------
ca00c2b9 185
a1b63119 186.. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
ca00c2b9
JN
187 :doc: Display Refresh Rate Switching (DRRS)
188
a1b63119 189.. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
fd048473 190 :internal:
ca00c2b9
JN
191
192DPIO
22554020 193----
ca00c2b9 194
6800d9a5 195.. kernel-doc:: drivers/gpu/drm/i915/display/intel_dpio_phy.c
ca00c2b9
JN
196 :doc: DPIO
197
32f9402d
AS
198DMC Firmware Support
199--------------------
ca00c2b9 200
32f9402d
AS
201.. kernel-doc:: drivers/gpu/drm/i915/display/intel_dmc.c
202 :doc: DMC Firmware Support
ca00c2b9 203
32f9402d 204.. kernel-doc:: drivers/gpu/drm/i915/display/intel_dmc.c
ca00c2b9
JN
205 :internal:
206
207Video BIOS Table (VBT)
22554020 208----------------------
ca00c2b9 209
6800d9a5 210.. kernel-doc:: drivers/gpu/drm/i915/display/intel_bios.c
ca00c2b9
JN
211 :doc: Video BIOS Table (VBT)
212
6800d9a5 213.. kernel-doc:: drivers/gpu/drm/i915/display/intel_bios.c
ca00c2b9
JN
214 :internal:
215
6800d9a5 216.. kernel-doc:: drivers/gpu/drm/i915/display/intel_vbt_defs.h
ca00c2b9
JN
217 :internal:
218
7ff89ca2
VS
219Display clocks
220--------------
221
6800d9a5 222.. kernel-doc:: drivers/gpu/drm/i915/display/intel_cdclk.c
7ff89ca2
VS
223 :doc: CDCLK / RAWCLK
224
6800d9a5 225.. kernel-doc:: drivers/gpu/drm/i915/display/intel_cdclk.c
7ff89ca2
VS
226 :internal:
227
294591cf
ACO
228Display PLLs
229------------
230
6800d9a5 231.. kernel-doc:: drivers/gpu/drm/i915/display/intel_dpll_mgr.c
294591cf
ACO
232 :doc: Display PLLs
233
6800d9a5 234.. kernel-doc:: drivers/gpu/drm/i915/display/intel_dpll_mgr.c
294591cf
ACO
235 :internal:
236
6800d9a5 237.. kernel-doc:: drivers/gpu/drm/i915/display/intel_dpll_mgr.h
294591cf
ACO
238 :internal:
239
5dd85e72
AM
240Display State Buffer
241--------------------
242
243.. kernel-doc:: drivers/gpu/drm/i915/display/intel_dsb.c
244 :doc: DSB
245
246.. kernel-doc:: drivers/gpu/drm/i915/display/intel_dsb.c
247 :internal:
248
ca00c2b9 249Memory Management and Command Submission
22554020 250========================================
ca00c2b9
JN
251
252This sections covers all things related to the GEM implementation in the
253i915 driver.
254
fd5ff5f6
KR
255Intel GPU Basics
256----------------
257
258An Intel GPU has multiple engines. There are several engine types.
259
260- RCS engine is for rendering 3D and performing compute, this is named
261 `I915_EXEC_RENDER` in user space.
262- BCS is a blitting (copy) engine, this is named `I915_EXEC_BLT` in user
263 space.
264- VCS is a video encode and decode engine, this is named `I915_EXEC_BSD`
265 in user space
266- VECS is video enhancement engine, this is named `I915_EXEC_VEBOX` in user
267 space.
268- The enumeration `I915_EXEC_DEFAULT` does not refer to specific engine;
269 instead it is to be used by user space to specify a default rendering
270 engine (for 3D) that may or may not be the same as RCS.
271
272The Intel GPU family is a family of integrated GPU's using Unified
273Memory Access. For having the GPU "do work", user space will feed the
274GPU batch buffers via one of the ioctls `DRM_IOCTL_I915_GEM_EXECBUFFER2`
275or `DRM_IOCTL_I915_GEM_EXECBUFFER2_WR`. Most such batchbuffers will
276instruct the GPU to perform work (for example rendering) and that work
277needs memory from which to read and memory to which to write. All memory
278is encapsulated within GEM buffer objects (usually created with the ioctl
279`DRM_IOCTL_I915_GEM_CREATE`). An ioctl providing a batchbuffer for the GPU
280to create will also list all GEM buffer objects that the batchbuffer reads
281and/or writes. For implementation details of memory management see
282`GEM BO Management Implementation Details`_.
283
284The i915 driver allows user space to create a context via the ioctl
285`DRM_IOCTL_I915_GEM_CONTEXT_CREATE` which is identified by a 32-bit
286integer. Such a context should be viewed by user-space as -loosely-
287analogous to the idea of a CPU process of an operating system. The i915
288driver guarantees that commands issued to a fixed context are to be
289executed so that writes of a previously issued command are seen by
290reads of following commands. Actions issued between different contexts
291(even if from the same file descriptor) are NOT given that guarantee
292and the only way to synchronize across contexts (even from the same
293file descriptor) is through the use of fences. At least as far back as
294Gen4, also have that a context carries with it a GPU HW context;
295the HW context is essentially (most of atleast) the state of a GPU.
296In addition to the ordering guarantees, the kernel will restore GPU
297state via HW context when commands are issued to a context, this saves
298user space the need to restore (most of atleast) the GPU state at the
299start of each batchbuffer. The non-deprecated ioctls to submit batchbuffer
300work can pass that ID (in the lower bits of drm_i915_gem_execbuffer2::rsvd1)
301to identify what context to use with the command.
302
303The GPU has its own memory management and address space. The kernel
304driver maintains the memory translation table for the GPU. For older
305GPUs (i.e. those before Gen8), there is a single global such translation
306table, a global Graphics Translation Table (GTT). For newer generation
307GPUs each context has its own translation table, called Per-Process
308Graphics Translation Table (PPGTT). Of important note, is that although
309PPGTT is named per-process it is actually per context. When user space
310submits a batchbuffer, the kernel walks the list of GEM buffer objects
311used by the batchbuffer and guarantees that not only is the memory of
312each such GEM buffer object resident but it is also present in the
313(PP)GTT. If the GEM buffer object is not yet placed in the (PP)GTT,
314then it is given an address. Two consequences of this are: the kernel
315needs to edit the batchbuffer submitted to write the correct value of
316the GPU address when a GEM BO is assigned a GPU address and the kernel
317might evict a different GEM BO from the (PP)GTT to make address room
318for another GEM BO. Consequently, the ioctls submitting a batchbuffer
319for execution also include a list of all locations within buffers that
320refer to GPU-addresses so that the kernel can edit the buffer correctly.
321This process is dubbed relocation.
322
ca69a3c6
JL
323Locking Guidelines
324------------------
325
326.. note::
327 This is a description of how the locking should be after
328 refactoring is done. Does not necessarily reflect what the locking
329 looks like while WIP.
330
331#. All locking rules and interface contracts with cross-driver interfaces
332 (dma-buf, dma_fence) need to be followed.
333
334#. No struct_mutex anywhere in the code
335
336#. dma_resv will be the outermost lock (when needed) and ww_acquire_ctx
337 is to be hoisted at highest level and passed down within i915_gem_ctx
338 in the call chain
339
340#. While holding lru/memory manager (buddy, drm_mm, whatever) locks
341 system memory allocations are not allowed
342
343 * Enforce this by priming lockdep (with fs_reclaim). If we
344 allocate memory while holding these looks we get a rehash
345 of the shrinker vs. struct_mutex saga, and that would be
346 real bad.
347
348#. Do not nest different lru/memory manager locks within each other.
349 Take them in turn to update memory allocations, relying on the object’s
350 dma_resv ww_mutex to serialize against other operations.
351
352#. The suggestion for lru/memory managers locks is that they are small
353 enough to be spinlocks.
354
355#. All features need to come with exhaustive kernel selftests and/or
356 IGT tests when appropriate
357
358#. All LMEM uAPI paths need to be fully restartable (_interruptible()
359 for all locks/waits/sleeps)
360
361 * Error handling validation through signal injection.
362 Still the best strategy we have for validating GEM uAPI
363 corner cases.
364 Must be excessively used in the IGT, and we need to check
365 that we really have full path coverage of all error cases.
366
367 * -EDEADLK handling with ww_mutex
368
fd5ff5f6
KR
369GEM BO Management Implementation Details
370----------------------------------------
371
83dc7f69 372.. kernel-doc:: drivers/gpu/drm/i915/i915_vma_types.h
fd5ff5f6
KR
373 :doc: Virtual Memory Address
374
375Buffer Object Eviction
376----------------------
377
378This section documents the interface functions for evicting buffer
379objects to make space available in the virtual gpu address spaces. Note
380that this is mostly orthogonal to shrinking buffer objects caches, which
381has the goal to make main memory (shared with the gpu through the
382unified memory architecture) available.
383
384.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_evict.c
385 :internal:
386
387Buffer Object Memory Shrinking
388------------------------------
389
390This section documents the interface function for shrinking memory usage
391of buffer object caches. Shrinking is used to make main memory
392available. Note that this is mostly orthogonal to evicting buffer
393objects, which has the goal to make space in gpu virtual address spaces.
394
8a6f43d4 395.. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_shrinker.c
fd5ff5f6
KR
396 :internal:
397
ca00c2b9 398Batchbuffer Parsing
22554020 399-------------------
ca00c2b9
JN
400
401.. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_parser.c
402 :doc: batch buffer command parser
403
404.. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_parser.c
405 :internal:
406
4d42db18
KR
407User Batchbuffer Execution
408--------------------------
409
f8a9a5c2
JE
410.. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_context_types.h
411
8a6f43d4 412.. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_execbuffer.c
4d42db18
KR
413 :doc: User command execution
414
3e28d371
MB
415Scheduling
416----------
417.. kernel-doc:: drivers/gpu/drm/i915/i915_scheduler_types.h
418 :functions: i915_sched_engine
419
ca00c2b9 420Logical Rings, Logical Ring Contexts and Execlists
22554020 421--------------------------------------------------
ca00c2b9 422
3b7bc18b 423.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_execlists_submission.c
ca00c2b9
JN
424 :doc: Logical Rings, Logical Ring Contexts and Execlists
425
ca00c2b9 426Global GTT views
22554020 427----------------
ca00c2b9 428
83dc7f69 429.. kernel-doc:: drivers/gpu/drm/i915/i915_vma_types.h
ca00c2b9
JN
430 :doc: Global GTT views
431
432.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_gtt.c
433 :internal:
434
435GTT Fences and Swizzling
22554020 436------------------------
ca00c2b9 437
ba69fb16 438.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ggtt_fencing.c
ca00c2b9
JN
439 :internal:
440
441Global GTT Fence Handling
22554020 442~~~~~~~~~~~~~~~~~~~~~~~~~
ca00c2b9 443
ba69fb16 444.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ggtt_fencing.c
ca00c2b9
JN
445 :doc: fence register handling
446
447Hardware Tiling and Swizzling Details
22554020 448~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ca00c2b9 449
ba69fb16 450.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ggtt_fencing.c
ca00c2b9
JN
451 :doc: tiling swizzling details
452
453Object Tiling IOCTLs
22554020 454--------------------
ca00c2b9 455
8a6f43d4 456.. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_tiling.c
ca00c2b9
JN
457 :internal:
458
8a6f43d4 459.. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_tiling.c
ca00c2b9
JN
460 :doc: buffer object tiling
461
2d5517a5
DCS
462Protected Objects
463-----------------
464
465.. kernel-doc:: drivers/gpu/drm/i915/pxp/intel_pxp.c
466 :doc: PXP
467
468.. kernel-doc:: drivers/gpu/drm/i915/pxp/intel_pxp_types.h
469
493065e2
DCS
470Microcontrollers
471================
472
473Starting from gen9, three microcontrollers are available on the HW: the
474graphics microcontroller (GuC), the HEVC/H.265 microcontroller (HuC) and the
475display microcontroller (DMC). The driver is responsible for loading the
476firmwares on the microcontrollers; the GuC and HuC firmwares are transferred
477to WOPCM using the DMA engine, while the DMC firmware is written through MMIO.
478
fbe6f8f2 479WOPCM
4072761b 480-----
fbe6f8f2
YL
481
482WOPCM Layout
4072761b 483~~~~~~~~~~~~
fbe6f8f2
YL
484
485.. kernel-doc:: drivers/gpu/drm/i915/intel_wopcm.c
486 :doc: WOPCM Layout
487
ca00c2b9 488GuC
4072761b 489---
ca00c2b9 490
218151e9
DCS
491.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.c
492 :doc: GuC
493
4f41ddc7
MB
494.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.h
495
218151e9
DCS
496GuC Firmware Layout
497~~~~~~~~~~~~~~~~~~~
199ddded 498
abf30f23 499.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h
199ddded
MW
500 :doc: Firmware Layout
501
218151e9
DCS
502GuC Memory Management
503~~~~~~~~~~~~~~~~~~~~~
504
505.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.c
506 :doc: GuC Memory Management
507.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.c
508 :functions: intel_guc_allocate_vma
509
510
ca00c2b9 511GuC-specific firmware loader
4072761b 512~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ca00c2b9 513
dbbff8c3 514.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_fw.c
ca00c2b9
JN
515 :internal:
516
517GuC-based command submission
4072761b 518~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ca00c2b9 519
dbbff8c3 520.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_submission.c
ca00c2b9
JN
521 :doc: GuC-based command submission
522
bfde26df
MW
523GuC ABI
524~~~~~~~~~~~~~~~~~~~~~~~~~~~~
525
526.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_messages_abi.h
527.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h
528.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h
529.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_actions_abi.h
77b6f79d 530.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_klvs_abi.h
bfde26df 531
493065e2
DCS
532HuC
533---
0b23e2a6
DCS
534.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc.c
535 :doc: HuC
536.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc.c
537 :functions: intel_huc_auth
538
539HuC Memory Management
540~~~~~~~~~~~~~~~~~~~~~
541
542.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc.c
543 :doc: HuC Memory Management
544
545HuC Firmware Layout
546~~~~~~~~~~~~~~~~~~~
547The HuC FW layout is the same as the GuC one, see `GuC Firmware Layout`_
493065e2
DCS
548
549DMC
550---
32f9402d 551See `DMC Firmware Support`_
493065e2 552
ca00c2b9 553Tracing
22554020 554=======
ca00c2b9
JN
555
556This sections covers all things related to the tracepoints implemented
557in the i915 driver.
558
559i915_ppgtt_create and i915_ppgtt_release
22554020 560----------------------------------------
ca00c2b9
JN
561
562.. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
563 :doc: i915_ppgtt_create and i915_ppgtt_release tracepoints
564
565i915_context_create and i915_context_free
22554020 566-----------------------------------------
ca00c2b9
JN
567
568.. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
569 :doc: i915_context_create and i915_context_free tracepoints
570
16d98b31
RB
571Perf
572====
573
574Overview
575--------
576.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
577 :doc: i915 Perf Overview
578
579Comparison with Core Perf
580-------------------------
581.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
582 :doc: i915 Perf History and Comparison with Core Perf
583
584i915 Driver Entry Points
585------------------------
586
587This section covers the entrypoints exported outside of i915_perf.c to
588integrate with drm/i915 and to handle the `DRM_I915_PERF_OPEN` ioctl.
589
590.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
591 :functions: i915_perf_init
592.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
593 :functions: i915_perf_fini
594.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
595 :functions: i915_perf_register
596.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
597 :functions: i915_perf_unregister
598.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
599 :functions: i915_perf_open_ioctl
600.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
601 :functions: i915_perf_release
f89823c2
LL
602.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
603 :functions: i915_perf_add_config_ioctl
604.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
605 :functions: i915_perf_remove_config_ioctl
16d98b31
RB
606
607i915 Perf Stream
608----------------
609
610This section covers the stream-semantics-agnostic structures and functions
611for representing an i915 perf stream FD and associated file operations.
612
8c638802 613.. kernel-doc:: drivers/gpu/drm/i915/i915_perf_types.h
16d98b31 614 :functions: i915_perf_stream
8c638802 615.. kernel-doc:: drivers/gpu/drm/i915/i915_perf_types.h
16d98b31
RB
616 :functions: i915_perf_stream_ops
617
618.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
619 :functions: read_properties_unlocked
620.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
621 :functions: i915_perf_open_ioctl_locked
622.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
623 :functions: i915_perf_destroy_locked
624.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
625 :functions: i915_perf_read
626.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
627 :functions: i915_perf_ioctl
628.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
629 :functions: i915_perf_enable_locked
630.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
631 :functions: i915_perf_disable_locked
632.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
633 :functions: i915_perf_poll
634.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
635 :functions: i915_perf_poll_locked
636
637i915 Perf Observation Architecture Stream
638-----------------------------------------
639
8c638802 640.. kernel-doc:: drivers/gpu/drm/i915/i915_perf_types.h
16d98b31
RB
641 :functions: i915_oa_ops
642
643.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
644 :functions: i915_oa_stream_init
645.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
646 :functions: i915_oa_read
647.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
648 :functions: i915_oa_stream_enable
649.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
650 :functions: i915_oa_stream_disable
651.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
652 :functions: i915_oa_wait_unlocked
653.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
654 :functions: i915_oa_poll_wait
655
11604da2
MCC
656Other i915 Perf Internals
657-------------------------
16d98b31 658
11604da2
MCC
659This section simply includes all other currently documented i915 perf internals,
660in no particular order, but may include some more minor utilities or platform
16d98b31
RB
661specific details than found in the more high-level sections.
662
663.. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
664 :internal:
11604da2
MCC
665 :no-identifiers:
666 i915_perf_init
667 i915_perf_fini
668 i915_perf_register
669 i915_perf_unregister
670 i915_perf_open_ioctl
671 i915_perf_release
672 i915_perf_add_config_ioctl
673 i915_perf_remove_config_ioctl
674 read_properties_unlocked
675 i915_perf_open_ioctl_locked
676 i915_perf_destroy_locked
677 i915_perf_read i915_perf_ioctl
678 i915_perf_enable_locked
679 i915_perf_disable_locked
680 i915_perf_poll i915_perf_poll_locked
681 i915_oa_stream_init i915_oa_read
682 i915_oa_stream_enable
683 i915_oa_stream_disable
684 i915_oa_wait_unlocked
685 i915_oa_poll_wait
1aa920ea
JN
686
687Style
688=====
689
690The drm/i915 driver codebase has some style rules in addition to (and, in some
691cases, deviating from) the kernel coding style.
692
693Register macro definition style
694-------------------------------
695
696The style guide for ``i915_reg.h``.
697
698.. kernel-doc:: drivers/gpu/drm/i915/i915_reg.h
699 :doc: The i915 register macro definition style guide
055634e4
TU
700
701.. _i915-usage-stats:
702
703i915 DRM client usage stats implementation
704==========================================
705
706The drm/i915 driver implements the DRM client usage stats specification as
707documented in :ref:`drm-client-usage-stats`.
708
709Example of the output showing the implemented key value pairs and entirety of
710the currently possible format options:
711
712::
713
714 pos: 0
715 flags: 0100002
716 mnt_id: 21
717 drm-driver: i915
718 drm-pdev: 0000:00:02.0
719 drm-client-id: 7
720 drm-engine-render: 9288864723 ns
721 drm-engine-copy: 2035071108 ns
722 drm-engine-video: 0 ns
723 drm-engine-capacity-video: 2
724 drm-engine-video-enhance: 0 ns
725
726Possible `drm-engine-` key names are: `render`, `copy`, `video` and
727`video-enhance`.