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 REF_TRACKER
  28         select STACKDEPOT
  29         select STACKTRACE
  30         select DRM_DP_AUX_CHARDEV
  31         select DRM_DISPLAY_DEBUG_DP_TUNNEL_STATE if DRM_I915_DP_TUNNEL
  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
  35         select DRM_EXPORT_FOR_TESTS if m
  36         select DRM_DEBUG_SELFTEST
  37         select DMABUF_SELFTESTS
  38         select SW_SYNC # signaling validation framework (igt/syncobj*)
  39         select DRM_I915_WERROR
  40         select DRM_I915_DEBUG_GEM
  41         select DRM_I915_DEBUG_GEM_ONCE
  42         select DRM_I915_DEBUG_MMIO
  43         select DRM_I915_DEBUG_RUNTIME_PM
  44         select DRM_I915_DEBUG_WAKEREF
  45         select DRM_I915_SW_FENCE_DEBUG_OBJECTS
  46         select DRM_I915_SELFTEST
  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.
  51
  52           Recommended for driver developers only.
  53
  54           If in doubt, say "N".
  55
  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
  69 config DRM_I915_DEBUG_GEM
  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.
  76
  77           Recommended for driver developers only.
  78
  79           If in doubt, say "N".
  80
  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
  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
 108 config DRM_I915_TRACE_GEM
 109         bool "Insert extra ftrace output from the GEM internals"
 110         depends on DRM_I915_DEBUG_GEM
 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
 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
 136 config DRM_I915_SW_FENCE_DEBUG_OBJECTS
 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.
 144
 145           Recommended for driver developers only.
 146
 147           If in doubt, say "N".
 148
 149 config DRM_I915_SW_FENCE_CHECK_DAG
 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.
 156
 157           Recommended for driver developers only.
 158
 159           If in doubt, say "N".
 160
 161 config DRM_I915_DEBUG_GUC
 162         bool "Enable additional driver debugging for GuC"
 163         depends on DRM_I915
 164         select STACKDEPOT
 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.
 169
 170           Recommended for driver developers only.
 171
 172           If in doubt, say "N".
 173
 174 config DRM_I915_SELFTEST
 175         bool "Enable selftests upon driver load"
 176         depends on DRM_I915
 177         default n
 178         select DRM_EXPORT_FOR_TESTS if m
 179         select FAULT_INJECTION
 180         select PRIME_NUMBERS
 181         select CRC32
 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".
 191
 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
 206 config DRM_I915_LOW_LEVEL_TRACEPOINTS
 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
 215           Recommended for driver developers only.
 216
 217           If in doubt, say "N".
 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
 230           Recommended for driver developers only.
 231
 232           If in doubt, say "N".
 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
 238         select REF_TRACKER
 239         select STACKDEPOT
 240         select STACKTRACE
 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
 246           Recommended for driver developers only.
 247
 248           If in doubt, say "N"
 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"