xref: /openbmc/linux/drivers/gpu/drm/i915/i915_params.c (revision 35267cea)
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 
37 struct 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 
52 i915_param_named(modeset, int, 0400,
53 	"Use kernel modesetting [KMS] (0=disable, "
54 	"1=on, -1=force vga console preference [default])");
55 
56 i915_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 
61 i915_param_named_unsafe(enable_fbc, int, 0400,
62 	"Enable frame buffer compression for power savings "
63 	"(default: -1 (use per-chip default))");
64 
65 i915_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 
69 i915_param_named_unsafe(panel_use_ssc, int, 0400,
70 	"Use Spread Spectrum Clock with panels [LVDS/eDP] "
71 	"(default: auto from VBT)");
72 
73 i915_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 
77 i915_param_named_unsafe(reset, uint, 0400,
78 	"Attempt GPU resets (0=disabled, 1=full gpu reset, 2=engine reset [default])");
79 
80 i915_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)
84 i915_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 
90 i915_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 
95 i915_param_named_unsafe(enable_psr, int, 0400,
96 	"Enable PSR "
97 	"(0=disabled, 1=enabled) "
98 	"Default: -1 (use per-chip default)");
99 
100 i915_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 
105 i915_param_named_unsafe(enable_psr2_sel_fetch, bool, 0400,
106 	"Enable PSR2 selective fetch "
107 	"(0=disabled, 1=enabled) "
108 	"Default: 0");
109 
110 i915_param_named_unsafe(force_probe, charp, 0400,
111 	"Force probe the driver for specified devices. "
112 	"See CONFIG_DRM_I915_FORCE_PROBE for details.");
113 
114 i915_param_named_unsafe(disable_power_well, int, 0400,
115 	"Disable display power wells when possible "
116 	"(-1=auto [default], 0=power wells always on, 1=power wells disabled when possible)");
117 
118 i915_param_named_unsafe(enable_ips, int, 0400, "Enable IPS (default: true)");
119 
120 i915_param_named(fastboot, int, 0400,
121 	"Try to skip unnecessary mode sets at boot time "
122 	"(0=disabled, 1=enabled) "
123 	"Default: -1 (use per-chip default)");
124 
125 i915_param_named_unsafe(load_detect_test, bool, 0400,
126 	"Force-enable the VGA load detect code for testing (default:false). "
127 	"For developers only.");
128 
129 i915_param_named_unsafe(force_reset_modeset_test, bool, 0400,
130 	"Force a modeset during gpu reset for testing (default:false). "
131 	"For developers only.");
132 
133 i915_param_named_unsafe(invert_brightness, int, 0400,
134 	"Invert backlight brightness "
135 	"(-1 force normal, 0 machine defaults, 1 force inversion), please "
136 	"report PCI device ID, subsystem vendor and subsystem device ID "
137 	"to dri-devel@lists.freedesktop.org, if your machine needs it. "
138 	"It will then be included in an upcoming module version.");
139 
140 i915_param_named(disable_display, bool, 0400,
141 	"Disable display (default: false)");
142 
143 i915_param_named(mmio_debug, int, 0400,
144 	"Enable the MMIO debug code for the first N failures (default: off). "
145 	"This may negatively affect performance.");
146 
147 /* Special case writable file */
148 i915_param_named(verbose_state_checks, bool, 0600,
149 	"Enable verbose logs (ie. WARN_ON()) in case of unexpected hw state conditions.");
150 
151 i915_param_named_unsafe(nuclear_pageflip, bool, 0400,
152 	"Force enable atomic functionality on platforms that don't have full support yet.");
153 
154 /* WA to get away with the default setting in VBT for early platforms.Will be removed */
155 i915_param_named_unsafe(edp_vswing, int, 0400,
156 	"Ignore/Override vswing pre-emph table selection from VBT "
157 	"(0=use value from vbt [default], 1=low power swing(200mV),"
158 	"2=default swing(400mV))");
159 
160 i915_param_named_unsafe(enable_guc, int, 0400,
161 	"Enable GuC load for GuC submission and/or HuC load. "
162 	"Required functionality can be selected using bitmask values. "
163 	"(-1=auto [default], 0=disable, 1=GuC submission, 2=HuC load)");
164 
165 i915_param_named(guc_log_level, int, 0400,
166 	"GuC firmware logging level. Requires GuC to be loaded. "
167 	"(-1=auto [default], 0=disable, 1..4=enable with verbosity min..max)");
168 
169 i915_param_named_unsafe(guc_firmware_path, charp, 0400,
170 	"GuC firmware path to use instead of the default one");
171 
172 i915_param_named_unsafe(huc_firmware_path, charp, 0400,
173 	"HuC firmware path to use instead of the default one");
174 
175 i915_param_named_unsafe(dmc_firmware_path, charp, 0400,
176 	"DMC firmware path to use instead of the default one");
177 
178 i915_param_named_unsafe(enable_dp_mst, bool, 0400,
179 	"Enable multi-stream transport (MST) for new DisplayPort sinks. (default: true)");
180 
181 #if IS_ENABLED(CONFIG_DRM_I915_DEBUG)
182 i915_param_named_unsafe(inject_probe_failure, uint, 0400,
183 	"Force an error after a number of failure check points (0:disabled (default), N:force failure at the Nth failure check point)");
184 #endif
185 
186 i915_param_named(enable_dpcd_backlight, int, 0400,
187 	"Enable support for DPCD backlight control"
188 	"(-1=use per-VBT LFP backlight type setting [default], 0=disabled, 1=enable, 2=force VESA interface, 3=force Intel interface)");
189 
190 #if IS_ENABLED(CONFIG_DRM_I915_GVT)
191 i915_param_named(enable_gvt, bool, 0400,
192 	"Enable support for Intel GVT-g graphics virtualization host support(default:false)");
193 #endif
194 
195 #if IS_ENABLED(CONFIG_DRM_I915_UNSTABLE_FAKE_LMEM)
196 i915_param_named_unsafe(fake_lmem_start, ulong, 0400,
197 	"Fake LMEM start offset (default: 0)");
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 static __always_inline void _print_param(struct drm_printer *p,
206 					 const char *name,
207 					 const char *type,
208 					 const void *x)
209 {
210 	if (!__builtin_strcmp(type, "bool"))
211 		drm_printf(p, "i915.%s=%s\n", name, yesno(*(const bool *)x));
212 	else if (!__builtin_strcmp(type, "int"))
213 		drm_printf(p, "i915.%s=%d\n", name, *(const int *)x);
214 	else if (!__builtin_strcmp(type, "unsigned int"))
215 		drm_printf(p, "i915.%s=%u\n", name, *(const unsigned int *)x);
216 	else if (!__builtin_strcmp(type, "unsigned long"))
217 		drm_printf(p, "i915.%s=%lu\n", name, *(const unsigned long *)x);
218 	else if (!__builtin_strcmp(type, "char *"))
219 		drm_printf(p, "i915.%s=%s\n", name, *(const char **)x);
220 	else
221 		WARN_ONCE(1, "no printer defined for param type %s (i915.%s)\n",
222 			  type, name);
223 }
224 
225 /**
226  * i915_params_dump - dump i915 modparams
227  * @params: i915 modparams
228  * @p: the &drm_printer
229  *
230  * Pretty printer for i915 modparams.
231  */
232 void i915_params_dump(const struct i915_params *params, struct drm_printer *p)
233 {
234 #define PRINT(T, x, ...) _print_param(p, #x, #T, &params->x);
235 	I915_PARAMS_FOR_EACH(PRINT);
236 #undef PRINT
237 }
238 
239 static __always_inline void dup_param(const char *type, void *x)
240 {
241 	if (!__builtin_strcmp(type, "char *"))
242 		*(void **)x = kstrdup(*(void **)x, GFP_ATOMIC);
243 }
244 
245 void i915_params_copy(struct i915_params *dest, const struct i915_params *src)
246 {
247 	*dest = *src;
248 #define DUP(T, x, ...) dup_param(#T, &dest->x);
249 	I915_PARAMS_FOR_EACH(DUP);
250 #undef DUP
251 }
252 
253 static __always_inline void free_param(const char *type, void *x)
254 {
255 	if (!__builtin_strcmp(type, "char *")) {
256 		kfree(*(void **)x);
257 		*(void **)x = NULL;
258 	}
259 }
260 
261 /* free the allocated members, *not* the passed in params itself */
262 void i915_params_free(struct i915_params *params)
263 {
264 #define FREE(T, x, ...) free_param(#T, &params->x);
265 	I915_PARAMS_FOR_EACH(FREE);
266 #undef FREE
267 }
268