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