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