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/seqlock.h>
56 #include <linux/slab.h>
57 #include <linux/types.h>
58 #include <linux/vmalloc.h>
59 #include <linux/workqueue.h>
60 #include <linux/fence.h>
63 #include <asm/pgalloc.h>
64 #include <asm/uaccess.h>
66 #include <uapi/drm/drm.h>
67 #include <uapi/drm/drm_mode.h>
69 #include <drm/drm_agpsupport.h>
70 #include <drm/drm_crtc.h>
71 #include <drm/drm_global.h>
72 #include <drm/drm_hashtab.h>
73 #include <drm/drm_mem_util.h>
74 #include <drm/drm_mm.h>
75 #include <drm/drm_os_linux.h>
76 #include <drm/drm_sarea.h>
77 #include <drm/drm_vma_manager.h>
85 struct drm_device_dma
;
86 struct drm_dma_handle
;
87 struct drm_gem_object
;
91 struct reservation_object
;
92 struct dma_buf_attachment
;
95 * The following categories are defined:
97 * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
98 * This is the category used by the DRM_DEBUG() macro.
100 * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
101 * This is the category used by the DRM_DEBUG_DRIVER() macro.
103 * KMS: used in the modesetting code.
104 * This is the category used by the DRM_DEBUG_KMS() macro.
106 * PRIME: used in the prime code.
107 * This is the category used by the DRM_DEBUG_PRIME() macro.
109 * ATOMIC: used in the atomic code.
110 * This is the category used by the DRM_DEBUG_ATOMIC() macro.
112 * VBL: used for verbose debug message in the vblank code
113 * This is the category used by the DRM_DEBUG_VBL() macro.
115 * Enabling verbose debug messages is done through the drm.debug parameter,
116 * each category being enabled by a bit.
118 * drm.debug=0x1 will enable CORE messages
119 * drm.debug=0x2 will enable DRIVER messages
120 * drm.debug=0x3 will enable CORE and DRIVER messages
122 * drm.debug=0x3f will enable all messages
124 * An interesting feature is that it's possible to enable verbose logging at
125 * run-time by echoing the debug value in its sysfs node:
126 * # echo 0xf > /sys/module/drm/parameters/debug
128 #define DRM_UT_CORE 0x01
129 #define DRM_UT_DRIVER 0x02
130 #define DRM_UT_KMS 0x04
131 #define DRM_UT_PRIME 0x08
132 #define DRM_UT_ATOMIC 0x10
133 #define DRM_UT_VBL 0x20
135 extern __printf(2, 3)
136 void drm_ut_debug_printk(const char *function_name
,
137 const char *format
, ...);
138 extern __printf(1, 2)
139 void drm_err(const char *format
, ...);
141 /***********************************************************************/
142 /** \name DRM template customization defaults */
145 /* driver capabilities and requirements mask */
146 #define DRIVER_USE_AGP 0x1
147 #define DRIVER_PCI_DMA 0x8
148 #define DRIVER_SG 0x10
149 #define DRIVER_HAVE_DMA 0x20
150 #define DRIVER_HAVE_IRQ 0x40
151 #define DRIVER_IRQ_SHARED 0x80
152 #define DRIVER_GEM 0x1000
153 #define DRIVER_MODESET 0x2000
154 #define DRIVER_PRIME 0x4000
155 #define DRIVER_RENDER 0x8000
156 #define DRIVER_ATOMIC 0x10000
157 #define DRIVER_KMS_LEGACY_CONTEXT 0x20000
159 /***********************************************************************/
160 /** \name Macros to make printk easier */
166 * \param fmt printf() like format string.
167 * \param arg arguments
169 #define DRM_ERROR(fmt, ...) \
170 drm_err(fmt, ##__VA_ARGS__)
173 * Rate limited error output. Like DRM_ERROR() but won't flood the log.
175 * \param fmt printf() like format string.
176 * \param arg arguments
178 #define DRM_ERROR_RATELIMITED(fmt, ...) \
180 static DEFINE_RATELIMIT_STATE(_rs, \
181 DEFAULT_RATELIMIT_INTERVAL, \
182 DEFAULT_RATELIMIT_BURST); \
184 if (__ratelimit(&_rs)) \
185 drm_err(fmt, ##__VA_ARGS__); \
188 #define DRM_INFO(fmt, ...) \
189 printk(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
191 #define DRM_INFO_ONCE(fmt, ...) \
192 printk_once(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
197 * \param fmt printf() like format string.
198 * \param arg arguments
200 #define DRM_DEBUG(fmt, args...) \
202 if (unlikely(drm_debug & DRM_UT_CORE)) \
203 drm_ut_debug_printk(__func__, fmt, ##args); \
206 #define DRM_DEBUG_DRIVER(fmt, args...) \
208 if (unlikely(drm_debug & DRM_UT_DRIVER)) \
209 drm_ut_debug_printk(__func__, fmt, ##args); \
211 #define DRM_DEBUG_KMS(fmt, args...) \
213 if (unlikely(drm_debug & DRM_UT_KMS)) \
214 drm_ut_debug_printk(__func__, fmt, ##args); \
216 #define DRM_DEBUG_PRIME(fmt, args...) \
218 if (unlikely(drm_debug & DRM_UT_PRIME)) \
219 drm_ut_debug_printk(__func__, fmt, ##args); \
221 #define DRM_DEBUG_ATOMIC(fmt, args...) \
223 if (unlikely(drm_debug & DRM_UT_ATOMIC)) \
224 drm_ut_debug_printk(__func__, fmt, ##args); \
226 #define DRM_DEBUG_VBL(fmt, args...) \
228 if (unlikely(drm_debug & DRM_UT_VBL)) \
229 drm_ut_debug_printk(__func__, fmt, ##args); \
234 /***********************************************************************/
235 /** \name Internal types and structures */
238 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
241 * Ioctl function type.
243 * \param inode device inode.
244 * \param file_priv DRM file private pointer.
245 * \param cmd command.
246 * \param arg argument.
248 typedef int drm_ioctl_t(struct drm_device
*dev
, void *data
,
249 struct drm_file
*file_priv
);
251 typedef int drm_ioctl_compat_t(struct file
*filp
, unsigned int cmd
,
254 #define DRM_IOCTL_NR(n) _IOC_NR(n)
255 #define DRM_MAJOR 226
258 #define DRM_MASTER 0x2
259 #define DRM_ROOT_ONLY 0x4
260 #define DRM_CONTROL_ALLOW 0x8
261 #define DRM_UNLOCKED 0x10
262 #define DRM_RENDER_ALLOW 0x20
264 struct drm_ioctl_desc
{
272 * Creates a driver or general drm_ioctl_desc array entry for the given
273 * ioctl, for use by drm_ioctl().
276 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags) \
277 [DRM_IOCTL_NR(DRM_IOCTL_##ioctl) - DRM_COMMAND_BASE] = { \
278 .cmd = DRM_IOCTL_##ioctl, \
284 /* Event queued up for userspace to read */
285 struct drm_pending_event
{
286 struct drm_event
*event
;
288 struct list_head link
;
289 struct list_head pending_link
;
290 struct drm_file
*file_priv
;
291 pid_t pid
; /* pid of requester, no guarantee it's valid by the time
292 we deliver the event, for tracing only */
295 /* initial implementaton using a linked list - todo hashtab */
296 struct drm_prime_file_private
{
297 struct list_head head
;
301 /** File private data */
303 unsigned authenticated
:1;
304 /* Whether we're master for a minor. Protected by master_mutex */
305 unsigned is_master
:1;
306 /* true when the client has asked us to expose stereo 3D mode flags */
307 unsigned stereo_allowed
:1;
309 * true if client understands CRTC primary planes and cursor planes
312 unsigned universal_planes
:1;
313 /* true if client understands atomic properties */
316 * This client is allowed to gain master privileges for @master.
317 * Protected by struct drm_device::master_mutex.
319 unsigned allowed_master
:1;
324 struct list_head lhead
;
325 struct drm_minor
*minor
;
326 unsigned long lock_count
;
328 /** Mapping of mm object handles to object pointers. */
329 struct idr object_idr
;
330 /** Lock for synchronization of access to object_idr. */
331 spinlock_t table_lock
;
336 struct drm_master
*master
; /* master this node is currently associated with
337 N.B. not always minor->master */
339 * fbs - List of framebuffers associated with this file.
341 * Protected by fbs_lock. Note that the fbs list holds a reference on
342 * the fb object to prevent it from untimely disappearing.
344 struct list_head fbs
;
345 struct mutex fbs_lock
;
347 /** User-created blob properties; this retains a reference on the
349 struct list_head blobs
;
351 wait_queue_head_t event_wait
;
352 struct list_head pending_event_list
;
353 struct list_head event_list
;
356 struct mutex event_read_lock
;
358 struct drm_prime_file_private prime
;
364 struct drm_lock_data
{
365 struct drm_hw_lock
*hw_lock
; /**< Hardware lock */
366 /** Private of lock holder's file (NULL=kernel) */
367 struct drm_file
*file_priv
;
368 wait_queue_head_t lock_queue
; /**< Queue of blocked processes */
369 unsigned long lock_time
; /**< Time of last lock in jiffies */
371 uint32_t kernel_waiters
;
372 uint32_t user_waiters
;
377 * struct drm_master - drm master structure
379 * @refcount: Refcount for this master object.
380 * @minor: Link back to minor char device we are master for. Immutable.
381 * @unique: Unique identifier: e.g. busid. Protected by drm_global_mutex.
382 * @unique_len: Length of unique field. Protected by drm_global_mutex.
383 * @magic_map: Map of used authentication tokens. Protected by struct_mutex.
384 * @lock: DRI lock information.
385 * @driver_priv: Pointer to driver-private information.
388 struct kref refcount
;
389 struct drm_minor
*minor
;
392 struct idr magic_map
;
393 struct drm_lock_data lock
;
397 /* Flags and return codes for get_vblank_timestamp() driver function. */
398 #define DRM_CALLED_FROM_VBLIRQ 1
399 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
400 #define DRM_VBLANKTIME_IN_VBLANK (1 << 1)
402 /* get_scanout_position() return flags */
403 #define DRM_SCANOUTPOS_VALID (1 << 0)
404 #define DRM_SCANOUTPOS_IN_VBLANK (1 << 1)
405 #define DRM_SCANOUTPOS_ACCURATE (1 << 2)
408 * DRM driver structure. This structure represent the common code for
409 * a family of cards. There will one drm_device for each card present
413 int (*load
) (struct drm_device
*, unsigned long flags
);
414 int (*firstopen
) (struct drm_device
*);
415 int (*open
) (struct drm_device
*, struct drm_file
*);
416 void (*preclose
) (struct drm_device
*, struct drm_file
*file_priv
);
417 void (*postclose
) (struct drm_device
*, struct drm_file
*);
418 void (*lastclose
) (struct drm_device
*);
419 int (*unload
) (struct drm_device
*);
420 int (*dma_ioctl
) (struct drm_device
*dev
, void *data
, struct drm_file
*file_priv
);
421 int (*dma_quiescent
) (struct drm_device
*);
422 int (*context_dtor
) (struct drm_device
*dev
, int context
);
423 int (*set_busid
)(struct drm_device
*dev
, struct drm_master
*master
);
426 * get_vblank_counter - get raw hardware vblank counter
428 * @pipe: counter to fetch
430 * Driver callback for fetching a raw hardware vblank counter for @crtc.
431 * If a device doesn't have a hardware counter, the driver can simply
432 * use drm_vblank_no_hw_counter() function. The DRM core will account for
433 * missed vblank events while interrupts where disabled based on system
436 * Wraparound handling and loss of events due to modesetting is dealt
437 * with in the DRM core code.
440 * Raw vblank counter value.
442 u32 (*get_vblank_counter
) (struct drm_device
*dev
, unsigned int pipe
);
445 * enable_vblank - enable vblank interrupt events
447 * @pipe: which irq to enable
449 * Enable vblank interrupts for @crtc. If the device doesn't have
450 * a hardware vblank counter, the driver should use the
451 * drm_vblank_no_hw_counter() function that keeps a virtual counter.
454 * Zero on success, appropriate errno if the given @crtc's vblank
455 * interrupt cannot be enabled.
457 int (*enable_vblank
) (struct drm_device
*dev
, unsigned int pipe
);
460 * disable_vblank - disable vblank interrupt events
462 * @pipe: which irq to enable
464 * Disable vblank interrupts for @crtc. If the device doesn't have
465 * a hardware vblank counter, the driver should use the
466 * drm_vblank_no_hw_counter() function that keeps a virtual counter.
468 void (*disable_vblank
) (struct drm_device
*dev
, unsigned int pipe
);
471 * Called by \c drm_device_is_agp. Typically used to determine if a
472 * card is really attached to AGP or not.
474 * \param dev DRM device handle
477 * One of three values is returned depending on whether or not the
478 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
479 * (return of 1), or may or may not be AGP (return of 2).
481 int (*device_is_agp
) (struct drm_device
*dev
);
484 * Called by vblank timestamping code.
486 * Return the current display scanout position from a crtc, and an
487 * optional accurate ktime_get timestamp of when position was measured.
489 * \param dev DRM device.
490 * \param pipe Id of the crtc to query.
491 * \param flags Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
492 * \param *vpos Target location for current vertical scanout position.
493 * \param *hpos Target location for current horizontal scanout position.
494 * \param *stime Target location for timestamp taken immediately before
495 * scanout position query. Can be NULL to skip timestamp.
496 * \param *etime Target location for timestamp taken immediately after
497 * scanout position query. Can be NULL to skip timestamp.
498 * \param mode Current display timings.
500 * Returns vpos as a positive number while in active scanout area.
501 * Returns vpos as a negative number inside vblank, counting the number
502 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
503 * until start of active scanout / end of vblank."
505 * \return Flags, or'ed together as follows:
507 * DRM_SCANOUTPOS_VALID = Query successful.
508 * DRM_SCANOUTPOS_INVBL = Inside vblank.
509 * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
510 * this flag means that returned position may be offset by a constant
511 * but unknown small number of scanlines wrt. real scanout position.
514 int (*get_scanout_position
) (struct drm_device
*dev
, unsigned int pipe
,
515 unsigned int flags
, int *vpos
, int *hpos
,
516 ktime_t
*stime
, ktime_t
*etime
,
517 const struct drm_display_mode
*mode
);
520 * Called by \c drm_get_last_vbltimestamp. Should return a precise
521 * timestamp when the most recent VBLANK interval ended or will end.
523 * Specifically, the timestamp in @vblank_time should correspond as
524 * closely as possible to the time when the first video scanline of
525 * the video frame after the end of VBLANK will start scanning out,
526 * the time immediately after end of the VBLANK interval. If the
527 * @crtc is currently inside VBLANK, this will be a time in the future.
528 * If the @crtc is currently scanning out a frame, this will be the
529 * past start time of the current scanout. This is meant to adhere
530 * to the OpenML OML_sync_control extension specification.
532 * \param dev dev DRM device handle.
533 * \param pipe crtc for which timestamp should be returned.
534 * \param *max_error Maximum allowable timestamp error in nanoseconds.
535 * Implementation should strive to provide timestamp
536 * with an error of at most *max_error nanoseconds.
537 * Returns true upper bound on error for timestamp.
538 * \param *vblank_time Target location for returned vblank timestamp.
539 * \param flags 0 = Defaults, no special treatment needed.
540 * \param DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
541 * irq handler. Some drivers need to apply some workarounds
542 * for gpu-specific vblank irq quirks if flag is set.
545 * Zero if timestamping isn't supported in current display mode or a
546 * negative number on failure. A positive status code on success,
547 * which describes how the vblank_time timestamp was computed.
549 int (*get_vblank_timestamp
) (struct drm_device
*dev
, unsigned int pipe
,
551 struct timeval
*vblank_time
,
554 /* these have to be filled in */
556 irqreturn_t(*irq_handler
) (int irq
, void *arg
);
557 void (*irq_preinstall
) (struct drm_device
*dev
);
558 int (*irq_postinstall
) (struct drm_device
*dev
);
559 void (*irq_uninstall
) (struct drm_device
*dev
);
561 /* Master routines */
562 int (*master_create
)(struct drm_device
*dev
, struct drm_master
*master
);
563 void (*master_destroy
)(struct drm_device
*dev
, struct drm_master
*master
);
565 * master_set is called whenever the minor master is set.
566 * master_drop is called whenever the minor master is dropped.
569 int (*master_set
)(struct drm_device
*dev
, struct drm_file
*file_priv
,
571 void (*master_drop
)(struct drm_device
*dev
, struct drm_file
*file_priv
,
574 int (*debugfs_init
)(struct drm_minor
*minor
);
575 void (*debugfs_cleanup
)(struct drm_minor
*minor
);
578 * @gem_free_object: deconstructor for drm_gem_objects
580 * This is deprecated and should not be used by new drivers. Use
581 * @gem_free_object_unlocked instead.
583 void (*gem_free_object
) (struct drm_gem_object
*obj
);
586 * @gem_free_object_unlocked: deconstructor for drm_gem_objects
588 * This is for drivers which are not encumbered with dev->struct_mutex
589 * legacy locking schemes. Use this hook instead of @gem_free_object.
591 void (*gem_free_object_unlocked
) (struct drm_gem_object
*obj
);
593 int (*gem_open_object
) (struct drm_gem_object
*, struct drm_file
*);
594 void (*gem_close_object
) (struct drm_gem_object
*, struct drm_file
*);
597 * Hook for allocating the GEM object struct, for use by core
600 struct drm_gem_object
*(*gem_create_object
)(struct drm_device
*dev
,
604 /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
605 int (*prime_handle_to_fd
)(struct drm_device
*dev
, struct drm_file
*file_priv
,
606 uint32_t handle
, uint32_t flags
, int *prime_fd
);
607 /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
608 int (*prime_fd_to_handle
)(struct drm_device
*dev
, struct drm_file
*file_priv
,
609 int prime_fd
, uint32_t *handle
);
610 /* export GEM -> dmabuf */
611 struct dma_buf
* (*gem_prime_export
)(struct drm_device
*dev
,
612 struct drm_gem_object
*obj
, int flags
);
613 /* import dmabuf -> GEM */
614 struct drm_gem_object
* (*gem_prime_import
)(struct drm_device
*dev
,
615 struct dma_buf
*dma_buf
);
616 /* low-level interface used by drm_gem_prime_{import,export} */
617 int (*gem_prime_pin
)(struct drm_gem_object
*obj
);
618 void (*gem_prime_unpin
)(struct drm_gem_object
*obj
);
619 struct reservation_object
* (*gem_prime_res_obj
)(
620 struct drm_gem_object
*obj
);
621 struct sg_table
*(*gem_prime_get_sg_table
)(struct drm_gem_object
*obj
);
622 struct drm_gem_object
*(*gem_prime_import_sg_table
)(
623 struct drm_device
*dev
,
624 struct dma_buf_attachment
*attach
,
625 struct sg_table
*sgt
);
626 void *(*gem_prime_vmap
)(struct drm_gem_object
*obj
);
627 void (*gem_prime_vunmap
)(struct drm_gem_object
*obj
, void *vaddr
);
628 int (*gem_prime_mmap
)(struct drm_gem_object
*obj
,
629 struct vm_area_struct
*vma
);
631 /* vga arb irq handler */
632 void (*vgaarb_irq
)(struct drm_device
*dev
, bool state
);
634 /* dumb alloc support */
635 int (*dumb_create
)(struct drm_file
*file_priv
,
636 struct drm_device
*dev
,
637 struct drm_mode_create_dumb
*args
);
638 int (*dumb_map_offset
)(struct drm_file
*file_priv
,
639 struct drm_device
*dev
, uint32_t handle
,
641 int (*dumb_destroy
)(struct drm_file
*file_priv
,
642 struct drm_device
*dev
,
645 /* Driver private ops for this object */
646 const struct vm_operations_struct
*gem_vm_ops
;
657 const struct drm_ioctl_desc
*ioctls
;
659 const struct file_operations
*fops
;
661 /* List of devices hanging off this driver with stealth attach. */
662 struct list_head legacy_dev_list
;
665 enum drm_minor_type
{
673 * Info file list entry. This structure represents a debugfs or proc file to
674 * be created by the drm core
676 struct drm_info_list
{
677 const char *name
; /** file name */
678 int (*show
)(struct seq_file
*, void*); /** show callback */
679 u32 driver_features
; /**< Required driver features for this entry */
684 * debugfs node structure. This structure represents a debugfs file.
686 struct drm_info_node
{
687 struct list_head list
;
688 struct drm_minor
*minor
;
689 const struct drm_info_list
*info_ent
;
694 * DRM minor structure. This structure represents a drm minor number.
697 int index
; /**< Minor device number */
698 int type
; /**< Control or render */
699 struct device
*kdev
; /**< Linux device */
700 struct drm_device
*dev
;
702 struct dentry
*debugfs_root
;
704 struct list_head debugfs_list
;
705 struct mutex debugfs_lock
; /* Protects debugfs_list. */
707 /* currently active master for this node. Protected by master_mutex */
708 struct drm_master
*master
;
712 struct drm_pending_vblank_event
{
713 struct drm_pending_event base
;
715 struct drm_event_vblank event
;
718 struct drm_vblank_crtc
{
719 struct drm_device
*dev
; /* pointer to the drm_device */
720 wait_queue_head_t queue
; /**< VBLANK wait queue */
721 struct timer_list disable_timer
; /* delayed disable timer */
723 seqlock_t seqlock
; /* protects vblank count and time */
725 u32 count
; /* vblank counter */
726 struct timeval time
; /* vblank timestamp */
728 atomic_t refcount
; /* number of users of vblank interruptsper crtc */
729 u32 last
; /* protected by dev->vbl_lock, used */
730 /* for wraparound handling */
731 u32 last_wait
; /* Last vblank seqno waited per CRTC */
732 unsigned int inmodeset
; /* Display driver is setting mode */
733 unsigned int pipe
; /* crtc index */
734 int framedur_ns
; /* frame/field duration in ns */
735 int linedur_ns
; /* line duration in ns */
736 bool enabled
; /* so we don't call enable more than
741 * DRM device structure. This structure represent a complete card that
742 * may contain multiple heads.
745 struct list_head legacy_dev_list
;/**< list of devices per driver for stealth attach cleanup */
746 int if_version
; /**< Highest interface version set */
748 /** \name Lifetime Management */
750 struct kref ref
; /**< Object ref-count */
751 struct device
*dev
; /**< Device structure of bus-device */
752 struct drm_driver
*driver
; /**< DRM driver managing the device */
753 void *dev_private
; /**< DRM driver private data */
754 struct drm_minor
*control
; /**< Control node */
755 struct drm_minor
*primary
; /**< Primary node */
756 struct drm_minor
*render
; /**< Render node */
757 atomic_t unplugged
; /**< Flag whether dev is dead */
758 struct inode
*anon_inode
; /**< inode for private address-space */
759 char *unique
; /**< unique name of the device */
764 struct mutex struct_mutex
; /**< For others */
765 struct mutex master_mutex
; /**< For drm_minor::master and drm_file::is_master */
768 /** \name Usage Counters */
770 int open_count
; /**< Outstanding files open, protected by drm_global_mutex. */
771 spinlock_t buf_lock
; /**< For drm_device::buf_use and a few other things. */
772 int buf_use
; /**< Buffers in use -- cannot alloc */
773 atomic_t buf_alloc
; /**< Buffer allocation in progress */
776 struct mutex filelist_mutex
;
777 struct list_head filelist
;
779 /** \name Memory management */
781 struct list_head maplist
; /**< Linked list of regions */
782 struct drm_open_hash map_hash
; /**< User token hash table for maps */
784 /** \name Context handle management */
786 struct list_head ctxlist
; /**< Linked list of context handles */
787 struct mutex ctxlist_mutex
; /**< For ctxlist */
791 struct list_head vmalist
; /**< List of vmas (for debugging) */
795 /** \name DMA support */
797 struct drm_device_dma
*dma
; /**< Optional pointer for DMA support */
800 /** \name Context support */
803 __volatile__
long context_flag
; /**< Context swapping flag */
804 int last_context
; /**< Last current context */
807 /** \name VBLANK IRQ support */
813 * If true, vblank interrupt will be disabled immediately when the
814 * refcount drops to zero, as opposed to via the vblank disable
816 * This can be set to true it the hardware has a working vblank
817 * counter and the driver uses drm_vblank_on() and drm_vblank_off()
820 bool vblank_disable_immediate
;
822 /* array of size num_crtcs */
823 struct drm_vblank_crtc
*vblank
;
825 spinlock_t vblank_time_lock
; /**< Protects vblank count and time updates during vblank enable/disable */
828 u32 max_vblank_count
; /**< size of vblank counter register */
833 struct list_head vblank_event_list
;
834 spinlock_t event_lock
;
838 struct drm_agp_head
*agp
; /**< AGP data */
840 struct pci_dev
*pdev
; /**< PCI device structure */
842 struct pci_controller
*hose
;
845 struct platform_device
*platformdev
; /**< Platform device struture */
846 struct virtio_device
*virtdev
;
848 struct drm_sg_mem
*sg
; /**< Scatter gather memory */
849 unsigned int num_crtcs
; /**< Number of CRTCs on this device */
853 struct drm_hw_lock
*lock
;
856 struct drm_local_map
*agp_buffer_map
;
857 unsigned int agp_buffer_token
;
859 struct drm_mode_config mode_config
; /**< Current mode config */
861 /** \name GEM information */
863 struct mutex object_name_lock
;
864 struct idr object_name_idr
;
865 struct drm_vma_offset_manager
*vma_offset_manager
;
867 int switch_power_state
;
870 #define DRM_SWITCH_POWER_ON 0
871 #define DRM_SWITCH_POWER_OFF 1
872 #define DRM_SWITCH_POWER_CHANGING 2
873 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
875 static __inline__
int drm_core_check_feature(struct drm_device
*dev
,
878 return ((dev
->driver
->driver_features
& feature
) ? 1 : 0);
881 static inline void drm_device_set_unplugged(struct drm_device
*dev
)
884 atomic_set(&dev
->unplugged
, 1);
887 static inline int drm_device_is_unplugged(struct drm_device
*dev
)
889 int ret
= atomic_read(&dev
->unplugged
);
894 static inline bool drm_is_render_client(const struct drm_file
*file_priv
)
896 return file_priv
->minor
->type
== DRM_MINOR_RENDER
;
899 static inline bool drm_is_control_client(const struct drm_file
*file_priv
)
901 return file_priv
->minor
->type
== DRM_MINOR_CONTROL
;
904 static inline bool drm_is_primary_client(const struct drm_file
*file_priv
)
906 return file_priv
->minor
->type
== DRM_MINOR_LEGACY
;
909 /******************************************************************/
910 /** \name Internal function definitions */
913 /* Driver support (drm_drv.h) */
914 extern int drm_ioctl_permit(u32 flags
, struct drm_file
*file_priv
);
915 extern long drm_ioctl(struct file
*filp
,
916 unsigned int cmd
, unsigned long arg
);
917 extern long drm_compat_ioctl(struct file
*filp
,
918 unsigned int cmd
, unsigned long arg
);
919 extern bool drm_ioctl_flags(unsigned int nr
, unsigned int *flags
);
921 /* File Operations (drm_fops.c) */
922 int drm_open(struct inode
*inode
, struct file
*filp
);
923 ssize_t
drm_read(struct file
*filp
, char __user
*buffer
,
924 size_t count
, loff_t
*offset
);
925 int drm_release(struct inode
*inode
, struct file
*filp
);
926 int drm_new_set_master(struct drm_device
*dev
, struct drm_file
*fpriv
);
927 unsigned int drm_poll(struct file
*filp
, struct poll_table_struct
*wait
);
928 int drm_event_reserve_init_locked(struct drm_device
*dev
,
929 struct drm_file
*file_priv
,
930 struct drm_pending_event
*p
,
931 struct drm_event
*e
);
932 int drm_event_reserve_init(struct drm_device
*dev
,
933 struct drm_file
*file_priv
,
934 struct drm_pending_event
*p
,
935 struct drm_event
*e
);
936 void drm_event_cancel_free(struct drm_device
*dev
,
937 struct drm_pending_event
*p
);
938 void drm_send_event_locked(struct drm_device
*dev
, struct drm_pending_event
*e
);
939 void drm_send_event(struct drm_device
*dev
, struct drm_pending_event
*e
);
941 /* Misc. IOCTL support (drm_ioctl.c) */
942 int drm_noop(struct drm_device
*dev
, void *data
,
943 struct drm_file
*file_priv
);
944 int drm_invalid_op(struct drm_device
*dev
, void *data
,
945 struct drm_file
*file_priv
);
947 /* Cache management (drm_cache.c) */
948 void drm_clflush_pages(struct page
*pages
[], unsigned long num_pages
);
949 void drm_clflush_sg(struct sg_table
*st
);
950 void drm_clflush_virt_range(void *addr
, unsigned long length
);
953 * These are exported to drivers so that they can implement fencing using
954 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
957 /* IRQ support (drm_irq.h) */
958 extern int drm_irq_install(struct drm_device
*dev
, int irq
);
959 extern int drm_irq_uninstall(struct drm_device
*dev
);
961 extern int drm_vblank_init(struct drm_device
*dev
, unsigned int num_crtcs
);
962 extern int drm_wait_vblank(struct drm_device
*dev
, void *data
,
963 struct drm_file
*filp
);
964 extern u32
drm_vblank_count(struct drm_device
*dev
, unsigned int pipe
);
965 extern u32
drm_crtc_vblank_count(struct drm_crtc
*crtc
);
966 extern u32
drm_vblank_count_and_time(struct drm_device
*dev
, unsigned int pipe
,
967 struct timeval
*vblanktime
);
968 extern u32
drm_crtc_vblank_count_and_time(struct drm_crtc
*crtc
,
969 struct timeval
*vblanktime
);
970 extern void drm_send_vblank_event(struct drm_device
*dev
, unsigned int pipe
,
971 struct drm_pending_vblank_event
*e
);
972 extern void drm_crtc_send_vblank_event(struct drm_crtc
*crtc
,
973 struct drm_pending_vblank_event
*e
);
974 extern void drm_arm_vblank_event(struct drm_device
*dev
, unsigned int pipe
,
975 struct drm_pending_vblank_event
*e
);
976 extern void drm_crtc_arm_vblank_event(struct drm_crtc
*crtc
,
977 struct drm_pending_vblank_event
*e
);
978 extern bool drm_handle_vblank(struct drm_device
*dev
, unsigned int pipe
);
979 extern bool drm_crtc_handle_vblank(struct drm_crtc
*crtc
);
980 extern int drm_vblank_get(struct drm_device
*dev
, unsigned int pipe
);
981 extern void drm_vblank_put(struct drm_device
*dev
, unsigned int pipe
);
982 extern int drm_crtc_vblank_get(struct drm_crtc
*crtc
);
983 extern void drm_crtc_vblank_put(struct drm_crtc
*crtc
);
984 extern void drm_wait_one_vblank(struct drm_device
*dev
, unsigned int pipe
);
985 extern void drm_crtc_wait_one_vblank(struct drm_crtc
*crtc
);
986 extern void drm_vblank_off(struct drm_device
*dev
, unsigned int pipe
);
987 extern void drm_vblank_on(struct drm_device
*dev
, unsigned int pipe
);
988 extern void drm_crtc_vblank_off(struct drm_crtc
*crtc
);
989 extern void drm_crtc_vblank_reset(struct drm_crtc
*crtc
);
990 extern void drm_crtc_vblank_on(struct drm_crtc
*crtc
);
991 extern void drm_vblank_cleanup(struct drm_device
*dev
);
992 extern u32
drm_accurate_vblank_count(struct drm_crtc
*crtc
);
993 extern u32
drm_vblank_no_hw_counter(struct drm_device
*dev
, unsigned int pipe
);
995 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device
*dev
,
996 unsigned int pipe
, int *max_error
,
997 struct timeval
*vblank_time
,
999 const struct drm_display_mode
*mode
);
1000 extern void drm_calc_timestamping_constants(struct drm_crtc
*crtc
,
1001 const struct drm_display_mode
*mode
);
1004 * drm_crtc_vblank_waitqueue - get vblank waitqueue for the CRTC
1005 * @crtc: which CRTC's vblank waitqueue to retrieve
1007 * This function returns a pointer to the vblank waitqueue for the CRTC.
1008 * Drivers can use this to implement vblank waits using wait_event() & co.
1010 static inline wait_queue_head_t
*drm_crtc_vblank_waitqueue(struct drm_crtc
*crtc
)
1012 return &crtc
->dev
->vblank
[drm_crtc_index(crtc
)].queue
;
1015 /* Modesetting support */
1016 extern void drm_vblank_pre_modeset(struct drm_device
*dev
, unsigned int pipe
);
1017 extern void drm_vblank_post_modeset(struct drm_device
*dev
, unsigned int pipe
);
1019 /* Stub support (drm_stub.h) */
1020 extern struct drm_master
*drm_master_get(struct drm_master
*master
);
1021 extern void drm_master_put(struct drm_master
**master
);
1023 extern void drm_put_dev(struct drm_device
*dev
);
1024 extern void drm_unplug_dev(struct drm_device
*dev
);
1025 extern unsigned int drm_debug
;
1026 extern bool drm_atomic
;
1028 /* Debugfs support */
1029 #if defined(CONFIG_DEBUG_FS)
1030 extern int drm_debugfs_create_files(const struct drm_info_list
*files
,
1031 int count
, struct dentry
*root
,
1032 struct drm_minor
*minor
);
1033 extern int drm_debugfs_remove_files(const struct drm_info_list
*files
,
1034 int count
, struct drm_minor
*minor
);
1036 static inline int drm_debugfs_create_files(const struct drm_info_list
*files
,
1037 int count
, struct dentry
*root
,
1038 struct drm_minor
*minor
)
1043 static inline int drm_debugfs_remove_files(const struct drm_info_list
*files
,
1044 int count
, struct drm_minor
*minor
)
1050 extern struct dma_buf
*drm_gem_prime_export(struct drm_device
*dev
,
1051 struct drm_gem_object
*obj
, int flags
);
1052 extern int drm_gem_prime_handle_to_fd(struct drm_device
*dev
,
1053 struct drm_file
*file_priv
, uint32_t handle
, uint32_t flags
,
1055 extern struct drm_gem_object
*drm_gem_prime_import(struct drm_device
*dev
,
1056 struct dma_buf
*dma_buf
);
1057 extern int drm_gem_prime_fd_to_handle(struct drm_device
*dev
,
1058 struct drm_file
*file_priv
, int prime_fd
, uint32_t *handle
);
1059 extern void drm_gem_dmabuf_release(struct dma_buf
*dma_buf
);
1061 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table
*sgt
, struct page
**pages
,
1062 dma_addr_t
*addrs
, int max_pages
);
1063 extern struct sg_table
*drm_prime_pages_to_sg(struct page
**pages
, unsigned int nr_pages
);
1064 extern void drm_prime_gem_destroy(struct drm_gem_object
*obj
, struct sg_table
*sg
);
1067 extern struct drm_dma_handle
*drm_pci_alloc(struct drm_device
*dev
, size_t size
,
1069 extern void drm_pci_free(struct drm_device
*dev
, struct drm_dma_handle
* dmah
);
1071 /* sysfs support (drm_sysfs.c) */
1072 extern void drm_sysfs_hotplug_event(struct drm_device
*dev
);
1075 struct drm_device
*drm_dev_alloc(struct drm_driver
*driver
,
1076 struct device
*parent
);
1077 void drm_dev_ref(struct drm_device
*dev
);
1078 void drm_dev_unref(struct drm_device
*dev
);
1079 int drm_dev_register(struct drm_device
*dev
, unsigned long flags
);
1080 void drm_dev_unregister(struct drm_device
*dev
);
1081 int drm_dev_set_unique(struct drm_device
*dev
, const char *name
);
1083 struct drm_minor
*drm_minor_acquire(unsigned int minor_id
);
1084 void drm_minor_release(struct drm_minor
*minor
);
1089 static __inline__
int drm_pci_device_is_agp(struct drm_device
*dev
)
1091 if (dev
->driver
->device_is_agp
!= NULL
) {
1092 int err
= (*dev
->driver
->device_is_agp
) (dev
);
1099 return pci_find_capability(dev
->pdev
, PCI_CAP_ID_AGP
);
1101 void drm_pci_agp_destroy(struct drm_device
*dev
);
1103 extern int drm_pci_init(struct drm_driver
*driver
, struct pci_driver
*pdriver
);
1104 extern void drm_pci_exit(struct drm_driver
*driver
, struct pci_driver
*pdriver
);
1106 extern int drm_get_pci_dev(struct pci_dev
*pdev
,
1107 const struct pci_device_id
*ent
,
1108 struct drm_driver
*driver
);
1109 extern int drm_pci_set_busid(struct drm_device
*dev
, struct drm_master
*master
);
1111 static inline int drm_get_pci_dev(struct pci_dev
*pdev
,
1112 const struct pci_device_id
*ent
,
1113 struct drm_driver
*driver
)
1118 static inline int drm_pci_set_busid(struct drm_device
*dev
,
1119 struct drm_master
*master
)
1125 #define DRM_PCIE_SPEED_25 1
1126 #define DRM_PCIE_SPEED_50 2
1127 #define DRM_PCIE_SPEED_80 4
1129 extern int drm_pcie_get_speed_cap_mask(struct drm_device
*dev
, u32
*speed_mask
);
1130 extern int drm_pcie_get_max_link_width(struct drm_device
*dev
, u32
*mlw
);
1132 /* platform section */
1133 extern int drm_platform_init(struct drm_driver
*driver
, struct platform_device
*platform_device
);
1134 extern int drm_platform_set_busid(struct drm_device
*d
, struct drm_master
*m
);
1136 /* returns true if currently okay to sleep */
1137 static __inline__
bool drm_can_sleep(void)
1139 if (in_atomic() || in_dbg_master() || irqs_disabled())
1144 /* helper for handling conditionals in various for_each macros */
1145 #define for_each_if(condition) if (!(condition)) {} else