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