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 $
31 * $DragonFly: src/sys/dev/drm/drmP.h,v 1.3 2004/02/13 01:23:57 joerg Exp $
37 #if defined(_KERNEL) || defined(__KERNEL__)
39 /* DRM template customization defaults
47 #ifndef __HAVE_CTX_BITMAP
48 #define __HAVE_CTX_BITMAP 0
53 #ifndef __HAVE_DMA_IRQ
54 #define __HAVE_DMA_IRQ 0
57 #define DRM_DEBUG_CODE 0 /* Include debugging code (if > 1, then
58 also include looping detection. */
60 typedef struct drm_device drm_device_t;
61 typedef struct drm_file drm_file_t;
63 /* There's undoubtably more of this file to go into these OS dependent ones. */
65 #if defined(__DragonFly__) || defined(__FreeBSD__)
66 #include "dev/drm/drm_os_freebsd.h"
67 #elif defined __NetBSD__
68 #include "dev/drm/drm_os_netbsd.h"
71 #include "dev/drm/drm.h"
73 /* Begin the DRM... */
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 */
79 #define DRM_FLAG_DEBUG 0x01
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
102 #define DRM_MAX_CTXBITMAP (PAGE_SIZE * 8)
104 /* Mapping helper macros */
105 #define DRM_IOREMAP(map) \
106 (map)->handle = DRM(ioremap)( dev, map )
108 #define DRM_IOREMAP_NOCACHE(map) \
109 (map)->handle = DRM(ioremap_nocache)( dev, map )
111 #define DRM_IOREMAPFREE(map) \
113 if ( (map)->handle && (map)->size ) \
114 DRM(ioremapfree)( map ); \
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))
122 #define DRM_LEFTCOUNT(x) (((x)->rp + (x)->count - (x)->wp) % ((x)->count + 1))
123 #define DRM_BUFCOUNT(x) ((x)->count - DRM_LEFTCOUNT(x))
124 #define DRM_WAITCOUNT(dev,idx) DRM_BUFCOUNT(&dev->queuelist[idx]->waitlist)
126 #define DRM_GET_PRIV_SAREA(_dev, _ctx, _map) do { \
127 (_map) = (_dev)->context_sareas[_ctx]; \
131 typedef struct drm_ioctl_desc {
132 int (*func)(DRM_IOCTL_ARGS);
137 typedef struct drm_magic_entry {
139 struct drm_file *priv;
140 struct drm_magic_entry *next;
143 typedef struct drm_magic_head {
144 struct drm_magic_entry *head;
145 struct drm_magic_entry *tail;
148 typedef struct drm_buf {
149 int idx; /* Index into master buflist */
150 int total; /* Buffer size */
151 int order; /* log-base-2(total) */
152 int used; /* Amount of buffer in use (for DMA) */
153 unsigned long offset; /* Byte offset (used internally) */
154 void *address; /* Address of buffer */
155 unsigned long bus_address; /* Bus address of buffer */
156 struct drm_buf *next; /* Kernel-only: used for free list */
157 __volatile__ int pending; /* On hardware DMA queue */
158 DRMFILE filp; /* Unique identifier of holding process */
159 int context; /* Kernel queue for this buffer */
167 } list; /* Which list we're on */
169 int dev_priv_size; /* Size of buffer private stoarge */
170 void *dev_private; /* Per-buffer private storage */
173 /* bufs is one longer than it has to be */
174 typedef struct drm_waitlist {
175 int count; /* Number of possible buffers */
176 drm_buf_t **bufs; /* List of pointers to buffers */
177 drm_buf_t **rp; /* Read pointer */
178 drm_buf_t **wp; /* Write pointer */
179 drm_buf_t **end; /* End pointer */
180 DRM_SPINTYPE read_lock;
181 DRM_SPINTYPE write_lock;
184 typedef struct drm_freelist {
185 int initialized; /* Freelist in use */
186 atomic_t count; /* Number of free buffers */
187 drm_buf_t *next; /* End pointer */
189 int low_mark; /* Low water mark */
190 int high_mark; /* High water mark */
194 typedef struct drm_buf_entry {
200 unsigned long *seglist;
202 drm_freelist_t freelist;
205 typedef struct drm_hw_lock {
206 __volatile__ unsigned int lock;
207 char padding[60]; /* Pad to cache line */
210 typedef TAILQ_HEAD(drm_file_list, drm_file) drm_file_list_t;
212 TAILQ_ENTRY(drm_file) link;
219 unsigned long ioctl_count;
220 struct drm_device *devXX;
223 typedef struct drm_lock_data {
224 drm_hw_lock_t *hw_lock; /* Hardware lock */
225 DRMFILE filp; /* Unique identifier of holding process (NULL is kernel)*/
226 wait_queue_head_t lock_queue; /* Queue of blocked processes */
227 unsigned long lock_time; /* Time of last lock in jiffies */
230 typedef struct drm_device_dma {
231 drm_buf_entry_t bufs[DRM_MAX_ORDER+1];
233 drm_buf_t **buflist; /* Vector of pointers info bufs */
236 unsigned long *pagelist;
237 unsigned long byte_count;
239 _DRM_DMA_USE_AGP = 0x01,
240 _DRM_DMA_USE_SG = 0x02
244 drm_buf_t *this_buffer; /* Buffer being sent */
245 drm_buf_t *next_buffer; /* Selected buffer to send */
248 #if __REALLY_HAVE_AGP
249 typedef struct drm_agp_mem {
251 unsigned long bound; /* address */
253 struct drm_agp_mem *prev;
254 struct drm_agp_mem *next;
257 typedef struct drm_agp_head {
259 struct agp_info info;
261 drm_agp_mem_t *memory;
267 int cant_use_aperture;
268 unsigned long page_mask;
272 typedef struct drm_sg_mem {
273 unsigned long handle;
279 typedef 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 */
289 bus_space_handle_t ioh;
292 typedef TAILQ_HEAD(drm_map_list, drm_map_list_entry) drm_map_list_t;
293 typedef 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;
298 TAILQ_HEAD(drm_vbl_sig_list, drm_vbl_sig);
299 typedef struct drm_vbl_sig {
300 TAILQ_ENTRY(drm_vbl_sig) link;
301 unsigned int sequence;
308 struct device device; /* NetBSD's softc is an extension of struct device */
310 const char *name; /* Simple driver name */
311 char *unique; /* Unique identifier: e.g., busid */
312 int unique_len; /* Length of unique field */
313 #if defined(__DragonFly__) || defined(__FreeBSD__)
314 device_t device; /* Device instance from newbus */
316 dev_t devnode; /* Device number for mknod */
318 int flags; /* Flags to open(2) */
321 DRM_SPINTYPE count_lock; /* For open_count, buf_use, buf_alloc */
322 struct lock dev_lock; /* For others */
324 int open_count; /* Outstanding files open */
325 int buf_use; /* Buffers in use -- cannot alloc */
326 int buf_alloc; /* Buffer allocation in progress */
328 /* Performance counters */
329 unsigned long counters;
330 drm_stat_type_t types[15];
334 drm_file_list_t files;
335 drm_magic_head_t magiclist[DRM_HASH_SIZE];
337 /* Memory management */
338 drm_map_list_t *maplist; /* Linked list of regions */
340 drm_local_map_t **context_sareas;
343 drm_lock_data_t lock; /* Information on hardware lock */
345 /* DMA queues (contexts) */
346 drm_device_dma_t *dma; /* Optional pointer for DMA support */
348 /* Context support */
349 int irq; /* Interrupt used by board */
350 int irqrid; /* Interrupt used by board */
351 #if defined(__DragonFly__) || defined(__FreeBSD__)
352 struct resource *irqr; /* Resource for interrupt used by board */
353 #elif defined(__NetBSD__)
354 struct pci_attach_args pa;
355 pci_intr_handle_t ih;
357 void *irqh; /* Handle from bus_setup_intr */
358 atomic_t context_flag; /* Context swapping flag */
359 struct callout timer; /* Timer for delaying ctx switch */
360 int last_context; /* Last current context */
361 #if defined(__DragonFly__) || __FreeBSD_version >= 400005
365 wait_queue_head_t vbl_queue; /* vbl wait channel */
366 atomic_t vbl_received;
367 #if 0 /* vbl signals are untested */
368 struct drm_vbl_sig_list vbl_sig_list;
369 DRM_SPINTYPE vbl_lock;
373 #if defined(__DragonFly__) || defined(__FreeBSD__)
374 struct sigio *buf_sigio; /* Processes waiting for SIGIO */
375 #elif defined(__NetBSD__)
380 struct drm_sysctl_info *sysctl;
382 #if __REALLY_HAVE_AGP
385 drm_sg_mem_t *sg; /* Scatter gather memory */
386 atomic_t *ctx_bitmap;
390 extern int DRM(flags);
392 /* Authentication (drm_auth.h) */
393 extern int DRM(add_magic)(drm_device_t *dev, drm_file_t *priv,
395 extern int DRM(remove_magic)(drm_device_t *dev, drm_magic_t magic);
397 /* Driver support (drm_drv.h) */
398 extern int DRM(version)( DRM_IOCTL_ARGS );
400 /* Memory management support (drm_memory.h) */
401 extern void DRM(mem_init)(void);
402 extern void DRM(mem_uninit)(void);
403 extern void *DRM(alloc)(size_t size, int area);
404 extern void *DRM(realloc)(void *oldpt, size_t oldsize, size_t size,
406 extern char *DRM(strdup)(const char *s, int area);
407 extern void DRM(strfree)(char *s, int area);
408 extern void DRM(free)(void *pt, size_t size, int area);
409 extern void *DRM(ioremap)(drm_device_t *dev, drm_local_map_t *map);
410 extern void *DRM(ioremap_nocache)(drm_device_t *dev, drm_local_map_t *map);
411 extern void DRM(ioremapfree)(drm_local_map_t *map);
413 #if __REALLY_HAVE_AGP
414 extern agp_memory *DRM(alloc_agp)(int pages, u32 type);
415 extern int DRM(free_agp)(agp_memory *handle, int pages);
416 extern int DRM(bind_agp)(agp_memory *handle, unsigned int start);
417 extern int DRM(unbind_agp)(agp_memory *handle);
420 extern int DRM(context_switch)(drm_device_t *dev, int old, int new);
421 extern int DRM(context_switch_complete)(drm_device_t *dev, int new);
423 #if __HAVE_CTX_BITMAP
424 extern int DRM(ctxbitmap_init)( drm_device_t *dev );
425 extern void DRM(ctxbitmap_cleanup)( drm_device_t *dev );
426 extern void DRM(ctxbitmap_free)( drm_device_t *dev, int ctx_handle );
427 extern int DRM(ctxbitmap_next)( drm_device_t *dev );
430 /* Locking IOCTL support (drm_lock.h) */
431 extern int DRM(lock_take)(__volatile__ unsigned int *lock,
432 unsigned int context);
433 extern int DRM(lock_transfer)(drm_device_t *dev,
434 __volatile__ unsigned int *lock,
435 unsigned int context);
436 extern int DRM(lock_free)(drm_device_t *dev,
437 __volatile__ unsigned int *lock,
438 unsigned int context);
440 /* Buffer management support (drm_bufs.h) */
441 extern int DRM(order)( unsigned long size );
444 /* DMA support (drm_dma.h) */
445 extern int DRM(dma_setup)(drm_device_t *dev);
446 extern void DRM(dma_takedown)(drm_device_t *dev);
447 extern void DRM(free_buffer)(drm_device_t *dev, drm_buf_t *buf);
448 extern void DRM(reclaim_buffers)(drm_device_t *dev, DRMFILE filp);
450 extern int DRM(irq_install)( drm_device_t *dev, int irq );
451 extern int DRM(irq_uninstall)( drm_device_t *dev );
452 extern void DRM(dma_service)( DRM_IRQ_ARGS );
453 extern void DRM(driver_irq_preinstall)( drm_device_t *dev );
454 extern void DRM(driver_irq_postinstall)( drm_device_t *dev );
455 extern void DRM(driver_irq_uninstall)( drm_device_t *dev );
456 #if __HAVE_DMA_IRQ_BH
457 extern void DRM(dma_immediate_bh)( DRM_TASKQUEUE_ARGS );
461 /* Buffer list support (drm_lists.h) */
462 #if __HAVE_DMA_WAITLIST
463 extern int DRM(waitlist_create)(drm_waitlist_t *bl, int count);
464 extern int DRM(waitlist_destroy)(drm_waitlist_t *bl);
465 extern int DRM(waitlist_put)(drm_waitlist_t *bl, drm_buf_t *buf);
466 extern drm_buf_t *DRM(waitlist_get)(drm_waitlist_t *bl);
468 #endif /* __HAVE_DMA */
470 extern int DRM(vblank_wait)(drm_device_t *dev, unsigned int *vbl_seq);
471 extern void DRM(vbl_send_signals)( drm_device_t *dev );
474 #if __REALLY_HAVE_AGP
475 /* AGP/GART support (drm_agpsupport.h) */
476 extern drm_agp_head_t *DRM(agp_init)(void);
477 extern void DRM(agp_uninit)(void);
478 extern void DRM(agp_do_release)(void);
479 extern agp_memory *DRM(agp_allocate_memory)(size_t pages, u32 type);
480 extern int DRM(agp_free_memory)(agp_memory *handle);
481 extern int DRM(agp_bind_memory)(agp_memory *handle, off_t start);
482 extern int DRM(agp_unbind_memory)(agp_memory *handle);
486 /* Scatter Gather Support (drm_scatter.h) */
487 extern void DRM(sg_cleanup)(drm_sg_mem_t *entry);
491 /* ATI PCIGART support (ati_pcigart.h) */
492 extern int DRM(ati_pcigart_init)(drm_device_t *dev,
494 dma_addr_t *bus_addr);
495 extern int DRM(ati_pcigart_cleanup)(drm_device_t *dev,
497 dma_addr_t bus_addr);
500 /* Locking IOCTL support (drm_drv.h) */
501 extern int DRM(lock)(DRM_IOCTL_ARGS);
502 extern int DRM(unlock)(DRM_IOCTL_ARGS);
504 /* Misc. IOCTL support (drm_ioctl.h) */
505 extern int DRM(irq_busid)(DRM_IOCTL_ARGS);
506 extern int DRM(getunique)(DRM_IOCTL_ARGS);
507 extern int DRM(setunique)(DRM_IOCTL_ARGS);
508 extern int DRM(getmap)(DRM_IOCTL_ARGS);
509 extern int DRM(getclient)(DRM_IOCTL_ARGS);
510 extern int DRM(getstats)(DRM_IOCTL_ARGS);
511 extern int DRM(noop)(DRM_IOCTL_ARGS);
513 /* Context IOCTL support (drm_context.h) */
514 extern int DRM(resctx)(DRM_IOCTL_ARGS);
515 extern int DRM(addctx)(DRM_IOCTL_ARGS);
516 extern int DRM(modctx)(DRM_IOCTL_ARGS);
517 extern int DRM(getctx)(DRM_IOCTL_ARGS);
518 extern int DRM(switchctx)(DRM_IOCTL_ARGS);
519 extern int DRM(newctx)(DRM_IOCTL_ARGS);
520 extern int DRM(rmctx)(DRM_IOCTL_ARGS);
521 extern int DRM(setsareactx)(DRM_IOCTL_ARGS);
522 extern int DRM(getsareactx)(DRM_IOCTL_ARGS);
524 /* Drawable IOCTL support (drm_drawable.h) */
525 extern int DRM(adddraw)(DRM_IOCTL_ARGS);
526 extern int DRM(rmdraw)(DRM_IOCTL_ARGS);
528 /* Authentication IOCTL support (drm_auth.h) */
529 extern int DRM(getmagic)(DRM_IOCTL_ARGS);
530 extern int DRM(authmagic)(DRM_IOCTL_ARGS);
532 /* Buffer management support (drm_bufs.h) */
533 extern int DRM(addmap)(DRM_IOCTL_ARGS);
534 extern int DRM(rmmap)(DRM_IOCTL_ARGS);
536 extern int DRM(addbufs)(DRM_IOCTL_ARGS);
537 extern int DRM(infobufs)(DRM_IOCTL_ARGS);
538 extern int DRM(markbufs)(DRM_IOCTL_ARGS);
539 extern int DRM(freebufs)(DRM_IOCTL_ARGS);
540 extern int DRM(mapbufs)(DRM_IOCTL_ARGS);
543 /* DMA support (drm_dma.h) */
545 extern int DRM(control)(DRM_IOCTL_ARGS);
548 extern int DRM(wait_vblank)(DRM_IOCTL_ARGS);
551 /* AGP/GART support (drm_agpsupport.h) */
552 #if __REALLY_HAVE_AGP
553 extern int DRM(agp_acquire)(DRM_IOCTL_ARGS);
554 extern int DRM(agp_release)(DRM_IOCTL_ARGS);
555 extern int DRM(agp_enable)(DRM_IOCTL_ARGS);
556 extern int DRM(agp_info)(DRM_IOCTL_ARGS);
557 extern int DRM(agp_alloc)(DRM_IOCTL_ARGS);
558 extern int DRM(agp_free)(DRM_IOCTL_ARGS);
559 extern int DRM(agp_unbind)(DRM_IOCTL_ARGS);
560 extern int DRM(agp_bind)(DRM_IOCTL_ARGS);
563 /* Scatter Gather Support (drm_scatter.h) */
565 extern int DRM(sg_alloc)(DRM_IOCTL_ARGS);
566 extern int DRM(sg_free)(DRM_IOCTL_ARGS);
570 #endif /* __KERNEL__ */
571 #endif /* _DRM_P_H_ */