185e634bcSDaniel Vetter /* 285e634bcSDaniel Vetter * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas. 385e634bcSDaniel Vetter * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California. 485e634bcSDaniel Vetter * Copyright (c) 2009-2010, Code Aurora Forum. 585e634bcSDaniel Vetter * Copyright 2016 Intel Corp. 685e634bcSDaniel Vetter * 785e634bcSDaniel Vetter * Permission is hereby granted, free of charge, to any person obtaining a 885e634bcSDaniel Vetter * copy of this software and associated documentation files (the "Software"), 985e634bcSDaniel Vetter * to deal in the Software without restriction, including without limitation 1085e634bcSDaniel Vetter * the rights to use, copy, modify, merge, publish, distribute, sublicense, 1185e634bcSDaniel Vetter * and/or sell copies of the Software, and to permit persons to whom the 1285e634bcSDaniel Vetter * Software is furnished to do so, subject to the following conditions: 1385e634bcSDaniel Vetter * 1485e634bcSDaniel Vetter * The above copyright notice and this permission notice (including the next 1585e634bcSDaniel Vetter * paragraph) shall be included in all copies or substantial portions of the 1685e634bcSDaniel Vetter * Software. 1785e634bcSDaniel Vetter * 1885e634bcSDaniel Vetter * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 1985e634bcSDaniel Vetter * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 2085e634bcSDaniel Vetter * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 2185e634bcSDaniel Vetter * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 2285e634bcSDaniel Vetter * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 2385e634bcSDaniel Vetter * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 2485e634bcSDaniel Vetter * OTHER DEALINGS IN THE SOFTWARE. 2585e634bcSDaniel Vetter */ 2685e634bcSDaniel Vetter 2785e634bcSDaniel Vetter #ifndef _DRM_DRV_H_ 2885e634bcSDaniel Vetter #define _DRM_DRV_H_ 2985e634bcSDaniel Vetter 3085e634bcSDaniel Vetter #include <linux/list.h> 3185e634bcSDaniel Vetter #include <linux/irqreturn.h> 3285e634bcSDaniel Vetter 3385e634bcSDaniel Vetter struct drm_device; 3485e634bcSDaniel Vetter struct drm_file; 3585e634bcSDaniel Vetter struct drm_gem_object; 3685e634bcSDaniel Vetter struct drm_master; 3785e634bcSDaniel Vetter struct drm_minor; 3885e634bcSDaniel Vetter struct dma_buf_attachment; 3985e634bcSDaniel Vetter struct drm_display_mode; 4085e634bcSDaniel Vetter struct drm_mode_create_dumb; 4185e634bcSDaniel Vetter 4285e634bcSDaniel Vetter /* driver capabilities and requirements mask */ 4385e634bcSDaniel Vetter #define DRIVER_USE_AGP 0x1 4485e634bcSDaniel Vetter #define DRIVER_LEGACY 0x2 4585e634bcSDaniel Vetter #define DRIVER_PCI_DMA 0x8 4685e634bcSDaniel Vetter #define DRIVER_SG 0x10 4785e634bcSDaniel Vetter #define DRIVER_HAVE_DMA 0x20 4885e634bcSDaniel Vetter #define DRIVER_HAVE_IRQ 0x40 4985e634bcSDaniel Vetter #define DRIVER_IRQ_SHARED 0x80 5085e634bcSDaniel Vetter #define DRIVER_GEM 0x1000 5185e634bcSDaniel Vetter #define DRIVER_MODESET 0x2000 5285e634bcSDaniel Vetter #define DRIVER_PRIME 0x4000 5385e634bcSDaniel Vetter #define DRIVER_RENDER 0x8000 5485e634bcSDaniel Vetter #define DRIVER_ATOMIC 0x10000 5585e634bcSDaniel Vetter #define DRIVER_KMS_LEGACY_CONTEXT 0x20000 5685e634bcSDaniel Vetter 5785e634bcSDaniel Vetter /** 5885e634bcSDaniel Vetter * struct drm_driver - DRM driver structure 5985e634bcSDaniel Vetter * 6085e634bcSDaniel Vetter * This structure represent the common code for a family of cards. There will 6185e634bcSDaniel Vetter * one drm_device for each card present in this family. It contains lots of 6285e634bcSDaniel Vetter * vfunc entries, and a pile of those probably should be moved to more 6385e634bcSDaniel Vetter * appropriate places like &drm_mode_config_funcs or into a new operations 6485e634bcSDaniel Vetter * structure for GEM drivers. 6585e634bcSDaniel Vetter */ 6685e634bcSDaniel Vetter struct drm_driver { 6756926500SGabriel Krisman Bertazi /** 6856926500SGabriel Krisman Bertazi * @load: 6956926500SGabriel Krisman Bertazi * 7056926500SGabriel Krisman Bertazi * Backward-compatible driver callback to complete 7156926500SGabriel Krisman Bertazi * initialization steps after the driver is registered. For 7256926500SGabriel Krisman Bertazi * this reason, may suffer from race conditions and its use is 7356926500SGabriel Krisman Bertazi * deprecated for new drivers. It is therefore only supported 7456926500SGabriel Krisman Bertazi * for existing drivers not yet converted to the new scheme. 7556926500SGabriel Krisman Bertazi * See drm_dev_init() and drm_dev_register() for proper and 7656926500SGabriel Krisman Bertazi * race-free way to set up a &struct drm_device. 7756926500SGabriel Krisman Bertazi * 78b93658f8SDaniel Vetter * This is deprecated, do not use! 79b93658f8SDaniel Vetter * 8056926500SGabriel Krisman Bertazi * Returns: 8156926500SGabriel Krisman Bertazi * 8256926500SGabriel Krisman Bertazi * Zero on success, non-zero value on failure. 8356926500SGabriel Krisman Bertazi */ 8485e634bcSDaniel Vetter int (*load) (struct drm_device *, unsigned long flags); 85b93658f8SDaniel Vetter 86b93658f8SDaniel Vetter /** 87b93658f8SDaniel Vetter * @open: 88b93658f8SDaniel Vetter * 89b93658f8SDaniel Vetter * Driver callback when a new &struct drm_file is opened. Useful for 90b93658f8SDaniel Vetter * setting up driver-private data structures like buffer allocators, 91b93658f8SDaniel Vetter * execution contexts or similar things. Such driver-private resources 92b93658f8SDaniel Vetter * must be released again in @postclose. 93b93658f8SDaniel Vetter * 94b93658f8SDaniel Vetter * Since the display/modeset side of DRM can only be owned by exactly 95b93658f8SDaniel Vetter * one &struct drm_file (see &drm_file.is_master and &drm_device.master) 96b93658f8SDaniel Vetter * there should never be a need to set up any modeset related resources 97b93658f8SDaniel Vetter * in this callback. Doing so would be a driver design bug. 98b93658f8SDaniel Vetter * 99b93658f8SDaniel Vetter * Returns: 100b93658f8SDaniel Vetter * 101b93658f8SDaniel Vetter * 0 on success, a negative error code on failure, which will be 102b93658f8SDaniel Vetter * promoted to userspace as the result of the open() system call. 103b93658f8SDaniel Vetter */ 10485e634bcSDaniel Vetter int (*open) (struct drm_device *, struct drm_file *); 105b93658f8SDaniel Vetter 106b93658f8SDaniel Vetter /** 107b93658f8SDaniel Vetter * @postclose: 108b93658f8SDaniel Vetter * 109b93658f8SDaniel Vetter * One of the driver callbacks when a new &struct drm_file is closed. 110b93658f8SDaniel Vetter * Useful for tearing down driver-private data structures allocated in 111b93658f8SDaniel Vetter * @open like buffer allocators, execution contexts or similar things. 112b93658f8SDaniel Vetter * 113b93658f8SDaniel Vetter * Since the display/modeset side of DRM can only be owned by exactly 114b93658f8SDaniel Vetter * one &struct drm_file (see &drm_file.is_master and &drm_device.master) 115b93658f8SDaniel Vetter * there should never be a need to tear down any modeset related 116b93658f8SDaniel Vetter * resources in this callback. Doing so would be a driver design bug. 117b93658f8SDaniel Vetter */ 11885e634bcSDaniel Vetter void (*postclose) (struct drm_device *, struct drm_file *); 119b93658f8SDaniel Vetter 120b93658f8SDaniel Vetter /** 121b93658f8SDaniel Vetter * @lastclose: 122b93658f8SDaniel Vetter * 123b93658f8SDaniel Vetter * Called when the last &struct drm_file has been closed and there's 124b93658f8SDaniel Vetter * currently no userspace client for the &struct drm_device. 125b93658f8SDaniel Vetter * 126b93658f8SDaniel Vetter * Modern drivers should only use this to force-restore the fbdev 127b93658f8SDaniel Vetter * framebuffer using drm_fb_helper_restore_fbdev_mode_unlocked(). 128b93658f8SDaniel Vetter * Anything else would indicate there's something seriously wrong. 129b93658f8SDaniel Vetter * Modern drivers can also use this to execute delayed power switching 130b93658f8SDaniel Vetter * state changes, e.g. in conjunction with the :ref:`vga_switcheroo` 131b93658f8SDaniel Vetter * infrastructure. 132b93658f8SDaniel Vetter * 13345c3d213SDaniel Vetter * This is called after @postclose hook has been called. 134b93658f8SDaniel Vetter * 135b93658f8SDaniel Vetter * NOTE: 136b93658f8SDaniel Vetter * 137b93658f8SDaniel Vetter * All legacy drivers use this callback to de-initialize the hardware. 138b93658f8SDaniel Vetter * This is purely because of the shadow-attach model, where the DRM 139b93658f8SDaniel Vetter * kernel driver does not really own the hardware. Instead ownershipe is 140b93658f8SDaniel Vetter * handled with the help of userspace through an inheritedly racy dance 141b93658f8SDaniel Vetter * to set/unset the VT into raw mode. 142b93658f8SDaniel Vetter * 143b93658f8SDaniel Vetter * Legacy drivers initialize the hardware in the @firstopen callback, 144b93658f8SDaniel Vetter * which isn't even called for modern drivers. 145b93658f8SDaniel Vetter */ 14685e634bcSDaniel Vetter void (*lastclose) (struct drm_device *); 14756926500SGabriel Krisman Bertazi 14856926500SGabriel Krisman Bertazi /** 14956926500SGabriel Krisman Bertazi * @unload: 15056926500SGabriel Krisman Bertazi * 15156926500SGabriel Krisman Bertazi * Reverse the effects of the driver load callback. Ideally, 15256926500SGabriel Krisman Bertazi * the clean up performed by the driver should happen in the 15356926500SGabriel Krisman Bertazi * reverse order of the initialization. Similarly to the load 15456926500SGabriel Krisman Bertazi * hook, this handler is deprecated and its usage should be 15556926500SGabriel Krisman Bertazi * dropped in favor of an open-coded teardown function at the 15656926500SGabriel Krisman Bertazi * driver layer. See drm_dev_unregister() and drm_dev_unref() 15756926500SGabriel Krisman Bertazi * for the proper way to remove a &struct drm_device. 15856926500SGabriel Krisman Bertazi * 15956926500SGabriel Krisman Bertazi * The unload() hook is called right after unregistering 16056926500SGabriel Krisman Bertazi * the device. 16156926500SGabriel Krisman Bertazi * 16256926500SGabriel Krisman Bertazi */ 16311b3c20bSGabriel Krisman Bertazi void (*unload) (struct drm_device *); 164f30c9257SChris Wilson 165f30c9257SChris Wilson /** 166f30c9257SChris Wilson * @release: 167f30c9257SChris Wilson * 168f30c9257SChris Wilson * Optional callback for destroying device data after the final 169f30c9257SChris Wilson * reference is released, i.e. the device is being destroyed. Drivers 170f30c9257SChris Wilson * using this callback are responsible for calling drm_dev_fini() 171f30c9257SChris Wilson * to finalize the device and then freeing the struct themselves. 172f30c9257SChris Wilson */ 173f30c9257SChris Wilson void (*release) (struct drm_device *); 174f30c9257SChris Wilson 17585e634bcSDaniel Vetter /** 1766c4789edSDaniel Vetter * @get_vblank_counter: 17785e634bcSDaniel Vetter * 1786c4789edSDaniel Vetter * Driver callback for fetching a raw hardware vblank counter for the 1796c4789edSDaniel Vetter * CRTC specified with the pipe argument. If a device doesn't have a 1805ac74757SShawn Guo * hardware counter, the driver can simply leave the hook as NULL. 1815ac74757SShawn Guo * The DRM core will account for missed vblank events while interrupts 1825ac74757SShawn Guo * where disabled based on system timestamps. 18385e634bcSDaniel Vetter * 18485e634bcSDaniel Vetter * Wraparound handling and loss of events due to modesetting is dealt 1856c4789edSDaniel Vetter * with in the DRM core code, as long as drivers call 1866c4789edSDaniel Vetter * drm_crtc_vblank_off() and drm_crtc_vblank_on() when disabling or 1876c4789edSDaniel Vetter * enabling a CRTC. 18885e634bcSDaniel Vetter * 18984e35483SShawn Guo * This is deprecated and should not be used by new drivers. 19084e35483SShawn Guo * Use &drm_crtc_funcs.get_vblank_counter instead. 19184e35483SShawn Guo * 1926c4789edSDaniel Vetter * Returns: 1936c4789edSDaniel Vetter * 19485e634bcSDaniel Vetter * Raw vblank counter value. 19585e634bcSDaniel Vetter */ 19685e634bcSDaniel Vetter u32 (*get_vblank_counter) (struct drm_device *dev, unsigned int pipe); 19785e634bcSDaniel Vetter 19885e634bcSDaniel Vetter /** 1996c4789edSDaniel Vetter * @enable_vblank: 20085e634bcSDaniel Vetter * 2016c4789edSDaniel Vetter * Enable vblank interrupts for the CRTC specified with the pipe 2026c4789edSDaniel Vetter * argument. 20385e634bcSDaniel Vetter * 20484e35483SShawn Guo * This is deprecated and should not be used by new drivers. 20584e35483SShawn Guo * Use &drm_crtc_funcs.enable_vblank instead. 20684e35483SShawn Guo * 2076c4789edSDaniel Vetter * Returns: 2086c4789edSDaniel Vetter * 20985e634bcSDaniel Vetter * Zero on success, appropriate errno if the given @crtc's vblank 21085e634bcSDaniel Vetter * interrupt cannot be enabled. 21185e634bcSDaniel Vetter */ 21285e634bcSDaniel Vetter int (*enable_vblank) (struct drm_device *dev, unsigned int pipe); 21385e634bcSDaniel Vetter 21485e634bcSDaniel Vetter /** 2156c4789edSDaniel Vetter * @disable_vblank: 21685e634bcSDaniel Vetter * 2176c4789edSDaniel Vetter * Disable vblank interrupts for the CRTC specified with the pipe 2186c4789edSDaniel Vetter * argument. 21984e35483SShawn Guo * 22084e35483SShawn Guo * This is deprecated and should not be used by new drivers. 22184e35483SShawn Guo * Use &drm_crtc_funcs.disable_vblank instead. 22285e634bcSDaniel Vetter */ 22385e634bcSDaniel Vetter void (*disable_vblank) (struct drm_device *dev, unsigned int pipe); 22485e634bcSDaniel Vetter 22585e634bcSDaniel Vetter /** 2266c4789edSDaniel Vetter * @get_scanout_position: 2276c4789edSDaniel Vetter * 22885e634bcSDaniel Vetter * Called by vblank timestamping code. 22985e634bcSDaniel Vetter * 2306c4789edSDaniel Vetter * Returns the current display scanout position from a crtc, and an 2316c4789edSDaniel Vetter * optional accurate ktime_get() timestamp of when position was 2326c4789edSDaniel Vetter * measured. Note that this is a helper callback which is only used if a 2336c4789edSDaniel Vetter * driver uses drm_calc_vbltimestamp_from_scanoutpos() for the 2346c4789edSDaniel Vetter * @get_vblank_timestamp callback. 23585e634bcSDaniel Vetter * 2366c4789edSDaniel Vetter * Parameters: 2376c4789edSDaniel Vetter * 2386c4789edSDaniel Vetter * dev: 2396c4789edSDaniel Vetter * DRM device. 2406c4789edSDaniel Vetter * pipe: 2416c4789edSDaniel Vetter * Id of the crtc to query. 2423fcdcb27SDaniel Vetter * in_vblank_irq: 2433fcdcb27SDaniel Vetter * True when called from drm_crtc_handle_vblank(). Some drivers 2443fcdcb27SDaniel Vetter * need to apply some workarounds for gpu-specific vblank irq quirks 2453fcdcb27SDaniel Vetter * if flag is set. 2466c4789edSDaniel Vetter * vpos: 2476c4789edSDaniel Vetter * Target location for current vertical scanout position. 2486c4789edSDaniel Vetter * hpos: 2496c4789edSDaniel Vetter * Target location for current horizontal scanout position. 2506c4789edSDaniel Vetter * stime: 2516c4789edSDaniel Vetter * Target location for timestamp taken immediately before 25285e634bcSDaniel Vetter * scanout position query. Can be NULL to skip timestamp. 2536c4789edSDaniel Vetter * etime: 2546c4789edSDaniel Vetter * Target location for timestamp taken immediately after 25585e634bcSDaniel Vetter * scanout position query. Can be NULL to skip timestamp. 2566c4789edSDaniel Vetter * mode: 2576c4789edSDaniel Vetter * Current display timings. 25885e634bcSDaniel Vetter * 25985e634bcSDaniel Vetter * Returns vpos as a positive number while in active scanout area. 26085e634bcSDaniel Vetter * Returns vpos as a negative number inside vblank, counting the number 26185e634bcSDaniel Vetter * of scanlines to go until end of vblank, e.g., -1 means "one scanline 26285e634bcSDaniel Vetter * until start of active scanout / end of vblank." 26385e634bcSDaniel Vetter * 2646c4789edSDaniel Vetter * Returns: 26585e634bcSDaniel Vetter * 2661bf6ad62SDaniel Vetter * True on success, false if a reliable scanout position counter could 2671bf6ad62SDaniel Vetter * not be read out. 26885e634bcSDaniel Vetter * 2692a39b88bSDaniel Vetter * FIXME: 2702a39b88bSDaniel Vetter * 2712a39b88bSDaniel Vetter * Since this is a helper to implement @get_vblank_timestamp, we should 2722a39b88bSDaniel Vetter * move it to &struct drm_crtc_helper_funcs, like all the other 2732a39b88bSDaniel Vetter * helper-internal hooks. 27485e634bcSDaniel Vetter */ 2751bf6ad62SDaniel Vetter bool (*get_scanout_position) (struct drm_device *dev, unsigned int pipe, 2761bf6ad62SDaniel Vetter bool in_vblank_irq, int *vpos, int *hpos, 27785e634bcSDaniel Vetter ktime_t *stime, ktime_t *etime, 27885e634bcSDaniel Vetter const struct drm_display_mode *mode); 27985e634bcSDaniel Vetter 28085e634bcSDaniel Vetter /** 2816c4789edSDaniel Vetter * @get_vblank_timestamp: 2826c4789edSDaniel Vetter * 2836c4789edSDaniel Vetter * Called by drm_get_last_vbltimestamp(). Should return a precise 28485e634bcSDaniel Vetter * timestamp when the most recent VBLANK interval ended or will end. 28585e634bcSDaniel Vetter * 28685e634bcSDaniel Vetter * Specifically, the timestamp in @vblank_time should correspond as 28785e634bcSDaniel Vetter * closely as possible to the time when the first video scanline of 28885e634bcSDaniel Vetter * the video frame after the end of VBLANK will start scanning out, 28985e634bcSDaniel Vetter * the time immediately after end of the VBLANK interval. If the 29085e634bcSDaniel Vetter * @crtc is currently inside VBLANK, this will be a time in the future. 29185e634bcSDaniel Vetter * If the @crtc is currently scanning out a frame, this will be the 29285e634bcSDaniel Vetter * past start time of the current scanout. This is meant to adhere 29385e634bcSDaniel Vetter * to the OpenML OML_sync_control extension specification. 29485e634bcSDaniel Vetter * 2956c4789edSDaniel Vetter * Paramters: 2966c4789edSDaniel Vetter * 2976c4789edSDaniel Vetter * dev: 2986c4789edSDaniel Vetter * dev DRM device handle. 2996c4789edSDaniel Vetter * pipe: 3006c4789edSDaniel Vetter * crtc for which timestamp should be returned. 3016c4789edSDaniel Vetter * max_error: 3026c4789edSDaniel Vetter * Maximum allowable timestamp error in nanoseconds. 30385e634bcSDaniel Vetter * Implementation should strive to provide timestamp 3046c4789edSDaniel Vetter * with an error of at most max_error nanoseconds. 30585e634bcSDaniel Vetter * Returns true upper bound on error for timestamp. 3066c4789edSDaniel Vetter * vblank_time: 3076c4789edSDaniel Vetter * Target location for returned vblank timestamp. 3083fcdcb27SDaniel Vetter * in_vblank_irq: 3093fcdcb27SDaniel Vetter * True when called from drm_crtc_handle_vblank(). Some drivers 3103fcdcb27SDaniel Vetter * need to apply some workarounds for gpu-specific vblank irq quirks 3113fcdcb27SDaniel Vetter * if flag is set. 31285e634bcSDaniel Vetter * 3136c4789edSDaniel Vetter * Returns: 3146c4789edSDaniel Vetter * 315d673c02cSDaniel Vetter * True on success, false on failure, which means the core should 316d673c02cSDaniel Vetter * fallback to a simple timestamp taken in drm_crtc_handle_vblank(). 3172a39b88bSDaniel Vetter * 3182a39b88bSDaniel Vetter * FIXME: 3192a39b88bSDaniel Vetter * 3202a39b88bSDaniel Vetter * We should move this hook to &struct drm_crtc_funcs like all the other 3212a39b88bSDaniel Vetter * vblank hooks. 32285e634bcSDaniel Vetter */ 323d673c02cSDaniel Vetter bool (*get_vblank_timestamp) (struct drm_device *dev, unsigned int pipe, 32485e634bcSDaniel Vetter int *max_error, 32585e634bcSDaniel Vetter struct timeval *vblank_time, 3263fcdcb27SDaniel Vetter bool in_vblank_irq); 32785e634bcSDaniel Vetter 32816584b20SDaniel Vetter /** 32916584b20SDaniel Vetter * @irq_handler: 33016584b20SDaniel Vetter * 33116584b20SDaniel Vetter * Interrupt handler called when using drm_irq_install(). Not used by 33216584b20SDaniel Vetter * drivers which implement their own interrupt handling. 33316584b20SDaniel Vetter */ 33485e634bcSDaniel Vetter irqreturn_t(*irq_handler) (int irq, void *arg); 33516584b20SDaniel Vetter 33616584b20SDaniel Vetter /** 33716584b20SDaniel Vetter * @irq_preinstall: 33816584b20SDaniel Vetter * 33916584b20SDaniel Vetter * Optional callback used by drm_irq_install() which is called before 34016584b20SDaniel Vetter * the interrupt handler is registered. This should be used to clear out 34116584b20SDaniel Vetter * any pending interrupts (from e.g. firmware based drives) and reset 34216584b20SDaniel Vetter * the interrupt handling registers. 34316584b20SDaniel Vetter */ 34485e634bcSDaniel Vetter void (*irq_preinstall) (struct drm_device *dev); 34516584b20SDaniel Vetter 34616584b20SDaniel Vetter /** 34716584b20SDaniel Vetter * @irq_postinstall: 34816584b20SDaniel Vetter * 34916584b20SDaniel Vetter * Optional callback used by drm_irq_install() which is called after 35016584b20SDaniel Vetter * the interrupt handler is registered. This should be used to enable 35116584b20SDaniel Vetter * interrupt generation in the hardware. 35216584b20SDaniel Vetter */ 35385e634bcSDaniel Vetter int (*irq_postinstall) (struct drm_device *dev); 35416584b20SDaniel Vetter 35516584b20SDaniel Vetter /** 35616584b20SDaniel Vetter * @irq_uninstall: 35716584b20SDaniel Vetter * 35816584b20SDaniel Vetter * Optional callback used by drm_irq_uninstall() which is called before 35916584b20SDaniel Vetter * the interrupt handler is unregistered. This should be used to disable 36016584b20SDaniel Vetter * interrupt generation in the hardware. 36116584b20SDaniel Vetter */ 36285e634bcSDaniel Vetter void (*irq_uninstall) (struct drm_device *dev); 36385e634bcSDaniel Vetter 36485e634bcSDaniel Vetter /** 3656c4789edSDaniel Vetter * @master_create: 3666c4789edSDaniel Vetter * 3676c4789edSDaniel Vetter * Called whenever a new master is created. Only used by vmwgfx. 36885e634bcSDaniel Vetter */ 3696c4789edSDaniel Vetter int (*master_create)(struct drm_device *dev, struct drm_master *master); 37085e634bcSDaniel Vetter 3716c4789edSDaniel Vetter /** 3726c4789edSDaniel Vetter * @master_destroy: 3736c4789edSDaniel Vetter * 3746c4789edSDaniel Vetter * Called whenever a master is destroyed. Only used by vmwgfx. 3756c4789edSDaniel Vetter */ 3766c4789edSDaniel Vetter void (*master_destroy)(struct drm_device *dev, struct drm_master *master); 3776c4789edSDaniel Vetter 3786c4789edSDaniel Vetter /** 3796c4789edSDaniel Vetter * @master_set: 3806c4789edSDaniel Vetter * 3816c4789edSDaniel Vetter * Called whenever the minor master is set. Only used by vmwgfx. 3826c4789edSDaniel Vetter */ 38385e634bcSDaniel Vetter int (*master_set)(struct drm_device *dev, struct drm_file *file_priv, 38485e634bcSDaniel Vetter bool from_open); 3856c4789edSDaniel Vetter /** 3866c4789edSDaniel Vetter * @master_drop: 3876c4789edSDaniel Vetter * 3886c4789edSDaniel Vetter * Called whenever the minor master is dropped. Only used by vmwgfx. 3896c4789edSDaniel Vetter */ 39085e634bcSDaniel Vetter void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv); 39185e634bcSDaniel Vetter 39285e634bcSDaniel Vetter int (*debugfs_init)(struct drm_minor *minor); 39385e634bcSDaniel Vetter 39485e634bcSDaniel Vetter /** 39585e634bcSDaniel Vetter * @gem_free_object: deconstructor for drm_gem_objects 39685e634bcSDaniel Vetter * 39785e634bcSDaniel Vetter * This is deprecated and should not be used by new drivers. Use 39885e634bcSDaniel Vetter * @gem_free_object_unlocked instead. 39985e634bcSDaniel Vetter */ 40085e634bcSDaniel Vetter void (*gem_free_object) (struct drm_gem_object *obj); 40185e634bcSDaniel Vetter 40285e634bcSDaniel Vetter /** 40385e634bcSDaniel Vetter * @gem_free_object_unlocked: deconstructor for drm_gem_objects 40485e634bcSDaniel Vetter * 405ef40cbf9SDaniel Vetter * This is for drivers which are not encumbered with &drm_device.struct_mutex 40685e634bcSDaniel Vetter * legacy locking schemes. Use this hook instead of @gem_free_object. 40785e634bcSDaniel Vetter */ 40885e634bcSDaniel Vetter void (*gem_free_object_unlocked) (struct drm_gem_object *obj); 40985e634bcSDaniel Vetter 41085e634bcSDaniel Vetter int (*gem_open_object) (struct drm_gem_object *, struct drm_file *); 41185e634bcSDaniel Vetter void (*gem_close_object) (struct drm_gem_object *, struct drm_file *); 41285e634bcSDaniel Vetter 41385e634bcSDaniel Vetter /** 414218adc17SChris Wilson * @gem_create_object: constructor for gem objects 415218adc17SChris Wilson * 41685e634bcSDaniel Vetter * Hook for allocating the GEM object struct, for use by core 41785e634bcSDaniel Vetter * helpers. 41885e634bcSDaniel Vetter */ 41985e634bcSDaniel Vetter struct drm_gem_object *(*gem_create_object)(struct drm_device *dev, 42085e634bcSDaniel Vetter size_t size); 42185e634bcSDaniel Vetter 42285e634bcSDaniel Vetter /* prime: */ 42385e634bcSDaniel Vetter /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */ 42485e634bcSDaniel Vetter int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv, 42585e634bcSDaniel Vetter uint32_t handle, uint32_t flags, int *prime_fd); 42685e634bcSDaniel Vetter /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */ 42785e634bcSDaniel Vetter int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv, 42885e634bcSDaniel Vetter int prime_fd, uint32_t *handle); 42985e634bcSDaniel Vetter /* export GEM -> dmabuf */ 43085e634bcSDaniel Vetter struct dma_buf * (*gem_prime_export)(struct drm_device *dev, 43185e634bcSDaniel Vetter struct drm_gem_object *obj, int flags); 43285e634bcSDaniel Vetter /* import dmabuf -> GEM */ 43385e634bcSDaniel Vetter struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev, 43485e634bcSDaniel Vetter struct dma_buf *dma_buf); 43585e634bcSDaniel Vetter /* low-level interface used by drm_gem_prime_{import,export} */ 43685e634bcSDaniel Vetter int (*gem_prime_pin)(struct drm_gem_object *obj); 43785e634bcSDaniel Vetter void (*gem_prime_unpin)(struct drm_gem_object *obj); 43885e634bcSDaniel Vetter struct reservation_object * (*gem_prime_res_obj)( 43985e634bcSDaniel Vetter struct drm_gem_object *obj); 44085e634bcSDaniel Vetter struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj); 44185e634bcSDaniel Vetter struct drm_gem_object *(*gem_prime_import_sg_table)( 44285e634bcSDaniel Vetter struct drm_device *dev, 44385e634bcSDaniel Vetter struct dma_buf_attachment *attach, 44485e634bcSDaniel Vetter struct sg_table *sgt); 44585e634bcSDaniel Vetter void *(*gem_prime_vmap)(struct drm_gem_object *obj); 44685e634bcSDaniel Vetter void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr); 44785e634bcSDaniel Vetter int (*gem_prime_mmap)(struct drm_gem_object *obj, 44885e634bcSDaniel Vetter struct vm_area_struct *vma); 44985e634bcSDaniel Vetter 4504f93624eSDaniel Vetter /** 4514f93624eSDaniel Vetter * @dumb_create: 4524f93624eSDaniel Vetter * 4534f93624eSDaniel Vetter * This creates a new dumb buffer in the driver's backing storage manager (GEM, 4544f93624eSDaniel Vetter * TTM or something else entirely) and returns the resulting buffer handle. This 4554f93624eSDaniel Vetter * handle can then be wrapped up into a framebuffer modeset object. 4564f93624eSDaniel Vetter * 4574f93624eSDaniel Vetter * Note that userspace is not allowed to use such objects for render 4584f93624eSDaniel Vetter * acceleration - drivers must create their own private ioctls for such a use 4594f93624eSDaniel Vetter * case. 4604f93624eSDaniel Vetter * 4614f93624eSDaniel Vetter * Width, height and depth are specified in the &drm_mode_create_dumb 4624f93624eSDaniel Vetter * argument. The callback needs to fill the handle, pitch and size for 4634f93624eSDaniel Vetter * the created buffer. 4644f93624eSDaniel Vetter * 4654f93624eSDaniel Vetter * Called by the user via ioctl. 4664f93624eSDaniel Vetter * 4674f93624eSDaniel Vetter * Returns: 4684f93624eSDaniel Vetter * 4694f93624eSDaniel Vetter * Zero on success, negative errno on failure. 4704f93624eSDaniel Vetter */ 47185e634bcSDaniel Vetter int (*dumb_create)(struct drm_file *file_priv, 47285e634bcSDaniel Vetter struct drm_device *dev, 47385e634bcSDaniel Vetter struct drm_mode_create_dumb *args); 4744f93624eSDaniel Vetter /** 4754f93624eSDaniel Vetter * @dumb_map_offset: 4764f93624eSDaniel Vetter * 4774f93624eSDaniel Vetter * Allocate an offset in the drm device node's address space to be able to 4784f93624eSDaniel Vetter * memory map a dumb buffer. GEM-based drivers must use 4794f93624eSDaniel Vetter * drm_gem_create_mmap_offset() to implement this. 4804f93624eSDaniel Vetter * 4814f93624eSDaniel Vetter * Called by the user via ioctl. 4824f93624eSDaniel Vetter * 4834f93624eSDaniel Vetter * Returns: 4844f93624eSDaniel Vetter * 4854f93624eSDaniel Vetter * Zero on success, negative errno on failure. 4864f93624eSDaniel Vetter */ 48785e634bcSDaniel Vetter int (*dumb_map_offset)(struct drm_file *file_priv, 48885e634bcSDaniel Vetter struct drm_device *dev, uint32_t handle, 48985e634bcSDaniel Vetter uint64_t *offset); 4904f93624eSDaniel Vetter /** 4914f93624eSDaniel Vetter * @dumb_destroy: 4924f93624eSDaniel Vetter * 4934f93624eSDaniel Vetter * This destroys the userspace handle for the given dumb backing storage buffer. 4944f93624eSDaniel Vetter * Since buffer objects must be reference counted in the kernel a buffer object 4954f93624eSDaniel Vetter * won't be immediately freed if a framebuffer modeset object still uses it. 4964f93624eSDaniel Vetter * 4974f93624eSDaniel Vetter * Called by the user via ioctl. 4984f93624eSDaniel Vetter * 4994f93624eSDaniel Vetter * Returns: 5004f93624eSDaniel Vetter * 5014f93624eSDaniel Vetter * Zero on success, negative errno on failure. 5024f93624eSDaniel Vetter */ 50385e634bcSDaniel Vetter int (*dumb_destroy)(struct drm_file *file_priv, 50485e634bcSDaniel Vetter struct drm_device *dev, 50585e634bcSDaniel Vetter uint32_t handle); 50685e634bcSDaniel Vetter 50785e634bcSDaniel Vetter /* Driver private ops for this object */ 50885e634bcSDaniel Vetter const struct vm_operations_struct *gem_vm_ops; 50985e634bcSDaniel Vetter 51085e634bcSDaniel Vetter int major; 51185e634bcSDaniel Vetter int minor; 51285e634bcSDaniel Vetter int patchlevel; 51385e634bcSDaniel Vetter char *name; 51485e634bcSDaniel Vetter char *desc; 51585e634bcSDaniel Vetter char *date; 51685e634bcSDaniel Vetter 51785e634bcSDaniel Vetter u32 driver_features; 518bb2eaba6SDaniel Vetter 519bb2eaba6SDaniel Vetter /** 520bb2eaba6SDaniel Vetter * @ioctls: 521bb2eaba6SDaniel Vetter * 522bb2eaba6SDaniel Vetter * Array of driver-private IOCTL description entries. See the chapter on 523bb2eaba6SDaniel Vetter * :ref:`IOCTL support in the userland interfaces 524bb2eaba6SDaniel Vetter * chapter<drm_driver_ioctl>` for the full details. 525bb2eaba6SDaniel Vetter */ 526bb2eaba6SDaniel Vetter 52785e634bcSDaniel Vetter const struct drm_ioctl_desc *ioctls; 528bb2eaba6SDaniel Vetter /** @num_ioctls: Number of entries in @ioctls. */ 52985e634bcSDaniel Vetter int num_ioctls; 530bb2eaba6SDaniel Vetter 531bb2eaba6SDaniel Vetter /** 532bb2eaba6SDaniel Vetter * @fops: 533bb2eaba6SDaniel Vetter * 534bb2eaba6SDaniel Vetter * File operations for the DRM device node. See the discussion in 535bb2eaba6SDaniel Vetter * :ref:`file operations<drm_driver_fops>` for in-depth coverage and 536bb2eaba6SDaniel Vetter * some examples. 537bb2eaba6SDaniel Vetter */ 53885e634bcSDaniel Vetter const struct file_operations *fops; 53985e634bcSDaniel Vetter 5400683c0abSDaniel Vetter /* Everything below here is for legacy driver, never use! */ 5410683c0abSDaniel Vetter /* private: */ 5420683c0abSDaniel Vetter 54385e634bcSDaniel Vetter /* List of devices hanging off this driver with stealth attach. */ 54485e634bcSDaniel Vetter struct list_head legacy_dev_list; 5450683c0abSDaniel Vetter int (*firstopen) (struct drm_device *); 54645c3d213SDaniel Vetter void (*preclose) (struct drm_device *, struct drm_file *file_priv); 5470683c0abSDaniel Vetter int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv); 5480683c0abSDaniel Vetter int (*dma_quiescent) (struct drm_device *); 5490683c0abSDaniel Vetter int (*context_dtor) (struct drm_device *dev, int context); 5500683c0abSDaniel Vetter int dev_priv_size; 55185e634bcSDaniel Vetter }; 55285e634bcSDaniel Vetter 55391faa047SDaniel Vetter __printf(6, 7) 55485e634bcSDaniel Vetter void drm_dev_printk(const struct device *dev, const char *level, 55585e634bcSDaniel Vetter unsigned int category, const char *function_name, 55685e634bcSDaniel Vetter const char *prefix, const char *format, ...); 55791faa047SDaniel Vetter __printf(3, 4) 55885e634bcSDaniel Vetter void drm_printk(const char *level, unsigned int category, 55985e634bcSDaniel Vetter const char *format, ...); 56085e634bcSDaniel Vetter extern unsigned int drm_debug; 56185e634bcSDaniel Vetter 56285e634bcSDaniel Vetter int drm_dev_init(struct drm_device *dev, 56385e634bcSDaniel Vetter struct drm_driver *driver, 56485e634bcSDaniel Vetter struct device *parent); 565f30c9257SChris Wilson void drm_dev_fini(struct drm_device *dev); 566f30c9257SChris Wilson 56785e634bcSDaniel Vetter struct drm_device *drm_dev_alloc(struct drm_driver *driver, 56885e634bcSDaniel Vetter struct device *parent); 56985e634bcSDaniel Vetter int drm_dev_register(struct drm_device *dev, unsigned long flags); 57085e634bcSDaniel Vetter void drm_dev_unregister(struct drm_device *dev); 57185e634bcSDaniel Vetter 57285e634bcSDaniel Vetter void drm_dev_ref(struct drm_device *dev); 57385e634bcSDaniel Vetter void drm_dev_unref(struct drm_device *dev); 57485e634bcSDaniel Vetter void drm_put_dev(struct drm_device *dev); 57585e634bcSDaniel Vetter void drm_unplug_dev(struct drm_device *dev); 57685e634bcSDaniel Vetter 57763207455SDave Airlie int drm_dev_set_unique(struct drm_device *dev, const char *name); 57863207455SDave Airlie 57963207455SDave Airlie 58085e634bcSDaniel Vetter #endif 581