WebSVN – Kolibri OS – Diff – /drivers/include/drm/drm_gem.h

  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  * OTHER DEALINGS IN THE SOFTWARE.
  */
+/**
+ * struct drm_gem_object - GEM buffer object
-/**
+ *
+ * This structure defines the generic parts for GEM buffer objects, which are
+ * mostly around handling mmap and userspace handles.
- * This structure defines the drm_mm memory object, which will be used by the
+ *
- * DRM for its buffer objects.
+ * Buffer objects are often abbreviated to BO.
  */
+struct drm_gem_object {
+	/**
+	 * @refcount:
-struct drm_gem_object {
+	 *
+	 * Reference count of this object
+	 *
+	 * Please use drm_gem_object_reference() to acquire and
+	 * drm_gem_object_unreference() or drm_gem_object_unreference_unlocked()
+	 * to release a reference to a GEM buffer object.
-	/** Reference count of this object */
+	 */
 	struct kref refcount;
+	/**
+	 * @handle_count:
 	/**
-	 * handle_count - gem file_priv handle count of this object
+	 * This is the GEM file_priv handle count of this object.
+	 *
 	 * Each handle also holds a reference. Note that when the handle_count
 	 * drops to 0 any global names (e.g. the id in the flink namespace) will
 	 * be cleared.
 	 *
 	 * Protected by dev->object_name_lock.
+	 */
-	 * */
+	unsigned handle_count;
-	unsigned handle_count;
+	/**
+	 * @dev: DRM dev this object belongs to.
+	 */
+	struct drm_device *dev;
+	/**
+	 * @filp:
+	 *
+	 * SHMEM file node used as backing storage for swappable buffer objects.
-	/** Related drm device */
+	 * GEM also supports driver private objects with driver-specific backing
+	 * storage (contiguous CMA memory, special reserved blocks). In this
+	 * case @filp is NULL.
+	 */
-	struct drm_device *dev;
+	struct file *filp;
+	/**
+	 * @vma_node:
+	 *
+	 * Mapping info for this object to support mmap. Drivers are supposed to
+	 * allocate the mmap offset using drm_gem_create_mmap_offset(). The
 	 * offset itself can be retrieved using drm_vma_node_offset_addr().
 	/** File representing the shmem storage */
+	 * Memory mapping itself is handled by drm_gem_mmap(), which also checks
+	 * that userspace is allowed to access the object.
-	struct file *filp;
+	 */
 	struct drm_vma_offset_node vma_node;
 	/* Mapping info for this object */
-	struct drm_vma_offset_node vma_node;
+	/**
 	 * @size:
+	 *
+	 * Size of the object, in bytes.  Immutable over the object's
-	/**
+	 * lifetime.
-	 * Size of the object, in bytes.  Immutable over the object's
+	 */
+	size_t size;
 	 * lifetime.
-	 */
+	/**
-	size_t size;
+	 * @name:
+	 *
+	 * Global name for this object, starts at 1. 0 means unnamed.
+	 * Access is covered by dev->object_name_lock. This is used by the GEM_FLINK
-	/**
+	 * and GEM_OPEN ioctls.
-	 * Global name for this object, starts at 1. 0 means unnamed.
+	 */
-	 * Access is covered by the object_name_lock in the related drm_device
+	int name;
 	 */
-	int name;
+	/**
+	 * @read_domains:
+	 *
+	 * Read memory domains. These monitor which caches contain read/write data
+	 * related to the object. When transitioning from one set of domains
 	 * to another, the driver is called to ensure that caches are suitably
-	/**
+	 * flushed and invalidated.
+	 */
+	uint32_t read_domains;
 	 * Memory domains. These monitor which caches contain read/write data
-	 * related to the object. When transitioning from one set of domains
+	/**
-	 * to another, the driver is called to ensure that caches are suitably
+	 * @write_domain: Corresponding unique write memory domain.
-	 * flushed and invalidated
+	 */
-	 */
+	uint32_t write_domain;
 	uint32_t read_domains;
+	/**
+	 * @pending_read_domains:
+	 *
+	 * While validating an exec operation, the
-	uint32_t write_domain;
+	 * new read/write domain values are computed here.
 	 * They will be transferred to the above values
+	 * at the point that any cache flushing occurs
+	 */
-	/**
+	uint32_t pending_read_domains;
 	 * While validating an exec operation, the
-	 * new read/write domain values are computed here.
+	/**
-	 * They will be transferred to the above values
+	 * @pending_write_domain: Write domain similar to @pending_read_domains.
-	 * at the point that any cache flushing occurs
+	 */
-	 */
+	uint32_t pending_write_domain;
-	uint32_t pending_read_domains;
-	uint32_t pending_write_domain;
+	/**
 	 * @dma_buf:
 	/**
+	 * dma-buf associated with this GEM object.
+	 *
-	 * dma_buf - dma buf associated with this GEM object
+	 * Pointer to the dma-buf associated with this gem object (either
 	 * through importing or exporting). We break the resulting reference
-	 * Pointer to the dma-buf associated with this gem object (either
+	 * loop when the last gem handle for this object is released.
 	 * through importing or exporting). We break the resulting reference
-	 * loop when the last gem handle for this object is released.
+	 * Protected by obj->object_name_lock.
 	 */
 void drm_gem_vm_close(struct vm_area_struct *vma);
 int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
 		     struct vm_area_struct *vma);
 int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma);
+/**
+ * drm_gem_object_reference - acquire a GEM BO reference
+ * @obj: GEM buffer object
+ *
+ * This acquires additional reference to @obj. It is illegal to call this
+ * without already holding a reference. No locks required.
  */
 static inline void
 drm_gem_object_reference(struct drm_gem_object *obj)
+{
 	kref_get(&obj->refcount);
+}
+/**
+ * drm_gem_object_unreference - release a GEM BO reference
+ * @obj: GEM buffer object
+ *
+ * This releases a reference to @obj. Callers must hold the dev->struct_mutex
+ * lock when calling this function, even when the driver doesn't use
+ * dev->struct_mutex for anything.
+ *
+ * For drivers not encumbered with legacy locking use
  * drm_gem_object_unreference_unlocked() instead.
  */
 static inline void
 drm_gem_object_unreference(struct drm_gem_object *obj)
+{
 	if (obj != NULL) {
 		WARN_ON(!mutex_is_locked(&obj->dev->struct_mutex));
+		kref_put(&obj->refcount, drm_gem_object_free);
+	}
+}
+/**
+ * drm_gem_object_unreference_unlocked - release a GEM BO reference
+ * @obj: GEM buffer object
 		kref_put(&obj->refcount, drm_gem_object_free);
  * This releases a reference to @obj. Callers must not hold the
  * dev->struct_mutex lock when calling this function.
  */

Subversion Repositories Kolibri OS

(root)/drivers/include/drm/drm_gem.h – Rev 6125 → 6936