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 #include <video/nomodeset.h> 34 35 #include <drm/drm_device.h> 36 37 struct drm_file; 38 struct drm_gem_object; 39 struct drm_master; 40 struct drm_minor; 41 struct dma_buf; 42 struct dma_buf_attachment; 43 struct drm_display_mode; 44 struct drm_mode_create_dumb; 45 struct drm_printer; 46 struct sg_table; 47 48 /** 49 * enum drm_driver_feature - feature flags 50 * 51 * See &drm_driver.driver_features, drm_device.driver_features and 52 * drm_core_check_feature(). 53 */ 54 enum drm_driver_feature { 55 /** 56 * @DRIVER_GEM: 57 * 58 * Driver use the GEM memory manager. This should be set for all modern 59 * drivers. 60 */ 61 DRIVER_GEM = BIT(0), 62 /** 63 * @DRIVER_MODESET: 64 * 65 * Driver supports mode setting interfaces (KMS). 66 */ 67 DRIVER_MODESET = BIT(1), 68 /** 69 * @DRIVER_RENDER: 70 * 71 * Driver supports dedicated render nodes. See also the :ref:`section on 72 * render nodes <drm_render_node>` for details. 73 */ 74 DRIVER_RENDER = BIT(3), 75 /** 76 * @DRIVER_ATOMIC: 77 * 78 * Driver supports the full atomic modesetting userspace API. Drivers 79 * which only use atomic internally, but do not support the full 80 * userspace API (e.g. not all properties converted to atomic, or 81 * multi-plane updates are not guaranteed to be tear-free) should not 82 * set this flag. 83 */ 84 DRIVER_ATOMIC = BIT(4), 85 /** 86 * @DRIVER_SYNCOBJ: 87 * 88 * Driver supports &drm_syncobj for explicit synchronization of command 89 * submission. 90 */ 91 DRIVER_SYNCOBJ = BIT(5), 92 /** 93 * @DRIVER_SYNCOBJ_TIMELINE: 94 * 95 * Driver supports the timeline flavor of &drm_syncobj for explicit 96 * synchronization of command submission. 97 */ 98 DRIVER_SYNCOBJ_TIMELINE = BIT(6), 99 100 /* IMPORTANT: Below are all the legacy flags, add new ones above. */ 101 102 /** 103 * @DRIVER_USE_AGP: 104 * 105 * Set up DRM AGP support, see drm_agp_init(), the DRM core will manage 106 * AGP resources. New drivers don't need this. 107 */ 108 DRIVER_USE_AGP = BIT(25), 109 /** 110 * @DRIVER_LEGACY: 111 * 112 * Denote a legacy driver using shadow attach. Do not use. 113 */ 114 DRIVER_LEGACY = BIT(26), 115 /** 116 * @DRIVER_PCI_DMA: 117 * 118 * Driver is capable of PCI DMA, mapping of PCI DMA buffers to userspace 119 * will be enabled. Only for legacy drivers. Do not use. 120 */ 121 DRIVER_PCI_DMA = BIT(27), 122 /** 123 * @DRIVER_SG: 124 * 125 * Driver can perform scatter/gather DMA, allocation and mapping of 126 * scatter/gather buffers will be enabled. Only for legacy drivers. Do 127 * not use. 128 */ 129 DRIVER_SG = BIT(28), 130 131 /** 132 * @DRIVER_HAVE_DMA: 133 * 134 * Driver supports DMA, the userspace DMA API will be supported. Only 135 * for legacy drivers. Do not use. 136 */ 137 DRIVER_HAVE_DMA = BIT(29), 138 /** 139 * @DRIVER_HAVE_IRQ: 140 * 141 * Legacy irq support. Only for legacy drivers. Do not use. 142 */ 143 DRIVER_HAVE_IRQ = BIT(30), 144 /** 145 * @DRIVER_KMS_LEGACY_CONTEXT: 146 * 147 * Used only by nouveau for backwards compatibility with existing 148 * userspace. Do not use. 149 */ 150 DRIVER_KMS_LEGACY_CONTEXT = BIT(31), 151 }; 152 153 /** 154 * struct drm_driver - DRM driver structure 155 * 156 * This structure represent the common code for a family of cards. There will be 157 * one &struct drm_device for each card present in this family. It contains lots 158 * of vfunc entries, and a pile of those probably should be moved to more 159 * appropriate places like &drm_mode_config_funcs or into a new operations 160 * structure for GEM drivers. 161 */ 162 struct drm_driver { 163 /** 164 * @load: 165 * 166 * Backward-compatible driver callback to complete initialization steps 167 * after the driver is registered. For this reason, may suffer from 168 * race conditions and its use is deprecated for new drivers. It is 169 * therefore only supported for existing drivers not yet converted to 170 * the new scheme. See devm_drm_dev_alloc() and drm_dev_register() for 171 * proper and race-free way to set up a &struct drm_device. 172 * 173 * This is deprecated, do not use! 174 * 175 * Returns: 176 * 177 * Zero on success, non-zero value on failure. 178 */ 179 int (*load) (struct drm_device *, unsigned long flags); 180 181 /** 182 * @open: 183 * 184 * Driver callback when a new &struct drm_file is opened. Useful for 185 * setting up driver-private data structures like buffer allocators, 186 * execution contexts or similar things. Such driver-private resources 187 * must be released again in @postclose. 188 * 189 * Since the display/modeset side of DRM can only be owned by exactly 190 * one &struct drm_file (see &drm_file.is_master and &drm_device.master) 191 * there should never be a need to set up any modeset related resources 192 * in this callback. Doing so would be a driver design bug. 193 * 194 * Returns: 195 * 196 * 0 on success, a negative error code on failure, which will be 197 * promoted to userspace as the result of the open() system call. 198 */ 199 int (*open) (struct drm_device *, struct drm_file *); 200 201 /** 202 * @postclose: 203 * 204 * One of the driver callbacks when a new &struct drm_file is closed. 205 * Useful for tearing down driver-private data structures allocated in 206 * @open like buffer allocators, execution contexts or similar things. 207 * 208 * Since the display/modeset side of DRM can only be owned by exactly 209 * one &struct drm_file (see &drm_file.is_master and &drm_device.master) 210 * there should never be a need to tear down any modeset related 211 * resources in this callback. Doing so would be a driver design bug. 212 */ 213 void (*postclose) (struct drm_device *, struct drm_file *); 214 215 /** 216 * @lastclose: 217 * 218 * Called when the last &struct drm_file has been closed and there's 219 * currently no userspace client for the &struct drm_device. 220 * 221 * Modern drivers should only use this to force-restore the fbdev 222 * framebuffer using drm_fb_helper_restore_fbdev_mode_unlocked(). 223 * Anything else would indicate there's something seriously wrong. 224 * Modern drivers can also use this to execute delayed power switching 225 * state changes, e.g. in conjunction with the :ref:`vga_switcheroo` 226 * infrastructure. 227 * 228 * This is called after @postclose hook has been called. 229 * 230 * NOTE: 231 * 232 * All legacy drivers use this callback to de-initialize the hardware. 233 * This is purely because of the shadow-attach model, where the DRM 234 * kernel driver does not really own the hardware. Instead ownershipe is 235 * handled with the help of userspace through an inheritedly racy dance 236 * to set/unset the VT into raw mode. 237 * 238 * Legacy drivers initialize the hardware in the @firstopen callback, 239 * which isn't even called for modern drivers. 240 */ 241 void (*lastclose) (struct drm_device *); 242 243 /** 244 * @unload: 245 * 246 * Reverse the effects of the driver load callback. Ideally, 247 * the clean up performed by the driver should happen in the 248 * reverse order of the initialization. Similarly to the load 249 * hook, this handler is deprecated and its usage should be 250 * dropped in favor of an open-coded teardown function at the 251 * driver layer. See drm_dev_unregister() and drm_dev_put() 252 * for the proper way to remove a &struct drm_device. 253 * 254 * The unload() hook is called right after unregistering 255 * the device. 256 * 257 */ 258 void (*unload) (struct drm_device *); 259 260 /** 261 * @release: 262 * 263 * Optional callback for destroying device data after the final 264 * reference is released, i.e. the device is being destroyed. 265 * 266 * This is deprecated, clean up all memory allocations associated with a 267 * &drm_device using drmm_add_action(), drmm_kmalloc() and related 268 * managed resources functions. 269 */ 270 void (*release) (struct drm_device *); 271 272 /** 273 * @master_set: 274 * 275 * Called whenever the minor master is set. Only used by vmwgfx. 276 */ 277 void (*master_set)(struct drm_device *dev, struct drm_file *file_priv, 278 bool from_open); 279 /** 280 * @master_drop: 281 * 282 * Called whenever the minor master is dropped. Only used by vmwgfx. 283 */ 284 void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv); 285 286 /** 287 * @debugfs_init: 288 * 289 * Allows drivers to create driver-specific debugfs files. 290 */ 291 void (*debugfs_init)(struct drm_minor *minor); 292 293 /** 294 * @gem_create_object: constructor for gem objects 295 * 296 * Hook for allocating the GEM object struct, for use by the CMA 297 * and SHMEM GEM helpers. Returns a GEM object on success, or an 298 * ERR_PTR()-encoded error code otherwise. 299 */ 300 struct drm_gem_object *(*gem_create_object)(struct drm_device *dev, 301 size_t size); 302 303 /** 304 * @prime_handle_to_fd: 305 * 306 * Main PRIME export function. Should be implemented with 307 * drm_gem_prime_handle_to_fd() for GEM based drivers. 308 * 309 * For an in-depth discussion see :ref:`PRIME buffer sharing 310 * documentation <prime_buffer_sharing>`. 311 */ 312 int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv, 313 uint32_t handle, uint32_t flags, int *prime_fd); 314 /** 315 * @prime_fd_to_handle: 316 * 317 * Main PRIME import function. Should be implemented with 318 * drm_gem_prime_fd_to_handle() for GEM based drivers. 319 * 320 * For an in-depth discussion see :ref:`PRIME buffer sharing 321 * documentation <prime_buffer_sharing>`. 322 */ 323 int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv, 324 int prime_fd, uint32_t *handle); 325 326 /** 327 * @gem_prime_import: 328 * 329 * Import hook for GEM drivers. 330 * 331 * This defaults to drm_gem_prime_import() if not set. 332 */ 333 struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev, 334 struct dma_buf *dma_buf); 335 /** 336 * @gem_prime_import_sg_table: 337 * 338 * Optional hook used by the PRIME helper functions 339 * drm_gem_prime_import() respectively drm_gem_prime_import_dev(). 340 */ 341 struct drm_gem_object *(*gem_prime_import_sg_table)( 342 struct drm_device *dev, 343 struct dma_buf_attachment *attach, 344 struct sg_table *sgt); 345 /** 346 * @gem_prime_mmap: 347 * 348 * mmap hook for GEM drivers, used to implement dma-buf mmap in the 349 * PRIME helpers. 350 * 351 * This hook only exists for historical reasons. Drivers must use 352 * drm_gem_prime_mmap() to implement it. 353 * 354 * FIXME: Convert all drivers to implement mmap in struct 355 * &drm_gem_object_funcs and inline drm_gem_prime_mmap() into 356 * its callers. This hook should be removed afterwards. 357 */ 358 int (*gem_prime_mmap)(struct drm_gem_object *obj, struct vm_area_struct *vma); 359 360 /** 361 * @dumb_create: 362 * 363 * This creates a new dumb buffer in the driver's backing storage manager (GEM, 364 * TTM or something else entirely) and returns the resulting buffer handle. This 365 * handle can then be wrapped up into a framebuffer modeset object. 366 * 367 * Note that userspace is not allowed to use such objects for render 368 * acceleration - drivers must create their own private ioctls for such a use 369 * case. 370 * 371 * Width, height and depth are specified in the &drm_mode_create_dumb 372 * argument. The callback needs to fill the handle, pitch and size for 373 * the created buffer. 374 * 375 * Called by the user via ioctl. 376 * 377 * Returns: 378 * 379 * Zero on success, negative errno on failure. 380 */ 381 int (*dumb_create)(struct drm_file *file_priv, 382 struct drm_device *dev, 383 struct drm_mode_create_dumb *args); 384 /** 385 * @dumb_map_offset: 386 * 387 * Allocate an offset in the drm device node's address space to be able to 388 * memory map a dumb buffer. 389 * 390 * The default implementation is drm_gem_create_mmap_offset(). GEM based 391 * drivers must not overwrite this. 392 * 393 * Called by the user via ioctl. 394 * 395 * Returns: 396 * 397 * Zero on success, negative errno on failure. 398 */ 399 int (*dumb_map_offset)(struct drm_file *file_priv, 400 struct drm_device *dev, uint32_t handle, 401 uint64_t *offset); 402 /** 403 * @dumb_destroy: 404 * 405 * This destroys the userspace handle for the given dumb backing storage buffer. 406 * Since buffer objects must be reference counted in the kernel a buffer object 407 * won't be immediately freed if a framebuffer modeset object still uses it. 408 * 409 * Called by the user via ioctl. 410 * 411 * The default implementation is drm_gem_dumb_destroy(). GEM based drivers 412 * must not overwrite this. 413 * 414 * Returns: 415 * 416 * Zero on success, negative errno on failure. 417 */ 418 int (*dumb_destroy)(struct drm_file *file_priv, 419 struct drm_device *dev, 420 uint32_t handle); 421 422 /** @major: driver major number */ 423 int major; 424 /** @minor: driver minor number */ 425 int minor; 426 /** @patchlevel: driver patch level */ 427 int patchlevel; 428 /** @name: driver name */ 429 char *name; 430 /** @desc: driver description */ 431 char *desc; 432 /** @date: driver date */ 433 char *date; 434 435 /** 436 * @driver_features: 437 * Driver features, see &enum drm_driver_feature. Drivers can disable 438 * some features on a per-instance basis using 439 * &drm_device.driver_features. 440 */ 441 u32 driver_features; 442 443 /** 444 * @ioctls: 445 * 446 * Array of driver-private IOCTL description entries. See the chapter on 447 * :ref:`IOCTL support in the userland interfaces 448 * chapter<drm_driver_ioctl>` for the full details. 449 */ 450 451 const struct drm_ioctl_desc *ioctls; 452 /** @num_ioctls: Number of entries in @ioctls. */ 453 int num_ioctls; 454 455 /** 456 * @fops: 457 * 458 * File operations for the DRM device node. See the discussion in 459 * :ref:`file operations<drm_driver_fops>` for in-depth coverage and 460 * some examples. 461 */ 462 const struct file_operations *fops; 463 464 #ifdef CONFIG_DRM_LEGACY 465 /* Everything below here is for legacy driver, never use! */ 466 /* private: */ 467 468 int (*firstopen) (struct drm_device *); 469 void (*preclose) (struct drm_device *, struct drm_file *file_priv); 470 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv); 471 int (*dma_quiescent) (struct drm_device *); 472 int (*context_dtor) (struct drm_device *dev, int context); 473 irqreturn_t (*irq_handler)(int irq, void *arg); 474 void (*irq_preinstall)(struct drm_device *dev); 475 int (*irq_postinstall)(struct drm_device *dev); 476 void (*irq_uninstall)(struct drm_device *dev); 477 u32 (*get_vblank_counter)(struct drm_device *dev, unsigned int pipe); 478 int (*enable_vblank)(struct drm_device *dev, unsigned int pipe); 479 void (*disable_vblank)(struct drm_device *dev, unsigned int pipe); 480 int dev_priv_size; 481 #endif 482 }; 483 484 void *__devm_drm_dev_alloc(struct device *parent, 485 const struct drm_driver *driver, 486 size_t size, size_t offset); 487 488 /** 489 * devm_drm_dev_alloc - Resource managed allocation of a &drm_device instance 490 * @parent: Parent device object 491 * @driver: DRM driver 492 * @type: the type of the struct which contains struct &drm_device 493 * @member: the name of the &drm_device within @type. 494 * 495 * This allocates and initialize a new DRM device. No device registration is done. 496 * Call drm_dev_register() to advertice the device to user space and register it 497 * with other core subsystems. This should be done last in the device 498 * initialization sequence to make sure userspace can't access an inconsistent 499 * state. 500 * 501 * The initial ref-count of the object is 1. Use drm_dev_get() and 502 * drm_dev_put() to take and drop further ref-counts. 503 * 504 * It is recommended that drivers embed &struct drm_device into their own device 505 * structure. 506 * 507 * Note that this manages the lifetime of the resulting &drm_device 508 * automatically using devres. The DRM device initialized with this function is 509 * automatically put on driver detach using drm_dev_put(). 510 * 511 * RETURNS: 512 * Pointer to new DRM device, or ERR_PTR on failure. 513 */ 514 #define devm_drm_dev_alloc(parent, driver, type, member) \ 515 ((type *) __devm_drm_dev_alloc(parent, driver, sizeof(type), \ 516 offsetof(type, member))) 517 518 struct drm_device *drm_dev_alloc(const struct drm_driver *driver, 519 struct device *parent); 520 int drm_dev_register(struct drm_device *dev, unsigned long flags); 521 void drm_dev_unregister(struct drm_device *dev); 522 523 void drm_dev_get(struct drm_device *dev); 524 void drm_dev_put(struct drm_device *dev); 525 void drm_put_dev(struct drm_device *dev); 526 bool drm_dev_enter(struct drm_device *dev, int *idx); 527 void drm_dev_exit(int idx); 528 void drm_dev_unplug(struct drm_device *dev); 529 530 /** 531 * drm_dev_is_unplugged - is a DRM device unplugged 532 * @dev: DRM device 533 * 534 * This function can be called to check whether a hotpluggable is unplugged. 535 * Unplugging itself is singalled through drm_dev_unplug(). If a device is 536 * unplugged, these two functions guarantee that any store before calling 537 * drm_dev_unplug() is visible to callers of this function after it completes 538 * 539 * WARNING: This function fundamentally races against drm_dev_unplug(). It is 540 * recommended that drivers instead use the underlying drm_dev_enter() and 541 * drm_dev_exit() function pairs. 542 */ 543 static inline bool drm_dev_is_unplugged(struct drm_device *dev) 544 { 545 int idx; 546 547 if (drm_dev_enter(dev, &idx)) { 548 drm_dev_exit(idx); 549 return false; 550 } 551 552 return true; 553 } 554 555 /** 556 * drm_core_check_all_features - check driver feature flags mask 557 * @dev: DRM device to check 558 * @features: feature flag(s) mask 559 * 560 * This checks @dev for driver features, see &drm_driver.driver_features, 561 * &drm_device.driver_features, and the various &enum drm_driver_feature flags. 562 * 563 * Returns true if all features in the @features mask are supported, false 564 * otherwise. 565 */ 566 static inline bool drm_core_check_all_features(const struct drm_device *dev, 567 u32 features) 568 { 569 u32 supported = dev->driver->driver_features & dev->driver_features; 570 571 return features && (supported & features) == features; 572 } 573 574 /** 575 * drm_core_check_feature - check driver feature flags 576 * @dev: DRM device to check 577 * @feature: feature flag 578 * 579 * This checks @dev for driver features, see &drm_driver.driver_features, 580 * &drm_device.driver_features, and the various &enum drm_driver_feature flags. 581 * 582 * Returns true if the @feature is supported, false otherwise. 583 */ 584 static inline bool drm_core_check_feature(const struct drm_device *dev, 585 enum drm_driver_feature feature) 586 { 587 return drm_core_check_all_features(dev, feature); 588 } 589 590 /** 591 * drm_drv_uses_atomic_modeset - check if the driver implements 592 * atomic_commit() 593 * @dev: DRM device 594 * 595 * This check is useful if drivers do not have DRIVER_ATOMIC set but 596 * have atomic modesetting internally implemented. 597 */ 598 static inline bool drm_drv_uses_atomic_modeset(struct drm_device *dev) 599 { 600 return drm_core_check_feature(dev, DRIVER_ATOMIC) || 601 (dev->mode_config.funcs && dev->mode_config.funcs->atomic_commit != NULL); 602 } 603 604 605 int drm_dev_set_unique(struct drm_device *dev, const char *name); 606 607 /* TODO: Inline drm_firmware_drivers_only() in all its callers. */ 608 static inline bool drm_firmware_drivers_only(void) 609 { 610 return video_firmware_drivers_only(); 611 } 612 613 #endif 614