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 #if defined(_KERNEL) || defined(__KERNEL__)
37 #include <sys/param.h>
38 #include <sys/queue.h>
39 #include <sys/malloc.h>
40 #include <sys/kernel.h>
42 #include <sys/module.h>
43 #include <sys/systm.h>
44 #include <sys/device.h>
45 #include <sys/sglist.h>
50 #include <sys/spinlock.h>
51 #include <sys/spinlock2.h>
52 #include <sys/fcntl.h>
54 #include <sys/filio.h>
55 #include <sys/sysctl.h>
57 #include <sys/queue.h>
58 #include <sys/signalvar.h>
60 #include <linux/highmem.h>
62 #include <sys/taskqueue.h>
66 #include <vm/vm_extern.h>
67 #include <vm/vm_kern.h>
68 #include <vm/vm_map.h>
69 #include <vm/vm_object.h>
70 #include <vm/vm_page2.h>
71 #include <vm/vm_pager.h>
72 #include <vm/vm_param.h>
73 #include <machine/param.h>
74 #include <machine/pmap.h>
76 #include <machine/specialreg.h>
78 #include <machine/sysarch.h>
79 #include <sys/endian.h>
82 #include <sys/memrange.h>
83 #include <sys/mutex.h>
85 #include <linux/atomic.h>
86 #include <linux/bug.h>
87 #include <linux/dma-mapping.h>
88 #include <linux/capability.h>
89 #include <linux/err.h>
90 #include <linux/idr.h>
91 #include <linux/pci.h>
92 #include <linux/jiffies.h>
93 #include <linux/kernel.h>
95 #include <linux/kref.h>
96 #include <linux/list.h>
98 #include <linux/moduleparam.h>
99 #include <linux/mutex.h>
100 #include <linux/slab.h>
101 #include <linux/scatterlist.h>
102 #include <linux/timer.h>
104 #include <linux/seq_file.h>
105 #include <linux/types.h>
106 #include <linux/vmalloc.h>
107 #include <linux/wait.h>
108 #include <linux/workqueue.h>
110 #include <asm/uaccess.h>
112 #include <uapi_drm/drm.h>
113 #include <uapi_drm/drm_mode.h>
115 #include <drm/drm_agpsupport.h>
116 #include <drm/drm_crtc.h>
117 #include <drm/drm_global.h>
118 #include <drm/drm_hashtab.h>
119 #include <drm/drm_mem_util.h>
120 #include <drm/drm_mm.h>
121 #include <drm/drm_os_linux.h>
122 #include <uapi_drm/drm_sarea.h>
123 #include <drm/drm_vma_manager.h>
128 struct drm_local_map;
129 struct drm_device_dma;
130 struct drm_dma_handle;
131 struct drm_gem_object;
134 #ifdef CONFIG_VIDEOMODE_HELPERS
135 struct videomode; /* XXX empty struct in videomode.h ? */
137 struct reservation_object;
138 struct dma_buf_attachment;
141 * 4 debug categories are defined:
143 * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
144 * This is the category used by the DRM_DEBUG() macro.
146 * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
147 * This is the category used by the DRM_DEBUG_DRIVER() macro.
149 * KMS: used in the modesetting code.
150 * This is the category used by the DRM_DEBUG_KMS() macro.
152 * PRIME: used in the prime code.
153 * This is the category used by the DRM_DEBUG_PRIME() macro.
155 * ATOMIC: used in the atomic code.
156 * This is the category used by the DRM_DEBUG_ATOMIC() macro.
158 * Enabling verbose debug messages is done through the drm.debug parameter,
159 * each category being enabled by a bit.
161 * drm.debug=0x1 will enable CORE messages
162 * drm.debug=0x2 will enable DRIVER messages
163 * drm.debug=0x3 will enable CORE and DRIVER messages
165 * drm.debug=0xf will enable all messages
167 * An interesting feature is that it's possible to enable verbose logging at
168 * run-time by echoing the debug value in its sysfs node:
169 * # echo 0xf > /sys/module/drm/parameters/debug
171 #define DRM_UT_CORE 0x01
172 #define DRM_UT_DRIVER 0x02
173 #define DRM_UT_KMS 0x04
174 #define DRM_UT_PRIME 0x08
175 #define DRM_UT_ATOMIC 0x10
177 void drm_ut_debug_printk(const char *function_name,
178 const char *format, ...);
180 void drm_err(const char *format, ...);
182 /***********************************************************************/
183 /** \name DRM template customization defaults */
186 /* driver capabilities and requirements mask */
187 #define DRIVER_USE_AGP 0x1
188 #define DRIVER_REQUIRE_AGP 0x2
189 #define DRIVER_PCI_DMA 0x8
190 #define DRIVER_SG 0x10
191 #define DRIVER_HAVE_DMA 0x20
192 #define DRIVER_HAVE_IRQ 0x40
193 #define DRIVER_IRQ_SHARED 0x80
194 #define DRIVER_GEM 0x1000
195 #define DRIVER_MODESET 0x2000
196 #define DRIVER_PRIME 0x4000
197 #define DRIVER_RENDER 0x8000
198 #define DRIVER_ATOMIC 0x10000
199 #define DRIVER_KMS_LEGACY_CONTEXT 0x20000
201 #define DRM_MAGIC_HASH_ORDER 4 /**< Size of key hash table. Must be power of 2. */
203 /***********************************************************************/
204 /** \name Macros to make printk easier */
210 * \param fmt printf() like format string.
211 * \param arg arguments
213 #define DRM_ERROR(fmt, ...) \
214 kprintf("error: [" DRM_NAME ":pid%d:%s] *ERROR* " fmt, \
215 DRM_CURRENTPID, __func__ , ##__VA_ARGS__)
218 * Rate limited error output. Like DRM_ERROR() but won't flood the log.
220 * \param fmt printf() like format string.
221 * \param arg arguments
224 #define DRM_INFO(fmt, ...) kprintf("info: [" DRM_NAME "] " fmt , ##__VA_ARGS__)
226 #define DRM_INFO_ONCE(fmt, ...) \
227 printk_once(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
232 * \param fmt printf() like format string.
233 * \param arg arguments
236 #define DRM_DEBUGBITS_DEBUG 0x1
237 #define DRM_DEBUGBITS_KMS 0x2
238 #define DRM_DEBUGBITS_FAILED_IOCTL 0x4
239 #define DRM_DEBUGBITS_VERBOSE 0x8
241 #define DRM_DEBUG(fmt, ...) do { \
242 if ((drm_debug & DRM_DEBUGBITS_DEBUG) != 0) \
243 kprintf("[" DRM_NAME ":pid%d:%s] " fmt, DRM_CURRENTPID, \
244 __func__ , ##__VA_ARGS__); \
247 #define DRM_DEBUG_VERBOSE(fmt, ...) do { \
248 if ((drm_debug & DRM_DEBUGBITS_VERBOSE) != 0) \
249 kprintf("[" DRM_NAME ":pid%d:%s] " fmt, DRM_CURRENTPID, \
250 __func__ , ##__VA_ARGS__); \
253 #define DRM_DEBUG_KMS(fmt, ...) do { \
254 if ((drm_debug & DRM_DEBUGBITS_KMS) != 0) \
255 kprintf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
256 __func__ , ##__VA_ARGS__); \
259 #define DRM_DEBUG_DRIVER(fmt, ...) do { \
260 if ((drm_debug & DRM_DEBUGBITS_KMS) != 0) \
261 kprintf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
262 __func__ , ##__VA_ARGS__); \
265 #define DRM_DEBUG_ATOMIC(fmt, args...) \
267 if (unlikely(drm_debug & DRM_UT_ATOMIC)) \
268 drm_ut_debug_printk(__func__, fmt, ##args); \
273 /***********************************************************************/
274 /** \name Internal types and structures */
277 #define DRM_GEM_MAPPING_MASK (3ULL << 62)
278 #define DRM_GEM_MAPPING_KEY (2ULL << 62) /* Non-canonical address form */
279 #define DRM_GEM_MAX_IDX 0x3fffff
280 #define DRM_GEM_MAPPING_IDX(o) (((o) >> 40) & DRM_GEM_MAX_IDX)
281 #define DRM_GEM_MAPPING_OFF(i) (((uint64_t)(i)) << 40)
282 #define DRM_GEM_MAPPING_MAPOFF(o) \
283 ((o) & ~(DRM_GEM_MAPPING_OFF(DRM_GEM_MAX_IDX) | DRM_GEM_MAPPING_KEY))
285 SYSCTL_DECL(_hw_drm);
287 #define DRM_MAX(a,b) ((a)>(b)?(a):(b))
289 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
291 #define DRM_DEV_MODE (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
292 #define DRM_DEV_UID UID_ROOT
293 #define DRM_DEV_GID GID_WHEEL
295 #define DRM_CURPROC curthread
296 #define DRM_STRUCTPROC struct thread
297 #define DRM_LOCK(dev) lockmgr(&(dev)->struct_mutex, LK_EXCLUSIVE)
298 #define DRM_UNLOCK(dev) lockmgr(&(dev)->struct_mutex, LK_RELEASE)
299 #define DRM_LOCK_SLEEP(dev, chan, flags, msg, timeout) \
300 (lksleep((chan), &(dev)->struct_mutex, (flags), (msg), (timeout)))
301 #if defined(INVARIANTS)
302 #define DRM_LOCK_ASSERT(dev) KKASSERT(lockstatus(&(dev)->struct_mutex, curthread) != 0);
303 #define DRM_UNLOCK_ASSERT(dev) KKASSERT(lockstatus(&(dev)->struct_mutex, curthread) == 0);
305 #define DRM_LOCK_ASSERT(d)
306 #define DRM_UNLOCK_ASSERT(d)
309 #define DRM_SYSCTL_HANDLER_ARGS (SYSCTL_HANDLER_ARGS)
311 typedef void irqreturn_t;
312 #define IRQ_HANDLED /* nothing */
313 #define IRQ_NONE /* nothing */
315 #define drm_get_device_from_kdev(_kdev) (_kdev->si_drv1)
317 #define DRM_MTRR_WC MDF_WRITECOMBINE
319 int vm_phys_fictitious_reg_range(vm_paddr_t start, vm_paddr_t end,
320 vm_memattr_t memattr);
321 void vm_phys_fictitious_unreg_range(vm_paddr_t start, vm_paddr_t end);
322 vm_page_t vm_phys_fictitious_to_vm_page(vm_paddr_t pa);
325 #define dev_dbg(dev, fmt, ...) do { \
326 if ((drm_debug& DRM_DEBUGBITS_KMS) != 0) { \
327 device_printf((dev), "debug: " fmt, ## __VA_ARGS__); \
331 typedef struct drm_pci_id_list
340 * Ioctl function type.
342 * \param inode device inode.
343 * \param file_priv DRM file private pointer.
344 * \param cmd command.
345 * \param arg argument.
347 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
348 struct drm_file *file_priv);
350 typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
353 #define DRM_IOCTL_NR(n) ((n) & 0xff)
356 #define DRM_MASTER 0x2
357 #define DRM_ROOT_ONLY 0x4
358 #define DRM_CONTROL_ALLOW 0x8
359 #define DRM_UNLOCKED 0x10
360 #define DRM_RENDER_ALLOW 0x20
362 struct drm_ioctl_desc {
366 unsigned int cmd_drv;
371 * Creates a driver or general drm_ioctl_desc array entry for the given
372 * ioctl, for use by drm_ioctl().
374 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags) \
375 [DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl}
377 typedef struct drm_magic_entry {
378 struct list_head head;
379 struct drm_hash_item hash_item;
380 struct drm_file *priv;
381 struct drm_magic_entry *next;
384 typedef struct drm_magic_head {
385 struct drm_magic_entry *head;
386 struct drm_magic_entry *tail;
389 /** bufs is one longer than it has to be */
390 struct drm_waitlist {
391 int count; /**< Number of possible buffers */
392 struct drm_buf **bufs; /**< List of pointers to buffers */
393 struct drm_buf **rp; /**< Read pointer */
394 struct drm_buf **wp; /**< Write pointer */
395 struct drm_buf **end; /**< End pointer */
396 struct spinlock *read_lock;
397 struct spinlock *write_lock;
400 /* Event queued up for userspace to read */
401 struct drm_pending_event {
402 struct drm_event *event;
403 struct list_head link;
404 struct drm_file *file_priv;
405 pid_t pid; /* pid of requester, no guarantee it's valid by the time
406 we deliver the event, for tracing only */
407 void (*destroy)(struct drm_pending_event *event);
410 /* initial implementaton using a linked list - todo hashtab */
411 struct drm_prime_file_private {
412 struct list_head head;
415 #endif /* DUMBBELL_WIP */
418 /** File private data */
421 struct drm_device *dev;
424 /* true when the client has asked us to expose stereo 3D mode flags */
427 * true if client understands CRTC primary planes and cursor planes
430 unsigned universal_planes:1;
431 /* true if client understands atomic properties */
437 unsigned long ioctl_count;
438 struct list_head lhead;
441 /** Mapping of mm object handles to object pointers. */
442 struct idr object_idr;
443 /** Lock for synchronization of access to object_idr. */
444 struct lock table_lock;
449 struct drm_master *masterp;
452 * fbs - List of framebuffers associated with this file.
454 * Protected by fbs_lock. Note that the fbs list holds a reference on
455 * the fb object to prevent it from untimely disappearing.
457 struct list_head fbs;
458 struct lock fbs_lock;
460 /** User-created blob properties; this retains a reference on the
462 struct list_head blobs;
464 wait_queue_head_t event_wait;
465 struct list_head event_list;
468 struct drm_prime_file_private prime;
474 struct drm_lock_data {
475 struct drm_hw_lock *hw_lock; /**< Hardware lock */
476 /** Private of lock holder's file (NULL=kernel) */
477 struct drm_file *file_priv;
478 wait_queue_head_t lock_queue; /**< Queue of blocked processes */
479 unsigned long lock_time; /**< Time of last lock in jiffies */
483 * GEM specific mm private for tracking GEM objects
486 struct drm_vma_offset_manager vma_manager;
487 struct drm_mm offset_manager; /**< Offset mgmt for buffer objects */
488 struct drm_open_hash offset_hash; /**< User token hash table for maps */
489 struct unrhdr *idxunr;
493 * struct drm_master - drm master structure
495 * @refcount: Refcount for this master object.
496 * @minor: Link back to minor char device we are master for. Immutable.
497 * @unique: Unique identifier: e.g. busid. Protected by drm_global_mutex.
498 * @unique_len: Length of unique field. Protected by drm_global_mutex.
499 * @unique_size: Amount allocated. Protected by drm_global_mutex.
500 * @magiclist: Hash of used authentication tokens. Protected by struct_mutex.
501 * @magicfree: List of used authentication tokens. Protected by struct_mutex.
502 * @lock: DRI lock information.
503 * @driver_priv: Pointer to driver-private information.
507 struct kref refcount; /* refcount for this master */
509 struct list_head head; /**< each minor contains a list of masters */
510 struct drm_minor *minor; /**< link back to minor we are a master for */
512 char *unique; /**< Unique identifier: e.g., busid */
513 int unique_len; /**< Length of unique field */
514 int unique_size; /**< amount allocated */
516 int blocked; /**< Blocked due to VC switch? */
518 struct drm_open_hash magiclist;
519 struct list_head magicfree;
520 struct drm_lock_data lock;
524 /* Size of ringbuffer for vblank timestamps. Just double-buffer
525 * in initial implementation.
527 #define DRM_VBLANKTIME_RBSIZE 2
529 /* Flags and return codes for get_vblank_timestamp() driver function. */
530 #define DRM_CALLED_FROM_VBLIRQ 1
531 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
532 #define DRM_VBLANKTIME_IN_VBLANK (1 << 1)
534 /* get_scanout_position() return flags */
535 #define DRM_SCANOUTPOS_VALID (1 << 0)
536 #define DRM_SCANOUTPOS_IN_VBLANK (1 << 1)
537 #define DRM_SCANOUTPOS_ACCURATE (1 << 2)
540 #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : (1ULL<<(n)) - 1)
543 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
546 * DRM driver structure. This structure represent the common code for
547 * a family of cards. There will one drm_device for each card present
551 int (*load)(struct drm_device *, unsigned long flags);
552 int (*use_msi)(struct drm_device *, unsigned long flags);
553 int (*firstopen)(struct drm_device *);
554 int (*open)(struct drm_device *, struct drm_file *);
555 void (*preclose)(struct drm_device *, struct drm_file *file_priv);
556 void (*postclose)(struct drm_device *, struct drm_file *);
557 void (*lastclose)(struct drm_device *);
558 int (*unload)(struct drm_device *);
559 void (*reclaim_buffers_locked)(struct drm_device *,
560 struct drm_file *file_priv);
561 int (*dma_ioctl)(struct drm_device *dev, void *data,
562 struct drm_file *file_priv);
563 int (*dma_quiescent)(struct drm_device *);
564 int (*context_ctor)(struct drm_device *dev, int context);
565 int (*context_dtor)(struct drm_device *dev, int context);
566 void (*irq_preinstall)(struct drm_device *dev);
567 int (*irq_postinstall)(struct drm_device *dev);
568 void (*irq_uninstall)(struct drm_device *dev);
569 void (*irq_handler)(void *arg);
571 u32 (*get_vblank_counter)(struct drm_device *dev, int crtc);
572 int (*enable_vblank)(struct drm_device *dev, int crtc);
573 void (*disable_vblank)(struct drm_device *dev, int crtc);
576 * Called by \c drm_device_is_agp. Typically used to determine if a
577 * card is really attached to AGP or not.
579 * \param dev DRM device handle
582 * One of three values is returned depending on whether or not the
583 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
584 * (return of 1), or may or may not be AGP (return of 2).
586 int (*device_is_agp) (struct drm_device *dev);
589 * Called by vblank timestamping code.
591 * Return the current display scanout position from a crtc, and an
592 * optional accurate ktime_get timestamp of when position was measured.
594 * \param dev DRM device.
595 * \param crtc Id of the crtc to query.
596 * \param flags Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
597 * \param *vpos Target location for current vertical scanout position.
598 * \param *hpos Target location for current horizontal scanout position.
599 * \param *stime Target location for timestamp taken immediately before
600 * scanout position query. Can be NULL to skip timestamp.
601 * \param *etime Target location for timestamp taken immediately after
602 * scanout position query. Can be NULL to skip timestamp.
604 * Returns vpos as a positive number while in active scanout area.
605 * Returns vpos as a negative number inside vblank, counting the number
606 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
607 * until start of active scanout / end of vblank."
609 * \return Flags, or'ed together as follows:
611 * DRM_SCANOUTPOS_VALID = Query successful.
612 * DRM_SCANOUTPOS_INVBL = Inside vblank.
613 * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
614 * this flag means that returned position may be offset by a constant
615 * but unknown small number of scanlines wrt. real scanout position.
618 int (*get_scanout_position) (struct drm_device *dev, int crtc,
620 int *vpos, int *hpos, ktime_t *stime,
623 int (*get_vblank_timestamp)(struct drm_device *dev, int crtc,
624 int *max_error, struct timeval *vblank_time,
627 void (*gem_free_object)(struct drm_gem_object *obj);
628 int (*gem_open_object)(struct drm_gem_object *, struct drm_file *);
629 void (*gem_close_object)(struct drm_gem_object *, struct drm_file *);
631 struct cdev_pager_ops *gem_pager_ops;
633 int (*dumb_create)(struct drm_file *file_priv,
634 struct drm_device *dev, struct drm_mode_create_dumb *args);
635 int (*dumb_map_offset)(struct drm_file *file_priv,
636 struct drm_device *dev, uint32_t handle, uint64_t *offset);
637 int (*dumb_destroy)(struct drm_file *file_priv,
638 struct drm_device *dev, uint32_t handle);
640 int (*sysctl_init)(struct drm_device *dev,
641 struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
642 void (*sysctl_cleanup)(struct drm_device *dev);
644 drm_pci_id_list_t *id_entry; /* PCI ID, name, and chipset private */
649 const char *name; /* Simple driver name */
650 const char *desc; /* Longer driver name */
651 const char *date; /* Date of last major changes. */
655 const struct drm_ioctl_desc *ioctls;
660 * Info file list entry. This structure represents a debugfs or proc file to
661 * be created by the drm core
663 struct drm_info_list {
664 const char *name; /** file name */
665 int (*show)(struct seq_file*, void*); /** show callback */
666 u32 driver_features; /**< Required driver features for this entry */
671 * debugfs node structure. This structure represents a debugfs file.
673 struct drm_info_node {
674 struct list_head list;
675 struct drm_minor *minor;
676 const struct drm_info_list *info_ent;
681 * DRM minor structure. This structure represents a drm minor number.
684 int index; /**< Minor device number */
685 int type; /**< Control or render */
686 device_t kdev; /**< OS device */
687 struct drm_device *dev;
689 struct drm_master *master; /* currently active master for this node */
690 struct list_head master_list;
691 struct drm_mode_group mode_group;
694 struct drm_pending_vblank_event {
695 struct drm_pending_event base;
697 struct drm_event_vblank event;
700 struct drm_sysctl_info {
701 struct sysctl_ctx_list ctx;
705 /* Length for the array of resource pointers for drm_get_resource_*. */
706 #define DRM_MAX_PCI_RESOURCE 6
708 struct drm_vblank_crtc {
709 struct drm_device *dev; /* pointer to the drm_device */
710 wait_queue_head_t queue; /**< VBLANK wait queue */
711 struct timer_list disable_timer; /* delayed disable timer */
713 /* vblank counter, protected by dev->vblank_time_lock for writes */
715 /* vblank timestamps, protected by dev->vblank_time_lock for writes */
716 struct timeval time[DRM_VBLANKTIME_RBSIZE];
718 atomic_t refcount; /* number of users of vblank interruptsper crtc */
719 u32 last; /* protected by dev->vbl_lock, used */
720 /* for wraparound handling */
721 u32 last_wait; /* Last vblank seqno waited per CRTC */
722 unsigned int inmodeset; /* Display driver is setting mode */
723 unsigned int pipe; /* crtc index */
724 bool enabled; /* so we don't call enable more than
729 * DRM device structure. This structure represent a complete card that
730 * may contain multiple heads.
733 drm_pci_id_list_t *id_entry; /* PCI ID, name, and chipset private */
735 char *unique; /* Unique identifier: e.g., busid */
736 int unique_len; /* Length of unique field */
737 struct cdev *devnode; /* Device number for mknod */
738 int if_version; /* Highest interface version set */
740 int flags; /* Flags to open(2) */
743 struct spinlock dma_lock; /* protects dev->dma */
744 struct lwkt_serialize irq_lock; /* protects irq condition checks */
745 struct lock dev_lock; /* protects everything else */
749 struct lock struct_mutex; /**< For others */
750 struct lock master_mutex; /**< For drm_minor::master */
753 /** \name Usage Counters */
755 int open_count; /**< Outstanding files open, protected by drm_global_mutex. */
756 struct spinlock buf_lock; /**< For drm_device::buf_use and a few other things. */
757 int buf_use; /**< Buffers in use -- cannot alloc */
758 atomic_t buf_alloc; /**< Buffer allocation in progress */
762 /** \name Performance counters */
764 unsigned long counters;
765 enum drm_stat_type types[15];
770 struct drm_open_hash magiclist; /**< magic hash table */
771 struct list_head magicfree;
773 struct list_head filelist;
775 /** \name Memory management */
777 struct list_head maplist; /**< Linked list of regions */
778 int map_count; /**< Number of mappable regions */
779 struct drm_open_hash map_hash; /**< User token hash table for maps */
781 /** \name Context handle management */
783 struct list_head ctxlist; /**< Linked list of context handles */
784 int ctx_count; /**< Number of context handles */
785 struct lock ctxlist_mutex; /**< For ctxlist */
791 struct drm_lock_data lock; /* Information on hardware lock */
793 /** \name DMA support */
795 struct drm_device_dma *dma; /**< Optional pointer for DMA support */
798 int irq; /* Interrupt used by board */
799 int irq_type; /* IRQ type (MSI enabled or not) */
800 int irqrid; /* Interrupt used by board */
801 struct resource *irqr; /* Resource for interrupt used by board */
802 void *irqh; /* Handle from bus_setup_intr */
804 /* Storage of resource pointers for drm_get_resource_* */
805 struct resource *pcir[DRM_MAX_PCI_RESOURCE];
806 int pcirid[DRM_MAX_PCI_RESOURCE];
813 /** \name Context support */
815 int irq_enabled; /**< True if irq handler is enabled */
816 __volatile__ long context_flag; /**< Context swapping flag */
817 __volatile__ long interrupt_flag; /**< Interruption handler flag */
818 __volatile__ long dma_flag; /**< DMA dispatch flag */
819 wait_queue_head_t context_wait; /**< Processes waiting on ctx switch */
820 int last_checked; /**< Last context checked for DMA */
821 int last_context; /**< Last current context */
822 unsigned long last_switch; /**< jiffies at last context switch */
825 /** \name VBLANK IRQ support */
829 * At load time, disabling the vblank interrupt won't be allowed since
830 * old clients may not call the modeset ioctl and therefore misbehave.
831 * Once the modeset ioctl *has* been called though, we can safely
832 * disable them when unused.
834 bool vblank_disable_allowed;
837 * If true, vblank interrupt will be disabled immediately when the
838 * refcount drops to zero, as opposed to via the vblank disable
840 * This can be set to true it the hardware has a working vblank
841 * counter and the driver uses drm_vblank_on() and drm_vblank_off()
844 bool vblank_disable_immediate;
846 /* array of size num_crtcs */
847 struct drm_vblank_crtc *vblank;
849 struct lock vblank_time_lock; /**< Protects vblank count and time updates during vblank enable/disable */
850 struct lock vbl_lock;
851 struct timer_list vblank_disable_timer;
853 u32 max_vblank_count; /**< size of vblank counter register */
858 struct list_head vblank_event_list;
859 struct lock event_lock;
863 struct sigio *buf_sigio; /* Processes waiting for SIGIO */
866 struct drm_sysctl_info *sysctl;
869 struct drm_sg_mem *sg; /**< Scatter gather memory */
870 unsigned int num_crtcs; /**< Number of CRTCs on this device */
872 unsigned long *ctx_bitmap;
879 struct drm_agp_head *agp; /**< AGP data */
881 struct device *dev; /**< Device structure */
882 struct pci_dev *pdev; /**< PCI device structure */
884 struct drm_driver *driver;
885 struct drm_local_map *agp_buffer_map;
886 unsigned int agp_buffer_token;
887 struct drm_minor *control; /**< Control node for card */
888 struct drm_minor *primary; /**< render type primary screen head */
890 struct drm_mode_config mode_config; /**< Current mode config */
892 /** \name GEM information */
894 struct lock object_name_lock;
895 struct idr object_name_idr;
899 void *sysctl_private;
903 int switch_power_state;
905 atomic_t unplugged; /* device has been unplugged or gone away */
908 #define DRM_SWITCH_POWER_ON 0
909 #define DRM_SWITCH_POWER_OFF 1
910 #define DRM_SWITCH_POWER_CHANGING 2
911 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
913 static __inline__ int drm_core_check_feature(struct drm_device *dev,
916 return ((dev->driver->driver_features & feature) ? 1 : 0);
919 static inline void drm_device_set_unplugged(struct drm_device *dev)
922 atomic_set(&dev->unplugged, 1);
925 static inline int drm_device_is_unplugged(struct drm_device *dev)
927 int ret = atomic_read(&dev->unplugged);
932 static inline bool drm_is_primary_client(const struct drm_file *file_priv)
934 return 0 /* file_priv->minor->type == DRM_MINOR_LEGACY */;
938 * drm_is_master() - Check whether a DRM open-file is DRM-Master
939 * @file: DRM open-file context
941 * This checks whether a DRM open-file context is owner of the master context
942 * attached to it. If a file owns a master context, it's called DRM-Master.
943 * Per DRM device, only one such file can be DRM-Master at a time.
945 * Returns: True if the file is DRM-Master, otherwise false.
947 static inline bool drm_is_master(const struct drm_file *file)
950 return file->master && file->master == file->minor->master;
956 /******************************************************************/
957 /** \name Internal function definitions */
961 static inline int drm_core_has_AGP(struct drm_device *dev)
963 return drm_core_check_feature(dev, DRIVER_USE_AGP);
966 #define drm_core_has_AGP(dev) (0)
969 extern unsigned int drm_rnodes;
970 extern unsigned int drm_universal_planes;
972 extern int drm_vblank_offdelay;
973 extern unsigned int drm_timestamp_precision;
975 /* Driver support (drm_drv.h) */
976 extern int drm_ioctl_permit(u32 flags, struct drm_file *file_priv);
977 int drm_probe(device_t kdev, drm_pci_id_list_t *idlist);
978 int drm_attach(device_t kdev, drm_pci_id_list_t *idlist);
979 int drm_create_cdevs(device_t kdev);
981 extern bool drm_ioctl_flags(unsigned int nr, unsigned int *flags);
983 /* Device support (drm_fops.h) */
987 d_kqfilter_t drm_kqfilter;
988 int drm_release(device_t kdev);
991 d_mmap_single_t drm_mmap_single;
993 void drm_cdevpriv_dtor(void *cd);
995 int drm_add_busid_modesetting(struct drm_device *dev,
996 struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
998 /* File operations helpers (drm_fops.c) */
999 extern int drm_open_helper(struct cdev *kdev, int flags, int fmt,
1001 struct drm_device *dev,
1003 extern struct drm_file *drm_find_file_by_proc(struct drm_device *dev,
1007 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1008 struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1010 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1011 struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1013 extern int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
1014 struct drm_file *file_priv);
1015 extern int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
1016 struct drm_file *file_priv);
1018 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, vm_page_t *pages,
1019 dma_addr_t *addrs, int max_pages);
1020 #endif /* DUMBBELL_WIP */
1021 extern struct sg_table *drm_prime_pages_to_sg(vm_page_t *pages, int nr_pages);
1022 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1025 void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv);
1026 void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv);
1027 int drm_prime_add_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t handle);
1028 int drm_prime_lookup_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t *handle);
1029 void drm_prime_remove_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf);
1031 int drm_prime_add_dma_buf(struct drm_device *dev, struct drm_gem_object *obj);
1032 int drm_prime_lookup_obj(struct drm_device *dev, struct dma_buf *buf,
1033 struct drm_gem_object **obj);
1034 #endif /* DUMBBELL_WIP */
1036 int drm_mtrr_add(unsigned long offset, size_t size, int flags);
1037 int drm_mtrr_del(int handle, unsigned long offset, size_t size, int flags);
1040 * These are exported to drivers so that they can implement fencing using
1041 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1044 unsigned long drm_get_resource_start(struct drm_device *dev,
1045 unsigned int resource);
1046 unsigned long drm_get_resource_len(struct drm_device *dev,
1047 unsigned int resource);
1049 /* IRQ support (drm_irq.h) */
1050 extern int drm_irq_install(struct drm_device *dev, int irq);
1051 extern int drm_irq_uninstall(struct drm_device *dev);
1053 extern int drm_vblank_init(struct drm_device *dev, unsigned int num_crtcs);
1054 extern int drm_wait_vblank(struct drm_device *dev, void *data,
1055 struct drm_file *filp);
1056 extern u32 drm_vblank_count(struct drm_device *dev, int pipe);
1057 extern u32 drm_crtc_vblank_count(struct drm_crtc *crtc);
1058 extern u32 drm_vblank_count_and_time(struct drm_device *dev, unsigned int pipe,
1059 struct timeval *vblanktime);
1060 extern void drm_send_vblank_event(struct drm_device *dev, unsigned int pipe,
1061 struct drm_pending_vblank_event *e);
1062 extern void drm_crtc_send_vblank_event(struct drm_crtc *crtc,
1063 struct drm_pending_vblank_event *e);
1064 extern bool drm_handle_vblank(struct drm_device *dev, unsigned int pipe);
1065 extern bool drm_crtc_handle_vblank(struct drm_crtc *crtc);
1066 extern int drm_vblank_get(struct drm_device *dev, unsigned int pipe);
1067 extern void drm_vblank_put(struct drm_device *dev, unsigned int pipe);
1068 extern int drm_crtc_vblank_get(struct drm_crtc *crtc);
1069 extern void drm_crtc_vblank_put(struct drm_crtc *crtc);
1070 extern void drm_wait_one_vblank(struct drm_device *dev, unsigned int pipe);
1071 extern void drm_crtc_wait_one_vblank(struct drm_crtc *crtc);
1072 extern void drm_vblank_off(struct drm_device *dev, unsigned int pipe);
1073 extern void drm_vblank_on(struct drm_device *dev, unsigned int pipe);
1074 extern void drm_crtc_vblank_off(struct drm_crtc *crtc);
1075 extern void drm_crtc_vblank_reset(struct drm_crtc *crtc);
1076 extern void drm_crtc_vblank_on(struct drm_crtc *crtc);
1077 extern void drm_vblank_cleanup(struct drm_device *dev);
1079 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
1080 unsigned int pipe, int *max_error,
1081 struct timeval *vblank_time,
1083 const struct drm_crtc *refcrtc,
1084 const struct drm_display_mode *mode);
1085 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc,
1086 const struct drm_display_mode *mode);
1089 * drm_crtc_vblank_waitqueue - get vblank waitqueue for the CRTC
1090 * @crtc: which CRTC's vblank waitqueue to retrieve
1092 * This function returns a pointer to the vblank waitqueue for the CRTC.
1093 * Drivers can use this to implement vblank waits using wait_event() & co.
1095 static inline wait_queue_head_t *drm_crtc_vblank_waitqueue(struct drm_crtc *crtc)
1097 return &crtc->dev->vblank[drm_crtc_index(crtc)].queue;
1100 /* Modesetting support */
1101 extern void drm_vblank_pre_modeset(struct drm_device *dev, unsigned int pipe);
1102 extern void drm_vblank_post_modeset(struct drm_device *dev, unsigned int pipe);
1104 /* sysctl support (drm_sysctl.h) */
1105 extern int drm_sysctl_init(struct drm_device *dev);
1106 extern int drm_sysctl_cleanup(struct drm_device *dev);
1108 /* Locking IOCTL support (drm_drv.c) */
1109 int drm_lock(struct drm_device *dev, void *data,
1110 struct drm_file *file_priv);
1111 int drm_unlock(struct drm_device *dev, void *data,
1112 struct drm_file *file_priv);
1113 int drm_setversion(struct drm_device *dev, void *data,
1114 struct drm_file *file_priv);
1117 * These are exported to drivers so that they can implement fencing using
1118 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1121 extern int drm_i_have_hw_lock(struct drm_device *dev, struct drm_file *file_priv);
1123 /* Misc. IOCTL support (drm_ioctl.c) */
1124 int drm_noop(struct drm_device *dev, void *data,
1125 struct drm_file *file_priv);
1127 /* Cache management (drm_cache.c) */
1128 void drm_clflush_pages(struct vm_page *pages[], unsigned long num_pages);
1129 void drm_clflush_sg(struct sg_table *st);
1130 void drm_clflush_virt_range(void *addr, unsigned long length);
1132 /* DMA support (drm_dma.c) */
1133 int drm_dma(struct drm_device *dev, void *data, struct drm_file *file_priv);
1135 /* Stub support (drm_stub.h) */
1137 extern void drm_put_dev(struct drm_device *dev);
1138 extern void drm_unplug_dev(struct drm_device *dev);
1139 extern unsigned int drm_debug;
1140 extern bool drm_atomic;
1142 /* Scatter Gather Support (drm_scatter.c) */
1143 int drm_sg_alloc_ioctl(struct drm_device *dev, void *data,
1144 struct drm_file *file_priv);
1145 int drm_sg_free(struct drm_device *dev, void *data,
1146 struct drm_file *file_priv);
1148 /* consistent PCI memory functions (drm_pci.c) */
1149 extern struct drm_dma_handle *drm_pci_alloc(struct drm_device *dev, size_t size,
1151 void drm_pci_free(struct drm_device *dev, struct drm_dma_handle *dmah);
1153 /* sysfs support (drm_sysfs.c) */
1154 extern void drm_sysfs_hotplug_event(struct drm_device *dev);
1156 int drm_gem_mmap_single(struct drm_device *dev, vm_ooffset_t *offset,
1157 vm_size_t size, struct vm_object **obj_res, int nprot);
1158 void drm_gem_pager_dtr(void *obj);
1160 struct ttm_bo_device;
1161 int ttm_bo_mmap_single(struct ttm_bo_device *bdev, vm_ooffset_t *offset,
1162 vm_size_t size, struct vm_object **obj_res, int nprot);
1163 struct ttm_buffer_object;
1164 void ttm_bo_release_mmap(struct ttm_buffer_object *bo);
1166 void drm_device_lock_mtx(struct drm_device *dev);
1167 void drm_device_unlock_mtx(struct drm_device *dev);
1168 int drm_device_sleep_mtx(struct drm_device *dev, void *chan, int flags,
1169 const char *msg, int timeout);
1170 void drm_device_assert_mtx_locked(struct drm_device *dev);
1171 void drm_device_assert_mtx_unlocked(struct drm_device *dev);
1173 void drm_device_lock_struct(struct drm_device *dev);
1174 void drm_device_unlock_struct(struct drm_device *dev);
1175 int drm_device_sleep_struct(struct drm_device *dev, void *chan, int flags,
1176 const char *msg, int timeout);
1177 void drm_device_assert_struct_locked(struct drm_device *dev);
1178 void drm_device_assert_struct_unlocked(struct drm_device *dev);
1180 void drm_compat_locking_init(struct drm_device *dev);
1181 void drm_sleep_locking_init(struct drm_device *dev);
1183 /* XXX glue logic, should be done in drm_pci_init(), pending drm update */
1184 void drm_init_pdev(struct device *dev, struct pci_dev **pdev);
1185 void drm_fini_pdev(struct pci_dev **pdev);
1187 /* Inline replacements for drm_alloc and friends */
1188 static __inline__ void *
1189 drm_alloc(size_t size, struct malloc_type *area)
1191 return kmalloc(size, area, M_WAITOK | M_NULLOK);
1194 static __inline__ void *
1195 drm_calloc(size_t nmemb, size_t size, struct malloc_type *area)
1197 return kmalloc(size * nmemb, area, M_WAITOK | M_NULLOK | M_ZERO);
1200 static __inline__ void
1201 drm_free(void *pt, struct malloc_type *area)
1203 /* kfree is special!!! */
1208 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
1209 struct device *parent);
1210 void drm_dev_ref(struct drm_device *dev);
1211 void drm_dev_unref(struct drm_device *dev);
1212 int drm_dev_register(struct drm_device *dev, unsigned long flags);
1213 void drm_dev_unregister(struct drm_device *dev);
1214 int drm_dev_set_unique(struct drm_device *dev, const char *fmt, ...);
1216 /* FreeBSD compatibility macros */
1217 #define VM_OBJECT_WLOCK(object) VM_OBJECT_LOCK(object)
1218 #define VM_OBJECT_WUNLOCK(object) VM_OBJECT_UNLOCK(object)
1221 static __inline__ int drm_pci_device_is_agp(struct drm_device *dev)
1223 if (dev->driver->device_is_agp != NULL) {
1224 int err = (*dev->driver->device_is_agp) (dev);
1231 return (pci_find_extcap(dev->dev, PCIY_AGP, NULL) == 0);
1234 #define DRM_PCIE_SPEED_25 1
1235 #define DRM_PCIE_SPEED_50 2
1236 #define DRM_PCIE_SPEED_80 4
1238 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1241 #define drm_can_sleep() (HZ & 1)
1243 #endif /* __KERNEL__ */
1244 #endif /* _DRM_P_H_ */