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