2 * Internal Header for the Direct Rendering Manager
4 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
5 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
6 * Copyright (c) 2009-2010, Code Aurora Forum.
9 * Author: Rickard E. (Rik) Faith <faith@valinux.com>
10 * Author: Gareth Hughes <gareth@valinux.com>
12 * Permission is hereby granted, free of charge, to any person obtaining a
13 * copy of this software and associated documentation files (the "Software"),
14 * to deal in the Software without restriction, including without limitation
15 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16 * and/or sell copies of the Software, and to permit persons to whom the
17 * Software is furnished to do so, subject to the following conditions:
19 * The above copyright notice and this permission notice (including the next
20 * paragraph) shall be included in all copies or substantial portions of the
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
27 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
28 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
29 * OTHER DEALINGS IN THE SOFTWARE.
35 #include <linux/agp_backend.h>
36 #include <linux/cdev.h>
37 #include <linux/dma-mapping.h>
38 #include <linux/file.h>
40 #include <linux/highmem.h>
41 #include <linux/idr.h>
42 #include <linux/init.h>
44 #include <linux/jiffies.h>
45 #include <linux/kernel.h>
46 #include <linux/kref.h>
47 #include <linux/miscdevice.h>
49 #include <linux/mutex.h>
50 #include <linux/pci.h>
51 #include <linux/platform_device.h>
52 #include <linux/poll.h>
53 #include <linux/ratelimit.h>
54 #include <linux/sched.h>
55 #include <linux/slab.h>
56 #include <linux/types.h>
57 #include <linux/vmalloc.h>
58 #include <linux/workqueue.h>
61 #include <asm/pgalloc.h>
62 #include <asm/uaccess.h>
64 #include <uapi/drm/drm.h>
65 #include <uapi/drm/drm_mode.h>
67 #include <drm/drm_agpsupport.h>
68 #include <drm/drm_crtc.h>
69 #include <drm/drm_global.h>
70 #include <drm/drm_hashtab.h>
71 #include <drm/drm_mem_util.h>
72 #include <drm/drm_mm.h>
73 #include <drm/drm_os_linux.h>
74 #include <drm/drm_sarea.h>
75 #include <drm/drm_vma_manager.h>
83 struct drm_device_dma;
84 struct drm_dma_handle;
85 struct drm_gem_object;
89 struct reservation_object;
90 struct dma_buf_attachment;
93 * 4 debug categories are defined:
95 * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
96 * This is the category used by the DRM_DEBUG() macro.
98 * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
99 * This is the category used by the DRM_DEBUG_DRIVER() macro.
101 * KMS: used in the modesetting code.
102 * This is the category used by the DRM_DEBUG_KMS() macro.
104 * PRIME: used in the prime code.
105 * This is the category used by the DRM_DEBUG_PRIME() macro.
107 * ATOMIC: used in the atomic code.
108 * This is the category used by the DRM_DEBUG_ATOMIC() macro.
110 * VBL: used for verbose debug message in the vblank code
111 * This is the category used by the DRM_DEBUG_VBL() macro.
113 * Enabling verbose debug messages is done through the drm.debug parameter,
114 * each category being enabled by a bit.
116 * drm.debug=0x1 will enable CORE messages
117 * drm.debug=0x2 will enable DRIVER messages
118 * drm.debug=0x3 will enable CORE and DRIVER messages
120 * drm.debug=0x3f will enable all messages
122 * An interesting feature is that it's possible to enable verbose logging at
123 * run-time by echoing the debug value in its sysfs node:
124 * # echo 0xf > /sys/module/drm/parameters/debug
126 #define DRM_UT_NONE 0x00
127 #define DRM_UT_CORE 0x01
128 #define DRM_UT_DRIVER 0x02
129 #define DRM_UT_KMS 0x04
130 #define DRM_UT_PRIME 0x08
131 #define DRM_UT_ATOMIC 0x10
132 #define DRM_UT_VBL 0x20
134 extern __printf(6, 7)
135 void drm_dev_printk(const struct device *dev, const char *level,
136 unsigned int category, const char *function_name,
137 const char *prefix, const char *format, ...);
139 extern __printf(5, 6)
140 void drm_printk(const char *level, unsigned int category,
141 const char *function_name, const char *prefix,
142 const char *format, ...);
144 /***********************************************************************/
145 /** \name DRM template customization defaults */
148 /* driver capabilities and requirements mask */
149 #define DRIVER_USE_AGP 0x1
150 #define DRIVER_PCI_DMA 0x8
151 #define DRIVER_SG 0x10
152 #define DRIVER_HAVE_DMA 0x20
153 #define DRIVER_HAVE_IRQ 0x40
154 #define DRIVER_IRQ_SHARED 0x80
155 #define DRIVER_GEM 0x1000
156 #define DRIVER_MODESET 0x2000
157 #define DRIVER_PRIME 0x4000
158 #define DRIVER_RENDER 0x8000
159 #define DRIVER_ATOMIC 0x10000
160 #define DRIVER_KMS_LEGACY_CONTEXT 0x20000
162 /***********************************************************************/
163 /** \name Macros to make printk easier */
169 * \param fmt printf() like format string.
170 * \param arg arguments
172 #define DRM_DEV_ERROR(dev, fmt, ...) \
173 drm_dev_printk(dev, KERN_ERR, DRM_UT_NONE, __func__, " *ERROR*",\
175 #define DRM_ERROR(fmt, ...) \
176 drm_printk(KERN_ERR, DRM_UT_NONE, __func__, " *ERROR*", fmt, \
180 * Rate limited error output. Like DRM_ERROR() but won't flood the log.
182 * \param fmt printf() like format string.
183 * \param arg arguments
185 #define DRM_DEV_ERROR_RATELIMITED(dev, fmt, ...) \
187 static DEFINE_RATELIMIT_STATE(_rs, \
188 DEFAULT_RATELIMIT_INTERVAL, \
189 DEFAULT_RATELIMIT_BURST); \
191 if (__ratelimit(&_rs)) \
192 DRM_DEV_ERROR(dev, fmt, ##__VA_ARGS__); \
194 #define DRM_ERROR_RATELIMITED(fmt, ...) \
195 DRM_DEV_ERROR_RATELIMITED(NULL, fmt, ##__VA_ARGS__)
197 #define DRM_DEV_INFO(dev, fmt, ...) \
198 drm_dev_printk(dev, KERN_INFO, DRM_UT_NONE, __func__, "", fmt, \
200 #define DRM_INFO(fmt, ...) \
201 drm_printk(KERN_INFO, DRM_UT_NONE, __func__, "", fmt, ##__VA_ARGS__)
203 #define DRM_DEV_INFO_ONCE(dev, fmt, ...) \
205 static bool __print_once __read_mostly; \
206 if (!__print_once) { \
207 __print_once = true; \
208 DRM_DEV_INFO(dev, fmt, ##__VA_ARGS__); \
211 #define DRM_INFO_ONCE(fmt, ...) DRM_DEV_INFO_ONCE(NULL, fmt, ##__VA_ARGS__)
216 * \param fmt printf() like format string.
217 * \param arg arguments
219 #define DRM_DEV_DEBUG(dev, fmt, args...) \
220 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_CORE, __func__, "", fmt, \
222 #define DRM_DEBUG(fmt, args...) \
223 drm_printk(KERN_DEBUG, DRM_UT_CORE, __func__, "", fmt, ##args)
225 #define DRM_DEV_DEBUG_DRIVER(dev, fmt, args...) \
226 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_DRIVER, __func__, "", \
228 #define DRM_DEBUG_DRIVER(fmt, args...) \
229 drm_printk(KERN_DEBUG, DRM_UT_DRIVER, __func__, "", fmt, ##args)
231 #define DRM_DEV_DEBUG_KMS(dev, fmt, args...) \
232 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_KMS, __func__, "", fmt, \
234 #define DRM_DEBUG_KMS(fmt, args...) \
235 drm_printk(KERN_DEBUG, DRM_UT_KMS, __func__, "", fmt, ##args)
237 #define DRM_DEV_DEBUG_PRIME(dev, fmt, args...) \
238 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_PRIME, __func__, "", \
240 #define DRM_DEBUG_PRIME(fmt, args...) \
241 drm_printk(KERN_DEBUG, DRM_UT_PRIME, __func__, "", fmt, ##args)
243 #define DRM_DEV_DEBUG_ATOMIC(dev, fmt, args...) \
244 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_ATOMIC, __func__, "", \
246 #define DRM_DEBUG_ATOMIC(fmt, args...) \
247 drm_printk(KERN_DEBUG, DRM_UT_ATOMIC, __func__, "", fmt, ##args)
249 #define DRM_DEV_DEBUG_VBL(dev, fmt, args...) \
250 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_VBL, __func__, "", fmt, \
252 #define DRM_DEBUG_VBL(fmt, args...) \
253 drm_printk(KERN_DEBUG, DRM_UT_VBL, __func__, "", fmt, ##args)
255 #define _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, level, fmt, args...) \
257 static DEFINE_RATELIMIT_STATE(_rs, \
258 DEFAULT_RATELIMIT_INTERVAL, \
259 DEFAULT_RATELIMIT_BURST); \
260 if (__ratelimit(&_rs)) \
261 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_ ## level, \
262 __func__, "", fmt, ##args); \
266 * Rate limited debug output. Like DRM_DEBUG() but won't flood the log.
268 * \param fmt printf() like format string.
269 * \param arg arguments
271 #define DRM_DEV_DEBUG_RATELIMITED(dev, fmt, args...) \
272 DEV__DRM_DEFINE_DEBUG_RATELIMITED(dev, CORE, fmt, ##args)
273 #define DRM_DEBUG_RATELIMITED(fmt, args...) \
274 DRM_DEV_DEBUG_RATELIMITED(NULL, fmt, ##args)
275 #define DRM_DEV_DEBUG_DRIVER_RATELIMITED(dev, fmt, args...) \
276 _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, DRIVER, fmt, ##args)
277 #define DRM_DEBUG_DRIVER_RATELIMITED(fmt, args...) \
278 DRM_DEV_DEBUG_DRIVER_RATELIMITED(NULL, fmt, ##args)
279 #define DRM_DEV_DEBUG_KMS_RATELIMITED(dev, fmt, args...) \
280 _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, KMS, fmt, ##args)
281 #define DRM_DEBUG_KMS_RATELIMITED(fmt, args...) \
282 DRM_DEV_DEBUG_KMS_RATELIMITED(NULL, fmt, ##args)
283 #define DRM_DEV_DEBUG_PRIME_RATELIMITED(dev, fmt, args...) \
284 _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, PRIME, fmt, ##args)
285 #define DRM_DEBUG_PRIME_RATELIMITED(fmt, args...) \
286 DRM_DEV_DEBUG_PRIME_RATELIMITED(NULL, fmt, ##args)
290 /***********************************************************************/
291 /** \name Internal types and structures */
294 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
297 * Ioctl function type.
299 * \param inode device inode.
300 * \param file_priv DRM file private pointer.
301 * \param cmd command.
302 * \param arg argument.
304 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
305 struct drm_file *file_priv);
307 typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
310 #define DRM_IOCTL_NR(n) _IOC_NR(n)
311 #define DRM_MAJOR 226
314 #define DRM_MASTER 0x2
315 #define DRM_ROOT_ONLY 0x4
316 #define DRM_CONTROL_ALLOW 0x8
317 #define DRM_UNLOCKED 0x10
318 #define DRM_RENDER_ALLOW 0x20
320 struct drm_ioctl_desc {
328 * Creates a driver or general drm_ioctl_desc array entry for the given
329 * ioctl, for use by drm_ioctl().
332 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags) \
333 [DRM_IOCTL_NR(DRM_IOCTL_##ioctl) - DRM_COMMAND_BASE] = { \
334 .cmd = DRM_IOCTL_##ioctl, \
340 /* Event queued up for userspace to read */
341 struct drm_pending_event {
342 struct drm_event *event;
343 struct list_head link;
344 struct drm_file *file_priv;
345 pid_t pid; /* pid of requester, no guarantee it's valid by the time
346 we deliver the event, for tracing only */
347 void (*destroy)(struct drm_pending_event *event);
350 /* initial implementaton using a linked list - todo hashtab */
351 struct drm_prime_file_private {
352 struct list_head head;
356 /** File private data */
358 unsigned authenticated :1;
359 /* Whether we're master for a minor. Protected by master_mutex */
360 unsigned is_master :1;
361 /* true when the client has asked us to expose stereo 3D mode flags */
362 unsigned stereo_allowed :1;
364 * true if client understands CRTC primary planes and cursor planes
367 unsigned universal_planes:1;
368 /* true if client understands atomic properties */
371 * true if client understands share planes and
372 * hardware support share planes.
374 unsigned share_planes:1;
376 * This client is allowed to gain master privileges for @master.
377 * Protected by struct drm_device::master_mutex.
379 unsigned allowed_master:1;
384 struct list_head lhead;
385 struct drm_minor *minor;
386 unsigned long lock_count;
388 /** Mapping of mm object handles to object pointers. */
389 struct idr object_idr;
390 /** Lock for synchronization of access to object_idr. */
391 spinlock_t table_lock;
396 struct drm_master *master; /* master this node is currently associated with
397 N.B. not always minor->master */
399 * fbs - List of framebuffers associated with this file.
401 * Protected by fbs_lock. Note that the fbs list holds a reference on
402 * the fb object to prevent it from untimely disappearing.
404 struct list_head fbs;
405 struct mutex fbs_lock;
407 /** User-created blob properties; this retains a reference on the
409 struct list_head blobs;
411 wait_queue_head_t event_wait;
412 struct list_head event_list;
415 struct drm_prime_file_private prime;
421 struct drm_lock_data {
422 struct drm_hw_lock *hw_lock; /**< Hardware lock */
423 /** Private of lock holder's file (NULL=kernel) */
424 struct drm_file *file_priv;
425 wait_queue_head_t lock_queue; /**< Queue of blocked processes */
426 unsigned long lock_time; /**< Time of last lock in jiffies */
428 uint32_t kernel_waiters;
429 uint32_t user_waiters;
434 * struct drm_master - drm master structure
436 * @refcount: Refcount for this master object.
437 * @minor: Link back to minor char device we are master for. Immutable.
438 * @unique: Unique identifier: e.g. busid. Protected by drm_global_mutex.
439 * @unique_len: Length of unique field. Protected by drm_global_mutex.
440 * @magic_map: Map of used authentication tokens. Protected by struct_mutex.
441 * @lock: DRI lock information.
442 * @driver_priv: Pointer to driver-private information.
445 struct kref refcount;
446 struct drm_minor *minor;
449 struct idr magic_map;
450 struct drm_lock_data lock;
454 /* Size of ringbuffer for vblank timestamps. Just double-buffer
455 * in initial implementation.
457 #define DRM_VBLANKTIME_RBSIZE 2
459 /* Flags and return codes for get_vblank_timestamp() driver function. */
460 #define DRM_CALLED_FROM_VBLIRQ 1
461 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
462 #define DRM_VBLANKTIME_IN_VBLANK (1 << 1)
464 /* get_scanout_position() return flags */
465 #define DRM_SCANOUTPOS_VALID (1 << 0)
466 #define DRM_SCANOUTPOS_IN_VBLANK (1 << 1)
467 #define DRM_SCANOUTPOS_ACCURATE (1 << 2)
470 * DRM driver structure. This structure represent the common code for
471 * a family of cards. There will one drm_device for each card present
475 int (*load) (struct drm_device *, unsigned long flags);
476 int (*firstopen) (struct drm_device *);
477 int (*open) (struct drm_device *, struct drm_file *);
478 void (*preclose) (struct drm_device *, struct drm_file *file_priv);
479 void (*postclose) (struct drm_device *, struct drm_file *);
480 void (*lastclose) (struct drm_device *);
481 int (*unload) (struct drm_device *);
482 int (*suspend) (struct drm_device *, pm_message_t state);
483 int (*resume) (struct drm_device *);
484 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
485 int (*dma_quiescent) (struct drm_device *);
486 int (*context_dtor) (struct drm_device *dev, int context);
487 int (*set_busid)(struct drm_device *dev, struct drm_master *master);
490 * get_vblank_counter - get raw hardware vblank counter
492 * @pipe: counter to fetch
494 * Driver callback for fetching a raw hardware vblank counter for @crtc.
495 * If a device doesn't have a hardware counter, the driver can simply
496 * return the value of drm_vblank_count. The DRM core will account for
497 * missed vblank events while interrupts where disabled based on system
500 * Wraparound handling and loss of events due to modesetting is dealt
501 * with in the DRM core code.
504 * Raw vblank counter value.
506 u32 (*get_vblank_counter) (struct drm_device *dev, unsigned int pipe);
509 * enable_vblank - enable vblank interrupt events
511 * @pipe: which irq to enable
513 * Enable vblank interrupts for @crtc. If the device doesn't have
514 * a hardware vblank counter, this routine should be a no-op, since
515 * interrupts will have to stay on to keep the count accurate.
518 * Zero on success, appropriate errno if the given @crtc's vblank
519 * interrupt cannot be enabled.
521 int (*enable_vblank) (struct drm_device *dev, unsigned int pipe);
524 * disable_vblank - disable vblank interrupt events
526 * @pipe: which irq to enable
528 * Disable vblank interrupts for @crtc. If the device doesn't have
529 * a hardware vblank counter, this routine should be a no-op, since
530 * interrupts will have to stay on to keep the count accurate.
532 void (*disable_vblank) (struct drm_device *dev, unsigned int pipe);
535 * Called by \c drm_device_is_agp. Typically used to determine if a
536 * card is really attached to AGP or not.
538 * \param dev DRM device handle
541 * One of three values is returned depending on whether or not the
542 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
543 * (return of 1), or may or may not be AGP (return of 2).
545 int (*device_is_agp) (struct drm_device *dev);
548 * Called by vblank timestamping code.
550 * Return the current display scanout position from a crtc, and an
551 * optional accurate ktime_get timestamp of when position was measured.
553 * \param dev DRM device.
554 * \param pipe Id of the crtc to query.
555 * \param flags Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
556 * \param *vpos Target location for current vertical scanout position.
557 * \param *hpos Target location for current horizontal scanout position.
558 * \param *stime Target location for timestamp taken immediately before
559 * scanout position query. Can be NULL to skip timestamp.
560 * \param *etime Target location for timestamp taken immediately after
561 * scanout position query. Can be NULL to skip timestamp.
562 * \param mode Current display timings.
564 * Returns vpos as a positive number while in active scanout area.
565 * Returns vpos as a negative number inside vblank, counting the number
566 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
567 * until start of active scanout / end of vblank."
569 * \return Flags, or'ed together as follows:
571 * DRM_SCANOUTPOS_VALID = Query successful.
572 * DRM_SCANOUTPOS_INVBL = Inside vblank.
573 * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
574 * this flag means that returned position may be offset by a constant
575 * but unknown small number of scanlines wrt. real scanout position.
578 int (*get_scanout_position) (struct drm_device *dev, unsigned int pipe,
579 unsigned int flags, int *vpos, int *hpos,
580 ktime_t *stime, ktime_t *etime,
581 const struct drm_display_mode *mode);
584 * Called by \c drm_get_last_vbltimestamp. Should return a precise
585 * timestamp when the most recent VBLANK interval ended or will end.
587 * Specifically, the timestamp in @vblank_time should correspond as
588 * closely as possible to the time when the first video scanline of
589 * the video frame after the end of VBLANK will start scanning out,
590 * the time immediately after end of the VBLANK interval. If the
591 * @crtc is currently inside VBLANK, this will be a time in the future.
592 * If the @crtc is currently scanning out a frame, this will be the
593 * past start time of the current scanout. This is meant to adhere
594 * to the OpenML OML_sync_control extension specification.
596 * \param dev dev DRM device handle.
597 * \param pipe crtc for which timestamp should be returned.
598 * \param *max_error Maximum allowable timestamp error in nanoseconds.
599 * Implementation should strive to provide timestamp
600 * with an error of at most *max_error nanoseconds.
601 * Returns true upper bound on error for timestamp.
602 * \param *vblank_time Target location for returned vblank timestamp.
603 * \param flags 0 = Defaults, no special treatment needed.
604 * \param DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
605 * irq handler. Some drivers need to apply some workarounds
606 * for gpu-specific vblank irq quirks if flag is set.
609 * Zero if timestamping isn't supported in current display mode or a
610 * negative number on failure. A positive status code on success,
611 * which describes how the vblank_time timestamp was computed.
613 int (*get_vblank_timestamp) (struct drm_device *dev, unsigned int pipe,
615 struct timeval *vblank_time,
618 /* these have to be filled in */
620 irqreturn_t(*irq_handler) (int irq, void *arg);
621 void (*irq_preinstall) (struct drm_device *dev);
622 int (*irq_postinstall) (struct drm_device *dev);
623 void (*irq_uninstall) (struct drm_device *dev);
625 /* Master routines */
626 int (*master_create)(struct drm_device *dev, struct drm_master *master);
627 void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
629 * master_set is called whenever the minor master is set.
630 * master_drop is called whenever the minor master is dropped.
633 int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
635 void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv,
638 int (*debugfs_init)(struct drm_minor *minor);
639 void (*debugfs_cleanup)(struct drm_minor *minor);
642 * Driver-specific constructor for drm_gem_objects, to set up
643 * obj->driver_private.
645 * Returns 0 on success.
647 void (*gem_free_object) (struct drm_gem_object *obj);
648 int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
649 void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
652 /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
653 int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
654 uint32_t handle, uint32_t flags, int *prime_fd);
655 /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
656 int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
657 int prime_fd, uint32_t *handle);
658 /* export GEM -> dmabuf */
659 struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
660 struct drm_gem_object *obj, int flags);
661 /* import dmabuf -> GEM */
662 struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
663 struct dma_buf *dma_buf);
664 /* low-level interface used by drm_gem_prime_{import,export} */
665 int (*gem_prime_pin)(struct drm_gem_object *obj);
666 void (*gem_prime_unpin)(struct drm_gem_object *obj);
667 struct reservation_object * (*gem_prime_res_obj)(
668 struct drm_gem_object *obj);
669 struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj);
670 struct drm_gem_object *(*gem_prime_import_sg_table)(
671 struct drm_device *dev,
672 struct dma_buf_attachment *attach,
673 struct sg_table *sgt);
674 void *(*gem_prime_vmap)(struct drm_gem_object *obj);
675 void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr);
676 int (*gem_prime_mmap)(struct drm_gem_object *obj,
677 struct vm_area_struct *vma);
679 /* vga arb irq handler */
680 void (*vgaarb_irq)(struct drm_device *dev, bool state);
682 /* dumb alloc support */
683 int (*dumb_create)(struct drm_file *file_priv,
684 struct drm_device *dev,
685 struct drm_mode_create_dumb *args);
686 int (*dumb_map_offset)(struct drm_file *file_priv,
687 struct drm_device *dev, uint32_t handle,
689 int (*dumb_destroy)(struct drm_file *file_priv,
690 struct drm_device *dev,
693 /* Driver private ops for this object */
694 const struct vm_operations_struct *gem_vm_ops;
705 const struct drm_ioctl_desc *ioctls;
707 const struct file_operations *fops;
709 /* List of devices hanging off this driver with stealth attach. */
710 struct list_head legacy_dev_list;
713 enum drm_minor_type {
721 * Info file list entry. This structure represents a debugfs or proc file to
722 * be created by the drm core
724 struct drm_info_list {
725 const char *name; /** file name */
726 int (*show)(struct seq_file*, void*); /** show callback */
727 u32 driver_features; /**< Required driver features for this entry */
732 * debugfs node structure. This structure represents a debugfs file.
734 struct drm_info_node {
735 struct list_head list;
736 struct drm_minor *minor;
737 const struct drm_info_list *info_ent;
742 * DRM minor structure. This structure represents a drm minor number.
745 int index; /**< Minor device number */
746 int type; /**< Control or render */
747 struct device *kdev; /**< Linux device */
748 struct drm_device *dev;
750 struct dentry *debugfs_root;
752 struct list_head debugfs_list;
753 struct mutex debugfs_lock; /* Protects debugfs_list. */
755 /* currently active master for this node. Protected by master_mutex */
756 struct drm_master *master;
760 struct drm_pending_vblank_event {
761 struct drm_pending_event base;
763 struct drm_event_vblank event;
766 struct drm_vblank_crtc {
767 struct drm_device *dev; /* pointer to the drm_device */
768 wait_queue_head_t queue; /**< VBLANK wait queue */
769 struct timer_list disable_timer; /* delayed disable timer */
771 /* vblank counter, protected by dev->vblank_time_lock for writes */
773 /* vblank timestamps, protected by dev->vblank_time_lock for writes */
774 struct timeval time[DRM_VBLANKTIME_RBSIZE];
776 atomic_t refcount; /* number of users of vblank interruptsper crtc */
777 u32 last; /* protected by dev->vbl_lock, used */
778 /* for wraparound handling */
779 u32 last_wait; /* Last vblank seqno waited per CRTC */
780 unsigned int inmodeset; /* Display driver is setting mode */
781 unsigned int pipe; /* crtc index */
782 int framedur_ns; /* frame/field duration in ns */
783 int linedur_ns; /* line duration in ns */
784 bool enabled; /* so we don't call enable more than
789 * DRM device structure. This structure represent a complete card that
790 * may contain multiple heads.
793 struct list_head legacy_dev_list;/**< list of devices per driver for stealth attach cleanup */
794 int if_version; /**< Highest interface version set */
796 /** \name Lifetime Management */
798 struct kref ref; /**< Object ref-count */
799 struct device *dev; /**< Device structure of bus-device */
800 struct drm_driver *driver; /**< DRM driver managing the device */
801 void *dev_private; /**< DRM driver private data */
802 struct drm_minor *control; /**< Control node */
803 struct drm_minor *primary; /**< Primary node */
804 struct drm_minor *render; /**< Render node */
805 atomic_t unplugged; /**< Flag whether dev is dead */
806 struct inode *anon_inode; /**< inode for private address-space */
807 char *unique; /**< unique name of the device */
812 struct mutex struct_mutex; /**< For others */
813 struct mutex master_mutex; /**< For drm_minor::master and drm_file::is_master */
816 /** \name Usage Counters */
818 int open_count; /**< Outstanding files open, protected by drm_global_mutex. */
819 spinlock_t buf_lock; /**< For drm_device::buf_use and a few other things. */
820 int buf_use; /**< Buffers in use -- cannot alloc */
821 atomic_t buf_alloc; /**< Buffer allocation in progress */
824 struct list_head filelist;
826 /** \name Memory management */
828 struct list_head maplist; /**< Linked list of regions */
829 struct drm_open_hash map_hash; /**< User token hash table for maps */
831 /** \name Context handle management */
833 struct list_head ctxlist; /**< Linked list of context handles */
834 struct mutex ctxlist_mutex; /**< For ctxlist */
838 struct list_head vmalist; /**< List of vmas (for debugging) */
842 /** \name DMA support */
844 struct drm_device_dma *dma; /**< Optional pointer for DMA support */
847 /** \name Context support */
850 __volatile__ long context_flag; /**< Context swapping flag */
851 int last_context; /**< Last current context */
854 /** \name VBLANK IRQ support */
860 * At load time, disabling the vblank interrupt won't be allowed since
861 * old clients may not call the modeset ioctl and therefore misbehave.
862 * Once the modeset ioctl *has* been called though, we can safely
863 * disable them when unused.
865 bool vblank_disable_allowed;
868 * If true, vblank interrupt will be disabled immediately when the
869 * refcount drops to zero, as opposed to via the vblank disable
871 * This can be set to true it the hardware has a working vblank
872 * counter and the driver uses drm_vblank_on() and drm_vblank_off()
875 bool vblank_disable_immediate;
877 /* array of size num_crtcs */
878 struct drm_vblank_crtc *vblank;
880 spinlock_t vblank_time_lock; /**< Protects vblank count and time updates during vblank enable/disable */
883 u32 max_vblank_count; /**< size of vblank counter register */
888 struct list_head vblank_event_list;
889 spinlock_t event_lock;
893 struct drm_agp_head *agp; /**< AGP data */
895 struct pci_dev *pdev; /**< PCI device structure */
897 struct pci_controller *hose;
900 struct platform_device *platformdev; /**< Platform device struture */
901 struct virtio_device *virtdev;
903 struct drm_sg_mem *sg; /**< Scatter gather memory */
904 unsigned int num_crtcs; /**< Number of CRTCs on this device */
908 struct drm_hw_lock *lock;
911 struct drm_local_map *agp_buffer_map;
912 unsigned int agp_buffer_token;
914 struct drm_mode_config mode_config; /**< Current mode config */
916 /** \name GEM information */
918 struct mutex object_name_lock;
919 struct idr object_name_idr;
920 struct drm_vma_offset_manager *vma_offset_manager;
922 int switch_power_state;
925 #define DRM_SWITCH_POWER_ON 0
926 #define DRM_SWITCH_POWER_OFF 1
927 #define DRM_SWITCH_POWER_CHANGING 2
928 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
930 static __inline__ int drm_core_check_feature(struct drm_device *dev,
933 return ((dev->driver->driver_features & feature) ? 1 : 0);
936 static inline void drm_device_set_unplugged(struct drm_device *dev)
939 atomic_set(&dev->unplugged, 1);
942 static inline int drm_device_is_unplugged(struct drm_device *dev)
944 int ret = atomic_read(&dev->unplugged);
949 static inline bool drm_is_render_client(const struct drm_file *file_priv)
951 return file_priv->minor->type == DRM_MINOR_RENDER;
954 static inline bool drm_is_control_client(const struct drm_file *file_priv)
956 return file_priv->minor->type == DRM_MINOR_CONTROL;
959 static inline bool drm_is_primary_client(const struct drm_file *file_priv)
961 return file_priv->minor->type == DRM_MINOR_LEGACY;
964 /******************************************************************/
965 /** \name Internal function definitions */
968 /* Driver support (drm_drv.h) */
969 extern int drm_ioctl_permit(u32 flags, struct drm_file *file_priv);
970 extern long drm_ioctl(struct file *filp,
971 unsigned int cmd, unsigned long arg);
972 extern long drm_compat_ioctl(struct file *filp,
973 unsigned int cmd, unsigned long arg);
974 extern bool drm_ioctl_flags(unsigned int nr, unsigned int *flags);
976 /* Device support (drm_fops.h) */
977 extern int drm_open(struct inode *inode, struct file *filp);
978 extern ssize_t drm_read(struct file *filp, char __user *buffer,
979 size_t count, loff_t *offset);
980 extern int drm_release(struct inode *inode, struct file *filp);
981 extern int drm_new_set_master(struct drm_device *dev, struct drm_file *fpriv);
983 /* Mapping support (drm_vm.h) */
984 extern unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait);
986 /* Misc. IOCTL support (drm_ioctl.c) */
987 int drm_noop(struct drm_device *dev, void *data,
988 struct drm_file *file_priv);
989 int drm_invalid_op(struct drm_device *dev, void *data,
990 struct drm_file *file_priv);
992 /* Cache management (drm_cache.c) */
993 void drm_clflush_pages(struct page *pages[], unsigned long num_pages);
994 void drm_clflush_sg(struct sg_table *st);
995 void drm_clflush_virt_range(void *addr, unsigned long length);
998 * These are exported to drivers so that they can implement fencing using
999 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1002 /* IRQ support (drm_irq.h) */
1003 extern int drm_irq_install(struct drm_device *dev, int irq);
1004 extern int drm_irq_uninstall(struct drm_device *dev);
1006 extern int drm_vblank_init(struct drm_device *dev, unsigned int num_crtcs);
1007 extern int drm_wait_vblank(struct drm_device *dev, void *data,
1008 struct drm_file *filp);
1009 extern u32 drm_vblank_count(struct drm_device *dev, unsigned int pipe);
1010 extern u32 drm_crtc_vblank_count(struct drm_crtc *crtc);
1011 extern u32 drm_vblank_count_and_time(struct drm_device *dev, unsigned int pipe,
1012 struct timeval *vblanktime);
1013 extern u32 drm_crtc_vblank_count_and_time(struct drm_crtc *crtc,
1014 struct timeval *vblanktime);
1015 extern void drm_send_vblank_event(struct drm_device *dev, unsigned int pipe,
1016 struct drm_pending_vblank_event *e);
1017 extern void drm_crtc_send_vblank_event(struct drm_crtc *crtc,
1018 struct drm_pending_vblank_event *e);
1019 extern void drm_arm_vblank_event(struct drm_device *dev, unsigned int pipe,
1020 struct drm_pending_vblank_event *e);
1021 extern void drm_crtc_arm_vblank_event(struct drm_crtc *crtc,
1022 struct drm_pending_vblank_event *e);
1023 extern bool drm_handle_vblank(struct drm_device *dev, unsigned int pipe);
1024 extern bool drm_crtc_handle_vblank(struct drm_crtc *crtc);
1025 extern int drm_vblank_get(struct drm_device *dev, unsigned int pipe);
1026 extern void drm_vblank_put(struct drm_device *dev, unsigned int pipe);
1027 extern int drm_crtc_vblank_get(struct drm_crtc *crtc);
1028 extern void drm_crtc_vblank_put(struct drm_crtc *crtc);
1029 extern void drm_wait_one_vblank(struct drm_device *dev, unsigned int pipe);
1030 extern void drm_crtc_wait_one_vblank(struct drm_crtc *crtc);
1031 extern void drm_vblank_off(struct drm_device *dev, unsigned int pipe);
1032 extern void drm_vblank_on(struct drm_device *dev, unsigned int pipe);
1033 extern void drm_crtc_vblank_off(struct drm_crtc *crtc);
1034 extern void drm_crtc_vblank_reset(struct drm_crtc *crtc);
1035 extern void drm_crtc_vblank_on(struct drm_crtc *crtc);
1036 extern void drm_vblank_cleanup(struct drm_device *dev);
1037 extern u32 drm_vblank_no_hw_counter(struct drm_device *dev, unsigned int pipe);
1039 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
1040 unsigned int pipe, int *max_error,
1041 struct timeval *vblank_time,
1043 const struct drm_display_mode *mode);
1044 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc,
1045 const struct drm_display_mode *mode);
1048 * drm_crtc_vblank_waitqueue - get vblank waitqueue for the CRTC
1049 * @crtc: which CRTC's vblank waitqueue to retrieve
1051 * This function returns a pointer to the vblank waitqueue for the CRTC.
1052 * Drivers can use this to implement vblank waits using wait_event() & co.
1054 static inline wait_queue_head_t *drm_crtc_vblank_waitqueue(struct drm_crtc *crtc)
1056 return &crtc->dev->vblank[drm_crtc_index(crtc)].queue;
1059 /* Modesetting support */
1060 extern void drm_vblank_pre_modeset(struct drm_device *dev, unsigned int pipe);
1061 extern void drm_vblank_post_modeset(struct drm_device *dev, unsigned int pipe);
1063 /* Stub support (drm_stub.h) */
1064 extern struct drm_master *drm_master_get(struct drm_master *master);
1065 extern void drm_master_put(struct drm_master **master);
1067 extern void drm_put_dev(struct drm_device *dev);
1068 extern void drm_unplug_dev(struct drm_device *dev);
1069 extern unsigned int drm_debug;
1070 extern bool drm_atomic;
1072 /* Debugfs support */
1073 #if defined(CONFIG_DEBUG_FS)
1074 extern int drm_debugfs_create_files(const struct drm_info_list *files,
1075 int count, struct dentry *root,
1076 struct drm_minor *minor);
1077 extern int drm_debugfs_remove_files(const struct drm_info_list *files,
1078 int count, struct drm_minor *minor);
1080 static inline int drm_debugfs_create_files(const struct drm_info_list *files,
1081 int count, struct dentry *root,
1082 struct drm_minor *minor)
1087 static inline int drm_debugfs_remove_files(const struct drm_info_list *files,
1088 int count, struct drm_minor *minor)
1094 extern struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
1095 struct drm_gem_object *obj,
1097 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1098 struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1100 extern struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
1101 struct dma_buf *dma_buf);
1102 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1103 struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1104 extern void drm_gem_dmabuf_release(struct dma_buf *dma_buf);
1106 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
1107 dma_addr_t *addrs, int max_pages);
1108 extern struct sg_table *drm_prime_pages_to_sg(struct page **pages, unsigned int nr_pages);
1109 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1112 extern struct drm_dma_handle *drm_pci_alloc(struct drm_device *dev, size_t size,
1114 extern void drm_pci_free(struct drm_device *dev, struct drm_dma_handle * dmah);
1116 /* sysfs support (drm_sysfs.c) */
1117 extern void drm_sysfs_hotplug_event(struct drm_device *dev);
1120 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
1121 struct device *parent);
1122 void drm_dev_ref(struct drm_device *dev);
1123 void drm_dev_unref(struct drm_device *dev);
1124 int drm_dev_register(struct drm_device *dev, unsigned long flags);
1125 void drm_dev_unregister(struct drm_device *dev);
1126 int drm_dev_set_unique(struct drm_device *dev, const char *fmt, ...);
1128 struct drm_minor *drm_minor_acquire(unsigned int minor_id);
1129 void drm_minor_release(struct drm_minor *minor);
1131 struct drm_device *drm_device_get_by_name(const char *name);
1133 static inline struct drm_device *drm_device_get_by_name(const char *name)
1142 static __inline__ int drm_pci_device_is_agp(struct drm_device *dev)
1144 if (dev->driver->device_is_agp != NULL) {
1145 int err = (*dev->driver->device_is_agp) (dev);
1152 return pci_find_capability(dev->pdev, PCI_CAP_ID_AGP);
1154 void drm_pci_agp_destroy(struct drm_device *dev);
1156 extern int drm_pci_init(struct drm_driver *driver, struct pci_driver *pdriver);
1157 extern void drm_pci_exit(struct drm_driver *driver, struct pci_driver *pdriver);
1159 extern int drm_get_pci_dev(struct pci_dev *pdev,
1160 const struct pci_device_id *ent,
1161 struct drm_driver *driver);
1162 extern int drm_pci_set_busid(struct drm_device *dev, struct drm_master *master);
1164 static inline int drm_get_pci_dev(struct pci_dev *pdev,
1165 const struct pci_device_id *ent,
1166 struct drm_driver *driver)
1171 static inline int drm_pci_set_busid(struct drm_device *dev,
1172 struct drm_master *master)
1178 #define DRM_PCIE_SPEED_25 1
1179 #define DRM_PCIE_SPEED_50 2
1180 #define DRM_PCIE_SPEED_80 4
1182 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1184 /* platform section */
1185 extern int drm_platform_init(struct drm_driver *driver, struct platform_device *platform_device);
1186 extern int drm_platform_set_busid(struct drm_device *d, struct drm_master *m);
1188 /* returns true if currently okay to sleep */
1189 static __inline__ bool drm_can_sleep(void)
1191 if (in_atomic() || in_dbg_master() || irqs_disabled())