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 :functions: intel_dp_set_drrs_state
>> 191
>> 192 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
>> 193 :functions: intel_edp_drrs_enable
>> 194
>> 195 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
>> 196 :functions: intel_edp_drrs_disable
>> 197
>> 198 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
>> 199 :functions: intel_edp_drrs_invalidate
>> 200
>> 201 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
>> 202 :functions: intel_edp_drrs_flush
>> 203
>> 204 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
>> 205 :functions: intel_dp_drrs_init
191 206
192 DPIO 207 DPIO
193 ---- 208 ----
194 209
195 .. kernel-doc:: drivers/gpu/drm/i915/display/i 210 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dpio_phy.c
196 :doc: DPIO 211 :doc: DPIO
197 212
198 DMC Firmware Support 213 DMC Firmware Support
199 -------------------- 214 --------------------
200 215
201 .. kernel-doc:: drivers/gpu/drm/i915/display/i 216 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dmc.c
202 :doc: DMC Firmware Support 217 :doc: DMC Firmware Support
203 218
204 .. kernel-doc:: drivers/gpu/drm/i915/display/i 219 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dmc.c
205 :internal: 220 :internal:
206 221
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) 222 Video BIOS Table (VBT)
214 ---------------------- 223 ----------------------
215 224
216 .. kernel-doc:: drivers/gpu/drm/i915/display/i 225 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_bios.c
217 :doc: Video BIOS Table (VBT) 226 :doc: Video BIOS Table (VBT)
218 227
219 .. kernel-doc:: drivers/gpu/drm/i915/display/i 228 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_bios.c
220 :internal: 229 :internal:
221 230
222 .. kernel-doc:: drivers/gpu/drm/i915/display/i 231 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_vbt_defs.h
223 :internal: 232 :internal:
224 233
225 Display clocks 234 Display clocks
226 -------------- 235 --------------
227 236
228 .. kernel-doc:: drivers/gpu/drm/i915/display/i 237 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_cdclk.c
229 :doc: CDCLK / RAWCLK 238 :doc: CDCLK / RAWCLK
230 239
231 .. kernel-doc:: drivers/gpu/drm/i915/display/i 240 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_cdclk.c
232 :internal: 241 :internal:
233 242
234 Display PLLs 243 Display PLLs
235 ------------ 244 ------------
236 245
237 .. kernel-doc:: drivers/gpu/drm/i915/display/i 246 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dpll_mgr.c
238 :doc: Display PLLs 247 :doc: Display PLLs
239 248
240 .. kernel-doc:: drivers/gpu/drm/i915/display/i 249 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dpll_mgr.c
241 :internal: 250 :internal:
242 251
243 .. kernel-doc:: drivers/gpu/drm/i915/display/i 252 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dpll_mgr.h
244 :internal: 253 :internal:
245 254
246 Display State Buffer 255 Display State Buffer
247 -------------------- 256 --------------------
248 257
249 .. kernel-doc:: drivers/gpu/drm/i915/display/i 258 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dsb.c
250 :doc: DSB 259 :doc: DSB
251 260
252 .. kernel-doc:: drivers/gpu/drm/i915/display/i 261 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dsb.c
253 :internal: 262 :internal:
254 263
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 264 Memory Management and Command Submission
268 ======================================== 265 ========================================
269 266
270 This sections covers all things related to the 267 This sections covers all things related to the GEM implementation in the
271 i915 driver. 268 i915 driver.
272 269
273 Intel GPU Basics 270 Intel GPU Basics
274 ---------------- 271 ----------------
275 272
276 An Intel GPU has multiple engines. There are s !! 273 An Intel GPU has multiple engines. There are several engine types.
277 274
278 - Render Command Streamer (RCS). An engine for !! 275 - RCS engine is for rendering 3D and performing compute, this is named
279 performing compute. !! 276 `I915_EXEC_RENDER` in user space.
280 - Blitting Command Streamer (BCS). An engine f !! 277 - BCS is a blitting (copy) engine, this is named `I915_EXEC_BLT` in user
281 copying operations. !! 278 space.
282 - Video Command Streamer. An engine used for v !! 279 - VCS is a video encode and decode engine, this is named `I915_EXEC_BSD`
283 sometimes called 'BSD' in hardware documenta !! 280 in user space
284 - Video Enhancement Command Streamer (VECS). A !! 281 - VECS is video enhancement engine, this is named `I915_EXEC_VEBOX` in user
285 Also sometimes called 'VEBOX' in hardware do !! 282 space.
286 - Compute Command Streamer (CCS). An engine th !! 283 - The enumeration `I915_EXEC_DEFAULT` does not refer to specific engine;
287 GPGPU pipelines, but not the 3D pipeline. !! 284 instead it is to be used by user space to specify a default rendering
288 - Graphics Security Controller (GSCCS). A dedi !! 285 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 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 atleast) 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 atleast) 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 <<
484 ----------------- <<
485 <<
486 .. kernel-doc:: drivers/gpu/drm/i915/pxp/intel <<
487 :doc: PXP <<
488 <<
489 .. kernel-doc:: drivers/gpu/drm/i915/pxp/intel <<
490 <<
491 Microcontrollers 477 Microcontrollers
492 ================ 478 ================
493 479
494 Starting from gen9, three microcontrollers are 480 Starting from gen9, three microcontrollers are available on the HW: the
495 graphics microcontroller (GuC), the HEVC/H.265 481 graphics microcontroller (GuC), the HEVC/H.265 microcontroller (HuC) and the
496 display microcontroller (DMC). The driver is r 482 display microcontroller (DMC). The driver is responsible for loading the
497 firmwares on the microcontrollers; the GuC and 483 firmwares on the microcontrollers; the GuC and HuC firmwares are transferred
498 to WOPCM using the DMA engine, while the DMC f 484 to WOPCM using the DMA engine, while the DMC firmware is written through MMIO.
499 485
500 WOPCM 486 WOPCM
501 ----- 487 -----
502 488
503 WOPCM Layout 489 WOPCM Layout
504 ~~~~~~~~~~~~ 490 ~~~~~~~~~~~~
505 491
506 .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ !! 492 .. kernel-doc:: drivers/gpu/drm/i915/intel_wopcm.c
507 :doc: WOPCM Layout 493 :doc: WOPCM Layout
508 494
509 GuC 495 GuC
510 --- 496 ---
511 497
512 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 498 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.c
513 :doc: GuC 499 :doc: GuC
514 500
515 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int <<
516 <<
517 GuC Firmware Layout 501 GuC Firmware Layout
518 ~~~~~~~~~~~~~~~~~~~ 502 ~~~~~~~~~~~~~~~~~~~
519 503
520 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 504 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h
521 :doc: Firmware Layout 505 :doc: Firmware Layout
522 506
523 GuC Memory Management 507 GuC Memory Management
524 ~~~~~~~~~~~~~~~~~~~~~ 508 ~~~~~~~~~~~~~~~~~~~~~
525 509
526 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 510 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.c
527 :doc: GuC Memory Management 511 :doc: GuC Memory Management
528 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 512 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.c
529 :functions: intel_guc_allocate_vma 513 :functions: intel_guc_allocate_vma
530 514
531 515
532 GuC-specific firmware loader 516 GuC-specific firmware loader
533 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 517 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
534 518
535 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 519 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_fw.c
536 :internal: 520 :internal:
537 521
538 GuC-based command submission 522 GuC-based command submission
539 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 523 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
540 524
541 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 525 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_submission.c
542 :doc: GuC-based command submission 526 :doc: GuC-based command submission
543 527
544 GuC ABI 528 GuC ABI
545 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 529 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
546 530
547 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi 531 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_messages_abi.h
548 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi 532 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h
549 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi 533 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h
550 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi 534 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_actions_abi.h
551 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi <<
552 535
553 HuC 536 HuC
554 --- 537 ---
555 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 538 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc.c
556 :doc: HuC 539 :doc: HuC
557 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 540 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc.c
558 :functions: intel_huc_auth 541 :functions: intel_huc_auth
559 542
560 HuC Memory Management 543 HuC Memory Management
561 ~~~~~~~~~~~~~~~~~~~~~ 544 ~~~~~~~~~~~~~~~~~~~~~
562 545
563 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/int 546 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc.c
564 :doc: HuC Memory Management 547 :doc: HuC Memory Management
565 548
566 HuC Firmware Layout 549 HuC Firmware Layout
567 ~~~~~~~~~~~~~~~~~~~ 550 ~~~~~~~~~~~~~~~~~~~
568 The HuC FW layout is the same as the GuC one, 551 The HuC FW layout is the same as the GuC one, see `GuC Firmware Layout`_
569 552
570 DMC 553 DMC
571 --- 554 ---
572 See `DMC Firmware Support`_ 555 See `DMC Firmware Support`_
573 556
574 Tracing 557 Tracing
575 ======= 558 =======
576 559
577 This sections covers all things related to the 560 This sections covers all things related to the tracepoints implemented
578 in the i915 driver. 561 in the i915 driver.
579 562
580 i915_ppgtt_create and i915_ppgtt_release 563 i915_ppgtt_create and i915_ppgtt_release
581 ---------------------------------------- 564 ----------------------------------------
582 565
583 .. kernel-doc:: drivers/gpu/drm/i915/i915_trac 566 .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
584 :doc: i915_ppgtt_create and i915_ppgtt_rele 567 :doc: i915_ppgtt_create and i915_ppgtt_release tracepoints
585 568
586 i915_context_create and i915_context_free 569 i915_context_create and i915_context_free
587 ----------------------------------------- 570 -----------------------------------------
588 571
589 .. kernel-doc:: drivers/gpu/drm/i915/i915_trac 572 .. kernel-doc:: drivers/gpu/drm/i915/i915_trace.h
590 :doc: i915_context_create and i915_context_ 573 :doc: i915_context_create and i915_context_free tracepoints
591 574
592 Perf 575 Perf
593 ==== 576 ====
594 577
595 Overview 578 Overview
596 -------- 579 --------
597 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 580 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
598 :doc: i915 Perf Overview 581 :doc: i915 Perf Overview
599 582
600 Comparison with Core Perf 583 Comparison with Core Perf
601 ------------------------- 584 -------------------------
602 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 585 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
603 :doc: i915 Perf History and Comparison with 586 :doc: i915 Perf History and Comparison with Core Perf
604 587
605 i915 Driver Entry Points 588 i915 Driver Entry Points
606 ------------------------ 589 ------------------------
607 590
608 This section covers the entrypoints exported o 591 This section covers the entrypoints exported outside of i915_perf.c to
609 integrate with drm/i915 and to handle the `DRM 592 integrate with drm/i915 and to handle the `DRM_I915_PERF_OPEN` ioctl.
610 593
611 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 594 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
612 :functions: i915_perf_init 595 :functions: i915_perf_init
613 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 596 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
614 :functions: i915_perf_fini 597 :functions: i915_perf_fini
615 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 598 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
616 :functions: i915_perf_register 599 :functions: i915_perf_register
617 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 600 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
618 :functions: i915_perf_unregister 601 :functions: i915_perf_unregister
619 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 602 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
620 :functions: i915_perf_open_ioctl 603 :functions: i915_perf_open_ioctl
621 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 604 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
622 :functions: i915_perf_release 605 :functions: i915_perf_release
623 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 606 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
624 :functions: i915_perf_add_config_ioctl 607 :functions: i915_perf_add_config_ioctl
625 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 608 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
626 :functions: i915_perf_remove_config_ioctl 609 :functions: i915_perf_remove_config_ioctl
627 610
628 i915 Perf Stream 611 i915 Perf Stream
629 ---------------- 612 ----------------
630 613
631 This section covers the stream-semantics-agnos 614 This section covers the stream-semantics-agnostic structures and functions
632 for representing an i915 perf stream FD and as 615 for representing an i915 perf stream FD and associated file operations.
633 616
634 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 617 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf_types.h
635 :functions: i915_perf_stream 618 :functions: i915_perf_stream
636 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 619 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf_types.h
637 :functions: i915_perf_stream_ops 620 :functions: i915_perf_stream_ops
638 621
639 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 622 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
640 :functions: read_properties_unlocked 623 :functions: read_properties_unlocked
641 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 624 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
642 :functions: i915_perf_open_ioctl_locked 625 :functions: i915_perf_open_ioctl_locked
643 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 626 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
644 :functions: i915_perf_destroy_locked 627 :functions: i915_perf_destroy_locked
645 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 628 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
646 :functions: i915_perf_read 629 :functions: i915_perf_read
647 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 630 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
648 :functions: i915_perf_ioctl 631 :functions: i915_perf_ioctl
649 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 632 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
650 :functions: i915_perf_enable_locked 633 :functions: i915_perf_enable_locked
651 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 634 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
652 :functions: i915_perf_disable_locked 635 :functions: i915_perf_disable_locked
653 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 636 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
654 :functions: i915_perf_poll 637 :functions: i915_perf_poll
655 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 638 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
656 :functions: i915_perf_poll_locked 639 :functions: i915_perf_poll_locked
657 640
658 i915 Perf Observation Architecture Stream 641 i915 Perf Observation Architecture Stream
659 ----------------------------------------- 642 -----------------------------------------
660 643
661 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 644 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf_types.h
662 :functions: i915_oa_ops 645 :functions: i915_oa_ops
663 646
664 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 647 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
665 :functions: i915_oa_stream_init 648 :functions: i915_oa_stream_init
666 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 649 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
667 :functions: i915_oa_read 650 :functions: i915_oa_read
668 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 651 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
669 :functions: i915_oa_stream_enable 652 :functions: i915_oa_stream_enable
670 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 653 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
671 :functions: i915_oa_stream_disable 654 :functions: i915_oa_stream_disable
672 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 655 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
673 :functions: i915_oa_wait_unlocked 656 :functions: i915_oa_wait_unlocked
674 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 657 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
675 :functions: i915_oa_poll_wait 658 :functions: i915_oa_poll_wait
676 659
677 Other i915 Perf Internals 660 Other i915 Perf Internals
678 ------------------------- 661 -------------------------
679 662
680 This section simply includes all other current 663 This section simply includes all other currently documented i915 perf internals,
681 in no particular order, but may include some m 664 in no particular order, but may include some more minor utilities or platform
682 specific details than found in the more high-l 665 specific details than found in the more high-level sections.
683 666
684 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf 667 .. kernel-doc:: drivers/gpu/drm/i915/i915_perf.c
685 :internal: 668 :internal:
686 :no-identifiers: 669 :no-identifiers:
687 i915_perf_init 670 i915_perf_init
688 i915_perf_fini 671 i915_perf_fini
689 i915_perf_register 672 i915_perf_register
690 i915_perf_unregister 673 i915_perf_unregister
691 i915_perf_open_ioctl 674 i915_perf_open_ioctl
692 i915_perf_release 675 i915_perf_release
693 i915_perf_add_config_ioctl 676 i915_perf_add_config_ioctl
694 i915_perf_remove_config_ioctl 677 i915_perf_remove_config_ioctl
695 read_properties_unlocked 678 read_properties_unlocked
696 i915_perf_open_ioctl_locked 679 i915_perf_open_ioctl_locked
697 i915_perf_destroy_locked 680 i915_perf_destroy_locked
698 i915_perf_read i915_perf_ioctl 681 i915_perf_read i915_perf_ioctl
699 i915_perf_enable_locked 682 i915_perf_enable_locked
700 i915_perf_disable_locked 683 i915_perf_disable_locked
701 i915_perf_poll i915_perf_poll_locked 684 i915_perf_poll i915_perf_poll_locked
702 i915_oa_stream_init i915_oa_read 685 i915_oa_stream_init i915_oa_read
703 i915_oa_stream_enable 686 i915_oa_stream_enable
704 i915_oa_stream_disable 687 i915_oa_stream_disable
705 i915_oa_wait_unlocked 688 i915_oa_wait_unlocked
706 i915_oa_poll_wait 689 i915_oa_poll_wait
707 690
708 Style 691 Style
709 ===== 692 =====
710 693
711 The drm/i915 driver codebase has some style ru 694 The drm/i915 driver codebase has some style rules in addition to (and, in some
712 cases, deviating from) the kernel coding style 695 cases, deviating from) the kernel coding style.
713 696
714 Register macro definition style 697 Register macro definition style
715 ------------------------------- 698 -------------------------------
716 699
717 The style guide for ``i915_reg.h``. 700 The style guide for ``i915_reg.h``.
718 701
719 .. kernel-doc:: drivers/gpu/drm/i915/i915_reg. 702 .. kernel-doc:: drivers/gpu/drm/i915/i915_reg.h
720 :doc: The i915 register macro definition st 703 :doc: The i915 register macro definition style guide
721 <<
722 .. _i915-usage-stats: <<
723 <<
724 i915 DRM client usage stats implementation <<
725 ========================================== <<
726 <<
727 The drm/i915 driver implements the DRM client <<
728 documented in :ref:`drm-client-usage-stats`. <<
729 <<
730 Example of the output showing the implemented <<
731 the currently possible format options: <<
732 <<
733 :: <<
734 <<
735 pos: 0 <<
736 flags: 0100002 <<
737 mnt_id: 21 <<
738 drm-driver: i915 <<
739 drm-pdev: 0000:00:02.0 <<
740 drm-client-id: 7 <<
741 drm-engine-render: 9288864723 ns <<
742 drm-engine-copy: 2035071108 ns <<
743 drm-engine-video: 0 ns <<
744 drm-engine-capacity-video: 2 <<
745 drm-engine-video-enhance: 0 ns <<
746 <<
747 Possible `drm-engine-` key names are: `render` <<
748 `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.