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 #include <linux/uuid.h>
33
34 #include <drm/drm_device.h>
35
36 struct drm_file;
37 struct drm_gem_object;
38 struct drm_master;
39 struct drm_minor;
40 struct dma_buf_attachment;
41 struct drm_display_mode;
42 struct drm_mode_create_dumb;
43 struct drm_printer;
44
45 /**
46 * enum drm_driver_feature - feature flags
47 *
48 * See &drm_driver.driver_features, drm_device.driver_features and
49 * drm_core_check_feature().
50 */
51 enum drm_driver_feature {
52 /**
53 * @DRIVER_GEM:
54 *
55 * Driver use the GEM memory manager. This should be set for all modern
56 * drivers.
57 */
58 DRIVER_GEM = BIT(0),
59 /**
60 * @DRIVER_MODESET:
61 *
62 * Driver supports mode setting interfaces (KMS).
63 */
64 DRIVER_MODESET = BIT(1),
65 /**
66 * @DRIVER_RENDER:
67 *
68 * Driver supports dedicated render nodes. See also the :ref:`section on
69 * render nodes <drm_render_node>` for details.
70 */
71 DRIVER_RENDER = BIT(3),
72 /**
73 * @DRIVER_ATOMIC:
74 *
75 * Driver supports the full atomic modesetting userspace API. Drivers
76 * which only use atomic internally, but do not the support the full
77 * userspace API (e.g. not all properties converted to atomic, or
78 * multi-plane updates are not guaranteed to be tear-free) should not
79 * set this flag.
80 */
81 DRIVER_ATOMIC = BIT(4),
82 /**
83 * @DRIVER_SYNCOBJ:
84 *
85 * Driver supports &drm_syncobj for explicit synchronization of command
86 * submission.
87 */
88 DRIVER_SYNCOBJ = BIT(5),
89 /**
90 * @DRIVER_SYNCOBJ_TIMELINE:
91 *
92 * Driver supports the timeline flavor of &drm_syncobj for explicit
93 * synchronization of command submission.
94 */
95 DRIVER_SYNCOBJ_TIMELINE = BIT(6),
96
97 /* IMPORTANT: Below are all the legacy flags, add new ones above. */
98
99 /**
100 * @DRIVER_USE_AGP:
101 *
102 * Set up DRM AGP support, see drm_agp_init(), the DRM core will manage
103 * AGP resources. New drivers don't need this.
104 */
105 DRIVER_USE_AGP = BIT(25),
106 /**
107 * @DRIVER_LEGACY:
108 *
109 * Denote a legacy driver using shadow attach. Do not use.
110 */
111 DRIVER_LEGACY = BIT(26),
112 /**
113 * @DRIVER_PCI_DMA:
114 *
115 * Driver is capable of PCI DMA, mapping of PCI DMA buffers to userspace
116 * will be enabled. Only for legacy drivers. Do not use.
117 */
118 DRIVER_PCI_DMA = BIT(27),
119 /**
120 * @DRIVER_SG:
121 *
122 * Driver can perform scatter/gather DMA, allocation and mapping of
123 * scatter/gather buffers will be enabled. Only for legacy drivers. Do
124 * not use.
125 */
126 DRIVER_SG = BIT(28),
127
128 /**
129 * @DRIVER_HAVE_DMA:
130 *
131 * Driver supports DMA, the userspace DMA API will be supported. Only
132 * for legacy drivers. Do not use.
133 */
134 DRIVER_HAVE_DMA = BIT(29),
135 /**
136 * @DRIVER_HAVE_IRQ:
137 *
138 * Legacy irq support. Only for legacy drivers. Do not use.
139 *
140 * New drivers can either use the drm_irq_install() and
141 * drm_irq_uninstall() helper functions, or roll their own irq support
142 * code by calling request_irq() directly.
143 */
144 DRIVER_HAVE_IRQ = BIT(30),
145 /**
146 * @DRIVER_KMS_LEGACY_CONTEXT:
147 *
148 * Used only by nouveau for backwards compatibility with existing
149 * userspace. Do not use.
150 */
151 DRIVER_KMS_LEGACY_CONTEXT = BIT(31),
152 };
153
154 /**
155 * struct drm_driver - DRM driver structure
156 *
157 * This structure represent the common code for a family of cards. There will be
158 * one &struct drm_device for each card present in this family. It contains lots
159 * of vfunc entries, and a pile of those probably should be moved to more
160 * appropriate places like &drm_mode_config_funcs or into a new operations
161 * structure for GEM drivers.
162 */
163 struct drm_driver {
164 /**
165 * @load:
166 *
167 * Backward-compatible driver callback to complete
168 * initialization steps after the driver is registered. For
169 * this reason, may suffer from race conditions and its use is
170 * deprecated for new drivers. It is therefore only supported
171 * for existing drivers not yet converted to the new scheme.
172 * See drm_dev_init() and drm_dev_register() for proper and
173 * race-free way to set up a &struct drm_device.
174 *
175 * This is deprecated, do not use!
176 *
177 * Returns:
178 *
179 * Zero on success, non-zero value on failure.
180 */
181 int (*load) (struct drm_device *, unsigned long flags);
182
183 /**
184 * @open:
185 *
186 * Driver callback when a new &struct drm_file is opened. Useful for
187 * setting up driver-private data structures like buffer allocators,
188 * execution contexts or similar things. Such driver-private resources
189 * must be released again in @postclose.
190 *
191 * Since the display/modeset side of DRM can only be owned by exactly
192 * one &struct drm_file (see &drm_file.is_master and &drm_device.master)
193 * there should never be a need to set up any modeset related resources
194 * in this callback. Doing so would be a driver design bug.
195 *
196 * Returns:
197 *
198 * 0 on success, a negative error code on failure, which will be
199 * promoted to userspace as the result of the open() system call.
200 */
201 int (*open) (struct drm_device *, struct drm_file *);
202
203 /**
204 * @postclose:
205 *
206 * One of the driver callbacks when a new &struct drm_file is closed.
207 * Useful for tearing down driver-private data structures allocated in
208 * @open like buffer allocators, execution contexts or similar things.
209 *
210 * Since the display/modeset side of DRM can only be owned by exactly
211 * one &struct drm_file (see &drm_file.is_master and &drm_device.master)
212 * there should never be a need to tear down any modeset related
213 * resources in this callback. Doing so would be a driver design bug.
214 */
215 void (*postclose) (struct drm_device *, struct drm_file *);
216
217 /**
218 * @lastclose:
219 *
220 * Called when the last &struct drm_file has been closed and there's
221 * currently no userspace client for the &struct drm_device.
222 *
223 * Modern drivers should only use this to force-restore the fbdev
224 * framebuffer using drm_fb_helper_restore_fbdev_mode_unlocked().
225 * Anything else would indicate there's something seriously wrong.
226 * Modern drivers can also use this to execute delayed power switching
227 * state changes, e.g. in conjunction with the :ref:`vga_switcheroo`
228 * infrastructure.
229 *
230 * This is called after @postclose hook has been called.
231 *
232 * NOTE:
233 *
234 * All legacy drivers use this callback to de-initialize the hardware.
235 * This is purely because of the shadow-attach model, where the DRM
236 * kernel driver does not really own the hardware. Instead ownershipe is
237 * handled with the help of userspace through an inheritedly racy dance
238 * to set/unset the VT into raw mode.
239 *
240 * Legacy drivers initialize the hardware in the @firstopen callback,
241 * which isn't even called for modern drivers.
242 */
243 void (*lastclose) (struct drm_device *);
244
245 /**
246 * @unload:
247 *
248 * Reverse the effects of the driver load callback. Ideally,
249 * the clean up performed by the driver should happen in the
250 * reverse order of the initialization. Similarly to the load
251 * hook, this handler is deprecated and its usage should be
252 * dropped in favor of an open-coded teardown function at the
253 * driver layer. See drm_dev_unregister() and drm_dev_put()
254 * for the proper way to remove a &struct drm_device.
255 *
256 * The unload() hook is called right after unregistering
257 * the device.
258 *
259 */
260 void (*unload) (struct drm_device *);
261
262 /**
263 * @release:
264 *
265 * Optional callback for destroying device data after the final
266 * reference is released, i.e. the device is being destroyed. Drivers
267 * using this callback are responsible for calling drm_dev_fini()
268 * to finalize the device and then freeing the struct themselves.
269 */
270 void (*release) (struct drm_device *);
271
272 /**
273 * @get_vblank_counter:
274 *
275 * Driver callback for fetching a raw hardware vblank counter for the
276 * CRTC specified with the pipe argument. If a device doesn't have a
277 * hardware counter, the driver can simply leave the hook as NULL.
278 * The DRM core will account for missed vblank events while interrupts
279 * where disabled based on system timestamps.
280 *
281 * Wraparound handling and loss of events due to modesetting is dealt
282 * with in the DRM core code, as long as drivers call
283 * drm_crtc_vblank_off() and drm_crtc_vblank_on() when disabling or
284 * enabling a CRTC.
285 *
286 * This is deprecated and should not be used by new drivers.
287 * Use &drm_crtc_funcs.get_vblank_counter instead.
288 *
289 * Returns:
290 *
291 * Raw vblank counter value.
292 */
293 u32 (*get_vblank_counter) (struct drm_device *dev, unsigned int pipe);
294
295 /**
296 * @enable_vblank:
297 *
298 * Enable vblank interrupts for the CRTC specified with the pipe
299 * argument.
300 *
301 * This is deprecated and should not be used by new drivers.
302 * Use &drm_crtc_funcs.enable_vblank instead.
303 *
304 * Returns:
305 *
306 * Zero on success, appropriate errno if the given @crtc's vblank
307 * interrupt cannot be enabled.
308 */
309 int (*enable_vblank) (struct drm_device *dev, unsigned int pipe);
310
311 /**
312 * @disable_vblank:
313 *
314 * Disable vblank interrupts for the CRTC specified with the pipe
315 * argument.
316 *
317 * This is deprecated and should not be used by new drivers.
318 * Use &drm_crtc_funcs.disable_vblank instead.
319 */
320 void (*disable_vblank) (struct drm_device *dev, unsigned int pipe);
321
322 /**
323 * @get_scanout_position:
324 *
325 * Called by vblank timestamping code.
326 *
327 * Returns the current display scanout position from a crtc, and an
328 * optional accurate ktime_get() timestamp of when position was
329 * measured. Note that this is a helper callback which is only used if a
330 * driver uses drm_calc_vbltimestamp_from_scanoutpos() for the
331 * @get_vblank_timestamp callback.
332 *
333 * Parameters:
334 *
335 * dev:
336 * DRM device.
337 * pipe:
338 * Id of the crtc to query.
339 * in_vblank_irq:
340 * True when called from drm_crtc_handle_vblank(). Some drivers
341 * need to apply some workarounds for gpu-specific vblank irq quirks
342 * if flag is set.
343 * vpos:
344 * Target location for current vertical scanout position.
345 * hpos:
346 * Target location for current horizontal scanout position.
347 * stime:
348 * Target location for timestamp taken immediately before
349 * scanout position query. Can be NULL to skip timestamp.
350 * etime:
351 * Target location for timestamp taken immediately after
352 * scanout position query. Can be NULL to skip timestamp.
353 * mode:
354 * Current display timings.
355 *
356 * Returns vpos as a positive number while in active scanout area.
357 * Returns vpos as a negative number inside vblank, counting the number
358 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
359 * until start of active scanout / end of vblank."
360 *
361 * Returns:
362 *
363 * True on success, false if a reliable scanout position counter could
364 * not be read out.
365 *
366 * FIXME:
367 *
368 * Since this is a helper to implement @get_vblank_timestamp, we should
369 * move it to &struct drm_crtc_helper_funcs, like all the other
370 * helper-internal hooks.
371 */
372 bool (*get_scanout_position) (struct drm_device *dev, unsigned int pipe,
373 bool in_vblank_irq, int *vpos, int *hpos,
374 ktime_t *stime, ktime_t *etime,
375 const struct drm_display_mode *mode);
376
377 /**
378 * @get_vblank_timestamp:
379 *
380 * Called by drm_get_last_vbltimestamp(). Should return a precise
381 * timestamp when the most recent VBLANK interval ended or will end.
382 *
383 * Specifically, the timestamp in @vblank_time should correspond as
384 * closely as possible to the time when the first video scanline of
385 * the video frame after the end of VBLANK will start scanning out,
386 * the time immediately after end of the VBLANK interval. If the
387 * @crtc is currently inside VBLANK, this will be a time in the future.
388 * If the @crtc is currently scanning out a frame, this will be the
389 * past start time of the current scanout. This is meant to adhere
390 * to the OpenML OML_sync_control extension specification.
391 *
392 * Paramters:
393 *
394 * dev:
395 * dev DRM device handle.
396 * pipe:
397 * crtc for which timestamp should be returned.
398 * max_error:
399 * Maximum allowable timestamp error in nanoseconds.
400 * Implementation should strive to provide timestamp
401 * with an error of at most max_error nanoseconds.
402 * Returns true upper bound on error for timestamp.
403 * vblank_time:
404 * Target location for returned vblank timestamp.
405 * in_vblank_irq:
406 * True when called from drm_crtc_handle_vblank(). Some drivers
407 * need to apply some workarounds for gpu-specific vblank irq quirks
408 * if flag is set.
409 *
410 * Returns:
411 *
412 * True on success, false on failure, which means the core should
413 * fallback to a simple timestamp taken in drm_crtc_handle_vblank().
414 *
415 * FIXME:
416 *
417 * We should move this hook to &struct drm_crtc_funcs like all the other
418 * vblank hooks.
419 */
420 bool (*get_vblank_timestamp) (struct drm_device *dev, unsigned int pipe,
421 int *max_error,
422 ktime_t *vblank_time,
423 bool in_vblank_irq);
424
425 /**
426 * @irq_handler:
427 *
428 * Interrupt handler called when using drm_irq_install(). Not used by
429 * drivers which implement their own interrupt handling.
430 */
431 irqreturn_t(*irq_handler) (int irq, void *arg);
432
433 /**
434 * @irq_preinstall:
435 *
436 * Optional callback used by drm_irq_install() which is called before
437 * the interrupt handler is registered. This should be used to clear out
438 * any pending interrupts (from e.g. firmware based drives) and reset
439 * the interrupt handling registers.
440 */
441 void (*irq_preinstall) (struct drm_device *dev);
442
443 /**
444 * @irq_postinstall:
445 *
446 * Optional callback used by drm_irq_install() which is called after
447 * the interrupt handler is registered. This should be used to enable
448 * interrupt generation in the hardware.
449 */
450 int (*irq_postinstall) (struct drm_device *dev);
451
452 /**
453 * @irq_uninstall:
454 *
455 * Optional callback used by drm_irq_uninstall() which is called before
456 * the interrupt handler is unregistered. This should be used to disable
457 * interrupt generation in the hardware.
458 */
459 void (*irq_uninstall) (struct drm_device *dev);
460
461 /**
462 * @master_create:
463 *
464 * Called whenever a new master is created. Only used by vmwgfx.
465 */
466 int (*master_create)(struct drm_device *dev, struct drm_master *master);
467
468 /**
469 * @master_destroy:
470 *
471 * Called whenever a master is destroyed. Only used by vmwgfx.
472 */
473 void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
474
475 /**
476 * @master_set:
477 *
478 * Called whenever the minor master is set. Only used by vmwgfx.
479 */
480 int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
481 bool from_open);
482 /**
483 * @master_drop:
484 *
485 * Called whenever the minor master is dropped. Only used by vmwgfx.
486 */
487 void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv);
488
489 /**
490 * @debugfs_init:
491 *
492 * Allows drivers to create driver-specific debugfs files.
493 */
494 int (*debugfs_init)(struct drm_minor *minor);
495
496 /**
497 * @gem_free_object: deconstructor for drm_gem_objects
498 *
499 * This is deprecated and should not be used by new drivers. Use
500 * &drm_gem_object_funcs.free instead.
501 */
502 void (*gem_free_object) (struct drm_gem_object *obj);
503
504 /**
505 * @gem_free_object_unlocked: deconstructor for drm_gem_objects
506 *
507 * This is deprecated and should not be used by new drivers. Use
508 * &drm_gem_object_funcs.free instead.
509 * Compared to @gem_free_object this is not encumbered with
510 * &drm_device.struct_mutex legacy locking schemes.
511 */
512 void (*gem_free_object_unlocked) (struct drm_gem_object *obj);
513
514 /**
515 * @gem_open_object:
516 *
517 * This callback is deprecated in favour of &drm_gem_object_funcs.open.
518 *
519 * Driver hook called upon gem handle creation
520 */
521 int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
522
523 /**
524 * @gem_close_object:
525 *
526 * This callback is deprecated in favour of &drm_gem_object_funcs.close.
527 *
528 * Driver hook called upon gem handle release
529 */
530 void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
531
532 /**
533 * @gem_print_info:
534 *
535 * This callback is deprecated in favour of
536 * &drm_gem_object_funcs.print_info.
537 *
538 * If driver subclasses struct &drm_gem_object, it can implement this
539 * optional hook for printing additional driver specific info.
540 *
541 * drm_printf_indent() should be used in the callback passing it the
542 * indent argument.
543 *
544 * This callback is called from drm_gem_print_info().
545 */
546 void (*gem_print_info)(struct drm_printer *p, unsigned int indent,
547 const struct drm_gem_object *obj);
548
549 /**
550 * @gem_create_object: constructor for gem objects
551 *
552 * Hook for allocating the GEM object struct, for use by the CMA and
553 * SHMEM GEM helpers.
554 */
555 struct drm_gem_object *(*gem_create_object)(struct drm_device *dev,
556 size_t size);
557 /**
558 * @prime_handle_to_fd:
559 *
560 * Main PRIME export function. Should be implemented with
561 * drm_gem_prime_handle_to_fd() for GEM based drivers.
562 *
563 * For an in-depth discussion see :ref:`PRIME buffer sharing
564 * documentation <prime_buffer_sharing>`.
565 */
566 int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
567 uint32_t handle, uint32_t flags, int *prime_fd);
568 /**
569 * @prime_fd_to_handle:
570 *
571 * Main PRIME import function. Should be implemented with
572 * drm_gem_prime_fd_to_handle() for GEM based drivers.
573 *
574 * For an in-depth discussion see :ref:`PRIME buffer sharing
575 * documentation <prime_buffer_sharing>`.
576 */
577 int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
578 int prime_fd, uint32_t *handle);
579 /**
580 * @gem_prime_export:
581 *
582 * Export hook for GEM drivers. Deprecated in favour of
583 * &drm_gem_object_funcs.export.
584 */
585 struct dma_buf * (*gem_prime_export)(struct drm_gem_object *obj,
586 int flags);
587 /**
588 * @gem_prime_import:
589 *
590 * Import hook for GEM drivers.
591 *
592 * This defaults to drm_gem_prime_import() if not set.
593 */
594 struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
595 struct dma_buf *dma_buf);
596
597 /**
598 * @gem_prime_pin:
599 *
600 * Deprecated hook in favour of &drm_gem_object_funcs.pin.
601 */
602 int (*gem_prime_pin)(struct drm_gem_object *obj);
603
604 /**
605 * @gem_prime_unpin:
606 *
607 * Deprecated hook in favour of &drm_gem_object_funcs.unpin.
608 */
609 void (*gem_prime_unpin)(struct drm_gem_object *obj);
610
611
612 /**
613 * @gem_prime_get_sg_table:
614 *
615 * Deprecated hook in favour of &drm_gem_object_funcs.get_sg_table.
616 */
617 struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj);
618
619 /**
620 * @gem_prime_import_sg_table:
621 *
622 * Optional hook used by the PRIME helper functions
623 * drm_gem_prime_import() respectively drm_gem_prime_import_dev().
624 */
625 struct drm_gem_object *(*gem_prime_import_sg_table)(
626 struct drm_device *dev,
627 struct dma_buf_attachment *attach,
628 struct sg_table *sgt);
629 /**
630 * @gem_prime_vmap:
631 *
632 * Deprecated vmap hook for GEM drivers. Please use
633 * &drm_gem_object_funcs.vmap instead.
634 */
635 void *(*gem_prime_vmap)(struct drm_gem_object *obj);
636
637 /**
638 * @gem_prime_vunmap:
639 *
640 * Deprecated vunmap hook for GEM drivers. Please use
641 * &drm_gem_object_funcs.vunmap instead.
642 */
643 void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr);
644
645 /**
646 * @gem_prime_mmap:
647 *
648 * mmap hook for GEM drivers, used to implement dma-buf mmap in the
649 * PRIME helpers.
650 *
651 * FIXME: There's way too much duplication going on here, and also moved
652 * to &drm_gem_object_funcs.
653 */
654 int (*gem_prime_mmap)(struct drm_gem_object *obj,
655 struct vm_area_struct *vma);
656
657 /**
658 * @gem_prime_get_uuid
659 *
660 * get_uuid hook for GEM drivers. Retrieves the virtio uuid of the
661 * given GEM buffer.
662 */
663 int (*gem_prime_get_uuid)(struct drm_gem_object *obj,
664 uuid_t *uuid);
665
666 /**
667 * @dumb_create:
668 *
669 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
670 * TTM or something else entirely) and returns the resulting buffer handle. This
671 * handle can then be wrapped up into a framebuffer modeset object.
672 *
673 * Note that userspace is not allowed to use such objects for render
674 * acceleration - drivers must create their own private ioctls for such a use
675 * case.
676 *
677 * Width, height and depth are specified in the &drm_mode_create_dumb
678 * argument. The callback needs to fill the handle, pitch and size for
679 * the created buffer.
680 *
681 * Called by the user via ioctl.
682 *
683 * Returns:
684 *
685 * Zero on success, negative errno on failure.
686 */
687 int (*dumb_create)(struct drm_file *file_priv,
688 struct drm_device *dev,
689 struct drm_mode_create_dumb *args);
690 /**
691 * @dumb_map_offset:
692 *
693 * Allocate an offset in the drm device node's address space to be able to
694 * memory map a dumb buffer.
695 *
696 * The default implementation is drm_gem_create_mmap_offset(). GEM based
697 * drivers must not overwrite this.
698 *
699 * Called by the user via ioctl.
700 *
701 * Returns:
702 *
703 * Zero on success, negative errno on failure.
704 */
705 int (*dumb_map_offset)(struct drm_file *file_priv,
706 struct drm_device *dev, uint32_t handle,
707 uint64_t *offset);
708 /**
709 * @dumb_destroy:
710 *
711 * This destroys the userspace handle for the given dumb backing storage buffer.
712 * Since buffer objects must be reference counted in the kernel a buffer object
713 * won't be immediately freed if a framebuffer modeset object still uses it.
714 *
715 * Called by the user via ioctl.
716 *
717 * The default implementation is drm_gem_dumb_destroy(). GEM based drivers
718 * must not overwrite this.
719 *
720 * Returns:
721 *
722 * Zero on success, negative errno on failure.
723 */
724 int (*dumb_destroy)(struct drm_file *file_priv,
725 struct drm_device *dev,
726 uint32_t handle);
727
728 /**
729 * @gem_vm_ops: Driver private ops for this object
730 *
731 * For GEM drivers this is deprecated in favour of
732 * &drm_gem_object_funcs.vm_ops.
733 */
734 const struct vm_operations_struct *gem_vm_ops;
735
736 /** @major: driver major number */
737 int major;
738 /** @minor: driver minor number */
739 int minor;
740 /** @patchlevel: driver patch level */
741 int patchlevel;
742 /** @name: driver name */
743 char *name;
744 /** @desc: driver description */
745 char *desc;
746 /** @date: driver date */
747 char *date;
748
749 /**
750 * @driver_features:
751 * Driver features, see &enum drm_driver_feature. Drivers can disable
752 * some features on a per-instance basis using
753 * &drm_device.driver_features.
754 */
755 u32 driver_features;
756
757 /**
758 * @ioctls:
759 *
760 * Array of driver-private IOCTL description entries. See the chapter on
761 * :ref:`IOCTL support in the userland interfaces
762 * chapter<drm_driver_ioctl>` for the full details.
763 */
764
765 const struct drm_ioctl_desc *ioctls;
766 /** @num_ioctls: Number of entries in @ioctls. */
767 int num_ioctls;
768
769 /**
770 * @fops:
771 *
772 * File operations for the DRM device node. See the discussion in
773 * :ref:`file operations<drm_driver_fops>` for in-depth coverage and
774 * some examples.
775 */
776 const struct file_operations *fops;
777
778 /* Everything below here is for legacy driver, never use! */
779 /* private: */
780
781 /* List of devices hanging off this driver with stealth attach. */
782 struct list_head legacy_dev_list;
783 int (*firstopen) (struct drm_device *);
784 void (*preclose) (struct drm_device *, struct drm_file *file_priv);
785 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
786 int (*dma_quiescent) (struct drm_device *);
787 int (*context_dtor) (struct drm_device *dev, int context);
788 int dev_priv_size;
789 };
790
791 extern unsigned int drm_debug;
792
793 int drm_dev_init(struct drm_device *dev,
794 struct drm_driver *driver,
795 struct device *parent);
796 int devm_drm_dev_init(struct device *parent,
797 struct drm_device *dev,
798 struct drm_driver *driver);
799 void drm_dev_fini(struct drm_device *dev);
800
801 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
802 struct device *parent);
803 int drm_dev_register(struct drm_device *dev, unsigned long flags);
804 void drm_dev_unregister(struct drm_device *dev);
805
806 void drm_dev_get(struct drm_device *dev);
807 void drm_dev_put(struct drm_device *dev);
808 void drm_put_dev(struct drm_device *dev);
809 bool drm_dev_enter(struct drm_device *dev, int *idx);
810 void drm_dev_exit(int idx);
811 void drm_dev_unplug(struct drm_device *dev);
812
813 /**
814 * drm_dev_is_unplugged - is a DRM device unplugged
815 * @dev: DRM device
816 *
817 * This function can be called to check whether a hotpluggable is unplugged.
818 * Unplugging itself is singalled through drm_dev_unplug(). If a device is
819 * unplugged, these two functions guarantee that any store before calling
820 * drm_dev_unplug() is visible to callers of this function after it completes
821 *
822 * WARNING: This function fundamentally races against drm_dev_unplug(). It is
823 * recommended that drivers instead use the underlying drm_dev_enter() and
824 * drm_dev_exit() function pairs.
825 */
drm_dev_is_unplugged(struct drm_device * dev)826 static inline bool drm_dev_is_unplugged(struct drm_device *dev)
827 {
828 int idx;
829
830 if (drm_dev_enter(dev, &idx)) {
831 drm_dev_exit(idx);
832 return false;
833 }
834
835 return true;
836 }
837
838 /**
839 * drm_core_check_feature - check driver feature flags
840 * @dev: DRM device to check
841 * @feature: feature flag
842 *
843 * This checks @dev for driver features, see &drm_driver.driver_features,
844 * &drm_device.driver_features, and the various &enum drm_driver_feature flags.
845 *
846 * Returns true if the @feature is supported, false otherwise.
847 */
drm_core_check_feature(const struct drm_device * dev,u32 feature)848 static inline bool drm_core_check_feature(const struct drm_device *dev, u32 feature)
849 {
850 return dev->driver->driver_features & dev->driver_features & feature;
851 }
852
853 /**
854 * drm_drv_uses_atomic_modeset - check if the driver implements
855 * atomic_commit()
856 * @dev: DRM device
857 *
858 * This check is useful if drivers do not have DRIVER_ATOMIC set but
859 * have atomic modesetting internally implemented.
860 */
drm_drv_uses_atomic_modeset(struct drm_device * dev)861 static inline bool drm_drv_uses_atomic_modeset(struct drm_device *dev)
862 {
863 return drm_core_check_feature(dev, DRIVER_ATOMIC) ||
864 (dev->mode_config.funcs && dev->mode_config.funcs->atomic_commit != NULL);
865 }
866
867
868 int drm_dev_set_unique(struct drm_device *dev, const char *name);
869
870
871 #endif
872