[linux-2.6-block.git] / drivers / gpu / drm / i915 / Kconfig.debug

# SPDX-License-Identifier: GPL-2.0-only
config DRM_I915_WERROR
	bool "Force GCC to throw an error instead of a warning when compiling"
	# As this may inadvertently break the build, only allow the user
	# to shoot oneself in the foot iff they aim really hard
	depends on EXPERT
	# We use the dependency on !COMPILE_TEST to not be enabled in
	# allmodconfig or allyesconfig configurations
	depends on !COMPILE_TEST
	default n
	help
	  Add -Werror to the build flags for (and only for) i915.ko.
	  Do not enable this unless you are writing code for the i915.ko module.

	  Recommended for driver developers only.

	  If in doubt, say "N".

config DRM_I915_DEBUG
	bool "Enable additional driver debugging"
	depends on DRM_I915
	depends on EXPERT # only for developers
	depends on !COMPILE_TEST # never built by robots
	select DEBUG_FS
	select PREEMPT_COUNT
	select I2C_CHARDEV
	select REF_TRACKER
	select STACKDEPOT
	select STACKTRACE
	select DRM_DISPLAY_DP_AUX_CHARDEV
	select DRM_DISPLAY_DP_TUNNEL_STATE_DEBUG if DRM_I915_DP_TUNNEL
	select X86_MSR # used by igt/pm_rpm
	select DRM_VGEM # used by igt/prime_vgem (dmabuf interop checks)
	select DRM_DEBUG_MM if DRM=y
	select DRM_EXPORT_FOR_TESTS if m
	select DRM_DEBUG_SELFTEST
	select DMABUF_SELFTESTS
	select SW_SYNC # signaling validation framework (igt/syncobj*)
	select DRM_I915_WERROR
	select DRM_I915_DEBUG_GEM
	select DRM_I915_DEBUG_GEM_ONCE
	select DRM_I915_DEBUG_MMIO
	select DRM_I915_DEBUG_RUNTIME_PM
	select DRM_I915_DEBUG_WAKEREF
	select DRM_I915_SW_FENCE_DEBUG_OBJECTS
	select DRM_I915_SELFTEST
	default n
	help
	  Choose this option to turn on extra driver debugging that may affect
	  performance but will catch some internal issues.

	  Recommended for driver developers only.

	  If in doubt, say "N".

config DRM_I915_DEBUG_MMIO
	bool "Always insert extra checks around mmio access by default"
	default n
	help
	  By default, always enables the extra sanity checks (extra register
	  reads) around every mmio (register) access that will slow the system
	  down. This sets the default value of i915.mmio_debug to -1 and can
	  be overridden at module load.

	  Recommended for driver developers only.

	  If in doubt, say "N".

config DRM_I915_DEBUG_GEM
	bool "Insert extra checks into the GEM internals"
	default n
	depends on DRM_I915_WERROR
	help
	  Enable extra sanity checks (including BUGs) along the GEM driver
	  paths that may slow the system down and if hit hang the machine.

	  Recommended for driver developers only.

	  If in doubt, say "N".

config DRM_I915_DEBUG_GEM_ONCE
	bool "Make a GEM debug failure fatal"
	default n
	depends on DRM_I915_DEBUG_GEM
	help
	  During development, we often only want the very first failure
	  as that would otherwise be lost in the deluge of subsequent
	  failures. However, more casual testers may not want to trigger
	  a hard BUG_ON and hope that the system remains sufficiently usable
	  to capture a bug report in situ.

	  Recommended for driver developers only.

	  If in doubt, say "N".

config DRM_I915_ERRLOG_GEM
	bool "Insert extra logging (very verbose) for common GEM errors"
	default n
	depends on DRM_I915_DEBUG_GEM
	help
	  Enable additional logging that may help track down the cause of
	  principally userspace errors.

	  Recommended for driver developers only.

	  If in doubt, say "N".

config DRM_I915_TRACE_GEM
	bool "Insert extra ftrace output from the GEM internals"
	depends on DRM_I915_DEBUG_GEM
	select TRACING
	default n
	help
	  Enable additional and verbose debugging output that will spam
	  ordinary tests, but may be vital for post-mortem debugging when
	  used with /proc/sys/kernel/ftrace_dump_on_oops

	  Recommended for driver developers only.

	  If in doubt, say "N".

config DRM_I915_TRACE_GTT
	bool "Insert extra ftrace output from the GTT internals"
	depends on DRM_I915_DEBUG_GEM
	select TRACING
	default n
	help
	  Enable additional and verbose debugging output that will spam
	  ordinary tests, but may be vital for post-mortem debugging when
	  used with /proc/sys/kernel/ftrace_dump_on_oops

	  Recommended for driver developers only.

	  If in doubt, say "N".

config DRM_I915_SW_FENCE_DEBUG_OBJECTS
	bool "Enable additional driver debugging for fence objects"
	depends on DRM_I915
	select DEBUG_OBJECTS
	default n
	help
	  Choose this option to turn on extra driver debugging that may affect
	  performance but will catch some internal issues.

	  Recommended for driver developers only.

	  If in doubt, say "N".

config DRM_I915_SW_FENCE_CHECK_DAG
	bool "Enable additional driver debugging for detecting dependency cycles"
	depends on DRM_I915
	default n
	help
	  Choose this option to turn on extra driver debugging that may affect
	  performance but will catch some internal issues.

	  Recommended for driver developers only.

	  If in doubt, say "N".

config DRM_I915_DEBUG_GUC
	bool "Enable additional driver debugging for GuC"
	depends on DRM_I915
	select STACKDEPOT
	default n
	help
	  Choose this option to turn on extra driver debugging that may affect
	  performance but will help resolve GuC related issues.

	  Recommended for driver developers only.

	  If in doubt, say "N".

config DRM_I915_SELFTEST
	bool "Enable selftests upon driver load"
	depends on DRM_I915
	default n
	select DRM_EXPORT_FOR_TESTS if m
	select FAULT_INJECTION
	select PRIME_NUMBERS
	select CRC32
	help
	  Choose this option to allow the driver to perform selftests upon
	  loading; also requires the i915.selftest=1 module parameter. To
	  exit the module after running the selftests (i.e. to prevent normal
	  module initialisation afterwards) use i915.selftest=-1.

	  Recommended for driver developers only.

	  If in doubt, say "N".

config DRM_I915_SELFTEST_BROKEN
	bool "Enable broken and dangerous selftests"
	depends on DRM_I915_SELFTEST
	depends on BROKEN
	default n
	help
	  This option enables the execution of selftests that are "dangerous"
	  and may trigger unintended HW side-effects as they break strict
	  rules given in the HW specification. For science.

	  Recommended for masochistic driver developers only.

	  If in doubt, say "N".

config DRM_I915_LOW_LEVEL_TRACEPOINTS
	bool "Enable low level request tracing events"
	depends on DRM_I915
	default n
	help
	  Choose this option to turn on low level request tracing events.
	  This provides the ability to precisely monitor engine utilisation
	  and also analyze the request dependency resolving timeline.

	  Recommended for driver developers only.

	  If in doubt, say "N".

config DRM_I915_DEBUG_VBLANK_EVADE
	bool "Enable extra debug warnings for vblank evasion"
	depends on DRM_I915
	default n
	help
	  Choose this option to turn on extra debug warnings for the
	  vblank evade mechanism. This gives a warning every time the
	  the deadline allotted for the vblank evade critical section
	  is exceeded, even if there isn't an actual risk of missing
	  the vblank.

	  Recommended for driver developers only.

	  If in doubt, say "N".

config DRM_I915_DEBUG_RUNTIME_PM
	bool "Enable extra state checking for runtime PM"
	depends on DRM_I915
	default n
	select REF_TRACKER
	select STACKDEPOT
	select STACKTRACE
	help
	  Choose this option to turn on extra state checking for the
	  runtime PM functionality. This may introduce overhead during
	  driver loading, suspend and resume operations.

	  Recommended for driver developers only.

	  If in doubt, say "N"

config DRM_I915_DEBUG_WAKEREF
	bool "Enable extra tracking for wakerefs"
	depends on DRM_I915
	select REF_TRACKER
	select STACKDEPOT
	select STACKTRACE
	help
	  Choose this option to turn on extra state checking and usage
	  tracking for the wakerefPM functionality. This may introduce
	  overhead during driver runtime.

	  If in doubt, say "N"
Commit	Line	Data
ec8f24b7	1	# SPDX-License-Identifier: GPL-2.0-only
0a793ad3	2	config DRM_I915_WERROR
d30213e5 KK	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
d30213e5 KK	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.
0a793ad3	14
d30213e5	15	Recommended for driver developers only.
0a793ad3	16
d30213e5	17	If in doubt, say "N".
0a793ad3	18
643a24b6	19	config DRM_I915_DEBUG
d30213e5 KK	20	bool "Enable additional driver debugging"
d30213e5 KK	21	depends on DRM_I915
2a8f20bb CW	22	depends on EXPERT # only for developers
2a8f20bb CW	23	depends on !COMPILE_TEST # never built by robots
d30213e5 KK	24	select DEBUG_FS
d30213e5 KK	25	select PREEMPT_COUNT
d30213e5	26	select I2C_CHARDEV
b49e894c	27	select REF_TRACKER
d30213e5	28	select STACKDEPOT
b49e894c	29	select STACKTRACE
4d66d841	30	select DRM_DISPLAY_DP_AUX_CHARDEV
f6c74543	31	select DRM_DISPLAY_DP_TUNNEL_STATE_DEBUG if DRM_I915_DP_TUNNEL
d30213e5 KK	32	select X86_MSR # used by igt/pm_rpm
	33	select DRM_VGEM # used by igt/prime_vgem (dmabuf interop checks)
	34	select DRM_DEBUG_MM if DRM=y
85ca528e	35	select DRM_EXPORT_FOR_TESTS if m
34b13e5e	36	select DRM_DEBUG_SELFTEST
96158346	37	select DMABUF_SELFTESTS
d90cb7f8	38	select SW_SYNC # signaling validation framework (igt/syncobj*)
4f86975f CW	39	select DRM_I915_WERROR
4f86975f CW	40	select DRM_I915_DEBUG_GEM
03c62d88	41	select DRM_I915_DEBUG_GEM_ONCE
4f86975f CW	42	select DRM_I915_DEBUG_MMIO
4f86975f CW	43	select DRM_I915_DEBUG_RUNTIME_PM
5e4e06e4	44	select DRM_I915_DEBUG_WAKEREF
bdb821ca	45	select DRM_I915_SW_FENCE_DEBUG_OBJECTS
953c7f82	46	select DRM_I915_SELFTEST
d30213e5 KK	47	default n
	48	help
	49	Choose this option to turn on extra driver debugging that may affect
	50	performance but will catch some internal issues.
643a24b6	51
d30213e5	52	Recommended for driver developers only.
643a24b6	53
d30213e5	54	If in doubt, say "N".
643a24b6	55
1fbf9d81 CW	56	config DRM_I915_DEBUG_MMIO
	57	bool "Always insert extra checks around mmio access by default"
	58	default n
	59	help
	60	By default, always enables the extra sanity checks (extra register
	61	reads) around every mmio (register) access that will slow the system
	62	down. This sets the default value of i915.mmio_debug to -1 and can
	63	be overridden at module load.
	64
	65	Recommended for driver developers only.
	66
	67	If in doubt, say "N".
	68
d501b1d2	69	config DRM_I915_DEBUG_GEM
d30213e5 KK	70	bool "Insert extra checks into the GEM internals"
	71	default n
	72	depends on DRM_I915_WERROR
	73	help
	74	Enable extra sanity checks (including BUGs) along the GEM driver
	75	paths that may slow the system down and if hit hang the machine.
d501b1d2	76
d30213e5	77	Recommended for driver developers only.
d501b1d2	78
d30213e5	79	If in doubt, say "N".
d501b1d2	80
03c62d88 CW	81	config DRM_I915_DEBUG_GEM_ONCE
	82	bool "Make a GEM debug failure fatal"
	83	default n
	84	depends on DRM_I915_DEBUG_GEM
	85	help
	86	During development, we often only want the very first failure
	87	as that would otherwise be lost in the deluge of subsequent
	88	failures. However, more casual testers may not want to trigger
	89	a hard BUG_ON and hope that the system remains sufficiently usable
	90	to capture a bug report in situ.
	91
	92	Recommended for driver developers only.
	93
	94	If in doubt, say "N".
	95
1eca65d9 CW	96	config DRM_I915_ERRLOG_GEM
	97	bool "Insert extra logging (very verbose) for common GEM errors"
	98	default n
	99	depends on DRM_I915_DEBUG_GEM
	100	help
	101	Enable additional logging that may help track down the cause of
	102	principally userspace errors.
	103
	104	Recommended for driver developers only.
	105
	106	If in doubt, say "N".
	107
bccd3b83 CW	108	config DRM_I915_TRACE_GEM
bccd3b83 CW	109	bool "Insert extra ftrace output from the GEM internals"
16c8619a	110	depends on DRM_I915_DEBUG_GEM
bccd3b83 CW	111	select TRACING
	112	default n
	113	help
	114	Enable additional and verbose debugging output that will spam
	115	ordinary tests, but may be vital for post-mortem debugging when
	116	used with /proc/sys/kernel/ftrace_dump_on_oops
	117
	118	Recommended for driver developers only.
	119
	120	If in doubt, say "N".
	121
4c2be3c5 CW	122	config DRM_I915_TRACE_GTT
	123	bool "Insert extra ftrace output from the GTT internals"
	124	depends on DRM_I915_DEBUG_GEM
	125	select TRACING
	126	default n
	127	help
	128	Enable additional and verbose debugging output that will spam
	129	ordinary tests, but may be vital for post-mortem debugging when
	130	used with /proc/sys/kernel/ftrace_dump_on_oops
	131
	132	Recommended for driver developers only.
	133
	134	If in doubt, say "N".
	135
fc158405	136	config DRM_I915_SW_FENCE_DEBUG_OBJECTS
d30213e5 KK	137	bool "Enable additional driver debugging for fence objects"
	138	depends on DRM_I915
	139	select DEBUG_OBJECTS
	140	default n
	141	help
	142	Choose this option to turn on extra driver debugging that may affect
	143	performance but will catch some internal issues.
fc158405	144
d30213e5	145	Recommended for driver developers only.
fc158405	146
d30213e5	147	If in doubt, say "N".
953c7f82	148
47624cc3	149	config DRM_I915_SW_FENCE_CHECK_DAG
d30213e5 KK	150	bool "Enable additional driver debugging for detecting dependency cycles"
	151	depends on DRM_I915
	152	default n
	153	help
	154	Choose this option to turn on extra driver debugging that may affect
	155	performance but will catch some internal issues.
fc158405	156
d30213e5	157	Recommended for driver developers only.
fc158405	158
d30213e5	159	If in doubt, say "N".
953c7f82	160
0a015ff9	161	config DRM_I915_DEBUG_GUC
d30213e5 KK	162	bool "Enable additional driver debugging for GuC"
d30213e5 KK	163	depends on DRM_I915
a5606b94	164	select STACKDEPOT
d30213e5 KK	165	default n
	166	help
	167	Choose this option to turn on extra driver debugging that may affect
	168	performance but will help resolve GuC related issues.
0a015ff9	169
d30213e5	170	Recommended for driver developers only.
0a015ff9	171
d30213e5	172	If in doubt, say "N".
0a015ff9	173
953c7f82 CW	174	config DRM_I915_SELFTEST
	175	bool "Enable selftests upon driver load"
	176	depends on DRM_I915
	177	default n
85ca528e	178	select DRM_EXPORT_FOR_TESTS if m
aae4a3d8	179	select FAULT_INJECTION
953c7f82	180	select PRIME_NUMBERS
3da3c5c1	181	select CRC32
953c7f82 CW	182	help
	183	Choose this option to allow the driver to perform selftests upon
	184	loading; also requires the i915.selftest=1 module parameter. To
	185	exit the module after running the selftests (i.e. to prevent normal
	186	module initialisation afterwards) use i915.selftest=-1.
	187
	188	Recommended for driver developers only.
	189
	190	If in doubt, say "N".
354d036f	191
69ea47a5 CW	192	config DRM_I915_SELFTEST_BROKEN
	193	bool "Enable broken and dangerous selftests"
	194	depends on DRM_I915_SELFTEST
	195	depends on BROKEN
	196	default n
	197	help
	198	This option enables the execution of selftests that are "dangerous"
	199	and may trigger unintended HW side-effects as they break strict
	200	rules given in the HW specification. For science.
	201
	202	Recommended for masochistic driver developers only.
	203
	204	If in doubt, say "N".
	205
354d036f	206	config DRM_I915_LOW_LEVEL_TRACEPOINTS
d30213e5 KK	207	bool "Enable low level request tracing events"
	208	depends on DRM_I915
	209	default n
	210	help
	211	Choose this option to turn on low level request tracing events.
	212	This provides the ability to precisely monitor engine utilisation
	213	and also analyze the request dependency resolving timeline.
	214
7e8376f1 DV	215	Recommended for driver developers only.
7e8376f1 DV	216
d30213e5	217	If in doubt, say "N".
7b8cd336 VS	218
	219	config DRM_I915_DEBUG_VBLANK_EVADE
	220	bool "Enable extra debug warnings for vblank evasion"
	221	depends on DRM_I915
	222	default n
	223	help
	224	Choose this option to turn on extra debug warnings for the
	225	vblank evade mechanism. This gives a warning every time the
	226	the deadline allotted for the vblank evade critical section
	227	is exceeded, even if there isn't an actual risk of missing
	228	the vblank.
	229
7e8376f1 DV	230	Recommended for driver developers only.
7e8376f1 DV	231
7b8cd336	232	If in doubt, say "N".
6dfc4a8f ID	233
	234	config DRM_I915_DEBUG_RUNTIME_PM
	235	bool "Enable extra state checking for runtime PM"
	236	depends on DRM_I915
	237	default n
b49e894c	238	select REF_TRACKER
bd780f37	239	select STACKDEPOT
b49e894c	240	select STACKTRACE
6dfc4a8f ID	241	help
	242	Choose this option to turn on extra state checking for the
	243	runtime PM functionality. This may introduce overhead during
	244	driver loading, suspend and resume operations.
	245
7e8376f1 DV	246	Recommended for driver developers only.
7e8376f1 DV	247
6dfc4a8f	248	If in doubt, say "N"
5e4e06e4 AH	249
	250	config DRM_I915_DEBUG_WAKEREF
	251	bool "Enable extra tracking for wakerefs"
	252	depends on DRM_I915
	253	select REF_TRACKER
	254	select STACKDEPOT
	255	select STACKTRACE
	256	help
	257	Choose this option to turn on extra state checking and usage
	258	tracking for the wakerefPM functionality. This may introduce
	259	overhead during driver runtime.
	260
	261	If in doubt, say "N"