[linux-2.6-block.git] / drivers / gpu / drm / qxl / qxl_drv.h

/*
 * Copyright 2013 Red Hat Inc.
 *
 * 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 COPYRIGHT HOLDER(S) OR AUTHOR(S) 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.
 *
 * Authors: Dave Airlie
 *          Alon Levy
 */

#ifndef QXL_DRV_H
#define QXL_DRV_H

/*
 * Definitions taken from spice-protocol, plus kernel driver specific bits.
 */

#include <linux/dma-fence.h>
#include <linux/workqueue.h>
#include <linux/firmware.h>
#include <linux/platform_device.h>

#include <drm/drm_crtc.h>
#include <drm/drm_encoder.h>
#include <drm/drm_fb_helper.h>
#include <drm/drm_gem.h>
#include <drm/drmP.h>
#include <drm/ttm/ttm_bo_api.h>
#include <drm/ttm/ttm_bo_driver.h>
/* just for ttm_validate_buffer */
#include <drm/ttm/ttm_execbuf_util.h>
#include <drm/ttm/ttm_module.h>
#include <drm/ttm/ttm_placement.h>
#include <drm/qxl_drm.h>

#include "qxl_dev.h"

#define DRIVER_AUTHOR		"Dave Airlie"

#define DRIVER_NAME		"qxl"
#define DRIVER_DESC		"RH QXL"
#define DRIVER_DATE		"20120117"

#define DRIVER_MAJOR 0
#define DRIVER_MINOR 1
#define DRIVER_PATCHLEVEL 0

#define QXL_DEBUGFS_MAX_COMPONENTS		32

extern int qxl_num_crtc;
extern int qxl_max_ioctls;

#define DRM_FILE_OFFSET 0x100000000ULL
#define DRM_FILE_PAGE_OFFSET (DRM_FILE_OFFSET >> PAGE_SHIFT)

#define QXL_INTERRUPT_MASK (\
	QXL_INTERRUPT_DISPLAY |\
	QXL_INTERRUPT_CURSOR |\
	QXL_INTERRUPT_IO_CMD |\
	QXL_INTERRUPT_CLIENT_MONITORS_CONFIG)

struct qxl_bo {
	/* Protected by gem.mutex */
	struct list_head		list;
	/* Protected by tbo.reserved */
	struct ttm_place		placements[3];
	struct ttm_placement		placement;
	struct ttm_buffer_object	tbo;
	struct ttm_bo_kmap_obj		kmap;
	unsigned int pin_count;
	void				*kptr;
	int                             type;

	/* Constant after initialization */
	struct drm_gem_object		gem_base;
	unsigned int is_primary:1; /* is this now a primary surface */
	unsigned int is_dumb:1;
	struct qxl_bo *shadow;
	unsigned int hw_surf_alloc:1;
	struct qxl_surface surf;
	uint32_t surface_id;
	struct qxl_release *surf_create;
};
#define gem_to_qxl_bo(gobj) container_of((gobj), struct qxl_bo, gem_base)
#define to_qxl_bo(tobj) container_of((tobj), struct qxl_bo, tbo)

struct qxl_gem {
	struct mutex		mutex;
	struct list_head	objects;
};

struct qxl_bo_list {
	struct ttm_validate_buffer tv;
};

struct qxl_crtc {
	struct drm_crtc base;
	int index;

	struct qxl_bo *cursor_bo;
};

struct qxl_output {
	int index;
	struct drm_connector base;
	struct drm_encoder enc;
};

#define to_qxl_crtc(x) container_of(x, struct qxl_crtc, base)
#define drm_connector_to_qxl_output(x) container_of(x, struct qxl_output, base)
#define drm_encoder_to_qxl_output(x) container_of(x, struct qxl_output, enc)

struct qxl_mman {
	struct ttm_bo_device		bdev;
};

struct qxl_memslot {
	uint8_t		generation;
	uint64_t	start_phys_addr;
	uint64_t	end_phys_addr;
	uint64_t	high_bits;
};

enum {
	QXL_RELEASE_DRAWABLE,
	QXL_RELEASE_SURFACE_CMD,
	QXL_RELEASE_CURSOR_CMD,
};

/* drm_ prefix to differentiate from qxl_release_info in
 * spice-protocol/qxl_dev.h */
#define QXL_MAX_RES 96
struct qxl_release {
	struct dma_fence base;

	int id;
	int type;
	struct qxl_bo *release_bo;
	uint32_t release_offset;
	uint32_t surface_release_id;
	struct ww_acquire_ctx ticket;
	struct list_head bos;
};

struct qxl_drm_chunk {
	struct list_head head;
	struct qxl_bo *bo;
};

struct qxl_drm_image {
	struct qxl_bo *bo;
	struct list_head chunk_list;
};

struct qxl_fb_image {
	struct qxl_device *qdev;
	uint32_t pseudo_palette[16];
	struct fb_image fb_image;
	uint32_t visual;
};

struct qxl_draw_fill {
	struct qxl_device *qdev;
	struct qxl_rect rect;
	uint32_t color;
	uint16_t rop;
};

/*
 * Debugfs
 */
struct qxl_debugfs {
	struct drm_info_list	*files;
	unsigned int num_files;
};

int qxl_debugfs_add_files(struct qxl_device *rdev,
			     struct drm_info_list *files,
			     unsigned int nfiles);
int qxl_debugfs_fence_init(struct qxl_device *rdev);

struct qxl_device;

struct qxl_device {
	struct drm_device ddev;

	resource_size_t vram_base, vram_size;
	resource_size_t surfaceram_base, surfaceram_size;
	resource_size_t rom_base, rom_size;
	struct qxl_rom *rom;

	struct qxl_mode *modes;
	struct qxl_bo *monitors_config_bo;
	struct qxl_monitors_config *monitors_config;

	/* last received client_monitors_config */
	struct qxl_monitors_config *client_monitors_config;

	int io_base;
	void *ram;
	struct qxl_mman		mman;
	struct qxl_gem		gem;

	struct drm_fb_helper	fb_helper;

	void *ram_physical;

	struct qxl_ring *release_ring;
	struct qxl_ring *command_ring;
	struct qxl_ring *cursor_ring;

	struct qxl_ram_header *ram_header;

	unsigned int primary_created:1;

	struct qxl_memslot	*mem_slots;
	uint8_t		n_mem_slots;

	uint8_t		main_mem_slot;
	uint8_t		surfaces_mem_slot;
	uint8_t		slot_id_bits;
	uint8_t		slot_gen_bits;
	uint64_t	va_slot_mask;

	spinlock_t	release_lock;
	struct idr	release_idr;
	uint32_t	release_seqno;
	spinlock_t release_idr_lock;
	struct mutex	async_io_mutex;
	unsigned int last_sent_io_cmd;

	/* interrupt handling */
	atomic_t irq_received;
	atomic_t irq_received_display;
	atomic_t irq_received_cursor;
	atomic_t irq_received_io_cmd;
	unsigned int irq_received_error;
	wait_queue_head_t display_event;
	wait_queue_head_t cursor_event;
	wait_queue_head_t io_cmd_event;
	struct work_struct client_monitors_config_work;

	/* debugfs */
	struct qxl_debugfs	debugfs[QXL_DEBUGFS_MAX_COMPONENTS];
	unsigned int debugfs_count;

	struct mutex		update_area_mutex;

	struct idr	surf_id_idr;
	spinlock_t surf_id_idr_lock;
	int last_alloced_surf_id;

	struct mutex surf_evict_mutex;
	struct io_mapping *vram_mapping;
	struct io_mapping *surface_mapping;

	/* */
	struct mutex release_mutex;
	struct qxl_bo *current_release_bo[3];
	int current_release_bo_offset[3];

	struct work_struct gc_work;

	struct drm_property *hotplug_mode_update_property;
	int monitors_config_width;
	int monitors_config_height;
};

extern const struct drm_ioctl_desc qxl_ioctls[];
extern int qxl_max_ioctl;

int qxl_device_init(struct qxl_device *qdev, struct drm_driver *drv,
		    struct pci_dev *pdev);
void qxl_device_fini(struct qxl_device *qdev);

int qxl_modeset_init(struct qxl_device *qdev);
void qxl_modeset_fini(struct qxl_device *qdev);

int qxl_bo_init(struct qxl_device *qdev);
void qxl_bo_fini(struct qxl_device *qdev);

void qxl_reinit_memslots(struct qxl_device *qdev);
int qxl_surf_evict(struct qxl_device *qdev);
int qxl_vram_evict(struct qxl_device *qdev);

struct qxl_ring *qxl_ring_create(struct qxl_ring_header *header,
				 int element_size,
				 int n_elements,
				 int prod_notify,
				 bool set_prod_notify,
				 wait_queue_head_t *push_event);
void qxl_ring_free(struct qxl_ring *ring);
void qxl_ring_init_hdr(struct qxl_ring *ring);
int qxl_check_idle(struct qxl_ring *ring);

static inline uint64_t
qxl_bo_physical_address(struct qxl_device *qdev, struct qxl_bo *bo,
			unsigned long offset)
{
	int slot_id = bo->type == QXL_GEM_DOMAIN_VRAM ? qdev->main_mem_slot : qdev->surfaces_mem_slot;
	struct qxl_memslot *slot = &(qdev->mem_slots[slot_id]);

	/* TODO - need to hold one of the locks to read tbo.offset */
	return slot->high_bits | (bo->tbo.offset + offset);
}

/* qxl_fb.c */
#define QXLFB_CONN_LIMIT 1

int qxl_fbdev_init(struct qxl_device *qdev);
void qxl_fbdev_fini(struct qxl_device *qdev);

/* qxl_display.c */
void qxl_display_read_client_monitors_config(struct qxl_device *qdev);
int qxl_create_monitors_object(struct qxl_device *qdev);
int qxl_destroy_monitors_object(struct qxl_device *qdev);

/* qxl_gem.c */
void qxl_gem_init(struct qxl_device *qdev);
void qxl_gem_fini(struct qxl_device *qdev);
int qxl_gem_object_create(struct qxl_device *qdev, int size,
			  int alignment, int initial_domain,
			  bool discardable, bool kernel,
			  struct qxl_surface *surf,
			  struct drm_gem_object **obj);
int qxl_gem_object_create_with_handle(struct qxl_device *qdev,
				      struct drm_file *file_priv,
				      u32 domain,
				      size_t size,
				      struct qxl_surface *surf,
				      struct qxl_bo **qobj,
				      uint32_t *handle);
void qxl_gem_object_free(struct drm_gem_object *gobj);
int qxl_gem_object_open(struct drm_gem_object *obj, struct drm_file *file_priv);
void qxl_gem_object_close(struct drm_gem_object *obj,
			  struct drm_file *file_priv);
void qxl_bo_force_delete(struct qxl_device *qdev);
int qxl_bo_kmap(struct qxl_bo *bo, void **ptr);

/* qxl_dumb.c */
int qxl_mode_dumb_create(struct drm_file *file_priv,
			 struct drm_device *dev,
			 struct drm_mode_create_dumb *args);
int qxl_mode_dumb_mmap(struct drm_file *filp,
		       struct drm_device *dev,
		       uint32_t handle, uint64_t *offset_p);

/* qxl ttm */
int qxl_ttm_init(struct qxl_device *qdev);
void qxl_ttm_fini(struct qxl_device *qdev);
int qxl_mmap(struct file *filp, struct vm_area_struct *vma);

/* qxl image */

int qxl_image_init(struct qxl_device *qdev,
		   struct qxl_release *release,
		   struct qxl_drm_image *dimage,
		   const uint8_t *data,
		   int x, int y, int width, int height,
		   int depth, int stride);
int
qxl_image_alloc_objects(struct qxl_device *qdev,
			struct qxl_release *release,
			struct qxl_drm_image **image_ptr,
			int height, int stride);
void qxl_image_free_objects(struct qxl_device *qdev, struct qxl_drm_image *dimage);

void qxl_update_screen(struct qxl_device *qxl);

/* qxl io operations (qxl_cmd.c) */

void qxl_io_create_primary(struct qxl_device *qdev,
			   unsigned int offset,
			   struct qxl_bo *bo);
void qxl_io_destroy_primary(struct qxl_device *qdev);
void qxl_io_memslot_add(struct qxl_device *qdev, uint8_t id);
void qxl_io_notify_oom(struct qxl_device *qdev);

int qxl_io_update_area(struct qxl_device *qdev, struct qxl_bo *surf,
		       const struct qxl_rect *area);

void qxl_io_reset(struct qxl_device *qdev);
void qxl_io_monitors_config(struct qxl_device *qdev);
int qxl_ring_push(struct qxl_ring *ring, const void *new_elt, bool interruptible);
void qxl_io_flush_release(struct qxl_device *qdev);
void qxl_io_flush_surfaces(struct qxl_device *qdev);

union qxl_release_info *qxl_release_map(struct qxl_device *qdev,
					struct qxl_release *release);
void qxl_release_unmap(struct qxl_device *qdev,
		       struct qxl_release *release,
		       union qxl_release_info *info);
int qxl_release_list_add(struct qxl_release *release, struct qxl_bo *bo);
int qxl_release_reserve_list(struct qxl_release *release, bool no_intr);
void qxl_release_backoff_reserve_list(struct qxl_release *release);
void qxl_release_fence_buffer_objects(struct qxl_release *release);

int qxl_alloc_surface_release_reserved(struct qxl_device *qdev,
				       enum qxl_surface_cmd_type surface_cmd_type,
				       struct qxl_release *create_rel,
				       struct qxl_release **release);
int qxl_alloc_release_reserved(struct qxl_device *qdev, unsigned long size,
			       int type, struct qxl_release **release,
			       struct qxl_bo **rbo);

int
qxl_push_command_ring_release(struct qxl_device *qdev, struct qxl_release *release,
			      uint32_t type, bool interruptible);
int
qxl_push_cursor_ring_release(struct qxl_device *qdev, struct qxl_release *release,
			     uint32_t type, bool interruptible);
int qxl_alloc_bo_reserved(struct qxl_device *qdev,
			  struct qxl_release *release,
			  unsigned long size,
			  struct qxl_bo **_bo);
/* qxl drawing commands */

void qxl_draw_opaque_fb(const struct qxl_fb_image *qxl_fb_image,
			int stride /* filled in if 0 */);

void qxl_draw_dirty_fb(struct qxl_device *qdev,
		       struct drm_framebuffer *fb,
		       struct qxl_bo *bo,
		       unsigned int flags, unsigned int color,
		       struct drm_clip_rect *clips,
		       unsigned int num_clips, int inc);

void qxl_draw_fill(struct qxl_draw_fill *qxl_draw_fill_rec);

void qxl_draw_copyarea(struct qxl_device *qdev,
		       u32 width, u32 height,
		       u32 sx, u32 sy,
		       u32 dx, u32 dy);

void qxl_release_free(struct qxl_device *qdev,
		      struct qxl_release *release);

/* used by qxl_debugfs_release */
struct qxl_release *qxl_release_from_id_locked(struct qxl_device *qdev,
						   uint64_t id);

bool qxl_queue_garbage_collect(struct qxl_device *qdev, bool flush);
int qxl_garbage_collect(struct qxl_device *qdev);

/* debugfs */

int qxl_debugfs_init(struct drm_minor *minor);
int qxl_ttm_debugfs_init(struct qxl_device *qdev);

/* qxl_prime.c */
int qxl_gem_prime_pin(struct drm_gem_object *obj);
void qxl_gem_prime_unpin(struct drm_gem_object *obj);
struct sg_table *qxl_gem_prime_get_sg_table(struct drm_gem_object *obj);
struct drm_gem_object *qxl_gem_prime_import_sg_table(
	struct drm_device *dev, struct dma_buf_attachment *attach,
	struct sg_table *sgt);
void *qxl_gem_prime_vmap(struct drm_gem_object *obj);
void qxl_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
int qxl_gem_prime_mmap(struct drm_gem_object *obj,
				struct vm_area_struct *vma);

/* qxl_irq.c */
int qxl_irq_init(struct qxl_device *qdev);
irqreturn_t qxl_irq_handler(int irq, void *arg);

/* qxl_fb.c */
bool qxl_fbdev_qobj_is_fb(struct qxl_device *qdev, struct qxl_bo *qobj);

int qxl_debugfs_add_files(struct qxl_device *qdev,
			  struct drm_info_list *files,
			  unsigned int nfiles);

int qxl_surface_id_alloc(struct qxl_device *qdev,
			 struct qxl_bo *surf);
void qxl_surface_id_dealloc(struct qxl_device *qdev,
			    uint32_t surface_id);
int qxl_hw_surface_alloc(struct qxl_device *qdev,
			 struct qxl_bo *surf);
int qxl_hw_surface_dealloc(struct qxl_device *qdev,
			   struct qxl_bo *surf);

int qxl_bo_check_id(struct qxl_device *qdev, struct qxl_bo *bo);

struct qxl_drv_surface *
qxl_surface_lookup(struct drm_device *dev, int surface_id);
void qxl_surface_evict(struct qxl_device *qdev, struct qxl_bo *surf, bool freeing);

#endif
Commit	Line	Data
f64122c1 DA	1	/*
	2	* Copyright 2013 Red Hat Inc.
	3	*
	4	* Permission is hereby granted, free of charge, to any person obtaining a
	5	* copy of this software and associated documentation files (the "Software"),
	6	* to deal in the Software without restriction, including without limitation
	7	* the rights to use, copy, modify, merge, publish, distribute, sublicense,
	8	* and/or sell copies of the Software, and to permit persons to whom the
	9	* Software is furnished to do so, subject to the following conditions:
	10	*
	11	* The above copyright notice and this permission notice shall be included in
	12	* all copies or substantial portions of the Software.
	13	*
	14	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	15	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	16	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	17	* THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
	18	* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
	19	* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
	20	* OTHER DEALINGS IN THE SOFTWARE.
	21	*
	22	* Authors: Dave Airlie
	23	* Alon Levy
	24	*/
	25
f64122c1 DA	26	#ifndef QXL_DRV_H
	27	#define QXL_DRV_H
	28
	29	/*
	30	* Definitions taken from spice-protocol, plus kernel driver specific bits.
	31	*/
	32
f54d1867	33	#include <linux/dma-fence.h>
f64122c1 DA	34	#include <linux/workqueue.h>
	35	#include <linux/firmware.h>
	36	#include <linux/platform_device.h>
	37
edaf492c	38	#include <drm/drm_crtc.h>
9338203c	39	#include <drm/drm_encoder.h>
bf8744e4	40	#include <drm/drm_fb_helper.h>
d9fc9413	41	#include <drm/drm_gem.h>
edaf492c MY	42	#include <drm/drmP.h>
	43	#include <drm/ttm/ttm_bo_api.h>
	44	#include <drm/ttm/ttm_bo_driver.h>
8002db63	45	/* just for ttm_validate_buffer */
edaf492c MY	46	#include <drm/ttm/ttm_execbuf_util.h>
	47	#include <drm/ttm/ttm_module.h>
	48	#include <drm/ttm/ttm_placement.h>
f64122c1	49	#include <drm/qxl_drm.h>
edaf492c	50
f64122c1 DA	51	#include "qxl_dev.h"
	52
	53	#define DRIVER_AUTHOR "Dave Airlie"
	54
	55	#define DRIVER_NAME "qxl"
	56	#define DRIVER_DESC "RH QXL"
	57	#define DRIVER_DATE "20120117"
	58
	59	#define DRIVER_MAJOR 0
	60	#define DRIVER_MINOR 1
	61	#define DRIVER_PATCHLEVEL 0
	62
f64122c1 DA	63	#define QXL_DEBUGFS_MAX_COMPONENTS 32
f64122c1 DA	64
07f8d9bd	65	extern int qxl_num_crtc;
747fddd4	66	extern int qxl_max_ioctls;
f64122c1	67
f64122c1 DA	68	#define DRM_FILE_OFFSET 0x100000000ULL
	69	#define DRM_FILE_PAGE_OFFSET (DRM_FILE_OFFSET >> PAGE_SHIFT)
	70
	71	#define QXL_INTERRUPT_MASK (\
	72	QXL_INTERRUPT_DISPLAY \|\
	73	QXL_INTERRUPT_CURSOR \|\
	74	QXL_INTERRUPT_IO_CMD \|\
	75	QXL_INTERRUPT_CLIENT_MONITORS_CONFIG)
	76
f64122c1 DA	77	struct qxl_bo {
	78	/* Protected by gem.mutex */
	79	struct list_head list;
	80	/* Protected by tbo.reserved */
f1217ed0	81	struct ttm_place placements[3];
f64122c1 DA	82	struct ttm_placement placement;
	83	struct ttm_buffer_object tbo;
	84	struct ttm_bo_kmap_obj kmap;
1b000494	85	unsigned int pin_count;
f64122c1 DA	86	void *kptr;
f64122c1 DA	87	int type;
2f453ed4	88
f64122c1 DA	89	/* Constant after initialization */
f64122c1 DA	90	struct drm_gem_object gem_base;
94feeaaf SLM	91	unsigned int is_primary:1; /* is this now a primary surface */
94feeaaf SLM	92	unsigned int is_dumb:1;
62676d10	93	struct qxl_bo *shadow;
94feeaaf	94	unsigned int hw_surf_alloc:1;
f64122c1 DA	95	struct qxl_surface surf;
f64122c1 DA	96	uint32_t surface_id;
f64122c1	97	struct qxl_release *surf_create;
f64122c1 DA	98	};
f64122c1 DA	99	#define gem_to_qxl_bo(gobj) container_of((gobj), struct qxl_bo, gem_base)
8002db63	100	#define to_qxl_bo(tobj) container_of((tobj), struct qxl_bo, tbo)
f64122c1 DA	101
	102	struct qxl_gem {
	103	struct mutex mutex;
	104	struct list_head objects;
	105	};
	106
	107	struct qxl_bo_list {
8002db63	108	struct ttm_validate_buffer tv;
f64122c1 DA	109	};
	110
	111	struct qxl_crtc {
	112	struct drm_crtc base;
07f8d9bd	113	int index;
9428088c RS	114
9428088c RS	115	struct qxl_bo *cursor_bo;
f64122c1 DA	116	};
	117
	118	struct qxl_output {
	119	int index;
	120	struct drm_connector base;
	121	struct drm_encoder enc;
	122	};
	123
f64122c1 DA	124	#define to_qxl_crtc(x) container_of(x, struct qxl_crtc, base)
f64122c1 DA	125	#define drm_connector_to_qxl_output(x) container_of(x, struct qxl_output, base)
07f8d9bd	126	#define drm_encoder_to_qxl_output(x) container_of(x, struct qxl_output, enc)
f64122c1 DA	127
f64122c1 DA	128	struct qxl_mman {
f64122c1 DA	129	struct ttm_bo_device bdev;
	130	};
	131
f64122c1 DA	132	struct qxl_memslot {
	133	uint8_t generation;
	134	uint64_t start_phys_addr;
	135	uint64_t end_phys_addr;
	136	uint64_t high_bits;
	137	};
	138
	139	enum {
	140	QXL_RELEASE_DRAWABLE,
	141	QXL_RELEASE_SURFACE_CMD,
	142	QXL_RELEASE_CURSOR_CMD,
	143	};
	144
	145	/* drm_ prefix to differentiate from qxl_release_info in
	146	* spice-protocol/qxl_dev.h */
	147	#define QXL_MAX_RES 96
	148	struct qxl_release {
f54d1867	149	struct dma_fence base;
2f453ed4	150
f64122c1 DA	151	int id;
f64122c1 DA	152	int type;
7a31805b	153	struct qxl_bo *release_bo;
f64122c1 DA	154	uint32_t release_offset;
f64122c1 DA	155	uint32_t surface_release_id;
8002db63 DA	156	struct ww_acquire_ctx ticket;
	157	struct list_head bos;
	158	};
	159
	160	struct qxl_drm_chunk {
	161	struct list_head head;
	162	struct qxl_bo *bo;
	163	};
	164
	165	struct qxl_drm_image {
	166	struct qxl_bo *bo;
	167	struct list_head chunk_list;
f64122c1 DA	168	};
	169
	170	struct qxl_fb_image {
	171	struct qxl_device *qdev;
	172	uint32_t pseudo_palette[16];
	173	struct fb_image fb_image;
	174	uint32_t visual;
	175	};
	176
	177	struct qxl_draw_fill {
	178	struct qxl_device *qdev;
	179	struct qxl_rect rect;
	180	uint32_t color;
	181	uint16_t rop;
	182	};
	183
	184	/*
	185	* Debugfs
	186	*/
	187	struct qxl_debugfs {
	188	struct drm_info_list *files;
1b000494	189	unsigned int num_files;
f64122c1 DA	190	};
	191
	192	int qxl_debugfs_add_files(struct qxl_device *rdev,
	193	struct drm_info_list *files,
1b000494	194	unsigned int nfiles);
f64122c1	195	int qxl_debugfs_fence_init(struct qxl_device *rdev);
f64122c1 DA	196
	197	struct qxl_device;
	198
	199	struct qxl_device {
cbdded7f	200	struct drm_device ddev;
f64122c1 DA	201
	202	resource_size_t vram_base, vram_size;
	203	resource_size_t surfaceram_base, surfaceram_size;
	204	resource_size_t rom_base, rom_size;
	205	struct qxl_rom *rom;
	206
	207	struct qxl_mode *modes;
	208	struct qxl_bo *monitors_config_bo;
	209	struct qxl_monitors_config *monitors_config;
	210
	211	/* last received client_monitors_config */
	212	struct qxl_monitors_config *client_monitors_config;
	213
	214	int io_base;
	215	void *ram;
	216	struct qxl_mman mman;
	217	struct qxl_gem gem;
f64122c1	218
bf8744e4 PW	219	struct drm_fb_helper fb_helper;
bf8744e4 PW	220
f64122c1 DA	221	void *ram_physical;
	222
	223	struct qxl_ring *release_ring;
	224	struct qxl_ring *command_ring;
	225	struct qxl_ring *cursor_ring;
	226
	227	struct qxl_ram_header *ram_header;
f64122c1	228
94feeaaf	229	unsigned int primary_created:1;
f64122c1 DA	230
	231	struct qxl_memslot *mem_slots;
	232	uint8_t n_mem_slots;
	233
	234	uint8_t main_mem_slot;
	235	uint8_t surfaces_mem_slot;
	236	uint8_t slot_id_bits;
	237	uint8_t slot_gen_bits;
	238	uint64_t va_slot_mask;
	239
2f453ed4	240	spinlock_t release_lock;
f64122c1	241	struct idr release_idr;
2f453ed4	242	uint32_t release_seqno;
f64122c1 DA	243	spinlock_t release_idr_lock;
	244	struct mutex async_io_mutex;
	245	unsigned int last_sent_io_cmd;
	246
	247	/* interrupt handling */
	248	atomic_t irq_received;
	249	atomic_t irq_received_display;
	250	atomic_t irq_received_cursor;
	251	atomic_t irq_received_io_cmd;
1b000494	252	unsigned int irq_received_error;
f64122c1 DA	253	wait_queue_head_t display_event;
	254	wait_queue_head_t cursor_event;
	255	wait_queue_head_t io_cmd_event;
	256	struct work_struct client_monitors_config_work;
	257
	258	/* debugfs */
	259	struct qxl_debugfs debugfs[QXL_DEBUGFS_MAX_COMPONENTS];
1b000494	260	unsigned int debugfs_count;
f64122c1 DA	261
	262	struct mutex update_area_mutex;
	263
	264	struct idr surf_id_idr;
	265	spinlock_t surf_id_idr_lock;
	266	int last_alloced_surf_id;
	267
	268	struct mutex surf_evict_mutex;
	269	struct io_mapping *vram_mapping;
	270	struct io_mapping *surface_mapping;
	271
	272	/* */
	273	struct mutex release_mutex;
	274	struct qxl_bo *current_release_bo[3];
	275	int current_release_bo_offset[3];
	276
f64122c1 DA	277	struct work_struct gc_work;
f64122c1 DA	278
4695b039	279	struct drm_property *hotplug_mode_update_property;
bd3e1c7c JJ	280	int monitors_config_width;
bd3e1c7c JJ	281	int monitors_config_height;
f64122c1 DA	282	};
f64122c1 DA	283
baa70943	284	extern const struct drm_ioctl_desc qxl_ioctls[];
f64122c1 DA	285	extern int qxl_max_ioctl;
f64122c1 DA	286
cbdded7f	287	int qxl_device_init(struct qxl_device qdev, struct drm_driver drv,
aa5b62ba	288	struct pci_dev *pdev);
2b65d567 GKB	289	void qxl_device_fini(struct qxl_device *qdev);
2b65d567 GKB	290
f64122c1 DA	291	int qxl_modeset_init(struct qxl_device *qdev);
	292	void qxl_modeset_fini(struct qxl_device *qdev);
	293
	294	int qxl_bo_init(struct qxl_device *qdev);
	295	void qxl_bo_fini(struct qxl_device *qdev);
	296
c9fdda2a	297	void qxl_reinit_memslots(struct qxl_device *qdev);
b86487a6	298	int qxl_surf_evict(struct qxl_device *qdev);
d84300bf	299	int qxl_vram_evict(struct qxl_device *qdev);
c9fdda2a	300
f64122c1 DA	301	struct qxl_ring qxl_ring_create(struct qxl_ring_header header,
	302	int element_size,
	303	int n_elements,
	304	int prod_notify,
	305	bool set_prod_notify,
	306	wait_queue_head_t *push_event);
	307	void qxl_ring_free(struct qxl_ring *ring);
1e209117 DA	308	void qxl_ring_init_hdr(struct qxl_ring *ring);
1e209117 DA	309	int qxl_check_idle(struct qxl_ring *ring);
f64122c1	310
f64122c1 DA	311	static inline uint64_t
	312	qxl_bo_physical_address(struct qxl_device qdev, struct qxl_bo bo,
	313	unsigned long offset)
	314	{
	315	int slot_id = bo->type == QXL_GEM_DOMAIN_VRAM ? qdev->main_mem_slot : qdev->surfaces_mem_slot;
	316	struct qxl_memslot *slot = &(qdev->mem_slots[slot_id]);
	317
	318	/* TODO - need to hold one of the locks to read tbo.offset */
	319	return slot->high_bits \| (bo->tbo.offset + offset);
	320	}
	321
	322	/* qxl_fb.c */
	323	#define QXLFB_CONN_LIMIT 1
	324
	325	int qxl_fbdev_init(struct qxl_device *qdev);
	326	void qxl_fbdev_fini(struct qxl_device *qdev);
f64122c1 DA	327
f64122c1 DA	328	/* qxl_display.c */
f64122c1	329	void qxl_display_read_client_monitors_config(struct qxl_device *qdev);
2bd6ce84 DA	330	int qxl_create_monitors_object(struct qxl_device *qdev);
2bd6ce84 DA	331	int qxl_destroy_monitors_object(struct qxl_device *qdev);
f64122c1	332
f64122c1	333	/* qxl_gem.c */
ae4b9a09	334	void qxl_gem_init(struct qxl_device *qdev);
f64122c1 DA	335	void qxl_gem_fini(struct qxl_device *qdev);
	336	int qxl_gem_object_create(struct qxl_device *qdev, int size,
	337	int alignment, int initial_domain,
	338	bool discardable, bool kernel,
	339	struct qxl_surface *surf,
	340	struct drm_gem_object **obj);
f64122c1 DA	341	int qxl_gem_object_create_with_handle(struct qxl_device *qdev,
	342	struct drm_file *file_priv,
	343	u32 domain,
	344	size_t size,
	345	struct qxl_surface *surf,
	346	struct qxl_bo **qobj,
	347	uint32_t *handle);
f64122c1 DA	348	void qxl_gem_object_free(struct drm_gem_object *gobj);
	349	int qxl_gem_object_open(struct drm_gem_object obj, struct drm_file file_priv);
	350	void qxl_gem_object_close(struct drm_gem_object *obj,
	351	struct drm_file *file_priv);
	352	void qxl_bo_force_delete(struct qxl_device *qdev);
	353	int qxl_bo_kmap(struct qxl_bo bo, void *ptr);
	354
	355	/* qxl_dumb.c */
	356	int qxl_mode_dumb_create(struct drm_file *file_priv,
	357	struct drm_device *dev,
	358	struct drm_mode_create_dumb *args);
f64122c1 DA	359	int qxl_mode_dumb_mmap(struct drm_file *filp,
	360	struct drm_device *dev,
	361	uint32_t handle, uint64_t *offset_p);
	362
f64122c1 DA	363	/* qxl ttm */
	364	int qxl_ttm_init(struct qxl_device *qdev);
	365	void qxl_ttm_fini(struct qxl_device *qdev);
	366	int qxl_mmap(struct file filp, struct vm_area_struct vma);
	367
	368	/* qxl image */
	369
8002db63 DA	370	int qxl_image_init(struct qxl_device *qdev,
	371	struct qxl_release *release,
	372	struct qxl_drm_image *dimage,
	373	const uint8_t *data,
	374	int x, int y, int width, int height,
	375	int depth, int stride);
	376	int
	377	qxl_image_alloc_objects(struct qxl_device *qdev,
	378	struct qxl_release *release,
	379	struct qxl_drm_image **image_ptr,
	380	int height, int stride);
	381	void qxl_image_free_objects(struct qxl_device qdev, struct qxl_drm_image dimage);
	382
f64122c1 DA	383	void qxl_update_screen(struct qxl_device *qxl);
	384
	385	/* qxl io operations (qxl_cmd.c) */
	386
	387	void qxl_io_create_primary(struct qxl_device *qdev,
1b000494	388	unsigned int offset,
f64122c1 DA	389	struct qxl_bo *bo);
	390	void qxl_io_destroy_primary(struct qxl_device *qdev);
	391	void qxl_io_memslot_add(struct qxl_device *qdev, uint8_t id);
	392	void qxl_io_notify_oom(struct qxl_device *qdev);
	393
	394	int qxl_io_update_area(struct qxl_device qdev, struct qxl_bo surf,
	395	const struct qxl_rect *area);
	396
	397	void qxl_io_reset(struct qxl_device *qdev);
	398	void qxl_io_monitors_config(struct qxl_device *qdev);
	399	int qxl_ring_push(struct qxl_ring ring, const void new_elt, bool interruptible);
	400	void qxl_io_flush_release(struct qxl_device *qdev);
	401	void qxl_io_flush_surfaces(struct qxl_device *qdev);
	402
f64122c1 DA	403	union qxl_release_info qxl_release_map(struct qxl_device qdev,
	404	struct qxl_release *release);
	405	void qxl_release_unmap(struct qxl_device *qdev,
	406	struct qxl_release *release,
	407	union qxl_release_info *info);
8002db63 DA	408	int qxl_release_list_add(struct qxl_release release, struct qxl_bo bo);
	409	int qxl_release_reserve_list(struct qxl_release *release, bool no_intr);
	410	void qxl_release_backoff_reserve_list(struct qxl_release *release);
	411	void qxl_release_fence_buffer_objects(struct qxl_release *release);
f64122c1 DA	412
	413	int qxl_alloc_surface_release_reserved(struct qxl_device *qdev,
	414	enum qxl_surface_cmd_type surface_cmd_type,
	415	struct qxl_release *create_rel,
	416	struct qxl_release **release);
	417	int qxl_alloc_release_reserved(struct qxl_device *qdev, unsigned long size,
	418	int type, struct qxl_release **release,
	419	struct qxl_bo **rbo);
8002db63	420
f64122c1 DA	421	int
	422	qxl_push_command_ring_release(struct qxl_device qdev, struct qxl_release release,
	423	uint32_t type, bool interruptible);
	424	int
	425	qxl_push_cursor_ring_release(struct qxl_device qdev, struct qxl_release release,
	426	uint32_t type, bool interruptible);
8002db63 DA	427	int qxl_alloc_bo_reserved(struct qxl_device *qdev,
	428	struct qxl_release *release,
	429	unsigned long size,
f64122c1 DA	430	struct qxl_bo **_bo);
	431	/* qxl drawing commands */
	432
	433	void qxl_draw_opaque_fb(const struct qxl_fb_image *qxl_fb_image,
	434	int stride /* filled in if 0 */);
	435
	436	void qxl_draw_dirty_fb(struct qxl_device *qdev,
bf8744e4	437	struct drm_framebuffer *fb,
f64122c1	438	struct qxl_bo *bo,
1b000494	439	unsigned int flags, unsigned int color,
f64122c1	440	struct drm_clip_rect *clips,
1b000494	441	unsigned int num_clips, int inc);
f64122c1 DA	442
	443	void qxl_draw_fill(struct qxl_draw_fill *qxl_draw_fill_rec);
	444
	445	void qxl_draw_copyarea(struct qxl_device *qdev,
	446	u32 width, u32 height,
	447	u32 sx, u32 sy,
	448	u32 dx, u32 dy);
	449
f64122c1 DA	450	void qxl_release_free(struct qxl_device *qdev,
f64122c1 DA	451	struct qxl_release *release);
8002db63	452
f64122c1 DA	453	/* used by qxl_debugfs_release */
	454	struct qxl_release qxl_release_from_id_locked(struct qxl_device qdev,
	455	uint64_t id);
	456
	457	bool qxl_queue_garbage_collect(struct qxl_device *qdev, bool flush);
	458	int qxl_garbage_collect(struct qxl_device *qdev);
	459
	460	/* debugfs */
	461
	462	int qxl_debugfs_init(struct drm_minor *minor);
2b65d567	463	int qxl_ttm_debugfs_init(struct qxl_device *qdev);
f64122c1	464
47c12968 AP	465	/* qxl_prime.c */
	466	int qxl_gem_prime_pin(struct drm_gem_object *obj);
	467	void qxl_gem_prime_unpin(struct drm_gem_object *obj);
	468	struct sg_table qxl_gem_prime_get_sg_table(struct drm_gem_object obj);
	469	struct drm_gem_object *qxl_gem_prime_import_sg_table(
b5e9c1a2	470	struct drm_device dev, struct dma_buf_attachment attach,
47c12968 AP	471	struct sg_table *sgt);
	472	void qxl_gem_prime_vmap(struct drm_gem_object obj);
	473	void qxl_gem_prime_vunmap(struct drm_gem_object obj, void vaddr);
	474	int qxl_gem_prime_mmap(struct drm_gem_object *obj,
	475	struct vm_area_struct *vma);
	476
f64122c1 DA	477	/* qxl_irq.c */
f64122c1 DA	478	int qxl_irq_init(struct qxl_device *qdev);
e9f0d76f	479	irqreturn_t qxl_irq_handler(int irq, void *arg);
f64122c1 DA	480
f64122c1 DA	481	/* qxl_fb.c */
b86487a6	482	bool qxl_fbdev_qobj_is_fb(struct qxl_device qdev, struct qxl_bo qobj);
f64122c1 DA	483
	484	int qxl_debugfs_add_files(struct qxl_device *qdev,
	485	struct drm_info_list *files,
1b000494	486	unsigned int nfiles);
f64122c1 DA	487
	488	int qxl_surface_id_alloc(struct qxl_device *qdev,
	489	struct qxl_bo *surf);
	490	void qxl_surface_id_dealloc(struct qxl_device *qdev,
	491	uint32_t surface_id);
	492	int qxl_hw_surface_alloc(struct qxl_device *qdev,
edd38a1e	493	struct qxl_bo *surf);
f64122c1 DA	494	int qxl_hw_surface_dealloc(struct qxl_device *qdev,
	495	struct qxl_bo *surf);
	496
	497	int qxl_bo_check_id(struct qxl_device qdev, struct qxl_bo bo);
	498
	499	struct qxl_drv_surface *
	500	qxl_surface_lookup(struct drm_device *dev, int surface_id);
	501	void qxl_surface_evict(struct qxl_device qdev, struct qxl_bo surf, bool freeing);
f64122c1	502
f64122c1	503	#endif