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 /** 69 * @load: 70 * 71 * Backward-compatible driver callback to complete 72 * initialization steps after the driver is registered. For 73 * this reason, may suffer from race conditions and its use is 74 * deprecated for new drivers. It is therefore only supported 75 * for existing drivers not yet converted to the new scheme. 76 * See drm_dev_init() and drm_dev_register() for proper and 77 * race-free way to set up a &struct drm_device. 78 * 79 * Returns: 80 * 81 * Zero on success, non-zero value on failure. 82 */ 83 int (*load) (struct drm_device *, unsigned long flags); 84 int (*open) (struct drm_device *, struct drm_file *); 85 void (*preclose) (struct drm_device *, struct drm_file *file_priv); 86 void (*postclose) (struct drm_device *, struct drm_file *); 87 void (*lastclose) (struct drm_device *); 88 89 /** 90 * @unload: 91 * 92 * Reverse the effects of the driver load callback. Ideally, 93 * the clean up performed by the driver should happen in the 94 * reverse order of the initialization. Similarly to the load 95 * hook, this handler is deprecated and its usage should be 96 * dropped in favor of an open-coded teardown function at the 97 * driver layer. See drm_dev_unregister() and drm_dev_unref() 98 * for the proper way to remove a &struct drm_device. 99 * 100 * The unload() hook is called right after unregistering 101 * the device. 102 * 103 */ 104 void (*unload) (struct drm_device *); 105 106 /** 107 * @release: 108 * 109 * Optional callback for destroying device data after the final 110 * reference is released, i.e. the device is being destroyed. Drivers 111 * using this callback are responsible for calling drm_dev_fini() 112 * to finalize the device and then freeing the struct themselves. 113 */ 114 void (*release) (struct drm_device *); 115 116 int (*set_busid)(struct drm_device *dev, struct drm_master *master); 117 118 /** 119 * @get_vblank_counter: 120 * 121 * Driver callback for fetching a raw hardware vblank counter for the 122 * CRTC specified with the pipe argument. If a device doesn't have a 123 * hardware counter, the driver can simply leave the hook as NULL. 124 * The DRM core will account for missed vblank events while interrupts 125 * where disabled based on system timestamps. 126 * 127 * Wraparound handling and loss of events due to modesetting is dealt 128 * with in the DRM core code, as long as drivers call 129 * drm_crtc_vblank_off() and drm_crtc_vblank_on() when disabling or 130 * enabling a CRTC. 131 * 132 * This is deprecated and should not be used by new drivers. 133 * Use &drm_crtc_funcs.get_vblank_counter instead. 134 * 135 * Returns: 136 * 137 * Raw vblank counter value. 138 */ 139 u32 (*get_vblank_counter) (struct drm_device *dev, unsigned int pipe); 140 141 /** 142 * @enable_vblank: 143 * 144 * Enable vblank interrupts for the CRTC specified with the pipe 145 * argument. 146 * 147 * This is deprecated and should not be used by new drivers. 148 * Use &drm_crtc_funcs.enable_vblank instead. 149 * 150 * Returns: 151 * 152 * Zero on success, appropriate errno if the given @crtc's vblank 153 * interrupt cannot be enabled. 154 */ 155 int (*enable_vblank) (struct drm_device *dev, unsigned int pipe); 156 157 /** 158 * @disable_vblank: 159 * 160 * Disable vblank interrupts for the CRTC specified with the pipe 161 * argument. 162 * 163 * This is deprecated and should not be used by new drivers. 164 * Use &drm_crtc_funcs.disable_vblank instead. 165 */ 166 void (*disable_vblank) (struct drm_device *dev, unsigned int pipe); 167 168 /** 169 * @get_scanout_position: 170 * 171 * Called by vblank timestamping code. 172 * 173 * Returns the current display scanout position from a crtc, and an 174 * optional accurate ktime_get() timestamp of when position was 175 * measured. Note that this is a helper callback which is only used if a 176 * driver uses drm_calc_vbltimestamp_from_scanoutpos() for the 177 * @get_vblank_timestamp callback. 178 * 179 * Parameters: 180 * 181 * dev: 182 * DRM device. 183 * pipe: 184 * Id of the crtc to query. 185 * flags: 186 * Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0). 187 * vpos: 188 * Target location for current vertical scanout position. 189 * hpos: 190 * Target location for current horizontal scanout position. 191 * stime: 192 * Target location for timestamp taken immediately before 193 * scanout position query. Can be NULL to skip timestamp. 194 * etime: 195 * Target location for timestamp taken immediately after 196 * scanout position query. Can be NULL to skip timestamp. 197 * mode: 198 * Current display timings. 199 * 200 * Returns vpos as a positive number while in active scanout area. 201 * Returns vpos as a negative number inside vblank, counting the number 202 * of scanlines to go until end of vblank, e.g., -1 means "one scanline 203 * until start of active scanout / end of vblank." 204 * 205 * Returns: 206 * 207 * Flags, or'ed together as follows: 208 * 209 * DRM_SCANOUTPOS_VALID: 210 * Query successful. 211 * DRM_SCANOUTPOS_INVBL: 212 * Inside vblank. 213 * DRM_SCANOUTPOS_ACCURATE: Returned position is accurate. A lack of 214 * this flag means that returned position may be offset by a 215 * constant but unknown small number of scanlines wrt. real scanout 216 * position. 217 * 218 */ 219 int (*get_scanout_position) (struct drm_device *dev, unsigned int pipe, 220 unsigned int flags, int *vpos, int *hpos, 221 ktime_t *stime, ktime_t *etime, 222 const struct drm_display_mode *mode); 223 224 /** 225 * @get_vblank_timestamp: 226 * 227 * Called by drm_get_last_vbltimestamp(). Should return a precise 228 * timestamp when the most recent VBLANK interval ended or will end. 229 * 230 * Specifically, the timestamp in @vblank_time should correspond as 231 * closely as possible to the time when the first video scanline of 232 * the video frame after the end of VBLANK will start scanning out, 233 * the time immediately after end of the VBLANK interval. If the 234 * @crtc is currently inside VBLANK, this will be a time in the future. 235 * If the @crtc is currently scanning out a frame, this will be the 236 * past start time of the current scanout. This is meant to adhere 237 * to the OpenML OML_sync_control extension specification. 238 * 239 * Paramters: 240 * 241 * dev: 242 * dev DRM device handle. 243 * pipe: 244 * crtc for which timestamp should be returned. 245 * max_error: 246 * Maximum allowable timestamp error in nanoseconds. 247 * Implementation should strive to provide timestamp 248 * with an error of at most max_error nanoseconds. 249 * Returns true upper bound on error for timestamp. 250 * vblank_time: 251 * Target location for returned vblank timestamp. 252 * flags: 253 * 0 = Defaults, no special treatment needed. 254 * DRM_CALLED_FROM_VBLIRQ = Function is called from vblank 255 * irq handler. Some drivers need to apply some workarounds 256 * for gpu-specific vblank irq quirks if flag is set. 257 * 258 * Returns: 259 * 260 * Zero if timestamping isn't supported in current display mode or a 261 * negative number on failure. A positive status code on success, 262 * which describes how the vblank_time timestamp was computed. 263 */ 264 int (*get_vblank_timestamp) (struct drm_device *dev, unsigned int pipe, 265 int *max_error, 266 struct timeval *vblank_time, 267 unsigned flags); 268 269 /* these have to be filled in */ 270 271 irqreturn_t(*irq_handler) (int irq, void *arg); 272 void (*irq_preinstall) (struct drm_device *dev); 273 int (*irq_postinstall) (struct drm_device *dev); 274 void (*irq_uninstall) (struct drm_device *dev); 275 276 /** 277 * @master_create: 278 * 279 * Called whenever a new master is created. Only used by vmwgfx. 280 */ 281 int (*master_create)(struct drm_device *dev, struct drm_master *master); 282 283 /** 284 * @master_destroy: 285 * 286 * Called whenever a master is destroyed. Only used by vmwgfx. 287 */ 288 void (*master_destroy)(struct drm_device *dev, struct drm_master *master); 289 290 /** 291 * @master_set: 292 * 293 * Called whenever the minor master is set. Only used by vmwgfx. 294 */ 295 int (*master_set)(struct drm_device *dev, struct drm_file *file_priv, 296 bool from_open); 297 /** 298 * @master_drop: 299 * 300 * Called whenever the minor master is dropped. Only used by vmwgfx. 301 */ 302 void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv); 303 304 int (*debugfs_init)(struct drm_minor *minor); 305 void (*debugfs_cleanup)(struct drm_minor *minor); 306 307 /** 308 * @gem_free_object: deconstructor for drm_gem_objects 309 * 310 * This is deprecated and should not be used by new drivers. Use 311 * @gem_free_object_unlocked instead. 312 */ 313 void (*gem_free_object) (struct drm_gem_object *obj); 314 315 /** 316 * @gem_free_object_unlocked: deconstructor for drm_gem_objects 317 * 318 * This is for drivers which are not encumbered with &drm_device.struct_mutex 319 * legacy locking schemes. Use this hook instead of @gem_free_object. 320 */ 321 void (*gem_free_object_unlocked) (struct drm_gem_object *obj); 322 323 int (*gem_open_object) (struct drm_gem_object *, struct drm_file *); 324 void (*gem_close_object) (struct drm_gem_object *, struct drm_file *); 325 326 /** 327 * @gem_create_object: constructor for gem objects 328 * 329 * Hook for allocating the GEM object struct, for use by core 330 * helpers. 331 */ 332 struct drm_gem_object *(*gem_create_object)(struct drm_device *dev, 333 size_t size); 334 335 /* prime: */ 336 /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */ 337 int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv, 338 uint32_t handle, uint32_t flags, int *prime_fd); 339 /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */ 340 int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv, 341 int prime_fd, uint32_t *handle); 342 /* export GEM -> dmabuf */ 343 struct dma_buf * (*gem_prime_export)(struct drm_device *dev, 344 struct drm_gem_object *obj, int flags); 345 /* import dmabuf -> GEM */ 346 struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev, 347 struct dma_buf *dma_buf); 348 /* low-level interface used by drm_gem_prime_{import,export} */ 349 int (*gem_prime_pin)(struct drm_gem_object *obj); 350 void (*gem_prime_unpin)(struct drm_gem_object *obj); 351 struct reservation_object * (*gem_prime_res_obj)( 352 struct drm_gem_object *obj); 353 struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj); 354 struct drm_gem_object *(*gem_prime_import_sg_table)( 355 struct drm_device *dev, 356 struct dma_buf_attachment *attach, 357 struct sg_table *sgt); 358 void *(*gem_prime_vmap)(struct drm_gem_object *obj); 359 void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr); 360 int (*gem_prime_mmap)(struct drm_gem_object *obj, 361 struct vm_area_struct *vma); 362 363 /** 364 * @dumb_create: 365 * 366 * This creates a new dumb buffer in the driver's backing storage manager (GEM, 367 * TTM or something else entirely) and returns the resulting buffer handle. This 368 * handle can then be wrapped up into a framebuffer modeset object. 369 * 370 * Note that userspace is not allowed to use such objects for render 371 * acceleration - drivers must create their own private ioctls for such a use 372 * case. 373 * 374 * Width, height and depth are specified in the &drm_mode_create_dumb 375 * argument. The callback needs to fill the handle, pitch and size for 376 * the created buffer. 377 * 378 * Called by the user via ioctl. 379 * 380 * Returns: 381 * 382 * Zero on success, negative errno on failure. 383 */ 384 int (*dumb_create)(struct drm_file *file_priv, 385 struct drm_device *dev, 386 struct drm_mode_create_dumb *args); 387 /** 388 * @dumb_map_offset: 389 * 390 * Allocate an offset in the drm device node's address space to be able to 391 * memory map a dumb buffer. GEM-based drivers must use 392 * drm_gem_create_mmap_offset() to implement this. 393 * 394 * Called by the user via ioctl. 395 * 396 * Returns: 397 * 398 * Zero on success, negative errno on failure. 399 */ 400 int (*dumb_map_offset)(struct drm_file *file_priv, 401 struct drm_device *dev, uint32_t handle, 402 uint64_t *offset); 403 /** 404 * @dumb_destroy: 405 * 406 * This destroys the userspace handle for the given dumb backing storage buffer. 407 * Since buffer objects must be reference counted in the kernel a buffer object 408 * won't be immediately freed if a framebuffer modeset object still uses it. 409 * 410 * Called by the user via ioctl. 411 * 412 * Returns: 413 * 414 * Zero on success, negative errno on failure. 415 */ 416 int (*dumb_destroy)(struct drm_file *file_priv, 417 struct drm_device *dev, 418 uint32_t handle); 419 420 /* Driver private ops for this object */ 421 const struct vm_operations_struct *gem_vm_ops; 422 423 int major; 424 int minor; 425 int patchlevel; 426 char *name; 427 char *desc; 428 char *date; 429 430 u32 driver_features; 431 const struct drm_ioctl_desc *ioctls; 432 int num_ioctls; 433 const struct file_operations *fops; 434 435 /* Everything below here is for legacy driver, never use! */ 436 /* private: */ 437 438 /* List of devices hanging off this driver with stealth attach. */ 439 struct list_head legacy_dev_list; 440 int (*firstopen) (struct drm_device *); 441 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv); 442 int (*dma_quiescent) (struct drm_device *); 443 int (*context_dtor) (struct drm_device *dev, int context); 444 int dev_priv_size; 445 }; 446 447 extern __printf(6, 7) 448 void drm_dev_printk(const struct device *dev, const char *level, 449 unsigned int category, const char *function_name, 450 const char *prefix, const char *format, ...); 451 extern __printf(3, 4) 452 void drm_printk(const char *level, unsigned int category, 453 const char *format, ...); 454 extern unsigned int drm_debug; 455 456 int drm_dev_init(struct drm_device *dev, 457 struct drm_driver *driver, 458 struct device *parent); 459 void drm_dev_fini(struct drm_device *dev); 460 461 struct drm_device *drm_dev_alloc(struct drm_driver *driver, 462 struct device *parent); 463 int drm_dev_register(struct drm_device *dev, unsigned long flags); 464 void drm_dev_unregister(struct drm_device *dev); 465 466 void drm_dev_ref(struct drm_device *dev); 467 void drm_dev_unref(struct drm_device *dev); 468 void drm_put_dev(struct drm_device *dev); 469 void drm_unplug_dev(struct drm_device *dev); 470 471 int drm_dev_set_unique(struct drm_device *dev, const char *name); 472 473 474 #endif 475