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