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