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