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