drmP.h revision 121447
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 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas. 5 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California. 6 * All rights reserved. 7 * 8 * Permission is hereby granted, free of charge, to any person obtaining a 9 * copy of this software and associated documentation files (the "Software"), 10 * to deal in the Software without restriction, including without limitation 11 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 12 * and/or sell copies of the Software, and to permit persons to whom the 13 * Software is furnished to do so, subject to the following conditions: 14 * 15 * The above copyright notice and this permission notice (including the next 16 * paragraph) shall be included in all copies or substantial portions of the 17 * Software. 18 * 19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 22 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 23 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 25 * OTHER DEALINGS IN THE SOFTWARE. 26 * 27 * Authors: 28 * Rickard E. (Rik) Faith <faith@valinux.com> 29 * Gareth Hughes <gareth@valinux.com> 30 * 31 * $FreeBSD: head/sys/dev/drm/drmP.h 121447 2003-10-24 01:48:17Z anholt $ 32 */ 33 34#ifndef _DRM_P_H_ 35#define _DRM_P_H_ 36 37#if defined(_KERNEL) || defined(__KERNEL__) 38 39/* DRM template customization defaults 40 */ 41#ifndef __HAVE_AGP 42#define __HAVE_AGP 0 43#endif 44#ifndef __HAVE_MTRR 45#define __HAVE_MTRR 0 46#endif 47#ifndef __HAVE_CTX_BITMAP 48#define __HAVE_CTX_BITMAP 0 49#endif 50#ifndef __HAVE_DMA 51#define __HAVE_DMA 0 52#endif 53#ifndef __HAVE_IRQ 54#define __HAVE_IRQ 0 55#endif 56 57#define DRM_DEBUG_CODE 0 /* Include debugging code (if > 1, then 58 also include looping detection. */ 59 60typedef struct drm_device drm_device_t; 61typedef struct drm_file drm_file_t; 62 63/* There's undoubtably more of this file to go into these OS dependent ones. */ 64 65#ifdef __FreeBSD__ 66#include "dev/drm/drm_os_freebsd.h" 67#elif defined __NetBSD__ 68#include "dev/drm/drm_os_netbsd.h" 69#endif 70 71#include "dev/drm/drm.h" 72 73/* Begin the DRM... */ 74 75#define DRM_HASH_SIZE 16 /* Size of key hash table */ 76#define DRM_KERNEL_CONTEXT 0 /* Change drm_resctx if changed */ 77#define DRM_RESERVED_CONTEXTS 1 /* Change drm_resctx if changed */ 78 79#define DRM_FLAG_DEBUG 0x01 80 81#define DRM_MEM_DMA 0 82#define DRM_MEM_SAREA 1 83#define DRM_MEM_DRIVER 2 84#define DRM_MEM_MAGIC 3 85#define DRM_MEM_IOCTLS 4 86#define DRM_MEM_MAPS 5 87#define DRM_MEM_BUFS 6 88#define DRM_MEM_SEGS 7 89#define DRM_MEM_PAGES 8 90#define DRM_MEM_FILES 9 91#define DRM_MEM_QUEUES 10 92#define DRM_MEM_CMDS 11 93#define DRM_MEM_MAPPINGS 12 94#define DRM_MEM_BUFLISTS 13 95#define DRM_MEM_AGPLISTS 14 96#define DRM_MEM_TOTALAGP 15 97#define DRM_MEM_BOUNDAGP 16 98#define DRM_MEM_CTXBITMAP 17 99#define DRM_MEM_STUB 18 100#define DRM_MEM_SGLISTS 19 101 102#define DRM_MAX_CTXBITMAP (PAGE_SIZE * 8) 103 104 /* Mapping helper macros */ 105#define DRM_IOREMAP(map, dev) \ 106 (map)->handle = DRM(ioremap)( dev, map ) 107 108#define DRM_IOREMAP_NOCACHE(map, dev) \ 109 (map)->handle = DRM(ioremap_nocache)( dev, map ) 110 111#define DRM_IOREMAPFREE(map, dev) \ 112 do { \ 113 if ( (map)->handle && (map)->size ) \ 114 DRM(ioremapfree)( map ); \ 115 } while (0) 116 117 /* Internal types and structures */ 118#define DRM_ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0])) 119#define DRM_MIN(a,b) ((a)<(b)?(a):(b)) 120#define DRM_MAX(a,b) ((a)>(b)?(a):(b)) 121 122#define DRM_GET_PRIV_SAREA(_dev, _ctx, _map) do { \ 123 (_map) = (_dev)->context_sareas[_ctx]; \ 124} while(0) 125 126 127typedef struct drm_pci_id_list 128{ 129 int vendor; 130 int device; 131 long driver_private; 132 char *name; 133} drm_pci_id_list_t; 134 135typedef struct drm_ioctl_desc { 136 int (*func)(DRM_IOCTL_ARGS); 137 int auth_needed; 138 int root_only; 139} drm_ioctl_desc_t; 140 141typedef struct drm_magic_entry { 142 drm_magic_t magic; 143 struct drm_file *priv; 144 struct drm_magic_entry *next; 145} drm_magic_entry_t; 146 147typedef struct drm_magic_head { 148 struct drm_magic_entry *head; 149 struct drm_magic_entry *tail; 150} drm_magic_head_t; 151 152typedef struct drm_buf { 153 int idx; /* Index into master buflist */ 154 int total; /* Buffer size */ 155 int order; /* log-base-2(total) */ 156 int used; /* Amount of buffer in use (for DMA) */ 157 unsigned long offset; /* Byte offset (used internally) */ 158 void *address; /* Address of buffer */ 159 unsigned long bus_address; /* Bus address of buffer */ 160 struct drm_buf *next; /* Kernel-only: used for free list */ 161 __volatile__ int pending; /* On hardware DMA queue */ 162 DRMFILE filp; /* Unique identifier of holding process */ 163 int context; /* Kernel queue for this buffer */ 164 enum { 165 DRM_LIST_NONE = 0, 166 DRM_LIST_FREE = 1, 167 DRM_LIST_WAIT = 2, 168 DRM_LIST_PEND = 3, 169 DRM_LIST_PRIO = 4, 170 DRM_LIST_RECLAIM = 5 171 } list; /* Which list we're on */ 172 173 int dev_priv_size; /* Size of buffer private stoarge */ 174 void *dev_private; /* Per-buffer private storage */ 175} drm_buf_t; 176 177typedef struct drm_freelist { 178 int initialized; /* Freelist in use */ 179 atomic_t count; /* Number of free buffers */ 180 drm_buf_t *next; /* End pointer */ 181 182 int low_mark; /* Low water mark */ 183 int high_mark; /* High water mark */ 184} drm_freelist_t; 185 186typedef struct drm_buf_entry { 187 int buf_size; 188 int buf_count; 189 drm_buf_t *buflist; 190 int seg_count; 191 int page_order; 192 vm_offset_t *seglist; 193 dma_addr_t *seglist_bus; 194 195 drm_freelist_t freelist; 196} drm_buf_entry_t; 197 198typedef struct drm_hw_lock { 199 __volatile__ unsigned int lock; 200 char padding[60]; /* Pad to cache line */ 201} drm_hw_lock_t; 202 203typedef TAILQ_HEAD(drm_file_list, drm_file) drm_file_list_t; 204struct drm_file { 205 TAILQ_ENTRY(drm_file) link; 206 int authenticated; 207 int minor; 208 pid_t pid; 209 uid_t uid; 210 int refs; 211 drm_magic_t magic; 212 unsigned long ioctl_count; 213 struct drm_device *devXX; 214}; 215 216typedef struct drm_lock_data { 217 drm_hw_lock_t *hw_lock; /* Hardware lock */ 218 DRMFILE filp; /* Unique identifier of holding process (NULL is kernel)*/ 219 int lock_queue; /* Queue of blocked processes */ 220 unsigned long lock_time; /* Time of last lock in jiffies */ 221} drm_lock_data_t; 222 223/* This structure, in the drm_device_t, is always initialized while the device 224 * is open. dev->dma_lock protects the incrementing of dev->buf_use, which 225 * when set marks that no further bufs may be allocated until device teardown 226 * occurs (when the last open of the device has closed). The high/low 227 * watermarks of bufs are only touched by the X Server, and thus not 228 * concurrently accessed, so no locking is needed. 229 */ 230typedef struct drm_device_dma { 231 drm_buf_entry_t bufs[DRM_MAX_ORDER+1]; 232 int buf_count; 233 drm_buf_t **buflist; /* Vector of pointers info bufs */ 234 int seg_count; 235 int page_count; 236 unsigned long *pagelist; 237 unsigned long byte_count; 238 enum { 239 _DRM_DMA_USE_AGP = 0x01, 240 _DRM_DMA_USE_SG = 0x02 241 } flags; 242 243 /* DMA support */ 244 drm_buf_t *this_buffer; /* Buffer being sent */ 245 drm_buf_t *next_buffer; /* Selected buffer to send */ 246} drm_device_dma_t; 247 248#if __REALLY_HAVE_AGP 249typedef struct drm_agp_mem { 250 void *handle; 251 unsigned long bound; /* address */ 252 int pages; 253 struct drm_agp_mem *prev; 254 struct drm_agp_mem *next; 255} drm_agp_mem_t; 256 257typedef struct drm_agp_head { 258 device_t agpdev; 259 struct agp_info info; 260 const char *chipset; 261 drm_agp_mem_t *memory; 262 unsigned long mode; 263 int enabled; 264 int acquired; 265 unsigned long base; 266 int agp_mtrr; 267 int cant_use_aperture; 268 unsigned long page_mask; 269} drm_agp_head_t; 270#endif 271 272typedef struct drm_sg_mem { 273 unsigned long handle; 274 void *virtual; 275 int pages; 276 dma_addr_t *busaddr; 277} drm_sg_mem_t; 278 279typedef struct drm_local_map { 280 unsigned long offset; /* Physical address (0 for SAREA)*/ 281 unsigned long size; /* Physical size (bytes) */ 282 drm_map_type_t type; /* Type of memory mapped */ 283 drm_map_flags_t flags; /* Flags */ 284 void *handle; /* User-space: "Handle" to pass to mmap */ 285 /* Kernel-space: kernel-virtual address */ 286 int mtrr; /* MTRR slot used */ 287 /* Private data */ 288 bus_space_tag_t iot; 289 bus_space_handle_t ioh; 290} drm_local_map_t; 291 292typedef TAILQ_HEAD(drm_map_list, drm_map_list_entry) drm_map_list_t; 293typedef struct drm_map_list_entry { 294 TAILQ_ENTRY(drm_map_list_entry) link; 295 drm_local_map_t *map; 296} drm_map_list_entry_t; 297 298TAILQ_HEAD(drm_vbl_sig_list, drm_vbl_sig); 299typedef struct drm_vbl_sig { 300 TAILQ_ENTRY(drm_vbl_sig) link; 301 unsigned int sequence; 302 int signo; 303 int pid; 304} drm_vbl_sig_t; 305 306struct drm_device { 307#ifdef __NetBSD__ 308 struct device device; /* NetBSD's softc is an extension of struct device */ 309#endif 310 const char *name; /* Simple driver name */ 311 char *unique; /* Unique identifier: e.g., busid */ 312 int unique_len; /* Length of unique field */ 313#ifdef __FreeBSD__ 314 device_t device; /* Device instance from newbus */ 315#endif 316 dev_t devnode; /* Device number for mknod */ 317 318 int flags; /* Flags to open(2) */ 319 320 /* Locks */ 321#if defined(__FreeBSD__) && __FreeBSD_version > 500000 322#if __HAVE_DMA 323 struct mtx dma_lock; /* protects dev->dma */ 324#endif 325#if __HAVE_IRQ 326 struct mtx irq_lock; /* protects irq condition checks */ 327#endif 328 struct mtx dev_lock; /* protects everything else */ 329#endif 330 /* Usage Counters */ 331 int open_count; /* Outstanding files open */ 332 int buf_use; /* Buffers in use -- cannot alloc */ 333 int buf_alloc; /* Buffer allocation in progress */ 334 335 /* Performance counters */ 336 unsigned long counters; 337 drm_stat_type_t types[15]; 338 atomic_t counts[15]; 339 340 /* Authentication */ 341 drm_file_list_t files; 342 drm_magic_head_t magiclist[DRM_HASH_SIZE]; 343 344 /* Linked list of mappable regions. Protected by dev_lock */ 345 drm_map_list_t *maplist; 346 347 drm_local_map_t **context_sareas; 348 int max_context; 349 350 drm_lock_data_t lock; /* Information on hardware lock */ 351 352 /* DMA queues (contexts) */ 353 drm_device_dma_t *dma; /* Optional pointer for DMA support */ 354 355 /* Context support */ 356 int irq; /* Interrupt used by board */ 357 int irqrid; /* Interrupt used by board */ 358#ifdef __FreeBSD__ 359 struct resource *irqr; /* Resource for interrupt used by board */ 360#elif defined(__NetBSD__) 361 struct pci_attach_args pa; 362 pci_intr_handle_t ih; 363#endif 364 void *irqh; /* Handle from bus_setup_intr */ 365 atomic_t context_flag; /* Context swapping flag */ 366 int last_context; /* Last current context */ 367#if __FreeBSD_version >= 400005 368 struct task task; 369#endif 370#if __HAVE_VBL_IRQ 371 int vbl_queue; /* vbl wait channel */ 372 atomic_t vbl_received; 373#endif 374 375#ifdef __FreeBSD__ 376 struct sigio *buf_sigio; /* Processes waiting for SIGIO */ 377#elif defined(__NetBSD__) 378 pid_t buf_pgid; 379#endif 380 381 /* Sysctl support */ 382 struct drm_sysctl_info *sysctl; 383 384#if __REALLY_HAVE_AGP 385 drm_agp_head_t *agp; 386#endif 387 drm_sg_mem_t *sg; /* Scatter gather memory */ 388 atomic_t *ctx_bitmap; 389 void *dev_private; 390}; 391 392extern int DRM(flags); 393 394 /* Memory management support (drm_memory.h) */ 395extern void DRM(mem_init)(void); 396extern void DRM(mem_uninit)(void); 397extern void *DRM(alloc)(size_t size, int area); 398extern void *DRM(calloc)(size_t nmemb, size_t size, int area); 399extern void *DRM(realloc)(void *oldpt, size_t oldsize, size_t size, 400 int area); 401extern void DRM(free)(void *pt, size_t size, int area); 402extern void *DRM(ioremap)(drm_device_t *dev, drm_local_map_t *map); 403extern void DRM(ioremapfree)(drm_local_map_t *map); 404extern int DRM(mtrr_add)(unsigned long offset, size_t size, int flags); 405extern int DRM(mtrr_del)(unsigned long offset, size_t size, int flags); 406 407#if __REALLY_HAVE_AGP 408extern agp_memory *DRM(alloc_agp)(int pages, u32 type); 409extern int DRM(free_agp)(agp_memory *handle, int pages); 410extern int DRM(bind_agp)(agp_memory *handle, unsigned int start); 411extern int DRM(unbind_agp)(agp_memory *handle); 412#endif 413 414extern int DRM(context_switch)(drm_device_t *dev, int old, int new); 415extern int DRM(context_switch_complete)(drm_device_t *dev, int new); 416 417#if __HAVE_CTX_BITMAP 418extern int DRM(ctxbitmap_init)( drm_device_t *dev ); 419extern void DRM(ctxbitmap_cleanup)( drm_device_t *dev ); 420extern void DRM(ctxbitmap_free)( drm_device_t *dev, int ctx_handle ); 421extern int DRM(ctxbitmap_next)( drm_device_t *dev ); 422#endif 423 424 /* Locking IOCTL support (drm_lock.h) */ 425extern int DRM(lock_take)(__volatile__ unsigned int *lock, 426 unsigned int context); 427extern int DRM(lock_transfer)(drm_device_t *dev, 428 __volatile__ unsigned int *lock, 429 unsigned int context); 430extern int DRM(lock_free)(drm_device_t *dev, 431 __volatile__ unsigned int *lock, 432 unsigned int context); 433 434 /* Buffer management support (drm_bufs.h) */ 435extern int DRM(order)( unsigned long size ); 436 437#if __HAVE_DMA 438 /* DMA support (drm_dma.h) */ 439extern int DRM(dma_setup)(drm_device_t *dev); 440extern void DRM(dma_takedown)(drm_device_t *dev); 441extern void DRM(free_buffer)(drm_device_t *dev, drm_buf_t *buf); 442extern void DRM(reclaim_buffers)(drm_device_t *dev, DRMFILE filp); 443#endif 444 445#if __HAVE_IRQ 446 /* IRQ support (drm_irq.h) */ 447extern int DRM(irq_install)( drm_device_t *dev, int irq ); 448extern int DRM(irq_uninstall)( drm_device_t *dev ); 449extern irqreturn_t DRM(irq_handler)( DRM_IRQ_ARGS ); 450extern void DRM(driver_irq_preinstall)( drm_device_t *dev ); 451extern void DRM(driver_irq_postinstall)( drm_device_t *dev ); 452extern void DRM(driver_irq_uninstall)( drm_device_t *dev ); 453#if __HAVE_IRQ_BH 454extern void DRM(irq_immediate_bh)( DRM_TASKQUEUE_ARGS ); 455#endif 456#endif 457 458#if __HAVE_VBL_IRQ 459extern int DRM(vblank_wait)(drm_device_t *dev, unsigned int *vbl_seq); 460extern void DRM(vbl_send_signals)( drm_device_t *dev ); 461#endif 462 463#if __REALLY_HAVE_AGP 464 /* AGP/GART support (drm_agpsupport.h) */ 465extern drm_agp_head_t *DRM(agp_init)(void); 466extern void DRM(agp_uninit)(void); 467extern void DRM(agp_do_release)(void); 468extern agp_memory *DRM(agp_allocate_memory)(size_t pages, u32 type); 469extern int DRM(agp_free_memory)(agp_memory *handle); 470extern int DRM(agp_bind_memory)(agp_memory *handle, off_t start); 471extern int DRM(agp_unbind_memory)(agp_memory *handle); 472#endif 473 474#if __HAVE_SG 475 /* Scatter Gather Support (drm_scatter.h) */ 476extern void DRM(sg_cleanup)(drm_sg_mem_t *entry); 477#endif 478 479#if __REALLY_HAVE_SG 480 /* ATI PCIGART support (ati_pcigart.h) */ 481extern int DRM(ati_pcigart_init)(drm_device_t *dev, 482 unsigned long *addr, 483 dma_addr_t *bus_addr); 484extern int DRM(ati_pcigart_cleanup)(drm_device_t *dev, 485 unsigned long addr, 486 dma_addr_t bus_addr); 487#endif 488 489/* Locking IOCTL support (drm_drv.h) */ 490extern int DRM(lock)(DRM_IOCTL_ARGS); 491extern int DRM(unlock)(DRM_IOCTL_ARGS); 492extern int DRM(version)( DRM_IOCTL_ARGS ); 493extern int DRM(setversion)( DRM_IOCTL_ARGS ); 494 495/* Misc. IOCTL support (drm_ioctl.h) */ 496extern int DRM(irq_busid)(DRM_IOCTL_ARGS); 497extern int DRM(getunique)(DRM_IOCTL_ARGS); 498extern int DRM(setunique)(DRM_IOCTL_ARGS); 499extern int DRM(getmap)(DRM_IOCTL_ARGS); 500extern int DRM(getclient)(DRM_IOCTL_ARGS); 501extern int DRM(getstats)(DRM_IOCTL_ARGS); 502extern int DRM(noop)(DRM_IOCTL_ARGS); 503 504/* Context IOCTL support (drm_context.h) */ 505extern int DRM(resctx)(DRM_IOCTL_ARGS); 506extern int DRM(addctx)(DRM_IOCTL_ARGS); 507extern int DRM(modctx)(DRM_IOCTL_ARGS); 508extern int DRM(getctx)(DRM_IOCTL_ARGS); 509extern int DRM(switchctx)(DRM_IOCTL_ARGS); 510extern int DRM(newctx)(DRM_IOCTL_ARGS); 511extern int DRM(rmctx)(DRM_IOCTL_ARGS); 512extern int DRM(setsareactx)(DRM_IOCTL_ARGS); 513extern int DRM(getsareactx)(DRM_IOCTL_ARGS); 514 515/* Drawable IOCTL support (drm_drawable.h) */ 516extern int DRM(adddraw)(DRM_IOCTL_ARGS); 517extern int DRM(rmdraw)(DRM_IOCTL_ARGS); 518 519/* Authentication IOCTL support (drm_auth.h) */ 520extern int DRM(getmagic)(DRM_IOCTL_ARGS); 521extern int DRM(authmagic)(DRM_IOCTL_ARGS); 522 523/* Buffer management support (drm_bufs.h) */ 524extern int DRM(addmap)(DRM_IOCTL_ARGS); 525extern int DRM(rmmap)(DRM_IOCTL_ARGS); 526#if __HAVE_DMA 527extern int DRM(addbufs)(DRM_IOCTL_ARGS); 528extern int DRM(infobufs)(DRM_IOCTL_ARGS); 529extern int DRM(markbufs)(DRM_IOCTL_ARGS); 530extern int DRM(freebufs)(DRM_IOCTL_ARGS); 531extern int DRM(mapbufs)(DRM_IOCTL_ARGS); 532#endif 533 534/* IRQ support (drm_irq.h) */ 535#if __HAVE_IRQ || __HAVE_DMA 536extern int DRM(control)(DRM_IOCTL_ARGS); 537#endif 538#if __HAVE_VBL_IRQ 539extern int DRM(wait_vblank)(DRM_IOCTL_ARGS); 540#endif 541 542/* AGP/GART support (drm_agpsupport.h) */ 543#if __REALLY_HAVE_AGP 544extern int DRM(agp_acquire)(DRM_IOCTL_ARGS); 545extern int DRM(agp_release)(DRM_IOCTL_ARGS); 546extern int DRM(agp_enable)(DRM_IOCTL_ARGS); 547extern int DRM(agp_info)(DRM_IOCTL_ARGS); 548extern int DRM(agp_alloc)(DRM_IOCTL_ARGS); 549extern int DRM(agp_free)(DRM_IOCTL_ARGS); 550extern int DRM(agp_unbind)(DRM_IOCTL_ARGS); 551extern int DRM(agp_bind)(DRM_IOCTL_ARGS); 552#endif 553 554/* Scatter Gather Support (drm_scatter.h) */ 555#if __HAVE_SG 556extern int DRM(sg_alloc)(DRM_IOCTL_ARGS); 557extern int DRM(sg_free)(DRM_IOCTL_ARGS); 558#endif 559 560/* consistent PCI memory functions (drm_pci.h) */ 561extern void *DRM(pci_alloc)(drm_device_t *dev, size_t size, 562 size_t align, dma_addr_t maxaddr, 563 dma_addr_t *busaddr); 564extern void DRM(pci_free)(drm_device_t *dev, size_t size, 565 void *vaddr, dma_addr_t busaddr); 566 567#endif /* __KERNEL__ */ 568#endif /* _DRM_P_H_ */ 569