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/bus.h>
80 #include <machine/resource.h>
81 #if defined(__i386__) || defined(__amd64__)
82 #include <machine/specialreg.h>
84 #include <machine/sysarch.h>
85 #include <sys/endian.h>
88 #include <sys/memrange.h>
89 #include <dev/agp/agpvar.h>
90 #include <sys/agpio.h>
91 #include <sys/mutex.h>
92 #include <dev/pci/pcivar.h>
93 #include <dev/pci/pcireg.h>
94 #include <sys/selinfo.h>
97 #include <dev/drm2/drm.h>
98 #include <dev/drm2/drm_sarea.h>
100 #include <dev/drm2/drm_atomic.h>
101 #include <dev/drm2/drm_linux_list.h>
102 #include <dev/drm2/drm_gem_names.h>
104 #include <dev/drm2/drm_os_freebsd.h>
106 #if defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE))
107 #define __OS_HAS_AGP 1
109 #define __OS_HAS_AGP 0
111 #if defined(CONFIG_MTRR)
112 #define __OS_HAS_MTRR 1
114 #define __OS_HAS_MTRR 0
120 #include <dev/drm2/drm_hashtab.h>
121 #include <dev/drm2/drm_mm.h>
123 #include "opt_compat.h"
125 #include "opt_syscons.h"
128 #define DRM_DEBUG_DEFAULT_ON 1
129 #endif /* DRM_DEBUG */
131 #define DRM_DEBUGBITS_DEBUG 0x1
132 #define DRM_DEBUGBITS_KMS 0x2
133 #define DRM_DEBUGBITS_FAILED_IOCTL 0x4
138 /***********************************************************************/
139 /** \name DRM template customization defaults */
142 /* driver capabilities and requirements mask */
143 #define DRIVER_USE_AGP 0x1
144 #define DRIVER_REQUIRE_AGP 0x2
145 #define DRIVER_USE_MTRR 0x4
146 #define DRIVER_PCI_DMA 0x8
147 #define DRIVER_SG 0x10
148 #define DRIVER_HAVE_DMA 0x20
149 #define DRIVER_HAVE_IRQ 0x40
150 #define DRIVER_IRQ_SHARED 0x80
151 #define DRIVER_IRQ_VBL 0x100
152 #define DRIVER_DMA_QUEUE 0x200
153 #define DRIVER_FB_DMA 0x400
154 #define DRIVER_IRQ_VBL2 0x800
155 #define DRIVER_GEM 0x1000
156 #define DRIVER_MODESET 0x2000
157 #define DRIVER_PRIME 0x4000
159 #define DRIVER_BUS_PCI 0x1
160 #define DRIVER_BUS_PLATFORM 0x2
161 #define DRIVER_BUS_USB 0x3
163 /***********************************************************************/
164 /** \name Begin the DRM... */
167 #define DRM_DEBUG_CODE 2 /**< Include debugging code if > 1, then
168 also include looping detection. */
170 #define DRM_MAGIC_HASH_ORDER 4 /**< Size of key hash table. Must be power of 2. */
171 #define DRM_KERNEL_CONTEXT 0 /**< Change drm_resctx if changed */
172 #define DRM_RESERVED_CONTEXTS 1 /**< Change drm_resctx if changed */
173 #define DRM_LOOPING_LIMIT 5000000
174 #define DRM_TIME_SLICE (HZ/20) /**< Time slice for GLXContexts */
175 #define DRM_LOCK_SLICE 1 /**< Time slice for lock, in jiffies */
177 #define DRM_FLAG_DEBUG 0x01
179 #define DRM_MAX_CTXBITMAP (PAGE_SIZE * 8)
180 #define DRM_MAP_HASH_OFFSET 0x10000000
184 /***********************************************************************/
185 /** \name Macros to make printk easier */
191 * \param fmt printf() like format string.
192 * \param arg arguments
194 #define DRM_ERROR(fmt, ...) \
195 printf("error: [" DRM_NAME ":pid%d:%s] *ERROR* " fmt, \
196 DRM_CURRENTPID, __func__ , ##__VA_ARGS__)
198 #define DRM_WARNING(fmt, ...) printf("warning: [" DRM_NAME "] " fmt , ##__VA_ARGS__)
199 #define DRM_INFO(fmt, ...) printf("info: [" DRM_NAME "] " fmt , ##__VA_ARGS__)
204 * \param fmt printf() like format string.
205 * \param arg arguments
207 #define DRM_DEBUG(fmt, ...) do { \
208 if ((drm_debug & DRM_DEBUGBITS_DEBUG) != 0) \
209 printf("[" DRM_NAME ":pid%d:%s] " fmt, DRM_CURRENTPID, \
210 __func__ , ##__VA_ARGS__); \
213 #define DRM_DEBUG_DRIVER(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_DEBUG_KMS(fmt, ...) do { \
220 if ((drm_debug & DRM_DEBUGBITS_KMS) != 0) \
221 printf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
222 __func__ , ##__VA_ARGS__); \
225 #define DRM_LOG(fmt, ...) do { \
226 if ((drm_debug & DRM_DEBUGBITS_KMS) != 0) \
227 printf("[" DRM_NAME "]:pid%d:%s]" fmt, DRM_CURRENTPID, \
228 __func__ , ##__VA_ARGS__); \
231 #define DRM_LOG_KMS(fmt, ...) do { \
232 if ((drm_debug & DRM_DEBUGBITS_KMS) != 0) \
233 printf("[" DRM_NAME "]:KMS:pid%d:%s]" fmt, DRM_CURRENTPID,\
234 __func__ , ##__VA_ARGS__); \
237 #define DRM_LOG_MODE(fmt, ...) do { \
238 if ((drm_debug & DRM_DEBUGBITS_KMS) != 0) \
239 printf("[" DRM_NAME "]:pid%d:%s]" fmt, DRM_CURRENTPID, \
240 __func__ , ##__VA_ARGS__); \
243 #define DRM_LOG_DRIVER(fmt, ...) do { \
244 if ((drm_debug & DRM_DEBUGBITS_KMS) != 0) \
245 printf("[" DRM_NAME "]:KMS:pid%d:%s]" fmt, DRM_CURRENTPID,\
246 __func__ , ##__VA_ARGS__); \
251 /***********************************************************************/
252 /** \name Internal types and structures */
255 #define DRM_ARRAY_SIZE(x) ARRAY_SIZE(x)
257 #define DRM_LEFTCOUNT(x) (((x)->rp + (x)->count - (x)->wp) % ((x)->count + 1))
258 #define DRM_BUFCOUNT(x) ((x)->count - DRM_LEFTCOUNT(x))
260 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
263 * Test that the hardware lock is held by the caller, returning otherwise.
265 * \param dev DRM device.
266 * \param filp file pointer of the caller.
268 #define LOCK_TEST_WITH_RETURN( dev, _file_priv ) \
270 if (!_DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock) || \
271 _file_priv->master->lock.file_priv != _file_priv) { \
272 DRM_ERROR( "%s called without lock held, held %d owner %p %p\n",\
273 __func__, _DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock),\
274 _file_priv->master->lock.file_priv, _file_priv); \
280 * Ioctl function type.
282 * \param inode device inode.
283 * \param file_priv DRM file private pointer.
284 * \param cmd command.
285 * \param arg argument.
287 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
288 struct drm_file *file_priv);
290 #define DRM_IOCTL_NR(n) ((n) & 0xff)
291 #define DRM_MAJOR 226
294 #define DRM_MASTER 0x2
295 #define DRM_ROOT_ONLY 0x4
296 #define DRM_CONTROL_ALLOW 0x8
297 #define DRM_UNLOCKED 0x10
299 struct drm_ioctl_desc {
303 unsigned int cmd_drv;
307 * Creates a driver or general drm_ioctl_desc array entry for the given
308 * ioctl, for use by drm_ioctl().
311 #define DRM_IOCTL_DEF(ioctl, _func, _flags) \
312 [DRM_IOCTL_NR(ioctl)] = {.cmd = ioctl, .func = _func, .flags = _flags, .cmd_drv = 0}
314 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags) \
315 [DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl}
317 struct drm_magic_entry {
318 struct list_head head;
319 struct drm_hash_item hash_item;
320 struct drm_file *priv;
327 int idx; /**< Index into master buflist */
328 int total; /**< Buffer size */
329 int order; /**< log-base-2(total) */
330 int used; /**< Amount of buffer in use (for DMA) */
331 unsigned long offset; /**< Byte offset (used internally) */
332 void *address; /**< Address of buffer */
333 unsigned long bus_address; /**< Bus address of buffer */
334 struct drm_buf *next; /**< Kernel-only: used for free list */
335 __volatile__ int waiting; /**< On kernel DMA queue */
336 __volatile__ int pending; /**< On hardware DMA queue */
337 struct drm_file *file_priv; /**< Private of holding file descr */
338 int context; /**< Kernel queue for this buffer */
339 int while_locked; /**< Dispatch this buffer while locked */
347 } list; /**< Which list we're on */
349 int dev_priv_size; /**< Size of buffer private storage */
350 void *dev_private; /**< Per-buffer private storage */
353 struct drm_freelist {
354 int initialized; /**< Freelist in use */
355 atomic_t count; /**< Number of free buffers */
356 struct drm_buf *next; /**< End pointer */
358 #ifdef FREEBSD_NOTYET
359 wait_queue_head_t waiting; /**< Processes waiting on free bufs */
360 #endif /* defined(FREEBSD_NOTYET) */
361 int low_mark; /**< Low water mark */
362 int high_mark; /**< High water mark */
363 #ifdef FREEBSD_NOTYET
364 atomic_t wfh; /**< If waiting for high mark */
366 #endif /* defined(FREEBSD_NOTYET) */
369 typedef struct drm_dma_handle {
377 * Buffer entry. There is one of this for each buffer size order.
379 struct drm_buf_entry {
380 int buf_size; /**< size */
381 int buf_count; /**< number of buffers */
382 struct drm_buf *buflist; /**< buffer list */
385 struct drm_dma_handle **seglist;
387 struct drm_freelist freelist;
390 /* Event queued up for userspace to read */
391 struct drm_pending_event {
392 struct drm_event *event;
393 struct list_head link;
394 struct drm_file *file_priv;
395 pid_t pid; /* pid of requester, no guarantee it's valid by the time
396 we deliver the event, for tracing only */
397 void (*destroy)(struct drm_pending_event *event);
400 /* initial implementaton using a linked list - todo hashtab */
401 struct drm_prime_file_private {
402 struct list_head head;
411 unsigned long ioctl_count;
412 struct list_head lhead;
413 struct drm_minor *minor;
414 unsigned long lock_count;
417 struct drm_gem_names object_names;
419 int is_master; /* this file private is a master for a minor */
420 struct drm_master *master; /* master this node is currently associated with
421 N.B. not always minor->master */
422 struct list_head fbs;
424 struct selinfo event_poll;
425 struct list_head event_list;
428 struct drm_prime_file_private prime;
434 struct drm_lock_data {
435 struct drm_hw_lock *hw_lock; /**< Hardware lock */
436 /** Private of lock holder's file (NULL=kernel) */
437 struct drm_file *file_priv;
438 wait_queue_head_t lock_queue; /**< Queue of blocked processes */
439 unsigned long lock_time; /**< Time of last lock in jiffies */
441 uint32_t kernel_waiters;
442 uint32_t user_waiters;
449 struct drm_device_dma {
451 struct drm_buf_entry bufs[DRM_MAX_ORDER + 1]; /**< buffers, grouped by their size order */
452 int buf_count; /**< total number of buffers */
453 struct drm_buf **buflist; /**< Vector of pointers into drm_device_dma::bufs */
455 int page_count; /**< number of pages */
456 unsigned long *pagelist; /**< page list */
457 unsigned long byte_count;
459 _DRM_DMA_USE_AGP = 0x01,
460 _DRM_DMA_USE_SG = 0x02,
461 _DRM_DMA_USE_FB = 0x04,
462 _DRM_DMA_USE_PCI_RO = 0x08
468 * AGP memory entry. Stored as a doubly linked list.
471 unsigned long handle; /**< handle */
473 unsigned long bound; /**< address */
475 struct list_head head;
481 * \sa drm_agp_init() and drm_device::agp.
483 struct drm_agp_head {
484 DRM_AGP_KERN agp_info; /**< AGP device information */
485 struct list_head memory;
486 unsigned long mode; /**< AGP mode */
488 int enabled; /**< whether the AGP bus as been enabled */
489 int acquired; /**< whether the AGP device has been acquired */
492 int cant_use_aperture;
496 * Scatter-gather memory.
506 struct drm_hw_lock *lock;
510 * Kernel side of a mapping
512 #define DRM_MAP_HANDLE_BITS (sizeof(void *) == 4 ? 4 : 24)
513 #define DRM_MAP_HANDLE_SHIFT (sizeof(void *) * 8 - DRM_MAP_HANDLE_BITS)
515 struct drm_local_map {
516 resource_size_t offset; /**< Requested physical address (0 for SAREA)*/
517 unsigned long size; /**< Requested physical size (bytes) */
518 enum drm_map_type type; /**< Type of memory to map */
519 enum drm_map_flags flags; /**< Flags */
520 void *handle; /**< User-space: "Handle" to pass to mmap() */
521 /**< Kernel-space: kernel-virtual address */
522 int mtrr; /**< MTRR slot used */
525 drm_dma_handle_t *dmah;
528 typedef struct drm_local_map drm_local_map_t;
533 struct drm_map_list {
534 struct list_head head; /**< list head */
535 struct drm_hash_item hash;
536 struct drm_local_map *map; /**< mapping */
538 struct drm_master *master;
539 struct drm_mm_node *file_offset_node; /**< fake offset */
543 * Context handle list
545 struct drm_ctx_list {
546 struct list_head head; /**< list head */
547 drm_context_t handle; /**< context handle */
548 struct drm_file *tag; /**< associated fd private data */
551 /* location of GART table */
552 #define DRM_ATI_GART_MAIN 1
553 #define DRM_ATI_GART_FB 2
555 #define DRM_ATI_GART_PCI 1
556 #define DRM_ATI_GART_PCIE 2
557 #define DRM_ATI_GART_IGP 3
559 struct drm_ati_pcigart_info {
560 int gart_table_location;
564 dma_addr_t table_mask;
565 struct drm_dma_handle *table_handle;
566 struct drm_local_map mapping;
568 struct drm_dma_handle *dmah; /* handle for ATI PCIGART table FIXME */
572 * GEM specific mm private for tracking GEM objects
575 struct unrhdr *idxunr;
576 struct drm_open_hash offset_hash; /**< User token hash table for maps */
580 * This structure defines the drm_mm memory object, which will be used by the
581 * DRM for its buffer objects.
583 struct drm_gem_object {
584 /** Reference count of this object */
587 /** Handle count of this object. Each handle also holds a reference */
588 atomic_t handle_count; /* number of handles on this object */
590 /** Related drm device */
591 struct drm_device *dev;
593 /** File representing the shmem storage: filp in Linux parlance */
596 /* Mapping info for this object */
598 struct drm_hash_item map_list;
601 * Size of the object, in bytes. Immutable over the object's
607 * Global name for this object, starts at 1. 0 means unnamed.
608 * Access is covered by the object_name_lock in the related drm_device
613 * Memory domains. These monitor which caches contain read/write data
614 * related to the object. When transitioning from one set of domains
615 * to another, the driver is called to ensure that caches are suitably
616 * flushed and invalidated
618 uint32_t read_domains;
619 uint32_t write_domain;
622 * While validating an exec operation, the
623 * new read/write domain values are computed here.
624 * They will be transferred to the above values
625 * at the point that any cache flushing occurs
627 uint32_t pending_read_domains;
628 uint32_t pending_write_domain;
630 void *driver_private;
632 #ifdef FREEBSD_NOTYET
633 /* dma buf exported from this GEM object */
634 struct dma_buf *export_dma_buf;
636 /* dma buf attachment backing this object */
637 struct dma_buf_attachment *import_attach;
638 #endif /* FREEBSD_NOTYET */
641 #include <dev/drm2/drm_crtc.h>
643 /* per-master structure */
646 u_int refcount; /* refcount for this master */
648 struct list_head head; /**< each minor contains a list of masters */
649 struct drm_minor *minor; /**< link back to minor we are a master for */
651 char *unique; /**< Unique identifier: e.g., busid */
652 int unique_len; /**< Length of unique field */
653 int unique_size; /**< amount allocated */
655 int blocked; /**< Blocked due to VC switch? */
657 /** \name Authentication */
659 struct drm_open_hash magiclist;
660 struct list_head magicfree;
663 struct drm_lock_data lock; /**< Information on hardware lock */
665 void *driver_priv; /**< Private structure for driver to use */
668 /* Size of ringbuffer for vblank timestamps. Just double-buffer
669 * in initial implementation.
671 #define DRM_VBLANKTIME_RBSIZE 2
673 /* Flags and return codes for get_vblank_timestamp() driver function. */
674 #define DRM_CALLED_FROM_VBLIRQ 1
675 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
676 #define DRM_VBLANKTIME_INVBL (1 << 1)
678 /* get_scanout_position() return flags */
679 #define DRM_SCANOUTPOS_VALID (1 << 0)
680 #define DRM_SCANOUTPOS_INVBL (1 << 1)
681 #define DRM_SCANOUTPOS_ACCURATE (1 << 2)
685 int (*get_irq)(struct drm_device *dev);
686 void (*free_irq)(struct drm_device *dev);
687 const char *(*get_name)(struct drm_device *dev);
688 int (*set_busid)(struct drm_device *dev, struct drm_master *master);
689 int (*set_unique)(struct drm_device *dev, struct drm_master *master,
690 struct drm_unique *unique);
691 int (*irq_by_busid)(struct drm_device *dev, struct drm_irq_busid *p);
692 /* hooks that are for PCI */
693 int (*agp_init)(struct drm_device *dev);
698 * DRM driver structure. This structure represent the common code for
699 * a family of cards. There will one drm_device for each card present
703 int (*load) (struct drm_device *, unsigned long flags);
704 int (*firstopen) (struct drm_device *);
705 int (*open) (struct drm_device *, struct drm_file *);
706 void (*preclose) (struct drm_device *, struct drm_file *file_priv);
707 void (*postclose) (struct drm_device *, struct drm_file *);
708 void (*lastclose) (struct drm_device *);
709 int (*unload) (struct drm_device *);
710 int (*suspend) (struct drm_device *, pm_message_t state);
711 int (*resume) (struct drm_device *);
712 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
713 int (*dma_quiescent) (struct drm_device *);
714 int (*context_dtor) (struct drm_device *dev, int context);
717 * get_vblank_counter - get raw hardware vblank counter
719 * @crtc: counter to fetch
721 * Driver callback for fetching a raw hardware vblank counter for @crtc.
722 * If a device doesn't have a hardware counter, the driver can simply
723 * return the value of drm_vblank_count. The DRM core will account for
724 * missed vblank events while interrupts where disabled based on system
727 * Wraparound handling and loss of events due to modesetting is dealt
728 * with in the DRM core code.
731 * Raw vblank counter value.
733 u32 (*get_vblank_counter) (struct drm_device *dev, int crtc);
736 * enable_vblank - enable vblank interrupt events
738 * @crtc: which irq to enable
740 * Enable vblank interrupts for @crtc. If the device doesn't have
741 * a hardware vblank counter, this routine should be a no-op, since
742 * interrupts will have to stay on to keep the count accurate.
745 * Zero on success, appropriate errno if the given @crtc's vblank
746 * interrupt cannot be enabled.
748 int (*enable_vblank) (struct drm_device *dev, int crtc);
751 * disable_vblank - disable vblank interrupt events
753 * @crtc: which irq to enable
755 * Disable vblank interrupts for @crtc. If the device doesn't have
756 * a hardware vblank counter, this routine should be a no-op, since
757 * interrupts will have to stay on to keep the count accurate.
759 void (*disable_vblank) (struct drm_device *dev, int crtc);
762 * Called by \c drm_device_is_agp. Typically used to determine if a
763 * card is really attached to AGP or not.
765 * \param dev DRM device handle
768 * One of three values is returned depending on whether or not the
769 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
770 * (return of 1), or may or may not be AGP (return of 2).
772 int (*device_is_agp) (struct drm_device *dev);
775 * Called by vblank timestamping code.
777 * Return the current display scanout position from a crtc.
779 * \param dev DRM device.
780 * \param crtc Id of the crtc to query.
781 * \param *vpos Target location for current vertical scanout position.
782 * \param *hpos Target location for current horizontal scanout position.
784 * Returns vpos as a positive number while in active scanout area.
785 * Returns vpos as a negative number inside vblank, counting the number
786 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
787 * until start of active scanout / end of vblank."
789 * \return Flags, or'ed together as follows:
791 * DRM_SCANOUTPOS_VALID = Query successful.
792 * DRM_SCANOUTPOS_INVBL = Inside vblank.
793 * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
794 * this flag means that returned position may be offset by a constant
795 * but unknown small number of scanlines wrt. real scanout position.
798 int (*get_scanout_position) (struct drm_device *dev, int crtc,
799 int *vpos, int *hpos);
802 * Called by \c drm_get_last_vbltimestamp. Should return a precise
803 * timestamp when the most recent VBLANK interval ended or will end.
805 * Specifically, the timestamp in @vblank_time should correspond as
806 * closely as possible to the time when the first video scanline of
807 * the video frame after the end of VBLANK will start scanning out,
808 * the time immediately after end of the VBLANK interval. If the
809 * @crtc is currently inside VBLANK, this will be a time in the future.
810 * If the @crtc is currently scanning out a frame, this will be the
811 * past start time of the current scanout. This is meant to adhere
812 * to the OpenML OML_sync_control extension specification.
814 * \param dev dev DRM device handle.
815 * \param crtc crtc for which timestamp should be returned.
816 * \param *max_error Maximum allowable timestamp error in nanoseconds.
817 * Implementation should strive to provide timestamp
818 * with an error of at most *max_error nanoseconds.
819 * Returns true upper bound on error for timestamp.
820 * \param *vblank_time Target location for returned vblank timestamp.
821 * \param flags 0 = Defaults, no special treatment needed.
822 * \param DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
823 * irq handler. Some drivers need to apply some workarounds
824 * for gpu-specific vblank irq quirks if flag is set.
827 * Zero if timestamping isn't supported in current display mode or a
828 * negative number on failure. A positive status code on success,
829 * which describes how the vblank_time timestamp was computed.
831 int (*get_vblank_timestamp) (struct drm_device *dev, int crtc,
833 struct timeval *vblank_time,
836 /* these have to be filled in */
838 irqreturn_t(*irq_handler) (DRM_IRQ_ARGS);
839 void (*irq_preinstall) (struct drm_device *dev);
840 int (*irq_postinstall) (struct drm_device *dev);
841 void (*irq_uninstall) (struct drm_device *dev);
842 void (*set_version) (struct drm_device *dev,
843 struct drm_set_version *sv);
845 /* Master routines */
846 int (*master_create)(struct drm_device *dev, struct drm_master *master);
847 void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
849 * master_set is called whenever the minor master is set.
850 * master_drop is called whenever the minor master is dropped.
853 int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
855 void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv,
859 * Driver-specific constructor for drm_gem_objects, to set up
860 * obj->driver_private.
862 * Returns 0 on success.
864 int (*gem_init_object) (struct drm_gem_object *obj);
865 void (*gem_free_object) (struct drm_gem_object *obj);
866 int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
867 void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
869 #ifdef FREEBSD_NOTYET
871 /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
872 int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
873 uint32_t handle, uint32_t flags, int *prime_fd);
874 /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
875 int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
876 int prime_fd, uint32_t *handle);
877 /* export GEM -> dmabuf */
878 struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
879 struct drm_gem_object *obj, int flags);
880 /* import dmabuf -> GEM */
881 struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
882 struct dma_buf *dma_buf);
883 #endif /* defined(FREEBSD_NOTYET) */
885 /* dumb alloc support */
886 int (*dumb_create)(struct drm_file *file_priv,
887 struct drm_device *dev,
888 struct drm_mode_create_dumb *args);
889 int (*dumb_map_offset)(struct drm_file *file_priv,
890 struct drm_device *dev, uint32_t handle,
892 int (*dumb_destroy)(struct drm_file *file_priv,
893 struct drm_device *dev,
896 /* Driver private ops for this object */
897 struct cdev_pager_ops *gem_pager_ops;
899 int (*sysctl_init)(struct drm_device *dev,
900 struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
901 void (*sysctl_cleanup)(struct drm_device *dev);
912 struct drm_ioctl_desc *ioctls;
915 #ifdef COMPAT_FREEBSD32
916 struct drm_ioctl_desc *compat_ioctls;
917 int *num_compat_ioctls;
923 #define DRM_MINOR_UNASSIGNED 0
924 #define DRM_MINOR_LEGACY 1
925 #define DRM_MINOR_CONTROL 2
926 #define DRM_MINOR_RENDER 3
929 * DRM minor structure. This structure represents a drm minor number.
932 int index; /**< Minor device number */
933 int type; /**< Control or render */
934 struct cdev *device; /**< Device number for mknod */
935 device_t kdev; /**< OS device */
936 struct drm_device *dev;
938 struct drm_master *master; /* currently active master for this node */
939 struct list_head master_list;
940 struct drm_mode_group mode_group;
942 struct sigio *buf_sigio; /* Processes waiting for SIGIO */
945 /* mode specified on the command line */
946 struct drm_cmdline_mode {
948 bool refresh_specified;
957 enum drm_connector_force force;
961 struct drm_pending_vblank_event {
962 struct drm_pending_event base;
964 struct drm_event_vblank event;
968 * DRM device structure. This structure represent a complete card that
969 * may contain multiple heads.
972 int if_version; /**< Highest interface version set */
976 struct mtx count_lock; /**< For inuse, drm_device::open_count, drm_device::buf_use */
977 struct sx dev_struct_lock; /**< For others */
980 /** \name Usage Counters */
982 int open_count; /**< Outstanding files open */
983 atomic_t ioctl_count; /**< Outstanding IOCTLs pending */
984 atomic_t vma_count; /**< Outstanding vma areas open */
985 int buf_use; /**< Buffers in use -- cannot alloc */
986 atomic_t buf_alloc; /**< Buffer allocation in progress */
989 /** \name Performance counters */
991 unsigned long counters;
992 enum drm_stat_type types[15];
996 struct list_head filelist;
998 /** \name Memory management */
1000 struct list_head maplist; /**< Linked list of regions */
1001 int map_count; /**< Number of mappable regions */
1002 struct drm_open_hash map_hash; /**< User token hash table for maps */
1004 /** \name Context handle management */
1006 struct list_head ctxlist; /**< Linked list of context handles */
1007 int ctx_count; /**< Number of context handles */
1008 struct mtx ctxlist_mutex; /**< For ctxlist */
1009 drm_local_map_t **context_sareas;
1011 unsigned long *ctx_bitmap;
1015 /** \name DMA support */
1017 struct drm_device_dma *dma; /**< Optional pointer for DMA support */
1020 /** \name Context support */
1022 int irq_enabled; /**< True if irq handler is enabled */
1023 atomic_t context_flag; /**< Context swapping flag */
1024 atomic_t interrupt_flag; /**< Interruption handler flag */
1025 atomic_t dma_flag; /**< DMA dispatch flag */
1026 wait_queue_head_t context_wait; /**< Processes waiting on ctx switch */
1027 int last_checked; /**< Last context checked for DMA */
1028 int last_context; /**< Last current context */
1029 unsigned long last_switch; /**< jiffies at last context switch */
1032 /** \name VBLANK IRQ support */
1036 * At load time, disabling the vblank interrupt won't be allowed since
1037 * old clients may not call the modeset ioctl and therefore misbehave.
1038 * Once the modeset ioctl *has* been called though, we can safely
1039 * disable them when unused.
1041 int vblank_disable_allowed;
1043 atomic_t *_vblank_count; /**< number of VBLANK interrupts (driver must alloc the right number of counters) */
1044 struct timeval *_vblank_time; /**< timestamp of current vblank_count (drivers must alloc right number of fields) */
1045 struct mtx vblank_time_lock; /**< Protects vblank count and time updates during vblank enable/disable */
1046 struct mtx vbl_lock;
1047 atomic_t *vblank_refcount; /* number of users of vblank interruptsper crtc */
1048 u32 *last_vblank; /* protected by dev->vbl_lock, used */
1049 /* for wraparound handling */
1050 int *vblank_enabled; /* so we don't call enable more than
1052 int *vblank_inmodeset; /* Display driver is setting mode */
1053 u32 *last_vblank_wait; /* Last vblank seqno waited per CRTC */
1054 struct callout vblank_disable_callout;
1056 u32 max_vblank_count; /**< size of vblank counter register */
1061 struct list_head vblank_event_list;
1062 struct mtx event_lock;
1066 struct drm_agp_head *agp; /**< AGP data */
1068 device_t dev; /* Device instance from newbus */
1069 uint16_t pci_device; /* PCI device id */
1070 uint16_t pci_vendor; /* PCI vendor id */
1071 uint16_t pci_subdevice; /* PCI subsystem device id */
1072 uint16_t pci_subvendor; /* PCI subsystem vendor id */
1074 struct drm_sg_mem *sg; /**< Scatter gather memory */
1075 unsigned int num_crtcs; /**< Number of CRTCs on this device */
1076 void *dev_private; /**< device private data */
1078 struct drm_sigdata sigdata; /**< For block_all_signals */
1081 struct drm_driver *driver;
1082 struct drm_local_map *agp_buffer_map;
1083 unsigned int agp_buffer_token;
1084 struct drm_minor *control; /**< Control node for card */
1085 struct drm_minor *primary; /**< render type primary screen head */
1087 struct drm_mode_config mode_config; /**< Current mode config */
1089 /** \name GEM information */
1091 struct sx object_name_lock;
1092 struct drm_gem_names object_names;
1094 int switch_power_state;
1096 atomic_t unplugged; /* device has been unplugged or gone away */
1099 struct mtx dma_lock; /* protects dev->dma */
1100 struct mtx irq_lock; /* protects irq condition checks */
1102 /* Context support */
1103 int irq; /* Interrupt used by board */
1104 int msi_enabled; /* MSI enabled */
1105 int irqrid; /* Interrupt used by board */
1106 struct resource *irqr; /* Resource for interrupt used by board */
1107 void *irqh; /* Handle from bus_setup_intr */
1109 /* Storage of resource pointers for drm_get_resource_* */
1110 #define DRM_MAX_PCI_RESOURCE 6
1111 struct resource *pcir[DRM_MAX_PCI_RESOURCE];
1112 int pcirid[DRM_MAX_PCI_RESOURCE];
1113 struct mtx pcir_lock;
1120 /* Sysctl support */
1121 struct drm_sysctl_info *sysctl;
1122 int sysctl_node_idx;
1126 void *sysctl_private;
1127 char busid_str[128];
1130 const drm_pci_id_list_t *id_entry; /* PCI ID, name, and chipset private */
1133 #define DRM_SWITCH_POWER_ON 0
1134 #define DRM_SWITCH_POWER_OFF 1
1135 #define DRM_SWITCH_POWER_CHANGING 2
1137 static __inline__ int drm_core_check_feature(struct drm_device *dev,
1140 return ((dev->driver->driver_features & feature) ? 1 : 0);
1143 static inline int drm_dev_to_irq(struct drm_device *dev)
1145 return dev->driver->bus->get_irq(dev);
1150 static inline int drm_core_has_AGP(struct drm_device *dev)
1152 return drm_core_check_feature(dev, DRIVER_USE_AGP);
1155 #define drm_core_has_AGP(dev) (0)
1159 static inline int drm_core_has_MTRR(struct drm_device *dev)
1161 return drm_core_check_feature(dev, DRIVER_USE_MTRR);
1164 #define DRM_MTRR_WC MDF_WRITECOMBINE
1166 int drm_mtrr_add(unsigned long offset, unsigned long size, unsigned int flags);
1167 int drm_mtrr_del(int handle, unsigned long offset, unsigned long size, unsigned int flags);
1170 #define drm_core_has_MTRR(dev) (0)
1172 #define DRM_MTRR_WC 0
1174 static inline int drm_mtrr_add(unsigned long offset, unsigned long size,
1180 static inline int drm_mtrr_del(int handle, unsigned long offset,
1181 unsigned long size, unsigned int flags)
1187 /******************************************************************/
1188 /** \name Internal function definitions */
1191 /* Driver support (drm_drv.h) */
1192 d_ioctl_t drm_ioctl;
1193 extern int drm_lastclose(struct drm_device *dev);
1195 /* Device support (drm_fops.h) */
1196 extern struct sx drm_global_mutex;
1199 extern void drm_release(void *data);
1201 /* Mapping support (drm_vm.h) */
1203 int drm_mmap_single(struct cdev *kdev, vm_ooffset_t *offset,
1204 vm_size_t size, struct vm_object **obj_res, int nprot);
1208 /* Misc. IOCTL support (drm_ioctl.h) */
1209 extern int drm_irq_by_busid(struct drm_device *dev, void *data,
1210 struct drm_file *file_priv);
1211 extern int drm_getunique(struct drm_device *dev, void *data,
1212 struct drm_file *file_priv);
1213 extern int drm_setunique(struct drm_device *dev, void *data,
1214 struct drm_file *file_priv);
1215 extern int drm_getmap(struct drm_device *dev, void *data,
1216 struct drm_file *file_priv);
1217 extern int drm_getclient(struct drm_device *dev, void *data,
1218 struct drm_file *file_priv);
1219 extern int drm_getstats(struct drm_device *dev, void *data,
1220 struct drm_file *file_priv);
1221 extern int drm_getcap(struct drm_device *dev, void *data,
1222 struct drm_file *file_priv);
1223 extern int drm_setversion(struct drm_device *dev, void *data,
1224 struct drm_file *file_priv);
1225 extern int drm_noop(struct drm_device *dev, void *data,
1226 struct drm_file *file_priv);
1228 /* Context IOCTL support (drm_context.h) */
1229 extern int drm_resctx(struct drm_device *dev, void *data,
1230 struct drm_file *file_priv);
1231 extern int drm_addctx(struct drm_device *dev, void *data,
1232 struct drm_file *file_priv);
1233 extern int drm_modctx(struct drm_device *dev, void *data,
1234 struct drm_file *file_priv);
1235 extern int drm_getctx(struct drm_device *dev, void *data,
1236 struct drm_file *file_priv);
1237 extern int drm_switchctx(struct drm_device *dev, void *data,
1238 struct drm_file *file_priv);
1239 extern int drm_newctx(struct drm_device *dev, void *data,
1240 struct drm_file *file_priv);
1241 extern int drm_rmctx(struct drm_device *dev, void *data,
1242 struct drm_file *file_priv);
1244 extern int drm_ctxbitmap_init(struct drm_device *dev);
1245 extern void drm_ctxbitmap_cleanup(struct drm_device *dev);
1246 extern void drm_ctxbitmap_free(struct drm_device *dev, int ctx_handle);
1248 extern int drm_setsareactx(struct drm_device *dev, void *data,
1249 struct drm_file *file_priv);
1250 extern int drm_getsareactx(struct drm_device *dev, void *data,
1251 struct drm_file *file_priv);
1253 /* Authentication IOCTL support (drm_auth.h) */
1254 extern int drm_getmagic(struct drm_device *dev, void *data,
1255 struct drm_file *file_priv);
1256 extern int drm_authmagic(struct drm_device *dev, void *data,
1257 struct drm_file *file_priv);
1258 extern int drm_remove_magic(struct drm_master *master, drm_magic_t magic);
1260 /* Cache management (drm_cache.c) */
1261 void drm_clflush_pages(vm_page_t *pages, unsigned long num_pages);
1262 void drm_clflush_virt_range(char *addr, unsigned long length);
1264 /* Locking IOCTL support (drm_lock.h) */
1265 extern int drm_lock(struct drm_device *dev, void *data,
1266 struct drm_file *file_priv);
1267 extern int drm_unlock(struct drm_device *dev, void *data,
1268 struct drm_file *file_priv);
1269 extern int drm_lock_free(struct drm_lock_data *lock_data, unsigned int context);
1270 extern void drm_idlelock_take(struct drm_lock_data *lock_data);
1271 extern void drm_idlelock_release(struct drm_lock_data *lock_data);
1274 * These are exported to drivers so that they can implement fencing using
1275 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1278 extern int drm_i_have_hw_lock(struct drm_device *dev, struct drm_file *file_priv);
1280 /* Buffer management support (drm_bufs.h) */
1281 extern int drm_addbufs_agp(struct drm_device *dev, struct drm_buf_desc * request);
1282 extern int drm_addbufs_pci(struct drm_device *dev, struct drm_buf_desc * request);
1283 extern int drm_addmap(struct drm_device *dev, resource_size_t offset,
1284 unsigned int size, enum drm_map_type type,
1285 enum drm_map_flags flags, struct drm_local_map **map_ptr);
1286 extern int drm_addmap_ioctl(struct drm_device *dev, void *data,
1287 struct drm_file *file_priv);
1288 extern int drm_rmmap(struct drm_device *dev, struct drm_local_map *map);
1289 extern int drm_rmmap_locked(struct drm_device *dev, struct drm_local_map *map);
1290 extern int drm_rmmap_ioctl(struct drm_device *dev, void *data,
1291 struct drm_file *file_priv);
1292 extern int drm_addbufs(struct drm_device *dev, void *data,
1293 struct drm_file *file_priv);
1294 extern int drm_infobufs(struct drm_device *dev, void *data,
1295 struct drm_file *file_priv);
1296 extern int drm_markbufs(struct drm_device *dev, void *data,
1297 struct drm_file *file_priv);
1298 extern int drm_freebufs(struct drm_device *dev, void *data,
1299 struct drm_file *file_priv);
1300 extern int drm_mapbufs(struct drm_device *dev, void *data,
1301 struct drm_file *file_priv);
1302 extern int drm_order(unsigned long size);
1304 /* DMA support (drm_dma.h) */
1305 extern int drm_dma_setup(struct drm_device *dev);
1306 extern void drm_dma_takedown(struct drm_device *dev);
1307 extern void drm_free_buffer(struct drm_device *dev, struct drm_buf * buf);
1308 extern void drm_core_reclaim_buffers(struct drm_device *dev,
1309 struct drm_file *filp);
1311 /* IRQ support (drm_irq.h) */
1312 extern int drm_control(struct drm_device *dev, void *data,
1313 struct drm_file *file_priv);
1314 extern int drm_irq_install(struct drm_device *dev);
1315 extern int drm_irq_uninstall(struct drm_device *dev);
1317 extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
1318 extern int drm_wait_vblank(struct drm_device *dev, void *data,
1319 struct drm_file *filp);
1320 extern int drm_vblank_wait(struct drm_device *dev, unsigned int *vbl_seq);
1321 extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
1322 extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
1323 struct timeval *vblanktime);
1324 extern void drm_send_vblank_event(struct drm_device *dev, int crtc,
1325 struct drm_pending_vblank_event *e);
1326 extern bool drm_handle_vblank(struct drm_device *dev, int crtc);
1327 extern int drm_vblank_get(struct drm_device *dev, int crtc);
1328 extern void drm_vblank_put(struct drm_device *dev, int crtc);
1329 extern void drm_vblank_off(struct drm_device *dev, int crtc);
1330 extern void drm_vblank_cleanup(struct drm_device *dev);
1331 extern u32 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
1332 struct timeval *tvblank, unsigned flags);
1333 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
1334 int crtc, int *max_error,
1335 struct timeval *vblank_time,
1337 struct drm_crtc *refcrtc);
1338 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc);
1341 drm_mode_parse_command_line_for_connector(const char *mode_option,
1342 struct drm_connector *connector,
1343 struct drm_cmdline_mode *mode);
1345 extern struct drm_display_mode *
1346 drm_mode_create_from_cmdline_mode(struct drm_device *dev,
1347 struct drm_cmdline_mode *cmd);
1349 /* Modesetting support */
1350 extern void drm_vblank_pre_modeset(struct drm_device *dev, int crtc);
1351 extern void drm_vblank_post_modeset(struct drm_device *dev, int crtc);
1352 extern int drm_modeset_ctl(struct drm_device *dev, void *data,
1353 struct drm_file *file_priv);
1356 /* Stub support (drm_stub.h) */
1357 extern int drm_setmaster_ioctl(struct drm_device *dev, void *data,
1358 struct drm_file *file_priv);
1359 extern int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
1360 struct drm_file *file_priv);
1361 struct drm_master *drm_master_create(struct drm_minor *minor);
1362 extern struct drm_master *drm_master_get(struct drm_master *master);
1363 extern void drm_master_put(struct drm_master **master);
1365 extern void drm_put_dev(struct drm_device *dev);
1366 extern int drm_put_minor(struct drm_minor **minor);
1367 extern void drm_unplug_dev(struct drm_device *dev);
1368 extern unsigned int drm_debug;
1369 extern unsigned int drm_notyet;
1371 extern unsigned int drm_vblank_offdelay;
1372 extern unsigned int drm_timestamp_precision;
1373 extern unsigned int drm_timestamp_monotonic;
1375 extern struct drm_local_map *drm_getsarea(struct drm_device *dev);
1378 #ifdef FREEBSD_NOTYET
1379 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1380 struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1382 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1383 struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1385 extern int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
1386 struct drm_file *file_priv);
1387 extern int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
1388 struct drm_file *file_priv);
1390 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, vm_page_t *pages,
1391 dma_addr_t *addrs, int max_pages);
1392 extern struct sg_table *drm_prime_pages_to_sg(vm_page_t *pages, int nr_pages);
1393 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1396 void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv);
1397 void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv);
1398 int drm_prime_add_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t handle);
1399 int drm_prime_lookup_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t *handle);
1400 void drm_prime_remove_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf);
1402 int drm_prime_add_dma_buf(struct drm_device *dev, struct drm_gem_object *obj);
1403 int drm_prime_lookup_obj(struct drm_device *dev, struct dma_buf *buf,
1404 struct drm_gem_object **obj);
1405 #endif /* FREEBSD_NOTYET */
1407 /* Scatter Gather Support (drm_scatter.h) */
1408 extern void drm_sg_cleanup(struct drm_sg_mem * entry);
1409 extern int drm_sg_alloc_ioctl(struct drm_device *dev, void *data,
1410 struct drm_file *file_priv);
1411 extern int drm_sg_alloc(struct drm_device *dev, struct drm_scatter_gather * request);
1412 extern int drm_sg_free(struct drm_device *dev, void *data,
1413 struct drm_file *file_priv);
1415 /* ATI PCIGART support (ati_pcigart.h) */
1416 extern int drm_ati_pcigart_init(struct drm_device *dev,
1417 struct drm_ati_pcigart_info * gart_info);
1418 extern int drm_ati_pcigart_cleanup(struct drm_device *dev,
1419 struct drm_ati_pcigart_info * gart_info);
1421 extern drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
1422 size_t align, dma_addr_t maxaddr);
1423 extern void __drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1424 extern void drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1426 /* Graphics Execution Manager library functions (drm_gem.c) */
1427 int drm_gem_init(struct drm_device *dev);
1428 void drm_gem_destroy(struct drm_device *dev);
1429 void drm_gem_object_release(struct drm_gem_object *obj);
1430 void drm_gem_object_free(struct drm_gem_object *obj);
1431 struct drm_gem_object *drm_gem_object_alloc(struct drm_device *dev,
1433 int drm_gem_object_init(struct drm_device *dev,
1434 struct drm_gem_object *obj, size_t size);
1435 int drm_gem_private_object_init(struct drm_device *dev,
1436 struct drm_gem_object *obj, size_t size);
1437 void drm_gem_object_handle_free(struct drm_gem_object *obj);
1438 int drm_gem_mmap_single(struct drm_device *dev, vm_ooffset_t *offset,
1439 vm_size_t size, struct vm_object **obj_res, int nprot);
1440 void drm_gem_pager_dtr(void *obj);
1442 #include <dev/drm2/drm_global.h>
1445 drm_gem_object_reference(struct drm_gem_object *obj)
1448 KASSERT(obj->refcount > 0, ("Dangling obj %p", obj));
1449 refcount_acquire(&obj->refcount);
1453 drm_gem_object_unreference(struct drm_gem_object *obj)
1458 if (refcount_release(&obj->refcount))
1459 drm_gem_object_free(obj);
1463 drm_gem_object_unreference_unlocked(struct drm_gem_object *obj)
1466 struct drm_device *dev = obj->dev;
1468 drm_gem_object_unreference(obj);
1473 int drm_gem_handle_create(struct drm_file *file_priv,
1474 struct drm_gem_object *obj,
1476 int drm_gem_handle_delete(struct drm_file *filp, u32 handle);
1479 drm_gem_object_handle_reference(struct drm_gem_object *obj)
1481 drm_gem_object_reference(obj);
1482 atomic_inc(&obj->handle_count);
1486 drm_gem_object_handle_unreference(struct drm_gem_object *obj)
1491 if (atomic_read(&obj->handle_count) == 0)
1494 * Must bump handle count first as this may be the last
1495 * ref, in which case the object would disappear before we
1496 * checked for a name
1498 if (atomic_dec_and_test(&obj->handle_count))
1499 drm_gem_object_handle_free(obj);
1500 drm_gem_object_unreference(obj);
1504 drm_gem_object_handle_unreference_unlocked(struct drm_gem_object *obj)
1509 if (atomic_read(&obj->handle_count) == 0)
1513 * Must bump handle count first as this may be the last
1514 * ref, in which case the object would disappear before we
1515 * checked for a name
1518 if (atomic_dec_and_test(&obj->handle_count))
1519 drm_gem_object_handle_free(obj);
1520 drm_gem_object_unreference_unlocked(obj);
1523 void drm_gem_free_mmap_offset(struct drm_gem_object *obj);
1524 int drm_gem_create_mmap_offset(struct drm_gem_object *obj);
1526 struct drm_gem_object *drm_gem_object_lookup(struct drm_device *dev,
1527 struct drm_file *filp,
1529 int drm_gem_close_ioctl(struct drm_device *dev, void *data,
1530 struct drm_file *file_priv);
1531 int drm_gem_flink_ioctl(struct drm_device *dev, void *data,
1532 struct drm_file *file_priv);
1533 int drm_gem_open_ioctl(struct drm_device *dev, void *data,
1534 struct drm_file *file_priv);
1535 void drm_gem_open(struct drm_device *dev, struct drm_file *file_private);
1536 void drm_gem_release(struct drm_device *dev, struct drm_file *file_private);
1538 extern void drm_core_ioremap(struct drm_local_map *map, struct drm_device *dev);
1539 extern void drm_core_ioremap_wc(struct drm_local_map *map, struct drm_device *dev);
1540 extern void drm_core_ioremapfree(struct drm_local_map *map, struct drm_device *dev);
1542 static __inline__ struct drm_local_map *drm_core_findmap(struct drm_device *dev,
1545 struct drm_map_list *_entry;
1546 list_for_each_entry(_entry, &dev->maplist, head)
1547 if (_entry->user_token == token)
1552 static __inline__ void drm_core_dropmap(struct drm_local_map *map)
1556 #include <dev/drm2/drm_mem_util.h>
1558 extern int drm_fill_in_dev(struct drm_device *dev,
1559 struct drm_driver *driver);
1560 extern void drm_cancel_fill_in_dev(struct drm_device *dev);
1561 int drm_get_minor(struct drm_device *dev, struct drm_minor **minor, int type);
1565 int drm_pci_device_is_agp(struct drm_device *dev);
1566 int drm_pci_device_is_pcie(struct drm_device *dev);
1568 extern int drm_get_pci_dev(device_t kdev, struct drm_device *dev,
1569 struct drm_driver *driver);
1571 #define DRM_PCIE_SPEED_25 1
1572 #define DRM_PCIE_SPEED_50 2
1573 #define DRM_PCIE_SPEED_80 4
1575 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1577 #define drm_can_sleep() (DRM_HZ & 1)
1579 /* Platform section */
1580 int drm_get_platform_dev(device_t kdev, struct drm_device *dev,
1581 struct drm_driver *driver);
1583 /* FreeBSD specific -- should be moved to drm_os_freebsd.h */
1585 #define DRM_GEM_MAPPING_MASK (3ULL << 62)
1586 #define DRM_GEM_MAPPING_KEY (2ULL << 62) /* Non-canonical address form */
1587 #define DRM_GEM_MAX_IDX 0x3fffff
1588 #define DRM_GEM_MAPPING_IDX(o) (((o) >> 40) & DRM_GEM_MAX_IDX)
1589 #define DRM_GEM_MAPPING_OFF(i) (((uint64_t)(i)) << 40)
1590 #define DRM_GEM_MAPPING_MAPOFF(o) \
1591 ((o) & ~(DRM_GEM_MAPPING_OFF(DRM_GEM_MAX_IDX) | DRM_GEM_MAPPING_KEY))
1593 SYSCTL_DECL(_hw_drm);
1595 #define DRM_DEV_MODE (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
1596 #define DRM_DEV_UID UID_ROOT
1597 #define DRM_DEV_GID GID_VIDEO
1599 #define DRM_WAKEUP(w) wakeup((void *)w)
1600 #define DRM_WAKEUP_INT(w) wakeup(w)
1601 #define DRM_INIT_WAITQUEUE(queue) do {(void)(queue);} while (0)
1603 #define DRM_CURPROC curthread
1604 #define DRM_STRUCTPROC struct thread
1605 #define DRM_SPINTYPE struct mtx
1606 #define DRM_SPININIT(l,name) mtx_init(l, name, NULL, MTX_DEF)
1607 #define DRM_SPINUNINIT(l) mtx_destroy(l)
1608 #define DRM_SPINLOCK(l) mtx_lock(l)
1609 #define DRM_SPINUNLOCK(u) mtx_unlock(u)
1610 #define DRM_SPINLOCK_IRQSAVE(l, irqflags) do { \
1614 #define DRM_SPINUNLOCK_IRQRESTORE(u, irqflags) mtx_unlock(u)
1615 #define DRM_SPINLOCK_ASSERT(l) mtx_assert(l, MA_OWNED)
1616 #define DRM_LOCK_SLEEP(dev, chan, flags, msg, timeout) \
1617 (sx_sleep((chan), &(dev)->dev_struct_lock, (flags), (msg), (timeout)))
1618 #if defined(INVARIANTS)
1619 #define DRM_LOCK_ASSERT(dev) sx_assert(&(dev)->dev_struct_lock, SA_XLOCKED)
1620 #define DRM_UNLOCK_ASSERT(dev) sx_assert(&(dev)->dev_struct_lock, SA_UNLOCKED)
1622 #define DRM_LOCK_ASSERT(d)
1623 #define DRM_UNLOCK_ASSERT(d)
1626 #define DRM_SYSCTL_HANDLER_ARGS (SYSCTL_HANDLER_ARGS)
1634 #define DRM_VERIFYAREA_READ( uaddr, size ) \
1635 (!useracc(__DECONST(caddr_t, uaddr), size, VM_PROT_READ))
1637 #define DRM_COPY_TO_USER(user, kern, size) \
1638 copyout(kern, user, size)
1639 #define DRM_COPY_FROM_USER(kern, user, size) \
1640 copyin(user, kern, size)
1641 #define DRM_COPY_FROM_USER_UNCHECKED(arg1, arg2, arg3) \
1642 copyin(arg2, arg1, arg3)
1643 #define DRM_COPY_TO_USER_UNCHECKED(arg1, arg2, arg3) \
1644 copyout(arg2, arg1, arg3)
1645 #define DRM_GET_USER_UNCHECKED(val, uaddr) \
1646 ((val) = fuword32(uaddr), 0)
1648 #define DRM_GET_PRIV_SAREA(_dev, _ctx, _map) do { \
1649 (_map) = (_dev)->context_sareas[_ctx]; \
1652 /* Returns -errno to shared code */
1653 #define DRM_WAIT_ON( ret, queue, timeout, condition ) \
1654 for ( ret = 0 ; !ret && !(condition) ; ) { \
1656 mtx_lock(&dev->irq_lock); \
1658 ret = -mtx_sleep(&(queue), &dev->irq_lock, \
1659 PCATCH, "drmwtq", (timeout)); \
1660 if (ret == -ERESTART) \
1661 ret = -ERESTARTSYS; \
1662 mtx_unlock(&dev->irq_lock); \
1666 #define dev_err(dev, fmt, ...) \
1667 device_printf((dev), "error: " fmt, ## __VA_ARGS__)
1668 #define dev_warn(dev, fmt, ...) \
1669 device_printf((dev), "warning: " fmt, ## __VA_ARGS__)
1670 #define dev_info(dev, fmt, ...) \
1671 device_printf((dev), "info: " fmt, ## __VA_ARGS__)
1672 #define dev_dbg(dev, fmt, ...) do { \
1673 if ((drm_debug& DRM_DEBUGBITS_KMS) != 0) { \
1674 device_printf((dev), "debug: " fmt, ## __VA_ARGS__); \
1678 struct drm_msi_blacklist_entry
1684 struct drm_vblank_info {
1685 wait_queue_head_t queue; /* vblank wait queue */
1686 atomic_t count; /* number of VBLANK interrupts */
1687 /* (driver must alloc the right number of counters) */
1688 atomic_t refcount; /* number of users of vblank interrupts */
1689 u32 last; /* protected by dev->vbl_lock, used */
1690 /* for wraparound handling */
1691 int enabled; /* so we don't call enable more than */
1692 /* once per disable */
1693 int inmodeset; /* Display driver is setting mode */
1696 #ifndef DMA_BIT_MASK
1697 #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : (1ULL<<(n)) - 1)
1700 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
1709 DMI_PRODUCT_VERSION,
1716 DMI_BOARD_ASSET_TAG,
1719 DMI_CHASSIS_VERSION,
1721 DMI_CHASSIS_ASSET_TAG,
1725 struct dmi_strmatch {
1730 struct dmi_system_id {
1731 int (*callback)(const struct dmi_system_id *);
1733 struct dmi_strmatch matches[4];
1735 #define DMI_MATCH(a, b) {(a), (b)}
1736 bool dmi_check_system(const struct dmi_system_id *);
1738 /* Device setup support (drm_drv.c) */
1739 int drm_probe_helper(device_t kdev, const drm_pci_id_list_t *idlist);
1740 int drm_attach_helper(device_t kdev, const drm_pci_id_list_t *idlist,
1741 struct drm_driver *driver);
1742 int drm_generic_suspend(device_t kdev);
1743 int drm_generic_resume(device_t kdev);
1744 int drm_generic_detach(device_t kdev);
1746 void drm_event_wakeup(struct drm_pending_event *e);
1748 int drm_add_busid_modesetting(struct drm_device *dev,
1749 struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
1751 /* Buffer management support (drm_bufs.c) */
1752 unsigned long drm_get_resource_start(struct drm_device *dev,
1753 unsigned int resource);
1754 unsigned long drm_get_resource_len(struct drm_device *dev,
1755 unsigned int resource);
1757 /* IRQ support (drm_irq.c) */
1758 irqreturn_t drm_irq_handler(DRM_IRQ_ARGS);
1759 void drm_driver_irq_preinstall(struct drm_device *dev);
1760 void drm_driver_irq_postinstall(struct drm_device *dev);
1761 void drm_driver_irq_uninstall(struct drm_device *dev);
1763 /* sysctl support (drm_sysctl.h) */
1764 extern int drm_sysctl_init(struct drm_device *dev);
1765 extern int drm_sysctl_cleanup(struct drm_device *dev);
1767 int drm_version(struct drm_device *dev, void *data,
1768 struct drm_file *file_priv);
1770 /* consistent PCI memory functions (drm_pci.c) */
1771 int drm_pci_set_busid(struct drm_device *dev, struct drm_master *master);
1772 int drm_pci_set_unique(struct drm_device *dev, struct drm_master *master,
1773 struct drm_unique *u);
1774 int drm_pci_agp_init(struct drm_device *dev);
1775 int drm_pci_enable_msi(struct drm_device *dev);
1776 void drm_pci_disable_msi(struct drm_device *dev);
1778 struct ttm_bo_device;
1779 int ttm_bo_mmap_single(struct ttm_bo_device *bdev, vm_ooffset_t *offset,
1780 vm_size_t size, struct vm_object **obj_res, int nprot);
1781 struct ttm_buffer_object;
1782 void ttm_bo_release_mmap(struct ttm_buffer_object *bo);
1785 /* Memory management support (drm_memory.h) */
1786 extern void drm_free_agp(DRM_AGP_MEM * handle, int pages);
1787 extern int drm_bind_agp(DRM_AGP_MEM * handle, unsigned int start);
1788 #ifdef FREEBSD_NOTYET
1789 extern DRM_AGP_MEM *drm_agp_bind_pages(struct drm_device *dev,
1790 struct page **pages,
1791 unsigned long num_pages,
1792 uint32_t gtt_offset,
1794 #endif /* FREEBSD_NOTYET */
1795 extern int drm_unbind_agp(DRM_AGP_MEM * handle);
1797 /* AGP/GART support (drm_agpsupport.h) */
1798 extern struct drm_agp_head *drm_agp_init(struct drm_device *dev);
1799 extern int drm_agp_acquire(struct drm_device *dev);
1800 extern int drm_agp_acquire_ioctl(struct drm_device *dev, void *data,
1801 struct drm_file *file_priv);
1802 extern int drm_agp_release(struct drm_device *dev);
1803 extern int drm_agp_release_ioctl(struct drm_device *dev, void *data,
1804 struct drm_file *file_priv);
1805 extern int drm_agp_enable(struct drm_device *dev, struct drm_agp_mode mode);
1806 extern int drm_agp_enable_ioctl(struct drm_device *dev, void *data,
1807 struct drm_file *file_priv);
1808 extern int drm_agp_info(struct drm_device *dev, struct drm_agp_info *info);
1809 extern int drm_agp_info_ioctl(struct drm_device *dev, void *data,
1810 struct drm_file *file_priv);
1811 extern int drm_agp_alloc(struct drm_device *dev, struct drm_agp_buffer *request);
1812 extern int drm_agp_alloc_ioctl(struct drm_device *dev, void *data,
1813 struct drm_file *file_priv);
1814 extern int drm_agp_free(struct drm_device *dev, struct drm_agp_buffer *request);
1815 extern int drm_agp_free_ioctl(struct drm_device *dev, void *data,
1816 struct drm_file *file_priv);
1817 extern int drm_agp_unbind(struct drm_device *dev, struct drm_agp_binding *request);
1818 extern int drm_agp_unbind_ioctl(struct drm_device *dev, void *data,
1819 struct drm_file *file_priv);
1820 extern int drm_agp_bind(struct drm_device *dev, struct drm_agp_binding *request);
1821 extern int drm_agp_bind_ioctl(struct drm_device *dev, void *data,
1822 struct drm_file *file_priv);
1826 static inline void drm_free_agp(DRM_AGP_MEM * handle, int pages)
1830 static inline int drm_bind_agp(DRM_AGP_MEM * handle, unsigned int start)
1835 static inline int drm_unbind_agp(DRM_AGP_MEM * handle)
1839 #ifdef FREEBSD_NOTYET
1840 static inline struct agp_memory *drm_agp_bind_pages(struct drm_device *dev,
1841 struct page **pages,
1842 unsigned long num_pages,
1843 uint32_t gtt_offset,
1849 static inline struct drm_agp_head *drm_agp_init(struct drm_device *dev)
1854 static inline void drm_agp_clear(struct drm_device *dev)
1858 static inline int drm_agp_acquire(struct drm_device *dev)
1863 static inline int drm_agp_acquire_ioctl(struct drm_device *dev, void *data,
1864 struct drm_file *file_priv)
1869 static inline int drm_agp_release(struct drm_device *dev)
1874 static inline int drm_agp_release_ioctl(struct drm_device *dev, void *data,
1875 struct drm_file *file_priv)
1880 static inline int drm_agp_enable(struct drm_device *dev,
1881 struct drm_agp_mode mode)
1886 static inline int drm_agp_enable_ioctl(struct drm_device *dev, void *data,
1887 struct drm_file *file_priv)
1892 static inline int drm_agp_info(struct drm_device *dev,
1893 struct drm_agp_info *info)
1898 static inline int drm_agp_info_ioctl(struct drm_device *dev, void *data,
1899 struct drm_file *file_priv)
1904 static inline int drm_agp_alloc(struct drm_device *dev,
1905 struct drm_agp_buffer *request)
1910 static inline int drm_agp_alloc_ioctl(struct drm_device *dev, void *data,
1911 struct drm_file *file_priv)
1916 static inline int drm_agp_free(struct drm_device *dev,
1917 struct drm_agp_buffer *request)
1922 static inline int drm_agp_free_ioctl(struct drm_device *dev, void *data,
1923 struct drm_file *file_priv)
1928 static inline int drm_agp_unbind(struct drm_device *dev,
1929 struct drm_agp_binding *request)
1934 static inline int drm_agp_unbind_ioctl(struct drm_device *dev, void *data,
1935 struct drm_file *file_priv)
1940 static inline int drm_agp_bind(struct drm_device *dev,
1941 struct drm_agp_binding *request)
1946 static inline int drm_agp_bind_ioctl(struct drm_device *dev, void *data,
1947 struct drm_file *file_priv)
1952 #endif /* __OS_HAS_AGP */
1954 #endif /* __KERNEL__ */