[linux-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
	select DEBUG_FS
	select PREEMPT_COUNT
	select I2C_CHARDEV
	select STACKDEPOT
	select DRM_DP_AUX_CHARDEV
	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_SW_FENCE_DEBUG_OBJECTS
	select DRM_I915_SELFTEST
	select DRM_I915_DEBUG_RUNTIME_PM
	select DRM_I915_DEBUG_MMIO
	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_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
	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
	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.

	  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.

	  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 STACKDEPOT
	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.

	  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"
	21	depends on DRM_I915
	22	select DEBUG_FS
	23	select PREEMPT_COUNT
d30213e5 KK	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
85ca528e	30	select DRM_EXPORT_FOR_TESTS if m
34b13e5e	31	select DRM_DEBUG_SELFTEST
96158346	32	select DMABUF_SELFTESTS
d90cb7f8	33	select SW_SYNC # signaling validation framework (igt/syncobj*)
bdb821ca	34	select DRM_I915_SW_FENCE_DEBUG_OBJECTS
953c7f82	35	select DRM_I915_SELFTEST
6dfc4a8f	36	select DRM_I915_DEBUG_RUNTIME_PM
1fbf9d81	37	select DRM_I915_DEBUG_MMIO
d30213e5 KK	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.
643a24b6	42
d30213e5	43	Recommended for driver developers only.
643a24b6	44
d30213e5	45	If in doubt, say "N".
643a24b6	46
1fbf9d81 CW	47	config 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
d501b1d2	60	config DRM_I915_DEBUG_GEM
d30213e5 KK	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.
d501b1d2	67
d30213e5	68	Recommended for driver developers only.
d501b1d2	69
d30213e5	70	If in doubt, say "N".
d501b1d2	71
1eca65d9 CW	72	config 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
bccd3b83 CW	84	config DRM_I915_TRACE_GEM
bccd3b83 CW	85	bool "Insert extra ftrace output from the GEM internals"
16c8619a	86	depends on DRM_I915_DEBUG_GEM
bccd3b83 CW	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
4c2be3c5 CW	98	config 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
fc158405	112	config DRM_I915_SW_FENCE_DEBUG_OBJECTS
d30213e5 KK	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.
fc158405	120
d30213e5	121	Recommended for driver developers only.
fc158405	122
d30213e5	123	If in doubt, say "N".
953c7f82	124
47624cc3	125	config DRM_I915_SW_FENCE_CHECK_DAG
d30213e5 KK	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.
fc158405	132
d30213e5	133	Recommended for driver developers only.
fc158405	134
d30213e5	135	If in doubt, say "N".
953c7f82	136
0a015ff9	137	config DRM_I915_DEBUG_GUC
d30213e5 KK	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.
0a015ff9	144
d30213e5	145	Recommended for driver developers only.
0a015ff9	146
d30213e5	147	If in doubt, say "N".
0a015ff9	148
953c7f82 CW	149	config DRM_I915_SELFTEST
	150	bool "Enable selftests upon driver load"
	151	depends on DRM_I915
	152	default n
85ca528e	153	select DRM_EXPORT_FOR_TESTS if m
aae4a3d8	154	select FAULT_INJECTION
953c7f82 CW	155	select PRIME_NUMBERS
	156	help
	157	Choose this option to allow the driver to perform selftests upon
	158	loading; also requires the i915.selftest=1 module parameter. To
	159	exit the module after running the selftests (i.e. to prevent normal
	160	module initialisation afterwards) use i915.selftest=-1.
	161
	162	Recommended for driver developers only.
	163
	164	If in doubt, say "N".
354d036f	165
69ea47a5 CW	166	config DRM_I915_SELFTEST_BROKEN
	167	bool "Enable broken and dangerous selftests"
	168	depends on DRM_I915_SELFTEST
	169	depends on BROKEN
	170	default n
	171	help
	172	This option enables the execution of selftests that are "dangerous"
	173	and may trigger unintended HW side-effects as they break strict
	174	rules given in the HW specification. For science.
	175
	176	Recommended for masochistic driver developers only.
	177
	178	If in doubt, say "N".
	179
354d036f	180	config DRM_I915_LOW_LEVEL_TRACEPOINTS
d30213e5 KK	181	bool "Enable low level request tracing events"
	182	depends on DRM_I915
	183	default n
	184	help
	185	Choose this option to turn on low level request tracing events.
	186	This provides the ability to precisely monitor engine utilisation
	187	and also analyze the request dependency resolving timeline.
	188
	189	If in doubt, say "N".
7b8cd336 VS	190
	191	config DRM_I915_DEBUG_VBLANK_EVADE
	192	bool "Enable extra debug warnings for vblank evasion"
	193	depends on DRM_I915
	194	default n
	195	help
	196	Choose this option to turn on extra debug warnings for the
	197	vblank evade mechanism. This gives a warning every time the
	198	the deadline allotted for the vblank evade critical section
	199	is exceeded, even if there isn't an actual risk of missing
	200	the vblank.
	201
	202	If in doubt, say "N".
6dfc4a8f ID	203
	204	config DRM_I915_DEBUG_RUNTIME_PM
	205	bool "Enable extra state checking for runtime PM"
	206	depends on DRM_I915
	207	default n
bd780f37	208	select STACKDEPOT
6dfc4a8f ID	209	help
	210	Choose this option to turn on extra state checking for the
	211	runtime PM functionality. This may introduce overhead during
	212	driver loading, suspend and resume operations.
	213
	214	If in doubt, say "N"