1 /* 2 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas. 3 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California. 4 * Copyright (c) 2009-2010, Code Aurora Forum. 5 * Copyright 2016 Intel Corp. 6 * 7 * Permission is hereby granted, free of charge, to any person obtaining a 8 * copy of this software and associated documentation files (the "Software"), 9 * to deal in the Software without restriction, including without limitation 10 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 11 * and/or sell copies of the Software, and to permit persons to whom the 12 * Software is furnished to do so, subject to the following conditions: 13 * 14 * The above copyright notice and this permission notice (including the next 15 * paragraph) shall be included in all copies or substantial portions of the 16 * Software. 17 * 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 21 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 22 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 23 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 24 * OTHER DEALINGS IN THE SOFTWARE. 25 */ 26 27 #ifndef _DRM_DRV_H_ 28 #define _DRM_DRV_H_ 29 30 #include <linux/list.h> 31 #include <linux/irqreturn.h> 32 33 struct drm_device; 34 struct drm_file; 35 struct drm_gem_object; 36 struct drm_master; 37 struct drm_minor; 38 struct dma_buf_attachment; 39 struct drm_display_mode; 40 struct drm_mode_create_dumb; 41 42 /* driver capabilities and requirements mask */ 43 #define DRIVER_USE_AGP 0x1 44 #define DRIVER_LEGACY 0x2 45 #define DRIVER_PCI_DMA 0x8 46 #define DRIVER_SG 0x10 47 #define DRIVER_HAVE_DMA 0x20 48 #define DRIVER_HAVE_IRQ 0x40 49 #define DRIVER_IRQ_SHARED 0x80 50 #define DRIVER_GEM 0x1000 51 #define DRIVER_MODESET 0x2000 52 #define DRIVER_PRIME 0x4000 53 #define DRIVER_RENDER 0x8000 54 #define DRIVER_ATOMIC 0x10000 55 #define DRIVER_KMS_LEGACY_CONTEXT 0x20000 56 57 /** 58 * struct drm_driver - DRM driver structure 59 * 60 * This structure represent the common code for a family of cards. There will 61 * one drm_device for each card present in this family. It contains lots of 62 * vfunc entries, and a pile of those probably should be moved to more 63 * appropriate places like &drm_mode_config_funcs or into a new operations 64 * structure for GEM drivers. 65 */ 66 struct drm_driver { 67 68 /** 69 * @load: 70 * 71 * Backward-compatible driver callback to complete 72 * initialization steps after the driver is registered. For 73 * this reason, may suffer from race conditions and its use is 74 * deprecated for new drivers. It is therefore only supported 75 * for existing drivers not yet converted to the new scheme. 76 * See drm_dev_init() and drm_dev_register() for proper and 77 * race-free way to set up a &struct drm_device. 78 * 79 * Returns: 80 * 81 * Zero on success, non-zero value on failure. 82 */ 83 int (*load) (struct drm_device *, unsigned long flags); 84 int (*open) (struct drm_device *, struct drm_file *); 85 void (*preclose) (struct drm_device *, struct drm_file *file_priv); 86 void (*postclose) (struct drm_device *, struct drm_file *); 87 void (*lastclose) (struct drm_device *); 88 89 /** 90 * @unload: 91 * 92 * Reverse the effects of the driver load callback. Ideally, 93 * the clean up performed by the driver should happen in the 94 * reverse order of the initialization. Similarly to the load 95 * hook, this handler is deprecated and its usage should be 96 * dropped in favor of an open-coded teardown function at the 97 * driver layer. See drm_dev_unregister() and drm_dev_unref() 98 * for the proper way to remove a &struct drm_device. 99 * 100 * The unload() hook is called right after unregistering 101 * the device. 102 * 103 */ 104 void (*unload) (struct drm_device *); 105 106 /** 107 * @release: 108 * 109 * Optional callback for destroying device data after the final 110 * reference is released, i.e. the device is being destroyed. Drivers 111 * using this callback are responsible for calling drm_dev_fini() 112 * to finalize the device and then freeing the struct themselves. 113 */ 114 void (*release) (struct drm_device *); 115 116 int (*set_busid)(struct drm_device *dev, struct drm_master *master); 117 118 /** 119 * @get_vblank_counter: 120 * 121 * Driver callback for fetching a raw hardware vblank counter for the 122 * CRTC specified with the pipe argument. If a device doesn't have a 123 * hardware counter, the driver can simply use 124 * drm_vblank_no_hw_counter() function. The DRM core will account for 125 * missed vblank events while interrupts where disabled based on system 126 * timestamps. 127 * 128 * Wraparound handling and loss of events due to modesetting is dealt 129 * with in the DRM core code, as long as drivers call 130 * drm_crtc_vblank_off() and drm_crtc_vblank_on() when disabling or 131 * enabling a CRTC. 132 * 133 * Returns: 134 * 135 * Raw vblank counter value. 136 */ 137 u32 (*get_vblank_counter) (struct drm_device *dev, unsigned int pipe); 138 139 /** 140 * @enable_vblank: 141 * 142 * Enable vblank interrupts for the CRTC specified with the pipe 143 * argument. 144 * 145 * Returns: 146 * 147 * Zero on success, appropriate errno if the given @crtc's vblank 148 * interrupt cannot be enabled. 149 */ 150 int (*enable_vblank) (struct drm_device *dev, unsigned int pipe); 151 152 /** 153 * @disable_vblank: 154 * 155 * Disable vblank interrupts for the CRTC specified with the pipe 156 * argument. 157 */ 158 void (*disable_vblank) (struct drm_device *dev, unsigned int pipe); 159 160 /** 161 * @get_scanout_position: 162 * 163 * Called by vblank timestamping code. 164 * 165 * Returns the current display scanout position from a crtc, and an 166 * optional accurate ktime_get() timestamp of when position was 167 * measured. Note that this is a helper callback which is only used if a 168 * driver uses drm_calc_vbltimestamp_from_scanoutpos() for the 169 * @get_vblank_timestamp callback. 170 * 171 * Parameters: 172 * 173 * dev: 174 * DRM device. 175 * pipe: 176 * Id of the crtc to query. 177 * flags: 178 * Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0). 179 * vpos: 180 * Target location for current vertical scanout position. 181 * hpos: 182 * Target location for current horizontal scanout position. 183 * stime: 184 * Target location for timestamp taken immediately before 185 * scanout position query. Can be NULL to skip timestamp. 186 * etime: 187 * Target location for timestamp taken immediately after 188 * scanout position query. Can be NULL to skip timestamp. 189 * mode: 190 * Current display timings. 191 * 192 * Returns vpos as a positive number while in active scanout area. 193 * Returns vpos as a negative number inside vblank, counting the number 194 * of scanlines to go until end of vblank, e.g., -1 means "one scanline 195 * until start of active scanout / end of vblank." 196 * 197 * Returns: 198 * 199 * Flags, or'ed together as follows: 200 * 201 * DRM_SCANOUTPOS_VALID: 202 * Query successful. 203 * DRM_SCANOUTPOS_INVBL: 204 * Inside vblank. 205 * DRM_SCANOUTPOS_ACCURATE: Returned position is accurate. A lack of 206 * this flag means that returned position may be offset by a 207 * constant but unknown small number of scanlines wrt. real scanout 208 * position. 209 * 210 */ 211 int (*get_scanout_position) (struct drm_device *dev, unsigned int pipe, 212 unsigned int flags, int *vpos, int *hpos, 213 ktime_t *stime, ktime_t *etime, 214 const struct drm_display_mode *mode); 215 216 /** 217 * @get_vblank_timestamp: 218 * 219 * Called by drm_get_last_vbltimestamp(). Should return a precise 220 * timestamp when the most recent VBLANK interval ended or will end. 221 * 222 * Specifically, the timestamp in @vblank_time should correspond as 223 * closely as possible to the time when the first video scanline of 224 * the video frame after the end of VBLANK will start scanning out, 225 * the time immediately after end of the VBLANK interval. If the 226 * @crtc is currently inside VBLANK, this will be a time in the future. 227 * If the @crtc is currently scanning out a frame, this will be the 228 * past start time of the current scanout. This is meant to adhere 229 * to the OpenML OML_sync_control extension specification. 230 * 231 * Paramters: 232 * 233 * dev: 234 * dev DRM device handle. 235 * pipe: 236 * crtc for which timestamp should be returned. 237 * max_error: 238 * Maximum allowable timestamp error in nanoseconds. 239 * Implementation should strive to provide timestamp 240 * with an error of at most max_error nanoseconds. 241 * Returns true upper bound on error for timestamp. 242 * vblank_time: 243 * Target location for returned vblank timestamp. 244 * flags: 245 * 0 = Defaults, no special treatment needed. 246 * DRM_CALLED_FROM_VBLIRQ = Function is called from vblank 247 * irq handler. Some drivers need to apply some workarounds 248 * for gpu-specific vblank irq quirks if flag is set. 249 * 250 * Returns: 251 * 252 * Zero if timestamping isn't supported in current display mode or a 253 * negative number on failure. A positive status code on success, 254 * which describes how the vblank_time timestamp was computed. 255 */ 256 int (*get_vblank_timestamp) (struct drm_device *dev, unsigned int pipe, 257 int *max_error, 258 struct timeval *vblank_time, 259 unsigned flags); 260 261 /* these have to be filled in */ 262 263 irqreturn_t(*irq_handler) (int irq, void *arg); 264 void (*irq_preinstall) (struct drm_device *dev); 265 int (*irq_postinstall) (struct drm_device *dev); 266 void (*irq_uninstall) (struct drm_device *dev); 267 268 /** 269 * @master_create: 270 * 271 * Called whenever a new master is created. Only used by vmwgfx. 272 */ 273 int (*master_create)(struct drm_device *dev, struct drm_master *master); 274 275 /** 276 * @master_destroy: 277 * 278 * Called whenever a master is destroyed. Only used by vmwgfx. 279 */ 280 void (*master_destroy)(struct drm_device *dev, struct drm_master *master); 281 282 /** 283 * @master_set: 284 * 285 * Called whenever the minor master is set. Only used by vmwgfx. 286 */ 287 int (*master_set)(struct drm_device *dev, struct drm_file *file_priv, 288 bool from_open); 289 /** 290 * @master_drop: 291 * 292 * Called whenever the minor master is dropped. Only used by vmwgfx. 293 */ 294 void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv); 295 296 int (*debugfs_init)(struct drm_minor *minor); 297 void (*debugfs_cleanup)(struct drm_minor *minor); 298 299 /** 300 * @gem_free_object: deconstructor for drm_gem_objects 301 * 302 * This is deprecated and should not be used by new drivers. Use 303 * @gem_free_object_unlocked instead. 304 */ 305 void (*gem_free_object) (struct drm_gem_object *obj); 306 307 /** 308 * @gem_free_object_unlocked: deconstructor for drm_gem_objects 309 * 310 * This is for drivers which are not encumbered with &drm_device.struct_mutex 311 * legacy locking schemes. Use this hook instead of @gem_free_object. 312 */ 313 void (*gem_free_object_unlocked) (struct drm_gem_object *obj); 314 315 int (*gem_open_object) (struct drm_gem_object *, struct drm_file *); 316 void (*gem_close_object) (struct drm_gem_object *, struct drm_file *); 317 318 /** 319 * @gem_create_object: constructor for gem objects 320 * 321 * Hook for allocating the GEM object struct, for use by core 322 * helpers. 323 */ 324 struct drm_gem_object *(*gem_create_object)(struct drm_device *dev, 325 size_t size); 326 327 /* prime: */ 328 /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */ 329 int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv, 330 uint32_t handle, uint32_t flags, int *prime_fd); 331 /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */ 332 int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv, 333 int prime_fd, uint32_t *handle); 334 /* export GEM -> dmabuf */ 335 struct dma_buf * (*gem_prime_export)(struct drm_device *dev, 336 struct drm_gem_object *obj, int flags); 337 /* import dmabuf -> GEM */ 338 struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev, 339 struct dma_buf *dma_buf); 340 /* low-level interface used by drm_gem_prime_{import,export} */ 341 int (*gem_prime_pin)(struct drm_gem_object *obj); 342 void (*gem_prime_unpin)(struct drm_gem_object *obj); 343 struct reservation_object * (*gem_prime_res_obj)( 344 struct drm_gem_object *obj); 345 struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj); 346 struct drm_gem_object *(*gem_prime_import_sg_table)( 347 struct drm_device *dev, 348 struct dma_buf_attachment *attach, 349 struct sg_table *sgt); 350 void *(*gem_prime_vmap)(struct drm_gem_object *obj); 351 void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr); 352 int (*gem_prime_mmap)(struct drm_gem_object *obj, 353 struct vm_area_struct *vma); 354 355 /** 356 * @dumb_create: 357 * 358 * This creates a new dumb buffer in the driver's backing storage manager (GEM, 359 * TTM or something else entirely) and returns the resulting buffer handle. This 360 * handle can then be wrapped up into a framebuffer modeset object. 361 * 362 * Note that userspace is not allowed to use such objects for render 363 * acceleration - drivers must create their own private ioctls for such a use 364 * case. 365 * 366 * Width, height and depth are specified in the &drm_mode_create_dumb 367 * argument. The callback needs to fill the handle, pitch and size for 368 * the created buffer. 369 * 370 * Called by the user via ioctl. 371 * 372 * Returns: 373 * 374 * Zero on success, negative errno on failure. 375 */ 376 int (*dumb_create)(struct drm_file *file_priv, 377 struct drm_device *dev, 378 struct drm_mode_create_dumb *args); 379 /** 380 * @dumb_map_offset: 381 * 382 * Allocate an offset in the drm device node's address space to be able to 383 * memory map a dumb buffer. GEM-based drivers must use 384 * drm_gem_create_mmap_offset() to implement this. 385 * 386 * Called by the user via ioctl. 387 * 388 * Returns: 389 * 390 * Zero on success, negative errno on failure. 391 */ 392 int (*dumb_map_offset)(struct drm_file *file_priv, 393 struct drm_device *dev, uint32_t handle, 394 uint64_t *offset); 395 /** 396 * @dumb_destroy: 397 * 398 * This destroys the userspace handle for the given dumb backing storage buffer. 399 * Since buffer objects must be reference counted in the kernel a buffer object 400 * won't be immediately freed if a framebuffer modeset object still uses it. 401 * 402 * Called by the user via ioctl. 403 * 404 * Returns: 405 * 406 * Zero on success, negative errno on failure. 407 */ 408 int (*dumb_destroy)(struct drm_file *file_priv, 409 struct drm_device *dev, 410 uint32_t handle); 411 412 /* Driver private ops for this object */ 413 const struct vm_operations_struct *gem_vm_ops; 414 415 int major; 416 int minor; 417 int patchlevel; 418 char *name; 419 char *desc; 420 char *date; 421 422 u32 driver_features; 423 const struct drm_ioctl_desc *ioctls; 424 int num_ioctls; 425 const struct file_operations *fops; 426 427 /* Everything below here is for legacy driver, never use! */ 428 /* private: */ 429 430 /* List of devices hanging off this driver with stealth attach. */ 431 struct list_head legacy_dev_list; 432 int (*firstopen) (struct drm_device *); 433 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv); 434 int (*dma_quiescent) (struct drm_device *); 435 int (*context_dtor) (struct drm_device *dev, int context); 436 int dev_priv_size; 437 }; 438 439 extern __printf(6, 7) 440 void drm_dev_printk(const struct device *dev, const char *level, 441 unsigned int category, const char *function_name, 442 const char *prefix, const char *format, ...); 443 extern __printf(3, 4) 444 void drm_printk(const char *level, unsigned int category, 445 const char *format, ...); 446 extern unsigned int drm_debug; 447 448 int drm_dev_init(struct drm_device *dev, 449 struct drm_driver *driver, 450 struct device *parent); 451 void drm_dev_fini(struct drm_device *dev); 452 453 struct drm_device *drm_dev_alloc(struct drm_driver *driver, 454 struct device *parent); 455 int drm_dev_register(struct drm_device *dev, unsigned long flags); 456 void drm_dev_unregister(struct drm_device *dev); 457 458 void drm_dev_ref(struct drm_device *dev); 459 void drm_dev_unref(struct drm_device *dev); 460 void drm_put_dev(struct drm_device *dev); 461 void drm_unplug_dev(struct drm_device *dev); 462 463 int drm_dev_set_unique(struct drm_device *dev, const char *name); 464 465 466 #endif 467