include/drm/drm_syncobj.h

   1 /*
   2  * Copyright © 2017 Red Hat
   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  * Authors:
  24  *
  25  */
  26 #ifndef __DRM_SYNCOBJ_H__
  27 #define __DRM_SYNCOBJ_H__
  28
  29 #include "linux/dma-fence.h"
  30
  31 /**
  32  * struct drm_syncobj - sync object.
  33  *
  34  * This structure defines a generic sync object which wraps a dma fence.
  35  */
  36 struct drm_syncobj {
  37         /**
  38          * @refcount:
  39          *
  40          * Reference count of this object.
  41          */
  42         struct kref refcount;
  43         /**
  44          * @fence:
  45          * NULL or a pointer to the fence bound to this object.
  46          */
  47         struct dma_fence *fence;
  48         /**
  49          * @file:
  50          * a file backing for this syncobj.
  51          */
  52         struct file *file;
  53 };
  54
  55 void drm_syncobj_free(struct kref *kref);
  56
  57 /**
  58  * drm_syncobj_get - acquire a syncobj reference
  59  * @obj: sync object
  60  *
  61  * This acquires additional reference to @obj. It is illegal to call this
  62  * without already holding a reference. No locks required.
  63  */
  64 static inline void
  65 drm_syncobj_get(struct drm_syncobj *obj)
  66 {
  67         kref_get(&obj->refcount);
  68 }
  69
  70 /**
  71  * drm_syncobj_put - release a reference to a sync object.
  72  * @obj: sync object.
  73  */
  74 static inline void
  75 drm_syncobj_put(struct drm_syncobj *obj)
  76 {
  77         kref_put(&obj->refcount, drm_syncobj_free);
  78 }
  79
  80 struct drm_syncobj *drm_syncobj_find(struct drm_file *file_private,
  81                                      u32 handle);
  82 void drm_syncobj_replace_fence(struct drm_file *file_private,
  83                                struct drm_syncobj *syncobj,
  84                                struct dma_fence *fence);
  85 int drm_syncobj_fence_get(struct drm_file *file_private,
  86                           u32 handle,
  87                           struct dma_fence **fence);
  88 void drm_syncobj_free(struct kref *kref);
  89
  90 #endif