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 <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
65extern int qxl_num_crtc;
66extern 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
77struct 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
102struct qxl_gem {
103 struct mutex mutex;
104 struct list_head objects;
105};
106
107struct qxl_bo_list {
108 struct ttm_validate_buffer tv;
109};
110
111struct qxl_crtc {
112 struct drm_crtc base;
113 int index;
114
115 struct qxl_bo *cursor_bo;
116};
117
118struct qxl_output {
119 int index;
120 struct drm_connector base;
121 struct drm_encoder enc;
122};
123
124struct 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
134struct 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
141struct qxl_mode_info {
142 bool mode_config_initialized;
143
144 /* pointer to fbdev info structure */
145 struct qxl_fbdev *qfbdev;
146};
147
148
149struct 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
156enum {
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
165struct 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
177struct qxl_drm_chunk {
178 struct list_head head;
179 struct qxl_bo *bo;
180};
181
182struct qxl_drm_image {
183 struct qxl_bo *bo;
184 struct list_head chunk_list;
185};
186
187struct 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
194struct 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 */
204struct qxl_debugfs {
205 struct drm_info_list *files;
206 unsigned num_files;
207};
208
209int qxl_debugfs_add_files(struct qxl_device *rdev,
210 struct drm_info_list *files,
211 unsigned nfiles);
212int qxl_debugfs_fence_init(struct qxl_device *rdev);
213
214struct qxl_device;
215
216struct 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/* forward declaration for QXL_INFO_IO */
303__printf(2,3) void qxl_io_log(struct qxl_device *qdev, const char *fmt, ...);
304
305extern const struct drm_ioctl_desc qxl_ioctls[];
306extern int qxl_max_ioctl;
307
308int qxl_device_init(struct qxl_device *qdev, struct drm_driver *drv,
309 struct pci_dev *pdev);
310void qxl_device_fini(struct qxl_device *qdev);
311
312int qxl_modeset_init(struct qxl_device *qdev);
313void qxl_modeset_fini(struct qxl_device *qdev);
314
315int qxl_bo_init(struct qxl_device *qdev);
316void qxl_bo_fini(struct qxl_device *qdev);
317
318void qxl_reinit_memslots(struct qxl_device *qdev);
319int qxl_surf_evict(struct qxl_device *qdev);
320int qxl_vram_evict(struct qxl_device *qdev);
321
322struct qxl_ring *qxl_ring_create(struct qxl_ring_header *header,
323 int element_size,
324 int n_elements,
325 int prod_notify,
326 bool set_prod_notify,
327 wait_queue_head_t *push_event);
328void qxl_ring_free(struct qxl_ring *ring);
329void qxl_ring_init_hdr(struct qxl_ring *ring);
330int qxl_check_idle(struct qxl_ring *ring);
331
332static inline void *
333qxl_fb_virtual_address(struct qxl_device *qdev, unsigned long physical)
334{
335 DRM_DEBUG_DRIVER("not implemented (%lu)\n", physical);
336 return 0;
337}
338
339static inline uint64_t
340qxl_bo_physical_address(struct qxl_device *qdev, struct qxl_bo *bo,
341 unsigned long offset)
342{
343 int slot_id = bo->type == QXL_GEM_DOMAIN_VRAM ? qdev->main_mem_slot : qdev->surfaces_mem_slot;
344 struct qxl_memslot *slot = &(qdev->mem_slots[slot_id]);
345
346 /* TODO - need to hold one of the locks to read tbo.offset */
347 return slot->high_bits | (bo->tbo.offset + offset);
348}
349
350/* qxl_fb.c */
351#define QXLFB_CONN_LIMIT 1
352
353int qxl_fbdev_init(struct qxl_device *qdev);
354void qxl_fbdev_fini(struct qxl_device *qdev);
355int qxl_get_handle_for_primary_fb(struct qxl_device *qdev,
356 struct drm_file *file_priv,
357 uint32_t *handle);
358void qxl_fbdev_set_suspend(struct qxl_device *qdev, int state);
359
360/* qxl_display.c */
361void qxl_user_framebuffer_destroy(struct drm_framebuffer *fb);
362int
363qxl_framebuffer_init(struct drm_device *dev,
364 struct qxl_framebuffer *rfb,
365 const struct drm_mode_fb_cmd2 *mode_cmd,
366 struct drm_gem_object *obj,
367 const struct drm_framebuffer_funcs *funcs);
368void qxl_display_read_client_monitors_config(struct qxl_device *qdev);
369int qxl_create_monitors_object(struct qxl_device *qdev);
370int qxl_destroy_monitors_object(struct qxl_device *qdev);
371
372/* qxl_gem.c */
373void qxl_gem_init(struct qxl_device *qdev);
374void qxl_gem_fini(struct qxl_device *qdev);
375int qxl_gem_object_create(struct qxl_device *qdev, int size,
376 int alignment, int initial_domain,
377 bool discardable, bool kernel,
378 struct qxl_surface *surf,
379 struct drm_gem_object **obj);
380int qxl_gem_object_create_with_handle(struct qxl_device *qdev,
381 struct drm_file *file_priv,
382 u32 domain,
383 size_t size,
384 struct qxl_surface *surf,
385 struct qxl_bo **qobj,
386 uint32_t *handle);
387void qxl_gem_object_free(struct drm_gem_object *gobj);
388int qxl_gem_object_open(struct drm_gem_object *obj, struct drm_file *file_priv);
389void qxl_gem_object_close(struct drm_gem_object *obj,
390 struct drm_file *file_priv);
391void qxl_bo_force_delete(struct qxl_device *qdev);
392int qxl_bo_kmap(struct qxl_bo *bo, void **ptr);
393
394/* qxl_dumb.c */
395int qxl_mode_dumb_create(struct drm_file *file_priv,
396 struct drm_device *dev,
397 struct drm_mode_create_dumb *args);
398int qxl_mode_dumb_mmap(struct drm_file *filp,
399 struct drm_device *dev,
400 uint32_t handle, uint64_t *offset_p);
401
402
403/* qxl ttm */
404int qxl_ttm_init(struct qxl_device *qdev);
405void qxl_ttm_fini(struct qxl_device *qdev);
406int qxl_mmap(struct file *filp, struct vm_area_struct *vma);
407
408/* qxl image */
409
410int qxl_image_init(struct qxl_device *qdev,
411 struct qxl_release *release,
412 struct qxl_drm_image *dimage,
413 const uint8_t *data,
414 int x, int y, int width, int height,
415 int depth, int stride);
416int
417qxl_image_alloc_objects(struct qxl_device *qdev,
418 struct qxl_release *release,
419 struct qxl_drm_image **image_ptr,
420 int height, int stride);
421void qxl_image_free_objects(struct qxl_device *qdev, struct qxl_drm_image *dimage);
422
423void qxl_update_screen(struct qxl_device *qxl);
424
425/* qxl io operations (qxl_cmd.c) */
426
427void qxl_io_create_primary(struct qxl_device *qdev,
428 unsigned offset,
429 struct qxl_bo *bo);
430void qxl_io_destroy_primary(struct qxl_device *qdev);
431void qxl_io_memslot_add(struct qxl_device *qdev, uint8_t id);
432void qxl_io_notify_oom(struct qxl_device *qdev);
433
434int qxl_io_update_area(struct qxl_device *qdev, struct qxl_bo *surf,
435 const struct qxl_rect *area);
436
437void qxl_io_reset(struct qxl_device *qdev);
438void qxl_io_monitors_config(struct qxl_device *qdev);
439int qxl_ring_push(struct qxl_ring *ring, const void *new_elt, bool interruptible);
440void qxl_io_flush_release(struct qxl_device *qdev);
441void qxl_io_flush_surfaces(struct qxl_device *qdev);
442
443union qxl_release_info *qxl_release_map(struct qxl_device *qdev,
444 struct qxl_release *release);
445void qxl_release_unmap(struct qxl_device *qdev,
446 struct qxl_release *release,
447 union qxl_release_info *info);
448int qxl_release_list_add(struct qxl_release *release, struct qxl_bo *bo);
449int qxl_release_reserve_list(struct qxl_release *release, bool no_intr);
450void qxl_release_backoff_reserve_list(struct qxl_release *release);
451void qxl_release_fence_buffer_objects(struct qxl_release *release);
452
453int qxl_alloc_surface_release_reserved(struct qxl_device *qdev,
454 enum qxl_surface_cmd_type surface_cmd_type,
455 struct qxl_release *create_rel,
456 struct qxl_release **release);
457int qxl_alloc_release_reserved(struct qxl_device *qdev, unsigned long size,
458 int type, struct qxl_release **release,
459 struct qxl_bo **rbo);
460
461int
462qxl_push_command_ring_release(struct qxl_device *qdev, struct qxl_release *release,
463 uint32_t type, bool interruptible);
464int
465qxl_push_cursor_ring_release(struct qxl_device *qdev, struct qxl_release *release,
466 uint32_t type, bool interruptible);
467int qxl_alloc_bo_reserved(struct qxl_device *qdev,
468 struct qxl_release *release,
469 unsigned long size,
470 struct qxl_bo **_bo);
471/* qxl drawing commands */
472
473void qxl_draw_opaque_fb(const struct qxl_fb_image *qxl_fb_image,
474 int stride /* filled in if 0 */);
475
476void qxl_draw_dirty_fb(struct qxl_device *qdev,
477 struct qxl_framebuffer *qxl_fb,
478 struct qxl_bo *bo,
479 unsigned flags, unsigned color,
480 struct drm_clip_rect *clips,
481 unsigned num_clips, int inc);
482
483void qxl_draw_fill(struct qxl_draw_fill *qxl_draw_fill_rec);
484
485void qxl_draw_copyarea(struct qxl_device *qdev,
486 u32 width, u32 height,
487 u32 sx, u32 sy,
488 u32 dx, u32 dy);
489
490void qxl_release_free(struct qxl_device *qdev,
491 struct qxl_release *release);
492
493/* used by qxl_debugfs_release */
494struct qxl_release *qxl_release_from_id_locked(struct qxl_device *qdev,
495 uint64_t id);
496
497bool qxl_queue_garbage_collect(struct qxl_device *qdev, bool flush);
498int qxl_garbage_collect(struct qxl_device *qdev);
499
500/* debugfs */
501
502int qxl_debugfs_init(struct drm_minor *minor);
503int qxl_ttm_debugfs_init(struct qxl_device *qdev);
504
505/* qxl_prime.c */
506int qxl_gem_prime_pin(struct drm_gem_object *obj);
507void qxl_gem_prime_unpin(struct drm_gem_object *obj);
508struct sg_table *qxl_gem_prime_get_sg_table(struct drm_gem_object *obj);
509struct drm_gem_object *qxl_gem_prime_import_sg_table(
510 struct drm_device *dev, struct dma_buf_attachment *attach,
511 struct sg_table *sgt);
512void *qxl_gem_prime_vmap(struct drm_gem_object *obj);
513void qxl_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
514int qxl_gem_prime_mmap(struct drm_gem_object *obj,
515 struct vm_area_struct *vma);
516
517/* qxl_irq.c */
518int qxl_irq_init(struct qxl_device *qdev);
519irqreturn_t qxl_irq_handler(int irq, void *arg);
520
521/* qxl_fb.c */
522bool qxl_fbdev_qobj_is_fb(struct qxl_device *qdev, struct qxl_bo *qobj);
523
524int qxl_debugfs_add_files(struct qxl_device *qdev,
525 struct drm_info_list *files,
526 unsigned nfiles);
527
528int qxl_surface_id_alloc(struct qxl_device *qdev,
529 struct qxl_bo *surf);
530void qxl_surface_id_dealloc(struct qxl_device *qdev,
531 uint32_t surface_id);
532int qxl_hw_surface_alloc(struct qxl_device *qdev,
533 struct qxl_bo *surf,
534 struct ttm_mem_reg *mem);
535int qxl_hw_surface_dealloc(struct qxl_device *qdev,
536 struct qxl_bo *surf);
537
538int qxl_bo_check_id(struct qxl_device *qdev, struct qxl_bo *bo);
539
540struct qxl_drv_surface *
541qxl_surface_lookup(struct drm_device *dev, int surface_id);
542void qxl_surface_evict(struct qxl_device *qdev, struct qxl_bo *surf, bool freeing);
543
544#endif