include/drm/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
  35 #ifndef __MGA_DRM_H__
  36 #define __MGA_DRM_H__
  37
  38 #include "drm.h"
  39
  40 /* WARNING: If you change any of these defines, make sure to change the
  41  * defines in the Xserver file (mga_sarea.h)
  42  */
  43
  44 #ifndef __MGA_SAREA_DEFINES__
  45 #define __MGA_SAREA_DEFINES__
  46
  47 /* WARP pipe flags
  48  */
  49 #define MGA_F                   0x1     /* fog */
  50 #define MGA_A                   0x2     /* alpha */
  51 #define MGA_S                   0x4     /* specular */
  52 #define MGA_T2                  0x8     /* multitexture */
  53
  54 #define MGA_WARP_TGZ            0
  55 #define MGA_WARP_TGZF           (MGA_F)
  56 #define MGA_WARP_TGZA           (MGA_A)
  57 #define MGA_WARP_TGZAF          (MGA_F|MGA_A)
  58 #define MGA_WARP_TGZS           (MGA_S)
  59 #define MGA_WARP_TGZSF          (MGA_S|MGA_F)
  60 #define MGA_WARP_TGZSA          (MGA_S|MGA_A)
  61 #define MGA_WARP_TGZSAF         (MGA_S|MGA_F|MGA_A)
  62 #define MGA_WARP_T2GZ           (MGA_T2)
  63 #define MGA_WARP_T2GZF          (MGA_T2|MGA_F)
  64 #define MGA_WARP_T2GZA          (MGA_T2|MGA_A)
  65 #define MGA_WARP_T2GZAF         (MGA_T2|MGA_A|MGA_F)
  66 #define MGA_WARP_T2GZS          (MGA_T2|MGA_S)
  67 #define MGA_WARP_T2GZSF         (MGA_T2|MGA_S|MGA_F)
  68 #define MGA_WARP_T2GZSA         (MGA_T2|MGA_S|MGA_A)
  69 #define MGA_WARP_T2GZSAF        (MGA_T2|MGA_S|MGA_F|MGA_A)
  70
  71 #define MGA_MAX_G200_PIPES      8       /* no multitex */
  72 #define MGA_MAX_G400_PIPES      16
  73 #define MGA_MAX_WARP_PIPES      MGA_MAX_G400_PIPES
  74 #define MGA_WARP_UCODE_SIZE     32768   /* in bytes */
  75
  76 #define MGA_CARD_TYPE_G200      1
  77 #define MGA_CARD_TYPE_G400      2
  78 #define MGA_CARD_TYPE_G450      3       /* not currently used */
  79 #define MGA_CARD_TYPE_G550      4
  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 up to 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 #define  DRM_MGA_IDLE_RETRY          2048
 124
 125 #endif                          /* __MGA_SAREA_DEFINES__ */
 126
 127 /* Setup registers for 3D context
 128  */
 129 typedef struct {
 130         unsigned int dstorg;
 131         unsigned int maccess;
 132         unsigned int plnwt;
 133         unsigned int dwgctl;
 134         unsigned int alphactrl;
 135         unsigned int fogcolor;
 136         unsigned int wflag;
 137         unsigned int tdualstage0;
 138         unsigned int tdualstage1;
 139         unsigned int fcol;
 140         unsigned int stencil;
 141         unsigned int stencilctl;
 142 } drm_mga_context_regs_t;
 143
 144 /* Setup registers for 2D, X server
 145  */
 146 typedef struct {
 147         unsigned int pitch;
 148 } drm_mga_server_regs_t;
 149
 150 /* Setup registers for each texture unit
 151  */
 152 typedef struct {
 153         unsigned int texctl;
 154         unsigned int texctl2;
 155         unsigned int texfilter;
 156         unsigned int texbordercol;
 157         unsigned int texorg;
 158         unsigned int texwidth;
 159         unsigned int texheight;
 160         unsigned int texorg1;
 161         unsigned int texorg2;
 162         unsigned int texorg3;
 163         unsigned int texorg4;
 164 } drm_mga_texture_regs_t;
 165
 166 /* General aging mechanism
 167  */
 168 typedef struct {
 169         unsigned int head;      /* Position of head pointer          */
 170         unsigned int wrap;      /* Primary DMA wrap count            */
 171 } drm_mga_age_t;
 172
 173 typedef struct _drm_mga_sarea {
 174         /* The channel for communication of state information to the kernel
 175          * on firing a vertex dma buffer.
 176          */
 177         drm_mga_context_regs_t context_state;
 178         drm_mga_server_regs_t server_state;
 179         drm_mga_texture_regs_t tex_state[2];
 180         unsigned int warp_pipe;
 181         unsigned int dirty;
 182         unsigned int vertsize;
 183
 184         /* The current cliprects, or a subset thereof.
 185          */
 186         struct drm_clip_rect boxes[MGA_NR_SAREA_CLIPRECTS];
 187         unsigned int nbox;
 188
 189         /* Information about the most recently used 3d drawable.  The
 190          * client fills in the req_* fields, the server fills in the
 191          * exported_ fields and puts the cliprects into boxes, above.
 192          *
 193          * The client clears the exported_drawable field before
 194          * clobbering the boxes data.
 195          */
 196         unsigned int req_drawable;      /* the X drawable id */
 197         unsigned int req_draw_buffer;   /* MGA_FRONT or MGA_BACK */
 198
 199         unsigned int exported_drawable;
 200         unsigned int exported_index;
 201         unsigned int exported_stamp;
 202         unsigned int exported_buffers;
 203         unsigned int exported_nfront;
 204         unsigned int exported_nback;
 205         int exported_back_x, exported_front_x, exported_w;
 206         int exported_back_y, exported_front_y, exported_h;
 207         struct drm_clip_rect exported_boxes[MGA_NR_SAREA_CLIPRECTS];
 208
 209         /* Counters for aging textures and for client-side throttling.
 210          */
 211         unsigned int status[4];
 212         unsigned int last_wrap;
 213
 214         drm_mga_age_t last_frame;
 215         unsigned int last_enqueue;      /* last time a buffer was enqueued */
 216         unsigned int last_dispatch;     /* age of the most recently dispatched buffer */
 217         unsigned int last_quiescent;    /*  */
 218
 219         /* LRU lists for texture memory in agp space and on the card.
 220          */
 221         struct drm_tex_region texList[MGA_NR_TEX_HEAPS][MGA_NR_TEX_REGIONS + 1];
 222         unsigned int texAge[MGA_NR_TEX_HEAPS];
 223
 224         /* Mechanism to validate card state.
 225          */
 226         int ctxOwner;
 227 } drm_mga_sarea_t;
 228
 229 /* MGA specific ioctls
 230  * The device specific ioctl range is 0x40 to 0x79.
 231  */
 232 #define DRM_MGA_INIT     0x00
 233 #define DRM_MGA_FLUSH    0x01
 234 #define DRM_MGA_RESET    0x02
 235 #define DRM_MGA_SWAP     0x03
 236 #define DRM_MGA_CLEAR    0x04
 237 #define DRM_MGA_VERTEX   0x05
 238 #define DRM_MGA_INDICES  0x06
 239 #define DRM_MGA_ILOAD    0x07
 240 #define DRM_MGA_BLIT     0x08
 241 #define DRM_MGA_GETPARAM 0x09
 242
 243 /* 3.2:
 244  * ioctls for operating on fences.
 245  */
 246 #define DRM_MGA_SET_FENCE      0x0a
 247 #define DRM_MGA_WAIT_FENCE     0x0b
 248 #define DRM_MGA_DMA_BOOTSTRAP  0x0c
 249
 250 #define DRM_IOCTL_MGA_INIT     DRM_IOW( DRM_COMMAND_BASE + DRM_MGA_INIT, drm_mga_init_t)
 251 #define DRM_IOCTL_MGA_FLUSH    DRM_IOW( DRM_COMMAND_BASE + DRM_MGA_FLUSH, struct drm_lock)
 252 #define DRM_IOCTL_MGA_RESET    DRM_IO(  DRM_COMMAND_BASE + DRM_MGA_RESET)
 253 #define DRM_IOCTL_MGA_SWAP     DRM_IO(  DRM_COMMAND_BASE + DRM_MGA_SWAP)
 254 #define DRM_IOCTL_MGA_CLEAR    DRM_IOW( DRM_COMMAND_BASE + DRM_MGA_CLEAR, drm_mga_clear_t)
 255 #define DRM_IOCTL_MGA_VERTEX   DRM_IOW( DRM_COMMAND_BASE + DRM_MGA_VERTEX, drm_mga_vertex_t)
 256 #define DRM_IOCTL_MGA_INDICES  DRM_IOW( DRM_COMMAND_BASE + DRM_MGA_INDICES, drm_mga_indices_t)
 257 #define DRM_IOCTL_MGA_ILOAD    DRM_IOW( DRM_COMMAND_BASE + DRM_MGA_ILOAD, drm_mga_iload_t)
 258 #define DRM_IOCTL_MGA_BLIT     DRM_IOW( DRM_COMMAND_BASE + DRM_MGA_BLIT, drm_mga_blit_t)
 259 #define DRM_IOCTL_MGA_GETPARAM DRM_IOWR(DRM_COMMAND_BASE + DRM_MGA_GETPARAM, drm_mga_getparam_t)
 260 #define DRM_IOCTL_MGA_SET_FENCE     DRM_IOW( DRM_COMMAND_BASE + DRM_MGA_SET_FENCE, __u32)
 261 #define DRM_IOCTL_MGA_WAIT_FENCE    DRM_IOWR(DRM_COMMAND_BASE + DRM_MGA_WAIT_FENCE, __u32)
 262 #define DRM_IOCTL_MGA_DMA_BOOTSTRAP DRM_IOWR(DRM_COMMAND_BASE + DRM_MGA_DMA_BOOTSTRAP, drm_mga_dma_bootstrap_t)
 263
 264 typedef struct _drm_mga_warp_index {
 265         int installed;
 266         unsigned long phys_addr;
 267         int size;
 268 } drm_mga_warp_index_t;
 269
 270 typedef struct drm_mga_init {
 271         enum {
 272                 MGA_INIT_DMA = 0x01,
 273                 MGA_CLEANUP_DMA = 0x02
 274         } func;
 275
 276         unsigned long sarea_priv_offset;
 277
 278         int chipset;
 279         int sgram;
 280
 281         unsigned int maccess;
 282
 283         unsigned int fb_cpp;
 284         unsigned int front_offset, front_pitch;
 285         unsigned int back_offset, back_pitch;
 286
 287         unsigned int depth_cpp;
 288         unsigned int depth_offset, depth_pitch;
 289
 290         unsigned int texture_offset[MGA_NR_TEX_HEAPS];
 291         unsigned int texture_size[MGA_NR_TEX_HEAPS];
 292
 293         unsigned long fb_offset;
 294         unsigned long mmio_offset;
 295         unsigned long status_offset;
 296         unsigned long warp_offset;
 297         unsigned long primary_offset;
 298         unsigned long buffers_offset;
 299 } drm_mga_init_t;
 300
 301 typedef struct drm_mga_dma_bootstrap {
 302         /**
 303          * \name AGP texture region
 304          *
 305          * On return from the DRM_MGA_DMA_BOOTSTRAP ioctl, these fields will
 306          * be filled in with the actual AGP texture settings.
 307          *
 308          * \warning
 309          * If these fields are non-zero, but dma_mga_dma_bootstrap::agp_mode
 310          * is zero, it means that PCI memory (most likely through the use of
 311          * an IOMMU) is being used for "AGP" textures.
 312          */
 313         /*@{ */
 314         unsigned long texture_handle; /**< Handle used to map AGP textures. */
 315         __u32 texture_size;           /**< Size of the AGP texture region. */
 316         /*@} */
 317
 318         /**
 319          * Requested size of the primary DMA region.
 320          *
 321          * On return from the DRM_MGA_DMA_BOOTSTRAP ioctl, this field will be
 322          * filled in with the actual AGP mode.  If AGP was not available
 323          */
 324         __u32 primary_size;
 325
 326         /**
 327          * Requested number of secondary DMA buffers.
 328          *
 329          * On return from the DRM_MGA_DMA_BOOTSTRAP ioctl, this field will be
 330          * filled in with the actual number of secondary DMA buffers
 331          * allocated.  Particularly when PCI DMA is used, this may be
 332          * (subtantially) less than the number requested.
 333          */
 334         __u32 secondary_bin_count;
 335
 336         /**
 337          * Requested size of each secondary DMA buffer.
 338          *
 339          * While the kernel \b is free to reduce
 340          * dma_mga_dma_bootstrap::secondary_bin_count, it is \b not allowed
 341          * to reduce dma_mga_dma_bootstrap::secondary_bin_size.
 342          */
 343         __u32 secondary_bin_size;
 344
 345         /**
 346          * Bit-wise mask of AGPSTAT2_* values.  Currently only \c AGPSTAT2_1X,
 347          * \c AGPSTAT2_2X, and \c AGPSTAT2_4X are supported.  If this value is
 348          * zero, it means that PCI DMA should be used, even if AGP is
 349          * possible.
 350          *
 351          * On return from the DRM_MGA_DMA_BOOTSTRAP ioctl, this field will be
 352          * filled in with the actual AGP mode.  If AGP was not available
 353          * (i.e., PCI DMA was used), this value will be zero.
 354          */
 355         __u32 agp_mode;
 356
 357         /**
 358          * Desired AGP GART size, measured in megabytes.
 359          */
 360         __u8 agp_size;
 361 } drm_mga_dma_bootstrap_t;
 362
 363 typedef struct drm_mga_clear {
 364         unsigned int flags;
 365         unsigned int clear_color;
 366         unsigned int clear_depth;
 367         unsigned int color_mask;
 368         unsigned int depth_mask;
 369 } drm_mga_clear_t;
 370
 371 typedef struct drm_mga_vertex {
 372         int idx;                /* buffer to queue */
 373         int used;               /* bytes in use */
 374         int discard;            /* client finished with buffer?  */
 375 } drm_mga_vertex_t;
 376
 377 typedef struct drm_mga_indices {
 378         int idx;                /* buffer to queue */
 379         unsigned int start;
 380         unsigned int end;
 381         int discard;            /* client finished with buffer?  */
 382 } drm_mga_indices_t;
 383
 384 typedef struct drm_mga_iload {
 385         int idx;
 386         unsigned int dstorg;
 387         unsigned int length;
 388 } drm_mga_iload_t;
 389
 390 typedef struct _drm_mga_blit {
 391         unsigned int planemask;
 392         unsigned int srcorg;
 393         unsigned int dstorg;
 394         int src_pitch, dst_pitch;
 395         int delta_sx, delta_sy;
 396         int delta_dx, delta_dy;
 397         int height, ydir;       /* flip image vertically */
 398         int source_pitch, dest_pitch;
 399 } drm_mga_blit_t;
 400
 401 /* 3.1: An ioctl to get parameters that aren't available to the 3d
 402  * client any other way.
 403  */
 404 #define MGA_PARAM_IRQ_NR            1
 405
 406 /* 3.2: Query the actual card type.  The DDX only distinguishes between
 407  * G200 chips and non-G200 chips, which it calls G400.  It turns out that
 408  * there are some very sublte differences between the G4x0 chips and the G550
 409  * chips.  Using this parameter query, a client-side driver can detect the
 410  * difference between a G4x0 and a G550.
 411  */
 412 #define MGA_PARAM_CARD_TYPE         2
 413
 414 typedef struct drm_mga_getparam {
 415         int param;
 416         void __user *value;
 417 } drm_mga_getparam_t;
 418
 419 #endif