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