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 #if defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE))
109 #define __OS_HAS_AGP 1
111 #define __OS_HAS_AGP 0
113 #if defined(CONFIG_MTRR)
114 #define __OS_HAS_MTRR 1
116 #define __OS_HAS_MTRR 0
122 #include <dev/drm2/drm_hashtab.h>
123 #include <dev/drm2/drm_mm.h>
125 #include "opt_compat.h"
127 #include "opt_syscons.h"
130 #define DRM_DEBUG_DEFAULT_ON 1
131 #endif /* DRM_DEBUG */
133 #define DRM_DEBUGBITS_DEBUG 0x1
134 #define DRM_DEBUGBITS_KMS 0x2
135 #define DRM_DEBUGBITS_FAILED_IOCTL 0x4
140 /***********************************************************************/
141 /** \name DRM template customization defaults */
144 /* driver capabilities and requirements mask */
145 #define DRIVER_USE_AGP 0x1
146 #define DRIVER_REQUIRE_AGP 0x2
147 #define DRIVER_USE_MTRR 0x4
148 #define DRIVER_PCI_DMA 0x8
149 #define DRIVER_SG 0x10
150 #define DRIVER_HAVE_DMA 0x20
151 #define DRIVER_HAVE_IRQ 0x40
152 #define DRIVER_IRQ_SHARED 0x80
153 #define DRIVER_IRQ_VBL 0x100
154 #define DRIVER_DMA_QUEUE 0x200
155 #define DRIVER_FB_DMA 0x400
156 #define DRIVER_IRQ_VBL2 0x800
157 #define DRIVER_GEM 0x1000
158 #define DRIVER_MODESET 0x2000
159 #define DRIVER_PRIME 0x4000
161 #define DRIVER_BUS_PCI 0x1
162 #define DRIVER_BUS_PLATFORM 0x2
163 #define DRIVER_BUS_USB 0x3
165 /***********************************************************************/
166 /** \name Begin the DRM... */
169 #define DRM_DEBUG_CODE 2 /**< Include debugging code if > 1, then
170 also include looping detection. */
172 #define DRM_MAGIC_HASH_ORDER 4 /**< Size of key hash table. Must be power of 2. */
173 #define DRM_KERNEL_CONTEXT 0 /**< Change drm_resctx if changed */
174 #define DRM_RESERVED_CONTEXTS 1 /**< Change drm_resctx if changed */
175 #define DRM_LOOPING_LIMIT 5000000
176 #define DRM_TIME_SLICE (HZ/20) /**< Time slice for GLXContexts */
177 #define DRM_LOCK_SLICE 1 /**< Time slice for lock, in jiffies */
179 #define DRM_FLAG_DEBUG 0x01
181 #define DRM_MAX_CTXBITMAP (PAGE_SIZE * 8)
182 #define DRM_MAP_HASH_OFFSET 0x10000000
186 /***********************************************************************/
187 /** \name Macros to make printk easier */
193 * \param fmt printf() like format string.
194 * \param arg arguments
196 #define DRM_ERROR(fmt, ...) \
197 printf("error: [" DRM_NAME ":pid%d:%s] *ERROR* " fmt, \
198 DRM_CURRENTPID, __func__ , ##__VA_ARGS__)
200 #define DRM_WARNING(fmt, ...) printf("warning: [" DRM_NAME "] " fmt , ##__VA_ARGS__)
201 #define DRM_INFO(fmt, ...) printf("info: [" DRM_NAME "] " fmt , ##__VA_ARGS__)
206 * \param fmt printf() like format string.
207 * \param arg arguments
209 #define DRM_DEBUG(fmt, ...) do { \
210 if ((drm_debug & DRM_DEBUGBITS_DEBUG) != 0) \
211 printf("[" DRM_NAME ":pid%d:%s] " fmt, DRM_CURRENTPID, \
212 __func__ , ##__VA_ARGS__); \
215 #define DRM_DEBUG_KMS(fmt, ...) do { \
216 if ((drm_debug & DRM_DEBUGBITS_KMS) != 0) \
217 printf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
218 __func__ , ##__VA_ARGS__); \
221 #define DRM_DEBUG_DRIVER(fmt, ...) do { \
222 if ((drm_debug & DRM_DEBUGBITS_KMS) != 0) \
223 printf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
224 __func__ , ##__VA_ARGS__); \
229 /***********************************************************************/
230 /** \name Internal types and structures */
233 #define DRM_ARRAY_SIZE(x) ARRAY_SIZE(x)
235 #define DRM_LEFTCOUNT(x) (((x)->rp + (x)->count - (x)->wp) % ((x)->count + 1))
236 #define DRM_BUFCOUNT(x) ((x)->count - DRM_LEFTCOUNT(x))
238 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
241 * Test that the hardware lock is held by the caller, returning otherwise.
243 * \param dev DRM device.
244 * \param filp file pointer of the caller.
246 #define LOCK_TEST_WITH_RETURN( dev, _file_priv ) \
248 if (!_DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock) || \
249 _file_priv->master->lock.file_priv != _file_priv) { \
250 DRM_ERROR( "%s called without lock held, held %d owner %p %p\n",\
251 __func__, _DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock),\
252 _file_priv->master->lock.file_priv, _file_priv); \
258 * Ioctl function type.
260 * \param inode device inode.
261 * \param file_priv DRM file private pointer.
262 * \param cmd command.
263 * \param arg argument.
265 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
266 struct drm_file *file_priv);
268 #define DRM_IOCTL_NR(n) ((n) & 0xff)
269 #define DRM_MAJOR 226
272 #define DRM_MASTER 0x2
273 #define DRM_ROOT_ONLY 0x4
274 #define DRM_CONTROL_ALLOW 0x8
275 #define DRM_UNLOCKED 0x10
277 struct drm_ioctl_desc {
281 unsigned int cmd_drv;
285 * Creates a driver or general drm_ioctl_desc array entry for the given
286 * ioctl, for use by drm_ioctl().
289 #define DRM_IOCTL_DEF(ioctl, _func, _flags) \
290 [DRM_IOCTL_NR(ioctl)] = {.cmd = ioctl, .func = _func, .flags = _flags, .cmd_drv = 0}
292 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags) \
293 [DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl}
295 struct drm_magic_entry {
296 struct list_head head;
297 struct drm_hash_item hash_item;
298 struct drm_file *priv;
305 int idx; /**< Index into master buflist */
306 int total; /**< Buffer size */
307 int order; /**< log-base-2(total) */
308 int used; /**< Amount of buffer in use (for DMA) */
309 unsigned long offset; /**< Byte offset (used internally) */
310 void *address; /**< Address of buffer */
311 unsigned long bus_address; /**< Bus address of buffer */
312 struct drm_buf *next; /**< Kernel-only: used for free list */
313 __volatile__ int waiting; /**< On kernel DMA queue */
314 __volatile__ int pending; /**< On hardware DMA queue */
315 struct drm_file *file_priv; /**< Private of holding file descr */
316 int context; /**< Kernel queue for this buffer */
317 int while_locked; /**< Dispatch this buffer while locked */
325 } list; /**< Which list we're on */
327 int dev_priv_size; /**< Size of buffer private storage */
328 void *dev_private; /**< Per-buffer private storage */
331 struct drm_freelist {
332 int initialized; /**< Freelist in use */
333 atomic_t count; /**< Number of free buffers */
334 struct drm_buf *next; /**< End pointer */
336 #ifdef FREEBSD_NOTYET
337 wait_queue_head_t waiting; /**< Processes waiting on free bufs */
338 #endif /* defined(FREEBSD_NOTYET) */
339 int low_mark; /**< Low water mark */
340 int high_mark; /**< High water mark */
341 #ifdef FREEBSD_NOTYET
342 atomic_t wfh; /**< If waiting for high mark */
344 #endif /* defined(FREEBSD_NOTYET) */
347 typedef struct drm_dma_handle {
355 * Buffer entry. There is one of this for each buffer size order.
357 struct drm_buf_entry {
358 int buf_size; /**< size */
359 int buf_count; /**< number of buffers */
360 struct drm_buf *buflist; /**< buffer list */
363 struct drm_dma_handle **seglist;
365 struct drm_freelist freelist;
368 /* Event queued up for userspace to read */
369 struct drm_pending_event {
370 struct drm_event *event;
371 struct list_head link;
372 struct drm_file *file_priv;
373 pid_t pid; /* pid of requester, no guarantee it's valid by the time
374 we deliver the event, for tracing only */
375 void (*destroy)(struct drm_pending_event *event);
378 /* initial implementaton using a linked list - todo hashtab */
379 struct drm_prime_file_private {
380 struct list_head head;
389 unsigned long ioctl_count;
390 struct list_head lhead;
391 struct drm_minor *minor;
392 unsigned long lock_count;
395 struct drm_gem_names object_names;
397 int is_master; /* this file private is a master for a minor */
398 struct drm_master *master; /* master this node is currently associated with
399 N.B. not always minor->master */
400 struct list_head fbs;
402 struct selinfo event_poll;
403 struct list_head event_list;
406 struct drm_prime_file_private prime;
412 struct drm_lock_data {
413 struct drm_hw_lock *hw_lock; /**< Hardware lock */
414 /** Private of lock holder's file (NULL=kernel) */
415 struct drm_file *file_priv;
416 wait_queue_head_t lock_queue; /**< Queue of blocked processes */
417 unsigned long lock_time; /**< Time of last lock in jiffies */
419 uint32_t kernel_waiters;
420 uint32_t user_waiters;
427 struct drm_device_dma {
429 struct drm_buf_entry bufs[DRM_MAX_ORDER + 1]; /**< buffers, grouped by their size order */
430 int buf_count; /**< total number of buffers */
431 struct drm_buf **buflist; /**< Vector of pointers into drm_device_dma::bufs */
433 int page_count; /**< number of pages */
434 unsigned long *pagelist; /**< page list */
435 unsigned long byte_count;
437 _DRM_DMA_USE_AGP = 0x01,
438 _DRM_DMA_USE_SG = 0x02,
439 _DRM_DMA_USE_FB = 0x04,
440 _DRM_DMA_USE_PCI_RO = 0x08
446 * AGP memory entry. Stored as a doubly linked list.
449 unsigned long handle; /**< handle */
451 unsigned long bound; /**< address */
453 struct list_head head;
459 * \sa drm_agp_init() and drm_device::agp.
461 struct drm_agp_head {
462 DRM_AGP_KERN agp_info; /**< AGP device information */
463 struct list_head memory;
464 unsigned long mode; /**< AGP mode */
466 int enabled; /**< whether the AGP bus as been enabled */
467 int acquired; /**< whether the AGP device has been acquired */
470 int cant_use_aperture;
474 * Scatter-gather memory.
484 struct drm_hw_lock *lock;
488 * Kernel side of a mapping
490 #define DRM_MAP_HANDLE_BITS (sizeof(void *) == 4 ? 4 : 24)
491 #define DRM_MAP_HANDLE_SHIFT (sizeof(void *) * 8 - DRM_MAP_HANDLE_BITS)
493 struct drm_local_map {
494 resource_size_t offset; /**< Requested physical address (0 for SAREA)*/
495 unsigned long size; /**< Requested physical size (bytes) */
496 enum drm_map_type type; /**< Type of memory to map */
497 enum drm_map_flags flags; /**< Flags */
498 void *handle; /**< User-space: "Handle" to pass to mmap() */
499 /**< Kernel-space: kernel-virtual address */
500 int mtrr; /**< MTRR slot used */
503 drm_dma_handle_t *dmah;
506 typedef struct drm_local_map drm_local_map_t;
511 struct drm_map_list {
512 struct list_head head; /**< list head */
513 struct drm_hash_item hash;
514 struct drm_local_map *map; /**< mapping */
516 struct drm_master *master;
517 struct drm_mm_node *file_offset_node; /**< fake offset */
521 * Context handle list
523 struct drm_ctx_list {
524 struct list_head head; /**< list head */
525 drm_context_t handle; /**< context handle */
526 struct drm_file *tag; /**< associated fd private data */
529 /* location of GART table */
530 #define DRM_ATI_GART_MAIN 1
531 #define DRM_ATI_GART_FB 2
533 #define DRM_ATI_GART_PCI 1
534 #define DRM_ATI_GART_PCIE 2
535 #define DRM_ATI_GART_IGP 3
537 struct drm_ati_pcigart_info {
538 int gart_table_location;
542 dma_addr_t table_mask;
543 struct drm_dma_handle *table_handle;
544 struct drm_local_map mapping;
546 struct drm_dma_handle *dmah; /* handle for ATI PCIGART table FIXME */
550 * GEM specific mm private for tracking GEM objects
553 struct unrhdr *idxunr;
554 struct drm_open_hash offset_hash; /**< User token hash table for maps */
558 * This structure defines the drm_mm memory object, which will be used by the
559 * DRM for its buffer objects.
561 struct drm_gem_object {
562 /** Reference count of this object */
565 /** Handle count of this object. Each handle also holds a reference */
566 atomic_t handle_count; /* number of handles on this object */
568 /** Related drm device */
569 struct drm_device *dev;
571 /** File representing the shmem storage: filp in Linux parlance */
574 /* Mapping info for this object */
576 struct drm_hash_item map_list;
579 * Size of the object, in bytes. Immutable over the object's
585 * Global name for this object, starts at 1. 0 means unnamed.
586 * Access is covered by the object_name_lock in the related drm_device
591 * Memory domains. These monitor which caches contain read/write data
592 * related to the object. When transitioning from one set of domains
593 * to another, the driver is called to ensure that caches are suitably
594 * flushed and invalidated
596 uint32_t read_domains;
597 uint32_t write_domain;
600 * While validating an exec operation, the
601 * new read/write domain values are computed here.
602 * They will be transferred to the above values
603 * at the point that any cache flushing occurs
605 uint32_t pending_read_domains;
606 uint32_t pending_write_domain;
608 void *driver_private;
610 #ifdef FREEBSD_NOTYET
611 /* dma buf exported from this GEM object */
612 struct dma_buf *export_dma_buf;
614 /* dma buf attachment backing this object */
615 struct dma_buf_attachment *import_attach;
616 #endif /* FREEBSD_NOTYET */
619 #include <dev/drm2/drm_crtc.h>
621 /* per-master structure */
624 u_int refcount; /* refcount for this master */
626 struct list_head head; /**< each minor contains a list of masters */
627 struct drm_minor *minor; /**< link back to minor we are a master for */
629 char *unique; /**< Unique identifier: e.g., busid */
630 int unique_len; /**< Length of unique field */
631 int unique_size; /**< amount allocated */
633 int blocked; /**< Blocked due to VC switch? */
635 /** \name Authentication */
637 struct drm_open_hash magiclist;
638 struct list_head magicfree;
641 struct drm_lock_data lock; /**< Information on hardware lock */
643 void *driver_priv; /**< Private structure for driver to use */
646 /* Size of ringbuffer for vblank timestamps. Just double-buffer
647 * in initial implementation.
649 #define DRM_VBLANKTIME_RBSIZE 2
651 /* Flags and return codes for get_vblank_timestamp() driver function. */
652 #define DRM_CALLED_FROM_VBLIRQ 1
653 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
654 #define DRM_VBLANKTIME_INVBL (1 << 1)
656 /* get_scanout_position() return flags */
657 #define DRM_SCANOUTPOS_VALID (1 << 0)
658 #define DRM_SCANOUTPOS_INVBL (1 << 1)
659 #define DRM_SCANOUTPOS_ACCURATE (1 << 2)
663 int (*get_irq)(struct drm_device *dev);
664 void (*free_irq)(struct drm_device *dev);
665 const char *(*get_name)(struct drm_device *dev);
666 int (*set_busid)(struct drm_device *dev, struct drm_master *master);
667 int (*set_unique)(struct drm_device *dev, struct drm_master *master,
668 struct drm_unique *unique);
669 int (*irq_by_busid)(struct drm_device *dev, struct drm_irq_busid *p);
670 /* hooks that are for PCI */
671 int (*agp_init)(struct drm_device *dev);
676 * DRM driver structure. This structure represent the common code for
677 * a family of cards. There will one drm_device for each card present
681 int (*load) (struct drm_device *, unsigned long flags);
682 int (*firstopen) (struct drm_device *);
683 int (*open) (struct drm_device *, struct drm_file *);
684 void (*preclose) (struct drm_device *, struct drm_file *file_priv);
685 void (*postclose) (struct drm_device *, struct drm_file *);
686 void (*lastclose) (struct drm_device *);
687 int (*unload) (struct drm_device *);
688 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
689 int (*dma_quiescent) (struct drm_device *);
690 int (*context_dtor) (struct drm_device *dev, int context);
693 * get_vblank_counter - get raw hardware vblank counter
695 * @crtc: counter to fetch
697 * Driver callback for fetching a raw hardware vblank counter for @crtc.
698 * If a device doesn't have a hardware counter, the driver can simply
699 * return the value of drm_vblank_count. The DRM core will account for
700 * missed vblank events while interrupts where disabled based on system
703 * Wraparound handling and loss of events due to modesetting is dealt
704 * with in the DRM core code.
707 * Raw vblank counter value.
709 u32 (*get_vblank_counter) (struct drm_device *dev, int crtc);
712 * enable_vblank - enable vblank interrupt events
714 * @crtc: which irq to enable
716 * Enable vblank interrupts for @crtc. If the device doesn't have
717 * a hardware vblank counter, this routine should be a no-op, since
718 * interrupts will have to stay on to keep the count accurate.
721 * Zero on success, appropriate errno if the given @crtc's vblank
722 * interrupt cannot be enabled.
724 int (*enable_vblank) (struct drm_device *dev, int crtc);
727 * disable_vblank - disable vblank interrupt events
729 * @crtc: which irq to enable
731 * Disable vblank interrupts for @crtc. If the device doesn't have
732 * a hardware vblank counter, this routine should be a no-op, since
733 * interrupts will have to stay on to keep the count accurate.
735 void (*disable_vblank) (struct drm_device *dev, int crtc);
738 * Called by \c drm_device_is_agp. Typically used to determine if a
739 * card is really attached to AGP or not.
741 * \param dev DRM device handle
744 * One of three values is returned depending on whether or not the
745 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
746 * (return of 1), or may or may not be AGP (return of 2).
748 int (*device_is_agp) (struct drm_device *dev);
751 * Called by vblank timestamping code.
753 * Return the current display scanout position from a crtc.
755 * \param dev DRM device.
756 * \param crtc Id of the crtc to query.
757 * \param *vpos Target location for current vertical scanout position.
758 * \param *hpos Target location for current horizontal scanout position.
760 * Returns vpos as a positive number while in active scanout area.
761 * Returns vpos as a negative number inside vblank, counting the number
762 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
763 * until start of active scanout / end of vblank."
765 * \return Flags, or'ed together as follows:
767 * DRM_SCANOUTPOS_VALID = Query successful.
768 * DRM_SCANOUTPOS_INVBL = Inside vblank.
769 * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
770 * this flag means that returned position may be offset by a constant
771 * but unknown small number of scanlines wrt. real scanout position.
774 int (*get_scanout_position) (struct drm_device *dev, int crtc,
775 int *vpos, int *hpos);
778 * Called by \c drm_get_last_vbltimestamp. Should return a precise
779 * timestamp when the most recent VBLANK interval ended or will end.
781 * Specifically, the timestamp in @vblank_time should correspond as
782 * closely as possible to the time when the first video scanline of
783 * the video frame after the end of VBLANK will start scanning out,
784 * the time immediately after end of the VBLANK interval. If the
785 * @crtc is currently inside VBLANK, this will be a time in the future.
786 * If the @crtc is currently scanning out a frame, this will be the
787 * past start time of the current scanout. This is meant to adhere
788 * to the OpenML OML_sync_control extension specification.
790 * \param dev dev DRM device handle.
791 * \param crtc crtc for which timestamp should be returned.
792 * \param *max_error Maximum allowable timestamp error in nanoseconds.
793 * Implementation should strive to provide timestamp
794 * with an error of at most *max_error nanoseconds.
795 * Returns true upper bound on error for timestamp.
796 * \param *vblank_time Target location for returned vblank timestamp.
797 * \param flags 0 = Defaults, no special treatment needed.
798 * \param DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
799 * irq handler. Some drivers need to apply some workarounds
800 * for gpu-specific vblank irq quirks if flag is set.
803 * Zero if timestamping isn't supported in current display mode or a
804 * negative number on failure. A positive status code on success,
805 * which describes how the vblank_time timestamp was computed.
807 int (*get_vblank_timestamp) (struct drm_device *dev, int crtc,
809 struct timeval *vblank_time,
812 /* these have to be filled in */
814 irqreturn_t(*irq_handler) (DRM_IRQ_ARGS);
815 void (*irq_preinstall) (struct drm_device *dev);
816 int (*irq_postinstall) (struct drm_device *dev);
817 void (*irq_uninstall) (struct drm_device *dev);
818 void (*set_version) (struct drm_device *dev,
819 struct drm_set_version *sv);
821 /* Master routines */
822 int (*master_create)(struct drm_device *dev, struct drm_master *master);
823 void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
825 * master_set is called whenever the minor master is set.
826 * master_drop is called whenever the minor master is dropped.
829 int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
831 void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv,
835 * Driver-specific constructor for drm_gem_objects, to set up
836 * obj->driver_private.
838 * Returns 0 on success.
840 int (*gem_init_object) (struct drm_gem_object *obj);
841 void (*gem_free_object) (struct drm_gem_object *obj);
842 int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
843 void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
845 #ifdef FREEBSD_NOTYET
847 /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
848 int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
849 uint32_t handle, uint32_t flags, int *prime_fd);
850 /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
851 int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
852 int prime_fd, uint32_t *handle);
853 /* export GEM -> dmabuf */
854 struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
855 struct drm_gem_object *obj, int flags);
856 /* import dmabuf -> GEM */
857 struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
858 struct dma_buf *dma_buf);
859 #endif /* defined(FREEBSD_NOTYET) */
861 /* dumb alloc support */
862 int (*dumb_create)(struct drm_file *file_priv,
863 struct drm_device *dev,
864 struct drm_mode_create_dumb *args);
865 int (*dumb_map_offset)(struct drm_file *file_priv,
866 struct drm_device *dev, uint32_t handle,
868 int (*dumb_destroy)(struct drm_file *file_priv,
869 struct drm_device *dev,
872 /* Driver private ops for this object */
873 struct cdev_pager_ops *gem_pager_ops;
875 int (*sysctl_init)(struct drm_device *dev,
876 struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
877 void (*sysctl_cleanup)(struct drm_device *dev);
888 struct drm_ioctl_desc *ioctls;
891 #ifdef COMPAT_FREEBSD32
892 struct drm_ioctl_desc *compat_ioctls;
893 int *num_compat_ioctls;
899 #define DRM_MINOR_UNASSIGNED 0
900 #define DRM_MINOR_LEGACY 1
901 #define DRM_MINOR_CONTROL 2
902 #define DRM_MINOR_RENDER 3
905 * DRM minor structure. This structure represents a drm minor number.
908 int index; /**< Minor device number */
909 int type; /**< Control or render */
910 struct cdev *device; /**< Device number for mknod */
911 device_t kdev; /**< OS device */
912 struct drm_device *dev;
914 struct drm_master *master; /* currently active master for this node */
915 struct list_head master_list;
916 struct drm_mode_group mode_group;
918 struct sigio *buf_sigio; /* Processes waiting for SIGIO */
921 /* mode specified on the command line */
922 struct drm_cmdline_mode {
924 bool refresh_specified;
933 enum drm_connector_force force;
937 struct drm_pending_vblank_event {
938 struct drm_pending_event base;
940 struct drm_event_vblank event;
944 * DRM device structure. This structure represent a complete card that
945 * may contain multiple heads.
948 int if_version; /**< Highest interface version set */
952 struct mtx count_lock; /**< For inuse, drm_device::open_count, drm_device::buf_use */
953 struct sx dev_struct_lock; /**< For others */
956 /** \name Usage Counters */
958 int open_count; /**< Outstanding files open */
959 atomic_t ioctl_count; /**< Outstanding IOCTLs pending */
960 atomic_t vma_count; /**< Outstanding vma areas open */
961 int buf_use; /**< Buffers in use -- cannot alloc */
962 atomic_t buf_alloc; /**< Buffer allocation in progress */
965 /** \name Performance counters */
967 unsigned long counters;
968 enum drm_stat_type types[15];
972 struct list_head filelist;
974 /** \name Memory management */
976 struct list_head maplist; /**< Linked list of regions */
977 int map_count; /**< Number of mappable regions */
978 struct drm_open_hash map_hash; /**< User token hash table for maps */
980 /** \name Context handle management */
982 struct list_head ctxlist; /**< Linked list of context handles */
983 int ctx_count; /**< Number of context handles */
984 struct mtx ctxlist_mutex; /**< For ctxlist */
985 drm_local_map_t **context_sareas;
987 unsigned long *ctx_bitmap;
991 /** \name DMA support */
993 struct drm_device_dma *dma; /**< Optional pointer for DMA support */
996 /** \name Context support */
998 int irq_enabled; /**< True if irq handler is enabled */
999 atomic_t context_flag; /**< Context swapping flag */
1000 atomic_t interrupt_flag; /**< Interruption handler flag */
1001 atomic_t dma_flag; /**< DMA dispatch flag */
1002 wait_queue_head_t context_wait; /**< Processes waiting on ctx switch */
1003 int last_checked; /**< Last context checked for DMA */
1004 int last_context; /**< Last current context */
1005 unsigned long last_switch; /**< jiffies at last context switch */
1008 /** \name VBLANK IRQ support */
1012 * At load time, disabling the vblank interrupt won't be allowed since
1013 * old clients may not call the modeset ioctl and therefore misbehave.
1014 * Once the modeset ioctl *has* been called though, we can safely
1015 * disable them when unused.
1017 int vblank_disable_allowed;
1019 atomic_t *_vblank_count; /**< number of VBLANK interrupts (driver must alloc the right number of counters) */
1020 struct timeval *_vblank_time; /**< timestamp of current vblank_count (drivers must alloc right number of fields) */
1021 struct mtx vblank_time_lock; /**< Protects vblank count and time updates during vblank enable/disable */
1022 struct mtx vbl_lock;
1023 atomic_t *vblank_refcount; /* number of users of vblank interruptsper crtc */
1024 u32 *last_vblank; /* protected by dev->vbl_lock, used */
1025 /* for wraparound handling */
1026 int *vblank_enabled; /* so we don't call enable more than
1028 int *vblank_inmodeset; /* Display driver is setting mode */
1029 u32 *last_vblank_wait; /* Last vblank seqno waited per CRTC */
1030 struct callout vblank_disable_callout;
1032 u32 max_vblank_count; /**< size of vblank counter register */
1037 struct list_head vblank_event_list;
1038 struct mtx event_lock;
1042 struct drm_agp_head *agp; /**< AGP data */
1044 device_t dev; /* Device instance from newbus */
1045 uint16_t pci_device; /* PCI device id */
1046 uint16_t pci_vendor; /* PCI vendor id */
1047 uint16_t pci_subdevice; /* PCI subsystem device id */
1048 uint16_t pci_subvendor; /* PCI subsystem vendor id */
1050 struct drm_sg_mem *sg; /**< Scatter gather memory */
1051 unsigned int num_crtcs; /**< Number of CRTCs on this device */
1052 void *dev_private; /**< device private data */
1054 struct drm_sigdata sigdata; /**< For block_all_signals */
1057 struct drm_driver *driver;
1058 struct drm_local_map *agp_buffer_map;
1059 unsigned int agp_buffer_token;
1060 struct drm_minor *control; /**< Control node for card */
1061 struct drm_minor *primary; /**< render type primary screen head */
1063 struct drm_mode_config mode_config; /**< Current mode config */
1065 /** \name GEM information */
1067 struct sx object_name_lock;
1068 struct drm_gem_names object_names;
1070 int switch_power_state;
1072 atomic_t unplugged; /* device has been unplugged or gone away */
1075 struct mtx dma_lock; /* protects dev->dma */
1076 struct mtx irq_lock; /* protects irq condition checks */
1078 /* Context support */
1079 int irq; /* Interrupt used by board */
1080 int msi_enabled; /* MSI enabled */
1081 int irqrid; /* Interrupt used by board */
1082 struct resource *irqr; /* Resource for interrupt used by board */
1083 void *irqh; /* Handle from bus_setup_intr */
1085 /* Storage of resource pointers for drm_get_resource_* */
1086 #define DRM_MAX_PCI_RESOURCE 6
1087 struct resource *pcir[DRM_MAX_PCI_RESOURCE];
1088 int pcirid[DRM_MAX_PCI_RESOURCE];
1089 struct mtx pcir_lock;
1096 /* Sysctl support */
1097 struct drm_sysctl_info *sysctl;
1098 int sysctl_node_idx;
1102 void *sysctl_private;
1103 char busid_str[128];
1106 drm_pci_id_list_t *id_entry; /* PCI ID, name, and chipset private */
1109 #define DRM_SWITCH_POWER_ON 0
1110 #define DRM_SWITCH_POWER_OFF 1
1111 #define DRM_SWITCH_POWER_CHANGING 2
1113 static __inline__ int drm_core_check_feature(struct drm_device *dev,
1116 return ((dev->driver->driver_features & feature) ? 1 : 0);
1119 static inline int drm_dev_to_irq(struct drm_device *dev)
1121 return dev->driver->bus->get_irq(dev);
1126 static inline int drm_core_has_AGP(struct drm_device *dev)
1128 return drm_core_check_feature(dev, DRIVER_USE_AGP);
1131 #define drm_core_has_AGP(dev) (0)
1135 static inline int drm_core_has_MTRR(struct drm_device *dev)
1137 return drm_core_check_feature(dev, DRIVER_USE_MTRR);
1140 #define DRM_MTRR_WC MDF_WRITECOMBINE
1142 int drm_mtrr_add(unsigned long offset, unsigned long size, unsigned int flags);
1143 int drm_mtrr_del(int handle, unsigned long offset, unsigned long size, unsigned int flags);
1146 #define drm_core_has_MTRR(dev) (0)
1148 #define DRM_MTRR_WC 0
1150 static inline int drm_mtrr_add(unsigned long offset, unsigned long size,
1156 static inline int drm_mtrr_del(int handle, unsigned long offset,
1157 unsigned long size, unsigned int flags)
1163 /******************************************************************/
1164 /** \name Internal function definitions */
1167 /* Driver support (drm_drv.h) */
1168 d_ioctl_t drm_ioctl;
1169 extern int drm_lastclose(struct drm_device *dev);
1171 /* Device support (drm_fops.h) */
1172 extern struct sx drm_global_mutex;
1175 extern void drm_release(void *data);
1177 /* Mapping support (drm_vm.h) */
1179 int drm_mmap_single(struct cdev *kdev, vm_ooffset_t *offset,
1180 vm_size_t size, struct vm_object **obj_res, int nprot);
1183 /* Memory management support (drm_memory.h) */
1184 extern void drm_free_agp(DRM_AGP_MEM * handle, int pages);
1185 extern int drm_bind_agp(DRM_AGP_MEM * handle, unsigned int start);
1186 #ifdef FREEBSD_NOTYET
1187 extern DRM_AGP_MEM *drm_agp_bind_pages(struct drm_device *dev,
1188 struct page **pages,
1189 unsigned long num_pages,
1190 uint32_t gtt_offset,
1192 #endif /* FREEBSD_NOTYET */
1193 extern int drm_unbind_agp(DRM_AGP_MEM * handle);
1195 /* Misc. IOCTL support (drm_ioctl.h) */
1196 extern int drm_irq_by_busid(struct drm_device *dev, void *data,
1197 struct drm_file *file_priv);
1198 extern int drm_getunique(struct drm_device *dev, void *data,
1199 struct drm_file *file_priv);
1200 extern int drm_setunique(struct drm_device *dev, void *data,
1201 struct drm_file *file_priv);
1202 extern int drm_getmap(struct drm_device *dev, void *data,
1203 struct drm_file *file_priv);
1204 extern int drm_getclient(struct drm_device *dev, void *data,
1205 struct drm_file *file_priv);
1206 extern int drm_getstats(struct drm_device *dev, void *data,
1207 struct drm_file *file_priv);
1208 extern int drm_getcap(struct drm_device *dev, void *data,
1209 struct drm_file *file_priv);
1210 extern int drm_setversion(struct drm_device *dev, void *data,
1211 struct drm_file *file_priv);
1212 extern int drm_noop(struct drm_device *dev, void *data,
1213 struct drm_file *file_priv);
1215 /* Context IOCTL support (drm_context.h) */
1216 extern int drm_resctx(struct drm_device *dev, void *data,
1217 struct drm_file *file_priv);
1218 extern int drm_addctx(struct drm_device *dev, void *data,
1219 struct drm_file *file_priv);
1220 extern int drm_modctx(struct drm_device *dev, void *data,
1221 struct drm_file *file_priv);
1222 extern int drm_getctx(struct drm_device *dev, void *data,
1223 struct drm_file *file_priv);
1224 extern int drm_switchctx(struct drm_device *dev, void *data,
1225 struct drm_file *file_priv);
1226 extern int drm_newctx(struct drm_device *dev, void *data,
1227 struct drm_file *file_priv);
1228 extern int drm_rmctx(struct drm_device *dev, void *data,
1229 struct drm_file *file_priv);
1231 extern int drm_ctxbitmap_init(struct drm_device *dev);
1232 extern void drm_ctxbitmap_cleanup(struct drm_device *dev);
1233 extern void drm_ctxbitmap_free(struct drm_device *dev, int ctx_handle);
1235 extern int drm_setsareactx(struct drm_device *dev, void *data,
1236 struct drm_file *file_priv);
1237 extern int drm_getsareactx(struct drm_device *dev, void *data,
1238 struct drm_file *file_priv);
1240 /* Authentication IOCTL support (drm_auth.h) */
1241 extern int drm_getmagic(struct drm_device *dev, void *data,
1242 struct drm_file *file_priv);
1243 extern int drm_authmagic(struct drm_device *dev, void *data,
1244 struct drm_file *file_priv);
1245 extern int drm_remove_magic(struct drm_master *master, drm_magic_t magic);
1247 /* Cache management (drm_cache.c) */
1248 void drm_clflush_pages(vm_page_t *pages, unsigned long num_pages);
1249 void drm_clflush_virt_range(char *addr, unsigned long length);
1251 /* Locking IOCTL support (drm_lock.h) */
1252 extern int drm_lock(struct drm_device *dev, void *data,
1253 struct drm_file *file_priv);
1254 extern int drm_unlock(struct drm_device *dev, void *data,
1255 struct drm_file *file_priv);
1256 extern int drm_lock_free(struct drm_lock_data *lock_data, unsigned int context);
1257 extern void drm_idlelock_take(struct drm_lock_data *lock_data);
1258 extern void drm_idlelock_release(struct drm_lock_data *lock_data);
1261 * These are exported to drivers so that they can implement fencing using
1262 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1265 extern int drm_i_have_hw_lock(struct drm_device *dev, struct drm_file *file_priv);
1267 /* Buffer management support (drm_bufs.h) */
1268 extern int drm_addbufs_agp(struct drm_device *dev, struct drm_buf_desc * request);
1269 extern int drm_addbufs_pci(struct drm_device *dev, struct drm_buf_desc * request);
1270 extern int drm_addmap(struct drm_device *dev, resource_size_t offset,
1271 unsigned int size, enum drm_map_type type,
1272 enum drm_map_flags flags, struct drm_local_map **map_ptr);
1273 extern int drm_addmap_ioctl(struct drm_device *dev, void *data,
1274 struct drm_file *file_priv);
1275 extern int drm_rmmap(struct drm_device *dev, struct drm_local_map *map);
1276 extern int drm_rmmap_locked(struct drm_device *dev, struct drm_local_map *map);
1277 extern int drm_rmmap_ioctl(struct drm_device *dev, void *data,
1278 struct drm_file *file_priv);
1279 extern int drm_addbufs(struct drm_device *dev, void *data,
1280 struct drm_file *file_priv);
1281 extern int drm_infobufs(struct drm_device *dev, void *data,
1282 struct drm_file *file_priv);
1283 extern int drm_markbufs(struct drm_device *dev, void *data,
1284 struct drm_file *file_priv);
1285 extern int drm_freebufs(struct drm_device *dev, void *data,
1286 struct drm_file *file_priv);
1287 extern int drm_mapbufs(struct drm_device *dev, void *data,
1288 struct drm_file *file_priv);
1289 extern int drm_order(unsigned long size);
1291 /* DMA support (drm_dma.h) */
1292 extern int drm_dma_setup(struct drm_device *dev);
1293 extern void drm_dma_takedown(struct drm_device *dev);
1294 extern void drm_free_buffer(struct drm_device *dev, struct drm_buf * buf);
1295 extern void drm_core_reclaim_buffers(struct drm_device *dev,
1296 struct drm_file *filp);
1298 /* IRQ support (drm_irq.h) */
1299 extern int drm_control(struct drm_device *dev, void *data,
1300 struct drm_file *file_priv);
1301 extern int drm_irq_install(struct drm_device *dev);
1302 extern int drm_irq_uninstall(struct drm_device *dev);
1304 extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
1305 extern int drm_wait_vblank(struct drm_device *dev, void *data,
1306 struct drm_file *filp);
1307 extern int drm_vblank_wait(struct drm_device *dev, unsigned int *vbl_seq);
1308 extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
1309 extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
1310 struct timeval *vblanktime);
1311 extern void drm_send_vblank_event(struct drm_device *dev, int crtc,
1312 struct drm_pending_vblank_event *e);
1313 extern bool drm_handle_vblank(struct drm_device *dev, int crtc);
1314 extern int drm_vblank_get(struct drm_device *dev, int crtc);
1315 extern void drm_vblank_put(struct drm_device *dev, int crtc);
1316 extern void drm_vblank_off(struct drm_device *dev, int crtc);
1317 extern void drm_vblank_cleanup(struct drm_device *dev);
1318 extern u32 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
1319 struct timeval *tvblank, unsigned flags);
1320 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
1321 int crtc, int *max_error,
1322 struct timeval *vblank_time,
1324 struct drm_crtc *refcrtc);
1325 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc);
1328 drm_mode_parse_command_line_for_connector(const char *mode_option,
1329 struct drm_connector *connector,
1330 struct drm_cmdline_mode *mode);
1332 extern struct drm_display_mode *
1333 drm_mode_create_from_cmdline_mode(struct drm_device *dev,
1334 struct drm_cmdline_mode *cmd);
1336 /* Modesetting support */
1337 extern void drm_vblank_pre_modeset(struct drm_device *dev, int crtc);
1338 extern void drm_vblank_post_modeset(struct drm_device *dev, int crtc);
1339 extern int drm_modeset_ctl(struct drm_device *dev, void *data,
1340 struct drm_file *file_priv);
1342 /* AGP/GART support (drm_agpsupport.h) */
1343 extern struct drm_agp_head *drm_agp_init(struct drm_device *dev);
1344 extern int drm_agp_acquire(struct drm_device *dev);
1345 extern int drm_agp_acquire_ioctl(struct drm_device *dev, void *data,
1346 struct drm_file *file_priv);
1347 extern int drm_agp_release(struct drm_device *dev);
1348 extern int drm_agp_release_ioctl(struct drm_device *dev, void *data,
1349 struct drm_file *file_priv);
1350 extern int drm_agp_enable(struct drm_device *dev, struct drm_agp_mode mode);
1351 extern int drm_agp_enable_ioctl(struct drm_device *dev, void *data,
1352 struct drm_file *file_priv);
1353 extern int drm_agp_info(struct drm_device *dev, struct drm_agp_info *info);
1354 extern int drm_agp_info_ioctl(struct drm_device *dev, void *data,
1355 struct drm_file *file_priv);
1356 extern int drm_agp_alloc(struct drm_device *dev, struct drm_agp_buffer *request);
1357 extern int drm_agp_alloc_ioctl(struct drm_device *dev, void *data,
1358 struct drm_file *file_priv);
1359 extern int drm_agp_free(struct drm_device *dev, struct drm_agp_buffer *request);
1360 extern int drm_agp_free_ioctl(struct drm_device *dev, void *data,
1361 struct drm_file *file_priv);
1362 extern int drm_agp_unbind(struct drm_device *dev, struct drm_agp_binding *request);
1363 extern int drm_agp_unbind_ioctl(struct drm_device *dev, void *data,
1364 struct drm_file *file_priv);
1365 extern int drm_agp_bind(struct drm_device *dev, struct drm_agp_binding *request);
1366 extern int drm_agp_bind_ioctl(struct drm_device *dev, void *data,
1367 struct drm_file *file_priv);
1369 /* Stub support (drm_stub.h) */
1370 extern int drm_setmaster_ioctl(struct drm_device *dev, void *data,
1371 struct drm_file *file_priv);
1372 extern int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
1373 struct drm_file *file_priv);
1374 struct drm_master *drm_master_create(struct drm_minor *minor);
1375 extern struct drm_master *drm_master_get(struct drm_master *master);
1376 extern void drm_master_put(struct drm_master **master);
1378 extern void drm_put_dev(struct drm_device *dev);
1379 extern int drm_put_minor(struct drm_minor **minor);
1380 extern void drm_unplug_dev(struct drm_device *dev);
1381 extern unsigned int drm_debug;
1382 extern unsigned int drm_notyet;
1384 extern unsigned int drm_vblank_offdelay;
1385 extern unsigned int drm_timestamp_precision;
1386 extern unsigned int drm_timestamp_monotonic;
1388 extern struct drm_local_map *drm_getsarea(struct drm_device *dev);
1391 #ifdef FREEBSD_NOTYET
1392 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1393 struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1395 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1396 struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1398 extern int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
1399 struct drm_file *file_priv);
1400 extern int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
1401 struct drm_file *file_priv);
1403 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, vm_page_t *pages,
1404 dma_addr_t *addrs, int max_pages);
1405 extern struct sg_table *drm_prime_pages_to_sg(vm_page_t *pages, int nr_pages);
1406 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1409 void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv);
1410 void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv);
1411 int drm_prime_add_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t handle);
1412 int drm_prime_lookup_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t *handle);
1413 void drm_prime_remove_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf);
1415 int drm_prime_add_dma_buf(struct drm_device *dev, struct drm_gem_object *obj);
1416 int drm_prime_lookup_obj(struct drm_device *dev, struct dma_buf *buf,
1417 struct drm_gem_object **obj);
1418 #endif /* FREEBSD_NOTYET */
1420 /* Scatter Gather Support (drm_scatter.h) */
1421 extern void drm_sg_cleanup(struct drm_sg_mem * entry);
1422 extern int drm_sg_alloc_ioctl(struct drm_device *dev, void *data,
1423 struct drm_file *file_priv);
1424 extern int drm_sg_alloc(struct drm_device *dev, struct drm_scatter_gather * request);
1425 extern int drm_sg_free(struct drm_device *dev, void *data,
1426 struct drm_file *file_priv);
1428 /* ATI PCIGART support (ati_pcigart.h) */
1429 extern int drm_ati_pcigart_init(struct drm_device *dev,
1430 struct drm_ati_pcigart_info * gart_info);
1431 extern int drm_ati_pcigart_cleanup(struct drm_device *dev,
1432 struct drm_ati_pcigart_info * gart_info);
1434 extern drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
1435 size_t align, dma_addr_t maxaddr);
1436 extern void __drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1437 extern void drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1439 /* Graphics Execution Manager library functions (drm_gem.c) */
1440 int drm_gem_init(struct drm_device *dev);
1441 void drm_gem_destroy(struct drm_device *dev);
1442 void drm_gem_object_release(struct drm_gem_object *obj);
1443 void drm_gem_object_free(struct drm_gem_object *obj);
1444 struct drm_gem_object *drm_gem_object_alloc(struct drm_device *dev,
1446 int drm_gem_object_init(struct drm_device *dev,
1447 struct drm_gem_object *obj, size_t size);
1448 int drm_gem_private_object_init(struct drm_device *dev,
1449 struct drm_gem_object *obj, size_t size);
1450 void drm_gem_object_handle_free(struct drm_gem_object *obj);
1451 int drm_gem_mmap_single(struct drm_device *dev, vm_ooffset_t *offset,
1452 vm_size_t size, struct vm_object **obj_res, int nprot);
1453 void drm_gem_pager_dtr(void *obj);
1455 #include <dev/drm2/drm_global.h>
1458 drm_gem_object_reference(struct drm_gem_object *obj)
1461 KASSERT(obj->refcount > 0, ("Dangling obj %p", obj));
1462 refcount_acquire(&obj->refcount);
1466 drm_gem_object_unreference(struct drm_gem_object *obj)
1471 if (refcount_release(&obj->refcount))
1472 drm_gem_object_free(obj);
1476 drm_gem_object_unreference_unlocked(struct drm_gem_object *obj)
1479 struct drm_device *dev = obj->dev;
1481 drm_gem_object_unreference(obj);
1486 int drm_gem_handle_create(struct drm_file *file_priv,
1487 struct drm_gem_object *obj,
1489 int drm_gem_handle_delete(struct drm_file *filp, u32 handle);
1492 drm_gem_object_handle_reference(struct drm_gem_object *obj)
1494 drm_gem_object_reference(obj);
1495 atomic_inc(&obj->handle_count);
1499 drm_gem_object_handle_unreference(struct drm_gem_object *obj)
1504 if (atomic_read(&obj->handle_count) == 0)
1507 * Must bump handle count first as this may be the last
1508 * ref, in which case the object would disappear before we
1509 * checked for a name
1511 if (atomic_dec_and_test(&obj->handle_count))
1512 drm_gem_object_handle_free(obj);
1513 drm_gem_object_unreference(obj);
1517 drm_gem_object_handle_unreference_unlocked(struct drm_gem_object *obj)
1522 if (atomic_read(&obj->handle_count) == 0)
1526 * Must bump handle count first as this may be the last
1527 * ref, in which case the object would disappear before we
1528 * checked for a name
1531 if (atomic_dec_and_test(&obj->handle_count))
1532 drm_gem_object_handle_free(obj);
1533 drm_gem_object_unreference_unlocked(obj);
1536 void drm_gem_free_mmap_offset(struct drm_gem_object *obj);
1537 int drm_gem_create_mmap_offset(struct drm_gem_object *obj);
1539 struct drm_gem_object *drm_gem_object_lookup(struct drm_device *dev,
1540 struct drm_file *filp,
1542 int drm_gem_close_ioctl(struct drm_device *dev, void *data,
1543 struct drm_file *file_priv);
1544 int drm_gem_flink_ioctl(struct drm_device *dev, void *data,
1545 struct drm_file *file_priv);
1546 int drm_gem_open_ioctl(struct drm_device *dev, void *data,
1547 struct drm_file *file_priv);
1548 void drm_gem_open(struct drm_device *dev, struct drm_file *file_private);
1549 void drm_gem_release(struct drm_device *dev, struct drm_file *file_private);
1551 extern void drm_core_ioremap(struct drm_local_map *map, struct drm_device *dev);
1552 extern void drm_core_ioremap_wc(struct drm_local_map *map, struct drm_device *dev);
1553 extern void drm_core_ioremapfree(struct drm_local_map *map, struct drm_device *dev);
1555 static __inline__ struct drm_local_map *drm_core_findmap(struct drm_device *dev,
1558 struct drm_map_list *_entry;
1559 list_for_each_entry(_entry, &dev->maplist, head)
1560 if (_entry->user_token == token)
1565 static __inline__ void drm_core_dropmap(struct drm_local_map *map)
1569 extern int drm_fill_in_dev(struct drm_device *dev,
1570 struct drm_driver *driver);
1571 extern void drm_cancel_fill_in_dev(struct drm_device *dev);
1572 int drm_get_minor(struct drm_device *dev, struct drm_minor **minor, int type);
1576 int drm_pci_device_is_agp(struct drm_device *dev);
1577 int drm_pci_device_is_pcie(struct drm_device *dev);
1579 extern int drm_get_pci_dev(device_t kdev, struct drm_device *dev,
1580 struct drm_driver *driver);
1582 #define DRM_PCIE_SPEED_25 1
1583 #define DRM_PCIE_SPEED_50 2
1584 #define DRM_PCIE_SPEED_80 4
1586 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1588 #define drm_can_sleep() (DRM_HZ & 1)
1590 /* FreeBSD specific -- should be moved to drm_os_freebsd.h */
1592 #define DRM_GEM_MAPPING_MASK (3ULL << 62)
1593 #define DRM_GEM_MAPPING_KEY (2ULL << 62) /* Non-canonical address form */
1594 #define DRM_GEM_MAX_IDX 0x3fffff
1595 #define DRM_GEM_MAPPING_IDX(o) (((o) >> 40) & DRM_GEM_MAX_IDX)
1596 #define DRM_GEM_MAPPING_OFF(i) (((uint64_t)(i)) << 40)
1597 #define DRM_GEM_MAPPING_MAPOFF(o) \
1598 ((o) & ~(DRM_GEM_MAPPING_OFF(DRM_GEM_MAX_IDX) | DRM_GEM_MAPPING_KEY))
1600 SYSCTL_DECL(_hw_drm);
1602 #define DRM_DEV_MODE (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
1603 #define DRM_DEV_UID 0
1604 #define DRM_DEV_GID 0
1606 #define DRM_WAKEUP(w) wakeup((void *)w)
1607 #define DRM_WAKEUP_INT(w) wakeup(w)
1608 #define DRM_INIT_WAITQUEUE(queue) do {(void)(queue);} while (0)
1610 #define DRM_CURPROC curthread
1611 #define DRM_STRUCTPROC struct thread
1612 #define DRM_SPINTYPE struct mtx
1613 #define DRM_SPININIT(l,name) mtx_init(l, name, NULL, MTX_DEF)
1614 #define DRM_SPINUNINIT(l) mtx_destroy(l)
1615 #define DRM_SPINLOCK(l) mtx_lock(l)
1616 #define DRM_SPINUNLOCK(u) mtx_unlock(u)
1617 #define DRM_SPINLOCK_IRQSAVE(l, irqflags) do { \
1621 #define DRM_SPINUNLOCK_IRQRESTORE(u, irqflags) mtx_unlock(u)
1622 #define DRM_SPINLOCK_ASSERT(l) mtx_assert(l, MA_OWNED)
1623 #define DRM_LOCK_SLEEP(dev, chan, flags, msg, timeout) \
1624 (sx_sleep((chan), &(dev)->dev_struct_lock, (flags), (msg), (timeout)))
1625 #if defined(INVARIANTS)
1626 #define DRM_LOCK_ASSERT(dev) sx_assert(&(dev)->dev_struct_lock, SA_XLOCKED)
1627 #define DRM_UNLOCK_ASSERT(dev) sx_assert(&(dev)->dev_struct_lock, SA_UNLOCKED)
1629 #define DRM_LOCK_ASSERT(d)
1630 #define DRM_UNLOCK_ASSERT(d)
1633 #define DRM_SYSCTL_HANDLER_ARGS (SYSCTL_HANDLER_ARGS)
1641 #define DRM_VERIFYAREA_READ( uaddr, size ) \
1642 (!useracc(__DECONST(caddr_t, uaddr), size, VM_PROT_READ))
1644 #define DRM_COPY_TO_USER(user, kern, size) \
1645 copyout(kern, user, size)
1646 #define DRM_COPY_FROM_USER(kern, user, size) \
1647 copyin(user, kern, size)
1648 #define DRM_COPY_FROM_USER_UNCHECKED(arg1, arg2, arg3) \
1649 copyin(arg2, arg1, arg3)
1650 #define DRM_COPY_TO_USER_UNCHECKED(arg1, arg2, arg3) \
1651 copyout(arg2, arg1, arg3)
1652 #define DRM_GET_USER_UNCHECKED(val, uaddr) \
1653 ((val) = fuword32(uaddr), 0)
1655 #define DRM_GET_PRIV_SAREA(_dev, _ctx, _map) do { \
1656 (_map) = (_dev)->context_sareas[_ctx]; \
1659 /* Returns -errno to shared code */
1660 #define DRM_WAIT_ON( ret, queue, timeout, condition ) \
1661 for ( ret = 0 ; !ret && !(condition) ; ) { \
1663 mtx_lock(&dev->irq_lock); \
1665 ret = -mtx_sleep(&(queue), &dev->irq_lock, \
1666 PCATCH, "drmwtq", (timeout)); \
1667 if (ret == -ERESTART) \
1668 ret = -ERESTARTSYS; \
1669 mtx_unlock(&dev->irq_lock); \
1673 #define dev_err(dev, fmt, ...) \
1674 device_printf((dev), "error: " fmt, ## __VA_ARGS__)
1675 #define dev_warn(dev, fmt, ...) \
1676 device_printf((dev), "warning: " fmt, ## __VA_ARGS__)
1677 #define dev_info(dev, fmt, ...) \
1678 device_printf((dev), "info: " fmt, ## __VA_ARGS__)
1679 #define dev_dbg(dev, fmt, ...) do { \
1680 if ((drm_debug& DRM_DEBUGBITS_KMS) != 0) { \
1681 device_printf((dev), "debug: " fmt, ## __VA_ARGS__); \
1685 struct drm_msi_blacklist_entry
1691 struct drm_vblank_info {
1692 wait_queue_head_t queue; /* vblank wait queue */
1693 atomic_t count; /* number of VBLANK interrupts */
1694 /* (driver must alloc the right number of counters) */
1695 atomic_t refcount; /* number of users of vblank interrupts */
1696 u32 last; /* protected by dev->vbl_lock, used */
1697 /* for wraparound handling */
1698 int enabled; /* so we don't call enable more than */
1699 /* once per disable */
1700 int inmodeset; /* Display driver is setting mode */
1703 #ifndef DMA_BIT_MASK
1704 #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : (1ULL<<(n)) - 1)
1707 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
1716 DMI_PRODUCT_VERSION,
1723 DMI_BOARD_ASSET_TAG,
1726 DMI_CHASSIS_VERSION,
1728 DMI_CHASSIS_ASSET_TAG,
1732 struct dmi_strmatch {
1737 struct dmi_system_id {
1738 int (*callback)(const struct dmi_system_id *);
1740 struct dmi_strmatch matches[4];
1742 #define DMI_MATCH(a, b) {(a), (b)}
1743 bool dmi_check_system(const struct dmi_system_id *);
1745 /* Device setup support (drm_drv.c) */
1746 int drm_probe_helper(device_t kdev, drm_pci_id_list_t *idlist);
1747 int drm_attach_helper(device_t kdev, drm_pci_id_list_t *idlist,
1748 struct drm_driver *driver);
1749 int drm_generic_detach(device_t kdev);
1751 void drm_event_wakeup(struct drm_pending_event *e);
1753 int drm_add_busid_modesetting(struct drm_device *dev,
1754 struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
1756 /* Buffer management support (drm_bufs.c) */
1757 unsigned long drm_get_resource_start(struct drm_device *dev,
1758 unsigned int resource);
1759 unsigned long drm_get_resource_len(struct drm_device *dev,
1760 unsigned int resource);
1762 /* IRQ support (drm_irq.c) */
1763 irqreturn_t drm_irq_handler(DRM_IRQ_ARGS);
1764 void drm_driver_irq_preinstall(struct drm_device *dev);
1765 void drm_driver_irq_postinstall(struct drm_device *dev);
1766 void drm_driver_irq_uninstall(struct drm_device *dev);
1768 /* sysctl support (drm_sysctl.h) */
1769 extern int drm_sysctl_init(struct drm_device *dev);
1770 extern int drm_sysctl_cleanup(struct drm_device *dev);
1772 int drm_version(struct drm_device *dev, void *data,
1773 struct drm_file *file_priv);
1775 /* consistent PCI memory functions (drm_pci.c) */
1776 int drm_pci_set_busid(struct drm_device *dev, struct drm_master *master);
1777 int drm_pci_set_unique(struct drm_device *dev, struct drm_master *master,
1778 struct drm_unique *u);
1779 int drm_pci_agp_init(struct drm_device *dev);
1780 int drm_pci_enable_msi(struct drm_device *dev);
1781 void drm_pci_disable_msi(struct drm_device *dev);
1783 struct ttm_bo_device;
1784 int ttm_bo_mmap_single(struct ttm_bo_device *bdev, vm_ooffset_t *offset,
1785 vm_size_t size, struct vm_object **obj_res, int nprot);
1786 struct ttm_buffer_object;
1787 void ttm_bo_release_mmap(struct ttm_buffer_object *bo);
1789 #endif /* __KERNEL__ */