spice-common/qxl_dev.h

/*
   Copyright (C) 2009 Red Hat, Inc.

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions are
   met:

       * Redistributions of source code must retain the above copyright
         notice, this list of conditions and the following disclaimer.
       * Redistributions in binary form must reproduce the above copyright
         notice, this list of conditions and the following disclaimer in
         the documentation and/or other materials provided with the
         distribution.
       * Neither the name of the copyright holder nor the names of its
         contributors may be used to endorse or promote products derived
         from this software without specific prior written permission.

   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS
   IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
   TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
   PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/


#ifndef _H_QXL_DEV
#define _H_QXL_DEV

#include "ipc_ring.h"
#include "draw.h"

#ifdef __GNUC__
#ifdef __i386__
#define mb() __asm__ __volatile__ ("lock; addl $0,0(%%esp)": : :"memory")
#else
//mfence
#define mb() __asm__ __volatile__ ("lock; addl $0,0(%%rsp)": : :"memory")
#endif
#define ATTR_PACKED __attribute__ ((__packed__))
#else
#pragma pack(push)
#pragma pack(1)
#define ATTR_PACKED
#define mb() __asm {lock add [esp], 0}
#endif

#define REDHAT_PCI_VENDOR_ID 0x1b36
#define QXL_DEVICE_ID 0x0100 /* 0x100-0x11f reserved for spice */
#define QXL_REVISION 0x02

#define QXL_ROM_MAGIC (*(UINT32*)"QXRO")
#define QXL_RAM_MAGIC (*(UINT32*)"QXRA")

enum {
    QXL_RAM_RANGE_INDEX,
    QXL_VRAM_RANGE_INDEX,
    QXL_ROM_RANGE_INDEX,
    QXL_IO_RANGE_INDEX,

    QXL_PCI_RANGES
};

enum {
    QXL_IO_NOTIFY_CMD,
    QXL_IO_NOTIFY_CURSOR,
    QXL_IO_UPDATE_AREA,
    QXL_IO_UPDATE_IRQ,
    QXL_IO_NOTIFY_OOM,
    QXL_IO_RESET,
    QXL_IO_SET_MODE,
    QXL_IO_LOG,
    QXL_IO_MEMSLOT_ADD,
    QXL_IO_MEMSLOT_DEL,

    QXL_IO_RANGE_SIZE
};

typedef struct ATTR_PACKED QXLRom {
    UINT32 magic;
    UINT32 id;
    UINT32 update_id;
    UINT32 compression_level;
    UINT32 log_level;
    UINT32 mode;
    UINT32 modes_offset;
    UINT32 num_io_pages;
    UINT32 pages_offset;
    UINT32 draw_area_offset;
    UINT32 draw_area_size;
    UINT32 ram_header_offset;
    UINT32 mm_clock;
    UINT64 flags;
    UINT8 slots_start;
    UINT8 slots_end;
    UINT8 slot_gen_bits;
    UINT8 slot_id_bits;
    UINT8 slot_generation;
} QXLRom;

typedef struct ATTR_PACKED QXLMode {
    UINT32 id;
    UINT32 x_res;
    UINT32 y_res;
    UINT32 bits;
    UINT32 stride;
    UINT32 x_mili;
    UINT32 y_mili;
    UINT32 orientation;
} QXLMode;

typedef struct ATTR_PACKED QXLModes {
    UINT32 n_modes;
    QXLMode modes[0];
} QXLModes;

typedef UINT64 PHYSICAL;
typedef UINT32 QXLFIXED; //fixed 28.4

enum QXLCmdType {
    QXL_CMD_NOP,
    QXL_CMD_DRAW,
    QXL_CMD_UPDATE,
    QXL_CMD_CURSOR,
    QXL_CMD_MESSAGE,
};

typedef struct ATTR_PACKED QXLCommand {
    PHYSICAL data;
    UINT32 type;
    UINT32 ped;
} QXLCommand;


typedef struct ATTR_PACKED QXLMemSlot {
    UINT64 mem_start;
    UINT64 mem_end;
} QXLMemSlot;

RING_DECLARE(QXLCommandRing, QXLCommand, 32);
RING_DECLARE(QXLCursorRing, QXLCommand, 32);

RING_DECLARE(QXLReleaseRing, UINT64, 8);

#define QXL_LOG_BUF_SIZE 4096

#define QXL_INTERRUPT_DISPLAY (1 << 0)
#define QXL_INTERRUPT_CURSOR (1 << 1)

typedef struct ATTR_PACKED QXLRam {
    UINT32 magic;
    UINT32 int_pending;
    UINT32 int_mask;
    UINT8 log_buf[QXL_LOG_BUF_SIZE];
    QXLCommandRing cmd_ring;
    QXLCursorRing cursor_ring;
    QXLReleaseRing release_ring;
    Rect update_area;
    QXLMemSlot mem_slot;
    UINT64 flags;
} QXLRam;

typedef union QXLReleaseInfo {
    UINT64 id;      // in
    UINT64 next;    // out
} QXLReleaseInfo;

typedef struct  ATTR_PACKED QXLDataChunk {
    UINT32 data_size;
    PHYSICAL prev_chunk;
    PHYSICAL next_chunk;
    UINT8 data[0];
} QXLDataChunk;

typedef struct ATTR_PACKED QXLMessage {
    QXLReleaseInfo release_info;
    UINT8 data[0];
} QXLMessage;

typedef struct ATTR_PACKED QXLUpdateCmd {
    QXLReleaseInfo release_info;
    Rect area;
    UINT32 update_id;
} QXLUpdateCmd;

typedef struct ATTR_PACKED QXLCursor {
    CursorHeader header;
    UINT32 data_size;
    QXLDataChunk chunk;
} QXLCursor;

enum {
    QXL_CURSOR_SET,
    QXL_CURSOR_MOVE,
    QXL_CURSOR_HIDE,
    QXL_CURSOR_TRAIL,
};

#define QXL_CURSUR_DEVICE_DATA_SIZE 128

typedef struct ATTR_PACKED QXLCursorCmd {
    QXLReleaseInfo release_info;
    UINT8 type;
    union {
        struct ATTR_PACKED {
            Point16 position;
            UINT8 visible;
            PHYSICAL shape;
        } set;
        struct ATTR_PACKED {
            UINT16 length;
            UINT16 frequency;
        } trail;
        Point16 position;
    } u;
    UINT8 device_data[QXL_CURSUR_DEVICE_DATA_SIZE]; //todo: dynamic size from rom
} QXLCursorCmd;

enum {
    QXL_DRAW_NOP,
    QXL_DRAW_FILL,
    QXL_DRAW_OPAQUE,
    QXL_DRAW_COPY,
    QXL_COPY_BITS,
    QXL_DRAW_BLEND,
    QXL_DRAW_BLACKNESS,
    QXL_DRAW_WHITENESS,
    QXL_DRAW_INVERS,
    QXL_DRAW_ROP3,
    QXL_DRAW_STROKE,
    QXL_DRAW_TEXT,
    QXL_DRAW_TRANSPARENT,
    QXL_DRAW_ALPHA_BLEND,
};

typedef struct ATTR_PACKED QXLString {
    UINT32 data_size;
    UINT16 length;
    UINT16 flags;
    QXLDataChunk chunk;
} QXLString;

typedef struct ATTR_PACKED QXLCopyBits {
    Point src_pos;
} QXLCopyBits;

#define QXL_EFFECT_BLEND 0
#define QXL_EFFECT_OPAQUE 1
#define QXL_EFFECT_REVERT_ON_DUP 2
#define QXL_EFFECT_BLACKNESS_ON_DUP 3
#define QXL_EFFECT_WHITENESS_ON_DUP 4
#define QXL_EFFECT_NOP_ON_DUP 5
#define QXL_EFFECT_NOP 6
#define QXL_EFFECT_OPAQUE_BRUSH 7

typedef struct ATTR_PACKED QXLDrawable {
    QXLReleaseInfo release_info;
    UINT8 effect;
    UINT8 type;
    UINT16 bitmap_offset;
    Rect bitmap_area;
    Rect bbox;
    Clip clip;
    UINT32 mm_time;
    union {
        Fill fill;
        Opaque opaque;
        Copy copy;
        Transparent transparent;
        AlphaBlnd alpha_blend;
        QXLCopyBits copy_bits;
        Blend blend;
        Rop3 rop3;
        Stroke stroke;
        Text text;
        Blackness blackness;
        Invers invers;
        Whiteness whiteness;
    } u;
} QXLDrawable;

typedef struct ATTR_PACKED QXLClipRects {
    UINT32 num_rects;
    QXLDataChunk chunk;
} QXLClipRects;

enum {
    QXL_PATH_BEGIN = (1 << 0),
    QXL_PATH_END = (1 << 1),
    QXL_PATH_CLOSE = (1 << 3),
    QXL_PATH_BEZIER = (1 << 4),
};

typedef struct ATTR_PACKED QXLPath {
    UINT32 data_size;
    QXLDataChunk chunk;
} QXLPath;

enum {
    QXL_IMAGE_GROUP_DRIVER,
    QXL_IMAGE_GROUP_DEVICE,
    QXL_IMAGE_GROUP_RED,
    QXL_IMAGE_GROUP_DRIVER_DONT_CACHE,
};

typedef struct ATTR_PACKED QXLImageID {
    UINT32 group;
    UINT32 unique;
} QXLImageID;

enum {
    QXL_IMAGE_CACHE = (1 << 0),
};

enum {
    QXL_BITMAP_DIRECT = (1 << 0),
    QXL_BITMAP_UNSTABLE = (1 << 1),
    QXL_BITMAP_TOP_DOWN = (1 << 2), // == BITMAP_TOP_DOWN
};

#define QXL_SET_IMAGE_ID(image, _group, _unique) {              \
    UINT64* id_ptr = &(image)->descriptor.id;                   \
    QXLImageID *image_id = (QXLImageID *)id_ptr;                \
    image_id->group = _group;                                   \
    image_id->unique = _unique;                                 \
}

typedef struct ATTR_PACKED QXLImage {
    ImageDescriptor descriptor;
    union { // variable length
        Bitmap bitmap;
        QUICData quic;
    };
} QXLImage;

#ifndef __GNUC__
#pragma pack(pop)
#endif

#undef ATTR_PACKED

#endif