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 * Enabling verbose debug messages is done through the drm.debug parameter,
111 * each category being enabled by a bit.
113 * drm.debug=0x1 will enable CORE messages
114 * drm.debug=0x2 will enable DRIVER messages
115 * drm.debug=0x3 will enable CORE and DRIVER messages
117 * drm.debug=0xf will enable all messages
119 * An interesting feature is that it's possible to enable verbose logging at
120 * run-time by echoing the debug value in its sysfs node:
121 * # echo 0xf > /sys/module/drm/parameters/debug
123 #define DRM_UT_CORE 0x01
124 #define DRM_UT_DRIVER 0x02
125 #define DRM_UT_KMS 0x04
126 #define DRM_UT_PRIME 0x08
127 #define DRM_UT_ATOMIC 0x10
129 extern __printf(2, 3)
130 void drm_ut_debug_printk(const char *function_name,
131 const char *format, ...);
132 extern __printf(1, 2)
133 void drm_err(const char *format, ...);
135 /***********************************************************************/
136 /** \name DRM template customization defaults */
139 /* driver capabilities and requirements mask */
140 #define DRIVER_USE_AGP 0x1
141 #define DRIVER_PCI_DMA 0x8
142 #define DRIVER_SG 0x10
143 #define DRIVER_HAVE_DMA 0x20
144 #define DRIVER_HAVE_IRQ 0x40
145 #define DRIVER_IRQ_SHARED 0x80
146 #define DRIVER_GEM 0x1000
147 #define DRIVER_MODESET 0x2000
148 #define DRIVER_PRIME 0x4000
149 #define DRIVER_RENDER 0x8000
150 #define DRIVER_ATOMIC 0x10000
151 #define DRIVER_KMS_LEGACY_CONTEXT 0x20000
153 /***********************************************************************/
154 /** \name Macros to make printk easier */
160 * \param fmt printf() like format string.
161 * \param arg arguments
163 #define DRM_ERROR(fmt, ...) \
164 drm_err(fmt, ##__VA_ARGS__)
167 * Rate limited error output. Like DRM_ERROR() but won't flood the log.
169 * \param fmt printf() like format string.
170 * \param arg arguments
172 #define DRM_ERROR_RATELIMITED(fmt, ...) \
174 static DEFINE_RATELIMIT_STATE(_rs, \
175 DEFAULT_RATELIMIT_INTERVAL, \
176 DEFAULT_RATELIMIT_BURST); \
178 if (__ratelimit(&_rs)) \
179 drm_err(fmt, ##__VA_ARGS__); \
182 #define DRM_INFO(fmt, ...) \
183 printk(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
185 #define DRM_INFO_ONCE(fmt, ...) \
186 printk_once(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
191 * \param fmt printf() like format string.
192 * \param arg arguments
194 #define DRM_DEBUG(fmt, args...) \
196 if (unlikely(drm_debug & DRM_UT_CORE)) \
197 drm_ut_debug_printk(__func__, fmt, ##args); \
200 #define DRM_DEBUG_DRIVER(fmt, args...) \
202 if (unlikely(drm_debug & DRM_UT_DRIVER)) \
203 drm_ut_debug_printk(__func__, fmt, ##args); \
205 #define DRM_DEBUG_KMS(fmt, args...) \
207 if (unlikely(drm_debug & DRM_UT_KMS)) \
208 drm_ut_debug_printk(__func__, fmt, ##args); \
210 #define DRM_DEBUG_PRIME(fmt, args...) \
212 if (unlikely(drm_debug & DRM_UT_PRIME)) \
213 drm_ut_debug_printk(__func__, fmt, ##args); \
215 #define DRM_DEBUG_ATOMIC(fmt, args...) \
217 if (unlikely(drm_debug & DRM_UT_ATOMIC)) \
218 drm_ut_debug_printk(__func__, fmt, ##args); \
223 /***********************************************************************/
224 /** \name Internal types and structures */
227 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
230 * Ioctl function type.
232 * \param inode device inode.
233 * \param file_priv DRM file private pointer.
234 * \param cmd command.
235 * \param arg argument.
237 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
238 struct drm_file *file_priv);
240 typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
243 #define DRM_IOCTL_NR(n) _IOC_NR(n)
244 #define DRM_MAJOR 226
247 #define DRM_MASTER 0x2
248 #define DRM_ROOT_ONLY 0x4
249 #define DRM_CONTROL_ALLOW 0x8
250 #define DRM_UNLOCKED 0x10
251 #define DRM_RENDER_ALLOW 0x20
253 struct drm_ioctl_desc {
261 * Creates a driver or general drm_ioctl_desc array entry for the given
262 * ioctl, for use by drm_ioctl().
265 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags) \
266 [DRM_IOCTL_NR(DRM_IOCTL_##ioctl) - DRM_COMMAND_BASE] = { \
267 .cmd = DRM_IOCTL_##ioctl, \
273 /* Event queued up for userspace to read */
274 struct drm_pending_event {
275 struct drm_event *event;
276 struct list_head link;
277 struct drm_file *file_priv;
278 pid_t pid; /* pid of requester, no guarantee it's valid by the time
279 we deliver the event, for tracing only */
280 void (*destroy)(struct drm_pending_event *event);
283 /* initial implementaton using a linked list - todo hashtab */
284 struct drm_prime_file_private {
285 struct list_head head;
289 /** File private data */
291 unsigned authenticated :1;
292 /* Whether we're master for a minor. Protected by master_mutex */
293 unsigned is_master :1;
294 /* true when the client has asked us to expose stereo 3D mode flags */
295 unsigned stereo_allowed :1;
297 * true if client understands CRTC primary planes and cursor planes
300 unsigned universal_planes:1;
301 /* true if client understands atomic properties */
307 struct list_head lhead;
308 struct drm_minor *minor;
309 unsigned long lock_count;
311 /** Mapping of mm object handles to object pointers. */
312 struct idr object_idr;
313 /** Lock for synchronization of access to object_idr. */
314 spinlock_t table_lock;
319 struct drm_master *master; /* master this node is currently associated with
320 N.B. not always minor->master */
322 * fbs - List of framebuffers associated with this file.
324 * Protected by fbs_lock. Note that the fbs list holds a reference on
325 * the fb object to prevent it from untimely disappearing.
327 struct list_head fbs;
328 struct mutex fbs_lock;
330 /** User-created blob properties; this retains a reference on the
332 struct list_head blobs;
334 wait_queue_head_t event_wait;
335 struct list_head event_list;
338 struct drm_prime_file_private prime;
344 struct drm_lock_data {
345 struct drm_hw_lock *hw_lock; /**< Hardware lock */
346 /** Private of lock holder's file (NULL=kernel) */
347 struct drm_file *file_priv;
348 wait_queue_head_t lock_queue; /**< Queue of blocked processes */
349 unsigned long lock_time; /**< Time of last lock in jiffies */
351 uint32_t kernel_waiters;
352 uint32_t user_waiters;
357 * struct drm_master - drm master structure
359 * @refcount: Refcount for this master object.
360 * @minor: Link back to minor char device we are master for. Immutable.
361 * @unique: Unique identifier: e.g. busid. Protected by drm_global_mutex.
362 * @unique_len: Length of unique field. Protected by drm_global_mutex.
363 * @magic_map: Map of used authentication tokens. Protected by struct_mutex.
364 * @lock: DRI lock information.
365 * @driver_priv: Pointer to driver-private information.
368 struct kref refcount;
369 struct drm_minor *minor;
372 struct idr magic_map;
373 struct drm_lock_data lock;
377 /* Size of ringbuffer for vblank timestamps. Just double-buffer
378 * in initial implementation.
380 #define DRM_VBLANKTIME_RBSIZE 2
382 /* Flags and return codes for get_vblank_timestamp() driver function. */
383 #define DRM_CALLED_FROM_VBLIRQ 1
384 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
385 #define DRM_VBLANKTIME_IN_VBLANK (1 << 1)
387 /* get_scanout_position() return flags */
388 #define DRM_SCANOUTPOS_VALID (1 << 0)
389 #define DRM_SCANOUTPOS_IN_VBLANK (1 << 1)
390 #define DRM_SCANOUTPOS_ACCURATE (1 << 2)
393 * DRM driver structure. This structure represent the common code for
394 * a family of cards. There will one drm_device for each card present
398 int (*load) (struct drm_device *, unsigned long flags);
399 int (*firstopen) (struct drm_device *);
400 int (*open) (struct drm_device *, struct drm_file *);
401 void (*preclose) (struct drm_device *, struct drm_file *file_priv);
402 void (*postclose) (struct drm_device *, struct drm_file *);
403 void (*lastclose) (struct drm_device *);
404 int (*unload) (struct drm_device *);
405 int (*suspend) (struct drm_device *, pm_message_t state);
406 int (*resume) (struct drm_device *);
407 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
408 int (*dma_quiescent) (struct drm_device *);
409 int (*context_dtor) (struct drm_device *dev, int context);
410 int (*set_busid)(struct drm_device *dev, struct drm_master *master);
413 * get_vblank_counter - get raw hardware vblank counter
415 * @pipe: counter to fetch
417 * Driver callback for fetching a raw hardware vblank counter for @crtc.
418 * If a device doesn't have a hardware counter, the driver can simply
419 * return the value of drm_vblank_count. The DRM core will account for
420 * missed vblank events while interrupts where disabled based on system
423 * Wraparound handling and loss of events due to modesetting is dealt
424 * with in the DRM core code.
427 * Raw vblank counter value.
429 u32 (*get_vblank_counter) (struct drm_device *dev, unsigned int pipe);
432 * enable_vblank - enable vblank interrupt events
434 * @pipe: which irq to enable
436 * Enable vblank interrupts for @crtc. If the device doesn't have
437 * a hardware vblank counter, this routine should be a no-op, since
438 * interrupts will have to stay on to keep the count accurate.
441 * Zero on success, appropriate errno if the given @crtc's vblank
442 * interrupt cannot be enabled.
444 int (*enable_vblank) (struct drm_device *dev, unsigned int pipe);
447 * disable_vblank - disable vblank interrupt events
449 * @pipe: which irq to enable
451 * Disable vblank interrupts for @crtc. If the device doesn't have
452 * a hardware vblank counter, this routine should be a no-op, since
453 * interrupts will have to stay on to keep the count accurate.
455 void (*disable_vblank) (struct drm_device *dev, unsigned int pipe);
458 * Called by \c drm_device_is_agp. Typically used to determine if a
459 * card is really attached to AGP or not.
461 * \param dev DRM device handle
464 * One of three values is returned depending on whether or not the
465 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
466 * (return of 1), or may or may not be AGP (return of 2).
468 int (*device_is_agp) (struct drm_device *dev);
471 * Called by vblank timestamping code.
473 * Return the current display scanout position from a crtc, and an
474 * optional accurate ktime_get timestamp of when position was measured.
476 * \param dev DRM device.
477 * \param pipe Id of the crtc to query.
478 * \param flags Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
479 * \param *vpos Target location for current vertical scanout position.
480 * \param *hpos Target location for current horizontal scanout position.
481 * \param *stime Target location for timestamp taken immediately before
482 * scanout position query. Can be NULL to skip timestamp.
483 * \param *etime Target location for timestamp taken immediately after
484 * scanout position query. Can be NULL to skip timestamp.
485 * \param mode Current display timings.
487 * Returns vpos as a positive number while in active scanout area.
488 * Returns vpos as a negative number inside vblank, counting the number
489 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
490 * until start of active scanout / end of vblank."
492 * \return Flags, or'ed together as follows:
494 * DRM_SCANOUTPOS_VALID = Query successful.
495 * DRM_SCANOUTPOS_INVBL = Inside vblank.
496 * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
497 * this flag means that returned position may be offset by a constant
498 * but unknown small number of scanlines wrt. real scanout position.
501 int (*get_scanout_position) (struct drm_device *dev, unsigned int pipe,
502 unsigned int flags, int *vpos, int *hpos,
503 ktime_t *stime, ktime_t *etime,
504 const struct drm_display_mode *mode);
507 * Called by \c drm_get_last_vbltimestamp. Should return a precise
508 * timestamp when the most recent VBLANK interval ended or will end.
510 * Specifically, the timestamp in @vblank_time should correspond as
511 * closely as possible to the time when the first video scanline of
512 * the video frame after the end of VBLANK will start scanning out,
513 * the time immediately after end of the VBLANK interval. If the
514 * @crtc is currently inside VBLANK, this will be a time in the future.
515 * If the @crtc is currently scanning out a frame, this will be the
516 * past start time of the current scanout. This is meant to adhere
517 * to the OpenML OML_sync_control extension specification.
519 * \param dev dev DRM device handle.
520 * \param pipe crtc for which timestamp should be returned.
521 * \param *max_error Maximum allowable timestamp error in nanoseconds.
522 * Implementation should strive to provide timestamp
523 * with an error of at most *max_error nanoseconds.
524 * Returns true upper bound on error for timestamp.
525 * \param *vblank_time Target location for returned vblank timestamp.
526 * \param flags 0 = Defaults, no special treatment needed.
527 * \param DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
528 * irq handler. Some drivers need to apply some workarounds
529 * for gpu-specific vblank irq quirks if flag is set.
532 * Zero if timestamping isn't supported in current display mode or a
533 * negative number on failure. A positive status code on success,
534 * which describes how the vblank_time timestamp was computed.
536 int (*get_vblank_timestamp) (struct drm_device *dev, unsigned int pipe,
538 struct timeval *vblank_time,
541 /* these have to be filled in */
543 irqreturn_t(*irq_handler) (int irq, void *arg);
544 void (*irq_preinstall) (struct drm_device *dev);
545 int (*irq_postinstall) (struct drm_device *dev);
546 void (*irq_uninstall) (struct drm_device *dev);
548 /* Master routines */
549 int (*master_create)(struct drm_device *dev, struct drm_master *master);
550 void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
552 * master_set is called whenever the minor master is set.
553 * master_drop is called whenever the minor master is dropped.
556 int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
558 void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv,
561 int (*debugfs_init)(struct drm_minor *minor);
562 void (*debugfs_cleanup)(struct drm_minor *minor);
565 * Driver-specific constructor for drm_gem_objects, to set up
566 * obj->driver_private.
568 * Returns 0 on success.
570 void (*gem_free_object) (struct drm_gem_object *obj);
571 int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
572 void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
575 /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
576 int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
577 uint32_t handle, uint32_t flags, int *prime_fd);
578 /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
579 int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
580 int prime_fd, uint32_t *handle);
581 /* export GEM -> dmabuf */
582 struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
583 struct drm_gem_object *obj, int flags);
584 /* import dmabuf -> GEM */
585 struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
586 struct dma_buf *dma_buf);
587 /* low-level interface used by drm_gem_prime_{import,export} */
588 int (*gem_prime_pin)(struct drm_gem_object *obj);
589 void (*gem_prime_unpin)(struct drm_gem_object *obj);
590 struct reservation_object * (*gem_prime_res_obj)(
591 struct drm_gem_object *obj);
592 struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj);
593 struct drm_gem_object *(*gem_prime_import_sg_table)(
594 struct drm_device *dev,
595 struct dma_buf_attachment *attach,
596 struct sg_table *sgt);
597 void *(*gem_prime_vmap)(struct drm_gem_object *obj);
598 void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr);
599 int (*gem_prime_mmap)(struct drm_gem_object *obj,
600 struct vm_area_struct *vma);
602 /* vga arb irq handler */
603 void (*vgaarb_irq)(struct drm_device *dev, bool state);
605 /* dumb alloc support */
606 int (*dumb_create)(struct drm_file *file_priv,
607 struct drm_device *dev,
608 struct drm_mode_create_dumb *args);
609 int (*dumb_map_offset)(struct drm_file *file_priv,
610 struct drm_device *dev, uint32_t handle,
612 int (*dumb_destroy)(struct drm_file *file_priv,
613 struct drm_device *dev,
616 /* Driver private ops for this object */
617 const struct vm_operations_struct *gem_vm_ops;
628 const struct drm_ioctl_desc *ioctls;
630 const struct file_operations *fops;
632 /* List of devices hanging off this driver with stealth attach. */
633 struct list_head legacy_dev_list;
636 enum drm_minor_type {
644 * Info file list entry. This structure represents a debugfs or proc file to
645 * be created by the drm core
647 struct drm_info_list {
648 const char *name; /** file name */
649 int (*show)(struct seq_file*, void*); /** show callback */
650 u32 driver_features; /**< Required driver features for this entry */
655 * debugfs node structure. This structure represents a debugfs file.
657 struct drm_info_node {
658 struct list_head list;
659 struct drm_minor *minor;
660 const struct drm_info_list *info_ent;
665 * DRM minor structure. This structure represents a drm minor number.
668 int index; /**< Minor device number */
669 int type; /**< Control or render */
670 struct device *kdev; /**< Linux device */
671 struct drm_device *dev;
673 struct dentry *debugfs_root;
675 struct list_head debugfs_list;
676 struct mutex debugfs_lock; /* Protects debugfs_list. */
678 /* currently active master for this node. Protected by master_mutex */
679 struct drm_master *master;
683 struct drm_pending_vblank_event {
684 struct drm_pending_event base;
686 struct drm_event_vblank event;
689 struct drm_vblank_crtc {
690 struct drm_device *dev; /* pointer to the drm_device */
691 wait_queue_head_t queue; /**< VBLANK wait queue */
692 struct timer_list disable_timer; /* delayed disable timer */
694 /* vblank counter, protected by dev->vblank_time_lock for writes */
696 /* vblank timestamps, protected by dev->vblank_time_lock for writes */
697 struct timeval time[DRM_VBLANKTIME_RBSIZE];
699 atomic_t refcount; /* number of users of vblank interruptsper crtc */
700 u32 last; /* protected by dev->vbl_lock, used */
701 /* for wraparound handling */
702 u32 last_wait; /* Last vblank seqno waited per CRTC */
703 unsigned int inmodeset; /* Display driver is setting mode */
704 unsigned int pipe; /* crtc index */
705 int framedur_ns; /* frame/field duration in ns */
706 int linedur_ns; /* line duration in ns */
707 bool enabled; /* so we don't call enable more than
712 * DRM device structure. This structure represent a complete card that
713 * may contain multiple heads.
716 struct list_head legacy_dev_list;/**< list of devices per driver for stealth attach cleanup */
717 int if_version; /**< Highest interface version set */
719 /** \name Lifetime Management */
721 struct kref ref; /**< Object ref-count */
722 struct device *dev; /**< Device structure of bus-device */
723 struct drm_driver *driver; /**< DRM driver managing the device */
724 void *dev_private; /**< DRM driver private data */
725 struct drm_minor *control; /**< Control node */
726 struct drm_minor *primary; /**< Primary node */
727 struct drm_minor *render; /**< Render node */
728 atomic_t unplugged; /**< Flag whether dev is dead */
729 struct inode *anon_inode; /**< inode for private address-space */
730 char *unique; /**< unique name of the device */
735 struct mutex struct_mutex; /**< For others */
736 struct mutex master_mutex; /**< For drm_minor::master and drm_file::is_master */
739 /** \name Usage Counters */
741 int open_count; /**< Outstanding files open, protected by drm_global_mutex. */
742 spinlock_t buf_lock; /**< For drm_device::buf_use and a few other things. */
743 int buf_use; /**< Buffers in use -- cannot alloc */
744 atomic_t buf_alloc; /**< Buffer allocation in progress */
747 struct list_head filelist;
749 /** \name Memory management */
751 struct list_head maplist; /**< Linked list of regions */
752 struct drm_open_hash map_hash; /**< User token hash table for maps */
754 /** \name Context handle management */
756 struct list_head ctxlist; /**< Linked list of context handles */
757 struct mutex ctxlist_mutex; /**< For ctxlist */
761 struct list_head vmalist; /**< List of vmas (for debugging) */
765 /** \name DMA support */
767 struct drm_device_dma *dma; /**< Optional pointer for DMA support */
770 /** \name Context support */
773 __volatile__ long context_flag; /**< Context swapping flag */
774 int last_context; /**< Last current context */
777 /** \name VBLANK IRQ support */
783 * At load time, disabling the vblank interrupt won't be allowed since
784 * old clients may not call the modeset ioctl and therefore misbehave.
785 * Once the modeset ioctl *has* been called though, we can safely
786 * disable them when unused.
788 bool vblank_disable_allowed;
791 * If true, vblank interrupt will be disabled immediately when the
792 * refcount drops to zero, as opposed to via the vblank disable
794 * This can be set to true it the hardware has a working vblank
795 * counter and the driver uses drm_vblank_on() and drm_vblank_off()
798 bool vblank_disable_immediate;
800 /* array of size num_crtcs */
801 struct drm_vblank_crtc *vblank;
803 spinlock_t vblank_time_lock; /**< Protects vblank count and time updates during vblank enable/disable */
806 u32 max_vblank_count; /**< size of vblank counter register */
811 struct list_head vblank_event_list;
812 spinlock_t event_lock;
816 struct drm_agp_head *agp; /**< AGP data */
818 struct pci_dev *pdev; /**< PCI device structure */
820 struct pci_controller *hose;
823 struct platform_device *platformdev; /**< Platform device struture */
824 struct virtio_device *virtdev;
826 struct drm_sg_mem *sg; /**< Scatter gather memory */
827 unsigned int num_crtcs; /**< Number of CRTCs on this device */
832 struct drm_hw_lock *lock;
835 struct drm_local_map *agp_buffer_map;
836 unsigned int agp_buffer_token;
838 struct drm_mode_config mode_config; /**< Current mode config */
840 /** \name GEM information */
842 struct mutex object_name_lock;
843 struct idr object_name_idr;
844 struct drm_vma_offset_manager *vma_offset_manager;
846 int switch_power_state;
849 #define DRM_SWITCH_POWER_ON 0
850 #define DRM_SWITCH_POWER_OFF 1
851 #define DRM_SWITCH_POWER_CHANGING 2
852 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
854 static __inline__ int drm_core_check_feature(struct drm_device *dev,
857 return ((dev->driver->driver_features & feature) ? 1 : 0);
860 static inline void drm_device_set_unplugged(struct drm_device *dev)
863 atomic_set(&dev->unplugged, 1);
866 static inline int drm_device_is_unplugged(struct drm_device *dev)
868 int ret = atomic_read(&dev->unplugged);
873 static inline bool drm_is_render_client(const struct drm_file *file_priv)
875 return file_priv->minor->type == DRM_MINOR_RENDER;
878 static inline bool drm_is_control_client(const struct drm_file *file_priv)
880 return file_priv->minor->type == DRM_MINOR_CONTROL;
883 static inline bool drm_is_primary_client(const struct drm_file *file_priv)
885 return file_priv->minor->type == DRM_MINOR_LEGACY;
888 /******************************************************************/
889 /** \name Internal function definitions */
892 /* Driver support (drm_drv.h) */
893 extern int drm_ioctl_permit(u32 flags, struct drm_file *file_priv);
894 extern long drm_ioctl(struct file *filp,
895 unsigned int cmd, unsigned long arg);
896 extern long drm_compat_ioctl(struct file *filp,
897 unsigned int cmd, unsigned long arg);
898 extern bool drm_ioctl_flags(unsigned int nr, unsigned int *flags);
900 /* Device support (drm_fops.h) */
901 extern int drm_open(struct inode *inode, struct file *filp);
902 extern ssize_t drm_read(struct file *filp, char __user *buffer,
903 size_t count, loff_t *offset);
904 extern int drm_release(struct inode *inode, struct file *filp);
906 /* Mapping support (drm_vm.h) */
907 extern unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait);
909 /* Misc. IOCTL support (drm_ioctl.c) */
910 int drm_noop(struct drm_device *dev, void *data,
911 struct drm_file *file_priv);
912 int drm_invalid_op(struct drm_device *dev, void *data,
913 struct drm_file *file_priv);
915 /* Cache management (drm_cache.c) */
916 void drm_clflush_pages(struct page *pages[], unsigned long num_pages);
917 void drm_clflush_sg(struct sg_table *st);
918 void drm_clflush_virt_range(void *addr, unsigned long length);
921 * These are exported to drivers so that they can implement fencing using
922 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
925 /* IRQ support (drm_irq.h) */
926 extern int drm_irq_install(struct drm_device *dev, int irq);
927 extern int drm_irq_uninstall(struct drm_device *dev);
929 extern int drm_vblank_init(struct drm_device *dev, unsigned int num_crtcs);
930 extern int drm_wait_vblank(struct drm_device *dev, void *data,
931 struct drm_file *filp);
932 extern u32 drm_vblank_count(struct drm_device *dev, unsigned int pipe);
933 extern u32 drm_crtc_vblank_count(struct drm_crtc *crtc);
934 extern u32 drm_vblank_count_and_time(struct drm_device *dev, unsigned int pipe,
935 struct timeval *vblanktime);
936 extern u32 drm_crtc_vblank_count_and_time(struct drm_crtc *crtc,
937 struct timeval *vblanktime);
938 extern void drm_send_vblank_event(struct drm_device *dev, unsigned int pipe,
939 struct drm_pending_vblank_event *e);
940 extern void drm_crtc_send_vblank_event(struct drm_crtc *crtc,
941 struct drm_pending_vblank_event *e);
942 extern bool drm_handle_vblank(struct drm_device *dev, unsigned int pipe);
943 extern bool drm_crtc_handle_vblank(struct drm_crtc *crtc);
944 extern int drm_vblank_get(struct drm_device *dev, unsigned int pipe);
945 extern void drm_vblank_put(struct drm_device *dev, unsigned int pipe);
946 extern int drm_crtc_vblank_get(struct drm_crtc *crtc);
947 extern void drm_crtc_vblank_put(struct drm_crtc *crtc);
948 extern void drm_wait_one_vblank(struct drm_device *dev, unsigned int pipe);
949 extern void drm_crtc_wait_one_vblank(struct drm_crtc *crtc);
950 extern void drm_vblank_off(struct drm_device *dev, unsigned int pipe);
951 extern void drm_vblank_on(struct drm_device *dev, unsigned int pipe);
952 extern void drm_crtc_vblank_off(struct drm_crtc *crtc);
953 extern void drm_crtc_vblank_reset(struct drm_crtc *crtc);
954 extern void drm_crtc_vblank_on(struct drm_crtc *crtc);
955 extern void drm_vblank_cleanup(struct drm_device *dev);
956 extern u32 drm_vblank_no_hw_counter(struct drm_device *dev, unsigned int pipe);
958 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
959 unsigned int pipe, int *max_error,
960 struct timeval *vblank_time,
962 const struct drm_display_mode *mode);
963 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc,
964 const struct drm_display_mode *mode);
967 * drm_crtc_vblank_waitqueue - get vblank waitqueue for the CRTC
968 * @crtc: which CRTC's vblank waitqueue to retrieve
970 * This function returns a pointer to the vblank waitqueue for the CRTC.
971 * Drivers can use this to implement vblank waits using wait_event() & co.
973 static inline wait_queue_head_t *drm_crtc_vblank_waitqueue(struct drm_crtc *crtc)
975 return &crtc->dev->vblank[drm_crtc_index(crtc)].queue;
978 /* Modesetting support */
979 extern void drm_vblank_pre_modeset(struct drm_device *dev, unsigned int pipe);
980 extern void drm_vblank_post_modeset(struct drm_device *dev, unsigned int pipe);
982 /* Stub support (drm_stub.h) */
983 extern struct drm_master *drm_master_get(struct drm_master *master);
984 extern void drm_master_put(struct drm_master **master);
986 extern void drm_put_dev(struct drm_device *dev);
987 extern void drm_unplug_dev(struct drm_device *dev);
988 extern unsigned int drm_debug;
989 extern bool drm_atomic;
991 /* Debugfs support */
992 #if defined(CONFIG_DEBUG_FS)
993 extern int drm_debugfs_create_files(const struct drm_info_list *files,
994 int count, struct dentry *root,
995 struct drm_minor *minor);
996 extern int drm_debugfs_remove_files(const struct drm_info_list *files,
997 int count, struct drm_minor *minor);
999 static inline int drm_debugfs_create_files(const struct drm_info_list *files,
1000 int count, struct dentry *root,
1001 struct drm_minor *minor)
1006 static inline int drm_debugfs_remove_files(const struct drm_info_list *files,
1007 int count, struct drm_minor *minor)
1013 extern struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
1014 struct drm_gem_object *obj, int flags);
1015 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1016 struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1018 extern struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
1019 struct dma_buf *dma_buf);
1020 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1021 struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1022 extern void drm_gem_dmabuf_release(struct dma_buf *dma_buf);
1024 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
1025 dma_addr_t *addrs, int max_pages);
1026 extern struct sg_table *drm_prime_pages_to_sg(struct page **pages, unsigned int nr_pages);
1027 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1030 extern struct drm_dma_handle *drm_pci_alloc(struct drm_device *dev, size_t size,
1032 extern void drm_pci_free(struct drm_device *dev, struct drm_dma_handle * dmah);
1034 /* sysfs support (drm_sysfs.c) */
1035 extern void drm_sysfs_hotplug_event(struct drm_device *dev);
1038 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
1039 struct device *parent);
1040 void drm_dev_ref(struct drm_device *dev);
1041 void drm_dev_unref(struct drm_device *dev);
1042 int drm_dev_register(struct drm_device *dev, unsigned long flags);
1043 void drm_dev_unregister(struct drm_device *dev);
1044 int drm_dev_set_unique(struct drm_device *dev, const char *fmt, ...);
1046 struct drm_minor *drm_minor_acquire(unsigned int minor_id);
1047 void drm_minor_release(struct drm_minor *minor);
1052 static __inline__ int drm_pci_device_is_agp(struct drm_device *dev)
1054 if (dev->driver->device_is_agp != NULL) {
1055 int err = (*dev->driver->device_is_agp) (dev);
1062 return pci_find_capability(dev->pdev, PCI_CAP_ID_AGP);
1064 void drm_pci_agp_destroy(struct drm_device *dev);
1066 extern int drm_pci_init(struct drm_driver *driver, struct pci_driver *pdriver);
1067 extern void drm_pci_exit(struct drm_driver *driver, struct pci_driver *pdriver);
1069 extern int drm_get_pci_dev(struct pci_dev *pdev,
1070 const struct pci_device_id *ent,
1071 struct drm_driver *driver);
1072 extern int drm_pci_set_busid(struct drm_device *dev, struct drm_master *master);
1074 static inline int drm_get_pci_dev(struct pci_dev *pdev,
1075 const struct pci_device_id *ent,
1076 struct drm_driver *driver)
1081 static inline int drm_pci_set_busid(struct drm_device *dev,
1082 struct drm_master *master)
1088 #define DRM_PCIE_SPEED_25 1
1089 #define DRM_PCIE_SPEED_50 2
1090 #define DRM_PCIE_SPEED_80 4
1092 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1094 /* platform section */
1095 extern int drm_platform_init(struct drm_driver *driver, struct platform_device *platform_device);
1096 extern int drm_platform_set_busid(struct drm_device *d, struct drm_master *m);
1098 /* returns true if currently okay to sleep */
1099 static __inline__ bool drm_can_sleep(void)
1101 if (in_atomic() || in_dbg_master() || irqs_disabled())