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