Loading...
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
32DECLARE_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
51struct 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
66i915_param_named(modeset, int, 0400,
67 "Deprecated. Use the 'nomodeset' kernel parameter instead.");
68
69i915_param_named_unsafe(reset, uint, 0400,
70 "Attempt GPU resets (0=disabled, 1=full gpu reset, 2=engine reset [default])");
71
72#if IS_ENABLED(CONFIG_DRM_I915_CAPTURE_ERROR)
73i915_param_named(error_capture, bool, 0400,
74 "Record the GPU state following a hang. "
75 "This information in /sys/class/drm/card<N>/error is vital for "
76 "triaging and debugging hangs.");
77#endif
78
79i915_param_named_unsafe(enable_hangcheck, bool, 0400,
80 "Periodically check GPU activity for detecting hangs. "
81 "WARNING: Disabling this can cause system wide hangs. "
82 "(default: true)");
83
84i915_param_named_unsafe(force_probe, charp, 0400,
85 "Force probe options for specified supported devices. "
86 "See CONFIG_DRM_I915_FORCE_PROBE for details.");
87
88i915_param_named(memtest, bool, 0400,
89 "Perform a read/write test of all device memory on module load (default: off)");
90
91i915_param_named(mmio_debug, int, 0400,
92 "Enable the MMIO debug code for the first N failures (default: off). "
93 "This may negatively affect performance.");
94
95i915_param_named_unsafe(enable_guc, int, 0400,
96 "Enable GuC load for GuC submission and/or HuC load. "
97 "Required functionality can be selected using bitmask values. "
98 "(-1=auto [default], 0=disable, 1=GuC submission, 2=HuC load)");
99
100i915_param_named(guc_log_level, int, 0400,
101 "GuC firmware logging level. Requires GuC to be loaded. "
102 "(-1=auto [default], 0=disable, 1..4=enable with verbosity min..max)");
103
104i915_param_named_unsafe(guc_firmware_path, charp, 0400,
105 "GuC firmware path to use instead of the default one");
106
107i915_param_named_unsafe(huc_firmware_path, charp, 0400,
108 "HuC firmware path to use instead of the default one");
109
110i915_param_named_unsafe(gsc_firmware_path, charp, 0400,
111 "GSC firmware path to use instead of the default one");
112
113#if IS_ENABLED(CONFIG_DRM_I915_DEBUG)
114i915_param_named_unsafe(inject_probe_failure, uint, 0400,
115 "Force an error after a number of failure check points (0:disabled (default), N:force failure at the Nth failure check point)");
116#endif
117
118#if IS_ENABLED(CONFIG_DRM_I915_GVT)
119i915_param_named(enable_gvt, bool, 0400,
120 "Enable support for Intel GVT-g graphics virtualization host support(default:false)");
121#endif
122
123#if CONFIG_DRM_I915_REQUEST_TIMEOUT
124i915_param_named_unsafe(request_timeout_ms, uint, 0600,
125 "Default request/fence/batch buffer expiration timeout.");
126#endif
127
128i915_param_named_unsafe(lmem_size, uint, 0400,
129 "Set the lmem size(in MiB) for each region. (default: 0, all memory)");
130i915_param_named_unsafe(lmem_bar_size, uint, 0400,
131 "Set the lmem bar size(in MiB).");
132
133#if IS_ENABLED(CONFIG_DRM_I915_REPLAY_GPU_HANGS_API)
134i915_param_named(enable_debug_only_api, bool, 0400,
135 "Enable support for unstable debug only userspace API. (default:false)");
136#endif
137
138static void _param_print_bool(struct drm_printer *p, const char *name,
139 bool val)
140{
141 drm_printf(p, "i915.%s=%s\n", name, str_yes_no(val));
142}
143
144static void _param_print_int(struct drm_printer *p, const char *name,
145 int val)
146{
147 drm_printf(p, "i915.%s=%d\n", name, val);
148}
149
150static void _param_print_uint(struct drm_printer *p, const char *name,
151 unsigned int val)
152{
153 drm_printf(p, "i915.%s=%u\n", name, val);
154}
155
156static void _param_print_ulong(struct drm_printer *p, const char *name,
157 unsigned long val)
158{
159 drm_printf(p, "i915.%s=%lu\n", name, val);
160}
161
162static void _param_print_charp(struct drm_printer *p, const char *name,
163 const char *val)
164{
165 drm_printf(p, "i915.%s=%s\n", name, val);
166}
167
168#define _param_print(p, name, val) \
169 _Generic(val, \
170 bool: _param_print_bool, \
171 int: _param_print_int, \
172 unsigned int: _param_print_uint, \
173 unsigned long: _param_print_ulong, \
174 char *: _param_print_charp)(p, name, val)
175
176/**
177 * i915_params_dump - dump i915 modparams
178 * @params: i915 modparams
179 * @p: the &drm_printer
180 *
181 * Pretty printer for i915 modparams.
182 */
183void i915_params_dump(const struct i915_params *params, struct drm_printer *p)
184{
185#define PRINT(T, x, ...) _param_print(p, #x, params->x);
186 I915_PARAMS_FOR_EACH(PRINT);
187#undef PRINT
188}
189
190static void _param_dup_charp(char **valp)
191{
192 *valp = kstrdup(*valp, GFP_ATOMIC);
193}
194
195static void _param_nop(void *valp)
196{
197}
198
199#define _param_dup(valp) \
200 _Generic(valp, \
201 char **: _param_dup_charp, \
202 default: _param_nop)(valp)
203
204void i915_params_copy(struct i915_params *dest, const struct i915_params *src)
205{
206 *dest = *src;
207#define DUP(T, x, ...) _param_dup(&dest->x);
208 I915_PARAMS_FOR_EACH(DUP);
209#undef DUP
210}
211
212static void _param_free_charp(char **valp)
213{
214 kfree(*valp);
215 *valp = NULL;
216}
217
218#define _param_free(valp) \
219 _Generic(valp, \
220 char **: _param_free_charp, \
221 default: _param_nop)(valp)
222
223/* free the allocated members, *not* the passed in params itself */
224void i915_params_free(struct i915_params *params)
225{
226#define FREE(T, x, ...) _param_free(¶ms->x);
227 I915_PARAMS_FOR_EACH(FREE);
228#undef FREE
229}
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 <drm/drm_print.h>
26
27#include "i915_params.h"
28#include "i915_drv.h"
29
30#define i915_param_named(name, T, perm, desc) \
31 module_param_named(name, i915_modparams.name, T, perm); \
32 MODULE_PARM_DESC(name, desc)
33#define i915_param_named_unsafe(name, T, perm, desc) \
34 module_param_named_unsafe(name, i915_modparams.name, T, perm); \
35 MODULE_PARM_DESC(name, desc)
36
37struct i915_params i915_modparams __read_mostly = {
38#define MEMBER(T, member, value, ...) .member = (value),
39 I915_PARAMS_FOR_EACH(MEMBER)
40#undef MEMBER
41};
42
43/*
44 * Note: As a rule, keep module parameter sysfs permissions read-only
45 * 0400. Runtime changes are only supported through i915 debugfs.
46 *
47 * For any exceptions requiring write access and runtime changes through module
48 * parameter sysfs, prevent debugfs file creation by setting the parameter's
49 * debugfs mode to 0.
50 */
51
52i915_param_named(modeset, int, 0400,
53 "Use kernel modesetting [KMS] (0=disable, "
54 "1=on, -1=force vga console preference [default])");
55
56i915_param_named_unsafe(enable_dc, int, 0400,
57 "Enable power-saving display C-states. "
58 "(-1=auto [default]; 0=disable; 1=up to DC5; 2=up to DC6; "
59 "3=up to DC5 with DC3CO; 4=up to DC6 with DC3CO)");
60
61i915_param_named_unsafe(enable_fbc, int, 0400,
62 "Enable frame buffer compression for power savings "
63 "(default: -1 (use per-chip default))");
64
65i915_param_named_unsafe(lvds_channel_mode, int, 0400,
66 "Specify LVDS channel mode "
67 "(0=probe BIOS [default], 1=single-channel, 2=dual-channel)");
68
69i915_param_named_unsafe(panel_use_ssc, int, 0400,
70 "Use Spread Spectrum Clock with panels [LVDS/eDP] "
71 "(default: auto from VBT)");
72
73i915_param_named_unsafe(vbt_sdvo_panel_type, int, 0400,
74 "Override/Ignore selection of SDVO panel mode in the VBT "
75 "(-2=ignore, -1=auto [default], index in VBT BIOS table)");
76
77i915_param_named_unsafe(reset, uint, 0400,
78 "Attempt GPU resets (0=disabled, 1=full gpu reset, 2=engine reset [default])");
79
80i915_param_named_unsafe(vbt_firmware, charp, 0400,
81 "Load VBT from specified file under /lib/firmware");
82
83#if IS_ENABLED(CONFIG_DRM_I915_CAPTURE_ERROR)
84i915_param_named(error_capture, bool, 0400,
85 "Record the GPU state following a hang. "
86 "This information in /sys/class/drm/card<N>/error is vital for "
87 "triaging and debugging hangs.");
88#endif
89
90i915_param_named_unsafe(enable_hangcheck, bool, 0400,
91 "Periodically check GPU activity for detecting hangs. "
92 "WARNING: Disabling this can cause system wide hangs. "
93 "(default: true)");
94
95i915_param_named_unsafe(enable_psr, int, 0400,
96 "Enable PSR "
97 "(0=disabled, 1=enabled) "
98 "Default: -1 (use per-chip default)");
99
100i915_param_named(psr_safest_params, bool, 0400,
101 "Replace PSR VBT parameters by the safest and not optimal ones. This "
102 "is helpful to detect if PSR issues are related to bad values set in "
103 " VBT. (0=use VBT parameters, 1=use safest parameters)");
104
105i915_param_named_unsafe(force_probe, charp, 0400,
106 "Force probe the driver for specified devices. "
107 "See CONFIG_DRM_I915_FORCE_PROBE for details.");
108
109i915_param_named_unsafe(disable_power_well, int, 0400,
110 "Disable display power wells when possible "
111 "(-1=auto [default], 0=power wells always on, 1=power wells disabled when possible)");
112
113i915_param_named_unsafe(enable_ips, int, 0400, "Enable IPS (default: true)");
114
115i915_param_named(fastboot, int, 0400,
116 "Try to skip unnecessary mode sets at boot time "
117 "(0=disabled, 1=enabled) "
118 "Default: -1 (use per-chip default)");
119
120i915_param_named_unsafe(load_detect_test, bool, 0400,
121 "Force-enable the VGA load detect code for testing (default:false). "
122 "For developers only.");
123
124i915_param_named_unsafe(force_reset_modeset_test, bool, 0400,
125 "Force a modeset during gpu reset for testing (default:false). "
126 "For developers only.");
127
128i915_param_named_unsafe(invert_brightness, int, 0400,
129 "Invert backlight brightness "
130 "(-1 force normal, 0 machine defaults, 1 force inversion), please "
131 "report PCI device ID, subsystem vendor and subsystem device ID "
132 "to dri-devel@lists.freedesktop.org, if your machine needs it. "
133 "It will then be included in an upcoming module version.");
134
135i915_param_named(disable_display, bool, 0400,
136 "Disable display (default: false)");
137
138i915_param_named(mmio_debug, int, 0400,
139 "Enable the MMIO debug code for the first N failures (default: off). "
140 "This may negatively affect performance.");
141
142/* Special case writable file */
143i915_param_named(verbose_state_checks, bool, 0600,
144 "Enable verbose logs (ie. WARN_ON()) in case of unexpected hw state conditions.");
145
146i915_param_named_unsafe(nuclear_pageflip, bool, 0400,
147 "Force enable atomic functionality on platforms that don't have full support yet.");
148
149/* WA to get away with the default setting in VBT for early platforms.Will be removed */
150i915_param_named_unsafe(edp_vswing, int, 0400,
151 "Ignore/Override vswing pre-emph table selection from VBT "
152 "(0=use value from vbt [default], 1=low power swing(200mV),"
153 "2=default swing(400mV))");
154
155i915_param_named_unsafe(enable_guc, int, 0400,
156 "Enable GuC load for GuC submission and/or HuC load. "
157 "Required functionality can be selected using bitmask values. "
158 "(-1=auto, 0=disable [default], 1=GuC submission, 2=HuC load)");
159
160i915_param_named(guc_log_level, int, 0400,
161 "GuC firmware logging level. Requires GuC to be loaded. "
162 "(-1=auto [default], 0=disable, 1..4=enable with verbosity min..max)");
163
164i915_param_named_unsafe(guc_firmware_path, charp, 0400,
165 "GuC firmware path to use instead of the default one");
166
167i915_param_named_unsafe(huc_firmware_path, charp, 0400,
168 "HuC firmware path to use instead of the default one");
169
170i915_param_named_unsafe(dmc_firmware_path, charp, 0400,
171 "DMC firmware path to use instead of the default one");
172
173i915_param_named_unsafe(enable_dp_mst, bool, 0400,
174 "Enable multi-stream transport (MST) for new DisplayPort sinks. (default: true)");
175
176#if IS_ENABLED(CONFIG_DRM_I915_DEBUG)
177i915_param_named_unsafe(inject_probe_failure, uint, 0400,
178 "Force an error after a number of failure check points (0:disabled (default), N:force failure at the Nth failure check point)");
179#endif
180
181i915_param_named(enable_dpcd_backlight, int, 0400,
182 "Enable support for DPCD backlight control"
183 "(-1=use per-VBT LFP backlight type setting [default], 0=disabled, 1=enabled)");
184
185#if IS_ENABLED(CONFIG_DRM_I915_GVT)
186i915_param_named(enable_gvt, bool, 0400,
187 "Enable support for Intel GVT-g graphics virtualization host support(default:false)");
188#endif
189
190#if IS_ENABLED(CONFIG_DRM_I915_UNSTABLE_FAKE_LMEM)
191i915_param_named_unsafe(fake_lmem_start, ulong, 0400,
192 "Fake LMEM start offset (default: 0)");
193#endif
194
195static __always_inline void _print_param(struct drm_printer *p,
196 const char *name,
197 const char *type,
198 const void *x)
199{
200 if (!__builtin_strcmp(type, "bool"))
201 drm_printf(p, "i915.%s=%s\n", name, yesno(*(const bool *)x));
202 else if (!__builtin_strcmp(type, "int"))
203 drm_printf(p, "i915.%s=%d\n", name, *(const int *)x);
204 else if (!__builtin_strcmp(type, "unsigned int"))
205 drm_printf(p, "i915.%s=%u\n", name, *(const unsigned int *)x);
206 else if (!__builtin_strcmp(type, "unsigned long"))
207 drm_printf(p, "i915.%s=%lu\n", name, *(const unsigned long *)x);
208 else if (!__builtin_strcmp(type, "char *"))
209 drm_printf(p, "i915.%s=%s\n", name, *(const char **)x);
210 else
211 WARN_ONCE(1, "no printer defined for param type %s (i915.%s)\n",
212 type, name);
213}
214
215/**
216 * i915_params_dump - dump i915 modparams
217 * @params: i915 modparams
218 * @p: the &drm_printer
219 *
220 * Pretty printer for i915 modparams.
221 */
222void i915_params_dump(const struct i915_params *params, struct drm_printer *p)
223{
224#define PRINT(T, x, ...) _print_param(p, #x, #T, ¶ms->x);
225 I915_PARAMS_FOR_EACH(PRINT);
226#undef PRINT
227}
228
229static __always_inline void dup_param(const char *type, void *x)
230{
231 if (!__builtin_strcmp(type, "char *"))
232 *(void **)x = kstrdup(*(void **)x, GFP_ATOMIC);
233}
234
235void i915_params_copy(struct i915_params *dest, const struct i915_params *src)
236{
237 *dest = *src;
238#define DUP(T, x, ...) dup_param(#T, &dest->x);
239 I915_PARAMS_FOR_EACH(DUP);
240#undef DUP
241}
242
243static __always_inline void free_param(const char *type, void *x)
244{
245 if (!__builtin_strcmp(type, "char *")) {
246 kfree(*(void **)x);
247 *(void **)x = NULL;
248 }
249}
250
251/* free the allocated members, *not* the passed in params itself */
252void i915_params_free(struct i915_params *params)
253{
254#define FREE(T, x, ...) free_param(#T, ¶ms->x);
255 I915_PARAMS_FOR_EACH(FREE);
256#undef FREE
257}