Merge remote-tracking branch 'drm/drm-next' into drm-misc-next
[sfrench/cifs-2.6.git] / drivers / gpu / drm / virtio / virtgpu_drv.h
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 1
51 #define DRIVER_PATCHLEVEL 0
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         struct edid *edid;
119         int cur_x;
120         int cur_y;
121         bool enabled;
122 };
123 #define drm_crtc_to_virtio_gpu_output(x) \
124         container_of(x, struct virtio_gpu_output, crtc)
125 #define drm_connector_to_virtio_gpu_output(x) \
126         container_of(x, struct virtio_gpu_output, conn)
127 #define drm_encoder_to_virtio_gpu_output(x) \
128         container_of(x, struct virtio_gpu_output, enc)
129
130 struct virtio_gpu_framebuffer {
131         struct drm_framebuffer base;
132         int x1, y1, x2, y2; /* dirty rect */
133         spinlock_t dirty_lock;
134         uint32_t hw_res_handle;
135         struct virtio_gpu_fence *fence;
136 };
137 #define to_virtio_gpu_framebuffer(x) \
138         container_of(x, struct virtio_gpu_framebuffer, base)
139
140 struct virtio_gpu_fbdev {
141         struct drm_fb_helper           helper;
142         struct virtio_gpu_framebuffer  vgfb;
143         struct virtio_gpu_device       *vgdev;
144         struct delayed_work            work;
145 };
146
147 struct virtio_gpu_mman {
148         struct ttm_bo_device            bdev;
149 };
150
151 struct virtio_gpu_fbdev;
152
153 struct virtio_gpu_queue {
154         struct virtqueue *vq;
155         spinlock_t qlock;
156         wait_queue_head_t ack_queue;
157         struct work_struct dequeue_work;
158 };
159
160 struct virtio_gpu_drv_capset {
161         uint32_t id;
162         uint32_t max_version;
163         uint32_t max_size;
164 };
165
166 struct virtio_gpu_drv_cap_cache {
167         struct list_head head;
168         void *caps_cache;
169         uint32_t id;
170         uint32_t version;
171         uint32_t size;
172         atomic_t is_valid;
173 };
174
175 struct virtio_gpu_device {
176         struct device *dev;
177         struct drm_device *ddev;
178
179         struct virtio_device *vdev;
180
181         struct virtio_gpu_mman mman;
182
183         /* pointer to fbdev info structure */
184         struct virtio_gpu_fbdev *vgfbdev;
185         struct virtio_gpu_output outputs[VIRTIO_GPU_MAX_SCANOUTS];
186         uint32_t num_scanouts;
187
188         struct virtio_gpu_queue ctrlq;
189         struct virtio_gpu_queue cursorq;
190         struct kmem_cache *vbufs;
191         bool vqs_ready;
192
193         struct ida      resource_ida;
194
195         wait_queue_head_t resp_wq;
196         /* current display info */
197         spinlock_t display_info_lock;
198         bool display_info_pending;
199
200         struct virtio_gpu_fence_driver fence_drv;
201
202         struct ida      ctx_id_ida;
203
204         bool has_virgl_3d;
205         bool has_edid;
206
207         struct work_struct config_changed_work;
208
209         struct virtio_gpu_drv_capset *capsets;
210         uint32_t num_capsets;
211         struct list_head cap_cache;
212 };
213
214 struct virtio_gpu_fpriv {
215         uint32_t ctx_id;
216 };
217
218 /* virtio_ioctl.c */
219 #define DRM_VIRTIO_NUM_IOCTLS 10
220 extern struct drm_ioctl_desc virtio_gpu_ioctls[DRM_VIRTIO_NUM_IOCTLS];
221
222 /* virtio_kms.c */
223 int virtio_gpu_driver_load(struct drm_device *dev, unsigned long flags);
224 void virtio_gpu_driver_unload(struct drm_device *dev);
225 int virtio_gpu_driver_open(struct drm_device *dev, struct drm_file *file);
226 void virtio_gpu_driver_postclose(struct drm_device *dev, struct drm_file *file);
227
228 /* virtio_gem.c */
229 void virtio_gpu_gem_free_object(struct drm_gem_object *gem_obj);
230 int virtio_gpu_gem_init(struct virtio_gpu_device *vgdev);
231 void virtio_gpu_gem_fini(struct virtio_gpu_device *vgdev);
232 int virtio_gpu_gem_create(struct drm_file *file,
233                           struct drm_device *dev,
234                           uint64_t size,
235                           struct drm_gem_object **obj_p,
236                           uint32_t *handle_p);
237 int virtio_gpu_gem_object_open(struct drm_gem_object *obj,
238                                struct drm_file *file);
239 void virtio_gpu_gem_object_close(struct drm_gem_object *obj,
240                                  struct drm_file *file);
241 struct virtio_gpu_object *virtio_gpu_alloc_object(struct drm_device *dev,
242                                                   size_t size, bool kernel,
243                                                   bool pinned);
244 int virtio_gpu_mode_dumb_create(struct drm_file *file_priv,
245                                 struct drm_device *dev,
246                                 struct drm_mode_create_dumb *args);
247 int virtio_gpu_mode_dumb_mmap(struct drm_file *file_priv,
248                               struct drm_device *dev,
249                               uint32_t handle, uint64_t *offset_p);
250
251 /* virtio_fb */
252 #define VIRTIO_GPUFB_CONN_LIMIT 1
253 int virtio_gpu_fbdev_init(struct virtio_gpu_device *vgdev);
254 void virtio_gpu_fbdev_fini(struct virtio_gpu_device *vgdev);
255 int virtio_gpu_surface_dirty(struct virtio_gpu_framebuffer *qfb,
256                              struct drm_clip_rect *clips,
257                              unsigned int num_clips);
258 /* virtio vg */
259 int virtio_gpu_alloc_vbufs(struct virtio_gpu_device *vgdev);
260 void virtio_gpu_free_vbufs(struct virtio_gpu_device *vgdev);
261 void virtio_gpu_cmd_create_resource(struct virtio_gpu_device *vgdev,
262                                     struct virtio_gpu_object *bo,
263                                     uint32_t format,
264                                     uint32_t width,
265                                     uint32_t height);
266 void virtio_gpu_cmd_unref_resource(struct virtio_gpu_device *vgdev,
267                                    uint32_t resource_id);
268 void virtio_gpu_cmd_transfer_to_host_2d(struct virtio_gpu_device *vgdev,
269                                         struct virtio_gpu_object *bo,
270                                         uint64_t offset,
271                                         __le32 width, __le32 height,
272                                         __le32 x, __le32 y,
273                                         struct virtio_gpu_fence *fence);
274 void virtio_gpu_cmd_resource_flush(struct virtio_gpu_device *vgdev,
275                                    uint32_t resource_id,
276                                    uint32_t x, uint32_t y,
277                                    uint32_t width, uint32_t height);
278 void virtio_gpu_cmd_set_scanout(struct virtio_gpu_device *vgdev,
279                                 uint32_t scanout_id, uint32_t resource_id,
280                                 uint32_t width, uint32_t height,
281                                 uint32_t x, uint32_t y);
282 int virtio_gpu_object_attach(struct virtio_gpu_device *vgdev,
283                              struct virtio_gpu_object *obj,
284                              struct virtio_gpu_fence *fence);
285 void virtio_gpu_object_detach(struct virtio_gpu_device *vgdev,
286                               struct virtio_gpu_object *obj);
287 int virtio_gpu_attach_status_page(struct virtio_gpu_device *vgdev);
288 int virtio_gpu_detach_status_page(struct virtio_gpu_device *vgdev);
289 void virtio_gpu_cursor_ping(struct virtio_gpu_device *vgdev,
290                             struct virtio_gpu_output *output);
291 int virtio_gpu_cmd_get_display_info(struct virtio_gpu_device *vgdev);
292 int virtio_gpu_cmd_get_capset_info(struct virtio_gpu_device *vgdev, int idx);
293 int virtio_gpu_cmd_get_capset(struct virtio_gpu_device *vgdev,
294                               int idx, int version,
295                               struct virtio_gpu_drv_cap_cache **cache_p);
296 int virtio_gpu_cmd_get_edids(struct virtio_gpu_device *vgdev);
297 void virtio_gpu_cmd_context_create(struct virtio_gpu_device *vgdev, uint32_t id,
298                                    uint32_t nlen, const char *name);
299 void virtio_gpu_cmd_context_destroy(struct virtio_gpu_device *vgdev,
300                                     uint32_t id);
301 void virtio_gpu_cmd_context_attach_resource(struct virtio_gpu_device *vgdev,
302                                             uint32_t ctx_id,
303                                             uint32_t resource_id);
304 void virtio_gpu_cmd_context_detach_resource(struct virtio_gpu_device *vgdev,
305                                             uint32_t ctx_id,
306                                             uint32_t resource_id);
307 void virtio_gpu_cmd_submit(struct virtio_gpu_device *vgdev,
308                            void *data, uint32_t data_size,
309                            uint32_t ctx_id, struct virtio_gpu_fence *fence);
310 void virtio_gpu_cmd_transfer_from_host_3d(struct virtio_gpu_device *vgdev,
311                                           uint32_t resource_id, uint32_t ctx_id,
312                                           uint64_t offset, uint32_t level,
313                                           struct virtio_gpu_box *box,
314                                           struct virtio_gpu_fence *fence);
315 void virtio_gpu_cmd_transfer_to_host_3d(struct virtio_gpu_device *vgdev,
316                                         struct virtio_gpu_object *bo,
317                                         uint32_t ctx_id,
318                                         uint64_t offset, uint32_t level,
319                                         struct virtio_gpu_box *box,
320                                         struct virtio_gpu_fence *fence);
321 void
322 virtio_gpu_cmd_resource_create_3d(struct virtio_gpu_device *vgdev,
323                                   struct virtio_gpu_object *bo,
324                                   struct virtio_gpu_resource_create_3d *rc_3d);
325 void virtio_gpu_ctrl_ack(struct virtqueue *vq);
326 void virtio_gpu_cursor_ack(struct virtqueue *vq);
327 void virtio_gpu_fence_ack(struct virtqueue *vq);
328 void virtio_gpu_dequeue_ctrl_func(struct work_struct *work);
329 void virtio_gpu_dequeue_cursor_func(struct work_struct *work);
330 void virtio_gpu_dequeue_fence_func(struct work_struct *work);
331
332 /* virtio_gpu_display.c */
333 int virtio_gpu_framebuffer_init(struct drm_device *dev,
334                                 struct virtio_gpu_framebuffer *vgfb,
335                                 const struct drm_mode_fb_cmd2 *mode_cmd,
336                                 struct drm_gem_object *obj);
337 int virtio_gpu_modeset_init(struct virtio_gpu_device *vgdev);
338 void virtio_gpu_modeset_fini(struct virtio_gpu_device *vgdev);
339
340 /* virtio_gpu_plane.c */
341 uint32_t virtio_gpu_translate_format(uint32_t drm_fourcc);
342 struct drm_plane *virtio_gpu_plane_init(struct virtio_gpu_device *vgdev,
343                                         enum drm_plane_type type,
344                                         int index);
345
346 /* virtio_gpu_ttm.c */
347 int virtio_gpu_ttm_init(struct virtio_gpu_device *vgdev);
348 void virtio_gpu_ttm_fini(struct virtio_gpu_device *vgdev);
349 int virtio_gpu_mmap(struct file *filp, struct vm_area_struct *vma);
350
351 /* virtio_gpu_fence.c */
352 struct virtio_gpu_fence *virtio_gpu_fence_alloc(
353         struct virtio_gpu_device *vgdev);
354 void virtio_gpu_fence_cleanup(struct virtio_gpu_fence *fence);
355 int virtio_gpu_fence_emit(struct virtio_gpu_device *vgdev,
356                           struct virtio_gpu_ctrl_hdr *cmd_hdr,
357                           struct virtio_gpu_fence *fence);
358 void virtio_gpu_fence_event_process(struct virtio_gpu_device *vdev,
359                                     u64 last_seq);
360
361 /* virtio_gpu_object */
362 int virtio_gpu_object_create(struct virtio_gpu_device *vgdev,
363                              unsigned long size, bool kernel, bool pinned,
364                              struct virtio_gpu_object **bo_ptr);
365 void virtio_gpu_object_kunmap(struct virtio_gpu_object *bo);
366 int virtio_gpu_object_kmap(struct virtio_gpu_object *bo);
367 int virtio_gpu_object_get_sg_table(struct virtio_gpu_device *qdev,
368                                    struct virtio_gpu_object *bo);
369 void virtio_gpu_object_free_sg_table(struct virtio_gpu_object *bo);
370 int virtio_gpu_object_wait(struct virtio_gpu_object *bo, bool no_wait);
371
372 /* virtgpu_prime.c */
373 int virtgpu_gem_prime_pin(struct drm_gem_object *obj);
374 void virtgpu_gem_prime_unpin(struct drm_gem_object *obj);
375 struct sg_table *virtgpu_gem_prime_get_sg_table(struct drm_gem_object *obj);
376 struct drm_gem_object *virtgpu_gem_prime_import_sg_table(
377         struct drm_device *dev, struct dma_buf_attachment *attach,
378         struct sg_table *sgt);
379 void *virtgpu_gem_prime_vmap(struct drm_gem_object *obj);
380 void virtgpu_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
381 int virtgpu_gem_prime_mmap(struct drm_gem_object *obj,
382                            struct vm_area_struct *vma);
383
384 static inline struct virtio_gpu_object*
385 virtio_gpu_object_ref(struct virtio_gpu_object *bo)
386 {
387         ttm_bo_get(&bo->tbo);
388         return bo;
389 }
390
391 static inline void virtio_gpu_object_unref(struct virtio_gpu_object **bo)
392 {
393         struct ttm_buffer_object *tbo;
394
395         if ((*bo) == NULL)
396                 return;
397         tbo = &((*bo)->tbo);
398         ttm_bo_put(tbo);
399         *bo = NULL;
400 }
401
402 static inline u64 virtio_gpu_object_mmap_offset(struct virtio_gpu_object *bo)
403 {
404         return drm_vma_node_offset_addr(&bo->tbo.vma_node);
405 }
406
407 static inline int virtio_gpu_object_reserve(struct virtio_gpu_object *bo,
408                                          bool no_wait)
409 {
410         int r;
411
412         r = ttm_bo_reserve(&bo->tbo, true, no_wait, NULL);
413         if (unlikely(r != 0)) {
414                 if (r != -ERESTARTSYS) {
415                         struct virtio_gpu_device *qdev =
416                                 bo->gem_base.dev->dev_private;
417                         dev_err(qdev->dev, "%p reserve failed\n", bo);
418                 }
419                 return r;
420         }
421         return 0;
422 }
423
424 static inline void virtio_gpu_object_unreserve(struct virtio_gpu_object *bo)
425 {
426         ttm_bo_unreserve(&bo->tbo);
427 }
428
429 /* virgl debufs */
430 int virtio_gpu_debugfs_init(struct drm_minor *minor);
431
432 #endif