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_fourcc.h>
72 #include <drm/drm_global.h>
73 #include <drm/drm_hashtab.h>
74 #include <drm/drm_mem_util.h>
75 #include <drm/drm_mm.h>
76 #include <drm/drm_os_linux.h>
77 #include <drm/drm_sarea.h>
78 #include <drm/drm_vma_manager.h>
86 struct drm_device_dma
;
87 struct drm_dma_handle
;
88 struct drm_gem_object
;
92 struct reservation_object
;
93 struct dma_buf_attachment
;
96 * The following categories are defined:
98 * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
99 * This is the category used by the DRM_DEBUG() macro.
101 * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
102 * This is the category used by the DRM_DEBUG_DRIVER() macro.
104 * KMS: used in the modesetting code.
105 * This is the category used by the DRM_DEBUG_KMS() macro.
107 * PRIME: used in the prime code.
108 * This is the category used by the DRM_DEBUG_PRIME() macro.
110 * ATOMIC: used in the atomic code.
111 * This is the category used by the DRM_DEBUG_ATOMIC() macro.
113 * VBL: used for verbose debug message in the vblank code
114 * This is the category used by the DRM_DEBUG_VBL() macro.
116 * Enabling verbose debug messages is done through the drm.debug parameter,
117 * each category being enabled by a bit.
119 * drm.debug=0x1 will enable CORE messages
120 * drm.debug=0x2 will enable DRIVER messages
121 * drm.debug=0x3 will enable CORE and DRIVER messages
123 * drm.debug=0x3f will enable all messages
125 * An interesting feature is that it's possible to enable verbose logging at
126 * run-time by echoing the debug value in its sysfs node:
127 * # echo 0xf > /sys/module/drm/parameters/debug
129 #define DRM_UT_CORE 0x01
130 #define DRM_UT_DRIVER 0x02
131 #define DRM_UT_KMS 0x04
132 #define DRM_UT_PRIME 0x08
133 #define DRM_UT_ATOMIC 0x10
134 #define DRM_UT_VBL 0x20
136 extern __printf(2, 3)
137 void drm_ut_debug_printk(const char *function_name
,
138 const char *format
, ...);
139 extern __printf(1, 2)
140 void drm_err(const char *format
, ...);
142 /***********************************************************************/
143 /** \name DRM template customization defaults */
146 /* driver capabilities and requirements mask */
147 #define DRIVER_USE_AGP 0x1
148 #define DRIVER_PCI_DMA 0x8
149 #define DRIVER_SG 0x10
150 #define DRIVER_HAVE_DMA 0x20
151 #define DRIVER_HAVE_IRQ 0x40
152 #define DRIVER_IRQ_SHARED 0x80
153 #define DRIVER_GEM 0x1000
154 #define DRIVER_MODESET 0x2000
155 #define DRIVER_PRIME 0x4000
156 #define DRIVER_RENDER 0x8000
157 #define DRIVER_ATOMIC 0x10000
158 #define DRIVER_KMS_LEGACY_CONTEXT 0x20000
160 /***********************************************************************/
161 /** \name Macros to make printk easier */
167 * \param fmt printf() like format string.
168 * \param arg arguments
170 #define DRM_ERROR(fmt, ...) \
171 drm_err(fmt, ##__VA_ARGS__)
174 * Rate limited error output. Like DRM_ERROR() but won't flood the log.
176 * \param fmt printf() like format string.
177 * \param arg arguments
179 #define DRM_ERROR_RATELIMITED(fmt, ...) \
181 static DEFINE_RATELIMIT_STATE(_rs, \
182 DEFAULT_RATELIMIT_INTERVAL, \
183 DEFAULT_RATELIMIT_BURST); \
185 if (__ratelimit(&_rs)) \
186 drm_err(fmt, ##__VA_ARGS__); \
189 #define DRM_INFO(fmt, ...) \
190 printk(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
192 #define DRM_INFO_ONCE(fmt, ...) \
193 printk_once(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
198 * \param fmt printf() like format string.
199 * \param arg arguments
201 #define DRM_DEBUG(fmt, args...) \
203 if (unlikely(drm_debug & DRM_UT_CORE)) \
204 drm_ut_debug_printk(__func__, fmt, ##args); \
207 #define DRM_DEBUG_DRIVER(fmt, args...) \
209 if (unlikely(drm_debug & DRM_UT_DRIVER)) \
210 drm_ut_debug_printk(__func__, fmt, ##args); \
212 #define DRM_DEBUG_KMS(fmt, args...) \
214 if (unlikely(drm_debug & DRM_UT_KMS)) \
215 drm_ut_debug_printk(__func__, fmt, ##args); \
217 #define DRM_DEBUG_PRIME(fmt, args...) \
219 if (unlikely(drm_debug & DRM_UT_PRIME)) \
220 drm_ut_debug_printk(__func__, fmt, ##args); \
222 #define DRM_DEBUG_ATOMIC(fmt, args...) \
224 if (unlikely(drm_debug & DRM_UT_ATOMIC)) \
225 drm_ut_debug_printk(__func__, fmt, ##args); \
227 #define DRM_DEBUG_VBL(fmt, args...) \
229 if (unlikely(drm_debug & DRM_UT_VBL)) \
230 drm_ut_debug_printk(__func__, fmt, ##args); \
235 /***********************************************************************/
236 /** \name Internal types and structures */
239 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
242 * Ioctl function type.
244 * \param inode device inode.
245 * \param file_priv DRM file private pointer.
246 * \param cmd command.
247 * \param arg argument.
249 typedef int drm_ioctl_t(struct drm_device
*dev
, void *data
,
250 struct drm_file
*file_priv
);
252 typedef int drm_ioctl_compat_t(struct file
*filp
, unsigned int cmd
,
255 #define DRM_IOCTL_NR(n) _IOC_NR(n)
256 #define DRM_MAJOR 226
259 #define DRM_MASTER 0x2
260 #define DRM_ROOT_ONLY 0x4
261 #define DRM_CONTROL_ALLOW 0x8
262 #define DRM_UNLOCKED 0x10
263 #define DRM_RENDER_ALLOW 0x20
265 struct drm_ioctl_desc
{
273 * Creates a driver or general drm_ioctl_desc array entry for the given
274 * ioctl, for use by drm_ioctl().
277 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags) \
278 [DRM_IOCTL_NR(DRM_IOCTL_##ioctl) - DRM_COMMAND_BASE] = { \
279 .cmd = DRM_IOCTL_##ioctl, \
285 /* Event queued up for userspace to read */
286 struct drm_pending_event
{
287 struct completion
*completion
;
288 struct drm_event
*event
;
290 struct list_head link
;
291 struct list_head pending_link
;
292 struct drm_file
*file_priv
;
293 pid_t pid
; /* pid of requester, no guarantee it's valid by the time
294 we deliver the event, for tracing only */
297 /* initial implementaton using a linked list - todo hashtab */
298 struct drm_prime_file_private
{
299 struct list_head head
;
303 /** File private data */
305 unsigned authenticated
:1;
306 /* Whether we're master for a minor. Protected by master_mutex */
307 unsigned is_master
:1;
308 /* true when the client has asked us to expose stereo 3D mode flags */
309 unsigned stereo_allowed
:1;
311 * true if client understands CRTC primary planes and cursor planes
314 unsigned universal_planes
:1;
315 /* true if client understands atomic properties */
318 * This client is allowed to gain master privileges for @master.
319 * Protected by struct drm_device::master_mutex.
321 unsigned allowed_master
:1;
326 struct list_head lhead
;
327 struct drm_minor
*minor
;
328 unsigned long lock_count
;
330 /** Mapping of mm object handles to object pointers. */
331 struct idr object_idr
;
332 /** Lock for synchronization of access to object_idr. */
333 spinlock_t table_lock
;
338 struct drm_master
*master
; /* master this node is currently associated with
339 N.B. not always minor->master */
341 * fbs - List of framebuffers associated with this file.
343 * Protected by fbs_lock. Note that the fbs list holds a reference on
344 * the fb object to prevent it from untimely disappearing.
346 struct list_head fbs
;
347 struct mutex fbs_lock
;
349 /** User-created blob properties; this retains a reference on the
351 struct list_head blobs
;
353 wait_queue_head_t event_wait
;
354 struct list_head pending_event_list
;
355 struct list_head event_list
;
358 struct mutex event_read_lock
;
360 struct drm_prime_file_private prime
;
366 struct drm_lock_data
{
367 struct drm_hw_lock
*hw_lock
; /**< Hardware lock */
368 /** Private of lock holder's file (NULL=kernel) */
369 struct drm_file
*file_priv
;
370 wait_queue_head_t lock_queue
; /**< Queue of blocked processes */
371 unsigned long lock_time
; /**< Time of last lock in jiffies */
373 uint32_t kernel_waiters
;
374 uint32_t user_waiters
;
379 * struct drm_master - drm master structure
381 * @refcount: Refcount for this master object.
382 * @minor: Link back to minor char device we are master for. Immutable.
383 * @unique: Unique identifier: e.g. busid. Protected by drm_global_mutex.
384 * @unique_len: Length of unique field. Protected by drm_global_mutex.
385 * @magic_map: Map of used authentication tokens. Protected by struct_mutex.
386 * @lock: DRI lock information.
387 * @driver_priv: Pointer to driver-private information.
390 struct kref refcount
;
391 struct drm_minor
*minor
;
394 struct idr magic_map
;
395 struct drm_lock_data lock
;
399 /* Flags and return codes for get_vblank_timestamp() driver function. */
400 #define DRM_CALLED_FROM_VBLIRQ 1
401 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
402 #define DRM_VBLANKTIME_IN_VBLANK (1 << 1)
404 /* get_scanout_position() return flags */
405 #define DRM_SCANOUTPOS_VALID (1 << 0)
406 #define DRM_SCANOUTPOS_IN_VBLANK (1 << 1)
407 #define DRM_SCANOUTPOS_ACCURATE (1 << 2)
410 * DRM driver structure. This structure represent the common code for
411 * a family of cards. There will one drm_device for each card present
415 int (*load
) (struct drm_device
*, unsigned long flags
);
416 int (*firstopen
) (struct drm_device
*);
417 int (*open
) (struct drm_device
*, struct drm_file
*);
418 void (*preclose
) (struct drm_device
*, struct drm_file
*file_priv
);
419 void (*postclose
) (struct drm_device
*, struct drm_file
*);
420 void (*lastclose
) (struct drm_device
*);
421 int (*unload
) (struct drm_device
*);
422 int (*dma_ioctl
) (struct drm_device
*dev
, void *data
, struct drm_file
*file_priv
);
423 int (*dma_quiescent
) (struct drm_device
*);
424 int (*context_dtor
) (struct drm_device
*dev
, int context
);
425 int (*set_busid
)(struct drm_device
*dev
, struct drm_master
*master
);
428 * get_vblank_counter - get raw hardware vblank counter
430 * @pipe: counter to fetch
432 * Driver callback for fetching a raw hardware vblank counter for @crtc.
433 * If a device doesn't have a hardware counter, the driver can simply
434 * use drm_vblank_no_hw_counter() function. The DRM core will account for
435 * missed vblank events while interrupts where disabled based on system
438 * Wraparound handling and loss of events due to modesetting is dealt
439 * with in the DRM core code.
442 * Raw vblank counter value.
444 u32 (*get_vblank_counter
) (struct drm_device
*dev
, unsigned int pipe
);
447 * enable_vblank - enable vblank interrupt events
449 * @pipe: which irq to enable
451 * Enable vblank interrupts for @crtc. If the device doesn't have
452 * a hardware vblank counter, the driver should use the
453 * drm_vblank_no_hw_counter() function that keeps a virtual counter.
456 * Zero on success, appropriate errno if the given @crtc's vblank
457 * interrupt cannot be enabled.
459 int (*enable_vblank
) (struct drm_device
*dev
, unsigned int pipe
);
462 * disable_vblank - disable vblank interrupt events
464 * @pipe: which irq to enable
466 * Disable vblank interrupts for @crtc. If the device doesn't have
467 * a hardware vblank counter, the driver should use the
468 * drm_vblank_no_hw_counter() function that keeps a virtual counter.
470 void (*disable_vblank
) (struct drm_device
*dev
, unsigned int pipe
);
473 * Called by \c drm_device_is_agp. Typically used to determine if a
474 * card is really attached to AGP or not.
476 * \param dev DRM device handle
479 * One of three values is returned depending on whether or not the
480 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
481 * (return of 1), or may or may not be AGP (return of 2).
483 int (*device_is_agp
) (struct drm_device
*dev
);
486 * Called by vblank timestamping code.
488 * Return the current display scanout position from a crtc, and an
489 * optional accurate ktime_get timestamp of when position was measured.
491 * \param dev DRM device.
492 * \param pipe Id of the crtc to query.
493 * \param flags Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
494 * \param *vpos Target location for current vertical scanout position.
495 * \param *hpos Target location for current horizontal scanout position.
496 * \param *stime Target location for timestamp taken immediately before
497 * scanout position query. Can be NULL to skip timestamp.
498 * \param *etime Target location for timestamp taken immediately after
499 * scanout position query. Can be NULL to skip timestamp.
500 * \param mode Current display timings.
502 * Returns vpos as a positive number while in active scanout area.
503 * Returns vpos as a negative number inside vblank, counting the number
504 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
505 * until start of active scanout / end of vblank."
507 * \return Flags, or'ed together as follows:
509 * DRM_SCANOUTPOS_VALID = Query successful.
510 * DRM_SCANOUTPOS_INVBL = Inside vblank.
511 * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
512 * this flag means that returned position may be offset by a constant
513 * but unknown small number of scanlines wrt. real scanout position.
516 int (*get_scanout_position
) (struct drm_device
*dev
, unsigned int pipe
,
517 unsigned int flags
, int *vpos
, int *hpos
,
518 ktime_t
*stime
, ktime_t
*etime
,
519 const struct drm_display_mode
*mode
);
522 * Called by \c drm_get_last_vbltimestamp. Should return a precise
523 * timestamp when the most recent VBLANK interval ended or will end.
525 * Specifically, the timestamp in @vblank_time should correspond as
526 * closely as possible to the time when the first video scanline of
527 * the video frame after the end of VBLANK will start scanning out,
528 * the time immediately after end of the VBLANK interval. If the
529 * @crtc is currently inside VBLANK, this will be a time in the future.
530 * If the @crtc is currently scanning out a frame, this will be the
531 * past start time of the current scanout. This is meant to adhere
532 * to the OpenML OML_sync_control extension specification.
534 * \param dev dev DRM device handle.
535 * \param pipe crtc for which timestamp should be returned.
536 * \param *max_error Maximum allowable timestamp error in nanoseconds.
537 * Implementation should strive to provide timestamp
538 * with an error of at most *max_error nanoseconds.
539 * Returns true upper bound on error for timestamp.
540 * \param *vblank_time Target location for returned vblank timestamp.
541 * \param flags 0 = Defaults, no special treatment needed.
542 * \param DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
543 * irq handler. Some drivers need to apply some workarounds
544 * for gpu-specific vblank irq quirks if flag is set.
547 * Zero if timestamping isn't supported in current display mode or a
548 * negative number on failure. A positive status code on success,
549 * which describes how the vblank_time timestamp was computed.
551 int (*get_vblank_timestamp
) (struct drm_device
*dev
, unsigned int pipe
,
553 struct timeval
*vblank_time
,
556 /* these have to be filled in */
558 irqreturn_t(*irq_handler
) (int irq
, void *arg
);
559 void (*irq_preinstall
) (struct drm_device
*dev
);
560 int (*irq_postinstall
) (struct drm_device
*dev
);
561 void (*irq_uninstall
) (struct drm_device
*dev
);
563 /* Master routines */
564 int (*master_create
)(struct drm_device
*dev
, struct drm_master
*master
);
565 void (*master_destroy
)(struct drm_device
*dev
, struct drm_master
*master
);
567 * master_set is called whenever the minor master is set.
568 * master_drop is called whenever the minor master is dropped.
571 int (*master_set
)(struct drm_device
*dev
, struct drm_file
*file_priv
,
573 void (*master_drop
)(struct drm_device
*dev
, struct drm_file
*file_priv
,
576 int (*debugfs_init
)(struct drm_minor
*minor
);
577 void (*debugfs_cleanup
)(struct drm_minor
*minor
);
580 * @gem_free_object: deconstructor for drm_gem_objects
582 * This is deprecated and should not be used by new drivers. Use
583 * @gem_free_object_unlocked instead.
585 void (*gem_free_object
) (struct drm_gem_object
*obj
);
588 * @gem_free_object_unlocked: deconstructor for drm_gem_objects
590 * This is for drivers which are not encumbered with dev->struct_mutex
591 * legacy locking schemes. Use this hook instead of @gem_free_object.
593 void (*gem_free_object_unlocked
) (struct drm_gem_object
*obj
);
595 int (*gem_open_object
) (struct drm_gem_object
*, struct drm_file
*);
596 void (*gem_close_object
) (struct drm_gem_object
*, struct drm_file
*);
599 * Hook for allocating the GEM object struct, for use by core
602 struct drm_gem_object
*(*gem_create_object
)(struct drm_device
*dev
,
606 /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
607 int (*prime_handle_to_fd
)(struct drm_device
*dev
, struct drm_file
*file_priv
,
608 uint32_t handle
, uint32_t flags
, int *prime_fd
);
609 /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
610 int (*prime_fd_to_handle
)(struct drm_device
*dev
, struct drm_file
*file_priv
,
611 int prime_fd
, uint32_t *handle
);
612 /* export GEM -> dmabuf */
613 struct dma_buf
* (*gem_prime_export
)(struct drm_device
*dev
,
614 struct drm_gem_object
*obj
, int flags
);
615 /* import dmabuf -> GEM */
616 struct drm_gem_object
* (*gem_prime_import
)(struct drm_device
*dev
,
617 struct dma_buf
*dma_buf
);
618 /* low-level interface used by drm_gem_prime_{import,export} */
619 int (*gem_prime_pin
)(struct drm_gem_object
*obj
);
620 void (*gem_prime_unpin
)(struct drm_gem_object
*obj
);
621 struct reservation_object
* (*gem_prime_res_obj
)(
622 struct drm_gem_object
*obj
);
623 struct sg_table
*(*gem_prime_get_sg_table
)(struct drm_gem_object
*obj
);
624 struct drm_gem_object
*(*gem_prime_import_sg_table
)(
625 struct drm_device
*dev
,
626 struct dma_buf_attachment
*attach
,
627 struct sg_table
*sgt
);
628 void *(*gem_prime_vmap
)(struct drm_gem_object
*obj
);
629 void (*gem_prime_vunmap
)(struct drm_gem_object
*obj
, void *vaddr
);
630 int (*gem_prime_mmap
)(struct drm_gem_object
*obj
,
631 struct vm_area_struct
*vma
);
633 /* vga arb irq handler */
634 void (*vgaarb_irq
)(struct drm_device
*dev
, bool state
);
636 /* dumb alloc support */
637 int (*dumb_create
)(struct drm_file
*file_priv
,
638 struct drm_device
*dev
,
639 struct drm_mode_create_dumb
*args
);
640 int (*dumb_map_offset
)(struct drm_file
*file_priv
,
641 struct drm_device
*dev
, uint32_t handle
,
643 int (*dumb_destroy
)(struct drm_file
*file_priv
,
644 struct drm_device
*dev
,
647 /* Driver private ops for this object */
648 const struct vm_operations_struct
*gem_vm_ops
;
659 const struct drm_ioctl_desc
*ioctls
;
661 const struct file_operations
*fops
;
663 /* List of devices hanging off this driver with stealth attach. */
664 struct list_head legacy_dev_list
;
667 enum drm_minor_type
{
675 * Info file list entry. This structure represents a debugfs or proc file to
676 * be created by the drm core
678 struct drm_info_list
{
679 const char *name
; /** file name */
680 int (*show
)(struct seq_file
*, void*); /** show callback */
681 u32 driver_features
; /**< Required driver features for this entry */
686 * debugfs node structure. This structure represents a debugfs file.
688 struct drm_info_node
{
689 struct list_head list
;
690 struct drm_minor
*minor
;
691 const struct drm_info_list
*info_ent
;
696 * DRM minor structure. This structure represents a drm minor number.
699 int index
; /**< Minor device number */
700 int type
; /**< Control or render */
701 struct device
*kdev
; /**< Linux device */
702 struct drm_device
*dev
;
704 struct dentry
*debugfs_root
;
706 struct list_head debugfs_list
;
707 struct mutex debugfs_lock
; /* Protects debugfs_list. */
709 /* currently active master for this node. Protected by master_mutex */
710 struct drm_master
*master
;
714 struct drm_pending_vblank_event
{
715 struct drm_pending_event base
;
717 struct drm_event_vblank event
;
720 struct drm_vblank_crtc
{
721 struct drm_device
*dev
; /* pointer to the drm_device */
722 wait_queue_head_t queue
; /**< VBLANK wait queue */
723 struct timer_list disable_timer
; /* delayed disable timer */
725 seqlock_t seqlock
; /* protects vblank count and time */
727 u32 count
; /* vblank counter */
728 struct timeval time
; /* vblank timestamp */
730 atomic_t refcount
; /* number of users of vblank interruptsper crtc */
731 u32 last
; /* protected by dev->vbl_lock, used */
732 /* for wraparound handling */
733 u32 last_wait
; /* Last vblank seqno waited per CRTC */
734 unsigned int inmodeset
; /* Display driver is setting mode */
735 unsigned int pipe
; /* crtc index */
736 int framedur_ns
; /* frame/field duration in ns */
737 int linedur_ns
; /* line duration in ns */
738 bool enabled
; /* so we don't call enable more than
743 * DRM device structure. This structure represent a complete card that
744 * may contain multiple heads.
747 struct list_head legacy_dev_list
;/**< list of devices per driver for stealth attach cleanup */
748 int if_version
; /**< Highest interface version set */
750 /** \name Lifetime Management */
752 struct kref ref
; /**< Object ref-count */
753 struct device
*dev
; /**< Device structure of bus-device */
754 struct drm_driver
*driver
; /**< DRM driver managing the device */
755 void *dev_private
; /**< DRM driver private data */
756 struct drm_minor
*control
; /**< Control node */
757 struct drm_minor
*primary
; /**< Primary node */
758 struct drm_minor
*render
; /**< Render node */
759 atomic_t unplugged
; /**< Flag whether dev is dead */
760 struct inode
*anon_inode
; /**< inode for private address-space */
761 char *unique
; /**< unique name of the device */
766 struct mutex struct_mutex
; /**< For others */
767 struct mutex master_mutex
; /**< For drm_minor::master and drm_file::is_master */
770 /** \name Usage Counters */
772 int open_count
; /**< Outstanding files open, protected by drm_global_mutex. */
773 spinlock_t buf_lock
; /**< For drm_device::buf_use and a few other things. */
774 int buf_use
; /**< Buffers in use -- cannot alloc */
775 atomic_t buf_alloc
; /**< Buffer allocation in progress */
778 struct mutex filelist_mutex
;
779 struct list_head filelist
;
781 /** \name Memory management */
783 struct list_head maplist
; /**< Linked list of regions */
784 struct drm_open_hash map_hash
; /**< User token hash table for maps */
786 /** \name Context handle management */
788 struct list_head ctxlist
; /**< Linked list of context handles */
789 struct mutex ctxlist_mutex
; /**< For ctxlist */
793 struct list_head vmalist
; /**< List of vmas (for debugging) */
797 /** \name DMA support */
799 struct drm_device_dma
*dma
; /**< Optional pointer for DMA support */
802 /** \name Context support */
805 __volatile__
long context_flag
; /**< Context swapping flag */
806 int last_context
; /**< Last current context */
809 /** \name VBLANK IRQ support */
815 * If true, vblank interrupt will be disabled immediately when the
816 * refcount drops to zero, as opposed to via the vblank disable
818 * This can be set to true it the hardware has a working vblank
819 * counter and the driver uses drm_vblank_on() and drm_vblank_off()
822 bool vblank_disable_immediate
;
824 /* array of size num_crtcs */
825 struct drm_vblank_crtc
*vblank
;
827 spinlock_t vblank_time_lock
; /**< Protects vblank count and time updates during vblank enable/disable */
830 u32 max_vblank_count
; /**< size of vblank counter register */
835 struct list_head vblank_event_list
;
836 spinlock_t event_lock
;
840 struct drm_agp_head
*agp
; /**< AGP data */
842 struct pci_dev
*pdev
; /**< PCI device structure */
844 struct pci_controller
*hose
;
847 struct platform_device
*platformdev
; /**< Platform device struture */
848 struct virtio_device
*virtdev
;
850 struct drm_sg_mem
*sg
; /**< Scatter gather memory */
851 unsigned int num_crtcs
; /**< Number of CRTCs on this device */
855 struct drm_hw_lock
*lock
;
858 struct drm_local_map
*agp_buffer_map
;
859 unsigned int agp_buffer_token
;
861 struct drm_mode_config mode_config
; /**< Current mode config */
863 /** \name GEM information */
865 struct mutex object_name_lock
;
866 struct idr object_name_idr
;
867 struct drm_vma_offset_manager
*vma_offset_manager
;
869 int switch_power_state
;
872 #define DRM_SWITCH_POWER_ON 0
873 #define DRM_SWITCH_POWER_OFF 1
874 #define DRM_SWITCH_POWER_CHANGING 2
875 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
877 static __inline__
int drm_core_check_feature(struct drm_device
*dev
,
880 return ((dev
->driver
->driver_features
& feature
) ? 1 : 0);
883 static inline void drm_device_set_unplugged(struct drm_device
*dev
)
886 atomic_set(&dev
->unplugged
, 1);
889 static inline int drm_device_is_unplugged(struct drm_device
*dev
)
891 int ret
= atomic_read(&dev
->unplugged
);
896 static inline bool drm_is_render_client(const struct drm_file
*file_priv
)
898 return file_priv
->minor
->type
== DRM_MINOR_RENDER
;
901 static inline bool drm_is_control_client(const struct drm_file
*file_priv
)
903 return file_priv
->minor
->type
== DRM_MINOR_CONTROL
;
906 static inline bool drm_is_primary_client(const struct drm_file
*file_priv
)
908 return file_priv
->minor
->type
== DRM_MINOR_LEGACY
;
911 /******************************************************************/
912 /** \name Internal function definitions */
915 /* Driver support (drm_drv.h) */
916 extern int drm_ioctl_permit(u32 flags
, struct drm_file
*file_priv
);
917 extern long drm_ioctl(struct file
*filp
,
918 unsigned int cmd
, unsigned long arg
);
919 extern long drm_compat_ioctl(struct file
*filp
,
920 unsigned int cmd
, unsigned long arg
);
921 extern bool drm_ioctl_flags(unsigned int nr
, unsigned int *flags
);
923 /* File Operations (drm_fops.c) */
924 int drm_open(struct inode
*inode
, struct file
*filp
);
925 ssize_t
drm_read(struct file
*filp
, char __user
*buffer
,
926 size_t count
, loff_t
*offset
);
927 int drm_release(struct inode
*inode
, struct file
*filp
);
928 int drm_new_set_master(struct drm_device
*dev
, struct drm_file
*fpriv
);
929 unsigned int drm_poll(struct file
*filp
, struct poll_table_struct
*wait
);
930 int drm_event_reserve_init_locked(struct drm_device
*dev
,
931 struct drm_file
*file_priv
,
932 struct drm_pending_event
*p
,
933 struct drm_event
*e
);
934 int drm_event_reserve_init(struct drm_device
*dev
,
935 struct drm_file
*file_priv
,
936 struct drm_pending_event
*p
,
937 struct drm_event
*e
);
938 void drm_event_cancel_free(struct drm_device
*dev
,
939 struct drm_pending_event
*p
);
940 void drm_send_event_locked(struct drm_device
*dev
, struct drm_pending_event
*e
);
941 void drm_send_event(struct drm_device
*dev
, struct drm_pending_event
*e
);
943 /* Misc. IOCTL support (drm_ioctl.c) */
944 int drm_noop(struct drm_device
*dev
, void *data
,
945 struct drm_file
*file_priv
);
946 int drm_invalid_op(struct drm_device
*dev
, void *data
,
947 struct drm_file
*file_priv
);
949 /* Cache management (drm_cache.c) */
950 void drm_clflush_pages(struct page
*pages
[], unsigned long num_pages
);
951 void drm_clflush_sg(struct sg_table
*st
);
952 void drm_clflush_virt_range(void *addr
, unsigned long length
);
955 * These are exported to drivers so that they can implement fencing using
956 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
959 /* IRQ support (drm_irq.h) */
960 extern int drm_irq_install(struct drm_device
*dev
, int irq
);
961 extern int drm_irq_uninstall(struct drm_device
*dev
);
963 extern int drm_vblank_init(struct drm_device
*dev
, unsigned int num_crtcs
);
964 extern int drm_wait_vblank(struct drm_device
*dev
, void *data
,
965 struct drm_file
*filp
);
966 extern u32
drm_vblank_count(struct drm_device
*dev
, unsigned int pipe
);
967 extern u32
drm_crtc_vblank_count(struct drm_crtc
*crtc
);
968 extern u32
drm_vblank_count_and_time(struct drm_device
*dev
, unsigned int pipe
,
969 struct timeval
*vblanktime
);
970 extern u32
drm_crtc_vblank_count_and_time(struct drm_crtc
*crtc
,
971 struct timeval
*vblanktime
);
972 extern void drm_crtc_send_vblank_event(struct drm_crtc
*crtc
,
973 struct drm_pending_vblank_event
*e
);
974 extern void drm_crtc_arm_vblank_event(struct drm_crtc
*crtc
,
975 struct drm_pending_vblank_event
*e
);
976 extern bool drm_handle_vblank(struct drm_device
*dev
, unsigned int pipe
);
977 extern bool drm_crtc_handle_vblank(struct drm_crtc
*crtc
);
978 extern int drm_vblank_get(struct drm_device
*dev
, unsigned int pipe
);
979 extern void drm_vblank_put(struct drm_device
*dev
, unsigned int pipe
);
980 extern int drm_crtc_vblank_get(struct drm_crtc
*crtc
);
981 extern void drm_crtc_vblank_put(struct drm_crtc
*crtc
);
982 extern void drm_wait_one_vblank(struct drm_device
*dev
, unsigned int pipe
);
983 extern void drm_crtc_wait_one_vblank(struct drm_crtc
*crtc
);
984 extern void drm_vblank_off(struct drm_device
*dev
, unsigned int pipe
);
985 extern void drm_vblank_on(struct drm_device
*dev
, unsigned int pipe
);
986 extern void drm_crtc_vblank_off(struct drm_crtc
*crtc
);
987 extern void drm_crtc_vblank_reset(struct drm_crtc
*crtc
);
988 extern void drm_crtc_vblank_on(struct drm_crtc
*crtc
);
989 extern void drm_vblank_cleanup(struct drm_device
*dev
);
990 extern u32
drm_accurate_vblank_count(struct drm_crtc
*crtc
);
991 extern u32
drm_vblank_no_hw_counter(struct drm_device
*dev
, unsigned int pipe
);
993 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device
*dev
,
994 unsigned int pipe
, int *max_error
,
995 struct timeval
*vblank_time
,
997 const struct drm_display_mode
*mode
);
998 extern void drm_calc_timestamping_constants(struct drm_crtc
*crtc
,
999 const struct drm_display_mode
*mode
);
1002 * drm_crtc_vblank_waitqueue - get vblank waitqueue for the CRTC
1003 * @crtc: which CRTC's vblank waitqueue to retrieve
1005 * This function returns a pointer to the vblank waitqueue for the CRTC.
1006 * Drivers can use this to implement vblank waits using wait_event() & co.
1008 static inline wait_queue_head_t
*drm_crtc_vblank_waitqueue(struct drm_crtc
*crtc
)
1010 return &crtc
->dev
->vblank
[drm_crtc_index(crtc
)].queue
;
1013 /* Modesetting support */
1014 extern void drm_vblank_pre_modeset(struct drm_device
*dev
, unsigned int pipe
);
1015 extern void drm_vblank_post_modeset(struct drm_device
*dev
, unsigned int pipe
);
1017 /* Stub support (drm_stub.h) */
1018 extern struct drm_master
*drm_master_get(struct drm_master
*master
);
1019 extern void drm_master_put(struct drm_master
**master
);
1021 extern void drm_put_dev(struct drm_device
*dev
);
1022 extern void drm_unplug_dev(struct drm_device
*dev
);
1023 extern unsigned int drm_debug
;
1024 extern bool drm_atomic
;
1026 /* Debugfs support */
1027 #if defined(CONFIG_DEBUG_FS)
1028 extern int drm_debugfs_create_files(const struct drm_info_list
*files
,
1029 int count
, struct dentry
*root
,
1030 struct drm_minor
*minor
);
1031 extern int drm_debugfs_remove_files(const struct drm_info_list
*files
,
1032 int count
, struct drm_minor
*minor
);
1034 static inline int drm_debugfs_create_files(const struct drm_info_list
*files
,
1035 int count
, struct dentry
*root
,
1036 struct drm_minor
*minor
)
1041 static inline int drm_debugfs_remove_files(const struct drm_info_list
*files
,
1042 int count
, struct drm_minor
*minor
)
1048 extern struct dma_buf
*drm_gem_prime_export(struct drm_device
*dev
,
1049 struct drm_gem_object
*obj
, int flags
);
1050 extern int drm_gem_prime_handle_to_fd(struct drm_device
*dev
,
1051 struct drm_file
*file_priv
, uint32_t handle
, uint32_t flags
,
1053 extern struct drm_gem_object
*drm_gem_prime_import(struct drm_device
*dev
,
1054 struct dma_buf
*dma_buf
);
1055 extern int drm_gem_prime_fd_to_handle(struct drm_device
*dev
,
1056 struct drm_file
*file_priv
, int prime_fd
, uint32_t *handle
);
1057 extern void drm_gem_dmabuf_release(struct dma_buf
*dma_buf
);
1059 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table
*sgt
, struct page
**pages
,
1060 dma_addr_t
*addrs
, int max_pages
);
1061 extern struct sg_table
*drm_prime_pages_to_sg(struct page
**pages
, unsigned int nr_pages
);
1062 extern void drm_prime_gem_destroy(struct drm_gem_object
*obj
, struct sg_table
*sg
);
1065 extern struct drm_dma_handle
*drm_pci_alloc(struct drm_device
*dev
, size_t size
,
1067 extern void drm_pci_free(struct drm_device
*dev
, struct drm_dma_handle
* dmah
);
1069 /* sysfs support (drm_sysfs.c) */
1070 extern void drm_sysfs_hotplug_event(struct drm_device
*dev
);
1073 struct drm_device
*drm_dev_alloc(struct drm_driver
*driver
,
1074 struct device
*parent
);
1075 void drm_dev_ref(struct drm_device
*dev
);
1076 void drm_dev_unref(struct drm_device
*dev
);
1077 int drm_dev_register(struct drm_device
*dev
, unsigned long flags
);
1078 void drm_dev_unregister(struct drm_device
*dev
);
1079 int drm_dev_set_unique(struct drm_device
*dev
, const char *name
);
1081 struct drm_minor
*drm_minor_acquire(unsigned int minor_id
);
1082 void drm_minor_release(struct drm_minor
*minor
);
1087 static __inline__
int drm_pci_device_is_agp(struct drm_device
*dev
)
1089 if (dev
->driver
->device_is_agp
!= NULL
) {
1090 int err
= (*dev
->driver
->device_is_agp
) (dev
);
1097 return pci_find_capability(dev
->pdev
, PCI_CAP_ID_AGP
);
1099 void drm_pci_agp_destroy(struct drm_device
*dev
);
1101 extern int drm_pci_init(struct drm_driver
*driver
, struct pci_driver
*pdriver
);
1102 extern void drm_pci_exit(struct drm_driver
*driver
, struct pci_driver
*pdriver
);
1104 extern int drm_get_pci_dev(struct pci_dev
*pdev
,
1105 const struct pci_device_id
*ent
,
1106 struct drm_driver
*driver
);
1107 extern int drm_pci_set_busid(struct drm_device
*dev
, struct drm_master
*master
);
1109 static inline int drm_get_pci_dev(struct pci_dev
*pdev
,
1110 const struct pci_device_id
*ent
,
1111 struct drm_driver
*driver
)
1116 static inline int drm_pci_set_busid(struct drm_device
*dev
,
1117 struct drm_master
*master
)
1123 #define DRM_PCIE_SPEED_25 1
1124 #define DRM_PCIE_SPEED_50 2
1125 #define DRM_PCIE_SPEED_80 4
1127 extern int drm_pcie_get_speed_cap_mask(struct drm_device
*dev
, u32
*speed_mask
);
1128 extern int drm_pcie_get_max_link_width(struct drm_device
*dev
, u32
*mlw
);
1130 /* platform section */
1131 extern int drm_platform_init(struct drm_driver
*driver
, struct platform_device
*platform_device
);
1132 extern int drm_platform_set_busid(struct drm_device
*d
, struct drm_master
*m
);
1134 /* returns true if currently okay to sleep */
1135 static __inline__
bool drm_can_sleep(void)
1137 if (in_atomic() || in_dbg_master() || irqs_disabled())
1142 /* helper for handling conditionals in various for_each macros */
1143 #define for_each_if(condition) if (!(condition)) {} else