2 * Copyright © 2016 Intel Corporation
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
25 #ifndef __I915_UTILS_H
26 #define __I915_UTILS_H
28 #include <linux/list.h>
29 #include <linux/overflow.h>
30 #include <linux/sched.h>
31 #include <linux/types.h>
32 #include <linux/workqueue.h>
34 struct drm_i915_private;
37 #define FDO_BUG_URL "https://gitlab.freedesktop.org/drm/intel/-/wikis/How-to-file-i915-bugs"
40 /* Many gcc seem to no see through this and fall over :( */
42 #define WARN_ON(x) ({ \
43 bool __i915_warn_cond = (x); \
44 if (__builtin_constant_p(__i915_warn_cond)) \
45 BUILD_BUG_ON(__i915_warn_cond); \
46 WARN(__i915_warn_cond, "WARN_ON(" #x ")"); })
48 #define WARN_ON(x) WARN((x), "%s", "WARN_ON(" __stringify(x) ")")
52 #define WARN_ON_ONCE(x) WARN_ONCE((x), "%s", "WARN_ON_ONCE(" __stringify(x) ")")
54 #define MISSING_CASE(x) WARN(1, "Missing case (%s == %ld)\n", \
55 __stringify(x), (long)(x))
58 __i915_printk(struct drm_i915_private *dev_priv, const char *level,
59 const char *fmt, ...);
61 #define i915_report_error(dev_priv, fmt, ...) \
62 __i915_printk(dev_priv, KERN_ERR, fmt, ##__VA_ARGS__)
64 #if IS_ENABLED(CONFIG_DRM_I915_DEBUG)
66 int __i915_inject_probe_error(struct drm_i915_private *i915, int err,
67 const char *func, int line);
68 #define i915_inject_probe_error(_i915, _err) \
69 __i915_inject_probe_error((_i915), (_err), __func__, __LINE__)
70 bool i915_error_injected(void);
74 #define i915_inject_probe_error(i915, e) ({ BUILD_BUG_ON_INVALID(i915); 0; })
75 #define i915_error_injected() false
79 #define i915_inject_probe_failure(i915) i915_inject_probe_error((i915), -ENODEV)
81 #define i915_probe_error(i915, fmt, ...) \
82 __i915_printk(i915, i915_error_injected() ? KERN_DEBUG : KERN_ERR, \
85 #if defined(GCC_VERSION) && GCC_VERSION >= 70000
86 #define add_overflows_t(T, A, B) \
87 __builtin_add_overflow_p((A), (B), (T)0)
89 #define add_overflows_t(T, A, B) ({ \
96 #define add_overflows(A, B) \
97 add_overflows_t(typeof((A) + (B)), (A), (B))
99 #define range_overflows(start, size, max) ({ \
100 typeof(start) start__ = (start); \
101 typeof(size) size__ = (size); \
102 typeof(max) max__ = (max); \
103 (void)(&start__ == &size__); \
104 (void)(&start__ == &max__); \
105 start__ > max__ || size__ > max__ - start__; \
108 #define range_overflows_t(type, start, size, max) \
109 range_overflows((type)(start), (type)(size), (type)(max))
111 /* Note we don't consider signbits :| */
112 #define overflows_type(x, T) \
113 (sizeof(x) > sizeof(T) && (x) >> BITS_PER_TYPE(T))
116 __check_struct_size(size_t base, size_t arr, size_t count, size_t *size)
120 if (check_mul_overflow(count, arr, &sz))
123 if (check_add_overflow(sz, base, &sz))
131 * check_struct_size() - Calculate size of structure with trailing array.
132 * @p: Pointer to the structure.
133 * @member: Name of the array member.
134 * @n: Number of elements in the array.
135 * @sz: Total size of structure and array
137 * Calculates size of memory needed for structure @p followed by an
138 * array of @n @member elements, like struct_size() but reports
139 * whether it overflowed, and the resultant size in @sz
141 * Return: false if the calculation overflowed.
143 #define check_struct_size(p, member, n, sz) \
144 likely(__check_struct_size(sizeof(*(p)), \
145 sizeof(*(p)->member) + __must_be_array((p)->member), \
148 #define ptr_mask_bits(ptr, n) ({ \
149 unsigned long __v = (unsigned long)(ptr); \
150 (typeof(ptr))(__v & -BIT(n)); \
153 #define ptr_unmask_bits(ptr, n) ((unsigned long)(ptr) & (BIT(n) - 1))
155 #define ptr_unpack_bits(ptr, bits, n) ({ \
156 unsigned long __v = (unsigned long)(ptr); \
157 *(bits) = __v & (BIT(n) - 1); \
158 (typeof(ptr))(__v & -BIT(n)); \
161 #define ptr_pack_bits(ptr, bits, n) ({ \
162 unsigned long __bits = (bits); \
163 GEM_BUG_ON(__bits & -BIT(n)); \
164 ((typeof(ptr))((unsigned long)(ptr) | __bits)); \
167 #define ptr_dec(ptr) ({ \
168 unsigned long __v = (unsigned long)(ptr); \
169 (typeof(ptr))(__v - 1); \
172 #define ptr_inc(ptr) ({ \
173 unsigned long __v = (unsigned long)(ptr); \
174 (typeof(ptr))(__v + 1); \
177 #define page_mask_bits(ptr) ptr_mask_bits(ptr, PAGE_SHIFT)
178 #define page_unmask_bits(ptr) ptr_unmask_bits(ptr, PAGE_SHIFT)
179 #define page_pack_bits(ptr, bits) ptr_pack_bits(ptr, bits, PAGE_SHIFT)
180 #define page_unpack_bits(ptr, bits) ptr_unpack_bits(ptr, bits, PAGE_SHIFT)
182 #define struct_member(T, member) (((T *)0)->member)
184 #define ptr_offset(ptr, member) offsetof(typeof(*(ptr)), member)
186 #define fetch_and_zero(ptr) ({ \
187 typeof(*ptr) __T = *(ptr); \
188 *(ptr) = (typeof(*ptr))0; \
193 * container_of_user: Extract the superclass from a pointer to a member.
195 * Exactly like container_of() with the exception that it plays nicely
196 * with sparse for __user @ptr.
198 #define container_of_user(ptr, type, member) ({ \
199 void __user *__mptr = (void __user *)(ptr); \
200 BUILD_BUG_ON_MSG(!__same_type(*(ptr), struct_member(type, member)) && \
201 !__same_type(*(ptr), void), \
202 "pointer type mismatch in container_of()"); \
203 ((type __user *)(__mptr - offsetof(type, member))); })
206 * check_user_mbz: Check that a user value exists and is zero
208 * Frequently in our uABI we reserve space for future extensions, and
209 * two ensure that userspace is prepared we enforce that space must
210 * be zero. (Then any future extension can safely assume a default value
213 * check_user_mbz() combines checking that the user pointer is accessible
214 * and that the contained value is zero.
216 * Returns: -EFAULT if not accessible, -EINVAL if !zero, or 0 on success.
218 #define check_user_mbz(U) ({ \
219 typeof(*(U)) mbz__; \
220 get_user(mbz__, (U)) ? -EFAULT : mbz__ ? -EINVAL : 0; \
223 static inline u64 ptr_to_u64(const void *ptr)
225 return (uintptr_t)ptr;
228 #define u64_to_ptr(T, x) ({ \
230 (T *)(uintptr_t)(x); \
233 #define __mask_next_bit(mask) ({ \
234 int __idx = ffs(mask) - 1; \
235 mask &= ~BIT(__idx); \
239 static inline void __list_del_many(struct list_head *head,
240 struct list_head *first)
243 WRITE_ONCE(head->next, first);
247 * Wait until the work is finally complete, even if it tries to postpone
248 * by requeueing itself. Note, that if the worker never cancels itself,
249 * we will spin forever.
251 static inline void drain_delayed_work(struct delayed_work *dw)
254 while (flush_delayed_work(dw))
256 } while (delayed_work_pending(dw));
259 static inline unsigned long msecs_to_jiffies_timeout(const unsigned int m)
261 unsigned long j = msecs_to_jiffies(m);
263 return min_t(unsigned long, MAX_JIFFY_OFFSET, j + 1);
267 * If you need to wait X milliseconds between events A and B, but event B
268 * doesn't happen exactly after event A, you record the timestamp (jiffies) of
269 * when event A happened, then just before event B you call this function and
270 * pass the timestamp as the first argument, and X as the second argument.
273 wait_remaining_ms_from_jiffies(unsigned long timestamp_jiffies, int to_wait_ms)
275 unsigned long target_jiffies, tmp_jiffies, remaining_jiffies;
278 * Don't re-read the value of "jiffies" every time since it may change
279 * behind our back and break the math.
281 tmp_jiffies = jiffies;
282 target_jiffies = timestamp_jiffies +
283 msecs_to_jiffies_timeout(to_wait_ms);
285 if (time_after(target_jiffies, tmp_jiffies)) {
286 remaining_jiffies = target_jiffies - tmp_jiffies;
287 while (remaining_jiffies)
289 schedule_timeout_uninterruptible(remaining_jiffies);
294 * __wait_for - magic wait macro
296 * Macro to help avoid open coding check/wait/timeout patterns. Note that it's
297 * important that we check the condition again after having timed out, since the
298 * timeout could be due to preemption or similar and we've never had a chance to
299 * check the condition before the timeout.
301 #define __wait_for(OP, COND, US, Wmin, Wmax) ({ \
302 const ktime_t end__ = ktime_add_ns(ktime_get_raw(), 1000ll * (US)); \
303 long wait__ = (Wmin); /* recommended min for usleep is 10 us */ \
307 const bool expired__ = ktime_after(ktime_get_raw(), end__); \
309 /* Guarantee COND check prior to timeout */ \
316 ret__ = -ETIMEDOUT; \
319 usleep_range(wait__, wait__ * 2); \
320 if (wait__ < (Wmax)) \
326 #define _wait_for(COND, US, Wmin, Wmax) __wait_for(, (COND), (US), (Wmin), \
328 #define wait_for(COND, MS) _wait_for((COND), (MS) * 1000, 10, 1000)
330 /* If CONFIG_PREEMPT_COUNT is disabled, in_atomic() always reports false. */
331 #if defined(CONFIG_DRM_I915_DEBUG) && defined(CONFIG_PREEMPT_COUNT)
332 # define _WAIT_FOR_ATOMIC_CHECK(ATOMIC) WARN_ON_ONCE((ATOMIC) && !in_atomic())
334 # define _WAIT_FOR_ATOMIC_CHECK(ATOMIC) do { } while (0)
337 #define _wait_for_atomic(COND, US, ATOMIC) \
339 int cpu, ret, timeout = (US) * 1000; \
341 _WAIT_FOR_ATOMIC_CHECK(ATOMIC); \
344 cpu = smp_processor_id(); \
346 base = local_clock(); \
348 u64 now = local_clock(); \
351 /* Guarantee COND check prior to timeout */ \
357 if (now - base >= timeout) { \
364 if (unlikely(cpu != smp_processor_id())) { \
365 timeout -= now - base; \
366 cpu = smp_processor_id(); \
367 base = local_clock(); \
374 #define wait_for_us(COND, US) \
377 BUILD_BUG_ON(!__builtin_constant_p(US)); \
379 ret__ = _wait_for((COND), (US), 10, 10); \
381 ret__ = _wait_for_atomic((COND), (US), 0); \
385 #define wait_for_atomic_us(COND, US) \
387 BUILD_BUG_ON(!__builtin_constant_p(US)); \
388 BUILD_BUG_ON((US) > 50000); \
389 _wait_for_atomic((COND), (US), 1); \
392 #define wait_for_atomic(COND, MS) wait_for_atomic_us((COND), (MS) * 1000)
394 #define KHz(x) (1000 * (x))
395 #define MHz(x) KHz(1000 * (x))
397 #define KBps(x) (1000 * (x))
398 #define MBps(x) KBps(1000 * (x))
399 #define GBps(x) ((u64)1000 * MBps((x)))
401 static inline const char *yesno(bool v)
403 return v ? "yes" : "no";
406 static inline const char *onoff(bool v)
408 return v ? "on" : "off";
411 static inline const char *enableddisabled(bool v)
413 return v ? "enabled" : "disabled";
416 static inline void add_taint_for_CI(unsigned int taint)
419 * The system is "ok", just about surviving for the user, but
420 * CI results are now unreliable as the HW is very suspect.
421 * CI checks the taint state after every test and will reboot
422 * the machine if the kernel is tainted.
424 add_taint(taint, LOCKDEP_STILL_OK);
427 void cancel_timer(struct timer_list *t);
428 void set_timer_ms(struct timer_list *t, unsigned long timeout);
430 static inline bool timer_expired(const struct timer_list *t)
432 return READ_ONCE(t->expires) && !timer_pending(t);
436 * This is a lookalike for IS_ENABLED() that takes a kconfig value,
437 * e.g. CONFIG_DRM_I915_SPIN_REQUEST, and evaluates whether it is non-zero
438 * i.e. whether the configuration is active. Wrapping up the config inside
439 * a boolean context prevents clang and smatch from complaining about potential
440 * issues in confusing logical-&& with bitwise-& for constants.
442 * Sadly IS_ENABLED() itself does not work with kconfig values.
444 * Returns 0 if @config is 0, 1 if set to any value.
446 #define IS_ACTIVE(config) ((config) != 0)
448 #endif /* !__I915_UTILS_H */