drivers/gpu/drm/i915/i915_gem.h

   1 /*
   2  * Copyright © 2016 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 "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:
  10  *
  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
  13  * Software.
  14  *
  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
  21  * IN THE SOFTWARE.
  22  *
  23  */
  24
  25 #ifndef __I915_GEM_H__
  26 #define __I915_GEM_H__
  27
  28 #include <linux/bug.h>
  29 #include <linux/types.h>
  30
  31 #include <drm/drm_drv.h>
  32
  33 #include "i915_utils.h"
  34
  35 struct drm_file;
  36 struct drm_i915_gem_object;
  37 struct drm_i915_private;
  38 struct i915_gem_ww_ctx;
  39 struct i915_gtt_view;
  40 struct i915_vma;
  41
  42 void i915_gem_init_early(struct drm_i915_private *i915);
  43 void i915_gem_cleanup_early(struct drm_i915_private *i915);
  44
  45 void i915_gem_drain_freed_objects(struct drm_i915_private *i915);
  46 void i915_gem_drain_workqueue(struct drm_i915_private *i915);
  47
  48 struct i915_vma * __must_check
  49 i915_gem_object_ggtt_pin_ww(struct drm_i915_gem_object *obj,
  50                             struct i915_gem_ww_ctx *ww,
  51                             const struct i915_gtt_view *view,
  52                             u64 size, u64 alignment, u64 flags);
  53
  54 struct i915_vma * __must_check
  55 i915_gem_object_ggtt_pin(struct drm_i915_gem_object *obj,
  56                          const struct i915_gtt_view *view,
  57                          u64 size, u64 alignment, u64 flags);
  58
  59 int i915_gem_object_unbind(struct drm_i915_gem_object *obj,
  60                            unsigned long flags);
  61 #define I915_GEM_OBJECT_UNBIND_ACTIVE BIT(0)
  62 #define I915_GEM_OBJECT_UNBIND_BARRIER BIT(1)
  63 #define I915_GEM_OBJECT_UNBIND_TEST BIT(2)
  64 #define I915_GEM_OBJECT_UNBIND_VM_TRYLOCK BIT(3)
  65 #define I915_GEM_OBJECT_UNBIND_ASYNC BIT(4)
  66
  67 void i915_gem_runtime_suspend(struct drm_i915_private *i915);
  68
  69 int __must_check i915_gem_init(struct drm_i915_private *i915);
  70 void i915_gem_driver_register(struct drm_i915_private *i915);
  71 void i915_gem_driver_unregister(struct drm_i915_private *i915);
  72 void i915_gem_driver_remove(struct drm_i915_private *i915);
  73 void i915_gem_driver_release(struct drm_i915_private *i915);
  74
  75 int i915_gem_open(struct drm_i915_private *i915, struct drm_file *file);
  76
  77 /* FIXME: All of the below belong somewhere else. */
  78
  79 #ifdef CONFIG_DRM_I915_DEBUG_GEM
  80
  81 #define GEM_SHOW_DEBUG() drm_debug_enabled(DRM_UT_DRIVER)
  82
  83 #ifdef CONFIG_DRM_I915_DEBUG_GEM_ONCE
  84 #define __GEM_BUG(cond) BUG()
  85 #else
  86 #define __GEM_BUG(cond) \
  87         WARN(1, "%s:%d GEM_BUG_ON(%s)\n", __func__, __LINE__, __stringify(cond))
  88 #endif
  89
  90 #define GEM_BUG_ON(condition) do { if (unlikely((condition))) { \
  91                 GEM_TRACE_ERR("%s:%d GEM_BUG_ON(%s)\n", \
  92                               __func__, __LINE__, __stringify(condition)); \
  93                 GEM_TRACE_DUMP(); \
  94                 __GEM_BUG(condition); \
  95                 } \
  96         } while(0)
  97 #define GEM_WARN_ON(expr) WARN_ON(expr)
  98
  99 #define GEM_DEBUG_WARN_ON(expr) GEM_WARN_ON(expr)
 100
 101 #else
 102
 103 #define GEM_SHOW_DEBUG() (0)
 104
 105 #define GEM_BUG_ON(expr) BUILD_BUG_ON_INVALID(expr)
 106 #define GEM_WARN_ON(expr) ({ unlikely(!!(expr)); })
 107
 108 #define GEM_DEBUG_WARN_ON(expr) ({ BUILD_BUG_ON_INVALID(expr); 0; })
 109 #endif
 110
 111 #if IS_ENABLED(CONFIG_DRM_I915_TRACE_GEM)
 112 #define GEM_TRACE(...) trace_printk(__VA_ARGS__)
 113 #define GEM_TRACE_ERR(...) do {                                         \
 114         pr_err(__VA_ARGS__);                                            \
 115         trace_printk(__VA_ARGS__);                                      \
 116 } while (0)
 117 #define GEM_TRACE_DUMP() \
 118         do { ftrace_dump(DUMP_ALL); __add_taint_for_CI(TAINT_WARN); } while (0)
 119 #define GEM_TRACE_DUMP_ON(expr) \
 120         do { if (expr) GEM_TRACE_DUMP(); } while (0)
 121 #else
 122 #define GEM_TRACE(...) do { } while (0)
 123 #define GEM_TRACE_ERR(...) do { } while (0)
 124 #define GEM_TRACE_DUMP() do { } while (0)
 125 #define GEM_TRACE_DUMP_ON(expr) BUILD_BUG_ON_INVALID(expr)
 126 #endif
 127
 128 #define I915_GEM_IDLE_TIMEOUT (HZ / 5)
 129
 130 #endif /* __I915_GEM_H__ */