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