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