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 206
207 DMC wakelock support <<
208 -------------------- <<
209 <<
210 .. kernel-doc:: drivers/gpu/drm/i915/display/i <<
211 :doc: DMC wakelock support <<
212 <<
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 <<
256 ============== <<
257 <<
258 Multicast/Replicated (MCR) Registers <<
259 ------------------------------------ <<
260 <<
261 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ <<
262 :doc: GT Multicast/Replicated (MCR) Registe <<
263 <<
264 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ <<
265 :internal: <<
266 <<
267 Memory Management and Command Submission 249 Memory Management and Command Submission
268 ======================================== 250 ========================================
269 251
270 This sections covers all things related to the 252 This sections covers all things related to the GEM implementation in the
271 i915 driver. 253 i915 driver.
272 254
273 Intel GPU Basics 255 Intel GPU Basics
274 ---------------- 256 ----------------
275 257
276 An Intel GPU has multiple engines. There are s !! 258 An Intel GPU has multiple engines. There are several engine types.
277 259
278 - Render Command Streamer (RCS). An engine for !! 260 - RCS engine is for rendering 3D and performing compute, this is named
279 performing compute. !! 261 `I915_EXEC_RENDER` in user space.
280 - Blitting Command Streamer (BCS). An engine f !! 262 - BCS is a blitting (copy) engine, this is named `I915_EXEC_BLT` in user
281 copying operations. !! 263 space.
282 - Video Command Streamer. An engine used for v !! 264 - VCS is a video encode and decode engine, this is named `I915_EXEC_BSD`
283 sometimes called 'BSD' in hardware documenta !! 265 in user space
284 - Video Enhancement Command Streamer (VECS). A !! 266 - VECS is video enhancement engine, this is named `I915_EXEC_VEBOX` in user
285 Also sometimes called 'VEBOX' in hardware do !! 267 space.
286 - Compute Command Streamer (CCS). An engine th !! 268 - The enumeration `I915_EXEC_DEFAULT` does not refer to specific engine;
287 GPGPU pipelines, but not the 3D pipeline. !! 269 instead it is to be used by user space to specify a default rendering
288 - Graphics Security Controller (GSCCS). A dedi !! 270 engine (for 3D) that may or may not be the same as RCS.
289 communication with GSC controller on securit <<
290 High-bandwidth Digital Content Protection (H <<
291 and HuC firmware authentication. <<
292 271
293 The Intel GPU family is a family of integrated 272 The Intel GPU family is a family of integrated GPU's using Unified
294 Memory Access. For having the GPU "do work", u 273 Memory Access. For having the GPU "do work", user space will feed the
295 GPU batch buffers via one of the ioctls `DRM_I 274 GPU batch buffers via one of the ioctls `DRM_IOCTL_I915_GEM_EXECBUFFER2`
296 or `DRM_IOCTL_I915_GEM_EXECBUFFER2_WR`. Most s 275 or `DRM_IOCTL_I915_GEM_EXECBUFFER2_WR`. Most such batchbuffers will
297 instruct the GPU to perform work (for example 276 instruct the GPU to perform work (for example rendering) and that work
298 needs memory from which to read and memory to 277 needs memory from which to read and memory to which to write. All memory
299 is encapsulated within GEM buffer objects (usu 278 is encapsulated within GEM buffer objects (usually created with the ioctl
300 `DRM_IOCTL_I915_GEM_CREATE`). An ioctl providi 279 `DRM_IOCTL_I915_GEM_CREATE`). An ioctl providing a batchbuffer for the GPU
301 to create will also list all GEM buffer object 280 to create will also list all GEM buffer objects that the batchbuffer reads
302 and/or writes. For implementation details of m 281 and/or writes. For implementation details of memory management see
303 `GEM BO Management Implementation Details`_. 282 `GEM BO Management Implementation Details`_.
304 283
305 The i915 driver allows user space to create a 284 The i915 driver allows user space to create a context via the ioctl
306 `DRM_IOCTL_I915_GEM_CONTEXT_CREATE` which is i 285 `DRM_IOCTL_I915_GEM_CONTEXT_CREATE` which is identified by a 32-bit
307 integer. Such a context should be viewed by us 286 integer. Such a context should be viewed by user-space as -loosely-
308 analogous to the idea of a CPU process of an o 287 analogous to the idea of a CPU process of an operating system. The i915
309 driver guarantees that commands issued to a fi 288 driver guarantees that commands issued to a fixed context are to be
310 executed so that writes of a previously issued 289 executed so that writes of a previously issued command are seen by
311 reads of following commands. Actions issued be 290 reads of following commands. Actions issued between different contexts
312 (even if from the same file descriptor) are NO 291 (even if from the same file descriptor) are NOT given that guarantee
313 and the only way to synchronize across context 292 and the only way to synchronize across contexts (even from the same
314 file descriptor) is through the use of fences. 293 file descriptor) is through the use of fences. At least as far back as
315 Gen4, also have that a context carries with it 294 Gen4, also have that a context carries with it a GPU HW context;
316 the HW context is essentially (most of at leas !! 295 the HW context is essentially (most of atleast) the state of a GPU.
317 In addition to the ordering guarantees, the ke 296 In addition to the ordering guarantees, the kernel will restore GPU
318 state via HW context when commands are issued 297 state via HW context when commands are issued to a context, this saves
319 user space the need to restore (most of at lea !! 298 user space the need to restore (most of atleast) the GPU state at the
320 start of each batchbuffer. The non-deprecated 299 start of each batchbuffer. The non-deprecated ioctls to submit batchbuffer
321 work can pass that ID (in the lower bits of dr 300 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 301 to identify what context to use with the command.
323 302
324 The GPU has its own memory management and addr 303 The GPU has its own memory management and address space. The kernel
325 driver maintains the memory translation table 304 driver maintains the memory translation table for the GPU. For older
326 GPUs (i.e. those before Gen8), there is a sing 305 GPUs (i.e. those before Gen8), there is a single global such translation
327 table, a global Graphics Translation Table (GT 306 table, a global Graphics Translation Table (GTT). For newer generation
328 GPUs each context has its own translation tabl 307 GPUs each context has its own translation table, called Per-Process
329 Graphics Translation Table (PPGTT). Of importa 308 Graphics Translation Table (PPGTT). Of important note, is that although
330 PPGTT is named per-process it is actually per 309 PPGTT is named per-process it is actually per context. When user space
331 submits a batchbuffer, the kernel walks the li 310 submits a batchbuffer, the kernel walks the list of GEM buffer objects
332 used by the batchbuffer and guarantees that no 311 used by the batchbuffer and guarantees that not only is the memory of
333 each such GEM buffer object resident but it is 312 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 313 (PP)GTT. If the GEM buffer object is not yet placed in the (PP)GTT,
335 then it is given an address. Two consequences 314 then it is given an address. Two consequences of this are: the kernel
336 needs to edit the batchbuffer submitted to wri 315 needs to edit the batchbuffer submitted to write the correct value of
337 the GPU address when a GEM BO is assigned a GP 316 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 317 might evict a different GEM BO from the (PP)GTT to make address room
339 for another GEM BO. Consequently, the ioctls s 318 for another GEM BO. Consequently, the ioctls submitting a batchbuffer
340 for execution also include a list of all locat 319 for execution also include a list of all locations within buffers that
341 refer to GPU-addresses so that the kernel can 320 refer to GPU-addresses so that the kernel can edit the buffer correctly.
342 This process is dubbed relocation. 321 This process is dubbed relocation.
343 322
344 Locking Guidelines 323 Locking Guidelines
345 ------------------ 324 ------------------
346 325
347 .. note:: 326 .. note::
348 This is a description of how the locking sh 327 This is a description of how the locking should be after
349 refactoring is done. Does not necessarily r 328 refactoring is done. Does not necessarily reflect what the locking
350 looks like while WIP. 329 looks like while WIP.
351 330
352 #. All locking rules and interface contracts w 331 #. All locking rules and interface contracts with cross-driver interfaces
353 (dma-buf, dma_fence) need to be followed. 332 (dma-buf, dma_fence) need to be followed.
354 333
355 #. No struct_mutex anywhere in the code 334 #. No struct_mutex anywhere in the code
356 335
357 #. dma_resv will be the outermost lock (when n 336 #. dma_resv will be the outermost lock (when needed) and ww_acquire_ctx
358 is to be hoisted at highest level and passe 337 is to be hoisted at highest level and passed down within i915_gem_ctx
359 in the call chain 338 in the call chain
360 339
361 #. While holding lru/memory manager (buddy, dr 340 #. While holding lru/memory manager (buddy, drm_mm, whatever) locks
362 system memory allocations are not allowed 341 system memory allocations are not allowed
363 342
364 * Enforce this by priming lockdep (wit 343 * Enforce this by priming lockdep (with fs_reclaim). If we
365 allocate memory while holding these 344 allocate memory while holding these looks we get a rehash
366 of the shrinker vs. struct_mutex sag 345 of the shrinker vs. struct_mutex saga, and that would be
367 real bad. 346 real bad.
368 347
369 #. Do not nest different lru/memory manager lo 348 #. Do not nest different lru/memory manager locks within each other.
370 Take them in turn to update memory allocati 349 Take them in turn to update memory allocations, relying on the object’s
371 dma_resv ww_mutex to serialize against othe 350 dma_resv ww_mutex to serialize against other operations.
372 351
373 #. The suggestion for lru/memory managers lock 352 #. The suggestion for lru/memory managers locks is that they are small
374 enough to be spinlocks. 353 enough to be spinlocks.
375 354
376 #. All features need to come with exhaustive k 355 #. All features need to come with exhaustive kernel selftests and/or
377 IGT tests when appropriate 356 IGT tests when appropriate
378 357
379 #. All LMEM uAPI paths need to be fully restar 358 #. All LMEM uAPI paths need to be fully restartable (_interruptible()
380 for all locks/waits/sleeps) 359 for all locks/waits/sleeps)
381 360
382 * Error handling validation through si 361 * Error handling validation through signal injection.
383 Still the best strategy we have for 362 Still the best strategy we have for validating GEM uAPI
384 corner cases. 363 corner cases.
385 Must be excessively used in the IGT, 364 Must be excessively used in the IGT, and we need to check
386 that we really have full path covera 365 that we really have full path coverage of all error cases.
387 366
388 * -EDEADLK handling with ww_mutex 367 * -EDEADLK handling with ww_mutex
389 368
390 GEM BO Management Implementation Details 369 GEM BO Management Implementation Details
391 ---------------------------------------- 370 ----------------------------------------
392 371
393 .. kernel-doc:: drivers/gpu/drm/i915/i915_vma_ 372 .. kernel-doc:: drivers/gpu/drm/i915/i915_vma_types.h
394 :doc: Virtual Memory Address 373 :doc: Virtual Memory Address
395 374
396 Buffer Object Eviction 375 Buffer Object Eviction
397 ---------------------- 376 ----------------------
398 377
399 This section documents the interface functions 378 This section documents the interface functions for evicting buffer
400 objects to make space available in the virtual 379 objects to make space available in the virtual gpu address spaces. Note
401 that this is mostly orthogonal to shrinking bu 380 that this is mostly orthogonal to shrinking buffer objects caches, which
402 has the goal to make main memory (shared with 381 has the goal to make main memory (shared with the gpu through the
403 unified memory architecture) available. 382 unified memory architecture) available.
404 383
405 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_ 384 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_evict.c
406 :internal: 385 :internal:
407 386
408 Buffer Object Memory Shrinking 387 Buffer Object Memory Shrinking
409 ------------------------------ 388 ------------------------------
410 389
411 This section documents the interface function 390 This section documents the interface function for shrinking memory usage
412 of buffer object caches. Shrinking is used to 391 of buffer object caches. Shrinking is used to make main memory
413 available. Note that this is mostly orthogonal 392 available. Note that this is mostly orthogonal to evicting buffer
414 objects, which has the goal to make space in g 393 objects, which has the goal to make space in gpu virtual address spaces.
415 394
416 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_ 395 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_shrinker.c
417 :internal: 396 :internal:
418 397
419 Batchbuffer Parsing 398 Batchbuffer Parsing
420 ------------------- 399 -------------------
421 400
422 .. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_ 401 .. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_parser.c
423 :doc: batch buffer command parser 402 :doc: batch buffer command parser
424 403
425 .. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_ 404 .. kernel-doc:: drivers/gpu/drm/i915/i915_cmd_parser.c
426 :internal: 405 :internal:
427 406
428 User Batchbuffer Execution 407 User Batchbuffer Execution
429 -------------------------- 408 --------------------------
430 409
431 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_ 410 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_context_types.h
432 411
433 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_ 412 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_execbuffer.c
434 :doc: User command execution 413 :doc: User command execution
435 414
436 Scheduling 415 Scheduling
437 ---------- 416 ----------
438 .. kernel-doc:: drivers/gpu/drm/i915/i915_sche 417 .. kernel-doc:: drivers/gpu/drm/i915/i915_scheduler_types.h
439 :functions: i915_sched_engine 418 :functions: i915_sched_engine
440 419
441 Logical Rings, Logical Ring Contexts and Execl 420 Logical Rings, Logical Ring Contexts and Execlists
442 ---------------------------------------------- 421 --------------------------------------------------
443 422
444 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ 423 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_execlists_submission.c
445 :doc: Logical Rings, Logical Ring Contexts 424 :doc: Logical Rings, Logical Ring Contexts and Execlists
446 425
447 Global GTT views 426 Global GTT views
448 ---------------- 427 ----------------
449 428
450 .. kernel-doc:: drivers/gpu/drm/i915/i915_vma_ 429 .. kernel-doc:: drivers/gpu/drm/i915/i915_vma_types.h
451 :doc: Global GTT views 430 :doc: Global GTT views
452 431
453 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_ 432 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_gtt.c
454 :internal: 433 :internal:
455 434
456 GTT Fences and Swizzling 435 GTT Fences and Swizzling
457 ------------------------ 436 ------------------------
458 437
459 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ 438 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ggtt_fencing.c
460 :internal: 439 :internal:
461 440
462 Global GTT Fence Handling 441 Global GTT Fence Handling
463 ~~~~~~~~~~~~~~~~~~~~~~~~~ 442 ~~~~~~~~~~~~~~~~~~~~~~~~~
464 443
465 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ 444 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ggtt_fencing.c
466 :doc: fence register handling 445 :doc: fence register handling
467 446
468 Hardware Tiling and Swizzling Details 447 Hardware Tiling and Swizzling Details
469 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 448 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
470 449
471 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ 450 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ggtt_fencing.c
472 :doc: tiling swizzling details 451 :doc: tiling swizzling details
473 452
474 Object Tiling IOCTLs 453 Object Tiling IOCTLs
475 -------------------- 454 --------------------
476 455
477 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_ 456 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_tiling.c
478 :internal: 457 :internal:
479 458
480 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_ 459 .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_tiling.c
481 :doc: buffer object tiling 460 :doc: buffer object tiling
482 461
483 Protected Objects 462 Protected Objects
484 ----------------- 463 -----------------
485 464
486 .. kernel-doc:: drivers/gpu/drm/i915/pxp/intel 465 .. kernel-doc:: drivers/gpu/drm/i915/pxp/intel_pxp.c
487 :doc: PXP 466 :doc: PXP
488 467
489 .. kernel-doc:: drivers/gpu/drm/i915/pxp/intel 468 .. kernel-doc:: drivers/gpu/drm/i915/pxp/intel_pxp_types.h
490 469
491 Microcontrollers 470 Microcontrollers
492 ================ 471 ================
493 472
494 Starting from gen9, three microcontrollers are 473 Starting from gen9, three microcontrollers are available on the HW: the
495 graphics microcontroller (GuC), the HEVC/H.265 474 graphics microcontroller (GuC), the HEVC/H.265 microcontroller (HuC) and the
496 display microcontroller (DMC). The driver is r 475 display microcontroller (DMC). The driver is responsible for loading the
497 firmwares on the microcontrollers; the GuC and 476 firmwares on the microcontrollers; the GuC and HuC firmwares are transferred
498 to WOPCM using the DMA engine, while the DMC f 477 to WOPCM using the DMA engine, while the DMC firmware is written through MMIO.
499 478
500 WOPCM 479 WOPCM
501 ----- 480 -----
502 481
503 WOPCM Layout 482 WOPCM Layout
504 ~~~~~~~~~~~~ 483 ~~~~~~~~~~~~
505 484
506 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ !! 485 .. kernel-doc:: drivers/gpu/drm/i915/intel_wopcm.c
507 :doc: WOPCM Layout 486 :doc: WOPCM Layout
508 487
509 GuC 488 GuC
510 --- 489 ---
511 490
512 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 491 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.c
513 :doc: GuC 492 :doc: GuC
514 493
515 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 494 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.h
516 495
517 GuC Firmware Layout 496 GuC Firmware Layout
518 ~~~~~~~~~~~~~~~~~~~ 497 ~~~~~~~~~~~~~~~~~~~
519 498
520 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 499 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h
521 :doc: Firmware Layout 500 :doc: Firmware Layout
522 501
523 GuC Memory Management 502 GuC Memory Management
524 ~~~~~~~~~~~~~~~~~~~~~ 503 ~~~~~~~~~~~~~~~~~~~~~
525 504
526 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 505 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.c
527 :doc: GuC Memory Management 506 :doc: GuC Memory Management
528 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 507 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.c
529 :functions: intel_guc_allocate_vma 508 :functions: intel_guc_allocate_vma
530 509
531 510
532 GuC-specific firmware loader 511 GuC-specific firmware loader
533 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 512 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
534 513
535 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 514 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_fw.c
536 :internal: 515 :internal:
537 516
538 GuC-based command submission 517 GuC-based command submission
539 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 518 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
540 519
541 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 520 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_submission.c
542 :doc: GuC-based command submission 521 :doc: GuC-based command submission
543 522
544 GuC ABI 523 GuC ABI
545 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 524 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
546 525
547 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi 526 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_messages_abi.h
548 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi 527 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h
549 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi 528 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h
550 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi 529 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_actions_abi.h
551 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi 530 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_klvs_abi.h
552 531
553 HuC 532 HuC
554 --- 533 ---
555 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 534 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc.c
556 :doc: HuC 535 :doc: HuC
557 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 536 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc.c
558 :functions: intel_huc_auth 537 :functions: intel_huc_auth
559 538
560 HuC Memory Management 539 HuC Memory Management
561 ~~~~~~~~~~~~~~~~~~~~~ 540 ~~~~~~~~~~~~~~~~~~~~~
562 541
563 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 542 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc.c
564 :doc: HuC Memory Management 543 :doc: HuC Memory Management
565 544
566 HuC Firmware Layout 545 HuC Firmware Layout
567 ~~~~~~~~~~~~~~~~~~~ 546 ~~~~~~~~~~~~~~~~~~~
568 The HuC FW layout is the same as the GuC one, 547 The HuC FW layout is the same as the GuC one, see `GuC Firmware Layout`_
569 548
570 DMC 549 DMC
571 --- 550 ---
572 See `DMC Firmware Support`_ 551 See `DMC Firmware Support`_
573 552
574 Tracing 553 Tracing
575 ======= 554 =======
576 555
577 This sections covers all things related to the 556 This sections covers all things related to the tracepoints implemented
578 in the i915 driver. 557 in the i915 driver.
579 558
580 i915_ppgtt_create and i915_ppgtt_release 559 i915_ppgtt_create and i915_ppgtt_release
581 ---------------------------------------- 560 ----------------------------------------
582 561
583 .. kernel-doc:: drivers/gpu/drm/i915/i915_trac 562 .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
584 :doc: i915_ppgtt_create and i915_ppgtt_rele 563 :doc: i915_ppgtt_create and i915_ppgtt_release tracepoints
585 564
586 i915_context_create and i915_context_free 565 i915_context_create and i915_context_free
587 ----------------------------------------- 566 -----------------------------------------
588 567
589 .. kernel-doc:: drivers/gpu/drm/i915/i915_trac 568 .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
590 :doc: i915_context_create and i915_context_ 569 :doc: i915_context_create and i915_context_free tracepoints
591 570
592 Perf 571 Perf
593 ==== 572 ====
594 573
595 Overview 574 Overview
596 -------- 575 --------
597 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 576 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
598 :doc: i915 Perf Overview 577 :doc: i915 Perf Overview
599 578
600 Comparison with Core Perf 579 Comparison with Core Perf
601 ------------------------- 580 -------------------------
602 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 581 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
603 :doc: i915 Perf History and Comparison with 582 :doc: i915 Perf History and Comparison with Core Perf
604 583
605 i915 Driver Entry Points 584 i915 Driver Entry Points
606 ------------------------ 585 ------------------------
607 586
608 This section covers the entrypoints exported o 587 This section covers the entrypoints exported outside of i915_perf.c to
609 integrate with drm/i915 and to handle the `DRM 588 integrate with drm/i915 and to handle the `DRM_I915_PERF_OPEN` ioctl.
610 589
611 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 590 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
612 :functions: i915_perf_init 591 :functions: i915_perf_init
613 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 592 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
614 :functions: i915_perf_fini 593 :functions: i915_perf_fini
615 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 594 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
616 :functions: i915_perf_register 595 :functions: i915_perf_register
617 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 596 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
618 :functions: i915_perf_unregister 597 :functions: i915_perf_unregister
619 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 598 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
620 :functions: i915_perf_open_ioctl 599 :functions: i915_perf_open_ioctl
621 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 600 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
622 :functions: i915_perf_release 601 :functions: i915_perf_release
623 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 602 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
624 :functions: i915_perf_add_config_ioctl 603 :functions: i915_perf_add_config_ioctl
625 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 604 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
626 :functions: i915_perf_remove_config_ioctl 605 :functions: i915_perf_remove_config_ioctl
627 606
628 i915 Perf Stream 607 i915 Perf Stream
629 ---------------- 608 ----------------
630 609
631 This section covers the stream-semantics-agnos 610 This section covers the stream-semantics-agnostic structures and functions
632 for representing an i915 perf stream FD and as 611 for representing an i915 perf stream FD and associated file operations.
633 612
634 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 613 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf_types.h
635 :functions: i915_perf_stream 614 :functions: i915_perf_stream
636 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 615 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf_types.h
637 :functions: i915_perf_stream_ops 616 :functions: i915_perf_stream_ops
638 617
639 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 618 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
640 :functions: read_properties_unlocked 619 :functions: read_properties_unlocked
641 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 620 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
642 :functions: i915_perf_open_ioctl_locked 621 :functions: i915_perf_open_ioctl_locked
643 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 622 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
644 :functions: i915_perf_destroy_locked 623 :functions: i915_perf_destroy_locked
645 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 624 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
646 :functions: i915_perf_read 625 :functions: i915_perf_read
647 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 626 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
648 :functions: i915_perf_ioctl 627 :functions: i915_perf_ioctl
649 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 628 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
650 :functions: i915_perf_enable_locked 629 :functions: i915_perf_enable_locked
651 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 630 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
652 :functions: i915_perf_disable_locked 631 :functions: i915_perf_disable_locked
653 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 632 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
654 :functions: i915_perf_poll 633 :functions: i915_perf_poll
655 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 634 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
656 :functions: i915_perf_poll_locked 635 :functions: i915_perf_poll_locked
657 636
658 i915 Perf Observation Architecture Stream 637 i915 Perf Observation Architecture Stream
659 ----------------------------------------- 638 -----------------------------------------
660 639
661 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 640 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf_types.h
662 :functions: i915_oa_ops 641 :functions: i915_oa_ops
663 642
664 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 643 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
665 :functions: i915_oa_stream_init 644 :functions: i915_oa_stream_init
666 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 645 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
667 :functions: i915_oa_read 646 :functions: i915_oa_read
668 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 647 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
669 :functions: i915_oa_stream_enable 648 :functions: i915_oa_stream_enable
670 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 649 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
671 :functions: i915_oa_stream_disable 650 :functions: i915_oa_stream_disable
672 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 651 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
673 :functions: i915_oa_wait_unlocked 652 :functions: i915_oa_wait_unlocked
674 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 653 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
675 :functions: i915_oa_poll_wait 654 :functions: i915_oa_poll_wait
676 655
677 Other i915 Perf Internals 656 Other i915 Perf Internals
678 ------------------------- 657 -------------------------
679 658
680 This section simply includes all other current 659 This section simply includes all other currently documented i915 perf internals,
681 in no particular order, but may include some m 660 in no particular order, but may include some more minor utilities or platform
682 specific details than found in the more high-l 661 specific details than found in the more high-level sections.
683 662
684 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 663 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
685 :internal: 664 :internal:
686 :no-identifiers: 665 :no-identifiers:
687 i915_perf_init 666 i915_perf_init
688 i915_perf_fini 667 i915_perf_fini
689 i915_perf_register 668 i915_perf_register
690 i915_perf_unregister 669 i915_perf_unregister
691 i915_perf_open_ioctl 670 i915_perf_open_ioctl
692 i915_perf_release 671 i915_perf_release
693 i915_perf_add_config_ioctl 672 i915_perf_add_config_ioctl
694 i915_perf_remove_config_ioctl 673 i915_perf_remove_config_ioctl
695 read_properties_unlocked 674 read_properties_unlocked
696 i915_perf_open_ioctl_locked 675 i915_perf_open_ioctl_locked
697 i915_perf_destroy_locked 676 i915_perf_destroy_locked
698 i915_perf_read i915_perf_ioctl 677 i915_perf_read i915_perf_ioctl
699 i915_perf_enable_locked 678 i915_perf_enable_locked
700 i915_perf_disable_locked 679 i915_perf_disable_locked
701 i915_perf_poll i915_perf_poll_locked 680 i915_perf_poll i915_perf_poll_locked
702 i915_oa_stream_init i915_oa_read 681 i915_oa_stream_init i915_oa_read
703 i915_oa_stream_enable 682 i915_oa_stream_enable
704 i915_oa_stream_disable 683 i915_oa_stream_disable
705 i915_oa_wait_unlocked 684 i915_oa_wait_unlocked
706 i915_oa_poll_wait 685 i915_oa_poll_wait
707 686
708 Style 687 Style
709 ===== 688 =====
710 689
711 The drm/i915 driver codebase has some style ru 690 The drm/i915 driver codebase has some style rules in addition to (and, in some
712 cases, deviating from) the kernel coding style 691 cases, deviating from) the kernel coding style.
713 692
714 Register macro definition style 693 Register macro definition style
715 ------------------------------- 694 -------------------------------
716 695
717 The style guide for ``i915_reg.h``. 696 The style guide for ``i915_reg.h``.
718 697
719 .. kernel-doc:: drivers/gpu/drm/i915/i915_reg. 698 .. kernel-doc:: drivers/gpu/drm/i915/i915_reg.h
720 :doc: The i915 register macro definition st 699 :doc: The i915 register macro definition style guide
721 700
722 .. _i915-usage-stats: 701 .. _i915-usage-stats:
723 702
724 i915 DRM client usage stats implementation 703 i915 DRM client usage stats implementation
725 ========================================== 704 ==========================================
726 705
727 The drm/i915 driver implements the DRM client 706 The drm/i915 driver implements the DRM client usage stats specification as
728 documented in :ref:`drm-client-usage-stats`. 707 documented in :ref:`drm-client-usage-stats`.
729 708
730 Example of the output showing the implemented 709 Example of the output showing the implemented key value pairs and entirety of
731 the currently possible format options: 710 the currently possible format options:
732 711
733 :: 712 ::
734 713
735 pos: 0 714 pos: 0
736 flags: 0100002 715 flags: 0100002
737 mnt_id: 21 716 mnt_id: 21
738 drm-driver: i915 717 drm-driver: i915
739 drm-pdev: 0000:00:02.0 718 drm-pdev: 0000:00:02.0
740 drm-client-id: 7 719 drm-client-id: 7
741 drm-engine-render: 9288864723 ns 720 drm-engine-render: 9288864723 ns
742 drm-engine-copy: 2035071108 ns 721 drm-engine-copy: 2035071108 ns
743 drm-engine-video: 0 ns 722 drm-engine-video: 0 ns
744 drm-engine-capacity-video: 2 723 drm-engine-capacity-video: 2
745 drm-engine-video-enhance: 0 ns 724 drm-engine-video-enhance: 0 ns
746 725
747 Possible `drm-engine-` key names are: `render` 726 Possible `drm-engine-` key names are: `render`, `copy`, `video` and
748 `video-enhance`. 727 `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.