2 * Internal Header for the Direct Rendering Manager
4 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
5 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
6 * Copyright (c) 2009-2010, Code Aurora Forum.
9 * Author: Rickard E. (Rik) Faith <faith@valinux.com>
10 * Author: Gareth Hughes <gareth@valinux.com>
12 * Permission is hereby granted, free of charge, to any person obtaining a
13 * copy of this software and associated documentation files (the "Software"),
14 * to deal in the Software without restriction, including without limitation
15 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16 * and/or sell copies of the Software, and to permit persons to whom the
17 * Software is furnished to do so, subject to the following conditions:
19 * The above copyright notice and this permission notice (including the next
20 * paragraph) shall be included in all copies or substantial portions of the
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
27 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
28 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
29 * OTHER DEALINGS IN THE SOFTWARE.
35 #include <linux/agp_backend.h>
36 #include <linux/cdev.h>
37 #include <linux/dma-mapping.h>
38 #include <linux/file.h>
40 #include <linux/highmem.h>
41 #include <linux/idr.h>
42 #include <linux/init.h>
44 #include <linux/jiffies.h>
45 #include <linux/kernel.h>
46 #include <linux/kref.h>
47 #include <linux/miscdevice.h>
49 #include <linux/mutex.h>
50 #include <linux/pci.h>
51 #include <linux/platform_device.h>
52 #include <linux/poll.h>
53 #include <linux/ratelimit.h>
54 #include <linux/sched.h>
55 #include <linux/slab.h>
56 #include <linux/types.h>
57 #include <linux/vmalloc.h>
58 #include <linux/workqueue.h>
61 #include <asm/pgalloc.h>
62 #include <asm/uaccess.h>
64 #include <uapi/drm/drm.h>
65 #include <uapi/drm/drm_mode.h>
67 #include <drm/drm_agpsupport.h>
68 #include <drm/drm_crtc.h>
69 #include <drm/drm_global.h>
70 #include <drm/drm_hashtab.h>
71 #include <drm/drm_mem_util.h>
72 #include <drm/drm_mm.h>
73 #include <drm/drm_os_linux.h>
74 #include <drm/drm_sarea.h>
75 #include <drm/drm_vma_manager.h>
83 struct drm_device_dma
;
84 struct drm_dma_handle
;
85 struct drm_gem_object
;
89 struct reservation_object
;
90 struct dma_buf_attachment
;
93 * 4 debug categories are defined:
95 * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
96 * This is the category used by the DRM_DEBUG() macro.
98 * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
99 * This is the category used by the DRM_DEBUG_DRIVER() macro.
101 * KMS: used in the modesetting code.
102 * This is the category used by the DRM_DEBUG_KMS() macro.
104 * PRIME: used in the prime code.
105 * This is the category used by the DRM_DEBUG_PRIME() macro.
107 * ATOMIC: used in the atomic code.
108 * This is the category used by the DRM_DEBUG_ATOMIC() macro.
110 * Enabling verbose debug messages is done through the drm.debug parameter,
111 * each category being enabled by a bit.
113 * drm.debug=0x1 will enable CORE messages
114 * drm.debug=0x2 will enable DRIVER messages
115 * drm.debug=0x3 will enable CORE and DRIVER messages
117 * drm.debug=0xf will enable all messages
119 * An interesting feature is that it's possible to enable verbose logging at
120 * run-time by echoing the debug value in its sysfs node:
121 * # echo 0xf > /sys/module/drm/parameters/debug
123 #define DRM_UT_CORE 0x01
124 #define DRM_UT_DRIVER 0x02
125 #define DRM_UT_KMS 0x04
126 #define DRM_UT_PRIME 0x08
127 #define DRM_UT_ATOMIC 0x10
129 extern __printf(2, 3)
130 void drm_ut_debug_printk(const char *function_name
,
131 const char *format
, ...);
132 extern __printf(1, 2)
133 void drm_err(const char *format
, ...);
135 /***********************************************************************/
136 /** \name DRM template customization defaults */
139 /* driver capabilities and requirements mask */
140 #define DRIVER_USE_AGP 0x1
141 #define DRIVER_PCI_DMA 0x8
142 #define DRIVER_SG 0x10
143 #define DRIVER_HAVE_DMA 0x20
144 #define DRIVER_HAVE_IRQ 0x40
145 #define DRIVER_IRQ_SHARED 0x80
146 #define DRIVER_GEM 0x1000
147 #define DRIVER_MODESET 0x2000
148 #define DRIVER_PRIME 0x4000
149 #define DRIVER_RENDER 0x8000
150 #define DRIVER_ATOMIC 0x10000
151 #define DRIVER_KMS_LEGACY_CONTEXT 0x20000
153 /***********************************************************************/
154 /** \name Macros to make printk easier */
160 * \param fmt printf() like format string.
161 * \param arg arguments
163 #define DRM_ERROR(fmt, ...) \
164 drm_err(fmt, ##__VA_ARGS__)
167 * Rate limited error output. Like DRM_ERROR() but won't flood the log.
169 * \param fmt printf() like format string.
170 * \param arg arguments
172 #define DRM_ERROR_RATELIMITED(fmt, ...) \
174 static DEFINE_RATELIMIT_STATE(_rs, \
175 DEFAULT_RATELIMIT_INTERVAL, \
176 DEFAULT_RATELIMIT_BURST); \
178 if (__ratelimit(&_rs)) \
179 drm_err(fmt, ##__VA_ARGS__); \
182 #define DRM_INFO(fmt, ...) \
183 printk(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
185 #define DRM_INFO_ONCE(fmt, ...) \
186 printk_once(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
191 * \param fmt printf() like format string.
192 * \param arg arguments
194 #define DRM_DEBUG(fmt, args...) \
196 if (unlikely(drm_debug & DRM_UT_CORE)) \
197 drm_ut_debug_printk(__func__, fmt, ##args); \
200 #define DRM_DEBUG_DRIVER(fmt, args...) \
202 if (unlikely(drm_debug & DRM_UT_DRIVER)) \
203 drm_ut_debug_printk(__func__, fmt, ##args); \
205 #define DRM_DEBUG_KMS(fmt, args...) \
207 if (unlikely(drm_debug & DRM_UT_KMS)) \
208 drm_ut_debug_printk(__func__, fmt, ##args); \
210 #define DRM_DEBUG_PRIME(fmt, args...) \
212 if (unlikely(drm_debug & DRM_UT_PRIME)) \
213 drm_ut_debug_printk(__func__, fmt, ##args); \
215 #define DRM_DEBUG_ATOMIC(fmt, args...) \
217 if (unlikely(drm_debug & DRM_UT_ATOMIC)) \
218 drm_ut_debug_printk(__func__, fmt, ##args); \
223 /***********************************************************************/
224 /** \name Internal types and structures */
227 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
230 * Ioctl function type.
232 * \param inode device inode.
233 * \param file_priv DRM file private pointer.
234 * \param cmd command.
235 * \param arg argument.
237 typedef int drm_ioctl_t(struct drm_device
*dev
, void *data
,
238 struct drm_file
*file_priv
);
240 typedef int drm_ioctl_compat_t(struct file
*filp
, unsigned int cmd
,
243 #define DRM_IOCTL_NR(n) _IOC_NR(n)
244 #define DRM_MAJOR 226
247 #define DRM_MASTER 0x2
248 #define DRM_ROOT_ONLY 0x4
249 #define DRM_CONTROL_ALLOW 0x8
250 #define DRM_UNLOCKED 0x10
251 #define DRM_RENDER_ALLOW 0x20
253 struct drm_ioctl_desc
{
261 * Creates a driver or general drm_ioctl_desc array entry for the given
262 * ioctl, for use by drm_ioctl().
265 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags) \
266 [DRM_IOCTL_NR(DRM_IOCTL_##ioctl) - DRM_COMMAND_BASE] = { \
267 .cmd = DRM_IOCTL_##ioctl, \
273 /* Event queued up for userspace to read */
274 struct drm_pending_event
{
275 struct drm_event
*event
;
276 struct list_head link
;
277 struct drm_file
*file_priv
;
278 pid_t pid
; /* pid of requester, no guarantee it's valid by the time
279 we deliver the event, for tracing only */
280 void (*destroy
)(struct drm_pending_event
*event
);
283 /* initial implementaton using a linked list - todo hashtab */
284 struct drm_prime_file_private
{
285 struct list_head head
;
289 /** File private data */
291 unsigned authenticated
:1;
292 /* Whether we're master for a minor. Protected by master_mutex */
293 unsigned is_master
:1;
294 /* true when the client has asked us to expose stereo 3D mode flags */
295 unsigned stereo_allowed
:1;
297 * true if client understands CRTC primary planes and cursor planes
300 unsigned universal_planes
:1;
301 /* true if client understands atomic properties */
307 struct list_head lhead
;
308 struct drm_minor
*minor
;
309 unsigned long lock_count
;
311 /** Mapping of mm object handles to object pointers. */
312 struct idr object_idr
;
313 /** Lock for synchronization of access to object_idr. */
314 spinlock_t table_lock
;
319 struct drm_master
*master
; /* master this node is currently associated with
320 N.B. not always minor->master */
322 * fbs - List of framebuffers associated with this file.
324 * Protected by fbs_lock. Note that the fbs list holds a reference on
325 * the fb object to prevent it from untimely disappearing.
327 struct list_head fbs
;
328 struct mutex fbs_lock
;
330 /** User-created blob properties; this retains a reference on the
332 struct list_head blobs
;
334 wait_queue_head_t event_wait
;
335 struct list_head event_list
;
338 struct drm_prime_file_private prime
;
344 struct drm_lock_data
{
345 struct drm_hw_lock
*hw_lock
; /**< Hardware lock */
346 /** Private of lock holder's file (NULL=kernel) */
347 struct drm_file
*file_priv
;
348 wait_queue_head_t lock_queue
; /**< Queue of blocked processes */
349 unsigned long lock_time
; /**< Time of last lock in jiffies */
351 uint32_t kernel_waiters
;
352 uint32_t user_waiters
;
357 * struct drm_master - drm master structure
359 * @refcount: Refcount for this master object.
360 * @minor: Link back to minor char device we are master for. Immutable.
361 * @unique: Unique identifier: e.g. busid. Protected by drm_global_mutex.
362 * @unique_len: Length of unique field. Protected by drm_global_mutex.
363 * @magic_map: Map of used authentication tokens. Protected by struct_mutex.
364 * @lock: DRI lock information.
365 * @driver_priv: Pointer to driver-private information.
368 struct kref refcount
;
369 struct drm_minor
*minor
;
372 struct idr magic_map
;
373 struct drm_lock_data lock
;
377 /* Size of ringbuffer for vblank timestamps. Just double-buffer
378 * in initial implementation.
380 #define DRM_VBLANKTIME_RBSIZE 2
382 /* Flags and return codes for get_vblank_timestamp() driver function. */
383 #define DRM_CALLED_FROM_VBLIRQ 1
384 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
385 #define DRM_VBLANKTIME_IN_VBLANK (1 << 1)
387 /* get_scanout_position() return flags */
388 #define DRM_SCANOUTPOS_VALID (1 << 0)
389 #define DRM_SCANOUTPOS_IN_VBLANK (1 << 1)
390 #define DRM_SCANOUTPOS_ACCURATE (1 << 2)
393 * DRM driver structure. This structure represent the common code for
394 * a family of cards. There will one drm_device for each card present
398 int (*load
) (struct drm_device
*, unsigned long flags
);
399 int (*firstopen
) (struct drm_device
*);
400 int (*open
) (struct drm_device
*, struct drm_file
*);
401 void (*preclose
) (struct drm_device
*, struct drm_file
*file_priv
);
402 void (*postclose
) (struct drm_device
*, struct drm_file
*);
403 void (*lastclose
) (struct drm_device
*);
404 int (*unload
) (struct drm_device
*);
405 int (*suspend
) (struct drm_device
*, pm_message_t state
);
406 int (*resume
) (struct drm_device
*);
407 int (*dma_ioctl
) (struct drm_device
*dev
, void *data
, struct drm_file
*file_priv
);
408 int (*dma_quiescent
) (struct drm_device
*);
409 int (*context_dtor
) (struct drm_device
*dev
, int context
);
410 int (*set_busid
)(struct drm_device
*dev
, struct drm_master
*master
);
413 * get_vblank_counter - get raw hardware vblank counter
415 * @crtc: counter to fetch
417 * Driver callback for fetching a raw hardware vblank counter for @crtc.
418 * If a device doesn't have a hardware counter, the driver can simply
419 * return the value of drm_vblank_count. The DRM core will account for
420 * missed vblank events while interrupts where disabled based on system
423 * Wraparound handling and loss of events due to modesetting is dealt
424 * with in the DRM core code.
427 * Raw vblank counter value.
429 u32 (*get_vblank_counter
) (struct drm_device
*dev
, int crtc
);
432 * enable_vblank - enable vblank interrupt events
434 * @crtc: which irq to enable
436 * Enable vblank interrupts for @crtc. If the device doesn't have
437 * a hardware vblank counter, this routine should be a no-op, since
438 * interrupts will have to stay on to keep the count accurate.
441 * Zero on success, appropriate errno if the given @crtc's vblank
442 * interrupt cannot be enabled.
444 int (*enable_vblank
) (struct drm_device
*dev
, int crtc
);
447 * disable_vblank - disable vblank interrupt events
449 * @crtc: which irq to enable
451 * Disable vblank interrupts for @crtc. If the device doesn't have
452 * a hardware vblank counter, this routine should be a no-op, since
453 * interrupts will have to stay on to keep the count accurate.
455 void (*disable_vblank
) (struct drm_device
*dev
, int crtc
);
458 * Called by \c drm_device_is_agp. Typically used to determine if a
459 * card is really attached to AGP or not.
461 * \param dev DRM device handle
464 * One of three values is returned depending on whether or not the
465 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
466 * (return of 1), or may or may not be AGP (return of 2).
468 int (*device_is_agp
) (struct drm_device
*dev
);
471 * Called by vblank timestamping code.
473 * Return the current display scanout position from a crtc, and an
474 * optional accurate ktime_get timestamp of when position was measured.
476 * \param dev DRM device.
477 * \param crtc Id of the crtc to query.
478 * \param flags Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
479 * \param *vpos Target location for current vertical scanout position.
480 * \param *hpos Target location for current horizontal scanout position.
481 * \param *stime Target location for timestamp taken immediately before
482 * scanout position query. Can be NULL to skip timestamp.
483 * \param *etime Target location for timestamp taken immediately after
484 * scanout position query. Can be NULL to skip timestamp.
486 * Returns vpos as a positive number while in active scanout area.
487 * Returns vpos as a negative number inside vblank, counting the number
488 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
489 * until start of active scanout / end of vblank."
491 * \return Flags, or'ed together as follows:
493 * DRM_SCANOUTPOS_VALID = Query successful.
494 * DRM_SCANOUTPOS_INVBL = Inside vblank.
495 * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
496 * this flag means that returned position may be offset by a constant
497 * but unknown small number of scanlines wrt. real scanout position.
500 int (*get_scanout_position
) (struct drm_device
*dev
, int crtc
,
502 int *vpos
, int *hpos
, ktime_t
*stime
,
506 * Called by \c drm_get_last_vbltimestamp. Should return a precise
507 * timestamp when the most recent VBLANK interval ended or will end.
509 * Specifically, the timestamp in @vblank_time should correspond as
510 * closely as possible to the time when the first video scanline of
511 * the video frame after the end of VBLANK will start scanning out,
512 * the time immediately after end of the VBLANK interval. If the
513 * @crtc is currently inside VBLANK, this will be a time in the future.
514 * If the @crtc is currently scanning out a frame, this will be the
515 * past start time of the current scanout. This is meant to adhere
516 * to the OpenML OML_sync_control extension specification.
518 * \param dev dev DRM device handle.
519 * \param crtc crtc for which timestamp should be returned.
520 * \param *max_error Maximum allowable timestamp error in nanoseconds.
521 * Implementation should strive to provide timestamp
522 * with an error of at most *max_error nanoseconds.
523 * Returns true upper bound on error for timestamp.
524 * \param *vblank_time Target location for returned vblank timestamp.
525 * \param flags 0 = Defaults, no special treatment needed.
526 * \param DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
527 * irq handler. Some drivers need to apply some workarounds
528 * for gpu-specific vblank irq quirks if flag is set.
531 * Zero if timestamping isn't supported in current display mode or a
532 * negative number on failure. A positive status code on success,
533 * which describes how the vblank_time timestamp was computed.
535 int (*get_vblank_timestamp
) (struct drm_device
*dev
, int crtc
,
537 struct timeval
*vblank_time
,
540 /* these have to be filled in */
542 irqreturn_t(*irq_handler
) (int irq
, void *arg
);
543 void (*irq_preinstall
) (struct drm_device
*dev
);
544 int (*irq_postinstall
) (struct drm_device
*dev
);
545 void (*irq_uninstall
) (struct drm_device
*dev
);
547 /* Master routines */
548 int (*master_create
)(struct drm_device
*dev
, struct drm_master
*master
);
549 void (*master_destroy
)(struct drm_device
*dev
, struct drm_master
*master
);
551 * master_set is called whenever the minor master is set.
552 * master_drop is called whenever the minor master is dropped.
555 int (*master_set
)(struct drm_device
*dev
, struct drm_file
*file_priv
,
557 void (*master_drop
)(struct drm_device
*dev
, struct drm_file
*file_priv
,
560 int (*debugfs_init
)(struct drm_minor
*minor
);
561 void (*debugfs_cleanup
)(struct drm_minor
*minor
);
564 * Driver-specific constructor for drm_gem_objects, to set up
565 * obj->driver_private.
567 * Returns 0 on success.
569 void (*gem_free_object
) (struct drm_gem_object
*obj
);
570 int (*gem_open_object
) (struct drm_gem_object
*, struct drm_file
*);
571 void (*gem_close_object
) (struct drm_gem_object
*, struct drm_file
*);
574 /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
575 int (*prime_handle_to_fd
)(struct drm_device
*dev
, struct drm_file
*file_priv
,
576 uint32_t handle
, uint32_t flags
, int *prime_fd
);
577 /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
578 int (*prime_fd_to_handle
)(struct drm_device
*dev
, struct drm_file
*file_priv
,
579 int prime_fd
, uint32_t *handle
);
580 /* export GEM -> dmabuf */
581 struct dma_buf
* (*gem_prime_export
)(struct drm_device
*dev
,
582 struct drm_gem_object
*obj
, int flags
);
583 /* import dmabuf -> GEM */
584 struct drm_gem_object
* (*gem_prime_import
)(struct drm_device
*dev
,
585 struct dma_buf
*dma_buf
);
586 /* low-level interface used by drm_gem_prime_{import,export} */
587 int (*gem_prime_pin
)(struct drm_gem_object
*obj
);
588 void (*gem_prime_unpin
)(struct drm_gem_object
*obj
);
589 struct reservation_object
* (*gem_prime_res_obj
)(
590 struct drm_gem_object
*obj
);
591 struct sg_table
*(*gem_prime_get_sg_table
)(struct drm_gem_object
*obj
);
592 struct drm_gem_object
*(*gem_prime_import_sg_table
)(
593 struct drm_device
*dev
,
594 struct dma_buf_attachment
*attach
,
595 struct sg_table
*sgt
);
596 void *(*gem_prime_vmap
)(struct drm_gem_object
*obj
);
597 void (*gem_prime_vunmap
)(struct drm_gem_object
*obj
, void *vaddr
);
598 int (*gem_prime_mmap
)(struct drm_gem_object
*obj
,
599 struct vm_area_struct
*vma
);
601 /* vga arb irq handler */
602 void (*vgaarb_irq
)(struct drm_device
*dev
, bool state
);
604 /* dumb alloc support */
605 int (*dumb_create
)(struct drm_file
*file_priv
,
606 struct drm_device
*dev
,
607 struct drm_mode_create_dumb
*args
);
608 int (*dumb_map_offset
)(struct drm_file
*file_priv
,
609 struct drm_device
*dev
, uint32_t handle
,
611 int (*dumb_destroy
)(struct drm_file
*file_priv
,
612 struct drm_device
*dev
,
615 /* Driver private ops for this object */
616 const struct vm_operations_struct
*gem_vm_ops
;
627 const struct drm_ioctl_desc
*ioctls
;
629 const struct file_operations
*fops
;
631 /* List of devices hanging off this driver with stealth attach. */
632 struct list_head legacy_dev_list
;
635 enum drm_minor_type
{
643 * Info file list entry. This structure represents a debugfs or proc file to
644 * be created by the drm core
646 struct drm_info_list
{
647 const char *name
; /** file name */
648 int (*show
)(struct seq_file
*, void*); /** show callback */
649 u32 driver_features
; /**< Required driver features for this entry */
654 * debugfs node structure. This structure represents a debugfs file.
656 struct drm_info_node
{
657 struct list_head list
;
658 struct drm_minor
*minor
;
659 const struct drm_info_list
*info_ent
;
664 * DRM minor structure. This structure represents a drm minor number.
667 int index
; /**< Minor device number */
668 int type
; /**< Control or render */
669 struct device
*kdev
; /**< Linux device */
670 struct drm_device
*dev
;
672 struct dentry
*debugfs_root
;
674 struct list_head debugfs_list
;
675 struct mutex debugfs_lock
; /* Protects debugfs_list. */
677 /* currently active master for this node. Protected by master_mutex */
678 struct drm_master
*master
;
682 struct drm_pending_vblank_event
{
683 struct drm_pending_event base
;
685 struct drm_event_vblank event
;
688 struct drm_vblank_crtc
{
689 struct drm_device
*dev
; /* pointer to the drm_device */
690 wait_queue_head_t queue
; /**< VBLANK wait queue */
691 struct timer_list disable_timer
; /* delayed disable timer */
693 /* vblank counter, protected by dev->vblank_time_lock for writes */
695 /* vblank timestamps, protected by dev->vblank_time_lock for writes */
696 struct timeval time
[DRM_VBLANKTIME_RBSIZE
];
698 atomic_t refcount
; /* number of users of vblank interruptsper crtc */
699 u32 last
; /* protected by dev->vbl_lock, used */
700 /* for wraparound handling */
701 u32 last_wait
; /* Last vblank seqno waited per CRTC */
702 unsigned int inmodeset
; /* Display driver is setting mode */
703 unsigned int pipe
; /* crtc index */
704 bool enabled
; /* so we don't call enable more than
709 * DRM device structure. This structure represent a complete card that
710 * may contain multiple heads.
713 struct list_head legacy_dev_list
;/**< list of devices per driver for stealth attach cleanup */
714 int if_version
; /**< Highest interface version set */
716 /** \name Lifetime Management */
718 struct kref ref
; /**< Object ref-count */
719 struct device
*dev
; /**< Device structure of bus-device */
720 struct drm_driver
*driver
; /**< DRM driver managing the device */
721 void *dev_private
; /**< DRM driver private data */
722 struct drm_minor
*control
; /**< Control node */
723 struct drm_minor
*primary
; /**< Primary node */
724 struct drm_minor
*render
; /**< Render node */
725 atomic_t unplugged
; /**< Flag whether dev is dead */
726 struct inode
*anon_inode
; /**< inode for private address-space */
727 char *unique
; /**< unique name of the device */
732 struct mutex struct_mutex
; /**< For others */
733 struct mutex master_mutex
; /**< For drm_minor::master and drm_file::is_master */
736 /** \name Usage Counters */
738 int open_count
; /**< Outstanding files open, protected by drm_global_mutex. */
739 spinlock_t buf_lock
; /**< For drm_device::buf_use and a few other things. */
740 int buf_use
; /**< Buffers in use -- cannot alloc */
741 atomic_t buf_alloc
; /**< Buffer allocation in progress */
744 struct list_head filelist
;
746 /** \name Memory management */
748 struct list_head maplist
; /**< Linked list of regions */
749 struct drm_open_hash map_hash
; /**< User token hash table for maps */
751 /** \name Context handle management */
753 struct list_head ctxlist
; /**< Linked list of context handles */
754 struct mutex ctxlist_mutex
; /**< For ctxlist */
758 struct list_head vmalist
; /**< List of vmas (for debugging) */
762 /** \name DMA support */
764 struct drm_device_dma
*dma
; /**< Optional pointer for DMA support */
767 /** \name Context support */
770 __volatile__
long context_flag
; /**< Context swapping flag */
771 int last_context
; /**< Last current context */
774 /** \name VBLANK IRQ support */
780 * At load time, disabling the vblank interrupt won't be allowed since
781 * old clients may not call the modeset ioctl and therefore misbehave.
782 * Once the modeset ioctl *has* been called though, we can safely
783 * disable them when unused.
785 bool vblank_disable_allowed
;
788 * If true, vblank interrupt will be disabled immediately when the
789 * refcount drops to zero, as opposed to via the vblank disable
791 * This can be set to true it the hardware has a working vblank
792 * counter and the driver uses drm_vblank_on() and drm_vblank_off()
795 bool vblank_disable_immediate
;
797 /* array of size num_crtcs */
798 struct drm_vblank_crtc
*vblank
;
800 spinlock_t vblank_time_lock
; /**< Protects vblank count and time updates during vblank enable/disable */
803 u32 max_vblank_count
; /**< size of vblank counter register */
808 struct list_head vblank_event_list
;
809 spinlock_t event_lock
;
813 struct drm_agp_head
*agp
; /**< AGP data */
815 struct pci_dev
*pdev
; /**< PCI device structure */
817 struct pci_controller
*hose
;
820 struct platform_device
*platformdev
; /**< Platform device struture */
821 struct virtio_device
*virtdev
;
823 struct drm_sg_mem
*sg
; /**< Scatter gather memory */
824 unsigned int num_crtcs
; /**< Number of CRTCs on this device */
829 struct drm_hw_lock
*lock
;
832 struct drm_local_map
*agp_buffer_map
;
833 unsigned int agp_buffer_token
;
835 struct drm_mode_config mode_config
; /**< Current mode config */
837 /** \name GEM information */
839 struct mutex object_name_lock
;
840 struct idr object_name_idr
;
841 struct drm_vma_offset_manager
*vma_offset_manager
;
843 int switch_power_state
;
846 #define DRM_SWITCH_POWER_ON 0
847 #define DRM_SWITCH_POWER_OFF 1
848 #define DRM_SWITCH_POWER_CHANGING 2
849 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
851 static __inline__
int drm_core_check_feature(struct drm_device
*dev
,
854 return ((dev
->driver
->driver_features
& feature
) ? 1 : 0);
857 static inline void drm_device_set_unplugged(struct drm_device
*dev
)
860 atomic_set(&dev
->unplugged
, 1);
863 static inline int drm_device_is_unplugged(struct drm_device
*dev
)
865 int ret
= atomic_read(&dev
->unplugged
);
870 static inline bool drm_is_render_client(const struct drm_file
*file_priv
)
872 return file_priv
->minor
->type
== DRM_MINOR_RENDER
;
875 static inline bool drm_is_control_client(const struct drm_file
*file_priv
)
877 return file_priv
->minor
->type
== DRM_MINOR_CONTROL
;
880 static inline bool drm_is_primary_client(const struct drm_file
*file_priv
)
882 return file_priv
->minor
->type
== DRM_MINOR_LEGACY
;
885 /******************************************************************/
886 /** \name Internal function definitions */
889 /* Driver support (drm_drv.h) */
890 extern int drm_ioctl_permit(u32 flags
, struct drm_file
*file_priv
);
891 extern long drm_ioctl(struct file
*filp
,
892 unsigned int cmd
, unsigned long arg
);
893 extern long drm_compat_ioctl(struct file
*filp
,
894 unsigned int cmd
, unsigned long arg
);
895 extern bool drm_ioctl_flags(unsigned int nr
, unsigned int *flags
);
897 /* Device support (drm_fops.h) */
898 extern int drm_open(struct inode
*inode
, struct file
*filp
);
899 extern ssize_t
drm_read(struct file
*filp
, char __user
*buffer
,
900 size_t count
, loff_t
*offset
);
901 extern int drm_release(struct inode
*inode
, struct file
*filp
);
903 /* Mapping support (drm_vm.h) */
904 extern unsigned int drm_poll(struct file
*filp
, struct poll_table_struct
*wait
);
906 /* Misc. IOCTL support (drm_ioctl.c) */
907 int drm_noop(struct drm_device
*dev
, void *data
,
908 struct drm_file
*file_priv
);
910 /* Cache management (drm_cache.c) */
911 void drm_clflush_pages(struct page
*pages
[], unsigned long num_pages
);
912 void drm_clflush_sg(struct sg_table
*st
);
913 void drm_clflush_virt_range(void *addr
, unsigned long length
);
916 * These are exported to drivers so that they can implement fencing using
917 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
920 /* IRQ support (drm_irq.h) */
921 extern int drm_irq_install(struct drm_device
*dev
, int irq
);
922 extern int drm_irq_uninstall(struct drm_device
*dev
);
924 extern int drm_vblank_init(struct drm_device
*dev
, unsigned int num_crtcs
);
925 extern int drm_wait_vblank(struct drm_device
*dev
, void *data
,
926 struct drm_file
*filp
);
927 extern u32
drm_vblank_count(struct drm_device
*dev
, int pipe
);
928 extern u32
drm_crtc_vblank_count(struct drm_crtc
*crtc
);
929 extern u32
drm_vblank_count_and_time(struct drm_device
*dev
, unsigned int pipe
,
930 struct timeval
*vblanktime
);
931 extern void drm_send_vblank_event(struct drm_device
*dev
, unsigned int pipe
,
932 struct drm_pending_vblank_event
*e
);
933 extern void drm_crtc_send_vblank_event(struct drm_crtc
*crtc
,
934 struct drm_pending_vblank_event
*e
);
935 extern bool drm_handle_vblank(struct drm_device
*dev
, unsigned int pipe
);
936 extern bool drm_crtc_handle_vblank(struct drm_crtc
*crtc
);
937 extern int drm_vblank_get(struct drm_device
*dev
, unsigned int pipe
);
938 extern void drm_vblank_put(struct drm_device
*dev
, unsigned int pipe
);
939 extern int drm_crtc_vblank_get(struct drm_crtc
*crtc
);
940 extern void drm_crtc_vblank_put(struct drm_crtc
*crtc
);
941 extern void drm_wait_one_vblank(struct drm_device
*dev
, unsigned int pipe
);
942 extern void drm_crtc_wait_one_vblank(struct drm_crtc
*crtc
);
943 extern void drm_vblank_off(struct drm_device
*dev
, unsigned int pipe
);
944 extern void drm_vblank_on(struct drm_device
*dev
, unsigned int pipe
);
945 extern void drm_crtc_vblank_off(struct drm_crtc
*crtc
);
946 extern void drm_crtc_vblank_reset(struct drm_crtc
*crtc
);
947 extern void drm_crtc_vblank_on(struct drm_crtc
*crtc
);
948 extern void drm_vblank_cleanup(struct drm_device
*dev
);
950 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device
*dev
,
951 unsigned int pipe
, int *max_error
,
952 struct timeval
*vblank_time
,
954 const struct drm_crtc
*refcrtc
,
955 const struct drm_display_mode
*mode
);
956 extern void drm_calc_timestamping_constants(struct drm_crtc
*crtc
,
957 const struct drm_display_mode
*mode
);
960 * drm_crtc_vblank_waitqueue - get vblank waitqueue for the CRTC
961 * @crtc: which CRTC's vblank waitqueue to retrieve
963 * This function returns a pointer to the vblank waitqueue for the CRTC.
964 * Drivers can use this to implement vblank waits using wait_event() & co.
966 static inline wait_queue_head_t
*drm_crtc_vblank_waitqueue(struct drm_crtc
*crtc
)
968 return &crtc
->dev
->vblank
[drm_crtc_index(crtc
)].queue
;
971 /* Modesetting support */
972 extern void drm_vblank_pre_modeset(struct drm_device
*dev
, unsigned int pipe
);
973 extern void drm_vblank_post_modeset(struct drm_device
*dev
, unsigned int pipe
);
975 /* Stub support (drm_stub.h) */
976 extern struct drm_master
*drm_master_get(struct drm_master
*master
);
977 extern void drm_master_put(struct drm_master
**master
);
979 extern void drm_put_dev(struct drm_device
*dev
);
980 extern void drm_unplug_dev(struct drm_device
*dev
);
981 extern unsigned int drm_debug
;
982 extern bool drm_atomic
;
984 /* Debugfs support */
985 #if defined(CONFIG_DEBUG_FS)
986 extern int drm_debugfs_create_files(const struct drm_info_list
*files
,
987 int count
, struct dentry
*root
,
988 struct drm_minor
*minor
);
989 extern int drm_debugfs_remove_files(const struct drm_info_list
*files
,
990 int count
, struct drm_minor
*minor
);
992 static inline int drm_debugfs_create_files(const struct drm_info_list
*files
,
993 int count
, struct dentry
*root
,
994 struct drm_minor
*minor
)
999 static inline int drm_debugfs_remove_files(const struct drm_info_list
*files
,
1000 int count
, struct drm_minor
*minor
)
1006 extern struct dma_buf
*drm_gem_prime_export(struct drm_device
*dev
,
1007 struct drm_gem_object
*obj
, int flags
);
1008 extern int drm_gem_prime_handle_to_fd(struct drm_device
*dev
,
1009 struct drm_file
*file_priv
, uint32_t handle
, uint32_t flags
,
1011 extern struct drm_gem_object
*drm_gem_prime_import(struct drm_device
*dev
,
1012 struct dma_buf
*dma_buf
);
1013 extern int drm_gem_prime_fd_to_handle(struct drm_device
*dev
,
1014 struct drm_file
*file_priv
, int prime_fd
, uint32_t *handle
);
1015 extern void drm_gem_dmabuf_release(struct dma_buf
*dma_buf
);
1017 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table
*sgt
, struct page
**pages
,
1018 dma_addr_t
*addrs
, int max_pages
);
1019 extern struct sg_table
*drm_prime_pages_to_sg(struct page
**pages
, unsigned int nr_pages
);
1020 extern void drm_prime_gem_destroy(struct drm_gem_object
*obj
, struct sg_table
*sg
);
1023 extern struct drm_dma_handle
*drm_pci_alloc(struct drm_device
*dev
, size_t size
,
1025 extern void drm_pci_free(struct drm_device
*dev
, struct drm_dma_handle
* dmah
);
1027 /* sysfs support (drm_sysfs.c) */
1028 extern void drm_sysfs_hotplug_event(struct drm_device
*dev
);
1031 struct drm_device
*drm_dev_alloc(struct drm_driver
*driver
,
1032 struct device
*parent
);
1033 void drm_dev_ref(struct drm_device
*dev
);
1034 void drm_dev_unref(struct drm_device
*dev
);
1035 int drm_dev_register(struct drm_device
*dev
, unsigned long flags
);
1036 void drm_dev_unregister(struct drm_device
*dev
);
1037 int drm_dev_set_unique(struct drm_device
*dev
, const char *fmt
, ...);
1039 struct drm_minor
*drm_minor_acquire(unsigned int minor_id
);
1040 void drm_minor_release(struct drm_minor
*minor
);
1045 static __inline__
int drm_pci_device_is_agp(struct drm_device
*dev
)
1047 if (dev
->driver
->device_is_agp
!= NULL
) {
1048 int err
= (*dev
->driver
->device_is_agp
) (dev
);
1055 return pci_find_capability(dev
->pdev
, PCI_CAP_ID_AGP
);
1057 void drm_pci_agp_destroy(struct drm_device
*dev
);
1059 extern int drm_pci_init(struct drm_driver
*driver
, struct pci_driver
*pdriver
);
1060 extern void drm_pci_exit(struct drm_driver
*driver
, struct pci_driver
*pdriver
);
1062 extern int drm_get_pci_dev(struct pci_dev
*pdev
,
1063 const struct pci_device_id
*ent
,
1064 struct drm_driver
*driver
);
1065 extern int drm_pci_set_busid(struct drm_device
*dev
, struct drm_master
*master
);
1067 static inline int drm_get_pci_dev(struct pci_dev
*pdev
,
1068 const struct pci_device_id
*ent
,
1069 struct drm_driver
*driver
)
1074 static inline int drm_pci_set_busid(struct drm_device
*dev
,
1075 struct drm_master
*master
)
1081 #define DRM_PCIE_SPEED_25 1
1082 #define DRM_PCIE_SPEED_50 2
1083 #define DRM_PCIE_SPEED_80 4
1085 extern int drm_pcie_get_speed_cap_mask(struct drm_device
*dev
, u32
*speed_mask
);
1087 /* platform section */
1088 extern int drm_platform_init(struct drm_driver
*driver
, struct platform_device
*platform_device
);
1089 extern int drm_platform_set_busid(struct drm_device
*d
, struct drm_master
*m
);
1091 /* returns true if currently okay to sleep */
1092 static __inline__
bool drm_can_sleep(void)
1094 if (in_atomic() || in_dbg_master() || irqs_disabled())