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 * Enabling verbose debug messages is done through the drm.debug parameter,
108 * each category being enabled by a bit.
110 * drm.debug=0x1 will enable CORE messages
111 * drm.debug=0x2 will enable DRIVER messages
112 * drm.debug=0x3 will enable CORE and DRIVER messages
114 * drm.debug=0xf will enable all messages
116 * An interesting feature is that it's possible to enable verbose logging at
117 * run-time by echoing the debug value in its sysfs node:
118 * # echo 0xf > /sys/module/drm/parameters/debug
120 #define DRM_UT_CORE 0x01
121 #define DRM_UT_DRIVER 0x02
122 #define DRM_UT_KMS 0x04
123 #define DRM_UT_PRIME 0x08
125 extern __printf(2, 3)
126 void drm_ut_debug_printk(const char *function_name
,
127 const char *format
, ...);
128 extern __printf(1, 2)
129 void drm_err(const char *format
, ...);
131 /***********************************************************************/
132 /** \name DRM template customization defaults */
135 /* driver capabilities and requirements mask */
136 #define DRIVER_USE_AGP 0x1
137 #define DRIVER_PCI_DMA 0x8
138 #define DRIVER_SG 0x10
139 #define DRIVER_HAVE_DMA 0x20
140 #define DRIVER_HAVE_IRQ 0x40
141 #define DRIVER_IRQ_SHARED 0x80
142 #define DRIVER_GEM 0x1000
143 #define DRIVER_MODESET 0x2000
144 #define DRIVER_PRIME 0x4000
145 #define DRIVER_RENDER 0x8000
146 #define DRIVER_ATOMIC 0x10000
148 /***********************************************************************/
149 /** \name Macros to make printk easier */
155 * \param fmt printf() like format string.
156 * \param arg arguments
158 #define DRM_ERROR(fmt, ...) \
159 drm_err(fmt, ##__VA_ARGS__)
162 * Rate limited error output. Like DRM_ERROR() but won't flood the log.
164 * \param fmt printf() like format string.
165 * \param arg arguments
167 #define DRM_ERROR_RATELIMITED(fmt, ...) \
169 static DEFINE_RATELIMIT_STATE(_rs, \
170 DEFAULT_RATELIMIT_INTERVAL, \
171 DEFAULT_RATELIMIT_BURST); \
173 if (__ratelimit(&_rs)) \
174 drm_err(fmt, ##__VA_ARGS__); \
177 #define DRM_INFO(fmt, ...) \
178 printk(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
180 #define DRM_INFO_ONCE(fmt, ...) \
181 printk_once(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
186 * \param fmt printf() like format string.
187 * \param arg arguments
189 #define DRM_DEBUG(fmt, args...) \
191 if (unlikely(drm_debug & DRM_UT_CORE)) \
192 drm_ut_debug_printk(__func__, fmt, ##args); \
195 #define DRM_DEBUG_DRIVER(fmt, args...) \
197 if (unlikely(drm_debug & DRM_UT_DRIVER)) \
198 drm_ut_debug_printk(__func__, fmt, ##args); \
200 #define DRM_DEBUG_KMS(fmt, args...) \
202 if (unlikely(drm_debug & DRM_UT_KMS)) \
203 drm_ut_debug_printk(__func__, fmt, ##args); \
205 #define DRM_DEBUG_PRIME(fmt, args...) \
207 if (unlikely(drm_debug & DRM_UT_PRIME)) \
208 drm_ut_debug_printk(__func__, fmt, ##args); \
213 /***********************************************************************/
214 /** \name Internal types and structures */
217 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
220 * Ioctl function type.
222 * \param inode device inode.
223 * \param file_priv DRM file private pointer.
224 * \param cmd command.
225 * \param arg argument.
227 typedef int drm_ioctl_t(struct drm_device
*dev
, void *data
,
228 struct drm_file
*file_priv
);
230 typedef int drm_ioctl_compat_t(struct file
*filp
, unsigned int cmd
,
233 #define DRM_IOCTL_NR(n) _IOC_NR(n)
234 #define DRM_MAJOR 226
237 #define DRM_MASTER 0x2
238 #define DRM_ROOT_ONLY 0x4
239 #define DRM_CONTROL_ALLOW 0x8
240 #define DRM_UNLOCKED 0x10
241 #define DRM_RENDER_ALLOW 0x20
243 struct drm_ioctl_desc
{
247 unsigned int cmd_drv
;
252 * Creates a driver or general drm_ioctl_desc array entry for the given
253 * ioctl, for use by drm_ioctl().
256 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags) \
257 [DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl, .name = #ioctl}
259 /* Event queued up for userspace to read */
260 struct drm_pending_event
{
261 struct drm_event
*event
;
262 struct list_head link
;
263 struct drm_file
*file_priv
;
264 pid_t pid
; /* pid of requester, no guarantee it's valid by the time
265 we deliver the event, for tracing only */
266 void (*destroy
)(struct drm_pending_event
*event
);
269 /* initial implementaton using a linked list - todo hashtab */
270 struct drm_prime_file_private
{
271 struct list_head head
;
275 /** File private data */
277 unsigned authenticated
:1;
278 /* Whether we're master for a minor. Protected by master_mutex */
279 unsigned is_master
:1;
280 /* true when the client has asked us to expose stereo 3D mode flags */
281 unsigned stereo_allowed
:1;
283 * true if client understands CRTC primary planes and cursor planes
286 unsigned universal_planes
:1;
287 /* true if client understands atomic properties */
293 struct list_head lhead
;
294 struct drm_minor
*minor
;
295 unsigned long lock_count
;
297 /** Mapping of mm object handles to object pointers. */
298 struct idr object_idr
;
299 /** Lock for synchronization of access to object_idr. */
300 spinlock_t table_lock
;
305 struct drm_master
*master
; /* master this node is currently associated with
306 N.B. not always minor->master */
308 * fbs - List of framebuffers associated with this file.
310 * Protected by fbs_lock. Note that the fbs list holds a reference on
311 * the fb object to prevent it from untimely disappearing.
313 struct list_head fbs
;
314 struct mutex fbs_lock
;
316 wait_queue_head_t event_wait
;
317 struct list_head event_list
;
320 struct drm_prime_file_private prime
;
326 struct drm_lock_data
{
327 struct drm_hw_lock
*hw_lock
; /**< Hardware lock */
328 /** Private of lock holder's file (NULL=kernel) */
329 struct drm_file
*file_priv
;
330 wait_queue_head_t lock_queue
; /**< Queue of blocked processes */
331 unsigned long lock_time
; /**< Time of last lock in jiffies */
333 uint32_t kernel_waiters
;
334 uint32_t user_waiters
;
339 * struct drm_master - drm master structure
341 * @refcount: Refcount for this master object.
342 * @minor: Link back to minor char device we are master for. Immutable.
343 * @unique: Unique identifier: e.g. busid. Protected by drm_global_mutex.
344 * @unique_len: Length of unique field. Protected by drm_global_mutex.
345 * @magiclist: Hash of used authentication tokens. Protected by struct_mutex.
346 * @magicfree: List of used authentication tokens. Protected by struct_mutex.
347 * @lock: DRI lock information.
348 * @driver_priv: Pointer to driver-private information.
351 struct kref refcount
;
352 struct drm_minor
*minor
;
355 struct drm_open_hash magiclist
;
356 struct list_head magicfree
;
357 struct drm_lock_data lock
;
361 /* Size of ringbuffer for vblank timestamps. Just double-buffer
362 * in initial implementation.
364 #define DRM_VBLANKTIME_RBSIZE 2
366 /* Flags and return codes for get_vblank_timestamp() driver function. */
367 #define DRM_CALLED_FROM_VBLIRQ 1
368 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
369 #define DRM_VBLANKTIME_IN_VBLANK (1 << 1)
371 /* get_scanout_position() return flags */
372 #define DRM_SCANOUTPOS_VALID (1 << 0)
373 #define DRM_SCANOUTPOS_IN_VBLANK (1 << 1)
374 #define DRM_SCANOUTPOS_ACCURATE (1 << 2)
377 * DRM driver structure. This structure represent the common code for
378 * a family of cards. There will one drm_device for each card present
382 int (*load
) (struct drm_device
*, unsigned long flags
);
383 int (*firstopen
) (struct drm_device
*);
384 int (*open
) (struct drm_device
*, struct drm_file
*);
385 void (*preclose
) (struct drm_device
*, struct drm_file
*file_priv
);
386 void (*postclose
) (struct drm_device
*, struct drm_file
*);
387 void (*lastclose
) (struct drm_device
*);
388 int (*unload
) (struct drm_device
*);
389 int (*suspend
) (struct drm_device
*, pm_message_t state
);
390 int (*resume
) (struct drm_device
*);
391 int (*dma_ioctl
) (struct drm_device
*dev
, void *data
, struct drm_file
*file_priv
);
392 int (*dma_quiescent
) (struct drm_device
*);
393 int (*context_dtor
) (struct drm_device
*dev
, int context
);
394 int (*set_busid
)(struct drm_device
*dev
, struct drm_master
*master
);
397 * get_vblank_counter - get raw hardware vblank counter
399 * @crtc: counter to fetch
401 * Driver callback for fetching a raw hardware vblank counter for @crtc.
402 * If a device doesn't have a hardware counter, the driver can simply
403 * return the value of drm_vblank_count. The DRM core will account for
404 * missed vblank events while interrupts where disabled based on system
407 * Wraparound handling and loss of events due to modesetting is dealt
408 * with in the DRM core code.
411 * Raw vblank counter value.
413 u32 (*get_vblank_counter
) (struct drm_device
*dev
, int crtc
);
416 * enable_vblank - enable vblank interrupt events
418 * @crtc: which irq to enable
420 * Enable vblank interrupts for @crtc. If the device doesn't have
421 * a hardware vblank counter, this routine should be a no-op, since
422 * interrupts will have to stay on to keep the count accurate.
425 * Zero on success, appropriate errno if the given @crtc's vblank
426 * interrupt cannot be enabled.
428 int (*enable_vblank
) (struct drm_device
*dev
, int crtc
);
431 * disable_vblank - disable vblank interrupt events
433 * @crtc: which irq to enable
435 * Disable vblank interrupts for @crtc. If the device doesn't have
436 * a hardware vblank counter, this routine should be a no-op, since
437 * interrupts will have to stay on to keep the count accurate.
439 void (*disable_vblank
) (struct drm_device
*dev
, int crtc
);
442 * Called by \c drm_device_is_agp. Typically used to determine if a
443 * card is really attached to AGP or not.
445 * \param dev DRM device handle
448 * One of three values is returned depending on whether or not the
449 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
450 * (return of 1), or may or may not be AGP (return of 2).
452 int (*device_is_agp
) (struct drm_device
*dev
);
455 * Called by vblank timestamping code.
457 * Return the current display scanout position from a crtc, and an
458 * optional accurate ktime_get timestamp of when position was measured.
460 * \param dev DRM device.
461 * \param crtc Id of the crtc to query.
462 * \param flags Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
463 * \param *vpos Target location for current vertical scanout position.
464 * \param *hpos Target location for current horizontal scanout position.
465 * \param *stime Target location for timestamp taken immediately before
466 * scanout position query. Can be NULL to skip timestamp.
467 * \param *etime Target location for timestamp taken immediately after
468 * scanout position query. Can be NULL to skip timestamp.
470 * Returns vpos as a positive number while in active scanout area.
471 * Returns vpos as a negative number inside vblank, counting the number
472 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
473 * until start of active scanout / end of vblank."
475 * \return Flags, or'ed together as follows:
477 * DRM_SCANOUTPOS_VALID = Query successful.
478 * DRM_SCANOUTPOS_INVBL = Inside vblank.
479 * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
480 * this flag means that returned position may be offset by a constant
481 * but unknown small number of scanlines wrt. real scanout position.
484 int (*get_scanout_position
) (struct drm_device
*dev
, int crtc
,
486 int *vpos
, int *hpos
, ktime_t
*stime
,
490 * Called by \c drm_get_last_vbltimestamp. Should return a precise
491 * timestamp when the most recent VBLANK interval ended or will end.
493 * Specifically, the timestamp in @vblank_time should correspond as
494 * closely as possible to the time when the first video scanline of
495 * the video frame after the end of VBLANK will start scanning out,
496 * the time immediately after end of the VBLANK interval. If the
497 * @crtc is currently inside VBLANK, this will be a time in the future.
498 * If the @crtc is currently scanning out a frame, this will be the
499 * past start time of the current scanout. This is meant to adhere
500 * to the OpenML OML_sync_control extension specification.
502 * \param dev dev DRM device handle.
503 * \param crtc crtc for which timestamp should be returned.
504 * \param *max_error Maximum allowable timestamp error in nanoseconds.
505 * Implementation should strive to provide timestamp
506 * with an error of at most *max_error nanoseconds.
507 * Returns true upper bound on error for timestamp.
508 * \param *vblank_time Target location for returned vblank timestamp.
509 * \param flags 0 = Defaults, no special treatment needed.
510 * \param DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
511 * irq handler. Some drivers need to apply some workarounds
512 * for gpu-specific vblank irq quirks if flag is set.
515 * Zero if timestamping isn't supported in current display mode or a
516 * negative number on failure. A positive status code on success,
517 * which describes how the vblank_time timestamp was computed.
519 int (*get_vblank_timestamp
) (struct drm_device
*dev
, int crtc
,
521 struct timeval
*vblank_time
,
524 /* these have to be filled in */
526 irqreturn_t(*irq_handler
) (int irq
, void *arg
);
527 void (*irq_preinstall
) (struct drm_device
*dev
);
528 int (*irq_postinstall
) (struct drm_device
*dev
);
529 void (*irq_uninstall
) (struct drm_device
*dev
);
531 /* Master routines */
532 int (*master_create
)(struct drm_device
*dev
, struct drm_master
*master
);
533 void (*master_destroy
)(struct drm_device
*dev
, struct drm_master
*master
);
535 * master_set is called whenever the minor master is set.
536 * master_drop is called whenever the minor master is dropped.
539 int (*master_set
)(struct drm_device
*dev
, struct drm_file
*file_priv
,
541 void (*master_drop
)(struct drm_device
*dev
, struct drm_file
*file_priv
,
544 int (*debugfs_init
)(struct drm_minor
*minor
);
545 void (*debugfs_cleanup
)(struct drm_minor
*minor
);
548 * Driver-specific constructor for drm_gem_objects, to set up
549 * obj->driver_private.
551 * Returns 0 on success.
553 void (*gem_free_object
) (struct drm_gem_object
*obj
);
554 int (*gem_open_object
) (struct drm_gem_object
*, struct drm_file
*);
555 void (*gem_close_object
) (struct drm_gem_object
*, struct drm_file
*);
558 /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
559 int (*prime_handle_to_fd
)(struct drm_device
*dev
, struct drm_file
*file_priv
,
560 uint32_t handle
, uint32_t flags
, int *prime_fd
);
561 /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
562 int (*prime_fd_to_handle
)(struct drm_device
*dev
, struct drm_file
*file_priv
,
563 int prime_fd
, uint32_t *handle
);
564 /* export GEM -> dmabuf */
565 struct dma_buf
* (*gem_prime_export
)(struct drm_device
*dev
,
566 struct drm_gem_object
*obj
, int flags
);
567 /* import dmabuf -> GEM */
568 struct drm_gem_object
* (*gem_prime_import
)(struct drm_device
*dev
,
569 struct dma_buf
*dma_buf
);
570 /* low-level interface used by drm_gem_prime_{import,export} */
571 int (*gem_prime_pin
)(struct drm_gem_object
*obj
);
572 void (*gem_prime_unpin
)(struct drm_gem_object
*obj
);
573 struct reservation_object
* (*gem_prime_res_obj
)(
574 struct drm_gem_object
*obj
);
575 struct sg_table
*(*gem_prime_get_sg_table
)(struct drm_gem_object
*obj
);
576 struct drm_gem_object
*(*gem_prime_import_sg_table
)(
577 struct drm_device
*dev
,
578 struct dma_buf_attachment
*attach
,
579 struct sg_table
*sgt
);
580 void *(*gem_prime_vmap
)(struct drm_gem_object
*obj
);
581 void (*gem_prime_vunmap
)(struct drm_gem_object
*obj
, void *vaddr
);
582 int (*gem_prime_mmap
)(struct drm_gem_object
*obj
,
583 struct vm_area_struct
*vma
);
585 /* vga arb irq handler */
586 void (*vgaarb_irq
)(struct drm_device
*dev
, bool state
);
588 /* dumb alloc support */
589 int (*dumb_create
)(struct drm_file
*file_priv
,
590 struct drm_device
*dev
,
591 struct drm_mode_create_dumb
*args
);
592 int (*dumb_map_offset
)(struct drm_file
*file_priv
,
593 struct drm_device
*dev
, uint32_t handle
,
595 int (*dumb_destroy
)(struct drm_file
*file_priv
,
596 struct drm_device
*dev
,
599 /* Driver private ops for this object */
600 const struct vm_operations_struct
*gem_vm_ops
;
611 const struct drm_ioctl_desc
*ioctls
;
613 const struct file_operations
*fops
;
615 /* List of devices hanging off this driver with stealth attach. */
616 struct list_head legacy_dev_list
;
619 enum drm_minor_type
{
627 * Info file list entry. This structure represents a debugfs or proc file to
628 * be created by the drm core
630 struct drm_info_list
{
631 const char *name
; /** file name */
632 int (*show
)(struct seq_file
*, void*); /** show callback */
633 u32 driver_features
; /**< Required driver features for this entry */
638 * debugfs node structure. This structure represents a debugfs file.
640 struct drm_info_node
{
641 struct list_head list
;
642 struct drm_minor
*minor
;
643 const struct drm_info_list
*info_ent
;
648 * DRM minor structure. This structure represents a drm minor number.
651 int index
; /**< Minor device number */
652 int type
; /**< Control or render */
653 struct device
*kdev
; /**< Linux device */
654 struct drm_device
*dev
;
656 struct dentry
*debugfs_root
;
658 struct list_head debugfs_list
;
659 struct mutex debugfs_lock
; /* Protects debugfs_list. */
661 /* currently active master for this node. Protected by master_mutex */
662 struct drm_master
*master
;
663 struct drm_mode_group mode_group
;
667 struct drm_pending_vblank_event
{
668 struct drm_pending_event base
;
670 struct drm_event_vblank event
;
673 struct drm_vblank_crtc
{
674 struct drm_device
*dev
; /* pointer to the drm_device */
675 wait_queue_head_t queue
; /**< VBLANK wait queue */
676 struct timeval time
[DRM_VBLANKTIME_RBSIZE
]; /**< timestamp of current count */
677 struct timer_list disable_timer
; /* delayed disable timer */
678 atomic_t count
; /**< number of VBLANK interrupts */
679 atomic_t refcount
; /* number of users of vblank interruptsper crtc */
680 u32 last
; /* protected by dev->vbl_lock, used */
681 /* for wraparound handling */
682 u32 last_wait
; /* Last vblank seqno waited per CRTC */
683 unsigned int inmodeset
; /* Display driver is setting mode */
684 int crtc
; /* crtc index */
685 bool enabled
; /* so we don't call enable more than
690 * DRM device structure. This structure represent a complete card that
691 * may contain multiple heads.
694 struct list_head legacy_dev_list
;/**< list of devices per driver for stealth attach cleanup */
695 int if_version
; /**< Highest interface version set */
697 /** \name Lifetime Management */
699 struct kref ref
; /**< Object ref-count */
700 struct device
*dev
; /**< Device structure of bus-device */
701 struct drm_driver
*driver
; /**< DRM driver managing the device */
702 void *dev_private
; /**< DRM driver private data */
703 struct drm_minor
*control
; /**< Control node */
704 struct drm_minor
*primary
; /**< Primary node */
705 struct drm_minor
*render
; /**< Render node */
706 atomic_t unplugged
; /**< Flag whether dev is dead */
707 struct inode
*anon_inode
; /**< inode for private address-space */
708 char *unique
; /**< unique name of the device */
713 struct mutex struct_mutex
; /**< For others */
714 struct mutex master_mutex
; /**< For drm_minor::master and drm_file::is_master */
717 /** \name Usage Counters */
719 int open_count
; /**< Outstanding files open, protected by drm_global_mutex. */
720 spinlock_t buf_lock
; /**< For drm_device::buf_use and a few other things. */
721 int buf_use
; /**< Buffers in use -- cannot alloc */
722 atomic_t buf_alloc
; /**< Buffer allocation in progress */
725 struct list_head filelist
;
727 /** \name Memory management */
729 struct list_head maplist
; /**< Linked list of regions */
730 struct drm_open_hash map_hash
; /**< User token hash table for maps */
732 /** \name Context handle management */
734 struct list_head ctxlist
; /**< Linked list of context handles */
735 struct mutex ctxlist_mutex
; /**< For ctxlist */
739 struct list_head vmalist
; /**< List of vmas (for debugging) */
743 /** \name DMA support */
745 struct drm_device_dma
*dma
; /**< Optional pointer for DMA support */
748 /** \name Context support */
751 __volatile__
long context_flag
; /**< Context swapping flag */
752 int last_context
; /**< Last current context */
755 /** \name VBLANK IRQ support */
761 * At load time, disabling the vblank interrupt won't be allowed since
762 * old clients may not call the modeset ioctl and therefore misbehave.
763 * Once the modeset ioctl *has* been called though, we can safely
764 * disable them when unused.
766 bool vblank_disable_allowed
;
769 * If true, vblank interrupt will be disabled immediately when the
770 * refcount drops to zero, as opposed to via the vblank disable
772 * This can be set to true it the hardware has a working vblank
773 * counter and the driver uses drm_vblank_on() and drm_vblank_off()
776 bool vblank_disable_immediate
;
778 /* array of size num_crtcs */
779 struct drm_vblank_crtc
*vblank
;
781 spinlock_t vblank_time_lock
; /**< Protects vblank count and time updates during vblank enable/disable */
784 u32 max_vblank_count
; /**< size of vblank counter register */
789 struct list_head vblank_event_list
;
790 spinlock_t event_lock
;
794 struct drm_agp_head
*agp
; /**< AGP data */
796 struct pci_dev
*pdev
; /**< PCI device structure */
798 struct pci_controller
*hose
;
801 struct platform_device
*platformdev
; /**< Platform device struture */
803 struct drm_sg_mem
*sg
; /**< Scatter gather memory */
804 unsigned int num_crtcs
; /**< Number of CRTCs on this device */
809 struct drm_hw_lock
*lock
;
812 struct drm_local_map
*agp_buffer_map
;
813 unsigned int agp_buffer_token
;
815 struct drm_mode_config mode_config
; /**< Current mode config */
817 /** \name GEM information */
819 struct mutex object_name_lock
;
820 struct idr object_name_idr
;
821 struct drm_vma_offset_manager
*vma_offset_manager
;
823 int switch_power_state
;
826 #define DRM_SWITCH_POWER_ON 0
827 #define DRM_SWITCH_POWER_OFF 1
828 #define DRM_SWITCH_POWER_CHANGING 2
829 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
831 static __inline__
int drm_core_check_feature(struct drm_device
*dev
,
834 return ((dev
->driver
->driver_features
& feature
) ? 1 : 0);
837 static inline void drm_device_set_unplugged(struct drm_device
*dev
)
840 atomic_set(&dev
->unplugged
, 1);
843 static inline int drm_device_is_unplugged(struct drm_device
*dev
)
845 int ret
= atomic_read(&dev
->unplugged
);
850 static inline bool drm_is_render_client(const struct drm_file
*file_priv
)
852 return file_priv
->minor
->type
== DRM_MINOR_RENDER
;
855 static inline bool drm_is_control_client(const struct drm_file
*file_priv
)
857 return file_priv
->minor
->type
== DRM_MINOR_CONTROL
;
860 static inline bool drm_is_primary_client(const struct drm_file
*file_priv
)
862 return file_priv
->minor
->type
== DRM_MINOR_LEGACY
;
865 /******************************************************************/
866 /** \name Internal function definitions */
869 /* Driver support (drm_drv.h) */
870 extern long drm_ioctl(struct file
*filp
,
871 unsigned int cmd
, unsigned long arg
);
872 extern long drm_compat_ioctl(struct file
*filp
,
873 unsigned int cmd
, unsigned long arg
);
874 extern bool drm_ioctl_flags(unsigned int nr
, unsigned int *flags
);
876 /* Device support (drm_fops.h) */
877 extern int drm_open(struct inode
*inode
, struct file
*filp
);
878 extern ssize_t
drm_read(struct file
*filp
, char __user
*buffer
,
879 size_t count
, loff_t
*offset
);
880 extern int drm_release(struct inode
*inode
, struct file
*filp
);
882 /* Mapping support (drm_vm.h) */
883 extern unsigned int drm_poll(struct file
*filp
, struct poll_table_struct
*wait
);
885 /* Misc. IOCTL support (drm_ioctl.c) */
886 int drm_noop(struct drm_device
*dev
, void *data
,
887 struct drm_file
*file_priv
);
889 /* Cache management (drm_cache.c) */
890 void drm_clflush_pages(struct page
*pages
[], unsigned long num_pages
);
891 void drm_clflush_sg(struct sg_table
*st
);
892 void drm_clflush_virt_range(void *addr
, unsigned long length
);
895 * These are exported to drivers so that they can implement fencing using
896 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
899 /* IRQ support (drm_irq.h) */
900 extern int drm_irq_install(struct drm_device
*dev
, int irq
);
901 extern int drm_irq_uninstall(struct drm_device
*dev
);
903 extern int drm_vblank_init(struct drm_device
*dev
, int num_crtcs
);
904 extern int drm_wait_vblank(struct drm_device
*dev
, void *data
,
905 struct drm_file
*filp
);
906 extern u32
drm_vblank_count(struct drm_device
*dev
, int crtc
);
907 extern u32
drm_crtc_vblank_count(struct drm_crtc
*crtc
);
908 extern u32
drm_vblank_count_and_time(struct drm_device
*dev
, int crtc
,
909 struct timeval
*vblanktime
);
910 extern void drm_send_vblank_event(struct drm_device
*dev
, int crtc
,
911 struct drm_pending_vblank_event
*e
);
912 extern void drm_crtc_send_vblank_event(struct drm_crtc
*crtc
,
913 struct drm_pending_vblank_event
*e
);
914 extern bool drm_handle_vblank(struct drm_device
*dev
, int crtc
);
915 extern bool drm_crtc_handle_vblank(struct drm_crtc
*crtc
);
916 extern int drm_vblank_get(struct drm_device
*dev
, int crtc
);
917 extern void drm_vblank_put(struct drm_device
*dev
, int crtc
);
918 extern int drm_crtc_vblank_get(struct drm_crtc
*crtc
);
919 extern void drm_crtc_vblank_put(struct drm_crtc
*crtc
);
920 extern void drm_wait_one_vblank(struct drm_device
*dev
, int crtc
);
921 extern void drm_crtc_wait_one_vblank(struct drm_crtc
*crtc
);
922 extern void drm_vblank_off(struct drm_device
*dev
, int crtc
);
923 extern void drm_vblank_on(struct drm_device
*dev
, int crtc
);
924 extern void drm_crtc_vblank_off(struct drm_crtc
*crtc
);
925 extern void drm_crtc_vblank_on(struct drm_crtc
*crtc
);
926 extern void drm_vblank_cleanup(struct drm_device
*dev
);
928 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device
*dev
,
929 int crtc
, int *max_error
,
930 struct timeval
*vblank_time
,
932 const struct drm_crtc
*refcrtc
,
933 const struct drm_display_mode
*mode
);
934 extern void drm_calc_timestamping_constants(struct drm_crtc
*crtc
,
935 const struct drm_display_mode
*mode
);
938 * drm_crtc_vblank_waitqueue - get vblank waitqueue for the CRTC
939 * @crtc: which CRTC's vblank waitqueue to retrieve
941 * This function returns a pointer to the vblank waitqueue for the CRTC.
942 * Drivers can use this to implement vblank waits using wait_event() & co.
944 static inline wait_queue_head_t
*drm_crtc_vblank_waitqueue(struct drm_crtc
*crtc
)
946 return &crtc
->dev
->vblank
[drm_crtc_index(crtc
)].queue
;
949 /* Modesetting support */
950 extern void drm_vblank_pre_modeset(struct drm_device
*dev
, int crtc
);
951 extern void drm_vblank_post_modeset(struct drm_device
*dev
, int crtc
);
953 /* Stub support (drm_stub.h) */
954 extern struct drm_master
*drm_master_get(struct drm_master
*master
);
955 extern void drm_master_put(struct drm_master
**master
);
957 extern void drm_put_dev(struct drm_device
*dev
);
958 extern void drm_unplug_dev(struct drm_device
*dev
);
959 extern unsigned int drm_debug
;
960 extern bool drm_atomic
;
962 /* Debugfs support */
963 #if defined(CONFIG_DEBUG_FS)
964 extern int drm_debugfs_create_files(const struct drm_info_list
*files
,
965 int count
, struct dentry
*root
,
966 struct drm_minor
*minor
);
967 extern int drm_debugfs_remove_files(const struct drm_info_list
*files
,
968 int count
, struct drm_minor
*minor
);
970 static inline int drm_debugfs_create_files(const struct drm_info_list
*files
,
971 int count
, struct dentry
*root
,
972 struct drm_minor
*minor
)
977 static inline int drm_debugfs_remove_files(const struct drm_info_list
*files
,
978 int count
, struct drm_minor
*minor
)
984 extern struct dma_buf
*drm_gem_prime_export(struct drm_device
*dev
,
985 struct drm_gem_object
*obj
, int flags
);
986 extern int drm_gem_prime_handle_to_fd(struct drm_device
*dev
,
987 struct drm_file
*file_priv
, uint32_t handle
, uint32_t flags
,
989 extern struct drm_gem_object
*drm_gem_prime_import(struct drm_device
*dev
,
990 struct dma_buf
*dma_buf
);
991 extern int drm_gem_prime_fd_to_handle(struct drm_device
*dev
,
992 struct drm_file
*file_priv
, int prime_fd
, uint32_t *handle
);
993 extern void drm_gem_dmabuf_release(struct dma_buf
*dma_buf
);
995 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table
*sgt
, struct page
**pages
,
996 dma_addr_t
*addrs
, int max_pages
);
997 extern struct sg_table
*drm_prime_pages_to_sg(struct page
**pages
, unsigned int nr_pages
);
998 extern void drm_prime_gem_destroy(struct drm_gem_object
*obj
, struct sg_table
*sg
);
1001 extern struct drm_dma_handle
*drm_pci_alloc(struct drm_device
*dev
, size_t size
,
1003 extern void drm_pci_free(struct drm_device
*dev
, struct drm_dma_handle
* dmah
);
1005 /* sysfs support (drm_sysfs.c) */
1006 extern void drm_sysfs_hotplug_event(struct drm_device
*dev
);
1009 struct drm_device
*drm_dev_alloc(struct drm_driver
*driver
,
1010 struct device
*parent
);
1011 void drm_dev_ref(struct drm_device
*dev
);
1012 void drm_dev_unref(struct drm_device
*dev
);
1013 int drm_dev_register(struct drm_device
*dev
, unsigned long flags
);
1014 void drm_dev_unregister(struct drm_device
*dev
);
1015 int drm_dev_set_unique(struct drm_device
*dev
, const char *fmt
, ...);
1017 struct drm_minor
*drm_minor_acquire(unsigned int minor_id
);
1018 void drm_minor_release(struct drm_minor
*minor
);
1023 static __inline__
int drm_pci_device_is_agp(struct drm_device
*dev
)
1025 if (dev
->driver
->device_is_agp
!= NULL
) {
1026 int err
= (*dev
->driver
->device_is_agp
) (dev
);
1033 return pci_find_capability(dev
->pdev
, PCI_CAP_ID_AGP
);
1035 void drm_pci_agp_destroy(struct drm_device
*dev
);
1037 extern int drm_pci_init(struct drm_driver
*driver
, struct pci_driver
*pdriver
);
1038 extern void drm_pci_exit(struct drm_driver
*driver
, struct pci_driver
*pdriver
);
1040 extern int drm_get_pci_dev(struct pci_dev
*pdev
,
1041 const struct pci_device_id
*ent
,
1042 struct drm_driver
*driver
);
1043 extern int drm_pci_set_busid(struct drm_device
*dev
, struct drm_master
*master
);
1045 static inline int drm_get_pci_dev(struct pci_dev
*pdev
,
1046 const struct pci_device_id
*ent
,
1047 struct drm_driver
*driver
)
1052 static inline int drm_pci_set_busid(struct drm_device
*dev
,
1053 struct drm_master
*master
)
1059 #define DRM_PCIE_SPEED_25 1
1060 #define DRM_PCIE_SPEED_50 2
1061 #define DRM_PCIE_SPEED_80 4
1063 extern int drm_pcie_get_speed_cap_mask(struct drm_device
*dev
, u32
*speed_mask
);
1065 /* platform section */
1066 extern int drm_platform_init(struct drm_driver
*driver
, struct platform_device
*platform_device
);
1067 extern int drm_platform_set_busid(struct drm_device
*d
, struct drm_master
*m
);
1069 /* returns true if currently okay to sleep */
1070 static __inline__
bool drm_can_sleep(void)
1072 if (in_atomic() || in_dbg_master() || irqs_disabled())