sys/dev/drm/include/drm/drm_modeset_lock.h

   1 /*
   2  * Copyright (C) 2014 Red Hat
   3  * Author: Rob Clark <robdclark@gmail.com>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the 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 COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
  19  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  20  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  21  * OTHER DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 #ifndef DRM_MODESET_LOCK_H_
  25 #define DRM_MODESET_LOCK_H_
  26
  27 #include <linux/ww_mutex.h>
  28
  29 struct drm_modeset_lock;
  30
  31 /**
  32  * struct drm_modeset_acquire_ctx - locking context (see ww_acquire_ctx)
  33  * @ww_ctx: base acquire ctx
  34  * @contended: used internally for -EDEADLK handling
  35  * @locked: list of held locks
  36  *
  37  * Each thread competing for a set of locks must use one acquire
  38  * ctx.  And if any lock fxn returns -EDEADLK, it must backoff and
  39  * retry.
  40  */
  41 struct drm_modeset_acquire_ctx {
  42
  43         struct ww_acquire_ctx ww_ctx;
  44
  45         /**
  46          * Contended lock: if a lock is contended you should only call
  47          * drm_modeset_backoff() which drops locks and slow-locks the
  48          * contended lock.
  49          */
  50         struct drm_modeset_lock *contended;
  51
  52         /**
  53          * list of held locks (drm_modeset_lock_info)
  54          */
  55         struct list_head locked;
  56
  57         /**
  58          * Trylock mode, use only for panic handlers!
  59          */
  60         bool trylock_only;
  61 };
  62
  63 /*
  64  * Keep track of extra locks.
  65  */
  66 struct drm_modeset_lock_info {
  67         struct list_head ctx_entry;
  68         struct list_head lock_entry;
  69         struct drm_modeset_lock *lock;
  70         struct drm_modeset_acquire_ctx *ctx;
  71 };
  72
  73 /**
  74  * struct drm_modeset_lock - used for locking modeset resources.
  75  * @mutex: resource locking
  76  * @head: used to hold it's place on state->locked list when
  77  *    part of an atomic update
  78  *
  79  * Used for locking CRTCs and other modeset resources.
  80  */
  81 struct drm_modeset_lock {
  82         /**
  83          * modeset lock
  84          */
  85         struct ww_mutex mutex;
  86
  87         /**
  88          * Resources that are locked as part of an atomic update are added
  89          * to a list (so we know what to unlock at the end).
  90          */
  91         struct list_head locked;
  92 };
  93
  94 extern struct ww_class crtc_ww_class;
  95
  96 void drm_modeset_acquire_init(struct drm_modeset_acquire_ctx *ctx,
  97                 uint32_t flags);
  98 void drm_modeset_acquire_fini(struct drm_modeset_acquire_ctx *ctx);
  99 void drm_modeset_drop_locks(struct drm_modeset_acquire_ctx *ctx);
 100 void drm_modeset_backoff(struct drm_modeset_acquire_ctx *ctx);
 101 int drm_modeset_backoff_interruptible(struct drm_modeset_acquire_ctx *ctx);
 102
 103 /**
 104  * drm_modeset_lock_init - initialize lock
 105  * @lock: lock to init
 106  */
 107 static inline void drm_modeset_lock_init(struct drm_modeset_lock *lock)
 108 {
 109         ww_mutex_init(&lock->mutex, &crtc_ww_class);
 110         INIT_LIST_HEAD(&lock->locked);
 111 }
 112
 113 /**
 114  * drm_modeset_lock_fini - cleanup lock
 115  * @lock: lock to cleanup
 116  */
 117 static inline void drm_modeset_lock_fini(struct drm_modeset_lock *lock)
 118 {
 119         WARN_ON(!list_empty(&lock->locked));
 120 }
 121
 122 /**
 123  * drm_modeset_is_locked - equivalent to mutex_is_locked()
 124  * @lock: lock to check
 125  */
 126 static inline bool drm_modeset_is_locked(struct drm_modeset_lock *lock)
 127 {
 128         return ww_mutex_is_locked(&lock->mutex);
 129 }
 130
 131 int drm_modeset_lock(struct drm_modeset_lock *lock,
 132                 struct drm_modeset_acquire_ctx *ctx);
 133 int drm_modeset_lock_interruptible(struct drm_modeset_lock *lock,
 134                 struct drm_modeset_acquire_ctx *ctx);
 135 void drm_modeset_unlock(struct drm_modeset_lock *lock);
 136
 137 struct drm_device;
 138 struct drm_crtc;
 139
 140 void drm_modeset_lock_all(struct drm_device *dev);
 141 void drm_modeset_unlock_all(struct drm_device *dev);
 142 void drm_modeset_lock_crtc(struct drm_crtc *crtc);
 143 void drm_modeset_unlock_crtc(struct drm_crtc *crtc);
 144 void drm_warn_on_modeset_not_all_locked(struct drm_device *dev);
 145 struct drm_modeset_acquire_ctx *
 146 drm_modeset_legacy_acquire_ctx(struct drm_crtc *crtc);
 147
 148 int drm_modeset_lock_all_crtcs(struct drm_device *dev,
 149                 struct drm_modeset_acquire_ctx *ctx);
 150
 151 #endif /* DRM_MODESET_LOCK_H_ */