xref: /openbmc/linux/drivers/gpu/drm/i915/Kconfig.debug (revision 113094f7)
1# SPDX-License-Identifier: GPL-2.0-only
2config DRM_I915_WERROR
3        bool "Force GCC to throw an error instead of a warning when compiling"
4        # As this may inadvertently break the build, only allow the user
5        # to shoot oneself in the foot iff they aim really hard
6        depends on EXPERT
7        # We use the dependency on !COMPILE_TEST to not be enabled in
8        # allmodconfig or allyesconfig configurations
9        depends on !COMPILE_TEST
10        default n
11        help
12          Add -Werror to the build flags for (and only for) i915.ko.
13          Do not enable this unless you are writing code for the i915.ko module.
14
15          Recommended for driver developers only.
16
17          If in doubt, say "N".
18
19config DRM_I915_DEBUG
20        bool "Enable additional driver debugging"
21        depends on DRM_I915
22        select DEBUG_FS
23        select PREEMPT_COUNT
24        select I2C_CHARDEV
25        select STACKDEPOT
26        select DRM_DP_AUX_CHARDEV
27        select X86_MSR # used by igt/pm_rpm
28        select DRM_VGEM # used by igt/prime_vgem (dmabuf interop checks)
29        select DRM_DEBUG_MM if DRM=y
30	select DRM_DEBUG_SELFTEST
31	select SW_SYNC # signaling validation framework (igt/syncobj*)
32	select DRM_I915_SW_FENCE_DEBUG_OBJECTS
33	select DRM_I915_SELFTEST
34	select DRM_I915_DEBUG_RUNTIME_PM
35        default n
36        help
37          Choose this option to turn on extra driver debugging that may affect
38          performance but will catch some internal issues.
39
40          Recommended for driver developers only.
41
42          If in doubt, say "N".
43
44config DRM_I915_DEBUG_GEM
45        bool "Insert extra checks into the GEM internals"
46        default n
47        depends on DRM_I915_WERROR
48        help
49          Enable extra sanity checks (including BUGs) along the GEM driver
50          paths that may slow the system down and if hit hang the machine.
51
52          Recommended for driver developers only.
53
54          If in doubt, say "N".
55
56config DRM_I915_ERRLOG_GEM
57	bool "Insert extra logging (very verbose) for common GEM errors"
58	default n
59	depends on DRM_I915_DEBUG_GEM
60	help
61	  Enable additional logging that may help track down the cause of
62	  principally userspace errors.
63
64	  Recommended for driver developers only.
65
66	  If in doubt, say "N".
67
68config DRM_I915_TRACE_GEM
69	bool "Insert extra ftrace output from the GEM internals"
70	depends on DRM_I915_DEBUG_GEM
71	select TRACING
72	default n
73	help
74	  Enable additional and verbose debugging output that will spam
75	  ordinary tests, but may be vital for post-mortem debugging when
76	  used with /proc/sys/kernel/ftrace_dump_on_oops
77
78	  Recommended for driver developers only.
79
80	  If in doubt, say "N".
81
82config DRM_I915_SW_FENCE_DEBUG_OBJECTS
83        bool "Enable additional driver debugging for fence objects"
84        depends on DRM_I915
85        select DEBUG_OBJECTS
86        default n
87        help
88          Choose this option to turn on extra driver debugging that may affect
89          performance but will catch some internal issues.
90
91          Recommended for driver developers only.
92
93          If in doubt, say "N".
94
95config DRM_I915_SW_FENCE_CHECK_DAG
96        bool "Enable additional driver debugging for detecting dependency cycles"
97        depends on DRM_I915
98        default n
99        help
100          Choose this option to turn on extra driver debugging that may affect
101          performance but will catch some internal issues.
102
103          Recommended for driver developers only.
104
105          If in doubt, say "N".
106
107config DRM_I915_DEBUG_GUC
108        bool "Enable additional driver debugging for GuC"
109        depends on DRM_I915
110        default n
111        help
112          Choose this option to turn on extra driver debugging that may affect
113          performance but will help resolve GuC related issues.
114
115          Recommended for driver developers only.
116
117          If in doubt, say "N".
118
119config DRM_I915_SELFTEST
120	bool "Enable selftests upon driver load"
121	depends on DRM_I915
122	default n
123	select FAULT_INJECTION
124	select PRIME_NUMBERS
125	help
126	  Choose this option to allow the driver to perform selftests upon
127	  loading; also requires the i915.selftest=1 module parameter. To
128	  exit the module after running the selftests (i.e. to prevent normal
129	  module initialisation afterwards) use i915.selftest=-1.
130
131	  Recommended for driver developers only.
132
133	  If in doubt, say "N".
134
135config DRM_I915_SELFTEST_BROKEN
136	bool "Enable broken and dangerous selftests"
137	depends on DRM_I915_SELFTEST
138	depends on BROKEN
139	default n
140	help
141	  This option enables the execution of selftests that are "dangerous"
142	  and may trigger unintended HW side-effects as they break strict
143	  rules given in the HW specification. For science.
144
145	  Recommended for masochistic driver developers only.
146
147	  If in doubt, say "N".
148
149config DRM_I915_LOW_LEVEL_TRACEPOINTS
150        bool "Enable low level request tracing events"
151        depends on DRM_I915
152        default n
153        help
154          Choose this option to turn on low level request tracing events.
155          This provides the ability to precisely monitor engine utilisation
156          and also analyze the request dependency resolving timeline.
157
158          If in doubt, say "N".
159
160config DRM_I915_DEBUG_VBLANK_EVADE
161	bool "Enable extra debug warnings for vblank evasion"
162	depends on DRM_I915
163	default n
164	help
165	  Choose this option to turn on extra debug warnings for the
166	  vblank evade mechanism. This gives a warning every time the
167	  the deadline allotted for the vblank evade critical section
168	  is exceeded, even if there isn't an actual risk of missing
169	  the vblank.
170
171	  If in doubt, say "N".
172
173config DRM_I915_DEBUG_RUNTIME_PM
174	bool "Enable extra state checking for runtime PM"
175	depends on DRM_I915
176	default n
177	select STACKDEPOT
178	help
179	  Choose this option to turn on extra state checking for the
180	  runtime PM functionality. This may introduce overhead during
181	  driver loading, suspend and resume operations.
182
183	  If in doubt, say "N"
184