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, f: "i915.%s=%s\n", name, str_yes_no(v: val));
142}
143
144static void _param_print_int(struct drm_printer *p, const char *name,
145 int val)
146{
147 drm_printf(p, f: "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, f: "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, f: "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, f: "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(s: *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(objp: *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(&params->x);
227 I915_PARAMS_FOR_EACH(FREE);
228#undef FREE
229}
230