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