bsd-core/drmP.h

   1 /* drmP.h -- Private header for Direct Rendering Manager -*- linux-c -*-
   2  * Created: Mon Jan  4 10:05:05 1999 by faith@precisioninsight.com
   3  */
   4 /*-
   5  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
   6  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
   7  * All rights reserved.
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a
  10  * copy of this software and associated documentation files (the "Software"),
  11  * to deal in the Software without restriction, including without limitation
  12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  13  * and/or sell copies of the Software, and to permit persons to whom the
  14  * Software is furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice (including the next
  17  * paragraph) shall be included in all copies or substantial portions of the
  18  * Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  23  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  24  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  25  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  26  * OTHER DEALINGS IN THE SOFTWARE.
  27  *
  28  * Authors:
  29  *    Rickard E. (Rik) Faith <faith@valinux.com>
  30  *    Gareth Hughes <gareth@valinux.com>
  31  *
  32  */
  33
  34 #ifndef _DRM_P_H_
  35 #define _DRM_P_H_
  36
  37 #if defined(_KERNEL) || defined(__KERNEL__)
  38
  39 struct drm_device;
  40 struct drm_file;
  41
  42 #include <sys/param.h>
  43 #include <sys/queue.h>
  44 #include <sys/malloc.h>
  45 #include <sys/kernel.h>
  46 #include <sys/module.h>
  47 #include <sys/systm.h>
  48 #include <sys/conf.h>
  49 #include <sys/stat.h>
  50 #if __FreeBSD_version >= 700000
  51 #include <sys/priv.h>
  52 #endif
  53 #include <sys/proc.h>
  54 #include <sys/lock.h>
  55 #include <sys/fcntl.h>
  56 #include <sys/uio.h>
  57 #include <sys/filio.h>
  58 #include <sys/sysctl.h>
  59 #include <sys/bus.h>
  60 #include <sys/signalvar.h>
  61 #include <sys/poll.h>
  62 #include <sys/tree.h>
  63 #include <vm/vm.h>
  64 #include <vm/pmap.h>
  65 #include <vm/vm_extern.h>
  66 #include <vm/vm_map.h>
  67 #include <vm/vm_param.h>
  68 #include <machine/param.h>
  69 #include <machine/pmap.h>
  70 #include <machine/bus.h>
  71 #include <machine/resource.h>
  72 #include <machine/specialreg.h>
  73 #include <machine/sysarch.h>
  74 #include <sys/endian.h>
  75 #include <sys/mman.h>
  76 #include <sys/rman.h>
  77 #include <sys/memrange.h>
  78 #if __FreeBSD_version >= 800004
  79 #include <dev/agp/agpvar.h>
  80 #else /* __FreeBSD_version >= 800004 */
  81 #include <pci/agpvar.h>
  82 #endif /* __FreeBSD_version >= 800004 */
  83 #include <sys/agpio.h>
  84 #include <sys/mutex.h>
  85 #include <dev/pci/pcivar.h>
  86 #include <dev/pci/pcireg.h>
  87 #include <sys/selinfo.h>
  88 #include <sys/bus.h>
  89
  90 #include "drm.h"
  91 #include "drm_linux_list.h"
  92 #include "drm_atomic.h"
  93 #include "drm_internal.h"
  94
  95 #include <opt_drm.h>
  96 #ifdef DRM_DEBUG
  97 #undef DRM_DEBUG
  98 #define DRM_DEBUG_DEFAULT_ON 1
  99 #endif /* DRM_DEBUG */
 100
 101 #if defined(DRM_LINUX) && DRM_LINUX && !defined(__amd64__)
 102 #include <sys/file.h>
 103 #include <sys/proc.h>
 104 #include <machine/../linux/linux.h>
 105 #include <machine/../linux/linux_proto.h>
 106 #else
 107 /* Either it was defined when it shouldn't be (FreeBSD amd64) or it isn't
 108  * supported on this OS yet.
 109  */
 110 #undef DRM_LINUX
 111 #define DRM_LINUX 0
 112 #endif
 113
 114 /* driver capabilities and requirements mask */
 115 #define DRIVER_USE_AGP     0x1
 116 #define DRIVER_REQUIRE_AGP 0x2
 117 #define DRIVER_USE_MTRR    0x4
 118 #define DRIVER_PCI_DMA     0x8
 119 #define DRIVER_SG          0x10
 120 #define DRIVER_HAVE_DMA    0x20
 121 #define DRIVER_HAVE_IRQ    0x40
 122 #define DRIVER_DMA_QUEUE   0x100
 123
 124
 125 #define DRM_HASH_SIZE         16 /* Size of key hash table                */
 126 #define DRM_KERNEL_CONTEXT    0  /* Change drm_resctx if changed          */
 127 #define DRM_RESERVED_CONTEXTS 1  /* Change drm_resctx if changed          */
 128
 129 MALLOC_DECLARE(DRM_MEM_DMA);
 130 MALLOC_DECLARE(DRM_MEM_SAREA);
 131 MALLOC_DECLARE(DRM_MEM_DRIVER);
 132 MALLOC_DECLARE(DRM_MEM_MAGIC);
 133 MALLOC_DECLARE(DRM_MEM_IOCTLS);
 134 MALLOC_DECLARE(DRM_MEM_MAPS);
 135 MALLOC_DECLARE(DRM_MEM_BUFS);
 136 MALLOC_DECLARE(DRM_MEM_SEGS);
 137 MALLOC_DECLARE(DRM_MEM_PAGES);
 138 MALLOC_DECLARE(DRM_MEM_FILES);
 139 MALLOC_DECLARE(DRM_MEM_QUEUES);
 140 MALLOC_DECLARE(DRM_MEM_CMDS);
 141 MALLOC_DECLARE(DRM_MEM_MAPPINGS);
 142 MALLOC_DECLARE(DRM_MEM_BUFLISTS);
 143 MALLOC_DECLARE(DRM_MEM_AGPLISTS);
 144 MALLOC_DECLARE(DRM_MEM_CTXBITMAP);
 145 MALLOC_DECLARE(DRM_MEM_SGLISTS);
 146 MALLOC_DECLARE(DRM_MEM_DRAWABLE);
 147
 148 #define DRM_MAX_CTXBITMAP (PAGE_SIZE * 8)
 149
 150                                 /* Internal types and structures */
 151 #define DRM_ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
 152 #define DRM_MIN(a,b) ((a)<(b)?(a):(b))
 153 #define DRM_MAX(a,b) ((a)>(b)?(a):(b))
 154
 155 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
 156
 157 #define __OS_HAS_AGP    1
 158
 159 #define DRM_DEV_MODE    (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
 160 #define DRM_DEV_UID     0
 161 #define DRM_DEV_GID     0
 162
 163 #define wait_queue_head_t       atomic_t
 164 #define DRM_WAKEUP(w)           wakeup((void *)w)
 165 #define DRM_WAKEUP_INT(w)       wakeup(w)
 166 #define DRM_INIT_WAITQUEUE(queue) do {(void)(queue);} while (0)
 167
 168 #define DRM_CURPROC             curthread
 169 #define DRM_STRUCTPROC          struct thread
 170 #define DRM_SPINTYPE            struct mtx
 171 #define DRM_SPININIT(l,name)    mtx_init(l, name, NULL, MTX_DEF)
 172 #define DRM_SPINUNINIT(l)       mtx_destroy(l)
 173 #define DRM_SPINLOCK(l)         mtx_lock(l)
 174 #define DRM_SPINUNLOCK(u)       mtx_unlock(u)
 175 #define DRM_SPINLOCK_IRQSAVE(l, irqflags) do {          \
 176         mtx_lock(l);                                    \
 177         (void)irqflags;                                 \
 178 } while (0)
 179 #define DRM_SPINUNLOCK_IRQRESTORE(u, irqflags) mtx_unlock(u)
 180 #define DRM_SPINLOCK_ASSERT(l)  mtx_assert(l, MA_OWNED)
 181 #define DRM_CURRENTPID          curthread->td_proc->p_pid
 182 #define DRM_LOCK()              mtx_lock(&dev->dev_lock)
 183 #define DRM_UNLOCK()            mtx_unlock(&dev->dev_lock)
 184 #define DRM_SYSCTL_HANDLER_ARGS (SYSCTL_HANDLER_ARGS)
 185
 186 #define DRM_IRQ_ARGS            void *arg
 187 typedef void                    irqreturn_t;
 188 #define IRQ_HANDLED             /* nothing */
 189 #define IRQ_NONE                /* nothing */
 190
 191 enum {
 192         DRM_IS_NOT_AGP,
 193         DRM_IS_AGP,
 194         DRM_MIGHT_BE_AGP
 195 };
 196 #define DRM_AGP_MEM             struct agp_memory_info
 197
 198 #define drm_get_device_from_kdev(_kdev) (_kdev->si_drv1)
 199
 200 #define PAGE_ALIGN(addr) round_page(addr)
 201 /* DRM_SUSER returns true if the user is superuser */
 202 #if __FreeBSD_version >= 700000
 203 #define DRM_SUSER(p)            (priv_check(p, PRIV_DRIVER) == 0)
 204 #else
 205 #define DRM_SUSER(p)            (suser(p) == 0)
 206 #endif
 207 #define DRM_AGP_FIND_DEVICE()   agp_find_device()
 208 #define DRM_MTRR_WC             MDF_WRITECOMBINE
 209 #define jiffies                 ticks
 210
 211 typedef unsigned long dma_addr_t;
 212 typedef u_int64_t u64;
 213 typedef u_int32_t u32;
 214 typedef u_int16_t u16;
 215 typedef u_int8_t u8;
 216
 217 /* DRM_READMEMORYBARRIER() prevents reordering of reads.
 218  * DRM_WRITEMEMORYBARRIER() prevents reordering of writes.
 219  * DRM_MEMORYBARRIER() prevents reordering of reads and writes.
 220  */
 221 #if defined(__i386__)
 222 #define DRM_READMEMORYBARRIER()         __asm __volatile( \
 223                                         "lock; addl $0,0(%%esp)" : : : "memory");
 224 #define DRM_WRITEMEMORYBARRIER()        __asm __volatile("" : : : "memory");
 225 #define DRM_MEMORYBARRIER()             __asm __volatile( \
 226                                         "lock; addl $0,0(%%esp)" : : : "memory");
 227 #elif defined(__alpha__)
 228 #define DRM_READMEMORYBARRIER()         alpha_mb();
 229 #define DRM_WRITEMEMORYBARRIER()        alpha_wmb();
 230 #define DRM_MEMORYBARRIER()             alpha_mb();
 231 #elif defined(__amd64__)
 232 #define DRM_READMEMORYBARRIER()         __asm __volatile( \
 233                                         "lock; addl $0,0(%%rsp)" : : : "memory");
 234 #define DRM_WRITEMEMORYBARRIER()        __asm __volatile("" : : : "memory");
 235 #define DRM_MEMORYBARRIER()             __asm __volatile( \
 236                                         "lock; addl $0,0(%%rsp)" : : : "memory");
 237 #endif
 238
 239 #define DRM_READ8(map, offset)                                          \
 240         *(volatile u_int8_t *)(((vm_offset_t)(map)->handle) +           \
 241             (vm_offset_t)(offset))
 242 #define DRM_READ16(map, offset)                                         \
 243         *(volatile u_int16_t *)(((vm_offset_t)(map)->handle) +          \
 244             (vm_offset_t)(offset))
 245 #define DRM_READ32(map, offset)                                         \
 246         *(volatile u_int32_t *)(((vm_offset_t)(map)->handle) +          \
 247             (vm_offset_t)(offset))
 248 #define DRM_WRITE8(map, offset, val)                                    \
 249         *(volatile u_int8_t *)(((vm_offset_t)(map)->handle) +           \
 250             (vm_offset_t)(offset)) = val
 251 #define DRM_WRITE16(map, offset, val)                                   \
 252         *(volatile u_int16_t *)(((vm_offset_t)(map)->handle) +          \
 253             (vm_offset_t)(offset)) = val
 254 #define DRM_WRITE32(map, offset, val)                                   \
 255         *(volatile u_int32_t *)(((vm_offset_t)(map)->handle) +          \
 256             (vm_offset_t)(offset)) = val
 257
 258 #define DRM_VERIFYAREA_READ( uaddr, size )              \
 259         (!useracc(__DECONST(caddr_t, uaddr), size, VM_PROT_READ))
 260
 261 #define DRM_COPY_TO_USER(user, kern, size) \
 262         copyout(kern, user, size)
 263 #define DRM_COPY_FROM_USER(kern, user, size) \
 264         copyin(user, kern, size)
 265 #define DRM_COPY_FROM_USER_UNCHECKED(arg1, arg2, arg3)  \
 266         copyin(arg2, arg1, arg3)
 267 #define DRM_COPY_TO_USER_UNCHECKED(arg1, arg2, arg3)    \
 268         copyout(arg2, arg1, arg3)
 269 #define DRM_GET_USER_UNCHECKED(val, uaddr)              \
 270         ((val) = fuword32(uaddr), 0)
 271
 272 #define cpu_to_le32(x) htole32(x)
 273 #define le32_to_cpu(x) le32toh(x)
 274
 275 #define DRM_HZ                  hz
 276 #define DRM_UDELAY(udelay)      DELAY(udelay)
 277 #define DRM_TIME_SLICE          (hz/20)  /* Time slice for GLXContexts    */
 278
 279 #define DRM_GET_PRIV_SAREA(_dev, _ctx, _map) do {       \
 280         (_map) = (_dev)->context_sareas[_ctx];          \
 281 } while(0)
 282
 283 #define LOCK_TEST_WITH_RETURN(dev, file_priv)                           \
 284 do {                                                                    \
 285         if (!_DRM_LOCK_IS_HELD(dev->lock.hw_lock->lock) ||              \
 286              dev->lock.file_priv != file_priv) {                        \
 287                 DRM_ERROR("%s called without lock held\n",              \
 288                            __FUNCTION__);                               \
 289                 return EINVAL;                                          \
 290         }                                                               \
 291 } while (0)
 292
 293 /* Returns -errno to shared code */
 294 #define DRM_WAIT_ON( ret, queue, timeout, condition )           \
 295 for ( ret = 0 ; !ret && !(condition) ; ) {                      \
 296         DRM_UNLOCK();                                           \
 297         mtx_lock(&dev->irq_lock);                               \
 298         if (!(condition))                                       \
 299             ret = -mtx_sleep(&(queue), &dev->irq_lock,          \
 300                 PCATCH, "drmwtq", (timeout));                   \
 301         mtx_unlock(&dev->irq_lock);                             \
 302         DRM_LOCK();                                             \
 303 }
 304
 305 #define DRM_ERROR(fmt, ...) \
 306         printf("error: [" DRM_NAME ":pid%d:%s] *ERROR* " fmt,           \
 307             DRM_CURRENTPID, __func__ , ##__VA_ARGS__)
 308
 309 #define DRM_INFO(fmt, ...)  printf("info: [" DRM_NAME "] " fmt , ##__VA_ARGS__)
 310
 311 #define DRM_DEBUG(fmt, ...) do {                                        \
 312         if (drm_debug_flag)                                             \
 313                 printf("[" DRM_NAME ":pid%d:%s] " fmt, DRM_CURRENTPID,  \
 314                         __func__ , ##__VA_ARGS__);                      \
 315 } while (0)
 316
 317 typedef struct drm_pci_id_list
 318 {
 319         int vendor;
 320         int device;
 321         long driver_private;
 322         char *name;
 323 } drm_pci_id_list_t;
 324
 325 struct drm_msi_blacklist_entry
 326 {
 327         int vendor;
 328         int device;
 329 };
 330
 331 #define DRM_AUTH        0x1
 332 #define DRM_MASTER      0x2
 333 #define DRM_ROOT_ONLY   0x4
 334 typedef struct drm_ioctl_desc {
 335         unsigned long cmd;
 336         int (*func)(struct drm_device *dev, void *data,
 337                     struct drm_file *file_priv);
 338         int flags;
 339 } drm_ioctl_desc_t;
 340 /**
 341  * Creates a driver or general drm_ioctl_desc array entry for the given
 342  * ioctl, for use by drm_ioctl().
 343  */
 344 #define DRM_IOCTL_DEF(ioctl, func, flags) \
 345         [DRM_IOCTL_NR(ioctl)] = {ioctl, func, flags}
 346
 347 typedef struct drm_magic_entry {
 348         drm_magic_t            magic;
 349         struct drm_file        *priv;
 350         struct drm_magic_entry *next;
 351 } drm_magic_entry_t;
 352
 353 typedef struct drm_magic_head {
 354         struct drm_magic_entry *head;
 355         struct drm_magic_entry *tail;
 356 } drm_magic_head_t;
 357
 358 typedef struct drm_buf {
 359         int               idx;         /* Index into master buflist          */
 360         int               total;       /* Buffer size                        */
 361         int               order;       /* log-base-2(total)                  */
 362         int               used;        /* Amount of buffer in use (for DMA)  */
 363         unsigned long     offset;      /* Byte offset (used internally)      */
 364         void              *address;    /* Address of buffer                  */
 365         unsigned long     bus_address; /* Bus address of buffer              */
 366         struct drm_buf    *next;       /* Kernel-only: used for free list    */
 367         __volatile__ int  pending;     /* On hardware DMA queue              */
 368         struct drm_file   *file_priv;  /* Unique identifier of holding process */
 369         int               context;     /* Kernel queue for this buffer       */
 370         enum {
 371                 DRM_LIST_NONE    = 0,
 372                 DRM_LIST_FREE    = 1,
 373                 DRM_LIST_WAIT    = 2,
 374                 DRM_LIST_PEND    = 3,
 375                 DRM_LIST_PRIO    = 4,
 376                 DRM_LIST_RECLAIM = 5
 377         }                 list;        /* Which list we're on                */
 378
 379         int               dev_priv_size; /* Size of buffer private stoarge   */
 380         void              *dev_private;  /* Per-buffer private storage       */
 381 } drm_buf_t;
 382
 383 typedef struct drm_freelist {
 384         int               initialized; /* Freelist in use                  */
 385         atomic_t          count;       /* Number of free buffers           */
 386         drm_buf_t         *next;       /* End pointer                      */
 387
 388         int               low_mark;    /* Low water mark                   */
 389         int               high_mark;   /* High water mark                  */
 390 } drm_freelist_t;
 391
 392 typedef struct drm_dma_handle {
 393         void *vaddr;
 394         bus_addr_t busaddr;
 395         bus_dma_tag_t tag;
 396         bus_dmamap_t map;
 397 } drm_dma_handle_t;
 398
 399 typedef struct drm_buf_entry {
 400         int               buf_size;
 401         int               buf_count;
 402         drm_buf_t         *buflist;
 403         int               seg_count;
 404         drm_dma_handle_t  **seglist;
 405         int               page_order;
 406
 407         drm_freelist_t    freelist;
 408 } drm_buf_entry_t;
 409
 410 typedef TAILQ_HEAD(drm_file_list, drm_file) drm_file_list_t;
 411 struct drm_file {
 412         TAILQ_ENTRY(drm_file) link;
 413         struct drm_device *dev;
 414         int               authenticated;
 415         int               master;
 416         int               minor;
 417         pid_t             pid;
 418         uid_t             uid;
 419         drm_magic_t       magic;
 420         unsigned long     ioctl_count;
 421         void             *driver_priv;
 422 };
 423
 424 typedef struct drm_lock_data {
 425         struct drm_hw_lock      *hw_lock;       /* Hardware lock                   */
 426         struct drm_file   *file_priv;   /* Unique identifier of holding process (NULL is kernel)*/
 427         int               lock_queue;   /* Queue of blocked processes      */
 428         unsigned long     lock_time;    /* Time of last lock in jiffies    */
 429 } drm_lock_data_t;
 430
 431 /* This structure, in the struct drm_device, is always initialized while the
 432  * device
 433  * is open.  dev->dma_lock protects the incrementing of dev->buf_use, which
 434  * when set marks that no further bufs may be allocated until device teardown
 435  * occurs (when the last open of the device has closed).  The high/low
 436  * watermarks of bufs are only touched by the X Server, and thus not
 437  * concurrently accessed, so no locking is needed.
 438  */
 439 typedef struct drm_device_dma {
 440         drm_buf_entry_t   bufs[DRM_MAX_ORDER+1];
 441         int               buf_count;
 442         drm_buf_t         **buflist;    /* Vector of pointers info bufs    */
 443         int               seg_count;
 444         int               page_count;
 445         unsigned long     *pagelist;
 446         unsigned long     byte_count;
 447         enum {
 448                 _DRM_DMA_USE_AGP = 0x01,
 449                 _DRM_DMA_USE_SG  = 0x02
 450         } flags;
 451 } drm_device_dma_t;
 452
 453 typedef struct drm_agp_mem {
 454         void               *handle;
 455         unsigned long      bound; /* address */
 456         int                pages;
 457         struct drm_agp_mem *prev;
 458         struct drm_agp_mem *next;
 459 } drm_agp_mem_t;
 460
 461 typedef struct drm_agp_head {
 462         device_t           agpdev;
 463         struct agp_info    info;
 464         const char         *chipset;
 465         drm_agp_mem_t      *memory;
 466         unsigned long      mode;
 467         int                enabled;
 468         int                acquired;
 469         unsigned long      base;
 470         int                mtrr;
 471         int                cant_use_aperture;
 472         unsigned long      page_mask;
 473 } drm_agp_head_t;
 474
 475 typedef struct drm_sg_mem {
 476         unsigned long             handle;
 477         void                     *virtual;
 478         int                       pages;
 479         dma_addr_t               *busaddr;
 480         struct drm_dma_handle    *sg_dmah;      /* Handle for sg_pages   */
 481         struct drm_dma_handle    *dmah;         /* Handle to PCI memory  */
 482                                                 /* for ATI PCIGART table */
 483 } drm_sg_mem_t;
 484
 485 typedef TAILQ_HEAD(drm_map_list, drm_local_map) drm_map_list_t;
 486
 487 typedef struct drm_local_map {
 488         unsigned long   offset;  /* Physical address (0 for SAREA)*/
 489         unsigned long   size;    /* Physical size (bytes)           */
 490         enum drm_map_type       type;    /* Type of memory mapped                   */
 491         enum drm_map_flags      flags;   /* Flags                                   */
 492         void            *handle; /* User-space: "Handle" to pass to mmap    */
 493                                  /* Kernel-space: kernel-virtual address    */
 494         int             mtrr;    /* Boolean: MTRR used */
 495                                  /* Private data                            */
 496         int             rid;     /* PCI resource ID for bus_space */
 497         struct resource *bsr;
 498         bus_space_tag_t bst;
 499         bus_space_handle_t bsh;
 500         drm_dma_handle_t *dmah;
 501         TAILQ_ENTRY(drm_local_map) link;
 502 } drm_local_map_t;
 503
 504 TAILQ_HEAD(drm_vbl_sig_list, drm_vbl_sig);
 505 typedef struct drm_vbl_sig {
 506         TAILQ_ENTRY(drm_vbl_sig) link;
 507         unsigned int    sequence;
 508         int             signo;
 509         int             pid;
 510 } drm_vbl_sig_t;
 511
 512 struct drm_vblank_info {
 513         wait_queue_head_t queue;        /* vblank wait queue */
 514         atomic_t count;                 /* number of VBLANK interrupts */
 515                                         /* (driver must alloc the right number of counters) */
 516         struct drm_vbl_sig_list sigs;   /* signal list to send on VBLANK */
 517         atomic_t refcount;              /* number of users of vblank interrupts */
 518         u32 last;                       /* protected by dev->vbl_lock, used */
 519                                         /* for wraparound handling */
 520         int enabled;                    /* so we don't call enable more than */
 521                                         /* once per disable */
 522         int inmodeset;                  /* Display driver is setting mode */
 523 };
 524
 525 /* location of GART table */
 526 #define DRM_ATI_GART_MAIN 1
 527 #define DRM_ATI_GART_FB   2
 528
 529 #define DRM_ATI_GART_PCI  1
 530 #define DRM_ATI_GART_PCIE 2
 531 #define DRM_ATI_GART_IGP  3
 532
 533 struct drm_ati_pcigart_info {
 534         int gart_table_location;
 535         int gart_reg_if;
 536         void *addr;
 537         dma_addr_t bus_addr;
 538         dma_addr_t table_mask;
 539         dma_addr_t member_mask;
 540         struct drm_dma_handle *table_handle;
 541         drm_local_map_t mapping;
 542         int table_size;
 543 };
 544
 545 #ifndef DMA_BIT_MASK
 546 #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : (1ULL<<(n)) - 1)
 547 #endif
 548
 549 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
 550
 551 struct drm_driver_info {
 552         int     (*load)(struct drm_device *, unsigned long flags);
 553         int     (*firstopen)(struct drm_device *);
 554         int     (*open)(struct drm_device *, struct drm_file *);
 555         void    (*preclose)(struct drm_device *, struct drm_file *file_priv);
 556         void    (*postclose)(struct drm_device *, struct drm_file *);
 557         void    (*lastclose)(struct drm_device *);
 558         int     (*unload)(struct drm_device *);
 559         void    (*reclaim_buffers_locked)(struct drm_device *,
 560                                           struct drm_file *file_priv);
 561         int     (*dma_ioctl)(struct drm_device *dev, void *data,
 562                              struct drm_file *file_priv);
 563         void    (*dma_ready)(struct drm_device *);
 564         int     (*dma_quiescent)(struct drm_device *);
 565         int     (*dma_flush_block_and_flush)(struct drm_device *, int context,
 566                                              enum drm_lock_flags flags);
 567         int     (*dma_flush_unblock)(struct drm_device *, int context,
 568                                      enum drm_lock_flags flags);
 569         int     (*context_ctor)(struct drm_device *dev, int context);
 570         int     (*context_dtor)(struct drm_device *dev, int context);
 571         int     (*kernel_context_switch)(struct drm_device *dev, int old,
 572                                          int new);
 573         int     (*kernel_context_switch_unlock)(struct drm_device *dev);
 574         void    (*irq_preinstall)(struct drm_device *dev);
 575         int     (*irq_postinstall)(struct drm_device *dev);
 576         void    (*irq_uninstall)(struct drm_device *dev);
 577         void    (*irq_handler)(DRM_IRQ_ARGS);
 578         u32     (*get_vblank_counter)(struct drm_device *dev, int crtc);
 579         int     (*enable_vblank)(struct drm_device *dev, int crtc);
 580         void    (*disable_vblank)(struct drm_device *dev, int crtc);
 581
 582         drm_pci_id_list_t *id_entry;    /* PCI ID, name, and chipset private */
 583
 584         /**
 585          * Called by \c drm_device_is_agp.  Typically used to determine if a
 586          * card is really attached to AGP or not.
 587          *
 588          * \param dev  DRM device handle
 589          *
 590          * \returns
 591          * One of three values is returned depending on whether or not the
 592          * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
 593          * (return of 1), or may or may not be AGP (return of 2).
 594          */
 595         int     (*device_is_agp) (struct drm_device * dev);
 596
 597         drm_ioctl_desc_t *ioctls;
 598         int     max_ioctl;
 599
 600         int     buf_priv_size;
 601
 602         int     major;
 603         int     minor;
 604         int     patchlevel;
 605         const char *name;               /* Simple driver name              */
 606         const char *desc;               /* Longer driver name              */
 607         const char *date;               /* Date of last major changes.     */
 608
 609         u32 driver_features;
 610 };
 611
 612 /* Length for the array of resource pointers for drm_get_resource_*. */
 613 #define DRM_MAX_PCI_RESOURCE    6
 614
 615 /**
 616  * DRM device functions structure
 617  */
 618 struct drm_device {
 619         struct drm_driver_info *driver;
 620         drm_pci_id_list_t *id_entry;    /* PCI ID, name, and chipset private */
 621
 622         u_int16_t pci_device;           /* PCI device id */
 623         u_int16_t pci_vendor;           /* PCI vendor id */
 624
 625         char              *unique;      /* Unique identifier: e.g., busid  */
 626         int               unique_len;   /* Length of unique field          */
 627         device_t          device;       /* Device instance from newbus     */
 628         struct cdev       *devnode;     /* Device number for mknod         */
 629         int               if_version;   /* Highest interface version set */
 630
 631         int               flags;        /* Flags to open(2)                */
 632
 633                                 /* Locks */
 634         struct mtx        vbl_lock;     /* protects vblank operations */
 635         struct mtx        dma_lock;     /* protects dev->dma */
 636         struct mtx        irq_lock;     /* protects irq condition checks */
 637         struct mtx        dev_lock;     /* protects everything else */
 638         DRM_SPINTYPE      drw_lock;
 639
 640                                 /* Usage Counters */
 641         int               open_count;   /* Outstanding files open          */
 642         int               buf_use;      /* Buffers in use -- cannot alloc  */
 643
 644                                 /* Performance counters */
 645         unsigned long     counters;
 646         enum drm_stat_type      types[15];
 647         atomic_t          counts[15];
 648
 649                                 /* Authentication */
 650         drm_file_list_t   files;
 651         drm_magic_head_t  magiclist[DRM_HASH_SIZE];
 652
 653         /* Linked list of mappable regions. Protected by dev_lock */
 654         drm_map_list_t    maplist;
 655
 656         drm_local_map_t   **context_sareas;
 657         int               max_context;
 658
 659         drm_lock_data_t   lock;         /* Information on hardware lock    */
 660
 661                                 /* DMA queues (contexts) */
 662         drm_device_dma_t  *dma;         /* Optional pointer for DMA support */
 663
 664                                 /* Context support */
 665         int               irq;          /* Interrupt used by board         */
 666         int               irq_enabled;  /* True if the irq handler is enabled */
 667         int               msi_enabled;  /* MSI enabled */
 668         int               irqrid;       /* Interrupt used by board */
 669         struct resource   *irqr;        /* Resource for interrupt used by board    */
 670         void              *irqh;        /* Handle from bus_setup_intr      */
 671
 672         /* Storage of resource pointers for drm_get_resource_* */
 673         struct resource   *pcir[DRM_MAX_PCI_RESOURCE];
 674         int               pcirid[DRM_MAX_PCI_RESOURCE];
 675
 676         int               pci_domain;
 677         int               pci_bus;
 678         int               pci_slot;
 679         int               pci_func;
 680
 681         atomic_t          context_flag; /* Context swapping flag           */
 682         int               last_context; /* Last current context            */
 683
 684         int               vblank_disable_allowed;
 685         atomic_t          vbl_signal_pending;   /* number of signals pending on all crtcs */
 686         struct callout    vblank_disable_timer;
 687         u32               max_vblank_count;     /* size of vblank counter register */
 688         struct drm_vblank_info *vblank;         /* per crtc vblank info */
 689         int               num_crtcs;
 690
 691         struct sigio      *buf_sigio;   /* Processes waiting for SIGIO     */
 692
 693                                 /* Sysctl support */
 694         struct drm_sysctl_info *sysctl;
 695
 696         drm_agp_head_t    *agp;
 697         drm_sg_mem_t      *sg;  /* Scatter gather memory */
 698         atomic_t          *ctx_bitmap;
 699         void              *dev_private;
 700         unsigned int      agp_buffer_token;
 701         drm_local_map_t   *agp_buffer_map;
 702
 703         struct unrhdr     *drw_unrhdr;
 704         /* RB tree of drawable infos */
 705         RB_HEAD(drawable_tree, bsd_drm_drawable_info) drw_head;
 706 };
 707
 708 static __inline__ int drm_core_check_feature(struct drm_device *dev,
 709                                              int feature)
 710 {
 711         return ((dev->driver->driver_features & feature) ? 1 : 0);
 712 }
 713
 714 #if __OS_HAS_AGP
 715 static inline int drm_core_has_AGP(struct drm_device *dev)
 716 {
 717         return drm_core_check_feature(dev, DRIVER_USE_AGP);
 718 }
 719 #else
 720 #define drm_core_has_AGP(dev) (0)
 721 #endif
 722
 723 extern int      drm_debug_flag;
 724
 725 /* Device setup support (drm_drv.c) */
 726 int     drm_probe(device_t kdev, drm_pci_id_list_t *idlist);
 727 int     drm_attach(device_t kdev, drm_pci_id_list_t *idlist);
 728 void    drm_close(void *data);
 729 int     drm_detach(device_t kdev);
 730 d_ioctl_t drm_ioctl;
 731 d_open_t drm_open;
 732 d_read_t drm_read;
 733 d_poll_t drm_poll;
 734 d_mmap_t drm_mmap;
 735 extern drm_local_map_t  *drm_getsarea(struct drm_device *dev);
 736
 737 /* File operations helpers (drm_fops.c) */
 738 extern int              drm_open_helper(struct cdev *kdev, int flags, int fmt,
 739                                          DRM_STRUCTPROC *p,
 740                                         struct drm_device *dev);
 741
 742 /* Memory management support (drm_memory.c) */
 743 void    drm_mem_init(void);
 744 void    drm_mem_uninit(void);
 745 void    *drm_ioremap_wc(struct drm_device *dev, drm_local_map_t *map);
 746 void    *drm_ioremap(struct drm_device *dev, drm_local_map_t *map);
 747 void    drm_ioremapfree(drm_local_map_t *map);
 748 int     drm_mtrr_add(unsigned long offset, size_t size, int flags);
 749 int     drm_mtrr_del(int handle, unsigned long offset, size_t size, int flags);
 750
 751 int     drm_context_switch(struct drm_device *dev, int old, int new);
 752 int     drm_context_switch_complete(struct drm_device *dev, int new);
 753
 754 int     drm_ctxbitmap_init(struct drm_device *dev);
 755 void    drm_ctxbitmap_cleanup(struct drm_device *dev);
 756 void    drm_ctxbitmap_free(struct drm_device *dev, int ctx_handle);
 757 int     drm_ctxbitmap_next(struct drm_device *dev);
 758
 759 /* Locking IOCTL support (drm_lock.c) */
 760 int     drm_lock_take(struct drm_lock_data *lock_data,
 761                       unsigned int context);
 762 int     drm_lock_transfer(struct drm_lock_data *lock_data,
 763                           unsigned int context);
 764 int     drm_lock_free(struct drm_lock_data *lock_data,
 765                       unsigned int context);
 766
 767 /* Buffer management support (drm_bufs.c) */
 768 unsigned long drm_get_resource_start(struct drm_device *dev,
 769                                      unsigned int resource);
 770 unsigned long drm_get_resource_len(struct drm_device *dev,
 771                                    unsigned int resource);
 772 void    drm_rmmap(struct drm_device *dev, drm_local_map_t *map);
 773 int     drm_order(unsigned long size);
 774 int     drm_addmap(struct drm_device *dev, unsigned long offset,
 775                    unsigned long size,
 776                    enum drm_map_type type, enum drm_map_flags flags,
 777                    drm_local_map_t **map_ptr);
 778 int     drm_addbufs_pci(struct drm_device *dev, struct drm_buf_desc *request);
 779 int     drm_addbufs_sg(struct drm_device *dev, struct drm_buf_desc *request);
 780 int     drm_addbufs_agp(struct drm_device *dev, struct drm_buf_desc *request);
 781
 782 /* DMA support (drm_dma.c) */
 783 int     drm_dma_setup(struct drm_device *dev);
 784 void    drm_dma_takedown(struct drm_device *dev);
 785 void    drm_free_buffer(struct drm_device *dev, drm_buf_t *buf);
 786 void    drm_reclaim_buffers(struct drm_device *dev, struct drm_file *file_priv);
 787 #define drm_core_reclaim_buffers drm_reclaim_buffers
 788
 789 /* IRQ support (drm_irq.c) */
 790 int     drm_irq_install(struct drm_device *dev);
 791 int     drm_irq_uninstall(struct drm_device *dev);
 792 irqreturn_t drm_irq_handler(DRM_IRQ_ARGS);
 793 void    drm_driver_irq_preinstall(struct drm_device *dev);
 794 void    drm_driver_irq_postinstall(struct drm_device *dev);
 795 void    drm_driver_irq_uninstall(struct drm_device *dev);
 796 void    drm_handle_vblank(struct drm_device *dev, int crtc);
 797 u32     drm_vblank_count(struct drm_device *dev, int crtc);
 798 int     drm_vblank_get(struct drm_device *dev, int crtc);
 799 void    drm_vblank_put(struct drm_device *dev, int crtc);
 800 void    drm_vblank_cleanup(struct drm_device *dev);
 801 int     drm_vblank_wait(struct drm_device *dev, unsigned int *vbl_seq);
 802 int     drm_vblank_init(struct drm_device *dev, int num_crtcs);
 803 void    drm_vbl_send_signals(struct drm_device *dev, int crtc);
 804 int     drm_modeset_ctl(struct drm_device *dev, void *data,
 805                         struct drm_file *file_priv);
 806
 807 /* AGP/PCI Express/GART support (drm_agpsupport.c) */
 808 int     drm_device_is_agp(struct drm_device *dev);
 809 int     drm_device_is_pcie(struct drm_device *dev);
 810 drm_agp_head_t *drm_agp_init(void);
 811 int     drm_agp_acquire(struct drm_device *dev);
 812 int     drm_agp_release(struct drm_device *dev);
 813 int     drm_agp_info(struct drm_device * dev, struct drm_agp_info *info);
 814 int     drm_agp_enable(struct drm_device *dev, struct drm_agp_mode mode);
 815 void    *drm_agp_allocate_memory(size_t pages, u32 type);
 816 int     drm_agp_free_memory(void *handle);
 817 int     drm_agp_bind_memory(void *handle, off_t start);
 818 int     drm_agp_unbind_memory(void *handle);
 819 int     drm_agp_alloc(struct drm_device *dev, struct drm_agp_buffer *request);
 820 int     drm_agp_free(struct drm_device *dev, struct drm_agp_buffer *request);
 821 int     drm_agp_bind(struct drm_device *dev, struct drm_agp_binding *request);
 822 int     drm_agp_unbind(struct drm_device *dev, struct drm_agp_binding *request);
 823
 824 /* Scatter Gather Support (drm_scatter.c) */
 825 void    drm_sg_cleanup(drm_sg_mem_t *entry);
 826 int     drm_sg_alloc(struct drm_device *dev, struct drm_scatter_gather * request);
 827
 828 /* sysctl support (drm_sysctl.h) */
 829 extern int              drm_sysctl_init(struct drm_device *dev);
 830 extern int              drm_sysctl_cleanup(struct drm_device *dev);
 831
 832 /* ATI PCIGART support (ati_pcigart.c) */
 833 int     drm_ati_pcigart_init(struct drm_device *dev,
 834                                 struct drm_ati_pcigart_info *gart_info);
 835 int     drm_ati_pcigart_cleanup(struct drm_device *dev,
 836                                 struct drm_ati_pcigart_info *gart_info);
 837
 838 /* Locking IOCTL support (drm_drv.c) */
 839 int     drm_lock(struct drm_device *dev, void *data,
 840                  struct drm_file *file_priv);
 841 int     drm_unlock(struct drm_device *dev, void *data,
 842                    struct drm_file *file_priv);
 843 int     drm_version(struct drm_device *dev, void *data,
 844                     struct drm_file *file_priv);
 845 int     drm_setversion(struct drm_device *dev, void *data,
 846                        struct drm_file *file_priv);
 847
 848 /* Misc. IOCTL support (drm_ioctl.c) */
 849 int     drm_irq_by_busid(struct drm_device *dev, void *data,
 850                          struct drm_file *file_priv);
 851 int     drm_getunique(struct drm_device *dev, void *data,
 852                       struct drm_file *file_priv);
 853 int     drm_setunique(struct drm_device *dev, void *data,
 854                       struct drm_file *file_priv);
 855 int     drm_getmap(struct drm_device *dev, void *data,
 856                    struct drm_file *file_priv);
 857 int     drm_getclient(struct drm_device *dev, void *data,
 858                       struct drm_file *file_priv);
 859 int     drm_getstats(struct drm_device *dev, void *data,
 860                      struct drm_file *file_priv);
 861 int     drm_noop(struct drm_device *dev, void *data,
 862                  struct drm_file *file_priv);
 863
 864 /* Context IOCTL support (drm_context.c) */
 865 int     drm_resctx(struct drm_device *dev, void *data,
 866                    struct drm_file *file_priv);
 867 int     drm_addctx(struct drm_device *dev, void *data,
 868                    struct drm_file *file_priv);
 869 int     drm_modctx(struct drm_device *dev, void *data,
 870                    struct drm_file *file_priv);
 871 int     drm_getctx(struct drm_device *dev, void *data,
 872                    struct drm_file *file_priv);
 873 int     drm_switchctx(struct drm_device *dev, void *data,
 874                       struct drm_file *file_priv);
 875 int     drm_newctx(struct drm_device *dev, void *data,
 876                    struct drm_file *file_priv);
 877 int     drm_rmctx(struct drm_device *dev, void *data,
 878                   struct drm_file *file_priv);
 879 int     drm_setsareactx(struct drm_device *dev, void *data,
 880                         struct drm_file *file_priv);
 881 int     drm_getsareactx(struct drm_device *dev, void *data,
 882                         struct drm_file *file_priv);
 883
 884 /* Drawable IOCTL support (drm_drawable.c) */
 885 int     drm_adddraw(struct drm_device *dev, void *data,
 886                     struct drm_file *file_priv);
 887 int     drm_rmdraw(struct drm_device *dev, void *data,
 888                    struct drm_file *file_priv);
 889 int     drm_update_draw(struct drm_device *dev, void *data,
 890                         struct drm_file *file_priv);
 891 struct drm_drawable_info *drm_get_drawable_info(struct drm_device *dev,
 892                                                 int handle);
 893
 894 /* Drawable support (drm_drawable.c) */
 895 void drm_drawable_free_all(struct drm_device *dev);
 896
 897 /* Authentication IOCTL support (drm_auth.c) */
 898 int     drm_getmagic(struct drm_device *dev, void *data,
 899                      struct drm_file *file_priv);
 900 int     drm_authmagic(struct drm_device *dev, void *data,
 901                       struct drm_file *file_priv);
 902
 903 /* Buffer management support (drm_bufs.c) */
 904 int     drm_addmap_ioctl(struct drm_device *dev, void *data,
 905                          struct drm_file *file_priv);
 906 int     drm_rmmap_ioctl(struct drm_device *dev, void *data,
 907                         struct drm_file *file_priv);
 908 int     drm_addbufs(struct drm_device *dev, void *data,
 909                     struct drm_file *file_priv);
 910 int     drm_infobufs(struct drm_device *dev, void *data,
 911                      struct drm_file *file_priv);
 912 int     drm_markbufs(struct drm_device *dev, void *data,
 913                      struct drm_file *file_priv);
 914 int     drm_freebufs(struct drm_device *dev, void *data,
 915                      struct drm_file *file_priv);
 916 int     drm_mapbufs(struct drm_device *dev, void *data,
 917                     struct drm_file *file_priv);
 918
 919 /* DMA support (drm_dma.c) */
 920 int     drm_dma(struct drm_device *dev, void *data, struct drm_file *file_priv);
 921
 922 /* IRQ support (drm_irq.c) */
 923 int     drm_control(struct drm_device *dev, void *data,
 924                     struct drm_file *file_priv);
 925 int     drm_wait_vblank(struct drm_device *dev, void *data,
 926                         struct drm_file *file_priv);
 927
 928 /* AGP/GART support (drm_agpsupport.c) */
 929 int     drm_agp_acquire_ioctl(struct drm_device *dev, void *data,
 930                               struct drm_file *file_priv);
 931 int     drm_agp_release_ioctl(struct drm_device *dev, void *data,
 932                               struct drm_file *file_priv);
 933 int     drm_agp_enable_ioctl(struct drm_device *dev, void *data,
 934                              struct drm_file *file_priv);
 935 int     drm_agp_info_ioctl(struct drm_device *dev, void *data,
 936                            struct drm_file *file_priv);
 937 int     drm_agp_alloc_ioctl(struct drm_device *dev, void *data,
 938                             struct drm_file *file_priv);
 939 int     drm_agp_free_ioctl(struct drm_device *dev, void *data,
 940                            struct drm_file *file_priv);
 941 int     drm_agp_unbind_ioctl(struct drm_device *dev, void *data,
 942                              struct drm_file *file_priv);
 943 int     drm_agp_bind_ioctl(struct drm_device *dev, void *data,
 944                            struct drm_file *file_priv);
 945
 946 /* Scatter Gather Support (drm_scatter.c) */
 947 int     drm_sg_alloc_ioctl(struct drm_device *dev, void *data,
 948                            struct drm_file *file_priv);
 949 int     drm_sg_free(struct drm_device *dev, void *data,
 950                     struct drm_file *file_priv);
 951
 952 /* consistent PCI memory functions (drm_pci.c) */
 953 drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
 954                                 size_t align, dma_addr_t maxaddr);
 955 void    drm_pci_free(struct drm_device *dev, drm_dma_handle_t *dmah);
 956
 957 /* Inline replacements for drm_alloc and friends */
 958 static __inline__ void *
 959 drm_alloc(size_t size, struct malloc_type *area)
 960 {
 961         return malloc(size, area, M_NOWAIT);
 962 }
 963
 964 static __inline__ void *
 965 drm_calloc(size_t nmemb, size_t size, struct malloc_type *area)
 966 {
 967         return malloc(size * nmemb, area, M_NOWAIT | M_ZERO);
 968 }
 969
 970 static __inline__ void *
 971 drm_realloc(void *oldpt, size_t oldsize, size_t size,
 972     struct malloc_type *area)
 973 {
 974         return reallocf(oldpt, size, area, M_NOWAIT);
 975 }
 976
 977 static __inline__ void
 978 drm_free(void *pt, size_t size, struct malloc_type *area)
 979 {
 980         free(pt, area);
 981 }
 982
 983 /* Inline replacements for DRM_IOREMAP macros */
 984 static __inline__ void
 985 drm_core_ioremap_wc(struct drm_local_map *map, struct drm_device *dev)
 986 {
 987         map->handle = drm_ioremap_wc(dev, map);
 988 }
 989 static __inline__ void
 990 drm_core_ioremap(struct drm_local_map *map, struct drm_device *dev)
 991 {
 992         map->handle = drm_ioremap(dev, map);
 993 }
 994 static __inline__ void
 995 drm_core_ioremapfree(struct drm_local_map *map, struct drm_device *dev)
 996 {
 997         if ( map->handle && map->size )
 998                 drm_ioremapfree(map);
 999 }
1000
1001 static __inline__ struct drm_local_map *
1002 drm_core_findmap(struct drm_device *dev, unsigned long offset)
1003 {
1004         drm_local_map_t *map;
1005
1006         DRM_SPINLOCK_ASSERT(&dev->dev_lock);
1007         TAILQ_FOREACH(map, &dev->maplist, link) {
1008                 if (map->offset == offset)
1009                         return map;
1010         }
1011         return NULL;
1012 }
1013
1014 static __inline__ void drm_core_dropmap(struct drm_map *map)
1015 {
1016 }
1017
1018 #endif /* __KERNEL__ */
1019 #endif /* _DRM_P_H_ */