drivers/gpu/drm/i915/i915_params.c

   1 /*
   2  * Copyright © 2014 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the
   6  * "Software"), to deal in the Software without restriction, including
   7  * without limitation the rights to use, copy, modify, merge, publish,
   8  * distribute, sub license, and/or sell copies of the Software, and to
   9  * permit persons to whom the Software is furnished to do so, subject to
  10  * the following conditions:
  11  *
  12  * The above copyright notice and this permission notice (including the
  13  * next paragraph) shall be included in all copies or substantial portions
  14  * of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  22  * IN THE SOFTWARE.
  23  */
  24
  25 #include <linux/string_helpers.h>
  26
  27 #include <drm/drm_print.h>
  28
  29 #include "i915_params.h"
  30 #include "i915_drv.h"
  31
  32 DECLARE_DYNDBG_CLASSMAP(drm_debug_classes, DD_CLASS_TYPE_DISJOINT_BITS, 0,
  33                         "DRM_UT_CORE",
  34                         "DRM_UT_DRIVER",
  35                         "DRM_UT_KMS",
  36                         "DRM_UT_PRIME",
  37                         "DRM_UT_ATOMIC",
  38                         "DRM_UT_VBL",
  39                         "DRM_UT_STATE",
  40                         "DRM_UT_LEASE",
  41                         "DRM_UT_DP",
  42                         "DRM_UT_DRMRES");
  43
  44 #define i915_param_named(name, T, perm, desc) \
  45         module_param_named(name, i915_modparams.name, T, perm); \
  46         MODULE_PARM_DESC(name, desc)
  47 #define i915_param_named_unsafe(name, T, perm, desc) \
  48         module_param_named_unsafe(name, i915_modparams.name, T, perm); \
  49         MODULE_PARM_DESC(name, desc)
  50
  51 struct i915_params i915_modparams __read_mostly = {
  52 #define MEMBER(T, member, value, ...) .member = (value),
  53         I915_PARAMS_FOR_EACH(MEMBER)
  54 #undef MEMBER
  55 };
  56
  57 /*
  58  * Note: As a rule, keep module parameter sysfs permissions read-only
  59  * 0400. Runtime changes are only supported through i915 debugfs.
  60  *
  61  * For any exceptions requiring write access and runtime changes through module
  62  * parameter sysfs, prevent debugfs file creation by setting the parameter's
  63  * debugfs mode to 0.
  64  */
  65
  66 i915_param_named(modeset, int, 0400,
  67         "Use kernel modesetting [KMS] (0=disable, "
  68         "1=on, -1=force vga console preference [default])");
  69
  70 i915_param_named_unsafe(enable_dc, int, 0400,
  71         "Enable power-saving display C-states. "
  72         "(-1=auto [default]; 0=disable; 1=up to DC5; 2=up to DC6; "
  73         "3=up to DC5 with DC3CO; 4=up to DC6 with DC3CO)");
  74
  75 i915_param_named_unsafe(enable_fbc, int, 0400,
  76         "Enable frame buffer compression for power savings "
  77         "(default: -1 (use per-chip default))");
  78
  79 i915_param_named_unsafe(lvds_channel_mode, int, 0400,
  80          "Specify LVDS channel mode "
  81          "(0=probe BIOS [default], 1=single-channel, 2=dual-channel)");
  82
  83 i915_param_named_unsafe(panel_use_ssc, int, 0400,
  84         "Use Spread Spectrum Clock with panels [LVDS/eDP] "
  85         "(default: auto from VBT)");
  86
  87 i915_param_named_unsafe(vbt_sdvo_panel_type, int, 0400,
  88         "Override/Ignore selection of SDVO panel mode in the VBT "
  89         "(-2=ignore, -1=auto [default], index in VBT BIOS table)");
  90
  91 i915_param_named_unsafe(reset, uint, 0400,
  92         "Attempt GPU resets (0=disabled, 1=full gpu reset, 2=engine reset [default])");
  93
  94 i915_param_named_unsafe(vbt_firmware, charp, 0400,
  95         "Load VBT from specified file under /lib/firmware");
  96
  97 #if IS_ENABLED(CONFIG_DRM_I915_CAPTURE_ERROR)
  98 i915_param_named(error_capture, bool, 0400,
  99         "Record the GPU state following a hang. "
 100         "This information in /sys/class/drm/card<N>/error is vital for "
 101         "triaging and debugging hangs.");
 102 #endif
 103
 104 i915_param_named_unsafe(enable_hangcheck, bool, 0400,
 105         "Periodically check GPU activity for detecting hangs. "
 106         "WARNING: Disabling this can cause system wide hangs. "
 107         "(default: true)");
 108
 109 i915_param_named_unsafe(enable_psr, int, 0400,
 110         "Enable PSR "
 111         "(0=disabled, 1=enable up to PSR1, 2=enable up to PSR2) "
 112         "Default: -1 (use per-chip default)");
 113
 114 i915_param_named(psr_safest_params, bool, 0400,
 115         "Replace PSR VBT parameters by the safest and not optimal ones. This "
 116         "is helpful to detect if PSR issues are related to bad values set in "
 117         " VBT. (0=use VBT parameters, 1=use safest parameters)");
 118
 119 i915_param_named_unsafe(enable_psr2_sel_fetch, bool, 0400,
 120         "Enable PSR2 selective fetch "
 121         "(0=disabled, 1=enabled) "
 122         "Default: 0");
 123
 124 i915_param_named_unsafe(force_probe, charp, 0400,
 125         "Force probe the driver for specified devices. "
 126         "See CONFIG_DRM_I915_FORCE_PROBE for details.");
 127
 128 i915_param_named_unsafe(disable_power_well, int, 0400,
 129         "Disable display power wells when possible "
 130         "(-1=auto [default], 0=power wells always on, 1=power wells disabled when possible)");
 131
 132 i915_param_named_unsafe(enable_ips, int, 0400, "Enable IPS (default: true)");
 133
 134 i915_param_named(fastboot, int, 0400,
 135         "Try to skip unnecessary mode sets at boot time "
 136         "(0=disabled, 1=enabled) "
 137         "Default: -1 (use per-chip default)");
 138
 139 i915_param_named_unsafe(load_detect_test, bool, 0400,
 140         "Force-enable the VGA load detect code for testing (default:false). "
 141         "For developers only.");
 142
 143 i915_param_named_unsafe(force_reset_modeset_test, bool, 0400,
 144         "Force a modeset during gpu reset for testing (default:false). "
 145         "For developers only.");
 146
 147 i915_param_named_unsafe(invert_brightness, int, 0400,
 148         "Invert backlight brightness "
 149         "(-1 force normal, 0 machine defaults, 1 force inversion), please "
 150         "report PCI device ID, subsystem vendor and subsystem device ID "
 151         "to [email protected], if your machine needs it. "
 152         "It will then be included in an upcoming module version.");
 153
 154 i915_param_named(disable_display, bool, 0400,
 155         "Disable display (default: false)");
 156
 157 i915_param_named(memtest, bool, 0400,
 158         "Perform a read/write test of all device memory on module load (default: off)");
 159
 160 i915_param_named(mmio_debug, int, 0400,
 161         "Enable the MMIO debug code for the first N failures (default: off). "
 162         "This may negatively affect performance.");
 163
 164 /* Special case writable file */
 165 i915_param_named(verbose_state_checks, bool, 0600,
 166         "Enable verbose logs (ie. WARN_ON()) in case of unexpected hw state conditions.");
 167
 168 i915_param_named_unsafe(nuclear_pageflip, bool, 0400,
 169         "Force enable atomic functionality on platforms that don't have full support yet.");
 170
 171 /* WA to get away with the default setting in VBT for early platforms.Will be removed */
 172 i915_param_named_unsafe(edp_vswing, int, 0400,
 173         "Ignore/Override vswing pre-emph table selection from VBT "
 174         "(0=use value from vbt [default], 1=low power swing(200mV),"
 175         "2=default swing(400mV))");
 176
 177 i915_param_named_unsafe(enable_guc, int, 0400,
 178         "Enable GuC load for GuC submission and/or HuC load. "
 179         "Required functionality can be selected using bitmask values. "
 180         "(-1=auto [default], 0=disable, 1=GuC submission, 2=HuC load)");
 181
 182 i915_param_named(guc_log_level, int, 0400,
 183         "GuC firmware logging level. Requires GuC to be loaded. "
 184         "(-1=auto [default], 0=disable, 1..4=enable with verbosity min..max)");
 185
 186 i915_param_named_unsafe(guc_firmware_path, charp, 0400,
 187         "GuC firmware path to use instead of the default one");
 188
 189 i915_param_named_unsafe(huc_firmware_path, charp, 0400,
 190         "HuC firmware path to use instead of the default one");
 191
 192 i915_param_named_unsafe(dmc_firmware_path, charp, 0400,
 193         "DMC firmware path to use instead of the default one");
 194
 195 i915_param_named_unsafe(enable_dp_mst, bool, 0400,
 196         "Enable multi-stream transport (MST) for new DisplayPort sinks. (default: true)");
 197
 198 #if IS_ENABLED(CONFIG_DRM_I915_DEBUG)
 199 i915_param_named_unsafe(inject_probe_failure, uint, 0400,
 200         "Force an error after a number of failure check points (0:disabled (default), N:force failure at the Nth failure check point)");
 201 #endif
 202
 203 i915_param_named(enable_dpcd_backlight, int, 0400,
 204         "Enable support for DPCD backlight control"
 205         "(-1=use per-VBT LFP backlight type setting [default], 0=disabled, 1=enable, 2=force VESA interface, 3=force Intel interface)");
 206
 207 #if IS_ENABLED(CONFIG_DRM_I915_GVT)
 208 i915_param_named(enable_gvt, bool, 0400,
 209         "Enable support for Intel GVT-g graphics virtualization host support(default:false)");
 210 #endif
 211
 212 #if CONFIG_DRM_I915_REQUEST_TIMEOUT
 213 i915_param_named_unsafe(request_timeout_ms, uint, 0600,
 214                         "Default request/fence/batch buffer expiration timeout.");
 215 #endif
 216
 217 i915_param_named_unsafe(lmem_size, uint, 0400,
 218                         "Set the lmem size(in MiB) for each region. (default: 0, all memory)");
 219 i915_param_named_unsafe(lmem_bar_size, uint, 0400,
 220                         "Set the lmem bar size(in MiB).");
 221
 222 static __always_inline void _print_param(struct drm_printer *p,
 223                                          const char *name,
 224                                          const char *type,
 225                                          const void *x)
 226 {
 227         if (!__builtin_strcmp(type, "bool"))
 228                 drm_printf(p, "i915.%s=%s\n", name,
 229                            str_yes_no(*(const bool *)x));
 230         else if (!__builtin_strcmp(type, "int"))
 231                 drm_printf(p, "i915.%s=%d\n", name, *(const int *)x);
 232         else if (!__builtin_strcmp(type, "unsigned int"))
 233                 drm_printf(p, "i915.%s=%u\n", name, *(const unsigned int *)x);
 234         else if (!__builtin_strcmp(type, "unsigned long"))
 235                 drm_printf(p, "i915.%s=%lu\n", name, *(const unsigned long *)x);
 236         else if (!__builtin_strcmp(type, "char *"))
 237                 drm_printf(p, "i915.%s=%s\n", name, *(const char **)x);
 238         else
 239                 WARN_ONCE(1, "no printer defined for param type %s (i915.%s)\n",
 240                           type, name);
 241 }
 242
 243 /**
 244  * i915_params_dump - dump i915 modparams
 245  * @params: i915 modparams
 246  * @p: the &drm_printer
 247  *
 248  * Pretty printer for i915 modparams.
 249  */
 250 void i915_params_dump(const struct i915_params *params, struct drm_printer *p)
 251 {
 252 #define PRINT(T, x, ...) _print_param(p, #x, #T, &params->x);
 253         I915_PARAMS_FOR_EACH(PRINT);
 254 #undef PRINT
 255 }
 256
 257 static __always_inline void dup_param(const char *type, void *x)
 258 {
 259         if (!__builtin_strcmp(type, "char *"))
 260                 *(void **)x = kstrdup(*(void **)x, GFP_ATOMIC);
 261 }
 262
 263 void i915_params_copy(struct i915_params *dest, const struct i915_params *src)
 264 {
 265         *dest = *src;
 266 #define DUP(T, x, ...) dup_param(#T, &dest->x);
 267         I915_PARAMS_FOR_EACH(DUP);
 268 #undef DUP
 269 }
 270
 271 static __always_inline void free_param(const char *type, void *x)
 272 {
 273         if (!__builtin_strcmp(type, "char *")) {
 274                 kfree(*(void **)x);
 275                 *(void **)x = NULL;
 276         }
 277 }
 278
 279 /* free the allocated members, *not* the passed in params itself */
 280 void i915_params_free(struct i915_params *params)
 281 {
 282 #define FREE(T, x, ...) free_param(#T, &params->x);
 283         I915_PARAMS_FOR_EACH(FREE);
 284 #undef FREE
 285 }