3 * Private header for Direct Rendering Manager
5 * \author Rickard E. (Rik) Faith <faith@valinux.com>
6 * \author Gareth Hughes <gareth@valinux.com>
10 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
11 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
12 * Copyright (c) 2009-2010, Code Aurora Forum.
13 * All rights reserved.
15 * Permission is hereby granted, free of charge, to any person obtaining a
16 * copy of this software and associated documentation files (the "Software"),
17 * to deal in the Software without restriction, including without limitation
18 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
19 * and/or sell copies of the Software, and to permit persons to whom the
20 * Software is furnished to do so, subject to the following conditions:
22 * The above copyright notice and this permission notice (including the next
23 * paragraph) shall be included in all copies or substantial portions of the
26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
29 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
30 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
31 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
32 * OTHER DEALINGS IN THE SOFTWARE.
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
41 #if defined(_KERNEL) || defined(__KERNEL__)
43 #include <sys/param.h>
44 #include <sys/queue.h>
45 #include <sys/malloc.h>
46 #include <sys/kernel.h>
48 #include <sys/module.h>
49 #include <sys/systm.h>
51 #include <sys/sglist.h>
56 #include <sys/fcntl.h>
58 #include <sys/filio.h>
59 #include <sys/rwlock.h>
60 #include <sys/selinfo.h>
61 #include <sys/sysctl.h>
63 #include <sys/queue.h>
64 #include <sys/signalvar.h>
67 #include <sys/taskqueue.h>
71 #include <vm/vm_extern.h>
72 #include <vm/vm_kern.h>
73 #include <vm/vm_map.h>
74 #include <vm/vm_object.h>
75 #include <vm/vm_page.h>
76 #include <vm/vm_pager.h>
77 #include <vm/vm_param.h>
78 #include <vm/vm_phys.h>
79 #include <machine/param.h>
80 #include <machine/pmap.h>
81 #include <machine/bus.h>
82 #include <machine/resource.h>
83 #if defined(__i386__) || defined(__amd64__)
84 #include <machine/specialreg.h>
86 #include <machine/sysarch.h>
87 #include <sys/endian.h>
90 #include <sys/memrange.h>
91 #include <dev/agp/agpvar.h>
92 #include <sys/agpio.h>
93 #include <sys/mutex.h>
94 #include <dev/pci/pcivar.h>
95 #include <dev/pci/pcireg.h>
96 #include <sys/selinfo.h>
99 #include <dev/drm2/drm.h>
100 #include <dev/drm2/drm_sarea.h>
102 #include <dev/drm2/drm_atomic.h>
103 #include <dev/drm2/drm_linux_list.h>
104 #include <dev/drm2/drm_gem_names.h>
106 #include <dev/drm2/drm_os_freebsd.h>
108 #define __OS_HAS_AGP (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
109 #define __OS_HAS_MTRR (defined(CONFIG_MTRR))
114 #include <dev/drm2/drm_hashtab.h>
115 #include <dev/drm2/drm_mm.h>
117 #include "opt_compat.h"
119 #include "opt_syscons.h"
122 #define DRM_DEBUG_DEFAULT_ON 1
123 #endif /* DRM_DEBUG */
125 #define DRM_DEBUGBITS_DEBUG 0x1
126 #define DRM_DEBUGBITS_KMS 0x2
127 #define DRM_DEBUGBITS_FAILED_IOCTL 0x4
132 /***********************************************************************/
133 /** \name DRM template customization defaults */
136 /* driver capabilities and requirements mask */
137 #define DRIVER_USE_AGP 0x1
138 #define DRIVER_REQUIRE_AGP 0x2
139 #define DRIVER_USE_MTRR 0x4
140 #define DRIVER_PCI_DMA 0x8
141 #define DRIVER_SG 0x10
142 #define DRIVER_HAVE_DMA 0x20
143 #define DRIVER_HAVE_IRQ 0x40
144 #define DRIVER_IRQ_SHARED 0x80
145 #define DRIVER_IRQ_VBL 0x100
146 #define DRIVER_DMA_QUEUE 0x200
147 #define DRIVER_FB_DMA 0x400
148 #define DRIVER_IRQ_VBL2 0x800
149 #define DRIVER_GEM 0x1000
150 #define DRIVER_MODESET 0x2000
151 #define DRIVER_PRIME 0x4000
153 #define DRIVER_BUS_PCI 0x1
154 #define DRIVER_BUS_PLATFORM 0x2
155 #define DRIVER_BUS_USB 0x3
157 /***********************************************************************/
158 /** \name Begin the DRM... */
161 #define DRM_DEBUG_CODE 2 /**< Include debugging code if > 1, then
162 also include looping detection. */
164 #define DRM_MAGIC_HASH_ORDER 4 /**< Size of key hash table. Must be power of 2. */
165 #define DRM_KERNEL_CONTEXT 0 /**< Change drm_resctx if changed */
166 #define DRM_RESERVED_CONTEXTS 1 /**< Change drm_resctx if changed */
167 #define DRM_LOOPING_LIMIT 5000000
168 #define DRM_TIME_SLICE (HZ/20) /**< Time slice for GLXContexts */
169 #define DRM_LOCK_SLICE 1 /**< Time slice for lock, in jiffies */
171 #define DRM_FLAG_DEBUG 0x01
173 #define DRM_MAX_CTXBITMAP (PAGE_SIZE * 8)
174 #define DRM_MAP_HASH_OFFSET 0x10000000
178 /***********************************************************************/
179 /** \name Macros to make printk easier */
185 * \param fmt printf() like format string.
186 * \param arg arguments
188 #define DRM_ERROR(fmt, ...) \
189 printf("error: [" DRM_NAME ":pid%d:%s] *ERROR* " fmt, \
190 DRM_CURRENTPID, __func__ , ##__VA_ARGS__)
192 #define DRM_WARNING(fmt, ...) printf("warning: [" DRM_NAME "] " fmt , ##__VA_ARGS__)
193 #define DRM_INFO(fmt, ...) printf("info: [" DRM_NAME "] " fmt , ##__VA_ARGS__)
198 * \param fmt printf() like format string.
199 * \param arg arguments
201 #define DRM_DEBUG(fmt, ...) do { \
202 if ((drm_debug & DRM_DEBUGBITS_DEBUG) != 0) \
203 printf("[" DRM_NAME ":pid%d:%s] " fmt, DRM_CURRENTPID, \
204 __func__ , ##__VA_ARGS__); \
207 #define DRM_DEBUG_DRIVER(fmt, ...) do { \
208 if ((drm_debug & DRM_DEBUGBITS_KMS) != 0) \
209 printf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
210 __func__ , ##__VA_ARGS__); \
213 #define DRM_DEBUG_KMS(fmt, ...) do { \
214 if ((drm_debug & DRM_DEBUGBITS_KMS) != 0) \
215 printf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
216 __func__ , ##__VA_ARGS__); \
219 #define DRM_LOG(fmt, ...) do { \
220 if ((drm_debug & DRM_DEBUGBITS_KMS) != 0) \
221 printf("[" DRM_NAME "]:pid%d:%s]" fmt, DRM_CURRENTPID, \
222 __func__ , ##__VA_ARGS__); \
225 #define DRM_LOG_KMS(fmt, ...) do { \
226 if ((drm_debug & DRM_DEBUGBITS_KMS) != 0) \
227 printf("[" DRM_NAME "]:KMS:pid%d:%s]" fmt, DRM_CURRENTPID,\
228 __func__ , ##__VA_ARGS__); \
231 #define DRM_LOG_MODE(fmt, ...) do { \
232 if ((drm_debug & DRM_DEBUGBITS_KMS) != 0) \
233 printf("[" DRM_NAME "]:pid%d:%s]" fmt, DRM_CURRENTPID, \
234 __func__ , ##__VA_ARGS__); \
237 #define DRM_LOG_DRIVER(fmt, ...) do { \
238 if ((drm_debug & DRM_DEBUGBITS_KMS) != 0) \
239 printf("[" DRM_NAME "]:KMS:pid%d:%s]" fmt, DRM_CURRENTPID,\
240 __func__ , ##__VA_ARGS__); \
246 /***********************************************************************/
247 /** \name Internal types and structures */
250 #define DRM_ARRAY_SIZE(x) ARRAY_SIZE(x)
252 #define DRM_LEFTCOUNT(x) (((x)->rp + (x)->count - (x)->wp) % ((x)->count + 1))
253 #define DRM_BUFCOUNT(x) ((x)->count - DRM_LEFTCOUNT(x))
255 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
258 * Test that the hardware lock is held by the caller, returning otherwise.
260 * \param dev DRM device.
261 * \param filp file pointer of the caller.
263 #define LOCK_TEST_WITH_RETURN( dev, _file_priv ) \
265 if (!_DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock) || \
266 _file_priv->master->lock.file_priv != _file_priv) { \
267 DRM_ERROR( "%s called without lock held, held %d owner %p %p\n",\
268 __func__, _DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock),\
269 _file_priv->master->lock.file_priv, _file_priv); \
275 * Ioctl function type.
277 * \param inode device inode.
278 * \param file_priv DRM file private pointer.
279 * \param cmd command.
280 * \param arg argument.
282 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
283 struct drm_file *file_priv);
285 #define DRM_IOCTL_NR(n) ((n) & 0xff)
286 #define DRM_MAJOR 226
289 #define DRM_MASTER 0x2
290 #define DRM_ROOT_ONLY 0x4
291 #define DRM_CONTROL_ALLOW 0x8
292 #define DRM_UNLOCKED 0x10
294 struct drm_ioctl_desc {
298 unsigned int cmd_drv;
302 * Creates a driver or general drm_ioctl_desc array entry for the given
303 * ioctl, for use by drm_ioctl().
306 #define DRM_IOCTL_DEF(ioctl, _func, _flags) \
307 [DRM_IOCTL_NR(ioctl)] = {.cmd = ioctl, .func = _func, .flags = _flags, .cmd_drv = 0}
309 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags) \
310 [DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl}
312 struct drm_magic_entry {
313 struct list_head head;
314 struct drm_hash_item hash_item;
315 struct drm_file *priv;
322 int idx; /**< Index into master buflist */
323 int total; /**< Buffer size */
324 int order; /**< log-base-2(total) */
325 int used; /**< Amount of buffer in use (for DMA) */
326 unsigned long offset; /**< Byte offset (used internally) */
327 void *address; /**< Address of buffer */
328 unsigned long bus_address; /**< Bus address of buffer */
329 struct drm_buf *next; /**< Kernel-only: used for free list */
330 __volatile__ int waiting; /**< On kernel DMA queue */
331 __volatile__ int pending; /**< On hardware DMA queue */
332 struct drm_file *file_priv; /**< Private of holding file descr */
333 int context; /**< Kernel queue for this buffer */
334 int while_locked; /**< Dispatch this buffer while locked */
342 } list; /**< Which list we're on */
344 int dev_priv_size; /**< Size of buffer private storage */
345 void *dev_private; /**< Per-buffer private storage */
348 struct drm_freelist {
349 int initialized; /**< Freelist in use */
350 atomic_t count; /**< Number of free buffers */
351 struct drm_buf *next; /**< End pointer */
353 #ifdef FREEBSD_NOTYET
354 wait_queue_head_t waiting; /**< Processes waiting on free bufs */
355 #endif /* defined(FREEBSD_NOTYET) */
356 int low_mark; /**< Low water mark */
357 int high_mark; /**< High water mark */
358 #ifdef FREEBSD_NOTYET
359 atomic_t wfh; /**< If waiting for high mark */
361 #endif /* defined(FREEBSD_NOTYET) */
364 typedef struct drm_dma_handle {
372 * Buffer entry. There is one of this for each buffer size order.
374 struct drm_buf_entry {
375 int buf_size; /**< size */
376 int buf_count; /**< number of buffers */
377 struct drm_buf *buflist; /**< buffer list */
380 struct drm_dma_handle **seglist;
382 struct drm_freelist freelist;
385 /* Event queued up for userspace to read */
386 struct drm_pending_event {
387 struct drm_event *event;
388 struct list_head link;
389 struct drm_file *file_priv;
390 pid_t pid; /* pid of requester, no guarantee it's valid by the time
391 we deliver the event, for tracing only */
392 void (*destroy)(struct drm_pending_event *event);
395 /* initial implementaton using a linked list - todo hashtab */
396 struct drm_prime_file_private {
397 struct list_head head;
406 unsigned long ioctl_count;
407 struct list_head lhead;
408 struct drm_minor *minor;
409 unsigned long lock_count;
412 struct drm_gem_names object_names;
414 int is_master; /* this file private is a master for a minor */
415 struct drm_master *master; /* master this node is currently associated with
416 N.B. not always minor->master */
417 struct list_head fbs;
419 struct selinfo event_poll;
420 struct list_head event_list;
423 struct drm_prime_file_private prime;
429 struct drm_lock_data {
430 struct drm_hw_lock *hw_lock; /**< Hardware lock */
431 /** Private of lock holder's file (NULL=kernel) */
432 struct drm_file *file_priv;
433 wait_queue_head_t lock_queue; /**< Queue of blocked processes */
434 unsigned long lock_time; /**< Time of last lock in jiffies */
436 uint32_t kernel_waiters;
437 uint32_t user_waiters;
444 struct drm_device_dma {
446 struct drm_buf_entry bufs[DRM_MAX_ORDER + 1]; /**< buffers, grouped by their size order */
447 int buf_count; /**< total number of buffers */
448 struct drm_buf **buflist; /**< Vector of pointers into drm_device_dma::bufs */
450 int page_count; /**< number of pages */
451 unsigned long *pagelist; /**< page list */
452 unsigned long byte_count;
454 _DRM_DMA_USE_AGP = 0x01,
455 _DRM_DMA_USE_SG = 0x02,
456 _DRM_DMA_USE_FB = 0x04,
457 _DRM_DMA_USE_PCI_RO = 0x08
463 * AGP memory entry. Stored as a doubly linked list.
466 unsigned long handle; /**< handle */
468 unsigned long bound; /**< address */
470 struct list_head head;
476 * \sa drm_agp_init() and drm_device::agp.
478 struct drm_agp_head {
479 DRM_AGP_KERN agp_info; /**< AGP device information */
480 struct list_head memory;
481 unsigned long mode; /**< AGP mode */
483 int enabled; /**< whether the AGP bus as been enabled */
484 int acquired; /**< whether the AGP device has been acquired */
487 int cant_use_aperture;
491 * Scatter-gather memory.
501 struct drm_hw_lock *lock;
505 * Kernel side of a mapping
507 #define DRM_MAP_HANDLE_BITS (sizeof(void *) == 4 ? 4 : 24)
508 #define DRM_MAP_HANDLE_SHIFT (sizeof(void *) * 8 - DRM_MAP_HANDLE_BITS)
510 struct drm_local_map {
511 resource_size_t offset; /**< Requested physical address (0 for SAREA)*/
512 unsigned long size; /**< Requested physical size (bytes) */
513 enum drm_map_type type; /**< Type of memory to map */
514 enum drm_map_flags flags; /**< Flags */
515 void *handle; /**< User-space: "Handle" to pass to mmap() */
516 /**< Kernel-space: kernel-virtual address */
517 int mtrr; /**< MTRR slot used */
520 drm_dma_handle_t *dmah;
523 typedef struct drm_local_map drm_local_map_t;
528 struct drm_map_list {
529 struct list_head head; /**< list head */
530 struct drm_hash_item hash;
531 struct drm_local_map *map; /**< mapping */
533 struct drm_master *master;
534 struct drm_mm_node *file_offset_node; /**< fake offset */
538 * Context handle list
540 struct drm_ctx_list {
541 struct list_head head; /**< list head */
542 drm_context_t handle; /**< context handle */
543 struct drm_file *tag; /**< associated fd private data */
546 /* location of GART table */
547 #define DRM_ATI_GART_MAIN 1
548 #define DRM_ATI_GART_FB 2
550 #define DRM_ATI_GART_PCI 1
551 #define DRM_ATI_GART_PCIE 2
552 #define DRM_ATI_GART_IGP 3
554 struct drm_ati_pcigart_info {
555 int gart_table_location;
559 dma_addr_t table_mask;
560 struct drm_dma_handle *table_handle;
561 struct drm_local_map mapping;
563 struct drm_dma_handle *dmah; /* handle for ATI PCIGART table FIXME */
567 * GEM specific mm private for tracking GEM objects
570 struct unrhdr *idxunr;
571 struct drm_open_hash offset_hash; /**< User token hash table for maps */
575 * This structure defines the drm_mm memory object, which will be used by the
576 * DRM for its buffer objects.
578 struct drm_gem_object {
579 /** Reference count of this object */
582 /** Handle count of this object. Each handle also holds a reference */
583 atomic_t handle_count; /* number of handles on this object */
585 /** Related drm device */
586 struct drm_device *dev;
588 /** File representing the shmem storage: filp in Linux parlance */
591 /* Mapping info for this object */
593 struct drm_hash_item map_list;
596 * Size of the object, in bytes. Immutable over the object's
602 * Global name for this object, starts at 1. 0 means unnamed.
603 * Access is covered by the object_name_lock in the related drm_device
608 * Memory domains. These monitor which caches contain read/write data
609 * related to the object. When transitioning from one set of domains
610 * to another, the driver is called to ensure that caches are suitably
611 * flushed and invalidated
613 uint32_t read_domains;
614 uint32_t write_domain;
617 * While validating an exec operation, the
618 * new read/write domain values are computed here.
619 * They will be transferred to the above values
620 * at the point that any cache flushing occurs
622 uint32_t pending_read_domains;
623 uint32_t pending_write_domain;
625 void *driver_private;
627 #ifdef FREEBSD_NOTYET
628 /* dma buf exported from this GEM object */
629 struct dma_buf *export_dma_buf;
631 /* dma buf attachment backing this object */
632 struct dma_buf_attachment *import_attach;
633 #endif /* FREEBSD_NOTYET */
636 #include <dev/drm2/drm_crtc.h>
638 /* per-master structure */
641 u_int refcount; /* refcount for this master */
643 struct list_head head; /**< each minor contains a list of masters */
644 struct drm_minor *minor; /**< link back to minor we are a master for */
646 char *unique; /**< Unique identifier: e.g., busid */
647 int unique_len; /**< Length of unique field */
648 int unique_size; /**< amount allocated */
650 int blocked; /**< Blocked due to VC switch? */
652 /** \name Authentication */
654 struct drm_open_hash magiclist;
655 struct list_head magicfree;
658 struct drm_lock_data lock; /**< Information on hardware lock */
660 void *driver_priv; /**< Private structure for driver to use */
663 /* Size of ringbuffer for vblank timestamps. Just double-buffer
664 * in initial implementation.
666 #define DRM_VBLANKTIME_RBSIZE 2
668 /* Flags and return codes for get_vblank_timestamp() driver function. */
669 #define DRM_CALLED_FROM_VBLIRQ 1
670 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
671 #define DRM_VBLANKTIME_INVBL (1 << 1)
673 /* get_scanout_position() return flags */
674 #define DRM_SCANOUTPOS_VALID (1 << 0)
675 #define DRM_SCANOUTPOS_INVBL (1 << 1)
676 #define DRM_SCANOUTPOS_ACCURATE (1 << 2)
680 int (*get_irq)(struct drm_device *dev);
681 void (*free_irq)(struct drm_device *dev);
682 const char *(*get_name)(struct drm_device *dev);
683 int (*set_busid)(struct drm_device *dev, struct drm_master *master);
684 int (*set_unique)(struct drm_device *dev, struct drm_master *master,
685 struct drm_unique *unique);
686 int (*irq_by_busid)(struct drm_device *dev, struct drm_irq_busid *p);
687 /* hooks that are for PCI */
688 int (*agp_init)(struct drm_device *dev);
693 * DRM driver structure. This structure represent the common code for
694 * a family of cards. There will one drm_device for each card present
698 int (*load) (struct drm_device *, unsigned long flags);
699 int (*firstopen) (struct drm_device *);
700 int (*open) (struct drm_device *, struct drm_file *);
701 void (*preclose) (struct drm_device *, struct drm_file *file_priv);
702 void (*postclose) (struct drm_device *, struct drm_file *);
703 void (*lastclose) (struct drm_device *);
704 int (*unload) (struct drm_device *);
705 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
706 int (*dma_quiescent) (struct drm_device *);
707 int (*context_dtor) (struct drm_device *dev, int context);
710 * get_vblank_counter - get raw hardware vblank counter
712 * @crtc: counter to fetch
714 * Driver callback for fetching a raw hardware vblank counter for @crtc.
715 * If a device doesn't have a hardware counter, the driver can simply
716 * return the value of drm_vblank_count. The DRM core will account for
717 * missed vblank events while interrupts where disabled based on system
720 * Wraparound handling and loss of events due to modesetting is dealt
721 * with in the DRM core code.
724 * Raw vblank counter value.
726 u32 (*get_vblank_counter) (struct drm_device *dev, int crtc);
729 * enable_vblank - enable vblank interrupt events
731 * @crtc: which irq to enable
733 * Enable vblank interrupts for @crtc. If the device doesn't have
734 * a hardware vblank counter, this routine should be a no-op, since
735 * interrupts will have to stay on to keep the count accurate.
738 * Zero on success, appropriate errno if the given @crtc's vblank
739 * interrupt cannot be enabled.
741 int (*enable_vblank) (struct drm_device *dev, int crtc);
744 * disable_vblank - disable vblank interrupt events
746 * @crtc: which irq to enable
748 * Disable vblank interrupts for @crtc. If the device doesn't have
749 * a hardware vblank counter, this routine should be a no-op, since
750 * interrupts will have to stay on to keep the count accurate.
752 void (*disable_vblank) (struct drm_device *dev, int crtc);
755 * Called by \c drm_device_is_agp. Typically used to determine if a
756 * card is really attached to AGP or not.
758 * \param dev DRM device handle
761 * One of three values is returned depending on whether or not the
762 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
763 * (return of 1), or may or may not be AGP (return of 2).
765 int (*device_is_agp) (struct drm_device *dev);
768 * Called by vblank timestamping code.
770 * Return the current display scanout position from a crtc.
772 * \param dev DRM device.
773 * \param crtc Id of the crtc to query.
774 * \param *vpos Target location for current vertical scanout position.
775 * \param *hpos Target location for current horizontal scanout position.
777 * Returns vpos as a positive number while in active scanout area.
778 * Returns vpos as a negative number inside vblank, counting the number
779 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
780 * until start of active scanout / end of vblank."
782 * \return Flags, or'ed together as follows:
784 * DRM_SCANOUTPOS_VALID = Query successful.
785 * DRM_SCANOUTPOS_INVBL = Inside vblank.
786 * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
787 * this flag means that returned position may be offset by a constant
788 * but unknown small number of scanlines wrt. real scanout position.
791 int (*get_scanout_position) (struct drm_device *dev, int crtc,
792 int *vpos, int *hpos);
795 * Called by \c drm_get_last_vbltimestamp. Should return a precise
796 * timestamp when the most recent VBLANK interval ended or will end.
798 * Specifically, the timestamp in @vblank_time should correspond as
799 * closely as possible to the time when the first video scanline of
800 * the video frame after the end of VBLANK will start scanning out,
801 * the time immediately after end of the VBLANK interval. If the
802 * @crtc is currently inside VBLANK, this will be a time in the future.
803 * If the @crtc is currently scanning out a frame, this will be the
804 * past start time of the current scanout. This is meant to adhere
805 * to the OpenML OML_sync_control extension specification.
807 * \param dev dev DRM device handle.
808 * \param crtc crtc for which timestamp should be returned.
809 * \param *max_error Maximum allowable timestamp error in nanoseconds.
810 * Implementation should strive to provide timestamp
811 * with an error of at most *max_error nanoseconds.
812 * Returns true upper bound on error for timestamp.
813 * \param *vblank_time Target location for returned vblank timestamp.
814 * \param flags 0 = Defaults, no special treatment needed.
815 * \param DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
816 * irq handler. Some drivers need to apply some workarounds
817 * for gpu-specific vblank irq quirks if flag is set.
820 * Zero if timestamping isn't supported in current display mode or a
821 * negative number on failure. A positive status code on success,
822 * which describes how the vblank_time timestamp was computed.
824 int (*get_vblank_timestamp) (struct drm_device *dev, int crtc,
826 struct timeval *vblank_time,
829 /* these have to be filled in */
831 irqreturn_t(*irq_handler) (DRM_IRQ_ARGS);
832 void (*irq_preinstall) (struct drm_device *dev);
833 int (*irq_postinstall) (struct drm_device *dev);
834 void (*irq_uninstall) (struct drm_device *dev);
835 void (*set_version) (struct drm_device *dev,
836 struct drm_set_version *sv);
838 /* Master routines */
839 int (*master_create)(struct drm_device *dev, struct drm_master *master);
840 void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
842 * master_set is called whenever the minor master is set.
843 * master_drop is called whenever the minor master is dropped.
846 int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
848 void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv,
852 * Driver-specific constructor for drm_gem_objects, to set up
853 * obj->driver_private.
855 * Returns 0 on success.
857 int (*gem_init_object) (struct drm_gem_object *obj);
858 void (*gem_free_object) (struct drm_gem_object *obj);
859 int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
860 void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
862 #ifdef FREEBSD_NOTYET
864 /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
865 int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
866 uint32_t handle, uint32_t flags, int *prime_fd);
867 /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
868 int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
869 int prime_fd, uint32_t *handle);
870 /* export GEM -> dmabuf */
871 struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
872 struct drm_gem_object *obj, int flags);
873 /* import dmabuf -> GEM */
874 struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
875 struct dma_buf *dma_buf);
876 #endif /* defined(FREEBSD_NOTYET) */
878 /* dumb alloc support */
879 int (*dumb_create)(struct drm_file *file_priv,
880 struct drm_device *dev,
881 struct drm_mode_create_dumb *args);
882 int (*dumb_map_offset)(struct drm_file *file_priv,
883 struct drm_device *dev, uint32_t handle,
885 int (*dumb_destroy)(struct drm_file *file_priv,
886 struct drm_device *dev,
889 /* Driver private ops for this object */
890 struct cdev_pager_ops *gem_pager_ops;
892 int (*sysctl_init)(struct drm_device *dev,
893 struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
894 void (*sysctl_cleanup)(struct drm_device *dev);
905 struct drm_ioctl_desc *ioctls;
908 #ifdef COMPAT_FREEBSD32
909 struct drm_ioctl_desc *compat_ioctls;
910 int *num_compat_ioctls;
916 #define DRM_MINOR_UNASSIGNED 0
917 #define DRM_MINOR_LEGACY 1
918 #define DRM_MINOR_CONTROL 2
919 #define DRM_MINOR_RENDER 3
922 * DRM minor structure. This structure represents a drm minor number.
925 int index; /**< Minor device number */
926 int type; /**< Control or render */
927 struct cdev *device; /**< Device number for mknod */
928 device_t kdev; /**< OS device */
929 struct drm_device *dev;
931 struct drm_master *master; /* currently active master for this node */
932 struct list_head master_list;
933 struct drm_mode_group mode_group;
935 struct sigio *buf_sigio; /* Processes waiting for SIGIO */
938 /* mode specified on the command line */
939 struct drm_cmdline_mode {
941 bool refresh_specified;
950 enum drm_connector_force force;
954 struct drm_pending_vblank_event {
955 struct drm_pending_event base;
957 struct drm_event_vblank event;
961 * DRM device structure. This structure represent a complete card that
962 * may contain multiple heads.
965 int if_version; /**< Highest interface version set */
969 struct mtx count_lock; /**< For inuse, drm_device::open_count, drm_device::buf_use */
970 struct sx dev_struct_lock; /**< For others */
973 /** \name Usage Counters */
975 int open_count; /**< Outstanding files open */
976 atomic_t ioctl_count; /**< Outstanding IOCTLs pending */
977 atomic_t vma_count; /**< Outstanding vma areas open */
978 int buf_use; /**< Buffers in use -- cannot alloc */
979 atomic_t buf_alloc; /**< Buffer allocation in progress */
982 /** \name Performance counters */
984 unsigned long counters;
985 enum drm_stat_type types[15];
989 struct list_head filelist;
991 /** \name Memory management */
993 struct list_head maplist; /**< Linked list of regions */
994 int map_count; /**< Number of mappable regions */
995 struct drm_open_hash map_hash; /**< User token hash table for maps */
997 /** \name Context handle management */
999 struct list_head ctxlist; /**< Linked list of context handles */
1000 int ctx_count; /**< Number of context handles */
1001 struct mtx ctxlist_mutex; /**< For ctxlist */
1002 drm_local_map_t **context_sareas;
1004 unsigned long *ctx_bitmap;
1008 /** \name DMA support */
1010 struct drm_device_dma *dma; /**< Optional pointer for DMA support */
1013 /** \name Context support */
1015 int irq_enabled; /**< True if irq handler is enabled */
1016 atomic_t context_flag; /**< Context swapping flag */
1017 atomic_t interrupt_flag; /**< Interruption handler flag */
1018 atomic_t dma_flag; /**< DMA dispatch flag */
1019 wait_queue_head_t context_wait; /**< Processes waiting on ctx switch */
1020 int last_checked; /**< Last context checked for DMA */
1021 int last_context; /**< Last current context */
1022 unsigned long last_switch; /**< jiffies at last context switch */
1025 /** \name VBLANK IRQ support */
1029 * At load time, disabling the vblank interrupt won't be allowed since
1030 * old clients may not call the modeset ioctl and therefore misbehave.
1031 * Once the modeset ioctl *has* been called though, we can safely
1032 * disable them when unused.
1034 int vblank_disable_allowed;
1036 atomic_t *_vblank_count; /**< number of VBLANK interrupts (driver must alloc the right number of counters) */
1037 struct timeval *_vblank_time; /**< timestamp of current vblank_count (drivers must alloc right number of fields) */
1038 struct mtx vblank_time_lock; /**< Protects vblank count and time updates during vblank enable/disable */
1039 struct mtx vbl_lock;
1040 atomic_t *vblank_refcount; /* number of users of vblank interruptsper crtc */
1041 u32 *last_vblank; /* protected by dev->vbl_lock, used */
1042 /* for wraparound handling */
1043 int *vblank_enabled; /* so we don't call enable more than
1045 int *vblank_inmodeset; /* Display driver is setting mode */
1046 u32 *last_vblank_wait; /* Last vblank seqno waited per CRTC */
1047 struct callout vblank_disable_callout;
1049 u32 max_vblank_count; /**< size of vblank counter register */
1054 struct list_head vblank_event_list;
1055 struct mtx event_lock;
1059 struct drm_agp_head *agp; /**< AGP data */
1061 device_t dev; /* Device instance from newbus */
1062 uint16_t pci_device; /* PCI device id */
1063 uint16_t pci_vendor; /* PCI vendor id */
1064 uint16_t pci_subdevice; /* PCI subsystem device id */
1065 uint16_t pci_subvendor; /* PCI subsystem vendor id */
1067 struct drm_sg_mem *sg; /**< Scatter gather memory */
1068 unsigned int num_crtcs; /**< Number of CRTCs on this device */
1069 void *dev_private; /**< device private data */
1071 struct drm_sigdata sigdata; /**< For block_all_signals */
1074 struct drm_driver *driver;
1075 struct drm_local_map *agp_buffer_map;
1076 unsigned int agp_buffer_token;
1077 struct drm_minor *control; /**< Control node for card */
1078 struct drm_minor *primary; /**< render type primary screen head */
1080 struct drm_mode_config mode_config; /**< Current mode config */
1082 /** \name GEM information */
1084 struct sx object_name_lock;
1085 struct drm_gem_names object_names;
1087 int switch_power_state;
1089 atomic_t unplugged; /* device has been unplugged or gone away */
1092 struct mtx dma_lock; /* protects dev->dma */
1093 struct mtx irq_lock; /* protects irq condition checks */
1095 /* Context support */
1096 int irq; /* Interrupt used by board */
1097 int msi_enabled; /* MSI enabled */
1098 int irqrid; /* Interrupt used by board */
1099 struct resource *irqr; /* Resource for interrupt used by board */
1100 void *irqh; /* Handle from bus_setup_intr */
1102 /* Storage of resource pointers for drm_get_resource_* */
1103 #define DRM_MAX_PCI_RESOURCE 6
1104 struct resource *pcir[DRM_MAX_PCI_RESOURCE];
1105 int pcirid[DRM_MAX_PCI_RESOURCE];
1106 struct mtx pcir_lock;
1113 /* Sysctl support */
1114 struct drm_sysctl_info *sysctl;
1115 int sysctl_node_idx;
1119 void *sysctl_private;
1120 char busid_str[128];
1123 drm_pci_id_list_t *id_entry; /* PCI ID, name, and chipset private */
1126 #define DRM_SWITCH_POWER_ON 0
1127 #define DRM_SWITCH_POWER_OFF 1
1128 #define DRM_SWITCH_POWER_CHANGING 2
1130 static __inline__ int drm_core_check_feature(struct drm_device *dev,
1133 return ((dev->driver->driver_features & feature) ? 1 : 0);
1136 static inline int drm_dev_to_irq(struct drm_device *dev)
1138 return dev->driver->bus->get_irq(dev);
1143 static inline int drm_core_has_AGP(struct drm_device *dev)
1145 return drm_core_check_feature(dev, DRIVER_USE_AGP);
1148 #define drm_core_has_AGP(dev) (0)
1152 static inline int drm_core_has_MTRR(struct drm_device *dev)
1154 return drm_core_check_feature(dev, DRIVER_USE_MTRR);
1157 #define DRM_MTRR_WC MDF_WRITECOMBINE
1159 int drm_mtrr_add(unsigned long offset, unsigned long size, unsigned int flags);
1160 int drm_mtrr_del(int handle, unsigned long offset, unsigned long size, unsigned int flags);
1163 #define drm_core_has_MTRR(dev) (0)
1165 #define DRM_MTRR_WC 0
1167 static inline int drm_mtrr_add(unsigned long offset, unsigned long size,
1173 static inline int drm_mtrr_del(int handle, unsigned long offset,
1174 unsigned long size, unsigned int flags)
1180 /******************************************************************/
1181 /** \name Internal function definitions */
1184 /* Driver support (drm_drv.h) */
1185 d_ioctl_t drm_ioctl;
1186 extern int drm_lastclose(struct drm_device *dev);
1188 /* Device support (drm_fops.h) */
1189 extern struct sx drm_global_mutex;
1192 extern void drm_release(void *data);
1194 /* Mapping support (drm_vm.h) */
1196 int drm_mmap_single(struct cdev *kdev, vm_ooffset_t *offset,
1197 vm_size_t size, struct vm_object **obj_res, int nprot);
1200 /* Memory management support (drm_memory.h) */
1201 extern void drm_free_agp(DRM_AGP_MEM * handle, int pages);
1202 extern int drm_bind_agp(DRM_AGP_MEM * handle, unsigned int start);
1203 #ifdef FREEBSD_NOTYET
1204 extern DRM_AGP_MEM *drm_agp_bind_pages(struct drm_device *dev,
1205 struct page **pages,
1206 unsigned long num_pages,
1207 uint32_t gtt_offset,
1209 #endif /* FREEBSD_NOTYET */
1210 extern int drm_unbind_agp(DRM_AGP_MEM * handle);
1212 /* Misc. IOCTL support (drm_ioctl.h) */
1213 extern int drm_irq_by_busid(struct drm_device *dev, void *data,
1214 struct drm_file *file_priv);
1215 extern int drm_getunique(struct drm_device *dev, void *data,
1216 struct drm_file *file_priv);
1217 extern int drm_setunique(struct drm_device *dev, void *data,
1218 struct drm_file *file_priv);
1219 extern int drm_getmap(struct drm_device *dev, void *data,
1220 struct drm_file *file_priv);
1221 extern int drm_getclient(struct drm_device *dev, void *data,
1222 struct drm_file *file_priv);
1223 extern int drm_getstats(struct drm_device *dev, void *data,
1224 struct drm_file *file_priv);
1225 extern int drm_getcap(struct drm_device *dev, void *data,
1226 struct drm_file *file_priv);
1227 extern int drm_setversion(struct drm_device *dev, void *data,
1228 struct drm_file *file_priv);
1229 extern int drm_noop(struct drm_device *dev, void *data,
1230 struct drm_file *file_priv);
1232 /* Context IOCTL support (drm_context.h) */
1233 extern int drm_resctx(struct drm_device *dev, void *data,
1234 struct drm_file *file_priv);
1235 extern int drm_addctx(struct drm_device *dev, void *data,
1236 struct drm_file *file_priv);
1237 extern int drm_modctx(struct drm_device *dev, void *data,
1238 struct drm_file *file_priv);
1239 extern int drm_getctx(struct drm_device *dev, void *data,
1240 struct drm_file *file_priv);
1241 extern int drm_switchctx(struct drm_device *dev, void *data,
1242 struct drm_file *file_priv);
1243 extern int drm_newctx(struct drm_device *dev, void *data,
1244 struct drm_file *file_priv);
1245 extern int drm_rmctx(struct drm_device *dev, void *data,
1246 struct drm_file *file_priv);
1248 extern int drm_ctxbitmap_init(struct drm_device *dev);
1249 extern void drm_ctxbitmap_cleanup(struct drm_device *dev);
1250 extern void drm_ctxbitmap_free(struct drm_device *dev, int ctx_handle);
1252 extern int drm_setsareactx(struct drm_device *dev, void *data,
1253 struct drm_file *file_priv);
1254 extern int drm_getsareactx(struct drm_device *dev, void *data,
1255 struct drm_file *file_priv);
1257 /* Authentication IOCTL support (drm_auth.h) */
1258 extern int drm_getmagic(struct drm_device *dev, void *data,
1259 struct drm_file *file_priv);
1260 extern int drm_authmagic(struct drm_device *dev, void *data,
1261 struct drm_file *file_priv);
1262 extern int drm_remove_magic(struct drm_master *master, drm_magic_t magic);
1264 /* Cache management (drm_cache.c) */
1265 void drm_clflush_pages(vm_page_t *pages, unsigned long num_pages);
1266 void drm_clflush_virt_range(char *addr, unsigned long length);
1268 /* Locking IOCTL support (drm_lock.h) */
1269 extern int drm_lock(struct drm_device *dev, void *data,
1270 struct drm_file *file_priv);
1271 extern int drm_unlock(struct drm_device *dev, void *data,
1272 struct drm_file *file_priv);
1273 extern int drm_lock_free(struct drm_lock_data *lock_data, unsigned int context);
1274 extern void drm_idlelock_take(struct drm_lock_data *lock_data);
1275 extern void drm_idlelock_release(struct drm_lock_data *lock_data);
1278 * These are exported to drivers so that they can implement fencing using
1279 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1282 extern int drm_i_have_hw_lock(struct drm_device *dev, struct drm_file *file_priv);
1284 /* Buffer management support (drm_bufs.h) */
1285 extern int drm_addbufs_agp(struct drm_device *dev, struct drm_buf_desc * request);
1286 extern int drm_addbufs_pci(struct drm_device *dev, struct drm_buf_desc * request);
1287 extern int drm_addmap(struct drm_device *dev, resource_size_t offset,
1288 unsigned int size, enum drm_map_type type,
1289 enum drm_map_flags flags, struct drm_local_map **map_ptr);
1290 extern int drm_addmap_ioctl(struct drm_device *dev, void *data,
1291 struct drm_file *file_priv);
1292 extern int drm_rmmap(struct drm_device *dev, struct drm_local_map *map);
1293 extern int drm_rmmap_locked(struct drm_device *dev, struct drm_local_map *map);
1294 extern int drm_rmmap_ioctl(struct drm_device *dev, void *data,
1295 struct drm_file *file_priv);
1296 extern int drm_addbufs(struct drm_device *dev, void *data,
1297 struct drm_file *file_priv);
1298 extern int drm_infobufs(struct drm_device *dev, void *data,
1299 struct drm_file *file_priv);
1300 extern int drm_markbufs(struct drm_device *dev, void *data,
1301 struct drm_file *file_priv);
1302 extern int drm_freebufs(struct drm_device *dev, void *data,
1303 struct drm_file *file_priv);
1304 extern int drm_mapbufs(struct drm_device *dev, void *data,
1305 struct drm_file *file_priv);
1306 extern int drm_order(unsigned long size);
1308 /* DMA support (drm_dma.h) */
1309 extern int drm_dma_setup(struct drm_device *dev);
1310 extern void drm_dma_takedown(struct drm_device *dev);
1311 extern void drm_free_buffer(struct drm_device *dev, struct drm_buf * buf);
1312 extern void drm_core_reclaim_buffers(struct drm_device *dev,
1313 struct drm_file *filp);
1315 /* IRQ support (drm_irq.h) */
1316 extern int drm_control(struct drm_device *dev, void *data,
1317 struct drm_file *file_priv);
1318 extern int drm_irq_install(struct drm_device *dev);
1319 extern int drm_irq_uninstall(struct drm_device *dev);
1321 extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
1322 extern int drm_wait_vblank(struct drm_device *dev, void *data,
1323 struct drm_file *filp);
1324 extern int drm_vblank_wait(struct drm_device *dev, unsigned int *vbl_seq);
1325 extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
1326 extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
1327 struct timeval *vblanktime);
1328 extern void drm_send_vblank_event(struct drm_device *dev, int crtc,
1329 struct drm_pending_vblank_event *e);
1330 extern bool drm_handle_vblank(struct drm_device *dev, int crtc);
1331 extern int drm_vblank_get(struct drm_device *dev, int crtc);
1332 extern void drm_vblank_put(struct drm_device *dev, int crtc);
1333 extern void drm_vblank_off(struct drm_device *dev, int crtc);
1334 extern void drm_vblank_cleanup(struct drm_device *dev);
1335 extern u32 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
1336 struct timeval *tvblank, unsigned flags);
1337 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
1338 int crtc, int *max_error,
1339 struct timeval *vblank_time,
1341 struct drm_crtc *refcrtc);
1342 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc);
1345 drm_mode_parse_command_line_for_connector(const char *mode_option,
1346 struct drm_connector *connector,
1347 struct drm_cmdline_mode *mode);
1349 extern struct drm_display_mode *
1350 drm_mode_create_from_cmdline_mode(struct drm_device *dev,
1351 struct drm_cmdline_mode *cmd);
1353 /* Modesetting support */
1354 extern void drm_vblank_pre_modeset(struct drm_device *dev, int crtc);
1355 extern void drm_vblank_post_modeset(struct drm_device *dev, int crtc);
1356 extern int drm_modeset_ctl(struct drm_device *dev, void *data,
1357 struct drm_file *file_priv);
1359 /* AGP/GART support (drm_agpsupport.h) */
1360 extern struct drm_agp_head *drm_agp_init(struct drm_device *dev);
1361 extern int drm_agp_acquire(struct drm_device *dev);
1362 extern int drm_agp_acquire_ioctl(struct drm_device *dev, void *data,
1363 struct drm_file *file_priv);
1364 extern int drm_agp_release(struct drm_device *dev);
1365 extern int drm_agp_release_ioctl(struct drm_device *dev, void *data,
1366 struct drm_file *file_priv);
1367 extern int drm_agp_enable(struct drm_device *dev, struct drm_agp_mode mode);
1368 extern int drm_agp_enable_ioctl(struct drm_device *dev, void *data,
1369 struct drm_file *file_priv);
1370 extern int drm_agp_info(struct drm_device *dev, struct drm_agp_info *info);
1371 extern int drm_agp_info_ioctl(struct drm_device *dev, void *data,
1372 struct drm_file *file_priv);
1373 extern int drm_agp_alloc(struct drm_device *dev, struct drm_agp_buffer *request);
1374 extern int drm_agp_alloc_ioctl(struct drm_device *dev, void *data,
1375 struct drm_file *file_priv);
1376 extern int drm_agp_free(struct drm_device *dev, struct drm_agp_buffer *request);
1377 extern int drm_agp_free_ioctl(struct drm_device *dev, void *data,
1378 struct drm_file *file_priv);
1379 extern int drm_agp_unbind(struct drm_device *dev, struct drm_agp_binding *request);
1380 extern int drm_agp_unbind_ioctl(struct drm_device *dev, void *data,
1381 struct drm_file *file_priv);
1382 extern int drm_agp_bind(struct drm_device *dev, struct drm_agp_binding *request);
1383 extern int drm_agp_bind_ioctl(struct drm_device *dev, void *data,
1384 struct drm_file *file_priv);
1386 /* Stub support (drm_stub.h) */
1387 extern int drm_setmaster_ioctl(struct drm_device *dev, void *data,
1388 struct drm_file *file_priv);
1389 extern int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
1390 struct drm_file *file_priv);
1391 struct drm_master *drm_master_create(struct drm_minor *minor);
1392 extern struct drm_master *drm_master_get(struct drm_master *master);
1393 extern void drm_master_put(struct drm_master **master);
1395 extern void drm_put_dev(struct drm_device *dev);
1396 extern int drm_put_minor(struct drm_minor **minor);
1397 extern void drm_unplug_dev(struct drm_device *dev);
1398 extern unsigned int drm_debug;
1399 extern unsigned int drm_notyet;
1401 extern unsigned int drm_vblank_offdelay;
1402 extern unsigned int drm_timestamp_precision;
1403 extern unsigned int drm_timestamp_monotonic;
1405 extern struct drm_local_map *drm_getsarea(struct drm_device *dev);
1408 #ifdef FREEBSD_NOTYET
1409 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1410 struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1412 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1413 struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1415 extern int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
1416 struct drm_file *file_priv);
1417 extern int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
1418 struct drm_file *file_priv);
1420 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, vm_page_t *pages,
1421 dma_addr_t *addrs, int max_pages);
1422 extern struct sg_table *drm_prime_pages_to_sg(vm_page_t *pages, int nr_pages);
1423 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1426 void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv);
1427 void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv);
1428 int drm_prime_add_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t handle);
1429 int drm_prime_lookup_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t *handle);
1430 void drm_prime_remove_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf);
1432 int drm_prime_add_dma_buf(struct drm_device *dev, struct drm_gem_object *obj);
1433 int drm_prime_lookup_obj(struct drm_device *dev, struct dma_buf *buf,
1434 struct drm_gem_object **obj);
1435 #endif /* FREEBSD_NOTYET */
1437 /* Scatter Gather Support (drm_scatter.h) */
1438 extern void drm_sg_cleanup(struct drm_sg_mem * entry);
1439 extern int drm_sg_alloc_ioctl(struct drm_device *dev, void *data,
1440 struct drm_file *file_priv);
1441 extern int drm_sg_alloc(struct drm_device *dev, struct drm_scatter_gather * request);
1442 extern int drm_sg_free(struct drm_device *dev, void *data,
1443 struct drm_file *file_priv);
1445 /* ATI PCIGART support (ati_pcigart.h) */
1446 extern int drm_ati_pcigart_init(struct drm_device *dev,
1447 struct drm_ati_pcigart_info * gart_info);
1448 extern int drm_ati_pcigart_cleanup(struct drm_device *dev,
1449 struct drm_ati_pcigart_info * gart_info);
1451 extern drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
1452 size_t align, dma_addr_t maxaddr);
1453 extern void __drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1454 extern void drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1456 /* Graphics Execution Manager library functions (drm_gem.c) */
1457 int drm_gem_init(struct drm_device *dev);
1458 void drm_gem_destroy(struct drm_device *dev);
1459 void drm_gem_object_release(struct drm_gem_object *obj);
1460 void drm_gem_object_free(struct drm_gem_object *obj);
1461 struct drm_gem_object *drm_gem_object_alloc(struct drm_device *dev,
1463 int drm_gem_object_init(struct drm_device *dev,
1464 struct drm_gem_object *obj, size_t size);
1465 int drm_gem_private_object_init(struct drm_device *dev,
1466 struct drm_gem_object *obj, size_t size);
1467 void drm_gem_object_handle_free(struct drm_gem_object *obj);
1468 int drm_gem_mmap_single(struct drm_device *dev, vm_ooffset_t *offset,
1469 vm_size_t size, struct vm_object **obj_res, int nprot);
1470 void drm_gem_pager_dtr(void *obj);
1472 #include <dev/drm2/drm_global.h>
1475 drm_gem_object_reference(struct drm_gem_object *obj)
1478 KASSERT(obj->refcount > 0, ("Dangling obj %p", obj));
1479 refcount_acquire(&obj->refcount);
1483 drm_gem_object_unreference(struct drm_gem_object *obj)
1488 if (refcount_release(&obj->refcount))
1489 drm_gem_object_free(obj);
1493 drm_gem_object_unreference_unlocked(struct drm_gem_object *obj)
1496 struct drm_device *dev = obj->dev;
1498 drm_gem_object_unreference(obj);
1503 int drm_gem_handle_create(struct drm_file *file_priv,
1504 struct drm_gem_object *obj,
1506 int drm_gem_handle_delete(struct drm_file *filp, u32 handle);
1509 drm_gem_object_handle_reference(struct drm_gem_object *obj)
1511 drm_gem_object_reference(obj);
1512 atomic_inc(&obj->handle_count);
1516 drm_gem_object_handle_unreference(struct drm_gem_object *obj)
1521 if (atomic_read(&obj->handle_count) == 0)
1524 * Must bump handle count first as this may be the last
1525 * ref, in which case the object would disappear before we
1526 * checked for a name
1528 if (atomic_dec_and_test(&obj->handle_count))
1529 drm_gem_object_handle_free(obj);
1530 drm_gem_object_unreference(obj);
1534 drm_gem_object_handle_unreference_unlocked(struct drm_gem_object *obj)
1539 if (atomic_read(&obj->handle_count) == 0)
1543 * Must bump handle count first as this may be the last
1544 * ref, in which case the object would disappear before we
1545 * checked for a name
1548 if (atomic_dec_and_test(&obj->handle_count))
1549 drm_gem_object_handle_free(obj);
1550 drm_gem_object_unreference_unlocked(obj);
1553 void drm_gem_free_mmap_offset(struct drm_gem_object *obj);
1554 int drm_gem_create_mmap_offset(struct drm_gem_object *obj);
1556 struct drm_gem_object *drm_gem_object_lookup(struct drm_device *dev,
1557 struct drm_file *filp,
1559 int drm_gem_close_ioctl(struct drm_device *dev, void *data,
1560 struct drm_file *file_priv);
1561 int drm_gem_flink_ioctl(struct drm_device *dev, void *data,
1562 struct drm_file *file_priv);
1563 int drm_gem_open_ioctl(struct drm_device *dev, void *data,
1564 struct drm_file *file_priv);
1565 void drm_gem_open(struct drm_device *dev, struct drm_file *file_private);
1566 void drm_gem_release(struct drm_device *dev, struct drm_file *file_private);
1568 extern void drm_core_ioremap(struct drm_local_map *map, struct drm_device *dev);
1569 extern void drm_core_ioremap_wc(struct drm_local_map *map, struct drm_device *dev);
1570 extern void drm_core_ioremapfree(struct drm_local_map *map, struct drm_device *dev);
1572 static __inline__ struct drm_local_map *drm_core_findmap(struct drm_device *dev,
1575 struct drm_map_list *_entry;
1576 list_for_each_entry(_entry, &dev->maplist, head)
1577 if (_entry->user_token == token)
1582 static __inline__ void drm_core_dropmap(struct drm_local_map *map)
1586 extern int drm_fill_in_dev(struct drm_device *dev,
1587 struct drm_driver *driver);
1588 extern void drm_cancel_fill_in_dev(struct drm_device *dev);
1589 int drm_get_minor(struct drm_device *dev, struct drm_minor **minor, int type);
1593 int drm_pci_device_is_agp(struct drm_device *dev);
1594 int drm_pci_device_is_pcie(struct drm_device *dev);
1596 extern int drm_get_pci_dev(device_t kdev, struct drm_device *dev,
1597 struct drm_driver *driver);
1599 #define DRM_PCIE_SPEED_25 1
1600 #define DRM_PCIE_SPEED_50 2
1601 #define DRM_PCIE_SPEED_80 4
1603 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1605 #define drm_can_sleep() (DRM_HZ & 1)
1607 /* FreeBSD specific -- should be moved to drm_os_freebsd.h */
1609 #define DRM_GEM_MAPPING_MASK (3ULL << 62)
1610 #define DRM_GEM_MAPPING_KEY (2ULL << 62) /* Non-canonical address form */
1611 #define DRM_GEM_MAX_IDX 0x3fffff
1612 #define DRM_GEM_MAPPING_IDX(o) (((o) >> 40) & DRM_GEM_MAX_IDX)
1613 #define DRM_GEM_MAPPING_OFF(i) (((uint64_t)(i)) << 40)
1614 #define DRM_GEM_MAPPING_MAPOFF(o) \
1615 ((o) & ~(DRM_GEM_MAPPING_OFF(DRM_GEM_MAX_IDX) | DRM_GEM_MAPPING_KEY))
1617 SYSCTL_DECL(_hw_drm);
1619 #define DRM_DEV_MODE (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
1620 #define DRM_DEV_UID UID_ROOT
1621 #define DRM_DEV_GID GID_VIDEO
1623 #define DRM_WAKEUP(w) wakeup((void *)w)
1624 #define DRM_WAKEUP_INT(w) wakeup(w)
1625 #define DRM_INIT_WAITQUEUE(queue) do {(void)(queue);} while (0)
1627 #define DRM_CURPROC curthread
1628 #define DRM_STRUCTPROC struct thread
1629 #define DRM_SPINTYPE struct mtx
1630 #define DRM_SPININIT(l,name) mtx_init(l, name, NULL, MTX_DEF)
1631 #define DRM_SPINUNINIT(l) mtx_destroy(l)
1632 #define DRM_SPINLOCK(l) mtx_lock(l)
1633 #define DRM_SPINUNLOCK(u) mtx_unlock(u)
1634 #define DRM_SPINLOCK_IRQSAVE(l, irqflags) do { \
1638 #define DRM_SPINUNLOCK_IRQRESTORE(u, irqflags) mtx_unlock(u)
1639 #define DRM_SPINLOCK_ASSERT(l) mtx_assert(l, MA_OWNED)
1640 #define DRM_LOCK_SLEEP(dev, chan, flags, msg, timeout) \
1641 (sx_sleep((chan), &(dev)->dev_struct_lock, (flags), (msg), (timeout)))
1642 #if defined(INVARIANTS)
1643 #define DRM_LOCK_ASSERT(dev) sx_assert(&(dev)->dev_struct_lock, SA_XLOCKED)
1644 #define DRM_UNLOCK_ASSERT(dev) sx_assert(&(dev)->dev_struct_lock, SA_UNLOCKED)
1646 #define DRM_LOCK_ASSERT(d)
1647 #define DRM_UNLOCK_ASSERT(d)
1650 #define DRM_SYSCTL_HANDLER_ARGS (SYSCTL_HANDLER_ARGS)
1658 #define DRM_VERIFYAREA_READ( uaddr, size ) \
1659 (!useracc(__DECONST(caddr_t, uaddr), size, VM_PROT_READ))
1661 #define DRM_COPY_TO_USER(user, kern, size) \
1662 copyout(kern, user, size)
1663 #define DRM_COPY_FROM_USER(kern, user, size) \
1664 copyin(user, kern, size)
1665 #define DRM_COPY_FROM_USER_UNCHECKED(arg1, arg2, arg3) \
1666 copyin(arg2, arg1, arg3)
1667 #define DRM_COPY_TO_USER_UNCHECKED(arg1, arg2, arg3) \
1668 copyout(arg2, arg1, arg3)
1669 #define DRM_GET_USER_UNCHECKED(val, uaddr) \
1670 ((val) = fuword32(uaddr), 0)
1672 #define DRM_GET_PRIV_SAREA(_dev, _ctx, _map) do { \
1673 (_map) = (_dev)->context_sareas[_ctx]; \
1676 /* Returns -errno to shared code */
1677 #define DRM_WAIT_ON( ret, queue, timeout, condition ) \
1678 for ( ret = 0 ; !ret && !(condition) ; ) { \
1680 mtx_lock(&dev->irq_lock); \
1682 ret = -mtx_sleep(&(queue), &dev->irq_lock, \
1683 PCATCH, "drmwtq", (timeout)); \
1684 if (ret == -ERESTART) \
1685 ret = -ERESTARTSYS; \
1686 mtx_unlock(&dev->irq_lock); \
1690 #define dev_err(dev, fmt, ...) \
1691 device_printf((dev), "error: " fmt, ## __VA_ARGS__)
1692 #define dev_warn(dev, fmt, ...) \
1693 device_printf((dev), "warning: " fmt, ## __VA_ARGS__)
1694 #define dev_info(dev, fmt, ...) \
1695 device_printf((dev), "info: " fmt, ## __VA_ARGS__)
1696 #define dev_dbg(dev, fmt, ...) do { \
1697 if ((drm_debug& DRM_DEBUGBITS_KMS) != 0) { \
1698 device_printf((dev), "debug: " fmt, ## __VA_ARGS__); \
1702 struct drm_msi_blacklist_entry
1708 struct drm_vblank_info {
1709 wait_queue_head_t queue; /* vblank wait queue */
1710 atomic_t count; /* number of VBLANK interrupts */
1711 /* (driver must alloc the right number of counters) */
1712 atomic_t refcount; /* number of users of vblank interrupts */
1713 u32 last; /* protected by dev->vbl_lock, used */
1714 /* for wraparound handling */
1715 int enabled; /* so we don't call enable more than */
1716 /* once per disable */
1717 int inmodeset; /* Display driver is setting mode */
1720 #ifndef DMA_BIT_MASK
1721 #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : (1ULL<<(n)) - 1)
1724 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
1733 DMI_PRODUCT_VERSION,
1740 DMI_BOARD_ASSET_TAG,
1743 DMI_CHASSIS_VERSION,
1745 DMI_CHASSIS_ASSET_TAG,
1749 struct dmi_strmatch {
1754 struct dmi_system_id {
1755 int (*callback)(const struct dmi_system_id *);
1757 struct dmi_strmatch matches[4];
1759 #define DMI_MATCH(a, b) {(a), (b)}
1760 bool dmi_check_system(const struct dmi_system_id *);
1762 /* Device setup support (drm_drv.c) */
1763 int drm_probe_helper(device_t kdev, drm_pci_id_list_t *idlist);
1764 int drm_attach_helper(device_t kdev, drm_pci_id_list_t *idlist,
1765 struct drm_driver *driver);
1766 int drm_generic_detach(device_t kdev);
1768 void drm_event_wakeup(struct drm_pending_event *e);
1770 int drm_add_busid_modesetting(struct drm_device *dev,
1771 struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
1773 /* Buffer management support (drm_bufs.c) */
1774 unsigned long drm_get_resource_start(struct drm_device *dev,
1775 unsigned int resource);
1776 unsigned long drm_get_resource_len(struct drm_device *dev,
1777 unsigned int resource);
1779 /* IRQ support (drm_irq.c) */
1780 irqreturn_t drm_irq_handler(DRM_IRQ_ARGS);
1781 void drm_driver_irq_preinstall(struct drm_device *dev);
1782 void drm_driver_irq_postinstall(struct drm_device *dev);
1783 void drm_driver_irq_uninstall(struct drm_device *dev);
1785 /* sysctl support (drm_sysctl.h) */
1786 extern int drm_sysctl_init(struct drm_device *dev);
1787 extern int drm_sysctl_cleanup(struct drm_device *dev);
1789 int drm_version(struct drm_device *dev, void *data,
1790 struct drm_file *file_priv);
1792 /* consistent PCI memory functions (drm_pci.c) */
1793 int drm_pci_set_busid(struct drm_device *dev, struct drm_master *master);
1794 int drm_pci_set_unique(struct drm_device *dev, struct drm_master *master,
1795 struct drm_unique *u);
1796 int drm_pci_agp_init(struct drm_device *dev);
1797 int drm_pci_enable_msi(struct drm_device *dev);
1798 void drm_pci_disable_msi(struct drm_device *dev);
1800 struct ttm_bo_device;
1801 int ttm_bo_mmap_single(struct ttm_bo_device *bdev, vm_ooffset_t *offset,
1802 vm_size_t size, struct vm_object **obj_res, int nprot);
1803 struct ttm_buffer_object;
1804 void ttm_bo_release_mmap(struct ttm_buffer_object *bo);
1806 #endif /* __KERNEL__ */