Archipelago » qemu

/*

 * QEMU Cirrus CLGD 54xx VGA Emulator.

 *

 * Copyright (c) 2004 Fabrice Bellard

 * Copyright (c) 2004 Makoto Suzuki (suzu)

 *

 * Permission is hereby granted, free of charge, to any person obtaining a copy

 * of this software and associated documentation files (the "Software"), to deal

 * in the Software without restriction, including without limitation the rights

 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

 * copies of the Software, and to permit persons to whom the Software is

 * furnished to do so, subject to the following conditions:

 *

 * The above copyright notice and this permission notice shall be included in

 * all copies or substantial portions of the Software.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL

 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

 * THE SOFTWARE.

 */

/*

 * Reference: Finn Thogersons' VGADOC4b

 *   available at http://home.worldonline.dk/~finth/

 */

#include "hw/hw.h"

#include "hw/pci/pci.h"

#include "ui/console.h"

#include "vga_int.h"

#include "hw/loader.h"

/*

 * TODO:

 *    - destination write mask support not complete (bits 5..7)

 *    - optimize linear mappings

 *    - optimize bitblt functions

 */

//#define DEBUG_CIRRUS

//#define DEBUG_BITBLT

/***************************************

 *

 *  definitions

 *

 ***************************************/

// ID

#define CIRRUS_ID_CLGD5422  (0x23<<2)

#define CIRRUS_ID_CLGD5426  (0x24<<2)

#define CIRRUS_ID_CLGD5424  (0x25<<2)

#define CIRRUS_ID_CLGD5428  (0x26<<2)

#define CIRRUS_ID_CLGD5430  (0x28<<2)

#define CIRRUS_ID_CLGD5434  (0x2A<<2)

#define CIRRUS_ID_CLGD5436  (0x2B<<2)

#define CIRRUS_ID_CLGD5446  (0x2E<<2)

// sequencer 0x07

#define CIRRUS_SR7_BPP_VGA            0x00

#define CIRRUS_SR7_BPP_SVGA           0x01

#define CIRRUS_SR7_BPP_MASK           0x0e

#define CIRRUS_SR7_BPP_8              0x00

#define CIRRUS_SR7_BPP_16_DOUBLEVCLK  0x02

#define CIRRUS_SR7_BPP_24             0x04

#define CIRRUS_SR7_BPP_16             0x06

#define CIRRUS_SR7_BPP_32             0x08

#define CIRRUS_SR7_ISAADDR_MASK       0xe0

// sequencer 0x0f

#define CIRRUS_MEMSIZE_512k        0x08

#define CIRRUS_MEMSIZE_1M          0x10

#define CIRRUS_MEMSIZE_2M          0x18

#define CIRRUS_MEMFLAGS_BANKSWITCH 0x80        // bank switching is enabled.

// sequencer 0x12

#define CIRRUS_CURSOR_SHOW         0x01

#define CIRRUS_CURSOR_HIDDENPEL    0x02

#define CIRRUS_CURSOR_LARGE        0x04        // 64x64 if set, 32x32 if clear

// sequencer 0x17

#define CIRRUS_BUSTYPE_VLBFAST   0x10

#define CIRRUS_BUSTYPE_PCI       0x20

#define CIRRUS_BUSTYPE_VLBSLOW   0x30

#define CIRRUS_BUSTYPE_ISA       0x38

#define CIRRUS_MMIO_ENABLE       0x04

#define CIRRUS_MMIO_USE_PCIADDR  0x40        // 0xb8000 if cleared.

#define CIRRUS_MEMSIZEEXT_DOUBLE 0x80

// control 0x0b

#define CIRRUS_BANKING_DUAL             0x01

#define CIRRUS_BANKING_GRANULARITY_16K  0x20        // set:16k, clear:4k

// control 0x30

#define CIRRUS_BLTMODE_BACKWARDS        0x01

#define CIRRUS_BLTMODE_MEMSYSDEST       0x02

#define CIRRUS_BLTMODE_MEMSYSSRC        0x04

#define CIRRUS_BLTMODE_TRANSPARENTCOMP  0x08

#define CIRRUS_BLTMODE_PATTERNCOPY      0x40

#define CIRRUS_BLTMODE_COLOREXPAND      0x80

#define CIRRUS_BLTMODE_PIXELWIDTHMASK   0x30

#define CIRRUS_BLTMODE_PIXELWIDTH8      0x00

#define CIRRUS_BLTMODE_PIXELWIDTH16     0x10

#define CIRRUS_BLTMODE_PIXELWIDTH24     0x20

#define CIRRUS_BLTMODE_PIXELWIDTH32     0x30

// control 0x31

#define CIRRUS_BLT_BUSY                 0x01

#define CIRRUS_BLT_START                0x02

#define CIRRUS_BLT_RESET                0x04

#define CIRRUS_BLT_FIFOUSED             0x10

#define CIRRUS_BLT_AUTOSTART            0x80

// control 0x32

#define CIRRUS_ROP_0                    0x00

#define CIRRUS_ROP_SRC_AND_DST          0x05

#define CIRRUS_ROP_NOP                  0x06

#define CIRRUS_ROP_SRC_AND_NOTDST       0x09

#define CIRRUS_ROP_NOTDST               0x0b

#define CIRRUS_ROP_SRC                  0x0d

#define CIRRUS_ROP_1                    0x0e

#define CIRRUS_ROP_NOTSRC_AND_DST       0x50

#define CIRRUS_ROP_SRC_XOR_DST          0x59

#define CIRRUS_ROP_SRC_OR_DST           0x6d

#define CIRRUS_ROP_NOTSRC_OR_NOTDST     0x90

#define CIRRUS_ROP_SRC_NOTXOR_DST       0x95

#define CIRRUS_ROP_SRC_OR_NOTDST        0xad

#define CIRRUS_ROP_NOTSRC               0xd0

#define CIRRUS_ROP_NOTSRC_OR_DST        0xd6

#define CIRRUS_ROP_NOTSRC_AND_NOTDST    0xda

#define CIRRUS_ROP_NOP_INDEX 2

#define CIRRUS_ROP_SRC_INDEX 5

// control 0x33

#define CIRRUS_BLTMODEEXT_SOLIDFILL        0x04

#define CIRRUS_BLTMODEEXT_COLOREXPINV      0x02

#define CIRRUS_BLTMODEEXT_DWORDGRANULARITY 0x01

// memory-mapped IO

#define CIRRUS_MMIO_BLTBGCOLOR        0x00        // dword

#define CIRRUS_MMIO_BLTFGCOLOR        0x04        // dword

#define CIRRUS_MMIO_BLTWIDTH          0x08        // word

#define CIRRUS_MMIO_BLTHEIGHT         0x0a        // word

#define CIRRUS_MMIO_BLTDESTPITCH      0x0c        // word

#define CIRRUS_MMIO_BLTSRCPITCH       0x0e        // word

#define CIRRUS_MMIO_BLTDESTADDR       0x10        // dword

#define CIRRUS_MMIO_BLTSRCADDR        0x14        // dword

#define CIRRUS_MMIO_BLTWRITEMASK      0x17        // byte

#define CIRRUS_MMIO_BLTMODE           0x18        // byte

#define CIRRUS_MMIO_BLTROP            0x1a        // byte

#define CIRRUS_MMIO_BLTMODEEXT        0x1b        // byte

#define CIRRUS_MMIO_BLTTRANSPARENTCOLOR 0x1c        // word?

#define CIRRUS_MMIO_BLTTRANSPARENTCOLORMASK 0x20        // word?

#define CIRRUS_MMIO_LINEARDRAW_START_X 0x24        // word

#define CIRRUS_MMIO_LINEARDRAW_START_Y 0x26        // word

#define CIRRUS_MMIO_LINEARDRAW_END_X  0x28        // word

#define CIRRUS_MMIO_LINEARDRAW_END_Y  0x2a        // word

#define CIRRUS_MMIO_LINEARDRAW_LINESTYLE_INC 0x2c        // byte

#define CIRRUS_MMIO_LINEARDRAW_LINESTYLE_ROLLOVER 0x2d        // byte

#define CIRRUS_MMIO_LINEARDRAW_LINESTYLE_MASK 0x2e        // byte

#define CIRRUS_MMIO_LINEARDRAW_LINESTYLE_ACCUM 0x2f        // byte

#define CIRRUS_MMIO_BRESENHAM_K1      0x30        // word

#define CIRRUS_MMIO_BRESENHAM_K3      0x32        // word

#define CIRRUS_MMIO_BRESENHAM_ERROR   0x34        // word

#define CIRRUS_MMIO_BRESENHAM_DELTA_MAJOR 0x36        // word

#define CIRRUS_MMIO_BRESENHAM_DIRECTION 0x38        // byte

#define CIRRUS_MMIO_LINEDRAW_MODE     0x39        // byte

#define CIRRUS_MMIO_BLTSTATUS         0x40        // byte

#define CIRRUS_PNPMMIO_SIZE         0x1000

#define BLTUNSAFE(s) \

    ( \

        ( /* check dst is within bounds */ \

            (s)->cirrus_blt_height * ABS((s)->cirrus_blt_dstpitch) \

                + ((s)->cirrus_blt_dstaddr & (s)->cirrus_addr_mask) > \

                    (s)->vga.vram_size \

        ) || \

        ( /* check src is within bounds */ \

            (s)->cirrus_blt_height * ABS((s)->cirrus_blt_srcpitch) \

                + ((s)->cirrus_blt_srcaddr & (s)->cirrus_addr_mask) > \

                    (s)->vga.vram_size \

        ) \

    )

struct CirrusVGAState;

typedef void (*cirrus_bitblt_rop_t) (struct CirrusVGAState *s,

                                     uint8_t * dst, const uint8_t * src,

                                     int dstpitch, int srcpitch,

                                     int bltwidth, int bltheight);

typedef void (*cirrus_fill_t)(struct CirrusVGAState *s,

                              uint8_t *dst, int dst_pitch, int width, int height);

typedef struct CirrusVGAState {

    VGACommonState vga;

    MemoryRegion cirrus_vga_io;

    MemoryRegion cirrus_linear_io;

    MemoryRegion cirrus_linear_bitblt_io;

    MemoryRegion cirrus_mmio_io;

    MemoryRegion pci_bar;

    bool linear_vram;  /* vga.vram mapped over cirrus_linear_io */

    MemoryRegion low_mem_container; /* container for 0xa0000-0xc0000 */

    MemoryRegion low_mem;           /* always mapped, overridden by: */

    MemoryRegion cirrus_bank[2];    /*   aliases at 0xa0000-0xb0000  */

    uint32_t cirrus_addr_mask;

    uint32_t linear_mmio_mask;

    uint8_t cirrus_shadow_gr0;

    uint8_t cirrus_shadow_gr1;

    uint8_t cirrus_hidden_dac_lockindex;

    uint8_t cirrus_hidden_dac_data;

    uint32_t cirrus_bank_base[2];

    uint32_t cirrus_bank_limit[2];

    uint8_t cirrus_hidden_palette[48];

    uint32_t hw_cursor_x;

    uint32_t hw_cursor_y;

    int cirrus_blt_pixelwidth;

    int cirrus_blt_width;

    int cirrus_blt_height;

    int cirrus_blt_dstpitch;

    int cirrus_blt_srcpitch;

    uint32_t cirrus_blt_fgcol;

    uint32_t cirrus_blt_bgcol;

    uint32_t cirrus_blt_dstaddr;

    uint32_t cirrus_blt_srcaddr;

    uint8_t cirrus_blt_mode;

    uint8_t cirrus_blt_modeext;

    cirrus_bitblt_rop_t cirrus_rop;

#define CIRRUS_BLTBUFSIZE (2048 * 4) /* one line width */

    uint8_t cirrus_bltbuf[CIRRUS_BLTBUFSIZE];

    uint8_t *cirrus_srcptr;

    uint8_t *cirrus_srcptr_end;

    uint32_t cirrus_srccounter;

    /* hwcursor display state */

    int last_hw_cursor_size;

    int last_hw_cursor_x;

    int last_hw_cursor_y;

    int last_hw_cursor_y_start;

    int last_hw_cursor_y_end;

    int real_vram_size; /* XXX: suppress that */

    int device_id;

    int bustype;

} CirrusVGAState;

typedef struct PCICirrusVGAState {

    PCIDevice dev;

    CirrusVGAState cirrus_vga;

} PCICirrusVGAState;

#define TYPE_ISA_CIRRUS_VGA "isa-cirrus-vga"

#define ISA_CIRRUS_VGA(obj) \

    OBJECT_CHECK(ISACirrusVGAState, (obj), TYPE_ISA_CIRRUS_VGA)

typedef struct ISACirrusVGAState {

    ISADevice parent_obj;

    CirrusVGAState cirrus_vga;

} ISACirrusVGAState;

static uint8_t rop_to_index[256];

/***************************************

 *

 *  prototypes.

 *

 ***************************************/

static void cirrus_bitblt_reset(CirrusVGAState *s);

static void cirrus_update_memory_access(CirrusVGAState *s);

/***************************************

 *

 *  raster operations

 *

 ***************************************/

static void cirrus_bitblt_rop_nop(CirrusVGAState *s,

                                  uint8_t *dst,const uint8_t *src,

                                  int dstpitch,int srcpitch,

                                  int bltwidth,int bltheight)

{

}

static void cirrus_bitblt_fill_nop(CirrusVGAState *s,

                                   uint8_t *dst,

                                   int dstpitch, int bltwidth,int bltheight)

{

}

#define ROP_NAME 0

#define ROP_FN(d, s) 0

#include "cirrus_vga_rop.h"

#define ROP_NAME src_and_dst

#define ROP_FN(d, s) (s) & (d)

#include "cirrus_vga_rop.h"

#define ROP_NAME src_and_notdst

#define ROP_FN(d, s) (s) & (~(d))

#include "cirrus_vga_rop.h"

#define ROP_NAME notdst

#define ROP_FN(d, s) ~(d)

#include "cirrus_vga_rop.h"

#define ROP_NAME src

#define ROP_FN(d, s) s

#include "cirrus_vga_rop.h"

#define ROP_NAME 1

#define ROP_FN(d, s) ~0

#include "cirrus_vga_rop.h"

#define ROP_NAME notsrc_and_dst

#define ROP_FN(d, s) (~(s)) & (d)

#include "cirrus_vga_rop.h"

#define ROP_NAME src_xor_dst

#define ROP_FN(d, s) (s) ^ (d)

#include "cirrus_vga_rop.h"

#define ROP_NAME src_or_dst

#define ROP_FN(d, s) (s) | (d)

#include "cirrus_vga_rop.h"

#define ROP_NAME notsrc_or_notdst

#define ROP_FN(d, s) (~(s)) | (~(d))

#include "cirrus_vga_rop.h"

#define ROP_NAME src_notxor_dst

#define ROP_FN(d, s) ~((s) ^ (d))

#include "cirrus_vga_rop.h"

#define ROP_NAME src_or_notdst

#define ROP_FN(d, s) (s) | (~(d))

#include "cirrus_vga_rop.h"

#define ROP_NAME notsrc

#define ROP_FN(d, s) (~(s))

#include "cirrus_vga_rop.h"

#define ROP_NAME notsrc_or_dst

#define ROP_FN(d, s) (~(s)) | (d)

#include "cirrus_vga_rop.h"

#define ROP_NAME notsrc_and_notdst

#define ROP_FN(d, s) (~(s)) & (~(d))

#include "cirrus_vga_rop.h"

static const cirrus_bitblt_rop_t cirrus_fwd_rop[16] = {

    cirrus_bitblt_rop_fwd_0,

    cirrus_bitblt_rop_fwd_src_and_dst,

    cirrus_bitblt_rop_nop,

    cirrus_bitblt_rop_fwd_src_and_notdst,

    cirrus_bitblt_rop_fwd_notdst,

    cirrus_bitblt_rop_fwd_src,

    cirrus_bitblt_rop_fwd_1,

    cirrus_bitblt_rop_fwd_notsrc_and_dst,

    cirrus_bitblt_rop_fwd_src_xor_dst,

    cirrus_bitblt_rop_fwd_src_or_dst,

    cirrus_bitblt_rop_fwd_notsrc_or_notdst,

    cirrus_bitblt_rop_fwd_src_notxor_dst,

    cirrus_bitblt_rop_fwd_src_or_notdst,

    cirrus_bitblt_rop_fwd_notsrc,

    cirrus_bitblt_rop_fwd_notsrc_or_dst,

    cirrus_bitblt_rop_fwd_notsrc_and_notdst,

};

static const cirrus_bitblt_rop_t cirrus_bkwd_rop[16] = {

    cirrus_bitblt_rop_bkwd_0,

    cirrus_bitblt_rop_bkwd_src_and_dst,

    cirrus_bitblt_rop_nop,

    cirrus_bitblt_rop_bkwd_src_and_notdst,

    cirrus_bitblt_rop_bkwd_notdst,

    cirrus_bitblt_rop_bkwd_src,

    cirrus_bitblt_rop_bkwd_1,

    cirrus_bitblt_rop_bkwd_notsrc_and_dst,

    cirrus_bitblt_rop_bkwd_src_xor_dst,

    cirrus_bitblt_rop_bkwd_src_or_dst,

    cirrus_bitblt_rop_bkwd_notsrc_or_notdst,

    cirrus_bitblt_rop_bkwd_src_notxor_dst,

    cirrus_bitblt_rop_bkwd_src_or_notdst,

    cirrus_bitblt_rop_bkwd_notsrc,

    cirrus_bitblt_rop_bkwd_notsrc_or_dst,

    cirrus_bitblt_rop_bkwd_notsrc_and_notdst,

};

#define TRANSP_ROP(name) {\

    name ## _8,\

    name ## _16,\

        }

#define TRANSP_NOP(func) {\

    func,\

    func,\

        }

static const cirrus_bitblt_rop_t cirrus_fwd_transp_rop[16][2] = {

    TRANSP_ROP(cirrus_bitblt_rop_fwd_transp_0),

    TRANSP_ROP(cirrus_bitblt_rop_fwd_transp_src_and_dst),

    TRANSP_NOP(cirrus_bitblt_rop_nop),

    TRANSP_ROP(cirrus_bitblt_rop_fwd_transp_src_and_notdst),

    TRANSP_ROP(cirrus_bitblt_rop_fwd_transp_notdst),

    TRANSP_ROP(cirrus_bitblt_rop_fwd_transp_src),

    TRANSP_ROP(cirrus_bitblt_rop_fwd_transp_1),

    TRANSP_ROP(cirrus_bitblt_rop_fwd_transp_notsrc_and_dst),

    TRANSP_ROP(cirrus_bitblt_rop_fwd_transp_src_xor_dst),

    TRANSP_ROP(cirrus_bitblt_rop_fwd_transp_src_or_dst),

    TRANSP_ROP(cirrus_bitblt_rop_fwd_transp_notsrc_or_notdst),

    TRANSP_ROP(cirrus_bitblt_rop_fwd_transp_src_notxor_dst),

    TRANSP_ROP(cirrus_bitblt_rop_fwd_transp_src_or_notdst),

    TRANSP_ROP(cirrus_bitblt_rop_fwd_transp_notsrc),

    TRANSP_ROP(cirrus_bitblt_rop_fwd_transp_notsrc_or_dst),

    TRANSP_ROP(cirrus_bitblt_rop_fwd_transp_notsrc_and_notdst),

};

static const cirrus_bitblt_rop_t cirrus_bkwd_transp_rop[16][2] = {

    TRANSP_ROP(cirrus_bitblt_rop_bkwd_transp_0),

    TRANSP_ROP(cirrus_bitblt_rop_bkwd_transp_src_and_dst),

    TRANSP_NOP(cirrus_bitblt_rop_nop),

    TRANSP_ROP(cirrus_bitblt_rop_bkwd_transp_src_and_notdst),

    TRANSP_ROP(cirrus_bitblt_rop_bkwd_transp_notdst),

    TRANSP_ROP(cirrus_bitblt_rop_bkwd_transp_src),

    TRANSP_ROP(cirrus_bitblt_rop_bkwd_transp_1),

    TRANSP_ROP(cirrus_bitblt_rop_bkwd_transp_notsrc_and_dst),

    TRANSP_ROP(cirrus_bitblt_rop_bkwd_transp_src_xor_dst),

    TRANSP_ROP(cirrus_bitblt_rop_bkwd_transp_src_or_dst),

    TRANSP_ROP(cirrus_bitblt_rop_bkwd_transp_notsrc_or_notdst),

    TRANSP_ROP(cirrus_bitblt_rop_bkwd_transp_src_notxor_dst),

    TRANSP_ROP(cirrus_bitblt_rop_bkwd_transp_src_or_notdst),

    TRANSP_ROP(cirrus_bitblt_rop_bkwd_transp_notsrc),

    TRANSP_ROP(cirrus_bitblt_rop_bkwd_transp_notsrc_or_dst),

    TRANSP_ROP(cirrus_bitblt_rop_bkwd_transp_notsrc_and_notdst),

};

#define ROP2(name) {\

    name ## _8,\

    name ## _16,\

    name ## _24,\

    name ## _32,\

        }

#define ROP_NOP2(func) {\

    func,\

    func,\

    func,\

    func,\

        }

static const cirrus_bitblt_rop_t cirrus_patternfill[16][4] = {

    ROP2(cirrus_patternfill_0),

    ROP2(cirrus_patternfill_src_and_dst),

    ROP_NOP2(cirrus_bitblt_rop_nop),

    ROP2(cirrus_patternfill_src_and_notdst),

    ROP2(cirrus_patternfill_notdst),

    ROP2(cirrus_patternfill_src),

    ROP2(cirrus_patternfill_1),

    ROP2(cirrus_patternfill_notsrc_and_dst),

    ROP2(cirrus_patternfill_src_xor_dst),

    ROP2(cirrus_patternfill_src_or_dst),

    ROP2(cirrus_patternfill_notsrc_or_notdst),

    ROP2(cirrus_patternfill_src_notxor_dst),

    ROP2(cirrus_patternfill_src_or_notdst),

    ROP2(cirrus_patternfill_notsrc),

    ROP2(cirrus_patternfill_notsrc_or_dst),

    ROP2(cirrus_patternfill_notsrc_and_notdst),

};

static const cirrus_bitblt_rop_t cirrus_colorexpand_transp[16][4] = {

    ROP2(cirrus_colorexpand_transp_0),

    ROP2(cirrus_colorexpand_transp_src_and_dst),

    ROP_NOP2(cirrus_bitblt_rop_nop),

    ROP2(cirrus_colorexpand_transp_src_and_notdst),

    ROP2(cirrus_colorexpand_transp_notdst),

    ROP2(cirrus_colorexpand_transp_src),

    ROP2(cirrus_colorexpand_transp_1),

    ROP2(cirrus_colorexpand_transp_notsrc_and_dst),

    ROP2(cirrus_colorexpand_transp_src_xor_dst),

    ROP2(cirrus_colorexpand_transp_src_or_dst),

    ROP2(cirrus_colorexpand_transp_notsrc_or_notdst),

    ROP2(cirrus_colorexpand_transp_src_notxor_dst),

    ROP2(cirrus_colorexpand_transp_src_or_notdst),

    ROP2(cirrus_colorexpand_transp_notsrc),

    ROP2(cirrus_colorexpand_transp_notsrc_or_dst),

    ROP2(cirrus_colorexpand_transp_notsrc_and_notdst),

};

static const cirrus_bitblt_rop_t cirrus_colorexpand[16][4] = {

    ROP2(cirrus_colorexpand_0),

    ROP2(cirrus_colorexpand_src_and_dst),

    ROP_NOP2(cirrus_bitblt_rop_nop),

    ROP2(cirrus_colorexpand_src_and_notdst),

    ROP2(cirrus_colorexpand_notdst),

    ROP2(cirrus_colorexpand_src),

    ROP2(cirrus_colorexpand_1),

    ROP2(cirrus_colorexpand_notsrc_and_dst),

    ROP2(cirrus_colorexpand_src_xor_dst),

    ROP2(cirrus_colorexpand_src_or_dst),

    ROP2(cirrus_colorexpand_notsrc_or_notdst),

    ROP2(cirrus_colorexpand_src_notxor_dst),

    ROP2(cirrus_colorexpand_src_or_notdst),

    ROP2(cirrus_colorexpand_notsrc),

    ROP2(cirrus_colorexpand_notsrc_or_dst),

    ROP2(cirrus_colorexpand_notsrc_and_notdst),

};

static const cirrus_bitblt_rop_t cirrus_colorexpand_pattern_transp[16][4] = {

    ROP2(cirrus_colorexpand_pattern_transp_0),

    ROP2(cirrus_colorexpand_pattern_transp_src_and_dst),

    ROP_NOP2(cirrus_bitblt_rop_nop),

    ROP2(cirrus_colorexpand_pattern_transp_src_and_notdst),

    ROP2(cirrus_colorexpand_pattern_transp_notdst),

    ROP2(cirrus_colorexpand_pattern_transp_src),

    ROP2(cirrus_colorexpand_pattern_transp_1),

    ROP2(cirrus_colorexpand_pattern_transp_notsrc_and_dst),

    ROP2(cirrus_colorexpand_pattern_transp_src_xor_dst),

    ROP2(cirrus_colorexpand_pattern_transp_src_or_dst),

    ROP2(cirrus_colorexpand_pattern_transp_notsrc_or_notdst),

    ROP2(cirrus_colorexpand_pattern_transp_src_notxor_dst),

    ROP2(cirrus_colorexpand_pattern_transp_src_or_notdst),

    ROP2(cirrus_colorexpand_pattern_transp_notsrc),

    ROP2(cirrus_colorexpand_pattern_transp_notsrc_or_dst),

    ROP2(cirrus_colorexpand_pattern_transp_notsrc_and_notdst),

};

static const cirrus_bitblt_rop_t cirrus_colorexpand_pattern[16][4] = {

    ROP2(cirrus_colorexpand_pattern_0),

    ROP2(cirrus_colorexpand_pattern_src_and_dst),

    ROP_NOP2(cirrus_bitblt_rop_nop),

    ROP2(cirrus_colorexpand_pattern_src_and_notdst),

    ROP2(cirrus_colorexpand_pattern_notdst),

    ROP2(cirrus_colorexpand_pattern_src),

    ROP2(cirrus_colorexpand_pattern_1),

    ROP2(cirrus_colorexpand_pattern_notsrc_and_dst),

    ROP2(cirrus_colorexpand_pattern_src_xor_dst),

    ROP2(cirrus_colorexpand_pattern_src_or_dst),

    ROP2(cirrus_colorexpand_pattern_notsrc_or_notdst),

    ROP2(cirrus_colorexpand_pattern_src_notxor_dst),

    ROP2(cirrus_colorexpand_pattern_src_or_notdst),

    ROP2(cirrus_colorexpand_pattern_notsrc),

    ROP2(cirrus_colorexpand_pattern_notsrc_or_dst),

    ROP2(cirrus_colorexpand_pattern_notsrc_and_notdst),

};

static const cirrus_fill_t cirrus_fill[16][4] = {

    ROP2(cirrus_fill_0),

    ROP2(cirrus_fill_src_and_dst),

    ROP_NOP2(cirrus_bitblt_fill_nop),

    ROP2(cirrus_fill_src_and_notdst),

    ROP2(cirrus_fill_notdst),

    ROP2(cirrus_fill_src),

    ROP2(cirrus_fill_1),

    ROP2(cirrus_fill_notsrc_and_dst),

    ROP2(cirrus_fill_src_xor_dst),

    ROP2(cirrus_fill_src_or_dst),

    ROP2(cirrus_fill_notsrc_or_notdst),

    ROP2(cirrus_fill_src_notxor_dst),

    ROP2(cirrus_fill_src_or_notdst),

    ROP2(cirrus_fill_notsrc),

    ROP2(cirrus_fill_notsrc_or_dst),

    ROP2(cirrus_fill_notsrc_and_notdst),

};

static inline void cirrus_bitblt_fgcol(CirrusVGAState *s)

{

    unsigned int color;

    switch (s->cirrus_blt_pixelwidth) {

    case 1:

        s->cirrus_blt_fgcol = s->cirrus_shadow_gr1;

        break;

    case 2:

        color = s->cirrus_shadow_gr1 | (s->vga.gr[0x11] << 8);

        s->cirrus_blt_fgcol = le16_to_cpu(color);

        break;

    case 3:

        s->cirrus_blt_fgcol = s->cirrus_shadow_gr1 |

            (s->vga.gr[0x11] << 8) | (s->vga.gr[0x13] << 16);

        break;

    default:

    case 4:

        color = s->cirrus_shadow_gr1 | (s->vga.gr[0x11] << 8) |

            (s->vga.gr[0x13] << 16) | (s->vga.gr[0x15] << 24);

        s->cirrus_blt_fgcol = le32_to_cpu(color);

        break;

    }

}

static inline void cirrus_bitblt_bgcol(CirrusVGAState *s)

{

    unsigned int color;

    switch (s->cirrus_blt_pixelwidth) {

    case 1:

        s->cirrus_blt_bgcol = s->cirrus_shadow_gr0;

        break;

    case 2:

        color = s->cirrus_shadow_gr0 | (s->vga.gr[0x10] << 8);

        s->cirrus_blt_bgcol = le16_to_cpu(color);

        break;

    case 3:

        s->cirrus_blt_bgcol = s->cirrus_shadow_gr0 |

            (s->vga.gr[0x10] << 8) | (s->vga.gr[0x12] << 16);

        break;

    default:

    case 4:

        color = s->cirrus_shadow_gr0 | (s->vga.gr[0x10] << 8) |

            (s->vga.gr[0x12] << 16) | (s->vga.gr[0x14] << 24);

        s->cirrus_blt_bgcol = le32_to_cpu(color);

        break;

    }

}

static void cirrus_invalidate_region(CirrusVGAState * s, int off_begin,

                                     int off_pitch, int bytesperline,

                                     int lines)

{

    int y;

    int off_cur;

    int off_cur_end;

    for (y = 0; y < lines; y++) {

        off_cur = off_begin;

        off_cur_end = (off_cur + bytesperline) & s->cirrus_addr_mask;

        memory_region_set_dirty(&s->vga.vram, off_cur, off_cur_end - off_cur);

        off_begin += off_pitch;

    }

}

static int cirrus_bitblt_common_patterncopy(CirrusVGAState * s,

                                            const uint8_t * src)

{

    uint8_t *dst;

    dst = s->vga.vram_ptr + (s->cirrus_blt_dstaddr & s->cirrus_addr_mask);

    if (BLTUNSAFE(s))

        return 0;

    (*s->cirrus_rop) (s, dst, src,

                      s->cirrus_blt_dstpitch, 0,

                      s->cirrus_blt_width, s->cirrus_blt_height);

    cirrus_invalidate_region(s, s->cirrus_blt_dstaddr,

                             s->cirrus_blt_dstpitch, s->cirrus_blt_width,

                             s->cirrus_blt_height);

    return 1;

}

/* fill */

static int cirrus_bitblt_solidfill(CirrusVGAState *s, int blt_rop)

{

    cirrus_fill_t rop_func;

    if (BLTUNSAFE(s))

        return 0;

    rop_func = cirrus_fill[rop_to_index[blt_rop]][s->cirrus_blt_pixelwidth - 1];

    rop_func(s, s->vga.vram_ptr + (s->cirrus_blt_dstaddr & s->cirrus_addr_mask),

             s->cirrus_blt_dstpitch,

             s->cirrus_blt_width, s->cirrus_blt_height);

    cirrus_invalidate_region(s, s->cirrus_blt_dstaddr,

                             s->cirrus_blt_dstpitch, s->cirrus_blt_width,

                             s->cirrus_blt_height);

    cirrus_bitblt_reset(s);

    return 1;

}

/***************************************

 *

 *  bitblt (video-to-video)

 *

 ***************************************/

static int cirrus_bitblt_videotovideo_patterncopy(CirrusVGAState * s)

{

    return cirrus_bitblt_common_patterncopy(s,

                                            s->vga.vram_ptr + ((s->cirrus_blt_srcaddr & ~7) &

                                            s->cirrus_addr_mask));

}

static void cirrus_do_copy(CirrusVGAState *s, int dst, int src, int w, int h)

{

    int sx = 0, sy = 0;

    int dx = 0, dy = 0;

    int depth = 0;

    int notify = 0;

    /* make sure to only copy if it's a plain copy ROP */

    if (*s->cirrus_rop == cirrus_bitblt_rop_fwd_src ||

        *s->cirrus_rop == cirrus_bitblt_rop_bkwd_src) {

        int width, height;

        depth = s->vga.get_bpp(&s->vga) / 8;

        s->vga.get_resolution(&s->vga, &width, &height);

        /* extra x, y */

        sx = (src % ABS(s->cirrus_blt_srcpitch)) / depth;

        sy = (src / ABS(s->cirrus_blt_srcpitch));

        dx = (dst % ABS(s->cirrus_blt_dstpitch)) / depth;

        dy = (dst / ABS(s->cirrus_blt_dstpitch));

        /* normalize width */

        w /= depth;

        /* if we're doing a backward copy, we have to adjust

           our x/y to be the upper left corner (instead of the lower

           right corner) */

        if (s->cirrus_blt_dstpitch < 0) {

            sx -= (s->cirrus_blt_width / depth) - 1;

            dx -= (s->cirrus_blt_width / depth) - 1;

            sy -= s->cirrus_blt_height - 1;

            dy -= s->cirrus_blt_height - 1;

        }

        /* are we in the visible portion of memory? */

        if (sx >= 0 && sy >= 0 && dx >= 0 && dy >= 0 &&

            (sx + w) <= width && (sy + h) <= height &&

            (dx + w) <= width && (dy + h) <= height) {

            notify = 1;

        }

    }

    /* we have to flush all pending changes so that the copy

       is generated at the appropriate moment in time */

    if (notify)

        graphic_hw_update(s->vga.con);

    (*s->cirrus_rop) (s, s->vga.vram_ptr +

                      (s->cirrus_blt_dstaddr & s->cirrus_addr_mask),

                      s->vga.vram_ptr +

                      (s->cirrus_blt_srcaddr & s->cirrus_addr_mask),

                      s->cirrus_blt_dstpitch, s->cirrus_blt_srcpitch,

                      s->cirrus_blt_width, s->cirrus_blt_height);

    if (notify) {

        qemu_console_copy(s->vga.con,

                          sx, sy, dx, dy,

                          s->cirrus_blt_width / depth,

                          s->cirrus_blt_height);

    }

    /* we don't have to notify the display that this portion has

       changed since qemu_console_copy implies this */

    cirrus_invalidate_region(s, s->cirrus_blt_dstaddr,

                                s->cirrus_blt_dstpitch, s->cirrus_blt_width,

                                s->cirrus_blt_height);

}

static int cirrus_bitblt_videotovideo_copy(CirrusVGAState * s)

{

    if (BLTUNSAFE(s))

        return 0;

    cirrus_do_copy(s, s->cirrus_blt_dstaddr - s->vga.start_addr,

            s->cirrus_blt_srcaddr - s->vga.start_addr,

            s->cirrus_blt_width, s->cirrus_blt_height);

    return 1;

}

/***************************************

 *

 *  bitblt (cpu-to-video)

 *

 ***************************************/

static void cirrus_bitblt_cputovideo_next(CirrusVGAState * s)

{

    int copy_count;

    uint8_t *end_ptr;

    if (s->cirrus_srccounter > 0) {

        if (s->cirrus_blt_mode & CIRRUS_BLTMODE_PATTERNCOPY) {

            cirrus_bitblt_common_patterncopy(s, s->cirrus_bltbuf);

        the_end:

            s->cirrus_srccounter = 0;

            cirrus_bitblt_reset(s);

        } else {

            /* at least one scan line */

            do {

                (*s->cirrus_rop)(s, s->vga.vram_ptr +

                                 (s->cirrus_blt_dstaddr & s->cirrus_addr_mask),

                                  s->cirrus_bltbuf, 0, 0, s->cirrus_blt_width, 1);

                cirrus_invalidate_region(s, s->cirrus_blt_dstaddr, 0,

                                         s->cirrus_blt_width, 1);

                s->cirrus_blt_dstaddr += s->cirrus_blt_dstpitch;

                s->cirrus_srccounter -= s->cirrus_blt_srcpitch;

                if (s->cirrus_srccounter <= 0)

                    goto the_end;

                /* more bytes than needed can be transferred because of

                   word alignment, so we keep them for the next line */

                /* XXX: keep alignment to speed up transfer */

                end_ptr = s->cirrus_bltbuf + s->cirrus_blt_srcpitch;

                copy_count = s->cirrus_srcptr_end - end_ptr;

                memmove(s->cirrus_bltbuf, end_ptr, copy_count);

                s->cirrus_srcptr = s->cirrus_bltbuf + copy_count;

                s->cirrus_srcptr_end = s->cirrus_bltbuf + s->cirrus_blt_srcpitch;

            } while (s->cirrus_srcptr >= s->cirrus_srcptr_end);

        }

    }

}

/***************************************

 *

 *  bitblt wrapper

 *

 ***************************************/

static void cirrus_bitblt_reset(CirrusVGAState * s)

{

    int need_update;

    s->vga.gr[0x31] &=

        ~(CIRRUS_BLT_START | CIRRUS_BLT_BUSY | CIRRUS_BLT_FIFOUSED);

    need_update = s->cirrus_srcptr != &s->cirrus_bltbuf[0]

        || s->cirrus_srcptr_end != &s->cirrus_bltbuf[0];

    s->cirrus_srcptr = &s->cirrus_bltbuf[0];

    s->cirrus_srcptr_end = &s->cirrus_bltbuf[0];

    s->cirrus_srccounter = 0;

    if (!need_update)

        return;

    cirrus_update_memory_access(s);

}

static int cirrus_bitblt_cputovideo(CirrusVGAState * s)

{

    int w;

    s->cirrus_blt_mode &= ~CIRRUS_BLTMODE_MEMSYSSRC;

    s->cirrus_srcptr = &s->cirrus_bltbuf[0];

    s->cirrus_srcptr_end = &s->cirrus_bltbuf[0];

    if (s->cirrus_blt_mode & CIRRUS_BLTMODE_PATTERNCOPY) {

        if (s->cirrus_blt_mode & CIRRUS_BLTMODE_COLOREXPAND) {

            s->cirrus_blt_srcpitch = 8;

        } else {

            /* XXX: check for 24 bpp */

            s->cirrus_blt_srcpitch = 8 * 8 * s->cirrus_blt_pixelwidth;

        }

        s->cirrus_srccounter = s->cirrus_blt_srcpitch;

    } else {

        if (s->cirrus_blt_mode & CIRRUS_BLTMODE_COLOREXPAND) {

            w = s->cirrus_blt_width / s->cirrus_blt_pixelwidth;

            if (s->cirrus_blt_modeext & CIRRUS_BLTMODEEXT_DWORDGRANULARITY)

                s->cirrus_blt_srcpitch = ((w + 31) >> 5);

            else

                s->cirrus_blt_srcpitch = ((w + 7) >> 3);

        } else {

            /* always align input size to 32 bits */

            s->cirrus_blt_srcpitch = (s->cirrus_blt_width + 3) & ~3;

        }

        s->cirrus_srccounter = s->cirrus_blt_srcpitch * s->cirrus_blt_height;

    }

    s->cirrus_srcptr = s->cirrus_bltbuf;

    s->cirrus_srcptr_end = s->cirrus_bltbuf + s->cirrus_blt_srcpitch;

    cirrus_update_memory_access(s);

    return 1;

}

static int cirrus_bitblt_videotocpu(CirrusVGAState * s)

{

    /* XXX */

#ifdef DEBUG_BITBLT

    printf("cirrus: bitblt (video to cpu) is not implemented yet\n");

#endif

    return 0;

}

static int cirrus_bitblt_videotovideo(CirrusVGAState * s)

{

    int ret;

    if (s->cirrus_blt_mode & CIRRUS_BLTMODE_PATTERNCOPY) {

        ret = cirrus_bitblt_videotovideo_patterncopy(s);

    } else {

        ret = cirrus_bitblt_videotovideo_copy(s);

    }

    if (ret)

        cirrus_bitblt_reset(s);

    return ret;

}

static void cirrus_bitblt_start(CirrusVGAState * s)

{

    uint8_t blt_rop;

    s->vga.gr[0x31] |= CIRRUS_BLT_BUSY;

    s->cirrus_blt_width = (s->vga.gr[0x20] | (s->vga.gr[0x21] << 8)) + 1;

    s->cirrus_blt_height = (s->vga.gr[0x22] | (s->vga.gr[0x23] << 8)) + 1;

    s->cirrus_blt_dstpitch = (s->vga.gr[0x24] | (s->vga.gr[0x25] << 8));

    s->cirrus_blt_srcpitch = (s->vga.gr[0x26] | (s->vga.gr[0x27] << 8));