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
26
27 #ifndef QXL_DRV_H
28 #define QXL_DRV_H
29
30 /*
31 * Definitions taken from spice-protocol, plus kernel driver specific bits.
32 */
33
34 #include <linux/dma-fence.h>
35 #include <linux/workqueue.h>
36 #include <linux/firmware.h>
37 #include <linux/platform_device.h>
38
39 #include <drm/drm_crtc.h>
40 #include <drm/drm_encoder.h>
41 #include <drm/drm_gem.h>
42 #include <drm/drmP.h>
43 #include <drm/ttm/ttm_bo_api.h>
44 #include <drm/ttm/ttm_bo_driver.h>
45 /* just for ttm_validate_buffer */
46 #include <drm/ttm/ttm_execbuf_util.h>
47 #include <drm/ttm/ttm_module.h>
48 #include <drm/ttm/ttm_placement.h>
49 #include <drm/qxl_drm.h>
50
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
63 #define QXL_DEBUGFS_MAX_COMPONENTS 32
64
65 extern int qxl_num_crtc;
66 extern int qxl_max_ioctls;
67
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
77 struct qxl_bo {
78 /* Protected by gem.mutex */
79 struct list_head list;
80 /* Protected by tbo.reserved */
81 struct ttm_place placements[3];
82 struct ttm_placement placement;
83 struct ttm_buffer_object tbo;
84 struct ttm_bo_kmap_obj kmap;
85 unsigned pin_count;
86 void *kptr;
87 int type;
88
89 /* Constant after initialization */
90 struct drm_gem_object gem_base;
91 bool is_primary; /* is this now a primary surface */
92 bool is_dumb;
93 struct qxl_bo *shadow;
94 bool hw_surf_alloc;
95 struct qxl_surface surf;
96 uint32_t surface_id;
97 struct qxl_release *surf_create;
98 };
99 #define gem_to_qxl_bo(gobj) container_of((gobj), struct qxl_bo, gem_base)
100 #define to_qxl_bo(tobj) container_of((tobj), struct qxl_bo, tbo)
101
102 struct qxl_gem {
103 struct mutex mutex;
104 struct list_head objects;
105 };
106
107 struct qxl_bo_list {
108 struct ttm_validate_buffer tv;
109 };
110
111 struct qxl_crtc {
112 struct drm_crtc base;
113 int index;
114
115 struct qxl_bo *cursor_bo;
116 };
117
118 struct qxl_output {
119 int index;
120 struct drm_connector base;
121 struct drm_encoder enc;
122 };
123
124 struct qxl_framebuffer {
125 struct drm_framebuffer base;
126 struct drm_gem_object *obj;
127 };
128
129 #define to_qxl_crtc(x) container_of(x, struct qxl_crtc, base)
130 #define drm_connector_to_qxl_output(x) container_of(x, struct qxl_output, base)
131 #define drm_encoder_to_qxl_output(x) container_of(x, struct qxl_output, enc)
132 #define to_qxl_framebuffer(x) container_of(x, struct qxl_framebuffer, base)
133
134 struct qxl_mman {
135 struct ttm_bo_global_ref bo_global_ref;
136 struct drm_global_reference mem_global_ref;
137 bool mem_global_referenced;
138 struct ttm_bo_device bdev;
139 };
140
141 struct qxl_mode_info {
142 bool mode_config_initialized;
143
144 /* pointer to fbdev info structure */
145 struct qxl_fbdev *qfbdev;
146 };
147
148
149 struct qxl_memslot {
150 uint8_t generation;
151 uint64_t start_phys_addr;
152 uint64_t end_phys_addr;
153 uint64_t high_bits;
154 };
155
156 enum {
157 QXL_RELEASE_DRAWABLE,
158 QXL_RELEASE_SURFACE_CMD,
159 QXL_RELEASE_CURSOR_CMD,
160 };
161
162 /* drm_ prefix to differentiate from qxl_release_info in
163 * spice-protocol/qxl_dev.h */
164 #define QXL_MAX_RES 96
165 struct qxl_release {
166 struct dma_fence base;
167
168 int id;
169 int type;
170 struct qxl_bo *release_bo;
171 uint32_t release_offset;
172 uint32_t surface_release_id;
173 struct ww_acquire_ctx ticket;
174 struct list_head bos;
175 };
176
177 struct qxl_drm_chunk {
178 struct list_head head;
179 struct qxl_bo *bo;
180 };
181
182 struct qxl_drm_image {
183 struct qxl_bo *bo;
184 struct list_head chunk_list;
185 };
186
187 struct qxl_fb_image {
188 struct qxl_device *qdev;
189 uint32_t pseudo_palette[16];
190 struct fb_image fb_image;
191 uint32_t visual;
192 };
193
194 struct qxl_draw_fill {
195 struct qxl_device *qdev;
196 struct qxl_rect rect;
197 uint32_t color;
198 uint16_t rop;
199 };
200
201 /*
202 * Debugfs
203 */
204 struct qxl_debugfs {
205 struct drm_info_list *files;
206 unsigned num_files;
207 };
208
209 int qxl_debugfs_add_files(struct qxl_device *rdev,
210 struct drm_info_list *files,
211 unsigned nfiles);
212 int qxl_debugfs_fence_init(struct qxl_device *rdev);
213
214 struct qxl_device;
215
216 struct qxl_device {
217 struct drm_device ddev;
218
219 resource_size_t vram_base, vram_size;
220 resource_size_t surfaceram_base, surfaceram_size;
221 resource_size_t rom_base, rom_size;
222 struct qxl_rom *rom;
223
224 struct qxl_mode *modes;
225 struct qxl_bo *monitors_config_bo;
226 struct qxl_monitors_config *monitors_config;
227
228 /* last received client_monitors_config */
229 struct qxl_monitors_config *client_monitors_config;
230
231 int io_base;
232 void *ram;
233 struct qxl_mman mman;
234 struct qxl_gem gem;
235 struct qxl_mode_info mode_info;
236
237 struct fb_info *fbdev_info;
238 struct qxl_framebuffer *fbdev_qfb;
239 void *ram_physical;
240
241 struct qxl_ring *release_ring;
242 struct qxl_ring *command_ring;
243 struct qxl_ring *cursor_ring;
244
245 struct qxl_ram_header *ram_header;
246
247 bool primary_created;
248
249 struct qxl_memslot *mem_slots;
250 uint8_t n_mem_slots;
251
252 uint8_t main_mem_slot;
253 uint8_t surfaces_mem_slot;
254 uint8_t slot_id_bits;
255 uint8_t slot_gen_bits;
256 uint64_t va_slot_mask;
257
258 spinlock_t release_lock;
259 struct idr release_idr;
260 uint32_t release_seqno;
261 spinlock_t release_idr_lock;
262 struct mutex async_io_mutex;
263 unsigned int last_sent_io_cmd;
264
265 /* interrupt handling */
266 atomic_t irq_received;
267 atomic_t irq_received_display;
268 atomic_t irq_received_cursor;
269 atomic_t irq_received_io_cmd;
270 unsigned irq_received_error;
271 wait_queue_head_t display_event;
272 wait_queue_head_t cursor_event;
273 wait_queue_head_t io_cmd_event;
274 struct work_struct client_monitors_config_work;
275
276 /* debugfs */
277 struct qxl_debugfs debugfs[QXL_DEBUGFS_MAX_COMPONENTS];
278 unsigned debugfs_count;
279
280 struct mutex update_area_mutex;
281
282 struct idr surf_id_idr;
283 spinlock_t surf_id_idr_lock;
284 int last_alloced_surf_id;
285
286 struct mutex surf_evict_mutex;
287 struct io_mapping *vram_mapping;
288 struct io_mapping *surface_mapping;
289
290 /* */
291 struct mutex release_mutex;
292 struct qxl_bo *current_release_bo[3];
293 int current_release_bo_offset[3];
294
295 struct work_struct gc_work;
296
297 struct drm_property *hotplug_mode_update_property;
298 int monitors_config_width;
299 int monitors_config_height;
300 };
301
302 extern const struct drm_ioctl_desc qxl_ioctls[];
303 extern int qxl_max_ioctl;
304
305 int qxl_device_init(struct qxl_device *qdev, struct drm_driver *drv,
306 struct pci_dev *pdev);
307 void qxl_device_fini(struct qxl_device *qdev);
308
309 int qxl_modeset_init(struct qxl_device *qdev);
310 void qxl_modeset_fini(struct qxl_device *qdev);
311
312 int qxl_bo_init(struct qxl_device *qdev);
313 void qxl_bo_fini(struct qxl_device *qdev);
314
315 void qxl_reinit_memslots(struct qxl_device *qdev);
316 int qxl_surf_evict(struct qxl_device *qdev);
317 int qxl_vram_evict(struct qxl_device *qdev);
318
319 struct qxl_ring *qxl_ring_create(struct qxl_ring_header *header,
320 int element_size,
321 int n_elements,
322 int prod_notify,
323 bool set_prod_notify,
324 wait_queue_head_t *push_event);
325 void qxl_ring_free(struct qxl_ring *ring);
326 void qxl_ring_init_hdr(struct qxl_ring *ring);
327 int qxl_check_idle(struct qxl_ring *ring);
328
329 static inline void *
qxl_fb_virtual_address(struct qxl_device * qdev,unsigned long physical)330 qxl_fb_virtual_address(struct qxl_device *qdev, unsigned long physical)
331 {
332 DRM_DEBUG_DRIVER("not implemented (%lu)\n", physical);
333 return 0;
334 }
335
336 static inline uint64_t
qxl_bo_physical_address(struct qxl_device * qdev,struct qxl_bo * bo,unsigned long offset)337 qxl_bo_physical_address(struct qxl_device *qdev, struct qxl_bo *bo,
338 unsigned long offset)
339 {
340 int slot_id = bo->type == QXL_GEM_DOMAIN_VRAM ? qdev->main_mem_slot : qdev->surfaces_mem_slot;
341 struct qxl_memslot *slot = &(qdev->mem_slots[slot_id]);
342
343 /* TODO - need to hold one of the locks to read tbo.offset */
344 return slot->high_bits | (bo->tbo.offset + offset);
345 }
346
347 /* qxl_fb.c */
348 #define QXLFB_CONN_LIMIT 1
349
350 int qxl_fbdev_init(struct qxl_device *qdev);
351 void qxl_fbdev_fini(struct qxl_device *qdev);
352 int qxl_get_handle_for_primary_fb(struct qxl_device *qdev,
353 struct drm_file *file_priv,
354 uint32_t *handle);
355 void qxl_fbdev_set_suspend(struct qxl_device *qdev, int state);
356
357 /* qxl_display.c */
358 void qxl_user_framebuffer_destroy(struct drm_framebuffer *fb);
359 int
360 qxl_framebuffer_init(struct drm_device *dev,
361 struct qxl_framebuffer *rfb,
362 const struct drm_mode_fb_cmd2 *mode_cmd,
363 struct drm_gem_object *obj,
364 const struct drm_framebuffer_funcs *funcs);
365 void qxl_display_read_client_monitors_config(struct qxl_device *qdev);
366 int qxl_create_monitors_object(struct qxl_device *qdev);
367 int qxl_destroy_monitors_object(struct qxl_device *qdev);
368
369 /* qxl_gem.c */
370 void qxl_gem_init(struct qxl_device *qdev);
371 void qxl_gem_fini(struct qxl_device *qdev);
372 int qxl_gem_object_create(struct qxl_device *qdev, int size,
373 int alignment, int initial_domain,
374 bool discardable, bool kernel,
375 struct qxl_surface *surf,
376 struct drm_gem_object **obj);
377 int qxl_gem_object_create_with_handle(struct qxl_device *qdev,
378 struct drm_file *file_priv,
379 u32 domain,
380 size_t size,
381 struct qxl_surface *surf,
382 struct qxl_bo **qobj,
383 uint32_t *handle);
384 void qxl_gem_object_free(struct drm_gem_object *gobj);
385 int qxl_gem_object_open(struct drm_gem_object *obj, struct drm_file *file_priv);
386 void qxl_gem_object_close(struct drm_gem_object *obj,
387 struct drm_file *file_priv);
388 void qxl_bo_force_delete(struct qxl_device *qdev);
389 int qxl_bo_kmap(struct qxl_bo *bo, void **ptr);
390
391 /* qxl_dumb.c */
392 int qxl_mode_dumb_create(struct drm_file *file_priv,
393 struct drm_device *dev,
394 struct drm_mode_create_dumb *args);
395 int qxl_mode_dumb_mmap(struct drm_file *filp,
396 struct drm_device *dev,
397 uint32_t handle, uint64_t *offset_p);
398
399
400 /* qxl ttm */
401 int qxl_ttm_init(struct qxl_device *qdev);
402 void qxl_ttm_fini(struct qxl_device *qdev);
403 int qxl_mmap(struct file *filp, struct vm_area_struct *vma);
404
405 /* qxl image */
406
407 int qxl_image_init(struct qxl_device *qdev,
408 struct qxl_release *release,
409 struct qxl_drm_image *dimage,
410 const uint8_t *data,
411 int x, int y, int width, int height,
412 int depth, int stride);
413 int
414 qxl_image_alloc_objects(struct qxl_device *qdev,
415 struct qxl_release *release,
416 struct qxl_drm_image **image_ptr,
417 int height, int stride);
418 void qxl_image_free_objects(struct qxl_device *qdev, struct qxl_drm_image *dimage);
419
420 void qxl_update_screen(struct qxl_device *qxl);
421
422 /* qxl io operations (qxl_cmd.c) */
423
424 void qxl_io_create_primary(struct qxl_device *qdev,
425 unsigned offset,
426 struct qxl_bo *bo);
427 void qxl_io_destroy_primary(struct qxl_device *qdev);
428 void qxl_io_memslot_add(struct qxl_device *qdev, uint8_t id);
429 void qxl_io_notify_oom(struct qxl_device *qdev);
430
431 int qxl_io_update_area(struct qxl_device *qdev, struct qxl_bo *surf,
432 const struct qxl_rect *area);
433
434 void qxl_io_reset(struct qxl_device *qdev);
435 void qxl_io_monitors_config(struct qxl_device *qdev);
436 int qxl_ring_push(struct qxl_ring *ring, const void *new_elt, bool interruptible);
437 void qxl_io_flush_release(struct qxl_device *qdev);
438 void qxl_io_flush_surfaces(struct qxl_device *qdev);
439
440 union qxl_release_info *qxl_release_map(struct qxl_device *qdev,
441 struct qxl_release *release);
442 void qxl_release_unmap(struct qxl_device *qdev,
443 struct qxl_release *release,
444 union qxl_release_info *info);
445 int qxl_release_list_add(struct qxl_release *release, struct qxl_bo *bo);
446 int qxl_release_reserve_list(struct qxl_release *release, bool no_intr);
447 void qxl_release_backoff_reserve_list(struct qxl_release *release);
448 void qxl_release_fence_buffer_objects(struct qxl_release *release);
449
450 int qxl_alloc_surface_release_reserved(struct qxl_device *qdev,
451 enum qxl_surface_cmd_type surface_cmd_type,
452 struct qxl_release *create_rel,
453 struct qxl_release **release);
454 int qxl_alloc_release_reserved(struct qxl_device *qdev, unsigned long size,
455 int type, struct qxl_release **release,
456 struct qxl_bo **rbo);
457
458 int
459 qxl_push_command_ring_release(struct qxl_device *qdev, struct qxl_release *release,
460 uint32_t type, bool interruptible);
461 int
462 qxl_push_cursor_ring_release(struct qxl_device *qdev, struct qxl_release *release,
463 uint32_t type, bool interruptible);
464 int qxl_alloc_bo_reserved(struct qxl_device *qdev,
465 struct qxl_release *release,
466 unsigned long size,
467 struct qxl_bo **_bo);
468 /* qxl drawing commands */
469
470 void qxl_draw_opaque_fb(const struct qxl_fb_image *qxl_fb_image,
471 int stride /* filled in if 0 */);
472
473 void qxl_draw_dirty_fb(struct qxl_device *qdev,
474 struct qxl_framebuffer *qxl_fb,
475 struct qxl_bo *bo,
476 unsigned flags, unsigned color,
477 struct drm_clip_rect *clips,
478 unsigned num_clips, int inc);
479
480 void qxl_draw_fill(struct qxl_draw_fill *qxl_draw_fill_rec);
481
482 void qxl_draw_copyarea(struct qxl_device *qdev,
483 u32 width, u32 height,
484 u32 sx, u32 sy,
485 u32 dx, u32 dy);
486
487 void qxl_release_free(struct qxl_device *qdev,
488 struct qxl_release *release);
489
490 /* used by qxl_debugfs_release */
491 struct qxl_release *qxl_release_from_id_locked(struct qxl_device *qdev,
492 uint64_t id);
493
494 bool qxl_queue_garbage_collect(struct qxl_device *qdev, bool flush);
495 int qxl_garbage_collect(struct qxl_device *qdev);
496
497 /* debugfs */
498
499 int qxl_debugfs_init(struct drm_minor *minor);
500 int qxl_ttm_debugfs_init(struct qxl_device *qdev);
501
502 /* qxl_prime.c */
503 int qxl_gem_prime_pin(struct drm_gem_object *obj);
504 void qxl_gem_prime_unpin(struct drm_gem_object *obj);
505 struct sg_table *qxl_gem_prime_get_sg_table(struct drm_gem_object *obj);
506 struct drm_gem_object *qxl_gem_prime_import_sg_table(
507 struct drm_device *dev, struct dma_buf_attachment *attach,
508 struct sg_table *sgt);
509 void *qxl_gem_prime_vmap(struct drm_gem_object *obj);
510 void qxl_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
511 int qxl_gem_prime_mmap(struct drm_gem_object *obj,
512 struct vm_area_struct *vma);
513
514 /* qxl_irq.c */
515 int qxl_irq_init(struct qxl_device *qdev);
516 irqreturn_t qxl_irq_handler(int irq, void *arg);
517
518 /* qxl_fb.c */
519 bool qxl_fbdev_qobj_is_fb(struct qxl_device *qdev, struct qxl_bo *qobj);
520
521 int qxl_debugfs_add_files(struct qxl_device *qdev,
522 struct drm_info_list *files,
523 unsigned nfiles);
524
525 int qxl_surface_id_alloc(struct qxl_device *qdev,
526 struct qxl_bo *surf);
527 void qxl_surface_id_dealloc(struct qxl_device *qdev,
528 uint32_t surface_id);
529 int qxl_hw_surface_alloc(struct qxl_device *qdev,
530 struct qxl_bo *surf,
531 struct ttm_mem_reg *mem);
532 int qxl_hw_surface_dealloc(struct qxl_device *qdev,
533 struct qxl_bo *surf);
534
535 int qxl_bo_check_id(struct qxl_device *qdev, struct qxl_bo *bo);
536
537 struct qxl_drv_surface *
538 qxl_surface_lookup(struct drm_device *dev, int surface_id);
539 void qxl_surface_evict(struct qxl_device *qdev, struct qxl_bo *surf, bool freeing);
540
541 #endif
542
