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