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