/* ********************************************************** * Copyright (C) 1998-2001 VMware, Inc. * All Rights Reserved * $Id$ * **********************************************************/ /* * svga_reg.h -- * * SVGA hardware definitions */ /* $XFree86$ */ #ifndef _SVGA_REG_H_ #define _SVGA_REG_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_MONITOR #include "includeCheck.h" #include "svga_limits.h" /* * Memory and port addresses and fundamental constants */ /* * Note-- MAX_WIDTH and MAX_HEIGHT are largely ignored by the code. This * isn't such a bad thing for forward compatibility. --Jeremy. */ #define SVGA_MAX_WIDTH 2360 #define SVGA_MAX_HEIGHT 1770 #define SVGA_MAX_BITS_PER_PIXEL 32 #define PAGE_SHIFT 12 #define SVGA_FB_MAX_SIZE \ ((((SVGA_MAX_WIDTH * SVGA_MAX_HEIGHT * \ SVGA_MAX_BITS_PER_PIXEL / 8) >> PAGE_SHIFT) + 1) << PAGE_SHIFT) #if SVGA_FB_MAX_SIZE > SVGA_VRAM_SIZE #error "Bad SVGA maximum sizes" #endif #define SVGA_MAX_PSEUDOCOLOR_DEPTH 8 #define SVGA_MAX_PSEUDOCOLORS (1 << SVGA_MAX_PSEUDOCOLOR_DEPTH) #define SVGA_MAGIC 0x900000 #define SVGA_MAKE_ID(ver) (SVGA_MAGIC << 8 | (ver)) /* Version 2 let the address of the frame buffer be unsigned on Win32 */ #define SVGA_VERSION_2 2 #define SVGA_ID_2 SVGA_MAKE_ID(SVGA_VERSION_2) /* Version 1 has new registers starting with SVGA_REG_CAPABILITIES so PALETTE_BASE has moved */ #define SVGA_VERSION_1 1 #define SVGA_ID_1 SVGA_MAKE_ID(SVGA_VERSION_1) /* Version 0 is the initial version */ #define SVGA_VERSION_0 0 #define SVGA_ID_0 SVGA_MAKE_ID(SVGA_VERSION_0) /* Invalid SVGA_ID_ */ #define SVGA_ID_INVALID 0xFFFFFFFF /* More backwards compatibility, old location of color map: */ #define SVGA_OLD_PALETTE_BASE 17 /* Base and Offset gets us headed the right way for PCI Base Addr Registers */ #define SVGA_LEGACY_BASE_PORT 0x4560 #define SVGA_INDEX_PORT 0x0 #define SVGA_VALUE_PORT 0x1 #define SVGA_BIOS_PORT 0x2 #define SVGA_NUM_PORTS 0x3 /* This port is deprecated, but retained because of old drivers. */ #define SVGA_LEGACY_ACCEL_PORT 0x3 /* Legal values for the SVGA_REG_CURSOR_ON register in cursor bypass mode */ #define SVGA_CURSOR_ON_HIDE 0x0 /* Must be 0 to maintain backward compatibility */ #define SVGA_CURSOR_ON_SHOW 0x1 /* Must be 1 to maintain backward compatibility */ #define SVGA_CURSOR_ON_REMOVE_FROM_FB 0x2 /* Remove the cursor from the framebuffer because we need to see what's under it */ #define SVGA_CURSOR_ON_RESTORE_TO_FB 0x3 /* Put the cursor back in the framebuffer so the user can see it */ /* * Registers */ enum { SVGA_REG_ID = 0, SVGA_REG_ENABLE = 1, SVGA_REG_WIDTH = 2, SVGA_REG_HEIGHT = 3, SVGA_REG_MAX_WIDTH = 4, SVGA_REG_MAX_HEIGHT = 5, SVGA_REG_DEPTH = 6, SVGA_REG_BITS_PER_PIXEL = 7, /* Current bpp in the guest */ SVGA_REG_PSEUDOCOLOR = 8, SVGA_REG_RED_MASK = 9, SVGA_REG_GREEN_MASK = 10, SVGA_REG_BLUE_MASK = 11, SVGA_REG_BYTES_PER_LINE = 12, SVGA_REG_FB_START = 13, SVGA_REG_FB_OFFSET = 14, SVGA_REG_VRAM_SIZE = 15, SVGA_REG_FB_SIZE = 16, SVGA_REG_CAPABILITIES = 17, SVGA_REG_MEM_START = 18, /* Memory for command FIFO and bitmaps */ SVGA_REG_MEM_SIZE = 19, SVGA_REG_CONFIG_DONE = 20, /* Set when memory area configured */ SVGA_REG_SYNC = 21, /* Write to force synchronization */ SVGA_REG_BUSY = 22, /* Read to check if sync is done */ SVGA_REG_GUEST_ID = 23, /* Set guest OS identifier */ SVGA_REG_CURSOR_ID = 24, /* ID of cursor */ SVGA_REG_CURSOR_X = 25, /* Set cursor X position */ SVGA_REG_CURSOR_Y = 26, /* Set cursor Y position */ SVGA_REG_CURSOR_ON = 27, /* Turn cursor on/off */ SVGA_REG_HOST_BITS_PER_PIXEL = 28, /* Current bpp in the host */ SVGA_REG_TOP = 30, /* Must be 1 greater than the last register */ SVGA_PALETTE_BASE = 1024 /* Base of SVGA color map */ }; /* * Capabilities */ #define SVGA_CAP_NONE 0x0000 #define SVGA_CAP_RECT_FILL 0x0001 #define SVGA_CAP_RECT_COPY 0x0002 #define SVGA_CAP_RECT_PAT_FILL 0x0004 #define SVGA_CAP_LEGACY_OFFSCREEN 0x0008 #define SVGA_CAP_RASTER_OP 0x0010 #define SVGA_CAP_CURSOR 0x0020 #define SVGA_CAP_CURSOR_BYPASS 0x0040 #define SVGA_CAP_CURSOR_BYPASS_2 0x0080 #define SVGA_CAP_8BIT_EMULATION 0x0100 #define SVGA_CAP_ALPHA_CURSOR 0x0200 #define SVGA_CAP_GLYPH 0x0400 #define SVGA_CAP_GLYPH_CLIPPING 0x0800 #define SVGA_CAP_OFFSCREEN_1 0x1000 #define SVGA_CAP_ALPHA_BLEND 0x2000 /* * Raster op codes (same encoding as X) used by FIFO drivers. */ #define SVGA_ROP_CLEAR 0x00 /* 0 */ #define SVGA_ROP_AND 0x01 /* src AND dst */ #define SVGA_ROP_AND_REVERSE 0x02 /* src AND NOT dst */ #define SVGA_ROP_COPY 0x03 /* src */ #define SVGA_ROP_AND_INVERTED 0x04 /* NOT src AND dst */ #define SVGA_ROP_NOOP 0x05 /* dst */ #define SVGA_ROP_XOR 0x06 /* src XOR dst */ #define SVGA_ROP_OR 0x07 /* src OR dst */ #define SVGA_ROP_NOR 0x08 /* NOT src AND NOT dst */ #define SVGA_ROP_EQUIV 0x09 /* NOT src XOR dst */ #define SVGA_ROP_INVERT 0x0a /* NOT dst */ #define SVGA_ROP_OR_REVERSE 0x0b /* src OR NOT dst */ #define SVGA_ROP_COPY_INVERTED 0x0c /* NOT src */ #define SVGA_ROP_OR_INVERTED 0x0d /* NOT src OR dst */ #define SVGA_ROP_NAND 0x0e /* NOT src OR NOT dst */ #define SVGA_ROP_SET 0x0f /* 1 */ #define SVGA_ROP_UNSUPPORTED 0x10 #define SVGA_NUM_SUPPORTED_ROPS 16 #define SVGA_ROP_ALL (MASK(SVGA_NUM_SUPPORTED_ROPS)) #define SVGA_IS_VALID_ROP(rop) (rop >= 0 && rop < SVGA_NUM_SUPPORTED_ROPS) /* * Ops * For each pixel, the four channels of the image are computed with: * * C = Ca * Fa + Cb * Fb * * where C, Ca, Cb are the values of the respective channels and Fa * and Fb come from the following table: * * BlendOp Fa Fb * ------------------------------------------ * Clear 0 0 * Src 1 0 * Dst 0 1 * Over 1 1-Aa * OverReverse 1-Ab 1 * In Ab 0 * InReverse 0 Aa * Out 1-Ab 0 * OutReverse 0 1-Aa * Atop Ab 1-Aa * AtopReverse 1-Ab Aa * Xor 1-Ab 1-Aa * Add 1 1 * Saturate min(1,(1-Ab)/Aa) 1 * * Flags * You can use the following flags to achieve additional affects: * * Flag Effect * ------------------------------------------ * ConstantSourceAlpha Ca = Ca * Param0 * ConstantDestAlpha Cb = Cb * Param1 * * Flag effects resolve before the op. For example * BlendOp == Add && Flags == ConstantSourceAlpha | * ConstantDestAlpha results in: * * C = (Ca * Param0) + (Cb * Param1) */ #define SVGA_BLENDOP_CLEAR 0 #define SVGA_BLENDOP_SRC 1 #define SVGA_BLENDOP_DST 2 #define SVGA_BLENDOP_OVER 3 #define SVGA_BLENDOP_OVER_REVERSE 4 #define SVGA_BLENDOP_IN 5 #define SVGA_BLENDOP_IN_REVERSE 6 #define SVGA_BLENDOP_OUT 7 #define SVGA_BLENDOP_OUT_REVERSE 8 #define SVGA_BLENDOP_ATOP 9 #define SVGA_BLENDOP_ATOP_REVERSE 10 #define SVGA_BLENDOP_XOR 11 #define SVGA_BLENDOP_ADD 12 #define SVGA_BLENDOP_SATURATE 13 #define SVGA_NUM_BLENDOPS 14 #define SVGA_IS_VALID_BLENDOP(op) (op >= 0 && op < SVGA_NUM_BLENDOPS) #define SVGA_BLENDFLAG_CONSTANT_SOURCE_ALPHA 0x01 #define SVGA_BLENDFLAG_CONSTANT_DEST_ALPHA 0x02 #define SVGA_NUM_BLENDFLAGS 2 #define SVGA_BLENDFLAG_ALL (MASK(SVGA_NUM_BLENDFLAGS)) #define SVGA_IS_VALID_BLENDFLAG(flag) ((flag & ~SVGA_BLENDFLAG_ALL) == 0) /* * Memory area offsets (viewed as an array of 32-bit words) */ /* * The distance from MIN to MAX must be at least 10K */ #define SVGA_FIFO_MIN 0 #define SVGA_FIFO_MAX 1 #define SVGA_FIFO_NEXT_CMD 2 #define SVGA_FIFO_STOP 3 #define SVGA_FIFO_USER_DEFINED 4 /* * Drawing object ID's, in the range 0 to SVGA_MAX_ID */ #define SVGA_MAX_ID 499 /* * Macros to compute variable length items (sizes in 32-bit words, except * for SVGA_GLYPH_SCANLINE_SIZE, which is in bytes). */ #define SVGA_BITMAP_SIZE(w,h) ((((w)+31) >> 5) * (h)) #define SVGA_BITMAP_SCANLINE_SIZE(w) (( (w)+31 ) >> 5) #define SVGA_PIXMAP_SIZE(w,h,bpp) ((( ((w)*(bpp))+31 ) >> 5) * (h)) #define SVGA_PIXMAP_SCANLINE_SIZE(w,bpp) (( ((w)*(bpp))+31 ) >> 5) #define SVGA_GLYPH_SIZE(w,h) ((((((w) + 7) >> 3) * (h)) + 3) >> 2) #define SVGA_GLYPH_SCANLINE_SIZE(w) (((w) + 7) >> 3) /* * Get the width and height of VRAM in the current mode (for offscreen memory) */ #define SVGA_VRAM_WIDTH_HEIGHT(width /* out */, height /* out */) { \ uint32 pitch = svga->reg[SVGA_REG_BYTES_PER_LINE]; \ width = (pitch * 8) / ((svga->reg[SVGA_REG_BITS_PER_PIXEL] + 7) & ~7); \ height = (svga->reg[SVGA_REG_VRAM_SIZE] - \ svga->reg[SVGA_REG_FB_OFFSET]) / pitch; \ } /* * Increment from one scanline to the next of a bitmap or pixmap */ #define SVGA_BITMAP_INCREMENT(w) ((( (w)+31 ) >> 5) * sizeof (uint32)) #define SVGA_PIXMAP_INCREMENT(w,bpp) ((( ((w)*(bpp))+31 ) >> 5) * sizeof (uint32)) /* * Transparent color for DRAW_GLYPH_CLIPPED */ #define SVGA_COLOR_TRANSPARENT (~0) /* * Commands in the command FIFO */ #define SVGA_CMD_INVALID_CMD 0 /* FIFO layout: (well, undefined) */ #define SVGA_CMD_UPDATE 1 /* FIFO layout: X, Y, Width, Height */ #define SVGA_CMD_RECT_FILL 2 /* FIFO layout: Color, X, Y, Width, Height */ #define SVGA_CMD_RECT_COPY 3 /* FIFO layout: Source X, Source Y, Dest X, Dest Y, Width, Height */ #define SVGA_CMD_DEFINE_BITMAP 4 /* FIFO layout: Pixmap ID, Width, Height, */ #define SVGA_CMD_DEFINE_BITMAP_SCANLINE 5 /* FIFO layout: Pixmap ID, Width, Height, Line #, scanline */ #define SVGA_CMD_DEFINE_PIXMAP 6 /* FIFO layout: Pixmap ID, Width, Height, Depth, */ #define SVGA_CMD_DEFINE_PIXMAP_SCANLINE 7 /* FIFO layout: Pixmap ID, Width, Height, Depth, Line #, scanline */ #define SVGA_CMD_RECT_BITMAP_FILL 8 /* FIFO layout: Bitmap ID, X, Y, Width, Height, Foreground, Background */ #define SVGA_CMD_RECT_PIXMAP_FILL 9 /* FIFO layout: Pixmap ID, X, Y, Width, Height */ #define SVGA_CMD_RECT_BITMAP_COPY 10 /* FIFO layout: Bitmap ID, Source X, Source Y, Dest X, Dest Y, Width, Height, Foreground, Background */ #define SVGA_CMD_RECT_PIXMAP_COPY 11 /* FIFO layout: Pixmap ID, Source X, Source Y, Dest X, Dest Y, Width, Height */ #define SVGA_CMD_FREE_OBJECT 12 /* FIFO layout: Object (pixmap, bitmap, ...) ID */ #define SVGA_CMD_RECT_ROP_FILL 13 /* FIFO layout: Color, X, Y, Width, Height, ROP */ #define SVGA_CMD_RECT_ROP_COPY 14 /* FIFO layout: Source X, Source Y, Dest X, Dest Y, Width, Height, ROP */ #define SVGA_CMD_RECT_ROP_BITMAP_FILL 15 /* FIFO layout: ID, X, Y, Width, Height, Foreground, Background, ROP */ #define SVGA_CMD_RECT_ROP_PIXMAP_FILL 16 /* FIFO layout: ID, X, Y, Width, Height, ROP */ #define SVGA_CMD_RECT_ROP_BITMAP_COPY 17 /* FIFO layout: ID, Source X, Source Y, Dest X, Dest Y, Width, Height, Foreground, Background, ROP */ #define SVGA_CMD_RECT_ROP_PIXMAP_COPY 18 /* FIFO layout: ID, Source X, Source Y, Dest X, Dest Y, Width, Height, ROP */ #define SVGA_CMD_DEFINE_CURSOR 19 /* FIFO layout: ID, Hotspot X, Hotspot Y, Width, Height, Depth for AND mask, Depth for XOR mask, , */ #define SVGA_CMD_DISPLAY_CURSOR 20 /* FIFO layout: ID, On/Off (1 or 0) */ #define SVGA_CMD_MOVE_CURSOR 21 /* FIFO layout: X, Y */ #define SVGA_CMD_DEFINE_ALPHA_CURSOR 22 /* FIFO layout: ID, Hotspot X, Hotspot Y, Width, Height, */ #define SVGA_CMD_DRAW_GLYPH 23 /* FIFO layout: X, Y, W, H, FGCOLOR, */ #define SVGA_CMD_DRAW_GLYPH_CLIPPED 24 /* FIFO layout: X, Y, W, H, FGCOLOR, BGCOLOR, , Transparent color expands are done by setting BGCOLOR to ~0 */ #define SVGA_CMD_UPDATE_VERBOSE 25 /* FIFO layout: X, Y, Width, Height, Reason */ #define SVGA_CMD_SURFACE_FILL 26 /* FIFO layout: color, dstSurfaceOffset, x, y, w, h, rop */ #define SVGA_CMD_SURFACE_COPY 27 /* FIFO layout: srcSurfaceOffset, dstSurfaceOffset, srcX, srcY, destX, destY, w, h, rop */ #define SVGA_CMD_SURFACE_ALPHA_BLEND 28 /* FIFO layout: srcSurfaceOffset, dstSurfaceOffset, srcX, srcY, destX, destY, w, h, op (SVGA_BLENDOP*), flags (SVGA_BLENDFLAGS*), param1, param2 */ #define SVGA_CMD_MAX 29 /* SURFACE_ALPHA_BLEND currently has the most (non-data) arguments: 12 */ #define SVGA_CMD_MAX_ARGS 12 /* * A sync request is sent via a non-zero write to the SVGA_REG_SYNC * register. In devel builds, the driver will write a specific value * indicating exactly why the sync is necessary */ enum { SVGA_SYNC_INVALIDREASON = 0, /* Don't ever write a zero */ SVGA_SYNC_GENERIC = 1, /* Legacy drivers will always write a 1 */ SVGA_SYNC_FIFOFULL = 2, /* Need to drain FIFO for next write */ SVGA_SYNC_FB_WRITE = 3, /* About write to shadow frame buffer (generic) */ SVGA_SYNC_FB_BITBLT = 4, /* Unaccelerated DrvBitBlt */ SVGA_SYNC_FB_COPYBITS = 5, /* Unacclerated DrvCopyBits bits */ SVGA_SYNC_FB_FILLPATH = 6, /* Unacclerated DrvFillPath */ SVGA_SYNC_FB_LINETO = 7, /* Unacclerated DrvLineTo */ SVGA_SYNC_FB_PAINT = 8, /* Unacclerated DrvPaint */ SVGA_SYNC_FB_STRETCHBLT = 9, /* Unacclerated DrvStretchBlt */ SVGA_SYNC_FB_STROKEFILL = 10, /* Unacclerated DrvStrokeAndFillPath */ SVGA_SYNC_FB_STROKE = 11, /* Unacclerated DrvStrokePath */ SVGA_SYNC_FB_TEXTOUT = 12, /* Unacclerated DrvTextOut */ SVGA_SYNC_FB_ALPHABLEND = 13, /* Unacclerated DrvAlphaBlend */ SVGA_SYNC_FB_GRADIENT = 14, /* Unacclerated DrvGradientFill */ SVGA_SYNC_FB_PLGBLT = 15, /* Unacclerated DrvPlgBlt */ SVGA_SYNC_FB_STRETCHROP = 16, /* Unacclerated DrvStretchBltROP */ SVGA_SYNC_FB_TRANSPARENT = 17, /* Unacclerated DrvTransparentBlt */ SVGA_SYNC_FB_NEWCURSOR = 18, /* Defined a new cursor */ SVGA_SYNC_FB_SYNCSURFACE = 19, /* DrvSynchrnoizeSurface call */ SVGA_SYNC_FB_NUM_REASONS /* Total number of reasons */ }; #endif