drivers/gpu/drm/i915/Kconfig.debug

   1 # SPDX-License-Identifier: GPL-2.0-only
   2 config 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         select HEADER_TEST
  11         default n
  12         help
  13           Add -Werror to the build flags for (and only for) i915.ko.
  14           Do not enable this unless you are writing code for the i915.ko module.
  15
  16           Recommended for driver developers only.
  17
  18           If in doubt, say "N".
  19
  20 config DRM_I915_DEBUG
  21         bool "Enable additional driver debugging"
  22         depends on DRM_I915
  23         select DEBUG_FS
  24         select PREEMPT_COUNT
  25         select REFCOUNT_FULL
  26         select I2C_CHARDEV
  27         select STACKDEPOT
  28         select DRM_DP_AUX_CHARDEV
  29         select X86_MSR # used by igt/pm_rpm
  30         select DRM_VGEM # used by igt/prime_vgem (dmabuf interop checks)
  31         select DRM_DEBUG_MM if DRM=y
  32         select DRM_DEBUG_SELFTEST
  33         select DMABUF_SELFTESTS
  34         select SW_SYNC # signaling validation framework (igt/syncobj*)
  35         select DRM_I915_SW_FENCE_DEBUG_OBJECTS
  36         select DRM_I915_SELFTEST
  37         select DRM_I915_DEBUG_RUNTIME_PM
  38         select DRM_I915_DEBUG_MMIO
  39         default n
  40         help
  41           Choose this option to turn on extra driver debugging that may affect
  42           performance but will catch some internal issues.
  43
  44           Recommended for driver developers only.
  45
  46           If in doubt, say "N".
  47
  48 config DRM_I915_DEBUG_MMIO
  49         bool "Always insert extra checks around mmio access by default"
  50         default n
  51         help
  52           By default, always enables the extra sanity checks (extra register
  53           reads) around every mmio (register) access that will slow the system
  54           down. This sets the default value of i915.mmio_debug to -1 and can
  55           be overridden at module load.
  56
  57           Recommended for driver developers only.
  58
  59           If in doubt, say "N".
  60
  61 config DRM_I915_DEBUG_GEM
  62         bool "Insert extra checks into the GEM internals"
  63         default n
  64         depends on DRM_I915_WERROR
  65         help
  66           Enable extra sanity checks (including BUGs) along the GEM driver
  67           paths that may slow the system down and if hit hang the machine.
  68
  69           Recommended for driver developers only.
  70
  71           If in doubt, say "N".
  72
  73 config DRM_I915_ERRLOG_GEM
  74         bool "Insert extra logging (very verbose) for common GEM errors"
  75         default n
  76         depends on DRM_I915_DEBUG_GEM
  77         help
  78           Enable additional logging that may help track down the cause of
  79           principally userspace errors.
  80
  81           Recommended for driver developers only.
  82
  83           If in doubt, say "N".
  84
  85 config DRM_I915_TRACE_GEM
  86         bool "Insert extra ftrace output from the GEM internals"
  87         depends on DRM_I915_DEBUG_GEM
  88         select TRACING
  89         default n
  90         help
  91           Enable additional and verbose debugging output that will spam
  92           ordinary tests, but may be vital for post-mortem debugging when
  93           used with /proc/sys/kernel/ftrace_dump_on_oops
  94
  95           Recommended for driver developers only.
  96
  97           If in doubt, say "N".
  98
  99 config DRM_I915_TRACE_GTT
 100         bool "Insert extra ftrace output from the GTT internals"
 101         depends on DRM_I915_DEBUG_GEM
 102         select TRACING
 103         default n
 104         help
 105           Enable additional and verbose debugging output that will spam
 106           ordinary tests, but may be vital for post-mortem debugging when
 107           used with /proc/sys/kernel/ftrace_dump_on_oops
 108
 109           Recommended for driver developers only.
 110
 111           If in doubt, say "N".
 112
 113 config DRM_I915_SW_FENCE_DEBUG_OBJECTS
 114         bool "Enable additional driver debugging for fence objects"
 115         depends on DRM_I915
 116         select DEBUG_OBJECTS
 117         default n
 118         help
 119           Choose this option to turn on extra driver debugging that may affect
 120           performance but will catch some internal issues.
 121
 122           Recommended for driver developers only.
 123
 124           If in doubt, say "N".
 125
 126 config DRM_I915_SW_FENCE_CHECK_DAG
 127         bool "Enable additional driver debugging for detecting dependency cycles"
 128         depends on DRM_I915
 129         default n
 130         help
 131           Choose this option to turn on extra driver debugging that may affect
 132           performance but will catch some internal issues.
 133
 134           Recommended for driver developers only.
 135
 136           If in doubt, say "N".
 137
 138 config DRM_I915_DEBUG_GUC
 139         bool "Enable additional driver debugging for GuC"
 140         depends on DRM_I915
 141         default n
 142         help
 143           Choose this option to turn on extra driver debugging that may affect
 144           performance but will help resolve GuC related issues.
 145
 146           Recommended for driver developers only.
 147
 148           If in doubt, say "N".
 149
 150 config DRM_I915_SELFTEST
 151         bool "Enable selftests upon driver load"
 152         depends on DRM_I915
 153         default n
 154         select FAULT_INJECTION
 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".
 165
 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
 180 config DRM_I915_LOW_LEVEL_TRACEPOINTS
 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".
 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".
 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
 208         select STACKDEPOT
 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"