5 * GEM Graphics Execution Manager Driver Interfaces
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>
14 * Author: Rickard E. (Rik) Faith <faith@valinux.com>
15 * Author: Gareth Hughes <gareth@valinux.com>
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:
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
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.
37 /* BSD specific gem helpers. */
38 #define DRM_GEM_MAPPING_MASK (3ULL << 62)
39 #define DRM_GEM_MAPPING_KEY (2ULL << 62) /* Non-canonical address form */
40 #define DRM_GEM_MAX_IDX 0x3fffff
41 #define DRM_GEM_MAPPING_IDX(o) (((o) >> 40) & DRM_GEM_MAX_IDX)
42 #define DRM_GEM_MAPPING_OFF(i) (((uint64_t)(i)) << 40)
43 #define DRM_GEM_MAPPING_MAPOFF(o) \
44 ((o) & ~(DRM_GEM_MAPPING_OFF(DRM_GEM_MAX_IDX) | DRM_GEM_MAPPING_KEY))
47 * struct drm_gem_object - GEM buffer object
49 * This structure defines the generic parts for GEM buffer objects, which are
50 * mostly around handling mmap and userspace handles.
52 * Buffer objects are often abbreviated to BO.
54 struct drm_gem_object {
58 * Reference count of this object
60 * Please use drm_gem_object_reference() to acquire and
61 * drm_gem_object_unreference() or drm_gem_object_unreference_unlocked()
62 * to release a reference to a GEM buffer object.
69 * This is the GEM file_priv handle count of this object.
71 * Each handle also holds a reference. Note that when the handle_count
72 * drops to 0 any global names (e.g. the id in the flink namespace) will
75 * Protected by dev->object_name_lock.
77 unsigned handle_count;
80 * @dev: DRM dev this object belongs to.
82 struct drm_device *dev;
87 * SHMEM file node used as backing storage for swappable buffer objects.
88 * GEM also supports driver private objects with driver-specific backing
89 * storage (contiguous CMA memory, special reserved blocks). In this
101 * Mapping info for this object to support mmap. Drivers are supposed to
102 * allocate the mmap offset using drm_gem_create_mmap_offset(). The
103 * offset itself can be retrieved using drm_vma_node_offset_addr().
105 * Memory mapping itself is handled by drm_gem_mmap(), which also checks
106 * that userspace is allowed to access the object.
108 struct drm_vma_offset_node vma_node;
110 struct drm_hash_item map_list;
115 * Size of the object, in bytes. Immutable over the object's
123 * Global name for this object, starts at 1. 0 means unnamed.
124 * Access is covered by dev->object_name_lock. This is used by the GEM_FLINK
125 * and GEM_OPEN ioctls.
132 * Read memory domains. These monitor which caches contain read/write data
133 * related to the object. When transitioning from one set of domains
134 * to another, the driver is called to ensure that caches are suitably
135 * flushed and invalidated.
137 uint32_t read_domains;
140 * @write_domain: Corresponding unique write memory domain.
142 uint32_t write_domain;
145 * @pending_read_domains:
147 * While validating an exec operation, the
148 * new read/write domain values are computed here.
149 * They will be transferred to the above values
150 * at the point that any cache flushing occurs
152 uint32_t pending_read_domains;
155 * @pending_write_domain: Write domain similar to @pending_read_domains.
157 uint32_t pending_write_domain;
162 * dma-buf associated with this GEM object.
164 * Pointer to the dma-buf associated with this gem object (either
165 * through importing or exporting). We break the resulting reference
166 * loop when the last gem handle for this object is released.
168 * Protected by obj->object_name_lock.
170 struct dma_buf *dma_buf;
175 * dma-buf attachment backing this object.
177 * Any foreign dma_buf imported as a gem object has this set to the
178 * attachment point for the device. This is invariant over the lifetime
181 * The driver's ->gem_free_object callback is responsible for cleaning
182 * up the dma_buf attachment and references acquired at import time.
184 * Note that the drm gem/prime core does not depend upon drivers setting
185 * this field any more. So for drivers where this doesn't make sense
186 * (e.g. virtual devices or a displaylink behind an usb bus) they can
187 * simply leave it as NULL.
189 struct dma_buf_attachment *import_attach;
192 void drm_gem_object_release(struct drm_gem_object *obj);
193 void drm_gem_object_free(struct kref *kref);
194 int drm_gem_object_init(struct drm_device *dev,
195 struct drm_gem_object *obj, size_t size);
196 void drm_gem_private_object_init(struct drm_device *dev,
197 struct drm_gem_object *obj, size_t size);
198 void drm_gem_vm_open(struct vm_area_struct *vma);
199 void drm_gem_vm_close(struct vm_area_struct *vma);
200 int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
201 struct vm_area_struct *vma);
202 int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma);
204 int i915_gem_pager_ctor(void *handle, vm_ooffset_t size, vm_prot_t prot,
205 vm_ooffset_t foff, struct ucred *cred, u_short *color);
206 void i915_gem_pager_dtor(void * handle);
209 * drm_gem_object_reference - acquire a GEM BO reference
210 * @obj: GEM buffer object
212 * This acquires additional reference to @obj. It is illegal to call this
213 * without already holding a reference. No locks required.
216 drm_gem_object_reference(struct drm_gem_object *obj)
218 kref_get(&obj->refcount);
222 * drm_gem_object_unreference - release a GEM BO reference
223 * @obj: GEM buffer object
225 * This releases a reference to @obj. Callers must hold the dev->struct_mutex
226 * lock when calling this function, even when the driver doesn't use
227 * dev->struct_mutex for anything.
229 * For drivers not encumbered with legacy locking use
230 * drm_gem_object_unreference_unlocked() instead.
233 drm_gem_object_unreference(struct drm_gem_object *obj)
237 WARN_ON(!mutex_is_locked(&obj->dev->struct_mutex));
240 kref_put(&obj->refcount, drm_gem_object_free);
245 * drm_gem_object_unreference_unlocked - release a GEM BO reference
246 * @obj: GEM buffer object
248 * This releases a reference to @obj. Callers must not hold the
249 * dev->struct_mutex lock when calling this function.
252 drm_gem_object_unreference_unlocked(struct drm_gem_object *obj)
254 struct drm_device *dev;
260 if (kref_put_mutex(&obj->refcount, drm_gem_object_free, &dev->struct_mutex))
261 mutex_unlock(&dev->struct_mutex);
263 might_lock(&dev->struct_mutex);
266 int drm_gem_handle_create(struct drm_file *file_priv,
267 struct drm_gem_object *obj,
269 int drm_gem_handle_delete(struct drm_file *filp, u32 handle);
272 void drm_gem_free_mmap_offset(struct drm_gem_object *obj);
273 int drm_gem_create_mmap_offset(struct drm_gem_object *obj);
274 int drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size);
276 struct page **drm_gem_get_pages(struct drm_gem_object *obj);
277 void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages,
278 bool dirty, bool accessed);
280 struct drm_gem_object *drm_gem_object_lookup(struct drm_file *filp, u32 handle);
281 int drm_gem_dumb_destroy(struct drm_file *file,
282 struct drm_device *dev,
285 #endif /* __DRM_GEM_H__ */