xref: /linux/drivers/gpu/drm/i915/i915_params.c (revision d53b8e36925256097a08d7cb749198d85cbf9b2b)
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(reset, uint, 0400,
71 	"Attempt GPU resets (0=disabled, 1=full gpu reset, 2=engine reset [default])");
72 
73 #if IS_ENABLED(CONFIG_DRM_I915_CAPTURE_ERROR)
74 i915_param_named(error_capture, bool, 0400,
75 	"Record the GPU state following a hang. "
76 	"This information in /sys/class/drm/card<N>/error is vital for "
77 	"triaging and debugging hangs.");
78 #endif
79 
80 i915_param_named_unsafe(enable_hangcheck, bool, 0400,
81 	"Periodically check GPU activity for detecting hangs. "
82 	"WARNING: Disabling this can cause system wide hangs. "
83 	"(default: true)");
84 
85 i915_param_named_unsafe(force_probe, charp, 0400,
86 	"Force probe options for specified supported devices. "
87 	"See CONFIG_DRM_I915_FORCE_PROBE for details.");
88 
89 i915_param_named(memtest, bool, 0400,
90 	"Perform a read/write test of all device memory on module load (default: off)");
91 
92 i915_param_named(mmio_debug, int, 0400,
93 	"Enable the MMIO debug code for the first N failures (default: off). "
94 	"This may negatively affect performance.");
95 
96 i915_param_named_unsafe(enable_guc, int, 0400,
97 	"Enable GuC load for GuC submission and/or HuC load. "
98 	"Required functionality can be selected using bitmask values. "
99 	"(-1=auto [default], 0=disable, 1=GuC submission, 2=HuC load)");
100 
101 i915_param_named(guc_log_level, int, 0400,
102 	"GuC firmware logging level. Requires GuC to be loaded. "
103 	"(-1=auto [default], 0=disable, 1..4=enable with verbosity min..max)");
104 
105 i915_param_named_unsafe(guc_firmware_path, charp, 0400,
106 	"GuC firmware path to use instead of the default one");
107 
108 i915_param_named_unsafe(huc_firmware_path, charp, 0400,
109 	"HuC firmware path to use instead of the default one");
110 
111 i915_param_named_unsafe(gsc_firmware_path, charp, 0400,
112 	"GSC firmware path to use instead of the default one");
113 
114 #if IS_ENABLED(CONFIG_DRM_I915_DEBUG)
115 i915_param_named_unsafe(inject_probe_failure, uint, 0400,
116 	"Force an error after a number of failure check points (0:disabled (default), N:force failure at the Nth failure check point)");
117 #endif
118 
119 #if IS_ENABLED(CONFIG_DRM_I915_GVT)
120 i915_param_named(enable_gvt, bool, 0400,
121 	"Enable support for Intel GVT-g graphics virtualization host support(default:false)");
122 #endif
123 
124 #if CONFIG_DRM_I915_REQUEST_TIMEOUT
125 i915_param_named_unsafe(request_timeout_ms, uint, 0600,
126 			"Default request/fence/batch buffer expiration timeout.");
127 #endif
128 
129 i915_param_named_unsafe(lmem_size, uint, 0400,
130 			"Set the lmem size(in MiB) for each region. (default: 0, all memory)");
131 i915_param_named_unsafe(lmem_bar_size, uint, 0400,
132 			"Set the lmem bar size(in MiB).");
133 
134 #if IS_ENABLED(CONFIG_DRM_I915_REPLAY_GPU_HANGS_API)
135 i915_param_named(enable_debug_only_api, bool, 0400,
136 		 "Enable support for unstable debug only userspace API. (default:false)");
137 #endif
138 
139 static void _param_print_bool(struct drm_printer *p, const char *name,
140 			      bool val)
141 {
142 	drm_printf(p, "i915.%s=%s\n", name, str_yes_no(val));
143 }
144 
145 static void _param_print_int(struct drm_printer *p, const char *name,
146 			     int val)
147 {
148 	drm_printf(p, "i915.%s=%d\n", name, val);
149 }
150 
151 static void _param_print_uint(struct drm_printer *p, const char *name,
152 			      unsigned int val)
153 {
154 	drm_printf(p, "i915.%s=%u\n", name, val);
155 }
156 
157 static void _param_print_ulong(struct drm_printer *p, const char *name,
158 			       unsigned long val)
159 {
160 	drm_printf(p, "i915.%s=%lu\n", name, val);
161 }
162 
163 static void _param_print_charp(struct drm_printer *p, const char *name,
164 			       const char *val)
165 {
166 	drm_printf(p, "i915.%s=%s\n", name, val);
167 }
168 
169 #define _param_print(p, name, val)				\
170 	_Generic(val,						\
171 		 bool: _param_print_bool,			\
172 		 int: _param_print_int,				\
173 		 unsigned int: _param_print_uint,		\
174 		 unsigned long: _param_print_ulong,		\
175 		 char *: _param_print_charp)(p, name, val)
176 
177 /**
178  * i915_params_dump - dump i915 modparams
179  * @params: i915 modparams
180  * @p: the &drm_printer
181  *
182  * Pretty printer for i915 modparams.
183  */
184 void i915_params_dump(const struct i915_params *params, struct drm_printer *p)
185 {
186 #define PRINT(T, x, ...) _param_print(p, #x, params->x);
187 	I915_PARAMS_FOR_EACH(PRINT);
188 #undef PRINT
189 }
190 
191 static void _param_dup_charp(char **valp)
192 {
193 	*valp = kstrdup(*valp, GFP_ATOMIC);
194 }
195 
196 static void _param_nop(void *valp)
197 {
198 }
199 
200 #define _param_dup(valp)				\
201 	_Generic(valp,					\
202 		 char **: _param_dup_charp,		\
203 		 default: _param_nop)(valp)
204 
205 void i915_params_copy(struct i915_params *dest, const struct i915_params *src)
206 {
207 	*dest = *src;
208 #define DUP(T, x, ...) _param_dup(&dest->x);
209 	I915_PARAMS_FOR_EACH(DUP);
210 #undef DUP
211 }
212 
213 static void _param_free_charp(char **valp)
214 {
215 	kfree(*valp);
216 	*valp = NULL;
217 }
218 
219 #define _param_free(valp)				\
220 	_Generic(valp,					\
221 		 char **: _param_free_charp,		\
222 		 default: _param_nop)(valp)
223 
224 /* free the allocated members, *not* the passed in params itself */
225 void i915_params_free(struct i915_params *params)
226 {
227 #define FREE(T, x, ...) _param_free(&params->x);
228 	I915_PARAMS_FOR_EACH(FREE);
229 #undef FREE
230 }
231