xref: /openbmc/linux/drivers/gpu/drm/i915/Kconfig.debug (revision b830f94f)
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 REFCOUNT_FULL
25        select I2C_CHARDEV
26        select STACKDEPOT
27        select DRM_DP_AUX_CHARDEV
28        select X86_MSR # used by igt/pm_rpm
29        select DRM_VGEM # used by igt/prime_vgem (dmabuf interop checks)
30        select DRM_DEBUG_MM if DRM=y
31	select DRM_DEBUG_SELFTEST
32	select SW_SYNC # signaling validation framework (igt/syncobj*)
33	select DRM_I915_SW_FENCE_DEBUG_OBJECTS
34	select DRM_I915_SELFTEST
35	select DRM_I915_DEBUG_RUNTIME_PM
36	select DRM_I915_DEBUG_MMIO
37        default n
38        help
39          Choose this option to turn on extra driver debugging that may affect
40          performance but will catch some internal issues.
41
42          Recommended for driver developers only.
43
44          If in doubt, say "N".
45
46config DRM_I915_DEBUG_MMIO
47	bool "Always insert extra checks around mmio access by default"
48	default n
49	help
50	  By default, always enables the extra sanity checks (extra register
51	  reads) around every mmio (register) access that will slow the system
52	  down. This sets the default value of i915.mmio_debug to -1 and can
53	  be overridden at module load.
54
55	  Recommended for driver developers only.
56
57	  If in doubt, say "N".
58
59config DRM_I915_DEBUG_GEM
60        bool "Insert extra checks into the GEM internals"
61        default n
62        depends on DRM_I915_WERROR
63        help
64          Enable extra sanity checks (including BUGs) along the GEM driver
65          paths that may slow the system down and if hit hang the machine.
66
67          Recommended for driver developers only.
68
69          If in doubt, say "N".
70
71config DRM_I915_ERRLOG_GEM
72	bool "Insert extra logging (very verbose) for common GEM errors"
73	default n
74	depends on DRM_I915_DEBUG_GEM
75	help
76	  Enable additional logging that may help track down the cause of
77	  principally userspace errors.
78
79	  Recommended for driver developers only.
80
81	  If in doubt, say "N".
82
83config DRM_I915_TRACE_GEM
84	bool "Insert extra ftrace output from the GEM internals"
85	depends on DRM_I915_DEBUG_GEM
86	select TRACING
87	default n
88	help
89	  Enable additional and verbose debugging output that will spam
90	  ordinary tests, but may be vital for post-mortem debugging when
91	  used with /proc/sys/kernel/ftrace_dump_on_oops
92
93	  Recommended for driver developers only.
94
95	  If in doubt, say "N".
96
97config DRM_I915_SW_FENCE_DEBUG_OBJECTS
98        bool "Enable additional driver debugging for fence objects"
99        depends on DRM_I915
100        select DEBUG_OBJECTS
101        default n
102        help
103          Choose this option to turn on extra driver debugging that may affect
104          performance but will catch some internal issues.
105
106          Recommended for driver developers only.
107
108          If in doubt, say "N".
109
110config DRM_I915_SW_FENCE_CHECK_DAG
111        bool "Enable additional driver debugging for detecting dependency cycles"
112        depends on DRM_I915
113        default n
114        help
115          Choose this option to turn on extra driver debugging that may affect
116          performance but will catch some internal issues.
117
118          Recommended for driver developers only.
119
120          If in doubt, say "N".
121
122config DRM_I915_DEBUG_GUC
123        bool "Enable additional driver debugging for GuC"
124        depends on DRM_I915
125        default n
126        help
127          Choose this option to turn on extra driver debugging that may affect
128          performance but will help resolve GuC related issues.
129
130          Recommended for driver developers only.
131
132          If in doubt, say "N".
133
134config DRM_I915_SELFTEST
135	bool "Enable selftests upon driver load"
136	depends on DRM_I915
137	default n
138	select FAULT_INJECTION
139	select PRIME_NUMBERS
140	help
141	  Choose this option to allow the driver to perform selftests upon
142	  loading; also requires the i915.selftest=1 module parameter. To
143	  exit the module after running the selftests (i.e. to prevent normal
144	  module initialisation afterwards) use i915.selftest=-1.
145
146	  Recommended for driver developers only.
147
148	  If in doubt, say "N".
149
150config DRM_I915_SELFTEST_BROKEN
151	bool "Enable broken and dangerous selftests"
152	depends on DRM_I915_SELFTEST
153	depends on BROKEN
154	default n
155	help
156	  This option enables the execution of selftests that are "dangerous"
157	  and may trigger unintended HW side-effects as they break strict
158	  rules given in the HW specification. For science.
159
160	  Recommended for masochistic driver developers only.
161
162	  If in doubt, say "N".
163
164config DRM_I915_LOW_LEVEL_TRACEPOINTS
165        bool "Enable low level request tracing events"
166        depends on DRM_I915
167        default n
168        help
169          Choose this option to turn on low level request tracing events.
170          This provides the ability to precisely monitor engine utilisation
171          and also analyze the request dependency resolving timeline.
172
173          If in doubt, say "N".
174
175config DRM_I915_DEBUG_VBLANK_EVADE
176	bool "Enable extra debug warnings for vblank evasion"
177	depends on DRM_I915
178	default n
179	help
180	  Choose this option to turn on extra debug warnings for the
181	  vblank evade mechanism. This gives a warning every time the
182	  the deadline allotted for the vblank evade critical section
183	  is exceeded, even if there isn't an actual risk of missing
184	  the vblank.
185
186	  If in doubt, say "N".
187
188config DRM_I915_DEBUG_RUNTIME_PM
189	bool "Enable extra state checking for runtime PM"
190	depends on DRM_I915
191	default n
192	select STACKDEPOT
193	help
194	  Choose this option to turn on extra state checking for the
195	  runtime PM functionality. This may introduce overhead during
196	  driver loading, suspend and resume operations.
197
198	  If in doubt, say "N"
199