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 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)) 45 46 /** 47 * struct drm_gem_object - GEM buffer object 48 * 49 * This structure defines the generic parts for GEM buffer objects, which are 50 * mostly around handling mmap and userspace handles. 51 * 52 * Buffer objects are often abbreviated to BO. 53 */ 54 struct drm_gem_object { 55 /** 56 * @refcount: 57 * 58 * Reference count of this object 59 * 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. 63 */ 64 struct kref refcount; 65 66 /** 67 * @handle_count: 68 * 69 * This is the GEM file_priv handle count of this object. 70 * 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 73 * be cleared. 74 * 75 * Protected by dev->object_name_lock. 76 */ 77 unsigned handle_count; 78 79 /** 80 * @dev: DRM dev this object belongs to. 81 */ 82 struct drm_device *dev; 83 84 /** 85 * @filp: 86 * 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 90 * case @filp is NULL. 91 */ 92 #ifdef __DragonFly__ 93 struct vm_object *filp; 94 #else 95 struct file *filp; 96 #endif 97 98 /** 99 * @vma_node: 100 * 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(). 104 * 105 * Memory mapping itself is handled by drm_gem_mmap(), which also checks 106 * that userspace is allowed to access the object. 107 */ 108 struct drm_vma_offset_node vma_node; 109 #ifdef __DragonFly__ 110 bool on_map; 111 struct drm_hash_item map_list; 112 #endif 113 114 /** 115 * @size: 116 * 117 * Size of the object, in bytes. Immutable over the object's 118 * lifetime. 119 */ 120 size_t size; 121 122 /** 123 * @name: 124 * 125 * Global name for this object, starts at 1. 0 means unnamed. 126 * Access is covered by dev->object_name_lock. This is used by the GEM_FLINK 127 * and GEM_OPEN ioctls. 128 */ 129 int name; 130 131 /** 132 * @read_domains: 133 * 134 * Read memory domains. These monitor which caches contain read/write data 135 * related to the object. When transitioning from one set of domains 136 * to another, the driver is called to ensure that caches are suitably 137 * flushed and invalidated. 138 */ 139 uint32_t read_domains; 140 141 /** 142 * @write_domain: Corresponding unique write memory domain. 143 */ 144 uint32_t write_domain; 145 146 /** 147 * @pending_read_domains: 148 * 149 * While validating an exec operation, the 150 * new read/write domain values are computed here. 151 * They will be transferred to the above values 152 * at the point that any cache flushing occurs 153 */ 154 uint32_t pending_read_domains; 155 156 /** 157 * @pending_write_domain: Write domain similar to @pending_read_domains. 158 */ 159 uint32_t pending_write_domain; 160 161 /** 162 * @dma_buf: 163 * 164 * dma-buf associated with this GEM object. 165 * 166 * Pointer to the dma-buf associated with this gem object (either 167 * through importing or exporting). We break the resulting reference 168 * loop when the last gem handle for this object is released. 169 * 170 * Protected by obj->object_name_lock. 171 */ 172 struct dma_buf *dma_buf; 173 174 /** 175 * @import_attach: 176 * 177 * dma-buf attachment backing this object. 178 * 179 * Any foreign dma_buf imported as a gem object has this set to the 180 * attachment point for the device. This is invariant over the lifetime 181 * of a gem object. 182 * 183 * The driver's ->gem_free_object callback is responsible for cleaning 184 * up the dma_buf attachment and references acquired at import time. 185 * 186 * Note that the drm gem/prime core does not depend upon drivers setting 187 * this field any more. So for drivers where this doesn't make sense 188 * (e.g. virtual devices or a displaylink behind an usb bus) they can 189 * simply leave it as NULL. 190 */ 191 struct dma_buf_attachment *import_attach; 192 }; 193 194 void drm_gem_object_release(struct drm_gem_object *obj); 195 void drm_gem_object_free(struct kref *kref); 196 int drm_gem_object_init(struct drm_device *dev, 197 struct drm_gem_object *obj, size_t size); 198 void drm_gem_private_object_init(struct drm_device *dev, 199 struct drm_gem_object *obj, size_t size); 200 void drm_gem_vm_open(struct vm_area_struct *vma); 201 void drm_gem_vm_close(struct vm_area_struct *vma); 202 int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size, 203 struct vm_area_struct *vma); 204 int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma); 205 206 int i915_gem_pager_ctor(void *handle, vm_ooffset_t size, vm_prot_t prot, 207 vm_ooffset_t foff, struct ucred *cred, u_short *color); 208 void i915_gem_pager_dtor(void * handle); 209 210 /** 211 * drm_gem_object_reference - acquire a GEM BO reference 212 * @obj: GEM buffer object 213 * 214 * This acquires additional reference to @obj. It is illegal to call this 215 * without already holding a reference. No locks required. 216 */ 217 static inline void 218 drm_gem_object_reference(struct drm_gem_object *obj) 219 { 220 kref_get(&obj->refcount); 221 } 222 223 void drm_gem_object_unreference_unlocked(struct drm_gem_object *obj); 224 void drm_gem_object_unreference(struct drm_gem_object *obj); 225 226 int drm_gem_handle_create(struct drm_file *file_priv, 227 struct drm_gem_object *obj, 228 u32 *handlep); 229 int drm_gem_handle_delete(struct drm_file *filp, u32 handle); 230 231 232 void drm_gem_free_mmap_offset(struct drm_gem_object *obj); 233 int drm_gem_create_mmap_offset(struct drm_gem_object *obj); 234 int drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size); 235 236 struct page **drm_gem_get_pages(struct drm_gem_object *obj); 237 void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages, 238 bool dirty, bool accessed); 239 240 struct drm_gem_object *drm_gem_object_lookup(struct drm_file *filp, u32 handle); 241 int drm_gem_dumb_destroy(struct drm_file *file, 242 struct drm_device *dev, 243 uint32_t handle); 244 245 #endif /* __DRM_GEM_H__ */ 246