sys/dev/drm/mga/mga_drm.h

   1 /* mga_drm.h -- Public header for the Matrox g200/g400 driver -*- linux-c -*-
   2  * Created: Tue Jan 25 01:50:01 1999 by jhartmann@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  *    Jeff Hartmann <jhartmann@valinux.com>
  29  *    Keith Whitwell <keith@tungstengraphics.com>
  30  *
  31  * Rewritten by:
  32  *    Gareth Hughes <gareth@valinux.com>
  33  *
  34  * $FreeBSD: src/sys/dev/drm/mga_drm.h,v 1.3.2.1 2003/04/26 07:05:29 anholt Exp $
  35  * $DragonFly: src/sys/dev/drm/mga/Attic/mga_drm.h,v 1.2 2003/06/17 04:28:24 dillon Exp $
  36  */
  37
  38 #ifndef __MGA_DRM_H__
  39 #define __MGA_DRM_H__
  40
  41 /* WARNING: If you change any of these defines, make sure to change the
  42  * defines in the Xserver file (mga_sarea.h)
  43  */
  44
  45 #ifndef __MGA_SAREA_DEFINES__
  46 #define __MGA_SAREA_DEFINES__
  47
  48 /* WARP pipe flags
  49  */
  50 #define MGA_F                   0x1             /* fog */
  51 #define MGA_A                   0x2             /* alpha */
  52 #define MGA_S                   0x4             /* specular */
  53 #define MGA_T2                  0x8             /* multitexture */
  54
  55 #define MGA_WARP_TGZ            0
  56 #define MGA_WARP_TGZF           (MGA_F)
  57 #define MGA_WARP_TGZA           (MGA_A)
  58 #define MGA_WARP_TGZAF          (MGA_F|MGA_A)
  59 #define MGA_WARP_TGZS           (MGA_S)
  60 #define MGA_WARP_TGZSF          (MGA_S|MGA_F)
  61 #define MGA_WARP_TGZSA          (MGA_S|MGA_A)
  62 #define MGA_WARP_TGZSAF         (MGA_S|MGA_F|MGA_A)
  63 #define MGA_WARP_T2GZ           (MGA_T2)
  64 #define MGA_WARP_T2GZF          (MGA_T2|MGA_F)
  65 #define MGA_WARP_T2GZA          (MGA_T2|MGA_A)
  66 #define MGA_WARP_T2GZAF         (MGA_T2|MGA_A|MGA_F)
  67 #define MGA_WARP_T2GZS          (MGA_T2|MGA_S)
  68 #define MGA_WARP_T2GZSF         (MGA_T2|MGA_S|MGA_F)
  69 #define MGA_WARP_T2GZSA         (MGA_T2|MGA_S|MGA_A)
  70 #define MGA_WARP_T2GZSAF        (MGA_T2|MGA_S|MGA_F|MGA_A)
  71
  72 #define MGA_MAX_G200_PIPES      8               /* no multitex */
  73 #define MGA_MAX_G400_PIPES      16
  74 #define MGA_MAX_WARP_PIPES      MGA_MAX_G400_PIPES
  75 #define MGA_WARP_UCODE_SIZE     32768           /* in bytes */
  76
  77 #define MGA_CARD_TYPE_G200      1
  78 #define MGA_CARD_TYPE_G400      2
  79
  80
  81 #define MGA_FRONT               0x1
  82 #define MGA_BACK                0x2
  83 #define MGA_DEPTH               0x4
  84
  85 /* What needs to be changed for the current vertex dma buffer?
  86  */
  87 #define MGA_UPLOAD_CONTEXT      0x1
  88 #define MGA_UPLOAD_TEX0         0x2
  89 #define MGA_UPLOAD_TEX1         0x4
  90 #define MGA_UPLOAD_PIPE         0x8
  91 #define MGA_UPLOAD_TEX0IMAGE    0x10 /* handled client-side */
  92 #define MGA_UPLOAD_TEX1IMAGE    0x20 /* handled client-side */
  93 #define MGA_UPLOAD_2D           0x40
  94 #define MGA_WAIT_AGE            0x80 /* handled client-side */
  95 #define MGA_UPLOAD_CLIPRECTS    0x100 /* handled client-side */
  96 #if 0
  97 #define MGA_DMA_FLUSH           0x200 /* set when someone gets the lock
  98                                          quiescent */
  99 #endif
 100
 101 /* 32 buffers of 64k each, total 2 meg.
 102  */
 103 #define MGA_BUFFER_SIZE         (1 << 16)
 104 #define MGA_NUM_BUFFERS         128
 105
 106 /* Keep these small for testing.
 107  */
 108 #define MGA_NR_SAREA_CLIPRECTS  8
 109
 110 /* 2 heaps (1 for card, 1 for agp), each divided into upto 128
 111  * regions, subject to a minimum region size of (1<<16) == 64k.
 112  *
 113  * Clients may subdivide regions internally, but when sharing between
 114  * clients, the region size is the minimum granularity.
 115  */
 116
 117 #define MGA_CARD_HEAP                   0
 118 #define MGA_AGP_HEAP                    1
 119 #define MGA_NR_TEX_HEAPS                2
 120 #define MGA_NR_TEX_REGIONS              16
 121 #define MGA_LOG_MIN_TEX_REGION_SIZE     16
 122
 123 #endif /* __MGA_SAREA_DEFINES__ */
 124
 125
 126 /* Setup registers for 3D context
 127  */
 128 typedef struct {
 129         unsigned int dstorg;
 130         unsigned int maccess;
 131         unsigned int plnwt;
 132         unsigned int dwgctl;
 133         unsigned int alphactrl;
 134         unsigned int fogcolor;
 135         unsigned int wflag;
 136         unsigned int tdualstage0;
 137         unsigned int tdualstage1;
 138         unsigned int fcol;
 139         unsigned int stencil;
 140         unsigned int stencilctl;
 141 } drm_mga_context_regs_t;
 142
 143 /* Setup registers for 2D, X server
 144  */
 145 typedef struct {
 146         unsigned int pitch;
 147 } drm_mga_server_regs_t;
 148
 149 /* Setup registers for each texture unit
 150  */
 151 typedef struct {
 152         unsigned int texctl;
 153         unsigned int texctl2;
 154         unsigned int texfilter;
 155         unsigned int texbordercol;
 156         unsigned int texorg;
 157         unsigned int texwidth;
 158         unsigned int texheight;
 159         unsigned int texorg1;
 160         unsigned int texorg2;
 161         unsigned int texorg3;
 162         unsigned int texorg4;
 163 } drm_mga_texture_regs_t;
 164
 165 /* General aging mechanism
 166  */
 167 typedef struct {
 168         unsigned int head;              /* Position of head pointer          */
 169         unsigned int wrap;              /* Primary DMA wrap count            */
 170 } drm_mga_age_t;
 171
 172 typedef struct _drm_mga_sarea {
 173         /* The channel for communication of state information to the kernel
 174          * on firing a vertex dma buffer.
 175          */
 176         drm_mga_context_regs_t context_state;
 177         drm_mga_server_regs_t server_state;
 178         drm_mga_texture_regs_t tex_state[2];
 179         unsigned int warp_pipe;
 180         unsigned int dirty;
 181         unsigned int vertsize;
 182
 183         /* The current cliprects, or a subset thereof.
 184          */
 185         drm_clip_rect_t boxes[MGA_NR_SAREA_CLIPRECTS];
 186         unsigned int nbox;
 187
 188         /* Information about the most recently used 3d drawable.  The
 189          * client fills in the req_* fields, the server fills in the
 190          * exported_ fields and puts the cliprects into boxes, above.
 191          *
 192          * The client clears the exported_drawable field before
 193          * clobbering the boxes data.
 194          */
 195         unsigned int req_drawable;       /* the X drawable id */
 196         unsigned int req_draw_buffer;    /* MGA_FRONT or MGA_BACK */
 197
 198         unsigned int exported_drawable;
 199         unsigned int exported_index;
 200         unsigned int exported_stamp;
 201         unsigned int exported_buffers;
 202         unsigned int exported_nfront;
 203         unsigned int exported_nback;
 204         int exported_back_x, exported_front_x, exported_w;
 205         int exported_back_y, exported_front_y, exported_h;
 206         drm_clip_rect_t exported_boxes[MGA_NR_SAREA_CLIPRECTS];
 207
 208         /* Counters for aging textures and for client-side throttling.
 209          */
 210         unsigned int status[4];
 211         unsigned int last_wrap;
 212
 213         drm_mga_age_t last_frame;
 214         unsigned int last_enqueue;      /* last time a buffer was enqueued */
 215         unsigned int last_dispatch;     /* age of the most recently dispatched buffer */
 216         unsigned int last_quiescent;     /*  */
 217
 218         /* LRU lists for texture memory in agp space and on the card.
 219          */
 220         drm_tex_region_t texList[MGA_NR_TEX_HEAPS][MGA_NR_TEX_REGIONS+1];
 221         unsigned int texAge[MGA_NR_TEX_HEAPS];
 222
 223         /* Mechanism to validate card state.
 224          */
 225         int ctxOwner;
 226 } drm_mga_sarea_t;
 227
 228
 229 /* WARNING: If you change any of these defines, make sure to change the
 230  * defines in the Xserver file (xf86drmMga.h)
 231  */
 232
 233 /* MGA specific ioctls
 234  * The device specific ioctl range is 0x40 to 0x79.
 235  */
 236 #define DRM_IOCTL_MGA_INIT              DRM_IOW( 0x40, drm_mga_init_t)
 237 #define DRM_IOCTL_MGA_FLUSH             DRM_IOW( 0x41, drm_lock_t)
 238 #define DRM_IOCTL_MGA_RESET             DRM_IO(  0x42)
 239 #define DRM_IOCTL_MGA_SWAP              DRM_IO(  0x43)
 240 #define DRM_IOCTL_MGA_CLEAR             DRM_IOW( 0x44, drm_mga_clear_t)
 241 #define DRM_IOCTL_MGA_VERTEX            DRM_IOW( 0x45, drm_mga_vertex_t)
 242 #define DRM_IOCTL_MGA_INDICES           DRM_IOW( 0x46, drm_mga_indices_t)
 243 #define DRM_IOCTL_MGA_ILOAD             DRM_IOW( 0x47, drm_mga_iload_t)
 244 #define DRM_IOCTL_MGA_BLIT              DRM_IOW( 0x48, drm_mga_blit_t)
 245 #define DRM_IOCTL_MGA_GETPARAM          DRM_IOWR(0x49, drm_mga_getparam_t)
 246
 247 typedef struct _drm_mga_warp_index {
 248         int installed;
 249         unsigned long phys_addr;
 250         int size;
 251 } drm_mga_warp_index_t;
 252
 253 typedef struct drm_mga_init {
 254         enum {
 255                 MGA_INIT_DMA    = 0x01,
 256                 MGA_CLEANUP_DMA = 0x02
 257         } func;
 258
 259         unsigned long sarea_priv_offset;
 260
 261         int chipset;
 262         int sgram;
 263
 264         unsigned int maccess;
 265
 266         unsigned int fb_cpp;
 267         unsigned int front_offset, front_pitch;
 268         unsigned int back_offset, back_pitch;
 269
 270         unsigned int depth_cpp;
 271         unsigned int depth_offset, depth_pitch;
 272
 273         unsigned int texture_offset[MGA_NR_TEX_HEAPS];
 274         unsigned int texture_size[MGA_NR_TEX_HEAPS];
 275
 276         unsigned long fb_offset;
 277         unsigned long mmio_offset;
 278         unsigned long status_offset;
 279         unsigned long warp_offset;
 280         unsigned long primary_offset;
 281         unsigned long buffers_offset;
 282 } drm_mga_init_t;
 283
 284 typedef struct drm_mga_fullscreen {
 285         enum {
 286                 MGA_INIT_FULLSCREEN    = 0x01,
 287                 MGA_CLEANUP_FULLSCREEN = 0x02
 288         } func;
 289 } drm_mga_fullscreen_t;
 290
 291 typedef struct drm_mga_clear {
 292         unsigned int flags;
 293         unsigned int clear_color;
 294         unsigned int clear_depth;
 295         unsigned int color_mask;
 296         unsigned int depth_mask;
 297 } drm_mga_clear_t;
 298
 299 typedef struct drm_mga_vertex {
 300         int idx;                        /* buffer to queue */
 301         int used;                       /* bytes in use */
 302         int discard;                    /* client finished with buffer?  */
 303 } drm_mga_vertex_t;
 304
 305 typedef struct drm_mga_indices {
 306         int idx;                        /* buffer to queue */
 307         unsigned int start;
 308         unsigned int end;
 309         int discard;                    /* client finished with buffer?  */
 310 } drm_mga_indices_t;
 311
 312 typedef struct drm_mga_iload {
 313         int idx;
 314         unsigned int dstorg;
 315         unsigned int length;
 316 } drm_mga_iload_t;
 317
 318 typedef struct _drm_mga_blit {
 319         unsigned int planemask;
 320         unsigned int srcorg;
 321         unsigned int dstorg;
 322         int src_pitch, dst_pitch;
 323         int delta_sx, delta_sy;
 324         int delta_dx, delta_dy;
 325         int height, ydir;               /* flip image vertically */
 326         int source_pitch, dest_pitch;
 327 } drm_mga_blit_t;
 328
 329 /* 3.1: An ioctl to get parameters that aren't available to the 3d
 330  * client any other way.
 331  */
 332 #define MGA_PARAM_IRQ_NR            1
 333
 334 typedef struct drm_mga_getparam {
 335         int param;
 336         int *value;
 337 } drm_mga_getparam_t;
 338
 339 #endif