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 #define DRIVER_SYNCOBJ 0x40000 57 58 /** 59 * struct drm_driver - DRM driver structure 60 * 61 * This structure represent the common code for a family of cards. There will 62 * one drm_device for each card present in this family. It contains lots of 63 * vfunc entries, and a pile of those probably should be moved to more 64 * appropriate places like &drm_mode_config_funcs or into a new operations 65 * structure for GEM drivers. 66 */ 67 struct drm_driver { 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 * This is deprecated, do not use! 80 * 81 * Returns: 82 * 83 * Zero on success, non-zero value on failure. 84 */ 85 int (*load) (struct drm_device *, unsigned long flags); 86 87 /** 88 * @open: 89 * 90 * Driver callback when a new &struct drm_file is opened. Useful for 91 * setting up driver-private data structures like buffer allocators, 92 * execution contexts or similar things. Such driver-private resources 93 * must be released again in @postclose. 94 * 95 * Since the display/modeset side of DRM can only be owned by exactly 96 * one &struct drm_file (see &drm_file.is_master and &drm_device.master) 97 * there should never be a need to set up any modeset related resources 98 * in this callback. Doing so would be a driver design bug. 99 * 100 * Returns: 101 * 102 * 0 on success, a negative error code on failure, which will be 103 * promoted to userspace as the result of the open() system call. 104 */ 105 int (*open) (struct drm_device *, struct drm_file *); 106 107 /** 108 * @postclose: 109 * 110 * One of the driver callbacks when a new &struct drm_file is closed. 111 * Useful for tearing down driver-private data structures allocated in 112 * @open like buffer allocators, execution contexts or similar things. 113 * 114 * Since the display/modeset side of DRM can only be owned by exactly 115 * one &struct drm_file (see &drm_file.is_master and &drm_device.master) 116 * there should never be a need to tear down any modeset related 117 * resources in this callback. Doing so would be a driver design bug. 118 */ 119 void (*postclose) (struct drm_device *, struct drm_file *); 120 121 /** 122 * @lastclose: 123 * 124 * Called when the last &struct drm_file has been closed and there's 125 * currently no userspace client for the &struct drm_device. 126 * 127 * Modern drivers should only use this to force-restore the fbdev 128 * framebuffer using drm_fb_helper_restore_fbdev_mode_unlocked(). 129 * Anything else would indicate there's something seriously wrong. 130 * Modern drivers can also use this to execute delayed power switching 131 * state changes, e.g. in conjunction with the :ref:`vga_switcheroo` 132 * infrastructure. 133 * 134 * This is called after @postclose hook has been called. 135 * 136 * NOTE: 137 * 138 * All legacy drivers use this callback to de-initialize the hardware. 139 * This is purely because of the shadow-attach model, where the DRM 140 * kernel driver does not really own the hardware. Instead ownershipe is 141 * handled with the help of userspace through an inheritedly racy dance 142 * to set/unset the VT into raw mode. 143 * 144 * Legacy drivers initialize the hardware in the @firstopen callback, 145 * which isn't even called for modern drivers. 146 */ 147 void (*lastclose) (struct drm_device *); 148 149 /** 150 * @unload: 151 * 152 * Reverse the effects of the driver load callback. Ideally, 153 * the clean up performed by the driver should happen in the 154 * reverse order of the initialization. Similarly to the load 155 * hook, this handler is deprecated and its usage should be 156 * dropped in favor of an open-coded teardown function at the 157 * driver layer. See drm_dev_unregister() and drm_dev_unref() 158 * for the proper way to remove a &struct drm_device. 159 * 160 * The unload() hook is called right after unregistering 161 * the device. 162 * 163 */ 164 void (*unload) (struct drm_device *); 165 166 /** 167 * @release: 168 * 169 * Optional callback for destroying device data after the final 170 * reference is released, i.e. the device is being destroyed. Drivers 171 * using this callback are responsible for calling drm_dev_fini() 172 * to finalize the device and then freeing the struct themselves. 173 */ 174 void (*release) (struct drm_device *); 175 176 /** 177 * @get_vblank_counter: 178 * 179 * Driver callback for fetching a raw hardware vblank counter for the 180 * CRTC specified with the pipe argument. If a device doesn't have a 181 * hardware counter, the driver can simply leave the hook as NULL. 182 * The DRM core will account for missed vblank events while interrupts 183 * where disabled based on system timestamps. 184 * 185 * Wraparound handling and loss of events due to modesetting is dealt 186 * with in the DRM core code, as long as drivers call 187 * drm_crtc_vblank_off() and drm_crtc_vblank_on() when disabling or 188 * enabling a CRTC. 189 * 190 * This is deprecated and should not be used by new drivers. 191 * Use &drm_crtc_funcs.get_vblank_counter instead. 192 * 193 * Returns: 194 * 195 * Raw vblank counter value. 196 */ 197 u32 (*get_vblank_counter) (struct drm_device *dev, unsigned int pipe); 198 199 /** 200 * @enable_vblank: 201 * 202 * Enable vblank interrupts for the CRTC specified with the pipe 203 * argument. 204 * 205 * This is deprecated and should not be used by new drivers. 206 * Use &drm_crtc_funcs.enable_vblank instead. 207 * 208 * Returns: 209 * 210 * Zero on success, appropriate errno if the given @crtc's vblank 211 * interrupt cannot be enabled. 212 */ 213 int (*enable_vblank) (struct drm_device *dev, unsigned int pipe); 214 215 /** 216 * @disable_vblank: 217 * 218 * Disable vblank interrupts for the CRTC specified with the pipe 219 * argument. 220 * 221 * This is deprecated and should not be used by new drivers. 222 * Use &drm_crtc_funcs.disable_vblank instead. 223 */ 224 void (*disable_vblank) (struct drm_device *dev, unsigned int pipe); 225 226 /** 227 * @get_scanout_position: 228 * 229 * Called by vblank timestamping code. 230 * 231 * Returns the current display scanout position from a crtc, and an 232 * optional accurate ktime_get() timestamp of when position was 233 * measured. Note that this is a helper callback which is only used if a 234 * driver uses drm_calc_vbltimestamp_from_scanoutpos() for the 235 * @get_vblank_timestamp callback. 236 * 237 * Parameters: 238 * 239 * dev: 240 * DRM device. 241 * pipe: 242 * Id of the crtc to query. 243 * in_vblank_irq: 244 * True when called from drm_crtc_handle_vblank(). Some drivers 245 * need to apply some workarounds for gpu-specific vblank irq quirks 246 * if flag is set. 247 * vpos: 248 * Target location for current vertical scanout position. 249 * hpos: 250 * Target location for current horizontal scanout position. 251 * stime: 252 * Target location for timestamp taken immediately before 253 * scanout position query. Can be NULL to skip timestamp. 254 * etime: 255 * Target location for timestamp taken immediately after 256 * scanout position query. Can be NULL to skip timestamp. 257 * mode: 258 * Current display timings. 259 * 260 * Returns vpos as a positive number while in active scanout area. 261 * Returns vpos as a negative number inside vblank, counting the number 262 * of scanlines to go until end of vblank, e.g., -1 means "one scanline 263 * until start of active scanout / end of vblank." 264 * 265 * Returns: 266 * 267 * True on success, false if a reliable scanout position counter could 268 * not be read out. 269 * 270 * FIXME: 271 * 272 * Since this is a helper to implement @get_vblank_timestamp, we should 273 * move it to &struct drm_crtc_helper_funcs, like all the other 274 * helper-internal hooks. 275 */ 276 bool (*get_scanout_position) (struct drm_device *dev, unsigned int pipe, 277 bool in_vblank_irq, int *vpos, int *hpos, 278 ktime_t *stime, ktime_t *etime, 279 const struct drm_display_mode *mode); 280 281 /** 282 * @get_vblank_timestamp: 283 * 284 * Called by drm_get_last_vbltimestamp(). Should return a precise 285 * timestamp when the most recent VBLANK interval ended or will end. 286 * 287 * Specifically, the timestamp in @vblank_time should correspond as 288 * closely as possible to the time when the first video scanline of 289 * the video frame after the end of VBLANK will start scanning out, 290 * the time immediately after end of the VBLANK interval. If the 291 * @crtc is currently inside VBLANK, this will be a time in the future. 292 * If the @crtc is currently scanning out a frame, this will be the 293 * past start time of the current scanout. This is meant to adhere 294 * to the OpenML OML_sync_control extension specification. 295 * 296 * Paramters: 297 * 298 * dev: 299 * dev DRM device handle. 300 * pipe: 301 * crtc for which timestamp should be returned. 302 * max_error: 303 * Maximum allowable timestamp error in nanoseconds. 304 * Implementation should strive to provide timestamp 305 * with an error of at most max_error nanoseconds. 306 * Returns true upper bound on error for timestamp. 307 * vblank_time: 308 * Target location for returned vblank timestamp. 309 * in_vblank_irq: 310 * True when called from drm_crtc_handle_vblank(). Some drivers 311 * need to apply some workarounds for gpu-specific vblank irq quirks 312 * if flag is set. 313 * 314 * Returns: 315 * 316 * True on success, false on failure, which means the core should 317 * fallback to a simple timestamp taken in drm_crtc_handle_vblank(). 318 * 319 * FIXME: 320 * 321 * We should move this hook to &struct drm_crtc_funcs like all the other 322 * vblank hooks. 323 */ 324 bool (*get_vblank_timestamp) (struct drm_device *dev, unsigned int pipe, 325 int *max_error, 326 struct timeval *vblank_time, 327 bool in_vblank_irq); 328 329 /** 330 * @irq_handler: 331 * 332 * Interrupt handler called when using drm_irq_install(). Not used by 333 * drivers which implement their own interrupt handling. 334 */ 335 irqreturn_t(*irq_handler) (int irq, void *arg); 336 337 /** 338 * @irq_preinstall: 339 * 340 * Optional callback used by drm_irq_install() which is called before 341 * the interrupt handler is registered. This should be used to clear out 342 * any pending interrupts (from e.g. firmware based drives) and reset 343 * the interrupt handling registers. 344 */ 345 void (*irq_preinstall) (struct drm_device *dev); 346 347 /** 348 * @irq_postinstall: 349 * 350 * Optional callback used by drm_irq_install() which is called after 351 * the interrupt handler is registered. This should be used to enable 352 * interrupt generation in the hardware. 353 */ 354 int (*irq_postinstall) (struct drm_device *dev); 355 356 /** 357 * @irq_uninstall: 358 * 359 * Optional callback used by drm_irq_uninstall() which is called before 360 * the interrupt handler is unregistered. This should be used to disable 361 * interrupt generation in the hardware. 362 */ 363 void (*irq_uninstall) (struct drm_device *dev); 364 365 /** 366 * @master_create: 367 * 368 * Called whenever a new master is created. Only used by vmwgfx. 369 */ 370 int (*master_create)(struct drm_device *dev, struct drm_master *master); 371 372 /** 373 * @master_destroy: 374 * 375 * Called whenever a master is destroyed. Only used by vmwgfx. 376 */ 377 void (*master_destroy)(struct drm_device *dev, struct drm_master *master); 378 379 /** 380 * @master_set: 381 * 382 * Called whenever the minor master is set. Only used by vmwgfx. 383 */ 384 int (*master_set)(struct drm_device *dev, struct drm_file *file_priv, 385 bool from_open); 386 /** 387 * @master_drop: 388 * 389 * Called whenever the minor master is dropped. Only used by vmwgfx. 390 */ 391 void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv); 392 393 int (*debugfs_init)(struct drm_minor *minor); 394 395 /** 396 * @gem_free_object: deconstructor for drm_gem_objects 397 * 398 * This is deprecated and should not be used by new drivers. Use 399 * @gem_free_object_unlocked instead. 400 */ 401 void (*gem_free_object) (struct drm_gem_object *obj); 402 403 /** 404 * @gem_free_object_unlocked: deconstructor for drm_gem_objects 405 * 406 * This is for drivers which are not encumbered with &drm_device.struct_mutex 407 * legacy locking schemes. Use this hook instead of @gem_free_object. 408 */ 409 void (*gem_free_object_unlocked) (struct drm_gem_object *obj); 410 411 int (*gem_open_object) (struct drm_gem_object *, struct drm_file *); 412 void (*gem_close_object) (struct drm_gem_object *, struct drm_file *); 413 414 /** 415 * @gem_create_object: constructor for gem objects 416 * 417 * Hook for allocating the GEM object struct, for use by core 418 * helpers. 419 */ 420 struct drm_gem_object *(*gem_create_object)(struct drm_device *dev, 421 size_t size); 422 423 /* prime: */ 424 /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */ 425 int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv, 426 uint32_t handle, uint32_t flags, int *prime_fd); 427 /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */ 428 int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv, 429 int prime_fd, uint32_t *handle); 430 /* export GEM -> dmabuf */ 431 struct dma_buf * (*gem_prime_export)(struct drm_device *dev, 432 struct drm_gem_object *obj, int flags); 433 /* import dmabuf -> GEM */ 434 struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev, 435 struct dma_buf *dma_buf); 436 /* low-level interface used by drm_gem_prime_{import,export} */ 437 int (*gem_prime_pin)(struct drm_gem_object *obj); 438 void (*gem_prime_unpin)(struct drm_gem_object *obj); 439 struct reservation_object * (*gem_prime_res_obj)( 440 struct drm_gem_object *obj); 441 struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj); 442 struct drm_gem_object *(*gem_prime_import_sg_table)( 443 struct drm_device *dev, 444 struct dma_buf_attachment *attach, 445 struct sg_table *sgt); 446 void *(*gem_prime_vmap)(struct drm_gem_object *obj); 447 void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr); 448 int (*gem_prime_mmap)(struct drm_gem_object *obj, 449 struct vm_area_struct *vma); 450 451 /** 452 * @dumb_create: 453 * 454 * This creates a new dumb buffer in the driver's backing storage manager (GEM, 455 * TTM or something else entirely) and returns the resulting buffer handle. This 456 * handle can then be wrapped up into a framebuffer modeset object. 457 * 458 * Note that userspace is not allowed to use such objects for render 459 * acceleration - drivers must create their own private ioctls for such a use 460 * case. 461 * 462 * Width, height and depth are specified in the &drm_mode_create_dumb 463 * argument. The callback needs to fill the handle, pitch and size for 464 * the created buffer. 465 * 466 * Called by the user via ioctl. 467 * 468 * Returns: 469 * 470 * Zero on success, negative errno on failure. 471 */ 472 int (*dumb_create)(struct drm_file *file_priv, 473 struct drm_device *dev, 474 struct drm_mode_create_dumb *args); 475 /** 476 * @dumb_map_offset: 477 * 478 * Allocate an offset in the drm device node's address space to be able to 479 * memory map a dumb buffer. GEM-based drivers must use 480 * drm_gem_create_mmap_offset() to implement this. 481 * 482 * Called by the user via ioctl. 483 * 484 * Returns: 485 * 486 * Zero on success, negative errno on failure. 487 */ 488 int (*dumb_map_offset)(struct drm_file *file_priv, 489 struct drm_device *dev, uint32_t handle, 490 uint64_t *offset); 491 /** 492 * @dumb_destroy: 493 * 494 * This destroys the userspace handle for the given dumb backing storage buffer. 495 * Since buffer objects must be reference counted in the kernel a buffer object 496 * won't be immediately freed if a framebuffer modeset object still uses it. 497 * 498 * Called by the user via ioctl. 499 * 500 * Returns: 501 * 502 * Zero on success, negative errno on failure. 503 */ 504 int (*dumb_destroy)(struct drm_file *file_priv, 505 struct drm_device *dev, 506 uint32_t handle); 507 508 /* Driver private ops for this object */ 509 const struct vm_operations_struct *gem_vm_ops; 510 511 int major; 512 int minor; 513 int patchlevel; 514 char *name; 515 char *desc; 516 char *date; 517 518 u32 driver_features; 519 520 /** 521 * @ioctls: 522 * 523 * Array of driver-private IOCTL description entries. See the chapter on 524 * :ref:`IOCTL support in the userland interfaces 525 * chapter<drm_driver_ioctl>` for the full details. 526 */ 527 528 const struct drm_ioctl_desc *ioctls; 529 /** @num_ioctls: Number of entries in @ioctls. */ 530 int num_ioctls; 531 532 /** 533 * @fops: 534 * 535 * File operations for the DRM device node. See the discussion in 536 * :ref:`file operations<drm_driver_fops>` for in-depth coverage and 537 * some examples. 538 */ 539 const struct file_operations *fops; 540 541 /* Everything below here is for legacy driver, never use! */ 542 /* private: */ 543 544 /* List of devices hanging off this driver with stealth attach. */ 545 struct list_head legacy_dev_list; 546 int (*firstopen) (struct drm_device *); 547 void (*preclose) (struct drm_device *, struct drm_file *file_priv); 548 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv); 549 int (*dma_quiescent) (struct drm_device *); 550 int (*context_dtor) (struct drm_device *dev, int context); 551 int dev_priv_size; 552 }; 553 554 __printf(6, 7) 555 void drm_dev_printk(const struct device *dev, const char *level, 556 unsigned int category, const char *function_name, 557 const char *prefix, const char *format, ...); 558 __printf(3, 4) 559 void drm_printk(const char *level, unsigned int category, 560 const char *format, ...); 561 extern unsigned int drm_debug; 562 563 int drm_dev_init(struct drm_device *dev, 564 struct drm_driver *driver, 565 struct device *parent); 566 void drm_dev_fini(struct drm_device *dev); 567 568 struct drm_device *drm_dev_alloc(struct drm_driver *driver, 569 struct device *parent); 570 int drm_dev_register(struct drm_device *dev, unsigned long flags); 571 void drm_dev_unregister(struct drm_device *dev); 572 573 void drm_dev_ref(struct drm_device *dev); 574 void drm_dev_unref(struct drm_device *dev); 575 void drm_put_dev(struct drm_device *dev); 576 void drm_unplug_dev(struct drm_device *dev); 577 578 int drm_dev_set_unique(struct drm_device *dev, const char *name); 579 580 581 #endif 582