[mirror_ubuntu-bionic-kernel.git] / include / uapi / linux / virtio_gpu.h

/*
 * Virtio GPU Device
 *
 * Copyright Red Hat, Inc. 2013-2014
 *
 * Authors:
 *     Dave Airlie <airlied@redhat.com>
 *     Gerd Hoffmann <kraxel@redhat.com>
 *
 * This header is BSD licensed so anyone can use the definitions
 * to implement compatible drivers/servers:
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 * 3. Neither the name of IBM 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 HOLDERS 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 IBM 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 VIRTIO_GPU_HW_H
#define VIRTIO_GPU_HW_H

#include <linux/types.h>

enum virtio_gpu_ctrl_type {
	VIRTIO_GPU_UNDEFINED = 0,

	/* 2d commands */
	VIRTIO_GPU_CMD_GET_DISPLAY_INFO = 0x0100,
	VIRTIO_GPU_CMD_RESOURCE_CREATE_2D,
	VIRTIO_GPU_CMD_RESOURCE_UNREF,
	VIRTIO_GPU_CMD_SET_SCANOUT,
	VIRTIO_GPU_CMD_RESOURCE_FLUSH,
	VIRTIO_GPU_CMD_TRANSFER_TO_HOST_2D,
	VIRTIO_GPU_CMD_RESOURCE_ATTACH_BACKING,
	VIRTIO_GPU_CMD_RESOURCE_DETACH_BACKING,

	/* cursor commands */
	VIRTIO_GPU_CMD_UPDATE_CURSOR = 0x0300,
	VIRTIO_GPU_CMD_MOVE_CURSOR,

	/* success responses */
	VIRTIO_GPU_RESP_OK_NODATA = 0x1100,
	VIRTIO_GPU_RESP_OK_DISPLAY_INFO,

	/* error responses */
	VIRTIO_GPU_RESP_ERR_UNSPEC = 0x1200,
	VIRTIO_GPU_RESP_ERR_OUT_OF_MEMORY,
	VIRTIO_GPU_RESP_ERR_INVALID_SCANOUT_ID,
	VIRTIO_GPU_RESP_ERR_INVALID_RESOURCE_ID,
	VIRTIO_GPU_RESP_ERR_INVALID_CONTEXT_ID,
	VIRTIO_GPU_RESP_ERR_INVALID_PARAMETER,
};

#define VIRTIO_GPU_FLAG_FENCE (1 << 0)

struct virtio_gpu_ctrl_hdr {
	__le32 type;
	__le32 flags;
	__le64 fence_id;
	__le32 ctx_id;
	__le32 padding;
};

/* data passed in the cursor vq */

struct virtio_gpu_cursor_pos {
	__le32 scanout_id;
	__le32 x;
	__le32 y;
	__le32 padding;
};

/* VIRTIO_GPU_CMD_UPDATE_CURSOR, VIRTIO_GPU_CMD_MOVE_CURSOR */
struct virtio_gpu_update_cursor {
	struct virtio_gpu_ctrl_hdr hdr;
	struct virtio_gpu_cursor_pos pos;  /* update & move */
	__le32 resource_id;           /* update only */
	__le32 hot_x;                 /* update only */
	__le32 hot_y;                 /* update only */
	__le32 padding;
};

/* data passed in the control vq, 2d related */

struct virtio_gpu_rect {
	__le32 x;
	__le32 y;
	__le32 width;
	__le32 height;
};

/* VIRTIO_GPU_CMD_RESOURCE_UNREF */
struct virtio_gpu_resource_unref {
	struct virtio_gpu_ctrl_hdr hdr;
	__le32 resource_id;
	__le32 padding;
};

/* VIRTIO_GPU_CMD_RESOURCE_CREATE_2D: create a 2d resource with a format */
struct virtio_gpu_resource_create_2d {
	struct virtio_gpu_ctrl_hdr hdr;
	__le32 resource_id;
	__le32 format;
	__le32 width;
	__le32 height;
};

/* VIRTIO_GPU_CMD_SET_SCANOUT */
struct virtio_gpu_set_scanout {
	struct virtio_gpu_ctrl_hdr hdr;
	struct virtio_gpu_rect r;
	__le32 scanout_id;
	__le32 resource_id;
};

/* VIRTIO_GPU_CMD_RESOURCE_FLUSH */
struct virtio_gpu_resource_flush {
	struct virtio_gpu_ctrl_hdr hdr;
	struct virtio_gpu_rect r;
	__le32 resource_id;
	__le32 padding;
};

/* VIRTIO_GPU_CMD_TRANSFER_TO_HOST_2D: simple transfer to_host */
struct virtio_gpu_transfer_to_host_2d {
	struct virtio_gpu_ctrl_hdr hdr;
	struct virtio_gpu_rect r;
	__le64 offset;
	__le32 resource_id;
	__le32 padding;
};

struct virtio_gpu_mem_entry {
	__le64 addr;
	__le32 length;
	__le32 padding;
};

/* VIRTIO_GPU_CMD_RESOURCE_ATTACH_BACKING */
struct virtio_gpu_resource_attach_backing {
	struct virtio_gpu_ctrl_hdr hdr;
	__le32 resource_id;
	__le32 nr_entries;
};

/* VIRTIO_GPU_CMD_RESOURCE_DETACH_BACKING */
struct virtio_gpu_resource_detach_backing {
	struct virtio_gpu_ctrl_hdr hdr;
	__le32 resource_id;
	__le32 padding;
};

/* VIRTIO_GPU_RESP_OK_DISPLAY_INFO */
#define VIRTIO_GPU_MAX_SCANOUTS 16
struct virtio_gpu_resp_display_info {
	struct virtio_gpu_ctrl_hdr hdr;
	struct virtio_gpu_display_one {
		struct virtio_gpu_rect r;
		__le32 enabled;
		__le32 flags;
	} pmodes[VIRTIO_GPU_MAX_SCANOUTS];
};

#define VIRTIO_GPU_EVENT_DISPLAY (1 << 0)

struct virtio_gpu_config {
	__u32 events_read;
	__u32 events_clear;
	__u32 num_scanouts;
	__u32 reserved;
};

/* simple formats for fbcon/X use */
enum virtio_gpu_formats {
	VIRTIO_GPU_FORMAT_B8G8R8A8_UNORM  = 1,
	VIRTIO_GPU_FORMAT_B8G8R8X8_UNORM  = 2,
	VIRTIO_GPU_FORMAT_A8R8G8B8_UNORM  = 3,
	VIRTIO_GPU_FORMAT_X8R8G8B8_UNORM  = 4,

	VIRTIO_GPU_FORMAT_R8G8B8A8_UNORM  = 67,
	VIRTIO_GPU_FORMAT_X8B8G8R8_UNORM  = 68,

	VIRTIO_GPU_FORMAT_A8B8G8R8_UNORM  = 121,
	VIRTIO_GPU_FORMAT_R8G8B8X8_UNORM  = 134,
};

#endif
Commit	Line	Data
dc5698e8 DA	1	/*
	2	* Virtio GPU Device
	3	*
	4	* Copyright Red Hat, Inc. 2013-2014
	5	*
	6	* Authors:
	7	* Dave Airlie <airlied@redhat.com>
	8	* Gerd Hoffmann <kraxel@redhat.com>
	9	*
	10	* This header is BSD licensed so anyone can use the definitions
	11	* to implement compatible drivers/servers:
	12	*
	13	* Redistribution and use in source and binary forms, with or without
	14	* modification, are permitted provided that the following conditions
	15	* are met:
	16	* 1. Redistributions of source code must retain the above copyright
	17	* notice, this list of conditions and the following disclaimer.
	18	* 2. Redistributions in binary form must reproduce the above copyright
	19	* notice, this list of conditions and the following disclaimer in the
	20	* documentation and/or other materials provided with the distribution.
	21	* 3. Neither the name of IBM nor the names of its contributors
	22	* may be used to endorse or promote products derived from this software
	23	* without specific prior written permission.
	24	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	25	* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	26	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
	27	* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL IBM OR
	28	* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	29	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	30	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
	31	* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
	32	* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
	33	* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
	34	* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	35	* SUCH DAMAGE.
	36	*/
	37
	38	#ifndef VIRTIO_GPU_HW_H
	39	#define VIRTIO_GPU_HW_H
	40
ae455773 DA	41	#include <linux/types.h>
ae455773 DA	42
dc5698e8 DA	43	enum virtio_gpu_ctrl_type {
	44	VIRTIO_GPU_UNDEFINED = 0,
	45
	46	/* 2d commands */
	47	VIRTIO_GPU_CMD_GET_DISPLAY_INFO = 0x0100,
	48	VIRTIO_GPU_CMD_RESOURCE_CREATE_2D,
	49	VIRTIO_GPU_CMD_RESOURCE_UNREF,
	50	VIRTIO_GPU_CMD_SET_SCANOUT,
	51	VIRTIO_GPU_CMD_RESOURCE_FLUSH,
	52	VIRTIO_GPU_CMD_TRANSFER_TO_HOST_2D,
	53	VIRTIO_GPU_CMD_RESOURCE_ATTACH_BACKING,
	54	VIRTIO_GPU_CMD_RESOURCE_DETACH_BACKING,
	55
	56	/* cursor commands */
	57	VIRTIO_GPU_CMD_UPDATE_CURSOR = 0x0300,
	58	VIRTIO_GPU_CMD_MOVE_CURSOR,
	59
	60	/* success responses */
	61	VIRTIO_GPU_RESP_OK_NODATA = 0x1100,
	62	VIRTIO_GPU_RESP_OK_DISPLAY_INFO,
	63
	64	/* error responses */
	65	VIRTIO_GPU_RESP_ERR_UNSPEC = 0x1200,
	66	VIRTIO_GPU_RESP_ERR_OUT_OF_MEMORY,
	67	VIRTIO_GPU_RESP_ERR_INVALID_SCANOUT_ID,
	68	VIRTIO_GPU_RESP_ERR_INVALID_RESOURCE_ID,
	69	VIRTIO_GPU_RESP_ERR_INVALID_CONTEXT_ID,
	70	VIRTIO_GPU_RESP_ERR_INVALID_PARAMETER,
	71	};
	72
	73	#define VIRTIO_GPU_FLAG_FENCE (1 << 0)
	74
	75	struct virtio_gpu_ctrl_hdr {
	76	__le32 type;
	77	__le32 flags;
	78	__le64 fence_id;
	79	__le32 ctx_id;
	80	__le32 padding;
	81	};
	82
	83	/* data passed in the cursor vq */
	84
	85	struct virtio_gpu_cursor_pos {
	86	__le32 scanout_id;
	87	__le32 x;
	88	__le32 y;
	89	__le32 padding;
	90	};
	91
	92	/* VIRTIO_GPU_CMD_UPDATE_CURSOR, VIRTIO_GPU_CMD_MOVE_CURSOR */
	93	struct virtio_gpu_update_cursor {
	94	struct virtio_gpu_ctrl_hdr hdr;
	95	struct virtio_gpu_cursor_pos pos; /* update & move */
	96	__le32 resource_id; /* update only */
	97	__le32 hot_x; /* update only */
	98	__le32 hot_y; /* update only */
	99	__le32 padding;
	100	};
	101
	102	/* data passed in the control vq, 2d related */
	103
	104	struct virtio_gpu_rect {
	105	__le32 x;
	106	__le32 y;
107	__le32 width;
108	__le32 height;
109	};
110
111	/* VIRTIO_GPU_CMD_RESOURCE_UNREF */
112	struct virtio_gpu_resource_unref {
113	struct virtio_gpu_ctrl_hdr hdr;
114	__le32 resource_id;
115	__le32 padding;
116	};
117
118	/* VIRTIO_GPU_CMD_RESOURCE_CREATE_2D: create a 2d resource with a format */
119	struct virtio_gpu_resource_create_2d {
120	struct virtio_gpu_ctrl_hdr hdr;
121	__le32 resource_id;
122	__le32 format;
123	__le32 width;
124	__le32 height;
125	};
126
127	/* VIRTIO_GPU_CMD_SET_SCANOUT */
128	struct virtio_gpu_set_scanout {
129	struct virtio_gpu_ctrl_hdr hdr;
130	struct virtio_gpu_rect r;
131	__le32 scanout_id;
132	__le32 resource_id;
133	};
134
135	/* VIRTIO_GPU_CMD_RESOURCE_FLUSH */
136	struct virtio_gpu_resource_flush {
137	struct virtio_gpu_ctrl_hdr hdr;
138	struct virtio_gpu_rect r;
139	__le32 resource_id;
140	__le32 padding;
141	};
142
143	/* VIRTIO_GPU_CMD_TRANSFER_TO_HOST_2D: simple transfer to_host */
144	struct virtio_gpu_transfer_to_host_2d {
145	struct virtio_gpu_ctrl_hdr hdr;
146	struct virtio_gpu_rect r;
147	__le64 offset;
148	__le32 resource_id;
149	__le32 padding;
150	};
151
152	struct virtio_gpu_mem_entry {
153	__le64 addr;
154	__le32 length;
155	__le32 padding;
156	};
157
158	/* VIRTIO_GPU_CMD_RESOURCE_ATTACH_BACKING */
159	struct virtio_gpu_resource_attach_backing {
160	struct virtio_gpu_ctrl_hdr hdr;
161	__le32 resource_id;
162	__le32 nr_entries;
163	};
164
165	/* VIRTIO_GPU_CMD_RESOURCE_DETACH_BACKING */
166	struct virtio_gpu_resource_detach_backing {
167	struct virtio_gpu_ctrl_hdr hdr;
168	__le32 resource_id;
169	__le32 padding;
170	};
171
172	/* VIRTIO_GPU_RESP_OK_DISPLAY_INFO */
173	#define VIRTIO_GPU_MAX_SCANOUTS 16
174	struct virtio_gpu_resp_display_info {
175	struct virtio_gpu_ctrl_hdr hdr;
176	struct virtio_gpu_display_one {
177	struct virtio_gpu_rect r;
178	__le32 enabled;
179	__le32 flags;
180	} pmodes[VIRTIO_GPU_MAX_SCANOUTS];
181	};
182
183	#define VIRTIO_GPU_EVENT_DISPLAY (1 << 0)
184
185	struct virtio_gpu_config {
186	__u32 events_read;
187	__u32 events_clear;
188	__u32 num_scanouts;
189	__u32 reserved;
190	};
191
192	/* simple formats for fbcon/X use */
193	enum virtio_gpu_formats {
194	VIRTIO_GPU_FORMAT_B8G8R8A8_UNORM = 1,
195	VIRTIO_GPU_FORMAT_B8G8R8X8_UNORM = 2,
196	VIRTIO_GPU_FORMAT_A8R8G8B8_UNORM = 3,
197	VIRTIO_GPU_FORMAT_X8R8G8B8_UNORM = 4,
198
199	VIRTIO_GPU_FORMAT_R8G8B8A8_UNORM = 67,
200	VIRTIO_GPU_FORMAT_X8B8G8R8_UNORM = 68,
201
202	VIRTIO_GPU_FORMAT_A8B8G8R8_UNORM = 121,
203	VIRTIO_GPU_FORMAT_R8G8B8X8_UNORM = 134,
204	};
205
206	#endif