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.
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:
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
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.
30 #include <linux/list.h>
31 #include <linux/irqreturn.h>
35 struct drm_gem_object;
38 struct dma_buf_attachment;
39 struct drm_display_mode;
40 struct drm_mode_create_dumb;
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
58 * struct drm_driver - DRM driver structure
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.
70 * Backward-compatible driver callback to complete
71 * initialization steps after the driver is registered. For
72 * this reason, may suffer from race conditions and its use is
73 * deprecated for new drivers. It is therefore only supported
74 * for existing drivers not yet converted to the new scheme.
75 * See drm_dev_init() and drm_dev_register() for proper and
76 * race-free way to set up a &struct drm_device.
78 * This is deprecated, do not use!
82 * Zero on success, non-zero value on failure.
84 int (*load) (struct drm_device *, unsigned long flags);
89 * Driver callback when a new &struct drm_file is opened. Useful for
90 * setting up driver-private data structures like buffer allocators,
91 * execution contexts or similar things. Such driver-private resources
92 * must be released again in @postclose.
94 * Since the display/modeset side of DRM can only be owned by exactly
95 * one &struct drm_file (see &drm_file.is_master and &drm_device.master)
96 * there should never be a need to set up any modeset related resources
97 * in this callback. Doing so would be a driver design bug.
101 * 0 on success, a negative error code on failure, which will be
102 * promoted to userspace as the result of the open() system call.
104 int (*open) (struct drm_device *, struct drm_file *);
109 * One of the driver callbacks when a new &struct drm_file is closed.
110 * Useful for tearing down driver-private data structures allocated in
111 * @open like buffer allocators, execution contexts or similar things.
113 * Since the display/modeset side of DRM can only be owned by exactly
114 * one &struct drm_file (see &drm_file.is_master and &drm_device.master)
115 * there should never be a need to tear down any modeset related
116 * resources in this callback. Doing so would be a driver design bug.
118 void (*postclose) (struct drm_device *, struct drm_file *);
123 * Called when the last &struct drm_file has been closed and there's
124 * currently no userspace client for the &struct drm_device.
126 * Modern drivers should only use this to force-restore the fbdev
127 * framebuffer using drm_fb_helper_restore_fbdev_mode_unlocked().
128 * Anything else would indicate there's something seriously wrong.
129 * Modern drivers can also use this to execute delayed power switching
130 * state changes, e.g. in conjunction with the :ref:`vga_switcheroo`
133 * This is called after @postclose hook has been called.
137 * All legacy drivers use this callback to de-initialize the hardware.
138 * This is purely because of the shadow-attach model, where the DRM
139 * kernel driver does not really own the hardware. Instead ownershipe is
140 * handled with the help of userspace through an inheritedly racy dance
141 * to set/unset the VT into raw mode.
143 * Legacy drivers initialize the hardware in the @firstopen callback,
144 * which isn't even called for modern drivers.
146 void (*lastclose) (struct drm_device *);
151 * Reverse the effects of the driver load callback. Ideally,
152 * the clean up performed by the driver should happen in the
153 * reverse order of the initialization. Similarly to the load
154 * hook, this handler is deprecated and its usage should be
155 * dropped in favor of an open-coded teardown function at the
156 * driver layer. See drm_dev_unregister() and drm_dev_unref()
157 * for the proper way to remove a &struct drm_device.
159 * The unload() hook is called right after unregistering
163 void (*unload) (struct drm_device *);
168 * Optional callback for destroying device data after the final
169 * reference is released, i.e. the device is being destroyed. Drivers
170 * using this callback are responsible for calling drm_dev_fini()
171 * to finalize the device and then freeing the struct themselves.
173 void (*release) (struct drm_device *);
175 int (*set_busid)(struct drm_device *dev, struct drm_master *master);
178 * @get_vblank_counter:
180 * Driver callback for fetching a raw hardware vblank counter for the
181 * CRTC specified with the pipe argument. If a device doesn't have a
182 * hardware counter, the driver can simply leave the hook as NULL.
183 * The DRM core will account for missed vblank events while interrupts
184 * where disabled based on system timestamps.
186 * Wraparound handling and loss of events due to modesetting is dealt
187 * with in the DRM core code, as long as drivers call
188 * drm_crtc_vblank_off() and drm_crtc_vblank_on() when disabling or
191 * This is deprecated and should not be used by new drivers.
192 * Use &drm_crtc_funcs.get_vblank_counter instead.
196 * Raw vblank counter value.
198 u32 (*get_vblank_counter) (struct drm_device *dev, unsigned int pipe);
203 * Enable vblank interrupts for the CRTC specified with the pipe
206 * This is deprecated and should not be used by new drivers.
207 * Use &drm_crtc_funcs.enable_vblank instead.
211 * Zero on success, appropriate errno if the given @crtc's vblank
212 * interrupt cannot be enabled.
214 int (*enable_vblank) (struct drm_device *dev, unsigned int pipe);
219 * Disable vblank interrupts for the CRTC specified with the pipe
222 * This is deprecated and should not be used by new drivers.
223 * Use &drm_crtc_funcs.disable_vblank instead.
225 void (*disable_vblank) (struct drm_device *dev, unsigned int pipe);
228 * @get_scanout_position:
230 * Called by vblank timestamping code.
232 * Returns the current display scanout position from a crtc, and an
233 * optional accurate ktime_get() timestamp of when position was
234 * measured. Note that this is a helper callback which is only used if a
235 * driver uses drm_calc_vbltimestamp_from_scanoutpos() for the
236 * @get_vblank_timestamp callback.
243 * Id of the crtc to query.
245 * True when called from drm_crtc_handle_vblank(). Some drivers
246 * need to apply some workarounds for gpu-specific vblank irq quirks
249 * Target location for current vertical scanout position.
251 * Target location for current horizontal scanout position.
253 * Target location for timestamp taken immediately before
254 * scanout position query. Can be NULL to skip timestamp.
256 * Target location for timestamp taken immediately after
257 * scanout position query. Can be NULL to skip timestamp.
259 * Current display timings.
261 * Returns vpos as a positive number while in active scanout area.
262 * Returns vpos as a negative number inside vblank, counting the number
263 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
264 * until start of active scanout / end of vblank."
268 * True on success, false if a reliable scanout position counter could
273 * Since this is a helper to implement @get_vblank_timestamp, we should
274 * move it to &struct drm_crtc_helper_funcs, like all the other
275 * helper-internal hooks.
277 bool (*get_scanout_position) (struct drm_device *dev, unsigned int pipe,
278 bool in_vblank_irq, int *vpos, int *hpos,
279 ktime_t *stime, ktime_t *etime,
280 const struct drm_display_mode *mode);
283 * @get_vblank_timestamp:
285 * Called by drm_get_last_vbltimestamp(). Should return a precise
286 * timestamp when the most recent VBLANK interval ended or will end.
288 * Specifically, the timestamp in @vblank_time should correspond as
289 * closely as possible to the time when the first video scanline of
290 * the video frame after the end of VBLANK will start scanning out,
291 * the time immediately after end of the VBLANK interval. If the
292 * @crtc is currently inside VBLANK, this will be a time in the future.
293 * If the @crtc is currently scanning out a frame, this will be the
294 * past start time of the current scanout. This is meant to adhere
295 * to the OpenML OML_sync_control extension specification.
300 * dev DRM device handle.
302 * crtc for which timestamp should be returned.
304 * Maximum allowable timestamp error in nanoseconds.
305 * Implementation should strive to provide timestamp
306 * with an error of at most max_error nanoseconds.
307 * Returns true upper bound on error for timestamp.
309 * Target location for returned vblank timestamp.
311 * True when called from drm_crtc_handle_vblank(). Some drivers
312 * need to apply some workarounds for gpu-specific vblank irq quirks
317 * True on success, false on failure, which means the core should
318 * fallback to a simple timestamp taken in drm_crtc_handle_vblank().
322 * We should move this hook to &struct drm_crtc_funcs like all the other
325 bool (*get_vblank_timestamp) (struct drm_device *dev, unsigned int pipe,
327 struct timeval *vblank_time,
330 /* these have to be filled in */
332 irqreturn_t(*irq_handler) (int irq, void *arg);
333 void (*irq_preinstall) (struct drm_device *dev);
334 int (*irq_postinstall) (struct drm_device *dev);
335 void (*irq_uninstall) (struct drm_device *dev);
340 * Called whenever a new master is created. Only used by vmwgfx.
342 int (*master_create)(struct drm_device *dev, struct drm_master *master);
347 * Called whenever a master is destroyed. Only used by vmwgfx.
349 void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
354 * Called whenever the minor master is set. Only used by vmwgfx.
356 int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
361 * Called whenever the minor master is dropped. Only used by vmwgfx.
363 void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv);
365 int (*debugfs_init)(struct drm_minor *minor);
368 * @gem_free_object: deconstructor for drm_gem_objects
370 * This is deprecated and should not be used by new drivers. Use
371 * @gem_free_object_unlocked instead.
373 void (*gem_free_object) (struct drm_gem_object *obj);
376 * @gem_free_object_unlocked: deconstructor for drm_gem_objects
378 * This is for drivers which are not encumbered with &drm_device.struct_mutex
379 * legacy locking schemes. Use this hook instead of @gem_free_object.
381 void (*gem_free_object_unlocked) (struct drm_gem_object *obj);
383 int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
384 void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
387 * @gem_create_object: constructor for gem objects
389 * Hook for allocating the GEM object struct, for use by core
392 struct drm_gem_object *(*gem_create_object)(struct drm_device *dev,
396 /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
397 int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
398 uint32_t handle, uint32_t flags, int *prime_fd);
399 /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
400 int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
401 int prime_fd, uint32_t *handle);
402 /* export GEM -> dmabuf */
403 struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
404 struct drm_gem_object *obj, int flags);
405 /* import dmabuf -> GEM */
406 struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
407 struct dma_buf *dma_buf);
408 /* low-level interface used by drm_gem_prime_{import,export} */
409 int (*gem_prime_pin)(struct drm_gem_object *obj);
410 void (*gem_prime_unpin)(struct drm_gem_object *obj);
411 struct reservation_object * (*gem_prime_res_obj)(
412 struct drm_gem_object *obj);
413 struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj);
414 struct drm_gem_object *(*gem_prime_import_sg_table)(
415 struct drm_device *dev,
416 struct dma_buf_attachment *attach,
417 struct sg_table *sgt);
418 void *(*gem_prime_vmap)(struct drm_gem_object *obj);
419 void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr);
420 int (*gem_prime_mmap)(struct drm_gem_object *obj,
421 struct vm_area_struct *vma);
426 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
427 * TTM or something else entirely) and returns the resulting buffer handle. This
428 * handle can then be wrapped up into a framebuffer modeset object.
430 * Note that userspace is not allowed to use such objects for render
431 * acceleration - drivers must create their own private ioctls for such a use
434 * Width, height and depth are specified in the &drm_mode_create_dumb
435 * argument. The callback needs to fill the handle, pitch and size for
436 * the created buffer.
438 * Called by the user via ioctl.
442 * Zero on success, negative errno on failure.
444 int (*dumb_create)(struct drm_file *file_priv,
445 struct drm_device *dev,
446 struct drm_mode_create_dumb *args);
450 * Allocate an offset in the drm device node's address space to be able to
451 * memory map a dumb buffer. GEM-based drivers must use
452 * drm_gem_create_mmap_offset() to implement this.
454 * Called by the user via ioctl.
458 * Zero on success, negative errno on failure.
460 int (*dumb_map_offset)(struct drm_file *file_priv,
461 struct drm_device *dev, uint32_t handle,
466 * This destroys the userspace handle for the given dumb backing storage buffer.
467 * Since buffer objects must be reference counted in the kernel a buffer object
468 * won't be immediately freed if a framebuffer modeset object still uses it.
470 * Called by the user via ioctl.
474 * Zero on success, negative errno on failure.
476 int (*dumb_destroy)(struct drm_file *file_priv,
477 struct drm_device *dev,
480 /* Driver private ops for this object */
481 const struct vm_operations_struct *gem_vm_ops;
491 const struct drm_ioctl_desc *ioctls;
493 const struct file_operations *fops;
495 /* Everything below here is for legacy driver, never use! */
498 /* List of devices hanging off this driver with stealth attach. */
499 struct list_head legacy_dev_list;
500 int (*firstopen) (struct drm_device *);
501 void (*preclose) (struct drm_device *, struct drm_file *file_priv);
502 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
503 int (*dma_quiescent) (struct drm_device *);
504 int (*context_dtor) (struct drm_device *dev, int context);
509 void drm_dev_printk(const struct device *dev, const char *level,
510 unsigned int category, const char *function_name,
511 const char *prefix, const char *format, ...);
513 void drm_printk(const char *level, unsigned int category,
514 const char *format, ...);
515 extern unsigned int drm_debug;
517 int drm_dev_init(struct drm_device *dev,
518 struct drm_driver *driver,
519 struct device *parent);
520 void drm_dev_fini(struct drm_device *dev);
522 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
523 struct device *parent);
524 int drm_dev_register(struct drm_device *dev, unsigned long flags);
525 void drm_dev_unregister(struct drm_device *dev);
527 void drm_dev_ref(struct drm_device *dev);
528 void drm_dev_unref(struct drm_device *dev);
529 void drm_put_dev(struct drm_device *dev);
530 void drm_unplug_dev(struct drm_device *dev);
532 int drm_dev_set_unique(struct drm_device *dev, const char *name);