1 /* drmP.h -- Private header for Direct Rendering Manager -*- linux-c -*-
2 * Created: Mon Jan 4 10:05:05 1999 by faith@precisioninsight.com
4 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
5 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
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:
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
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.
28 * Rickard E. (Rik) Faith <faith@valinux.com>
29 * Gareth Hughes <gareth@valinux.com>
30 * $FreeBSD: src/sys/dev/drm/drmP.h,v 1.4.2.1 2003/04/26 07:05:27 anholt Exp $
36 #if defined(_KERNEL) || defined(__KERNEL__)
38 /* DRM template customization defaults
46 #ifndef __HAVE_CTX_BITMAP
47 #define __HAVE_CTX_BITMAP 0
52 #ifndef __HAVE_DMA_IRQ
53 #define __HAVE_DMA_IRQ 0
56 #define DRM_DEBUG_CODE 0 /* Include debugging code (if > 1, then
57 also include looping detection. */
59 typedef struct drm_device drm_device_t;
60 typedef struct drm_file drm_file_t;
62 /* There's undoubtably more of this file to go into these OS dependent ones. */
65 #include "dev/drm/drm_os_freebsd.h"
66 #elif defined __NetBSD__
67 #include "dev/drm/drm_os_netbsd.h"
70 #include "dev/drm/drm.h"
72 /* Begin the DRM... */
74 #define DRM_HASH_SIZE 16 /* Size of key hash table */
75 #define DRM_KERNEL_CONTEXT 0 /* Change drm_resctx if changed */
76 #define DRM_RESERVED_CONTEXTS 1 /* Change drm_resctx if changed */
78 #define DRM_FLAG_DEBUG 0x01
81 #define DRM_MEM_SAREA 1
82 #define DRM_MEM_DRIVER 2
83 #define DRM_MEM_MAGIC 3
84 #define DRM_MEM_IOCTLS 4
85 #define DRM_MEM_MAPS 5
86 #define DRM_MEM_BUFS 6
87 #define DRM_MEM_SEGS 7
88 #define DRM_MEM_PAGES 8
89 #define DRM_MEM_FILES 9
90 #define DRM_MEM_QUEUES 10
91 #define DRM_MEM_CMDS 11
92 #define DRM_MEM_MAPPINGS 12
93 #define DRM_MEM_BUFLISTS 13
94 #define DRM_MEM_AGPLISTS 14
95 #define DRM_MEM_TOTALAGP 15
96 #define DRM_MEM_BOUNDAGP 16
97 #define DRM_MEM_CTXBITMAP 17
98 #define DRM_MEM_STUB 18
99 #define DRM_MEM_SGLISTS 19
101 #define DRM_MAX_CTXBITMAP (PAGE_SIZE * 8)
103 /* Mapping helper macros */
104 #define DRM_IOREMAP(map) \
105 (map)->handle = DRM(ioremap)( dev, map )
107 #define DRM_IOREMAP_NOCACHE(map) \
108 (map)->handle = DRM(ioremap_nocache)( dev, map )
110 #define DRM_IOREMAPFREE(map) \
112 if ( (map)->handle && (map)->size ) \
113 DRM(ioremapfree)( map ); \
116 /* Internal types and structures */
117 #define DRM_ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
118 #define DRM_MIN(a,b) ((a)<(b)?(a):(b))
119 #define DRM_MAX(a,b) ((a)>(b)?(a):(b))
121 #define DRM_LEFTCOUNT(x) (((x)->rp + (x)->count - (x)->wp) % ((x)->count + 1))
122 #define DRM_BUFCOUNT(x) ((x)->count - DRM_LEFTCOUNT(x))
123 #define DRM_WAITCOUNT(dev,idx) DRM_BUFCOUNT(&dev->queuelist[idx]->waitlist)
125 #define DRM_GET_PRIV_SAREA(_dev, _ctx, _map) do { \
126 (_map) = (_dev)->context_sareas[_ctx]; \
130 typedef struct drm_ioctl_desc {
131 int (*func)(DRM_IOCTL_ARGS);
136 typedef struct drm_magic_entry {
138 struct drm_file *priv;
139 struct drm_magic_entry *next;
142 typedef struct drm_magic_head {
143 struct drm_magic_entry *head;
144 struct drm_magic_entry *tail;
147 typedef struct drm_buf {
148 int idx; /* Index into master buflist */
149 int total; /* Buffer size */
150 int order; /* log-base-2(total) */
151 int used; /* Amount of buffer in use (for DMA) */
152 unsigned long offset; /* Byte offset (used internally) */
153 void *address; /* Address of buffer */
154 unsigned long bus_address; /* Bus address of buffer */
155 struct drm_buf *next; /* Kernel-only: used for free list */
156 __volatile__ int pending; /* On hardware DMA queue */
157 DRMFILE filp; /* Unique identifier of holding process */
158 int context; /* Kernel queue for this buffer */
166 } list; /* Which list we're on */
168 int dev_priv_size; /* Size of buffer private stoarge */
169 void *dev_private; /* Per-buffer private storage */
172 /* bufs is one longer than it has to be */
173 typedef struct drm_waitlist {
174 int count; /* Number of possible buffers */
175 drm_buf_t **bufs; /* List of pointers to buffers */
176 drm_buf_t **rp; /* Read pointer */
177 drm_buf_t **wp; /* Write pointer */
178 drm_buf_t **end; /* End pointer */
179 DRM_SPINTYPE read_lock;
180 DRM_SPINTYPE write_lock;
183 typedef struct drm_freelist {
184 int initialized; /* Freelist in use */
185 atomic_t count; /* Number of free buffers */
186 drm_buf_t *next; /* End pointer */
188 int low_mark; /* Low water mark */
189 int high_mark; /* High water mark */
193 typedef struct drm_buf_entry {
199 unsigned long *seglist;
201 drm_freelist_t freelist;
204 typedef struct drm_hw_lock {
205 __volatile__ unsigned int lock;
206 char padding[60]; /* Pad to cache line */
209 typedef TAILQ_HEAD(drm_file_list, drm_file) drm_file_list_t;
211 TAILQ_ENTRY(drm_file) link;
218 unsigned long ioctl_count;
219 struct drm_device *devXX;
222 typedef struct drm_lock_data {
223 drm_hw_lock_t *hw_lock; /* Hardware lock */
224 DRMFILE filp; /* Unique identifier of holding process (NULL is kernel)*/
225 wait_queue_head_t lock_queue; /* Queue of blocked processes */
226 unsigned long lock_time; /* Time of last lock in jiffies */
229 typedef struct drm_device_dma {
230 drm_buf_entry_t bufs[DRM_MAX_ORDER+1];
232 drm_buf_t **buflist; /* Vector of pointers info bufs */
235 unsigned long *pagelist;
236 unsigned long byte_count;
238 _DRM_DMA_USE_AGP = 0x01,
239 _DRM_DMA_USE_SG = 0x02
243 drm_buf_t *this_buffer; /* Buffer being sent */
244 drm_buf_t *next_buffer; /* Selected buffer to send */
247 #if __REALLY_HAVE_AGP
248 typedef struct drm_agp_mem {
250 unsigned long bound; /* address */
252 struct drm_agp_mem *prev;
253 struct drm_agp_mem *next;
256 typedef struct drm_agp_head {
258 struct agp_info info;
260 drm_agp_mem_t *memory;
266 int cant_use_aperture;
267 unsigned long page_mask;
271 typedef struct drm_sg_mem {
272 unsigned long handle;
278 typedef struct drm_local_map {
279 unsigned long offset; /* Physical address (0 for SAREA)*/
280 unsigned long size; /* Physical size (bytes) */
281 drm_map_type_t type; /* Type of memory mapped */
282 drm_map_flags_t flags; /* Flags */
283 void *handle; /* User-space: "Handle" to pass to mmap */
284 /* Kernel-space: kernel-virtual address */
285 int mtrr; /* MTRR slot used */
288 bus_space_handle_t ioh;
291 typedef TAILQ_HEAD(drm_map_list, drm_map_list_entry) drm_map_list_t;
292 typedef struct drm_map_list_entry {
293 TAILQ_ENTRY(drm_map_list_entry) link;
294 drm_local_map_t *map;
295 } drm_map_list_entry_t;
297 TAILQ_HEAD(drm_vbl_sig_list, drm_vbl_sig);
298 typedef struct drm_vbl_sig {
299 TAILQ_ENTRY(drm_vbl_sig) link;
300 unsigned int sequence;
307 struct device device; /* NetBSD's softc is an extension of struct device */
309 const char *name; /* Simple driver name */
310 char *unique; /* Unique identifier: e.g., busid */
311 int unique_len; /* Length of unique field */
313 device_t device; /* Device instance from newbus */
315 dev_t devnode; /* Device number for mknod */
317 int flags; /* Flags to open(2) */
320 DRM_SPINTYPE count_lock; /* For open_count, buf_use, buf_alloc */
321 struct lock dev_lock; /* For others */
323 int open_count; /* Outstanding files open */
324 int buf_use; /* Buffers in use -- cannot alloc */
325 int buf_alloc; /* Buffer allocation in progress */
327 /* Performance counters */
328 unsigned long counters;
329 drm_stat_type_t types[15];
333 drm_file_list_t files;
334 drm_magic_head_t magiclist[DRM_HASH_SIZE];
336 /* Memory management */
337 drm_map_list_t *maplist; /* Linked list of regions */
339 drm_local_map_t **context_sareas;
342 drm_lock_data_t lock; /* Information on hardware lock */
344 /* DMA queues (contexts) */
345 drm_device_dma_t *dma; /* Optional pointer for DMA support */
347 /* Context support */
348 int irq; /* Interrupt used by board */
349 int irqrid; /* Interrupt used by board */
351 struct resource *irqr; /* Resource for interrupt used by board */
352 #elif defined(__NetBSD__)
353 struct pci_attach_args pa;
354 pci_intr_handle_t ih;
356 void *irqh; /* Handle from bus_setup_intr */
357 atomic_t context_flag; /* Context swapping flag */
358 struct callout timer; /* Timer for delaying ctx switch */
359 int last_context; /* Last current context */
360 #if __FreeBSD_version >= 400005
364 wait_queue_head_t vbl_queue; /* vbl wait channel */
365 atomic_t vbl_received;
366 #if 0 /* vbl signals are untested */
367 struct drm_vbl_sig_list vbl_sig_list;
368 DRM_SPINTYPE vbl_lock;
373 struct sigio *buf_sigio; /* Processes waiting for SIGIO */
374 #elif defined(__NetBSD__)
379 struct drm_sysctl_info *sysctl;
381 #if __REALLY_HAVE_AGP
384 drm_sg_mem_t *sg; /* Scatter gather memory */
385 atomic_t *ctx_bitmap;
389 extern int DRM(flags);
391 /* Authentication (drm_auth.h) */
392 extern int DRM(add_magic)(drm_device_t *dev, drm_file_t *priv,
394 extern int DRM(remove_magic)(drm_device_t *dev, drm_magic_t magic);
396 /* Driver support (drm_drv.h) */
397 extern int DRM(version)( DRM_IOCTL_ARGS );
399 /* Memory management support (drm_memory.h) */
400 extern void DRM(mem_init)(void);
401 extern void DRM(mem_uninit)(void);
402 extern void *DRM(alloc)(size_t size, int area);
403 extern void *DRM(realloc)(void *oldpt, size_t oldsize, size_t size,
405 extern char *DRM(strdup)(const char *s, int area);
406 extern void DRM(strfree)(char *s, int area);
407 extern void DRM(free)(void *pt, size_t size, int area);
408 extern void *DRM(ioremap)(drm_device_t *dev, drm_local_map_t *map);
409 extern void *DRM(ioremap_nocache)(drm_device_t *dev, drm_local_map_t *map);
410 extern void DRM(ioremapfree)(drm_local_map_t *map);
412 #if __REALLY_HAVE_AGP
413 extern agp_memory *DRM(alloc_agp)(int pages, u32 type);
414 extern int DRM(free_agp)(agp_memory *handle, int pages);
415 extern int DRM(bind_agp)(agp_memory *handle, unsigned int start);
416 extern int DRM(unbind_agp)(agp_memory *handle);
419 extern int DRM(context_switch)(drm_device_t *dev, int old, int new);
420 extern int DRM(context_switch_complete)(drm_device_t *dev, int new);
422 #if __HAVE_CTX_BITMAP
423 extern int DRM(ctxbitmap_init)( drm_device_t *dev );
424 extern void DRM(ctxbitmap_cleanup)( drm_device_t *dev );
425 extern void DRM(ctxbitmap_free)( drm_device_t *dev, int ctx_handle );
426 extern int DRM(ctxbitmap_next)( drm_device_t *dev );
429 /* Locking IOCTL support (drm_lock.h) */
430 extern int DRM(lock_take)(__volatile__ unsigned int *lock,
431 unsigned int context);
432 extern int DRM(lock_transfer)(drm_device_t *dev,
433 __volatile__ unsigned int *lock,
434 unsigned int context);
435 extern int DRM(lock_free)(drm_device_t *dev,
436 __volatile__ unsigned int *lock,
437 unsigned int context);
439 /* Buffer management support (drm_bufs.h) */
440 extern int DRM(order)( unsigned long size );
443 /* DMA support (drm_dma.h) */
444 extern int DRM(dma_setup)(drm_device_t *dev);
445 extern void DRM(dma_takedown)(drm_device_t *dev);
446 extern void DRM(free_buffer)(drm_device_t *dev, drm_buf_t *buf);
447 extern void DRM(reclaim_buffers)(drm_device_t *dev, DRMFILE filp);
449 extern int DRM(irq_install)( drm_device_t *dev, int irq );
450 extern int DRM(irq_uninstall)( drm_device_t *dev );
451 extern void DRM(dma_service)( DRM_IRQ_ARGS );
452 extern void DRM(driver_irq_preinstall)( drm_device_t *dev );
453 extern void DRM(driver_irq_postinstall)( drm_device_t *dev );
454 extern void DRM(driver_irq_uninstall)( drm_device_t *dev );
455 #if __HAVE_DMA_IRQ_BH
456 extern void DRM(dma_immediate_bh)( DRM_TASKQUEUE_ARGS );
460 /* Buffer list support (drm_lists.h) */
461 #if __HAVE_DMA_WAITLIST
462 extern int DRM(waitlist_create)(drm_waitlist_t *bl, int count);
463 extern int DRM(waitlist_destroy)(drm_waitlist_t *bl);
464 extern int DRM(waitlist_put)(drm_waitlist_t *bl, drm_buf_t *buf);
465 extern drm_buf_t *DRM(waitlist_get)(drm_waitlist_t *bl);
467 #endif /* __HAVE_DMA */
469 extern int DRM(vblank_wait)(drm_device_t *dev, unsigned int *vbl_seq);
470 extern void DRM(vbl_send_signals)( drm_device_t *dev );
473 #if __REALLY_HAVE_AGP
474 /* AGP/GART support (drm_agpsupport.h) */
475 extern drm_agp_head_t *DRM(agp_init)(void);
476 extern void DRM(agp_uninit)(void);
477 extern void DRM(agp_do_release)(void);
478 extern agp_memory *DRM(agp_allocate_memory)(size_t pages, u32 type);
479 extern int DRM(agp_free_memory)(agp_memory *handle);
480 extern int DRM(agp_bind_memory)(agp_memory *handle, off_t start);
481 extern int DRM(agp_unbind_memory)(agp_memory *handle);
485 /* Scatter Gather Support (drm_scatter.h) */
486 extern void DRM(sg_cleanup)(drm_sg_mem_t *entry);
490 /* ATI PCIGART support (ati_pcigart.h) */
491 extern int DRM(ati_pcigart_init)(drm_device_t *dev,
493 dma_addr_t *bus_addr);
494 extern int DRM(ati_pcigart_cleanup)(drm_device_t *dev,
496 dma_addr_t bus_addr);
499 /* Locking IOCTL support (drm_drv.h) */
500 extern int DRM(lock)(DRM_IOCTL_ARGS);
501 extern int DRM(unlock)(DRM_IOCTL_ARGS);
503 /* Misc. IOCTL support (drm_ioctl.h) */
504 extern int DRM(irq_busid)(DRM_IOCTL_ARGS);
505 extern int DRM(getunique)(DRM_IOCTL_ARGS);
506 extern int DRM(setunique)(DRM_IOCTL_ARGS);
507 extern int DRM(getmap)(DRM_IOCTL_ARGS);
508 extern int DRM(getclient)(DRM_IOCTL_ARGS);
509 extern int DRM(getstats)(DRM_IOCTL_ARGS);
510 extern int DRM(noop)(DRM_IOCTL_ARGS);
512 /* Context IOCTL support (drm_context.h) */
513 extern int DRM(resctx)(DRM_IOCTL_ARGS);
514 extern int DRM(addctx)(DRM_IOCTL_ARGS);
515 extern int DRM(modctx)(DRM_IOCTL_ARGS);
516 extern int DRM(getctx)(DRM_IOCTL_ARGS);
517 extern int DRM(switchctx)(DRM_IOCTL_ARGS);
518 extern int DRM(newctx)(DRM_IOCTL_ARGS);
519 extern int DRM(rmctx)(DRM_IOCTL_ARGS);
520 extern int DRM(setsareactx)(DRM_IOCTL_ARGS);
521 extern int DRM(getsareactx)(DRM_IOCTL_ARGS);
523 /* Drawable IOCTL support (drm_drawable.h) */
524 extern int DRM(adddraw)(DRM_IOCTL_ARGS);
525 extern int DRM(rmdraw)(DRM_IOCTL_ARGS);
527 /* Authentication IOCTL support (drm_auth.h) */
528 extern int DRM(getmagic)(DRM_IOCTL_ARGS);
529 extern int DRM(authmagic)(DRM_IOCTL_ARGS);
531 /* Buffer management support (drm_bufs.h) */
532 extern int DRM(addmap)(DRM_IOCTL_ARGS);
533 extern int DRM(rmmap)(DRM_IOCTL_ARGS);
535 extern int DRM(addbufs)(DRM_IOCTL_ARGS);
536 extern int DRM(infobufs)(DRM_IOCTL_ARGS);
537 extern int DRM(markbufs)(DRM_IOCTL_ARGS);
538 extern int DRM(freebufs)(DRM_IOCTL_ARGS);
539 extern int DRM(mapbufs)(DRM_IOCTL_ARGS);
542 /* DMA support (drm_dma.h) */
544 extern int DRM(control)(DRM_IOCTL_ARGS);
547 extern int DRM(wait_vblank)(DRM_IOCTL_ARGS);
550 /* AGP/GART support (drm_agpsupport.h) */
551 #if __REALLY_HAVE_AGP
552 extern int DRM(agp_acquire)(DRM_IOCTL_ARGS);
553 extern int DRM(agp_release)(DRM_IOCTL_ARGS);
554 extern int DRM(agp_enable)(DRM_IOCTL_ARGS);
555 extern int DRM(agp_info)(DRM_IOCTL_ARGS);
556 extern int DRM(agp_alloc)(DRM_IOCTL_ARGS);
557 extern int DRM(agp_free)(DRM_IOCTL_ARGS);
558 extern int DRM(agp_unbind)(DRM_IOCTL_ARGS);
559 extern int DRM(agp_bind)(DRM_IOCTL_ARGS);
562 /* Scatter Gather Support (drm_scatter.h) */
564 extern int DRM(sg_alloc)(DRM_IOCTL_ARGS);
565 extern int DRM(sg_free)(DRM_IOCTL_ARGS);
569 #endif /* __KERNEL__ */
570 #endif /* _DRM_P_H_ */