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