1 /*
2  * Copyright (C) 2015 Red Hat, Inc.
3  * All Rights Reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining
6  * a copy of this software and associated documentation files (the
7  * "Software"), to deal in the Software without restriction, including
8  * without limitation the rights to use, copy, modify, merge, publish,
9  * distribute, sublicense, and/or sell copies of the Software, and to
10  * permit persons to whom the Software is furnished to do so, subject to
11  * the following conditions:
12  *
13  * The above copyright notice and this permission notice (including the
14  * next paragraph) shall be included in all copies or substantial
15  * portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20  * IN NO EVENT SHALL THE COPYRIGHT OWNER(S) AND/OR ITS SUPPLIERS BE
21  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
22  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
23  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24  */
25 
26 #ifndef VIRTIO_DRV_H
27 #define VIRTIO_DRV_H
28 
29 #include <linux/virtio.h>
30 #include <linux/virtio_ids.h>
31 #include <linux/virtio_config.h>
32 #include <linux/virtio_gpu.h>
33 
34 #include <drm/drmP.h>
35 #include <drm/drm_gem.h>
36 #include <drm/drm_atomic.h>
37 #include <drm/drm_crtc_helper.h>
38 #include <drm/drm_encoder.h>
39 #include <drm/drm_fb_helper.h>
40 #include <drm/ttm/ttm_bo_api.h>
41 #include <drm/ttm/ttm_bo_driver.h>
42 #include <drm/ttm/ttm_placement.h>
43 #include <drm/ttm/ttm_module.h>
44 
45 #define DRIVER_NAME "virtio_gpu"
46 #define DRIVER_DESC "virtio GPU"
47 #define DRIVER_DATE "0"
48 
49 #define DRIVER_MAJOR 0
50 #define DRIVER_MINOR 0
51 #define DRIVER_PATCHLEVEL 1
52 
53 /* virtgpu_drm_bus.c */
54 int drm_virtio_init(struct drm_driver *driver, struct virtio_device *vdev);
55 
56 struct virtio_gpu_object {
57 	struct drm_gem_object gem_base;
58 	uint32_t hw_res_handle;
59 
60 	struct sg_table *pages;
61 	uint32_t mapped;
62 	void *vmap;
63 	bool dumb;
64 	struct ttm_place                placement_code;
65 	struct ttm_placement		placement;
66 	struct ttm_buffer_object	tbo;
67 	struct ttm_bo_kmap_obj		kmap;
68 	bool created;
69 };
70 #define gem_to_virtio_gpu_obj(gobj) \
71 	container_of((gobj), struct virtio_gpu_object, gem_base)
72 
73 struct virtio_gpu_vbuffer;
74 struct virtio_gpu_device;
75 
76 typedef void (*virtio_gpu_resp_cb)(struct virtio_gpu_device *vgdev,
77 				   struct virtio_gpu_vbuffer *vbuf);
78 
79 struct virtio_gpu_fence_driver {
80 	atomic64_t       last_seq;
81 	uint64_t         sync_seq;
82 	uint64_t         context;
83 	struct list_head fences;
84 	spinlock_t       lock;
85 };
86 
87 struct virtio_gpu_fence {
88 	struct dma_fence f;
89 	struct virtio_gpu_fence_driver *drv;
90 	struct list_head node;
91 	uint64_t seq;
92 };
93 #define to_virtio_fence(x) \
94 	container_of(x, struct virtio_gpu_fence, f)
95 
96 struct virtio_gpu_vbuffer {
97 	char *buf;
98 	int size;
99 
100 	void *data_buf;
101 	uint32_t data_size;
102 
103 	char *resp_buf;
104 	int resp_size;
105 
106 	virtio_gpu_resp_cb resp_cb;
107 
108 	struct list_head list;
109 };
110 
111 struct virtio_gpu_output {
112 	int index;
113 	struct drm_crtc crtc;
114 	struct drm_connector conn;
115 	struct drm_encoder enc;
116 	struct virtio_gpu_display_one info;
117 	struct virtio_gpu_update_cursor cursor;
118 	int cur_x;
119 	int cur_y;
120 	bool enabled;
121 };
122 #define drm_crtc_to_virtio_gpu_output(x) \
123 	container_of(x, struct virtio_gpu_output, crtc)
124 #define drm_connector_to_virtio_gpu_output(x) \
125 	container_of(x, struct virtio_gpu_output, conn)
126 #define drm_encoder_to_virtio_gpu_output(x) \
127 	container_of(x, struct virtio_gpu_output, enc)
128 
129 struct virtio_gpu_framebuffer {
130 	struct drm_framebuffer base;
131 	int x1, y1, x2, y2; /* dirty rect */
132 	spinlock_t dirty_lock;
133 	uint32_t hw_res_handle;
134 };
135 #define to_virtio_gpu_framebuffer(x) \
136 	container_of(x, struct virtio_gpu_framebuffer, base)
137 
138 struct virtio_gpu_fbdev {
139 	struct drm_fb_helper           helper;
140 	struct virtio_gpu_framebuffer  vgfb;
141 	struct virtio_gpu_device       *vgdev;
142 	struct delayed_work            work;
143 };
144 
145 struct virtio_gpu_mman {
146 	struct ttm_bo_device		bdev;
147 };
148 
149 struct virtio_gpu_fbdev;
150 
151 struct virtio_gpu_queue {
152 	struct virtqueue *vq;
153 	spinlock_t qlock;
154 	wait_queue_head_t ack_queue;
155 	struct work_struct dequeue_work;
156 };
157 
158 struct virtio_gpu_drv_capset {
159 	uint32_t id;
160 	uint32_t max_version;
161 	uint32_t max_size;
162 };
163 
164 struct virtio_gpu_drv_cap_cache {
165 	struct list_head head;
166 	void *caps_cache;
167 	uint32_t id;
168 	uint32_t version;
169 	uint32_t size;
170 	atomic_t is_valid;
171 };
172 
173 struct virtio_gpu_device {
174 	struct device *dev;
175 	struct drm_device *ddev;
176 
177 	struct virtio_device *vdev;
178 
179 	struct virtio_gpu_mman mman;
180 
181 	/* pointer to fbdev info structure */
182 	struct virtio_gpu_fbdev *vgfbdev;
183 	struct virtio_gpu_output outputs[VIRTIO_GPU_MAX_SCANOUTS];
184 	uint32_t num_scanouts;
185 
186 	struct virtio_gpu_queue ctrlq;
187 	struct virtio_gpu_queue cursorq;
188 	struct kmem_cache *vbufs;
189 	bool vqs_ready;
190 
191 	struct ida	resource_ida;
192 
193 	wait_queue_head_t resp_wq;
194 	/* current display info */
195 	spinlock_t display_info_lock;
196 	bool display_info_pending;
197 
198 	struct virtio_gpu_fence_driver fence_drv;
199 
200 	struct ida	ctx_id_ida;
201 
202 	bool has_virgl_3d;
203 
204 	struct work_struct config_changed_work;
205 
206 	struct virtio_gpu_drv_capset *capsets;
207 	uint32_t num_capsets;
208 	struct list_head cap_cache;
209 };
210 
211 struct virtio_gpu_fpriv {
212 	uint32_t ctx_id;
213 };
214 
215 /* virtio_ioctl.c */
216 #define DRM_VIRTIO_NUM_IOCTLS 10
217 extern struct drm_ioctl_desc virtio_gpu_ioctls[DRM_VIRTIO_NUM_IOCTLS];
218 
219 /* virtio_kms.c */
220 int virtio_gpu_driver_load(struct drm_device *dev, unsigned long flags);
221 void virtio_gpu_driver_unload(struct drm_device *dev);
222 int virtio_gpu_driver_open(struct drm_device *dev, struct drm_file *file);
223 void virtio_gpu_driver_postclose(struct drm_device *dev, struct drm_file *file);
224 
225 /* virtio_gem.c */
226 void virtio_gpu_gem_free_object(struct drm_gem_object *gem_obj);
227 int virtio_gpu_gem_init(struct virtio_gpu_device *vgdev);
228 void virtio_gpu_gem_fini(struct virtio_gpu_device *vgdev);
229 int virtio_gpu_gem_create(struct drm_file *file,
230 			  struct drm_device *dev,
231 			  uint64_t size,
232 			  struct drm_gem_object **obj_p,
233 			  uint32_t *handle_p);
234 int virtio_gpu_gem_object_open(struct drm_gem_object *obj,
235 			       struct drm_file *file);
236 void virtio_gpu_gem_object_close(struct drm_gem_object *obj,
237 				 struct drm_file *file);
238 struct virtio_gpu_object *virtio_gpu_alloc_object(struct drm_device *dev,
239 						  size_t size, bool kernel,
240 						  bool pinned);
241 int virtio_gpu_mode_dumb_create(struct drm_file *file_priv,
242 				struct drm_device *dev,
243 				struct drm_mode_create_dumb *args);
244 int virtio_gpu_mode_dumb_mmap(struct drm_file *file_priv,
245 			      struct drm_device *dev,
246 			      uint32_t handle, uint64_t *offset_p);
247 
248 /* virtio_fb */
249 #define VIRTIO_GPUFB_CONN_LIMIT 1
250 int virtio_gpu_fbdev_init(struct virtio_gpu_device *vgdev);
251 void virtio_gpu_fbdev_fini(struct virtio_gpu_device *vgdev);
252 int virtio_gpu_surface_dirty(struct virtio_gpu_framebuffer *qfb,
253 			     struct drm_clip_rect *clips,
254 			     unsigned int num_clips);
255 /* virtio vg */
256 int virtio_gpu_alloc_vbufs(struct virtio_gpu_device *vgdev);
257 void virtio_gpu_free_vbufs(struct virtio_gpu_device *vgdev);
258 void virtio_gpu_cmd_create_resource(struct virtio_gpu_device *vgdev,
259 				    struct virtio_gpu_object *bo,
260 				    uint32_t format,
261 				    uint32_t width,
262 				    uint32_t height);
263 void virtio_gpu_cmd_unref_resource(struct virtio_gpu_device *vgdev,
264 				   uint32_t resource_id);
265 void virtio_gpu_cmd_transfer_to_host_2d(struct virtio_gpu_device *vgdev,
266 					struct virtio_gpu_object *bo,
267 					uint64_t offset,
268 					__le32 width, __le32 height,
269 					__le32 x, __le32 y,
270 					struct virtio_gpu_fence **fence);
271 void virtio_gpu_cmd_resource_flush(struct virtio_gpu_device *vgdev,
272 				   uint32_t resource_id,
273 				   uint32_t x, uint32_t y,
274 				   uint32_t width, uint32_t height);
275 void virtio_gpu_cmd_set_scanout(struct virtio_gpu_device *vgdev,
276 				uint32_t scanout_id, uint32_t resource_id,
277 				uint32_t width, uint32_t height,
278 				uint32_t x, uint32_t y);
279 int virtio_gpu_object_attach(struct virtio_gpu_device *vgdev,
280 			     struct virtio_gpu_object *obj,
281 			     struct virtio_gpu_fence **fence);
282 void virtio_gpu_object_detach(struct virtio_gpu_device *vgdev,
283 			      struct virtio_gpu_object *obj);
284 int virtio_gpu_attach_status_page(struct virtio_gpu_device *vgdev);
285 int virtio_gpu_detach_status_page(struct virtio_gpu_device *vgdev);
286 void virtio_gpu_cursor_ping(struct virtio_gpu_device *vgdev,
287 			    struct virtio_gpu_output *output);
288 int virtio_gpu_cmd_get_display_info(struct virtio_gpu_device *vgdev);
289 int virtio_gpu_cmd_get_capset_info(struct virtio_gpu_device *vgdev, int idx);
290 int virtio_gpu_cmd_get_capset(struct virtio_gpu_device *vgdev,
291 			      int idx, int version,
292 			      struct virtio_gpu_drv_cap_cache **cache_p);
293 void virtio_gpu_cmd_context_create(struct virtio_gpu_device *vgdev, uint32_t id,
294 				   uint32_t nlen, const char *name);
295 void virtio_gpu_cmd_context_destroy(struct virtio_gpu_device *vgdev,
296 				    uint32_t id);
297 void virtio_gpu_cmd_context_attach_resource(struct virtio_gpu_device *vgdev,
298 					    uint32_t ctx_id,
299 					    uint32_t resource_id);
300 void virtio_gpu_cmd_context_detach_resource(struct virtio_gpu_device *vgdev,
301 					    uint32_t ctx_id,
302 					    uint32_t resource_id);
303 void virtio_gpu_cmd_submit(struct virtio_gpu_device *vgdev,
304 			   void *data, uint32_t data_size,
305 			   uint32_t ctx_id, struct virtio_gpu_fence **fence);
306 void virtio_gpu_cmd_transfer_from_host_3d(struct virtio_gpu_device *vgdev,
307 					  uint32_t resource_id, uint32_t ctx_id,
308 					  uint64_t offset, uint32_t level,
309 					  struct virtio_gpu_box *box,
310 					  struct virtio_gpu_fence **fence);
311 void virtio_gpu_cmd_transfer_to_host_3d(struct virtio_gpu_device *vgdev,
312 					struct virtio_gpu_object *bo,
313 					uint32_t ctx_id,
314 					uint64_t offset, uint32_t level,
315 					struct virtio_gpu_box *box,
316 					struct virtio_gpu_fence **fence);
317 void
318 virtio_gpu_cmd_resource_create_3d(struct virtio_gpu_device *vgdev,
319 				  struct virtio_gpu_object *bo,
320 				  struct virtio_gpu_resource_create_3d *rc_3d,
321 				  struct virtio_gpu_fence **fence);
322 void virtio_gpu_ctrl_ack(struct virtqueue *vq);
323 void virtio_gpu_cursor_ack(struct virtqueue *vq);
324 void virtio_gpu_fence_ack(struct virtqueue *vq);
325 void virtio_gpu_dequeue_ctrl_func(struct work_struct *work);
326 void virtio_gpu_dequeue_cursor_func(struct work_struct *work);
327 void virtio_gpu_dequeue_fence_func(struct work_struct *work);
328 
329 /* virtio_gpu_display.c */
330 int virtio_gpu_framebuffer_init(struct drm_device *dev,
331 				struct virtio_gpu_framebuffer *vgfb,
332 				const struct drm_mode_fb_cmd2 *mode_cmd,
333 				struct drm_gem_object *obj);
334 int virtio_gpu_modeset_init(struct virtio_gpu_device *vgdev);
335 void virtio_gpu_modeset_fini(struct virtio_gpu_device *vgdev);
336 
337 /* virtio_gpu_plane.c */
338 uint32_t virtio_gpu_translate_format(uint32_t drm_fourcc);
339 struct drm_plane *virtio_gpu_plane_init(struct virtio_gpu_device *vgdev,
340 					enum drm_plane_type type,
341 					int index);
342 
343 /* virtio_gpu_ttm.c */
344 int virtio_gpu_ttm_init(struct virtio_gpu_device *vgdev);
345 void virtio_gpu_ttm_fini(struct virtio_gpu_device *vgdev);
346 int virtio_gpu_mmap(struct file *filp, struct vm_area_struct *vma);
347 
348 /* virtio_gpu_fence.c */
349 int virtio_gpu_fence_emit(struct virtio_gpu_device *vgdev,
350 			  struct virtio_gpu_ctrl_hdr *cmd_hdr,
351 			  struct virtio_gpu_fence **fence);
352 void virtio_gpu_fence_event_process(struct virtio_gpu_device *vdev,
353 				    u64 last_seq);
354 
355 /* virtio_gpu_object */
356 int virtio_gpu_object_create(struct virtio_gpu_device *vgdev,
357 			     unsigned long size, bool kernel, bool pinned,
358 			     struct virtio_gpu_object **bo_ptr);
359 void virtio_gpu_object_kunmap(struct virtio_gpu_object *bo);
360 int virtio_gpu_object_kmap(struct virtio_gpu_object *bo);
361 int virtio_gpu_object_get_sg_table(struct virtio_gpu_device *qdev,
362 				   struct virtio_gpu_object *bo);
363 void virtio_gpu_object_free_sg_table(struct virtio_gpu_object *bo);
364 int virtio_gpu_object_wait(struct virtio_gpu_object *bo, bool no_wait);
365 
366 /* virtgpu_prime.c */
367 int virtgpu_gem_prime_pin(struct drm_gem_object *obj);
368 void virtgpu_gem_prime_unpin(struct drm_gem_object *obj);
369 struct sg_table *virtgpu_gem_prime_get_sg_table(struct drm_gem_object *obj);
370 struct drm_gem_object *virtgpu_gem_prime_import_sg_table(
371 	struct drm_device *dev, struct dma_buf_attachment *attach,
372 	struct sg_table *sgt);
373 void *virtgpu_gem_prime_vmap(struct drm_gem_object *obj);
374 void virtgpu_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
375 int virtgpu_gem_prime_mmap(struct drm_gem_object *obj,
376 			   struct vm_area_struct *vma);
377 
378 static inline struct virtio_gpu_object*
379 virtio_gpu_object_ref(struct virtio_gpu_object *bo)
380 {
381 	ttm_bo_get(&bo->tbo);
382 	return bo;
383 }
384 
385 static inline void virtio_gpu_object_unref(struct virtio_gpu_object **bo)
386 {
387 	struct ttm_buffer_object *tbo;
388 
389 	if ((*bo) == NULL)
390 		return;
391 	tbo = &((*bo)->tbo);
392 	ttm_bo_put(tbo);
393 	*bo = NULL;
394 }
395 
396 static inline u64 virtio_gpu_object_mmap_offset(struct virtio_gpu_object *bo)
397 {
398 	return drm_vma_node_offset_addr(&bo->tbo.vma_node);
399 }
400 
401 static inline int virtio_gpu_object_reserve(struct virtio_gpu_object *bo,
402 					 bool no_wait)
403 {
404 	int r;
405 
406 	r = ttm_bo_reserve(&bo->tbo, true, no_wait, NULL);
407 	if (unlikely(r != 0)) {
408 		if (r != -ERESTARTSYS) {
409 			struct virtio_gpu_device *qdev =
410 				bo->gem_base.dev->dev_private;
411 			dev_err(qdev->dev, "%p reserve failed\n", bo);
412 		}
413 		return r;
414 	}
415 	return 0;
416 }
417 
418 static inline void virtio_gpu_object_unreserve(struct virtio_gpu_object *bo)
419 {
420 	ttm_bo_unreserve(&bo->tbo);
421 }
422 
423 /* virgl debufs */
424 int virtio_gpu_debugfs_init(struct drm_minor *minor);
425 
426 #endif
427