[linux-2.6-block.git] / include / drm / drm_gem.h

#ifndef __DRM_GEM_H__
#define __DRM_GEM_H__

/*
 * GEM Graphics Execution Manager Driver Interfaces
 *
 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
 * Copyright (c) 2009-2010, Code Aurora Forum.
 * All rights reserved.
 * Copyright © 2014 Intel Corporation
 *   Daniel Vetter <daniel.vetter@ffwll.ch>
 *
 * Author: Rickard E. (Rik) Faith <faith@valinux.com>
 * Author: Gareth Hughes <gareth@valinux.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

#include <linux/kref.h>

#include <drm/drm_vma_manager.h>

struct drm_gem_object;

/**
 * struct drm_gem_object_funcs - GEM object functions
 */
struct drm_gem_object_funcs {
	/**
	 * @free:
	 *
	 * Deconstructor for drm_gem_objects.
	 *
	 * This callback is mandatory.
	 */
	void (*free)(struct drm_gem_object *obj);

	/**
	 * @open:
	 *
	 * Called upon GEM handle creation.
	 *
	 * This callback is optional.
	 */
	int (*open)(struct drm_gem_object *obj, struct drm_file *file);

	/**
	 * @close:
	 *
	 * Called upon GEM handle release.
	 *
	 * This callback is optional.
	 */
	void (*close)(struct drm_gem_object *obj, struct drm_file *file);

	/**
	 * @print_info:
	 *
	 * If driver subclasses struct &drm_gem_object, it can implement this
	 * optional hook for printing additional driver specific info.
	 *
	 * drm_printf_indent() should be used in the callback passing it the
	 * indent argument.
	 *
	 * This callback is called from drm_gem_print_info().
	 *
	 * This callback is optional.
	 */
	void (*print_info)(struct drm_printer *p, unsigned int indent,
			   const struct drm_gem_object *obj);

	/**
	 * @export:
	 *
	 * Export backing buffer as a &dma_buf.
	 * If this is not set drm_gem_prime_export() is used.
	 *
	 * This callback is optional.
	 */
	struct dma_buf *(*export)(struct drm_gem_object *obj, int flags);

	/**
	 * @pin:
	 *
	 * Pin backing buffer in memory.
	 *
	 * This callback is optional.
	 */
	int (*pin)(struct drm_gem_object *obj);

	/**
	 * @unpin:
	 *
	 * Unpin backing buffer.
	 *
	 * This callback is optional.
	 */
	void (*unpin)(struct drm_gem_object *obj);

	/**
	 * @get_sg_table:
	 *
	 * Returns a Scatter-Gather table representation of the buffer.
	 * Used when exporting a buffer.
	 *
	 * This callback is mandatory if buffer export is supported.
	 */
	struct sg_table *(*get_sg_table)(struct drm_gem_object *obj);

	/**
	 * @vmap:
	 *
	 * Returns a virtual address for the buffer.
	 *
	 * This callback is optional.
	 */
	void *(*vmap)(struct drm_gem_object *obj);

	/**
	 * @vunmap:
	 *
	 * Releases the the address previously returned by @vmap.
	 *
	 * This callback is optional.
	 */
	void (*vunmap)(struct drm_gem_object *obj, void *vaddr);

	/**
	 * @vm_ops:
	 *
	 * Virtual memory operations used with mmap.
	 *
	 * This is optional but necessary for mmap support.
	 */
	const struct vm_operations_struct *vm_ops;
};

/**
 * 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.
 *
 * Buffer objects are often abbreviated to BO.
 */
struct drm_gem_object {
	/**
	 * @refcount:
	 *
	 * Reference count of this object
	 *
	 * Please use drm_gem_object_get() to acquire and drm_gem_object_put()
	 * or drm_gem_object_put_unlocked() to release a reference to a GEM
	 * buffer object.
	 */
	struct kref refcount;

	/**
	 * @handle_count:
	 *
	 * 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 &drm_device.object_name_lock.
	 */
	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.
	 * GEM also supports driver private objects with driver-specific backing
	 * storage (contiguous CMA memory, special reserved blocks). In this
	 * case @filp is NULL.
	 */
	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().
	 *
	 * Memory mapping itself is handled by drm_gem_mmap(), which also checks
	 * that userspace is allowed to access the object.
	 */
	struct drm_vma_offset_node vma_node;

	/**
	 * @size:
	 *
	 * Size of the object, in bytes.  Immutable over the object's
	 * lifetime.
	 */
	size_t size;

	/**
	 * @name:
	 *
	 * Global name for this object, starts at 1. 0 means unnamed.
	 * Access is covered by &drm_device.object_name_lock. This is used by
	 * the GEM_FLINK and GEM_OPEN ioctls.
	 */
	int name;

	/**
	 * @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
	 * loop when the last gem handle for this object is released.
	 *
	 * Protected by &drm_device.object_name_lock.
	 */
	struct dma_buf *dma_buf;

	/**
	 * @import_attach:
	 *
	 * dma-buf attachment backing this object.
	 *
	 * Any foreign dma_buf imported as a gem object has this set to the
	 * attachment point for the device. This is invariant over the lifetime
	 * of a gem object.
	 *
	 * The &drm_driver.gem_free_object callback is responsible for cleaning
	 * up the dma_buf attachment and references acquired at import time.
	 *
	 * Note that the drm gem/prime core does not depend upon drivers setting
	 * this field any more. So for drivers where this doesn't make sense
	 * (e.g. virtual devices or a displaylink behind an usb bus) they can
	 * simply leave it as NULL.
	 */
	struct dma_buf_attachment *import_attach;

	/**
	 * @funcs:
	 *
	 * Optional GEM object functions. If this is set, it will be used instead of the
	 * corresponding &drm_driver GEM callbacks.
	 *
	 * New drivers should use this.
	 *
	 */
	const struct drm_gem_object_funcs *funcs;
};

/**
 * DEFINE_DRM_GEM_FOPS() - macro to generate file operations for GEM drivers
 * @name: name for the generated structure
 *
 * This macro autogenerates a suitable &struct file_operations for GEM based
 * drivers, which can be assigned to &drm_driver.fops. Note that this structure
 * cannot be shared between drivers, because it contains a reference to the
 * current module using THIS_MODULE.
 *
 * Note that the declaration is already marked as static - if you need a
 * non-static version of this you're probably doing it wrong and will break the
 * THIS_MODULE reference by accident.
 */
#define DEFINE_DRM_GEM_FOPS(name) \
	static const struct file_operations name = {\
		.owner		= THIS_MODULE,\
		.open		= drm_open,\
		.release	= drm_release,\
		.unlocked_ioctl	= drm_ioctl,\
		.compat_ioctl	= drm_compat_ioctl,\
		.poll		= drm_poll,\
		.read		= drm_read,\
		.llseek		= noop_llseek,\
		.mmap		= drm_gem_mmap,\
	}

void drm_gem_object_release(struct drm_gem_object *obj);
void drm_gem_object_free(struct kref *kref);
int drm_gem_object_init(struct drm_device *dev,
			struct drm_gem_object *obj, size_t size);
void drm_gem_private_object_init(struct drm_device *dev,
				 struct drm_gem_object *obj, size_t size);
void drm_gem_vm_open(struct vm_area_struct *vma);
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_get - acquire a GEM buffer object reference
 * @obj: GEM buffer object
 *
 * This function acquires an additional reference to @obj. It is illegal to
 * call this without already holding a reference. No locks required.
 */
static inline void drm_gem_object_get(struct drm_gem_object *obj)
{
	kref_get(&obj->refcount);
}

/**
 * __drm_gem_object_put - raw function to release a GEM buffer object reference
 * @obj: GEM buffer object
 *
 * This function is meant to be used by drivers which are not encumbered with
 * &drm_device.struct_mutex legacy locking and which are using the
 * gem_free_object_unlocked callback. It avoids all the locking checks and
 * locking overhead of drm_gem_object_put() and drm_gem_object_put_unlocked().
 *
 * Drivers should never call this directly in their code. Instead they should
 * wrap it up into a ``driver_gem_object_put(struct driver_gem_object *obj)``
 * wrapper function, and use that. Shared code should never call this, to
 * avoid breaking drivers by accident which still depend upon
 * &drm_device.struct_mutex locking.
 */
static inline void
__drm_gem_object_put(struct drm_gem_object *obj)
{
	kref_put(&obj->refcount, drm_gem_object_free);
}

void drm_gem_object_put_unlocked(struct drm_gem_object *obj);
void drm_gem_object_put(struct drm_gem_object *obj);

int drm_gem_handle_create(struct drm_file *file_priv,
			  struct drm_gem_object *obj,
			  u32 *handlep);
int drm_gem_handle_delete(struct drm_file *filp, u32 handle);


void drm_gem_free_mmap_offset(struct drm_gem_object *obj);
int drm_gem_create_mmap_offset(struct drm_gem_object *obj);
int drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size);

struct page **drm_gem_get_pages(struct drm_gem_object *obj);
void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages,
		bool dirty, bool accessed);

struct drm_gem_object *drm_gem_object_lookup(struct drm_file *filp, u32 handle);
int drm_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev,
			    u32 handle, u64 *offset);
int drm_gem_dumb_destroy(struct drm_file *file,
			 struct drm_device *dev,
			 uint32_t handle);

int drm_gem_pin(struct drm_gem_object *obj);
void drm_gem_unpin(struct drm_gem_object *obj);
void *drm_gem_vmap(struct drm_gem_object *obj);
void drm_gem_vunmap(struct drm_gem_object *obj, void *vaddr);

#endif /* __DRM_GEM_H__ */
Commit	Line	Data
d9fc9413 DV	1	#ifndef __DRM_GEM_H__
	2	#define __DRM_GEM_H__
	3
	4	/*
	5	* GEM Graphics Execution Manager Driver Interfaces
	6	*
	7	* Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
	8	* Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
	9	* Copyright (c) 2009-2010, Code Aurora Forum.
	10	* All rights reserved.
	11	* Copyright © 2014 Intel Corporation
	12	* Daniel Vetter <daniel.vetter@ffwll.ch>
	13	*
	14	* Author: Rickard E. (Rik) Faith <faith@valinux.com>
	15	* Author: Gareth Hughes <gareth@valinux.com>
	16	*
	17	* Permission is hereby granted, free of charge, to any person obtaining a
	18	* copy of this software and associated documentation files (the "Software"),
	19	* to deal in the Software without restriction, including without limitation
	20	* the rights to use, copy, modify, merge, publish, distribute, sublicense,
	21	* and/or sell copies of the Software, and to permit persons to whom the
	22	* Software is furnished to do so, subject to the following conditions:
	23	*
	24	* The above copyright notice and this permission notice (including the next
	25	* paragraph) shall be included in all copies or substantial portions of the
	26	* Software.
	27	*
	28	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	29	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	30	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	31	* VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
	32	* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
	33	* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
	34	* OTHER DEALINGS IN THE SOFTWARE.
	35	*/
	36
c6bb9baa DV	37	#include <linux/kref.h>
	38
	39	#include <drm/drm_vma_manager.h>
	40
b39b5394 NT	41	struct drm_gem_object;
	42
	43	/**
	44	* struct drm_gem_object_funcs - GEM object functions
	45	*/
	46	struct drm_gem_object_funcs {
	47	/**
	48	* @free:
	49	*
	50	* Deconstructor for drm_gem_objects.
	51	*
	52	* This callback is mandatory.
	53	*/
	54	void (free)(struct drm_gem_object obj);
	55
	56	/**
	57	* @open:
	58	*
	59	* Called upon GEM handle creation.
	60	*
	61	* This callback is optional.
	62	*/
	63	int (open)(struct drm_gem_object obj, struct drm_file *file);
	64
	65	/**
	66	* @close:
	67	*
	68	* Called upon GEM handle release.
	69	*
	70	* This callback is optional.
	71	*/
	72	void (close)(struct drm_gem_object obj, struct drm_file *file);
	73
	74	/**
	75	* @print_info:
	76	*
	77	* If driver subclasses struct &drm_gem_object, it can implement this
	78	* optional hook for printing additional driver specific info.
	79	*
	80	* drm_printf_indent() should be used in the callback passing it the
	81	* indent argument.
	82	*
	83	* This callback is called from drm_gem_print_info().
	84	*
	85	* This callback is optional.
	86	*/
	87	void (print_info)(struct drm_printer p, unsigned int indent,
	88	const struct drm_gem_object *obj);
	89
	90	/**
	91	* @export:
	92	*
	93	* Export backing buffer as a &dma_buf.
	94	* If this is not set drm_gem_prime_export() is used.
	95	*
	96	* This callback is optional.
	97	*/
	98	struct dma_buf (export)(struct drm_gem_object *obj, int flags);
	99
	100	/**
	101	* @pin:
	102	*
	103	* Pin backing buffer in memory.
	104	*
105	* This callback is optional.
106	*/
107	int (pin)(struct drm_gem_object obj);
108
109	/**
110	* @unpin:
111	*
112	* Unpin backing buffer.
113	*
114	* This callback is optional.
115	*/
116	void (unpin)(struct drm_gem_object obj);
117
118	/**
119	* @get_sg_table:
120	*
121	* Returns a Scatter-Gather table representation of the buffer.
122	* Used when exporting a buffer.
123	*
124	* This callback is mandatory if buffer export is supported.
125	*/
126	struct sg_table (get_sg_table)(struct drm_gem_object *obj);
127
128	/**
129	* @vmap:
130	*
131	* Returns a virtual address for the buffer.
132	*
133	* This callback is optional.
134	*/
135	void (vmap)(struct drm_gem_object *obj);
136
137	/**
138	* @vunmap:
139	*
140	* Releases the the address previously returned by @vmap.
141	*
142	* This callback is optional.
143	*/
144	void (vunmap)(struct drm_gem_object obj, void *vaddr);
145
146	/**
147	* @vm_ops:
148	*
149	* Virtual memory operations used with mmap.
150	*
151	* This is optional but necessary for mmap support.
152	*/
153	const struct vm_operations_struct *vm_ops;
154	};
155
d9fc9413	156	/**
decc60bf DV	157	* struct drm_gem_object - GEM buffer object
	158	*
	159	* This structure defines the generic parts for GEM buffer objects, which are
	160	* mostly around handling mmap and userspace handles.
	161	*
	162	* Buffer objects are often abbreviated to BO.
d9fc9413 DV	163	*/
d9fc9413 DV	164	struct drm_gem_object {
decc60bf DV	165	/**
	166	* @refcount:
	167	*
	168	* Reference count of this object
	169	*
e6b62714 TR	170	* Please use drm_gem_object_get() to acquire and drm_gem_object_put()
	171	* or drm_gem_object_put_unlocked() to release a reference to a GEM
	172	* buffer object.
decc60bf	173	*/
d9fc9413 DV	174	struct kref refcount;
	175
	176	/**
decc60bf DV	177	* @handle_count:
	178	*
	179	* This is the GEM file_priv handle count of this object.
d9fc9413 DV	180	*
	181	* Each handle also holds a reference. Note that when the handle_count
	182	* drops to 0 any global names (e.g. the id in the flink namespace) will
	183	* be cleared.
	184	*
940eba2d	185	* Protected by &drm_device.object_name_lock.
decc60bf	186	*/
d9fc9413 DV	187	unsigned handle_count;
d9fc9413 DV	188
decc60bf DV	189	/**
	190	* @dev: DRM dev this object belongs to.
	191	*/
d9fc9413 DV	192	struct drm_device *dev;
d9fc9413 DV	193
decc60bf DV	194	/**
	195	* @filp:
	196	*
	197	* SHMEM file node used as backing storage for swappable buffer objects.
	198	* GEM also supports driver private objects with driver-specific backing
	199	* storage (contiguous CMA memory, special reserved blocks). In this
	200	* case @filp is NULL.
	201	*/
d9fc9413 DV	202	struct file *filp;
d9fc9413 DV	203
decc60bf DV	204	/**
	205	* @vma_node:
	206	*
	207	* Mapping info for this object to support mmap. Drivers are supposed to
	208	* allocate the mmap offset using drm_gem_create_mmap_offset(). The
	209	* offset itself can be retrieved using drm_vma_node_offset_addr().
	210	*
	211	* Memory mapping itself is handled by drm_gem_mmap(), which also checks
	212	* that userspace is allowed to access the object.
	213	*/
d9fc9413 DV	214	struct drm_vma_offset_node vma_node;
	215
	216	/**
decc60bf DV	217	* @size:
decc60bf DV	218	*
d9fc9413 DV	219	* Size of the object, in bytes. Immutable over the object's
	220	* lifetime.
	221	*/
	222	size_t size;
	223
	224	/**
decc60bf DV	225	* @name:
decc60bf DV	226	*
d9fc9413	227	* Global name for this object, starts at 1. 0 means unnamed.
940eba2d DV	228	* Access is covered by &drm_device.object_name_lock. This is used by
940eba2d DV	229	* the GEM_FLINK and GEM_OPEN ioctls.
d9fc9413 DV	230	*/
	231	int name;
	232
d9fc9413	233	/**
decc60bf DV	234	* @dma_buf:
	235	*
	236	* dma-buf associated with this GEM object.
d9fc9413 DV	237	*
	238	* Pointer to the dma-buf associated with this gem object (either
	239	* through importing or exporting). We break the resulting reference
	240	* loop when the last gem handle for this object is released.
	241	*
940eba2d	242	* Protected by &drm_device.object_name_lock.
d9fc9413 DV	243	*/
	244	struct dma_buf *dma_buf;
	245
	246	/**
decc60bf DV	247	* @import_attach:
	248	*
	249	* dma-buf attachment backing this object.
d9fc9413 DV	250	*
	251	* Any foreign dma_buf imported as a gem object has this set to the
	252	* attachment point for the device. This is invariant over the lifetime
	253	* of a gem object.
	254	*
940eba2d	255	* The &drm_driver.gem_free_object callback is responsible for cleaning
d9fc9413 DV	256	* up the dma_buf attachment and references acquired at import time.
	257	*
	258	* Note that the drm gem/prime core does not depend upon drivers setting
	259	* this field any more. So for drivers where this doesn't make sense
	260	* (e.g. virtual devices or a displaylink behind an usb bus) they can
	261	* simply leave it as NULL.
	262	*/
	263	struct dma_buf_attachment *import_attach;
b39b5394 NT	264
	265	/**
	266	* @funcs:
	267	*
	268	* Optional GEM object functions. If this is set, it will be used instead of the
	269	* corresponding &drm_driver GEM callbacks.
	270	*
	271	* New drivers should use this.
	272	*
	273	*/
	274	const struct drm_gem_object_funcs *funcs;
d9fc9413 DV	275	};
d9fc9413 DV	276
f42e1819 DV	277	/**
	278	* DEFINE_DRM_GEM_FOPS() - macro to generate file operations for GEM drivers
	279	* @name: name for the generated structure
	280	*
	281	* This macro autogenerates a suitable &struct file_operations for GEM based
	282	* drivers, which can be assigned to &drm_driver.fops. Note that this structure
	283	* cannot be shared between drivers, because it contains a reference to the
	284	* current module using THIS_MODULE.
	285	*
	286	* Note that the declaration is already marked as static - if you need a
	287	* non-static version of this you're probably doing it wrong and will break the
	288	* THIS_MODULE reference by accident.
	289	*/
	290	#define DEFINE_DRM_GEM_FOPS(name) \
	291	static const struct file_operations name = {\
	292	.owner = THIS_MODULE,\
	293	.open = drm_open,\
	294	.release = drm_release,\
	295	.unlocked_ioctl = drm_ioctl,\
	296	.compat_ioctl = drm_compat_ioctl,\
	297	.poll = drm_poll,\
	298	.read = drm_read,\
	299	.llseek = noop_llseek,\
	300	.mmap = drm_gem_mmap,\
	301	}
	302
d9fc9413 DV	303	void drm_gem_object_release(struct drm_gem_object *obj);
	304	void drm_gem_object_free(struct kref *kref);
	305	int drm_gem_object_init(struct drm_device *dev,
	306	struct drm_gem_object *obj, size_t size);
	307	void drm_gem_private_object_init(struct drm_device *dev,
	308	struct drm_gem_object *obj, size_t size);
	309	void drm_gem_vm_open(struct vm_area_struct *vma);
	310	void drm_gem_vm_close(struct vm_area_struct *vma);
	311	int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
	312	struct vm_area_struct *vma);
	313	int drm_gem_mmap(struct file filp, struct vm_area_struct vma);
	314
decc60bf	315	/**
e6b62714	316	* drm_gem_object_get - acquire a GEM buffer object reference
decc60bf DV	317	* @obj: GEM buffer object
decc60bf DV	318	*
e6b62714 TR	319	* This function acquires an additional reference to @obj. It is illegal to
e6b62714 TR	320	* call this without already holding a reference. No locks required.
decc60bf	321	*/
e6b62714	322	static inline void drm_gem_object_get(struct drm_gem_object *obj)
d9fc9413 DV	323	{
	324	kref_get(&obj->refcount);
	325	}
	326
decc60bf	327	/**
e6b62714	328	* __drm_gem_object_put - raw function to release a GEM buffer object reference
decc60bf DV	329	* @obj: GEM buffer object
decc60bf DV	330	*
9f0ba539	331	* This function is meant to be used by drivers which are not encumbered with
940eba2d	332	* &drm_device.struct_mutex legacy locking and which are using the
9f0ba539	333	* gem_free_object_unlocked callback. It avoids all the locking checks and
e6b62714	334	* locking overhead of drm_gem_object_put() and drm_gem_object_put_unlocked().
decc60bf	335	*
9f0ba539	336	* Drivers should never call this directly in their code. Instead they should
e6b62714 TR	337	* wrap it up into a ``driver_gem_object_put(struct driver_gem_object *obj)``
e6b62714 TR	338	* wrapper function, and use that. Shared code should never call this, to
940eba2d DV	339	* avoid breaking drivers by accident which still depend upon
940eba2d DV	340	* &drm_device.struct_mutex locking.
decc60bf	341	*/
d9fc9413	342	static inline void
e6b62714	343	__drm_gem_object_put(struct drm_gem_object *obj)
d9fc9413	344	{
9f0ba539	345	kref_put(&obj->refcount, drm_gem_object_free);
d9fc9413 DV	346	}
d9fc9413 DV	347
e6b62714 TR	348	void drm_gem_object_put_unlocked(struct drm_gem_object *obj);
	349	void drm_gem_object_put(struct drm_gem_object *obj);
	350
d9fc9413 DV	351	int drm_gem_handle_create(struct drm_file *file_priv,
	352	struct drm_gem_object *obj,
	353	u32 *handlep);
	354	int drm_gem_handle_delete(struct drm_file *filp, u32 handle);
	355
	356
	357	void drm_gem_free_mmap_offset(struct drm_gem_object *obj);
	358	int drm_gem_create_mmap_offset(struct drm_gem_object *obj);
	359	int drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size);
	360
	361	struct page *drm_gem_get_pages(struct drm_gem_object obj);
	362	void drm_gem_put_pages(struct drm_gem_object obj, struct page *pages,
	363	bool dirty, bool accessed);
	364
a8ad0bd8	365	struct drm_gem_object drm_gem_object_lookup(struct drm_file filp, u32 handle);
db611527 NT	366	int drm_gem_dumb_map_offset(struct drm_file file, struct drm_device dev,
db611527 NT	367	u32 handle, u64 *offset);
d9fc9413 DV	368	int drm_gem_dumb_destroy(struct drm_file *file,
	369	struct drm_device *dev,
	370	uint32_t handle);
	371
b39b5394 NT	372	int drm_gem_pin(struct drm_gem_object *obj);
	373	void drm_gem_unpin(struct drm_gem_object *obj);
	374	void drm_gem_vmap(struct drm_gem_object obj);
	375	void drm_gem_vunmap(struct drm_gem_object obj, void vaddr);
	376
d9fc9413	377	#endif /* __DRM_GEM_H__ */