xref: /openbmc/linux/drivers/gpu/drm/i915/Kconfig.debug (revision fcbb8461)
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_TRACE_GTT
99	bool "Insert extra ftrace output from the GTT internals"
100	depends on DRM_I915_DEBUG_GEM
101	select TRACING
102	default n
103	help
104	  Enable additional and verbose debugging output that will spam
105	  ordinary tests, but may be vital for post-mortem debugging when
106	  used with /proc/sys/kernel/ftrace_dump_on_oops
107
108	  Recommended for driver developers only.
109
110	  If in doubt, say "N".
111
112config DRM_I915_SW_FENCE_DEBUG_OBJECTS
113        bool "Enable additional driver debugging for fence objects"
114        depends on DRM_I915
115        select DEBUG_OBJECTS
116        default n
117        help
118          Choose this option to turn on extra driver debugging that may affect
119          performance but will catch some internal issues.
120
121          Recommended for driver developers only.
122
123          If in doubt, say "N".
124
125config DRM_I915_SW_FENCE_CHECK_DAG
126        bool "Enable additional driver debugging for detecting dependency cycles"
127        depends on DRM_I915
128        default n
129        help
130          Choose this option to turn on extra driver debugging that may affect
131          performance but will catch some internal issues.
132
133          Recommended for driver developers only.
134
135          If in doubt, say "N".
136
137config DRM_I915_DEBUG_GUC
138        bool "Enable additional driver debugging for GuC"
139        depends on DRM_I915
140        default n
141        help
142          Choose this option to turn on extra driver debugging that may affect
143          performance but will help resolve GuC related issues.
144
145          Recommended for driver developers only.
146
147          If in doubt, say "N".
148
149config DRM_I915_SELFTEST
150	bool "Enable selftests upon driver load"
151	depends on DRM_I915
152	default n
153	select FAULT_INJECTION
154	select PRIME_NUMBERS
155	help
156	  Choose this option to allow the driver to perform selftests upon
157	  loading; also requires the i915.selftest=1 module parameter. To
158	  exit the module after running the selftests (i.e. to prevent normal
159	  module initialisation afterwards) use i915.selftest=-1.
160
161	  Recommended for driver developers only.
162
163	  If in doubt, say "N".
164
165config DRM_I915_SELFTEST_BROKEN
166	bool "Enable broken and dangerous selftests"
167	depends on DRM_I915_SELFTEST
168	depends on BROKEN
169	default n
170	help
171	  This option enables the execution of selftests that are "dangerous"
172	  and may trigger unintended HW side-effects as they break strict
173	  rules given in the HW specification. For science.
174
175	  Recommended for masochistic driver developers only.
176
177	  If in doubt, say "N".
178
179config DRM_I915_LOW_LEVEL_TRACEPOINTS
180        bool "Enable low level request tracing events"
181        depends on DRM_I915
182        default n
183        help
184          Choose this option to turn on low level request tracing events.
185          This provides the ability to precisely monitor engine utilisation
186          and also analyze the request dependency resolving timeline.
187
188          If in doubt, say "N".
189
190config DRM_I915_DEBUG_VBLANK_EVADE
191	bool "Enable extra debug warnings for vblank evasion"
192	depends on DRM_I915
193	default n
194	help
195	  Choose this option to turn on extra debug warnings for the
196	  vblank evade mechanism. This gives a warning every time the
197	  the deadline allotted for the vblank evade critical section
198	  is exceeded, even if there isn't an actual risk of missing
199	  the vblank.
200
201	  If in doubt, say "N".
202
203config DRM_I915_DEBUG_RUNTIME_PM
204	bool "Enable extra state checking for runtime PM"
205	depends on DRM_I915
206	default n
207	select STACKDEPOT
208	help
209	  Choose this option to turn on extra state checking for the
210	  runtime PM functionality. This may introduce overhead during
211	  driver loading, suspend and resume operations.
212
213	  If in doubt, say "N"
214